Jim Flynn / Mbed OS wifi_Example

wifi test

Dependencies:   X_NUCLEO_IKS01A2 mbed-http

easy-connect/stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_Gpio.h@0:24d3eb812fd4, 2018-09-05 (annotated)

Committer:
JMF
Date:
Wed Sep 05 14:28:24 2018 +0000
Revision:
0:24d3eb812fd4
Initial commit

Who changed what in which revision?

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