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_Gpio.h
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 This file provides all the low level API to manage SPIRIT GPIO.
Wolfgang Betz 0:4fb29d9ee571 8 *
Wolfgang Betz 0:4fb29d9ee571 9 * @details
Wolfgang Betz 0:4fb29d9ee571 10 *
Wolfgang Betz 0:4fb29d9ee571 11 * This module can be used to configure the Spirit GPIO pins to perform
Wolfgang Betz 0:4fb29d9ee571 12 * specific functions.
Wolfgang Betz 0:4fb29d9ee571 13 * The structure <i>@ref gpioIRQ</i> can be used to specify these features for
Wolfgang Betz 0:4fb29d9ee571 14 * one of the four Spirit Gpio pin.
Wolfgang Betz 0:4fb29d9ee571 15 * The following example shows how to configure a pin (GPIO 3) to be used as an IRQ source
Wolfgang Betz 0:4fb29d9ee571 16 * for a microcontroller using the <i>@ref SpiritGpioInit()</i> function.
Wolfgang Betz 0:4fb29d9ee571 17 *
Wolfgang Betz 0:4fb29d9ee571 18 * <b>Example:</b>
Wolfgang Betz 0:4fb29d9ee571 19 * @code
Wolfgang Betz 0:4fb29d9ee571 20 *
Wolfgang Betz 0:4fb29d9ee571 21 * SGpioInit gpioIRQ={
Wolfgang Betz 0:4fb29d9ee571 22 * SPIRIT_GPIO_3,
Wolfgang Betz 0:4fb29d9ee571 23 * SPIRIT_GPIO_MODE_DIGITAL_OUTPUT_LP,
Wolfgang Betz 0:4fb29d9ee571 24 * SPIRIT_GPIO_DIG_OUT_IRQ
Wolfgang Betz 0:4fb29d9ee571 25 * };
Wolfgang Betz 0:4fb29d9ee571 26 *
Wolfgang Betz 0:4fb29d9ee571 27 * ...
Wolfgang Betz 0:4fb29d9ee571 28 *
Wolfgang Betz 0:4fb29d9ee571 29 * SpiritGpioInit(&gpioIRQ);
Wolfgang Betz 0:4fb29d9ee571 30 *
Wolfgang Betz 0:4fb29d9ee571 31 * @endcode
Wolfgang Betz 0:4fb29d9ee571 32 *
Wolfgang Betz 0:4fb29d9ee571 33 * @note Please read the functions documentation for the other GPIO features.
Wolfgang Betz 0:4fb29d9ee571 34 *
Wolfgang Betz 0:4fb29d9ee571 35 *
Wolfgang Betz 0:4fb29d9ee571 36 * @attention
Wolfgang Betz 0:4fb29d9ee571 37 *
Wolfgang Betz 0:4fb29d9ee571 38 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 0:4fb29d9ee571 39 *
Wolfgang Betz 0:4fb29d9ee571 40 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 0:4fb29d9ee571 41 * are permitted provided that the following conditions are met:
Wolfgang Betz 0:4fb29d9ee571 42 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 0:4fb29d9ee571 43 * this list of conditions and the following disclaimer.
Wolfgang Betz 0:4fb29d9ee571 44 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 0:4fb29d9ee571 45 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 0:4fb29d9ee571 46 * and/or other materials provided with the distribution.
Wolfgang Betz 0:4fb29d9ee571 47 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 0:4fb29d9ee571 48 * may be used to endorse or promote products derived from this software
Wolfgang Betz 0:4fb29d9ee571 49 * without specific prior written permission.
Wolfgang Betz 0:4fb29d9ee571 50 *
Wolfgang Betz 0:4fb29d9ee571 51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 0:4fb29d9ee571 52 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 0:4fb29d9ee571 53 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 0:4fb29d9ee571 54 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 0:4fb29d9ee571 55 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 0:4fb29d9ee571 56 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 0:4fb29d9ee571 57 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 0:4fb29d9ee571 58 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 0:4fb29d9ee571 59 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 0:4fb29d9ee571 60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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 /* Define to prevent recursive inclusion -------------------------------------*/
Wolfgang Betz 0:4fb29d9ee571 66 #ifndef __SPIRIT_GPIO_H
Wolfgang Betz 0:4fb29d9ee571 67 #define __SPIRIT_GPIO_H
Wolfgang Betz 0:4fb29d9ee571 68
Wolfgang Betz 0:4fb29d9ee571 69
Wolfgang Betz 0:4fb29d9ee571 70 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 0:4fb29d9ee571 71
Wolfgang Betz 0:4fb29d9ee571 72 #include "SPIRIT_Regs.h"
Wolfgang Betz 0:4fb29d9ee571 73 #include "SPIRIT_Types.h"
Wolfgang Betz 0:4fb29d9ee571 74
Wolfgang Betz 0:4fb29d9ee571 75
Wolfgang Betz 0:4fb29d9ee571 76 #ifdef __cplusplus
Wolfgang Betz 0:4fb29d9ee571 77 extern "C" {
Wolfgang Betz 0:4fb29d9ee571 78 #endif
Wolfgang Betz 0:4fb29d9ee571 79
Wolfgang Betz 0:4fb29d9ee571 80
Wolfgang Betz 0:4fb29d9ee571 81 /** @addtogroup SPIRIT_Libraries
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 /** @defgroup SPIRIT_Gpio GPIO
Wolfgang Betz 0:4fb29d9ee571 87 * @brief Configuration and management of SPIRIT GPIO.
Wolfgang Betz 0:4fb29d9ee571 88 * @details See the file <i>@ref SPIRIT_Gpio.h</i> for more details.
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 /** @defgroup Gpio_Exported_Types GPIO Exported Types
Wolfgang Betz 0:4fb29d9ee571 95 * @{
Wolfgang Betz 0:4fb29d9ee571 96 */
Wolfgang Betz 0:4fb29d9ee571 97
Wolfgang Betz 0:4fb29d9ee571 98 /**
Wolfgang Betz 0:4fb29d9ee571 99 * @brief SPIRIT GPIO pin enumeration.
Wolfgang Betz 0:4fb29d9ee571 100 */
Wolfgang Betz 0:4fb29d9ee571 101 typedef enum
Wolfgang Betz 0:4fb29d9ee571 102 {
Wolfgang Betz 0:4fb29d9ee571 103 SPIRIT_GPIO_0 = GPIO0_CONF_BASE, /*!< GPIO_0 selected */
Wolfgang Betz 0:4fb29d9ee571 104 SPIRIT_GPIO_1 = GPIO1_CONF_BASE, /*!< GPIO_1 selected */
Wolfgang Betz 0:4fb29d9ee571 105 SPIRIT_GPIO_2 = GPIO2_CONF_BASE, /*!< GPIO_2 selected */
Wolfgang Betz 0:4fb29d9ee571 106 SPIRIT_GPIO_3 = GPIO3_CONF_BASE /*!< GPIO_3 selected */
Wolfgang Betz 0:4fb29d9ee571 107 }SpiritGpioPin;
Wolfgang Betz 0:4fb29d9ee571 108
Wolfgang Betz 0:4fb29d9ee571 109
Wolfgang Betz 0:4fb29d9ee571 110 #define IS_SPIRIT_GPIO(PIN) ((PIN == SPIRIT_GPIO_0) || \
Wolfgang Betz 0:4fb29d9ee571 111 (PIN == SPIRIT_GPIO_1) || \
Wolfgang Betz 0:4fb29d9ee571 112 (PIN == SPIRIT_GPIO_2) || \
Wolfgang Betz 0:4fb29d9ee571 113 (PIN == SPIRIT_GPIO_3))
Wolfgang Betz 0:4fb29d9ee571 114
Wolfgang Betz 0:4fb29d9ee571 115
Wolfgang Betz 0:4fb29d9ee571 116 /**
Wolfgang Betz 0:4fb29d9ee571 117 * @brief SPIRIT GPIO mode enumeration.
Wolfgang Betz 0:4fb29d9ee571 118 */
Wolfgang Betz 0:4fb29d9ee571 119 typedef enum
Wolfgang Betz 0:4fb29d9ee571 120 {
Wolfgang Betz 0:4fb29d9ee571 121 SPIRIT_GPIO_MODE_DIGITAL_INPUT = 0x01, /*!< Digital Input on GPIO */
Wolfgang Betz 0:4fb29d9ee571 122 SPIRIT_GPIO_MODE_DIGITAL_OUTPUT_LP = 0x02, /*!< Digital Output on GPIO (low current) */
Wolfgang Betz 0:4fb29d9ee571 123 SPIRIT_GPIO_MODE_DIGITAL_OUTPUT_HP = 0x03 /*!< Digital Output on GPIO (high current) */
Wolfgang Betz 0:4fb29d9ee571 124 }SpiritGpioMode;
Wolfgang Betz 0:4fb29d9ee571 125
Wolfgang Betz 0:4fb29d9ee571 126 #define IS_SPIRIT_GPIO_MODE(MODE) ((MODE == SPIRIT_GPIO_MODE_DIGITAL_INPUT) || \
Wolfgang Betz 0:4fb29d9ee571 127 (MODE == SPIRIT_GPIO_MODE_DIGITAL_OUTPUT_LP) || \
Wolfgang Betz 0:4fb29d9ee571 128 (MODE == SPIRIT_GPIO_MODE_DIGITAL_OUTPUT_HP))
Wolfgang Betz 0:4fb29d9ee571 129
Wolfgang Betz 0:4fb29d9ee571 130
Wolfgang Betz 0:4fb29d9ee571 131
Wolfgang Betz 0:4fb29d9ee571 132 /**
Wolfgang Betz 0:4fb29d9ee571 133 * @brief SPIRIT I/O selection enumeration.
Wolfgang Betz 0:4fb29d9ee571 134 */
Wolfgang Betz 0:4fb29d9ee571 135 typedef enum
Wolfgang Betz 0:4fb29d9ee571 136 {
Wolfgang Betz 0:4fb29d9ee571 137 SPIRIT_GPIO_DIG_OUT_IRQ = 0x00, /*!< nIRQ (Interrupt Request, active low) , default configuration after POR */
Wolfgang Betz 0:4fb29d9ee571 138 SPIRIT_GPIO_DIG_OUT_POR_INV = 0x08, /*!< POR inverted (active low) */
Wolfgang Betz 0:4fb29d9ee571 139 SPIRIT_GPIO_DIG_OUT_WUT_EXP = 0x10, /*!< Wake-Up Timer expiration: "1" when WUT has expired */
Wolfgang Betz 0:4fb29d9ee571 140 SPIRIT_GPIO_DIG_OUT_LBD = 0x18, /*!< Low battery detection: "1" when battery is below threshold setting */
Wolfgang Betz 0:4fb29d9ee571 141 SPIRIT_GPIO_DIG_OUT_TX_DATA = 0x20, /*!< TX data internal clock output (TX data are sampled on the rising edge of it) */
Wolfgang Betz 0:4fb29d9ee571 142 SPIRIT_GPIO_DIG_OUT_TX_STATE = 0x28, /*!< TX state indication: "1" when Spirit1 is passing in the TX state */
Wolfgang Betz 0:4fb29d9ee571 143 SPIRIT_GPIO_DIG_OUT_TX_FIFO_ALMOST_EMPTY = 0x30, /*!< TX FIFO Almost Empty Flag */
Wolfgang Betz 0:4fb29d9ee571 144 SPIRIT_GPIO_DIG_OUT_TX_FIFO_ALMOST_FULL = 0x38, /*!< TX FIFO Almost Full Flag */
Wolfgang Betz 0:4fb29d9ee571 145 SPIRIT_GPIO_DIG_OUT_RX_DATA = 0x40, /*!< RX data output */
Wolfgang Betz 0:4fb29d9ee571 146 SPIRIT_GPIO_DIG_OUT_RX_CLOCK = 0x48, /*!< RX clock output (recovered from received data) */
Wolfgang Betz 0:4fb29d9ee571 147 SPIRIT_GPIO_DIG_OUT_RX_STATE = 0x50, /*!< RX state indication: "1" when Spirit1 is passing in the RX state */
Wolfgang Betz 0:4fb29d9ee571 148 SPIRIT_GPIO_DIG_OUT_RX_FIFO_ALMOST_FULL = 0x58, /*!< RX FIFO Almost Full Flag */
Wolfgang Betz 0:4fb29d9ee571 149 SPIRIT_GPIO_DIG_OUT_RX_FIFO_ALMOST_EMPTY = 0x60, /*!< RX FIFO Almost Empty Flag */
Wolfgang Betz 0:4fb29d9ee571 150 SPIRIT_GPIO_DIG_OUT_ANTENNA_SWITCH = 0x68, /*!< Antenna switch used for antenna diversity */
Wolfgang Betz 0:4fb29d9ee571 151 SPIRIT_GPIO_DIG_OUT_VALID_PREAMBLE = 0x70, /*!< Valid Preamble Detected Flag */
Wolfgang Betz 0:4fb29d9ee571 152 SPIRIT_GPIO_DIG_OUT_SYNC_DETECTED = 0x78, /*!< Sync WordSync Word Detected Flag */
Wolfgang Betz 0:4fb29d9ee571 153 SPIRIT_GPIO_DIG_OUT_RSSI_THRESHOLD = 0x80, /*!< RSSI above threshold */
Wolfgang Betz 0:4fb29d9ee571 154 SPIRIT_GPIO_DIG_OUT_MCU_CLOCK = 0x88, /*!< MCU Clock */
Wolfgang Betz 0:4fb29d9ee571 155 SPIRIT_GPIO_DIG_OUT_TX_RX_MODE = 0x90, /*!< TX or RX mode indicator (to enable an external range extender) */
Wolfgang Betz 0:4fb29d9ee571 156 SPIRIT_GPIO_DIG_OUT_VDD = 0x98, /*!< VDD (to emulate an additional GPIO of the MCU, programmable by SPI) */
Wolfgang Betz 0:4fb29d9ee571 157 SPIRIT_GPIO_DIG_OUT_GND = 0xA0, /*!< GND (to emulate an additional GPIO of the MCU, programmable by SPI) */
Wolfgang Betz 0:4fb29d9ee571 158 SPIRIT_GPIO_DIG_OUT_SMPS_EXT = 0xA8, /*!< External SMPS enable signal (active high) */
Wolfgang Betz 0:4fb29d9ee571 159 SPIRIT_GPIO_DIG_OUT_SLEEP_OR_STANDBY = 0xB0,
Wolfgang Betz 0:4fb29d9ee571 160 SPIRIT_GPIO_DIG_OUT_READY = 0xB8,
Wolfgang Betz 0:4fb29d9ee571 161 SPIRIT_GPIO_DIG_OUT_LOCK = 0xC0,
Wolfgang Betz 0:4fb29d9ee571 162 SPIRIT_GPIO_DIG_OUT_WAIT_FOR_LOCK_SIG = 0xC8,
Wolfgang Betz 0:4fb29d9ee571 163 SPIRIT_GPIO_DIG_OUT_WAIT_FOR_TIMER_FOR_LOCK = 0xD0,
Wolfgang Betz 0:4fb29d9ee571 164 SPIRIT_GPIO_DIG_OUT_WAIT_FOR_READY2_SIG = 0xD8,
Wolfgang Betz 0:4fb29d9ee571 165 SPIRIT_GPIO_DIG_OUT_WAIT_FOR_TIMER_FOR_PM_SET = 0xE0,
Wolfgang Betz 0:4fb29d9ee571 166 SPIRIT_GPIO_DIG_OUT_WAIT_VCO_CALIBRATION = 0xE8,
Wolfgang Betz 0:4fb29d9ee571 167 SPIRIT_GPIO_DIG_OUT_ENABLE_SYNTH_FULL_CIRCUIT = 0xF0,
Wolfgang Betz 0:4fb29d9ee571 168 SPIRIT_GPIO_DIG_OUT_WAIT_FOR_RCCAL_OK_SIG = 0xFF,
Wolfgang Betz 0:4fb29d9ee571 169
Wolfgang Betz 0:4fb29d9ee571 170 SPIRIT_GPIO_DIG_IN_TX_COMMAND = 0x00,
Wolfgang Betz 0:4fb29d9ee571 171 SPIRIT_GPIO_DIG_IN_RX_COMMAND = 0x08,
Wolfgang Betz 0:4fb29d9ee571 172 SPIRIT_GPIO_DIG_IN_TX_DATA_INPUT_FOR_DIRECTRF = 0x10,
Wolfgang Betz 0:4fb29d9ee571 173 SPIRIT_GPIO_DIG_IN_DATA_WAKEUP = 0x18,
Wolfgang Betz 0:4fb29d9ee571 174 SPIRIT_GPIO_DIG_IN_EXT_CLOCK_AT_34_7KHZ = 0x20
Wolfgang Betz 0:4fb29d9ee571 175
Wolfgang Betz 0:4fb29d9ee571 176 }SpiritGpioIO;
Wolfgang Betz 0:4fb29d9ee571 177
Wolfgang Betz 0:4fb29d9ee571 178 #define IS_SPIRIT_GPIO_IO(IO_SEL) ((IO_SEL == SPIRIT_GPIO_DIG_OUT_IRQ) || \
Wolfgang Betz 0:4fb29d9ee571 179 (IO_SEL == SPIRIT_GPIO_DIG_OUT_POR_INV) || \
Wolfgang Betz 0:4fb29d9ee571 180 (IO_SEL == SPIRIT_GPIO_DIG_OUT_WUT_EXP) || \
Wolfgang Betz 0:4fb29d9ee571 181 (IO_SEL == SPIRIT_GPIO_DIG_OUT_LBD) || \
Wolfgang Betz 0:4fb29d9ee571 182 (IO_SEL == SPIRIT_GPIO_DIG_OUT_TX_DATA) || \
Wolfgang Betz 0:4fb29d9ee571 183 (IO_SEL == SPIRIT_GPIO_DIG_OUT_TX_STATE) || \
Wolfgang Betz 0:4fb29d9ee571 184 (IO_SEL == SPIRIT_GPIO_DIG_OUT_TX_FIFO_ALMOST_EMPTY) || \
Wolfgang Betz 0:4fb29d9ee571 185 (IO_SEL == SPIRIT_GPIO_DIG_OUT_TX_FIFO_ALMOST_FULL) || \
Wolfgang Betz 0:4fb29d9ee571 186 (IO_SEL == SPIRIT_GPIO_DIG_OUT_RX_DATA) || \
Wolfgang Betz 0:4fb29d9ee571 187 (IO_SEL == SPIRIT_GPIO_DIG_OUT_RX_CLOCK) || \
Wolfgang Betz 0:4fb29d9ee571 188 (IO_SEL == SPIRIT_GPIO_DIG_OUT_RX_STATE) || \
Wolfgang Betz 0:4fb29d9ee571 189 (IO_SEL == SPIRIT_GPIO_DIG_OUT_RX_FIFO_ALMOST_FULL) || \
Wolfgang Betz 0:4fb29d9ee571 190 (IO_SEL == SPIRIT_GPIO_DIG_OUT_RX_FIFO_ALMOST_EMPTY) || \
Wolfgang Betz 0:4fb29d9ee571 191 (IO_SEL == SPIRIT_GPIO_DIG_OUT_ANTENNA_SWITCH) || \
Wolfgang Betz 0:4fb29d9ee571 192 (IO_SEL == SPIRIT_GPIO_DIG_OUT_VALID_PREAMBLE) || \
Wolfgang Betz 0:4fb29d9ee571 193 (IO_SEL == SPIRIT_GPIO_DIG_OUT_SYNC_DETECTED) || \
Wolfgang Betz 0:4fb29d9ee571 194 (IO_SEL == SPIRIT_GPIO_DIG_OUT_RSSI_THRESHOLD) || \
Wolfgang Betz 0:4fb29d9ee571 195 (IO_SEL == SPIRIT_GPIO_DIG_OUT_MCU_CLOCK) || \
Wolfgang Betz 0:4fb29d9ee571 196 (IO_SEL == SPIRIT_GPIO_DIG_OUT_TX_RX_MODE) || \
Wolfgang Betz 0:4fb29d9ee571 197 (IO_SEL == SPIRIT_GPIO_DIG_OUT_VDD) || \
Wolfgang Betz 0:4fb29d9ee571 198 (IO_SEL == SPIRIT_GPIO_DIG_OUT_GND) || \
Wolfgang Betz 0:4fb29d9ee571 199 (IO_SEL == SPIRIT_GPIO_DIG_OUT_SMPS_EXT) ||\
Wolfgang Betz 0:4fb29d9ee571 200 (IO_SEL == SPIRIT_GPIO_DIG_OUT_SLEEP_OR_STANDBY) ||\
Wolfgang Betz 0:4fb29d9ee571 201 (IO_SEL == SPIRIT_GPIO_DIG_OUT_READY) ||\
Wolfgang Betz 0:4fb29d9ee571 202 (IO_SEL == SPIRIT_GPIO_DIG_OUT_LOCK) ||\
Wolfgang Betz 0:4fb29d9ee571 203 (IO_SEL == SPIRIT_GPIO_DIG_OUT_WAIT_FOR_LOCK_SIG) ||\
Wolfgang Betz 0:4fb29d9ee571 204 (IO_SEL == SPIRIT_GPIO_DIG_OUT_WAIT_FOR_TIMER_FOR_LOCK) ||\
Wolfgang Betz 0:4fb29d9ee571 205 (IO_SEL == SPIRIT_GPIO_DIG_OUT_WAIT_FOR_READY2_SIG) ||\
Wolfgang Betz 0:4fb29d9ee571 206 (IO_SEL == SPIRIT_GPIO_DIG_OUT_WAIT_FOR_TIMER_FOR_PM_SET) ||\
Wolfgang Betz 0:4fb29d9ee571 207 (IO_SEL == SPIRIT_GPIO_DIG_OUT_WAIT_VCO_CALIBRATION) ||\
Wolfgang Betz 0:4fb29d9ee571 208 (IO_SEL == SPIRIT_GPIO_DIG_OUT_ENABLE_SYNTH_FULL_CIRCUIT) ||\
Wolfgang Betz 0:4fb29d9ee571 209 (IO_SEL == SPIRIT_GPIO_DIG_OUT_WAIT_FOR_RCCAL_OK_SIG) ||\
Wolfgang Betz 0:4fb29d9ee571 210 (IO_SEL == SPIRIT_GPIO_DIG_IN_TX_COMMAND) ||\
Wolfgang Betz 0:4fb29d9ee571 211 (IO_SEL == SPIRIT_GPIO_DIG_IN_RX_COMMAND) ||\
Wolfgang Betz 0:4fb29d9ee571 212 (IO_SEL == SPIRIT_GPIO_DIG_IN_TX_DATA_INPUT_FOR_DIRECTRF) ||\
Wolfgang Betz 0:4fb29d9ee571 213 (IO_SEL == SPIRIT_GPIO_DIG_IN_DATA_WAKEUP) ||\
Wolfgang Betz 0:4fb29d9ee571 214 (IO_SEL == SPIRIT_GPIO_DIG_IN_EXT_CLOCK_AT_34_7KHZ))
Wolfgang Betz 0:4fb29d9ee571 215
Wolfgang Betz 0:4fb29d9ee571 216 /**
Wolfgang Betz 0:4fb29d9ee571 217 * @brief SPIRIT OutputLevel enumeration.
Wolfgang Betz 0:4fb29d9ee571 218 */
Wolfgang Betz 0:4fb29d9ee571 219
Wolfgang Betz 0:4fb29d9ee571 220 typedef enum
Wolfgang Betz 0:4fb29d9ee571 221 {
Wolfgang Betz 0:4fb29d9ee571 222 LOW = 0,
Wolfgang Betz 0:4fb29d9ee571 223 HIGH = !LOW
Wolfgang Betz 0:4fb29d9ee571 224 }OutputLevel;
Wolfgang Betz 0:4fb29d9ee571 225
Wolfgang Betz 0:4fb29d9ee571 226 #define IS_SPIRIT_GPIO_LEVEL(LEVEL) ((LEVEL == LOW) || \
Wolfgang Betz 0:4fb29d9ee571 227 (LEVEL == HIGH))
Wolfgang Betz 0:4fb29d9ee571 228
Wolfgang Betz 0:4fb29d9ee571 229
Wolfgang Betz 0:4fb29d9ee571 230 /**
Wolfgang Betz 0:4fb29d9ee571 231 * @brief SPIRIT GPIO Init structure definition.
Wolfgang Betz 0:4fb29d9ee571 232 */
Wolfgang Betz 0:4fb29d9ee571 233 typedef struct
Wolfgang Betz 0:4fb29d9ee571 234 {
Wolfgang Betz 0:4fb29d9ee571 235 SpiritGpioPin xSpiritGpioPin; /*!< Specifies the GPIO pins to be configured.
Wolfgang Betz 0:4fb29d9ee571 236 This parameter can be any value of @ref SpiritGpioPin */
Wolfgang Betz 0:4fb29d9ee571 237
Wolfgang Betz 0:4fb29d9ee571 238 SpiritGpioMode xSpiritGpioMode; /*!< Specifies the operating mode for the selected pins.
Wolfgang Betz 0:4fb29d9ee571 239 This parameter can be a value of @ref SpiritGpioMode */
Wolfgang Betz 0:4fb29d9ee571 240
Wolfgang Betz 0:4fb29d9ee571 241 SpiritGpioIO xSpiritGpioIO; /*!< Specifies the I/O selection for the selected pins.
Wolfgang Betz 0:4fb29d9ee571 242 This parameter can be a value of @ref SpiritGpioIO */
Wolfgang Betz 0:4fb29d9ee571 243
Wolfgang Betz 0:4fb29d9ee571 244 }SGpioInit;
Wolfgang Betz 0:4fb29d9ee571 245
Wolfgang Betz 0:4fb29d9ee571 246
Wolfgang Betz 0:4fb29d9ee571 247
Wolfgang Betz 0:4fb29d9ee571 248 /**
Wolfgang Betz 0:4fb29d9ee571 249 * @brief SPIRIT clock output XO prescaler enumeration.
Wolfgang Betz 0:4fb29d9ee571 250 */
Wolfgang Betz 0:4fb29d9ee571 251
Wolfgang Betz 0:4fb29d9ee571 252 typedef enum
Wolfgang Betz 0:4fb29d9ee571 253 {
Wolfgang Betz 0:4fb29d9ee571 254 XO_RATIO_1 = 0x00, /*!< XO Clock signal available on the GPIO divided by 1 */
Wolfgang Betz 0:4fb29d9ee571 255 XO_RATIO_2_3 = 0x02, /*!< XO Clock signal available on the GPIO divided by 2/3 */
Wolfgang Betz 0:4fb29d9ee571 256 XO_RATIO_1_2 = 0x04, /*!< XO Clock signal available on the GPIO divided by 1/2 */
Wolfgang Betz 0:4fb29d9ee571 257 XO_RATIO_1_3 = 0x06, /*!< XO Clock signal available on the GPIO divided by 1/3 */
Wolfgang Betz 0:4fb29d9ee571 258 XO_RATIO_1_4 = 0x08, /*!< XO Clock signal available on the GPIO divided by 1/4 */
Wolfgang Betz 0:4fb29d9ee571 259 XO_RATIO_1_6 = 0x0A, /*!< XO Clock signal available on the GPIO divided by 1/6 */
Wolfgang Betz 0:4fb29d9ee571 260 XO_RATIO_1_8 = 0x0C, /*!< XO Clock signal available on the GPIO divided by 1/8 */
Wolfgang Betz 0:4fb29d9ee571 261 XO_RATIO_1_12 = 0x0E, /*!< XO Clock signal available on the GPIO divided by 1/12 */
Wolfgang Betz 0:4fb29d9ee571 262 XO_RATIO_1_16 = 0x10, /*!< XO Clock signal available on the GPIO divided by 1/16 */
Wolfgang Betz 0:4fb29d9ee571 263 XO_RATIO_1_24 = 0x12, /*!< XO Clock signal available on the GPIO divided by 1/24 */
Wolfgang Betz 0:4fb29d9ee571 264 XO_RATIO_1_36 = 0x14, /*!< XO Clock signal available on the GPIO divided by 1/36 */
Wolfgang Betz 0:4fb29d9ee571 265 XO_RATIO_1_48 = 0x16, /*!< XO Clock signal available on the GPIO divided by 1/48 */
Wolfgang Betz 0:4fb29d9ee571 266 XO_RATIO_1_64 = 0x18, /*!< XO Clock signal available on the GPIO divided by 1/64 */
Wolfgang Betz 0:4fb29d9ee571 267 XO_RATIO_1_96 = 0x1A, /*!< XO Clock signal available on the GPIO divided by 1/96 */
Wolfgang Betz 0:4fb29d9ee571 268 XO_RATIO_1_128 = 0x1C, /*!< XO Clock signal available on the GPIO divided by 1/128 */
Wolfgang Betz 0:4fb29d9ee571 269 XO_RATIO_1_192 = 0x1E /*!< XO Clock signal available on the GPIO divided by 1/196 */
Wolfgang Betz 0:4fb29d9ee571 270 }ClockOutputXOPrescaler;
Wolfgang Betz 0:4fb29d9ee571 271
Wolfgang Betz 0:4fb29d9ee571 272 #define IS_SPIRIT_CLOCK_OUTPUT_XO(RATIO) ((RATIO == XO_RATIO_1) || \
Wolfgang Betz 0:4fb29d9ee571 273 (RATIO == XO_RATIO_2_3) || \
Wolfgang Betz 0:4fb29d9ee571 274 (RATIO == XO_RATIO_1_2) || \
Wolfgang Betz 0:4fb29d9ee571 275 (RATIO == XO_RATIO_1_3) || \
Wolfgang Betz 0:4fb29d9ee571 276 (RATIO == XO_RATIO_1_4) || \
Wolfgang Betz 0:4fb29d9ee571 277 (RATIO == XO_RATIO_1_6) || \
Wolfgang Betz 0:4fb29d9ee571 278 (RATIO == XO_RATIO_1_8) || \
Wolfgang Betz 0:4fb29d9ee571 279 (RATIO == XO_RATIO_1_12) || \
Wolfgang Betz 0:4fb29d9ee571 280 (RATIO == XO_RATIO_1_16) || \
Wolfgang Betz 0:4fb29d9ee571 281 (RATIO == XO_RATIO_1_24) || \
Wolfgang Betz 0:4fb29d9ee571 282 (RATIO == XO_RATIO_1_36) || \
Wolfgang Betz 0:4fb29d9ee571 283 (RATIO == XO_RATIO_1_48) || \
Wolfgang Betz 0:4fb29d9ee571 284 (RATIO == XO_RATIO_1_64) || \
Wolfgang Betz 0:4fb29d9ee571 285 (RATIO == XO_RATIO_1_96) || \
Wolfgang Betz 0:4fb29d9ee571 286 (RATIO == XO_RATIO_1_128) || \
Wolfgang Betz 0:4fb29d9ee571 287 (RATIO == XO_RATIO_1_192))
Wolfgang Betz 0:4fb29d9ee571 288
Wolfgang Betz 0:4fb29d9ee571 289 /**
Wolfgang Betz 0:4fb29d9ee571 290 * @brief SPIRIT Clock Output RCO prescaler enumeration.
Wolfgang Betz 0:4fb29d9ee571 291 */
Wolfgang Betz 0:4fb29d9ee571 292
Wolfgang Betz 0:4fb29d9ee571 293 typedef enum
Wolfgang Betz 0:4fb29d9ee571 294 {
Wolfgang Betz 0:4fb29d9ee571 295 RCO_RATIO_1 = 0x00, /*!< RCO Clock signal available on the GPIO divided by 1 */
Wolfgang Betz 0:4fb29d9ee571 296 RCO_RATIO_1_128 = 0x01 /*!< RCO Clock signal available on the GPIO divided by 1/128 */
Wolfgang Betz 0:4fb29d9ee571 297 }ClockOutputRCOPrescaler;
Wolfgang Betz 0:4fb29d9ee571 298
Wolfgang Betz 0:4fb29d9ee571 299 #define IS_SPIRIT_CLOCK_OUTPUT_RCO(RATIO) ((RATIO == RCO_RATIO_1) || \
Wolfgang Betz 0:4fb29d9ee571 300 (RATIO == RCO_RATIO_1_128))
Wolfgang Betz 0:4fb29d9ee571 301
Wolfgang Betz 0:4fb29d9ee571 302 /**
Wolfgang Betz 0:4fb29d9ee571 303 * @brief SPIRIT ExtraClockCycles enumeration.
Wolfgang Betz 0:4fb29d9ee571 304 */
Wolfgang Betz 0:4fb29d9ee571 305
Wolfgang Betz 0:4fb29d9ee571 306 typedef enum
Wolfgang Betz 0:4fb29d9ee571 307 {
Wolfgang Betz 0:4fb29d9ee571 308 EXTRA_CLOCK_CYCLES_0 = 0x00, /*!< 0 extra clock cycles provided to the MCU before switching to STANDBY state */
Wolfgang Betz 0:4fb29d9ee571 309 EXTRA_CLOCK_CYCLES_64 = 0x20, /*!< 64 extra clock cycles provided to the MCU before switching to STANDBY state */
Wolfgang Betz 0:4fb29d9ee571 310 EXTRA_CLOCK_CYCLES_256 = 0x40, /*!< 256 extra clock cycles provided to the MCU before switching to STANDBY state */
Wolfgang Betz 0:4fb29d9ee571 311 EXTRA_CLOCK_CYCLES_512 = 0x60 /*!< 512 extra clock cycles provided to the MCU before switching to STANDBY state */
Wolfgang Betz 0:4fb29d9ee571 312 }ExtraClockCycles;
Wolfgang Betz 0:4fb29d9ee571 313
Wolfgang Betz 0:4fb29d9ee571 314 #define IS_SPIRIT_CLOCK_OUTPUT_EXTRA_CYCLES(CYCLES) ((CYCLES == EXTRA_CLOCK_CYCLES_0) || \
Wolfgang Betz 0:4fb29d9ee571 315 (CYCLES == EXTRA_CLOCK_CYCLES_64) || \
Wolfgang Betz 0:4fb29d9ee571 316 (CYCLES == EXTRA_CLOCK_CYCLES_256) || \
Wolfgang Betz 0:4fb29d9ee571 317 (CYCLES == EXTRA_CLOCK_CYCLES_512))
Wolfgang Betz 0:4fb29d9ee571 318
Wolfgang Betz 0:4fb29d9ee571 319
Wolfgang Betz 0:4fb29d9ee571 320 /**
Wolfgang Betz 0:4fb29d9ee571 321 * @brief SPIRIT Clock Output initialization structure definition.
Wolfgang Betz 0:4fb29d9ee571 322 */
Wolfgang Betz 0:4fb29d9ee571 323 typedef struct
Wolfgang Betz 0:4fb29d9ee571 324 {
Wolfgang Betz 0:4fb29d9ee571 325 ClockOutputXOPrescaler xClockOutputXOPrescaler; /*!< Specifies the XO Ratio as clock output.
Wolfgang Betz 0:4fb29d9ee571 326 This parameter can be any value of @ref ClockOutputXOPrescaler */
Wolfgang Betz 0:4fb29d9ee571 327
Wolfgang Betz 0:4fb29d9ee571 328 ClockOutputRCOPrescaler xClockOutputRCOPrescaler; /*!< Specifies the RCO Ratio as clock output.
Wolfgang Betz 0:4fb29d9ee571 329 This parameter can be a value of @ref ClockOutputRCOPrescaler */
Wolfgang Betz 0:4fb29d9ee571 330
Wolfgang Betz 0:4fb29d9ee571 331 ExtraClockCycles xExtraClockCycles; /*!< Specifies the Extra Clock Cycles provided before entering in Standby State.
Wolfgang Betz 0:4fb29d9ee571 332 This parameter can be a value of @ref ExtraClockCycles */
Wolfgang Betz 0:4fb29d9ee571 333
Wolfgang Betz 0:4fb29d9ee571 334 }ClockOutputInit;
Wolfgang Betz 0:4fb29d9ee571 335
Wolfgang Betz 0:4fb29d9ee571 336
Wolfgang Betz 0:4fb29d9ee571 337
Wolfgang Betz 0:4fb29d9ee571 338 /**
Wolfgang Betz 0:4fb29d9ee571 339 * @}
Wolfgang Betz 0:4fb29d9ee571 340 */
Wolfgang Betz 0:4fb29d9ee571 341
Wolfgang Betz 0:4fb29d9ee571 342
Wolfgang Betz 0:4fb29d9ee571 343
Wolfgang Betz 0:4fb29d9ee571 344 /** @defgroup Gpio_Exported_Constants GPIO Exported Constants
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 /**
Wolfgang Betz 0:4fb29d9ee571 350 * @}
Wolfgang Betz 0:4fb29d9ee571 351 */
Wolfgang Betz 0:4fb29d9ee571 352
Wolfgang Betz 0:4fb29d9ee571 353
Wolfgang Betz 0:4fb29d9ee571 354
Wolfgang Betz 0:4fb29d9ee571 355 /** @defgroup Gpio_Exported_Macros GPIO Exported Macros
Wolfgang Betz 0:4fb29d9ee571 356 * @{
Wolfgang Betz 0:4fb29d9ee571 357 */
Wolfgang Betz 0:4fb29d9ee571 358
Wolfgang Betz 0:4fb29d9ee571 359
Wolfgang Betz 0:4fb29d9ee571 360 /**
Wolfgang Betz 0:4fb29d9ee571 361 * @}
Wolfgang Betz 0:4fb29d9ee571 362 */
Wolfgang Betz 0:4fb29d9ee571 363
Wolfgang Betz 0:4fb29d9ee571 364
Wolfgang Betz 0:4fb29d9ee571 365
Wolfgang Betz 0:4fb29d9ee571 366 /** @defgroup Gpio_Exported_Functions GPIO Exported Functions
Wolfgang Betz 0:4fb29d9ee571 367 * @{
Wolfgang Betz 0:4fb29d9ee571 368 */
Wolfgang Betz 0:4fb29d9ee571 369
Wolfgang Betz 0:4fb29d9ee571 370 void SpiritGpioInit(SGpioInit* pxGpioInitStruct);
Wolfgang Betz 0:4fb29d9ee571 371 void SpiritGpioTemperatureSensor(SpiritFunctionalState xNewState);
Wolfgang Betz 0:4fb29d9ee571 372 void SpiritGpioSetLevel(SpiritGpioPin xGpioX, OutputLevel xLevel);
Wolfgang Betz 0:4fb29d9ee571 373 OutputLevel SpiritGpioGetLevel(SpiritGpioPin xGpioX);
Wolfgang Betz 0:4fb29d9ee571 374 void SpiritGpioClockOutput(SpiritFunctionalState xNewState);
Wolfgang Betz 0:4fb29d9ee571 375 void SpiritGpioClockOutputInit(ClockOutputInit* pxClockOutputInitStruct);
Wolfgang Betz 0:4fb29d9ee571 376 void SpiritGpioSetXOPrescaler(ClockOutputXOPrescaler xXOPrescaler);
Wolfgang Betz 0:4fb29d9ee571 377 ClockOutputXOPrescaler SpiritGpioGetXOPrescaler(void);
Wolfgang Betz 0:4fb29d9ee571 378 void SpiritGpioSetRCOPrescaler(ClockOutputRCOPrescaler xRCOPrescaler);
Wolfgang Betz 0:4fb29d9ee571 379 ClockOutputRCOPrescaler SpiritGpioGetRCOPrescaler(void);
Wolfgang Betz 0:4fb29d9ee571 380 void SpiritGpioSetExtraClockCycles(ExtraClockCycles xExtraCycles);
Wolfgang Betz 0:4fb29d9ee571 381 ExtraClockCycles SpiritGpioGetExtraClockCycles(void);
Wolfgang Betz 0:4fb29d9ee571 382
Wolfgang Betz 0:4fb29d9ee571 383
Wolfgang Betz 0:4fb29d9ee571 384 /**
Wolfgang Betz 0:4fb29d9ee571 385 * @}
Wolfgang Betz 0:4fb29d9ee571 386 */
Wolfgang Betz 0:4fb29d9ee571 387
Wolfgang Betz 0:4fb29d9ee571 388 /**
Wolfgang Betz 0:4fb29d9ee571 389 * @}
Wolfgang Betz 0:4fb29d9ee571 390 */
Wolfgang Betz 0:4fb29d9ee571 391
Wolfgang Betz 0:4fb29d9ee571 392
Wolfgang Betz 0:4fb29d9ee571 393 /**
Wolfgang Betz 0:4fb29d9ee571 394 * @}
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 #ifdef __cplusplus
Wolfgang Betz 0:4fb29d9ee571 400 }
Wolfgang Betz 0:4fb29d9ee571 401 #endif
Wolfgang Betz 0:4fb29d9ee571 402
Wolfgang Betz 0:4fb29d9ee571 403 #endif
Wolfgang Betz 0:4fb29d9ee571 404
Wolfgang Betz 0:4fb29d9ee571 405 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/