Toyomasa Watarai / easy-connect-type-yd

Easily add all supported connectivity methods to your mbed OS project

Dependencies:   type-yd-driver

stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_Gpio.h@0:615f90842ce8, 2017-07-12 (annotated)

Committer:
MACRUM
Date:
Wed Jul 12 10:52:58 2017 +0000
Revision:
0:615f90842ce8
Initial commit

Who changed what in which revision?

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