michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: guides: pm: device_runtime: remove API definitions

Browse source 
The API is already rendered automatically by breathe, so do not manually
add definitions again.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-11-09 23:08:03 +01:00 • committed by Christopher Friedt
commit 68db978fb2
1 changed files with 0 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

60
doc/guides/pm/device_runtime.rst
View file

@ -11,63 +11,3 @@ device power state accordingly based on the usage count.
The interfaces and APIs provided by the Device Runtime PM are The interfaces and APIs provided by the Device Runtime PM are
designed to be generic and architecture independent. designed to be generic and architecture independent.
Device Runtime Power Management API
***********************************
The Device Drivers use these APIs to perform device runtime power
management operations on the devices.
Enable Device Runtime Power Management of a Device API
======================================================
.. code-block:: c
void pm_device_runtime_enable(const struct device *dev);
Enables Runtime Power Management of the device.
Disable Device Runtime Power Management of a Device API
=======================================================
.. code-block:: c
void pm_device_runtime_disable(const struct device *dev);
Disables Runtime Power Management of the device.
Resume Device synchronously API
===============================
.. code-block:: c
int pm_device_runtime_get(const struct device *dev);
Marks the device as being used. It will bring up or resume
the device if it is in suspended state based on the device
usage count. This call is blocked until the device PM state
is changed to active. The API returns 0 on success.
Suspend Device asynchronously API
=================================
.. code-block:: c
int pm_device_runtime_put_async(const struct device *dev);
Releases a device. This API asynchronously puts the device to suspend
state if not already in suspend state if the usage count of this device
reaches 0.
Suspend Device synchronously API
================================
.. code-block:: c
int pm_device_runtime_put(const struct device *dev);
Marks the device as being released. It will put the device to
suspended state if is is in active state based on the device
usage count. This call is blocked until the device PM state
is changed to resume. The API returns 0 on success. This
call is blocked until the device is suspended.