Power Manager#

sl_power_manager_em_t#

sl_power_manager_em_t

Energy modes.

sl_power_manager_on_isr_exit_t#

sl_power_manager_on_isr_exit_t

On ISR Exit Hook answer.

sl_power_manager_em_transition_event_t#

typedef uint32_t sl_power_manager_em_transition_event_t

Mask of all the event(s) to listen to.

sl_power_manager_em_transition_on_event_t#

typedef void(* sl_power_manager_em_transition_on_event_t) (sl_power_manager_em_t from, sl_power_manager_em_t to) )(sl_power_manager_em_t from, sl_power_manager_em_t to)

Typedef for the user supplied callback function which is called when an energy mode transition occurs.

sl_power_manager_init#

sl_status_t sl_power_manager_init (void )

Initialize Power Manager module.

Returns

• Status code

sl_power_manager_sleep#

void sl_power_manager_sleep (void )

Sleep at the lowest allowed energy mode.

Note

• Must not be called from ISR

Note

• This function will expect and call a callback with the following signature: bool sl_power_manager_is_ok_to_sleep(void).

• This function can be used to cancel a sleep action and handle the possible race condition where an ISR that would cause a wakeup is triggered right after the decision to call sl_power_manager_sleep() has been made.

• This function must NOT be called with interrupts disabled. This means both BASEPRI and PRIMASK MUST have a value of 0 when invoking this function.

Usage example:

void main(void)
{
  sl_power_manager_init();
  while (1) {
    tick();
    sl_power_manager_sleep();
  }
}

sl_power_manager_add_em_requirement#

void sl_power_manager_add_em_requirement (sl_power_manager_em_t em)

Adds requirement on given energy mode.

Note

• Adding EM requirements on SL_POWER_MANAGER_EM2 is now DEPRECATED. The calls can simply be removed since the system will go to deepsleep (EM2/EM3) in the absence of EM1 requirements.

sl_power_manager_remove_em_requirement#

void sl_power_manager_remove_em_requirement (sl_power_manager_em_t em)

Removes requirement on given energy mode.

Note

• Removing EM requirements on SL_POWER_MANAGER_EM2 is now DEPRECATED. The calls can simply be removed since the system will go to deepsleep (EM2/EM3) in the absence of EM1 requirements.

sl_power_manager_subscribe_em_transition_event#

void sl_power_manager_subscribe_em_transition_event (sl_power_manager_em_transition_event_handle_t * event_handle, const sl_power_manager_em_transition_event_info_t * event_info)

Registers a callback to be called on given Energy Mode transition(s).

Note

• Adding and removing requirement(s) from a callback on a transition event is not supported.

• The parameters passed must be persistent, meaning that they need to survive until the callback fires.

• SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM3 and SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM3 are now DEPRECATED and should not be used in the event_info argument.

Usage example:

#define EM_EVENT_MASK_ALL      (  SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM0 \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM0  \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM1 \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM1  \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM2 \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM2)

sl_power_manager_em_transition_event_handle_t event_handle;
sl_power_manager_em_transition_event_info_t event_info = {
  .event_mask = EM_EVENT_MASK_ALL,
  .on_event = my_callback,
};

void my_callback(sl_power_manager_em_t from,
                 sl_power_manager_em_t to)
{
  [...]
}

void main(void)
{
  sl_power_manager_init();
  sl_power_manager_subscribe_em_transition_event(&event_handle, &event_info);
}

sl_power_manager_unsubscribe_em_transition_event#

void sl_power_manager_unsubscribe_em_transition_event (sl_power_manager_em_transition_event_handle_t * event_handle)

Unregisters an event callback handle on Energy mode transition.

Note

• An EFM_ASSERT is thrown if the handle is not found.

sl_power_manager_schedule_wakeup_get_restore_overhead_tick#

int32_t sl_power_manager_schedule_wakeup_get_restore_overhead_tick (void )

Get configurable overhead value for early restore time in Sleeptimer ticks when a schedule wake-up is set.

Returns

• Current overhead value for early restore time.

Note

• This function will do nothing when a project contains the power_manager_no_deepsleep component, which configures the lowest energy mode as EM1.

sl_power_manager_schedule_wakeup_set_restore_overhead_tick#

void sl_power_manager_schedule_wakeup_set_restore_overhead_tick (int32_t overhead_tick)

Set configurable overhead value for early restore time in Sleeptimer ticks used for schedule wake-up.

Must be called after initialization else the value will be overwritten.

Note

• The overhead value can also be negative to remove time from the restore process.

• This function will do nothing when a project contains the power_manager_no_deepsleep component, which configures the lowest energy mode as EM1.

sl_power_manager_schedule_wakeup_get_minimum_offtime_tick#

