Features

Overview of support for various features across hardware platforms.

Macros

#define RAIL_SUPPORTS_DUAL_BAND 1
Boolean to indicate whether the selected chip supports both SubGHz and 2.4 GHz bands.
#define RAIL_FEAT_DUAL_BAND_RADIO RAIL_SUPPORTS_DUAL_BAND
Backwards-compatible synonym of RAIL_SUPPORTS_DUAL_BAND .
#define RAIL_SUPPORTS_2P4GHZ_BAND 1
Boolean to indicate whether the selected chip supports the 2.4 GHz band.
#define RAIL_FEAT_2G4_RADIO RAIL_SUPPORTS_2P4GHZ_BAND
Backwards-compatible synonym of RAIL_SUPPORTS_2P4GHZ_BAND .
#define RAIL_SUPPORTS_SUBGHZ_BAND 1
Boolean to indicate whether the selected chip supports SubGHz bands.
#define RAIL_FEAT_SUBGIG_RADIO RAIL_SUPPORTS_SUBGHZ_BAND
Backwards-compatible synonym of RAIL_SUPPORTS_SUBGHZ_BAND .
#define RAIL_SUPPORTS_ADDR_FILTER_ADDRESS_BIT_MASK 0
Boolean to indicate whether the selected chip supports bit masked address filtering.
#define RAIL_SUPPORTS_ADDR_FILTER_MASK 1
Boolean to indicate whether the selected chip supports address filter mask information for incoming packets in RAIL_RxPacketInfo_t::filterMask and RAIL_IEEE802154_Address_t::filterMask .
#define RAIL_SUPPORTS_ALTERNATE_TX_POWER 0
Boolean to indicate whether the selected chip supports alternate power settings for the Power Amplifier.
#define RAIL_FEAT_ALTERNATE_POWER_TX_SUPPORTED RAIL_SUPPORTS_ALTERNATE_TX_POWER
Backwards-compatible synonym of RAIL_SUPPORTS_ALTERNATE_TX_POWER .
#define RAIL_SUPPORTS_ANTENNA_DIVERSITY 0
Boolean to indicate whether the selected chip supports antenna diversity.
#define RAIL_FEAT_ANTENNA_DIVERSITY RAIL_SUPPORTS_ANTENNA_DIVERSITY
Backwards-compatible synonym of RAIL_SUPPORTS_ANTENNA_DIVERSITY .
#define RAIL_SUPPORTS_CHANNEL_HOPPING 0
Boolean to indicate whether the selected chip supports channel hopping.
#define RAIL_FEAT_CHANNEL_HOPPING RAIL_SUPPORTS_CHANNEL_HOPPING
Backwards-compatible synonym of RAIL_SUPPORTS_CHANNEL_HOPPING .
#define RAIL_SUPPORTS_DUAL_SYNC_WORDS 1
Boolean to indicate whether the selected chip supports dual sync words.
#define RAIL_SUPPORTS_TX_TO_TX 1
Boolean to indicate whether the selected chip supports automatic transitions from TX to TX.
#define RAIL_SUPPORTS_EXTERNAL_THERMISTOR 0
Boolean to indicate whether the selected chip supports thermistor measurements.
#define RAIL_FEAT_EXTERNAL_THERMISTOR RAIL_SUPPORTS_EXTERNAL_THERMISTOR
Backwards-compatible synonym of RAIL_SUPPORTS_EXTERNAL_THERMISTOR .
#define RAIL_SUPPORTS_PRECISION_LFRCO 0
Boolean to indicate whether the selected chip supports a high-precision LFRCO.
#define RAIL_SUPPORTS_RADIO_ENTROPY 1
Boolean to indicate whether the selected chip supports radio entropy.
#define RAIL_SUPPORTS_RFSENSE_ENERGY_DETECTION 0
Boolean to indicate whether the selected chip supports RFSENSE Energy Detection Mode.
#define RAIL_SUPPORTS_RFSENSE_SELECTIVE_OOK 0
Boolean to indicate whether the selected chip supports RFSENSE Selective(OOK) Mode.
#define RAIL_FEAT_RFSENSE_SELECTIVE_OOK_MODE_SUPPORTED RAIL_SUPPORTS_RFSENSE_SELECTIVE_OOK
Backwards-compatible synonym of RAIL_SUPPORTS_RFSENSE_SELECTIVE_OOK .
#define RAIL_SUPPORTS_PROTOCOL_BLE RAIL_SUPPORTS_2P4GHZ_BAND
Boolean to indicate whether the selected chip supports BLE.
#define RAIL_BLE_SUPPORTS_1MBPS_NON_VITERBI 0
Boolean to indicate whether the selected chip supports BLE 1Mbps Non-Viterbi PHY.
#define RAIL_BLE_SUPPORTS_1MBPS_VITERBI RAIL_SUPPORTS_PROTOCOL_BLE
Boolean to indicate whether the selected chip supports BLE 1Mbps Viterbi PHY.
#define RAIL_BLE_SUPPORTS_1MBPS ( RAIL_BLE_SUPPORTS_1MBPS_NON_VITERBI || RAIL_BLE_SUPPORTS_1MBPS_VITERBI )
Boolean to indicate whether the selected chip supports BLE 1Mbps operation.
#define RAIL_BLE_SUPPORTS_2MBPS_NON_VITERBI 0
Boolean to indicate whether the selected chip supports BLE 2Mbps Non-Viterbi PHY.
#define RAIL_BLE_SUPPORTS_2MBPS_VITERBI RAIL_SUPPORTS_PROTOCOL_BLE
Boolean to indicate whether the selected chip supports BLE 2Mbps Viterbi PHY.
#define RAIL_BLE_SUPPORTS_2MBPS ( RAIL_BLE_SUPPORTS_2MBPS_NON_VITERBI || RAIL_BLE_SUPPORTS_2MBPS_VITERBI )
Boolean to indicate whether the selected chip supports BLE 2Mbps operation.
#define RAIL_BLE_SUPPORTS_ANTENNA_SWITCHING 0
Boolean to indicate whether the selected chip supports BLE Antenna Switching needed for Angle-of-Arrival receives or Angle-of-Departure transmits.
#define RAIL_BLE_SUPPORTS_CODED_PHY 0
Boolean to indicate whether the selected chip supports the BLE Coded PHY used for Long-Range.
#define RAIL_FEAT_BLE_CODED RAIL_BLE_SUPPORTS_CODED_PHY
Backwards-compatible synonym of RAIL_BLE_SUPPORTS_CODED_PHY .
#define RAIL_BLE_SUPPORTS_SIMULSCAN_PHY 0
Boolean to indicate whether the selected chip supports the BLE Simulscan PHY used for simultaneous BLE 1Mbps and Coded PHY reception.
#define RAIL_BLE_SUPPORTS_CTE 0
Boolean to indicate whether the selected chip supports BLE CTE (Constant Tone Extension) needed for Angle-of-Arrival/Departure transmits.
#define RAIL_BLE_SUPPORTS_QUUPPA 0
Boolean to indicate whether the selected chip supports the Quuppa PHY.
#define RAIL_BLE_SUPPORTS_IQ_SAMPLING 0
Boolean to indicate whether the selected chip supports BLE IQ Sampling needed for Angle-of-Arrival/Departure receives.
#define RAIL_FEAT_BLE_AOX_SUPPORTED
Backwards-compatible synonym of RAIL_BLE_SUPPORTS_ANTENNA_SWITCHING , or RAIL_BLE_SUPPORTS_IQ_SAMPLING , or RAIL_BLE_SUPPORTS_CTE .
#define RAIL_BLE_SUPPORTS_PHY_SWITCH_TO_RX RAIL_SUPPORTS_PROTOCOL_BLE
Boolean to indicate whether the selected chip supports BLE PHY switch to RX functionality, which is used to switch BLE PHYs at a specific time to receive auxiliary packets.
#define RAIL_FEAT_BLE_PHY_SWITCH_TO_RX RAIL_BLE_SUPPORTS_PHY_SWITCH_TO_RX
Backwards-compatible synonym of RAIL_BLE_SUPPORTS_PHY_SWITCH_TO_RX .
#define RAIL_SUPPORTS_PROTOCOL_IEEE802154 1
Boolean to indicate whether the selected chip supports IEEE 802.15.4.
#define RAIL_IEEE802154_SUPPORTS_COEX_PHY 0
Boolean to indicate whether the selected chip supports the 802.15.4 Wi-Fi Coexistence PHY.
#define RAIL_FEAT_802154_COEX_PHY RAIL_IEEE802154_SUPPORTS_COEX_PHY
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_COEX_PHY .
#define RAIL_IEEE802154_SUPPORTS_FEM_PHY ( RAIL_SUPPORTS_PROTOCOL_IEEE802154 && RAIL_SUPPORTS_2P4GHZ_BAND )
Boolean to indicate whether the selected chip supports a front end module.
#define RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868 RAIL_SUPPORTS_PROTOCOL_IEEE802154
Boolean to indicate whether the selected chip supports IEEE 802.15.4E-2012 feature subset needed for Zigbee R22 GB868.
#define RAIL_FEAT_IEEE802154_E_GB868_SUPPORTED RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868 .
#define RAIL_IEEE802154_SUPPORTS_E_ENHANCED_ACK RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868
Boolean to indicate whether the selected chip supports IEEE 802.15.4E-2012 Enhanced ACKing.
#define RAIL_FEAT_IEEE802154_E_ENH_ACK_SUPPORTED RAIL_IEEE802154_SUPPORTS_E_ENHANCED_ACK
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_E_ENHANCED_ACK .
#define RAIL_IEEE802154_SUPPORTS_E_MULTIPURPOSE_FRAMES RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868
Boolean to indicate whether the selected chip supports receiving IEEE 802.15.4E-2012 Multipurpose frames.
#define RAIL_FEAT_IEEE802154_MULTIPURPOSE_FRAME_SUPPORTED RAIL_IEEE802154_SUPPORTS_E_MULTIPURPOSE_FRAMES
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_E_MULTIPURPOSE_FRAMES .
#define RAIL_IEEE802154_SUPPORTS_G_SUBSET_GB868 ( RAIL_SUPPORTS_PROTOCOL_IEEE802154 && RAIL_SUPPORTS_SUBGHZ_BAND )
Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 feature subset needed for Zigbee R22 GB868.
#define RAIL_FEAT_IEEE802154_G_GB868_SUPPORTED RAIL_IEEE802154_SUPPORTS_G_SUBSET_GB868
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_SUBSET_GB868 .
#define RAIL_IEEE802154_SUPPORTS_G_4BYTE_CRC 0
Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 reception and transmission of frames with 4-byte CRC.
#define RAIL_FEAT_IEEE802154_G_4BYTE_CRC_SUPPORTED RAIL_IEEE802154_SUPPORTS_G_4BYTE_CRC
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_4BYTE_CRC .
#define RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_RX 0
Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 reception of unwhitened frames.
#define RAIL_FEAT_IEEE802154_G_UNWHITENED_RX_SUPPORTED RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_RX
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_RX .
#define RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_TX 0
Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 transmission of unwhitened frames.
#define RAIL_FEAT_IEEE802154_G_UNWHITENED_TX_SUPPORTED RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_TX
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_TX .
#define RAIL_IEEE802154_SUPPORTS_CANCEL_FRAME_PENDING_LOOKUP RAIL_SUPPORTS_PROTOCOL_IEEE802154
Boolean to indicate whether the selected chip supports canceling the frame-pending lookup event RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND when the radio transitions to a state that renders the the reporting of this event moot (i.e., too late for the stack to influence the outgoing ACK).
#define RAIL_FEAT_IEEE802154_CANCEL_FP_LOOKUP_SUPPORTED RAIL_IEEE802154_SUPPORTS_CANCEL_FRAME_PENDING_LOOKUP
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_CANCEL_FRAME_PENDING_LOOKUP .
#define RAIL_IEEE802154_SUPPORTS_EARLY_FRAME_PENDING_LOOKUP RAIL_SUPPORTS_PROTOCOL_IEEE802154
Boolean to indicate whether the selected chip supports early triggering of the frame-pending lookup event RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND just after MAC address fields have been received.
#define RAIL_FEAT_IEEE802154_EARLY_FP_LOOKUP_SUPPORTED RAIL_IEEE802154_SUPPORTS_EARLY_FRAME_PENDING_LOOKUP
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_EARLY_FRAME_PENDING_LOOKUP .
#define RAIL_SUPPORTS_PROTOCOL_ZWAVE 0
Boolean to indicate whether the selected chip supports Z-Wave.
#define RAIL_FEAT_ZWAVE_SUPPORTED RAIL_SUPPORTS_PROTOCOL_ZWAVE
Backwards-compatible synonym of RAIL_SUPPORTS_PROTOCOL_ZWAVE .
#define RAIL_ZWAVE_SUPPORTS_ED_PHY 0
Boolean to indicate whether the selected chip supports energy detect PHY.
#define RAIL_ZWAVE_SUPPORTS_CONC_PHY 0
Boolean to indicate whether the selected chip supports concurrent PHY.
#define RAIL_SUPPORTS_SQ_PHY 0
Boolean to indicate whether the selected chip supports SQ-based PHY.
#define RAIL_ZWAVE_SUPPORTS_REGION_PTI RAIL_SUPPORTS_PROTOCOL_ZWAVE
Boolean to indicate whether the code supports Z-Wave region information in PTI and newer RAIL_ZWAVE_RegionConfig_t structure See also runtime refinement RAIL_ZWAVE_SupportsRegionPti() .
#define RAIL_FEAT_ZWAVE_REGION_PTI RAIL_ZWAVE_SUPPORTS_REGION_PTI
Backwards-compatible synonym of RAIL_ZWAVE_SUPPORTS_REGION_PTI .
#define RAIL_SUPPORTS_DIRECT_MODE 0
Boolean to indicate whether the selected chip supports direct mode.
#define RAIL_SUPPORTS_RX_DIRECT_MODE_DATA_TO_FIFO 0
Boolean to indicate whether the selected chip supports RX direct mode data to FIFO.
#define RAIL_SUPPORTS_MFM 0
Boolean to indicate whether the selected chip supports MFM protocol.

