can_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_CAN_API_H
00023 #define MBED_CAN_API_H
00024 
00025 #include "device.h"
00026 
00027 #if DEVICE_CAN
00028 
00029 #include "PinNames.h"
00030 #include "PeripheralNames.h"
00031 #include "can_helper.h"
00032 
00033 #ifdef __cplusplus
00034 extern "C" {
00035 #endif
00036 
00037 typedef struct can_s can_t;
00038 
00039 void          can_init     (can_t *obj, PinName rd, PinName td);
00040 void          can_free     (can_t *obj);
00041 int           can_frequency(can_t *obj, int hz);
00042 int           can_write    (can_t *obj, CAN_Message, int cc);
00043 int           can_read     (can_t *obj, CAN_Message *msg);
00044 void          can_reset    (can_t *obj);
00045 unsigned char can_rderror  (can_t *obj);
00046 unsigned char can_tderror  (can_t *obj);
00047 void          can_monitor  (can_t *obj, int silent);
00048 
00049 #ifdef __cplusplus
00050 };
00051 #endif
00052 
00053 #endif    // MBED_CAN_API_H
00054 
00055 #endif
00056