ST / stm-spirit1-rf-driver

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Prototype RF Driver for STM Sub-1 GHz RF Expansion Boards based on the SPSGRF-868 and SPSGRF-915 Modules for STM32 Nucleo

Currently supported boards:

Note, in order to use expansion board X-NUCLEO-IDS01A4 in mbed you need to perform the following HW modifications on the board:

  • Unmount resistor R4
  • Mount resistor R7

Furthermore, on some Nucleo development boards (e.g. the NUCLEO_F429ZI), in order to be able to use Ethernet together with these Sub-1 GHz RF expansion boards, you need to compile this driver with macro SPIRIT1_SPI_MOSI=PB_5 defined, while the development board typically requires some HW modification as e.g. described here!

This driver can be used together with the 6LoWPAN stack (a.k.a. Nanostack).

source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_Gpio.h@67:93bec0baf1de, 2017-07-06 (annotated)

Committer:
Wolfgang Betz
Date:
Thu Jul 06 11:13:31 2017 +0200
Revision:
67:93bec0baf1de
Parent:
34:edda6a7238ec 
Clarify some comments

Who changed what in which revision?

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