Functions

bool RAIL_SupportsTxPowerMode ( RAIL_Handle_t railHandle, RAIL_TxPowerMode_t powerMode, RAIL_TxPowerLevel_t *pMaxPowerLevel)
Indicate whether this chip supports a particular power mode (PA).
bool RAIL_SupportsTxPowerModeAlt ( RAIL_Handle_t railHandle, RAIL_TxPowerMode_t *powerMode, RAIL_TxPowerLevel_t *maxPowerLevel, RAIL_TxPowerLevel_t *minPowerLevel)
Indicate whether this chip supports a particular power mode (PA) and provides the maximum and minimum power level for that power mode if supported by the chip.
bool RAIL_SupportsDualBand ( RAIL_Handle_t railHandle)
Indicate whether this chip supports dual 2.4 GHz and SubGHz band operation.
bool RAIL_Supports2p4GHzBand ( RAIL_Handle_t railHandle)
Indicate whether RAIL supports 2.4 GHz band operation on this chip.
bool RAIL_SupportsSubGHzBand ( RAIL_Handle_t railHandle)
Indicate whether RAIL supports SubGHz band operation on this chip.
bool RAIL_SupportsAddrFilterAddressBitMask ( RAIL_Handle_t railHandle)
Indicate whether this chip supports bit masked address filtering.
bool RAIL_SupportsAddrFilterMask ( RAIL_Handle_t railHandle)
Indicate whether this chip supports address filter mask information for incoming packets in RAIL_RxPacketInfo_t::filterMask and RAIL_IEEE802154_Address_t::filterMask .
bool RAIL_SupportsAlternateTxPower ( RAIL_Handle_t railHandle)
Indicate whether this chip supports alternate TX power settings.
bool RAIL_SupportsAntennaDiversity ( RAIL_Handle_t railHandle)
Indicate whether this chip supports antenna diversity.
bool RAIL_SupportsChannelHopping ( RAIL_Handle_t railHandle)
Indicate whether RAIL supports channel hopping on this chip.
bool RAIL_SupportsDualSyncWords ( RAIL_Handle_t railHandle)
Indicate whether this chip supports dual sync words.
bool RAIL_SupportsTxToTx ( RAIL_Handle_t railHandle)
Indicate whether this chip supports automatic TX to TX transitions.
bool RAIL_SupportsExternalThermistor ( RAIL_Handle_t railHandle)
Indicate whether RAIL supports thermistor measurements on this chip.
bool RAIL_SupportsPrecisionLFRCO ( RAIL_Handle_t railHandle)
Indicate whether this chip supports a high-precision LFRCO.
bool RAIL_SupportsRadioEntropy ( RAIL_Handle_t railHandle)
Indicate whether this chip supports radio entropy.
bool RAIL_SupportsRfSenseEnergyDetection ( RAIL_Handle_t railHandle)
Indicate whether RAIL supports RFSENSE Energy Detection Mode on this chip.
bool RAIL_SupportsRfSenseSelectiveOok ( RAIL_Handle_t railHandle)
Indicate whether RAIL supports RFSENSE Selective(OOK) Mode on this chip.
bool RAIL_SupportsProtocolBLE ( RAIL_Handle_t railHandle)
Indicate whether RAIL supports the BLE protocol on this chip.
bool RAIL_BLE_Supports1MbpsNonViterbi ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE 1Mbps Non-Viterbi PHY.
bool RAIL_BLE_Supports1MbpsViterbi ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE 1Mbps Viterbi PHY.
static bool RAIL_BLE_Supports1Mbps ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE 1Mbps operation.
bool RAIL_BLE_Supports2MbpsNonViterbi ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE 2Mbps Non-Viterbi PHY.
bool RAIL_BLE_Supports2MbpsViterbi ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE 2Mbps Viterbi PHY.
static bool RAIL_BLE_Supports2Mbps ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE 2Mbps operation.
bool RAIL_BLE_SupportsAntennaSwitching ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE Antenna Switching needed for Angle-of-Arrival receives or Angle-of-Departure transmits.
bool RAIL_BLE_SupportsCodedPhy ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE Coded PHY used for Long-Range.
bool RAIL_BLE_SupportsSimulscanPhy ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE Simulscan PHY used for simultaneous BLE 1Mbps and Coded PHY reception.
bool RAIL_BLE_SupportsCte ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE CTE (Constant Tone Extension) needed for Angle-of-Arrival/Departure transmits.
bool RAIL_BLE_SupportsQuuppa ( RAIL_Handle_t railHandle)
Indicate whether this chip supports the Quuppa PHY.
bool RAIL_BLE_SupportsIQSampling ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE IQ Sampling needed for Angle-of-Arrival/Departure receives.
bool RAIL_BLE_SupportsPhySwitchToRx ( RAIL_Handle_t railHandle)
Indicate whether this chip supports BLE PHY switch to RX functionality, which is used to switch BLE PHYs at a specific time to receive auxiliary packets.
bool RAIL_SupportsProtocolIEEE802154 ( RAIL_Handle_t railHandle)
Indicate whether this chip supports the IEEE 802.15.4 protocol.
bool RAIL_IEEE802154_SupportsCoexPhy ( RAIL_Handle_t railHandle)
Indicate whether this chip supports the IEEE 802.15.4 Wi-Fi Coexistence PHY.
bool RAIL_IEEE802154_SupportsFemPhy ( RAIL_Handle_t railHandle)
Indicate whether this chip supports the IEEE 802.15.4 front end module optimized PHY.
bool RAIL_IEEE802154_SupportsESubsetGB868 ( RAIL_Handle_t railHandle)
Indicate whether this chip supports the IEEE 802.15.4E-2012 feature subset needed for Zigbee R22 GB868.
bool RAIL_IEEE802154_SupportsEEnhancedAck ( RAIL_Handle_t railHandle)
Indicate whether this chip supports IEEE 802.15.4E-2012 Enhanced ACKing.
bool RAIL_IEEE802154_SupportsEMultipurposeFrames ( RAIL_Handle_t railHandle)
Indicate whether this chip supports IEEE 802.15.4E-2012 Multipurpose frame reception.
bool RAIL_IEEE802154_SupportsGSubsetGB868 ( RAIL_Handle_t railHandle)
Indicate whether this chip supports IEEE 802.15.4G-2012 feature subset needed for Zigbee R22 GB868.
bool RAIL_IEEE802154_SupportsG4ByteCrc ( RAIL_Handle_t railHandle)
Indicate whether this chip supports IEEE 802.15.4G-2012 reception and transmission of frames with 4-byte CRC.
bool RAIL_IEEE802154_SupportsGUnwhitenedRx ( RAIL_Handle_t railHandle)
Indicate whether this chip supports IEEE 802.15.4G-2012 reception of unwhitened frames.
bool RAIL_IEEE802154_SupportsGUnwhitenedTx ( RAIL_Handle_t railHandle)
Indicate whether this chip supports IEEE 802.15.4G-2012 transmission of unwhitened frames.
bool RAIL_IEEE802154_SupportsCancelFramePendingLookup ( RAIL_Handle_t railHandle)
Indicate whether this chip supports canceling the frame-pending lookup event RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND when the radio transitions to a state that renders the the reporting of this event moot (i.e., too late for the stack to influence the outgoing ACK).
bool RAIL_IEEE802154_SupportsEarlyFramePendingLookup ( RAIL_Handle_t railHandle)
Indicate whether this chip supports early triggering of the frame-pending lookup event RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND just after MAC address fields have been received.
bool RAIL_SupportsProtocolZWave ( RAIL_Handle_t railHandle)
Indicate whether this chip supports the Z-Wave protocol.
bool RAIL_ZWAVE_SupportsEnergyDetectPhy ( RAIL_Handle_t railHandle)
Indicate whether this chip supports the Z-Wave energy detect PHY.
bool RAIL_ZWAVE_SupportsConcPhy ( RAIL_Handle_t railHandle)
Indicate whether this chip supports the Z-Wave concurrent PHY.
bool RAIL_SupportsSQPhy ( RAIL_Handle_t railHandle)
Indicate whether this chip supports SQ-based PHY.
bool RAIL_ZWAVE_SupportsRegionPti ( RAIL_Handle_t railHandle)
Indicate whether this chip supports Z-Wave Region in PTI.
bool RAIL_SupportsDirectMode ( RAIL_Handle_t railHandle)
Indicate whether this chip supports direct mode.
bool RAIL_SupportsRxDirectModeDataToFifo ( RAIL_Handle_t railHandle)
Indicate whether this chip supports RX direct mode data to FIFO.
bool RAIL_SupportsMfm ( RAIL_Handle_t railHandle)
Indicate whether this chip supports MFM protocol.

