Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

can_api.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
69:4a7918f48478
Child:
99:dbbf35b96557
dgdgr

Who changed what in which revision?

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