HAL Power Modes Macro Definition Documentation

 

POWER_MODES_BLE_NOT_PRESENT

#define POWER_MODES_BLE_NOT_PRESENT (false)

 

Location: power_modes.h:60

 

Options to set if the application makes use of Bluetooth.

 

These constants can be used to set the ble_present field of the configuration structure (LowPowerModeCfg_t). By selecting POWER_MODES_BLE_PRESENT, certain RF and baseband registers will be saved before entering a low-power mode and restored after waking up. By selecting POWER_MODES_BLE_NOT_PRESENT, the RF and baseband registers will not be saved and restored. LowPowerModeCfg_t). By selecting POWER_MODES_BLE_PRESENT, certain RF and baseband registers will be saved before entering a low-power mode and restored after waking up. By selecting POWER_MODES_BLE_NOT_PRESENT, the RF and baseband registers will not be saved and restored.

 

POWER_MODES_BLE_PRESENT

#define POWER_MODES_BLE_PRESENT (true)

 

Location: power_modes.h:61

 

VDDM_RETENTION_TRIM_MINIMUM

#define VDDM_RETENTION_TRIM_MINIMUM (0x0U) /* Minimum value */

 

Location: power_modes.h:74

 

VDDM retention regulator voltage trimming values.

 

These preset values can be used to set the trim value for the VDDM retention regulator (ACS_VDDRET_CTRL->VDDMRET_VTRIM) by setting the vddret_ctrl.vddm_ret_trim field of the configuration structure (LowPowerModeCfg_t) accordingly. The typical value is suitable for most industrial product variants. The maximum may be selected to support operation across an extended temperature range (e.g. for automotive product variants). LowPowerModeCfg_t) accordingly. The typical value is suitable for most industrial product variants. The maximum may be selected to support operation across an extended temperature range (e.g. for automotive product variants).

 

VDDM_RETENTION_TRIM_TYPICAL

#define VDDM_RETENTION_TRIM_TYPICAL (0x1U) /* Typical value */

 

Location: power_modes.h:75

 

VDDM_RETENTION_TRIM_MAXIMUM

#define VDDM_RETENTION_TRIM_MAXIMUM (0x3U) /* Maximum value */

 

Location: power_modes.h:76

 

VDDT_RETENTION_DISABLE

#define VDDT_RETENTION_DISABLE (0x0U)

 

Location: power_modes.h:86

 

VDDT baseband retention regulator options.

 

These preset values can be used to set if the VDDT retention (ACS_VDDRET_CTRL->VDDTRET_ENABLE) should be enabled or disabled by setting the vddret_ctrl.vddt_ret field of the configuration structure (LowPowerModeCfg_t) accordingly. When enabled, the baseband timer retention supply is powered. LowPowerModeCfg_t) accordingly. When enabled, the baseband timer retention supply is powered.

 

VDDT_RETENTION_ENABLE

#define VDDT_RETENTION_ENABLE (0x1U)

 

Location: power_modes.h:87

 

VDDC_RETENTION_TRIM_MINIMUM

#define VDDC_RETENTION_TRIM_MINIMUM (0x0U) /* Minimum value */

 

Location: power_modes.h:100

 

VDDC retention regulator voltage trimming values.

 

These preset values can be used to set the trim value for the VDDC retention regulator (ACS_VDDRET_CTRL->VDDCRET_VTRIM) by setting the vddret_ctrl.vddc_ret_trim field of the configuration structure (LowPowerModeCfg_t) accordingly. The typical value is suitable for most industrial product variants. The maximum may be selected to support operation across an extended temperature range (e.g. for automotive product variants). LowPowerModeCfg_t) accordingly. The typical value is suitable for most industrial product variants. The maximum may be selected to support operation across an extended temperature range (e.g. for automotive product variants).

 

VDDC_RETENTION_TRIM_TYPICAL

#define VDDC_RETENTION_TRIM_TYPICAL (0x1U) /* Typical value */

 

Location: power_modes.h:101

 

VDDC_RETENTION_TRIM_MAXIMUM

#define VDDC_RETENTION_TRIM_MAXIMUM (0x3U) /* Maximum value */

 

Location: power_modes.h:102

 

VDDACS_RETENTION_TRIM_MINIMUM

#define VDDACS_RETENTION_TRIM_MINIMUM (0x0U) /* Minimum value */

 

Location: power_modes.h:115

 

VDDACS regulator voltage trimming values.

 

