Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/can_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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