sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

pm: update document, add pm_idle interface for not-smp case

Browse Source 
Signed-off-by: buxiasen <buxiasen@xiaomi.com>
This commit is contained in:
buxiasen 2024-08-21 11:19:28 +08:00 committed by Xiang Xiao
parent c4d8d937d5
commit c40358ff0d
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Documentation/components/drivers/special/power/pm/index.rst
View File

@ -221,9 +221,33 @@ All PM interfaces are declared in the file ``include/nuttx/power/pm.h``.
completes the entire state change unless interrupts are disabled
throughout the state change.
.. c:function:: void pm_idle(pm_idle_handler_t handler)
This function provide standard pm idle work flow for up_idle.
Called from the chip bsp and should only focus on handle the system
state changed.
:param handler: The execution after PM_IDLE_DOMAIN state changed
:return:
None
Callbacks
=========
.. c:typedef::pm_idle_handler_t
This type declare is provide for pm_idle interface.
Handle the pm low power action and execution for not SMP case.
Possible execution for long time because of WFI inside.
.. code-block:: c
typedef void (*pm_idle_handler_t)(enum pm_state_e);
:param pm_state_e:
Indicate the new system power state.
.. c:struct:: pm_callback_s
This struct includes the pointers to the driver