BA / Mbed OS BaBoRo1

mbed-os/hal/can_helper.h@4:75df35ef4fb6, 2018-03-30 (annotated)

Committer:
borlanic
Date:
Fri Mar 30 14:07:05 2018 +0000
Revision:
4:75df35ef4fb6
Parent:
0:380207fcb5c1 
commentar

Who changed what in which revision?

UserRevisionLine numberNew contents of line
borlanic 0:380207fcb5c1 1
borlanic 0:380207fcb5c1 2 /** \addtogroup hal */
borlanic 0:380207fcb5c1 3 /** @{*/
borlanic 0:380207fcb5c1 4 /* mbed Microcontroller Library
borlanic 0:380207fcb5c1 5 * Copyright (c) 2006-2013 ARM Limited
borlanic 0:380207fcb5c1 6 *
borlanic 0:380207fcb5c1 7 * Licensed under the Apache License, Version 2.0 (the "License");
borlanic 0:380207fcb5c1 8 * you may not use this file except in compliance with the License.
borlanic 0:380207fcb5c1 9 * You may obtain a copy of the License at
borlanic 0:380207fcb5c1 10 *
borlanic 0:380207fcb5c1 11 * http://www.apache.org/licenses/LICENSE-2.0
borlanic 0:380207fcb5c1 12 *
borlanic 0:380207fcb5c1 13 * Unless required by applicable law or agreed to in writing, software
borlanic 0:380207fcb5c1 14 * distributed under the License is distributed on an "AS IS" BASIS,
borlanic 0:380207fcb5c1 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
borlanic 0:380207fcb5c1 16 * See the License for the specific language governing permissions and
borlanic 0:380207fcb5c1 17 * limitations under the License.
borlanic 0:380207fcb5c1 18 */
borlanic 0:380207fcb5c1 19 #ifndef MBED_CAN_HELPER_H
borlanic 0:380207fcb5c1 20 #define MBED_CAN_HELPER_H
borlanic 0:380207fcb5c1 21
borlanic 0:380207fcb5c1 22 #if DEVICE_CAN
borlanic 0:380207fcb5c1 23
borlanic 0:380207fcb5c1 24 #ifdef __cplusplus
borlanic 0:380207fcb5c1 25 extern "C" {
borlanic 0:380207fcb5c1 26 #endif
borlanic 0:380207fcb5c1 27
borlanic 0:380207fcb5c1 28 /**
borlanic 0:380207fcb5c1 29 *
borlanic 0:380207fcb5c1 30 * \enum CANFormat
borlanic 0:380207fcb5c1 31 *
borlanic 0:380207fcb5c1 32 * \brief Values that represent CAN Format
borlanic 0:380207fcb5c1 33 **/
borlanic 0:380207fcb5c1 34 enum CANFormat {
borlanic 0:380207fcb5c1 35 CANStandard = 0,
borlanic 0:380207fcb5c1 36 CANExtended = 1,
borlanic 0:380207fcb5c1 37 CANAny = 2
borlanic 0:380207fcb5c1 38 };
borlanic 0:380207fcb5c1 39 typedef enum CANFormat CANFormat;
borlanic 0:380207fcb5c1 40
borlanic 0:380207fcb5c1 41 /**
borlanic 0:380207fcb5c1 42 *
borlanic 0:380207fcb5c1 43 * \enum CANType
borlanic 0:380207fcb5c1 44 *
borlanic 0:380207fcb5c1 45 * \brief Values that represent CAN Type
borlanic 0:380207fcb5c1 46 **/
borlanic 0:380207fcb5c1 47 enum CANType {
borlanic 0:380207fcb5c1 48 CANData = 0,
borlanic 0:380207fcb5c1 49 CANRemote = 1
borlanic 0:380207fcb5c1 50 };
borlanic 0:380207fcb5c1 51 typedef enum CANType CANType;
borlanic 0:380207fcb5c1 52
borlanic 0:380207fcb5c1 53 /**
borlanic 0:380207fcb5c1 54 *
borlanic 0:380207fcb5c1 55 * \struct CAN_Message
borlanic 0:380207fcb5c1 56 *
borlanic 0:380207fcb5c1 57 * \brief Holder for single CAN message.
borlanic 0:380207fcb5c1 58 *
borlanic 0:380207fcb5c1 59 **/
borlanic 0:380207fcb5c1 60 struct CAN_Message {
borlanic 0:380207fcb5c1 61 unsigned int id; // 29 bit identifier
borlanic 0:380207fcb5c1 62 unsigned char data[8]; // Data field
borlanic 0:380207fcb5c1 63 unsigned char len; // Length of data field in bytes
borlanic 0:380207fcb5c1 64 CANFormat format; // Format ::CANFormat
borlanic 0:380207fcb5c1 65 CANType type; // Type ::CANType
borlanic 0:380207fcb5c1 66 };
borlanic 0:380207fcb5c1 67 typedef struct CAN_Message CAN_Message;
borlanic 0:380207fcb5c1 68
borlanic 0:380207fcb5c1 69 #ifdef __cplusplus
borlanic 0:380207fcb5c1 70 };
borlanic 0:380207fcb5c1 71 #endif
borlanic 0:380207fcb5c1 72
borlanic 0:380207fcb5c1 73 #endif
borlanic 0:380207fcb5c1 74
borlanic 0:380207fcb5c1 75 #endif // MBED_CAN_HELPER_H
borlanic 0:380207fcb5c1 76
borlanic 0:380207fcb5c1 77 /** @}*/