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_Timer.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_Timer.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 timers.
vpcola 0:a1734fe1ec4b 8 * @details
vpcola 0:a1734fe1ec4b 9 *
vpcola 0:a1734fe1ec4b 10 * This module provides API to configure the Spirit timing mechanisms.
vpcola 0:a1734fe1ec4b 11 * They allow the user to set the timer registers using raw values or
vpcola 0:a1734fe1ec4b 12 * compute them since the desired timer value is expressed in ms.
vpcola 0:a1734fe1ec4b 13 * Moreover the management of the Spirit LDCR mode can be done using
vpcola 0:a1734fe1ec4b 14 * these API.
vpcola 0:a1734fe1ec4b 15 *
vpcola 0:a1734fe1ec4b 16 * <b>Example:</b>
vpcola 0:a1734fe1ec4b 17 * @code
vpcola 0:a1734fe1ec4b 18 * ...
vpcola 0:a1734fe1ec4b 19 *
vpcola 0:a1734fe1ec4b 20 * SpiritTimerSetRxTimeoutMs(50.0);
vpcola 0:a1734fe1ec4b 21 * SpiritTimerSetWakeUpTimerMs(150.0);
vpcola 0:a1734fe1ec4b 22 *
vpcola 0:a1734fe1ec4b 23 * // IRQ configuration for RX_TIMEOUT and WAKEUP_TIMEOUT
vpcola 0:a1734fe1ec4b 24 * ...
vpcola 0:a1734fe1ec4b 25 *
vpcola 0:a1734fe1ec4b 26 * SpiritTimerLdcrMode(S_ENABLE);
vpcola 0:a1734fe1ec4b 27 *
vpcola 0:a1734fe1ec4b 28 * ...
vpcola 0:a1734fe1ec4b 29 *
vpcola 0:a1734fe1ec4b 30 * @endcode
vpcola 0:a1734fe1ec4b 31 *
vpcola 0:a1734fe1ec4b 32 *
vpcola 0:a1734fe1ec4b 33 * @attention
vpcola 0:a1734fe1ec4b 34 *
vpcola 0:a1734fe1ec4b 35 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
vpcola 0:a1734fe1ec4b 36 *
vpcola 0:a1734fe1ec4b 37 * Redistribution and use in source and binary forms, with or without modification,
vpcola 0:a1734fe1ec4b 38 * are permitted provided that the following conditions are met:
vpcola 0:a1734fe1ec4b 39 * 1. Redistributions of source code must retain the above copyright notice,
vpcola 0:a1734fe1ec4b 40 * this list of conditions and the following disclaimer.
vpcola 0:a1734fe1ec4b 41 * 2. Redistributions in binary form must reproduce the above copyright notice,
vpcola 0:a1734fe1ec4b 42 * this list of conditions and the following disclaimer in the documentation
vpcola 0:a1734fe1ec4b 43 * and/or other materials provided with the distribution.
vpcola 0:a1734fe1ec4b 44 * 3. Neither the name of STMicroelectronics nor the names of its contributors
vpcola 0:a1734fe1ec4b 45 * may be used to endorse or promote products derived from this software
vpcola 0:a1734fe1ec4b 46 * without specific prior written permission.
vpcola 0:a1734fe1ec4b 47 *
vpcola 0:a1734fe1ec4b 48 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
vpcola 0:a1734fe1ec4b 49 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
vpcola 0:a1734fe1ec4b 50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
vpcola 0:a1734fe1ec4b 51 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
vpcola 0:a1734fe1ec4b 52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
vpcola 0:a1734fe1ec4b 53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
vpcola 0:a1734fe1ec4b 54 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
vpcola 0:a1734fe1ec4b 55 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
vpcola 0:a1734fe1ec4b 56 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
vpcola 0:a1734fe1ec4b 57 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
vpcola 0:a1734fe1ec4b 58 *
vpcola 0:a1734fe1ec4b 59 ******************************************************************************
vpcola 0:a1734fe1ec4b 60 */
vpcola 0:a1734fe1ec4b 61
vpcola 0:a1734fe1ec4b 62 /* Define to prevent recursive inclusion -------------------------------------*/
vpcola 0:a1734fe1ec4b 63 #ifndef __SPIRIT1_TIMER_H
vpcola 0:a1734fe1ec4b 64 #define __SPIRIT1_TIMER_H
vpcola 0:a1734fe1ec4b 65
vpcola 0:a1734fe1ec4b 66
vpcola 0:a1734fe1ec4b 67 /* Includes ------------------------------------------------------------------*/
vpcola 0:a1734fe1ec4b 68
vpcola 0:a1734fe1ec4b 69 #include "SPIRIT_Regs.h"
vpcola 0:a1734fe1ec4b 70 #include "SPIRIT_Types.h"
vpcola 0:a1734fe1ec4b 71
vpcola 0:a1734fe1ec4b 72
vpcola 0:a1734fe1ec4b 73 #ifdef __cplusplus
vpcola 0:a1734fe1ec4b 74 extern "C" {
vpcola 0:a1734fe1ec4b 75 #endif
vpcola 0:a1734fe1ec4b 76
vpcola 0:a1734fe1ec4b 77
vpcola 0:a1734fe1ec4b 78 /**
vpcola 0:a1734fe1ec4b 79 * @addtogroup SPIRIT_Libraries
vpcola 0:a1734fe1ec4b 80 * @{
vpcola 0:a1734fe1ec4b 81 */
vpcola 0:a1734fe1ec4b 82
vpcola 0:a1734fe1ec4b 83
vpcola 0:a1734fe1ec4b 84 /**
vpcola 0:a1734fe1ec4b 85 * @defgroup SPIRIT_Timer Timer
vpcola 0:a1734fe1ec4b 86 * @brief Configuration and management of SPIRIT Timers.
vpcola 0:a1734fe1ec4b 87 * @details See the file <i>@ref SPIRIT_Timer.h</i> for more details.
vpcola 0:a1734fe1ec4b 88 * @{
vpcola 0:a1734fe1ec4b 89 */
vpcola 0:a1734fe1ec4b 90
vpcola 0:a1734fe1ec4b 91
vpcola 0:a1734fe1ec4b 92 /**
vpcola 0:a1734fe1ec4b 93 * @defgroup Timer_Exported_Types Timer Exported Types
vpcola 0:a1734fe1ec4b 94 * @{
vpcola 0:a1734fe1ec4b 95 */
vpcola 0:a1734fe1ec4b 96
vpcola 0:a1734fe1ec4b 97 /**
vpcola 0:a1734fe1ec4b 98 * @brief All the possible RX timeout stop conditions enumeration.
vpcola 0:a1734fe1ec4b 99 */
vpcola 0:a1734fe1ec4b 100 typedef enum{
vpcola 0:a1734fe1ec4b 101
vpcola 0:a1734fe1ec4b 102 NO_TIMEOUT_STOP = 0x00, /*!< Timeout never stopped */
vpcola 0:a1734fe1ec4b 103 TIMEOUT_ALWAYS_STOPPED = 0x08, /*!< Timeout always stopped (default) */
vpcola 0:a1734fe1ec4b 104 RSSI_ABOVE_THRESHOLD = 0x04, /*!< Timeout stopped on RSSI above threshold */
vpcola 0:a1734fe1ec4b 105 SQI_ABOVE_THRESHOLD = 0x02, /*!< Timeout stopped on SQI above threshold */
vpcola 0:a1734fe1ec4b 106 PQI_ABOVE_THRESHOLD = 0x01, /*!< Timeout stopped on PQI above threshold */
vpcola 0:a1734fe1ec4b 107 RSSI_AND_SQI_ABOVE_THRESHOLD = 0x06, /*!< Timeout stopped on both RSSI and SQI above threshold */
vpcola 0:a1734fe1ec4b 108 RSSI_AND_PQI_ABOVE_THRESHOLD = 0x05, /*!< Timeout stopped on both RSSI and PQI above threshold */
vpcola 0:a1734fe1ec4b 109 SQI_AND_PQI_ABOVE_THRESHOLD = 0x03, /*!< Timeout stopped on both SQI and PQI above threshold */
vpcola 0:a1734fe1ec4b 110 ALL_ABOVE_THRESHOLD = 0x07, /*!< Timeout stopped only if RSSI, SQI and PQI are above threshold */
vpcola 0:a1734fe1ec4b 111 RSSI_OR_SQI_ABOVE_THRESHOLD = 0x0E, /*!< Timeout stopped if one between RSSI or SQI are above threshold */
vpcola 0:a1734fe1ec4b 112 RSSI_OR_PQI_ABOVE_THRESHOLD = 0x0D, /*!< Timeout stopped if one between RSSI or PQI are above threshold */
vpcola 0:a1734fe1ec4b 113 SQI_OR_PQI_ABOVE_THRESHOLD = 0x0B, /*!< Timeout stopped if one between SQI or PQI are above threshold */
vpcola 0:a1734fe1ec4b 114 ANY_ABOVE_THRESHOLD = 0x0F /*!< Timeout stopped if one among RSSI, SQI or SQI are above threshold */
vpcola 0:a1734fe1ec4b 115
vpcola 0:a1734fe1ec4b 116 } RxTimeoutStopCondition;
vpcola 0:a1734fe1ec4b 117
vpcola 0:a1734fe1ec4b 118
vpcola 0:a1734fe1ec4b 119 #define IS_RX_TIMEOUT_STOP_CONDITION(COND) ( COND == NO_TIMEOUT_STOP || \
vpcola 0:a1734fe1ec4b 120 COND == TIMEOUT_ALWAYS_STOPPED || \
vpcola 0:a1734fe1ec4b 121 COND == RSSI_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 122 COND == SQI_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 123 COND == PQI_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 124 COND == RSSI_AND_SQI_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 125 COND == RSSI_AND_PQI_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 126 COND == SQI_AND_PQI_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 127 COND == ALL_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 128 COND == RSSI_OR_SQI_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 129 COND == RSSI_OR_PQI_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 130 COND == SQI_OR_PQI_ABOVE_THRESHOLD || \
vpcola 0:a1734fe1ec4b 131 COND == ANY_ABOVE_THRESHOLD )
vpcola 0:a1734fe1ec4b 132
vpcola 0:a1734fe1ec4b 133
vpcola 0:a1734fe1ec4b 134
vpcola 0:a1734fe1ec4b 135 /**
vpcola 0:a1734fe1ec4b 136 * @}
vpcola 0:a1734fe1ec4b 137 */
vpcola 0:a1734fe1ec4b 138
vpcola 0:a1734fe1ec4b 139
vpcola 0:a1734fe1ec4b 140 /**
vpcola 0:a1734fe1ec4b 141 * @defgroup Timer_Exported_Constants Timer Exported Constants
vpcola 0:a1734fe1ec4b 142 * @{
vpcola 0:a1734fe1ec4b 143 */
vpcola 0:a1734fe1ec4b 144
vpcola 0:a1734fe1ec4b 145 /**
vpcola 0:a1734fe1ec4b 146 * @brief It represents the Time Step for RX_Timeout timer in case of 24 MHz Crystal, expressed in us.
vpcola 0:a1734fe1ec4b 147 * It is equal to 1210/(24*10^6). With this time step it is possible to fix the RX_Timeout to
vpcola 0:a1734fe1ec4b 148 * a minimum value of 50.417us to a maximum value of about 3.278 s.
vpcola 0:a1734fe1ec4b 149 * Remember that it is possible to have infinite RX_Timeout writing 0 in the RX_Timeout_Counter and/or RX_Timeout_Prescaler registers.
vpcola 0:a1734fe1ec4b 150 */
vpcola 0:a1734fe1ec4b 151 #define RX_TCLK_24MHz 50.417f
vpcola 0:a1734fe1ec4b 152 #define IS_RX_TIMEOUT_24MHz(TIMEOUT) (TIMEOUT*1000)>=RX_TCLK_24MHz
vpcola 0:a1734fe1ec4b 153
vpcola 0:a1734fe1ec4b 154 /**
vpcola 0:a1734fe1ec4b 155 * @brief It represents the Time Step for RX_Timeout timer in case of 26 MHz Crystal, expressed in us.
vpcola 0:a1734fe1ec4b 156 * It is equal to 1210/(26*10^6). With this time step it is possible to fix the RX_Timeout to
vpcola 0:a1734fe1ec4b 157 * a minimum value of 46.538us to a maximum value of about 3.026 s.
vpcola 0:a1734fe1ec4b 158 * Remember that it is possible to have infinite RX_Timeout writing 0 in the RX_Timeout_Counter register.
vpcola 0:a1734fe1ec4b 159 */
vpcola 0:a1734fe1ec4b 160 #define RX_TCLK_26MHz 46.538f
vpcola 0:a1734fe1ec4b 161 #define IS_RX_TIMEOUT_26MHz(TIMEOUT) (TIMEOUT*1000)>=RX_TCLK_26MHz
vpcola 0:a1734fe1ec4b 162
vpcola 0:a1734fe1ec4b 163 /**
vpcola 0:a1734fe1ec4b 164 * @brief It represents the Time Step for RX_Wakeup timer expressed in us. This timer is based on RCO (about 34.7 kHZ).
vpcola 0:a1734fe1ec4b 165 * With this time step it is possible to fix the Wakeup_Timeout to a minimum value of 28.818us to a maximum
vpcola 0:a1734fe1ec4b 166 * value of about 1.888 s.
vpcola 0:a1734fe1ec4b 167 */
vpcola 0:a1734fe1ec4b 168 #define WAKEUP_TCLK 28.818f
vpcola 0:a1734fe1ec4b 169 #define IS_WKUP_TIMEOUT(TIMEOUT) (TIMEOUT*1000)>=WAKEUP_TCLK
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
vpcola 0:a1734fe1ec4b 178 /**
vpcola 0:a1734fe1ec4b 179 * @defgroup Timer_Exported_Macros Timer Exported Macros
vpcola 0:a1734fe1ec4b 180 * @{
vpcola 0:a1734fe1ec4b 181 */
vpcola 0:a1734fe1ec4b 182
vpcola 0:a1734fe1ec4b 183 #define SET_INFINITE_RX_TIMEOUT() SpiritTimerSetRxTimeoutCounter(0)
vpcola 0:a1734fe1ec4b 184
vpcola 0:a1734fe1ec4b 185 /**
vpcola 0:a1734fe1ec4b 186 * @}
vpcola 0:a1734fe1ec4b 187 */
vpcola 0:a1734fe1ec4b 188
vpcola 0:a1734fe1ec4b 189
vpcola 0:a1734fe1ec4b 190 /**
vpcola 0:a1734fe1ec4b 191 * @defgroup Timer_Exported_Functions Timer Exported Functions
vpcola 0:a1734fe1ec4b 192 * @{
vpcola 0:a1734fe1ec4b 193 */
vpcola 0:a1734fe1ec4b 194
vpcola 0:a1734fe1ec4b 195 void SpiritTimerLdcrMode(SpiritFunctionalState xNewState);
vpcola 0:a1734fe1ec4b 196 void SpiritTimerLdcrAutoReload(SpiritFunctionalState xNewState);
vpcola 0:a1734fe1ec4b 197 SpiritFunctionalState SpiritTimerLdcrGetAutoReload(void);
vpcola 0:a1734fe1ec4b 198 void SpiritTimerSetRxTimeout(uint8_t cCounter , uint8_t cPrescaler);
vpcola 0:a1734fe1ec4b 199 void SpiritTimerSetRxTimeoutMs(float fDesiredMsec);
vpcola 0:a1734fe1ec4b 200 void SpiritTimerSetRxTimeoutCounter(uint8_t cCounter);
vpcola 0:a1734fe1ec4b 201 void SpiritTimerSetRxTimeoutPrescaler(uint8_t cPrescaler);
vpcola 0:a1734fe1ec4b 202 void SpiritTimerGetRxTimeout(float* pfTimeoutMsec, uint8_t* pcCounter , uint8_t* pcPrescaler);
vpcola 0:a1734fe1ec4b 203 void SpiritTimerSetWakeUpTimer(uint8_t cCounter , uint8_t cPrescaler);
vpcola 0:a1734fe1ec4b 204 void SpiritTimerSetWakeUpTimerMs(float fDesiredMsec);
vpcola 0:a1734fe1ec4b 205 void SpiritTimerSetWakeUpTimerCounter(uint8_t cCounter);
vpcola 0:a1734fe1ec4b 206 void SpiritTimerSetWakeUpTimerPrescaler(uint8_t cPrescaler);
vpcola 0:a1734fe1ec4b 207 void SpiritTimerSetWakeUpTimerReloadMs(float fDesiredMsec);
vpcola 0:a1734fe1ec4b 208 void SpiritTimerGetWakeUpTimer(float* pfWakeUpMsec, uint8_t* pcCounter , uint8_t* pcPrescaler);
vpcola 0:a1734fe1ec4b 209 void SpiritTimerSetWakeUpTimerReload(uint8_t cCounter , uint8_t cPrescaler);
vpcola 0:a1734fe1ec4b 210 void SpiritTimerSetWakeUpTimerReloadCounter(uint8_t cCounter);
vpcola 0:a1734fe1ec4b 211 void SpiritTimerSetWakeUpTimerReloadPrescaler(uint8_t cPrescaler);
vpcola 0:a1734fe1ec4b 212 void SpiritTimerGetWakeUpTimerReload(float* pfWakeUpReloadMsec, uint8_t* pcCounter , uint8_t* pcPrescaler);
vpcola 0:a1734fe1ec4b 213 void SpiritTimerComputeWakeUpValues(float fDesiredMsec , uint8_t* pcCounter , uint8_t* pcPrescaler);
vpcola 0:a1734fe1ec4b 214 void SpiritTimerComputeRxTimeoutValues(float fDesiredMsec , uint8_t* pcCounter , uint8_t* pcPrescaler);
vpcola 0:a1734fe1ec4b 215 void SpiritTimerSetRxTimeoutStopCondition(RxTimeoutStopCondition xStopCondition);
vpcola 0:a1734fe1ec4b 216 void SpiritTimerReloadStrobe(void);
vpcola 0:a1734fe1ec4b 217 uint16_t SpiritTimerGetRcoFrequency(void);
vpcola 0:a1734fe1ec4b 218
vpcola 0:a1734fe1ec4b 219 /**
vpcola 0:a1734fe1ec4b 220 * @}
vpcola 0:a1734fe1ec4b 221 */
vpcola 0:a1734fe1ec4b 222
vpcola 0:a1734fe1ec4b 223 /**
vpcola 0:a1734fe1ec4b 224 * @}
vpcola 0:a1734fe1ec4b 225 */
vpcola 0:a1734fe1ec4b 226
vpcola 0:a1734fe1ec4b 227
vpcola 0:a1734fe1ec4b 228 /**
vpcola 0:a1734fe1ec4b 229 * @}
vpcola 0:a1734fe1ec4b 230 */
vpcola 0:a1734fe1ec4b 231
vpcola 0:a1734fe1ec4b 232 #ifdef __cplusplus
vpcola 0:a1734fe1ec4b 233 }
vpcola 0:a1734fe1ec4b 234 #endif
vpcola 0:a1734fe1ec4b 235
vpcola 0:a1734fe1ec4b 236 #endif
vpcola 0:a1734fe1ec4b 237
vpcola 0:a1734fe1ec4b 238 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/
vpcola 0:a1734fe1ec4b 239