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