zephyr/doc/reference
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
..
api everywhere: fix typos 2022-03-14 20:22:24 -04:00
audio doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
bluetooth doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
canbus drivers: can: add CAN transceiver device driver API 2022-03-15 14:32:29 -05:00
crypto drivers: crypto: Organize documentation 2022-03-01 16:32:43 -05:00
data_structures doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
devicetree devicetree: add devicetree/can.h 2022-03-15 14:32:29 -05:00
display
drivers doc: reference: drivers: update system drivers section 2021-12-24 20:59:10 -05:00
edac doc: reference: reword a few titles 2021-12-15 14:59:21 -05:00
file_system
iterable_sections doc: fix C domain reference usage 2021-10-26 10:57:45 +02:00
kernel include/atomics: doc: Clarify memory barrier behavior 2022-03-09 13:46:06 -05:00
libc doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
logging doc: reference: logging: Extend frontend section 2022-03-14 14:08:49 -04:00
memory_management doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
misc doc: reference: misc: Update cbprintf documentation 2022-03-14 11:16:14 +01:00
modbus doc: reference: reword a few titles 2021-12-15 14:59:21 -05:00
networking doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
peripherals doc: drivers: tcpc: Add USB TCPC API documentation 2022-03-08 11:08:43 +01:00
pinctrl doc: reference: add pinctrl API 2021-10-25 15:26:47 -05:00
pm pm: policy: move constraints to policy API 2022-03-16 15:26:47 +01:00
random doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
resource_management
settings doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
shell doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
storage doc: correct location of fs.h in access.rst doc 2022-03-16 10:24:53 +01:00
task_wdt doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
timing_functions doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
usb doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
usermode doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
util
virtualization doc: use :kconfig:option: domain role 2022-03-02 09:28:37 +01:00
index.rst doc: reference: include two levels of titles in the toc 2021-12-15 14:59:21 -05:00