Events

RAIL API

Occurs when the application needs to run a calibration.

The RAIL library detects when a calibration is needed. The application determines a valid window to call RAIL_Calibrate().

Definition at line 631 of file rail_types.h.

Occurs when the scheduler switches to this configuration.

This event can occur often in dynamic multiprotocol scenarios, and can be used to influence the stack's operation.

Definition at line 613 of file rail_types.h.

Occurs when the scheduler switches away from this configuration.

This event can occur often in dynamic multiprotocol scenarios, and can give the current stack an opportunity to release hardware resources.

Definition at line 606 of file rail_types.h.

Indicates a Data Request is being received when using IEEE 802.15.4 functionality.

This occurs when the command byte of an incoming frame is for a data request, which requests an ACK. This callback is called before the packet is fully received to allow the node to have more time to decide whether to set the frame pending in the outgoing ACK. This event only ever occurs if the RAIL IEEE 802.15.4 functionality is enabled, but will never occur if promiscuous mode is enabled via RAIL_IEEE802154_SetPromiscuousMode().

Call RAIL_IEEE802154_GetAddress() to get the source address of the packet.

Definition at line 441 of file rail_types.h.

Occurs when the hardware-averaged RSSI is done.

It only occurs in response to RAIL_StartAverageRssi() to indicate that the hardware has completed averaging. Call RAIL_GetAverageRssi() to get the result.

Definition at line 297 of file rail_types.h.

Notifies the application when searching for an ack packet has timed out.

This event occurs whenever the timeout for searching for an ack packet is exceeded. This will only occur after calling RAIL_ConfigAutoAck() and transmitting a packet.

Definition at line 305 of file rail_types.h.

Occurs when a packet's address does not match the filtering settings.

After this event, the packet will not be received, and no other events should occur for the packet. This event can only occur after calling RAIL_EnableAddressFilter().

Definition at line 375 of file rail_types.h.

Occurs when the receive FIFO exceeds the configured threshold value.

Call RAIL_GetRxFifoBytesAvailable() to get the number of bytes available. When using this event, the threshold should be set via RAIL_SetRxFifoThreshold().

Definition at line 312 of file rail_types.h.

Occurs when RX buffer is full.

This will cause the radio to stop receiving packets until the packet causing the overflow is processed.

Definition at line 367 of file rail_types.h.

Occurs when the packet has passed any configured address and frame filtering options.

This event will only occur between the start of the packet, indicated by RAIL_EVENT_RX_SYNC1_DETECT or RAIL_EVENT_RX_SYNC2_DETECT, and one of the events in the RAIL_EVENTS_RX_COMPLETION mask. This event will always occur before or concurrently with RAIL_EVENT_RX_PACKET_RECEIVED. If IEEE 802.15.4 frame and address filtering are enabled, this event will occur immediately after destination address filtering.

Definition at line 413 of file rail_types.h.

Occurs when a packet being received has a frame error.

For efr32xg1x parts, frame errors include violations of variable length minimum/maximum limits and CRC errors. If RAIL_RX_OPTION_IGNORE_CRC_ERRORS is set, RAIL_EVENT_RX_FRAME_ERROR will not occur for CRC errors.

Definition at line 361 of file rail_types.h.

Occurs whenever a packet is received.

Call RAIL_GetRxPacketInfo() to get basic packet information along with a handle to this packet for subsequent use with RAIL_PeekRxPacket(), RAIL_GetRxPacketDetails(), RAIL_HoldRxPacket(), and RAIL_ReleaseRxPacket() as needed.

If RAIL_RX_OPTION_IGNORE_CRC_ERRORS is set, this event also occurs for packets with CRC errors.

Definition at line 323 of file rail_types.h.

Occurs when the radio has detected a preamble.

This event can occur multiple times while searching for a packet, and is generally used for diagnostic purposes. This event can only occur after a RAIL_EVENT_RX_TIMING_DETECT event has already occurred.

Definition at line 339 of file rail_types.h.

Occurs when the radio has lost a preamble.

