Energy Friendly Front End Module (EFF)#

RAIL_EffDevice_t#

RAIL_EffDevice_t

EFF part numbers.

The part number of the attached EFF device is passed to RAIL_ConfigEff() as RAIL_EffConfig_t::device. The Energy Friendly Front End Module (EFF) Utility configures and controls the EFF based on the capabilities of the attached EFF.

RAIL_EffLnaMode_t#

RAIL_EffLnaMode_t

EFF LNA Modes.

The enabled EFF LNA modes are passed toRAIL_ConfigEff() as the RAIL_EffConfig_t::enabledLnaModes. The Energy Friendly Front End Module (EFF) Utility dynamically transitions between enabled LNA modes to maximize receive performance.

RAIL_ClpcEnable_t#

RAIL_ClpcEnable_t

EFF Closed Loop Power Control (CLPC) Enable states.

The EFF CLPC Enable state is passed to RAIL_ConfigEff() as the RAIL_EffConfig_t::clpcEnable. The Energy Friendly Front End Module (EFF) Utility uses advanced power controls to tune EFF output to match Surface Acoustic Wave (SAW) filter losses and antenna performance.

RAIL_EffModeSensor_t#

RAIL_EffModeSensor_t

EFF Closed Loop Power Control (CLPC) Mode Sensor Indices.

The mode sensor indices are used to access specific settings with CLPC.

RAIL_ConfigEff#

RAIL_Status_t RAIL_ConfigEff (RAIL_Handle_t genericRailHandle, const RAIL_EffConfig_t * config)

Configure the attached EFF device.

Returns

• Status code indicating success of the function call.

RAIL_GetTemperature#

RAIL_Status_t RAIL_GetTemperature (RAIL_Handle_t railHandle, int16_t tempBuffer, bool reset)

Get the different temperature measurements in Kelvin done by sequencer or host.

Values that are not populated yet or incorrect are set to 0.

Temperatures, in Kelvin, are stored in tempBuffer such as: tempBuffer[0] is the chip temperature tempBuffer[1] is the minimal chip temperature tempBuffer[2] is the maximal chip temperature

If RAIL_SUPPORTS_EFF is defined tempBuffer[3] is the EFF temperature before Tx tempBuffer[4] is the EFF temperature after Tx tempBuffer[5] is the minimal EFF temperature value before Tx tempBuffer[6] is the minimal EFF temperature value after Tx tempBuffer[7] is the maximal EFF temperature value before Tx tempBuffer[8] is the maximal EFF temperature value after Tx tempBuffer[9] is not used tempBuffer[10] is not used

If RAIL_SUPPORTS_HFXO_COMPENSATION tempBuffer[11] is the HFXO temperature

Returns

• Status code indicating success of the function call.

RAIL_GetSetEffControl#

RAIL_Status_t RAIL_GetSetEffControl (RAIL_Handle_t railHandle, uint16_t tempBuffer, bool reset)

Get the different EFF Control measurements.

Returns

• Status code indicating success of the function call.

RAIL_GetSetEffMode#

RAIL_Status_t RAIL_GetSetEffMode (RAIL_Handle_t railHandle, uint8_t * newMode, bool changeMode)

Copy the current FEM_DATA pin values into newMode.

If changeMode is true, update FEM_DATA pin values with newMode first.

Returns

• Status code indicating success of the function call.

RAIL_GetSetEffRuralUrbanMv#

RAIL_Status_t RAIL_GetSetEffRuralUrbanMv (RAIL_Handle_t railHandle, uint16_t * newTrip, bool changeTrip)

Copy the current Rural to Urban trip voltage into newTrip.

If changeTrip is true, update current Rural to Urban trip voltage with newTrip first.

Returns

• Status code indicating success of the function call.

RAIL_GetSetEffUrbanBypassMv#

RAIL_Status_t RAIL_GetSetEffUrbanBypassMv (RAIL_Handle_t railHandle, uint16_t * newTrip, bool changeTrip)

Copy the current Urban to Bypass trip voltage into newTrip.

If changeTrip is true, update current Urban to Bypass trip voltage with newTrip first.

Returns

• Status code indicating success of the function call.

RAIL_GetSetEffUrbanDwellTimeMs#

RAIL_Status_t RAIL_GetSetEffUrbanDwellTimeMs (RAIL_Handle_t railHandle, uint32_t * newDwellTime, bool changeDwellTime)

Copy the current Urban dwell time into newDwellTime.

If changeDwellTime is true, update current Urban dwell time with newDwellTime first.

Returns

• Status code indicating success of the function call.

RAIL_GetSetEffBypassDwellTimeMs#

RAIL_Status_t RAIL_GetSetEffBypassDwellTimeMs (RAIL_Handle_t railHandle, uint32_t * newDwellTime, bool changeDwellTime)

