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/Src/SPIRIT_PktStack.c@67:93bec0baf1de, 2017-07-06 (annotated)

Committer:
Wolfgang Betz
Date:
Thu Jul 06 11:13:31 2017 +0200
Revision:
67:93bec0baf1de
Parent:
34:edda6a7238ec 
Clarify some comments

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 67:93bec0baf1de 1 /**
Wolfgang Betz 67:93bec0baf1de 2 ******************************************************************************
Wolfgang Betz 67:93bec0baf1de 3 * @file SPIRIT_PktStack.c
Wolfgang Betz 67:93bec0baf1de 4 * @author VMA division - AMS
Wolfgang Betz 67:93bec0baf1de 5 * @version 3.2.2
Wolfgang Betz 67:93bec0baf1de 6 * @date 08-July-2015
Wolfgang Betz 67:93bec0baf1de 7 * @brief Configuration and management of SPIRIT STack packets.
Wolfgang Betz 67:93bec0baf1de 8 * @details
Wolfgang Betz 67:93bec0baf1de 9 *
Wolfgang Betz 67:93bec0baf1de 10 * @attention
Wolfgang Betz 67:93bec0baf1de 11 *
Wolfgang Betz 67:93bec0baf1de 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 67:93bec0baf1de 13 *
Wolfgang Betz 67:93bec0baf1de 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 67:93bec0baf1de 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 67:93bec0baf1de 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 67:93bec0baf1de 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 67:93bec0baf1de 20 * and/or other materials provided with the distribution.
Wolfgang Betz 67:93bec0baf1de 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 67:93bec0baf1de 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 67:93bec0baf1de 23 * without specific prior written permission.
Wolfgang Betz 67:93bec0baf1de 24 *
Wolfgang Betz 67:93bec0baf1de 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 67:93bec0baf1de 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 67:93bec0baf1de 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 67:93bec0baf1de 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 67:93bec0baf1de 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 67:93bec0baf1de 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 67:93bec0baf1de 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 67:93bec0baf1de 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 67:93bec0baf1de 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 67:93bec0baf1de 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 67:93bec0baf1de 35 *
Wolfgang Betz 67:93bec0baf1de 36 ******************************************************************************
Wolfgang Betz 67:93bec0baf1de 37 */
Wolfgang Betz 67:93bec0baf1de 38
Wolfgang Betz 67:93bec0baf1de 39 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 67:93bec0baf1de 40 #include "SPIRIT_PktStack.h"
Wolfgang Betz 67:93bec0baf1de 41 #include "MCU_Interface.h"
Wolfgang Betz 67:93bec0baf1de 42
Wolfgang Betz 67:93bec0baf1de 43
Wolfgang Betz 67:93bec0baf1de 44 /**
Wolfgang Betz 67:93bec0baf1de 45 * @addtogroup SPIRIT_Libraries
Wolfgang Betz 67:93bec0baf1de 46 * @{
Wolfgang Betz 67:93bec0baf1de 47 */
Wolfgang Betz 67:93bec0baf1de 48
Wolfgang Betz 67:93bec0baf1de 49
Wolfgang Betz 67:93bec0baf1de 50 /**
Wolfgang Betz 67:93bec0baf1de 51 * @addtogroup SPIRIT_PktStack
Wolfgang Betz 67:93bec0baf1de 52 * @{
Wolfgang Betz 67:93bec0baf1de 53 */
Wolfgang Betz 67:93bec0baf1de 54
Wolfgang Betz 67:93bec0baf1de 55
Wolfgang Betz 67:93bec0baf1de 56 /**
Wolfgang Betz 67:93bec0baf1de 57 * @defgroup PktStack_Private_TypesDefinitions Pkt STack Private Types Definitions
Wolfgang Betz 67:93bec0baf1de 58 * @{
Wolfgang Betz 67:93bec0baf1de 59 */
Wolfgang Betz 67:93bec0baf1de 60
Wolfgang Betz 67:93bec0baf1de 61 /**
Wolfgang Betz 67:93bec0baf1de 62 *@}
Wolfgang Betz 67:93bec0baf1de 63 */
Wolfgang Betz 67:93bec0baf1de 64
Wolfgang Betz 67:93bec0baf1de 65
Wolfgang Betz 67:93bec0baf1de 66 /**
Wolfgang Betz 67:93bec0baf1de 67 * @defgroup PktStack_Private_Defines Pkt STack Private Defines
Wolfgang Betz 67:93bec0baf1de 68 * @{
Wolfgang Betz 67:93bec0baf1de 69 */
Wolfgang Betz 67:93bec0baf1de 70
Wolfgang Betz 67:93bec0baf1de 71 /**
Wolfgang Betz 67:93bec0baf1de 72 *@}
Wolfgang Betz 67:93bec0baf1de 73 */
Wolfgang Betz 67:93bec0baf1de 74
Wolfgang Betz 67:93bec0baf1de 75
Wolfgang Betz 67:93bec0baf1de 76 /**
Wolfgang Betz 67:93bec0baf1de 77 * @defgroup PktStack_Private_Macros Pkt STack Private Macros
Wolfgang Betz 67:93bec0baf1de 78 * @{
Wolfgang Betz 67:93bec0baf1de 79 */
Wolfgang Betz 67:93bec0baf1de 80
Wolfgang Betz 67:93bec0baf1de 81 /**
Wolfgang Betz 67:93bec0baf1de 82 *@}
Wolfgang Betz 67:93bec0baf1de 83 */
Wolfgang Betz 67:93bec0baf1de 84
Wolfgang Betz 67:93bec0baf1de 85
Wolfgang Betz 67:93bec0baf1de 86 /**
Wolfgang Betz 67:93bec0baf1de 87 * @defgroup PktStack_Private_Variables Pkt STack Private Variables
Wolfgang Betz 67:93bec0baf1de 88 * @{
Wolfgang Betz 67:93bec0baf1de 89 */
Wolfgang Betz 67:93bec0baf1de 90
Wolfgang Betz 67:93bec0baf1de 91 /**
Wolfgang Betz 67:93bec0baf1de 92 *@}
Wolfgang Betz 67:93bec0baf1de 93 */
Wolfgang Betz 67:93bec0baf1de 94
Wolfgang Betz 67:93bec0baf1de 95
Wolfgang Betz 67:93bec0baf1de 96 /**
Wolfgang Betz 67:93bec0baf1de 97 * @defgroup PktStack_Private_FunctionPrototypes Pkt STack Private Function Prototypes
Wolfgang Betz 67:93bec0baf1de 98 * @{
Wolfgang Betz 67:93bec0baf1de 99 */
Wolfgang Betz 67:93bec0baf1de 100
Wolfgang Betz 67:93bec0baf1de 101 /**
Wolfgang Betz 67:93bec0baf1de 102 *@}
Wolfgang Betz 67:93bec0baf1de 103 */
Wolfgang Betz 67:93bec0baf1de 104
Wolfgang Betz 67:93bec0baf1de 105
Wolfgang Betz 67:93bec0baf1de 106 /**
Wolfgang Betz 67:93bec0baf1de 107 * @defgroup PktStack_Private_Functions Pkt STack Private Functions
Wolfgang Betz 67:93bec0baf1de 108 * @{
Wolfgang Betz 67:93bec0baf1de 109 */
Wolfgang Betz 67:93bec0baf1de 110
Wolfgang Betz 67:93bec0baf1de 111
Wolfgang Betz 67:93bec0baf1de 112 /**
Wolfgang Betz 67:93bec0baf1de 113 * @brief Initializes the SPIRIT STack packet according to the specified
Wolfgang Betz 67:93bec0baf1de 114 * parameters in the PktStackInit.
Wolfgang Betz 67:93bec0baf1de 115 * @param pxPktStackInit STack packet init structure.
Wolfgang Betz 67:93bec0baf1de 116 * This parameter is a pointer to @ref PktStackInit.
Wolfgang Betz 67:93bec0baf1de 117 * @retval None.
Wolfgang Betz 67:93bec0baf1de 118 */
Wolfgang Betz 67:93bec0baf1de 119 void SpiritPktStackInit(PktStackInit* pxPktStackInit)
Wolfgang Betz 67:93bec0baf1de 120 {
Wolfgang Betz 67:93bec0baf1de 121 uint8_t tempRegValue[4], i;
Wolfgang Betz 67:93bec0baf1de 122
Wolfgang Betz 67:93bec0baf1de 123 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 124 s_assert_param(IS_STACK_PREAMBLE_LENGTH(pxPktStackInit->xPreambleLength));
Wolfgang Betz 67:93bec0baf1de 125 s_assert_param(IS_STACK_SYNC_LENGTH(pxPktStackInit->xSyncLength));
Wolfgang Betz 67:93bec0baf1de 126 s_assert_param(IS_STACK_CRC_MODE(pxPktStackInit->xCrcMode));
Wolfgang Betz 67:93bec0baf1de 127 s_assert_param(IS_STACK_LENGTH_WIDTH_BITS(pxPktStackInit->cPktLengthWidth));
Wolfgang Betz 67:93bec0baf1de 128 s_assert_param(IS_STACK_FIX_VAR_LENGTH(pxPktStackInit->xFixVarLength));
Wolfgang Betz 67:93bec0baf1de 129 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(pxPktStackInit->xFec));
Wolfgang Betz 67:93bec0baf1de 130 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(pxPktStackInit->xDataWhitening));
Wolfgang Betz 67:93bec0baf1de 131 s_assert_param(IS_STACK_CONTROL_LENGTH(pxPktStackInit->xControlLength));
Wolfgang Betz 67:93bec0baf1de 132
Wolfgang Betz 67:93bec0baf1de 133
Wolfgang Betz 67:93bec0baf1de 134 /* Reads the PROTOCOL1 register */
Wolfgang Betz 67:93bec0baf1de 135 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue[0]);
Wolfgang Betz 67:93bec0baf1de 136
Wolfgang Betz 67:93bec0baf1de 137 /* Mask a reserved bit */
Wolfgang Betz 67:93bec0baf1de 138 tempRegValue[0] &= ~0x20;
Wolfgang Betz 67:93bec0baf1de 139
Wolfgang Betz 67:93bec0baf1de 140 /* Always (!) set the automatic packet filtering */
Wolfgang Betz 67:93bec0baf1de 141 tempRegValue[0] |= PROTOCOL1_AUTO_PCKT_FLT_MASK;
Wolfgang Betz 67:93bec0baf1de 142
Wolfgang Betz 67:93bec0baf1de 143 /* Writes the value on register */
Wolfgang Betz 67:93bec0baf1de 144 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 1, &tempRegValue[0]);
Wolfgang Betz 67:93bec0baf1de 145
Wolfgang Betz 67:93bec0baf1de 146 /* Reads the PCKT_FLT_OPTIONS register */
Wolfgang Betz 67:93bec0baf1de 147 g_xStatus = SpiritSpiReadRegisters(PCKT_FLT_OPTIONS_BASE, 1, &tempRegValue[0]);
Wolfgang Betz 67:93bec0baf1de 148
Wolfgang Betz 67:93bec0baf1de 149 /* Always reset the control and source filtering */
Wolfgang Betz 67:93bec0baf1de 150 tempRegValue[0] &= ~(PCKT_FLT_OPTIONS_SOURCE_FILTERING_MASK | PCKT_FLT_OPTIONS_CONTROL_FILTERING_MASK);
Wolfgang Betz 67:93bec0baf1de 151
Wolfgang Betz 67:93bec0baf1de 152 /* Writes the value on register */
Wolfgang Betz 67:93bec0baf1de 153 g_xStatus = SpiritSpiWriteRegisters(PCKT_FLT_OPTIONS_BASE, 1, &tempRegValue[0]);
Wolfgang Betz 67:93bec0baf1de 154
Wolfgang Betz 67:93bec0baf1de 155
Wolfgang Betz 67:93bec0baf1de 156 /* Address and control length setting: source and destination address are always present so ADDRESS_LENGTH=2 */
Wolfgang Betz 67:93bec0baf1de 157 tempRegValue[0] = 0x10 | ((uint8_t) pxPktStackInit->xControlLength);
Wolfgang Betz 67:93bec0baf1de 158
Wolfgang Betz 67:93bec0baf1de 159
Wolfgang Betz 67:93bec0baf1de 160 /* Packet format and width length setting */
Wolfgang Betz 67:93bec0baf1de 161 pxPktStackInit->cPktLengthWidth == 0 ? pxPktStackInit->cPktLengthWidth=1 : pxPktStackInit->cPktLengthWidth;
Wolfgang Betz 67:93bec0baf1de 162 tempRegValue[1] = ((uint8_t) PCKTCTRL3_PCKT_FRMT_STACK) | ((uint8_t)(pxPktStackInit->cPktLengthWidth-1));
Wolfgang Betz 67:93bec0baf1de 163
Wolfgang Betz 67:93bec0baf1de 164 /* Preamble, sync and fixed or variable length setting */
Wolfgang Betz 67:93bec0baf1de 165 tempRegValue[2] = ((uint8_t) pxPktStackInit->xPreambleLength) | ((uint8_t) pxPktStackInit->xSyncLength) |
Wolfgang Betz 67:93bec0baf1de 166 ((uint8_t) pxPktStackInit->xFixVarLength);
Wolfgang Betz 67:93bec0baf1de 167
Wolfgang Betz 67:93bec0baf1de 168 /* CRC length, whitening and FEC setting */
Wolfgang Betz 67:93bec0baf1de 169 tempRegValue[3] = (uint8_t) pxPktStackInit->xCrcMode;
Wolfgang Betz 67:93bec0baf1de 170
Wolfgang Betz 67:93bec0baf1de 171 if(pxPktStackInit->xDataWhitening == S_ENABLE)
Wolfgang Betz 67:93bec0baf1de 172 {
Wolfgang Betz 67:93bec0baf1de 173 tempRegValue[3] |= PCKTCTRL1_WHIT_MASK;
Wolfgang Betz 67:93bec0baf1de 174 }
Wolfgang Betz 67:93bec0baf1de 175
Wolfgang Betz 67:93bec0baf1de 176 if(pxPktStackInit->xFec == S_ENABLE)
Wolfgang Betz 67:93bec0baf1de 177 {
Wolfgang Betz 67:93bec0baf1de 178 tempRegValue[3] |= PCKTCTRL1_FEC_MASK;
Wolfgang Betz 67:93bec0baf1de 179 }
Wolfgang Betz 67:93bec0baf1de 180
Wolfgang Betz 67:93bec0baf1de 181 /* Writes registers */
Wolfgang Betz 67:93bec0baf1de 182 SpiritSpiWriteRegisters(PCKTCTRL4_BASE, 4, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 183
Wolfgang Betz 67:93bec0baf1de 184 /* Sync words setting */
Wolfgang Betz 67:93bec0baf1de 185 for(i=0;i<4;i++)
Wolfgang Betz 67:93bec0baf1de 186 {
Wolfgang Betz 67:93bec0baf1de 187 if(i<3-(pxPktStackInit->xSyncLength >>1))
Wolfgang Betz 67:93bec0baf1de 188 {
Wolfgang Betz 67:93bec0baf1de 189 tempRegValue[i]=0;
Wolfgang Betz 67:93bec0baf1de 190 }
Wolfgang Betz 67:93bec0baf1de 191 else
Wolfgang Betz 67:93bec0baf1de 192 {
Wolfgang Betz 67:93bec0baf1de 193 tempRegValue[i] = (uint8_t)(pxPktStackInit->lSyncWords>>(8*i));
Wolfgang Betz 67:93bec0baf1de 194 }
Wolfgang Betz 67:93bec0baf1de 195 }
Wolfgang Betz 67:93bec0baf1de 196
Wolfgang Betz 67:93bec0baf1de 197 /* Enables or disables the CRC check */
Wolfgang Betz 67:93bec0baf1de 198 if(pxPktStackInit->xCrcMode == PKT_NO_CRC)
Wolfgang Betz 67:93bec0baf1de 199 {
Wolfgang Betz 67:93bec0baf1de 200 SpiritPktStackFilterOnCrc(S_DISABLE);
Wolfgang Betz 67:93bec0baf1de 201 }
Wolfgang Betz 67:93bec0baf1de 202 else
Wolfgang Betz 67:93bec0baf1de 203 {
Wolfgang Betz 67:93bec0baf1de 204 SpiritPktStackFilterOnCrc(S_ENABLE);
Wolfgang Betz 67:93bec0baf1de 205 }
Wolfgang Betz 67:93bec0baf1de 206
Wolfgang Betz 67:93bec0baf1de 207 /* Writes registers */
Wolfgang Betz 67:93bec0baf1de 208 g_xStatus = SpiritSpiWriteRegisters(SYNC4_BASE, 4, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 209
Wolfgang Betz 67:93bec0baf1de 210 }
Wolfgang Betz 67:93bec0baf1de 211
Wolfgang Betz 67:93bec0baf1de 212
Wolfgang Betz 67:93bec0baf1de 213 /**
Wolfgang Betz 67:93bec0baf1de 214 * @brief Returns the SPIRIT STack packet structure according to the specified parameters in the registers.
Wolfgang Betz 67:93bec0baf1de 215 * @param pxPktStackInit STack packet init structure.
Wolfgang Betz 67:93bec0baf1de 216 * This parameter is a pointer to @ref PktStackInit.
Wolfgang Betz 67:93bec0baf1de 217 * @retval None.
Wolfgang Betz 67:93bec0baf1de 218 */
Wolfgang Betz 67:93bec0baf1de 219 void SpiritPktStackGetInfo(PktStackInit* pxPktStackInit)
Wolfgang Betz 67:93bec0baf1de 220 {
Wolfgang Betz 67:93bec0baf1de 221 uint8_t tempRegValue[10];
Wolfgang Betz 67:93bec0baf1de 222
Wolfgang Betz 67:93bec0baf1de 223 /* Reads registers */
Wolfgang Betz 67:93bec0baf1de 224 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL4_BASE, 10, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 225
Wolfgang Betz 67:93bec0baf1de 226 /* Length width */
Wolfgang Betz 67:93bec0baf1de 227 pxPktStackInit->cPktLengthWidth=(tempRegValue[1] & 0x0F)+1;
Wolfgang Betz 67:93bec0baf1de 228
Wolfgang Betz 67:93bec0baf1de 229 /* Control length */
Wolfgang Betz 67:93bec0baf1de 230 pxPktStackInit->xControlLength=(StackControlLength)(tempRegValue[0] & 0x07);
Wolfgang Betz 67:93bec0baf1de 231
Wolfgang Betz 67:93bec0baf1de 232 /* CRC mode */
Wolfgang Betz 67:93bec0baf1de 233 pxPktStackInit->xCrcMode=(StackCrcMode)(tempRegValue[3] & 0xE0);
Wolfgang Betz 67:93bec0baf1de 234
Wolfgang Betz 67:93bec0baf1de 235 /* Whitening */
Wolfgang Betz 67:93bec0baf1de 236 pxPktStackInit->xDataWhitening=(SpiritFunctionalState)((tempRegValue[3] >> 4) & 0x01);
Wolfgang Betz 67:93bec0baf1de 237
Wolfgang Betz 67:93bec0baf1de 238 /* FEC */
Wolfgang Betz 67:93bec0baf1de 239 pxPktStackInit->xFec=(SpiritFunctionalState)(tempRegValue[3] & 0x01);
Wolfgang Betz 67:93bec0baf1de 240
Wolfgang Betz 67:93bec0baf1de 241 /* FIX or VAR bit */
Wolfgang Betz 67:93bec0baf1de 242 pxPktStackInit->xFixVarLength=(StackFixVarLength)(tempRegValue[2] & 0x01);
Wolfgang Betz 67:93bec0baf1de 243
Wolfgang Betz 67:93bec0baf1de 244 /* Preamble length */
Wolfgang Betz 67:93bec0baf1de 245 pxPktStackInit->xPreambleLength=(StackPreambleLength)(tempRegValue[2] & 0xF8);
Wolfgang Betz 67:93bec0baf1de 246
Wolfgang Betz 67:93bec0baf1de 247 /* Sync length */
Wolfgang Betz 67:93bec0baf1de 248 pxPktStackInit->xSyncLength=(StackSyncLength)(tempRegValue[2] & 0x06);
Wolfgang Betz 67:93bec0baf1de 249
Wolfgang Betz 67:93bec0baf1de 250 /* sync Words */
Wolfgang Betz 67:93bec0baf1de 251 pxPktStackInit->lSyncWords=0;
Wolfgang Betz 67:93bec0baf1de 252 for(uint8_t i=0 ; i<4 ; i++)
Wolfgang Betz 67:93bec0baf1de 253 {
Wolfgang Betz 67:93bec0baf1de 254 if(i>2-(pxPktStackInit->xSyncLength >>1))
Wolfgang Betz 67:93bec0baf1de 255 {
Wolfgang Betz 67:93bec0baf1de 256 pxPktStackInit->lSyncWords |= tempRegValue[i+6]<<(8*i);
Wolfgang Betz 67:93bec0baf1de 257 }
Wolfgang Betz 67:93bec0baf1de 258 }
Wolfgang Betz 67:93bec0baf1de 259
Wolfgang Betz 67:93bec0baf1de 260 }
Wolfgang Betz 67:93bec0baf1de 261
Wolfgang Betz 67:93bec0baf1de 262
Wolfgang Betz 67:93bec0baf1de 263 /**
Wolfgang Betz 67:93bec0baf1de 264 * @brief Initializes the SPIRIT STack packet addresses according to the specified
Wolfgang Betz 67:93bec0baf1de 265 * parameters in the PktStackAddresses struct.
Wolfgang Betz 67:93bec0baf1de 266 * @param pxPktStackAddresses STack packet addresses init structure.
Wolfgang Betz 67:93bec0baf1de 267 * This parameter is a pointer to @ref PktStackAddressesInit .
Wolfgang Betz 67:93bec0baf1de 268 * @retval None.
Wolfgang Betz 67:93bec0baf1de 269 */
Wolfgang Betz 67:93bec0baf1de 270 void SpiritPktStackAddressesInit(PktStackAddressesInit* pxPktStackAddresses)
Wolfgang Betz 67:93bec0baf1de 271 {
Wolfgang Betz 67:93bec0baf1de 272 uint8_t tempRegValue[3];
Wolfgang Betz 67:93bec0baf1de 273
Wolfgang Betz 67:93bec0baf1de 274 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 275 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(pxPktStackAddresses->xFilterOnMyAddress));
Wolfgang Betz 67:93bec0baf1de 276 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(pxPktStackAddresses->xFilterOnMulticastAddress));
Wolfgang Betz 67:93bec0baf1de 277 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(pxPktStackAddresses->xFilterOnBroadcastAddress));
Wolfgang Betz 67:93bec0baf1de 278
Wolfgang Betz 67:93bec0baf1de 279 /* Reads the filtering options ragister */
Wolfgang Betz 67:93bec0baf1de 280 g_xStatus = SpiritSpiReadRegisters(PCKT_FLT_OPTIONS_BASE, 1, &tempRegValue[0]);
Wolfgang Betz 67:93bec0baf1de 281
Wolfgang Betz 67:93bec0baf1de 282 /* Enables or disables filtering on my address */
Wolfgang Betz 67:93bec0baf1de 283 if(pxPktStackAddresses->xFilterOnMyAddress == S_ENABLE)
Wolfgang Betz 67:93bec0baf1de 284 {
Wolfgang Betz 67:93bec0baf1de 285 tempRegValue[0] |= PCKT_FLT_OPTIONS_DEST_VS_TX_ADDR_MASK;
Wolfgang Betz 67:93bec0baf1de 286 }
Wolfgang Betz 67:93bec0baf1de 287 else
Wolfgang Betz 67:93bec0baf1de 288 {
Wolfgang Betz 67:93bec0baf1de 289 tempRegValue[0] &= ~PCKT_FLT_OPTIONS_DEST_VS_TX_ADDR_MASK;
Wolfgang Betz 67:93bec0baf1de 290 }
Wolfgang Betz 67:93bec0baf1de 291
Wolfgang Betz 67:93bec0baf1de 292 /* Enables or disables filtering on multicast address */
Wolfgang Betz 67:93bec0baf1de 293 if(pxPktStackAddresses->xFilterOnMulticastAddress == S_ENABLE)
Wolfgang Betz 67:93bec0baf1de 294 {
Wolfgang Betz 67:93bec0baf1de 295 tempRegValue[0] |= PCKT_FLT_OPTIONS_DEST_VS_MULTICAST_ADDR_MASK;
Wolfgang Betz 67:93bec0baf1de 296 }
Wolfgang Betz 67:93bec0baf1de 297 else
Wolfgang Betz 67:93bec0baf1de 298 {
Wolfgang Betz 67:93bec0baf1de 299 tempRegValue[0] &= ~PCKT_FLT_OPTIONS_DEST_VS_MULTICAST_ADDR_MASK;
Wolfgang Betz 67:93bec0baf1de 300 }
Wolfgang Betz 67:93bec0baf1de 301
Wolfgang Betz 67:93bec0baf1de 302 /* Enables or disables filtering on broadcast address */
Wolfgang Betz 67:93bec0baf1de 303 if(pxPktStackAddresses->xFilterOnBroadcastAddress == S_ENABLE)
Wolfgang Betz 67:93bec0baf1de 304 {
Wolfgang Betz 67:93bec0baf1de 305 tempRegValue[0] |= PCKT_FLT_OPTIONS_DEST_VS_BROADCAST_ADDR_MASK;
Wolfgang Betz 67:93bec0baf1de 306 }
Wolfgang Betz 67:93bec0baf1de 307 else
Wolfgang Betz 67:93bec0baf1de 308 {
Wolfgang Betz 67:93bec0baf1de 309 tempRegValue[0] &= ~PCKT_FLT_OPTIONS_DEST_VS_BROADCAST_ADDR_MASK;
Wolfgang Betz 67:93bec0baf1de 310 }
Wolfgang Betz 67:93bec0baf1de 311
Wolfgang Betz 67:93bec0baf1de 312 /* Writes value on the register */
Wolfgang Betz 67:93bec0baf1de 313 g_xStatus = SpiritSpiWriteRegisters(PCKT_FLT_OPTIONS_BASE, 1, &tempRegValue[0]);
Wolfgang Betz 67:93bec0baf1de 314
Wolfgang Betz 67:93bec0baf1de 315 /* Fills array with the addresses passed in the structure */
Wolfgang Betz 67:93bec0baf1de 316 tempRegValue[0] = pxPktStackAddresses->cBroadcastAddress;
Wolfgang Betz 67:93bec0baf1de 317 tempRegValue[1] = pxPktStackAddresses->cMulticastAddress;
Wolfgang Betz 67:93bec0baf1de 318 tempRegValue[2] = pxPktStackAddresses->cMyAddress;
Wolfgang Betz 67:93bec0baf1de 319
Wolfgang Betz 67:93bec0baf1de 320 /* Writes them on the addresses registers */
Wolfgang Betz 67:93bec0baf1de 321 g_xStatus = SpiritSpiWriteRegisters(PCKT_FLT_GOALS_BROADCAST_BASE, 3, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 322
Wolfgang Betz 67:93bec0baf1de 323 }
Wolfgang Betz 67:93bec0baf1de 324
Wolfgang Betz 67:93bec0baf1de 325
Wolfgang Betz 67:93bec0baf1de 326 /**
Wolfgang Betz 67:93bec0baf1de 327 * @brief Returns the SPIRIT STack packet addresses structure according to the specified
Wolfgang Betz 67:93bec0baf1de 328 * parameters in the registers.
Wolfgang Betz 67:93bec0baf1de 329 * @param pxPktStackAddresses STack packet addresses init structure.
Wolfgang Betz 67:93bec0baf1de 330 * This parameter is a pointer to @ref PktStackAddresses.
Wolfgang Betz 67:93bec0baf1de 331 * @retval None.
Wolfgang Betz 67:93bec0baf1de 332 */
Wolfgang Betz 67:93bec0baf1de 333 void SpiritPktStackGetAddressesInfo(PktStackAddressesInit* pxPktStackAddresses)
Wolfgang Betz 67:93bec0baf1de 334 {
Wolfgang Betz 67:93bec0baf1de 335 uint8_t tempRegValue[3];
Wolfgang Betz 67:93bec0baf1de 336
Wolfgang Betz 67:93bec0baf1de 337 /* Reads values on the PCKT_FLT_GOALS registers */
Wolfgang Betz 67:93bec0baf1de 338 g_xStatus = SpiritSpiReadRegisters(PCKT_FLT_GOALS_BROADCAST_BASE, 3, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 339
Wolfgang Betz 67:93bec0baf1de 340 /* Fit the structure with the read addresses */
Wolfgang Betz 67:93bec0baf1de 341 pxPktStackAddresses->cBroadcastAddress = tempRegValue[0];
Wolfgang Betz 67:93bec0baf1de 342 pxPktStackAddresses->cMulticastAddress = tempRegValue[1];
Wolfgang Betz 67:93bec0baf1de 343 pxPktStackAddresses->cMyAddress = tempRegValue[2];
Wolfgang Betz 67:93bec0baf1de 344
Wolfgang Betz 67:93bec0baf1de 345 g_xStatus = SpiritSpiReadRegisters(PCKT_FLT_OPTIONS_BASE, 1, &tempRegValue[0]);
Wolfgang Betz 67:93bec0baf1de 346
Wolfgang Betz 67:93bec0baf1de 347 /* Fit the structure with the read filtering bits */
Wolfgang Betz 67:93bec0baf1de 348 pxPktStackAddresses->xFilterOnBroadcastAddress = (SpiritFunctionalState)((tempRegValue[0] >> 1) & 0x01);
Wolfgang Betz 67:93bec0baf1de 349 pxPktStackAddresses->xFilterOnMulticastAddress = (SpiritFunctionalState)((tempRegValue[0] >> 2) & 0x01);
Wolfgang Betz 67:93bec0baf1de 350 pxPktStackAddresses->xFilterOnMyAddress = (SpiritFunctionalState)((tempRegValue[0] >> 3) & 0x01);
Wolfgang Betz 67:93bec0baf1de 351
Wolfgang Betz 67:93bec0baf1de 352 }
Wolfgang Betz 67:93bec0baf1de 353
Wolfgang Betz 67:93bec0baf1de 354
Wolfgang Betz 67:93bec0baf1de 355 /**
Wolfgang Betz 67:93bec0baf1de 356 * @brief Initializes the SPIRIT STack packet LLP options according to the specified
Wolfgang Betz 67:93bec0baf1de 357 * parameters in the PktStackLlpInit struct.
Wolfgang Betz 67:93bec0baf1de 358 * @param pxPktStackLlpInit STack packet LLP init structure.
Wolfgang Betz 67:93bec0baf1de 359 * This parameter is a pointer to @ref PktStackLlpInit.
Wolfgang Betz 67:93bec0baf1de 360 * @retval None.
Wolfgang Betz 67:93bec0baf1de 361 */
Wolfgang Betz 67:93bec0baf1de 362 void SpiritPktStackLlpInit(PktStackLlpInit* pxPktStackLlpInit)
Wolfgang Betz 67:93bec0baf1de 363 {
Wolfgang Betz 67:93bec0baf1de 364 uint8_t tempRegValue[2];
Wolfgang Betz 67:93bec0baf1de 365
Wolfgang Betz 67:93bec0baf1de 366 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 367 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(pxPktStackLlpInit->xPiggybacking));
Wolfgang Betz 67:93bec0baf1de 368 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(pxPktStackLlpInit->xAutoAck));
Wolfgang Betz 67:93bec0baf1de 369 s_assert_param(IS_STACK_NMAX_RETX(pxPktStackLlpInit->xNMaxRetx));
Wolfgang Betz 67:93bec0baf1de 370 /* check if piggybacking is enabled and autoack is disabled */
Wolfgang Betz 67:93bec0baf1de 371 s_assert_param(!(pxPktStackLlpInit->xPiggybacking==S_ENABLE && pxPktStackLlpInit->xAutoAck==S_DISABLE));
Wolfgang Betz 67:93bec0baf1de 372
Wolfgang Betz 67:93bec0baf1de 373 /* Piggybacking mechanism setting on the PROTOCOL1 register */
Wolfgang Betz 67:93bec0baf1de 374 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 2, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 375 if(pxPktStackLlpInit->xPiggybacking == S_ENABLE)
Wolfgang Betz 67:93bec0baf1de 376 {
Wolfgang Betz 67:93bec0baf1de 377 tempRegValue[0] |= PROTOCOL1_PIGGYBACKING_MASK;
Wolfgang Betz 67:93bec0baf1de 378 }
Wolfgang Betz 67:93bec0baf1de 379 else
Wolfgang Betz 67:93bec0baf1de 380 {
Wolfgang Betz 67:93bec0baf1de 381 tempRegValue[0] &= ~PROTOCOL1_PIGGYBACKING_MASK;
Wolfgang Betz 67:93bec0baf1de 382 }
Wolfgang Betz 67:93bec0baf1de 383
Wolfgang Betz 67:93bec0baf1de 384 /* RX and TX autoack mechanisms setting on the PROTOCOL0 register */
Wolfgang Betz 67:93bec0baf1de 385 if(pxPktStackLlpInit->xAutoAck == S_ENABLE)
Wolfgang Betz 67:93bec0baf1de 386 {
Wolfgang Betz 67:93bec0baf1de 387 tempRegValue[1] |= PROTOCOL0_AUTO_ACK_MASK;
Wolfgang Betz 67:93bec0baf1de 388 }
Wolfgang Betz 67:93bec0baf1de 389 else
Wolfgang Betz 67:93bec0baf1de 390 {
Wolfgang Betz 67:93bec0baf1de 391 tempRegValue[1] &= ~PROTOCOL0_AUTO_ACK_MASK;
Wolfgang Betz 67:93bec0baf1de 392 }
Wolfgang Betz 67:93bec0baf1de 393
Wolfgang Betz 67:93bec0baf1de 394 /* Max number of retransmission setting */
Wolfgang Betz 67:93bec0baf1de 395 tempRegValue[1] &= ~PROTOCOL0_NMAX_RETX_MASK;
Wolfgang Betz 67:93bec0baf1de 396 tempRegValue[1] |= pxPktStackLlpInit->xNMaxRetx;
Wolfgang Betz 67:93bec0baf1de 397
Wolfgang Betz 67:93bec0baf1de 398 /* Writes registers */
Wolfgang Betz 67:93bec0baf1de 399 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 2, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 400
Wolfgang Betz 67:93bec0baf1de 401 }
Wolfgang Betz 67:93bec0baf1de 402
Wolfgang Betz 67:93bec0baf1de 403
Wolfgang Betz 67:93bec0baf1de 404 /**
Wolfgang Betz 67:93bec0baf1de 405 * @brief Returns the SPIRIT STack packet LLP options according to the specified
Wolfgang Betz 67:93bec0baf1de 406 * values in the registers.
Wolfgang Betz 67:93bec0baf1de 407 * @param pxPktStackLlpInit STack packet LLP structure.
Wolfgang Betz 67:93bec0baf1de 408 * This parameter is a pointer to @ref PktStackLlpInit.
Wolfgang Betz 67:93bec0baf1de 409 * @retval None.
Wolfgang Betz 67:93bec0baf1de 410 */
Wolfgang Betz 67:93bec0baf1de 411 void SpiritPktStackLlpGetInfo(PktStackLlpInit* pxPktStackLlpInit)
Wolfgang Betz 67:93bec0baf1de 412 {
Wolfgang Betz 67:93bec0baf1de 413 uint8_t tempRegValue[2];
Wolfgang Betz 67:93bec0baf1de 414
Wolfgang Betz 67:93bec0baf1de 415 /* Piggybacking mechanism setting on the PROTOCOL1 register */
Wolfgang Betz 67:93bec0baf1de 416 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 2, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 417
Wolfgang Betz 67:93bec0baf1de 418 /* Fit the structure with the read values */
Wolfgang Betz 67:93bec0baf1de 419 pxPktStackLlpInit->xPiggybacking = (SpiritFunctionalState)((tempRegValue[0] >> 6) & 0x01);
Wolfgang Betz 67:93bec0baf1de 420 pxPktStackLlpInit->xAutoAck = (SpiritFunctionalState)((tempRegValue[1] >> 2) & 0x01);
Wolfgang Betz 67:93bec0baf1de 421 pxPktStackLlpInit->xNMaxRetx = (StackNMaxReTx)(tempRegValue[1] & PROTOCOL0_NMAX_RETX_MASK);
Wolfgang Betz 67:93bec0baf1de 422
Wolfgang Betz 67:93bec0baf1de 423 }
Wolfgang Betz 67:93bec0baf1de 424
Wolfgang Betz 67:93bec0baf1de 425
Wolfgang Betz 67:93bec0baf1de 426 /**
Wolfgang Betz 67:93bec0baf1de 427 * @brief Configures the STack packet format for SPIRIT.
Wolfgang Betz 67:93bec0baf1de 428 * @param None.
Wolfgang Betz 67:93bec0baf1de 429 * @retval None.
Wolfgang Betz 67:93bec0baf1de 430 */
Wolfgang Betz 67:93bec0baf1de 431 void SpiritPktStackSetFormat(void)
Wolfgang Betz 67:93bec0baf1de 432 {
Wolfgang Betz 67:93bec0baf1de 433 uint8_t tempRegValue;
Wolfgang Betz 67:93bec0baf1de 434
Wolfgang Betz 67:93bec0baf1de 435 /* Reads the PCKTCTRL3 register value */
Wolfgang Betz 67:93bec0baf1de 436 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 437
Wolfgang Betz 67:93bec0baf1de 438 /* Build value to be written. Also set to 0 the direct RX mode bits */
Wolfgang Betz 67:93bec0baf1de 439 tempRegValue &= 0x0F;
Wolfgang Betz 67:93bec0baf1de 440 tempRegValue |= ((uint8_t)PCKTCTRL3_PCKT_FRMT_STACK);
Wolfgang Betz 67:93bec0baf1de 441
Wolfgang Betz 67:93bec0baf1de 442 /* Writes the value on the PCKTCTRL3 register. */
Wolfgang Betz 67:93bec0baf1de 443 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 444
Wolfgang Betz 67:93bec0baf1de 445 /* Reads the PCKTCTRL1 register value */
Wolfgang Betz 67:93bec0baf1de 446 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 447
Wolfgang Betz 67:93bec0baf1de 448 /* Build the new value. Set to 0 the direct TX mode bits */
Wolfgang Betz 67:93bec0baf1de 449 tempRegValue &= 0xF3;
Wolfgang Betz 67:93bec0baf1de 450
Wolfgang Betz 67:93bec0baf1de 451 /* Writes the PCKTCTRL1 value on register */
Wolfgang Betz 67:93bec0baf1de 452 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 453
Wolfgang Betz 67:93bec0baf1de 454 /* Reads the PROTOCOL1 register */
Wolfgang Betz 67:93bec0baf1de 455 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 456
Wolfgang Betz 67:93bec0baf1de 457 /* Mask a reserved bit */
Wolfgang Betz 67:93bec0baf1de 458 tempRegValue &= ~0x20;
Wolfgang Betz 67:93bec0baf1de 459
Wolfgang Betz 67:93bec0baf1de 460 /* Writes the value on the PROTOCOL1 register */
Wolfgang Betz 67:93bec0baf1de 461 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 462
Wolfgang Betz 67:93bec0baf1de 463 }
Wolfgang Betz 67:93bec0baf1de 464
Wolfgang Betz 67:93bec0baf1de 465
Wolfgang Betz 67:93bec0baf1de 466 /**
Wolfgang Betz 67:93bec0baf1de 467 * @brief Sets the address length for SPIRIT STack packets (always 2).
Wolfgang Betz 67:93bec0baf1de 468 * @param None.
Wolfgang Betz 67:93bec0baf1de 469 * @retval None.
Wolfgang Betz 67:93bec0baf1de 470 */
Wolfgang Betz 67:93bec0baf1de 471 void SpiritPktStackSetAddressLength(void)
Wolfgang Betz 67:93bec0baf1de 472 {
Wolfgang Betz 67:93bec0baf1de 473 uint8_t tempRegValue;
Wolfgang Betz 67:93bec0baf1de 474
Wolfgang Betz 67:93bec0baf1de 475 /* Reads the PCKTCTRL4 register value */
Wolfgang Betz 67:93bec0baf1de 476 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL4_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 477
Wolfgang Betz 67:93bec0baf1de 478 /* Build the new value */
Wolfgang Betz 67:93bec0baf1de 479 tempRegValue &= ~PCKTCTRL4_ADDRESS_LEN_MASK;
Wolfgang Betz 67:93bec0baf1de 480 tempRegValue |= ((uint8_t)0x10);
Wolfgang Betz 67:93bec0baf1de 481
Wolfgang Betz 67:93bec0baf1de 482 /* Writes the value on the PCKTCTRL4 register */
Wolfgang Betz 67:93bec0baf1de 483 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL4_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 484
Wolfgang Betz 67:93bec0baf1de 485 }
Wolfgang Betz 67:93bec0baf1de 486
Wolfgang Betz 67:93bec0baf1de 487
Wolfgang Betz 67:93bec0baf1de 488 /**
Wolfgang Betz 67:93bec0baf1de 489 * @brief Sets the payload length for SPIRIT STack packets. Since the packet length
Wolfgang Betz 67:93bec0baf1de 490 * depends from the address (always 2 for this packet format)
Wolfgang Betz 67:93bec0baf1de 491 * and the control field size, this function reads the control length register
Wolfgang Betz 67:93bec0baf1de 492 * content in order to determine the correct packet length to be written.
Wolfgang Betz 67:93bec0baf1de 493 * @param nPayloadLength payload length in bytes.
Wolfgang Betz 67:93bec0baf1de 494 * This parameter can be any value of uint16_t.
Wolfgang Betz 67:93bec0baf1de 495 * @retval None.
Wolfgang Betz 67:93bec0baf1de 496 */
Wolfgang Betz 67:93bec0baf1de 497 void SpiritPktStackSetPayloadLength(uint16_t nPayloadLength)
Wolfgang Betz 67:93bec0baf1de 498 {
Wolfgang Betz 67:93bec0baf1de 499 uint8_t tempRegValue[2];
Wolfgang Betz 67:93bec0baf1de 500
Wolfgang Betz 67:93bec0baf1de 501 /* Computes the oversize (address + control) size */
Wolfgang Betz 67:93bec0baf1de 502 uint16_t overSize = 2 + (uint16_t) SpiritPktStackGetControlLength();
Wolfgang Betz 67:93bec0baf1de 503
Wolfgang Betz 67:93bec0baf1de 504 /* Computes PCKTLEN0 value from lPayloadLength */
Wolfgang Betz 67:93bec0baf1de 505 tempRegValue[1]=STACK_BUILD_PCKTLEN0(nPayloadLength+overSize);
Wolfgang Betz 67:93bec0baf1de 506 /* Computes PCKTLEN1 value from lPayloadLength */
Wolfgang Betz 67:93bec0baf1de 507 tempRegValue[0]=STACK_BUILD_PCKTLEN1(nPayloadLength+overSize);
Wolfgang Betz 67:93bec0baf1de 508
Wolfgang Betz 67:93bec0baf1de 509 /* Writes the value on the PCKTLENx registers */
Wolfgang Betz 67:93bec0baf1de 510 g_xStatus = SpiritSpiWriteRegisters(PCKTLEN1_BASE, 2, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 511
Wolfgang Betz 67:93bec0baf1de 512 }
Wolfgang Betz 67:93bec0baf1de 513
Wolfgang Betz 67:93bec0baf1de 514
Wolfgang Betz 67:93bec0baf1de 515 /**
Wolfgang Betz 67:93bec0baf1de 516 * @brief Returns the payload length for SPIRIT STack packets. Since the
Wolfgang Betz 67:93bec0baf1de 517 * packet length depends from the address and the control
Wolfgang Betz 67:93bec0baf1de 518 * field size, this function reads the correspondent
Wolfgang Betz 67:93bec0baf1de 519 * registers in order to determine the correct payload length
Wolfgang Betz 67:93bec0baf1de 520 * to be returned.
Wolfgang Betz 67:93bec0baf1de 521 * @param None.
Wolfgang Betz 67:93bec0baf1de 522 * @retval uint16_t Payload length.
Wolfgang Betz 67:93bec0baf1de 523 */
Wolfgang Betz 67:93bec0baf1de 524 uint16_t SpiritPktStackGetPayloadLength(void)
Wolfgang Betz 67:93bec0baf1de 525 {
Wolfgang Betz 67:93bec0baf1de 526 uint8_t tempRegValue[2];
Wolfgang Betz 67:93bec0baf1de 527 /* Computes the oversize (address + control) size */
Wolfgang Betz 67:93bec0baf1de 528 uint16_t overSize = 2 + (uint16_t) SpiritPktStackGetControlLength();
Wolfgang Betz 67:93bec0baf1de 529
Wolfgang Betz 67:93bec0baf1de 530 /* Reads the PCKTLEN1 registers value */
Wolfgang Betz 67:93bec0baf1de 531 g_xStatus = SpiritSpiReadRegisters(PCKTLEN1_BASE, 2, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 532
Wolfgang Betz 67:93bec0baf1de 533 /* Rebuild and return the payload length value */
Wolfgang Betz 67:93bec0baf1de 534 return ((((uint16_t) tempRegValue[1])<<8) + (uint16_t) tempRegValue[0] - overSize);
Wolfgang Betz 67:93bec0baf1de 535
Wolfgang Betz 67:93bec0baf1de 536 }
Wolfgang Betz 67:93bec0baf1de 537
Wolfgang Betz 67:93bec0baf1de 538
Wolfgang Betz 67:93bec0baf1de 539 /**
Wolfgang Betz 67:93bec0baf1de 540 * @brief Computes and sets the variable payload length for SPIRIT STack packets.
Wolfgang Betz 67:93bec0baf1de 541 * @param nMaxPayloadLength payload length in bytes.
Wolfgang Betz 67:93bec0baf1de 542 * This parameter is an uint16_t.
Wolfgang Betz 67:93bec0baf1de 543 * @param xControlLength control length in bytes.
Wolfgang Betz 67:93bec0baf1de 544 * This parameter can be any value of @ref StackControlLength.
Wolfgang Betz 67:93bec0baf1de 545 * @retval None.
Wolfgang Betz 67:93bec0baf1de 546 */
Wolfgang Betz 67:93bec0baf1de 547 void SpiritPktStackSetVarLengthWidth(uint16_t nMaxPayloadLength, StackControlLength xControlLength)
Wolfgang Betz 67:93bec0baf1de 548 {
Wolfgang Betz 67:93bec0baf1de 549 uint8_t tempRegValue,
Wolfgang Betz 67:93bec0baf1de 550 i;
Wolfgang Betz 67:93bec0baf1de 551 uint32_t packetLength;
Wolfgang Betz 67:93bec0baf1de 552
Wolfgang Betz 67:93bec0baf1de 553
Wolfgang Betz 67:93bec0baf1de 554 /* packet length = payload length + address length (2) + control length */
Wolfgang Betz 67:93bec0baf1de 555 packetLength=nMaxPayloadLength+2+xControlLength;
Wolfgang Betz 67:93bec0baf1de 556
Wolfgang Betz 67:93bec0baf1de 557 /* Computes the number of bits */
Wolfgang Betz 67:93bec0baf1de 558 for(i=0;i<16;i++)
Wolfgang Betz 67:93bec0baf1de 559 {
Wolfgang Betz 67:93bec0baf1de 560 if(packetLength == 0)
Wolfgang Betz 67:93bec0baf1de 561 {
Wolfgang Betz 67:93bec0baf1de 562 break;
Wolfgang Betz 67:93bec0baf1de 563 }
Wolfgang Betz 67:93bec0baf1de 564 packetLength >>= 1;
Wolfgang Betz 67:93bec0baf1de 565 }
Wolfgang Betz 67:93bec0baf1de 566 i==0 ? i=1 : i;
Wolfgang Betz 67:93bec0baf1de 567
Wolfgang Betz 67:93bec0baf1de 568 /* Reads the PCKTCTRL3 register value */
Wolfgang Betz 67:93bec0baf1de 569 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 570
Wolfgang Betz 67:93bec0baf1de 571 /* Build the register value */
Wolfgang Betz 67:93bec0baf1de 572 tempRegValue &= ~PCKTCTRL3_LEN_WID_MASK;
Wolfgang Betz 67:93bec0baf1de 573 tempRegValue |= ((uint8_t)(i-1));
Wolfgang Betz 67:93bec0baf1de 574
Wolfgang Betz 67:93bec0baf1de 575 /* Writes the PCKTCTRL3 register value */
Wolfgang Betz 67:93bec0baf1de 576 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 577
Wolfgang Betz 67:93bec0baf1de 578 }
Wolfgang Betz 67:93bec0baf1de 579
Wolfgang Betz 67:93bec0baf1de 580
Wolfgang Betz 67:93bec0baf1de 581 /**
Wolfgang Betz 67:93bec0baf1de 582 * @brief Rx packet source mask. Used to mask the address of the accepted packets. If 0 -> no filtering.
Wolfgang Betz 67:93bec0baf1de 583 * @param cMask Rx source mask.
Wolfgang Betz 67:93bec0baf1de 584 * This parameter is an uint8_t.
Wolfgang Betz 67:93bec0baf1de 585 * @retval None.
Wolfgang Betz 67:93bec0baf1de 586 */
Wolfgang Betz 67:93bec0baf1de 587 void SpiritPktStackSetRxSourceMask(uint8_t cMask)
Wolfgang Betz 67:93bec0baf1de 588 {
Wolfgang Betz 67:93bec0baf1de 589 /* Writes value on the register PCKT_FLT_GOALS_SOURCE_MASK */
Wolfgang Betz 67:93bec0baf1de 590 g_xStatus = SpiritSpiWriteRegisters(PCKT_FLT_GOALS_SOURCE_MASK_BASE, 1, &cMask);
Wolfgang Betz 67:93bec0baf1de 591
Wolfgang Betz 67:93bec0baf1de 592 }
Wolfgang Betz 67:93bec0baf1de 593
Wolfgang Betz 67:93bec0baf1de 594
Wolfgang Betz 67:93bec0baf1de 595 /**
Wolfgang Betz 67:93bec0baf1de 596 * @brief Returns the Rx packet source mask. Used to mask the address of the accepted packets. If 0 -> no filtering.
Wolfgang Betz 67:93bec0baf1de 597 * @param None.
Wolfgang Betz 67:93bec0baf1de 598 * @retval uint8_t Rx source mask.
Wolfgang Betz 67:93bec0baf1de 599 */
Wolfgang Betz 67:93bec0baf1de 600 uint8_t SpiritPktStackGetRxSourceMask(void)
Wolfgang Betz 67:93bec0baf1de 601 {
Wolfgang Betz 67:93bec0baf1de 602 uint8_t tempRegValue;
Wolfgang Betz 67:93bec0baf1de 603
Wolfgang Betz 67:93bec0baf1de 604 /* Writes value on the PCKT_FLT_GOALS_SOURCE_MASK register */
Wolfgang Betz 67:93bec0baf1de 605 g_xStatus = SpiritSpiReadRegisters(PCKT_FLT_GOALS_SOURCE_MASK_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 606
Wolfgang Betz 67:93bec0baf1de 607 /* Return the read value */
Wolfgang Betz 67:93bec0baf1de 608 return tempRegValue;
Wolfgang Betz 67:93bec0baf1de 609
Wolfgang Betz 67:93bec0baf1de 610 }
Wolfgang Betz 67:93bec0baf1de 611
Wolfgang Betz 67:93bec0baf1de 612 /**
Wolfgang Betz 67:93bec0baf1de 613 * @brief Returns the packet length field of the received packet.
Wolfgang Betz 67:93bec0baf1de 614 * @param None.
Wolfgang Betz 67:93bec0baf1de 615 * @retval uint16_t Packet length.
Wolfgang Betz 67:93bec0baf1de 616 */
Wolfgang Betz 67:93bec0baf1de 617 uint16_t SpiritPktStackGetReceivedPktLength(void)
Wolfgang Betz 67:93bec0baf1de 618 {
Wolfgang Betz 67:93bec0baf1de 619 uint8_t tempRegValue[2];
Wolfgang Betz 67:93bec0baf1de 620 uint16_t tempLength;
Wolfgang Betz 67:93bec0baf1de 621
Wolfgang Betz 67:93bec0baf1de 622 /* Reads the RX_PCKT_LENx registers value */
Wolfgang Betz 67:93bec0baf1de 623 g_xStatus = SpiritSpiReadRegisters(RX_PCKT_LEN1_BASE, 2, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 624
Wolfgang Betz 67:93bec0baf1de 625 /* Rebuild and return the the length field */
Wolfgang Betz 67:93bec0baf1de 626 tempLength = ((((uint16_t) tempRegValue[0]) << 8) + (uint16_t) tempRegValue[1]);
Wolfgang Betz 67:93bec0baf1de 627
Wolfgang Betz 67:93bec0baf1de 628 /* Computes the oversize (address + control) size */
Wolfgang Betz 67:93bec0baf1de 629 tempLength -= 2 + (uint16_t) SpiritPktStackGetControlLength();
Wolfgang Betz 67:93bec0baf1de 630
Wolfgang Betz 67:93bec0baf1de 631 return tempLength;
Wolfgang Betz 67:93bec0baf1de 632
Wolfgang Betz 67:93bec0baf1de 633 }
Wolfgang Betz 67:93bec0baf1de 634
Wolfgang Betz 67:93bec0baf1de 635
Wolfgang Betz 67:93bec0baf1de 636 /**
Wolfgang Betz 67:93bec0baf1de 637 * @brief If enabled RX packet is accepted only if the masked source address field matches the
Wolfgang Betz 67:93bec0baf1de 638 * masked source address field reference (SOURCE_MASK & SOURCE_FIELD_REF == SOURCE_MASK & RX_SOURCE_FIELD).
Wolfgang Betz 67:93bec0baf1de 639 * @param xNewState new state for Source address filtering enable bit.
Wolfgang Betz 67:93bec0baf1de 640 * This parameter can be S_ENABLE or S_DISABLE.
Wolfgang Betz 67:93bec0baf1de 641 * @retval None.
Wolfgang Betz 67:93bec0baf1de 642 * @note This filtering control is enabled by default but the source address mask is by default set to 0.
Wolfgang Betz 67:93bec0baf1de 643 * As a matter of fact the user has to enable the source filtering bit after the packet initialization
Wolfgang Betz 67:93bec0baf1de 644 * because the PktInit routine disables it.
Wolfgang Betz 67:93bec0baf1de 645 */
Wolfgang Betz 67:93bec0baf1de 646 void SpiritPktStackFilterOnSourceAddress(SpiritFunctionalState xNewState)
Wolfgang Betz 67:93bec0baf1de 647 {
Wolfgang Betz 67:93bec0baf1de 648 uint8_t tempRegValue;
Wolfgang Betz 67:93bec0baf1de 649
Wolfgang Betz 67:93bec0baf1de 650 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 651 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 67:93bec0baf1de 652
Wolfgang Betz 67:93bec0baf1de 653
Wolfgang Betz 67:93bec0baf1de 654 /* Modify the register value: set or reset the source bit filtering */
Wolfgang Betz 67:93bec0baf1de 655 g_xStatus = SpiritSpiReadRegisters(PCKT_FLT_OPTIONS_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 656
Wolfgang Betz 67:93bec0baf1de 657 /* Set or reset the SOURCE ADDRESS filtering enabling bit */
Wolfgang Betz 67:93bec0baf1de 658 if(xNewState == S_ENABLE)
Wolfgang Betz 67:93bec0baf1de 659 {
Wolfgang Betz 67:93bec0baf1de 660 tempRegValue |= PCKT_FLT_OPTIONS_SOURCE_FILTERING_MASK;
Wolfgang Betz 67:93bec0baf1de 661 }
Wolfgang Betz 67:93bec0baf1de 662 else
Wolfgang Betz 67:93bec0baf1de 663 {
Wolfgang Betz 67:93bec0baf1de 664 tempRegValue &= ~PCKT_FLT_OPTIONS_SOURCE_FILTERING_MASK;
Wolfgang Betz 67:93bec0baf1de 665 }
Wolfgang Betz 67:93bec0baf1de 666
Wolfgang Betz 67:93bec0baf1de 667 /* Writes the new value on the PCKT_FLT_OPTIONS register */
Wolfgang Betz 67:93bec0baf1de 668 g_xStatus = SpiritSpiWriteRegisters(PCKT_FLT_OPTIONS_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 669
Wolfgang Betz 67:93bec0baf1de 670 }
Wolfgang Betz 67:93bec0baf1de 671
Wolfgang Betz 67:93bec0baf1de 672 /**
Wolfgang Betz 67:93bec0baf1de 673 *@}
Wolfgang Betz 67:93bec0baf1de 674 */
Wolfgang Betz 67:93bec0baf1de 675
Wolfgang Betz 67:93bec0baf1de 676 /**
Wolfgang Betz 67:93bec0baf1de 677 *@}
Wolfgang Betz 67:93bec0baf1de 678 */
Wolfgang Betz 67:93bec0baf1de 679
Wolfgang Betz 67:93bec0baf1de 680
Wolfgang Betz 67:93bec0baf1de 681 /**
Wolfgang Betz 67:93bec0baf1de 682 *@}
Wolfgang Betz 67:93bec0baf1de 683 */
Wolfgang Betz 67:93bec0baf1de 684
Wolfgang Betz 67:93bec0baf1de 685
Wolfgang Betz 67:93bec0baf1de 686
Wolfgang Betz 67:93bec0baf1de 687 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/