Detailed Description

Overview of support for various features across hardware platforms.

These defines can be used at compile time to determine which features are available on your platform. However, keep in mind that these defines hold true for chip families. Your specific part may have further restrictions (band limitations, power amplifier restrictions, and so on) on top of those listed below, for which runtime RAIL_Supports*() APIs can be used to check availability on a particular chip (after RAIL_Init() has been called). In general, an attempt to call an API that is not supported on your chip family as listed below will result in a RAIL_STATUS_INVALID_CALL .

Macro Definition Documentation

RAIL_BLE_SUPPORTS_1MBPS

Boolean to indicate whether the selected chip supports BLE 1Mbps operation.

See also runtime refinement RAIL_BLE_Supports1Mbps() .

Definition at line 443 of file rail_features.h .

RAIL_BLE_SUPPORTS_1MBPS_NON_VITERBI

#define RAIL_BLE_SUPPORTS_1MBPS_NON_VITERBI   0

Boolean to indicate whether the selected chip supports BLE 1Mbps Non-Viterbi PHY.

See also runtime refinement RAIL_BLE_Supports1MbpsNonViterbi() .

Definition at line 409 of file rail_features.h .

RAIL_BLE_SUPPORTS_1MBPS_VITERBI

#define RAIL_BLE_SUPPORTS_1MBPS_VITERBI RAIL_SUPPORTS_PROTOCOL_BLE

