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