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_Gpio.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_Gpio.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 This file provides all the low level API to manage SPIRIT GPIO.
Wolfgang Betz 67:93bec0baf1de 8 * @details
Wolfgang Betz 67:93bec0baf1de 9 *
Wolfgang Betz 67:93bec0baf1de 10 * @attention
Wolfgang Betz 67:93bec0baf1de 11 *
Wolfgang Betz 67:93bec0baf1de 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 67:93bec0baf1de 13 *
Wolfgang Betz 67:93bec0baf1de 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 67:93bec0baf1de 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 67:93bec0baf1de 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 67:93bec0baf1de 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 67:93bec0baf1de 20 * and/or other materials provided with the distribution.
Wolfgang Betz 67:93bec0baf1de 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 67:93bec0baf1de 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 67:93bec0baf1de 23 * without specific prior written permission.
Wolfgang Betz 67:93bec0baf1de 24 *
Wolfgang Betz 67:93bec0baf1de 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 67:93bec0baf1de 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 67:93bec0baf1de 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 67:93bec0baf1de 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 67:93bec0baf1de 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 67:93bec0baf1de 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 67:93bec0baf1de 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 67:93bec0baf1de 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 67:93bec0baf1de 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 67:93bec0baf1de 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 67:93bec0baf1de 35 *
Wolfgang Betz 67:93bec0baf1de 36 ******************************************************************************
Wolfgang Betz 67:93bec0baf1de 37 */
Wolfgang Betz 67:93bec0baf1de 38
Wolfgang Betz 67:93bec0baf1de 39 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 67:93bec0baf1de 40 #include "SPIRIT_Gpio.h"
Wolfgang Betz 67:93bec0baf1de 41 #include "MCU_Interface.h"
Wolfgang Betz 67:93bec0baf1de 42
Wolfgang Betz 67:93bec0baf1de 43
Wolfgang Betz 67:93bec0baf1de 44 /** @addtogroup SPIRIT_Libraries
Wolfgang Betz 67:93bec0baf1de 45 * @{
Wolfgang Betz 67:93bec0baf1de 46 */
Wolfgang Betz 67:93bec0baf1de 47
Wolfgang Betz 67:93bec0baf1de 48
Wolfgang Betz 67:93bec0baf1de 49 /** @addtogroup SPIRIT_Gpio
Wolfgang Betz 67:93bec0baf1de 50 * @{
Wolfgang Betz 67:93bec0baf1de 51 */
Wolfgang Betz 67:93bec0baf1de 52
Wolfgang Betz 67:93bec0baf1de 53
Wolfgang Betz 67:93bec0baf1de 54 /** @defgroup Gpio_Private_TypesDefinitions GPIO Private Types Definitions
Wolfgang Betz 67:93bec0baf1de 55 * @{
Wolfgang Betz 67:93bec0baf1de 56 */
Wolfgang Betz 67:93bec0baf1de 57
Wolfgang Betz 67:93bec0baf1de 58
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 /** @defgroup Gpio_Private_Defines GPIO Private Defines
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 /**
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 /** @defgroup Gpio_Private_Macros GPIO Private Macros
Wolfgang Betz 67:93bec0baf1de 76 * @{
Wolfgang Betz 67:93bec0baf1de 77 */
Wolfgang Betz 67:93bec0baf1de 78
Wolfgang Betz 67:93bec0baf1de 79
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 /** @defgroup Gpio_Private_Variables GPIO Private Variables
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 * @}
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 /** @defgroup Gpio_Private_FunctionPrototypes GPIO Private Function Prototypes
Wolfgang Betz 67:93bec0baf1de 98 * @{
Wolfgang Betz 67:93bec0baf1de 99 */
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
Wolfgang Betz 67:93bec0baf1de 106
Wolfgang Betz 67:93bec0baf1de 107
Wolfgang Betz 67:93bec0baf1de 108 /** @defgroup Gpio_Private_Functions GPIO Private Functions
Wolfgang Betz 67:93bec0baf1de 109 * @{
Wolfgang Betz 67:93bec0baf1de 110 */
Wolfgang Betz 67:93bec0baf1de 111
Wolfgang Betz 67:93bec0baf1de 112 /**
Wolfgang Betz 67:93bec0baf1de 113 * @brief Initializes the SPIRIT GPIOx according to the specified
Wolfgang Betz 67:93bec0baf1de 114 * parameters in the pxGpioInitStruct.
Wolfgang Betz 67:93bec0baf1de 115 * @param pxGpioInitStruct pointer to a SGpioInit structure that
Wolfgang Betz 67:93bec0baf1de 116 * contains the configuration information for the specified SPIRIT GPIO.
Wolfgang Betz 67:93bec0baf1de 117 * @retval None.
Wolfgang Betz 67:93bec0baf1de 118 */
Wolfgang Betz 67:93bec0baf1de 119 void SpiritGpioInit(SGpioInit* pxGpioInitStruct)
Wolfgang Betz 67:93bec0baf1de 120 {
Wolfgang Betz 67:93bec0baf1de 121 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 122
Wolfgang Betz 67:93bec0baf1de 123 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 124 s_assert_param(IS_SPIRIT_GPIO(pxGpioInitStruct->xSpiritGpioPin));
Wolfgang Betz 67:93bec0baf1de 125 s_assert_param(IS_SPIRIT_GPIO_MODE(pxGpioInitStruct->xSpiritGpioMode));
Wolfgang Betz 67:93bec0baf1de 126 s_assert_param(IS_SPIRIT_GPIO_IO(pxGpioInitStruct->xSpiritGpioIO));
Wolfgang Betz 67:93bec0baf1de 127
Wolfgang Betz 67:93bec0baf1de 128 tempRegValue = ((uint8_t)(pxGpioInitStruct->xSpiritGpioMode) | (uint8_t)(pxGpioInitStruct->xSpiritGpioIO));
Wolfgang Betz 67:93bec0baf1de 129
Wolfgang Betz 67:93bec0baf1de 130 g_xStatus = SpiritSpiWriteRegisters(pxGpioInitStruct->xSpiritGpioPin, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 131
Wolfgang Betz 67:93bec0baf1de 132 }
Wolfgang Betz 67:93bec0baf1de 133
Wolfgang Betz 67:93bec0baf1de 134
Wolfgang Betz 67:93bec0baf1de 135 /**
Wolfgang Betz 67:93bec0baf1de 136 * @brief Enables or Disables the output of temperature sensor on SPIRIT GPIO_0.
Wolfgang Betz 67:93bec0baf1de 137 * @param xNewState new state for temperature sensor.
Wolfgang Betz 67:93bec0baf1de 138 * This parameter can be: S_ENABLE or S_DISABLE.
Wolfgang Betz 67:93bec0baf1de 139 * @retval None.
Wolfgang Betz 67:93bec0baf1de 140 */
Wolfgang Betz 67:93bec0baf1de 141 void SpiritGpioTemperatureSensor(SpiritFunctionalState xNewState)
Wolfgang Betz 67:93bec0baf1de 142 {
Wolfgang Betz 67:93bec0baf1de 143 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 144 uint8_t gpio0tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 145
Wolfgang Betz 67:93bec0baf1de 146 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 147 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 67:93bec0baf1de 148
Wolfgang Betz 67:93bec0baf1de 149 /* Reads the ANA_FUNC_CONF0 register and mask the result to enable or disable the
Wolfgang Betz 67:93bec0baf1de 150 temperature sensor */
Wolfgang Betz 67:93bec0baf1de 151 g_xStatus = SpiritSpiReadRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 152 if(xNewState == S_ENABLE)
Wolfgang Betz 67:93bec0baf1de 153 {
Wolfgang Betz 67:93bec0baf1de 154 tempRegValue |= TEMPERATURE_SENSOR_MASK;
Wolfgang Betz 67:93bec0baf1de 155 }
Wolfgang Betz 67:93bec0baf1de 156 else
Wolfgang Betz 67:93bec0baf1de 157 {
Wolfgang Betz 67:93bec0baf1de 158 tempRegValue &= (~TEMPERATURE_SENSOR_MASK);
Wolfgang Betz 67:93bec0baf1de 159 gpio0tempRegValue = 0x0A; /* Default value */
Wolfgang Betz 67:93bec0baf1de 160 }
Wolfgang Betz 67:93bec0baf1de 161 g_xStatus = SpiritSpiWriteRegisters(ANA_FUNC_CONF0_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 162
Wolfgang Betz 67:93bec0baf1de 163 /* Sets the SPIRIT GPIO_0 according to input request */
Wolfgang Betz 67:93bec0baf1de 164 g_xStatus = SpiritSpiWriteRegisters(GPIO0_CONF_BASE, 1, &gpio0tempRegValue);
Wolfgang Betz 67:93bec0baf1de 165
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 * @brief Forces SPIRIT GPIO_x configured as digital output, to VDD or GND.
Wolfgang Betz 67:93bec0baf1de 171 * @param xGpioX Specifies the GPIO to be configured.
Wolfgang Betz 67:93bec0baf1de 172 * This parameter can be one of following parameters:
Wolfgang Betz 67:93bec0baf1de 173 * @arg SPIRIT_GPIO_0: SPIRIT GPIO_0
Wolfgang Betz 67:93bec0baf1de 174 * @arg SPIRIT_GPIO_1: SPIRIT GPIO_1
Wolfgang Betz 67:93bec0baf1de 175 * @arg SPIRIT_GPIO_2: SPIRIT GPIO_2
Wolfgang Betz 67:93bec0baf1de 176 * @arg SPIRIT_GPIO_3: SPIRIT GPIO_3
Wolfgang Betz 67:93bec0baf1de 177 * @param xLevel Specifies the level.
Wolfgang Betz 67:93bec0baf1de 178 * This parameter can be: HIGH or LOW.
Wolfgang Betz 67:93bec0baf1de 179 * @retval None.
Wolfgang Betz 67:93bec0baf1de 180 */
Wolfgang Betz 67:93bec0baf1de 181 void SpiritGpioSetLevel(SpiritGpioPin xGpioX, OutputLevel xLevel)
Wolfgang Betz 67:93bec0baf1de 182 {
Wolfgang Betz 67:93bec0baf1de 183 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 184
Wolfgang Betz 67:93bec0baf1de 185 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 186 s_assert_param(IS_SPIRIT_GPIO(xGpioX));
Wolfgang Betz 67:93bec0baf1de 187 s_assert_param(IS_SPIRIT_GPIO_LEVEL(xLevel));
Wolfgang Betz 67:93bec0baf1de 188
Wolfgang Betz 67:93bec0baf1de 189 /* Reads the SPIRIT_GPIOx register and mask the GPIO_SELECT field */
Wolfgang Betz 67:93bec0baf1de 190 g_xStatus = SpiritSpiReadRegisters(xGpioX, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 191 tempRegValue &= 0x04;
Wolfgang Betz 67:93bec0baf1de 192
Wolfgang Betz 67:93bec0baf1de 193 /* Sets the value of the SPIRIT GPIO register according to the specified level */
Wolfgang Betz 67:93bec0baf1de 194 if(xLevel == HIGH)
Wolfgang Betz 67:93bec0baf1de 195 {
Wolfgang Betz 67:93bec0baf1de 196 tempRegValue |= (uint8_t)SPIRIT_GPIO_DIG_OUT_VDD | (uint8_t)SPIRIT_GPIO_MODE_DIGITAL_OUTPUT_HP;
Wolfgang Betz 67:93bec0baf1de 197 }
Wolfgang Betz 67:93bec0baf1de 198 else
Wolfgang Betz 67:93bec0baf1de 199 {
Wolfgang Betz 67:93bec0baf1de 200 tempRegValue |= (uint8_t)SPIRIT_GPIO_DIG_OUT_GND | (uint8_t)SPIRIT_GPIO_MODE_DIGITAL_OUTPUT_HP;
Wolfgang Betz 67:93bec0baf1de 201 }
Wolfgang Betz 67:93bec0baf1de 202
Wolfgang Betz 67:93bec0baf1de 203 /* Writes the SPIRIT GPIO register */
Wolfgang Betz 67:93bec0baf1de 204 g_xStatus = SpiritSpiWriteRegisters(xGpioX, 1, &tempRegValue);
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 * @brief Returns output value (VDD or GND) of SPIRIT GPIO_x, when it is configured as digital output.
Wolfgang Betz 67:93bec0baf1de 211 * @param xGpioX Specifies the GPIO to be read.
Wolfgang Betz 67:93bec0baf1de 212 * This parameter can be one of following parameters:
Wolfgang Betz 67:93bec0baf1de 213 * @arg SPIRIT_GPIO_0: SPIRIT GPIO_0
Wolfgang Betz 67:93bec0baf1de 214 * @arg SPIRIT_GPIO_1: SPIRIT GPIO_1
Wolfgang Betz 67:93bec0baf1de 215 * @arg SPIRIT_GPIO_2: SPIRIT GPIO_2
Wolfgang Betz 67:93bec0baf1de 216 * @arg SPIRIT_GPIO_3: SPIRIT GPIO_3
Wolfgang Betz 67:93bec0baf1de 217 * @retval OutputLevel Logical level of selected GPIO configured as digital output.
Wolfgang Betz 67:93bec0baf1de 218 * This parameter can be: HIGH or LOW.
Wolfgang Betz 67:93bec0baf1de 219 */
Wolfgang Betz 67:93bec0baf1de 220 OutputLevel SpiritGpioGetLevel(SpiritGpioPin xGpioX)
Wolfgang Betz 67:93bec0baf1de 221 {
Wolfgang Betz 67:93bec0baf1de 222 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 223 OutputLevel level;
Wolfgang Betz 67:93bec0baf1de 224
Wolfgang Betz 67:93bec0baf1de 225 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 226 s_assert_param(IS_SPIRIT_GPIO(xGpioX));
Wolfgang Betz 67:93bec0baf1de 227
Wolfgang Betz 67:93bec0baf1de 228 /* Reads the SPIRIT_GPIOx register */
Wolfgang Betz 67:93bec0baf1de 229 g_xStatus = SpiritSpiReadRegisters(xGpioX, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 230
Wolfgang Betz 67:93bec0baf1de 231 /* Mask the GPIO_SELECT field and returns the value according */
Wolfgang Betz 67:93bec0baf1de 232 tempRegValue &= 0xF8;
Wolfgang Betz 67:93bec0baf1de 233 if(tempRegValue == SPIRIT_GPIO_DIG_OUT_VDD)
Wolfgang Betz 67:93bec0baf1de 234 {
Wolfgang Betz 67:93bec0baf1de 235 level = HIGH;
Wolfgang Betz 67:93bec0baf1de 236 }
Wolfgang Betz 67:93bec0baf1de 237 else
Wolfgang Betz 67:93bec0baf1de 238 {
Wolfgang Betz 67:93bec0baf1de 239 level = LOW;
Wolfgang Betz 67:93bec0baf1de 240 }
Wolfgang Betz 67:93bec0baf1de 241
Wolfgang Betz 67:93bec0baf1de 242 return level;
Wolfgang Betz 67:93bec0baf1de 243
Wolfgang Betz 67:93bec0baf1de 244 }
Wolfgang Betz 67:93bec0baf1de 245
Wolfgang Betz 67:93bec0baf1de 246
Wolfgang Betz 67:93bec0baf1de 247 /**
Wolfgang Betz 67:93bec0baf1de 248 * @brief Enables or Disables the MCU clock output.
Wolfgang Betz 67:93bec0baf1de 249 * @param xNewState new state for the MCU clock output.
Wolfgang Betz 67:93bec0baf1de 250 * This parameter can be: S_ENABLE or S_DISABLE.
Wolfgang Betz 67:93bec0baf1de 251 * @retval None.
Wolfgang Betz 67:93bec0baf1de 252 */
Wolfgang Betz 67:93bec0baf1de 253 void SpiritGpioClockOutput(SpiritFunctionalState xNewState)
Wolfgang Betz 67:93bec0baf1de 254 {
Wolfgang Betz 67:93bec0baf1de 255 uint8_t tempRegValue;
Wolfgang Betz 67:93bec0baf1de 256
Wolfgang Betz 67:93bec0baf1de 257 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 258 s_assert_param(IS_SPIRIT_FUNCTIONAL_STATE(xNewState));
Wolfgang Betz 67:93bec0baf1de 259
Wolfgang Betz 67:93bec0baf1de 260 /* Reads the MCU_CK_CONF register and mask the result to enable or disable the clock output */
Wolfgang Betz 67:93bec0baf1de 261 g_xStatus = SpiritSpiReadRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 262
Wolfgang Betz 67:93bec0baf1de 263 if(xNewState)
Wolfgang Betz 67:93bec0baf1de 264 {
Wolfgang Betz 67:93bec0baf1de 265 tempRegValue |= MCU_CK_ENABLE;
Wolfgang Betz 67:93bec0baf1de 266 }
Wolfgang Betz 67:93bec0baf1de 267 else
Wolfgang Betz 67:93bec0baf1de 268 {
Wolfgang Betz 67:93bec0baf1de 269 tempRegValue &= (~MCU_CK_ENABLE);
Wolfgang Betz 67:93bec0baf1de 270 }
Wolfgang Betz 67:93bec0baf1de 271
Wolfgang Betz 67:93bec0baf1de 272 /* Writes the MCU_CK_CONF register */
Wolfgang Betz 67:93bec0baf1de 273 g_xStatus = SpiritSpiWriteRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 274
Wolfgang Betz 67:93bec0baf1de 275 }
Wolfgang Betz 67:93bec0baf1de 276
Wolfgang Betz 67:93bec0baf1de 277
Wolfgang Betz 67:93bec0baf1de 278 /**
Wolfgang Betz 67:93bec0baf1de 279 * @brief Initializes the SPIRIT Clock Output according to the specified
Wolfgang Betz 67:93bec0baf1de 280 * parameters in the xClockOutputInitStruct.
Wolfgang Betz 67:93bec0baf1de 281 * @param pxClockOutputInitStruct pointer to a ClockOutputInit structure that
Wolfgang Betz 67:93bec0baf1de 282 * contains the configuration information for the SPIRIT Clock Output.
Wolfgang Betz 67:93bec0baf1de 283 * @retval None.
Wolfgang Betz 67:93bec0baf1de 284 * @note The function SpiritGpioClockOutput() must be called in order to enable
Wolfgang Betz 67:93bec0baf1de 285 * or disable the MCU clock dividers.
Wolfgang Betz 67:93bec0baf1de 286 */
Wolfgang Betz 67:93bec0baf1de 287 void SpiritGpioClockOutputInit(ClockOutputInit* pxClockOutputInitStruct)
Wolfgang Betz 67:93bec0baf1de 288 {
Wolfgang Betz 67:93bec0baf1de 289 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 290
Wolfgang Betz 67:93bec0baf1de 291 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 292 s_assert_param(IS_SPIRIT_CLOCK_OUTPUT_XO(pxClockOutputInitStruct->xClockOutputXOPrescaler));
Wolfgang Betz 67:93bec0baf1de 293 s_assert_param(IS_SPIRIT_CLOCK_OUTPUT_RCO(pxClockOutputInitStruct->xClockOutputRCOPrescaler));
Wolfgang Betz 67:93bec0baf1de 294 s_assert_param(IS_SPIRIT_CLOCK_OUTPUT_EXTRA_CYCLES(pxClockOutputInitStruct->xExtraClockCycles));
Wolfgang Betz 67:93bec0baf1de 295
Wolfgang Betz 67:93bec0baf1de 296 /* Calculates the register value to write according to the specified configuration */
Wolfgang Betz 67:93bec0baf1de 297 tempRegValue = ((uint8_t)(pxClockOutputInitStruct->xClockOutputXOPrescaler) | (uint8_t)(pxClockOutputInitStruct->xClockOutputRCOPrescaler) | \
Wolfgang Betz 67:93bec0baf1de 298 (uint8_t)(pxClockOutputInitStruct->xExtraClockCycles));
Wolfgang Betz 67:93bec0baf1de 299
Wolfgang Betz 67:93bec0baf1de 300 /* Writes the MCU_CLOCK register */
Wolfgang Betz 67:93bec0baf1de 301 g_xStatus = SpiritSpiWriteRegisters(MCU_CK_CONF_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 Sets the XO ratio as clock output.
Wolfgang Betz 67:93bec0baf1de 308 * @param xXOPrescaler the XO prescaler to be used as clock output.
Wolfgang Betz 67:93bec0baf1de 309 * This parameter can be any value of @ref ClockOutputXOPrescaler .
Wolfgang Betz 67:93bec0baf1de 310 * @retval None
Wolfgang Betz 67:93bec0baf1de 311 */
Wolfgang Betz 67:93bec0baf1de 312 void SpiritGpioSetXOPrescaler(ClockOutputXOPrescaler xXOPrescaler)
Wolfgang Betz 67:93bec0baf1de 313 {
Wolfgang Betz 67:93bec0baf1de 314 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 315
Wolfgang Betz 67:93bec0baf1de 316 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 317 s_assert_param(IS_SPIRIT_CLOCK_OUTPUT_XO(xXOPrescaler));
Wolfgang Betz 67:93bec0baf1de 318
Wolfgang Betz 67:93bec0baf1de 319 /* Reads the MCU_CLK_CONFIG register */
Wolfgang Betz 67:93bec0baf1de 320 g_xStatus = SpiritSpiReadRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 321
Wolfgang Betz 67:93bec0baf1de 322 /* Mask the XO_RATIO field and writes the new value */
Wolfgang Betz 67:93bec0baf1de 323 tempRegValue &= 0x61;
Wolfgang Betz 67:93bec0baf1de 324 tempRegValue |= ((uint8_t)xXOPrescaler);
Wolfgang Betz 67:93bec0baf1de 325
Wolfgang Betz 67:93bec0baf1de 326 /* Writes the new XO prescaler in the MCU_CLOCK register */
Wolfgang Betz 67:93bec0baf1de 327 g_xStatus = SpiritSpiWriteRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 328
Wolfgang Betz 67:93bec0baf1de 329 }
Wolfgang Betz 67:93bec0baf1de 330
Wolfgang Betz 67:93bec0baf1de 331
Wolfgang Betz 67:93bec0baf1de 332 /**
Wolfgang Betz 67:93bec0baf1de 333 * @brief Returns the settled XO prescaler as clock output.
Wolfgang Betz 67:93bec0baf1de 334 * @param None.
Wolfgang Betz 67:93bec0baf1de 335 * @retval ClockOutputXOPrescaler Settled XO prescaler used for clock
Wolfgang Betz 67:93bec0baf1de 336 * output. This parameter can be a value of @ref ClockOutputXOPrescaler .
Wolfgang Betz 67:93bec0baf1de 337 */
Wolfgang Betz 67:93bec0baf1de 338 ClockOutputXOPrescaler SpiritGpioGetXOPrescaler(void)
Wolfgang Betz 67:93bec0baf1de 339 {
Wolfgang Betz 67:93bec0baf1de 340 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 341
Wolfgang Betz 67:93bec0baf1de 342 /* Reads the MCU_CLK_CONFIG register */
Wolfgang Betz 67:93bec0baf1de 343 g_xStatus = SpiritSpiReadRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 344
Wolfgang Betz 67:93bec0baf1de 345 /* Mask the XO_RATIO field and return the value */
Wolfgang Betz 67:93bec0baf1de 346 return ((ClockOutputXOPrescaler)(tempRegValue & 0x1E));
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 /**
Wolfgang Betz 67:93bec0baf1de 352 * @brief Sets the RCO ratio as clock output
Wolfgang Betz 67:93bec0baf1de 353 * @param xRCOPrescaler the RCO prescaler to be used as clock output.
Wolfgang Betz 67:93bec0baf1de 354 * This parameter can be any value of @ref ClockOutputRCOPrescaler .
Wolfgang Betz 67:93bec0baf1de 355 * @retval None.
Wolfgang Betz 67:93bec0baf1de 356 */
Wolfgang Betz 67:93bec0baf1de 357 void SpiritGpioSetRCOPrescaler(ClockOutputRCOPrescaler xRCOPrescaler)
Wolfgang Betz 67:93bec0baf1de 358 {
Wolfgang Betz 67:93bec0baf1de 359 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 360
Wolfgang Betz 67:93bec0baf1de 361 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 362 s_assert_param(IS_SPIRIT_CLOCK_OUTPUT_RCO(xRCOPrescaler));
Wolfgang Betz 67:93bec0baf1de 363
Wolfgang Betz 67:93bec0baf1de 364 /* Reads the MCU_CLK_CONFIG register */
Wolfgang Betz 67:93bec0baf1de 365 g_xStatus = SpiritSpiReadRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 366
Wolfgang Betz 67:93bec0baf1de 367 /* Mask the RCO_RATIO field and writes the new value */
Wolfgang Betz 67:93bec0baf1de 368 tempRegValue &= 0xFE;
Wolfgang Betz 67:93bec0baf1de 369 tempRegValue |= ((uint8_t)xRCOPrescaler);
Wolfgang Betz 67:93bec0baf1de 370
Wolfgang Betz 67:93bec0baf1de 371 /* Writes the new RCO prescaler in the MCU_CLOCK register */
Wolfgang Betz 67:93bec0baf1de 372 g_xStatus = SpiritSpiWriteRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 373
Wolfgang Betz 67:93bec0baf1de 374 }
Wolfgang Betz 67:93bec0baf1de 375
Wolfgang Betz 67:93bec0baf1de 376
Wolfgang Betz 67:93bec0baf1de 377 /**
Wolfgang Betz 67:93bec0baf1de 378 * @brief Returns the settled RCO prescaler as clock output.
Wolfgang Betz 67:93bec0baf1de 379 * @param None.
Wolfgang Betz 67:93bec0baf1de 380 * @retval ClockOutputRCOPrescaler Settled RCO prescaler used for clock
Wolfgang Betz 67:93bec0baf1de 381 * output. This parameter can be a value of @ref ClockOutputRCOPrescaler.
Wolfgang Betz 67:93bec0baf1de 382 */
Wolfgang Betz 67:93bec0baf1de 383 ClockOutputRCOPrescaler SpiritGpioGetRCOPrescaler(void)
Wolfgang Betz 67:93bec0baf1de 384 {
Wolfgang Betz 67:93bec0baf1de 385 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 386
Wolfgang Betz 67:93bec0baf1de 387 /* Reads the MCU_CLK_CONFIG register */
Wolfgang Betz 67:93bec0baf1de 388 g_xStatus = SpiritSpiReadRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 389
Wolfgang Betz 67:93bec0baf1de 390 /* Mask the RCO_RATIO field and returns the value */
Wolfgang Betz 67:93bec0baf1de 391 return ((ClockOutputRCOPrescaler)(tempRegValue & 0x01));
Wolfgang Betz 67:93bec0baf1de 392
Wolfgang Betz 67:93bec0baf1de 393 }
Wolfgang Betz 67:93bec0baf1de 394
Wolfgang Betz 67:93bec0baf1de 395
Wolfgang Betz 67:93bec0baf1de 396 /**
Wolfgang Betz 67:93bec0baf1de 397 * @brief Sets the RCO ratio as clock output.
Wolfgang Betz 67:93bec0baf1de 398 * @param xExtraCycles the number of extra clock cycles provided before switching
Wolfgang Betz 67:93bec0baf1de 399 * to STANDBY state. This parameter can be any value of @ref ExtraClockCycles .
Wolfgang Betz 67:93bec0baf1de 400 * @retval None.
Wolfgang Betz 67:93bec0baf1de 401 */
Wolfgang Betz 67:93bec0baf1de 402 void SpiritGpioSetExtraClockCycles(ExtraClockCycles xExtraCycles)
Wolfgang Betz 67:93bec0baf1de 403 {
Wolfgang Betz 67:93bec0baf1de 404 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 405
Wolfgang Betz 67:93bec0baf1de 406 /* Check the parameters */
Wolfgang Betz 67:93bec0baf1de 407 s_assert_param(IS_SPIRIT_CLOCK_OUTPUT_EXTRA_CYCLES(xExtraCycles));
Wolfgang Betz 67:93bec0baf1de 408
Wolfgang Betz 67:93bec0baf1de 409 /* Reads the MCU_CLK_CONFIG register */
Wolfgang Betz 67:93bec0baf1de 410 g_xStatus = SpiritSpiReadRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 411
Wolfgang Betz 67:93bec0baf1de 412 /* Mask the CLOCK_TAIL field and writes the new value */
Wolfgang Betz 67:93bec0baf1de 413 tempRegValue &= 0x9F;
Wolfgang Betz 67:93bec0baf1de 414 tempRegValue |= ((uint8_t)xExtraCycles);
Wolfgang Betz 67:93bec0baf1de 415
Wolfgang Betz 67:93bec0baf1de 416 /* Writes the new number of extra clock cycles in the MCU_CLOCK register */
Wolfgang Betz 67:93bec0baf1de 417 g_xStatus = SpiritSpiWriteRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 418
Wolfgang Betz 67:93bec0baf1de 419 }
Wolfgang Betz 67:93bec0baf1de 420
Wolfgang Betz 67:93bec0baf1de 421
Wolfgang Betz 67:93bec0baf1de 422 /**
Wolfgang Betz 67:93bec0baf1de 423 * @brief Returns the settled RCO prescaler as clock output.
Wolfgang Betz 67:93bec0baf1de 424 * @param None.
Wolfgang Betz 67:93bec0baf1de 425 * @retval ExtraClockCycles Settled number of extra clock cycles
Wolfgang Betz 67:93bec0baf1de 426 * provided before switching to STANDBY state. This parameter can be
Wolfgang Betz 67:93bec0baf1de 427 * any value of @ref ExtraClockCycles .
Wolfgang Betz 67:93bec0baf1de 428 */
Wolfgang Betz 67:93bec0baf1de 429 ExtraClockCycles SpiritGpioGetExtraClockCycles(void)
Wolfgang Betz 67:93bec0baf1de 430 {
Wolfgang Betz 67:93bec0baf1de 431 uint8_t tempRegValue = 0x00;
Wolfgang Betz 67:93bec0baf1de 432
Wolfgang Betz 67:93bec0baf1de 433 /* Reads the MCU_CLK_CONFIG register */
Wolfgang Betz 67:93bec0baf1de 434 g_xStatus = SpiritSpiReadRegisters(MCU_CK_CONF_BASE, 1, &tempRegValue);
Wolfgang Betz 67:93bec0baf1de 435
Wolfgang Betz 67:93bec0baf1de 436 /* Mask the CLOCK_TAIL field and returns the value */
Wolfgang Betz 67:93bec0baf1de 437 return ((ExtraClockCycles)(tempRegValue & 0x60));
Wolfgang Betz 67:93bec0baf1de 438
Wolfgang Betz 67:93bec0baf1de 439 }
Wolfgang Betz 67:93bec0baf1de 440
Wolfgang Betz 67:93bec0baf1de 441
Wolfgang Betz 67:93bec0baf1de 442 /**
Wolfgang Betz 67:93bec0baf1de 443 * @}
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
Wolfgang Betz 67:93bec0baf1de 451
Wolfgang Betz 67:93bec0baf1de 452 /**
Wolfgang Betz 67:93bec0baf1de 453 * @}
Wolfgang Betz 67:93bec0baf1de 454 */
Wolfgang Betz 67:93bec0baf1de 455
Wolfgang Betz 67:93bec0baf1de 456
Wolfgang Betz 67:93bec0baf1de 457
Wolfgang Betz 67:93bec0baf1de 458 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/