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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

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