ST
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).
libs/spirit1/SPIRIT1_Library/Src/SPIRIT_DirectRF.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_DirectRF.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 direct transmission / receive modes. |
| Wolfgang Betz |
0:4fb29d9ee571 | 8 | * @details |
| Wolfgang Betz |
0:4fb29d9ee571 | 9 | * @attention |
| Wolfgang Betz |
0:4fb29d9ee571 | 10 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 11 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> |
| Wolfgang Betz |
0:4fb29d9ee571 | 12 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 13 | * Redistribution and use in source and binary forms, with or without modification, |
| Wolfgang Betz |
0:4fb29d9ee571 | 14 | * are permitted provided that the following conditions are met: |
| Wolfgang Betz |
0:4fb29d9ee571 | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
| Wolfgang Betz |
0:4fb29d9ee571 | 16 | * this list of conditions and the following disclaimer. |
| Wolfgang Betz |
0:4fb29d9ee571 | 17 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| Wolfgang Betz |
0:4fb29d9ee571 | 18 | * this list of conditions and the following disclaimer in the documentation |
| Wolfgang Betz |
0:4fb29d9ee571 | 19 | * and/or other materials provided with the distribution. |
| Wolfgang Betz |
0:4fb29d9ee571 | 20 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
| Wolfgang Betz |
0:4fb29d9ee571 | 21 | * may be used to endorse or promote products derived from this software |
| Wolfgang Betz |
0:4fb29d9ee571 | 22 | * without specific prior written permission. |
| Wolfgang Betz |
0:4fb29d9ee571 | 23 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| Wolfgang Betz |
0:4fb29d9ee571 | 25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| Wolfgang Betz |
0:4fb29d9ee571 | 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| Wolfgang Betz |
0:4fb29d9ee571 | 27 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
| Wolfgang Betz |
0:4fb29d9ee571 | 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| Wolfgang Betz |
0:4fb29d9ee571 | 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| Wolfgang Betz |
0:4fb29d9ee571 | 30 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| Wolfgang Betz |
0:4fb29d9ee571 | 31 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| Wolfgang Betz |
0:4fb29d9ee571 | 32 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| Wolfgang Betz |
0:4fb29d9ee571 | 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| Wolfgang Betz |
0:4fb29d9ee571 | 34 | * |
| Wolfgang Betz |
0:4fb29d9ee571 | 35 | ****************************************************************************** |
| Wolfgang Betz |
0:4fb29d9ee571 | 36 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 37 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 38 | /* Includes ------------------------------------------------------------------*/ |
| Wolfgang Betz |
0:4fb29d9ee571 | 39 | #include "SPIRIT_DirectRF.h" |
| Wolfgang Betz |
0:4fb29d9ee571 | 40 | #include "MCU_Interface.h" |
| Wolfgang Betz |
0:4fb29d9ee571 | 41 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 42 | |
| 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_DirectRf |
| 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 DirectRf_Private_TypesDefinitions Direct RF 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 DirectRf_Private_Defines Direct RF 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 DirectRf_Private_Macros Direct RF 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 DirectRf_Private_Variables Direct RF 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 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 98 | * @defgroup DirectRf_Private_FunctionPrototypes Direct RF Private Function Prototypes |
| 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 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 108 | * @defgroup DirectRf_Private_Functions Direct RF Private Functions |
| 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 Sets the DirectRF RX mode of SPIRIT. |
| Wolfgang Betz |
0:4fb29d9ee571 | 114 | * @param xDirectRx code of the desired mode. |
| Wolfgang Betz |
0:4fb29d9ee571 | 115 | * This parameter can be any value of @ref DirectRx. |
| Wolfgang Betz |
0:4fb29d9ee571 | 116 | * @retval None. |
| Wolfgang Betz |
0:4fb29d9ee571 | 117 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 118 | void SpiritDirectRfSetRxMode(DirectRx xDirectRx) |
| Wolfgang Betz |
0:4fb29d9ee571 | 119 | { |
| Wolfgang Betz |
0:4fb29d9ee571 | 120 | uint8_t tempRegValue; |
| Wolfgang Betz |
0:4fb29d9ee571 | 121 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 122 | /* Check the parameters */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 123 | s_assert_param(IS_DIRECT_RX(xDirectRx)); |
| Wolfgang Betz |
0:4fb29d9ee571 | 124 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 125 | /* Reads the register value */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 126 | SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue); |
| Wolfgang Betz |
0:4fb29d9ee571 | 127 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 128 | /* Build the value to be stored */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 129 | tempRegValue &= ~PCKTCTRL3_RX_MODE_MASK; |
| Wolfgang Betz |
0:4fb29d9ee571 | 130 | tempRegValue |= (uint8_t)xDirectRx; |
| Wolfgang Betz |
0:4fb29d9ee571 | 131 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 132 | /* Writes value on register */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 133 | g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL3_BASE, 1, &tempRegValue); |
| Wolfgang Betz |
0:4fb29d9ee571 | 134 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 135 | } |
| Wolfgang Betz |
0:4fb29d9ee571 | 136 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 137 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 138 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 139 | * @brief Returns the DirectRF RX mode of SPIRIT. |
| Wolfgang Betz |
0:4fb29d9ee571 | 140 | * @param None. |
| Wolfgang Betz |
0:4fb29d9ee571 | 141 | * @retval DirectRx Direct Rx mode. |
| Wolfgang Betz |
0:4fb29d9ee571 | 142 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 143 | DirectRx SpiritDirectRfGetRxMode(void) |
| Wolfgang Betz |
0:4fb29d9ee571 | 144 | { |
| Wolfgang Betz |
0:4fb29d9ee571 | 145 | uint8_t tempRegValue; |
| Wolfgang Betz |
0:4fb29d9ee571 | 146 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 147 | /* Reads the register value and mask the RX_Mode field */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 148 | g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue); |
| Wolfgang Betz |
0:4fb29d9ee571 | 149 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 150 | /* Rebuild and return value */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 151 | return (DirectRx)(tempRegValue & 0x30); |
| Wolfgang Betz |
0:4fb29d9ee571 | 152 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 153 | } |
| Wolfgang Betz |
0:4fb29d9ee571 | 154 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 155 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 156 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 157 | * @brief Sets the TX mode of SPIRIT. |
| Wolfgang Betz |
0:4fb29d9ee571 | 158 | * @param xDirectTx code of the desired source. |
| Wolfgang Betz |
0:4fb29d9ee571 | 159 | * This parameter can be any value of @ref DirectTx. |
| Wolfgang Betz |
0:4fb29d9ee571 | 160 | * @retval None. |
| Wolfgang Betz |
0:4fb29d9ee571 | 161 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 162 | void SpiritDirectRfSetTxMode(DirectTx xDirectTx) |
| Wolfgang Betz |
0:4fb29d9ee571 | 163 | { |
| Wolfgang Betz |
0:4fb29d9ee571 | 164 | uint8_t tempRegValue; |
| Wolfgang Betz |
0:4fb29d9ee571 | 165 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 166 | /* Check the parameters */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 167 | s_assert_param(IS_DIRECT_TX(xDirectTx)); |
| Wolfgang Betz |
0:4fb29d9ee571 | 168 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 169 | /* Reads the register value */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 170 | SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue); |
| Wolfgang Betz |
0:4fb29d9ee571 | 171 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 172 | /* Build the value to be stored */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 173 | tempRegValue &= ~PCKTCTRL1_TX_SOURCE_MASK; |
| Wolfgang Betz |
0:4fb29d9ee571 | 174 | tempRegValue |= (uint8_t)xDirectTx; |
| Wolfgang Betz |
0:4fb29d9ee571 | 175 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 176 | /* Writes value on register */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 177 | g_xStatus = SpiritSpiWriteRegisters(PCKTCTRL1_BASE, 1, &tempRegValue); |
| Wolfgang Betz |
0:4fb29d9ee571 | 178 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 179 | } |
| Wolfgang Betz |
0:4fb29d9ee571 | 180 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 181 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 182 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 183 | * @brief Returns the DirectRF TX mode of SPIRIT. |
| Wolfgang Betz |
0:4fb29d9ee571 | 184 | * @param None. |
| Wolfgang Betz |
0:4fb29d9ee571 | 185 | * @retval DirectTx Direct Tx mode. |
| Wolfgang Betz |
0:4fb29d9ee571 | 186 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 187 | DirectTx SpiritDirectRfGetTxMode(void) |
| Wolfgang Betz |
0:4fb29d9ee571 | 188 | { |
| Wolfgang Betz |
0:4fb29d9ee571 | 189 | uint8_t tempRegValue; |
| Wolfgang Betz |
0:4fb29d9ee571 | 190 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 191 | /* Reads the register value and mask the RX_Mode field */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 192 | g_xStatus = SpiritSpiReadRegisters(PCKTCTRL1_BASE, 1, &tempRegValue); |
| Wolfgang Betz |
0:4fb29d9ee571 | 193 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 194 | /* Returns value */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 195 | return (DirectTx)(tempRegValue & 0x0C); |
| Wolfgang Betz |
0:4fb29d9ee571 | 196 | |
| 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 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 203 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 204 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 205 | *@} |
| Wolfgang Betz |
0:4fb29d9ee571 | 206 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 207 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 208 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 209 | /** |
| Wolfgang Betz |
0:4fb29d9ee571 | 210 | *@} |
| Wolfgang Betz |
0:4fb29d9ee571 | 211 | */ |
| Wolfgang Betz |
0:4fb29d9ee571 | 212 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 213 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 214 | |
| Wolfgang Betz |
0:4fb29d9ee571 | 215 | /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/ |
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 05 Jul 2017 |
| Imports: | 273 |
| Forks: | 2 |
| Commits: | 83 |
| Dependents: | 0 |
| Dependencies: | 0 |
| Followers: | 410 |
The code in this repository is Apache licensed.
Components
X-NUCLEO-IDS01A4 Sub-1GHz RF Expansion Board