Toyomasa Watarai / easy-connect-type-yd

Easily add all supported connectivity methods to your mbed OS project

Dependencies:   type-yd-driver

stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Src/SPIRIT_General.c@0:615f90842ce8, 2017-07-12 (annotated)

Committer:
MACRUM
Date:
Wed Jul 12 10:52:58 2017 +0000
Revision:
0:615f90842ce8
Initial commit

Who changed what in which revision?

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