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_Irq.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_Irq.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 Configuration and management of SPIRIT IRQs.
MACRUM 0:615f90842ce8 8 *
MACRUM 0:615f90842ce8 9 * @details
MACRUM 0:615f90842ce8 10 *
MACRUM 0:615f90842ce8 11 * On the Spirit side specific IRQs can be enabled by setting a specific bitmask.
MACRUM 0:615f90842ce8 12 * The Spirit libraries allow the user to do this in two different ways:
MACRUM 0:615f90842ce8 13 * <ul>
MACRUM 0:615f90842ce8 14 *
MACRUM 0:615f90842ce8 15 * <li>The first enables the IRQs one by one, i.e. using an SPI transaction for each
MACRUM 0:615f90842ce8 16 * IRQ to enable.
MACRUM 0:615f90842ce8 17 *
MACRUM 0:615f90842ce8 18 * <b>Example:</b>
MACRUM 0:615f90842ce8 19 * @code
MACRUM 0:615f90842ce8 20 *
MACRUM 0:615f90842ce8 21 * SpiritIrqDeInit(NULL); // this call is used to reset the IRQ mask registers
MACRUM 0:615f90842ce8 22 * SpiritIrq(RX_DATA_READY , S_ENABLE);
MACRUM 0:615f90842ce8 23 * SpiritIrq(VALID_SYNC , S_ENABLE);
MACRUM 0:615f90842ce8 24 * SpiritIrq(RX_TIMEOUT , S_ENABLE);
MACRUM 0:615f90842ce8 25 *
MACRUM 0:615f90842ce8 26 * @endcode
MACRUM 0:615f90842ce8 27 *
MACRUM 0:615f90842ce8 28 * </li>
MACRUM 0:615f90842ce8 29 *
MACRUM 0:615f90842ce8 30 * <li>The second strategy is to set the IRQ bitfields structure. So, during the initialization the user
MACRUM 0:615f90842ce8 31 * has to fill the @ref SpiritIrqs structure setting to one the single field related to the IRQ he
MACRUM 0:615f90842ce8 32 * wants to enable, and to zero the single field related to all the IRQs he wants to disable.
MACRUM 0:615f90842ce8 33 *
MACRUM 0:615f90842ce8 34 * <b>Example:</b>
MACRUM 0:615f90842ce8 35 * @code
MACRUM 0:615f90842ce8 36 *
MACRUM 0:615f90842ce8 37 * SpiritIrqs irqMask;
MACRUM 0:615f90842ce8 38 *
MACRUM 0:615f90842ce8 39 * ...
MACRUM 0:615f90842ce8 40 *
MACRUM 0:615f90842ce8 41 * SpiritIrqDeInit(&irqMask); // this call is used to reset the IRQ mask registers
MACRUM 0:615f90842ce8 42 * // and to set to 0x00000000 the irq mask in order to disable
MACRUM 0:615f90842ce8 43 * // all IRQs (disabled by default on startup)
MACRUM 0:615f90842ce8 44 * irqMask.IRQ_RX_DATA_READY = 1;
MACRUM 0:615f90842ce8 45 * irqMask.IRQ_VALID_SYNC = 1;
MACRUM 0:615f90842ce8 46 * irqMask.IRQ_RX_TIMEOUT = 1;
MACRUM 0:615f90842ce8 47 *
MACRUM 0:615f90842ce8 48 * ...
MACRUM 0:615f90842ce8 49 * @endcode
MACRUM 0:615f90842ce8 50 * </li>
MACRUM 0:615f90842ce8 51 * </ul>
MACRUM 0:615f90842ce8 52 *
MACRUM 0:615f90842ce8 53 * The most applications will require a Spirit IRQ notification on an microcontroller EXTI line.
MACRUM 0:615f90842ce8 54 * Then, the user can check which IRQ has been raised using two different ways.
MACRUM 0:615f90842ce8 55 *
MACRUM 0:615f90842ce8 56 * On the ISR of the EXTI line phisically linked to the Spirit pin configured for IRQ:
MACRUM 0:615f90842ce8 57 *
MACRUM 0:615f90842ce8 58 * <ul>
MACRUM 0:615f90842ce8 59 * <li> Check <b>only one</b> Spirit IRQ (because the Spirit IRQ status register automatically blanks itself
MACRUM 0:615f90842ce8 60 * after an SPI reading) into the ISR.
MACRUM 0:615f90842ce8 61 *
MACRUM 0:615f90842ce8 62 * <b>Example:</b>
MACRUM 0:615f90842ce8 63 * @code
MACRUM 0:615f90842ce8 64 *
MACRUM 0:615f90842ce8 65 * if(SpiritIrqCheckFlag(RX_DATA_READY))
MACRUM 0:615f90842ce8 66 * {
MACRUM 0:615f90842ce8 67 * // do something...
MACRUM 0:615f90842ce8 68 * }
MACRUM 0:615f90842ce8 69 *
MACRUM 0:615f90842ce8 70 * @endcode
MACRUM 0:615f90842ce8 71 * </li>
MACRUM 0:615f90842ce8 72 *
MACRUM 0:615f90842ce8 73 * <li> Check more than one Spirit IRQ status by storing the entire IRQ status registers into a bitfields <i>@ref SpiritIrqs</i> structure
MACRUM 0:615f90842ce8 74 * and then check the interested bits.
MACRUM 0:615f90842ce8 75 *
MACRUM 0:615f90842ce8 76 * <b>Example:</b>
MACRUM 0:615f90842ce8 77 * @code
MACRUM 0:615f90842ce8 78 *
MACRUM 0:615f90842ce8 79 * SpiritIrqGetStatus(&irqStatus);
MACRUM 0:615f90842ce8 80 *
MACRUM 0:615f90842ce8 81 * if(irqStatus.IRQ_RX_DATA_READY)
MACRUM 0:615f90842ce8 82 * {
MACRUM 0:615f90842ce8 83 * // do something...
MACRUM 0:615f90842ce8 84 * }
MACRUM 0:615f90842ce8 85 * if(irqStatus.IRQ_VALID_SYNC)
MACRUM 0:615f90842ce8 86 * {
MACRUM 0:615f90842ce8 87 * // do something...
MACRUM 0:615f90842ce8 88 * }
MACRUM 0:615f90842ce8 89 * if(irqStatus.RX_TIMEOUT)
MACRUM 0:615f90842ce8 90 * {
MACRUM 0:615f90842ce8 91 * // do something...
MACRUM 0:615f90842ce8 92 * }
MACRUM 0:615f90842ce8 93 *
MACRUM 0:615f90842ce8 94 * @endcode
MACRUM 0:615f90842ce8 95 * </li>
MACRUM 0:615f90842ce8 96 * </ul>
MACRUM 0:615f90842ce8 97 *
MACRUM 0:615f90842ce8 98
MACRUM 0:615f90842ce8 99 * @attention
MACRUM 0:615f90842ce8 100 *
MACRUM 0:615f90842ce8 101 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
MACRUM 0:615f90842ce8 102 *
MACRUM 0:615f90842ce8 103 * Redistribution and use in source and binary forms, with or without modification,
MACRUM 0:615f90842ce8 104 * are permitted provided that the following conditions are met:
MACRUM 0:615f90842ce8 105 * 1. Redistributions of source code must retain the above copyright notice,
MACRUM 0:615f90842ce8 106 * this list of conditions and the following disclaimer.
MACRUM 0:615f90842ce8 107 * 2. Redistributions in binary form must reproduce the above copyright notice,
MACRUM 0:615f90842ce8 108 * this list of conditions and the following disclaimer in the documentation
MACRUM 0:615f90842ce8 109 * and/or other materials provided with the distribution.
MACRUM 0:615f90842ce8 110 * 3. Neither the name of STMicroelectronics nor the names of its contributors
MACRUM 0:615f90842ce8 111 * may be used to endorse or promote products derived from this software
MACRUM 0:615f90842ce8 112 * without specific prior written permission.
MACRUM 0:615f90842ce8 113 *
MACRUM 0:615f90842ce8 114 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
MACRUM 0:615f90842ce8 115 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
MACRUM 0:615f90842ce8 116 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
MACRUM 0:615f90842ce8 117 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
MACRUM 0:615f90842ce8 118 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
MACRUM 0:615f90842ce8 119 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
MACRUM 0:615f90842ce8 120 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
MACRUM 0:615f90842ce8 121 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
MACRUM 0:615f90842ce8 122 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
MACRUM 0:615f90842ce8 123 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
MACRUM 0:615f90842ce8 124 *
MACRUM 0:615f90842ce8 125 ******************************************************************************
MACRUM 0:615f90842ce8 126 */
MACRUM 0:615f90842ce8 127
MACRUM 0:615f90842ce8 128 /* Define to prevent recursive inclusion -------------------------------------*/
MACRUM 0:615f90842ce8 129 #ifndef __SPIRIT1_IRQ_H
MACRUM 0:615f90842ce8 130 #define __SPIRIT1_IRQ_H
MACRUM 0:615f90842ce8 131
MACRUM 0:615f90842ce8 132
MACRUM 0:615f90842ce8 133 /* Includes ------------------------------------------------------------------*/
MACRUM 0:615f90842ce8 134
MACRUM 0:615f90842ce8 135 #include "SPIRIT_Regs.h"
MACRUM 0:615f90842ce8 136 #include "SPIRIT_Types.h"
MACRUM 0:615f90842ce8 137
MACRUM 0:615f90842ce8 138
MACRUM 0:615f90842ce8 139 #ifdef __cplusplus
MACRUM 0:615f90842ce8 140 extern "C" {
MACRUM 0:615f90842ce8 141 #endif
MACRUM 0:615f90842ce8 142
MACRUM 0:615f90842ce8 143
MACRUM 0:615f90842ce8 144 /**
MACRUM 0:615f90842ce8 145 * @addtogroup SPIRIT_Libraries
MACRUM 0:615f90842ce8 146 * @{
MACRUM 0:615f90842ce8 147 */
MACRUM 0:615f90842ce8 148
MACRUM 0:615f90842ce8 149
MACRUM 0:615f90842ce8 150 /**
MACRUM 0:615f90842ce8 151 * @defgroup SPIRIT_Irq IRQ
MACRUM 0:615f90842ce8 152 * @brief Configuration and management of SPIRIT IRQs.
MACRUM 0:615f90842ce8 153 * @details See the file <i>@ref SPIRIT_Irq.h</i> for more details.
MACRUM 0:615f90842ce8 154 * @{
MACRUM 0:615f90842ce8 155 */
MACRUM 0:615f90842ce8 156
MACRUM 0:615f90842ce8 157 /**
MACRUM 0:615f90842ce8 158 * @defgroup Irq_Exported_Types IRQ Exported Types
MACRUM 0:615f90842ce8 159 * @{
MACRUM 0:615f90842ce8 160 */
MACRUM 0:615f90842ce8 161
MACRUM 0:615f90842ce8 162
MACRUM 0:615f90842ce8 163 /**
MACRUM 0:615f90842ce8 164 * @brief IRQ bitfield structure for SPIRIT. This structure is used to read or write the single IRQ bit.
MACRUM 0:615f90842ce8 165 * During the initialization the user has to fill this structure setting to one the single field related
MACRUM 0:615f90842ce8 166 * to the IRQ he wants to enable, and to zero the single field related to all the IRQs he wants to disable.
MACRUM 0:615f90842ce8 167 * The same structure can be used to retrieve all the IRQ events from the IRQ registers IRQ_STATUS[3:0],
MACRUM 0:615f90842ce8 168 * and read if one or more specific IRQ raised.
MACRUM 0:615f90842ce8 169 * @note The fields order in the structure depends on used endianness (little or big
MACRUM 0:615f90842ce8 170 * endian). The actual definition is valid ONLY for LITTLE ENDIAN mode. Be sure to
MACRUM 0:615f90842ce8 171 * change opportunely the fields order when use a different endianness.
MACRUM 0:615f90842ce8 172 */
MACRUM 0:615f90842ce8 173 typedef struct
MACRUM 0:615f90842ce8 174 {
MACRUM 0:615f90842ce8 175 SpiritFlagStatus IRQ_SYNTH_LOCK_TIMEOUT:1; /*!< IRQ: only for debug; LOCK state timeout */
MACRUM 0:615f90842ce8 176 SpiritFlagStatus IRQ_SYNTH_LOCK_STARTUP:1; /*!< IRQ: only for debug; see CALIBR_START_COUNTER */
MACRUM 0:615f90842ce8 177 SpiritFlagStatus IRQ_SYNTH_CAL_TIMEOUT:1; /*!< IRQ: only for debug; SYNTH calibration timeout */
MACRUM 0:615f90842ce8 178 SpiritFlagStatus IRQ_TX_START_TIME:1; /*!< IRQ: only for debug; TX circuitry startup time; see TX_START_COUNTER */
MACRUM 0:615f90842ce8 179 SpiritFlagStatus IRQ_RX_START_TIME:1; /*!< IRQ: only for debug; RX circuitry startup time; see TX_START_COUNTER */
MACRUM 0:615f90842ce8 180 SpiritFlagStatus IRQ_RX_TIMEOUT:1; /*!< IRQ: RX operation timeout */
MACRUM 0:615f90842ce8 181 SpiritFlagStatus IRQ_AES_END:1; /*!< IRQ: AES End of operation */
MACRUM 0:615f90842ce8 182 SpiritFlagStatus reserved:1; /*!< Reserved bit */
MACRUM 0:615f90842ce8 183
MACRUM 0:615f90842ce8 184 SpiritFlagStatus IRQ_READY:1; /*!< IRQ: READY state */
MACRUM 0:615f90842ce8 185 SpiritFlagStatus IRQ_STANDBY_DELAYED:1; /*!< IRQ: STANDBY state after MCU_CK_CONF_CLOCK_TAIL_X clock cycles */
MACRUM 0:615f90842ce8 186 SpiritFlagStatus IRQ_LOW_BATT_LVL:1; /*!< IRQ: Battery level below threshold*/
MACRUM 0:615f90842ce8 187 SpiritFlagStatus IRQ_POR:1; /*!< IRQ: Power On Reset */
MACRUM 0:615f90842ce8 188 SpiritFlagStatus IRQ_BOR:1; /*!< IRQ: Brown out event (both accurate and inaccurate)*/
MACRUM 0:615f90842ce8 189 SpiritFlagStatus IRQ_LOCK:1; /*!< IRQ: LOCK state */
MACRUM 0:615f90842ce8 190 SpiritFlagStatus IRQ_PM_COUNT_EXPIRED:1; /*!< IRQ: only for debug; Power Management startup timer expiration (see reg PM_START_COUNTER, 0xB5) */
MACRUM 0:615f90842ce8 191 SpiritFlagStatus IRQ_XO_COUNT_EXPIRED:1; /*!< IRQ: only for debug; Crystal oscillator settling time counter expired */
MACRUM 0:615f90842ce8 192
MACRUM 0:615f90842ce8 193 SpiritFlagStatus IRQ_TX_FIFO_ALMOST_EMPTY:1; /*!< IRQ: TX FIFO almost empty */
MACRUM 0:615f90842ce8 194 SpiritFlagStatus IRQ_RX_FIFO_ALMOST_FULL:1; /*!< IRQ: RX FIFO almost full */
MACRUM 0:615f90842ce8 195 SpiritFlagStatus IRQ_RX_FIFO_ALMOST_EMPTY:1; /*!< IRQ: RX FIFO almost empty */
MACRUM 0:615f90842ce8 196 SpiritFlagStatus IRQ_MAX_BO_CCA_REACH:1; /*!< IRQ: Max number of back-off during CCA */
MACRUM 0:615f90842ce8 197 SpiritFlagStatus IRQ_VALID_PREAMBLE:1; /*!< IRQ: Valid preamble detected */
MACRUM 0:615f90842ce8 198 SpiritFlagStatus IRQ_VALID_SYNC:1; /*!< IRQ: Sync word detected */
MACRUM 0:615f90842ce8 199 SpiritFlagStatus IRQ_RSSI_ABOVE_TH:1; /*!< IRQ: RSSI above threshold */
MACRUM 0:615f90842ce8 200 SpiritFlagStatus IRQ_WKUP_TOUT_LDC:1; /*!< IRQ: Wake-up timeout in LDC mode */
MACRUM 0:615f90842ce8 201
MACRUM 0:615f90842ce8 202 SpiritFlagStatus IRQ_RX_DATA_READY:1; /*!< IRQ: RX data ready */
MACRUM 0:615f90842ce8 203 SpiritFlagStatus IRQ_RX_DATA_DISC:1; /*!< IRQ: RX data discarded (upon filtering) */
MACRUM 0:615f90842ce8 204 SpiritFlagStatus IRQ_TX_DATA_SENT:1; /*!< IRQ: TX data sent */
MACRUM 0:615f90842ce8 205 SpiritFlagStatus IRQ_MAX_RE_TX_REACH:1; /*!< IRQ: Max re-TX reached */
MACRUM 0:615f90842ce8 206 SpiritFlagStatus IRQ_CRC_ERROR:1; /*!< IRQ: CRC error */
MACRUM 0:615f90842ce8 207 SpiritFlagStatus IRQ_TX_FIFO_ERROR:1; /*!< IRQ: TX FIFO underflow/overflow error */
MACRUM 0:615f90842ce8 208 SpiritFlagStatus IRQ_RX_FIFO_ERROR:1; /*!< IRQ: RX FIFO underflow/overflow error */
MACRUM 0:615f90842ce8 209 SpiritFlagStatus IRQ_TX_FIFO_ALMOST_FULL:1; /*!< IRQ: TX FIFO almost full */
MACRUM 0:615f90842ce8 210 } SpiritIrqs;
MACRUM 0:615f90842ce8 211
MACRUM 0:615f90842ce8 212 // betzw: uint32_t masks
MACRUM 0:615f90842ce8 213 #define IRQ_TX_FIFO_ALMOST_EMPTY_MASK (0x00010000) /* (1<<16) */
MACRUM 0:615f90842ce8 214 #define IRQ_RX_FIFO_ALMOST_FULL_MASK (0x00020000) /* (1<<17) */
MACRUM 0:615f90842ce8 215 #define IRQ_VALID_SYNC_MASK (0x00200000) /* (1<<21) */
MACRUM 0:615f90842ce8 216 #define IRQ_RX_DATA_READY_MASK (0x01000000) /* (1<<24) */
MACRUM 0:615f90842ce8 217 #define IRQ_RX_DATA_DISC_MASK (0x02000000) /* (1<<25) */
MACRUM 0:615f90842ce8 218 #define IRQ_TX_DATA_SENT_MASK (0x04000000) /* (1<<26) */
MACRUM 0:615f90842ce8 219 #define IRQ_TX_FIFO_ERROR_MASK (0x20000000) /* (1<<29) */
MACRUM 0:615f90842ce8 220 #define IRQ_RX_FIFO_ERROR_MASK (0x40000000) /* (1<<30) */
MACRUM 0:615f90842ce8 221
MACRUM 0:615f90842ce8 222 /**
MACRUM 0:615f90842ce8 223 * @brief IRQ list enumeration for SPIRIT. This enumeration type can be used to address a
MACRUM 0:615f90842ce8 224 * specific IRQ.
MACRUM 0:615f90842ce8 225 */
MACRUM 0:615f90842ce8 226 typedef enum
MACRUM 0:615f90842ce8 227 {
MACRUM 0:615f90842ce8 228 RX_DATA_READY = 0x00000001, /*!< IRQ: RX data ready */
MACRUM 0:615f90842ce8 229 RX_DATA_DISC = 0x00000002, /*!< IRQ: RX data discarded (upon filtering) */
MACRUM 0:615f90842ce8 230 TX_DATA_SENT = 0x00000004, /*!< IRQ: TX data sent */
MACRUM 0:615f90842ce8 231 MAX_RE_TX_REACH = 0x00000008, /*!< IRQ: Max re-TX reached */
MACRUM 0:615f90842ce8 232 CRC_ERROR = 0x00000010, /*!< IRQ: CRC error */
MACRUM 0:615f90842ce8 233 TX_FIFO_ERROR = 0x00000020, /*!< IRQ: TX FIFO underflow/overflow error */
MACRUM 0:615f90842ce8 234 RX_FIFO_ERROR = 0x00000040, /*!< IRQ: RX FIFO underflow/overflow error */
MACRUM 0:615f90842ce8 235 TX_FIFO_ALMOST_FULL = 0x00000080, /*!< IRQ: TX FIFO almost full */
MACRUM 0:615f90842ce8 236 TX_FIFO_ALMOST_EMPTY = 0x00000100, /*!< IRQ: TX FIFO almost empty */
MACRUM 0:615f90842ce8 237 RX_FIFO_ALMOST_FULL = 0x00000200, /*!< IRQ: RX FIFO almost full */
MACRUM 0:615f90842ce8 238 RX_FIFO_ALMOST_EMPTY = 0x00000400, /*!< IRQ: RX FIFO almost empty */
MACRUM 0:615f90842ce8 239 MAX_BO_CCA_REACH = 0x00000800, /*!< IRQ: Max number of back-off during CCA */
MACRUM 0:615f90842ce8 240 VALID_PREAMBLE = 0x00001000, /*!< IRQ: Valid preamble detected */
MACRUM 0:615f90842ce8 241 VALID_SYNC = 0x00002000, /*!< IRQ: Sync word detected */
MACRUM 0:615f90842ce8 242 RSSI_ABOVE_TH = 0x00004000, /*!< IRQ: RSSI above threshold */
MACRUM 0:615f90842ce8 243 WKUP_TOUT_LDC = 0x00008000, /*!< IRQ: Wake-up timeout in LDC mode */
MACRUM 0:615f90842ce8 244 READY = 0x00010000, /*!< IRQ: READY state */
MACRUM 0:615f90842ce8 245 STANDBY_DELAYED = 0x00020000, /*!< IRQ: STANDBY state after MCU_CK_CONF_CLOCK_TAIL_X clock cycles */
MACRUM 0:615f90842ce8 246 LOW_BATT_LVL = 0x00040000, /*!< IRQ: Battery level below threshold*/
MACRUM 0:615f90842ce8 247 POR = 0x00080000, /*!< IRQ: Power On Reset */
MACRUM 0:615f90842ce8 248 BOR = 0x00100000, /*!< IRQ: Brown out event (both accurate and inaccurate)*/
MACRUM 0:615f90842ce8 249 LOCK = 0x00200000, /*!< IRQ: LOCK state */
MACRUM 0:615f90842ce8 250 PM_COUNT_EXPIRED = 0x00400000, /*!< IRQ: only for debug; Power Management startup timer expiration (see reg PM_START_COUNTER, 0xB5) */
MACRUM 0:615f90842ce8 251 XO_COUNT_EXPIRED = 0x00800000, /*!< IRQ: only for debug; Crystal oscillator settling time counter expired */
MACRUM 0:615f90842ce8 252 SYNTH_LOCK_TIMEOUT = 0x01000000, /*!< IRQ: only for debug; LOCK state timeout */
MACRUM 0:615f90842ce8 253 SYNTH_LOCK_STARTUP = 0x02000000, /*!< IRQ: only for debug; see CALIBR_START_COUNTER */
MACRUM 0:615f90842ce8 254 SYNTH_CAL_TIMEOUT = 0x04000000, /*!< IRQ: only for debug; SYNTH calibration timeout */
MACRUM 0:615f90842ce8 255 TX_START_TIME = 0x08000000, /*!< IRQ: only for debug; TX circuitry startup time; see TX_START_COUNTER */
MACRUM 0:615f90842ce8 256 RX_START_TIME = 0x10000000, /*!< IRQ: only for debug; RX circuitry startup time; see TX_START_COUNTER */
MACRUM 0:615f90842ce8 257 RX_TIMEOUT = 0x20000000, /*!< IRQ: RX operation timeout */
MACRUM 0:615f90842ce8 258 AES_END = 0x40000000, /*!< IRQ: AES End of operation */
MACRUM 0:615f90842ce8 259 ALL_IRQ = 0x7FFFFFFF /*!< All the above mentioned IRQs */
MACRUM 0:615f90842ce8 260
MACRUM 0:615f90842ce8 261 } IrqList;
MACRUM 0:615f90842ce8 262
MACRUM 0:615f90842ce8 263 #define IS_SPIRIT_IRQ_LIST(VALUE) ((VALUE == RX_DATA_READY) || \
MACRUM 0:615f90842ce8 264 (VALUE == RX_DATA_DISC) || \
MACRUM 0:615f90842ce8 265 (VALUE == TX_DATA_SENT) || \
MACRUM 0:615f90842ce8 266 (VALUE == MAX_RE_TX_REACH) || \
MACRUM 0:615f90842ce8 267 (VALUE == CRC_ERROR) || \
MACRUM 0:615f90842ce8 268 (VALUE == TX_FIFO_ERROR) || \
MACRUM 0:615f90842ce8 269 (VALUE == RX_FIFO_ERROR) || \
MACRUM 0:615f90842ce8 270 (VALUE == TX_FIFO_ALMOST_FULL) || \
MACRUM 0:615f90842ce8 271 (VALUE == TX_FIFO_ALMOST_EMPTY) || \
MACRUM 0:615f90842ce8 272 (VALUE == RX_FIFO_ALMOST_FULL) || \
MACRUM 0:615f90842ce8 273 (VALUE == RX_FIFO_ALMOST_EMPTY) || \
MACRUM 0:615f90842ce8 274 (VALUE == MAX_BO_CCA_REACH) || \
MACRUM 0:615f90842ce8 275 (VALUE == VALID_PREAMBLE) || \
MACRUM 0:615f90842ce8 276 (VALUE == VALID_SYNC) || \
MACRUM 0:615f90842ce8 277 (VALUE == RSSI_ABOVE_TH) || \
MACRUM 0:615f90842ce8 278 (VALUE == WKUP_TOUT_LDC) || \
MACRUM 0:615f90842ce8 279 (VALUE == READY) || \
MACRUM 0:615f90842ce8 280 (VALUE == STANDBY_DELAYED) || \
MACRUM 0:615f90842ce8 281 (VALUE == LOW_BATT_LVL) || \
MACRUM 0:615f90842ce8 282 (VALUE == POR) || \
MACRUM 0:615f90842ce8 283 (VALUE == BOR) || \
MACRUM 0:615f90842ce8 284 (VALUE == LOCK) || \
MACRUM 0:615f90842ce8 285 (VALUE == PM_COUNT_EXPIRED) || \
MACRUM 0:615f90842ce8 286 (VALUE == XO_COUNT_EXPIRED) || \
MACRUM 0:615f90842ce8 287 (VALUE == SYNTH_LOCK_TIMEOUT) || \
MACRUM 0:615f90842ce8 288 (VALUE == SYNTH_LOCK_STARTUP) || \
MACRUM 0:615f90842ce8 289 (VALUE == SYNTH_CAL_TIMEOUT) || \
MACRUM 0:615f90842ce8 290 (VALUE == TX_START_TIME) || \
MACRUM 0:615f90842ce8 291 (VALUE == RX_START_TIME) || \
MACRUM 0:615f90842ce8 292 (VALUE == RX_TIMEOUT) || \
MACRUM 0:615f90842ce8 293 (VALUE == AES_END) || \
MACRUM 0:615f90842ce8 294 (VALUE == ALL_IRQ ))
MACRUM 0:615f90842ce8 295
MACRUM 0:615f90842ce8 296
MACRUM 0:615f90842ce8 297 /**
MACRUM 0:615f90842ce8 298 * @}
MACRUM 0:615f90842ce8 299 */
MACRUM 0:615f90842ce8 300
MACRUM 0:615f90842ce8 301
MACRUM 0:615f90842ce8 302 /**
MACRUM 0:615f90842ce8 303 * @defgroup Irq_Exported_Constants IRQ Exported Constants
MACRUM 0:615f90842ce8 304 * @{
MACRUM 0:615f90842ce8 305 */
MACRUM 0:615f90842ce8 306
MACRUM 0:615f90842ce8 307
MACRUM 0:615f90842ce8 308 /**
MACRUM 0:615f90842ce8 309 * @}
MACRUM 0:615f90842ce8 310 */
MACRUM 0:615f90842ce8 311
MACRUM 0:615f90842ce8 312
MACRUM 0:615f90842ce8 313 /**
MACRUM 0:615f90842ce8 314 * @defgroup Irq_Exported_Macros IRQ Exported Macros
MACRUM 0:615f90842ce8 315 * @{
MACRUM 0:615f90842ce8 316 */
MACRUM 0:615f90842ce8 317
MACRUM 0:615f90842ce8 318
MACRUM 0:615f90842ce8 319 /**
MACRUM 0:615f90842ce8 320 * @}
MACRUM 0:615f90842ce8 321 */
MACRUM 0:615f90842ce8 322
MACRUM 0:615f90842ce8 323
MACRUM 0:615f90842ce8 324 /**
MACRUM 0:615f90842ce8 325 * @defgroup Irq_Exported_Functions IRQ Exported Functions
MACRUM 0:615f90842ce8 326 * @{
MACRUM 0:615f90842ce8 327 */
MACRUM 0:615f90842ce8 328
MACRUM 0:615f90842ce8 329 void SpiritIrqDeInit(SpiritIrqs* pxIrqInit);
MACRUM 0:615f90842ce8 330 void SpiritIrqInit(SpiritIrqs* pxIrqInit);
MACRUM 0:615f90842ce8 331 void SpiritIrq(IrqList xIrq, SpiritFunctionalState xNewState);
MACRUM 0:615f90842ce8 332 void SpiritIrqGetMask(SpiritIrqs* pxIrqMask);
MACRUM 0:615f90842ce8 333 void SpiritIrqGetStatus(SpiritIrqs* pxIrqStatus);
MACRUM 0:615f90842ce8 334 void SpiritIrqClearStatus(void);
MACRUM 0:615f90842ce8 335 SpiritBool SpiritIrqCheckFlag(IrqList xFlag);
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
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 #ifdef __cplusplus
MACRUM 0:615f90842ce8 352 }
MACRUM 0:615f90842ce8 353 #endif
MACRUM 0:615f90842ce8 354
MACRUM 0:615f90842ce8 355 #endif
MACRUM 0:615f90842ce8 356
MACRUM 0:615f90842ce8 357 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/