This event can occur multiple times while searching for a packet, and is generally used for diagnostic purposes. This event can only occur after a RAIL_EVENT_RX_PREAMBLE_DETECT event has already occurred.

Definition at line 331 of file rail_types.h.

Occurs when the scheduled RX window ends.

This event only occurs in response to a scheduled receive timeout after calling RAIL_ScheduleRx(). If RAIL_ScheduleRxConfig_t::rxTransitionEndSchedule was passed as false, then this event will occur unless the receive is aborted (due to a call to RAIL_Idle() or a scheduler pre-emption, for instance). If RAIL_ScheduleRxConfig_t::rxTransitionEndSchedule was passed as true, then any of the RAIL_EVENTS_RX_COMPLETION events occurring will also cause this event to not occur, since the scheduled reeive will end with the transition at the end of the packet.

Definition at line 395 of file rail_types.h.

Occurs when the first sync word is detected.

After this event occurs, one of the events in the RAIL_EVENTS_RX_COMPLETION mask will occur.

Definition at line 345 of file rail_types.h.

Occurs when the second sync word is detected.

After this event occurs, one of the events in the RAIL_EVENTS_RX_COMPLETION mask will occur.

Definition at line 351 of file rail_types.h.

Occurs when an RX event times out.

This event can only occur if the RAIL_StateTiming_t::rxSearchTimeout passed to RAIL_SetStateTiming() is nonzero.

Definition at line 382 of file rail_types.h.

Occurs when the modem timing is detected.

This event can occur multiple times while searching for a packet, and is generally used for diagnostic purposes.

Definition at line 427 of file rail_types.h.

Occurs when the modem timing is lost.

This event can occur multiple times while searching for a packet, and is generally used for diagnostic purposes. This event can only occur after a RAIL_EVENT_RX_TIMING_DETECT event has already occurred.

Definition at line 421 of file rail_types.h.

Occurs when the scheduler has a status to report.

The exact status can be found with RAIL_GetSchedulerStatus(). See RAIL_SchedulerStatus_t for more details.

Note

RAIL_GetSchedulerStatus() is only valid to call during the timeframe of the RAIL_Config_t::eventsCallback.

Definition at line 622 of file rail_types.h.

Occurs when a transmit is aborted by the user.

This can occur due to calling RAIL_Idle() or due to a scheduler pre-emption.

Definition at line 494 of file rail_types.h.

Occurs during CSMA or LBT when an individual Clear Channel Assessment (CCA) check failed, but there are more tries needed before the overall operation completes.

This event can occur multiple times based on the configuration of the ongoing CSMA or LBT tranmission. This event can only happen after calling RAIL_StartCcaCsmaTx() or RAIL_StartCsmaLbtTx().

Definition at line 555 of file rail_types.h.

Occurs when Carrier Sense Mulitple Access (CSMA) or Listen Before Talk (LBT) fails.

This event can only happen after calling RAIL_StartCcaCsmaTx() or RAIL_StartCsmaLbtTx().

Definition at line 545 of file rail_types.h.

Occurs when Carrier Sense Mulitple Access (CSMA) or Listen Before Talk (LBT) succeeds.

This event can only happen after calling RAIL_StartCcaCsmaTx() or RAIL_StartCsmaLbtTx().

Definition at line 538 of file rail_types.h.

Occurs when the number of bytes in the transmit FIFO was above the configured threshold, and falls to a value at or below the threshold value.

This event does not occur on initailization or after resetting the transmit FIFO with RAIL_ResetFifo(). Call RAIL_GetTxFifoSpaceAvailable() to get the number of bytes available in the transmit FIFO at the time of the callback dispatch. When using this event, the threshold should be set via RAIL_SetTxFifoThreshold().

Definition at line 471 of file rail_types.h.

Occurs when a packet was sent.

Call RAIL_GetTxPacketDetails() to get information about the packet that was transmitted.

Note

RAIL_GetTxPacketDetails() is only valid to call during the timeframe of the RAIL_Config_t::eventsCallback.

Definition at line 479 of file rail_types.h.

Occurs when a Clear Channel Assessment (CCA) check begins.