Boolean to indicate whether the selected chip supports BLE 1Mbps Viterbi PHY.

See also runtime refinement RAIL_BLE_Supports1MbpsViterbi() .

Definition at line 426 of file rail_features.h .

RAIL_BLE_SUPPORTS_2MBPS

Boolean to indicate whether the selected chip supports BLE 2Mbps operation.

See also runtime refinement RAIL_BLE_Supports2Mbps() .

Definition at line 501 of file rail_features.h .

RAIL_BLE_SUPPORTS_2MBPS_NON_VITERBI

#define RAIL_BLE_SUPPORTS_2MBPS_NON_VITERBI   0

Boolean to indicate whether the selected chip supports BLE 2Mbps Non-Viterbi PHY.

See also runtime refinement RAIL_BLE_Supports2MbpsNonViterbi() .

Definition at line 467 of file rail_features.h .

RAIL_BLE_SUPPORTS_2MBPS_VITERBI

#define RAIL_BLE_SUPPORTS_2MBPS_VITERBI RAIL_SUPPORTS_PROTOCOL_BLE

Boolean to indicate whether the selected chip supports BLE 2Mbps Viterbi PHY.

See also runtime refinement RAIL_BLE_Supports2MbpsViterbi() .

Definition at line 484 of file rail_features.h .

RAIL_BLE_SUPPORTS_ANTENNA_SWITCHING

#define RAIL_BLE_SUPPORTS_ANTENNA_SWITCHING   0

Boolean to indicate whether the selected chip supports BLE Antenna Switching needed for Angle-of-Arrival receives or Angle-of-Departure transmits.

See also runtime refinement RAIL_BLE_SupportsAntennaSwitching() .

Definition at line 526 of file rail_features.h .

RAIL_BLE_SUPPORTS_CODED_PHY

#define RAIL_BLE_SUPPORTS_CODED_PHY   0

Boolean to indicate whether the selected chip supports the BLE Coded PHY used for Long-Range.

See also runtime refinement RAIL_BLE_SupportsCodedPhy() .

Definition at line 548 of file rail_features.h .

RAIL_BLE_SUPPORTS_CTE

#define RAIL_BLE_SUPPORTS_CTE   0

Boolean to indicate whether the selected chip supports BLE CTE (Constant Tone Extension) needed for Angle-of-Arrival/Departure transmits.

See also runtime refinement RAIL_BLE_SupportsCte() .

Definition at line 591 of file rail_features.h .

RAIL_BLE_SUPPORTS_IQ_SAMPLING

#define RAIL_BLE_SUPPORTS_IQ_SAMPLING   0

Boolean to indicate whether the selected chip supports BLE IQ Sampling needed for Angle-of-Arrival/Departure receives.

See also runtime refinement RAIL_BLE_SupportsIQSampling() .

Definition at line 630 of file rail_features.h .

RAIL_BLE_SUPPORTS_PHY_SWITCH_TO_RX

#define RAIL_BLE_SUPPORTS_PHY_SWITCH_TO_RX RAIL_SUPPORTS_PROTOCOL_BLE

Boolean to indicate whether the selected chip supports BLE PHY switch to RX functionality, which is used to switch BLE PHYs at a specific time to receive auxiliary packets.

See also runtime refinement RAIL_BLE_SupportsPhySwitchToRx() .

Definition at line 656 of file rail_features.h .

RAIL_BLE_SUPPORTS_QUUPPA

#define RAIL_BLE_SUPPORTS_QUUPPA   0

Boolean to indicate whether the selected chip supports the Quuppa PHY.

See also runtime refinement RAIL_BLE_SupportsQuuppa() .

Definition at line 611 of file rail_features.h .

RAIL_BLE_SUPPORTS_SIMULSCAN_PHY

#define RAIL_BLE_SUPPORTS_SIMULSCAN_PHY   0

Boolean to indicate whether the selected chip supports the BLE Simulscan PHY used for simultaneous BLE 1Mbps and Coded PHY reception.

See also runtime refinement RAIL_BLE_SupportsSimulscanPhy() .

Definition at line 570 of file rail_features.h .

RAIL_FEAT_BLE_AOX_SUPPORTED

#define RAIL_FEAT_BLE_AOX_SUPPORTED
Value:
#define RAIL_BLE_SUPPORTS_ANTENNA_SWITCHING
Boolean to indicate whether the selected chip supports BLE Antenna Switching needed for Angle-of-Arri...
Definition: rail_features.h:526
#define RAIL_BLE_SUPPORTS_IQ_SAMPLING
Boolean to indicate whether the selected chip supports BLE IQ Sampling needed for Angle-of-Arrival/De...
Definition: rail_features.h:630
#define RAIL_BLE_SUPPORTS_CTE
Boolean to indicate whether the selected chip supports BLE CTE (Constant Tone Extension) needed for A...
Definition: rail_features.h:591

Backwards-compatible synonym of RAIL_BLE_SUPPORTS_ANTENNA_SWITCHING , or RAIL_BLE_SUPPORTS_IQ_SAMPLING , or RAIL_BLE_SUPPORTS_CTE .

Definition at line 646 of file rail_features.h .

RAIL_FEAT_IEEE802154_CANCEL_FP_LOOKUP_SUPPORTED

#define RAIL_FEAT_IEEE802154_CANCEL_FP_LOOKUP_SUPPORTED RAIL_IEEE802154_SUPPORTS_CANCEL_FRAME_PENDING_LOOKUP

Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_CANCEL_FRAME_PENDING_LOOKUP .

Definition at line 931 of file rail_features.h .

RAIL_FEAT_IEEE802154_E_ENH_ACK_SUPPORTED

#define RAIL_FEAT_IEEE802154_E_ENH_ACK_SUPPORTED RAIL_IEEE802154_SUPPORTS_E_ENHANCED_ACK

Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_E_ENHANCED_ACK .

Definition at line 770 of file rail_features.h .

RAIL_FEAT_IEEE802154_E_GB868_SUPPORTED

#define RAIL_FEAT_IEEE802154_E_GB868_SUPPORTED RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868

Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868 .

Definition at line 744 of file rail_features.h .

RAIL_FEAT_IEEE802154_EARLY_FP_LOOKUP_SUPPORTED

#define RAIL_FEAT_IEEE802154_EARLY_FP_LOOKUP_SUPPORTED RAIL_IEEE802154_SUPPORTS_EARLY_FRAME_PENDING_LOOKUP

Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_EARLY_FRAME_PENDING_LOOKUP .

