RAIL_BLE_RX_SUBPHY_ID_500K#

#define RAIL_BLE_RX_SUBPHY_ID_500K

(0U)

RAIL_RxPacketDetails_t::subPhyId indicating a 500 kbps packet.

RAIL_BLE_RX_SUBPHY_ID_125K#

#define RAIL_BLE_RX_SUBPHY_ID_125K

(1U)

RAIL_RxPacketDetails_t::subPhyId indicating a 125 kbps packet.

RAIL_BLE_RX_SUBPHY_ID_1M#

#define RAIL_BLE_RX_SUBPHY_ID_1M

(2U)

RAIL_RxPacketDetails_t::subPhyId value indicating a 1 Mbps packet.

RAIL_BLE_RX_SUBPHY_ID_INVALID#

#define RAIL_BLE_RX_SUBPHY_ID_INVALID

(3U)

RAIL_RxPacketDetails_t::subPhyId invalid value.

RAIL_BLE_RX_SUBPHY_COUNT#

#define RAIL_BLE_RX_SUBPHY_COUNT

(4U)

The total count of BLE subPhyId's.

Must be last.

RAIL_BLE_EnableSignalIdentifier#

#define RAIL_BLE_EnableSignalIdentifier

RAIL_BLE_EnableSignalDetection

Backward compatible name for the RAIL_BLE_EnableSignalDetection API.

RAIL_BLE_AOX_ANTENNA_PIN_COUNT#

#define RAIL_BLE_AOX_ANTENNA_PIN_COUNT

(6U)

The maximum number of GPIO pins used for AoX Antenna switching.

If the user configures more pins using RAIL_BLE_ConfigAoxAntenna() than allowed RAIL_BLE_AOX_ANTENNA_PIN_COUNT, then RAIL_STATUS_INVALID_PARAMETER status will be returned.

RAIL_STATUS_INVALID_CALL is returned if : RAIL_BLE_AOX_ANTENNA_PIN_COUNT is set to 0 or the user configures no pins.

The maximum value RAIL_BLE_AOX_ANTENNA_PIN_COUNT can take depends on number of Antenna route pins , a chip provides. For EFR32xG22, the maximum value of RAIL_BLE_AOX_ANTENNA_PIN_COUNT is 6. If the user configures fewer pins than RAIL_BLE_AOX_ANTENNA_PIN_COUNT, then only number of pins asked by user will be configured with RAIL_STATUS_NO_ERROR.

RAIL_BLE_AOX_OPTIONS_DO_SWITCH#

#define RAIL_BLE_AOX_OPTIONS_DO_SWITCH

(0U)

DeprecatedObsolete AOX option

RAIL_BLE_AOX_OPTIONS_TX_ENABLED#

#define RAIL_BLE_AOX_OPTIONS_TX_ENABLED

(0U)

DeprecatedObsolete AOX option

RAIL_BLE_AOX_OPTIONS_RX_ENABLED#

#define RAIL_BLE_AOX_OPTIONS_RX_ENABLED

(0U)

DeprecatedObsolete AOX option

RAIL_BLE_AOX_OPTIONS_LOCK_CTE_BUFFER_SHIFT#

#define RAIL_BLE_AOX_OPTIONS_LOCK_CTE_BUFFER_SHIFT

RAIL_BLE_AOX_OPTIONS_DISABLE_BUFFER_LOCK_SHIFT

DeprecatedPlease use RAIL_BLE_AOX_OPTIONS_DISABLE_BUFFER_LOCK_SHIFT instead.

RAIL_BLE_AOX_OPTIONS_DISABLED#

#define RAIL_BLE_AOX_OPTIONS_DISABLED

(0U)

Disable the AoX feature.

RAIL_BLE_AOX_OPTIONS_SAMPLE_MODE#

#define RAIL_BLE_AOX_OPTIONS_SAMPLE_MODE

(1U << RAIL_BLE_AOX_OPTIONS_SAMPLE_MODE_SHIFT)

