mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

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

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

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