Copy the current Bypass dwell time into newDwellTime.

If changeDwellTime is true, update current Bypass dwell time with newDwellTime first.

Returns

• Status code indicating success of the function call.

RAIL_GetSetClpcFastLoopCal#

RAIL_Status_t RAIL_GetSetClpcFastLoopCal (RAIL_Handle_t railHandle, RAIL_EffModeSensor_t modeSensorIndex, RAIL_EffCalConfig_t * calibrationEntry, bool changeValues)

If changeValues is true, update current CLPC Fast Loop calibration values using the new variables.

If false, copy the current CLPC Fast Loop calibration values into new variables.

Returns

• Status code indicating success of the function call.

RAIL_GetSetClpcFastLoopCalSlp#

RAIL_Status_t RAIL_GetSetClpcFastLoopCalSlp (RAIL_Handle_t railHandle, RAIL_EffModeSensor_t modeSensorIndex, int16_t * newSlope1e1MvPerDdbm, int16_t * newoffset290Ddbm, bool changeValues)

If changeValues is true, update current CLPC Fast Loop calibration equations using the new variables.

If false, copy the current CLPC Fast Loop calibration equations into new variables.

Returns

• Status code indicating success of the function call.

RAIL_GetSetClpcFastLoop#

RAIL_Status_t RAIL_GetSetClpcFastLoop (RAIL_Handle_t railHandle, RAIL_EffModeSensor_t modeSensorIndex, uint16_t * newTargetMv, uint16_t * newSlopeMvPerPaLevel, bool changeValues)

If changeValues is true, update current CLPC Fast Loop Target and Slope.

If false, copy the current CLPC Fast Loop values into newTarget and newSlope.

Returns

• Status code indicating success of the function call.

RAIL_GetSetClpcEnable#

RAIL_Status_t RAIL_GetSetClpcEnable (RAIL_Handle_t railHandle, uint8_t * newClpcEnable, bool changeClpcEnable)

Copy the current CLPC Enable in to newClpcEnable.

If changeClpcEnable is true, update current CLPC Enable with newClpcEnable first.

Returns

• Status code indicating success of the function call.

RAIL_GetSetEffTempThreshold#

RAIL_Status_t RAIL_GetSetEffTempThreshold (RAIL_Handle_t railHandle, uint16_t * newThresholdK, bool changeThreshold)

Get and set the EFF temperature threshold.

The EFR32 device periodically takes temperature measurements of the attached EFF device. If the EFF temperature ever exceeds the EFF temperature threshold, any active transmit operation is aborted and future transmit operations are blocked until the EFF temperature falls below the threshold.

Returns

• Status code indicating the result of the function call.

RAIL_CLPC_MINIMUM_POWER#

#define RAIL_CLPC_MINIMUM_POWER

180

Minimum power for CLPC usage in deci-dBm.

Below this power CLPC will not activate. Recommend staying above 19 dBm for best performance. Signed unit, do not add U.

RAIL_EFF_TEMP_MEASURE_COUNT#

#define RAIL_EFF_TEMP_MEASURE_COUNT

(6U)

Number of temperature values provided for the EFF thermal protection.

RAIL_EFF_TEMP_MEASURE_DEPRECATED_COUNT#

#define RAIL_EFF_TEMP_MEASURE_DEPRECATED_COUNT

(2U)

Number of deprecated temperature values in EFF thermal protection.

RAIL_HFXO_TEMP_MEASURE_COUNT#

#define RAIL_HFXO_TEMP_MEASURE_COUNT

(1U)

Number of temperature values provided for HFXO metrics.

RAIL_TEMP_MEASURE_COUNT#

#define RAIL_TEMP_MEASURE_COUNT

Total number of temperature values provided by RAIL_GetTemperature().

RAIL_EFF_CONTROL_SIZE#

#define RAIL_EFF_CONTROL_SIZE

(52U)

Number of bytes provided by RAIL_GetSetEffControl().

RAIL_EFF_SUPPORTS_TRANSMIT#

#define RAIL_EFF_SUPPORTS_TRANSMIT

A macro that checks for EFFxx devices that support high power transmit.

RAIL_EFF_SUPPORTS_RECEIVE#

#define RAIL_EFF_SUPPORTS_RECEIVE

A macro that checks for EFFxx devices that support receive.

RAIL_EFF_TEMP_THRESHOLD_MAX#

#define RAIL_EFF_TEMP_THRESHOLD_MAX

(383U)

Maximum EFF internal temperature in Kelvin, allowing transmissions when RAIL_SUPPORTS_EFF is enabled.

RAIL_EFF_MODE_SENSOR_ENUM_NAMES#

#define RAIL_EFF_MODE_SENSOR_ENUM_NAMES

A macro that is string versions of the calibration enums.