Toyomasa Watarai
Easily add all supported connectivity methods to your mbed OS project
stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_PktCommon.h@0:615f90842ce8, 2017-07-12 (annotated)
- Committer:
- MACRUM
- Date:
- Wed Jul 12 10:52:58 2017 +0000
- Revision:
- 0:615f90842ce8
Initial commit
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| MACRUM | 0:615f90842ce8 | 1 | /** |
| MACRUM | 0:615f90842ce8 | 2 | ****************************************************************************** |
| MACRUM | 0:615f90842ce8 | 3 | * @file SPIRIT_PktCommon.h |
| MACRUM | 0:615f90842ce8 | 4 | * @author VMA division - AMS |
| MACRUM | 0:615f90842ce8 | 5 | * @version 3.2.2 |
| MACRUM | 0:615f90842ce8 | 6 | * @date 08-July-2015 |
| MACRUM | 0:615f90842ce8 | 7 | * @brief Configuration and management of the common features of SPIRIT packets. |
| MACRUM | 0:615f90842ce8 | 8 | * |
| MACRUM | 0:615f90842ce8 | 9 | * @details |
| MACRUM | 0:615f90842ce8 | 10 | * |
| MACRUM | 0:615f90842ce8 | 11 | * This module provides all the common functions and definitions used by the |
| MACRUM | 0:615f90842ce8 | 12 | * packets modules. |
| MACRUM | 0:615f90842ce8 | 13 | * Here are also defined all the generic enumeration types that are redefined |
| MACRUM | 0:615f90842ce8 | 14 | * in the specific packets modules, but every enumeration value is referred |
| MACRUM | 0:615f90842ce8 | 15 | * to this module. So the user who wants to configure the preamble of a Basic, |
| MACRUM | 0:615f90842ce8 | 16 | * or a STack packet has to use the enumeration values defined here. |
| MACRUM | 0:615f90842ce8 | 17 | * |
| MACRUM | 0:615f90842ce8 | 18 | * <b>Example:</b> |
| MACRUM | 0:615f90842ce8 | 19 | * @code |
| MACRUM | 0:615f90842ce8 | 20 | * |
| MACRUM | 0:615f90842ce8 | 21 | * ... |
| MACRUM | 0:615f90842ce8 | 22 | * |
| MACRUM | 0:615f90842ce8 | 23 | * SpiritPktBasicSetPreambleLength(PKT_PREAMBLE_LENGTH_18BYTES); |
| MACRUM | 0:615f90842ce8 | 24 | * |
| MACRUM | 0:615f90842ce8 | 25 | * ... |
| MACRUM | 0:615f90842ce8 | 26 | * |
| MACRUM | 0:615f90842ce8 | 27 | * @endcode |
| MACRUM | 0:615f90842ce8 | 28 | * |
| MACRUM | 0:615f90842ce8 | 29 | * @note Is recommended for the user to not use these API directly |
| MACRUM | 0:615f90842ce8 | 30 | * importing this module in his application. |
| MACRUM | 0:615f90842ce8 | 31 | * |
| MACRUM | 0:615f90842ce8 | 32 | * |
| MACRUM | 0:615f90842ce8 | 33 | * @attention |
| MACRUM | 0:615f90842ce8 | 34 | * |
| MACRUM | 0:615f90842ce8 | 35 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> |
| MACRUM | 0:615f90842ce8 | 36 | * |
| MACRUM | 0:615f90842ce8 | 37 | * Redistribution and use in source and binary forms, with or without modification, |
| MACRUM | 0:615f90842ce8 | 38 | * are permitted provided that the following conditions are met: |
| MACRUM | 0:615f90842ce8 | 39 | * 1. Redistributions of source code must retain the above copyright notice, |
| MACRUM | 0:615f90842ce8 | 40 | * this list of conditions and the following disclaimer. |
| MACRUM | 0:615f90842ce8 | 41 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| MACRUM | 0:615f90842ce8 | 42 | * this list of conditions and the following disclaimer in the documentation |
| MACRUM | 0:615f90842ce8 | 43 | * and/or other materials provided with the distribution. |
| MACRUM | 0:615f90842ce8 | 44 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
| MACRUM | 0:615f90842ce8 | 45 | * may be used to endorse or promote products derived from this software |
| MACRUM | 0:615f90842ce8 | 46 | * without specific prior written permission. |
| MACRUM | 0:615f90842ce8 | 47 | * |
| MACRUM | 0:615f90842ce8 | 48 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| MACRUM | 0:615f90842ce8 | 49 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| MACRUM | 0:615f90842ce8 | 50 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| MACRUM | 0:615f90842ce8 | 51 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
| MACRUM | 0:615f90842ce8 | 52 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| MACRUM | 0:615f90842ce8 | 53 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| MACRUM | 0:615f90842ce8 | 54 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| MACRUM | 0:615f90842ce8 | 55 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| MACRUM | 0:615f90842ce8 | 56 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| MACRUM | 0:615f90842ce8 | 57 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| MACRUM | 0:615f90842ce8 | 58 | * |
| MACRUM | 0:615f90842ce8 | 59 | ****************************************************************************** |
| MACRUM | 0:615f90842ce8 | 60 | */ |
| MACRUM | 0:615f90842ce8 | 61 | |
| MACRUM | 0:615f90842ce8 | 62 | /* Define to prevent recursive inclusion -------------------------------------*/ |
| MACRUM | 0:615f90842ce8 | 63 | #ifndef __SPIRIT_PKT_COMMON_H |
| MACRUM | 0:615f90842ce8 | 64 | #define __SPIRIT_PKT_COMMON_H |
| MACRUM | 0:615f90842ce8 | 65 | |
| MACRUM | 0:615f90842ce8 | 66 | /* Includes ------------------------------------------------------------------*/ |
| MACRUM | 0:615f90842ce8 | 67 | |
| MACRUM | 0:615f90842ce8 | 68 | #include "SPIRIT_Regs.h" |
| MACRUM | 0:615f90842ce8 | 69 | #include "SPIRIT_Types.h" |
| MACRUM | 0:615f90842ce8 | 70 | |
| MACRUM | 0:615f90842ce8 | 71 | |
| MACRUM | 0:615f90842ce8 | 72 | #ifdef __cplusplus |
| MACRUM | 0:615f90842ce8 | 73 | extern "C" { |
| MACRUM | 0:615f90842ce8 | 74 | #endif |
| MACRUM | 0:615f90842ce8 | 75 | |
| MACRUM | 0:615f90842ce8 | 76 | |
| MACRUM | 0:615f90842ce8 | 77 | |
| MACRUM | 0:615f90842ce8 | 78 | /** |
| MACRUM | 0:615f90842ce8 | 79 | * @addtogroup SPIRIT_Libraries |
| MACRUM | 0:615f90842ce8 | 80 | * @{ |
| MACRUM | 0:615f90842ce8 | 81 | */ |
| MACRUM | 0:615f90842ce8 | 82 | |
| MACRUM | 0:615f90842ce8 | 83 | |
| MACRUM | 0:615f90842ce8 | 84 | /** |
| MACRUM | 0:615f90842ce8 | 85 | * @defgroup SPIRIT_PktCommon Pkt Common |
| MACRUM | 0:615f90842ce8 | 86 | * @brief Configuration and management of the common features of SPIRIT packets. |
| MACRUM | 0:615f90842ce8 | 87 | * @details See the file <i>@ref SPIRIT_PktCommon.h</i> for more details. |
| MACRUM | 0:615f90842ce8 | 88 | * @{ |
| MACRUM | 0:615f90842ce8 | 89 | */ |
| MACRUM | 0:615f90842ce8 | 90 | |
| MACRUM | 0:615f90842ce8 | 91 | /** |
| MACRUM | 0:615f90842ce8 | 92 | * @defgroup PktCommon_Exported_Types Pkt Common Exported Types |
| MACRUM | 0:615f90842ce8 | 93 | * @{ |
| MACRUM | 0:615f90842ce8 | 94 | */ |
| MACRUM | 0:615f90842ce8 | 95 | |
| MACRUM | 0:615f90842ce8 | 96 | |
| MACRUM | 0:615f90842ce8 | 97 | /** |
| MACRUM | 0:615f90842ce8 | 98 | * @brief Preamble length in bytes enumeration. |
| MACRUM | 0:615f90842ce8 | 99 | */ |
| MACRUM | 0:615f90842ce8 | 100 | typedef enum |
| MACRUM | 0:615f90842ce8 | 101 | { |
| MACRUM | 0:615f90842ce8 | 102 | PKT_PREAMBLE_LENGTH_01BYTE = 0x00, /*!< Preamble length 1 byte*/ |
| MACRUM | 0:615f90842ce8 | 103 | PKT_PREAMBLE_LENGTH_02BYTES = 0x08, /*!< Preamble length 2 bytes */ |
| MACRUM | 0:615f90842ce8 | 104 | PKT_PREAMBLE_LENGTH_03BYTES = 0x10, /*!< Preamble length 3 bytes */ |
| MACRUM | 0:615f90842ce8 | 105 | PKT_PREAMBLE_LENGTH_04BYTES = 0x18, /*!< Preamble length 4 bytes */ |
| MACRUM | 0:615f90842ce8 | 106 | PKT_PREAMBLE_LENGTH_05BYTES = 0x20, /*!< Preamble length 5 bytes */ |
| MACRUM | 0:615f90842ce8 | 107 | PKT_PREAMBLE_LENGTH_06BYTES = 0x28, /*!< Preamble length 6 bytes */ |
| MACRUM | 0:615f90842ce8 | 108 | PKT_PREAMBLE_LENGTH_07BYTES = 0x30, /*!< Preamble length 7 bytes */ |
| MACRUM | 0:615f90842ce8 | 109 | PKT_PREAMBLE_LENGTH_08BYTES = 0x38, /*!< Preamble length 8 bytes */ |
| MACRUM | 0:615f90842ce8 | 110 | PKT_PREAMBLE_LENGTH_09BYTES = 0x40, /*!< Preamble length 9 bytes */ |
| MACRUM | 0:615f90842ce8 | 111 | PKT_PREAMBLE_LENGTH_10BYTES = 0x48, /*!< Preamble length 10 bytes */ |
| MACRUM | 0:615f90842ce8 | 112 | PKT_PREAMBLE_LENGTH_11BYTES = 0x50, /*!< Preamble length 11 bytes */ |
| MACRUM | 0:615f90842ce8 | 113 | PKT_PREAMBLE_LENGTH_12BYTES = 0x58, /*!< Preamble length 12 bytes */ |
| MACRUM | 0:615f90842ce8 | 114 | PKT_PREAMBLE_LENGTH_13BYTES = 0x60, /*!< Preamble length 13 bytes */ |
| MACRUM | 0:615f90842ce8 | 115 | PKT_PREAMBLE_LENGTH_14BYTES = 0x68, /*!< Preamble length 14 bytes */ |
| MACRUM | 0:615f90842ce8 | 116 | PKT_PREAMBLE_LENGTH_15BYTES = 0x70, /*!< Preamble length 15 bytes */ |
| MACRUM | 0:615f90842ce8 | 117 | PKT_PREAMBLE_LENGTH_16BYTES = 0x78, /*!< Preamble length 16 bytes */ |
| MACRUM | 0:615f90842ce8 | 118 | PKT_PREAMBLE_LENGTH_17BYTES = 0x80, /*!< Preamble length 17 bytes */ |
| MACRUM | 0:615f90842ce8 | 119 | PKT_PREAMBLE_LENGTH_18BYTES = 0x88, /*!< Preamble length 18 bytes */ |
| MACRUM | 0:615f90842ce8 | 120 | PKT_PREAMBLE_LENGTH_19BYTES = 0x90, /*!< Preamble length 19 bytes */ |
| MACRUM | 0:615f90842ce8 | 121 | PKT_PREAMBLE_LENGTH_20BYTES = 0x98, /*!< Preamble length 20 bytes */ |
| MACRUM | 0:615f90842ce8 | 122 | PKT_PREAMBLE_LENGTH_21BYTES = 0xA0, /*!< Preamble length 21 bytes */ |
| MACRUM | 0:615f90842ce8 | 123 | PKT_PREAMBLE_LENGTH_22BYTES = 0xA8, /*!< Preamble length 22 bytes */ |
| MACRUM | 0:615f90842ce8 | 124 | PKT_PREAMBLE_LENGTH_23BYTES = 0xB0, /*!< Preamble length 23 bytes */ |
| MACRUM | 0:615f90842ce8 | 125 | PKT_PREAMBLE_LENGTH_24BYTES = 0xB8, /*!< Preamble length 24 bytes */ |
| MACRUM | 0:615f90842ce8 | 126 | PKT_PREAMBLE_LENGTH_25BYTES = 0xC0, /*!< Preamble length 25 bytes */ |
| MACRUM | 0:615f90842ce8 | 127 | PKT_PREAMBLE_LENGTH_26BYTES = 0xC8, /*!< Preamble length 26 bytes */ |
| MACRUM | 0:615f90842ce8 | 128 | PKT_PREAMBLE_LENGTH_27BYTES = 0xD0, /*!< Preamble length 27 bytes */ |
| MACRUM | 0:615f90842ce8 | 129 | PKT_PREAMBLE_LENGTH_28BYTES = 0xD8, /*!< Preamble length 28 bytes */ |
| MACRUM | 0:615f90842ce8 | 130 | PKT_PREAMBLE_LENGTH_29BYTES = 0xE0, /*!< Preamble length 29 bytes */ |
| MACRUM | 0:615f90842ce8 | 131 | PKT_PREAMBLE_LENGTH_30BYTES = 0xE8, /*!< Preamble length 30 bytes */ |
| MACRUM | 0:615f90842ce8 | 132 | PKT_PREAMBLE_LENGTH_31BYTES = 0xF0, /*!< Preamble length 31 bytes */ |
| MACRUM | 0:615f90842ce8 | 133 | PKT_PREAMBLE_LENGTH_32BYTES = 0xF8 /*!< Preamble length 32 bytes */ |
| MACRUM | 0:615f90842ce8 | 134 | |
| MACRUM | 0:615f90842ce8 | 135 | }PktPreambleLength; |
| MACRUM | 0:615f90842ce8 | 136 | |
| MACRUM | 0:615f90842ce8 | 137 | #define IS_PKT_PREAMBLE_LENGTH(LENGTH) ((LENGTH == PKT_PREAMBLE_LENGTH_01BYTE) || \ |
| MACRUM | 0:615f90842ce8 | 138 | (LENGTH == PKT_PREAMBLE_LENGTH_02BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 139 | (LENGTH == PKT_PREAMBLE_LENGTH_03BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 140 | (LENGTH == PKT_PREAMBLE_LENGTH_04BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 141 | (LENGTH == PKT_PREAMBLE_LENGTH_05BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 142 | (LENGTH == PKT_PREAMBLE_LENGTH_06BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 143 | (LENGTH == PKT_PREAMBLE_LENGTH_07BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 144 | (LENGTH == PKT_PREAMBLE_LENGTH_08BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 145 | (LENGTH == PKT_PREAMBLE_LENGTH_09BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 146 | (LENGTH == PKT_PREAMBLE_LENGTH_10BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 147 | (LENGTH == PKT_PREAMBLE_LENGTH_11BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 148 | (LENGTH == PKT_PREAMBLE_LENGTH_12BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 149 | (LENGTH == PKT_PREAMBLE_LENGTH_13BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 150 | (LENGTH == PKT_PREAMBLE_LENGTH_14BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 151 | (LENGTH == PKT_PREAMBLE_LENGTH_15BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 152 | (LENGTH == PKT_PREAMBLE_LENGTH_16BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 153 | (LENGTH == PKT_PREAMBLE_LENGTH_17BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 154 | (LENGTH == PKT_PREAMBLE_LENGTH_18BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 155 | (LENGTH == PKT_PREAMBLE_LENGTH_19BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 156 | (LENGTH == PKT_PREAMBLE_LENGTH_20BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 157 | (LENGTH == PKT_PREAMBLE_LENGTH_21BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 158 | (LENGTH == PKT_PREAMBLE_LENGTH_22BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 159 | (LENGTH == PKT_PREAMBLE_LENGTH_23BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 160 | (LENGTH == PKT_PREAMBLE_LENGTH_24BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 161 | (LENGTH == PKT_PREAMBLE_LENGTH_25BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 162 | (LENGTH == PKT_PREAMBLE_LENGTH_26BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 163 | (LENGTH == PKT_PREAMBLE_LENGTH_27BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 164 | (LENGTH == PKT_PREAMBLE_LENGTH_28BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 165 | (LENGTH == PKT_PREAMBLE_LENGTH_29BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 166 | (LENGTH == PKT_PREAMBLE_LENGTH_30BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 167 | (LENGTH == PKT_PREAMBLE_LENGTH_31BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 168 | (LENGTH == PKT_PREAMBLE_LENGTH_32BYTES)) |
| MACRUM | 0:615f90842ce8 | 169 | |
| MACRUM | 0:615f90842ce8 | 170 | |
| MACRUM | 0:615f90842ce8 | 171 | |
| MACRUM | 0:615f90842ce8 | 172 | /** |
| MACRUM | 0:615f90842ce8 | 173 | * @brief Sync length in bytes enumeration. |
| MACRUM | 0:615f90842ce8 | 174 | */ |
| MACRUM | 0:615f90842ce8 | 175 | typedef enum |
| MACRUM | 0:615f90842ce8 | 176 | { |
| MACRUM | 0:615f90842ce8 | 177 | PKT_SYNC_LENGTH_1BYTE = 0x00, /*!< Sync length 1 byte*/ |
| MACRUM | 0:615f90842ce8 | 178 | PKT_SYNC_LENGTH_2BYTES = 0x02, /*!< Sync length 2 bytes*/ |
| MACRUM | 0:615f90842ce8 | 179 | PKT_SYNC_LENGTH_3BYTES = 0x04, /*!< Sync length 3 bytes */ |
| MACRUM | 0:615f90842ce8 | 180 | PKT_SYNC_LENGTH_4BYTES = 0x06 , /*!< Sync length 4 bytes */ |
| MACRUM | 0:615f90842ce8 | 181 | |
| MACRUM | 0:615f90842ce8 | 182 | }PktSyncLength; |
| MACRUM | 0:615f90842ce8 | 183 | |
| MACRUM | 0:615f90842ce8 | 184 | #define IS_PKT_SYNC_LENGTH(LENGTH) ((LENGTH == PKT_SYNC_LENGTH_1BYTE) || \ |
| MACRUM | 0:615f90842ce8 | 185 | (LENGTH == PKT_SYNC_LENGTH_2BYTES)|| \ |
| MACRUM | 0:615f90842ce8 | 186 | (LENGTH == PKT_SYNC_LENGTH_3BYTES)|| \ |
| MACRUM | 0:615f90842ce8 | 187 | (LENGTH == PKT_SYNC_LENGTH_4BYTES)) |
| MACRUM | 0:615f90842ce8 | 188 | |
| MACRUM | 0:615f90842ce8 | 189 | |
| MACRUM | 0:615f90842ce8 | 190 | |
| MACRUM | 0:615f90842ce8 | 191 | /** |
| MACRUM | 0:615f90842ce8 | 192 | * @brief CRC length in bytes enumeration. |
| MACRUM | 0:615f90842ce8 | 193 | */ |
| MACRUM | 0:615f90842ce8 | 194 | typedef enum |
| MACRUM | 0:615f90842ce8 | 195 | { |
| MACRUM | 0:615f90842ce8 | 196 | PKT_NO_CRC = 0x00, /*!< No CRC */ |
| MACRUM | 0:615f90842ce8 | 197 | PKT_CRC_MODE_8BITS = 0x20, /*!< CRC length 8 bits - poly: 0x07 */ |
| MACRUM | 0:615f90842ce8 | 198 | PKT_CRC_MODE_16BITS_1 = 0x40, /*!< CRC length 16 bits - poly: 0x8005 */ |
| MACRUM | 0:615f90842ce8 | 199 | PKT_CRC_MODE_16BITS_2 = 0x60, /*!< CRC length 16 bits - poly: 0x1021 */ |
| MACRUM | 0:615f90842ce8 | 200 | PKT_CRC_MODE_24BITS = 0x80, /*!< CRC length 24 bits - poly: 0x864CFB */ |
| MACRUM | 0:615f90842ce8 | 201 | |
| MACRUM | 0:615f90842ce8 | 202 | }PktCrcMode; |
| MACRUM | 0:615f90842ce8 | 203 | |
| MACRUM | 0:615f90842ce8 | 204 | #define IS_PKT_CRC_MODE(MODE) ((MODE == PKT_NO_CRC) || \ |
| MACRUM | 0:615f90842ce8 | 205 | (MODE == PKT_CRC_MODE_8BITS) || \ |
| MACRUM | 0:615f90842ce8 | 206 | (MODE == PKT_CRC_MODE_16BITS_1) || \ |
| MACRUM | 0:615f90842ce8 | 207 | (MODE == PKT_CRC_MODE_16BITS_2) || \ |
| MACRUM | 0:615f90842ce8 | 208 | (MODE == PKT_CRC_MODE_24BITS)) |
| MACRUM | 0:615f90842ce8 | 209 | |
| MACRUM | 0:615f90842ce8 | 210 | |
| MACRUM | 0:615f90842ce8 | 211 | |
| MACRUM | 0:615f90842ce8 | 212 | /** |
| MACRUM | 0:615f90842ce8 | 213 | * @brief Fixed or variable payload length enumeration. |
| MACRUM | 0:615f90842ce8 | 214 | */ |
| MACRUM | 0:615f90842ce8 | 215 | typedef enum |
| MACRUM | 0:615f90842ce8 | 216 | { |
| MACRUM | 0:615f90842ce8 | 217 | PKT_LENGTH_FIX = 0x00, /*!< Fixed payload length */ |
| MACRUM | 0:615f90842ce8 | 218 | PKT_LENGTH_VAR = 0x01 /*!< Variable payload length */ |
| MACRUM | 0:615f90842ce8 | 219 | |
| MACRUM | 0:615f90842ce8 | 220 | }PktFixVarLength; |
| MACRUM | 0:615f90842ce8 | 221 | |
| MACRUM | 0:615f90842ce8 | 222 | #define IS_PKT_FIX_VAR_LENGTH(LENGTH) ((LENGTH == PKT_LENGTH_FIX) || \ |
| MACRUM | 0:615f90842ce8 | 223 | (LENGTH == PKT_LENGTH_VAR)) |
| MACRUM | 0:615f90842ce8 | 224 | |
| MACRUM | 0:615f90842ce8 | 225 | |
| MACRUM | 0:615f90842ce8 | 226 | /** |
| MACRUM | 0:615f90842ce8 | 227 | * @brief Control length in bytes enumeration for SPIRIT packets. |
| MACRUM | 0:615f90842ce8 | 228 | */ |
| MACRUM | 0:615f90842ce8 | 229 | typedef enum |
| MACRUM | 0:615f90842ce8 | 230 | { |
| MACRUM | 0:615f90842ce8 | 231 | PKT_CONTROL_LENGTH_0BYTES = 0x00, /*!< Control length 0 byte*/ |
| MACRUM | 0:615f90842ce8 | 232 | PKT_CONTROL_LENGTH_1BYTE, /*!< Control length 1 byte*/ |
| MACRUM | 0:615f90842ce8 | 233 | PKT_CONTROL_LENGTH_2BYTES, /*!< Control length 2 bytes*/ |
| MACRUM | 0:615f90842ce8 | 234 | PKT_CONTROL_LENGTH_3BYTES, /*!< Control length 3 bytes*/ |
| MACRUM | 0:615f90842ce8 | 235 | PKT_CONTROL_LENGTH_4BYTES /*!< Control length 4 bytes*/ |
| MACRUM | 0:615f90842ce8 | 236 | |
| MACRUM | 0:615f90842ce8 | 237 | }PktControlLength; |
| MACRUM | 0:615f90842ce8 | 238 | |
| MACRUM | 0:615f90842ce8 | 239 | #define IS_PKT_CONTROL_LENGTH(LENGTH) ((LENGTH == PKT_CONTROL_LENGTH_0BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 240 | (LENGTH == PKT_CONTROL_LENGTH_1BYTE) || \ |
| MACRUM | 0:615f90842ce8 | 241 | (LENGTH == PKT_CONTROL_LENGTH_2BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 242 | (LENGTH == PKT_CONTROL_LENGTH_3BYTES) || \ |
| MACRUM | 0:615f90842ce8 | 243 | (LENGTH == PKT_CONTROL_LENGTH_4BYTES)) |
| MACRUM | 0:615f90842ce8 | 244 | |
| MACRUM | 0:615f90842ce8 | 245 | /** |
| MACRUM | 0:615f90842ce8 | 246 | * @brief Sync words enumeration for SPIRIT packets. |
| MACRUM | 0:615f90842ce8 | 247 | */ |
| MACRUM | 0:615f90842ce8 | 248 | typedef enum |
| MACRUM | 0:615f90842ce8 | 249 | { |
| MACRUM | 0:615f90842ce8 | 250 | PKT_SYNC_WORD_1=0x01, /*!< Index of the 1st sync word*/ |
| MACRUM | 0:615f90842ce8 | 251 | PKT_SYNC_WORD_2, /*!< Index of the 2nd sync word*/ |
| MACRUM | 0:615f90842ce8 | 252 | PKT_SYNC_WORD_3, /*!< Index of the 3rd sync word*/ |
| MACRUM | 0:615f90842ce8 | 253 | PKT_SYNC_WORD_4 /*!< Index of the 4th sync word*/ |
| MACRUM | 0:615f90842ce8 | 254 | |
| MACRUM | 0:615f90842ce8 | 255 | }PktSyncX; |
| MACRUM | 0:615f90842ce8 | 256 | |
| MACRUM | 0:615f90842ce8 | 257 | #define IS_PKT_SYNCx(WORD) ((WORD == PKT_SYNC_WORD_1) || \ |
| MACRUM | 0:615f90842ce8 | 258 | (WORD == PKT_SYNC_WORD_2) || \ |
| MACRUM | 0:615f90842ce8 | 259 | (WORD == PKT_SYNC_WORD_3) || \ |
| MACRUM | 0:615f90842ce8 | 260 | (WORD == PKT_SYNC_WORD_4)) |
| MACRUM | 0:615f90842ce8 | 261 | |
| MACRUM | 0:615f90842ce8 | 262 | |
| MACRUM | 0:615f90842ce8 | 263 | |
| MACRUM | 0:615f90842ce8 | 264 | /** |
| MACRUM | 0:615f90842ce8 | 265 | * @brief Max retransmissions number enumeration for SPIRIT packets. |
| MACRUM | 0:615f90842ce8 | 266 | */ |
| MACRUM | 0:615f90842ce8 | 267 | typedef enum |
| MACRUM | 0:615f90842ce8 | 268 | { |
| MACRUM | 0:615f90842ce8 | 269 | PKT_DISABLE_RETX = 0x00, /*!< No retrasmissions*/ |
| MACRUM | 0:615f90842ce8 | 270 | PKT_N_RETX_1 = 0x10, /*!< Max retrasmissions 1*/ |
| MACRUM | 0:615f90842ce8 | 271 | PKT_N_RETX_2 = 0x20, /*!< Max retrasmissions 2*/ |
| MACRUM | 0:615f90842ce8 | 272 | PKT_N_RETX_3 = 0x30, /*!< Max retrasmissions 3*/ |
| MACRUM | 0:615f90842ce8 | 273 | PKT_N_RETX_4 = 0x40, /*!< Max retrasmissions 4*/ |
| MACRUM | 0:615f90842ce8 | 274 | PKT_N_RETX_5 = 0x50, /*!< Max retrasmissions 5*/ |
| MACRUM | 0:615f90842ce8 | 275 | PKT_N_RETX_6 = 0x60, /*!< Max retrasmissions 6*/ |
| MACRUM | 0:615f90842ce8 | 276 | PKT_N_RETX_7 = 0x70, /*!< Max retrasmissions 7*/ |
| MACRUM | 0:615f90842ce8 | 277 | PKT_N_RETX_8 = 0x80, /*!< Max retrasmissions 8*/ |
| MACRUM | 0:615f90842ce8 | 278 | PKT_N_RETX_9 = 0x90, /*!< Max retrasmissions 9*/ |
| MACRUM | 0:615f90842ce8 | 279 | PKT_N_RETX_10 = 0xA0, /*!< Max retrasmissions 10*/ |
| MACRUM | 0:615f90842ce8 | 280 | PKT_N_RETX_11 = 0xB0, /*!< Max retrasmissions 11*/ |
| MACRUM | 0:615f90842ce8 | 281 | PKT_N_RETX_12 = 0xC0, /*!< Max retrasmissions 12*/ |
| MACRUM | 0:615f90842ce8 | 282 | PKT_N_RETX_13 = 0xD0, /*!< Max retrasmissions 13*/ |
| MACRUM | 0:615f90842ce8 | 283 | PKT_N_RETX_14 = 0xE0, /*!< Max retrasmissions 14*/ |
| MACRUM | 0:615f90842ce8 | 284 | PKT_N_RETX_15 = 0xF0 /*!< Max retrasmissions 15*/ |
| MACRUM | 0:615f90842ce8 | 285 | |
| MACRUM | 0:615f90842ce8 | 286 | }PktNMaxReTx; |
| MACRUM | 0:615f90842ce8 | 287 | |
| MACRUM | 0:615f90842ce8 | 288 | #define IS_PKT_NMAX_RETX(N_RETX) ((N_RETX == PKT_DISABLE_RETX) || \ |
| MACRUM | 0:615f90842ce8 | 289 | (N_RETX == PKT_N_RETX_1) || \ |
| MACRUM | 0:615f90842ce8 | 290 | (N_RETX == PKT_N_RETX_2) || \ |
| MACRUM | 0:615f90842ce8 | 291 | (N_RETX == PKT_N_RETX_3) || \ |
| MACRUM | 0:615f90842ce8 | 292 | (N_RETX == PKT_N_RETX_4) || \ |
| MACRUM | 0:615f90842ce8 | 293 | (N_RETX == PKT_N_RETX_5) || \ |
| MACRUM | 0:615f90842ce8 | 294 | (N_RETX == PKT_N_RETX_6) || \ |
| MACRUM | 0:615f90842ce8 | 295 | (N_RETX == PKT_N_RETX_7) || \ |
| MACRUM | 0:615f90842ce8 | 296 | (N_RETX == PKT_N_RETX_8) || \ |
| MACRUM | 0:615f90842ce8 | 297 | (N_RETX == PKT_N_RETX_9) || \ |
| MACRUM | 0:615f90842ce8 | 298 | (N_RETX == PKT_N_RETX_10) || \ |
| MACRUM | 0:615f90842ce8 | 299 | (N_RETX == PKT_N_RETX_11) || \ |
| MACRUM | 0:615f90842ce8 | 300 | (N_RETX == PKT_N_RETX_12) || \ |
| MACRUM | 0:615f90842ce8 | 301 | (N_RETX == PKT_N_RETX_13) || \ |
| MACRUM | 0:615f90842ce8 | 302 | (N_RETX == PKT_N_RETX_14) || \ |
| MACRUM | 0:615f90842ce8 | 303 | (N_RETX == PKT_N_RETX_15)) |
| MACRUM | 0:615f90842ce8 | 304 | |
| MACRUM | 0:615f90842ce8 | 305 | |
| MACRUM | 0:615f90842ce8 | 306 | /** |
| MACRUM | 0:615f90842ce8 | 307 | *@} |
| MACRUM | 0:615f90842ce8 | 308 | */ |
| MACRUM | 0:615f90842ce8 | 309 | |
| MACRUM | 0:615f90842ce8 | 310 | |
| MACRUM | 0:615f90842ce8 | 311 | /** |
| MACRUM | 0:615f90842ce8 | 312 | * @defgroup PktCommon_Exported_Constants Pkt Common Exported Constants |
| MACRUM | 0:615f90842ce8 | 313 | * @{ |
| MACRUM | 0:615f90842ce8 | 314 | */ |
| MACRUM | 0:615f90842ce8 | 315 | |
| MACRUM | 0:615f90842ce8 | 316 | #define IS_PKT_LENGTH_WIDTH_BITS(BITS) (BITS<=16) |
| MACRUM | 0:615f90842ce8 | 317 | #define IS_PKT_SEQ_NUMBER_RELOAD(SEQN) (SEQN<=3) |
| MACRUM | 0:615f90842ce8 | 318 | |
| MACRUM | 0:615f90842ce8 | 319 | /** |
| MACRUM | 0:615f90842ce8 | 320 | *@} |
| MACRUM | 0:615f90842ce8 | 321 | */ |
| MACRUM | 0:615f90842ce8 | 322 | |
| MACRUM | 0:615f90842ce8 | 323 | |
| MACRUM | 0:615f90842ce8 | 324 | /** |
| MACRUM | 0:615f90842ce8 | 325 | * @defgroup PktCommon_Exported_Macros Pkt Common Exported Macros |
| MACRUM | 0:615f90842ce8 | 326 | * @{ |
| MACRUM | 0:615f90842ce8 | 327 | */ |
| MACRUM | 0:615f90842ce8 | 328 | |
| MACRUM | 0:615f90842ce8 | 329 | |
| MACRUM | 0:615f90842ce8 | 330 | /** |
| MACRUM | 0:615f90842ce8 | 331 | * @brief Macro used to compute the lower part of the packet length, to write in the PCKTLEN0 register |
| MACRUM | 0:615f90842ce8 | 332 | * @param nLength Length of the packet payload. |
| MACRUM | 0:615f90842ce8 | 333 | * This parameter is an uint16_t. |
| MACRUM | 0:615f90842ce8 | 334 | * @retval None. |
| MACRUM | 0:615f90842ce8 | 335 | */ |
| MACRUM | 0:615f90842ce8 | 336 | #define BUILD_PCKTLEN0(nLength) ((nLength) & 0xFF) |
| MACRUM | 0:615f90842ce8 | 337 | |
| MACRUM | 0:615f90842ce8 | 338 | |
| MACRUM | 0:615f90842ce8 | 339 | /** |
| MACRUM | 0:615f90842ce8 | 340 | * @brief Macro used to compute the upper part of the packet length, to write the PCKTLEN1 register |
| MACRUM | 0:615f90842ce8 | 341 | * @param nLength Length of the packet payload. |
| MACRUM | 0:615f90842ce8 | 342 | * This parameter is an uint16_t. |
| MACRUM | 0:615f90842ce8 | 343 | * @retval None. |
| MACRUM | 0:615f90842ce8 | 344 | */ |
| MACRUM | 0:615f90842ce8 | 345 | #define BUILD_PCKTLEN1(nLength) ((nLength) >> 8) |
| MACRUM | 0:615f90842ce8 | 346 | |
| MACRUM | 0:615f90842ce8 | 347 | /** |
| MACRUM | 0:615f90842ce8 | 348 | *@} |
| MACRUM | 0:615f90842ce8 | 349 | */ |
| MACRUM | 0:615f90842ce8 | 350 | |
| MACRUM | 0:615f90842ce8 | 351 | |
| MACRUM | 0:615f90842ce8 | 352 | /** |
| MACRUM | 0:615f90842ce8 | 353 | * @defgroup PktCommon_Exported_Functions Pkt Common Exported Functions |
| MACRUM | 0:615f90842ce8 | 354 | * @{ |
| MACRUM | 0:615f90842ce8 | 355 | */ |
| MACRUM | 0:615f90842ce8 | 356 | |
| MACRUM | 0:615f90842ce8 | 357 | void SpiritPktCommonSetControlLength(PktControlLength xControlLength); |
| MACRUM | 0:615f90842ce8 | 358 | uint8_t SpiritPktCommonGetControlLength(void); |
| MACRUM | 0:615f90842ce8 | 359 | void SpiritPktCommonSetPreambleLength(PktPreambleLength xPreambleLength); |
| MACRUM | 0:615f90842ce8 | 360 | uint8_t SpiritPktCommonGetPreambleLength(void); |
| MACRUM | 0:615f90842ce8 | 361 | void SpiritPktCommonSetSyncLength(PktSyncLength xSyncLength); |
| MACRUM | 0:615f90842ce8 | 362 | uint8_t SpiritPktCommonGetSyncLength(void); |
| MACRUM | 0:615f90842ce8 | 363 | void SpiritPktCommonSetFixVarLength(PktFixVarLength xFixVarLength); |
| MACRUM | 0:615f90842ce8 | 364 | void SpiritPktCommonFilterOnCrc(SpiritFunctionalState xNewState); |
| MACRUM | 0:615f90842ce8 | 365 | SpiritFunctionalState SpiritPktCommonGetFilterOnCrc(void); |
| MACRUM | 0:615f90842ce8 | 366 | void SpiritPktCommonSetCrcMode(PktCrcMode xCrcLength); |
| MACRUM | 0:615f90842ce8 | 367 | PktCrcMode SpiritPktCommonGetCrcMode(void); |
| MACRUM | 0:615f90842ce8 | 368 | void SpiritPktCommonWhitening(SpiritFunctionalState xNewState); |
| MACRUM | 0:615f90842ce8 | 369 | void SpiritPktCommonFec(SpiritFunctionalState xNewState); |
| MACRUM | 0:615f90842ce8 | 370 | void SpiritPktCommonSetSyncxWord(PktSyncX xSyncX, uint8_t cSyncWord); |
| MACRUM | 0:615f90842ce8 | 371 | uint8_t SpiritPktCommonGetSyncxWord(PktSyncX xSyncX); |
| MACRUM | 0:615f90842ce8 | 372 | void SpiritPktCommonSetSyncWords(uint32_t lSyncWords, PktSyncLength xSyncLength); |
| MACRUM | 0:615f90842ce8 | 373 | uint32_t SpiritPktCommonGetSyncWords(PktSyncLength xSyncLength); |
| MACRUM | 0:615f90842ce8 | 374 | uint8_t SpiritPktCommonGetVarLengthWidth(void); |
| MACRUM | 0:615f90842ce8 | 375 | void SpiritPktCommonSetDestinationAddress(uint8_t cAddress); |
| MACRUM | 0:615f90842ce8 | 376 | uint8_t SpiritPktCommonGetTransmittedDestAddress(void); |
| MACRUM | 0:615f90842ce8 | 377 | void SpiritPktCommonSetMyAddress(uint8_t cAddress); |
| MACRUM | 0:615f90842ce8 | 378 | uint8_t SpiritPktCommonGetMyAddress(void); |
| MACRUM | 0:615f90842ce8 | 379 | void SpiritPktCommonSetBroadcastAddress(uint8_t cAddress); |
| MACRUM | 0:615f90842ce8 | 380 | uint8_t SpiritPktCommonGetBroadcastAddress(void); |
| MACRUM | 0:615f90842ce8 | 381 | SpiritFunctionalState SpiritPktCommonGetTxAckRequest(void); |
| MACRUM | 0:615f90842ce8 | 382 | void SpiritPktCommonSetMulticastAddress(uint8_t cAddress); |
| MACRUM | 0:615f90842ce8 | 383 | uint8_t SpiritPktCommonGetMulticastAddress(void); |
| MACRUM | 0:615f90842ce8 | 384 | void SpiritPktCommonSetCtrlMask(uint32_t lMask); |
| MACRUM | 0:615f90842ce8 | 385 | uint32_t SpiritPktCommonGetCtrlMask(void); |
| MACRUM | 0:615f90842ce8 | 386 | void SpiritPktCommonSetCtrlReference(uint32_t lReference); |
| MACRUM | 0:615f90842ce8 | 387 | uint32_t SpiritPktCommonGetCtrlReference(void); |
| MACRUM | 0:615f90842ce8 | 388 | void SpiritPktCommonSetTransmittedCtrlField(uint32_t lField); |
| MACRUM | 0:615f90842ce8 | 389 | uint32_t SpiritPktCommonGetTransmittedCtrlField(void); |
| MACRUM | 0:615f90842ce8 | 390 | void SpiritPktCommonFilterOnMyAddress(SpiritFunctionalState xNewState); |
| MACRUM | 0:615f90842ce8 | 391 | void SpiritPktCommonFilterOnMulticastAddress(SpiritFunctionalState xNewState); |
| MACRUM | 0:615f90842ce8 | 392 | void SpiritPktCommonFilterOnBroadcastAddress(SpiritFunctionalState xNewState); |
| MACRUM | 0:615f90842ce8 | 393 | SpiritFunctionalState SpiritPktCommonGetFilterOnMyAddress(void); |
| MACRUM | 0:615f90842ce8 | 394 | SpiritFunctionalState SpiritPktCommonGetFilterOnMulticastAddress(void); |
| MACRUM | 0:615f90842ce8 | 395 | SpiritFunctionalState SpiritPktCommonGetFilterOnBroadcastAddress(void); |
| MACRUM | 0:615f90842ce8 | 396 | uint8_t SpiritPktCommonGetReceivedDestAddress(void); |
| MACRUM | 0:615f90842ce8 | 397 | uint32_t SpiritPktCommonGetReceivedCtrlField(void); |
| MACRUM | 0:615f90842ce8 | 398 | void SpiritPktCommonGetReceivedCrcField(uint8_t* cCrcFieldVect); |
| MACRUM | 0:615f90842ce8 | 399 | void SpiritPktCommonAutoAck(SpiritFunctionalState xAutoAck,SpiritFunctionalState xPiggybacking); |
| MACRUM | 0:615f90842ce8 | 400 | void SpiritPktCommonRequireAck(SpiritFunctionalState xRequireAck); |
| MACRUM | 0:615f90842ce8 | 401 | void SpiritPktCommonSetTransmittedSeqNumberReload(uint8_t cSeqNumberReload); |
| MACRUM | 0:615f90842ce8 | 402 | void SpiritPktCommonSetNMaxReTx(PktNMaxReTx xNMaxReTx); |
| MACRUM | 0:615f90842ce8 | 403 | uint8_t SpiritPktCommonGetNMaxReTx(void); |
| MACRUM | 0:615f90842ce8 | 404 | uint8_t SpiritPktCommonGetReceivedDestAddress(void); |
| MACRUM | 0:615f90842ce8 | 405 | uint8_t SpiritPktCommonGetReceivedSourceAddress(void); |
| MACRUM | 0:615f90842ce8 | 406 | uint8_t SpiritPktCommonGetReceivedSeqNumber(void); |
| MACRUM | 0:615f90842ce8 | 407 | uint8_t SpiritPktCommonGetReceivedNackRx(void); |
| MACRUM | 0:615f90842ce8 | 408 | uint8_t SpiritPktCommonGetTransmittedSeqNumber(void); |
| MACRUM | 0:615f90842ce8 | 409 | uint8_t SpiritPktCommonGetNReTx(void); |
| MACRUM | 0:615f90842ce8 | 410 | void SpiritPktCommonFilterOnControlField(SpiritFunctionalState xNewState); |
| MACRUM | 0:615f90842ce8 | 411 | SpiritFunctionalState SpiritPktCommonGetFilterOnControlField(void); |
| MACRUM | 0:615f90842ce8 | 412 | |
| MACRUM | 0:615f90842ce8 | 413 | /** |
| MACRUM | 0:615f90842ce8 | 414 | *@} |
| MACRUM | 0:615f90842ce8 | 415 | */ |
| MACRUM | 0:615f90842ce8 | 416 | |
| MACRUM | 0:615f90842ce8 | 417 | /** |
| MACRUM | 0:615f90842ce8 | 418 | *@} |
| MACRUM | 0:615f90842ce8 | 419 | */ |
| MACRUM | 0:615f90842ce8 | 420 | |
| MACRUM | 0:615f90842ce8 | 421 | |
| MACRUM | 0:615f90842ce8 | 422 | /** |
| MACRUM | 0:615f90842ce8 | 423 | *@} |
| MACRUM | 0:615f90842ce8 | 424 | */ |
| MACRUM | 0:615f90842ce8 | 425 | |
| MACRUM | 0:615f90842ce8 | 426 | #ifdef __cplusplus |
| MACRUM | 0:615f90842ce8 | 427 | } |
| MACRUM | 0:615f90842ce8 | 428 | #endif |
| MACRUM | 0:615f90842ce8 | 429 | |
| MACRUM | 0:615f90842ce8 | 430 | #endif |
| MACRUM | 0:615f90842ce8 | 431 | |
| MACRUM | 0:615f90842ce8 | 432 | /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/ |