Retiming#

EFR32-specific retiming capability.

The EFR product families have many digital and analog modules that can run in parallel with a radio. These combinations can cause interference and degradation on the radio RX sensitivity. Retiming can modify the clocking of the digital modules to reduce the interference.

Enumerations#

enum

RAIL_RetimeOptions_t {

RAIL_RETIME_OPTION_HFXO_SHIFT = 0

RAIL_RETIME_OPTION_HFRCO_SHIFT = 1

RAIL_RETIME_OPTION_DCDC_SHIFT = 2

RAIL_RETIME_OPTION_LCD_SHIFT = 3

}

Retiming options bit shifts.

enum

sl_rail_retime_options_t {

SL_RAIL_RETIME_OPTION_HFXO_SHIFT = 0

SL_RAIL_RETIME_OPTION_HFRCO_SHIFT = 1

SL_RAIL_RETIME_OPTION_DCDC_SHIFT = 2

SL_RAIL_RETIME_OPTION_LCD_SHIFT = 3

}

Retiming options bit shifts.

Functions#

RAIL_Status_t

RAIL_ConfigRetimeOptions(RAIL_Handle_t railHandle, RAIL_RetimeOptions_t mask, RAIL_RetimeOptions_t options)

Configure retiming options.

RAIL_Status_t

RAIL_GetRetimeOptions(RAIL_Handle_t railHandle, RAIL_RetimeOptions_t *pOptions)

Get the currently configured retiming option.

RAIL_Status_t

RAIL_ChangedDcdc(void)

Indicate that the DCDC peripheral bus clock enable has changed allowing RAIL to react accordingly.

sl_rail_status_t

sl_rail_config_retime_options(sl_rail_handle_t rail_handle, sl_rail_retime_options_t mask, sl_rail_retime_options_t options)

Configure retiming options.

sl_rail_status_t

sl_rail_get_retime_options(sl_rail_handle_t rail_handle, sl_rail_retime_options_t *p_options)

Get the currently configured retiming option.

sl_rail_status_t

sl_rail_changed_dcdc(void)

Indicate that the DCDC peripheral bus clock enable has changed allowing RAIL to react accordingly.

Macros#

#define

RAIL_RETIME_OPTION_HFXO (1U << RAIL_RETIME_OPTION_HFXO_SHIFT)

An option to configure HFXO retiming.

#define

RAIL_RETIME_OPTION_HFRCO (1U << RAIL_RETIME_OPTION_HFRCO_SHIFT)

An option to configure HFRCO retiming.

#define

RAIL_RETIME_OPTION_DCDC (1U << RAIL_RETIME_OPTION_DCDC_SHIFT)

An option to configure DCDC retiming.

#define

RAIL_RETIME_OPTION_LCD (1U << RAIL_RETIME_OPTION_LCD_SHIFT)

An option to configure LCD retiming.

#define

RAIL_RETIME_OPTIONS_NONE 0x0U

A value representing no retiming options.

#define

RAIL_RETIME_OPTIONS_ALL 0xFFU

A value representing all retiming options.

#define

SL_RAIL_RETIME_OPTION_HFXO (1U << SL_RAIL_RETIME_OPTION_HFXO_SHIFT)

An option to configure HFXO retiming.

#define

SL_RAIL_RETIME_OPTION_HFRCO (1U << SL_RAIL_RETIME_OPTION_HFRCO_SHIFT)

An option to configure HFRCO retiming.

#define

SL_RAIL_RETIME_OPTION_DCDC (1U << SL_RAIL_RETIME_OPTION_DCDC_SHIFT)

An option to configure DCDC retiming.

#define

SL_RAIL_RETIME_OPTION_LCD (1U << SL_RAIL_RETIME_OPTION_LCD_SHIFT)

An option to configure LCD retiming.

#define

SL_RAIL_RETIME_OPTIONS_NONE 0x0U

A value representing no retiming options.

#define

SL_RAIL_RETIME_OPTIONS_ALL 0xFFU

A value representing all retiming options.

