EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/can_helper.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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