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_PktMbus.c@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_PktMbus.c
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 SPIRIT MBUS packets.
Wolfgang Betz 34:edda6a7238ec 8 * @details
Wolfgang Betz 34:edda6a7238ec 9 *
Wolfgang Betz 34:edda6a7238ec 10 * @attention
Wolfgang Betz 34:edda6a7238ec 11 *
Wolfgang Betz 34:edda6a7238ec 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 34:edda6a7238ec 13 *
Wolfgang Betz 34:edda6a7238ec 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 34:edda6a7238ec 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 34:edda6a7238ec 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 34:edda6a7238ec 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 34:edda6a7238ec 20 * and/or other materials provided with the distribution.
Wolfgang Betz 34:edda6a7238ec 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 34:edda6a7238ec 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 34:edda6a7238ec 23 * without specific prior written permission.
Wolfgang Betz 34:edda6a7238ec 24 *
Wolfgang Betz 34:edda6a7238ec 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 34:edda6a7238ec 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 34:edda6a7238ec 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 34:edda6a7238ec 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 34:edda6a7238ec 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 34:edda6a7238ec 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 34:edda6a7238ec 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 34:edda6a7238ec 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 34:edda6a7238ec 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 34:edda6a7238ec 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 34:edda6a7238ec 35 *
Wolfgang Betz 34:edda6a7238ec 36 ******************************************************************************
Wolfgang Betz 34:edda6a7238ec 37 */
Wolfgang Betz 34:edda6a7238ec 38
Wolfgang Betz 34:edda6a7238ec 39 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 40 #include "SPIRIT_PktMbus.h"
Wolfgang Betz 34:edda6a7238ec 41 #include "SPIRIT_Radio.h"
Wolfgang Betz 34:edda6a7238ec 42 #include "MCU_Interface.h"
Wolfgang Betz 34:edda6a7238ec 43
Wolfgang Betz 34:edda6a7238ec 44 /**
Wolfgang Betz 34:edda6a7238ec 45 * @addtogroup SPIRIT_Libraries
Wolfgang Betz 34:edda6a7238ec 46 * @{
Wolfgang Betz 34:edda6a7238ec 47 */
Wolfgang Betz 34:edda6a7238ec 48
Wolfgang Betz 34:edda6a7238ec 49
Wolfgang Betz 34:edda6a7238ec 50 /**
Wolfgang Betz 34:edda6a7238ec 51 * @addtogroup SPIRIT_PktMbus
Wolfgang Betz 34:edda6a7238ec 52 * @{
Wolfgang Betz 34:edda6a7238ec 53 */
Wolfgang Betz 34:edda6a7238ec 54
Wolfgang Betz 34:edda6a7238ec 55
Wolfgang Betz 34:edda6a7238ec 56 /**
Wolfgang Betz 34:edda6a7238ec 57 * @defgroup PktMbus_Private_TypesDefinitions Pkt MBUS Private Types Definitions
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 *@}
Wolfgang Betz 34:edda6a7238ec 63 */
Wolfgang Betz 34:edda6a7238ec 64
Wolfgang Betz 34:edda6a7238ec 65
Wolfgang Betz 34:edda6a7238ec 66 /**
Wolfgang Betz 34:edda6a7238ec 67 * @defgroup PktMbus_Private_Defines Pkt MBUS Private Defines
Wolfgang Betz 34:edda6a7238ec 68 * @{
Wolfgang Betz 34:edda6a7238ec 69 */
Wolfgang Betz 34:edda6a7238ec 70
Wolfgang Betz 34:edda6a7238ec 71 /**
Wolfgang Betz 34:edda6a7238ec 72 *@}
Wolfgang Betz 34:edda6a7238ec 73 */
Wolfgang Betz 34:edda6a7238ec 74
Wolfgang Betz 34:edda6a7238ec 75
Wolfgang Betz 34:edda6a7238ec 76 /**
Wolfgang Betz 34:edda6a7238ec 77 * @defgroup PktMbus_Private_Macros Pkt MBUS Private Macros
Wolfgang Betz 34:edda6a7238ec 78 * @{
Wolfgang Betz 34:edda6a7238ec 79 */
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
Wolfgang Betz 34:edda6a7238ec 86 /**
Wolfgang Betz 34:edda6a7238ec 87 * @defgroup PktMbus_Private_Variables Pkt MBUS Private Variables
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 *@}
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 * @defgroup PktMbus_Private_FunctionPrototypes Pkt MBUS Private Function Prototypes
Wolfgang Betz 34:edda6a7238ec 98 * @{
Wolfgang Betz 34:edda6a7238ec 99 */
Wolfgang Betz 34:edda6a7238ec 100
Wolfgang Betz 34:edda6a7238ec 101 /**
Wolfgang Betz 34:edda6a7238ec 102 *@}
Wolfgang Betz 34:edda6a7238ec 103 */
Wolfgang Betz 34:edda6a7238ec 104
Wolfgang Betz 34:edda6a7238ec 105
Wolfgang Betz 34:edda6a7238ec 106 /**
Wolfgang Betz 34:edda6a7238ec 107 * @defgroup PktMbus_Private_Functions Pkt MBUS Private Functions
Wolfgang Betz 34:edda6a7238ec 108 * @{
Wolfgang Betz 34:edda6a7238ec 109 */
Wolfgang Betz 34:edda6a7238ec 110
Wolfgang Betz 34:edda6a7238ec 111
Wolfgang Betz 34:edda6a7238ec 112 /**
Wolfgang Betz 34:edda6a7238ec 113 * @brief Initializes the SPIRIT MBUS packet according to the specified parameters in the PktMbusInit struct.
Wolfgang Betz 34:edda6a7238ec 114 * @param pxPktMbusInit pointer to a PktMbusInit structure that contains the configuration information for the specified SPIRIT MBUS PACKET FORMAT.
Wolfgang Betz 34:edda6a7238ec 115 * This parameter is a pointer to @ref PktMbusInit.
Wolfgang Betz 34:edda6a7238ec 116 * @retval None.
Wolfgang Betz 34:edda6a7238ec 117 */
Wolfgang Betz 34:edda6a7238ec 118 void SpiritPktMbusInit(PktMbusInit* pxPktMbusInit)
Wolfgang Betz 34:edda6a7238ec 119 {
Wolfgang Betz 34:edda6a7238ec 120 uint8_t tempRegValue[3];
Wolfgang Betz 34:edda6a7238ec 121
Wolfgang Betz 34:edda6a7238ec 122 /* Check the parameters */
Wolfgang Betz 34:edda6a7238ec 123 s_assert_param(IS_MBUS_SUBMODE(pxPktMbusInit->xMbusSubmode));
Wolfgang Betz 34:edda6a7238ec 124
Wolfgang Betz 34:edda6a7238ec 125 /* Packet format config */
Wolfgang Betz 34:edda6a7238ec 126 SpiritPktMbusSetFormat();
Wolfgang Betz 34:edda6a7238ec 127 SpiritPktCommonFilterOnCrc(S_DISABLE);
Wolfgang Betz 34:edda6a7238ec 128 SpiritRadioCsBlanking(S_ENABLE);
Wolfgang Betz 34:edda6a7238ec 129
Wolfgang Betz 34:edda6a7238ec 130 /* Preamble, postamble and submode config */
Wolfgang Betz 34:edda6a7238ec 131 tempRegValue[0] = pxPktMbusInit->cPreambleLength;
Wolfgang Betz 34:edda6a7238ec 132 tempRegValue[1] = pxPktMbusInit->cPostambleLength;
Wolfgang Betz 34:edda6a7238ec 133 tempRegValue[2] = (uint8_t) pxPktMbusInit->xMbusSubmode;
Wolfgang Betz 34:edda6a7238ec 134
Wolfgang Betz 34:edda6a7238ec 135 /* Writes the new values on the MBUS_PRMBL registers */
Wolfgang Betz 34:edda6a7238ec 136 g_xStatus = SpiritSpiWriteRegisters(MBUS_PRMBL_BASE, 3, tempRegValue);
Wolfgang Betz 34:edda6a7238ec 137
Wolfgang Betz 34:edda6a7238ec 138 }
Wolfgang Betz 34:edda6a7238ec 139
Wolfgang Betz 34:edda6a7238ec 140 /**
Wolfgang Betz 34:edda6a7238ec 141 * @brief Returns the SPIRIT MBUS packet structure according to the specified parameters in the registers.
Wolfgang Betz 34:edda6a7238ec 142 * @param pxPktMbusInit MBUS packet init structure.
Wolfgang Betz 34:edda6a7238ec 143 * This parameter is a pointer to @ref PktMbusInit.
Wolfgang Betz 34:edda6a7238ec 144 * @retval None.
Wolfgang Betz 34:edda6a7238ec 145 */
Wolfgang Betz 34:edda6a7238ec 146 void SpiritPktMbusGetInfo(PktMbusInit* pxPktMbusInit)
Wolfgang Betz 34:edda6a7238ec 147 {
Wolfgang Betz 34:edda6a7238ec 148 uint8_t tempRegValue[3];
Wolfgang Betz 34:edda6a7238ec 149
Wolfgang Betz 34:edda6a7238ec 150 /* Reads the MBUS regs value */
Wolfgang Betz 34:edda6a7238ec 151 g_xStatus = SpiritSpiReadRegisters(MBUS_PRMBL_BASE, 3, tempRegValue);
Wolfgang Betz 34:edda6a7238ec 152
Wolfgang Betz 34:edda6a7238ec 153 /* Fit the structure */
Wolfgang Betz 34:edda6a7238ec 154 pxPktMbusInit->cPreambleLength = tempRegValue[0];
Wolfgang Betz 34:edda6a7238ec 155 pxPktMbusInit->cPostambleLength = tempRegValue[1];
Wolfgang Betz 34:edda6a7238ec 156 pxPktMbusInit->xMbusSubmode = (MbusSubmode) (tempRegValue[2]&0x0E);
Wolfgang Betz 34:edda6a7238ec 157
Wolfgang Betz 34:edda6a7238ec 158 }
Wolfgang Betz 34:edda6a7238ec 159
Wolfgang Betz 34:edda6a7238ec 160
Wolfgang Betz 34:edda6a7238ec 161 /**
Wolfgang Betz 34:edda6a7238ec 162 * @brief Configures the MBUS packet format as the one used by SPIRIT.
Wolfgang Betz 34:edda6a7238ec 163 * @param None.
Wolfgang Betz 34:edda6a7238ec 164 * @retval None.
Wolfgang Betz 34:edda6a7238ec 165 */
Wolfgang Betz 34:edda6a7238ec 166 void SpiritPktMbusSetFormat(void)
Wolfgang Betz 34:edda6a7238ec 167 {
Wolfgang Betz 34:edda6a7238ec 168 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 169
Wolfgang Betz 34:edda6a7238ec 170 /* Reads the PCKTCTRL3 register value */
Wolfgang Betz 34:edda6a7238ec 171 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 172
Wolfgang Betz 34:edda6a7238ec 173 /* Sets format bits. Also set to 0 the direct RX mode bits */
Wolfgang Betz 34:edda6a7238ec 174 tempRegValue &= 0x0F;
Wolfgang Betz 34:edda6a7238ec 175 tempRegValue |= ((uint8_t)PCKTCTRL3_PCKT_FRMT_MBUS);
Wolfgang Betz 34:edda6a7238ec 176
Wolfgang Betz 34:edda6a7238ec 177 /* Writes value on the PCKTCTRL3 register */
Wolfgang Betz 34:edda6a7238ec 178 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 179
Wolfgang Betz 34:edda6a7238ec 180 /* Reads the PCKTCTRL1 register value */
Wolfgang Betz 34:edda6a7238ec 181 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 182
Wolfgang Betz 34:edda6a7238ec 183 /* Build the new value. Set to 0 the direct TX mode bits */
Wolfgang Betz 34:edda6a7238ec 184 tempRegValue &= 0xF3;
Wolfgang Betz 34:edda6a7238ec 185
Wolfgang Betz 34:edda6a7238ec 186 /* Writes the value on the PCKTCTRL1 register */
Wolfgang Betz 34:edda6a7238ec 187 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 188
Wolfgang Betz 34:edda6a7238ec 189 /* Reads the PROTOCOL1 register */
Wolfgang Betz 34:edda6a7238ec 190 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 191
Wolfgang Betz 34:edda6a7238ec 192 /* Mask a reserved bit */
Wolfgang Betz 34:edda6a7238ec 193 tempRegValue &= ~0x20;
Wolfgang Betz 34:edda6a7238ec 194
Wolfgang Betz 34:edda6a7238ec 195 /* Writes the value on the PROTOCOL1 register */
Wolfgang Betz 34:edda6a7238ec 196 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 197
Wolfgang Betz 34:edda6a7238ec 198 }
Wolfgang Betz 34:edda6a7238ec 199
Wolfgang Betz 34:edda6a7238ec 200
Wolfgang Betz 34:edda6a7238ec 201 /**
Wolfgang Betz 34:edda6a7238ec 202 * @brief Sets how many chip sequence “01” shall be added in the preamble
Wolfgang Betz 34:edda6a7238ec 203 * respect to the minimum value as defined according to the specified sub-mode.
Wolfgang Betz 34:edda6a7238ec 204 * @param cPreamble the number of chip sequence.
Wolfgang Betz 34:edda6a7238ec 205 * This parameter is an uint8_t.
Wolfgang Betz 34:edda6a7238ec 206 * @retval None.
Wolfgang Betz 34:edda6a7238ec 207 */
Wolfgang Betz 34:edda6a7238ec 208 void SpiritPktMbusSetPreamble(uint8_t cPreamble)
Wolfgang Betz 34:edda6a7238ec 209 {
Wolfgang Betz 34:edda6a7238ec 210 /* Modifies the MBUS_PRMBL register value */
Wolfgang Betz 34:edda6a7238ec 211 g_xStatus = SpiritSpiWriteRegisters(MBUS_PRMBL_BASE, 1, &cPreamble);
Wolfgang Betz 34:edda6a7238ec 212
Wolfgang Betz 34:edda6a7238ec 213 }
Wolfgang Betz 34:edda6a7238ec 214
Wolfgang Betz 34:edda6a7238ec 215
Wolfgang Betz 34:edda6a7238ec 216 /**
Wolfgang Betz 34:edda6a7238ec 217 * @brief Returns how many chip sequence "01" are added in the preamble
Wolfgang Betz 34:edda6a7238ec 218 * respect to the minimum value as defined according to the specified sub-mode.
Wolfgang Betz 34:edda6a7238ec 219 * @param None.
Wolfgang Betz 34:edda6a7238ec 220 * @retval uint8_t Preable in number of "01" chip sequences.
Wolfgang Betz 34:edda6a7238ec 221 */
Wolfgang Betz 34:edda6a7238ec 222 uint8_t SpiritPktMbusGetPreamble(void)
Wolfgang Betz 34:edda6a7238ec 223 {
Wolfgang Betz 34:edda6a7238ec 224 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 225
Wolfgang Betz 34:edda6a7238ec 226 /* Modifies the MBUS_PRMBL register value */
Wolfgang Betz 34:edda6a7238ec 227 g_xStatus = SpiritSpiReadRegisters(MBUS_PRMBL_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 228
Wolfgang Betz 34:edda6a7238ec 229 /* Return value */
Wolfgang Betz 34:edda6a7238ec 230 return tempRegValue;
Wolfgang Betz 34:edda6a7238ec 231
Wolfgang Betz 34:edda6a7238ec 232 }
Wolfgang Betz 34:edda6a7238ec 233
Wolfgang Betz 34:edda6a7238ec 234
Wolfgang Betz 34:edda6a7238ec 235 /**
Wolfgang Betz 34:edda6a7238ec 236 * @brief Sets how many chip sequence “01” will be used in postamble
Wolfgang Betz 34:edda6a7238ec 237 * @param cPostamble the number of chip sequence.
Wolfgang Betz 34:edda6a7238ec 238 * This parameter is an uint8_t.
Wolfgang Betz 34:edda6a7238ec 239 * @retval None.
Wolfgang Betz 34:edda6a7238ec 240 */
Wolfgang Betz 34:edda6a7238ec 241 void SpiritPktMbusSetPostamble(uint8_t cPostamble)
Wolfgang Betz 34:edda6a7238ec 242 {
Wolfgang Betz 34:edda6a7238ec 243 /* Modifies the MBUS_PSTMBL register value */
Wolfgang Betz 34:edda6a7238ec 244 g_xStatus = SpiritSpiWriteRegisters(MBUS_PSTMBL_BASE, 1, &cPostamble);
Wolfgang Betz 34:edda6a7238ec 245
Wolfgang Betz 34:edda6a7238ec 246 }
Wolfgang Betz 34:edda6a7238ec 247
Wolfgang Betz 34:edda6a7238ec 248
Wolfgang Betz 34:edda6a7238ec 249 /**
Wolfgang Betz 34:edda6a7238ec 250 * @brief Returns how many chip sequence "01" are used in the postamble
Wolfgang Betz 34:edda6a7238ec 251 * @param None.
Wolfgang Betz 34:edda6a7238ec 252 * @retval uint8_t Postamble in number of "01" chip sequences.
Wolfgang Betz 34:edda6a7238ec 253 */
Wolfgang Betz 34:edda6a7238ec 254 uint8_t SpiritPktMbusGetPostamble(void)
Wolfgang Betz 34:edda6a7238ec 255 {
Wolfgang Betz 34:edda6a7238ec 256 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 257
Wolfgang Betz 34:edda6a7238ec 258 /* Reads the MBUS_PSTMBL register */
Wolfgang Betz 34:edda6a7238ec 259 g_xStatus = SpiritSpiReadRegisters(MBUS_PSTMBL_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 260
Wolfgang Betz 34:edda6a7238ec 261 /* Returns value */
Wolfgang Betz 34:edda6a7238ec 262 return tempRegValue;
Wolfgang Betz 34:edda6a7238ec 263
Wolfgang Betz 34:edda6a7238ec 264 }
Wolfgang Betz 34:edda6a7238ec 265
Wolfgang Betz 34:edda6a7238ec 266
Wolfgang Betz 34:edda6a7238ec 267 /**
Wolfgang Betz 34:edda6a7238ec 268 * @brief Sets the MBUS submode used.
Wolfgang Betz 34:edda6a7238ec 269 * @param xMbusSubmode the submode used.
Wolfgang Betz 34:edda6a7238ec 270 * This parameter can be any value of @ref MbusSubmode.
Wolfgang Betz 34:edda6a7238ec 271 * @retval None.
Wolfgang Betz 34:edda6a7238ec 272 */
Wolfgang Betz 34:edda6a7238ec 273 void SpiritPktMbusSetSubmode(MbusSubmode xMbusSubmode)
Wolfgang Betz 34:edda6a7238ec 274 {
Wolfgang Betz 34:edda6a7238ec 275 /* Modifies the MBUS_CTRL register value */
Wolfgang Betz 34:edda6a7238ec 276 g_xStatus = SpiritSpiWriteRegisters(MBUS_CTRL_BASE, 1, (uint8_t*)xMbusSubmode);
Wolfgang Betz 34:edda6a7238ec 277
Wolfgang Betz 34:edda6a7238ec 278 }
Wolfgang Betz 34:edda6a7238ec 279
Wolfgang Betz 34:edda6a7238ec 280
Wolfgang Betz 34:edda6a7238ec 281 /**
Wolfgang Betz 34:edda6a7238ec 282 * @brief Returns the MBUS submode used.
Wolfgang Betz 34:edda6a7238ec 283 * @param None.
Wolfgang Betz 34:edda6a7238ec 284 * @retval MbusSubmode MBUS submode.
Wolfgang Betz 34:edda6a7238ec 285 */
Wolfgang Betz 34:edda6a7238ec 286 MbusSubmode SpiritPktMbusGetSubmode(void)
Wolfgang Betz 34:edda6a7238ec 287 {
Wolfgang Betz 34:edda6a7238ec 288 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 289
Wolfgang Betz 34:edda6a7238ec 290 /* Reads the MBUS_CTRL register value */
Wolfgang Betz 34:edda6a7238ec 291 g_xStatus = SpiritSpiReadRegisters(MBUS_CTRL_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 292
Wolfgang Betz 34:edda6a7238ec 293 /* Returns value */
Wolfgang Betz 34:edda6a7238ec 294 return (MbusSubmode) tempRegValue;
Wolfgang Betz 34:edda6a7238ec 295
Wolfgang Betz 34:edda6a7238ec 296 }
Wolfgang Betz 34:edda6a7238ec 297
Wolfgang Betz 34:edda6a7238ec 298
Wolfgang Betz 34:edda6a7238ec 299 /**
Wolfgang Betz 34:edda6a7238ec 300 * @brief Sets the payload length for SPIRIT MBUS packets.
Wolfgang Betz 34:edda6a7238ec 301 * @param nPayloadLength payload length in bytes.
Wolfgang Betz 34:edda6a7238ec 302 * This parameter is an uint16_t.
Wolfgang Betz 34:edda6a7238ec 303 * @retval None.
Wolfgang Betz 34:edda6a7238ec 304 */
Wolfgang Betz 34:edda6a7238ec 305 void SpiritPktMbusSetPayloadLength(uint16_t nPayloadLength)
Wolfgang Betz 34:edda6a7238ec 306 {
Wolfgang Betz 34:edda6a7238ec 307 uint8_t tempRegValue[2];
Wolfgang Betz 34:edda6a7238ec 308
Wolfgang Betz 34:edda6a7238ec 309 /* Computes PCKTLEN0 value from nPayloadLength */
Wolfgang Betz 34:edda6a7238ec 310 tempRegValue[1]=BUILD_PCKTLEN0(nPayloadLength);//(uint8_t)nPayloadLength;
Wolfgang Betz 34:edda6a7238ec 311 /* Computes PCKTLEN1 value from nPayloadLength */
Wolfgang Betz 34:edda6a7238ec 312 tempRegValue[0]=BUILD_PCKTLEN1(nPayloadLength);//(uint8_t)(nPayloadLength>>8);
Wolfgang Betz 34:edda6a7238ec 313
Wolfgang Betz 34:edda6a7238ec 314 /* Writes data on the PCKTLEN1/0 register */
Wolfgang Betz 34:edda6a7238ec 315 g_xStatus = SpiritSpiWriteRegisters(PCKTLEN1_BASE, 2, tempRegValue);
Wolfgang Betz 34:edda6a7238ec 316
Wolfgang Betz 34:edda6a7238ec 317 }
Wolfgang Betz 34:edda6a7238ec 318
Wolfgang Betz 34:edda6a7238ec 319
Wolfgang Betz 34:edda6a7238ec 320 /**
Wolfgang Betz 34:edda6a7238ec 321 * @brief Returns the payload length for SPIRIT MBUS packets.
Wolfgang Betz 34:edda6a7238ec 322 * @param None.
Wolfgang Betz 34:edda6a7238ec 323 * @retval uint16_t Payload length in bytes.
Wolfgang Betz 34:edda6a7238ec 324 */
Wolfgang Betz 34:edda6a7238ec 325 uint16_t SpiritPktMbusGetPayloadLength(void)
Wolfgang Betz 34:edda6a7238ec 326 {
Wolfgang Betz 34:edda6a7238ec 327 uint8_t tempRegValue[2];
Wolfgang Betz 34:edda6a7238ec 328
Wolfgang Betz 34:edda6a7238ec 329 /* Reads the packet length registers */
Wolfgang Betz 34:edda6a7238ec 330 g_xStatus = SpiritSpiReadRegisters(PCKTLEN1_BASE, 2, tempRegValue);
Wolfgang Betz 34:edda6a7238ec 331
Wolfgang Betz 34:edda6a7238ec 332 /* Returns the packet length */
Wolfgang Betz 34:edda6a7238ec 333 return ((((uint16_t)tempRegValue[0])<<8) + (uint16_t) tempRegValue[1]);
Wolfgang Betz 34:edda6a7238ec 334
Wolfgang Betz 34:edda6a7238ec 335 }
Wolfgang Betz 34:edda6a7238ec 336
Wolfgang Betz 34:edda6a7238ec 337 /**
Wolfgang Betz 34:edda6a7238ec 338 *@}
Wolfgang Betz 34:edda6a7238ec 339 */
Wolfgang Betz 34:edda6a7238ec 340
Wolfgang Betz 34:edda6a7238ec 341 /**
Wolfgang Betz 34:edda6a7238ec 342 *@}
Wolfgang Betz 34:edda6a7238ec 343 */
Wolfgang Betz 34:edda6a7238ec 344
Wolfgang Betz 34:edda6a7238ec 345
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
Wolfgang Betz 34:edda6a7238ec 354 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/