mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/can_api.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
156:ff21514d8981
Child:
170:e95d10626187
mbed library. Release version 162

Who changed what in which revision?

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