This event can occur multiple times based on the configuration of the ongoing CSMA or LBT transmission. This event can only happen after calling RAIL_StartCcaCsmaTx() or RAIL_StartCsmaLbtTx().

Definition at line 563 of file rail_types.h.

Occurs when the transmit buffer underflows.

This can happen due to the transmitted packet specifying an unintended length based on the current radio configuration, or due to RAIL_WriteTxFifo() calls not keeping up with the transmit rate, if the entire packet isn't loaded at once.

Definition at line 522 of file rail_types.h.

Occurs when an ack transmit is aborted by the user.

This event can only occur after calling RAIL_ConfigAutoAck(). This can occur due to calling RAIL_Idle() or due to a scheduler pre-emption.

Definition at line 501 of file rail_types.h.

Occurs when an ack transmit is blocked from occurring due to having called RAIL_EnableTxHoldOff().

This event can only occur after calling RAIL_ConfigAutoAck().

Definition at line 514 of file rail_types.h.

Occurs when an ack packet was sent.

Call RAIL_GetTxPacketDetails() to get information about the packet that was transmitted. This event can only occur after calling RAIL_ConfigAutoAck().

Note

RAIL_GetTxPacketDetails() is only valid to call during the timeframe of the RAIL_Config_t::eventsCallback.

Definition at line 488 of file rail_types.h.

Occurs when the ack transmit buffer underflows.

This can happen due to the transmitted packet specifying an unintended length based on the current radio configuration, or due to RAIL_WriteAutoAckFifo() not being called at all before an ack transmit. This event can only occur after calling RAIL_ConfigAutoAck().

Definition at line 531 of file rail_types.h.

This mask indicates all of the events that determine the end of a received packet.

After a packet has begun to be received, which is indicated by a RAIL_EVENT_RX_SYNC1_DETECT or a RAIL_EVENT_RX_SYNC2_DETECT, exactly one of the following events will occur. When one of these events occurs a state transition will take place, based on the parameter passed to RAIL_SetRxTransitions(). The RAIL_StateTransitions_t::success transition will be followed only if the RAIL_EVENT_RX_PACKET_RECEIVED event occurs. Any of the other events will trigger the RAIL_StateTransitions_t::error transition.

Definition at line 454 of file rail_types.h.

This mask indicates all of the events that determine the end of a transmitted packet.

After a packet has begun to be transmitted, which is indicated by a RAIL_STATUS_NO_ERROR return value from one of the transmit functions, exactly one of the following events will occur. When one of these events occurs a state transition will take place based on the parameter passed to RAIL_SetTxTransitions(). The RAIL_StateTransitions_t::success transition will be followed only if the RAIL_EVENT_TX_PACKET_SENT event occurs. Any of the other events will trigger the RAIL_StateTransitions_t::error transition.

Definition at line 576 of file rail_types.h.

This mask indicates all of the events that determine the end of a transmitted ack packet.

After an ack packet has begun to be transmitted, which occurs after an ack-requesting receive, exactly one of the following events will occur. When one of these events occurs a state transition will take place based on the RAIL_AutoAckConfig_t::rxTransitions passed to RAIL_ConfigAutoAck(). The receive transitions are used because the transmitted ack packet is considered a part of the ack-requesting received packet. The RAIL_StateTransitions_t::success transition will be followed only if the RAIL_EVENT_TXACK_PACKET_SENT event occurs. Any of the other events will trigger the RAIL_StateTransitions_t::error transition.

Definition at line 594 of file rail_types.h.

RAIL events passed to event callback.

More than one event may be indicated due to interrupt latency.

Definition at line 203 of file rail_types.h.

Configures radio events.

Parameters

[in]	railHandle	A RAIL instance handle.
[in]	mask	Bitmask containing which events should be modified.
[in]	events	Define which events should trigger RAIL_Config_t::eventsCallback The full list of available callbacks can be found by looking at the RAIL_EVENT_* set of defines.

Returns

Status code indicating success of the function call.

Sets up which radio interrupts generate a RAIL event. The full list of options is in RAIL_Events_t.