Retiming
RAIL API

EFR32-specific retiming capability.

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_OPTIONS_NONE   0x0U
 A value representing no retiming options.
 
#define RAIL_RETIME_OPTIONS_ALL   0xFFU
 A value representing all retiming options.

Enumerations

enum  RAIL_RetimeOptions_t {
  RAIL_RETIME_OPTION_HFXO_SHIFT = 0,
  RAIL_RETIME_OPTION_HFRCO_SHIFT,
  RAIL_RETIME_OPTION_DCDC_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.

Detailed Description

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.

Enumeration Type Documentation

◆ RAIL_RetimeOptions_t

enum 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.

Definition at line 899 of file rail_chip_specific.h.

Function Documentation

◆ RAIL_ChangedDcdc()

RAIL_Status_t RAIL_ChangedDcdc ( void  )

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

Note
This should be called after DCDC has been enabled or disabled.
Returns
Status code indicating success of the function call.

◆ RAIL_ConfigRetimeOptions()

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

Configure retiming options.

Parameters
[in]railHandleA handle of RAIL instance.
[in]maskA bitmask containing which options should be modified.
[in]optionsA 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.

◆ RAIL_GetRetimeOptions()

RAIL_Status_t RAIL_GetRetimeOptions ( RAIL_Handle_t  railHandle,
RAIL_RetimeOptions_t *  pOptions 
)

Get the currently configured retiming option.

Parameters
[in]railHandleA handle of RAIL instance.
[out]pOptionsA pointer to configured retiming options bitmask indicating which are enabled.
Returns
Status code indicating success of the function call.