Auxiliary header for the RAIL library.
Includes consistent definitions of features available across different chips.
License#
Copyright 2020 Silicon Laboratories Inc. www.silabs.com
SPDX-License-Identifier: Zlib
The licensor of this software is Silicon Laboratories Inc.
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
This notice may not be removed or altered from any source distribution.
Macros#
Boolean to indicate whether the selected chip supports both SubGHz and 2.4 GHz bands.
Backwards-compatible synonym of RAIL_SUPPORTS_DUAL_BAND.
Boolean to indicate whether the selected chip supports the 2.4 GHz band.
Backwards-compatible synonym of RAIL_SUPPORTS_2P4GHZ_BAND.
Boolean to indicate whether the selected chip supports SubGHz bands.
Backwards-compatible synonym of RAIL_SUPPORTS_SUBGHZ_BAND.
Boolean to indicate whether the selected chip supports OFDM PA.
Boolean to indicate whether the selected chip supports bit masked address filtering.
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.
Boolean to indicate whether the selected chip supports alternate power settings for the Power Amplifier.
Backwards-compatible synonym of RAIL_SUPPORTS_ALTERNATE_TX_POWER.
Boolean to indicate whether the selected chip supports antenna diversity.
Backwards-compatible synonym of RAIL_SUPPORTS_ANTENNA_DIVERSITY.
Boolean to indicate whether the selected chip supports RF path diversity.
Boolean to indicate whether the selected chip supports channel hopping.
Backwards-compatible synonym of RAIL_SUPPORTS_CHANNEL_HOPPING.
Boolean to indicate whether the selected chip supports dual sync words.
Boolean to indicate whether the selected chip supports automatic transitions from TX to TX.
Boolean to indicate whether the selected chip supports RAIL_TX_REPEAT_OPTION_START_TO_START.
Boolean to indicate whether the selected chip supports thermistor measurements.
Backwards-compatible synonym of RAIL_SUPPORTS_EXTERNAL_THERMISTOR.
Boolean to indicate whether the selected chip supports HFXO compensation.
Boolean to indicate whether the selected chip supports AUXADC measurements.
Boolean to indicate whether the selected chip supports a high-precision LFRCO.
Boolean to indicate whether the selected chip supports radio entropy.
Boolean to indicate whether the selected chip supports RFSENSE Energy Detection Mode.
Boolean to indicate whether the selected chip supports RFSENSE Selective(OOK) Mode.
Backwards-compatible synonym of RAIL_SUPPORTS_RFSENSE_SELECTIVE_OOK.
Boolean to indicate whether the selected chip supports the VDET voltage measurement feature.
Boolean to indicate whether the selected chip supports BLE.
Boolean to indicate whether the selected chip supports BLE 1Mbps Non-Viterbi PHY.
Boolean to indicate whether the selected chip supports BLE 1Mbps Viterbi PHY.
Boolean to indicate whether the selected chip supports BLE 1Mbps operation.
Boolean to indicate whether the selected chip supports BLE 2Mbps Non-Viterbi PHY.
Boolean to indicate whether the selected chip supports BLE 2Mbps Viterbi PHY.
Boolean to indicate whether the selected chip supports BLE 2Mbps operation.
Boolean to indicate whether the selected chip supports BLE Antenna Switching needed for Angle-of-Arrival receives or Angle-of-Departure transmits.
Boolean to indicate whether the selected chip supports the BLE Coded PHY used for Long-Range.
Backwards-compatible synonym of RAIL_BLE_SUPPORTS_CODED_PHY.
Boolean to indicate whether the selected chip supports the BLE Simulscan PHY used for simultaneous BLE 1Mbps and Coded PHY reception.
Boolean to indicate whether the selected chip supports BLE CTE (Constant Tone Extension) needed for Angle-of-Arrival/Departure transmits.
Boolean to indicate whether the selected chip supports the Quuppa PHY.
Boolean to indicate whether the selected chip supports BLE IQ Sampling needed for Angle-of-Arrival/Departure receives.
Boolean to indicate whether the selected chip supports some BLE AOX features.
Backwards-compatible synonym of RAIL_BLE_SUPPORTS_AOX.
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.
Backwards-compatible synonym of RAIL_BLE_SUPPORTS_PHY_SWITCH_TO_RX.
Boolean to indicate whether the selected chip supports IEEE 802.15.4.
Boolean to indicate whether the selected chip supports the 802.15.4 Wi-Fi Coexistence PHY.
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_COEX_PHY.
Boolean to indicate whether the selected chip supports the IEEE 802.15.4 2.4 GHz band variant.
Boolean to indicate whether the selected chip supports the IEEE 802.15.4 2.4 RX channel switching.
Boolean to indicate whether the selected chip supports a front end module.
Boolean to indicate whether the selected chip supports IEEE 802.15.4E-2012 feature subset needed for Zigbee R22 GB868.
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_E_SUBSET_GB868.
Boolean to indicate whether the selected chip supports IEEE 802.15.4E-2012 Enhanced ACKing.
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_E_ENHANCED_ACK.
Boolean to indicate whether the selected chip supports receiving IEEE 802.15.4E-2012 Multipurpose frames.
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_E_MULTIPURPOSE_FRAMES.
Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 feature subset needed for Zigbee R22 GB868.
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_SUBSET_GB868.
Boolean to indicate whether the selected chip supports dynamic FEC See also runtime refinement RAIL_IEEE802154_SupportsGDynFec().
Boolean to indicate whether the selected chip supports Wi-SUN mode switching See also runtime refinement RAIL_IEEE802154_SupportsGModeSwitch().
Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 reception and transmission of frames with 4-byte CRC.
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_4BYTE_CRC.
Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 reception of unwhitened frames.
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_RX.
Boolean to indicate whether the selected chip supports IEEE 802.15.4G-2012 transmission of unwhitened frames.
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_G_UNWHITENED_TX.
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).
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_CANCEL_FRAME_PENDING_LOOKUP.
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.
Backwards-compatible synonym of RAIL_IEEE802154_SUPPORTS_EARLY_FRAME_PENDING_LOOKUP.
Boolean to indicate whether the selected chip supports dual PA configs for mode switch or concurrent mode.
Boolean to indicate whether the selected chip supports the pa power setting table.
Boolean to indicate whether the selected chip supports IEEE 802.15.4 PHY with custom settings.
Boolean to indicate whether the selected chip supports Wi-SUN See also runtime refinement RAIL_SupportsProtocolWiSUN().
Boolean to indicate whether the selected chip supports WMBUS simultaneous M2O RX of T and C modes set by RAIL_WMBUS_Config().
Boolean to indicate whether the selected chip supports Z-Wave.
Backwards-compatible synonym of RAIL_SUPPORTS_PROTOCOL_ZWAVE.
Boolean to indicate whether the selected chip supports energy detect PHY.
Boolean to indicate whether the selected chip supports concurrent PHY.
Boolean to indicate whether the selected chip supports SQ-based PHY.
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().
Backwards-compatible synonym of RAIL_ZWAVE_SUPPORTS_REGION_PTI.
Boolean to indicate whether the selected chip supports raw RX data sources other than RAIL_RxDataSource_t::RX_PACKET_DATA.
Boolean to indicate whether the selected chip supports direct mode.
Boolean to indicate whether the selected chip supports RX direct mode data to FIFO.
Boolean to indicate whether the selected chip supports MFM protocol.
Boolean to indicate whether the selected chip supports 802.15.4 signal detection.
Boolean to indicate whether the selected chip supports BLE signal detection.
Boolean to indicate whether the selected chip supports configurable RSSI threshold set by RAIL_SetRssiDetectThreshold().
Boolean to indicate whether the selected chip supports thermal protection set by RAIL_ConfigThermalProtection().
Boolean to indicate whether the selected chip supports fast RX2RX enabled by RAIL_RX_OPTION_FAST_RX2RX.
Boolean to indicate whether the selected chip supports collision detection enabled by RAIL_RX_OPTION_ENABLE_COLLISION_DETECTION See also runtime refinement RAIL_SupportsCollisionDetection().
Boolean to indicate whether the selected chip supports Sidewalk protocol.
Boolean to indicate whether the selected chip supports automatic LNA bypass for external FEM.