Definition at line 961 of file rail_features.h .

RAIL_FEAT_IEEE802154_G_GB868_SUPPORTED

#define RAIL_FEAT_IEEE802154_G_GB868_SUPPORTED RAIL_IEEE802154_SUPPORTS_G_SUBSET_GB868

Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_SUBSET_GB868 .

Definition at line 822 of file rail_features.h .

RAIL_FEAT_IEEE802154_G_UNWHITENED_RX_SUPPORTED

#define RAIL_FEAT_IEEE802154_G_UNWHITENED_RX_SUPPORTED RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_RX

Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_RX .

Definition at line 873 of file rail_features.h .

RAIL_FEAT_IEEE802154_G_UNWHITENED_TX_SUPPORTED

#define RAIL_FEAT_IEEE802154_G_UNWHITENED_TX_SUPPORTED RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_TX

Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_TX .

Definition at line 900 of file rail_features.h .

RAIL_FEAT_IEEE802154_MULTIPURPOSE_FRAME_SUPPORTED

#define RAIL_FEAT_IEEE802154_MULTIPURPOSE_FRAME_SUPPORTED RAIL_IEEE802154_SUPPORTS_E_MULTIPURPOSE_FRAMES

Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_E_MULTIPURPOSE_FRAMES .

Definition at line 795 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_CANCEL_FRAME_PENDING_LOOKUP

#define RAIL_IEEE802154_SUPPORTS_CANCEL_FRAME_PENDING_LOOKUP RAIL_SUPPORTS_PROTOCOL_IEEE802154

Boolean to indicate whether the selected chip supports canceling the frame-pending lookup event RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND when the radio transitions to a state that renders the the reporting of this event moot (i.e., too late for the stack to influence the outgoing ACK).

See also runtime refinement RAIL_IEEE802154_SupportsCancelFramePendingLookup() .

Definition at line 925 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_COEX_PHY

#define RAIL_IEEE802154_SUPPORTS_COEX_PHY   0

Boolean to indicate whether the selected chip supports the 802.15.4 Wi-Fi Coexistence PHY.

See also runtime refinement RAIL_IEEE802154_SupportsCoexPhy() .

Definition at line 703 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_E_ENHANCED_ACK

#define RAIL_IEEE802154_SUPPORTS_E_ENHANCED_ACK RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868

Boolean to indicate whether the selected chip supports IEEE 802.15.4E-2012 Enhanced ACKing.

See also runtime refinement RAIL_IEEE802154_SupportsEEnhancedAck() .

Definition at line 764 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_E_MULTIPURPOSE_FRAMES

#define RAIL_IEEE802154_SUPPORTS_E_MULTIPURPOSE_FRAMES RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868

Boolean to indicate whether the selected chip supports receiving IEEE 802.15.4E-2012 Multipurpose frames.

See also runtime refinement RAIL_IEEE802154_SupportsEMultipurposeFrames() .

Definition at line 789 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868

#define RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868 RAIL_SUPPORTS_PROTOCOL_IEEE802154

Boolean to indicate whether the selected chip supports IEEE 802.15.4E-2012 feature subset needed for Zigbee R22 GB868.

See also runtime refinement RAIL_IEEE802154_SupportsESubsetGB868() .

Definition at line 738 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_EARLY_FRAME_PENDING_LOOKUP

#define RAIL_IEEE802154_SUPPORTS_EARLY_FRAME_PENDING_LOOKUP RAIL_SUPPORTS_PROTOCOL_IEEE802154

Boolean to indicate whether the selected chip supports early triggering of the frame-pending lookup event RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND just after MAC address fields have been received.

See also runtime refinement RAIL_IEEE802154_SupportsEarlyFramePendingLookup() .

Definition at line 955 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_FEM_PHY

#define RAIL_IEEE802154_SUPPORTS_FEM_PHY   ( RAIL_SUPPORTS_PROTOCOL_IEEE802154 && RAIL_SUPPORTS_2P4GHZ_BAND )

Boolean to indicate whether the selected chip supports a front end module.

See also runtime refinement RAIL_IEEE802154_SupportsFemPhy() .

Definition at line 720 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_G_4BYTE_CRC

#define RAIL_IEEE802154_SUPPORTS_G_4BYTE_CRC   0

Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 reception and transmission of frames with 4-byte CRC.

See also runtime refinement RAIL_IEEE802154_SupportsG4ByteCrc() .

Definition at line 844 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_G_SUBSET_GB868

#define RAIL_IEEE802154_SUPPORTS_G_SUBSET_GB868   ( RAIL_SUPPORTS_PROTOCOL_IEEE802154 && RAIL_SUPPORTS_SUBGHZ_BAND )

Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 feature subset needed for Zigbee R22 GB868.

See also runtime refinement RAIL_IEEE802154_SupportsGSubsetGB868() .

Definition at line 815 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_RX

#define RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_RX   0

Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 reception of unwhitened frames.

See also runtime refinement RAIL_IEEE802154_SupportsGUnwhitenedRx() .

Definition at line 869 of file rail_features.h .

RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_TX

#define RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_TX   0

Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 transmission of unwhitened frames.

See also runtime refinement RAIL_IEEE802154_SupportsGUnwhitenedTx() .

Definition at line 896 of file rail_features.h .

RAIL_SUPPORTS_2P4GHZ_BAND

#define RAIL_SUPPORTS_2P4GHZ_BAND   1

Boolean to indicate whether the selected chip supports the 2.4 GHz band.

See also runtime refinement RAIL_Supports2p4GHzBand() .

Definition at line 91 of file rail_features.h .

RAIL_SUPPORTS_ADDR_FILTER_ADDRESS_BIT_MASK

#define RAIL_SUPPORTS_ADDR_FILTER_ADDRESS_BIT_MASK   0

Boolean to indicate whether the selected chip supports bit masked address filtering.

See also runtime refinement RAIL_SupportsAddrFilterAddressBitMask() .

Definition at line 136 of file rail_features.h .

RAIL_SUPPORTS_ADDR_FILTER_MASK

#define RAIL_SUPPORTS_ADDR_FILTER_MASK   1

Boolean to indicate whether the selected chip supports address filter mask information for incoming packets in RAIL_RxPacketInfo_t::filterMask and RAIL_IEEE802154_Address_t::filterMask .

See also runtime refinement RAIL_SupportsAddrFilterMask() .

Definition at line 156 of file rail_features.h .

RAIL_SUPPORTS_ALTERNATE_TX_POWER

#define RAIL_SUPPORTS_ALTERNATE_TX_POWER   0

Boolean to indicate whether the selected chip supports alternate power settings for the Power Amplifier.

See also runtime refinement RAIL_SupportsAlternateTxPower() .

Definition at line 181 of file rail_features.h .

RAIL_SUPPORTS_ANTENNA_DIVERSITY

#define RAIL_SUPPORTS_ANTENNA_DIVERSITY   0

Boolean to indicate whether the selected chip supports antenna diversity.

See also runtime refinement RAIL_SupportsAntennaDiversity() .

Definition at line 203 of file rail_features.h .

RAIL_SUPPORTS_CHANNEL_HOPPING

#define RAIL_SUPPORTS_CHANNEL_HOPPING   0

Boolean to indicate whether the selected chip supports channel hopping.

See also runtime refinement RAIL_SupportsChannelHopping() .

Definition at line 226 of file rail_features.h .

RAIL_SUPPORTS_DIRECT_MODE

#define RAIL_SUPPORTS_DIRECT_MODE   0

Boolean to indicate whether the selected chip supports direct mode.

See also runtime refinement RAIL_SupportsDirectMode() .

Definition at line 1083 of file rail_features.h .

RAIL_SUPPORTS_DUAL_BAND