Sets one of the two AoX sampling/switching modes: 1 us or 2 us window.

RAIL_BLE_AOX_OPTIONS_CONNLESS#

#define RAIL_BLE_AOX_OPTIONS_CONNLESS

(1U << RAIL_BLE_AOX_OPTIONS_CONNLESS_SHIFT)

Enables connectionless AoX Rx packets.

RAIL_BLE_AOX_OPTIONS_CONN#

#define RAIL_BLE_AOX_OPTIONS_CONN

(1U << RAIL_BLE_AOX_OPTIONS_CONN_SHIFT)

Enables connection based AoX Rx packets.

RAIL_BLE_AOX_OPTIONS_DISABLE_BUFFER_LOCK#

#define RAIL_BLE_AOX_OPTIONS_DISABLE_BUFFER_LOCK

(1U << RAIL_BLE_AOX_OPTIONS_DISABLE_BUFFER_LOCK_SHIFT)

Disables CTE buffer lock.

RAIL_BLE_AOX_OPTIONS_ENABLED#

#define RAIL_BLE_AOX_OPTIONS_ENABLED

(RAIL_BLE_AOX_OPTIONS_CONN | RAIL_BLE_AOX_OPTIONS_CONNLESS)

Enables connection based or connectionless AoX Rx packets.

RAIL_BLE_Coding_t#

RAIL_BLE_Coding_t

The variant of the BLE Coded PHY.

RAIL_BLE_Phy_t#

RAIL_BLE_Phy_t

The variant of the BLE PHY.

RAIL_BLE_SignalIdentifierMode_t#

RAIL_BLE_SignalIdentifierMode_t

Available Signal Identifier modes.

RAIL_BLE_AoxOptions_t#

RAIL_BLE_AoxOptions_t

Angle of Arrival/Departure options bit fields.

RAIL_BLE_Phy1Mbps#

const RAIL_ChannelConfig_t* const RAIL_BLE_Phy1Mbps

Default PHY to use for BLE 1 Mbps non-Viterbi.

Will be NULL if RAIL_BLE_SUPPORTS_1MBPS_NON_VITERBI is 0.

RAIL_BLE_Phy2Mbps#

const RAIL_ChannelConfig_t* const RAIL_BLE_Phy2Mbps

Default PHY to use for BLE 2 Mbps non-Viterbi.

Will be NULL if RAIL_BLE_SUPPORTS_2MBPS_NON_VITERBI is 0.

RAIL_BLE_Phy1MbpsViterbi#

const RAIL_ChannelConfig_t* const RAIL_BLE_Phy1MbpsViterbi

Default PHY to use for BLE 1 Mbps Viterbi.

Will be NULL if RAIL_BLE_SUPPORTS_1MBPS_VITERBI is 0.

RAIL_BLE_Phy2MbpsViterbi#

const RAIL_ChannelConfig_t* const RAIL_BLE_Phy2MbpsViterbi

Default PHY to use for BLE 2 Mbps Viterbi.

Will be NULL if RAIL_BLE_SUPPORTS_2MBPS_VITERBI is 0.

RAIL_BLE_Phy2MbpsAox#

const RAIL_ChannelConfig_t* const RAIL_BLE_Phy2MbpsAox

PHY to use for BLE 2 Mbps with AoX functionality.

Will be NULL if either RAIL_BLE_SUPPORTS_2MBPS_VITERBI or RAIL_BLE_SUPPORTS_AOX is 0.

RAIL_BLE_Phy125kbps#

const RAIL_ChannelConfig_t* const RAIL_BLE_Phy125kbps

Default PHY to use for BLE Coded 125 kbps.

Will be NULL if RAIL_BLE_SUPPORTS_CODED_PHY is 0. This PHY can receive on both 125 kbps and 500 kbps BLE Coded, but will only transmit at 125 kbps.

RAIL_BLE_Phy500kbps#

const RAIL_ChannelConfig_t* const RAIL_BLE_Phy500kbps

