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).

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