BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/can_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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