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@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_PktMbus.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 MBUS 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_PktMbus.h"
Wolfgang Betz 67:93bec0baf1de 41 #include "SPIRIT_Radio.h"
Wolfgang Betz 67:93bec0baf1de 42 #include "MCU_Interface.h"
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_PktMbus
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 PktMbus_Private_TypesDefinitions Pkt MBUS 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 PktMbus_Private_Defines Pkt MBUS 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 PktMbus_Private_Macros Pkt MBUS 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 PktMbus_Private_Variables Pkt MBUS 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 PktMbus_Private_FunctionPrototypes Pkt MBUS 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 PktMbus_Private_Functions Pkt MBUS 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 MBUS packet according to the specified parameters in the PktMbusInit struct.
Wolfgang Betz 67:93bec0baf1de 114 * @param pxPktMbusInit pointer to a PktMbusInit structure that contains the configuration information for the specified SPIRIT MBUS PACKET FORMAT.
Wolfgang Betz 67:93bec0baf1de 115 * This parameter is a pointer to @ref PktMbusInit.
Wolfgang Betz 67:93bec0baf1de 116 * @retval None.
Wolfgang Betz 67:93bec0baf1de 117 */
Wolfgang Betz 67:93bec0baf1de 118 void SpiritPktMbusInit(PktMbusInit* pxPktMbusInit)
Wolfgang Betz 67:93bec0baf1de 119 {
Wolfgang Betz 67:93bec0baf1de 120 uint8_t tempRegValue[3];
Wolfgang Betz 67:93bec0baf1de 121
Wolfgang Betz 67:93bec0baf1de 122 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 123 s_assert_param(IS_MBUS_SUBMODE(pxPktMbusInit->xMbusSubmode));
Wolfgang Betz 67:93bec0baf1de 124
Wolfgang Betz 67:93bec0baf1de 125 /* Packet format config */
Wolfgang Betz 67:93bec0baf1de 126 SpiritPktMbusSetFormat();
Wolfgang Betz 67:93bec0baf1de 127 SpiritPktCommonFilterOnCrc(S_DISABLE);
Wolfgang Betz 67:93bec0baf1de 128 SpiritRadioCsBlanking(S_ENABLE);
Wolfgang Betz 67:93bec0baf1de 129
Wolfgang Betz 67:93bec0baf1de 130 /* Preamble, postamble and submode config */
Wolfgang Betz 67:93bec0baf1de 131 tempRegValue[0] = pxPktMbusInit->cPreambleLength;
Wolfgang Betz 67:93bec0baf1de 132 tempRegValue[1] = pxPktMbusInit->cPostambleLength;
Wolfgang Betz 67:93bec0baf1de 133 tempRegValue[2] = (uint8_t) pxPktMbusInit->xMbusSubmode;
Wolfgang Betz 67:93bec0baf1de 134
Wolfgang Betz 67:93bec0baf1de 135 /* Writes the new values on the MBUS_PRMBL registers */
Wolfgang Betz 67:93bec0baf1de 136 g_xStatus = SpiritSpiWriteRegisters(MBUS_PRMBL_BASE, 3, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 137
Wolfgang Betz 67:93bec0baf1de 138 }
Wolfgang Betz 67:93bec0baf1de 139
Wolfgang Betz 67:93bec0baf1de 140 /**
Wolfgang Betz 67:93bec0baf1de 141 * @brief Returns the SPIRIT MBUS packet structure according to the specified parameters in the registers.
Wolfgang Betz 67:93bec0baf1de 142 * @param pxPktMbusInit MBUS packet init structure.
Wolfgang Betz 67:93bec0baf1de 143 * This parameter is a pointer to @ref PktMbusInit.
Wolfgang Betz 67:93bec0baf1de 144 * @retval None.
Wolfgang Betz 67:93bec0baf1de 145 */
Wolfgang Betz 67:93bec0baf1de 146 void SpiritPktMbusGetInfo(PktMbusInit* pxPktMbusInit)
Wolfgang Betz 67:93bec0baf1de 147 {
Wolfgang Betz 67:93bec0baf1de 148 uint8_t tempRegValue[3];
Wolfgang Betz 67:93bec0baf1de 149
Wolfgang Betz 67:93bec0baf1de 150 /* Reads the MBUS regs value */
Wolfgang Betz 67:93bec0baf1de 151 g_xStatus = SpiritSpiReadRegisters(MBUS_PRMBL_BASE, 3, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 152
Wolfgang Betz 67:93bec0baf1de 153 /* Fit the structure */
Wolfgang Betz 67:93bec0baf1de 154 pxPktMbusInit->cPreambleLength = tempRegValue[0];
Wolfgang Betz 67:93bec0baf1de 155 pxPktMbusInit->cPostambleLength = tempRegValue[1];
Wolfgang Betz 67:93bec0baf1de 156 pxPktMbusInit->xMbusSubmode = (MbusSubmode) (tempRegValue[2]&0x0E);
Wolfgang Betz 67:93bec0baf1de 157
Wolfgang Betz 67:93bec0baf1de 158 }
Wolfgang Betz 67:93bec0baf1de 159
Wolfgang Betz 67:93bec0baf1de 160
Wolfgang Betz 67:93bec0baf1de 161 /**
Wolfgang Betz 67:93bec0baf1de 162 * @brief Configures the MBUS packet format as the one used by SPIRIT.
Wolfgang Betz 67:93bec0baf1de 163 * @param None.
Wolfgang Betz 67:93bec0baf1de 164 * @retval None.
Wolfgang Betz 67:93bec0baf1de 165 */
Wolfgang Betz 67:93bec0baf1de 166 void SpiritPktMbusSetFormat(void)
Wolfgang Betz 67:93bec0baf1de 167 {
Wolfgang Betz 67:93bec0baf1de 168 uint8_t tempRegValue;
Wolfgang Betz 67:93bec0baf1de 169
Wolfgang Betz 67:93bec0baf1de 170 /* Reads the PCKTCTRL3 register value */
Wolfgang Betz 67:93bec0baf1de 171 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 172
Wolfgang Betz 67:93bec0baf1de 173 /* Sets format bits. Also set to 0 the direct RX mode bits */
Wolfgang Betz 67:93bec0baf1de 174 tempRegValue &= 0x0F;
Wolfgang Betz 67:93bec0baf1de 175 tempRegValue |= ((uint8_t)PCKTCTRL3_PCKT_FRMT_MBUS);
Wolfgang Betz 67:93bec0baf1de 176
Wolfgang Betz 67:93bec0baf1de 177 /* Writes value on the PCKTCTRL3 register */
Wolfgang Betz 67:93bec0baf1de 178 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 179
Wolfgang Betz 67:93bec0baf1de 180 /* Reads the PCKTCTRL1 register value */
Wolfgang Betz 67:93bec0baf1de 181 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 182
Wolfgang Betz 67:93bec0baf1de 183 /* Build the new value. Set to 0 the direct TX mode bits */
Wolfgang Betz 67:93bec0baf1de 184 tempRegValue &= 0xF3;
Wolfgang Betz 67:93bec0baf1de 185
Wolfgang Betz 67:93bec0baf1de 186 /* Writes the value on the PCKTCTRL1 register */
Wolfgang Betz 67:93bec0baf1de 187 g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL1_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 188
Wolfgang Betz 67:93bec0baf1de 189 /* Reads the PROTOCOL1 register */
Wolfgang Betz 67:93bec0baf1de 190 g_xStatus = SpiritSpiReadRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 191
Wolfgang Betz 67:93bec0baf1de 192 /* Mask a reserved bit */
Wolfgang Betz 67:93bec0baf1de 193 tempRegValue &= ~0x20;
Wolfgang Betz 67:93bec0baf1de 194
Wolfgang Betz 67:93bec0baf1de 195 /* Writes the value on the PROTOCOL1 register */
Wolfgang Betz 67:93bec0baf1de 196 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL1_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 197
Wolfgang Betz 67:93bec0baf1de 198 }
Wolfgang Betz 67:93bec0baf1de 199
Wolfgang Betz 67:93bec0baf1de 200
Wolfgang Betz 67:93bec0baf1de 201 /**
Wolfgang Betz 67:93bec0baf1de 202 * @brief Sets how many chip sequence “01” shall be added in the preamble
Wolfgang Betz 67:93bec0baf1de 203 * respect to the minimum value as defined according to the specified sub-mode.
Wolfgang Betz 67:93bec0baf1de 204 * @param cPreamble the number of chip sequence.
Wolfgang Betz 67:93bec0baf1de 205 * This parameter is an uint8_t.
Wolfgang Betz 67:93bec0baf1de 206 * @retval None.
Wolfgang Betz 67:93bec0baf1de 207 */
Wolfgang Betz 67:93bec0baf1de 208 void SpiritPktMbusSetPreamble(uint8_t cPreamble)
Wolfgang Betz 67:93bec0baf1de 209 {
Wolfgang Betz 67:93bec0baf1de 210 /* Modifies the MBUS_PRMBL register value */
Wolfgang Betz 67:93bec0baf1de 211 g_xStatus = SpiritSpiWriteRegisters(MBUS_PRMBL_BASE, 1, &cPreamble);
Wolfgang Betz 67:93bec0baf1de 212
Wolfgang Betz 67:93bec0baf1de 213 }
Wolfgang Betz 67:93bec0baf1de 214
Wolfgang Betz 67:93bec0baf1de 215
Wolfgang Betz 67:93bec0baf1de 216 /**
Wolfgang Betz 67:93bec0baf1de 217 * @brief Returns how many chip sequence "01" are added in the preamble
Wolfgang Betz 67:93bec0baf1de 218 * respect to the minimum value as defined according to the specified sub-mode.
Wolfgang Betz 67:93bec0baf1de 219 * @param None.
Wolfgang Betz 67:93bec0baf1de 220 * @retval uint8_t Preable in number of "01" chip sequences.
Wolfgang Betz 67:93bec0baf1de 221 */
Wolfgang Betz 67:93bec0baf1de 222 uint8_t SpiritPktMbusGetPreamble(void)
Wolfgang Betz 67:93bec0baf1de 223 {
Wolfgang Betz 67:93bec0baf1de 224 uint8_t tempRegValue;
Wolfgang Betz 67:93bec0baf1de 225
Wolfgang Betz 67:93bec0baf1de 226 /* Modifies the MBUS_PRMBL register value */
Wolfgang Betz 67:93bec0baf1de 227 g_xStatus = SpiritSpiReadRegisters(MBUS_PRMBL_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 228
Wolfgang Betz 67:93bec0baf1de 229 /* Return value */
Wolfgang Betz 67:93bec0baf1de 230 return tempRegValue;
Wolfgang Betz 67:93bec0baf1de 231
Wolfgang Betz 67:93bec0baf1de 232 }
Wolfgang Betz 67:93bec0baf1de 233
Wolfgang Betz 67:93bec0baf1de 234
Wolfgang Betz 67:93bec0baf1de 235 /**
Wolfgang Betz 67:93bec0baf1de 236 * @brief Sets how many chip sequence “01” will be used in postamble
Wolfgang Betz 67:93bec0baf1de 237 * @param cPostamble the number of chip sequence.
Wolfgang Betz 67:93bec0baf1de 238 * This parameter is an uint8_t.
Wolfgang Betz 67:93bec0baf1de 239 * @retval None.
Wolfgang Betz 67:93bec0baf1de 240 */
Wolfgang Betz 67:93bec0baf1de 241 void SpiritPktMbusSetPostamble(uint8_t cPostamble)
Wolfgang Betz 67:93bec0baf1de 242 {
Wolfgang Betz 67:93bec0baf1de 243 /* Modifies the MBUS_PSTMBL register value */
Wolfgang Betz 67:93bec0baf1de 244 g_xStatus = SpiritSpiWriteRegisters(MBUS_PSTMBL_BASE, 1, &cPostamble);
Wolfgang Betz 67:93bec0baf1de 245
Wolfgang Betz 67:93bec0baf1de 246 }
Wolfgang Betz 67:93bec0baf1de 247
Wolfgang Betz 67:93bec0baf1de 248
Wolfgang Betz 67:93bec0baf1de 249 /**
Wolfgang Betz 67:93bec0baf1de 250 * @brief Returns how many chip sequence "01" are used in the postamble
Wolfgang Betz 67:93bec0baf1de 251 * @param None.
Wolfgang Betz 67:93bec0baf1de 252 * @retval uint8_t Postamble in number of "01" chip sequences.
Wolfgang Betz 67:93bec0baf1de 253 */
Wolfgang Betz 67:93bec0baf1de 254 uint8_t SpiritPktMbusGetPostamble(void)
Wolfgang Betz 67:93bec0baf1de 255 {
Wolfgang Betz 67:93bec0baf1de 256 uint8_t tempRegValue;
Wolfgang Betz 67:93bec0baf1de 257
Wolfgang Betz 67:93bec0baf1de 258 /* Reads the MBUS_PSTMBL register */
Wolfgang Betz 67:93bec0baf1de 259 g_xStatus = SpiritSpiReadRegisters(MBUS_PSTMBL_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 260
Wolfgang Betz 67:93bec0baf1de 261 /* Returns value */
Wolfgang Betz 67:93bec0baf1de 262 return tempRegValue;
Wolfgang Betz 67:93bec0baf1de 263
Wolfgang Betz 67:93bec0baf1de 264 }
Wolfgang Betz 67:93bec0baf1de 265
Wolfgang Betz 67:93bec0baf1de 266
Wolfgang Betz 67:93bec0baf1de 267 /**
Wolfgang Betz 67:93bec0baf1de 268 * @brief Sets the MBUS submode used.
Wolfgang Betz 67:93bec0baf1de 269 * @param xMbusSubmode the submode used.
Wolfgang Betz 67:93bec0baf1de 270 * This parameter can be any value of @ref MbusSubmode.
Wolfgang Betz 67:93bec0baf1de 271 * @retval None.
Wolfgang Betz 67:93bec0baf1de 272 */
Wolfgang Betz 67:93bec0baf1de 273 void SpiritPktMbusSetSubmode(MbusSubmode xMbusSubmode)
Wolfgang Betz 67:93bec0baf1de 274 {
Wolfgang Betz 67:93bec0baf1de 275 /* Modifies the MBUS_CTRL register value */
Wolfgang Betz 67:93bec0baf1de 276 g_xStatus = SpiritSpiWriteRegisters(MBUS_CTRL_BASE, 1, (uint8_t*)xMbusSubmode);
Wolfgang Betz 67:93bec0baf1de 277
Wolfgang Betz 67:93bec0baf1de 278 }
Wolfgang Betz 67:93bec0baf1de 279
Wolfgang Betz 67:93bec0baf1de 280
Wolfgang Betz 67:93bec0baf1de 281 /**
Wolfgang Betz 67:93bec0baf1de 282 * @brief Returns the MBUS submode used.
Wolfgang Betz 67:93bec0baf1de 283 * @param None.
Wolfgang Betz 67:93bec0baf1de 284 * @retval MbusSubmode MBUS submode.
Wolfgang Betz 67:93bec0baf1de 285 */
Wolfgang Betz 67:93bec0baf1de 286 MbusSubmode SpiritPktMbusGetSubmode(void)
Wolfgang Betz 67:93bec0baf1de 287 {
Wolfgang Betz 67:93bec0baf1de 288 uint8_t tempRegValue;
Wolfgang Betz 67:93bec0baf1de 289
Wolfgang Betz 67:93bec0baf1de 290 /* Reads the MBUS_CTRL register value */
Wolfgang Betz 67:93bec0baf1de 291 g_xStatus = SpiritSpiReadRegisters(MBUS_CTRL_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 292
Wolfgang Betz 67:93bec0baf1de 293 /* Returns value */
Wolfgang Betz 67:93bec0baf1de 294 return (MbusSubmode) tempRegValue;
Wolfgang Betz 67:93bec0baf1de 295
Wolfgang Betz 67:93bec0baf1de 296 }
Wolfgang Betz 67:93bec0baf1de 297
Wolfgang Betz 67:93bec0baf1de 298
Wolfgang Betz 67:93bec0baf1de 299 /**
Wolfgang Betz 67:93bec0baf1de 300 * @brief Sets the payload length for SPIRIT MBUS packets.
Wolfgang Betz 67:93bec0baf1de 301 * @param nPayloadLength payload length in bytes.
Wolfgang Betz 67:93bec0baf1de 302 * This parameter is an uint16_t.
Wolfgang Betz 67:93bec0baf1de 303 * @retval None.
Wolfgang Betz 67:93bec0baf1de 304 */
Wolfgang Betz 67:93bec0baf1de 305 void SpiritPktMbusSetPayloadLength(uint16_t nPayloadLength)
Wolfgang Betz 67:93bec0baf1de 306 {
Wolfgang Betz 67:93bec0baf1de 307 uint8_t tempRegValue[2];
Wolfgang Betz 67:93bec0baf1de 308
Wolfgang Betz 67:93bec0baf1de 309 /* Computes PCKTLEN0 value from nPayloadLength */
Wolfgang Betz 67:93bec0baf1de 310 tempRegValue[1]=BUILD_PCKTLEN0(nPayloadLength);//(uint8_t)nPayloadLength;
Wolfgang Betz 67:93bec0baf1de 311 /* Computes PCKTLEN1 value from nPayloadLength */
Wolfgang Betz 67:93bec0baf1de 312 tempRegValue[0]=BUILD_PCKTLEN1(nPayloadLength);//(uint8_t)(nPayloadLength>>8);
Wolfgang Betz 67:93bec0baf1de 313
Wolfgang Betz 67:93bec0baf1de 314 /* Writes data on the PCKTLEN1/0 register */
Wolfgang Betz 67:93bec0baf1de 315 g_xStatus = SpiritSpiWriteRegisters(PCKTLEN1_BASE, 2, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 316
Wolfgang Betz 67:93bec0baf1de 317 }
Wolfgang Betz 67:93bec0baf1de 318
Wolfgang Betz 67:93bec0baf1de 319
Wolfgang Betz 67:93bec0baf1de 320 /**
Wolfgang Betz 67:93bec0baf1de 321 * @brief Returns the payload length for SPIRIT MBUS packets.
Wolfgang Betz 67:93bec0baf1de 322 * @param None.
Wolfgang Betz 67:93bec0baf1de 323 * @retval uint16_t Payload length in bytes.
Wolfgang Betz 67:93bec0baf1de 324 */
Wolfgang Betz 67:93bec0baf1de 325 uint16_t SpiritPktMbusGetPayloadLength(void)
Wolfgang Betz 67:93bec0baf1de 326 {
Wolfgang Betz 67:93bec0baf1de 327 uint8_t tempRegValue[2];
Wolfgang Betz 67:93bec0baf1de 328
Wolfgang Betz 67:93bec0baf1de 329 /* Reads the packet length registers */
Wolfgang Betz 67:93bec0baf1de 330 g_xStatus = SpiritSpiReadRegisters(PCKTLEN1_BASE, 2, tempRegValue);
Wolfgang Betz 67:93bec0baf1de 331
Wolfgang Betz 67:93bec0baf1de 332 /* Returns the packet length */
Wolfgang Betz 67:93bec0baf1de 333 return ((((uint16_t)tempRegValue[0])<<8) + (uint16_t) tempRegValue[1]);
Wolfgang Betz 67:93bec0baf1de 334
Wolfgang Betz 67:93bec0baf1de 335 }
Wolfgang Betz 67:93bec0baf1de 336
Wolfgang Betz 67:93bec0baf1de 337 /**
Wolfgang Betz 67:93bec0baf1de 338 *@}
Wolfgang Betz 67:93bec0baf1de 339 */
Wolfgang Betz 67:93bec0baf1de 340
Wolfgang Betz 67:93bec0baf1de 341 /**
Wolfgang Betz 67:93bec0baf1de 342 *@}
Wolfgang Betz 67:93bec0baf1de 343 */
Wolfgang Betz 67:93bec0baf1de 344
Wolfgang Betz 67:93bec0baf1de 345
Wolfgang Betz 67:93bec0baf1de 346 /**
Wolfgang Betz 67:93bec0baf1de 347 *@}
Wolfgang Betz 67:93bec0baf1de 348 */
Wolfgang Betz 67:93bec0baf1de 349
Wolfgang Betz 67:93bec0baf1de 350
Wolfgang Betz 67:93bec0baf1de 351
Wolfgang Betz 67:93bec0baf1de 352
Wolfgang Betz 67:93bec0baf1de 353
Wolfgang Betz 67:93bec0baf1de 354 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/