mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/can_helper.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
156:ff21514d8981
Child:
172:65be27845400
mbed library. Release version 162

Who changed what in which revision?

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