Sidewalk Radio Configurations#
Radio configurations for the RAIL Sidewalk Accelerator.
These radio configurations are used to configure Sidewalk when a function such as RAIL_Sidewalk_ConfigPhy2GFSK50kbps() is called. Each radio configuration listed below is compiled into the RAIL library as a weak symbol that will take into account per-die defaults. If the board configuration in use has different settings than the default, such as a different radio subsystem clock frequency, these radio configurations can be overriden to account for those settings.
These radio configurations are used to configure Sidewalk when a function such as sl_rail_sidewalk_config_phy_2gfsk_50_kbps() is called. Each radio configuration listed below is compiled into the RAIL library as a weak symbol that will take into account per-die defaults. If the board configuration in use has different settings than the default, such as a different radio subsystem clock frequency, these radio configurations can be overriden to account for those settings.
Enumerations#
The Sidewalk PHY identifier (aka PTI radio configuration id).
Variables#
Default PHY to use for Sidewalk 2GFSK 50kbps.
Default PHY to use for Sidewalk 2GFSK 50kbps.
Functions#
Switch to the 2GFSK 50 kbps Sidewalk PHY.
Switch to the 2GFSK 50 kbps Sidewalk PHY.
Enumeration Documentation#
sl_rail_sidewalk_phy_t#
sl_rail_sidewalk_phy_t
The Sidewalk PHY identifier (aka PTI radio configuration id).
| Enumerator | |
|---|---|
| SL_RAIL_SIDEWALK_PHY_2GFSK_50_KBPS | Use the 2GFSK 50 kbps Sidewalk PHY. |
Variable Documentation#
RAIL_Sidewalk_Phy2GFSK50kbps#
const RAIL_ChannelConfig_t* const RAIL_Sidewalk_Phy2GFSK50kbps
Default PHY to use for Sidewalk 2GFSK 50kbps.
Will be NULL if RAIL_SUPPORTS_PROTOCOL_SIDEWALK is 0.
DeprecatedRAIL 2.x synonym of sl_rail_sidewalk_phy_2gfsk_50_kbps.
sl_rail_sidewalk_phy_2gfsk_50_kbps#
const sl_rail_channel_config_t* const sl_rail_sidewalk_phy_2gfsk_50_kbps
Default PHY to use for Sidewalk 2GFSK 50kbps.
Will be NULL if SL_RAIL_SUPPORTS_PROTOCOL_SIDEWALK is 0.
Function Documentation#
RAIL_Sidewalk_ConfigPhy2GFSK50kbps#
RAIL_Status_t RAIL_Sidewalk_ConfigPhy2GFSK50kbps (RAIL_Handle_t railHandle)
Switch to the 2GFSK 50 kbps Sidewalk PHY.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| RAIL_Handle_t | [in] | railHandle | A handle for RAIL instance. |
Returns
Status code indicating success of the function call.
Use this function to switch to the 2GFSK 50 kbps Sidewalk PHY.
Note
The Sidewalk PHY is supported only on some parts. The preprocessor symbol RAIL_SUPPORTS_PROTOCOL_SIDEWALK and the runtime function RAIL_SupportsProtocolSidewalk() may be used to test for support of the Sidewalk PHY.
DeprecatedRAIL 2.x synonym of sl_rail_sidewalk_config_phy_2gfsk_50_kbps().
sl_rail_sidewalk_config_phy_2gfsk_50_kbps#
sl_rail_status_t sl_rail_sidewalk_config_phy_2gfsk_50_kbps (sl_rail_handle_t rail_handle)
Switch to the 2GFSK 50 kbps Sidewalk PHY.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_rail_handle_t | [in] | rail_handle | A real RAIL instance handle. |
Returns
Status code indicating success of the function call.
Use this function to switch to the 2GFSK 50 kbps Sidewalk PHY.
Note
The Sidewalk PHY is supported only on some parts. The preprocessor symbol SL_RAIL_SUPPORTS_PROTOCOL_SIDEWALK and the runtime function sl_rail_supports_protocol_sidewalk() may be used to test for support of the Sidewalk PHY.