John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

hal/can_helper.h@182:57724642e740, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:09:33 2018 +0000
Revision:
182:57724642e740
Parent:
167:e84263d55307 
mbed-dev library. Release version 159.

Who changed what in which revision?

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