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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
156:ff21514d8981 
mbed library release version 165

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