Vergil Cola / Mbed OS MQTTGateway2

Fork of my original MQTTGateway

Dependencies:   mbed-http

easy-connect/stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_Calibration.h@0:a1734fe1ec4b, 2017-04-08 (annotated)

Committer:
vpcola
Date:
Sat Apr 08 14:43:14 2017 +0000
Revision:
0:a1734fe1ec4b
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vpcola 0:a1734fe1ec4b 1 /**
vpcola 0:a1734fe1ec4b 2 ******************************************************************************
vpcola 0:a1734fe1ec4b 3 * @file SPIRIT_Calibration.h
vpcola 0:a1734fe1ec4b 4 * @author VMA division - AMS
vpcola 0:a1734fe1ec4b 5 * @version 3.2.2
vpcola 0:a1734fe1ec4b 6 * @date 08-July-2015
vpcola 0:a1734fe1ec4b 7 * @brief Configuration and management of SPIRIT VCO-RCO calibration.
vpcola 0:a1734fe1ec4b 8 *
vpcola 0:a1734fe1ec4b 9 * @details
vpcola 0:a1734fe1ec4b 10 *
vpcola 0:a1734fe1ec4b 11 * This module allows the user to set some parameters which deal
vpcola 0:a1734fe1ec4b 12 * with the oscillators calibration.
vpcola 0:a1734fe1ec4b 13 * The state machine of Spirit contemplates some optional calibrating operations
vpcola 0:a1734fe1ec4b 14 * in the transition between the READY and the LOCK state.
vpcola 0:a1734fe1ec4b 15 * The user is allowed to enable or disable the automatic RCO/VCO calibration
vpcola 0:a1734fe1ec4b 16 * by calling the functions <i>@ref SpiritCalibrationVco()</i> and <i>@ref SpiritCalibrationRco()</i>.
vpcola 0:a1734fe1ec4b 17 * The following example shows how to do an initial calibration of VCO.
vpcola 0:a1734fe1ec4b 18 *
vpcola 0:a1734fe1ec4b 19 * <b>Example:</b>
vpcola 0:a1734fe1ec4b 20 * @code
vpcola 0:a1734fe1ec4b 21 * uint8_t calData;
vpcola 0:a1734fe1ec4b 22 *
vpcola 0:a1734fe1ec4b 23 * SpiritCalibrationVco(S_ENABLE);
vpcola 0:a1734fe1ec4b 24 * SpiritCmdStrobeLockTx();
vpcola 0:a1734fe1ec4b 25 *
vpcola 0:a1734fe1ec4b 26 * while(g_xStatus.MC_STATE != MC_STATE_LOCK){
vpcola 0:a1734fe1ec4b 27 * SpiritRefreshStatus();
vpcola 0:a1734fe1ec4b 28 * }
vpcola 0:a1734fe1ec4b 29 *
vpcola 0:a1734fe1ec4b 30 * calData = SpiritCalibrationGetVcoCalDataTx();
vpcola 0:a1734fe1ec4b 31 * SpiritCalibrationSetVcoCalDataTx(calData);
vpcola 0:a1734fe1ec4b 32 *
vpcola 0:a1734fe1ec4b 33 * SpiritCmdStrobeReady();
vpcola 0:a1734fe1ec4b 34 * SpiritCalibrationVco(S_DISABLE);
vpcola 0:a1734fe1ec4b 35 *
vpcola 0:a1734fe1ec4b 36 * @endcode
vpcola 0:a1734fe1ec4b 37 *
vpcola 0:a1734fe1ec4b 38 * Similar operations can be done for the RCO calibrator.
vpcola 0:a1734fe1ec4b 39 *
vpcola 0:a1734fe1ec4b 40 * @attention
vpcola 0:a1734fe1ec4b 41 *
vpcola 0:a1734fe1ec4b 42 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
vpcola 0:a1734fe1ec4b 43 *
vpcola 0:a1734fe1ec4b 44 * Redistribution and use in source and binary forms, with or without modification,
vpcola 0:a1734fe1ec4b 45 * are permitted provided that the following conditions are met:
vpcola 0:a1734fe1ec4b 46 * 1. Redistributions of source code must retain the above copyright notice,
vpcola 0:a1734fe1ec4b 47 * this list of conditions and the following disclaimer.
vpcola 0:a1734fe1ec4b 48 * 2. Redistributions in binary form must reproduce the above copyright notice,
vpcola 0:a1734fe1ec4b 49 * this list of conditions and the following disclaimer in the documentation
vpcola 0:a1734fe1ec4b 50 * and/or other materials provided with the distribution.
vpcola 0:a1734fe1ec4b 51 * 3. Neither the name of STMicroelectronics nor the names of its contributors
vpcola 0:a1734fe1ec4b 52 * may be used to endorse or promote products derived from this software
vpcola 0:a1734fe1ec4b 53 * without specific prior written permission.
vpcola 0:a1734fe1ec4b 54 *
vpcola 0:a1734fe1ec4b 55 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
vpcola 0:a1734fe1ec4b 56 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
vpcola 0:a1734fe1ec4b 57 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
vpcola 0:a1734fe1ec4b 58 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
vpcola 0:a1734fe1ec4b 59 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
vpcola 0:a1734fe1ec4b 60 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
vpcola 0:a1734fe1ec4b 61 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
vpcola 0:a1734fe1ec4b 62 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
vpcola 0:a1734fe1ec4b 63 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
vpcola 0:a1734fe1ec4b 64 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
vpcola 0:a1734fe1ec4b 65 *
vpcola 0:a1734fe1ec4b 66 ******************************************************************************
vpcola 0:a1734fe1ec4b 67 */
vpcola 0:a1734fe1ec4b 68
vpcola 0:a1734fe1ec4b 69 /* Define to prevent recursive inclusion -------------------------------------*/
vpcola 0:a1734fe1ec4b 70 #ifndef __SPIRIT_CALIBRATION_H
vpcola 0:a1734fe1ec4b 71 #define __SPIRIT_CALIBRATION_H
vpcola 0:a1734fe1ec4b 72
vpcola 0:a1734fe1ec4b 73
vpcola 0:a1734fe1ec4b 74 /* Includes ------------------------------------------------------------------*/
vpcola 0:a1734fe1ec4b 75
vpcola 0:a1734fe1ec4b 76 #include "SPIRIT_Regs.h"
vpcola 0:a1734fe1ec4b 77 #include "SPIRIT_Types.h"
vpcola 0:a1734fe1ec4b 78
vpcola 0:a1734fe1ec4b 79
vpcola 0:a1734fe1ec4b 80 #ifdef __cplusplus
vpcola 0:a1734fe1ec4b 81 extern "C" {
vpcola 0:a1734fe1ec4b 82 #endif
vpcola 0:a1734fe1ec4b 83
vpcola 0:a1734fe1ec4b 84
vpcola 0:a1734fe1ec4b 85 /**
vpcola 0:a1734fe1ec4b 86 * @addtogroup SPIRIT_Libraries
vpcola 0:a1734fe1ec4b 87 * @{
vpcola 0:a1734fe1ec4b 88 */
vpcola 0:a1734fe1ec4b 89
vpcola 0:a1734fe1ec4b 90
vpcola 0:a1734fe1ec4b 91 /**
vpcola 0:a1734fe1ec4b 92 * @defgroup SPIRIT_Calibration Calibration
vpcola 0:a1734fe1ec4b 93 * @brief Configuration and management of SPIRIT VCO-RCO calibration.
vpcola 0:a1734fe1ec4b 94 * @details See the file <i>@ref SPIRIT_Calibration.h</i> for more details.
vpcola 0:a1734fe1ec4b 95 * @{
vpcola 0:a1734fe1ec4b 96 */
vpcola 0:a1734fe1ec4b 97
vpcola 0:a1734fe1ec4b 98 /**
vpcola 0:a1734fe1ec4b 99 * @defgroup Calibration_Exported_Types Calibration Exported Types
vpcola 0:a1734fe1ec4b 100 * @{
vpcola 0:a1734fe1ec4b 101 */
vpcola 0:a1734fe1ec4b 102
vpcola 0:a1734fe1ec4b 103
vpcola 0:a1734fe1ec4b 104 /**
vpcola 0:a1734fe1ec4b 105 * @brief VCO / RCO calibration window.
vpcola 0:a1734fe1ec4b 106 */
vpcola 0:a1734fe1ec4b 107 typedef enum
vpcola 0:a1734fe1ec4b 108 {
vpcola 0:a1734fe1ec4b 109
vpcola 0:a1734fe1ec4b 110 CALIB_TIME_7_33_US_24MHZ = 0x00, /*!< calibration window of 7.33 us with XTAL=24MHz */
vpcola 0:a1734fe1ec4b 111 CALIB_TIME_14_67_US_24MHZ, /*!< calibration window of 14.67 us with XTAL=24MHz */
vpcola 0:a1734fe1ec4b 112 CALIB_TIME_29_33_US_24MHZ, /*!< calibration window of 29.33 us with XTAL=24MHz */
vpcola 0:a1734fe1ec4b 113 CALIB_TIME_58_67_US_24MHZ, /*!< calibration window of 58.67 us with XTAL=24MHz */
vpcola 0:a1734fe1ec4b 114
vpcola 0:a1734fe1ec4b 115 CALIB_TIME_6_77_US_26MHZ = 0x00, /*!< calibration window of 6.77 us with XTAL=26MHz */
vpcola 0:a1734fe1ec4b 116 CALIB_TIME_13_54_US_26MHZ, /*!< calibration window of 13.54 us with XTAL=26MHz */
vpcola 0:a1734fe1ec4b 117 CALIB_TIME_27_08_US_26MHZ, /*!< calibration window of 27.08 us with XTAL=26MHz */
vpcola 0:a1734fe1ec4b 118 CALIB_TIME_54_15_US_26MHZ /*!< calibration window of 54.15 us with XTAL=26MHz */
vpcola 0:a1734fe1ec4b 119
vpcola 0:a1734fe1ec4b 120 } VcoWin;
vpcola 0:a1734fe1ec4b 121
vpcola 0:a1734fe1ec4b 122
vpcola 0:a1734fe1ec4b 123 #define IS_VCO_WIN(REF) (REF == CALIB_TIME_7_33_US_24MHZ ||\
vpcola 0:a1734fe1ec4b 124 REF == CALIB_TIME_14_67_US_24MHZ ||\
vpcola 0:a1734fe1ec4b 125 REF == CALIB_TIME_29_33_US_24MHZ ||\
vpcola 0:a1734fe1ec4b 126 REF == CALIB_TIME_58_67_US_24MHZ ||\
vpcola 0:a1734fe1ec4b 127 REF == CALIB_TIME_6_77_US_26MHZ ||\
vpcola 0:a1734fe1ec4b 128 REF == CALIB_TIME_13_54_US_26MHZ ||\
vpcola 0:a1734fe1ec4b 129 REF == CALIB_TIME_27_08_US_26MHZ ||\
vpcola 0:a1734fe1ec4b 130 REF == CALIB_TIME_54_15_US_26MHZ \
vpcola 0:a1734fe1ec4b 131 )
vpcola 0:a1734fe1ec4b 132
vpcola 0:a1734fe1ec4b 133 /**
vpcola 0:a1734fe1ec4b 134 * @brief VCO_H / VCO_L selection.
vpcola 0:a1734fe1ec4b 135 */
vpcola 0:a1734fe1ec4b 136 typedef enum
vpcola 0:a1734fe1ec4b 137 {
vpcola 0:a1734fe1ec4b 138
vpcola 0:a1734fe1ec4b 139 VCO_L = 0x00, /*!< VCO lower */
vpcola 0:a1734fe1ec4b 140 VCO_H, /*!< VCO higher */
vpcola 0:a1734fe1ec4b 141 } VcoSel;
vpcola 0:a1734fe1ec4b 142
vpcola 0:a1734fe1ec4b 143
vpcola 0:a1734fe1ec4b 144 #define IS_VCO_SEL(REF) (REF == VCO_L ||\
vpcola 0:a1734fe1ec4b 145 REF == VCO_H \
vpcola 0:a1734fe1ec4b 146 )
vpcola 0:a1734fe1ec4b 147
vpcola 0:a1734fe1ec4b 148
vpcola 0:a1734fe1ec4b 149 /**
vpcola 0:a1734fe1ec4b 150 * @}
vpcola 0:a1734fe1ec4b 151 */
vpcola 0:a1734fe1ec4b 152
vpcola 0:a1734fe1ec4b 153
vpcola 0:a1734fe1ec4b 154 /**
vpcola 0:a1734fe1ec4b 155 * @defgroup Calibration_Exported_Constants Calibration Exported Constants
vpcola 0:a1734fe1ec4b 156 * @{
vpcola 0:a1734fe1ec4b 157 */
vpcola 0:a1734fe1ec4b 158
vpcola 0:a1734fe1ec4b 159 /**
vpcola 0:a1734fe1ec4b 160 * @}
vpcola 0:a1734fe1ec4b 161 */
vpcola 0:a1734fe1ec4b 162
vpcola 0:a1734fe1ec4b 163
vpcola 0:a1734fe1ec4b 164
vpcola 0:a1734fe1ec4b 165 /** @defgroup VCO_Calibration VCO Calibration
vpcola 0:a1734fe1ec4b 166 * @{
vpcola 0:a1734fe1ec4b 167 */
vpcola 0:a1734fe1ec4b 168
vpcola 0:a1734fe1ec4b 169 /**
vpcola 0:a1734fe1ec4b 170 * @}
vpcola 0:a1734fe1ec4b 171 */
vpcola 0:a1734fe1ec4b 172
vpcola 0:a1734fe1ec4b 173
vpcola 0:a1734fe1ec4b 174
vpcola 0:a1734fe1ec4b 175
vpcola 0:a1734fe1ec4b 176 /**
vpcola 0:a1734fe1ec4b 177 * @defgroup Calibration_Exported_Macros Calibration Exported Macros
vpcola 0:a1734fe1ec4b 178 * @{
vpcola 0:a1734fe1ec4b 179 */
vpcola 0:a1734fe1ec4b 180
vpcola 0:a1734fe1ec4b 181
vpcola 0:a1734fe1ec4b 182 /**
vpcola 0:a1734fe1ec4b 183 * @}
vpcola 0:a1734fe1ec4b 184 */
vpcola 0:a1734fe1ec4b 185
vpcola 0:a1734fe1ec4b 186
vpcola 0:a1734fe1ec4b 187 /**
vpcola 0:a1734fe1ec4b 188 * @defgroup Calibration_Exported_Functions Calibration Exported Functions
vpcola 0:a1734fe1ec4b 189 * @{
vpcola 0:a1734fe1ec4b 190 */
vpcola 0:a1734fe1ec4b 191
vpcola 0:a1734fe1ec4b 192 void SpiritCalibrationRco(SpiritFunctionalState xNewState);
vpcola 0:a1734fe1ec4b 193 void SpiritCalibrationVco(SpiritFunctionalState xNewState);
vpcola 0:a1734fe1ec4b 194 void SpiritCalibrationSetRcoCalWords(uint8_t cRwt, uint8_t cRfb);
vpcola 0:a1734fe1ec4b 195 void SpiritCalibrationGetRcoCalWords(uint8_t* pcRwt, uint8_t* pcRfb);
vpcola 0:a1734fe1ec4b 196 uint8_t SpiritCalibrationGetVcoCalData(void);
vpcola 0:a1734fe1ec4b 197 void SpiritCalibrationSetVcoCalDataTx(uint8_t cVcoCalData);
vpcola 0:a1734fe1ec4b 198 uint8_t SpiritCalibrationGetVcoCalDataTx(void);
vpcola 0:a1734fe1ec4b 199 void SpiritCalibrationSetVcoCalDataRx(uint8_t cVcoCalData);
vpcola 0:a1734fe1ec4b 200 uint8_t SpiritCalibrationGetVcoCalDataRx(void);
vpcola 0:a1734fe1ec4b 201 void SpiritCalibrationSetVcoWindow(VcoWin xRefWord);
vpcola 0:a1734fe1ec4b 202 VcoWin SpiritCalibrationGetVcoWindow(void);
vpcola 0:a1734fe1ec4b 203 VcoSel SpiritCalibrationGetVcoSelecttion(void);
vpcola 0:a1734fe1ec4b 204 void SpiritCalibrationSelectVco(VcoSel xVco);
vpcola 0:a1734fe1ec4b 205
vpcola 0:a1734fe1ec4b 206 /**
vpcola 0:a1734fe1ec4b 207 * @}
vpcola 0:a1734fe1ec4b 208 */
vpcola 0:a1734fe1ec4b 209
vpcola 0:a1734fe1ec4b 210
vpcola 0:a1734fe1ec4b 211 /**
vpcola 0:a1734fe1ec4b 212 * @}
vpcola 0:a1734fe1ec4b 213 */
vpcola 0:a1734fe1ec4b 214
vpcola 0:a1734fe1ec4b 215
vpcola 0:a1734fe1ec4b 216 /**
vpcola 0:a1734fe1ec4b 217 * @}
vpcola 0:a1734fe1ec4b 218 */
vpcola 0:a1734fe1ec4b 219
vpcola 0:a1734fe1ec4b 220 #ifdef __cplusplus
vpcola 0:a1734fe1ec4b 221 }
vpcola 0:a1734fe1ec4b 222 #endif
vpcola 0:a1734fe1ec4b 223
vpcola 0:a1734fe1ec4b 224 #endif
vpcola 0:a1734fe1ec4b 225
vpcola 0:a1734fe1ec4b 226 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/