mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/can_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
187:0387e8f68319 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 149:156823d33999 1
<> 149:156823d33999 2 /** \addtogroup hal */
<> 149:156823d33999 3 /** @{*/
<> 144:ef7eb2e8f9f7 4 /* mbed Microcontroller Library
<> 144:ef7eb2e8f9f7 5 * Copyright (c) 2006-2016 ARM Limited
AnnaBridge 189:f392fc9709a3 6 * SPDX-License-Identifier: Apache-2.0
<> 144:ef7eb2e8f9f7 7 *
<> 144:ef7eb2e8f9f7 8 * Licensed under the Apache License, Version 2.0 (the "License");
<> 144:ef7eb2e8f9f7 9 * you may not use this file except in compliance with the License.
<> 144:ef7eb2e8f9f7 10 * You may obtain a copy of the License at
<> 144:ef7eb2e8f9f7 11 *
<> 144:ef7eb2e8f9f7 12 * http://www.apache.org/licenses/LICENSE-2.0
<> 144:ef7eb2e8f9f7 13 *
<> 144:ef7eb2e8f9f7 14 * Unless required by applicable law or agreed to in writing, software
<> 144:ef7eb2e8f9f7 15 * distributed under the License is distributed on an "AS IS" BASIS,
<> 144:ef7eb2e8f9f7 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 144:ef7eb2e8f9f7 17 * See the License for the specific language governing permissions and
<> 144:ef7eb2e8f9f7 18 * limitations under the License.
<> 144:ef7eb2e8f9f7 19 */
<> 144:ef7eb2e8f9f7 20 #ifndef MBED_CAN_API_H
<> 144:ef7eb2e8f9f7 21 #define MBED_CAN_API_H
<> 144:ef7eb2e8f9f7 22
<> 144:ef7eb2e8f9f7 23 #include "device.h"
<> 144:ef7eb2e8f9f7 24
<> 144:ef7eb2e8f9f7 25 #if DEVICE_CAN
<> 144:ef7eb2e8f9f7 26
<> 144:ef7eb2e8f9f7 27 #include "PinNames.h"
<> 144:ef7eb2e8f9f7 28 #include "PeripheralNames.h"
<> 149:156823d33999 29 #include "hal/can_helper.h"
<> 144:ef7eb2e8f9f7 30
<> 144:ef7eb2e8f9f7 31 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 32 extern "C" {
<> 144:ef7eb2e8f9f7 33 #endif
<> 144:ef7eb2e8f9f7 34
<> 144:ef7eb2e8f9f7 35 typedef enum {
<> 144:ef7eb2e8f9f7 36 IRQ_RX,
<> 144:ef7eb2e8f9f7 37 IRQ_TX,
<> 144:ef7eb2e8f9f7 38 IRQ_ERROR,
<> 144:ef7eb2e8f9f7 39 IRQ_OVERRUN,
<> 144:ef7eb2e8f9f7 40 IRQ_WAKEUP,
<> 144:ef7eb2e8f9f7 41 IRQ_PASSIVE,
<> 144:ef7eb2e8f9f7 42 IRQ_ARB,
<> 144:ef7eb2e8f9f7 43 IRQ_BUS,
<> 144:ef7eb2e8f9f7 44 IRQ_READY
<> 144:ef7eb2e8f9f7 45 } CanIrqType;
<> 144:ef7eb2e8f9f7 46
<> 144:ef7eb2e8f9f7 47
<> 144:ef7eb2e8f9f7 48 typedef enum {
<> 144:ef7eb2e8f9f7 49 MODE_RESET,
<> 144:ef7eb2e8f9f7 50 MODE_NORMAL,
<> 144:ef7eb2e8f9f7 51 MODE_SILENT,
<> 144:ef7eb2e8f9f7 52 MODE_TEST_LOCAL,
<> 144:ef7eb2e8f9f7 53 MODE_TEST_GLOBAL,
<> 144:ef7eb2e8f9f7 54 MODE_TEST_SILENT
<> 144:ef7eb2e8f9f7 55 } CanMode;
<> 144:ef7eb2e8f9f7 56
<> 144:ef7eb2e8f9f7 57 typedef void (*can_irq_handler)(uint32_t id, CanIrqType type);
<> 144:ef7eb2e8f9f7 58
<> 144:ef7eb2e8f9f7 59 typedef struct can_s can_t;
<> 144:ef7eb2e8f9f7 60
AnnaBridge 187:0387e8f68319 61 void can_init(can_t *obj, PinName rd, PinName td);
AnnaBridge 187:0387e8f68319 62 void can_init_freq(can_t *obj, PinName rd, PinName td, int hz);
AnnaBridge 187:0387e8f68319 63 void can_free(can_t *obj);
AnnaBridge 187:0387e8f68319 64 int can_frequency(can_t *obj, int hz);
<> 144:ef7eb2e8f9f7 65
AnnaBridge 187:0387e8f68319 66 void can_irq_init(can_t *obj, can_irq_handler handler, uint32_t id);
AnnaBridge 187:0387e8f68319 67 void can_irq_free(can_t *obj);
AnnaBridge 187:0387e8f68319 68 void can_irq_set(can_t *obj, CanIrqType irq, uint32_t enable);
<> 144:ef7eb2e8f9f7 69
AnnaBridge 187:0387e8f68319 70 int can_write(can_t *obj, CAN_Message, int cc);
AnnaBridge 187:0387e8f68319 71 int can_read(can_t *obj, CAN_Message *msg, int handle);
AnnaBridge 187:0387e8f68319 72 int can_mode(can_t *obj, CanMode mode);
<> 144:ef7eb2e8f9f7 73 int can_filter(can_t *obj, uint32_t id, uint32_t mask, CANFormat format, int32_t handle);
AnnaBridge 187:0387e8f68319 74 void can_reset(can_t *obj);
AnnaBridge 187:0387e8f68319 75 unsigned char can_rderror(can_t *obj);
AnnaBridge 187:0387e8f68319 76 unsigned char can_tderror(can_t *obj);
AnnaBridge 187:0387e8f68319 77 void can_monitor(can_t *obj, int silent);
<> 144:ef7eb2e8f9f7 78
<> 144:ef7eb2e8f9f7 79 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 80 };
<> 144:ef7eb2e8f9f7 81 #endif
<> 144:ef7eb2e8f9f7 82
<> 144:ef7eb2e8f9f7 83 #endif // MBED_CAN_API_H
<> 144:ef7eb2e8f9f7 84
<> 144:ef7eb2e8f9f7 85 #endif
<> 149:156823d33999 86
<> 149:156823d33999 87 /** @}*/