michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: pm: update documentation

Browse source 
Update documentation so that latest changes are reflected.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-06-09 13:31:50 +02:00 • committed by Anas Nashif
commit 59f0e73522
1 changed files with 5 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

18
doc/reference/power_management/index.rst
View file

@ -273,13 +273,8 @@ Device Power Management Operations
================================== ==================================
Zephyr RTOS power management subsystem provides a control function interface Zephyr RTOS power management subsystem provides a control function interface
to device drivers to indicate power management operations to perform. to device drivers to indicate power management operations to perform. Each
The supported PM control commands are: device driver defines:
* PM_DEVICE_STATE_SET
* PM_DEVICE_STATE_GET
Each device driver defines:
* The device's supported power states. * The device's supported power states.
* The device's supported transitions between power states. * The device's supported transitions between power states.
@ -330,20 +325,17 @@ Device Set Power State
.. code-block:: c .. code-block:: c
int pm_device_state_set(const struct device *dev, uint32_t device_power_state, pm_device_cb cb, void *arg); int pm_device_state_set(const struct device *dev, enum pm_device_state state);
Calls the :c:func:`pm_control()` handler function implemented by the Calls the :c:func:`pm_control()` handler function implemented by the
device driver with PM_DEVICE_STATE_SET command. device driver with the provided state.
Device Get Power State Device Get Power State
---------------------- ----------------------
.. code-block:: c .. code-block:: c
int pm_device_state_get(const struct device *dev, uint32_t * device_power_state); int pm_device_state_get(const struct device *dev, enum pm_device_state *state);
Calls the :c:func:`pm_control()` handler function implemented by the
device driver with PM_DEVICE_STATE_GET command.
Busy Status Indication Busy Status Indication
====================== ======================