Default PHY to use for BLE Coded 500 kbps.

Will be NULL if RAIL_BLE_SUPPORTS_CODED_PHY is 0. This PHY can receive on both 125 kbps and 500 kbps BLE Coded, but will only transmit at 125 kbps.

RAIL_BLE_PhySimulscan#

const RAIL_ChannelConfig_t* const RAIL_BLE_PhySimulscan

Default PHY to use for BLE Simulscan.

Will be NULL if RAIL_BLE_SUPPORTS_SIMULSCAN_PHY is 0. This PHY can receive on 1 Mbps as well as 125 kbps and 500 kbps BLE Coded, but will only transmit at 1 Mbps.

RAIL_BLE_PhyQuuppa#

const RAIL_ChannelConfig_t* const RAIL_BLE_PhyQuuppa

Default 1 Mbps Quuppa PHY.

Will be NULL if RAIL_BLE_SUPPORTS_QUUPPA is 0.

RAIL_BLE_Init#

RAIL_Status_t RAIL_BLE_Init (RAIL_Handle_t railHandle)

Configure RAIL to run in BLE mode.

Returns

• Status code indicating success of the function call.

This function changes your radio, channel configuration, and other parameters to match what is needed for BLE, initially establishing the BLE 1 Mbps PHY. To switch back to a default RAIL mode, call RAIL_BLE_Deinit() first. This function will configure the protocol output on PTI to RAIL_PTI_PROTOCOL_BLE.

Note

• BLE may not be enabled while Auto-ACKing is enabled.

RAIL_BLE_Deinit#

RAIL_Status_t RAIL_BLE_Deinit (RAIL_Handle_t railHandle)

Take RAIL out of BLE mode.

Returns

• Status code indicating success of the function call.

This function will undo some of the configuration that happens when you call RAIL_BLE_Init(). After this you can safely run your normal radio initialization code to use a non-BLE configuration. This function does not change back your radio or channel configurations so you must do this by manually reinitializing. This also resets the protocol output on PTI to RAIL_PTI_PROTOCOL_CUSTOM.

RAIL_BLE_IsEnabled#

bool RAIL_BLE_IsEnabled (RAIL_Handle_t railHandle)

Determine whether BLE mode is enabled or not.

Returns

• true if BLE mode is enabled and false otherwise.

This function returns the current status of RAIL's BLE mode. It is enabled by a call to RAIL_BLE_Init() and disabled by a call to RAIL_BLE_Deinit().

RAIL_BLE_ConfigPhyQuuppa#

RAIL_Status_t RAIL_BLE_ConfigPhyQuuppa (RAIL_Handle_t railHandle)

Switch to the 1 Mbps Quuppa PHY.

Returns

• Status code indicating success of the function call.

You can use this function to switch to the Quuppa PHY.

Note

• Not all chips support the 1 Mbps Quuppa PHY. This API should return RAIL_STATUS_INVALID_CALL if unsupported by the hardware we're building for.

RAIL_BLE_ConfigPhy1MbpsViterbi#

RAIL_Status_t RAIL_BLE_ConfigPhy1MbpsViterbi (RAIL_Handle_t railHandle)

Switch to the Viterbi 1 Mbps BLE PHY.

Returns

• Status code indicating success of the function call.

Use this function to switch back to the default BLE 1 Mbps PHY if you have switched to the 2 Mbps or another configuration. You may only call this function after initializing BLE and while the radio is idle.

RAIL_BLE_ConfigPhy1Mbps#

RAIL_Status_t RAIL_BLE_ConfigPhy1Mbps (RAIL_Handle_t railHandle)

Switch to the legacy non-Viterbi 1 Mbps BLE PHY.

Returns

• Status code indicating success of the function call.

Use this function to switch back to the legacy BLE 1 Mbps PHY if you have switched to the 2 Mbps or another configuration. You may only call this function after initializing BLE and while the radio is idle.

