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