These preset values can be used to set the trim value for the VDDACS retention regulator (ACS_VDDRET_CTRL->VDDACS_VTRIM) by setting the vddret_ctrl.vddacs_ret_trim field of the configuration structure (LowPowerModeCfg_t) accordingly. The typical value is suitable for most industrial product variants. The maximum may be selected to support operation across an extended temperature range (e.g. for automotive product variants). LowPowerModeCfg_t) accordingly. The typical value is suitable for most industrial product variants. The maximum may be selected to support operation across an extended temperature range (e.g. for automotive product variants).

 

VDDACS_RETENTION_TRIM_TYPICAL

#define VDDACS_RETENTION_TRIM_TYPICAL (0x1U) /* Typical value */

 

Location: power_modes.h:116

 

VDDACS_RETENTION_TRIM_MAXIMUM

#define VDDACS_RETENTION_TRIM_MAXIMUM (0x3U) /* Maximum value */

 

Location: power_modes.h:117

 

WAKEUP_CTRL_FLAGS_TO_CLEAR_BITS

#define WAKEUP_CTRL_FLAGS_TO_CLEAR_BITS ( (((x) >> 16) & 0x1F) \ | (((x) >> 21) & 0x0F) \ | (((x) >> 25) & 0x07) )

 

Location: power_modes.h:132

 

Convert wakeup flags to clear bits.

 

Converts the sticky flags of the ACS_WAKEUP_CTRL register into their respective clear bits for the register. x (uint32_t) The ACS_WAKEUP_CTRL wakeup flags to be converted.
Returns:
(uint32_t) The ACS_WAKEUP_CTRL clear flag bits.

Returns:
(uint32_t) The ACS_WAKEUP_CTRL clear flag bits.

 

Parameters

Direction Name Description

in

x

(uint32_t) The ACS_WAKEUP_CTRL wakeup flags to be converted.

 

WAKEUP_ALL_FLAGS_CLEAR

#define WAKEUP_ALL_FLAGS_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ (uint32_t)(0xFFFF))

 

Location: power_modes.h:141

 

Clear all of the sticky wakeup flags.

 

A macro function to clear the sticky wakeup flags, for all of the wakeup event types, in the wakeup control register.

 

WAKEUP_GPIO0_FLAG_CLEAR

#define WAKEUP_GPIO0_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_GPIO0_EVENT_CLEAR)

 

Location: power_modes.h:150

 

Clear sticky wakeup flags.

 

A set of macro functions for clearing specific sticky wakeup event flags in the wakeup control register.

 

WAKEUP_GPIO1_FLAG_CLEAR

#define WAKEUP_GPIO1_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_GPIO1_EVENT_CLEAR)

 

Location: power_modes.h:153

 

WAKEUP_GPIO2_FLAG_CLEAR

#define WAKEUP_GPIO2_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_GPIO2_EVENT_CLEAR)

 

Location: power_modes.h:156

 

WAKEUP_GPIO3_FLAG_CLEAR

#define WAKEUP_GPIO3_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_GPIO3_EVENT_CLEAR)

 

Location: power_modes.h:159

 

WAKEUP_BB_TIMER_FLAG_CLEAR

#define WAKEUP_BB_TIMER_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_BB_TIMER_CLEAR)

 

Location: power_modes.h:162

 

WAKEUP_RTC_ALARM_FLAG_CLEAR

#define WAKEUP_RTC_ALARM_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_RTC_ALARM_EVENT_CLEAR)

 

Location: power_modes.h:165

 

WAKEUP_RTC_CLOCK_FLAG_CLEAR

#define WAKEUP_RTC_CLOCK_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_RTC_CLOCK_EVENT_CLEAR)

 

Location: power_modes.h:168

 

WAKEUP_RTC_OVERFLOW_FLAG_CLEAR

#define WAKEUP_RTC_OVERFLOW_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_RTC_OVERFLOW_EVENT_CLEAR)

 

Location: power_modes.h:171

 

WAKEUP_DCDC_OVERLOAD_FLAG_CLEAR

#define WAKEUP_DCDC_OVERLOAD_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_DCDC_OVERLOAD_EVENT_CLEAR)

 

Location: power_modes.h:174

 

WAKEUP_ACOMP_FLAG_CLEAR

#define WAKEUP_ACOMP_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_ACOMP_EVENT_CLEAR)

 

Location: power_modes.h:177

 

WAKEUP_FIFO_FULL_FLAG_CLEAR

#define WAKEUP_FIFO_FULL_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ WAKEUP_FIFO_FULL_EVENT_CLEAR)

 

Location: power_modes.h:180

 

WAKEUP_THRESHOLD_FULL_FLAG_CLEAR

#define WAKEUP_THRESHOLD_FULL_FLAG_CLEAR Sys_ACS_WriteRegister( \ &ACS->WAKEUP_CTRL, \ THRESHOLD_FULL_EVENT_CLEAR)

 

Location: power_modes.h:183