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