can_helper.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_HELPER_H
00023 #define MBED_CAN_HELPER_H
00024 
00025 #if DEVICE_CAN
00026 
00027 #ifdef __cplusplus
00028 extern "C" {
00029 #endif
00030 
00031 enum CANFormat {
00032     CANStandard = 0,
00033     CANExtended = 1
00034 };
00035 typedef enum CANFormat CANFormat;
00036 
00037 enum CANType {
00038     CANData   = 0,
00039     CANRemote = 1
00040 };
00041 typedef enum CANType CANType;
00042 
00043 struct CAN_Message {
00044     unsigned int   id;                 // 29 bit identifier
00045     unsigned char  data[8];            // Data field
00046     unsigned char  len;                // Length of data field in bytes
00047     CANFormat      format;             // 0 - STANDARD, 1- EXTENDED IDENTIFIER
00048     CANType        type;               // 0 - DATA FRAME, 1 - REMOTE FRAME
00049 };
00050 typedef struct CAN_Message CAN_Message;
00051 
00052 #ifdef __cplusplus
00053 };
00054 #endif
00055 
00056 #endif
00057 
00058 #endif // MBED_CAN_HELPER_H
00059