Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/hal/can_helper.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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