zephyr/doc/reference/pm/index.rst
Gerard Marull-Paretas 5a71eeb35c pm: policy: move constraints to policy API
The pm_constraint_* APIs were effectively used by the policy manager
only. This patch renames the API to the policy namespace and makes its
naming more explicit:

- pm_constraint_set -> pm_policy_state_lock_get()
- pm_constraint_release -> pm_policy_state_lock_put()
- pm_constraint_get -> pm_policy_state_lock_is_active()

The reason for these changes is that constraints can be of many types:
allow/disallow states, impose latency requirements, etc. The new naming
also makes explicit that the API calls will influence the PM policy
behavior.

All drivers and documentation have been updated accordingly.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-16 15:26:47 +01:00

34 lines
427 B
ReStructuredText

.. _pm_api:
Power Management
################
System PM APIs
**************
.. doxygengroup:: subsys_pm_sys
States
======
.. doxygengroup:: subsys_pm_states
Policy
======
.. doxygengroup:: subsys_pm_sys_policy
Hooks
=====
.. doxygengroup:: subsys_pm_sys_hooks
Device PM APIs
**************
.. doxygengroup:: subsys_pm_device
Device Runtime PM APIs
**********************
.. doxygengroup:: subsys_pm_device_runtime