DeprecatedBLE non-Viterbi PHYs are no longer supported.

RAIL_BLE_ConfigPhy2MbpsViterbi#

RAIL_Status_t RAIL_BLE_ConfigPhy2MbpsViterbi (RAIL_Handle_t railHandle)

Switch to the Viterbi 2 Mbps BLE PHY.

Returns

• Status code indicating success of the function call.

Use this function to switch back to the BLE 2 Mbps PHY from the default 1 Mbps option. You may only call this function after initializing BLE and while the radio is idle.

RAIL_BLE_ConfigPhy2Mbps#

RAIL_Status_t RAIL_BLE_ConfigPhy2Mbps (RAIL_Handle_t railHandle)

Switch to the legacy non-Viterbi 2 Mbps BLE PHY.

Returns

• Status code indicating success of the function call.

Use this function to switch back to legacy BLE 2 Mbps PHY from the default 1 Mbps option. You may only call this function after initializing BLE and while the radio is idle.

DeprecatedBLE non-Viterbi PHYs are no longer supported.

RAIL_BLE_ConfigPhyCoded#

RAIL_Status_t RAIL_BLE_ConfigPhyCoded (RAIL_Handle_t railHandle, RAIL_BLE_Coding_t bleCoding)

Switch to the BLE Coded PHY.

Returns

• Status code indicating success of the function call.

Use this function to switch back to BLE Coded PHY from the default 1 Mbps option. You may only call this function after initializing BLE and while the radio is idle. When using a BLE Coded PHY, the RAIL_RxPacketDetails_t::subPhyId marks the coding of the received packet. A subPhyId of 0 marks a 500 kbps packet, and a subPhyId of 1 marks a 125 kbps packet.

RAIL_BLE_ConfigPhySimulscan#

RAIL_Status_t RAIL_BLE_ConfigPhySimulscan (RAIL_Handle_t railHandle)

Switch to the Simulscan PHY.

Returns

• Status code indicating success of the function call.

Use this function to switch to the BLE Simulscan PHY. You may only call this function after initializing BLE and while the radio is idle. When using Simulscan PHY, the RAIL_RxPacketDetails_t::subPhyId marks the coding of the received packet. A subPhyId of 0 marks a 500 kbps packet, a subPhyId of 1 marks a 125 kbps packet, and a subPhyId of 2 marks a 1 Mbps packet.

Note

• : The Simulscan PHY is supported only on some parts. The preprocessor symbol RAIL_BLE_SUPPORTS_SIMULSCAN_PHY and the runtime function RAIL_BLE_SupportsSimulscanPhy() may be used to test for support of the Simulscan PHY.

RAIL_BLE_ConfigChannelRadioParams#

RAIL_Status_t RAIL_BLE_ConfigChannelRadioParams (RAIL_Handle_t railHandle, uint32_t crcInit, uint32_t accessAddress, uint16_t channel, bool disableWhitening)

Change BLE radio parameters.

Returns

• Status code indicating success of the function call.

This function can be used to switch radio parameters on every connection and/or channel change. It is BLE-aware and will set the access address, preamble, CRC initialization value, and whitening configuration without requiring you to load a new radio configuration. This function should be called after switching to a particular BLE phy (1 Mbps, 2 Mbps, etc.) and not while the radio is active.

RAIL_BLE_PhySwitchToRx#

RAIL_Status_t RAIL_BLE_PhySwitchToRx (RAIL_Handle_t railHandle, RAIL_BLE_Phy_t phy, uint16_t railChannel, RAIL_Time_t startRxTime, uint32_t crcInit, uint32_t accessAddress, uint16_t logicalChannel, bool disableWhitening)

Change the current BLE PHY and go into receive.

Returns

• Status code indicating success of the function call.

This function is used to implement auxiliary packet reception, as defined in the BLE specification. The radio will be put into IDLE, the PHY and channel will be changed, and then receive will be entered at the start time given. The new receive will have a timeout of 30 us, which means that this function should only be called if the offset unit is 30 us.

