ST / stm-spirit1-rf-driver

Prototype RF driver for STM Sub-1 GHz RF expansion board based on the SPSGRF-868 module for STM32 Nucleo.

Prototype RF Driver for STM Sub-1 GHz RF Expansion Boards based on the SPSGRF-868 and SPSGRF-915 Modules for STM32 Nucleo

Currently supported boards:

Note, in order to use expansion board X-NUCLEO-IDS01A4 in mbed you need to perform the following HW modifications on the board:

  • Unmount resistor R4
  • Mount resistor R7

Furthermore, on some Nucleo development boards (e.g. the NUCLEO_F429ZI), in order to be able to use Ethernet together with these Sub-1 GHz RF expansion boards, you need to compile this driver with macro SPIRIT1_SPI_MOSI=PB_5 defined, while the development board typically requires some HW modification as e.g. described here!

This driver can be used together with the 6LoWPAN stack (a.k.a. Nanostack).

source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_PktCommon.h@34:edda6a7238ec, 2016-11-22 (annotated)

Committer:
Wolfgang Betz
Date:
Tue Nov 22 11:40:10 2016 +0100
Revision:
34:edda6a7238ec
Child:
67:93bec0baf1de
Perform re-naming

Who changed what in which revision?

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