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).

Committer:
Wolfgang Betz
Date:
Thu Oct 13 15:41:39 2016 +0200
Revision:
0:4fb29d9ee571
First compiling version (without warnings)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 0:4fb29d9ee571 1 /**
Wolfgang Betz 0:4fb29d9ee571 2 ******************************************************************************
Wolfgang Betz 0:4fb29d9ee571 3 * @file SPIRIT_Qi.c
Wolfgang Betz 0:4fb29d9ee571 4 * @author VMA division - AMS
Wolfgang Betz 0:4fb29d9ee571 5 * @version 3.2.2
Wolfgang Betz 0:4fb29d9ee571 6 * @date 08-July-2015
Wolfgang Betz 0:4fb29d9ee571 7 * @brief Configuration and management of SPIRIT QI.
Wolfgang Betz 0:4fb29d9ee571 8 * @details
Wolfgang Betz 0:4fb29d9ee571 9 *
Wolfgang Betz 0:4fb29d9ee571 10 * @attention
Wolfgang Betz 0:4fb29d9ee571 11 *
Wolfgang Betz 0:4fb29d9ee571 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 0:4fb29d9ee571 13 *
Wolfgang Betz 0:4fb29d9ee571 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 0:4fb29d9ee571 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 0:4fb29d9ee571 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 0:4fb29d9ee571 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 0:4fb29d9ee571 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 0:4fb29d9ee571 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 0:4fb29d9ee571 20 * and/or other materials provided with the distribution.
Wolfgang Betz 0:4fb29d9ee571 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 0:4fb29d9ee571 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 0:4fb29d9ee571 23 * without specific prior written permission.
Wolfgang Betz 0:4fb29d9ee571 24 *
Wolfgang Betz 0:4fb29d9ee571 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 0:4fb29d9ee571 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 0:4fb29d9ee571 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 0:4fb29d9ee571 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 0:4fb29d9ee571 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 0:4fb29d9ee571 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 0:4fb29d9ee571 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 0:4fb29d9ee571 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 0:4fb29d9ee571 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 0:4fb29d9ee571 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 0:4fb29d9ee571 35 *
Wolfgang Betz 0:4fb29d9ee571 36 ******************************************************************************
Wolfgang Betz 0:4fb29d9ee571 37 */
Wolfgang Betz 0:4fb29d9ee571 38
Wolfgang Betz 0:4fb29d9ee571 39 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 0:4fb29d9ee571 40 #include "SPIRIT_Qi.h"
Wolfgang Betz 0:4fb29d9ee571 41 #include "MCU_Interface.h"
Wolfgang Betz 0:4fb29d9ee571 42
Wolfgang Betz 0:4fb29d9ee571 43
Wolfgang Betz 0:4fb29d9ee571 44
Wolfgang Betz 0:4fb29d9ee571 45 /**
Wolfgang Betz 0:4fb29d9ee571 46 * @addtogroup SPIRIT_Libraries
Wolfgang Betz 0:4fb29d9ee571 47 * @{
Wolfgang Betz 0:4fb29d9ee571 48 */
Wolfgang Betz 0:4fb29d9ee571 49
Wolfgang Betz 0:4fb29d9ee571 50
Wolfgang Betz 0:4fb29d9ee571 51 /**
Wolfgang Betz 0:4fb29d9ee571 52 * @addtogroup SPIRIT_Qi
Wolfgang Betz 0:4fb29d9ee571 53 * @{
Wolfgang Betz 0:4fb29d9ee571 54 */
Wolfgang Betz 0:4fb29d9ee571 55
Wolfgang Betz 0:4fb29d9ee571 56
Wolfgang Betz 0:4fb29d9ee571 57 /**
Wolfgang Betz 0:4fb29d9ee571 58 * @defgroup Qi_Private_TypesDefinitions QI Private Types Definitions
Wolfgang Betz 0:4fb29d9ee571 59 * @{
Wolfgang Betz 0:4fb29d9ee571 60 */
Wolfgang Betz 0:4fb29d9ee571 61
Wolfgang Betz 0:4fb29d9ee571 62 /**
Wolfgang Betz 0:4fb29d9ee571 63 *@}
Wolfgang Betz 0:4fb29d9ee571 64 */
Wolfgang Betz 0:4fb29d9ee571 65
Wolfgang Betz 0:4fb29d9ee571 66
Wolfgang Betz 0:4fb29d9ee571 67 /**
Wolfgang Betz 0:4fb29d9ee571 68 * @defgroup Qi_Private_Defines QI Private Defines
Wolfgang Betz 0:4fb29d9ee571 69 * @{
Wolfgang Betz 0:4fb29d9ee571 70 */
Wolfgang Betz 0:4fb29d9ee571 71
Wolfgang Betz 0:4fb29d9ee571 72 /**
Wolfgang Betz 0:4fb29d9ee571 73 *@}
Wolfgang Betz 0:4fb29d9ee571 74 */
Wolfgang Betz 0:4fb29d9ee571 75
Wolfgang Betz 0:4fb29d9ee571 76
Wolfgang Betz 0:4fb29d9ee571 77 /**
Wolfgang Betz 0:4fb29d9ee571 78 * @defgroup Qi_Private_Macros QI Private Macros
Wolfgang Betz 0:4fb29d9ee571 79 * @{
Wolfgang Betz 0:4fb29d9ee571 80 */
Wolfgang Betz 0:4fb29d9ee571 81
Wolfgang Betz 0:4fb29d9ee571 82 /**
Wolfgang Betz 0:4fb29d9ee571 83 *@}
Wolfgang Betz 0:4fb29d9ee571 84 */
Wolfgang Betz 0:4fb29d9ee571 85
Wolfgang Betz 0:4fb29d9ee571 86
Wolfgang Betz 0:4fb29d9ee571 87 /**
Wolfgang Betz 0:4fb29d9ee571 88 * @defgroup Qi_Private_Variables QI Private Variables
Wolfgang Betz 0:4fb29d9ee571 89 * @{
Wolfgang Betz 0:4fb29d9ee571 90 */
Wolfgang Betz 0:4fb29d9ee571 91
Wolfgang Betz 0:4fb29d9ee571 92 /**
Wolfgang Betz 0:4fb29d9ee571 93 *@}
Wolfgang Betz 0:4fb29d9ee571 94 */
Wolfgang Betz 0:4fb29d9ee571 95
Wolfgang Betz 0:4fb29d9ee571 96
Wolfgang Betz 0:4fb29d9ee571 97 /**
Wolfgang Betz 0:4fb29d9ee571 98 * @defgroup Qi_Private_FunctionPrototypes QI Private Function Prototypes
Wolfgang Betz 0:4fb29d9ee571 99 * @{
Wolfgang Betz 0:4fb29d9ee571 100 */
Wolfgang Betz 0:4fb29d9ee571 101
Wolfgang Betz 0:4fb29d9ee571 102 /**
Wolfgang Betz 0:4fb29d9ee571 103 *@}
Wolfgang Betz 0:4fb29d9ee571 104 */
Wolfgang Betz 0:4fb29d9ee571 105
Wolfgang Betz 0:4fb29d9ee571 106
Wolfgang Betz 0:4fb29d9ee571 107 /**
Wolfgang Betz 0:4fb29d9ee571 108 * @defgroup Qi_Private_Functions QI Private Functions
Wolfgang Betz 0:4fb29d9ee571 109 * @{
Wolfgang Betz 0:4fb29d9ee571 110 */
Wolfgang Betz 0:4fb29d9ee571 111
Wolfgang Betz 0:4fb29d9ee571 112 /**
Wolfgang Betz 0:4fb29d9ee571 113 * @brief Enables/Disables the PQI Preamble Quality Indicator check. The running peak PQI is
Wolfgang Betz 0:4fb29d9ee571 114 * compared to a threshold value and the preamble valid IRQ is asserted as soon as the threshold is passed.
Wolfgang Betz 0:4fb29d9ee571 115 * @param xNewState new state for PQI check.
Wolfgang Betz 0:4fb29d9ee571 116 * This parameter can be: S_ENABLE or S_DISABLE.
Wolfgang Betz 0:4fb29d9ee571 117 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 118 */
Wolfgang Betz 0:4fb29d9ee571 119 void SpiritQiPqiCheck(SpiritFunctionalState xNewState)
Wolfgang Betz 0:4fb29d9ee571 120 {
Wolfgang Betz 0:4fb29d9ee571 121 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 122
Wolfgang Betz 0:4fb29d9ee571 123 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 124 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 0:4fb29d9ee571 125
Wolfgang Betz 0:4fb29d9ee571 126 /* Reads the QI register value */
Wolfgang Betz 0:4fb29d9ee571 127 g_xStatus = SpiritSpiReadRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 128
Wolfgang Betz 0:4fb29d9ee571 129 /* Enables or disables the PQI Check bit on the QI_BASE register */
Wolfgang Betz 0:4fb29d9ee571 130 if(xNewState == S_ENABLE)
Wolfgang Betz 0:4fb29d9ee571 131 {
Wolfgang Betz 0:4fb29d9ee571 132 tempRegValue |= QI_PQI_MASK;
Wolfgang Betz 0:4fb29d9ee571 133 }
Wolfgang Betz 0:4fb29d9ee571 134 else
Wolfgang Betz 0:4fb29d9ee571 135 {
Wolfgang Betz 0:4fb29d9ee571 136 tempRegValue &= ~QI_PQI_MASK;
Wolfgang Betz 0:4fb29d9ee571 137 }
Wolfgang Betz 0:4fb29d9ee571 138
Wolfgang Betz 0:4fb29d9ee571 139 /* Writes value on the QI register */
Wolfgang Betz 0:4fb29d9ee571 140 g_xStatus = SpiritSpiWriteRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 141
Wolfgang Betz 0:4fb29d9ee571 142 }
Wolfgang Betz 0:4fb29d9ee571 143
Wolfgang Betz 0:4fb29d9ee571 144
Wolfgang Betz 0:4fb29d9ee571 145 /**
Wolfgang Betz 0:4fb29d9ee571 146 * @brief Enables/Disables the Synchronization Quality Indicator check. The running peak SQI is
Wolfgang Betz 0:4fb29d9ee571 147 * compared to a threshold value and the sync valid IRQ is asserted as soon as the threshold is passed.
Wolfgang Betz 0:4fb29d9ee571 148 * @param xNewState new state for SQI check.
Wolfgang Betz 0:4fb29d9ee571 149 * This parameter can be: S_ENABLE or S_DISABLE.
Wolfgang Betz 0:4fb29d9ee571 150 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 151 */
Wolfgang Betz 0:4fb29d9ee571 152 void SpiritQiSqiCheck(SpiritFunctionalState xNewState)
Wolfgang Betz 0:4fb29d9ee571 153 {
Wolfgang Betz 0:4fb29d9ee571 154 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 155
Wolfgang Betz 0:4fb29d9ee571 156 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 157 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 0:4fb29d9ee571 158
Wolfgang Betz 0:4fb29d9ee571 159 /* Reads the QI register value */
Wolfgang Betz 0:4fb29d9ee571 160 g_xStatus = SpiritSpiReadRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 161
Wolfgang Betz 0:4fb29d9ee571 162 /* Enables or disables the SQI Check bit on the QI_BASE register */
Wolfgang Betz 0:4fb29d9ee571 163 if(xNewState == S_ENABLE)
Wolfgang Betz 0:4fb29d9ee571 164 {
Wolfgang Betz 0:4fb29d9ee571 165 tempRegValue |= QI_SQI_MASK;
Wolfgang Betz 0:4fb29d9ee571 166 }
Wolfgang Betz 0:4fb29d9ee571 167 else
Wolfgang Betz 0:4fb29d9ee571 168 {
Wolfgang Betz 0:4fb29d9ee571 169 tempRegValue &= ~QI_SQI_MASK;
Wolfgang Betz 0:4fb29d9ee571 170 }
Wolfgang Betz 0:4fb29d9ee571 171
Wolfgang Betz 0:4fb29d9ee571 172 /* Writes value on the QI register */
Wolfgang Betz 0:4fb29d9ee571 173 g_xStatus = SpiritSpiWriteRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 174
Wolfgang Betz 0:4fb29d9ee571 175 }
Wolfgang Betz 0:4fb29d9ee571 176
Wolfgang Betz 0:4fb29d9ee571 177
Wolfgang Betz 0:4fb29d9ee571 178 /**
Wolfgang Betz 0:4fb29d9ee571 179 * @brief Sets the PQI threshold. The preamble quality threshold is 4*PQI_TH (PQI_TH = 0..15).
Wolfgang Betz 0:4fb29d9ee571 180 * @param xPqiThr parameter of the formula above.
Wolfgang Betz 0:4fb29d9ee571 181 * This variable is a @ref PqiThreshold.
Wolfgang Betz 0:4fb29d9ee571 182 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 183 */
Wolfgang Betz 0:4fb29d9ee571 184 void SpiritQiSetPqiThreshold(PqiThreshold xPqiThr)
Wolfgang Betz 0:4fb29d9ee571 185 {
Wolfgang Betz 0:4fb29d9ee571 186 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 187
Wolfgang Betz 0:4fb29d9ee571 188 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 189 s_assert_param(IS_PQI_THR(xPqiThr));
Wolfgang Betz 0:4fb29d9ee571 190
Wolfgang Betz 0:4fb29d9ee571 191 /* Reads the QI register value */
Wolfgang Betz 0:4fb29d9ee571 192 g_xStatus = SpiritSpiReadRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 193
Wolfgang Betz 0:4fb29d9ee571 194 /* Build the PQI threshold value to be written */
Wolfgang Betz 0:4fb29d9ee571 195 tempRegValue &= 0xC3;
Wolfgang Betz 0:4fb29d9ee571 196 tempRegValue |= ((uint8_t)xPqiThr);
Wolfgang Betz 0:4fb29d9ee571 197
Wolfgang Betz 0:4fb29d9ee571 198 /* Writes value on the QI register */
Wolfgang Betz 0:4fb29d9ee571 199 g_xStatus = SpiritSpiWriteRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 200
Wolfgang Betz 0:4fb29d9ee571 201 }
Wolfgang Betz 0:4fb29d9ee571 202
Wolfgang Betz 0:4fb29d9ee571 203
Wolfgang Betz 0:4fb29d9ee571 204 /**
Wolfgang Betz 0:4fb29d9ee571 205 * @brief Returns the PQI threshold. The preamble quality threshold is 4*PQI_TH (PQI_TH = 0..15).
Wolfgang Betz 0:4fb29d9ee571 206 * @param None.
Wolfgang Betz 0:4fb29d9ee571 207 * @retval PqiThreshold PQI threshold (PQI_TH of the formula above).
Wolfgang Betz 0:4fb29d9ee571 208 */
Wolfgang Betz 0:4fb29d9ee571 209 PqiThreshold SpiritQiGetPqiThreshold(void)
Wolfgang Betz 0:4fb29d9ee571 210 {
Wolfgang Betz 0:4fb29d9ee571 211 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 212
Wolfgang Betz 0:4fb29d9ee571 213 /* Reads the QI register value */
Wolfgang Betz 0:4fb29d9ee571 214 g_xStatus = SpiritSpiReadRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 215
Wolfgang Betz 0:4fb29d9ee571 216 /* Rebuild and return the PQI threshold value */
Wolfgang Betz 0:4fb29d9ee571 217 return (PqiThreshold)(tempRegValue & 0x3C);
Wolfgang Betz 0:4fb29d9ee571 218
Wolfgang Betz 0:4fb29d9ee571 219 }
Wolfgang Betz 0:4fb29d9ee571 220
Wolfgang Betz 0:4fb29d9ee571 221
Wolfgang Betz 0:4fb29d9ee571 222 /**
Wolfgang Betz 0:4fb29d9ee571 223 * @brief Sets the SQI threshold. The synchronization quality
Wolfgang Betz 0:4fb29d9ee571 224 * threshold is equal to 8 * SYNC_LEN - 2 * SQI_TH with SQI_TH = 0..3. When SQI_TH is 0 perfect match is required; when
Wolfgang Betz 0:4fb29d9ee571 225 * SQI_TH = 1, 2, 3 then 1, 2, or 3 bit errors are respectively accepted. It is recommended that the SQI check is always
Wolfgang Betz 0:4fb29d9ee571 226 * enabled.
Wolfgang Betz 0:4fb29d9ee571 227 * @param xSqiThr parameter of the formula above.
Wolfgang Betz 0:4fb29d9ee571 228 * This parameter is a @ref SqiThreshold.
Wolfgang Betz 0:4fb29d9ee571 229 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 230 */
Wolfgang Betz 0:4fb29d9ee571 231 void SpiritQiSetSqiThreshold(SqiThreshold xSqiThr)
Wolfgang Betz 0:4fb29d9ee571 232 {
Wolfgang Betz 0:4fb29d9ee571 233 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 234
Wolfgang Betz 0:4fb29d9ee571 235 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 236 s_assert_param(IS_SQI_THR(xSqiThr));
Wolfgang Betz 0:4fb29d9ee571 237
Wolfgang Betz 0:4fb29d9ee571 238 /* Reads the QI register value */
Wolfgang Betz 0:4fb29d9ee571 239 g_xStatus = SpiritSpiReadRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 240
Wolfgang Betz 0:4fb29d9ee571 241 /* Build the SQI threshold value to be written */
Wolfgang Betz 0:4fb29d9ee571 242 tempRegValue &= 0x3F;
Wolfgang Betz 0:4fb29d9ee571 243 tempRegValue |= ((uint8_t)xSqiThr);
Wolfgang Betz 0:4fb29d9ee571 244
Wolfgang Betz 0:4fb29d9ee571 245 /* Writes the new value on the QI register */
Wolfgang Betz 0:4fb29d9ee571 246 g_xStatus = SpiritSpiWriteRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 247
Wolfgang Betz 0:4fb29d9ee571 248 }
Wolfgang Betz 0:4fb29d9ee571 249
Wolfgang Betz 0:4fb29d9ee571 250
Wolfgang Betz 0:4fb29d9ee571 251 /**
Wolfgang Betz 0:4fb29d9ee571 252 * @brief Returns the SQI threshold. The synchronization quality threshold is equal to 8 * SYNC_LEN - 2 * SQI_TH with SQI_TH = 0..3.
Wolfgang Betz 0:4fb29d9ee571 253 * @param None.
Wolfgang Betz 0:4fb29d9ee571 254 * @retval SqiThreshold SQI threshold (SQI_TH of the formula above).
Wolfgang Betz 0:4fb29d9ee571 255 */
Wolfgang Betz 0:4fb29d9ee571 256 SqiThreshold SpiritQiGetSqiThreshold(void)
Wolfgang Betz 0:4fb29d9ee571 257 {
Wolfgang Betz 0:4fb29d9ee571 258 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 259
Wolfgang Betz 0:4fb29d9ee571 260 /* Reads the QI register value */
Wolfgang Betz 0:4fb29d9ee571 261 g_xStatus = SpiritSpiReadRegisters(QI_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 262
Wolfgang Betz 0:4fb29d9ee571 263 /* Rebuild and return the SQI threshold value */
Wolfgang Betz 0:4fb29d9ee571 264 return (SqiThreshold)(tempRegValue & 0xC0);
Wolfgang Betz 0:4fb29d9ee571 265
Wolfgang Betz 0:4fb29d9ee571 266 }
Wolfgang Betz 0:4fb29d9ee571 267
Wolfgang Betz 0:4fb29d9ee571 268
Wolfgang Betz 0:4fb29d9ee571 269 /**
Wolfgang Betz 0:4fb29d9ee571 270 * @brief Returns the PQI value.
Wolfgang Betz 0:4fb29d9ee571 271 * @param None.
Wolfgang Betz 0:4fb29d9ee571 272 * @retval uint8_t PQI value.
Wolfgang Betz 0:4fb29d9ee571 273 */
Wolfgang Betz 0:4fb29d9ee571 274 uint8_t SpiritQiGetPqi(void)
Wolfgang Betz 0:4fb29d9ee571 275 {
Wolfgang Betz 0:4fb29d9ee571 276 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 277
Wolfgang Betz 0:4fb29d9ee571 278 /* Reads the LINK_QUALIF2 register value */
Wolfgang Betz 0:4fb29d9ee571 279 g_xStatus = SpiritSpiReadRegisters(LINK_QUALIF2_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 280
Wolfgang Betz 0:4fb29d9ee571 281 /* Returns the PQI value */
Wolfgang Betz 0:4fb29d9ee571 282 return tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 283
Wolfgang Betz 0:4fb29d9ee571 284 }
Wolfgang Betz 0:4fb29d9ee571 285
Wolfgang Betz 0:4fb29d9ee571 286
Wolfgang Betz 0:4fb29d9ee571 287 /**
Wolfgang Betz 0:4fb29d9ee571 288 * @brief Returns the SQI value.
Wolfgang Betz 0:4fb29d9ee571 289 * @param None.
Wolfgang Betz 0:4fb29d9ee571 290 * @retval uint8_t SQI value.
Wolfgang Betz 0:4fb29d9ee571 291 */
Wolfgang Betz 0:4fb29d9ee571 292 uint8_t SpiritQiGetSqi(void)
Wolfgang Betz 0:4fb29d9ee571 293 {
Wolfgang Betz 0:4fb29d9ee571 294 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 295
Wolfgang Betz 0:4fb29d9ee571 296 /* Reads the register LINK_QUALIF1 value */
Wolfgang Betz 0:4fb29d9ee571 297 g_xStatus = SpiritSpiReadRegisters(LINK_QUALIF1_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 298
Wolfgang Betz 0:4fb29d9ee571 299 /* Rebuild and return the SQI value */
Wolfgang Betz 0:4fb29d9ee571 300 return (tempRegValue & 0x7F);
Wolfgang Betz 0:4fb29d9ee571 301
Wolfgang Betz 0:4fb29d9ee571 302 }
Wolfgang Betz 0:4fb29d9ee571 303
Wolfgang Betz 0:4fb29d9ee571 304
Wolfgang Betz 0:4fb29d9ee571 305 /**
Wolfgang Betz 0:4fb29d9ee571 306 * @brief Returns the LQI value.
Wolfgang Betz 0:4fb29d9ee571 307 * @param None.
Wolfgang Betz 0:4fb29d9ee571 308 * @retval uint8_t LQI value.
Wolfgang Betz 0:4fb29d9ee571 309 */
Wolfgang Betz 0:4fb29d9ee571 310 uint8_t SpiritQiGetLqi(void)
Wolfgang Betz 0:4fb29d9ee571 311 {
Wolfgang Betz 0:4fb29d9ee571 312 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 313
Wolfgang Betz 0:4fb29d9ee571 314 /* Reads the LINK_QUALIF0 register value */
Wolfgang Betz 0:4fb29d9ee571 315 g_xStatus = SpiritSpiReadRegisters(LINK_QUALIF0_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 316
Wolfgang Betz 0:4fb29d9ee571 317 /* Rebuild and return the LQI value */
Wolfgang Betz 0:4fb29d9ee571 318 return ((tempRegValue & 0xF0)>> 4);
Wolfgang Betz 0:4fb29d9ee571 319
Wolfgang Betz 0:4fb29d9ee571 320 }
Wolfgang Betz 0:4fb29d9ee571 321
Wolfgang Betz 0:4fb29d9ee571 322
Wolfgang Betz 0:4fb29d9ee571 323 /**
Wolfgang Betz 0:4fb29d9ee571 324 * @brief Returns the CS status.
Wolfgang Betz 0:4fb29d9ee571 325 * @param None.
Wolfgang Betz 0:4fb29d9ee571 326 * @retval SpiritFlagStatus CS value (S_SET or S_RESET).
Wolfgang Betz 0:4fb29d9ee571 327 */
Wolfgang Betz 0:4fb29d9ee571 328 SpiritFlagStatus SpiritQiGetCs(void)
Wolfgang Betz 0:4fb29d9ee571 329 {
Wolfgang Betz 0:4fb29d9ee571 330 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 331
Wolfgang Betz 0:4fb29d9ee571 332 /* Reads the LINK_QUALIF1 register value */
Wolfgang Betz 0:4fb29d9ee571 333 g_xStatus = SpiritSpiReadRegisters(LINK_QUALIF1_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 334
Wolfgang Betz 0:4fb29d9ee571 335 /* Rebuild and returns the CS status value */
Wolfgang Betz 0:4fb29d9ee571 336 if((tempRegValue & 0x80) == 0)
Wolfgang Betz 0:4fb29d9ee571 337 {
Wolfgang Betz 0:4fb29d9ee571 338 return S_RESET;
Wolfgang Betz 0:4fb29d9ee571 339 }
Wolfgang Betz 0:4fb29d9ee571 340 else
Wolfgang Betz 0:4fb29d9ee571 341 {
Wolfgang Betz 0:4fb29d9ee571 342 return S_SET;
Wolfgang Betz 0:4fb29d9ee571 343 }
Wolfgang Betz 0:4fb29d9ee571 344
Wolfgang Betz 0:4fb29d9ee571 345 }
Wolfgang Betz 0:4fb29d9ee571 346
Wolfgang Betz 0:4fb29d9ee571 347
Wolfgang Betz 0:4fb29d9ee571 348 /**
Wolfgang Betz 0:4fb29d9ee571 349 * @brief Returns the RSSI value. The measured power is reported in steps of half a dB from 0 to 255 and is offset in such a way that -120 dBm corresponds
Wolfgang Betz 0:4fb29d9ee571 350 * to 20.
Wolfgang Betz 0:4fb29d9ee571 351 * @param None.
Wolfgang Betz 0:4fb29d9ee571 352 * @retval uint8_t RSSI value.
Wolfgang Betz 0:4fb29d9ee571 353 */
Wolfgang Betz 0:4fb29d9ee571 354 uint8_t SpiritQiGetRssi(void)
Wolfgang Betz 0:4fb29d9ee571 355 {
Wolfgang Betz 0:4fb29d9ee571 356 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 357
Wolfgang Betz 0:4fb29d9ee571 358 /* Reads the RSSI_LEVEL register value */
Wolfgang Betz 0:4fb29d9ee571 359 g_xStatus = SpiritSpiReadRegisters(RSSI_LEVEL_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 360
Wolfgang Betz 0:4fb29d9ee571 361 /* Returns the RSSI value */
Wolfgang Betz 0:4fb29d9ee571 362 return tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 363
Wolfgang Betz 0:4fb29d9ee571 364 }
Wolfgang Betz 0:4fb29d9ee571 365
Wolfgang Betz 0:4fb29d9ee571 366
Wolfgang Betz 0:4fb29d9ee571 367 /**
Wolfgang Betz 0:4fb29d9ee571 368 * @brief Sets the RSSI threshold.
Wolfgang Betz 0:4fb29d9ee571 369 * @param cRssiThr RSSI threshold reported in steps of half a dBm with a -130 dBm offset.
Wolfgang Betz 0:4fb29d9ee571 370 * This parameter must be a uint8_t.
Wolfgang Betz 0:4fb29d9ee571 371 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 372 */
Wolfgang Betz 0:4fb29d9ee571 373 void SpiritQiSetRssiThreshold(uint8_t cRssiThr)
Wolfgang Betz 0:4fb29d9ee571 374 {
Wolfgang Betz 0:4fb29d9ee571 375 /* Writes the new value on the RSSI_TH register */
Wolfgang Betz 0:4fb29d9ee571 376 g_xStatus = SpiritSpiWriteRegisters(RSSI_TH_BASE, 1, &cRssiThr);
Wolfgang Betz 0:4fb29d9ee571 377
Wolfgang Betz 0:4fb29d9ee571 378 }
Wolfgang Betz 0:4fb29d9ee571 379
Wolfgang Betz 0:4fb29d9ee571 380
Wolfgang Betz 0:4fb29d9ee571 381 /**
Wolfgang Betz 0:4fb29d9ee571 382 * @brief Returns the RSSI threshold.
Wolfgang Betz 0:4fb29d9ee571 383 * @param None.
Wolfgang Betz 0:4fb29d9ee571 384 * @retval uint8_t RSSI threshold.
Wolfgang Betz 0:4fb29d9ee571 385 */
Wolfgang Betz 0:4fb29d9ee571 386 uint8_t SpiritQiGetRssiThreshold(void)
Wolfgang Betz 0:4fb29d9ee571 387 {
Wolfgang Betz 0:4fb29d9ee571 388 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 389
Wolfgang Betz 0:4fb29d9ee571 390 /* Reads the RSSI_TH register value */
Wolfgang Betz 0:4fb29d9ee571 391 g_xStatus = SpiritSpiReadRegisters(RSSI_TH_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 392
Wolfgang Betz 0:4fb29d9ee571 393 /* Returns RSSI threshold */
Wolfgang Betz 0:4fb29d9ee571 394 return tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 395
Wolfgang Betz 0:4fb29d9ee571 396 }
Wolfgang Betz 0:4fb29d9ee571 397
Wolfgang Betz 0:4fb29d9ee571 398
Wolfgang Betz 0:4fb29d9ee571 399 /**
Wolfgang Betz 0:4fb29d9ee571 400 * @brief Computes the RSSI threshold from its dBm value according to the formula: (RSSI[Dbm] + 130)/0.5
Wolfgang Betz 0:4fb29d9ee571 401 * @param nDbmValue RSSI threshold reported in dBm.
Wolfgang Betz 0:4fb29d9ee571 402 * This parameter must be a sint16_t.
Wolfgang Betz 0:4fb29d9ee571 403 * @retval uint8_t RSSI threshold corresponding to dBm value.
Wolfgang Betz 0:4fb29d9ee571 404 */
Wolfgang Betz 0:4fb29d9ee571 405 uint8_t SpiritQiComputeRssiThreshold(int nDbmValue)
Wolfgang Betz 0:4fb29d9ee571 406 {
Wolfgang Betz 0:4fb29d9ee571 407 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 408 s_assert_param(IS_RSSI_THR_DBM(nDbmValue));
Wolfgang Betz 0:4fb29d9ee571 409
Wolfgang Betz 0:4fb29d9ee571 410 /* Computes the RSSI threshold for register */
Wolfgang Betz 0:4fb29d9ee571 411 return 2*(nDbmValue+130);
Wolfgang Betz 0:4fb29d9ee571 412
Wolfgang Betz 0:4fb29d9ee571 413 }
Wolfgang Betz 0:4fb29d9ee571 414
Wolfgang Betz 0:4fb29d9ee571 415 /**
Wolfgang Betz 0:4fb29d9ee571 416 * @brief Sets the RSSI threshold from its dBm value according to the formula: (RSSI[Dbm] + 130)/0.5.
Wolfgang Betz 0:4fb29d9ee571 417 * @param nDbmValue RSSI threshold reported in dBm.
Wolfgang Betz 0:4fb29d9ee571 418 * This parameter must be a sint16_t.
Wolfgang Betz 0:4fb29d9ee571 419 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 420 */
Wolfgang Betz 0:4fb29d9ee571 421 void SpiritQiSetRssiThresholddBm(int nDbmValue)
Wolfgang Betz 0:4fb29d9ee571 422 {
Wolfgang Betz 0:4fb29d9ee571 423 uint8_t tempRegValue=2*(nDbmValue+130);
Wolfgang Betz 0:4fb29d9ee571 424
Wolfgang Betz 0:4fb29d9ee571 425 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 426 s_assert_param(IS_RSSI_THR_DBM(nDbmValue));
Wolfgang Betz 0:4fb29d9ee571 427
Wolfgang Betz 0:4fb29d9ee571 428 /* Writes the new value on the RSSI_TH register */
Wolfgang Betz 0:4fb29d9ee571 429 g_xStatus = SpiritSpiWriteRegisters(RSSI_TH_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 430
Wolfgang Betz 0:4fb29d9ee571 431 }
Wolfgang Betz 0:4fb29d9ee571 432
Wolfgang Betz 0:4fb29d9ee571 433 /**
Wolfgang Betz 0:4fb29d9ee571 434 * @brief Sets the RSSI filter gain. This parameter sets the bandwidth of a low pass IIR filter (RSSI_FLT register, allowed values 0..15), a
Wolfgang Betz 0:4fb29d9ee571 435 * lower values gives a faster settling of the measurements but lower precision. The recommended value for such parameter is 14.
Wolfgang Betz 0:4fb29d9ee571 436 * @param xRssiFg RSSI filter gain value.
Wolfgang Betz 0:4fb29d9ee571 437 * This parameter can be any value of @ref RssiFilterGain.
Wolfgang Betz 0:4fb29d9ee571 438 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 439 */
Wolfgang Betz 0:4fb29d9ee571 440 void SpiritQiSetRssiFilterGain(RssiFilterGain xRssiFg)
Wolfgang Betz 0:4fb29d9ee571 441 {
Wolfgang Betz 0:4fb29d9ee571 442 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 443
Wolfgang Betz 0:4fb29d9ee571 444 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 445 s_assert_param(IS_RSSI_FILTER_GAIN(xRssiFg));
Wolfgang Betz 0:4fb29d9ee571 446
Wolfgang Betz 0:4fb29d9ee571 447 /* Reads the RSSI_FLT register */
Wolfgang Betz 0:4fb29d9ee571 448 g_xStatus = SpiritSpiReadRegisters(RSSI_FLT_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 449
Wolfgang Betz 0:4fb29d9ee571 450 /* Sets the specified filter gain */
Wolfgang Betz 0:4fb29d9ee571 451 tempRegValue &= 0x0F;
Wolfgang Betz 0:4fb29d9ee571 452 tempRegValue |= ((uint8_t)xRssiFg);
Wolfgang Betz 0:4fb29d9ee571 453
Wolfgang Betz 0:4fb29d9ee571 454 /* Writes the new value on the RSSI_FLT register */
Wolfgang Betz 0:4fb29d9ee571 455 g_xStatus = SpiritSpiWriteRegisters(RSSI_FLT_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 456
Wolfgang Betz 0:4fb29d9ee571 457 }
Wolfgang Betz 0:4fb29d9ee571 458
Wolfgang Betz 0:4fb29d9ee571 459
Wolfgang Betz 0:4fb29d9ee571 460 /**
Wolfgang Betz 0:4fb29d9ee571 461 * @brief Returns the RSSI filter gain.
Wolfgang Betz 0:4fb29d9ee571 462 * @param None.
Wolfgang Betz 0:4fb29d9ee571 463 * @retval RssiFilterGain RSSI filter gain.
Wolfgang Betz 0:4fb29d9ee571 464 */
Wolfgang Betz 0:4fb29d9ee571 465 RssiFilterGain SpiritQiGetRssiFilterGain(void)
Wolfgang Betz 0:4fb29d9ee571 466 {
Wolfgang Betz 0:4fb29d9ee571 467 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 468
Wolfgang Betz 0:4fb29d9ee571 469 /* Reads the RSSI_FLT register */
Wolfgang Betz 0:4fb29d9ee571 470 g_xStatus = SpiritSpiReadRegisters(RSSI_FLT_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 471
Wolfgang Betz 0:4fb29d9ee571 472 /* Rebuild and returns the filter gain value */
Wolfgang Betz 0:4fb29d9ee571 473 return (RssiFilterGain)(tempRegValue & 0xF0);
Wolfgang Betz 0:4fb29d9ee571 474
Wolfgang Betz 0:4fb29d9ee571 475 }
Wolfgang Betz 0:4fb29d9ee571 476
Wolfgang Betz 0:4fb29d9ee571 477
Wolfgang Betz 0:4fb29d9ee571 478 /**
Wolfgang Betz 0:4fb29d9ee571 479 * @brief Sets the CS Mode. When static carrier sensing is used (cs_mode = 0), the carrier sense signal is asserted when the measured RSSI is above the
Wolfgang Betz 0:4fb29d9ee571 480 * value specified in the RSSI_TH register and is deasserted when the RSSI falls 3 dB below the same threshold.
Wolfgang Betz 0:4fb29d9ee571 481 * When dynamic carrier sense is used (cs_mode = 1, 2, 3), the carrier sense signal is asserted if the signal is above the
Wolfgang Betz 0:4fb29d9ee571 482 * threshold and a fast power increase of 6, 12 or 18 dB is detected; it is deasserted if a power fall of the same amplitude is
Wolfgang Betz 0:4fb29d9ee571 483 * detected.
Wolfgang Betz 0:4fb29d9ee571 484 * @param xCsMode CS mode selector.
Wolfgang Betz 0:4fb29d9ee571 485 * This parameter can be any value of @ref CSMode.
Wolfgang Betz 0:4fb29d9ee571 486 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 487 */
Wolfgang Betz 0:4fb29d9ee571 488 void SpiritQiSetCsMode(CSMode xCsMode)
Wolfgang Betz 0:4fb29d9ee571 489 {
Wolfgang Betz 0:4fb29d9ee571 490 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 491
Wolfgang Betz 0:4fb29d9ee571 492 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 493 s_assert_param(IS_CS_MODE(xCsMode));
Wolfgang Betz 0:4fb29d9ee571 494
Wolfgang Betz 0:4fb29d9ee571 495 /* Reads the RSSI_FLT register */
Wolfgang Betz 0:4fb29d9ee571 496 g_xStatus = SpiritSpiReadRegisters(RSSI_FLT_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 497
Wolfgang Betz 0:4fb29d9ee571 498 /* Sets bit to select the CS mode */
Wolfgang Betz 0:4fb29d9ee571 499 tempRegValue &= ~0x0C;
Wolfgang Betz 0:4fb29d9ee571 500 tempRegValue |= ((uint8_t)xCsMode);
Wolfgang Betz 0:4fb29d9ee571 501
Wolfgang Betz 0:4fb29d9ee571 502 /* Writes the new value on the RSSI_FLT register */
Wolfgang Betz 0:4fb29d9ee571 503 g_xStatus = SpiritSpiWriteRegisters(RSSI_FLT_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 504
Wolfgang Betz 0:4fb29d9ee571 505 }
Wolfgang Betz 0:4fb29d9ee571 506
Wolfgang Betz 0:4fb29d9ee571 507
Wolfgang Betz 0:4fb29d9ee571 508 /**
Wolfgang Betz 0:4fb29d9ee571 509 * @brief Returns the CS Mode.
Wolfgang Betz 0:4fb29d9ee571 510 * @param None.
Wolfgang Betz 0:4fb29d9ee571 511 * @retval CSMode CS mode.
Wolfgang Betz 0:4fb29d9ee571 512 */
Wolfgang Betz 0:4fb29d9ee571 513 CSMode SpiritQiGetCsMode(void)
Wolfgang Betz 0:4fb29d9ee571 514 {
Wolfgang Betz 0:4fb29d9ee571 515 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 516
Wolfgang Betz 0:4fb29d9ee571 517 /* Reads the RSSI_FLT register */
Wolfgang Betz 0:4fb29d9ee571 518 g_xStatus = SpiritSpiReadRegisters(RSSI_FLT_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 519
Wolfgang Betz 0:4fb29d9ee571 520 /* Rebuild and returns the CS mode value */
Wolfgang Betz 0:4fb29d9ee571 521 return (CSMode)(tempRegValue & 0x0C);
Wolfgang Betz 0:4fb29d9ee571 522
Wolfgang Betz 0:4fb29d9ee571 523 }
Wolfgang Betz 0:4fb29d9ee571 524
Wolfgang Betz 0:4fb29d9ee571 525 /**
Wolfgang Betz 0:4fb29d9ee571 526 * @brief Enables/Disables the CS Timeout Mask. If enabled CS value contributes to timeout disabling.
Wolfgang Betz 0:4fb29d9ee571 527 * @param xNewState new state for CS Timeout Mask.
Wolfgang Betz 0:4fb29d9ee571 528 * This parameter can be S_ENABLE or S_DISABLE.
Wolfgang Betz 0:4fb29d9ee571 529 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 530 */
Wolfgang Betz 0:4fb29d9ee571 531 void SpiritQiCsTimeoutMask(SpiritFunctionalState xNewState)
Wolfgang Betz 0:4fb29d9ee571 532 {
Wolfgang Betz 0:4fb29d9ee571 533 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 534
Wolfgang Betz 0:4fb29d9ee571 535 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 536 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 0:4fb29d9ee571 537
Wolfgang Betz 0:4fb29d9ee571 538 /* Reads the PROTOCOL2 register value */
Wolfgang Betz 0:4fb29d9ee571 539 g_xStatus = SpiritSpiReadRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 540
Wolfgang Betz 0:4fb29d9ee571 541 /* Enables or disables the CS timeout mask */
Wolfgang Betz 0:4fb29d9ee571 542 if(xNewState == S_ENABLE)
Wolfgang Betz 0:4fb29d9ee571 543 {
Wolfgang Betz 0:4fb29d9ee571 544 tempRegValue |= PROTOCOL2_CS_TIMEOUT_MASK;
Wolfgang Betz 0:4fb29d9ee571 545 }
Wolfgang Betz 0:4fb29d9ee571 546 else
Wolfgang Betz 0:4fb29d9ee571 547 {
Wolfgang Betz 0:4fb29d9ee571 548 tempRegValue &= ~PROTOCOL2_CS_TIMEOUT_MASK;
Wolfgang Betz 0:4fb29d9ee571 549 }
Wolfgang Betz 0:4fb29d9ee571 550
Wolfgang Betz 0:4fb29d9ee571 551 /* Writes the new value on the PROTOCOL2 register */
Wolfgang Betz 0:4fb29d9ee571 552 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 553
Wolfgang Betz 0:4fb29d9ee571 554 }
Wolfgang Betz 0:4fb29d9ee571 555
Wolfgang Betz 0:4fb29d9ee571 556
Wolfgang Betz 0:4fb29d9ee571 557 /**
Wolfgang Betz 0:4fb29d9ee571 558 * @brief Enables/Disables the PQI Timeout Mask. If enabled PQI value contributes to timeout disabling.
Wolfgang Betz 0:4fb29d9ee571 559 * @param xNewState new state for PQI Timeout Mask.
Wolfgang Betz 0:4fb29d9ee571 560 * This parameter can be S_ENABLE or S_DISABLE.
Wolfgang Betz 0:4fb29d9ee571 561 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 562 */
Wolfgang Betz 0:4fb29d9ee571 563 void SpiritQiPqiTimeoutMask(SpiritFunctionalState xNewState)
Wolfgang Betz 0:4fb29d9ee571 564 {
Wolfgang Betz 0:4fb29d9ee571 565 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 566
Wolfgang Betz 0:4fb29d9ee571 567 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 568 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 0:4fb29d9ee571 569
Wolfgang Betz 0:4fb29d9ee571 570 /* Reads the PROTOCOL2 register */
Wolfgang Betz 0:4fb29d9ee571 571 g_xStatus = SpiritSpiReadRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 572
Wolfgang Betz 0:4fb29d9ee571 573 /* Enables or disables the PQI timeout mask */
Wolfgang Betz 0:4fb29d9ee571 574 if(xNewState == S_ENABLE)
Wolfgang Betz 0:4fb29d9ee571 575 {
Wolfgang Betz 0:4fb29d9ee571 576 tempRegValue |= PROTOCOL2_PQI_TIMEOUT_MASK;
Wolfgang Betz 0:4fb29d9ee571 577 }
Wolfgang Betz 0:4fb29d9ee571 578 else
Wolfgang Betz 0:4fb29d9ee571 579 {
Wolfgang Betz 0:4fb29d9ee571 580 tempRegValue &= ~PROTOCOL2_PQI_TIMEOUT_MASK;
Wolfgang Betz 0:4fb29d9ee571 581 }
Wolfgang Betz 0:4fb29d9ee571 582
Wolfgang Betz 0:4fb29d9ee571 583 /* Writes the new value on the PROTOCOL2 register */
Wolfgang Betz 0:4fb29d9ee571 584 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 585
Wolfgang Betz 0:4fb29d9ee571 586 }
Wolfgang Betz 0:4fb29d9ee571 587
Wolfgang Betz 0:4fb29d9ee571 588
Wolfgang Betz 0:4fb29d9ee571 589 /**
Wolfgang Betz 0:4fb29d9ee571 590 * @brief Enables/Disables the SQI Timeout Mask. If enabled SQI value contributes to timeout disabling.
Wolfgang Betz 0:4fb29d9ee571 591 * @param xNewState new state for SQI Timeout Mask.
Wolfgang Betz 0:4fb29d9ee571 592 * This parameter can be S_ENABLE or S_DISABLE.
Wolfgang Betz 0:4fb29d9ee571 593 * @retval None.
Wolfgang Betz 0:4fb29d9ee571 594 */
Wolfgang Betz 0:4fb29d9ee571 595 void SpiritQiSqiTimeoutMask(SpiritFunctionalState xNewState)
Wolfgang Betz 0:4fb29d9ee571 596 {
Wolfgang Betz 0:4fb29d9ee571 597 uint8_t tempRegValue;
Wolfgang Betz 0:4fb29d9ee571 598
Wolfgang Betz 0:4fb29d9ee571 599 /* Check the parameters */
Wolfgang Betz 0:4fb29d9ee571 600 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 0:4fb29d9ee571 601
Wolfgang Betz 0:4fb29d9ee571 602 /* Reads the PROTOCOL2 register */
Wolfgang Betz 0:4fb29d9ee571 603 g_xStatus = SpiritSpiReadRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 604
Wolfgang Betz 0:4fb29d9ee571 605 /* Enables or disables the SQI timeout mask */
Wolfgang Betz 0:4fb29d9ee571 606 if(xNewState == S_ENABLE)
Wolfgang Betz 0:4fb29d9ee571 607 {
Wolfgang Betz 0:4fb29d9ee571 608 tempRegValue |= PROTOCOL2_SQI_TIMEOUT_MASK;
Wolfgang Betz 0:4fb29d9ee571 609 }
Wolfgang Betz 0:4fb29d9ee571 610 else
Wolfgang Betz 0:4fb29d9ee571 611 {
Wolfgang Betz 0:4fb29d9ee571 612 tempRegValue &= ~PROTOCOL2_SQI_TIMEOUT_MASK;
Wolfgang Betz 0:4fb29d9ee571 613 }
Wolfgang Betz 0:4fb29d9ee571 614
Wolfgang Betz 0:4fb29d9ee571 615 /* Writes the new value on the PROTOCOL2 register */
Wolfgang Betz 0:4fb29d9ee571 616 g_xStatus = SpiritSpiWriteRegisters(PROTOCOL2_BASE, 1, &tempRegValue);
Wolfgang Betz 0:4fb29d9ee571 617
Wolfgang Betz 0:4fb29d9ee571 618 }
Wolfgang Betz 0:4fb29d9ee571 619
Wolfgang Betz 0:4fb29d9ee571 620
Wolfgang Betz 0:4fb29d9ee571 621 /**
Wolfgang Betz 0:4fb29d9ee571 622 *@}
Wolfgang Betz 0:4fb29d9ee571 623 */
Wolfgang Betz 0:4fb29d9ee571 624
Wolfgang Betz 0:4fb29d9ee571 625 /**
Wolfgang Betz 0:4fb29d9ee571 626 *@}
Wolfgang Betz 0:4fb29d9ee571 627 */
Wolfgang Betz 0:4fb29d9ee571 628
Wolfgang Betz 0:4fb29d9ee571 629
Wolfgang Betz 0:4fb29d9ee571 630 /**
Wolfgang Betz 0:4fb29d9ee571 631 *@}
Wolfgang Betz 0:4fb29d9ee571 632 */
Wolfgang Betz 0:4fb29d9ee571 633
Wolfgang Betz 0:4fb29d9ee571 634
Wolfgang Betz 0:4fb29d9ee571 635
Wolfgang Betz 0:4fb29d9ee571 636 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/