uint32_t sl_power_manager_schedule_wakeup_get_minimum_offtime_tick (void )

Get configurable minimum off-time value for schedule wake-up in Sleeptimer ticks.

Returns

• Current minimum off-time value for schedule wake-up.

Note

• Turning on external high frequency clock, such as HFXO, requires more energy since we must supply higher current for the wake-up. Therefore, when an 'external high frequency clock enable' is scheduled in 'x' time, there is a threshold 'x' value where turning off the clock is not worthwhile since the energy consumed by taking into account the wake-up will be greater than if we just keep the clock on until the next scheduled clock enabled. This threshold value is what we refer as the minimum off-time.

• This function will do nothing when a project contains the power_manager_no_deepsleep component, which configures the lowest energy mode as EM1.

sl_power_manager_schedule_wakeup_set_minimum_offtime_tick#

void sl_power_manager_schedule_wakeup_set_minimum_offtime_tick (uint32_t minimum_offtime_tick)

Set configurable minimum off-time value for schedule wake-up in Sleeptimer ticks.

Note

• Turning on external high frequency clock, such as HFXO, requires more energy since we must supply higher current for the wake-up. Therefore, when an 'external high frequency clock enable' is scheduled in 'x' time, there is a threshold 'x' value where turning off the clock is not worthwhile since the energy consumed by taking into account the wake-up will be greater than if we just keep the clock on until the next scheduled clock enabled. This threshold value is what we refer as the minimum off-time.

• This function will do nothing when a project contains the power_manager_no_deepsleep component, which configures the lowest energy mode as EM1.

sl_power_manager_em23_voltage_scaling_enable_fast_wakeup#

void sl_power_manager_em23_voltage_scaling_enable_fast_wakeup (bool enable)

Enable or disable fast wake-up in EM2 and EM3.

Note

• Will also update the wake up time from EM2 to EM0.

• This function will do nothing when a project contains the power_manager_no_deepsleep component, which configures the lowest energy mode as EM1.

sl_power_manager_is_latest_wakeup_internal#

bool sl_power_manager_is_latest_wakeup_internal (void )

Determines if the HFXO interrupt was part of the last wake-up and/or if the HFXO early wakeup expired during the last ISR and if it was the only timer to expire in that period.

Returns

• true if power manager sleep can return to sleep, false otherwise.

Note

• This function will always return false in case a requirement is added on SL_POWER_MANAGER_EM1, since we will never sleep at a lower level than EM1.

sl_power_manager_enter_em4#

void sl_power_manager_enter_em4 (void )

Enter energy mode 4 (EM4).

Note

• You should not expect to return from this function. Once the device enters EM4, only a power on reset or external reset pin can wake the device.

• On xG22 devices, this function re-configures the IADC if EM4 entry is possible.

sl_power_manager_em4_unlatch_pin_retention#

void sl_power_manager_em4_unlatch_pin_retention (void )

When EM4 pin retention is set to power_manager_pin_retention_latch, then pins are retained through EM4 entry and wakeup.

The pin state is released by calling this function. The feature allows peripherals or GPIO to be re-initialized after EM4 exit (reset), and when initialization is done, this function can release pins and return control to the peripherals or GPIO.

Note

• When the EM4 Pin Retention feature is not available on a device, calling this function will do nothing.

sl_power_manager_em4_presleep_hook#

void sl_power_manager_em4_presleep_hook (void )

Energy mode 4 pre-sleep hook function.

Note

• This function is called by sl_power_manager_enter_em4 just prior to the sequence of writes to put the device in EM4. The function implementation does not perform anything, but it is SL_WEAK so that it can be re-implemented in application code if actions are needed.

sl_power_manager_debug_print_em_requirements#

void sl_power_manager_debug_print_em_requirements (void )

Print a table that describes the current requirements on each energy mode and their owner.

CURRENT_MODULE_NAME#

#define CURRENT_MODULE_NAME

"Anonymous"

current module name

SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM0#

#define SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM0

(1 << 0)

sl power manager event transition entering em0

SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM0#

#define SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM0

(1 << 1)

sl power manager event transition leaving em0

SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM1#

#define SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM1

(1 << 2)

sl power manager event transition entering em1

SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM1#

#define SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM1

(1 << 3)

sl power manager event transition leaving em1

SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM2#

#define SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM2

(1 << 4)

sl power manager event transition entering em2

SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM2#

#define SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM2

(1 << 5)

sl power manager event transition leaving em2

SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM3#

#define SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_EM3

(1 << 6)

sl power manager event transition entering em3 (DEPRECATED)

SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM3#

#define SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_EM3

(1 << 7)

sl power manager event transition leaving em3 (DEPRECATED)