Enumeration Documentation#

RAIL_RetimeOptions_t#

RAIL_RetimeOptions_t

Retiming options bit shifts.

DeprecatedRAIL 2.x synonym of sl_rail_retime_options_t.

Enumerator
RAIL_RETIME_OPTION_HFXO_SHIFT	Shift position of RAIL_RETIME_OPTION_HFXO bit.
RAIL_RETIME_OPTION_HFRCO_SHIFT	Shift position of RAIL_RETIME_OPTION_HFRCO bit.
RAIL_RETIME_OPTION_DCDC_SHIFT	Shift position of RAIL_RETIME_OPTION_DCDC bit.
RAIL_RETIME_OPTION_LCD_SHIFT	Shift position of RAIL_RETIME_OPTION_LCD bit.

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.

Function Documentation#

RAIL_ConfigRetimeOptions#

RAIL_Status_t RAIL_ConfigRetimeOptions (RAIL_Handle_t railHandle, RAIL_RetimeOptions_t mask, RAIL_RetimeOptions_t options)

Configure retiming options.

Parameters

Type	Direction	Argument Name	Description
RAIL_Handle_t	[in]	railHandle	A handle of RAIL instance.
RAIL_RetimeOptions_t	[in]	mask	A bitmask containing which options should be modified.
RAIL_RetimeOptions_t	[in]	options	A bitmask containing desired configuration settings. Bit positions for each option are found in the RAIL_RetimeOptions_t.

Returns

Status code indicating success of the function call.

DeprecatedRAIL 2.x synonym of sl_rail_config_retime_options().

RAIL_GetRetimeOptions#

RAIL_Status_t RAIL_GetRetimeOptions (RAIL_Handle_t railHandle, RAIL_RetimeOptions_t * pOptions)

Get the currently configured retiming option.

Parameters

Type	Direction	Argument Name	Description
RAIL_Handle_t	[in]	railHandle	A handle of RAIL instance.
RAIL_RetimeOptions_t *	[out]	pOptions	A pointer to configured retiming options bitmask indicating which are enabled.

Returns

Status code indicating success of the function call.

DeprecatedRAIL 2.x synonym of sl_rail_get_retime_options().

RAIL_ChangedDcdc#

RAIL_Status_t RAIL_ChangedDcdc (void )

Indicate that the DCDC peripheral bus clock enable has changed allowing RAIL to react accordingly.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

Status code indicating success of the function call.

Note

This should be called after DCDC has been enabled or disabled.

DeprecatedRAIL 2.x synonym of sl_rail_changed_dcdc().

sl_rail_config_retime_options#

sl_rail_status_t sl_rail_config_retime_options (sl_rail_handle_t rail_handle, sl_rail_retime_options_t mask, sl_rail_retime_options_t options)

Configure retiming options.

Parameters

Type	Direction	Argument Name	Description
sl_rail_handle_t	[in]	rail_handle	A handle of RAIL instance.
sl_rail_retime_options_t	[in]	mask	A bitmask containing which options should be modified.
sl_rail_retime_options_t	[in]	options	A bitmask containing desired configuration settings. Bit positions for each option are found in the sl_rail_retime_options_t.

Returns

Status code indicating success of the function call.

sl_rail_get_retime_options#

sl_rail_status_t sl_rail_get_retime_options (sl_rail_handle_t rail_handle, sl_rail_retime_options_t * p_options)

Get the currently configured retiming option.

Parameters

Type	Direction	Argument Name	Description
sl_rail_handle_t	[in]	rail_handle	A handle of RAIL instance.
sl_rail_retime_options_t *	[out]	p_options	A pointer to configured retiming options bitmask indicating which are enabled.

Returns

Status code indicating success of the function call.

sl_rail_changed_dcdc#

sl_rail_status_t sl_rail_changed_dcdc (void )

Indicate that the DCDC peripheral bus clock enable has changed allowing RAIL to react accordingly.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

Status code indicating success of the function call.

Note

This should be called after DCDC has been enabled or disabled.