#define RAIL_SUPPORTS_DUAL_BAND   1

Boolean to indicate whether the selected chip supports both SubGHz and 2.4 GHz bands.

See also runtime refinement RAIL_SupportsDualBand() .

Definition at line 69 of file rail_features.h .

RAIL_SUPPORTS_DUAL_SYNC_WORDS

#define RAIL_SUPPORTS_DUAL_SYNC_WORDS   1

Boolean to indicate whether the selected chip supports dual sync words.

See also runtime refinement RAIL_SupportsDualSyncWords() .

Definition at line 244 of file rail_features.h .

RAIL_SUPPORTS_EXTERNAL_THERMISTOR

#define RAIL_SUPPORTS_EXTERNAL_THERMISTOR   0

Boolean to indicate whether the selected chip supports thermistor measurements.

See also runtime refinement RAIL_SupportsExternalThermistor() .

Definition at line 286 of file rail_features.h .

RAIL_SUPPORTS_MFM

#define RAIL_SUPPORTS_MFM   0

Boolean to indicate whether the selected chip supports MFM protocol.

See also runtime refinement RAIL_SupportsMfm() .

Definition at line 1123 of file rail_features.h .

RAIL_SUPPORTS_PRECISION_LFRCO

#define RAIL_SUPPORTS_PRECISION_LFRCO   0

Boolean to indicate whether the selected chip supports a high-precision LFRCO.

Best to use the runtime refinement RAIL_SupportsPrecisionLFRCO() because some chip revisions do not support it.

Definition at line 308 of file rail_features.h .

RAIL_SUPPORTS_PROTOCOL_BLE

#define RAIL_SUPPORTS_PROTOCOL_BLE RAIL_SUPPORTS_2P4GHZ_BAND

Boolean to indicate whether the selected chip supports BLE.

See also runtime refinement RAIL_SupportsProtocolBLE() .

Definition at line 388 of file rail_features.h .

RAIL_SUPPORTS_PROTOCOL_IEEE802154

#define RAIL_SUPPORTS_PROTOCOL_IEEE802154   1

Boolean to indicate whether the selected chip supports IEEE 802.15.4.

See also runtime refinement RAIL_SupportsProtocolIEEE802154() .

Definition at line 682 of file rail_features.h .

RAIL_SUPPORTS_PROTOCOL_ZWAVE

#define RAIL_SUPPORTS_PROTOCOL_ZWAVE   0

Boolean to indicate whether the selected chip supports Z-Wave.

See also runtime refinement RAIL_SupportsProtocolZWave() .

Definition at line 986 of file rail_features.h .

RAIL_SUPPORTS_RADIO_ENTROPY

#define RAIL_SUPPORTS_RADIO_ENTROPY   1

Boolean to indicate whether the selected chip supports radio entropy.

See also runtime refinement RAIL_SupportsRadioEntropy() .

Definition at line 324 of file rail_features.h .

RAIL_SUPPORTS_RFSENSE_ENERGY_DETECTION

#define RAIL_SUPPORTS_RFSENSE_ENERGY_DETECTION   0

Boolean to indicate whether the selected chip supports RFSENSE Energy Detection Mode.

See also runtime refinement RAIL_SupportsRfSenseEnergyDetection() .

Definition at line 345 of file rail_features.h .

RAIL_SUPPORTS_RFSENSE_SELECTIVE_OOK

#define RAIL_SUPPORTS_RFSENSE_SELECTIVE_OOK   0

Boolean to indicate whether the selected chip supports RFSENSE Selective(OOK) Mode.

See also runtime refinement RAIL_SupportsRfSenseSelectiveOok() .

Definition at line 365 of file rail_features.h .

RAIL_SUPPORTS_RX_DIRECT_MODE_DATA_TO_FIFO

#define RAIL_SUPPORTS_RX_DIRECT_MODE_DATA_TO_FIFO   0

Boolean to indicate whether the selected chip supports RX direct mode data to FIFO.

See also runtime refinement RAIL_SupportsRxDirectModeDataToFifo() .

Definition at line 1103 of file rail_features.h .

RAIL_SUPPORTS_SQ_PHY

#define RAIL_SUPPORTS_SQ_PHY   0

Boolean to indicate whether the selected chip supports SQ-based PHY.

See also runtime refinement RAIL_SupportsSQPhy() .

Definition at line 1042 of file rail_features.h .

RAIL_SUPPORTS_SUBGHZ_BAND

#define RAIL_SUPPORTS_SUBGHZ_BAND   1

Boolean to indicate whether the selected chip supports SubGHz bands.

See also runtime refinement RAIL_SupportsSubGHzBand() .

Definition at line 113 of file rail_features.h .

RAIL_SUPPORTS_TX_TO_TX

#define RAIL_SUPPORTS_TX_TO_TX   1

Boolean to indicate whether the selected chip supports automatic transitions from TX to TX.

See also runtime refinement RAIL_SupportsTxToTx() .

Definition at line 266 of file rail_features.h .

RAIL_ZWAVE_SUPPORTS_CONC_PHY

#define RAIL_ZWAVE_SUPPORTS_CONC_PHY   0

Boolean to indicate whether the selected chip supports concurrent PHY.

See also runtime refinement RAIL_ZWAVE_SupportsConcPhy() .

Definition at line 1024 of file rail_features.h .

RAIL_ZWAVE_SUPPORTS_ED_PHY

#define RAIL_ZWAVE_SUPPORTS_ED_PHY   0

Boolean to indicate whether the selected chip supports energy detect PHY.

See also runtime refinement RAIL_ZWAVE_SupportsEnergyDetectPhy() .

Definition at line 1006 of file rail_features.h .

RAIL_ZWAVE_SUPPORTS_REGION_PTI

#define RAIL_ZWAVE_SUPPORTS_REGION_PTI RAIL_SUPPORTS_PROTOCOL_ZWAVE

Boolean to indicate whether the code supports Z-Wave region information in PTI and newer RAIL_ZWAVE_RegionConfig_t structure See also runtime refinement RAIL_ZWAVE_SupportsRegionPti() .

Definition at line 1060 of file rail_features.h .

Function Documentation

RAIL_BLE_Supports1Mbps()

static bool RAIL_BLE_Supports1Mbps ( RAIL_Handle_t railHandle )
inline static

Indicate whether this chip supports BLE 1Mbps operation.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE 1Mbps operation is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_1MBPS .

Definition at line 455 of file rail_features.h .

RAIL_BLE_Supports1MbpsNonViterbi()

bool RAIL_BLE_Supports1MbpsNonViterbi ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE 1Mbps Non-Viterbi PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE 1Mbps Non-Viterbi is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_1MBPS_NON_VITERBI .

RAIL_BLE_Supports1MbpsViterbi()

bool RAIL_BLE_Supports1MbpsViterbi ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE 1Mbps Viterbi PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE 1Mbps Viterbi is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_1MBPS_VITERBI .

RAIL_BLE_Supports2Mbps()

static bool RAIL_BLE_Supports2Mbps ( RAIL_Handle_t railHandle )
inline static

Indicate whether this chip supports BLE 2Mbps operation.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE 2Mbps operation is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_2MBPS .

Definition at line 513 of file rail_features.h .

RAIL_BLE_Supports2MbpsNonViterbi()

bool RAIL_BLE_Supports2MbpsNonViterbi ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE 2Mbps Non-Viterbi PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE 2Mbps Non-Viterbi is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_2MBPS_NON_VITERBI .

RAIL_BLE_Supports2MbpsViterbi()

bool RAIL_BLE_Supports2MbpsViterbi ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE 2Mbps Viterbi PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE 2Mbps Viterbi is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_2MBPS_VITERBI .

RAIL_BLE_SupportsAntennaSwitching()

