Gan likun / mbed-dev11

hal/can_helper.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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