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