This function is extremely time-sensitive, and may only be called within the interrupt context of a RAIL_EVENT_RX_PACKET_RECEIVED event.

RAIL_BLE_ConfigSignalIdentifier#

RAIL_Status_t RAIL_BLE_ConfigSignalIdentifier (RAIL_Handle_t railHandle, RAIL_BLE_SignalIdentifierMode_t signalIdentifierMode)

Configure and enable signal identifier for BLE signal detection.

Returns

• Status code indicating success of the function call.

This features allows detection of BLE signal on air based on the mode. This function must be called once before RAIL_BLE_EnableSignalDetection to configure and enable signal identifier.

To enable event for signal detection RAIL_ConfigEvents() must be called for enabling RAIL_EVENT_SIGNAL_DETECTED.

This function is only supported by chips where RAIL_BLE_SUPPORTS_SIGNAL_IDENTIFIER and RAIL_BLE_SupportsSignalIdentifier() are true.

RAIL_BLE_EnableSignalDetection#

RAIL_Status_t RAIL_BLE_EnableSignalDetection (RAIL_Handle_t railHandle, bool enable)

Enable or disable signal identifier interrupt for BLE signal detection.

Returns

• Status code indicating success of the function call.

RAIL_BLE_ConfigSignalIdentifier() must be called once before calling this function to configure and enable signal identifier. Once a signal is detected signal detection will be turned off and this function should be called to re-enable the signal detection without needing to call RAIL_BLE_ConfigSignalIdentifier() if the signal identifier is already configured and enabled.

This function is only supported by chips where RAIL_BLE_SUPPORTS_SIGNAL_IDENTIFIER and RAIL_BLE_SupportsSignalIdentifier() are true.

RAIL_BLE_LockCteBuffer#

bool RAIL_BLE_LockCteBuffer (RAIL_Handle_t railHandle, bool lock)

Lock/unlock the CTE buffer from the application's perspective.

The radio will write to the buffer only if the bit is NOT set at the beginning of the sampling period. The radio will set the bit once the sampling period starts to indicate that some CTE data has been collected, which will not be overwritten during the next sampling period, unless the buffer is unlocked by the application.

Returns

• true if the CTE buffer is locked after the call, otherwise false.

RAIL_BLE_CteBufferIsLocked#

bool RAIL_BLE_CteBufferIsLocked (RAIL_Handle_t railHandle)

Determine whether the CTE buffer is currently locked or not.

Returns

• true if CTE buffer is locked and false otherwise.

RAIL_BLE_GetCteSampleOffset#

uint8_t RAIL_BLE_GetCteSampleOffset (RAIL_Handle_t railHandle)

Get the offset into CTE sample of CTE data.

Returns

• The offset of CTE data in a CTE sample in bytes. On unsupported platforms this returns 0.

RAIL_BLE_GetCteSampleRate#

uint32_t RAIL_BLE_GetCteSampleRate (RAIL_Handle_t railHandle)

Get the effective sample rate used by the ADC to capture the CTE samples.

Returns

• The actual sample rate used to capture the CTE in samples per second. On unsupported platforms this returns 0.

RAIL_BLE_ConfigAox#

RAIL_Status_t RAIL_BLE_ConfigAox (RAIL_Handle_t railHandle, const RAIL_BLE_AoxConfig_t * aoxConfig)

Configure Angle of Arrival/Departure (AoX) functionality.

Returns

• Status code indicating success of the function call.

AoX is a method of radio localization which infers angle of arrival/departure of the signal based on different phases of the raw I/Q signal from different antennas by controlling external RF switch during the continuous tone extension (CTE). Connection based AoX packets are different than normal BLE packets in that they have 3 header bytes instead of 2 and they have CTE appended after the payload's CRC. 3rd byte or CTE info contains CTE length. Connectionless AoX packets have 2 header bytes and CTE info is part of the payload.

Note

