This file contains the type definitions for RAIL structures, enums, and other types.
License#
Copyright 2024 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.
Modules#
sl_rail_tx_power_setting_entry_t
sl_rail_channel_config_group_t
sl_rail_channel_config_entry_t
sl_rail_tx_channel_hopping_config_entry_t
sl_rail_tx_channel_hopping_config_t
sl_rail_prs_lna_bypass_config_t
sl_rail_hfxo_thermistor_config_t
sl_rail_hfxo_compensation_config_t
sl_rail_rf_sense_selective_ook_config_t
sl_rail_rx_channel_hopping_config_multi_mode_t
sl_rail_rx_channel_hopping_config_entry_t
sl_rail_rx_channel_hopping_config_t
sl_rail_rx_duty_cycle_config_t
Macros#
The RAIL library does not use enumerations because the ARM EABI leaves their size ambiguous, which causes problems if the application is built with different flags than the library.
This macro is a more generic version of the SLI_RAIL_ENUM() macro that allows the size of the type to be overridden instead of forcing the use of a uint8_t.
A generic-radio RAIL handle for the primary EFR32 radio.
RAIL function reports no error.
Call to RAIL function threw an error because of an invalid parameter.
Call to RAIL function threw an error because it was called during an invalid radio state.
RAIL function is called in an invalid order.
RAIL function did not finish in the allotted time.
RAIL function could not be scheduled by the Radio scheduler.
RAIL function could not allocate needed resource(s).
A value to signal that RAIL should not use DMA.
Platform-agnostic value to use default PRS channel when configuring sleep.
Platform-agnostic vlaue to use default RTCC channel when configuring sleep.
Default timer synchronization configuration.
Radio Scheduler Status mask within sl_rail_scheduler_status_t values.
Radio Scheduler Status shift within sl_rail_scheduler_status_t values.
Radio Scheduler Task mask within sl_rail_scheduler_status_t values.
Radio Scheduler Task shift within sl_rail_scheduler_status_t values.
A value representing no events.
Occurs when the hardware-averaged RSSI is done in response to sl_rail_start_average_rssi() to indicate that the hardware has completed averaging.
Occurs when the Ack timeout expires while waiting to receive the sync word of an expected Ack.
Keeps occurring as long as the number of bytes in the receive FIFO exceeds the configured threshold value.
Occurs whenever a packet is received with SL_RAIL_RX_PACKET_READY_SUCCESS or SL_RAIL_RX_PACKET_READY_CRC_ERROR.
Occurs when the radio has lost a preamble.
Occurs when the radio has detected a preamble.
Occurs when the primary sync word is detected.
Occurs when the alternate sync word is detected.
Occurs when a receive is aborted with SL_RAIL_RX_PACKET_ABORT_CRC_ERROR which only happens after any filtering has passed.
When using sl_rail_rx_data_source_t::SL_RAIL_RX_DATA_SOURCE_PACKET_DATA this event occurs coincident to a receive packet completion event in which the receive FIFO or the supplemental receive Packet Queue (see Data Management) are full and further packet reception is jeopardized.
When using sl_rail_rx_data_source_t::SL_RAIL_RX_DATA_SOURCE_PACKET_DATA this event occurs when a receive is aborted with SL_RAIL_RX_PACKET_ABORT_OVERFLOW due to overflowing the receive FIFO or the supplemental receive Packet Queue (see Data Management).
Occurs when a receive is aborted with SL_RAIL_RX_PACKET_ABORT_FILTERED because its address does not match the filtering settings.
Occurs when an RX event times out.
Occurs when a scheduled RX begins turning on the receiver.
Occurs when the receiver has been blocked due to radio arbitration.
Occurs when the scheduled RX window ends.
Occurs when start of a scheduled receive is missed.
Occurs when a receive is aborted during filtering with SL_RAIL_RX_PACKET_ABORT_FORMAT or after filtering with SL_RAIL_RX_PACKET_ABORT_ABORTED for reasons other than address filtering mismatch (which triggers SL_RAIL_EVENT_RX_ADDRESS_FILTERED instead).
Occurs when the packet has passed any configured address and frame filtering options.
Occurs when the modem timing is lost.
Occurs when the modem timing is detected.
Occurs when RX Channel Hopping is enabled and channel hopping finishes receiving on the last channel in its sequence.
Occurs during RX duty cycle mode when the radio finishes its time in receive mode.
Indicate a Data Request is received when using IEEE 802.15.4 functionality.
Indicate a Z-Wave Beam Request relevant to the node was received.
Indicate a MFM buffer has completely transmitted.
Indicate a request for populating Z-Wave LR Ack packet.
The mask representing all events that determine the end of a received packet.
Occurs when the number of bytes in the transmit FIFO falls below the configured threshold value.
Occurs after a packet has been transmitted.
Occurs after an Ack packet has been transmitted.
Occurs when a transmit is aborted by the user.
Occurs when an Ack transmit is aborted by the user.
Occurs when a transmit is blocked from occurring because sl_rail_enable_tx_hold_off() was called.
Occurs when an Ack transmit is blocked from occurring because sl_rail_enable_tx_hold_off() was called.
Occurs when the transmit buffer underflows.
Occurs when the Ack transmit buffer underflows.
Occurs when Carrier Sense Multiple Access (CSMA) or Listen Before Talk (LBT) succeeds.
Occurs when Carrier Sense Multiple Access (CSMA) or Listen Before Talk (LBT) fails.
Occurs during CSMA or LBT when an individual Clear Channel Assessment (CCA) check fails, but there are more tries needed before the overall operation completes.
Occurs when the receiver is enabled to perform a Clear Channel Assessment (CCA) check.
Occurs when the a Clear Channel Assessment (CCA) check is activated.
Occurs when the radio starts transmitting a normal packet on the air.
A value to pass as sl_rail_get_tx_time_preamble_start() total_packet_bytes parameter to retrieve the SL_RAIL_EVENT_TX_STARTED time stamp.
Occurs when a scheduled TX begins turning on the transmitter.
Occurs when the start of a scheduled transmit is missed.
A mask representing all events that determine the end of a transmitted packet.
A mask representing all events that determine the end of a transmitted Ack packet.
Occurs when the scheduler switches away from this configuration.
Occurs when the scheduler switches to this configuration.
Occurs when the scheduler has a status to report.
Occurs when the application needs to run a calibration, as determined by the RAIL library.
Occurs when RF energy is sensed from the radio.
Occurs when PA protection circuit kicks in.
Occurs after enabling the signal detection using sl_rail_ble_enable_signal_detection() or sl_rail_ieee802154_enable_signal_detection() when a signal is detected.
Occurs when a Wi-SUN mode switch packet has been received, after switching to the new PHY.
Occurs when switching back to the original base PHY in effect prior to the Wi-SUN mode switch reception.
Occurs when the sampled RSSI is above the threshold set by sl_rail_set_rssi_detect_threshold().
Occurs when the thermistor has finished its measurement in response to sl_rail_start_thermistor_measurement().
Reserved for possible future use.
Occurs when die internal temperature exceeds the temperature threshold subtracted by the cool down parameter from sl_rail_chip_temp_config_t.
Occurs when die internal temperature falls below the temperature threshold subtracted by the cool down parameter from sl_rail_chip_temp_config_t.
Occurs when the user received a mailbox message.
A value representing all possible events.
Convenience macro for declaring RAIL FIFO buffers of desired size.
The minimum size in bytes of a receive / transmit / Auto-Ack FIFO.
The maximum size in bytes of a receive / transmit / Auto-Ack FIFO.
A FIFO threshold value that disables the threshold.
The maximum valid value for a sl_rail_tx_power_t.
The minimum valid value for a sl_rail_tx_power_t.
The maximum power in deci-dBm the curve supports.
The increment step in deci-dBm for calculating power level.
mV are used for all TX power voltage values.
deci-dBm are used for all TX power dBm values.
An unsupported power setting used with the PA Power Conversions component.
The names of the TX power modes.
Convenience macro for any OFDM mapping table mode.
Convenience macro for any Sub-GHz mapping table mode.
Convenience macro for any OFDM mode.
An invalid return value when calling sl_rail_set_fixed_length().
Indicates this version of RAIL supports concurrent PHY information in radio configurator output.
Indicates this version of RAIL supports stack info feature in radio configurator output.
A value representing an invalid channel, used for APIs that return or output a channel when none can be identified.
A value to use in sl_rail_state_timing_t fields when calling sl_rail_set_state_timing() to keep that timing parameter at it current setting.
Radio is inactive.
Radio is in or headed to the idle state.
Radio is in or headed to the receive state.
Radio is in or headed to the transmit state.
Radio is headed to the idle, receive, or transmit state.
Radio is actively transmitting or receiving.
Radio has frame detect disabled.
LBT/CSMA operation is currently ongoing.
Mask for core radio state bits.
The worst-case platform-agnostic static amount of memory needed per channel for channel hopping, measured in 32 bit words, regardless of the size of radio configuration structures.
Do not stop any radio operations.
Stop active radio operations only.
Stop pending radio operations.
Stop all radio operations.
A value representing no options enabled.
All options disabled by default.
An option when Auto-Ack has been configured, enabled, and not TX paused, to configure whether or not the transmitting node will listen for an Ack response.
An option to remove CRC bytes from TX packets.
An option to select which sync word is used during the transmission.
An option to select antenna 0 for transmission.
An option to select antenna 1 for transmission.
An option to use the alternate preamble length established by sl_rail_set_tx_alt_preamble_length() for the transmission.
An option to only perform the CCA (CSMA/LBT) operation but not automatically transmit if the channel is clear.
An option to resend packet at the beginning of the Transmit FIFO.
An option to specify which PHY is used to transmit in the case of concurrent mode.
A value representing all possible options.
The maximum number of LBT/CSMA retries supported.
The maximum power-of-2 exponent for CSMA backoffs.
sl_rail_csma_config_t initializer configuring CSMA per IEEE 802.15.4-2003 on 2.4 GHz OSPSK, commonly used by Zigbee.
sl_rail_csma_config_t initializer configuring a single CCA prior to TX.
sl_rail_lbt_config_t initializer configuring LBT per ETSI 300 220-1 V2.4.1 for a typical Sub-GHz band.
sl_rail_lbt_config_t initializer configuring LBT per ETSI 300 220-1 V3.1.0 for a typical Sub-GHz band.
A value representing no repeat options enabled.
All repeat options disabled by default.
An option to configure whether or not to channel-hop before each repeated transmit.
An option to configure the delay between transmissions to be from start to start instead of end to start.
sl_rail_tx_repeat_config_t::iterations initializer configuring infinite repeated transmissions.
A default address filtering match table for configurations that use only one address field.
A default address filtering match table for configurations that use two address fields and want to match the same index in each.
The maximum number of address fields that can be used by the address filtering logic.
A value representing no options enabled.
All options are disabled by default.
An option to configure whether the CRC portion of the packet is included in the packet payload exposed to the app on packet reception.
An option to configure whether CRC errors will be ignored.
An option to control which sync words will be accepted.
An option to configure whether frames which are aborted during reception should continue to be tracked.
An option to suppress capturing the appended information after received frames.
An option to select the use of antenna 0 during receive (including Auto-Ack receive).
An option to select the use of antenna 1 during receive (including Auto-Ack receive).
An option combination to automatically choose an antenna during receive (including Auto-Ack receive).
An option to disable frame detection.
An option to enable IEEE 802.15.4 RX channel switching.
An option to enable fast RX-to-RX state transition.
An option to enable collision detection.
A value representing all possible options.
The value returned by RAIL for an invalid RSSI, in dBm.
The value returned by RAIL for an invalid RSSI: in quarter dBm.
The lowest RSSI value returned by RAIL: in quarter dBm.
Maximum absolute value for RSSI offset.
A sentinel value to indicate waiting for a valid RSSI without a timeout.
A sentinel value to indicate no waiting for a valid RSSI.
An invalid RX packet handle value.
A special RX packet handle to refer to the oldest unreleased packet.
A special RX packet handle to refer to the oldest unreleased complete packet.
A special RX packet handle to refer to the newest unreleased packet when in callback context.
The default size in bytes of the built-in per-protocol Auto-Ack FIFO.
A sentinel value to indicate an invalid thermistor measurement value.
A sentinel value to indicate an invalid PPM calculation value.
EFR32-specific temperature calibration bit.
EFR32-specific HFXO temperature check bit.
EFR32-specific HFXO compensation bit.
EFR32-specific IR calibration bit.
EFR32-specific Tx IR calibration bit.
A mask to run EFR32-specific IR calibrations.
A mask to run temperature-dependent calibrations.
A mask to run one-time calibrations.
A mask to run optional performance calibrations.
A mask for calibrations that require the radio to be off.
A mask to run all possible calibrations for this chip.
A mask to run all pending calibrations.
An invalid calibration value.
Indicates the maximum number of RF Paths supported across all platforms.
A define to set all sl_rail_rx_ir_cal_values_t values to uninitialized.
A define to set all sl_rail_tx_ir_cal_values_t values to uninitialized.
A define to set all sl_rail_ir_cal_values_t values to uninitialized.
A define allowing Rx calibration value access compatibility between non-OFDM and OFDM platforms.
A define to set all sl_rail_cal_values_t values to uninitialized.
RF Sense low sensitivity offset.
Use the MODEM default sync word.
The maximum sense time supported for those sl_rail_rx_channel_hopping_mode_t modes whose parameter(s) specify a sensing time.
A value representing no options enabled.
All options disabled by default.
An option to skip synth calibration while hopping into the channel specified in the current entry.
An option to skip DC calibration while hopping into the channel specified in the current entry.
An option to check RSSI after hopping into the channel specified in the current entry and hop if that RSSI is below the threshold specified in sl_rail_rx_channel_hopping_config_entry_t::rssi_threshold_dbm.
An option to stop the hopping sequence at this entry in the hop table, which also idles the radio.
A sentinel value to flag an invalid channel hopping index.
The maximum frequency offset value supported.
The minimum frequency offset value supported.
Specify an invalid frequency offset value.
A macro that is string versions of the calibration enums.
A macro that is string versions of the resolution enums.
A macro that is string versions of the status enums.
Maximum junction temperature in Kelvin.
Default number of Kelvin degrees below threshold needed to allow transmissions.
Number of temperature values provided for the chip thermal protection.
An option to configure HFXO retiming.
An option to configure HFRCO retiming.
An option to configure DCDC retiming.
An option to configure LCD retiming.
A value representing no retiming options.
A value representing all retiming options.
Enumerations#
Specify a time offset in RAIL APIs.
The available packet time stamp position choices.
The configuration.
Multiprotocol scheduler status returned by sl_rail_get_scheduler_status().
Multiprotocol radio operation task types, used with sl_rail_set_task_priority().
RAIL events passed to the event callback.
Transmit data sources supported by RAIL.
Receive data sources supported by RAIL.
Methods for the application to provide and retrieve data from RAIL.
Suitable type for the supported PA modes.
An enumeration of the power modes.
A channel type enumeration.
The protocol that RAIL outputs via the Packet Trace Interface (PTI).
Define if the channel support using concurrent PHY during channel hopping.
The state of the radio.
The detailed state of the radio.
An enumeration for the different types of supported idle modes.
Stop radio operation options bit mask.
Transmit options, in reality a bitmask.
Enumerates the possible outcomes of what will occur if a scheduled TX ends up firing during RX.
Transmit repeat options, in reality a bitmask.
Receive options, in reality a bitmask.
The packet status code associated with a packet received or currently being received.
Antenna path Selection enumeration.
An enumeration for specifying the RF Sense frequency band.
Modes by which RAIL can determine when to proceed to the next channel during channel hopping.
Options that can customize channel hopping behavior on a per-hop basis.
Possible stream output modes.
VDET Modes.
VDET Resolution for the Aux ADC.
VDET Status.
Retiming options bit shifts.
Typedefs#
A radio-generic handle (e.g., SL_RAIL_EFR32_HANDLE), or a real RAIL instance handle as returned from sl_rail_init().
A status returned by many RAIL API calls indicating their success or failure.
A pointer to an initialization complete callback function.
An opaque type not examined by RAIL; can be used for application- specific purposes.
Time in microseconds.
A pointer to the callback called when the RAIL timer expires.
Callback fired when timer expires.
Type indicating the needed alignment for RX and TX FIFOs.
Type used for Packet Queue entries.
A pointer to the callback called when some RAIL event(s) occur.
The transmit power in deci-dBm units (e.g., 4.5 dBm -> 45 deci-dBm).
PA power setting type used directly by the PA Power Conversions component which is decoded to the actual hardware register value(s).
Pointer to a radio configuration array.
A pointer to a function that processes packet duration on air.
A pointer to a function called whenever a radio configuration change occurs.
Suitable type for the supported transition time range.
A bitmask representation of which 4 filters passed for each SL_RAIL_ADDR_CONFIG_MAX_ADDRESS_FIELDS when filtering has completed successfully.
A handle used to reference a packet during reception processing.
A pointer to a function called before LQI is copied into the sl_rail_rx_packet_details_t structure.
A calibration mask type.
sl_rail_rx_ir_cal_values_t
A calibration value structure.
A pointer to an RF Sense callback function.
Rx channel hopping on-channel time.
Type that represents the number of Frequency Offset units.
A pointer to the callback used to switch to secure world and run sl_rail_changed_dcdc().
A pointer to the callback used to switch to secure world and run sl_rail_tz_config_antenna_gpio().
A pointer to the callback used to switch to secure world and run sl_rail_tz_radio_clock_enable().
A pointer to the callback used to switch to secure world and run sl_rail_get_radio_clock_freq_hz().
A pointer to the callback used to switch to secure world and run sl_rail_tz_rfeca_clock_enable().
A pointer to the callback used to switch to secure world and run sl_rail_tz_rfeca_is_clock_enabled().
A pointer to the callback used to switch to secure world and run sl_rail_tz_read_internal_temperature().
A pointer to the callback used to switch to secure world and run sl_rail_tz_enable_secure_radio_irqs().
A pointer to the callback used to switch to secure world and run sl_rail_tz_disable_secure_radio_irqs().
A pointer to the callback used to switch to secure world and run sl_rail_tz_radio_perform_m2m_ldma().
A pointer to the callback used to switch to secure world and run sl_rail_tz_configure_hfxo().
Enumeration Documentation#
sl_rail_time_mode_t#
sl_rail_time_mode_t
Specify a time offset in RAIL APIs.
Different APIs use the same constants and may provide more specifics about how they're used but the general use for each is described below.
| Enumerator | |
|---|---|
| SL_RAIL_TIME_ABSOLUTE | The time specified is an exact time in the RAIL timebase. |
| SL_RAIL_TIME_DELAY | The time specified is relative to the current time. |
| SL_RAIL_TIME_DISABLED | The specified time is invalid and should be ignored. |
sl_rail_packet_time_position_t#
sl_rail_packet_time_position_t
The available packet time stamp position choices.
| Enumerator | |
|---|---|
| SL_RAIL_PACKET_TIME_INVALID | Indicate that a time stamp is not to be or was not provided. |
| SL_RAIL_PACKET_TIME_DEFAULT | Request the choice most expedient for RAIL to calculate, which may depend on the radio and/or its configuration. |
| SL_RAIL_PACKET_TIME_AT_PREAMBLE_START | Request the time stamp corresponding to the first preamble bit sent or received. |
| SL_RAIL_PACKET_TIME_AT_PREAMBLE_START_USED_TOTAL | Request the time stamp corresponding to the first preamble bit sent or received. |
| SL_RAIL_PACKET_TIME_AT_SYNC_END | Request the time stamp corresponding to right after its last SYNC word bit has been sent or received. |
| SL_RAIL_PACKET_TIME_AT_SYNC_END_USED_TOTAL | Request the time stamp corresponding to right after its last SYNC word bit has been sent or received. |
| SL_RAIL_PACKET_TIME_AT_PACKET_END | Request the time stamp corresponding to right after its last bit has been sent or received. |
| SL_RAIL_PACKET_TIME_AT_PACKET_END_USED_TOTAL | Request the time stamp corresponding to right after its last bit has been sent or received. |
| SL_RAIL_PACKET_TIME_COUNT | A count of the choices in this enumeration. |
sl_rail_sleep_config_t#
sl_rail_sleep_config_t
The configuration.
| Enumerator | |
|---|---|
| SL_RAIL_SLEEP_CONFIG_TIMERSYNC_DISABLED | Disable timer sync before and after sleep. |
| SL_RAIL_SLEEP_CONFIG_TIMERSYNC_ENABLED | Enable timer sync before and after sleep. |
sl_rail_scheduler_status_t#
sl_rail_scheduler_status_t
Multiprotocol scheduler status returned by sl_rail_get_scheduler_status().
Multiprotocol scheduler status is a combination of the upper 4 bits which constitute the type of scheduler task and the lower 4 bits which constitute the type of scheduler error.
| Enumerator | |
|---|---|
| SL_RAIL_SCHEDULER_STATUS_NO_ERROR | Multiprotocol scheduler reports no error. |
| SL_RAIL_SCHEDULER_STATUS_UNSUPPORTED | The scheduler is disabled or the requested scheduler operation is unsupported. |
| SL_RAIL_SCHEDULER_STATUS_EVENT_INTERRUPTED | The scheduled task was started but was interrupted by a higher-priority event before it could be completed. |
| SL_RAIL_SCHEDULER_STATUS_SCHEDULE_FAIL | Scheduled task could not be scheduled given its priority and the other tasks running on the system. |
| SL_RAIL_SCHEDULER_STATUS_TASK_FAIL | Calling the RAIL API associated with the Radio scheduler task returned an error code. |
| SL_RAIL_SCHEDULER_STATUS_INTERNAL_ERROR | An internal error occurred in scheduler data structures, which should not happen and indicates a problem. |
| SL_RAIL_SCHEDULER_TASK_EMPTY | Radio scheduler has no task. |
| SL_RAIL_SCHEDULER_TASK_SCHEDULED_RX | Radio scheduler calls sl_rail_start_scheduled_rx(). |
| SL_RAIL_SCHEDULER_TASK_SCHEDULED_TX | Radio scheduler calls sl_rail_start_scheduled_tx(). |
| SL_RAIL_SCHEDULER_TASK_SINGLE_TX | Radio scheduler calls sl_rail_start_tx(). |
| SL_RAIL_SCHEDULER_TASK_SINGLE_CCA_CSMA_TX | Radio scheduler calls sl_rail_start_cca_csma_tx(). |
| SL_RAIL_SCHEDULER_TASK_SINGLE_CCA_LBT_TX | Radio scheduler calls sl_rail_start_cca_lbt_tx(). |
| SL_RAIL_SCHEDULER_TASK_SCHEDULED_CCA_CSMA_TX | Radio scheduler calls sl_rail_start_scheduled_cca_csma_tx(). |
| SL_RAIL_SCHEDULER_TASK_SCHEDULED_CCA_LBT_TX | Radio scheduler calls sl_rail_start_scheduled_cca_lbt_tx(). |
| SL_RAIL_SCHEDULER_TASK_TX_STREAM | Radio scheduler calls sl_rail_start_tx_stream(). |
| SL_RAIL_SCHEDULER_TASK_AVERAGE_RSSI | Radio scheduler calls sl_rail_start_average_rssi(). |
| SL_RAIL_SCHEDULER_STATUS_SCHEDULED_TX_FAIL | sl_rail_start_scheduled_tx() returned error status. |
| SL_RAIL_SCHEDULER_STATUS_SINGLE_TX_FAIL | sl_rail_start_tx() returned error status. |
| SL_RAIL_SCHEDULER_STATUS_CCA_CSMA_TX_FAIL | sl_rail_start_cca_csma_tx() returned error status. |
| SL_RAIL_SCHEDULER_STATUS_CCA_LBT_TX_FAIL | sl_rail_start_cca_lbt_tx() returned error status. |
| SL_RAIL_SCHEDULER_STATUS_SCHEDULED_RX_FAIL | sl_rail_start_scheduled_rx() returned error status. |
| SL_RAIL_SCHEDULER_STATUS_TX_STREAM_FAIL | sl_rail_start_tx_stream() returned error status. |
| SL_RAIL_SCHEDULER_STATUS_AVERAGE_RSSI_FAIL | sl_rail_start_average_rssi() returned error status. |
| SL_RAIL_SCHEDULER_SCHEDULED_RX_INTERNAL_ERROR | Multiprotocol scheduled receive function internal error. |
| SL_RAIL_SCHEDULER_SCHEDULED_RX_SCHEDULING_ERROR | Multiprotocol scheduled receive scheduling error. |
| SL_RAIL_SCHEDULER_SCHEDULED_RX_INTERRUPTED | sl_rail_start_scheduled_rx() operation interrupted |
| SL_RAIL_SCHEDULER_SCHEDULED_TX_INTERNAL_ERROR | Multiprotocol scheduled TX internal error. |
| SL_RAIL_SCHEDULER_SCHEDULED_TX_SCHEDULING_ERROR | Multiprotocol scheduled TX scheduling error. |
| SL_RAIL_SCHEDULER_SCHEDULED_TX_INTERRUPTED | sl_rail_start_scheduled_tx() operation interrupted. |
| SL_RAIL_SCHEDULER_SINGLE_TX_INTERNAL_ERROR | Multiprotocol instantaneous TX internal error. |
| SL_RAIL_SCHEDULER_SINGLE_TX_SCHEDULING_ERROR | Multiprotocol instantaneous TX scheduling error. |
| SL_RAIL_SCHEDULER_SINGLE_TX_INTERRUPTED | sl_rail_start_tx() operation interrupted. |
| SL_RAIL_SCHEDULER_SINGLE_CCA_CSMA_TX_INTERNAL_ERROR | Multiprotocol single CSMA transmit function internal error. |
| SL_RAIL_SCHEDULER_SINGLE_CCA_CSMA_TX_SCHEDULING_ERROR | Multiprotocol single CSMA transmit scheduling error. |
| SL_RAIL_SCHEDULER_SINGLE_CCA_CSMA_TX_INTERRUPTED | sl_rail_start_cca_csma_tx() operation interrupted. |
| SL_RAIL_SCHEDULER_SINGLE_CCA_LBT_TX_INTERNAL_ERROR | Multiprotocol single LBT transmit function internal error. |
| SL_RAIL_SCHEDULER_SINGLE_CCA_LBT_TX_SCHEDULING_ERROR | Multiprotocol single LBT transmit scheduling error. |
| SL_RAIL_SCHEDULER_SINGLE_CCA_LBT_TX_INTERRUPTED | sl_rail_start_cca_lbt_tx() operation interrupted. |
| SL_RAIL_SCHEDULER_SCHEDULED_CCA_CSMA_TX_INTERNAL_ERROR | Multiprotocol scheduled CSMA transmit function internal error. |
| SL_RAIL_SCHEDULER_SCHEDULED_CCA_CSMA_TX_FAIL | sl_rail_start_scheduled_cca_csma_tx() returned error status. |
| SL_RAIL_SCHEDULER_SCHEDULED_CCA_CSMA_TX_SCHEDULING_ERROR | Multiprotocol scheduled CSMA transmit scheduling error. |
| SL_RAIL_SCHEDULER_SCHEDULED_CCA_CSMA_TX_INTERRUPTED | sl_rail_start_scheduled_cca_csma_tx() operation interrupted. |
| SL_RAIL_SCHEDULER_SCHEDULED_CCA_LBT_TX_INTERNAL_ERROR | Multiprotocol scheduled LBT transmit function internal error. |
| SL_RAIL_SCHEDULER_SCHEDULED_CCA_LBT_TX_FAIL | sl_rail_start_scheduled_cca_lbt_tx() returned error status. |
| SL_RAIL_SCHEDULER_SCHEDULED_CCA_LBT_TX_SCHEDULING_ERROR | Multiprotocol scheduled LBT transmit scheduling error. |
| SL_RAIL_SCHEDULER_SCHEDULED_CCA_LBT_TX_INTERRUPTED | sl_rail_start_scheduled_cca_lbt_tx() operation interrupted. |
| SL_RAIL_SCHEDULER_TX_STREAM_INTERNAL_ERROR | Multiprotocol stream transmit function internal error. |
| SL_RAIL_SCHEDULER_TX_STREAM_SCHEDULING_ERROR | Multiprotocol stream transmit scheduling error. |
| SL_RAIL_SCHEDULER_TX_STREAM_INTERRUPTED | sl_rail_start_tx_stream() operation interrupted. |
| SL_RAIL_SCHEDULER_AVERAGE_RSSI_INTERNAL_ERROR | Multiprotocol RSSI averaging function internal error. |
| SL_RAIL_SCHEDULER_AVERAGE_RSSI_SCHEDULING_ERROR | Multiprotocol RSSI average scheduling error. |
| SL_RAIL_SCHEDULER_AVERAGE_RSSI_INTERRUPTED | sl_rail_start_average_rssi() operation interrupted. |
sl_rail_task_type_t#
sl_rail_task_type_t
Multiprotocol radio operation task types, used with sl_rail_set_task_priority().
| Enumerator | |
|---|---|
| SL_RAIL_TASK_TYPE_START_RX | Indicate a task started using sl_rail_start_rx(). |
| SL_RAIL_TASK_TYPE_OTHER | Indicate a task started functions other than sl_rail_start_rx(). |
sl_rail_events_t#
sl_rail_events_t
RAIL events passed to the event callback.
More than one event may be indicated due to interrupt latency.
| Enumerator | |
|---|---|
| SL_RAIL_EVENT_RSSI_AVERAGE_DONE_SHIFT | Shift position of SL_RAIL_EVENT_RSSI_AVERAGE_DONE bit. |
| SL_RAIL_EVENT_RX_ACK_TIMEOUT_SHIFT | Shift position of SL_RAIL_EVENT_RX_ACK_TIMEOUT bit. |
| SL_RAIL_EVENT_RX_FIFO_ALMOST_FULL_SHIFT | Shift position of SL_RAIL_EVENT_RX_FIFO_ALMOST_FULL bit. |
| SL_RAIL_EVENT_RX_PACKET_RECEIVED_SHIFT | Shift position of SL_RAIL_EVENT_RX_PACKET_RECEIVED bit. |
| SL_RAIL_EVENT_RX_PREAMBLE_LOST_SHIFT | Shift position of SL_RAIL_EVENT_RX_PREAMBLE_LOST bit. |
| SL_RAIL_EVENT_RX_PREAMBLE_DETECT_SHIFT | Shift position of SL_RAIL_EVENT_RX_PREAMBLE_DETECT bit. |
| SL_RAIL_EVENT_RX_SYNC_0_DETECT_SHIFT | Shift position of SL_RAIL_EVENT_RX_SYNC_0_DETECT bit. |
| SL_RAIL_EVENT_RX_SYNC_1_DETECT_SHIFT | Shift position of SL_RAIL_EVENT_RX_SYNC_1_DETECT bit. |
| SL_RAIL_EVENT_RX_FRAME_ERROR_SHIFT | Shift position of SL_RAIL_EVENT_RX_FRAME_ERROR bit. |
| SL_RAIL_EVENT_RX_FIFO_FULL_SHIFT | Shift position of SL_RAIL_EVENT_RX_FIFO_FULL bit. |
| SL_RAIL_EVENT_RX_FIFO_OVERFLOW_SHIFT | Shift position of SL_RAIL_EVENT_RX_FIFO_OVERFLOW bit. |
| SL_RAIL_EVENT_RX_ADDRESS_FILTERED_SHIFT | Shift position of SL_RAIL_EVENT_RX_ADDRESS_FILTERED bit. |
| SL_RAIL_EVENT_RX_TIMEOUT_SHIFT | Shift position of SL_RAIL_EVENT_RX_TIMEOUT bit. |
| SL_RAIL_EVENT_RX_SCHEDULED_RX_STARTED_SHIFT | Shift position of SL_RAIL_EVENT_RX_SCHEDULED_RX_STARTED bit. |
| SL_RAIL_EVENT_RX_SCHEDULED_RX_END_SHIFT | Shift position of SL_RAIL_EVENT_RX_SCHEDULED_RX_END bit. |
| SL_RAIL_EVENT_RX_SCHEDULED_RX_MISSED_SHIFT | Shift position of SL_RAIL_EVENT_RX_SCHEDULED_RX_MISSED bit. |
| SL_RAIL_EVENT_RX_PACKET_ABORTED_SHIFT | Shift position of SL_RAIL_EVENT_RX_PACKET_ABORTED bit. |
| SL_RAIL_EVENT_RX_FILTER_PASSED_SHIFT | Shift position of SL_RAIL_EVENT_RX_FILTER_PASSED bit. |
| SL_RAIL_EVENT_RX_TIMING_LOST_SHIFT | Shift position of SL_RAIL_EVENT_RX_TIMING_LOST bit. |
| SL_RAIL_EVENT_RX_TIMING_DETECT_SHIFT | Shift position of SL_RAIL_EVENT_RX_TIMING_DETECT bit. |
| SL_RAIL_EVENT_RX_CHANNEL_HOPPING_COMPLETE_SHIFT | Shift position of SL_RAIL_EVENT_RX_CHANNEL_HOPPING_COMPLETE bit. |
| SL_RAIL_EVENT_RX_DUTY_CYCLE_RX_END_SHIFT | Shift position of SL_RAIL_EVENT_RX_DUTY_CYCLE_RX_END bit. |
| SL_RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND_SHIFT | Shift position of SL_RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND bit. |
| SL_RAIL_EVENT_ZWAVE_LR_ACK_REQUEST_COMMAND_SHIFT | Shift position of SL_RAIL_EVENT_ZWAVE_LR_ACK_REQUEST_COMMAND_SHIFT bit. |
| SL_RAIL_EVENT_MFM_TX_BUFFER_DONE_SHIFT | Shift position of SL_RAIL_EVENT_MFM_TX_BUFFER_DONE bit. |
| SL_RAIL_EVENT_ZWAVE_BEAM_SHIFT | Shift position of SL_RAIL_EVENT_ZWAVE_BEAM bit. |
| SL_RAIL_EVENT_TX_FIFO_ALMOST_EMPTY_SHIFT | Shift position of SL_RAIL_EVENT_TX_FIFO_ALMOST_EMPTY bit. |
| SL_RAIL_EVENT_TX_PACKET_SENT_SHIFT | Shift position of SL_RAIL_EVENT_TX_PACKET_SENT bit. |
| SL_RAIL_EVENT_TXACK_PACKET_SENT_SHIFT | Shift position of SL_RAIL_EVENT_TXACK_PACKET_SENT bit. |
| SL_RAIL_EVENT_TX_ABORTED_SHIFT | Shift position of SL_RAIL_EVENT_TX_ABORTED bit. |
| SL_RAIL_EVENT_TXACK_ABORTED_SHIFT | Shift position of SL_RAIL_EVENT_TXACK_ABORTED bit. |
| SL_RAIL_EVENT_TX_BLOCKED_SHIFT | Shift position of SL_RAIL_EVENT_TX_BLOCKED bit. |
| SL_RAIL_EVENT_TXACK_BLOCKED_SHIFT | Shift position of SL_RAIL_EVENT_TXACK_BLOCKED bit. |
| SL_RAIL_EVENT_TX_UNDERFLOW_SHIFT | Shift position of SL_RAIL_EVENT_TX_UNDERFLOW bit. |
| SL_RAIL_EVENT_TXACK_UNDERFLOW_SHIFT | Shift position of SL_RAIL_EVENT_TXACK_UNDERFLOW bit. |
| SL_RAIL_EVENT_TX_CHANNEL_CLEAR_SHIFT | Shift position of SL_RAIL_EVENT_TX_CHANNEL_CLEAR bit. |
| SL_RAIL_EVENT_TX_CHANNEL_BUSY_SHIFT | Shift position of SL_RAIL_EVENT_TX_CHANNEL_BUSY bit. |
| SL_RAIL_EVENT_TX_CCA_RETRY_SHIFT | Shift position of SL_RAIL_EVENT_TX_CCA_RETRY bit. |
| SL_RAIL_EVENT_TX_START_CCA_SHIFT | Shift position of SL_RAIL_EVENT_TX_START_CCA bit. |
| SL_RAIL_EVENT_TX_STARTED_SHIFT | Shift position of SL_RAIL_EVENT_TX_STARTED bit. |
| SL_RAIL_EVENT_TX_SCHEDULED_TX_STARTED_SHIFT | Shift position of SL_RAIL_EVENT_TX_SCHEDULED_TX_STARTED bit. |
| SL_RAIL_EVENT_TX_SCHEDULED_TX_MISSED_SHIFT | Shift position of SL_RAIL_EVENT_TX_SCHEDULED_TX_MISSED bit. |
| SL_RAIL_EVENT_CONFIG_UNSCHEDULED_SHIFT | Shift position of SL_RAIL_EVENT_CONFIG_UNSCHEDULED bit. |
| SL_RAIL_EVENT_CONFIG_SCHEDULED_SHIFT | Shift position of SL_RAIL_EVENT_CONFIG_SCHEDULED bit. |
| SL_RAIL_EVENT_SCHEDULER_STATUS_SHIFT | Shift position of SL_RAIL_EVENT_SCHEDULER_STATUS bit. |
| SL_RAIL_EVENT_CAL_NEEDED_SHIFT | Shift position of SL_RAIL_EVENT_CAL_NEEDED bit. |
| SL_RAIL_EVENT_RF_SENSED_SHIFT | Shift position of SL_RAIL_EVENT_RF_SENSED bit. |
| SL_RAIL_EVENT_PA_PROTECTION_SHIFT | Shift position of SL_RAIL_EVENT_PA_PROTECTION bit. |
| SL_RAIL_EVENT_SIGNAL_DETECTED_SHIFT | Shift position of SL_RAIL_EVENT_SIGNAL_DETECTED bit. |
| SL_RAIL_EVENT_IEEE802154_MODE_SWITCH_START_SHIFT | Shift position of SL_RAIL_EVENT_IEEE802154_MODE_SWITCH_START bit. |
| SL_RAIL_EVENT_IEEE802154_MODE_SWITCH_END_SHIFT | Shift position of SL_RAIL_EVENT_IEEE802154_MODE_SWITCH_END bit. |
| SL_RAIL_EVENT_DETECT_RSSI_THRESHOLD_SHIFT | Shift position of SL_RAIL_EVENT_DETECT_RSSI_THRESHOLD bit. |
| SL_RAIL_EVENT_THERMISTOR_DONE_SHIFT | Shift position of SL_RAIL_EVENT_THERMISTOR_DONE bit. |
| SL_RAIL_EVENT_RESERVED_49_SHIFT | Shift position of SL_RAIL_EVENT_RESERVED_49 bit. |
| SL_RAIL_EVENT_TEMPERATURE_TOO_HOT_SHIFT | Shift position of SL_RAIL_EVENT_TEMPERATURE_TOO_HOT bit. |
| SL_RAIL_EVENT_TEMPERATURE_COOL_DOWN_SHIFT | Shift position of SL_RAIL_EVENT_TEMPERATURE_COOL_DOWN bit. |
| SL_RAIL_EVENT_USER_MBOX_SHIFT | Shift position of SL_RAIL_EVENT_USER_MBOX bit. |
| SL_RAIL_EVENT_TX_CCA_ACTIVATED_SHIFT | Shift position of SL_RAIL_EVENT_TX_CCA_ACTIVATED bit. |
| SL_RAIL_EVENT_RX_BLOCKED_SHIFT | Shift position of SL_RAIL_EVENT_RX_BLOCKED bit. |
sl_rail_tx_data_source_t#
sl_rail_tx_data_source_t
Transmit data sources supported by RAIL.
| Enumerator | |
|---|---|
| SL_RAIL_TX_DATA_SOURCE_PACKET_DATA | Uses the frame hardware to packetize data. |
| SL_RAIL_TX_DATA_SOURCE_MFM_DATA | Uses the multi-level frequency modulation data. |
| SL_RAIL_TX_DATA_SOURCE_COUNT | A count of the choices in this enumeration. |
sl_rail_rx_data_source_t#
sl_rail_rx_data_source_t
Receive data sources supported by RAIL.
Note
Data sources other than SL_RAIL_RX_DATA_SOURCE_PACKET_DATA require use of sl_rail_data_method_t::SL_RAIL_DATA_METHOD_FIFO_MODE.
| Enumerator | |
|---|---|
| SL_RAIL_RX_DATA_SOURCE_PACKET_DATA | Uses the frame hardware to packetize data. |
| SL_RAIL_RX_DATA_SOURCE_DEMOD_DATA | Gets 8-bit data output from the demodulator. |
| SL_RAIL_RX_DATA_SOURCE_IQDATA_FILTLSB | Gets lower 16 bits of I/Q data provided to the demodulator. |
| SL_RAIL_RX_DATA_SOURCE_IQDATA_FILTMSB | Gets highest 16 bits of I/Q data provided to the demodulator. |
| SL_RAIL_RX_DATA_SOURCE_DIRECT_MODE_DATA | Gets RX direct mode data output from the demodulator. |
| SL_RAIL_RX_DATA_SOURCE_DIRECT_SYNCHRONOUS_MODE_DATA | Gets synchronous RX direct mode data output from the demodulator. |
| SL_RAIL_RX_DATA_SOURCE_COUNT | A count of the choices in this enumeration. |
sl_rail_data_method_t#
sl_rail_data_method_t
Methods for the application to provide and retrieve data from RAIL.
For Transmit the distinction between sl_rail_data_method_t::SL_RAIL_DATA_METHOD_PACKET_MODE and sl_rail_data_method_t::SL_RAIL_DATA_METHOD_FIFO_MODE has become more cosmetic than functional, as the sl_rail_write_tx_fifo() and sl_rail_set_tx_fifo_threshold() APIs and related SL_RAIL_EVENT_TX_FIFO_ALMOST_EMPTY event can be used in either mode. For Receive the distinction is functionally important because in sl_rail_data_method_t::SL_RAIL_DATA_METHOD_PACKET_MODE rollback occurs automatically for unsuccessfully-received packets (sl_rail_rx_packet_status_t ABORT statuses), flushing their data. In sl_rail_data_method_t::SL_RAIL_DATA_METHOD_FIFO_MODE rollback is prevented, leaving the data from unsuccessfully-received packets in the receive FIFO for the application to deal with. This allows for packets larger than the receive FIFO size where automatic rollback would corrupt the receive FIFO.
| Enumerator | |
|---|---|
| SL_RAIL_DATA_METHOD_PACKET_MODE | Packet-based data method. |
| SL_RAIL_DATA_METHOD_FIFO_MODE | FIFO-based data method. |
| SL_RAIL_DATA_METHOD_COUNT | A count of the choices in this enumeration. |
sl_rail_tx_pa_mode_t#
sl_rail_tx_pa_mode_t
Suitable type for the supported PA modes.
The PA modes correspond to the different on-chip PAs that are physically available. For more information about the power and performance characteristics of a given amplifier, see the data sheet.
Note
Some platforms support only a subset of these PAs.
| Enumerator | |
|---|---|
| SL_RAIL_TX_PA_MODE_2P4_GHZ | PA for 2.4 GHz. |
| SL_RAIL_TX_PA_MODE_SUB_GHZ | PA for Sub-GHz. |
| SL_RAIL_TX_PA_MODE_SUB_GHZ_OFDM | PA for Sub-GHz OFDM. |
| SL_RAIL_TX_PA_MODE_INVALID | An invalid Power Amplifier (PA) mode in the RAIL TX configuration. |
sl_rail_tx_power_mode_t#
sl_rail_tx_power_mode_t
An enumeration of the power modes.
The power modes correspond to the different on-chip PAs that are available. For more information about the power and performance characteristics of a given amplifier, see the data sheet.
| Enumerator | |
|---|---|
| SL_RAIL_TX_POWER_MODE_2P4_GHZ_HP | High-power 2.4 GHz amplifier EFR32xG21: up to 20 dBm, raw values: 1-180 EFR32xG22: up to 6 dBm, raw values: 1-128 EFR32xG24: up to 20 dBm, raw values: 0-180, or up to 10 dBm, raw values: 0-90 EFR32xG26: same as EFR32xG24 EFR32xG27: up to 6 dBm, raw values: 1-128 EFR32xG28: up to 10 dBm, raw values: 0-240 Not supported on other platforms. |
| SL_RAIL_TX_POWER_MODE_2P4_GHZ_MP | Mid-power 2.4 GHz amplifier EFR32xG21: up to 10 dBm, raw values: 1-90 Not supported on other platforms. |
| SL_RAIL_TX_POWER_MODE_2P4_GHZ_LP | Low-power 2.4 GHz amplifier EFR32xG21: up to 0 dBm, raw values: 1-64 EFR32xG22: up to 0 dBm, raw values: 1-16 EFR32xG24: up to 0 dBm, raw values: 1-16 EFR32xG26: same as EFR32xG24 EFR32xG27: up to 0 dBm, raw values: 1-16 Not supported on other platforms. |
| SL_RAIL_TX_POWER_MODE_2P4_GHZ_LLP | Low-Low-power 2.4 GHz amplifier Not currently supported on any EFR32 platform. |
| SL_RAIL_TX_POWER_MODE_2P4_GHZ_HIGHEST | Select the highest 2.4 GHz power PA available on the current chip. |
| SL_RAIL_TX_POWER_MODE_SUB_GHZ_POWERSETTING_TABLE | PA for all Sub-GHz dBm values in range, using sl_rail_pa_power_setting_t table. |
| SL_RAIL_TX_POWER_MODE_SUB_GHZ_HP | High-power Sub-GHz amplifier (Class D mode) Supported on EFR32xG23 and EFR32xG28. |
| SL_RAIL_TX_POWER_MODE_SUB_GHZ_MP | Mid-power Sub-GHz amplifier Supported only on EFR32xG23 and EFR32xG28. |
| SL_RAIL_TX_POWER_MODE_SUB_GHZ_LP | Low-power Sub-GHz amplifier Supported only on EFR32xG23 and EFR32xG28. |
| SL_RAIL_TX_POWER_MODE_SUB_GHZ_LLP | Low-Low-power Sub-GHz amplifier Supported only on EFR32xG23 and EFR32xG28. |
| SL_RAIL_TX_POWER_MODE_SUB_GHZ_HIGHEST | Select the highest Sub-GHz power PA available on the current chip. |
| SL_RAIL_TX_POWER_MODE_OFDM_PA_POWERSETTING_TABLE | PA for all OFDM Sub-GHz dBm values in range, using sl_rail_pa_power_setting_t table. |
| SL_RAIL_TX_POWER_MODE_NONE | Invalid amplifier Selection. |
sl_rail_pti_mode_t#
sl_rail_pti_mode_t
A channel type enumeration.
| Enumerator | |
|---|---|
| SL_RAIL_PTI_MODE_DISABLED | Turn PTI off entirely. |
| SL_RAIL_PTI_MODE_SPI | 8-bit SPI mode. |
| SL_RAIL_PTI_MODE_UART | 8-bit UART mode. |
| SL_RAIL_PTI_MODE_UART_ONEWIRE | 9-bit UART mode. |
sl_rail_pti_protocol_t#
sl_rail_pti_protocol_t
The protocol that RAIL outputs via the Packet Trace Interface (PTI).
| Enumerator | |
|---|---|
| SL_RAIL_PTI_PROTOCOL_CUSTOM | PTI output for a custom protocol. |
| SL_RAIL_PTI_PROTOCOL_THREAD | PTI output for the Thread protocol. |
| SL_RAIL_PTI_PROTOCOL_BLE | PTI output for the Bluetooth Smart protocol. |
| SL_RAIL_PTI_PROTOCOL_CONNECT | PTI output for the Connect protocol. |
| SL_RAIL_PTI_PROTOCOL_ZIGBEE | PTI output for the Zigbee protocol. |
| SL_RAIL_PTI_PROTOCOL_ZWAVE | PTI output for the Z-Wave protocol. |
| SL_RAIL_PTI_PROTOCOL_WI_SUN | PTI output for the Wi-SUN protocol. |
| SL_RAIL_PTI_PROTOCOL_802154 | PTI output for a custom protocol using a built-in 802.15.4 radio config. |
| SL_RAIL_PTI_PROTOCOL_SIDEWALK | PTI output for Sidewalk protocol. |
| SL_RAIL_PTI_PROTOCOL_BTC | PTI output for the Bluetooth Classic protocol. |
sl_rail_channel_config_entry_type_t#
sl_rail_channel_config_entry_type_t
Define if the channel support using concurrent PHY during channel hopping.
SL_RAIL_RX_CHANNEL_HOPPING_MODE_CONC and SL_RAIL_RX_CHANNEL_HOPPING_MODE_VT can only be used if the channel supports it.
| Enumerator | |
|---|---|
| SL_RAIL_CH_TYPE_NORMAL | Not a concurrent PHY. |
| SL_RAIL_CH_TYPE_CONC_BASE | Base concurrent PHY. |
| SL_RAIL_CH_TYPE_CONC_VIRTUAL | Virtual concurrent PHY. |
sl_rail_radio_state_t#
sl_rail_radio_state_t
The state of the radio.
| Enumerator | |
|---|---|
| SL_RAIL_RF_STATE_INACTIVE | Radio is inactive. |
| SL_RAIL_RF_STATE_ACTIVE | Radio is either idle or, in combination with the RX and TX states, receiving or transmitting a frame. |
| SL_RAIL_RF_STATE_RX | Radio is in receive. |
| SL_RAIL_RF_STATE_TX | Radio is in transmit. |
| SL_RAIL_RF_STATE_IDLE | Radio is idle. |
| SL_RAIL_RF_STATE_RX_ACTIVE | Radio is actively receiving a frame. |
| SL_RAIL_RF_STATE_TX_ACTIVE | Radio is actively transmitting a frame. |
sl_rail_radio_state_detail_t#
sl_rail_radio_state_detail_t
The detailed state of the radio.
The three radio state bits SL_RAIL_RF_STATE_DETAIL_IDLE_STATE, SL_RAIL_RF_STATE_DETAIL_RX_STATE, and SL_RAIL_RF_STATE_DETAIL_TX_STATE comprise a set of mutually exclusive core radio states. Only one (or none) of these bits can be set at a time. Otherwise, the value is invalid.
The precise meaning of each of these three core bits, when set, depends on the value of the two bits SL_RAIL_RF_STATE_DETAIL_TRANSITION and SL_RAIL_RF_STATE_DETAIL_ACTIVE. When SL_RAIL_RF_STATE_DETAIL_TRANSITION is set, the radio is transitioning into the core radio state corresponding to the set state bit. When it is clear, the radio is already in the core radio state that corresponds to the set state bit. When SL_RAIL_RF_STATE_DETAIL_ACTIVE is set, the radio is actively transmitting or receiving. When it is clear, the radio is not actively transmitting or receiving. This bit will always be clear when SL_RAIL_RF_STATE_DETAIL_IDLE_STATE is set, and will always be set when SL_RAIL_RF_STATE_DETAIL_TX_STATE is set. Otherwise, the value is invalid.
The bit SL_RAIL_RF_STATE_DETAIL_NO_FRAMES is set if the radio is currently operating with frame detection disabled, and clear otherwise. The bit SL_RAIL_RF_STATE_DETAIL_LBT_SHIFT is set if an LBT/CSMA operation (e.g., performing CCA) is currently ongoing, and clear otherwise.
| Enumerator | |
|---|---|
| SL_RAIL_RF_STATE_DETAIL_IDLE_STATE_SHIFT | Shift position of SL_RAIL_RF_STATE_DETAIL_IDLE_STATE bit. |
| SL_RAIL_RF_STATE_DETAIL_RX_STATE_SHIFT | Shift position of SL_RAIL_RF_STATE_DETAIL_RX_STATE bit. |
| SL_RAIL_RF_STATE_DETAIL_TX_STATE_SHIFT | Shift position of SL_RAIL_RF_STATE_DETAIL_TX_STATE bit. |
| SL_RAIL_RF_STATE_DETAIL_TRANSITION_SHIFT | Shift position of SL_RAIL_RF_STATE_DETAIL_TRANSITION bit. |
| SL_RAIL_RF_STATE_DETAIL_ACTIVE_SHIFT | Shift position of SL_RAIL_RF_STATE_DETAIL_ACTIVE bit. |
| SL_RAIL_RF_STATE_DETAIL_NO_FRAMES_SHIFT | Shift position of SL_RAIL_RF_STATE_DETAIL_NO_FRAMES bit. |
| SL_RAIL_RF_STATE_DETAIL_LBT_SHIFT | Shift position of SL_RAIL_RF_STATE_DETAIL_LBT bit. |
sl_rail_idle_mode_t#
sl_rail_idle_mode_t
An enumeration for the different types of supported idle modes.
These vary how quickly and destructively they put the radio into idle.
| Enumerator | |
|---|---|
| SL_RAIL_IDLE | Idle the radio by turning off receive and canceling any future scheduled receive or transmit operations. |
| SL_RAIL_IDLE_ABORT | Idle the radio by turning off receive and any scheduled events. |
| SL_RAIL_IDLE_FORCE_SHUTDOWN | Force the radio into a shutdown mode by stopping whatever state is in progress. |
| SL_RAIL_IDLE_FORCE_SHUTDOWN_CLEAR_FLAGS | Similar to the SL_RAIL_IDLE_FORCE_SHUTDOWN command, however, it will also clear any pending RAIL events related to receive and transmit. |
sl_rail_stop_mode_t#
sl_rail_stop_mode_t
Stop radio operation options bit mask.
| Enumerator | |
|---|---|
| SL_RAIL_STOP_MODE_ACTIVE_SHIFT | Shift position of SL_RAIL_STOP_MODE_ACTIVE bit. |
| SL_RAIL_STOP_MODE_PENDING_SHIFT | Shift position of SL_RAIL_STOP_MODE_PENDING bit. |
sl_rail_tx_options_t#
sl_rail_tx_options_t
Transmit options, in reality a bitmask.
| Enumerator | |
|---|---|
| SL_RAIL_TX_OPTION_WAIT_FOR_ACK_SHIFT | Shift position of SL_RAIL_TX_OPTION_WAIT_FOR_ACK bit. |
| SL_RAIL_TX_OPTION_REMOVE_CRC_SHIFT | Shift position of SL_RAIL_TX_OPTION_REMOVE_CRC bit. |
| SL_RAIL_TX_OPTION_SYNC_WORD_ID_SHIFT | Shift position of SL_RAIL_TX_OPTION_SYNC_WORD_ID bit. |
| SL_RAIL_TX_OPTION_ANTENNA_0_SHIFT | Shift position of SL_RAIL_TX_OPTION_ANTENNA_0 bit. |
| SL_RAIL_TX_OPTION_ANTENNA_1_SHIFT | Shift position of SL_RAIL_TX_OPTION_ANTENNA_1 bit. |
| SL_RAIL_TX_OPTION_ALT_PREAMBLE_LEN_SHIFT | Shift position of SL_RAIL_TX_OPTION_ALT_PREAMBLE_LEN bit. |
| SL_RAIL_TX_OPTION_RESERVED_6_SHIFT | Reserved for future use. |
| SL_RAIL_TX_OPTION_CCA_ONLY_SHIFT | Shift position of SL_RAIL_TX_OPTION_CCA_ONLY bit. |
| SL_RAIL_TX_OPTION_RESEND_SHIFT | Shift position of SL_RAIL_TX_OPTION_RESEND bit. |
| SL_RAIL_TX_OPTION_CONCURRENT_PHY_ID_SHIFT | Shift position of SL_RAIL_TX_OPTION_CONCURRENT_PHY_ID bit. |
| SL_RAIL_TX_OPTIONS_COUNT | A count of the choices in this enumeration. |
sl_rail_scheduled_tx_during_rx_t#
sl_rail_scheduled_tx_during_rx_t
Enumerates the possible outcomes of what will occur if a scheduled TX ends up firing during RX.
Because RX and TX can't happen at the same time, it is up to the user how the TX should be handled. This enumeration is passed into sl_rail_start_scheduled_tx() as part of sl_rail_scheduled_tx_config_t.
| Enumerator | |
|---|---|
| SL_RAIL_SCHEDULED_TX_DURING_RX_POSTPONE_TX | The scheduled TX will be postponed until RX completes and then sent. |
| SL_RAIL_SCHEDULED_TX_DURING_RX_ABORT_TX | The scheduled TX will be aborted and a SL_RAIL_EVENT_TX_BLOCKED event will fire. |
sl_rail_tx_repeat_options_t#
sl_rail_tx_repeat_options_t
Transmit repeat options, in reality a bitmask.
| Enumerator | |
|---|---|
| SL_RAIL_TX_REPEAT_OPTION_HOP_SHIFT | Shift position of SL_RAIL_TX_REPEAT_OPTION_HOP bit. |
| SL_RAIL_TX_REPEAT_OPTION_START_TO_START_SHIFT | Shift position of the SL_RAIL_TX_REPEAT_OPTION_START_TO_START bit. |
sl_rail_rx_options_t#
sl_rail_rx_options_t
Receive options, in reality a bitmask.
| Enumerator | |
|---|---|
| SL_RAIL_RX_OPTION_STORE_CRC_SHIFT | Shift position of SL_RAIL_RX_OPTION_STORE_CRC bit. |
| SL_RAIL_RX_OPTION_IGNORE_CRC_ERRORS_SHIFT | Shift position of SL_RAIL_RX_OPTION_IGNORE_CRC_ERRORS bit. |
| SL_RAIL_RX_OPTION_ENABLE_DUAL_SYNC_SHIFT | Shift position of SL_RAIL_RX_OPTION_ENABLE_DUAL_SYNC bit. |
| SL_RAIL_RX_OPTION_TRACK_ABORTED_FRAMES_SHIFT | Shift position of SL_RAIL_RX_OPTION_TRACK_ABORTED_FRAMES bit. |
| SL_RAIL_RX_OPTION_REMOVE_APPENDED_INFO_SHIFT | Shift position of SL_RAIL_RX_OPTION_REMOVE_APPENDED_INFO bit. |
| SL_RAIL_RX_OPTION_ANTENNA_0_SHIFT | Shift position of SL_RAIL_RX_OPTION_ANTENNA_0 bit. |
| SL_RAIL_RX_OPTION_ANTENNA_1_SHIFT | Shift position of SL_RAIL_RX_OPTION_ANTENNA_1 bit. |
| SL_RAIL_RX_OPTION_DISABLE_FRAME_DETECTION_SHIFT | Shift position of SL_RAIL_RX_OPTION_DISABLE_FRAME_DETECTION bit. |
| SL_RAIL_RX_OPTION_CHANNEL_SWITCHING_SHIFT | Shift position of SL_RAIL_RX_OPTION_CHANNEL_SWITCHING bit. |
| SL_RAIL_RX_OPTION_FAST_RX_TO_RX_SHIFT | Shift position of SL_RAIL_RX_OPTION_FAST_RX_TO_RX bit. |
| SL_RAIL_RX_OPTION_ENABLE_COLLISION_DETECTION_SHIFT | Shift position of SL_RAIL_RX_OPTION_ENABLE_COLLISION_DETECTION bit. |
sl_rail_rx_packet_status_t#
sl_rail_rx_packet_status_t
The packet status code associated with a packet received or currently being received.
Note
RECEIVING implies some packet data may be available, but is untrustworthy (not CRC-verified) and might disappear if the packet is rolled back on error. No packet details are yet available.
In RX sl_rail_data_method_t::SL_RAIL_DATA_METHOD_FIFO_MODE, ABORT statuses imply some packet data may be available, but it's incomplete and not trustworthy.
| Enumerator | |
|---|---|
| SL_RAIL_RX_PACKET_NONE | The radio is idle or searching for a packet. |
| SL_RAIL_RX_PACKET_ABORT_FORMAT | The packet was aborted during filtering because of illegal frame length, CRC or block decoding errors, other RAIL built-in protocol-specific packet content errors, or by the application or multiprotocol scheduler idling the radio with SL_RAIL_IDLE_ABORT or higher. |
| SL_RAIL_RX_PACKET_ABORT_FILTERED | The packet failed address filtering. |
| SL_RAIL_RX_PACKET_ABORT_ABORTED | The packet passed any filtering but was aborted by the application or multiprotocol scheduler idling the radio with SL_RAIL_IDLE_ABORT or higher. |
| SL_RAIL_RX_PACKET_ABORT_OVERFLOW | The packet overflowed the receive buffer. |
| SL_RAIL_RX_PACKET_ABORT_CRC_ERROR | The packet passed any filtering but subsequently failed CRC check(s) block decoding, or illegal frame length, and was aborted. |
| SL_RAIL_RX_PACKET_READY_CRC_ERROR | The packet passed any filtering but subsequently failed CRC check(s) with SL_RAIL_RX_OPTION_IGNORE_CRC_ERRORS in effect. |
| SL_RAIL_RX_PACKET_READY_SUCCESS | The packet was successfully received, passing CRC check(s). |
| SL_RAIL_RX_PACKET_RECEIVING | A packet is being received and is not yet complete. |
sl_rail_antenna_sel_t#
sl_rail_antenna_sel_t
Antenna path Selection enumeration.
| Enumerator | |
|---|---|
| SL_RAIL_ANTENNA_0 | Enum for antenna path 0. |
| SL_RAIL_ANTENNA_1 | Enum for antenna path 1. |
| SL_RAIL_ANTENNA_AUTO | Enum for antenna path auto. |
sl_rail_rf_sense_band_t#
sl_rail_rf_sense_band_t
An enumeration for specifying the RF Sense frequency band.
| Enumerator | |
|---|---|
| SL_RAIL_RF_SENSE_OFF | RF Sense is disabled. |
| SL_RAIL_RF_SENSE_2P4_GHZ | RF Sense is in 2.4 GHz band. |
| SL_RAIL_RF_SENSE_SUB_GHZ | RF Sense is in Sub-GHz band. |
| SL_RAIL_RF_SENSE_ANY | RF Sense is in both bands. |
| SL_RAIL_RF_SENSE_MAX | A count of the basic choices in this enumeration. |
| SL_RAIL_RF_SENSE_2P4_GHZ_LOW_SENSITIVITY | RF Sense is in low sensitivity 2.4 GHz band. |
| SL_RAIL_RF_SENSE_SUB_GHZ_LOW_SENSITIVITY | RF Sense is in low sensitivity Sub-GHz band. |
| SL_RAIL_RF_SENSE_ANY_LOW_SENSITIVITY | RF Sense is in low sensitivity for both bands. |
sl_rail_rx_channel_hopping_mode_t#
sl_rail_rx_channel_hopping_mode_t
Modes by which RAIL can determine when to proceed to the next channel during channel hopping.
| Enumerator | |
|---|---|
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_MANUAL | Switch to the next channel each time the radio re-enters RX after packet reception or a transmit based on the corresponding State Transitions. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_TIMEOUT | Switch to the next channel after a certain amount of time passes. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_TIMING_SENSE | Listen in receive RX for at least a specified timeout. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_PREAMBLE_SENSE | Listen in receive RX for at least a specified timeout. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_RESERVED_4 | Placeholder for a reserved hopping mode that is not supported. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_MULTI_SENSE | A mode that combines modes TIMING_SENSE, PREAMBLE_SENSE, and TIMEOUT (sync detect) all running in parallel. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_SQ | Switch to the next channel based on the demodulation settings in the PHY config. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_CONC | Marks that the channel is concurrent with another channel, and otherwise behaves identically to SL_RAIL_RX_CHANNEL_HOPPING_MODE_SQ. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_VT | Indicates that this channel is a virtual channel that is concurrently detected with the channel indicated by the sl_rail_rx_channel_hopping_config_entry_t::parameter. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_TX | This is the transmit channel used for Auto-Ack if the regular channel, specified in sl_rail_rx_channel_hopping_config_entry::parameter, is optimized for RX which may degrade some TX performance. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODES_COUNT | A count of the basic choices in this enumeration. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODES_WITH_OPTIONS_BASE | The start of equivalent modes requiring non-default sl_rail_rx_duty_cycle_config_t::options, needed for backwards-compatibility with earlier sl_rail_rx_duty_cycle_config_t format. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_MANUAL_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_MANUAL with options. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_TIMEOUT_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_TIMEOUT with options. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_TIMING_SENSE_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_TIMING_SENSE with options. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_PREAMBLE_SENSE_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_PREAMBLE_SENSE with options. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_RESERVED_4_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_RESERVED_4 with options. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_MULTI_SENSE_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_MULTI_SENSE with options. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_SQ_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_SQ with options. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_CONC_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_CONC with options. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_VT_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_VT with options. |
| SL_RAIL_RX_CHANNEL_HOPPING_MODE_TX_WITH_OPTIONS | Variant of SL_RAIL_RX_CHANNEL_HOPPING_MODE_TX with options. |
sl_rail_rx_channel_hopping_options_t#
sl_rail_rx_channel_hopping_options_t
Options that can customize channel hopping behavior on a per-hop basis.
| Enumerator | |
|---|---|
| SL_RAIL_RX_CHANNEL_HOPPING_OPTION_SKIP_SYNTH_CAL_SHIFT | Shift position of SL_RAIL_RX_CHANNEL_HOPPING_OPTION_SKIP_SYNTH_CAL bit. |
| SL_RAIL_RX_CHANNEL_HOPPING_OPTION_SKIP_DC_CAL_SHIFT | Shift position of SL_RAIL_RX_CHANNEL_HOPPING_OPTION_SKIP_DC_CAL bit. |
| SL_RAIL_RX_CHANNEL_HOPPING_OPTION_RSSI_THRESHOLD_SHIFT | Shift position of SL_RAIL_RX_CHANNEL_HOPPING_OPTION_RSSI_THRESHOLD bit. |
| SL_RAIL_RX_CHANNEL_HOPPING_OPTION_STOP_SHIFT | Shift position of SL_RAIL_RX_CHANNEL_HOPPING_OPTION_STOP bit. |
| SL_RAIL_RX_CHANNEL_HOPPING_OPTIONS_COUNT | A count of the choices in this enumeration. |
sl_rail_stream_mode_t#
sl_rail_stream_mode_t
Possible stream output modes.
| Enumerator | |
|---|---|
| SL_RAIL_STREAM_CARRIER_WAVE | An unmodulated carrier wave. |
| SL_RAIL_STREAM_PN9_STREAM | PN9 byte sequence. |
| SL_RAIL_STREAM_10_STREAM | 101010 sequence. |
| SL_RAIL_STREAM_CARRIER_WAVE_PHASENOISE | An unmodulated carrier wave with no change to PLL BW. |
| SL_RAIL_STREAM_RAMP_STREAM | ramp sequence starting at a different offset for consecutive packets. |
| SL_RAIL_STREAM_CARRIER_WAVE_SHIFTED | An unmodulated carrier wave not centered on DC but shifted roughly by channel_bandwidth/6 allowing an easy check of the residual DC. |
| SL_RAIL_STREAM_1000_STREAM | 10001000 sequence. |
| SL_RAIL_STREAM_MODES_COUNT | A count of the choices in this enumeration. |
sl_rail_vdet_mode_t#
sl_rail_vdet_mode_t
VDET Modes.
The VDET Mode is passed to sl_rail_config_vdet() via sl_rail_vdet_config_t. The Front End Module Voltage Detection (VDET) Utility component allows customers to measure their Front End Module performance at specified points in the Transmit packet.
| Enumerator | |
|---|---|
| SL_RAIL_VDET_MODE_DISABLED | VDET is completely disabled. |
| SL_RAIL_VDET_MODE_AUTOMATIC | AUTOMATIC causes VDET measurements to be taken every Tx packet at the specified time. |
| SL_RAIL_VDET_MODE_IMMEDIATE | IMMEDIATE causes an immediate VDET measurement. |
| SL_RAIL_VDET_MODE_COUNT | A count of the choices in this enumeration. |
sl_rail_vdet_resolution_t#
sl_rail_vdet_resolution_t
VDET Resolution for the Aux ADC.
The VDET Resolution is passed to sl_rail_config_vdet() via sl_rail_vdet_config_t. Shows available resolution options.
| Enumerator | |
|---|---|
| SL_RAIL_VDET_RESOLUTION_10_BIT | ~10 bit resolution. |
| SL_RAIL_VDET_RESOLUTION_11_BIT | ~11 bit resolution. |
| SL_RAIL_VDET_RESOLUTION_12_BIT | ~12 bit resolution. |
| SL_RAIL_VDET_RESOLUTION_COUNT | A count of the choices in this enumeration. |
sl_rail_vdet_status_t#
sl_rail_vdet_status_t
VDET Status.
The VDET Status for internal debug. Shows states.
| Enumerator | |
|---|---|
| SL_RAIL_VDET_STATUS_IDLE | IDLE - Waiting for next command/measurement. |
| SL_RAIL_VDET_STATUS_START | START of the VDET measurement activity. |
| SL_RAIL_VDET_STATUS_10_BIT_DONE | Completion of a 10 bit measurement. |
| SL_RAIL_VDET_STATUS_11_BIT_DONE | Completion of a 11 bit measurement. |
| SL_RAIL_VDET_STATUS_12_BIT_DONE | Completion of a 12 bit measurement. |
| SL_RAIL_VDET_STATUS_BLOCKED | Conflict with another AuxADC user. |
| SL_RAIL_VDET_STATUS_ERROR | An error has occurred. |
| SL_RAIL_VDET_STATUS_COUNT | A count of the choices in this enumeration. |
sl_rail_retime_options_t#
sl_rail_retime_options_t
Retiming options bit shifts.
| Enumerator | |
|---|---|
| SL_RAIL_RETIME_OPTION_HFXO_SHIFT | Shift position of SL_RAIL_RETIME_OPTION_HFXO bit. |
| SL_RAIL_RETIME_OPTION_HFRCO_SHIFT | Shift position of SL_RAIL_RETIME_OPTION_HFRCO bit. |
| SL_RAIL_RETIME_OPTION_DCDC_SHIFT | Shift position of SL_RAIL_RETIME_OPTION_DCDC bit. |
| SL_RAIL_RETIME_OPTION_LCD_SHIFT | Shift position of SL_RAIL_RETIME_OPTION_LCD bit. |
Typedef Documentation#
sl_rail_handle_t#
sl_rail_handle_t
A radio-generic handle (e.g., SL_RAIL_EFR32_HANDLE), or a real RAIL instance handle as returned from sl_rail_init().
Generic-radio handles must be used for certain RAIL APIs that are called prior to RAIL initialization. However, once RAIL has been initialized, the real handle returned by sl_rail_init() should be used instead.
sl_rail_status_t#
sl_rail_status_t
A status returned by many RAIL API calls indicating their success or failure.
It is a subset of sl_status_t.
sl_rail_init_complete_callback_t#
typedef void(* sl_rail_init_complete_callback_t) (sl_rail_handle_t rail_handle) )(sl_rail_handle_t rail_handle)
A pointer to an initialization complete callback function.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | rail_handle | The initialized RAIL instance handle. |
sl_rail_opaque_value_t#
sl_rail_opaque_value_t [1]
An opaque type not examined by RAIL; can be used for application- specific purposes.
sl_rail_timer_callback_t#
typedef void(* sl_rail_timer_callback_t) (sl_rail_handle_t rail_handle) )(sl_rail_handle_t rail_handle)
A pointer to the callback called when the RAIL timer expires.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | rail_handle | The RAIL handle that was used in the sl_rail_set_timer() call. |
sl_rail_multi_timer_callback_t#
sl_rail_multi_timer_callback_t )(struct sl_rail_multi_timer *p_tmr, sl_rail_time_t expected_time_of_event, void *cb_arg)
Callback fired when timer expires.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | p_tmr | A pointer to an expired timer. | |
| [in] | expected_time_of_event | An absolute time event fired. | |
| [in] | cb_arg | A user-supplied callback argument. Since this callback doesn't include a parameter for the sl_rail_handle_t passed into sl_rail_set_multi_timer() it might be handy to also pass that RAIL handle as the cb_arg when calling sl_rail_set_multi_timer(). |
sl_rail_fifo_buffer_align_t#
typedef uint32_t sl_rail_fifo_buffer_align_t
Type indicating the needed alignment for RX and TX FIFOs.
sl_rail_packet_queue_entry_t#
typedef uint64_t sl_rail_packet_queue_entry_t
Type used for Packet Queue entries.
RAIL utilizes a receive Packet Queue for packet reception metadata that supplements the receive FIFO, helping sl_rail_get_rx_packet_info() and sl_rail_get_rx_packet_details() provide their information in the order that packets were received.
sl_rail_events_callback_t#
typedef void(* sl_rail_events_callback_t) (sl_rail_handle_t rail_handle, sl_rail_events_t events) )(sl_rail_handle_t rail_handle, sl_rail_events_t events)
A pointer to the callback called when some RAIL event(s) occur.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | rail_handle | The RAIL handle active when the event occurred. | |
| [in] | events | The RAIL event(s) that have occurred. |
sl_rail_tx_power_t#
typedef int16_t sl_rail_tx_power_t
The transmit power in deci-dBm units (e.g., 4.5 dBm -> 45 deci-dBm).
On EFR32 they can range from SL_RAIL_TX_POWER_MIN to SL_RAIL_TX_POWER_MAX.
sl_rail_pa_power_setting_t#
typedef uint32_t sl_rail_pa_power_setting_t
PA power setting type used directly by the PA Power Conversions component which is decoded to the actual hardware register value(s).
sl_rail_radio_config_t#
typedef const uint32_t* sl_rail_radio_config_t
Pointer to a radio configuration array.
The radio configuration properly configures the radio for operation on a protocol. These configurations are very chip-specific should not be created or edited by hand.
sl_rail_packet_duration_t#
sl_rail_packet_duration_t )(uint8_t bit_rate, uint16_t number_of_bytes)
A pointer to a function that processes packet duration on air.
sl_rail_radio_config_changed_callback_t#
sl_rail_radio_config_changed_callback_t )(sl_rail_handle_t rail_handle, const sl_rail_channel_config_entry_t *p_entry)
A pointer to a function called whenever a radio configuration change occurs.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | rail_handle | The corresponding real RAIL instance handle. | |
| [in] | p_entry | A pointer to the radio configuration entry being changed to. |
sl_rail_transition_time_t#
sl_rail_transition_time_t
Suitable type for the supported transition time range.
Refer to platform-specific SL_RAIL_MINIMUM_TRANSITION_US and SL_RAIL_MAXIMUM_TRANSITION_US for the valid range of this type.
sl_rail_addr_filter_mask_t#
typedef uint8_t sl_rail_addr_filter_mask_t
A bitmask representation of which 4 filters passed for each SL_RAIL_ADDR_CONFIG_MAX_ADDRESS_FIELDS when filtering has completed successfully.
It's layout is: | Bit 7 | Bit 6 | Bit 5 | Bit 4 | Bit 3 | Bit 2 | Bit 1 | Bit 0 | |-----—+-----—+-----—+-----—+-----—+-----—+-----—+-----—| | Second Address Field Nibble | First Address Field Nibble | | Addr 3 | Addr 2 | Addr 1 | Addr 0 | Addr 3 | Addr 2 | Addr 1 | Addr 0 | | match | match | match | match | match | match | match | match | |-----—+-----—+-----—+-----—+-----—+-----—+-----—+-----—|
Note
This information is valid in sl_rail_ieee802154_address_t on all platforms, but is only valid in sl_rail_rx_packet_info_t on platforms where SL_RAIL_SUPPORTS_ADDR_FILTER_MASK is true.
sl_rail_rx_packet_handle_t#
sl_rail_rx_packet_handle_t
A handle used to reference a packet during reception processing.
There are several sentinel handle values that pertain to certain circumstances: SL_RAIL_RX_PACKET_HANDLE_INVALID, SL_RAIL_RX_PACKET_HANDLE_OLDEST, SL_RAIL_RX_PACKET_HANDLE_OLDEST_COMPLETE and SL_RAIL_RX_PACKET_HANDLE_NEWEST.
sl_rail_convert_lqi_callback_t#
sl_rail_convert_lqi_callback_t )(uint8_t lqi, int8_t rssi_dbm)
A pointer to a function called before LQI is copied into the sl_rail_rx_packet_details_t structure.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | lqi | The LQI value obtained by hardware and being readied for application consumption. This LQI value is in integral units ranging from 0 to 255. | |
| [in] | rssi_dbm | The RSSI value corresponding to the packet from which the hardware LQI value was obtained. This RSSI value is in integral dBm units. |
Returns
uint8_t The converted LQI value that will be loaded into the sl_rail_rx_packet_details_t structure in preparation for application consumption. This value should likewise be in integral units ranging from 0 to 255.
sl_rail_cal_mask_t#
sl_rail_cal_mask_t
A calibration mask type.
This type is a bitmask of different RAIL calibration values. The exact meaning of these bits depends on what a particular chip supports.
sl_rail_rx_ir_cal_values_t#
typedef uint32_t sl_rail_rx_ir_cal_values_t[2] [2]
sl_rail_rx_ir_cal_values_t
RX IR calibration values.
Platforms with fewer SL_RAIL_RF_PATHS than SL_RAIL_MAX_RF_PATHS will only respect and update SL_RAIL_RF_PATHS indices and ignore the rest.
sl_rail_cal_values_t#
sl_rail_cal_values_t
A calibration value structure.
This structure contains the set of persistent calibration values for EFR32. You can set these beforehand and apply them at startup to save the time required to compute them. Any of these values may be set to SL_RAIL_CAL_INVALID_VALUE to force the code to compute that calibration value.
sl_rail_rf_sense_callback_t#
typedef void(* sl_rail_rf_sense_callback_t) (void) )(void)
A pointer to an RF Sense callback function.
Consider using the event SL_RAIL_EVENT_RF_SENSED as an alternative.
sl_rail_rx_channel_hopping_parameter_t#
sl_rail_rx_channel_hopping_parameter_t
Rx channel hopping on-channel time.
sl_rail_frequency_offset_t#
sl_rail_frequency_offset_t
Type that represents the number of Frequency Offset units.
It is used with sl_rail_get_rx_freq_offset() and sl_rail_set_freq_offset().
The units are chip-specific. For EFR32 they are radio synthesizer resolution steps (synth ticks) and is limited to 15 bits. A value of SL_RAIL_FREQUENCY_OFFSET_INVALID means that this value is invalid.
sl_rail_tz_changed_dcdc_callback_t#
sl_rail_tz_changed_dcdc_callback_t )(void)
A pointer to the callback used to switch to secure world and run sl_rail_changed_dcdc().
Returns
Status code indicating success of the function call.
sl_rail_tz_config_antenna_gpio_callback_t#
sl_rail_tz_config_antenna_gpio_callback_t )(const sl_rail_antenna_config_t *p_config)
A pointer to the callback used to switch to secure world and run sl_rail_tz_config_antenna_gpio().
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | p_config | A pointer to a configuration structure applied to the relevant Antenna Configuration registers. A NULL configuration will produce undefined behavior. |
Returns
Status code indicating success of the function call.
sl_rail_tz_radio_clock_enable_callback_t#
sl_rail_tz_radio_clock_enable_callback_t )(void)
A pointer to the callback used to switch to secure world and run sl_rail_tz_radio_clock_enable().
sl_rail_tz_get_radio_clock_freq_hz_callback_t#
sl_rail_tz_get_radio_clock_freq_hz_callback_t )(void)
A pointer to the callback used to switch to secure world and run sl_rail_get_radio_clock_freq_hz().
Returns
Radio subsystem clock frequency in Hz.
sl_rail_tz_rfeca_clock_enable_callback_t#
sl_rail_tz_rfeca_clock_enable_callback_t )(void)
A pointer to the callback used to switch to secure world and run sl_rail_tz_rfeca_clock_enable().
sl_rail_tz_rfeca_is_clock_enabled_callback_t#
sl_rail_tz_rfeca_is_clock_enabled_callback_t )(void)
A pointer to the callback used to switch to secure world and run sl_rail_tz_rfeca_is_clock_enabled().
Returns
true if RFECA clocks are enabled; false otherwise
sl_rail_tz_read_internal_temperature_callback_t#
sl_rail_tz_read_internal_temperature_callback_t )(uint16_t *p_internal_temperature_kelvin, bool enable_temperature_interrupts)
A pointer to the callback used to switch to secure world and run sl_rail_tz_read_internal_temperature().
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [out] | p_internal_temperature_kelvin | A pointer to the internal temperature in Kelvin. | |
| [in] | enable_temperature_interrupts | Indicate whether temperature interrupts are enabled. |
Returns
Status code indicating success of the function call.
sl_rail_tz_enable_secure_radio_irqs_callback_t#
sl_rail_tz_enable_secure_radio_irqs_callback_t )(void)
A pointer to the callback used to switch to secure world and run sl_rail_tz_enable_secure_radio_irqs().
sl_rail_tz_disable_secure_radio_irqs_callback_t#
sl_rail_tz_disable_secure_radio_irqs_callback_t )(void)
A pointer to the callback used to switch to secure world and run sl_rail_tz_disable_secure_radio_irqs().
sl_rail_tz_radio_perform_m2m_ldma_callback_t#
sl_rail_tz_radio_perform_m2m_ldma_callback_t )(uint32_t *p_dest, const uint32_t *p_src, uint32_t num_words)
A pointer to the callback used to switch to secure world and run sl_rail_tz_radio_perform_m2m_ldma().
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [in] | p_dest | A pointer to the destination data. | |
| [in] | p_src | A pointer to the source data. | |
| [in] | num_words | Number of words to transfer. |
Returns
Status code indicating success of the function call.
sl_rail_tz_configure_hfxo_callback_t#
sl_rail_tz_configure_hfxo_callback_t )(void)
A pointer to the callback used to switch to secure world and run sl_rail_tz_configure_hfxo().