Added support for the WNC M14A2A Cellular LTE Data Module.

Dependencies:   WNC14A2AInterface

Embed: (wiki syntax)

« Back to documentation index

SpiritIrqs Struct Reference

SpiritIrqs Struct Reference
[IRQ Exported Types]

IRQ bitfield structure for SPIRIT. More...

#include <SPIRIT_Irq.h>

Data Fields

SpiritFlagStatus IRQ_SYNTH_LOCK_TIMEOUT:1
SpiritFlagStatus IRQ_SYNTH_LOCK_STARTUP:1
SpiritFlagStatus IRQ_SYNTH_CAL_TIMEOUT:1
SpiritFlagStatus IRQ_TX_START_TIME:1
SpiritFlagStatus IRQ_RX_START_TIME:1
SpiritFlagStatus IRQ_RX_TIMEOUT:1
SpiritFlagStatus IRQ_AES_END:1
SpiritFlagStatus reserved:1
SpiritFlagStatus IRQ_READY:1
SpiritFlagStatus IRQ_STANDBY_DELAYED:1
SpiritFlagStatus IRQ_LOW_BATT_LVL:1
SpiritFlagStatus IRQ_POR:1
SpiritFlagStatus IRQ_BOR:1
SpiritFlagStatus IRQ_LOCK:1
SpiritFlagStatus IRQ_PM_COUNT_EXPIRED:1
SpiritFlagStatus IRQ_XO_COUNT_EXPIRED:1
SpiritFlagStatus IRQ_TX_FIFO_ALMOST_EMPTY:1
SpiritFlagStatus IRQ_RX_FIFO_ALMOST_FULL:1
SpiritFlagStatus IRQ_RX_FIFO_ALMOST_EMPTY:1
SpiritFlagStatus IRQ_MAX_BO_CCA_REACH:1
SpiritFlagStatus IRQ_VALID_PREAMBLE:1
SpiritFlagStatus IRQ_VALID_SYNC:1
SpiritFlagStatus IRQ_RSSI_ABOVE_TH:1
SpiritFlagStatus IRQ_WKUP_TOUT_LDC:1
SpiritFlagStatus IRQ_RX_DATA_READY:1
SpiritFlagStatus IRQ_RX_DATA_DISC:1
SpiritFlagStatus IRQ_TX_DATA_SENT:1
SpiritFlagStatus IRQ_MAX_RE_TX_REACH:1
SpiritFlagStatus IRQ_CRC_ERROR:1
SpiritFlagStatus IRQ_TX_FIFO_ERROR:1
SpiritFlagStatus IRQ_RX_FIFO_ERROR:1
SpiritFlagStatus IRQ_TX_FIFO_ALMOST_FULL:1

Detailed Description

IRQ bitfield structure for SPIRIT.

This structure is used to read or write the single IRQ bit. During the initialization the user has to fill this structure setting to one the single field related to the IRQ he wants to enable, and to zero the single field related to all the IRQs he wants to disable. The same structure can be used to retrieve all the IRQ events from the IRQ registers IRQ_STATUS[3:0], and read if one or more specific IRQ raised.

Note:
The fields order in the structure depends on used endianness (little or big endian). The actual definition is valid ONLY for LITTLE ENDIAN mode. Be sure to change opportunely the fields order when use a different endianness.

Definition at line 173 of file SPIRIT_Irq.h.


Field Documentation

SpiritFlagStatus IRQ_AES_END

IRQ: AES End of operation

Definition at line 181 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_BOR

IRQ: Brown out event (both accurate and inaccurate)

Definition at line 188 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_CRC_ERROR

IRQ: CRC error

Definition at line 206 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_LOCK

IRQ: LOCK state

Definition at line 189 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_LOW_BATT_LVL

IRQ: Battery level below threshold

Definition at line 186 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_MAX_BO_CCA_REACH

IRQ: Max number of back-off during CCA

Definition at line 196 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_MAX_RE_TX_REACH

IRQ: Max re-TX reached

Definition at line 205 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_PM_COUNT_EXPIRED

IRQ: only for debug; Power Management startup timer expiration (see reg PM_START_COUNTER, 0xB5)

Definition at line 190 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_POR

IRQ: Power On Reset

Definition at line 187 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_READY

IRQ: READY state

Definition at line 184 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_RSSI_ABOVE_TH

IRQ: RSSI above threshold

Definition at line 199 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_RX_DATA_DISC

IRQ: RX data discarded (upon filtering)

Definition at line 203 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_RX_DATA_READY

IRQ: RX data ready

Definition at line 202 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_RX_FIFO_ALMOST_EMPTY

IRQ: RX FIFO almost empty

Definition at line 195 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_RX_FIFO_ALMOST_FULL

IRQ: RX FIFO almost full

Definition at line 194 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_RX_FIFO_ERROR

IRQ: RX FIFO underflow/overflow error

Definition at line 208 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_RX_START_TIME

IRQ: only for debug; RX circuitry startup time; see TX_START_COUNTER

Definition at line 179 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_RX_TIMEOUT

IRQ: RX operation timeout

Definition at line 180 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_STANDBY_DELAYED

IRQ: STANDBY state after MCU_CK_CONF_CLOCK_TAIL_X clock cycles

Definition at line 185 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_SYNTH_CAL_TIMEOUT

IRQ: only for debug; SYNTH calibration timeout

Definition at line 177 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_SYNTH_LOCK_STARTUP

IRQ: only for debug; see CALIBR_START_COUNTER

Definition at line 176 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_SYNTH_LOCK_TIMEOUT

IRQ: only for debug; LOCK state timeout

Definition at line 175 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_TX_DATA_SENT

IRQ: TX data sent

Definition at line 204 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_TX_FIFO_ALMOST_EMPTY

IRQ: TX FIFO almost empty

Definition at line 193 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_TX_FIFO_ALMOST_FULL

IRQ: TX FIFO almost full

Definition at line 209 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_TX_FIFO_ERROR

IRQ: TX FIFO underflow/overflow error

Definition at line 207 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_TX_START_TIME

IRQ: only for debug; TX circuitry startup time; see TX_START_COUNTER

Definition at line 178 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_VALID_PREAMBLE

IRQ: Valid preamble detected

Definition at line 197 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_VALID_SYNC

IRQ: Sync word detected

Definition at line 198 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_WKUP_TOUT_LDC

IRQ: Wake-up timeout in LDC mode

Definition at line 200 of file SPIRIT_Irq.h.

SpiritFlagStatus IRQ_XO_COUNT_EXPIRED

IRQ: only for debug; Crystal oscillator settling time counter expired

Definition at line 191 of file SPIRIT_Irq.h.

SpiritFlagStatus reserved

Reserved bit

Definition at line 182 of file SPIRIT_Irq.h.