Jim Flynn / Mbed OS wifi_Example

wifi test

Dependencies:   X_NUCLEO_IKS01A2 mbed-http

easy-connect/stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_PktCommon.h@0:24d3eb812fd4, 2018-09-05 (annotated)

Committer:
JMF
Date:
Wed Sep 05 14:28:24 2018 +0000
Revision:
0:24d3eb812fd4
Initial commit

Who changed what in which revision?

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