bool RAIL_BLE_SupportsAntennaSwitching ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE Antenna Switching needed for Angle-of-Arrival receives or Angle-of-Departure transmits.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE Antenna Switching is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_ANTENNA_SWITCHING .

RAIL_BLE_SupportsCodedPhy()

bool RAIL_BLE_SupportsCodedPhy ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE Coded PHY used for Long-Range.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE Coded PHY is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_CODED_PHY .

RAIL_BLE_SupportsCte()

bool RAIL_BLE_SupportsCte ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE CTE (Constant Tone Extension) needed for Angle-of-Arrival/Departure transmits.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE CTE is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_CTE .

RAIL_BLE_SupportsIQSampling()

bool RAIL_BLE_SupportsIQSampling ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE IQ Sampling needed for Angle-of-Arrival/Departure receives.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE IQ Sampling is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_IQ_SAMPLING .

RAIL_BLE_SupportsPhySwitchToRx()

bool RAIL_BLE_SupportsPhySwitchToRx ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE PHY switch to RX functionality, which is used to switch BLE PHYs at a specific time to receive auxiliary packets.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE PHY switch to RX is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_PHY_SWITCH_TO_RX .

RAIL_BLE_SupportsQuuppa()

bool RAIL_BLE_SupportsQuuppa ( RAIL_Handle_t railHandle )

Indicate whether this chip supports the Quuppa PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the Quuppa is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_QUUPPA .

RAIL_BLE_SupportsSimulscanPhy()

bool RAIL_BLE_SupportsSimulscanPhy ( RAIL_Handle_t railHandle )

Indicate whether this chip supports BLE Simulscan PHY used for simultaneous BLE 1Mbps and Coded PHY reception.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE Simulscan PHY is supported; false otherwise.

Runtime refinement of compile-time RAIL_BLE_SUPPORTS_SIMULSCAN_PHY .

RAIL_IEEE802154_SupportsCancelFramePendingLookup()

bool RAIL_IEEE802154_SupportsCancelFramePendingLookup ( RAIL_Handle_t railHandle )

Indicate whether this chip supports canceling the frame-pending lookup event RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND when the radio transitions to a state that renders the the reporting of this event moot (i.e., too late for the stack to influence the outgoing ACK).

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if canceling the lookup event is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_CANCEL_FRAME_PENDING_LOOKUP .

RAIL_IEEE802154_SupportsCoexPhy()

bool RAIL_IEEE802154_SupportsCoexPhy ( RAIL_Handle_t railHandle )

Indicate whether this chip supports the IEEE 802.15.4 Wi-Fi Coexistence PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the 802.15.4 Coex PHY is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_COEX_PHY .

RAIL_IEEE802154_SupportsEarlyFramePendingLookup()

bool RAIL_IEEE802154_SupportsEarlyFramePendingLookup ( RAIL_Handle_t railHandle )

Indicate whether this chip supports early triggering of the frame-pending lookup event RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND just after MAC address fields have been received.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if early triggering is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_EARLY_FRAME_PENDING_LOOKUP .

RAIL_IEEE802154_SupportsEEnhancedAck()

bool RAIL_IEEE802154_SupportsEEnhancedAck ( RAIL_Handle_t railHandle )

Indicate whether this chip supports IEEE 802.15.4E-2012 Enhanced ACKing.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if 802.15.4E Enhanced ACKing is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_E_ENHANCED_ACK .

RAIL_IEEE802154_SupportsEMultipurposeFrames()

bool RAIL_IEEE802154_SupportsEMultipurposeFrames ( RAIL_Handle_t railHandle )

Indicate whether this chip supports IEEE 802.15.4E-2012 Multipurpose frame reception.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if Multipurpose frame reception is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_E_MULTIPURPOSE_FRAMES .

RAIL_IEEE802154_SupportsESubsetGB868()

bool RAIL_IEEE802154_SupportsESubsetGB868 ( RAIL_Handle_t railHandle )

Indicate whether this chip supports the IEEE 802.15.4E-2012 feature subset needed for Zigbee R22 GB868.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if 802.15.4E GB868 subset is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868 .

RAIL_IEEE802154_SupportsFemPhy()

bool RAIL_IEEE802154_SupportsFemPhy ( RAIL_Handle_t railHandle )

Indicate whether this chip supports the IEEE 802.15.4 front end module optimized PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if a front end module is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_FEM_PHY .

RAIL_IEEE802154_SupportsG4ByteCrc()

bool RAIL_IEEE802154_SupportsG4ByteCrc ( RAIL_Handle_t railHandle )

Indicate whether this chip supports IEEE 802.15.4G-2012 reception and transmission of frames with 4-byte CRC.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if 802.15.4G 4-byte CRC is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_G_4BYTE_CRC .

RAIL_IEEE802154_SupportsGSubsetGB868()

bool RAIL_IEEE802154_SupportsGSubsetGB868 ( RAIL_Handle_t railHandle )

Indicate whether this chip supports IEEE 802.15.4G-2012 feature subset needed for Zigbee R22 GB868.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if 802.15.4G GB868 subset is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_G_SUBSET_GB868 .

RAIL_IEEE802154_SupportsGUnwhitenedRx()

bool RAIL_IEEE802154_SupportsGUnwhitenedRx ( RAIL_Handle_t railHandle )

Indicate whether this chip supports IEEE 802.15.4G-2012 reception of unwhitened frames.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if 802.15.4G unwhitened frame reception is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_RX .

RAIL_IEEE802154_SupportsGUnwhitenedTx()

bool RAIL_IEEE802154_SupportsGUnwhitenedTx ( RAIL_Handle_t railHandle )

Indicate whether this chip supports IEEE 802.15.4G-2012 transmission of unwhitened frames.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if 802.15.4G unwhitened frame transmit is supported; false otherwise.

Runtime refinement of compile-time RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_TX .

RAIL_Supports2p4GHzBand()

bool RAIL_Supports2p4GHzBand ( RAIL_Handle_t railHandle )

Indicate whether RAIL supports 2.4 GHz band operation on this chip.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the 2.4 GHz band is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_2P4GHZ_BAND .

RAIL_SupportsAddrFilterAddressBitMask()

bool RAIL_SupportsAddrFilterAddressBitMask ( RAIL_Handle_t railHandle )

Indicate whether this chip supports bit masked address filtering.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if bit masked address filtering is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_ADDR_FILTER_ADDRESS_BIT_MASK .

RAIL_SupportsAddrFilterMask()

bool RAIL_SupportsAddrFilterMask ( RAIL_Handle_t railHandle )

Indicate whether this chip supports address filter mask information for incoming packets in RAIL_RxPacketInfo_t::filterMask and RAIL_IEEE802154_Address_t::filterMask .

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if address filter information is supported; false otherwise (in which case RAIL_RxPacketInfo_t::filterMask value is undefined).

Runtime refinement of compile-time RAIL_SUPPORTS_ADDR_FILTER_MASK .

RAIL_SupportsAlternateTxPower()

bool RAIL_SupportsAlternateTxPower ( RAIL_Handle_t railHandle )

Indicate whether this chip supports alternate TX power settings.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if alternate TX power settings are supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_ALTERNATE_TX_POWER .

RAIL_SupportsAntennaDiversity()

bool RAIL_SupportsAntennaDiversity ( RAIL_Handle_t railHandle )

Indicate whether this chip supports antenna diversity.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if antenna diversity is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_ANTENNA_DIVERSITY .

Note
Certain radio configurations may not support this feature even if the chip in general claims to support it.

RAIL_SupportsChannelHopping()

bool RAIL_SupportsChannelHopping ( RAIL_Handle_t railHandle )

