siva surendar / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

hal/can_api.h@75:245e7931bad6, 2016-02-26 (annotated)

Committer:
mbed_official
Date:
Fri Feb 26 17:15:12 2016 +0000
Revision:
75:245e7931bad6
Parent:
0:9b334a45a8ff
Child:
144:ef7eb2e8f9f7
Synchronized with git revision bd0417cb15230c145c56176806e7b1bb3fcafbb8



Full URL: https://github.com/mbedmicro/mbed/commit/bd0417cb15230c145c56176806e7b1bb3fcafbb8/



[STM B96B_F446VE] Add CAN feature

Who changed what in which revision?

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