Commit Graph

11 Commits

Author SHA1 Message Date
Flavio Ceolin
287984f629 docs: pm: Update runtime PM documentation and release notes
Add new configuration options for runtime PM to the release notes,
including stack size, priority, and system work queue usage. Update
the runtime PM documentation to explain the implications of using the
system work queue and disabling asynchronous operations. Include a new
version of the sequence diagram for asynchronous operations.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-05-27 14:45:07 +02:00
Gerard Marull-Paretas
f989711a60 pm: s/power-domain/power-domains and add power-domain-names
Some devices may belong to >1 power domain, so with the current design
this is something not possible to describe. It's worth to note that
Linux also uses the `power-domains` naming scheme, not `power-domain`.
This patch also introduces `power-domain-names` so that each entry in
`power-domains` can be given a name if needed. `#power-domain-cells`
is now required as well.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
2024-10-18 17:45:21 +01:00
Benjamin Cabé
df294e34e1 doc: sphinx-lint: fix bad usage of "default role"
Fixes bad usage of single backticks in lieu of double backticks for
rendering inline literals, or simple '*' for italics.

When appropriate, a better construct than double backticks has been
selected (ex. :file:, :kconfig:option:, :c:func:, ...), or proper :ref:
have been used if the original intention was to have a link.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-13 11:42:51 -05:00
Glenn Andrews
b649efe6dd doc: PM: Fix dereference in 'services/pm/device_runtime'
See https://github.com/zephyrproject-rtos/zephyr/issues/76741

Fixes the dereference of the PM action in the doc.

Signed-off-by: Glenn Andrews <glenn.andrews.42@gmail.com>
2024-08-12 15:14:06 +02:00
Flavio Ceolin
b4d3f47466 docs: pm: Add examples to device runtime pm
Add specific device runtime power management samples to device runtime
pm section.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin
b5ca7a06b4 pm: device_runtime: Add delay to async put
Add a delay parameter to asynchronous device runtim put. This allows
to delay the put operation what is useful to avoid multiple states
transitions.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-12-12 10:57:34 +01:00
Marcel Krüger
f055110802 doc: Add hint for automatic power domain swiching
Add a hint that when a device is on a power domain
and the device and power domain have runtime PM,
the power domain will automatically resumed/susepended.

Signed-off-by: Marcel Krüger <marcel.krueger@ithinx.io>
2023-07-20 16:23:36 +02:00
Gerard Marull-Paretas
5b049f35b5 doc: drop usage of numref
Usage of numfig=True option in conf.py significantly increases doc build
time. While it is a nice feature, it's not extensively used in Zephyr
documentation, so let's remove its usage in favor of faster doc builds.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-22 11:08:53 +02:00
Jordan Yates
738b75171b doc: pm: device_runtime: document new devicetree flag
Document the new devicetree flag and provide an example of how to use
it.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2023-03-29 12:21:13 -04:00
Flavio Ceolin
b0f8142b1b doc: pm: Add reference for device runtime pm
Add a way to reference device runtime documentation from
other documents.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-07-01 22:09:50 +02:00
Anas Nashif
34cdeabeb8 doc: move power management under os services
Move this documentation to a new location under OS Services section.

See #33725

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00