Indicate whether RAIL supports channel hopping on this chip.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if channel hopping is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_CHANNEL_HOPPING .

RAIL_SupportsDirectMode()

bool RAIL_SupportsDirectMode ( RAIL_Handle_t railHandle )

Indicate whether this chip supports direct mode.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if direct mode is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_DIRECT_MODE .

RAIL_SupportsDualBand()

bool RAIL_SupportsDualBand ( RAIL_Handle_t railHandle )

Indicate whether this chip supports dual 2.4 GHz and SubGHz band operation.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the dual band is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_DUAL_BAND .

RAIL_SupportsDualSyncWords()

bool RAIL_SupportsDualSyncWords ( RAIL_Handle_t railHandle )

Indicate whether this chip supports dual sync words.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if dual sync words are supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_DUAL_SYNC_WORDS .

Note
Certain radio configurations may not support this feature even if the chip in general claims to support it.

RAIL_SupportsExternalThermistor()

bool RAIL_SupportsExternalThermistor ( RAIL_Handle_t railHandle )

Indicate whether RAIL supports thermistor measurements on this chip.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if thermistor measurements are supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_EXTERNAL_THERMISTOR .

RAIL_SupportsMfm()

bool RAIL_SupportsMfm ( RAIL_Handle_t railHandle )

Indicate whether this chip supports MFM protocol.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if MFM protocol is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_MFM .

RAIL_SupportsPrecisionLFRCO()

bool RAIL_SupportsPrecisionLFRCO ( RAIL_Handle_t railHandle )

Indicate whether this chip supports a high-precision LFRCO.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if high-precision LFRCO is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_PRECISION_LFRCO .

RAIL_SupportsProtocolBLE()

bool RAIL_SupportsProtocolBLE ( RAIL_Handle_t railHandle )

Indicate whether RAIL supports the BLE protocol on this chip.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if BLE is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_PROTOCOL_BLE .

RAIL_SupportsProtocolIEEE802154()

bool RAIL_SupportsProtocolIEEE802154 ( RAIL_Handle_t railHandle )

Indicate whether this chip supports the IEEE 802.15.4 protocol.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the 802.15.4 protocol is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_PROTOCOL_IEEE802154 .

RAIL_SupportsProtocolZWave()

bool RAIL_SupportsProtocolZWave ( RAIL_Handle_t railHandle )

Indicate whether this chip supports the Z-Wave protocol.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the Z-Wave protocol is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_PROTOCOL_ZWAVE .

RAIL_SupportsRadioEntropy()

bool RAIL_SupportsRadioEntropy ( RAIL_Handle_t railHandle )

Indicate whether this chip supports radio entropy.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if radio entropy is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_RADIO_ENTROPY .

RAIL_SupportsRfSenseEnergyDetection()

bool RAIL_SupportsRfSenseEnergyDetection ( RAIL_Handle_t railHandle )

Indicate whether RAIL supports RFSENSE Energy Detection Mode on this chip.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if RFSENSE Energy Detection Mode is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_RFSENSE_ENERGY_DETECTION .

RAIL_SupportsRfSenseSelectiveOok()

bool RAIL_SupportsRfSenseSelectiveOok ( RAIL_Handle_t railHandle )

Indicate whether RAIL supports RFSENSE Selective(OOK) Mode on this chip.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if RFSENSE Selective(OOK) Mode is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_RFSENSE_SELECTIVE_OOK .

RAIL_SupportsRxDirectModeDataToFifo()

bool RAIL_SupportsRxDirectModeDataToFifo ( RAIL_Handle_t railHandle )

Indicate whether this chip supports RX direct mode data to FIFO.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if direct mode data to FIFO is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_RX_DIRECT_MODE_DATA_TO_FIFO .

RAIL_SupportsSQPhy()

bool RAIL_SupportsSQPhy ( RAIL_Handle_t railHandle )

Indicate whether this chip supports SQ-based PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the SQ-based PHY is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_SQ_PHY .

RAIL_SupportsSubGHzBand()

bool RAIL_SupportsSubGHzBand ( RAIL_Handle_t railHandle )

Indicate whether RAIL supports SubGHz band operation on this chip.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the SubGHz band is supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_SUBGHZ_BAND .

RAIL_SupportsTxPowerMode()

bool RAIL_SupportsTxPowerMode ( RAIL_Handle_t railHandle,
RAIL_TxPowerMode_t powerMode,
RAIL_TxPowerLevel_t * pMaxPowerLevel
)

Indicate whether this chip supports a particular power mode (PA).

Note
Consider using RAIL_SupportsTxPowerModeAlt to also get the power mode's lowest allowed power level.
Parameters
[in] railHandle A RAIL instance handle.
[in] powerMode The power mode to check if supported.
[out] pMaxPowerLevel A pointer to a RAIL_TxPowerLevel_t that if non-NULL will be filled in with the power mode's highest power level allowed if this function returns true.
Returns
true if the powerMode is supported; false otherwise.

This function has no compile-time equivalent.

RAIL_SupportsTxPowerModeAlt()

bool RAIL_SupportsTxPowerModeAlt ( RAIL_Handle_t railHandle,
RAIL_TxPowerMode_t * powerMode,
RAIL_TxPowerLevel_t * maxPowerLevel,
RAIL_TxPowerLevel_t * minPowerLevel
)

Indicate whether this chip supports a particular power mode (PA) and provides the maximum and minimum power level for that power mode if supported by the chip.

Parameters
[in] railHandle A RAIL instance handle.
[in,out] powerMode A pointer to PA power mode to check if supported. In case of RAIL_TX_POWER_MODE_2P4_HIGHEST or RAIL_TX_POWER_MODE_SUBGIG_HIGHEST is used as input then the highest selected PA on the chip is updated here.
[out] maxPowerLevel A pointer to a RAIL_TxPowerLevel_t that if non-NULL will be filled in with the power mode's highest power level allowed if this function returns RAIL_STATUS_NO_ERROR .
[out] minPowerLevel A pointer to a RAIL_TxPowerLevel_t that if non-NULL will be filled in with the power mode's lowest power level allowed if this function returns RAIL_STATUS_NO_ERROR .
Returns
true if powerMode is supported; false otherwise.

RAIL_SupportsTxToTx()

bool RAIL_SupportsTxToTx ( RAIL_Handle_t railHandle )

Indicate whether this chip supports automatic TX to TX transitions.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if TX to TX transitions are supported; false otherwise.

Runtime refinement of compile-time RAIL_SUPPORTS_TX_TO_TX .

RAIL_ZWAVE_SupportsConcPhy()

bool RAIL_ZWAVE_SupportsConcPhy ( RAIL_Handle_t railHandle )

Indicate whether this chip supports the Z-Wave concurrent PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the Z-Wave concurrent PHY is supported; false otherwise.

Runtime refinement of compile-time RAIL_ZWAVE_SUPPORTS_CONC_PHY .

RAIL_ZWAVE_SupportsEnergyDetectPhy()

bool RAIL_ZWAVE_SupportsEnergyDetectPhy ( RAIL_Handle_t railHandle )

Indicate whether this chip supports the Z-Wave energy detect PHY.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if the Z-Wave energy detect PHY is supported; false otherwise.

Runtime refinement of compile-time RAIL_ZWAVE_SUPPORTS_ED_PHY .

RAIL_ZWAVE_SupportsRegionPti()

bool RAIL_ZWAVE_SupportsRegionPti ( RAIL_Handle_t railHandle )

Indicate whether this chip supports Z-Wave Region in PTI.

Parameters
[in] railHandle A RAIL instance handle.
Returns
true if ZWAVE Region in PTI is supported; false otherwise.

Runtime refinement of compile-time RAIL_ZWAVE_SUPPORTS_REGION_PTI .