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

RAIL_RETIME_OPTION_DCDC_SHIFT

RAIL_RETIME_OPTION_LCD_SHIFT

}

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.

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.

Enumeration Documentation#

RAIL_RetimeOptions_t#

RAIL_RetimeOptions_t

Retiming options bit shifts.

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.

Definition at line 5725 of file common/rail_types.h

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

[in]	railHandle	A handle of RAIL instance.
[in]	mask	A bitmask containing which options should be modified.
[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.

Definition at line 5778 of file common/rail_types.h

RAIL_GetRetimeOptions#

RAIL_Status_t RAIL_GetRetimeOptions (RAIL_Handle_t railHandle, RAIL_RetimeOptions_t * pOptions)

Get the currently configured retiming option.

Parameters

[in]	railHandle	A handle of RAIL instance.
[out]	pOptions	A pointer to configured retiming options bitmask indicating which are enabled.

Returns

Status code indicating success of the function call.

Definition at line 5790 of file common/rail_types.h

RAIL_ChangedDcdc#

RAIL_Status_t RAIL_ChangedDcdc (void )

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

Parameters

N/A

Note

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

Returns

Status code indicating success of the function call.

Definition at line 5801 of file common/rail_types.h

Macro Definition Documentation#

RAIL_RETIME_OPTION_HFXO#

#define RAIL_RETIME_OPTION_HFXO

Value:

  (1U << RAIL_RETIME_OPTION_HFXO_SHIFT)

An option to configure HFXO retiming.

Definition at line 5740 of file common/rail_types.h

RAIL_RETIME_OPTION_HFRCO#

#define RAIL_RETIME_OPTION_HFRCO

Value:

  (1U << RAIL_RETIME_OPTION_HFRCO_SHIFT)

An option to configure HFRCO retiming.

Definition at line 5746 of file common/rail_types.h

RAIL_RETIME_OPTION_DCDC#

#define RAIL_RETIME_OPTION_DCDC

Value:

  (1U << RAIL_RETIME_OPTION_DCDC_SHIFT)

An option to configure DCDC retiming.

Ignored on platforms that lack DCDC.

Definition at line 5753 of file common/rail_types.h

RAIL_RETIME_OPTION_LCD#

#define RAIL_RETIME_OPTION_LCD

Value:

  (1U << RAIL_RETIME_OPTION_LCD_SHIFT)

An option to configure LCD retiming.

Ignored on platforms that lack LCD.

Definition at line 5760 of file common/rail_types.h

RAIL_RETIME_OPTIONS_NONE#

#define RAIL_RETIME_OPTIONS_NONE

Value:

0x0U

A value representing no retiming options.

Definition at line 5764 of file common/rail_types.h

RAIL_RETIME_OPTIONS_ALL#

#define RAIL_RETIME_OPTIONS_ALL

Value:

0xFFU

A value representing all retiming options.

Definition at line 5767 of file common/rail_types.h