Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
pm_notifier Struct Reference

Power management notifier struct. More...

#include <pm.h>

Data Fields

void(* state_entry )(enum pm_state state)
 Application defined function for doing any target specific operations for power state entry.
 
void(* state_exit )(enum pm_state state)
 Application defined function for doing any target specific operations for power state exit.
 

Detailed Description

Power management notifier struct.

This struct contains callbacks that are called when the target enters and exits power states.

As currently implemented the entry callback is invoked when transitioning from PM_STATE_ACTIVE to another state, and the exit callback is invoked when transitioning from a non-active state to PM_STATE_ACTIVE. This behavior may change in the future.

Note
These callbacks can be called from the ISR of the event that caused the kernel exit from idling.
It is not allowed to call pm_notifier_unregister or pm_notifier_register from these callbacks because they are called with the spin locked in those functions.

Field Documentation

◆ state_entry

void(* pm_notifier::state_entry) (enum pm_state state)

Application defined function for doing any target specific operations for power state entry.

◆ state_exit

void(* pm_notifier::state_exit) (enum pm_state state)

Application defined function for doing any target specific operations for power state exit.


The documentation for this struct was generated from the following file: