mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/hal/can_helper.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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