• Calling RAIL_GetRadioEntropy() during AoX reception may break packet reception.

RAIL_BLE_InitCte#

RAIL_Status_t RAIL_BLE_InitCte (RAIL_Handle_t railHandle)

Perform one time initialization of AoX registers.

This function must be called before RAIL_BLE_ConfigAox() and before configuring the BLE PHY.

Returns

• Status code indicating success of the function call.

RAIL_BLE_ConfigAoxAntenna#

RAIL_Status_t RAIL_BLE_ConfigAoxAntenna (RAIL_Handle_t railHandle, RAIL_BLE_AoxAntennaConfig_t * antennaConfig)

Perform initialization of AoX antenna GPIO pins.

This function must be called before calls to RAIL_BLE_InitCte() and RAIL_BLE_ConfigAox(), and before configuring the BLE PHY, else a RAIL_STATUS_INVALID_CALL is returned.

If user configures more pins in RAIL_BLE_AoxAntennaConfig_t::antCount than allowed by RAIL_BLE_AOX_ANTENNA_PIN_COUNT, then the API returns RAIL_STATUS_INVALID_PARAMETER.

If user configures lesser than or equal to number of pins allowed by RAIL_BLE_AOX_ANTENNA_PIN_COUNT, then the requested number of pins are configured and RAIL_STATUS_NO_ERROR is returned.

If AoX antenna switching is inactive, non-AoX transmits and receives will occur on the first antenna specified by the antenna pattern or on the default antenna if no antenna pattern is provided.

Returns

• Status code indicating success of the function call.

RAIL_BLE_SetNextTxRepeat#

RAIL_Status_t RAIL_BLE_SetNextTxRepeat (RAIL_Handle_t railHandle, const RAIL_BLE_TxRepeatConfig_t * repeatConfig)

Set up automatic repeated transmits after the next transmit.

Returns

• Status code indicating a success of the function call.

Repeated transmits will occur after an application-initiated transmit caused by calling one of the Packet Transmit APIs. The repetition will only occur after the first application-initiated transmit after this function is called. Future repeated transmits must be requested by calling this function again.

Each repeated transmit that occurs will have full PTI Packet Trace information and will receive events such as RAIL_EVENT_TX_PACKET_SENT as normal.

If a TX error occurs during the repetition, the process will abort and the TX error transition from RAIL_SetTxTransitions() will be used. If the repetition completes successfully, the TX success transition from RAIL_SetTxTransitions() will be used.

Any call to RAIL_Idle(), RAIL_StopTx(), or RAIL_SetTxTransitions() will clear the pending repeated transmits. The state will also be cleared by another call to this function. To clear the repeated transmits before they've started without stopping other radio actions, call this function with a RAIL_BLE_TxRepeatConfig_t::iterations count of 0. A DMP switch will clear this state only if the initial transmit triggering the repeated transmits has started.

The application is responsible for populating the transmit data to be used by the repeated transmits via RAIL_SetTxFifo() or RAIL_WriteTxFifo(). Data will be transmitted from the TX FIFO. If the TX FIFO does not have sufficient data to transmit, a TX error and a RAIL_EVENT_TX_UNDERFLOW will occur. To avoid an underflow, the application should queue data to be transmitted as early as possible.

This function will fail to configure the repetition if a transmit of any kind is ongoing, including during the time between an initial transmit and the end of a previously-configured repetition.

Note

• Use the compile time symbol RAIL_SUPPORTS_TX_TO_TX or the runtime call RAIL_SupportsTxToTx() to check whether the platform supports this feature.

RAIL_BLE_CalibrateIr#

RAIL_Status_t RAIL_BLE_CalibrateIr (RAIL_Handle_t railHandle, uint32_t * imageRejection)

Calibrate image rejection for Bluetooth Low Energy.

Returns

• Status code indicating success of the function call.

Some chips have protocol-specific image rejection calibrations programmed into their flash. This function will either get the value from flash and apply it, or run the image rejection algorithm to find the value.