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_General.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_General.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 General functionalities.
Wolfgang Betz 34:edda6a7238ec 8 * @details
Wolfgang Betz 34:edda6a7238ec 9 *
Wolfgang Betz 34:edda6a7238ec 10 * @attention
Wolfgang Betz 34:edda6a7238ec 11 *
Wolfgang Betz 34:edda6a7238ec 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 34:edda6a7238ec 13 *
Wolfgang Betz 34:edda6a7238ec 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 34:edda6a7238ec 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 34:edda6a7238ec 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 34:edda6a7238ec 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 34:edda6a7238ec 20 * and/or other materials provided with the distribution.
Wolfgang Betz 34:edda6a7238ec 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 34:edda6a7238ec 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 34:edda6a7238ec 23 * without specific prior written permission.
Wolfgang Betz 34:edda6a7238ec 24 *
Wolfgang Betz 34:edda6a7238ec 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 34:edda6a7238ec 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 34:edda6a7238ec 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 34:edda6a7238ec 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 34:edda6a7238ec 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 34:edda6a7238ec 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 34:edda6a7238ec 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 34:edda6a7238ec 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 34:edda6a7238ec 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 34:edda6a7238ec 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 34:edda6a7238ec 35 *
Wolfgang Betz 34:edda6a7238ec 36 ******************************************************************************
Wolfgang Betz 34:edda6a7238ec 37 */
Wolfgang Betz 34:edda6a7238ec 38
Wolfgang Betz 34:edda6a7238ec 39 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 40 #include "SPIRIT_General.h"
Wolfgang Betz 34:edda6a7238ec 41 #include "MCU_Interface.h"
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_General
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 General_Private_TypesDefinitions General 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 General_Private_Defines General 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 General_Private_Macros General 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 General_Private_Variables General 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 General_Private_FunctionPrototypes General 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 General_Private_Functions General 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 Enables or Disables the output of battery level detector.
Wolfgang Betz 34:edda6a7238ec 114 * @param xNewState new state for battery level detector.
Wolfgang Betz 34:edda6a7238ec 115 * This parameter can be: S_ENABLE or S_DISABLE.
Wolfgang Betz 34:edda6a7238ec 116 * @retval None
Wolfgang Betz 34:edda6a7238ec 117 */
Wolfgang Betz 34:edda6a7238ec 118 void SpiritGeneralBatteryLevel(SpiritFunctionalState xNewState)
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_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 34:edda6a7238ec 124
Wolfgang Betz 34:edda6a7238ec 125 /* Reads the ANA_FUNC_CONF0_BASE register value */
Wolfgang Betz 34:edda6a7238ec 126 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 127
Wolfgang Betz 34:edda6a7238ec 128 /* Build the value to be stored */
Wolfgang Betz 34:edda6a7238ec 129 if(xNewState == S_ENABLE)
Wolfgang Betz 34:edda6a7238ec 130 {
Wolfgang Betz 34:edda6a7238ec 131 tempRegValue |= BATTERY_LEVEL_MASK;
Wolfgang Betz 34:edda6a7238ec 132 }
Wolfgang Betz 34:edda6a7238ec 133 else
Wolfgang Betz 34:edda6a7238ec 134 {
Wolfgang Betz 34:edda6a7238ec 135 tempRegValue &= ~BATTERY_LEVEL_MASK;
Wolfgang Betz 34:edda6a7238ec 136 }
Wolfgang Betz 34:edda6a7238ec 137
Wolfgang Betz 34:edda6a7238ec 138 /* Writes the new value */
Wolfgang Betz 34:edda6a7238ec 139 g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 140
Wolfgang Betz 34:edda6a7238ec 141 }
Wolfgang Betz 34:edda6a7238ec 142
Wolfgang Betz 34:edda6a7238ec 143
Wolfgang Betz 34:edda6a7238ec 144 /**
Wolfgang Betz 34:edda6a7238ec 145 * @brief Sets the battery level.
Wolfgang Betz 34:edda6a7238ec 146 * @param xBatteryLevel new state for battery level.
Wolfgang Betz 34:edda6a7238ec 147 * This parameter can be a value of @ref BatteryLevel.
Wolfgang Betz 34:edda6a7238ec 148 * @retval None.
Wolfgang Betz 34:edda6a7238ec 149 */
Wolfgang Betz 34:edda6a7238ec 150 void SpiritGeneralSetBatteryLevel(BatteryLevel xBatteryLevel)
Wolfgang Betz 34:edda6a7238ec 151 {
Wolfgang Betz 34:edda6a7238ec 152 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 153
Wolfgang Betz 34:edda6a7238ec 154 /* Check the parameters */
Wolfgang Betz 34:edda6a7238ec 155 s_assert_param(IS_BLD_LVL(xBatteryLevel));
Wolfgang Betz 34:edda6a7238ec 156
Wolfgang Betz 34:edda6a7238ec 157 /* Reads the ANA_FUNC_CONF1_BASE register value */
Wolfgang Betz 34:edda6a7238ec 158 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 159
Wolfgang Betz 34:edda6a7238ec 160 /* Build the value to be stored */
Wolfgang Betz 34:edda6a7238ec 161 tempRegValue &= ~ANA_FUNC_CONF1_SET_BLD_LVL_MASK;
Wolfgang Betz 34:edda6a7238ec 162 switch(xBatteryLevel)
Wolfgang Betz 34:edda6a7238ec 163 {
Wolfgang Betz 34:edda6a7238ec 164 case BLD_LVL_2_7_V:
Wolfgang Betz 34:edda6a7238ec 165 tempRegValue |= BLD_LVL_2_7;
Wolfgang Betz 34:edda6a7238ec 166 break;
Wolfgang Betz 34:edda6a7238ec 167 case BLD_LVL_2_5_V:
Wolfgang Betz 34:edda6a7238ec 168 tempRegValue |= BLD_LVL_2_5;
Wolfgang Betz 34:edda6a7238ec 169 break;
Wolfgang Betz 34:edda6a7238ec 170 case BLD_LVL_2_3_V:
Wolfgang Betz 34:edda6a7238ec 171 tempRegValue |= BLD_LVL_2_3;
Wolfgang Betz 34:edda6a7238ec 172 break;
Wolfgang Betz 34:edda6a7238ec 173 case BLD_LVL_2_1_V:
Wolfgang Betz 34:edda6a7238ec 174 tempRegValue |= BLD_LVL_2_1;
Wolfgang Betz 34:edda6a7238ec 175 break;
Wolfgang Betz 34:edda6a7238ec 176 }
Wolfgang Betz 34:edda6a7238ec 177
Wolfgang Betz 34:edda6a7238ec 178 /* Writes the new value */
Wolfgang Betz 34:edda6a7238ec 179 g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 180
Wolfgang Betz 34:edda6a7238ec 181 }
Wolfgang Betz 34:edda6a7238ec 182
Wolfgang Betz 34:edda6a7238ec 183
Wolfgang Betz 34:edda6a7238ec 184 /**
Wolfgang Betz 34:edda6a7238ec 185 * @brief Returns the settled battery level.
Wolfgang Betz 34:edda6a7238ec 186 * @param None.
Wolfgang Betz 34:edda6a7238ec 187 * @retval BatteryLevel Settled battery level. This parameter can be a value of @ref BatteryLevel.
Wolfgang Betz 34:edda6a7238ec 188 */
Wolfgang Betz 34:edda6a7238ec 189 BatteryLevel SpiritGeneralGetBatteryLevel(void)
Wolfgang Betz 34:edda6a7238ec 190 {
Wolfgang Betz 34:edda6a7238ec 191 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 192
Wolfgang Betz 34:edda6a7238ec 193 /* Reads the ANA_FUNC_CONF1_BASE register value */
Wolfgang Betz 34:edda6a7238ec 194 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 195
Wolfgang Betz 34:edda6a7238ec 196 /* Mask the battery level field and returns the settled battery level */
Wolfgang Betz 34:edda6a7238ec 197 return ((BatteryLevel)(tempRegValue & ANA_FUNC_CONF1_SET_BLD_LVL_MASK));
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 * @brief Enables or Disables the output of brown out detector.
Wolfgang Betz 34:edda6a7238ec 204 * @param xNewState new state for brown out detector.
Wolfgang Betz 34:edda6a7238ec 205 * This parameter can be: S_ENABLE or S_DISABLE.
Wolfgang Betz 34:edda6a7238ec 206 * @retval None.
Wolfgang Betz 34:edda6a7238ec 207 */
Wolfgang Betz 34:edda6a7238ec 208 void SpiritGeneralBrownOut(SpiritFunctionalState xNewState)
Wolfgang Betz 34:edda6a7238ec 209 {
Wolfgang Betz 34:edda6a7238ec 210 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 211
Wolfgang Betz 34:edda6a7238ec 212 /* Check the parameters */
Wolfgang Betz 34:edda6a7238ec 213 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 34:edda6a7238ec 214
Wolfgang Betz 34:edda6a7238ec 215 /* Reads the ANA_FUNC_CONF0_BASE register value */
Wolfgang Betz 34:edda6a7238ec 216 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 217
Wolfgang Betz 34:edda6a7238ec 218 /* Build the value to be stored */
Wolfgang Betz 34:edda6a7238ec 219 if(xNewState == S_ENABLE)
Wolfgang Betz 34:edda6a7238ec 220 {
Wolfgang Betz 34:edda6a7238ec 221 tempRegValue |= BROWN_OUT_MASK;
Wolfgang Betz 34:edda6a7238ec 222 }
Wolfgang Betz 34:edda6a7238ec 223 else
Wolfgang Betz 34:edda6a7238ec 224 {
Wolfgang Betz 34:edda6a7238ec 225 tempRegValue &= ~BROWN_OUT_MASK;
Wolfgang Betz 34:edda6a7238ec 226 }
Wolfgang Betz 34:edda6a7238ec 227
Wolfgang Betz 34:edda6a7238ec 228 /* Writes value on register */
Wolfgang Betz 34:edda6a7238ec 229 g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 230
Wolfgang Betz 34:edda6a7238ec 231 }
Wolfgang Betz 34:edda6a7238ec 232
Wolfgang Betz 34:edda6a7238ec 233
Wolfgang Betz 34:edda6a7238ec 234 /**
Wolfgang Betz 34:edda6a7238ec 235 * @brief Sets High Power Mode.
Wolfgang Betz 34:edda6a7238ec 236 * @param xNewState new state for High Power Mode.
Wolfgang Betz 34:edda6a7238ec 237 * This parameter can be: S_ENABLE or S_DISABLE.
Wolfgang Betz 34:edda6a7238ec 238 * @retval None.
Wolfgang Betz 34:edda6a7238ec 239 */
Wolfgang Betz 34:edda6a7238ec 240 void SpiritGeneralHighPwr(SpiritFunctionalState xNewState)
Wolfgang Betz 34:edda6a7238ec 241 {
Wolfgang Betz 34:edda6a7238ec 242 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 243
Wolfgang Betz 34:edda6a7238ec 244 /* Check the parameters */
Wolfgang Betz 34:edda6a7238ec 245 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 34:edda6a7238ec 246
Wolfgang Betz 34:edda6a7238ec 247 /* Reads the ANA_FUNC_CONF0_BASE register value */
Wolfgang Betz 34:edda6a7238ec 248 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 249
Wolfgang Betz 34:edda6a7238ec 250 /* Build the value to write */
Wolfgang Betz 34:edda6a7238ec 251 if(xNewState == S_ENABLE)
Wolfgang Betz 34:edda6a7238ec 252 {
Wolfgang Betz 34:edda6a7238ec 253 tempRegValue |= HIGH_POWER_MODE_MASK;
Wolfgang Betz 34:edda6a7238ec 254 }
Wolfgang Betz 34:edda6a7238ec 255 else
Wolfgang Betz 34:edda6a7238ec 256 {
Wolfgang Betz 34:edda6a7238ec 257 tempRegValue &= ~HIGH_POWER_MODE_MASK;
Wolfgang Betz 34:edda6a7238ec 258 }
Wolfgang Betz 34:edda6a7238ec 259
Wolfgang Betz 34:edda6a7238ec 260 /* Writes the new value on register */
Wolfgang Betz 34:edda6a7238ec 261 g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 262
Wolfgang Betz 34:edda6a7238ec 263 }
Wolfgang Betz 34:edda6a7238ec 264
Wolfgang Betz 34:edda6a7238ec 265
Wolfgang Betz 34:edda6a7238ec 266 /**
Wolfgang Betz 34:edda6a7238ec 267 * @brief Sets External Reference.
Wolfgang Betz 34:edda6a7238ec 268 * @param xExtMode new state for the external reference.
Wolfgang Betz 34:edda6a7238ec 269 * This parameter can be: MODE_EXT_XO or MODE_EXT_XIN.
Wolfgang Betz 34:edda6a7238ec 270 * @retval None.
Wolfgang Betz 34:edda6a7238ec 271 */
Wolfgang Betz 34:edda6a7238ec 272 void SpiritGeneralSetExtRef(ModeExtRef xExtMode)
Wolfgang Betz 34:edda6a7238ec 273 {
Wolfgang Betz 34:edda6a7238ec 274 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 275
Wolfgang Betz 34:edda6a7238ec 276 /* Check the parameters */
Wolfgang Betz 34:edda6a7238ec 277 s_assert_param(IS_MODE_EXT(xExtMode));
Wolfgang Betz 34:edda6a7238ec 278
Wolfgang Betz 34:edda6a7238ec 279 /* Reads the ANA_FUNC_CONF0_BASE register value */
Wolfgang Betz 34:edda6a7238ec 280 SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 281
Wolfgang Betz 34:edda6a7238ec 282 /* Build the value to write */
Wolfgang Betz 34:edda6a7238ec 283 if(xExtMode == MODE_EXT_XO)
Wolfgang Betz 34:edda6a7238ec 284 {
Wolfgang Betz 34:edda6a7238ec 285 tempRegValue &= ~EXT_REF_MASK;
Wolfgang Betz 34:edda6a7238ec 286 }
Wolfgang Betz 34:edda6a7238ec 287 else
Wolfgang Betz 34:edda6a7238ec 288 {
Wolfgang Betz 34:edda6a7238ec 289 tempRegValue |= EXT_REF_MASK;
Wolfgang Betz 34:edda6a7238ec 290 }
Wolfgang Betz 34:edda6a7238ec 291
Wolfgang Betz 34:edda6a7238ec 292 /* Writes value on register */
Wolfgang Betz 34:edda6a7238ec 293 g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 294
Wolfgang Betz 34:edda6a7238ec 295 }
Wolfgang Betz 34:edda6a7238ec 296
Wolfgang Betz 34:edda6a7238ec 297
Wolfgang Betz 34:edda6a7238ec 298 /**
Wolfgang Betz 34:edda6a7238ec 299 * @brief Returns External Reference.
Wolfgang Betz 34:edda6a7238ec 300 * @param None.
Wolfgang Betz 34:edda6a7238ec 301 * @retval ModeExtRef Settled external reference.
Wolfgang Betz 34:edda6a7238ec 302 * This parameter can be: MODE_EXT_XO or MODE_EXT_XIN.
Wolfgang Betz 34:edda6a7238ec 303 */
Wolfgang Betz 34:edda6a7238ec 304 ModeExtRef SpiritGeneralGetExtRef(void)
Wolfgang Betz 34:edda6a7238ec 305 {
Wolfgang Betz 34:edda6a7238ec 306 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 307
Wolfgang Betz 34:edda6a7238ec 308 /* Reads the ANA_FUNC_CONF0_BASE register value and return the result */
Wolfgang Betz 34:edda6a7238ec 309 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 310
Wolfgang Betz 34:edda6a7238ec 311 /* Mask the EXT_REF field field and returns the settled reference signal */
Wolfgang Betz 34:edda6a7238ec 312 return ((ModeExtRef)((tempRegValue & 0x10)>>4));
Wolfgang Betz 34:edda6a7238ec 313
Wolfgang Betz 34:edda6a7238ec 314 }
Wolfgang Betz 34:edda6a7238ec 315
Wolfgang Betz 34:edda6a7238ec 316
Wolfgang Betz 34:edda6a7238ec 317 /**
Wolfgang Betz 34:edda6a7238ec 318 * @brief Sets XO gm at startup.
Wolfgang Betz 34:edda6a7238ec 319 * @param xGm transconductance value of XO at startup.
Wolfgang Betz 34:edda6a7238ec 320 * This parameter can be a value of @ref GmConf.
Wolfgang Betz 34:edda6a7238ec 321 * @retval None.
Wolfgang Betz 34:edda6a7238ec 322 */
Wolfgang Betz 34:edda6a7238ec 323 void SpiritGeneralSetXoGm(GmConf xGm)
Wolfgang Betz 34:edda6a7238ec 324 {
Wolfgang Betz 34:edda6a7238ec 325 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 326
Wolfgang Betz 34:edda6a7238ec 327 /* Check the parameters */
Wolfgang Betz 34:edda6a7238ec 328 s_assert_param(IS_GM_CONF(xGm));
Wolfgang Betz 34:edda6a7238ec 329
Wolfgang Betz 34:edda6a7238ec 330 /* Reads the ANA_FUNC_CONF1_BASE register value */
Wolfgang Betz 34:edda6a7238ec 331 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 332
Wolfgang Betz 34:edda6a7238ec 333 /* Build the value to write */
Wolfgang Betz 34:edda6a7238ec 334 tempRegValue &= ~ANA_FUNC_CONF1_GMCONF_MASK;
Wolfgang Betz 34:edda6a7238ec 335 switch(xGm)
Wolfgang Betz 34:edda6a7238ec 336 {
Wolfgang Betz 34:edda6a7238ec 337 case GM_SU_13_2:
Wolfgang Betz 34:edda6a7238ec 338 tempRegValue |= GM_13_2;
Wolfgang Betz 34:edda6a7238ec 339 break;
Wolfgang Betz 34:edda6a7238ec 340 case GM_SU_18_2:
Wolfgang Betz 34:edda6a7238ec 341 tempRegValue |= GM_18_2;
Wolfgang Betz 34:edda6a7238ec 342 break;
Wolfgang Betz 34:edda6a7238ec 343 case GM_SU_21_5:
Wolfgang Betz 34:edda6a7238ec 344 tempRegValue |= GM_21_5;
Wolfgang Betz 34:edda6a7238ec 345 break;
Wolfgang Betz 34:edda6a7238ec 346 case GM_SU_25_6:
Wolfgang Betz 34:edda6a7238ec 347 tempRegValue |= GM_25_6;
Wolfgang Betz 34:edda6a7238ec 348 break;
Wolfgang Betz 34:edda6a7238ec 349 case GM_SU_28_8:
Wolfgang Betz 34:edda6a7238ec 350 tempRegValue |= GM_28_8;
Wolfgang Betz 34:edda6a7238ec 351 break;
Wolfgang Betz 34:edda6a7238ec 352 case GM_SU_33_9:
Wolfgang Betz 34:edda6a7238ec 353 tempRegValue |= GM_33_9;
Wolfgang Betz 34:edda6a7238ec 354 break;
Wolfgang Betz 34:edda6a7238ec 355 case GM_SU_38_5:
Wolfgang Betz 34:edda6a7238ec 356 tempRegValue |= GM_38_5;
Wolfgang Betz 34:edda6a7238ec 357 break;
Wolfgang Betz 34:edda6a7238ec 358 case GM_SU_43_0:
Wolfgang Betz 34:edda6a7238ec 359 tempRegValue |= GM_43_0;
Wolfgang Betz 34:edda6a7238ec 360 break;
Wolfgang Betz 34:edda6a7238ec 361 }
Wolfgang Betz 34:edda6a7238ec 362
Wolfgang Betz 34:edda6a7238ec 363 /* Writes new value on register */
Wolfgang Betz 34:edda6a7238ec 364 g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 365
Wolfgang Betz 34:edda6a7238ec 366 }
Wolfgang Betz 34:edda6a7238ec 367
Wolfgang Betz 34:edda6a7238ec 368
Wolfgang Betz 34:edda6a7238ec 369 /**
Wolfgang Betz 34:edda6a7238ec 370 * @brief Returns the configured XO gm at startup.
Wolfgang Betz 34:edda6a7238ec 371 * @param None.
Wolfgang Betz 34:edda6a7238ec 372 * @retval GmConf Settled XO gm. This parameter can be a value of @ref GmConf.
Wolfgang Betz 34:edda6a7238ec 373 */
Wolfgang Betz 34:edda6a7238ec 374 GmConf SpiritGeneralGetXoGm(void)
Wolfgang Betz 34:edda6a7238ec 375 {
Wolfgang Betz 34:edda6a7238ec 376 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 377
Wolfgang Betz 34:edda6a7238ec 378 /* Reads the ANA_FUNC_CONF1_BASE register value */
Wolfgang Betz 34:edda6a7238ec 379 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 380
Wolfgang Betz 34:edda6a7238ec 381 /* Mask the GM_CONF field field and returns the settled transconductance of the XO at startup */
Wolfgang Betz 34:edda6a7238ec 382 return ((GmConf)((tempRegValue & 0x1C)>>2));
Wolfgang Betz 34:edda6a7238ec 383
Wolfgang Betz 34:edda6a7238ec 384 }
Wolfgang Betz 34:edda6a7238ec 385
Wolfgang Betz 34:edda6a7238ec 386
Wolfgang Betz 34:edda6a7238ec 387 /**
Wolfgang Betz 34:edda6a7238ec 388 * @brief Returns the settled packet format.
Wolfgang Betz 34:edda6a7238ec 389 * @param None.
Wolfgang Betz 34:edda6a7238ec 390 * @retval PacketType Settled packet type. This parameter can be a value of @ref PacketType.
Wolfgang Betz 34:edda6a7238ec 391 */
Wolfgang Betz 34:edda6a7238ec 392 PacketType SpiritGeneralGetPktType(void)
Wolfgang Betz 34:edda6a7238ec 393 {
Wolfgang Betz 34:edda6a7238ec 394 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 395
Wolfgang Betz 34:edda6a7238ec 396 /* Reads the PROTOCOL1 register */
Wolfgang Betz 34:edda6a7238ec 397 g_xStatus = SpiritSpiReadRegisters(PCKTCTRL3_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 398
Wolfgang Betz 34:edda6a7238ec 399 /* cast and return value */
Wolfgang Betz 34:edda6a7238ec 400 return (PacketType)(tempRegValue>>6);
Wolfgang Betz 34:edda6a7238ec 401
Wolfgang Betz 34:edda6a7238ec 402 }
Wolfgang Betz 34:edda6a7238ec 403
Wolfgang Betz 34:edda6a7238ec 404
Wolfgang Betz 34:edda6a7238ec 405
Wolfgang Betz 34:edda6a7238ec 406 /**
Wolfgang Betz 34:edda6a7238ec 407 * @brief Returns device part number.
Wolfgang Betz 34:edda6a7238ec 408 * @param None.
Wolfgang Betz 34:edda6a7238ec 409 * @retval uint16_t Device part number.
Wolfgang Betz 34:edda6a7238ec 410 */
Wolfgang Betz 34:edda6a7238ec 411 uint16_t SpiritGeneralGetDevicePartNumber(void)
Wolfgang Betz 34:edda6a7238ec 412 {
Wolfgang Betz 34:edda6a7238ec 413 uint8_t tempRegValue[2];
Wolfgang Betz 34:edda6a7238ec 414
Wolfgang Betz 34:edda6a7238ec 415 /* Reads the register value containing the device part number */
Wolfgang Betz 34:edda6a7238ec 416 g_xStatus = SpiritSpiReadRegisters(DEVICE_INFO1_PARTNUM, 2, tempRegValue);
Wolfgang Betz 34:edda6a7238ec 417
Wolfgang Betz 34:edda6a7238ec 418 return ((((uint16_t)tempRegValue[0])<<8) | ((uint16_t)tempRegValue[1]));
Wolfgang Betz 34:edda6a7238ec 419
Wolfgang Betz 34:edda6a7238ec 420 }
Wolfgang Betz 34:edda6a7238ec 421
Wolfgang Betz 34:edda6a7238ec 422 /**
Wolfgang Betz 34:edda6a7238ec 423 * @brief Returns SPIRIT RF board version.
Wolfgang Betz 34:edda6a7238ec 424 * @param None.
Wolfgang Betz 34:edda6a7238ec 425 * @retval SPIRIT RF board version: 0x30 is the only admitted value
Wolfgang Betz 34:edda6a7238ec 426 */
Wolfgang Betz 34:edda6a7238ec 427 uint8_t SpiritGeneralGetSpiritVersion(void)
Wolfgang Betz 34:edda6a7238ec 428 {
Wolfgang Betz 34:edda6a7238ec 429 uint8_t ver;
Wolfgang Betz 34:edda6a7238ec 430 SpiritSpiReadRegisters(DEVICE_INFO0_VERSION, 1, &ver);
Wolfgang Betz 34:edda6a7238ec 431 return ver;
Wolfgang Betz 34:edda6a7238ec 432 }
Wolfgang Betz 34:edda6a7238ec 433
Wolfgang Betz 34:edda6a7238ec 434 /**
Wolfgang Betz 34:edda6a7238ec 435 *@}
Wolfgang Betz 34:edda6a7238ec 436 */
Wolfgang Betz 34:edda6a7238ec 437
Wolfgang Betz 34:edda6a7238ec 438
Wolfgang Betz 34:edda6a7238ec 439 /**
Wolfgang Betz 34:edda6a7238ec 440 *@}
Wolfgang Betz 34:edda6a7238ec 441 */
Wolfgang Betz 34:edda6a7238ec 442
Wolfgang Betz 34:edda6a7238ec 443
Wolfgang Betz 34:edda6a7238ec 444 /**
Wolfgang Betz 34:edda6a7238ec 445 *@}
Wolfgang Betz 34:edda6a7238ec 446 */
Wolfgang Betz 34:edda6a7238ec 447
Wolfgang Betz 34:edda6a7238ec 448
Wolfgang Betz 34:edda6a7238ec 449 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/