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