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