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