Toyomasa Watarai / easy-connect-type-yd

Easily add all supported connectivity methods to your mbed OS project

Dependencies:   type-yd-driver

stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Src/SPIRIT_PktBasic.c@0:615f90842ce8, 2017-07-12 (annotated)

Committer:
MACRUM
Date:
Wed Jul 12 10:52:58 2017 +0000
Revision:
0:615f90842ce8
Initial commit

Who changed what in which revision?

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