RAIL_RxPacketDetails_t Struct Reference

Received packet details obtained via RAIL_GetRxPacketDetails() or RAIL_GetRxPacketDetailsAlt().

#include <rail_types.h>

Data Fields

RAIL_PacketTimeStamp_t timeReceived
 The timestamp of the received packet in the RAIL timebase.
 
bool crcPassed
 Indicates whether the CRC passed or failed for the received packet.
 
bool isAck
 Indicate whether the received packet was the expected ACK.
 
int8_t rssi
 RSSI of the received packet in integer dBm.
 
uint8_t lqi
 The link quality indicator of the received packet.
 
uint8_t syncWordId
 For radios and PHY configurations that support multiple sync words, this number is the ID of the sync word that was used for this packet.
 
uint8_t subPhyId
 In configurations where the radio has the option of receiving a given packet in multiple ways, indicates which of the sub-PHY options was used to receive the packet.
 
uint8_t antennaId
 For Antenna Control configurations where the device has multiple antennas, this indicates which antenna received the packet.
 
uint8_t channelHoppingChannelIndex
 When channel hopping is enabled, this field will contain the index of the channel in RAIL_RxChannelHoppingConfig_t::entries on which this packet was received, or a sentinel value.

Received packet details obtained via RAIL_GetRxPacketDetails() or RAIL_GetRxPacketDetailsAlt().

Note
Certain details are always available, while others are only available if the RAIL_RxOptions_t RAIL_RX_OPTION_REMOVE_APPENDED_INFO option is not in effect and the received packet's RAIL_RxPacketStatus_t is among the RAIL_RX_PACKET_READY_ set. Each detail's description indicates its availability.

Definition at line 2598 of file rail_types.h.

Field Documentation

◆ antennaId

uint8_t RAIL_RxPacketDetails_t::antennaId

For Antenna Control configurations where the device has multiple antennas, this indicates which antenna received the packet.

When there is only one antenna, this will be set to the default of 0.

It is always available.

Definition at line 2676 of file rail_types.h.

◆ channelHoppingChannelIndex

uint8_t RAIL_RxPacketDetails_t::channelHoppingChannelIndex

When channel hopping is enabled, this field will contain the index of the channel in RAIL_RxChannelHoppingConfig_t::entries on which this packet was received, or a sentinel value.

On EFR32XG1 parts, on which channel hopping is not supported, this value is still part of the structure, but will be a meaningless value.

It is always available.

Definition at line 2686 of file rail_types.h.

◆ crcPassed

bool RAIL_RxPacketDetails_t::crcPassed

Indicates whether the CRC passed or failed for the received packet.

It is true for RAIL_RX_PACKET_READY_SUCCESS packets and false for all others.

It is always available.

Definition at line 2612 of file rail_types.h.

◆ isAck

bool RAIL_RxPacketDetails_t::isAck

Indicate whether the received packet was the expected ACK.

It is true for the expected ACK and false otherwise.

It is always available.

An expected ACK is defined as a protocol-correct ACK packet successfully-received (RAIL_RX_PACKET_READY_SUCCESS or RAIL_RX_PACKET_READY_CRC_ERROR) and whose sync word was detected within the RAIL_AutoAckConfig_t::ackTimeout period following a transmit which specified RAIL_TX_OPTION_WAIT_FOR_ACK, requested an ACK, and auto-ACK is enabled. When true, the ackTimeout period was terminated so no RAIL_EVENT_RX_ACK_TIMEOUT will be subsequently posted for the transmit.

A "protocol-correct ACK" applies to the 802.15.4 or Z-Wave protocols for which RAIL can discern the frame type and match the ACK's sequence number with that of the transmitted frame. For other protocols, the first packet successfully-received whose sync word was detected within the ackTimeout period is considered the expected ACK; upper layers are responsible for confirming this.

Definition at line 2637 of file rail_types.h.

◆ lqi

uint8_t RAIL_RxPacketDetails_t::lqi

The link quality indicator of the received packet.

A zero would indicate a very low quality packet while a 255 would indicate a very high quality packet.

When not available it will be 0.

Definition at line 2652 of file rail_types.h.

◆ rssi

int8_t RAIL_RxPacketDetails_t::rssi

RSSI of the received packet in integer dBm.

It is latched when the sync word is detected for the packet.

When not available it will be RAIL_RSSI_INVALID_DBM.

Definition at line 2644 of file rail_types.h.

◆ subPhyId

uint8_t RAIL_RxPacketDetails_t::subPhyId

In configurations where the radio has the option of receiving a given packet in multiple ways, indicates which of the sub-PHY options was used to receive the packet.

Most radio configurations do not have this ability and the subPhy is set to 0.

It is always available.

Definition at line 2668 of file rail_types.h.

◆ syncWordId

uint8_t RAIL_RxPacketDetails_t::syncWordId

For radios and PHY configurations that support multiple sync words, this number is the ID of the sync word that was used for this packet.

It is always available.

Definition at line 2659 of file rail_types.h.

◆ timeReceived

RAIL_PacketTimeStamp_t RAIL_RxPacketDetails_t::timeReceived

The timestamp of the received packet in the RAIL timebase.

When not available it will be RAIL_PACKET_TIME_INVALID.

Definition at line 2604 of file rail_types.h.


The documentation for this struct was generated from the following file:
  • common/rail_types.h