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_Calibration.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_Calibration.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 VCO-RCO calibration.
Wolfgang Betz 34:edda6a7238ec 8 *
Wolfgang Betz 34:edda6a7238ec 9 * @attention
Wolfgang Betz 34:edda6a7238ec 10 *
Wolfgang Betz 34:edda6a7238ec 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 34:edda6a7238ec 12 *
Wolfgang Betz 34:edda6a7238ec 13 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 34:edda6a7238ec 14 * are permitted provided that the following conditions are met:
Wolfgang Betz 34:edda6a7238ec 15 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 16 * this list of conditions and the following disclaimer.
Wolfgang Betz 34:edda6a7238ec 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 34:edda6a7238ec 18 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 34:edda6a7238ec 19 * and/or other materials provided with the distribution.
Wolfgang Betz 34:edda6a7238ec 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 34:edda6a7238ec 21 * may be used to endorse or promote products derived from this software
Wolfgang Betz 34:edda6a7238ec 22 * without specific prior written permission.
Wolfgang Betz 34:edda6a7238ec 23 *
Wolfgang Betz 34:edda6a7238ec 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 34:edda6a7238ec 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 34:edda6a7238ec 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 34:edda6a7238ec 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 34:edda6a7238ec 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 34:edda6a7238ec 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 34:edda6a7238ec 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 34:edda6a7238ec 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 34:edda6a7238ec 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 34:edda6a7238ec 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 34:edda6a7238ec 34 *
Wolfgang Betz 34:edda6a7238ec 35 ******************************************************************************
Wolfgang Betz 34:edda6a7238ec 36 */
Wolfgang Betz 34:edda6a7238ec 37
Wolfgang Betz 34:edda6a7238ec 38 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 34:edda6a7238ec 39 #include "SPIRIT_Calibration.h"
Wolfgang Betz 34:edda6a7238ec 40 #include "MCU_Interface.h"
Wolfgang Betz 34:edda6a7238ec 41
Wolfgang Betz 34:edda6a7238ec 42
Wolfgang Betz 34:edda6a7238ec 43
Wolfgang Betz 34:edda6a7238ec 44
Wolfgang Betz 34:edda6a7238ec 45 /**
Wolfgang Betz 34:edda6a7238ec 46 * @addtogroup SPIRIT_Libraries
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 /**
Wolfgang Betz 34:edda6a7238ec 52 * @addtogroup SPIRIT_Calibration
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 /**
Wolfgang Betz 34:edda6a7238ec 58 * @defgroup Calibration_Private_TypesDefinitions Calibration Private Types Definitions
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 /**
Wolfgang Betz 34:edda6a7238ec 68 * @defgroup Calibration_Private_Defines Calibration Private Defines
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
Wolfgang Betz 34:edda6a7238ec 78 /**
Wolfgang Betz 34:edda6a7238ec 79 * @defgroup Calibration_Private_Macros Calibration Private Macros
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
Wolfgang Betz 34:edda6a7238ec 88 /**
Wolfgang Betz 34:edda6a7238ec 89 * @defgroup Calibration_Private_Variables Calibration Private Variables
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
Wolfgang Betz 34:edda6a7238ec 99 /**
Wolfgang Betz 34:edda6a7238ec 100 * @defgroup Calibration_Private_FunctionPrototypes Calibration Private Function Prototypes
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
Wolfgang Betz 34:edda6a7238ec 109 /**
Wolfgang Betz 34:edda6a7238ec 110 * @defgroup Calibration_Private_Functions Calibration Private Functions
Wolfgang Betz 34:edda6a7238ec 111 * @{
Wolfgang Betz 34:edda6a7238ec 112 */
Wolfgang Betz 34:edda6a7238ec 113
Wolfgang Betz 34:edda6a7238ec 114 /**
Wolfgang Betz 34:edda6a7238ec 115 * @brief Enables or Disables the RCO calibration.
Wolfgang Betz 34:edda6a7238ec 116 * @param xNewState new state for RCO calibration.
Wolfgang Betz 34:edda6a7238ec 117 This parameter can be S_ENABLE or S_DISABLE.
Wolfgang Betz 34:edda6a7238ec 118 * @retval None.
Wolfgang Betz 34:edda6a7238ec 119 */
Wolfgang Betz 34:edda6a7238ec 120 void SpiritCalibrationRco(SpiritFunctionalState xNewState)
Wolfgang Betz 34:edda6a7238ec 121 {
Wolfgang Betz 34:edda6a7238ec 122 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 123
Wolfgang Betz 34:edda6a7238ec 124 /* Check the parameters */
Wolfgang Betz 34:edda6a7238ec 125 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 34:edda6a7238ec 126
Wolfgang Betz 34:edda6a7238ec 127 /* Reads the register value */
Wolfgang Betz 34:edda6a7238ec 128 g_xStatus = SpiritSpiReadRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 129
Wolfgang Betz 34:edda6a7238ec 130 /* Build new value for the register */
Wolfgang Betz 34:edda6a7238ec 131 if(xNewState==S_ENABLE)
Wolfgang Betz 34:edda6a7238ec 132 {
Wolfgang Betz 34:edda6a7238ec 133 tempRegValue |= PROTOCOL2_RCO_CALIBRATION_MASK;
Wolfgang Betz 34:edda6a7238ec 134 }
Wolfgang Betz 34:edda6a7238ec 135 else
Wolfgang Betz 34:edda6a7238ec 136 {
Wolfgang Betz 34:edda6a7238ec 137 tempRegValue &= ~PROTOCOL2_RCO_CALIBRATION_MASK;
Wolfgang Betz 34:edda6a7238ec 138 }
Wolfgang Betz 34:edda6a7238ec 139
Wolfgang Betz 34:edda6a7238ec 140 /* Writes register to enable or disable the RCO calibration */
Wolfgang Betz 34:edda6a7238ec 141 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 142
Wolfgang Betz 34:edda6a7238ec 143 }
Wolfgang Betz 34:edda6a7238ec 144
Wolfgang Betz 34:edda6a7238ec 145
Wolfgang Betz 34:edda6a7238ec 146 /**
Wolfgang Betz 34:edda6a7238ec 147 * @brief Enables or Disables the VCO calibration.
Wolfgang Betz 34:edda6a7238ec 148 * @param xNewState new state for VCO calibration.
Wolfgang Betz 34:edda6a7238ec 149 This parameter can be S_ENABLE or S_DISABLE.
Wolfgang Betz 34:edda6a7238ec 150 * @retval None.
Wolfgang Betz 34:edda6a7238ec 151 */
Wolfgang Betz 34:edda6a7238ec 152 void SpiritCalibrationVco(SpiritFunctionalState xNewState)
Wolfgang Betz 34:edda6a7238ec 153 {
Wolfgang Betz 34:edda6a7238ec 154 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 155
Wolfgang Betz 34:edda6a7238ec 156 /* Check the parameters */
Wolfgang Betz 34:edda6a7238ec 157 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 34:edda6a7238ec 158
Wolfgang Betz 34:edda6a7238ec 159 /* Reads the register value */
Wolfgang Betz 34:edda6a7238ec 160 g_xStatus = SpiritSpiReadRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 161
Wolfgang Betz 34:edda6a7238ec 162 /* Build new value for the register */
Wolfgang Betz 34:edda6a7238ec 163 if(xNewState==S_ENABLE)
Wolfgang Betz 34:edda6a7238ec 164 tempRegValue |= PROTOCOL2_VCO_CALIBRATION_MASK;
Wolfgang Betz 34:edda6a7238ec 165 else
Wolfgang Betz 34:edda6a7238ec 166 tempRegValue &= ~PROTOCOL2_VCO_CALIBRATION_MASK;
Wolfgang Betz 34:edda6a7238ec 167
Wolfgang Betz 34:edda6a7238ec 168 /* Writes register to enable or disable the VCO calibration */
Wolfgang Betz 34:edda6a7238ec 169 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 170
Wolfgang Betz 34:edda6a7238ec 171 }
Wolfgang Betz 34:edda6a7238ec 172
Wolfgang Betz 34:edda6a7238ec 173
Wolfgang Betz 34:edda6a7238ec 174 /**
Wolfgang Betz 34:edda6a7238ec 175 * @brief Sets the RCO calibration words.
Wolfgang Betz 34:edda6a7238ec 176 * @param cRwt RWT word for RCO calibration.
Wolfgang Betz 34:edda6a7238ec 177 * This parameter can be a value of uint8_t.
Wolfgang Betz 34:edda6a7238ec 178 * @param cRfb RFB word for RCO calibration.
Wolfgang Betz 34:edda6a7238ec 179 * This parameter can be a value of uint8_t.
Wolfgang Betz 34:edda6a7238ec 180 * @retval None.
Wolfgang Betz 34:edda6a7238ec 181 */
Wolfgang Betz 34:edda6a7238ec 182 void SpiritCalibrationSetRcoCalWords(uint8_t cRwt, uint8_t cRfb)
Wolfgang Betz 34:edda6a7238ec 183 {
Wolfgang Betz 34:edda6a7238ec 184 uint8_t tempRegValue[2];
Wolfgang Betz 34:edda6a7238ec 185
Wolfgang Betz 34:edda6a7238ec 186 /* Build the value of RWT and the MSbits of the RFB word */
Wolfgang Betz 34:edda6a7238ec 187 tempRegValue[0] = (cRwt << 4) | (cRfb >> 1);
Wolfgang Betz 34:edda6a7238ec 188
Wolfgang Betz 34:edda6a7238ec 189 /* Reads the register value to update the LSbit of RFB */
Wolfgang Betz 34:edda6a7238ec 190 g_xStatus = SpiritSpiReadRegisters(RCO_VCO_CALIBR_IN1_BASE, 1, &tempRegValue[1]);
Wolfgang Betz 34:edda6a7238ec 191
Wolfgang Betz 34:edda6a7238ec 192 /* Build new value for the register */
Wolfgang Betz 34:edda6a7238ec 193 tempRegValue[1] = (tempRegValue[1] & 0x7F) | (cRfb<<7);
Wolfgang Betz 34:edda6a7238ec 194
Wolfgang Betz 34:edda6a7238ec 195 /* Writes the new value for RCO calibration words */
Wolfgang Betz 34:edda6a7238ec 196 g_xStatus = SpiritSpiWriteRegisters(RCO_VCO_CALIBR_IN2_BASE, 2, tempRegValue);
Wolfgang Betz 34:edda6a7238ec 197
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 * @brief Returns the RCO calibration words.
Wolfgang Betz 34:edda6a7238ec 203 * @param pcRwt pointer to the variable in which the RWT word has to be stored.
Wolfgang Betz 34:edda6a7238ec 204 * This parameter is a variable of uint8_t*.
Wolfgang Betz 34:edda6a7238ec 205 * @param pcRfb pointer to the variable in which the RFB word has to be stored.
Wolfgang Betz 34:edda6a7238ec 206 * This parameter is a variable of uint8_t*.
Wolfgang Betz 34:edda6a7238ec 207 * @retval None.
Wolfgang Betz 34:edda6a7238ec 208 */
Wolfgang Betz 34:edda6a7238ec 209 void SpiritCalibrationGetRcoCalWords(uint8_t* pcRwt, uint8_t* pcRfb)
Wolfgang Betz 34:edda6a7238ec 210 {
Wolfgang Betz 34:edda6a7238ec 211 uint8_t tempRegValue[2];
Wolfgang Betz 34:edda6a7238ec 212
Wolfgang Betz 34:edda6a7238ec 213 /* Reads the registers values */
Wolfgang Betz 34:edda6a7238ec 214 g_xStatus = SpiritSpiReadRegisters(RCO_VCO_CALIBR_OUT1_BASE, 2, tempRegValue);
Wolfgang Betz 34:edda6a7238ec 215
Wolfgang Betz 34:edda6a7238ec 216 /* Build the RWT value */
Wolfgang Betz 34:edda6a7238ec 217 (*pcRwt) = tempRegValue[0] >> 4;
Wolfgang Betz 34:edda6a7238ec 218 /* Build the RFB value */
Wolfgang Betz 34:edda6a7238ec 219 (*pcRfb) = (tempRegValue[0] & 0x0F)<<1 | (tempRegValue[1]>>7);
Wolfgang Betz 34:edda6a7238ec 220
Wolfgang Betz 34:edda6a7238ec 221 }
Wolfgang Betz 34:edda6a7238ec 222
Wolfgang Betz 34:edda6a7238ec 223
Wolfgang Betz 34:edda6a7238ec 224 /**
Wolfgang Betz 34:edda6a7238ec 225 * @brief Returns the VCO calibration data from internal VCO calibrator.
Wolfgang Betz 34:edda6a7238ec 226 * @param None.
Wolfgang Betz 34:edda6a7238ec 227 * @retval uint8_t VCO calibration data word.
Wolfgang Betz 34:edda6a7238ec 228 */
Wolfgang Betz 34:edda6a7238ec 229 uint8_t SpiritCalibrationGetVcoCalData(void)
Wolfgang Betz 34:edda6a7238ec 230 {
Wolfgang Betz 34:edda6a7238ec 231 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 232
Wolfgang Betz 34:edda6a7238ec 233 /* Reads the register value */
Wolfgang Betz 34:edda6a7238ec 234 g_xStatus = SpiritSpiReadRegisters(RCO_VCO_CALIBR_OUT0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 235
Wolfgang Betz 34:edda6a7238ec 236 /* Build and returns the VCO calibration data value */
Wolfgang Betz 34:edda6a7238ec 237 return (tempRegValue & 0x7F);
Wolfgang Betz 34:edda6a7238ec 238
Wolfgang Betz 34:edda6a7238ec 239 }
Wolfgang Betz 34:edda6a7238ec 240
Wolfgang Betz 34:edda6a7238ec 241
Wolfgang Betz 34:edda6a7238ec 242 /**
Wolfgang Betz 34:edda6a7238ec 243 * @brief Sets the VCO calibration data to be used in TX mode.
Wolfgang Betz 34:edda6a7238ec 244 * @param cVcoCalData calibration data word to be set.
Wolfgang Betz 34:edda6a7238ec 245 * This parameter is a variable of uint8_t.
Wolfgang Betz 34:edda6a7238ec 246 * @retval None.
Wolfgang Betz 34:edda6a7238ec 247 */
Wolfgang Betz 34:edda6a7238ec 248 void SpiritCalibrationSetVcoCalDataTx(uint8_t cVcoCalData)
Wolfgang Betz 34:edda6a7238ec 249 {
Wolfgang Betz 34:edda6a7238ec 250 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 251
Wolfgang Betz 34:edda6a7238ec 252 /* Reads the register value */
Wolfgang Betz 34:edda6a7238ec 253 g_xStatus = SpiritSpiReadRegisters(RCO_VCO_CALIBR_IN1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 254
Wolfgang Betz 34:edda6a7238ec 255 /* Build the value to be written */
Wolfgang Betz 34:edda6a7238ec 256 tempRegValue &= 0x80;
Wolfgang Betz 34:edda6a7238ec 257 tempRegValue |= cVcoCalData;
Wolfgang Betz 34:edda6a7238ec 258
Wolfgang Betz 34:edda6a7238ec 259 /* Writes the new value of calibration data in TX */
Wolfgang Betz 34:edda6a7238ec 260 g_xStatus = SpiritSpiWriteRegisters(RCO_VCO_CALIBR_IN1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 261
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 * @brief Returns the actual VCO calibration data used in TX mode.
Wolfgang Betz 34:edda6a7238ec 267 * @param None.
Wolfgang Betz 34:edda6a7238ec 268 * @retval uint8_t Calibration data word used in TX mode.
Wolfgang Betz 34:edda6a7238ec 269 */
Wolfgang Betz 34:edda6a7238ec 270 uint8_t SpiritCalibrationGetVcoCalDataTx(void)
Wolfgang Betz 34:edda6a7238ec 271 {
Wolfgang Betz 34:edda6a7238ec 272 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 273
Wolfgang Betz 34:edda6a7238ec 274 /* Reads the register containing the calibration data word used in TX mode */
Wolfgang Betz 34:edda6a7238ec 275 g_xStatus = SpiritSpiReadRegisters(RCO_VCO_CALIBR_IN1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 276
Wolfgang Betz 34:edda6a7238ec 277 /* Mask the VCO_CALIBR_TX field and returns the value */
Wolfgang Betz 34:edda6a7238ec 278 return (tempRegValue & 0x7F);
Wolfgang Betz 34:edda6a7238ec 279
Wolfgang Betz 34:edda6a7238ec 280 }
Wolfgang Betz 34:edda6a7238ec 281
Wolfgang Betz 34:edda6a7238ec 282
Wolfgang Betz 34:edda6a7238ec 283 /**
Wolfgang Betz 34:edda6a7238ec 284 * @brief Sets the VCO calibration data to be used in RX mode.
Wolfgang Betz 34:edda6a7238ec 285 * @param cVcoCalData calibration data word to be set.
Wolfgang Betz 34:edda6a7238ec 286 * This parameter is a variable of uint8_t.
Wolfgang Betz 34:edda6a7238ec 287 * @retval None.
Wolfgang Betz 34:edda6a7238ec 288 */
Wolfgang Betz 34:edda6a7238ec 289 void SpiritCalibrationSetVcoCalDataRx(uint8_t cVcoCalData)
Wolfgang Betz 34:edda6a7238ec 290 {
Wolfgang Betz 34:edda6a7238ec 291 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 292
Wolfgang Betz 34:edda6a7238ec 293 /* Reads the register value */
Wolfgang Betz 34:edda6a7238ec 294 g_xStatus = SpiritSpiReadRegisters(RCO_VCO_CALIBR_IN0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 295
Wolfgang Betz 34:edda6a7238ec 296 /* Build the value to be written */
Wolfgang Betz 34:edda6a7238ec 297 tempRegValue &= 0x80;
Wolfgang Betz 34:edda6a7238ec 298 tempRegValue |= cVcoCalData;
Wolfgang Betz 34:edda6a7238ec 299
Wolfgang Betz 34:edda6a7238ec 300 /* Writes the new value of calibration data in RX */
Wolfgang Betz 34:edda6a7238ec 301 g_xStatus = SpiritSpiWriteRegisters(RCO_VCO_CALIBR_IN0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 302
Wolfgang Betz 34:edda6a7238ec 303 }
Wolfgang Betz 34:edda6a7238ec 304
Wolfgang Betz 34:edda6a7238ec 305
Wolfgang Betz 34:edda6a7238ec 306 /**
Wolfgang Betz 34:edda6a7238ec 307 * @brief Returns the actual VCO calibration data used in RX mode.
Wolfgang Betz 34:edda6a7238ec 308 * @param None.
Wolfgang Betz 34:edda6a7238ec 309 * @retval uint8_t Calibration data word used in RX mode.
Wolfgang Betz 34:edda6a7238ec 310 */
Wolfgang Betz 34:edda6a7238ec 311 uint8_t SpiritCalibrationGetVcoCalDataRx(void)
Wolfgang Betz 34:edda6a7238ec 312 {
Wolfgang Betz 34:edda6a7238ec 313 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 314
Wolfgang Betz 34:edda6a7238ec 315 /* Reads the register containing the calibration data word used in TX mode */
Wolfgang Betz 34:edda6a7238ec 316 g_xStatus = SpiritSpiReadRegisters(RCO_VCO_CALIBR_IN0_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 317
Wolfgang Betz 34:edda6a7238ec 318 /* Mask the VCO_CALIBR_RX field and returns the value */
Wolfgang Betz 34:edda6a7238ec 319 return (tempRegValue & 0x7F);
Wolfgang Betz 34:edda6a7238ec 320
Wolfgang Betz 34:edda6a7238ec 321 }
Wolfgang Betz 34:edda6a7238ec 322
Wolfgang Betz 34:edda6a7238ec 323
Wolfgang Betz 34:edda6a7238ec 324 /**
Wolfgang Betz 34:edda6a7238ec 325 * @brief Sets the VCO calibration window.
Wolfgang Betz 34:edda6a7238ec 326 * @param xRefWord value of REFWORD corresponding to the Ref_period according to the formula: CALIBRATION_WIN = 11*Ref_period/fxo.
Wolfgang Betz 34:edda6a7238ec 327 This parameter can be a value of @ref VcoWin.
Wolfgang Betz 34:edda6a7238ec 328 * @retval None.
Wolfgang Betz 34:edda6a7238ec 329 */
Wolfgang Betz 34:edda6a7238ec 330 void SpiritCalibrationSetVcoWindow(VcoWin xRefWord)
Wolfgang Betz 34:edda6a7238ec 331 {
Wolfgang Betz 34:edda6a7238ec 332 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 333
Wolfgang Betz 34:edda6a7238ec 334 /* Check the parameters */
Wolfgang Betz 34:edda6a7238ec 335 s_assert_param(IS_VCO_WIN(xRefWord));
Wolfgang Betz 34:edda6a7238ec 336
Wolfgang Betz 34:edda6a7238ec 337 /* Reads the register value */
Wolfgang Betz 34:edda6a7238ec 338 g_xStatus = SpiritSpiReadRegisters(SYNTH_CONFIG1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 339
Wolfgang Betz 34:edda6a7238ec 340 /* Build the values to be written */
Wolfgang Betz 34:edda6a7238ec 341 tempRegValue &= 0xFC;
Wolfgang Betz 34:edda6a7238ec 342 tempRegValue |= xRefWord;
Wolfgang Betz 34:edda6a7238ec 343
Wolfgang Betz 34:edda6a7238ec 344 /* Writes the new value of VCO calibration window */
Wolfgang Betz 34:edda6a7238ec 345 g_xStatus = SpiritSpiWriteRegisters(SYNTH_CONFIG1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 346
Wolfgang Betz 34:edda6a7238ec 347 }
Wolfgang Betz 34:edda6a7238ec 348
Wolfgang Betz 34:edda6a7238ec 349
Wolfgang Betz 34:edda6a7238ec 350 /**
Wolfgang Betz 34:edda6a7238ec 351 * @brief Returns the VCO calibration window.
Wolfgang Betz 34:edda6a7238ec 352 * @param None.
Wolfgang Betz 34:edda6a7238ec 353 * @retval VcoWin Value of REFWORD corresponding to the Ref_period according to the formula: CALIBRATION_WIN = 11*Ref_period/fxo.
Wolfgang Betz 34:edda6a7238ec 354 * This parameter can be a value of @ref VcoWin.
Wolfgang Betz 34:edda6a7238ec 355 */
Wolfgang Betz 34:edda6a7238ec 356 VcoWin SpiritCalibrationGetVcoWindow(void)
Wolfgang Betz 34:edda6a7238ec 357 {
Wolfgang Betz 34:edda6a7238ec 358 uint8_t tempRegValue1, tempRegValue2;
Wolfgang Betz 34:edda6a7238ec 359 VcoWin refWord;
Wolfgang Betz 34:edda6a7238ec 360
Wolfgang Betz 34:edda6a7238ec 361 /* Reads the register containing the REFWORD value */
Wolfgang Betz 34:edda6a7238ec 362 g_xStatus = SpiritSpiReadRegisters(SYNTH_CONFIG1_BASE, 1, &tempRegValue1);
Wolfgang Betz 34:edda6a7238ec 363
Wolfgang Betz 34:edda6a7238ec 364 /* Reads the Xtal configuration */
Wolfgang Betz 34:edda6a7238ec 365 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue2);
Wolfgang Betz 34:edda6a7238ec 366
Wolfgang Betz 34:edda6a7238ec 367 /* Mask the REFWORD field */
Wolfgang Betz 34:edda6a7238ec 368 tempRegValue1 &= 0x03;
Wolfgang Betz 34:edda6a7238ec 369
Wolfgang Betz 34:edda6a7238ec 370 /* Mask the 24_26_MHz_SELECT field */
Wolfgang Betz 34:edda6a7238ec 371 tempRegValue2 = ((tempRegValue2 & 0x40)>>6);
Wolfgang Betz 34:edda6a7238ec 372
Wolfgang Betz 34:edda6a7238ec 373 /* In case of 26 MHz crystal */
Wolfgang Betz 34:edda6a7238ec 374 if(tempRegValue2)
Wolfgang Betz 34:edda6a7238ec 375 {
Wolfgang Betz 34:edda6a7238ec 376 switch(tempRegValue1)
Wolfgang Betz 34:edda6a7238ec 377 {
Wolfgang Betz 34:edda6a7238ec 378 case 0:
Wolfgang Betz 34:edda6a7238ec 379 refWord = CALIB_TIME_6_77_US_26MHZ;
Wolfgang Betz 34:edda6a7238ec 380 break;
Wolfgang Betz 34:edda6a7238ec 381 case 1:
Wolfgang Betz 34:edda6a7238ec 382 refWord = CALIB_TIME_13_54_US_26MHZ;
Wolfgang Betz 34:edda6a7238ec 383 break;
Wolfgang Betz 34:edda6a7238ec 384 case 2:
Wolfgang Betz 34:edda6a7238ec 385 refWord = CALIB_TIME_27_08_US_26MHZ;
Wolfgang Betz 34:edda6a7238ec 386 break;
Wolfgang Betz 34:edda6a7238ec 387 case 3:
Wolfgang Betz 34:edda6a7238ec 388 refWord = CALIB_TIME_54_15_US_26MHZ;
Wolfgang Betz 34:edda6a7238ec 389 break;
Wolfgang Betz 34:edda6a7238ec 390 }
Wolfgang Betz 34:edda6a7238ec 391 }
Wolfgang Betz 34:edda6a7238ec 392
Wolfgang Betz 34:edda6a7238ec 393 /* In case of 24 MHz crystal */
Wolfgang Betz 34:edda6a7238ec 394 else
Wolfgang Betz 34:edda6a7238ec 395 {
Wolfgang Betz 34:edda6a7238ec 396 switch(tempRegValue1)
Wolfgang Betz 34:edda6a7238ec 397 {
Wolfgang Betz 34:edda6a7238ec 398 case 0:
Wolfgang Betz 34:edda6a7238ec 399 refWord = CALIB_TIME_7_33_US_24MHZ;
Wolfgang Betz 34:edda6a7238ec 400 break;
Wolfgang Betz 34:edda6a7238ec 401 case 1:
Wolfgang Betz 34:edda6a7238ec 402 refWord = CALIB_TIME_14_67_US_24MHZ;
Wolfgang Betz 34:edda6a7238ec 403 break;
Wolfgang Betz 34:edda6a7238ec 404 case 2:
Wolfgang Betz 34:edda6a7238ec 405 refWord = CALIB_TIME_29_33_US_24MHZ;
Wolfgang Betz 34:edda6a7238ec 406 break;
Wolfgang Betz 34:edda6a7238ec 407 case 3:
Wolfgang Betz 34:edda6a7238ec 408 refWord = CALIB_TIME_58_67_US_24MHZ;
Wolfgang Betz 34:edda6a7238ec 409 break;
Wolfgang Betz 34:edda6a7238ec 410 }
Wolfgang Betz 34:edda6a7238ec 411 }
Wolfgang Betz 34:edda6a7238ec 412
Wolfgang Betz 34:edda6a7238ec 413 return refWord;
Wolfgang Betz 34:edda6a7238ec 414
Wolfgang Betz 34:edda6a7238ec 415 }
Wolfgang Betz 34:edda6a7238ec 416
Wolfgang Betz 34:edda6a7238ec 417 /**
Wolfgang Betz 34:edda6a7238ec 418 * @brief Selects a VCO.
Wolfgang Betz 34:edda6a7238ec 419 * @param xVco can be VCO_H or VCO_L according to which VCO select.
Wolfgang Betz 34:edda6a7238ec 420 * This parameter can be a value of @ref VcoSel.
Wolfgang Betz 34:edda6a7238ec 421 * @retval None.
Wolfgang Betz 34:edda6a7238ec 422 */
Wolfgang Betz 34:edda6a7238ec 423 void SpiritCalibrationSelectVco(VcoSel xVco)
Wolfgang Betz 34:edda6a7238ec 424 {
Wolfgang Betz 34:edda6a7238ec 425 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 426
Wolfgang Betz 34:edda6a7238ec 427 /* Check the parameter */
Wolfgang Betz 34:edda6a7238ec 428 s_assert_param(IS_VCO_SEL(xVco));
Wolfgang Betz 34:edda6a7238ec 429
Wolfgang Betz 34:edda6a7238ec 430 SpiritSpiReadRegisters(SYNTH_CONFIG1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 431
Wolfgang Betz 34:edda6a7238ec 432 tempRegValue &= 0xF9;
Wolfgang Betz 34:edda6a7238ec 433
Wolfgang Betz 34:edda6a7238ec 434 if(xVco == VCO_H)
Wolfgang Betz 34:edda6a7238ec 435 {
Wolfgang Betz 34:edda6a7238ec 436 tempRegValue |= 0x02;
Wolfgang Betz 34:edda6a7238ec 437
Wolfgang Betz 34:edda6a7238ec 438 }
Wolfgang Betz 34:edda6a7238ec 439 else
Wolfgang Betz 34:edda6a7238ec 440 {
Wolfgang Betz 34:edda6a7238ec 441 tempRegValue |= 0x04;
Wolfgang Betz 34:edda6a7238ec 442 }
Wolfgang Betz 34:edda6a7238ec 443 SpiritSpiWriteRegisters(SYNTH_CONFIG1_BASE, 1, &tempRegValue);
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 /**
Wolfgang Betz 34:edda6a7238ec 450 * @brief Returns the VCO selected.
Wolfgang Betz 34:edda6a7238ec 451 * @param void.
Wolfgang Betz 34:edda6a7238ec 452 * @retval VCO_H or VCO_L according to which VCO selected.
Wolfgang Betz 34:edda6a7238ec 453 * This parameter can be a value of @ref VcoSel.
Wolfgang Betz 34:edda6a7238ec 454 */
Wolfgang Betz 34:edda6a7238ec 455 VcoSel SpiritCalibrationGetVcoSelecttion(void)
Wolfgang Betz 34:edda6a7238ec 456 {
Wolfgang Betz 34:edda6a7238ec 457 uint8_t tempRegValue;
Wolfgang Betz 34:edda6a7238ec 458
Wolfgang Betz 34:edda6a7238ec 459 SpiritSpiReadRegisters(SYNTH_CONFIG1_BASE, 1, &tempRegValue);
Wolfgang Betz 34:edda6a7238ec 460
Wolfgang Betz 34:edda6a7238ec 461 tempRegValue = (tempRegValue>>1)&0x3;
Wolfgang Betz 34:edda6a7238ec 462
Wolfgang Betz 34:edda6a7238ec 463 if(tempRegValue == 0x01)
Wolfgang Betz 34:edda6a7238ec 464 {
Wolfgang Betz 34:edda6a7238ec 465 return VCO_H;
Wolfgang Betz 34:edda6a7238ec 466
Wolfgang Betz 34:edda6a7238ec 467 }
Wolfgang Betz 34:edda6a7238ec 468 else
Wolfgang Betz 34:edda6a7238ec 469 {
Wolfgang Betz 34:edda6a7238ec 470 return VCO_L;
Wolfgang Betz 34:edda6a7238ec 471 }
Wolfgang Betz 34:edda6a7238ec 472
Wolfgang Betz 34:edda6a7238ec 473 }
Wolfgang Betz 34:edda6a7238ec 474
Wolfgang Betz 34:edda6a7238ec 475
Wolfgang Betz 34:edda6a7238ec 476 /**
Wolfgang Betz 34:edda6a7238ec 477 *@}
Wolfgang Betz 34:edda6a7238ec 478 */
Wolfgang Betz 34:edda6a7238ec 479
Wolfgang Betz 34:edda6a7238ec 480 /**
Wolfgang Betz 34:edda6a7238ec 481 *@}
Wolfgang Betz 34:edda6a7238ec 482 */
Wolfgang Betz 34:edda6a7238ec 483
Wolfgang Betz 34:edda6a7238ec 484
Wolfgang Betz 34:edda6a7238ec 485 /**
Wolfgang Betz 34:edda6a7238ec 486 *@}
Wolfgang Betz 34:edda6a7238ec 487 */
Wolfgang Betz 34:edda6a7238ec 488
Wolfgang Betz 34:edda6a7238ec 489
Wolfgang Betz 34:edda6a7238ec 490
Wolfgang Betz 34:edda6a7238ec 491 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/