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>
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>
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>
Group all STM32 board samples in samples/boards/st to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Group all Microchip board samples in samples/boards/espressif to
keep samples/boards/ organized by vendor
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add new information about new property to
enable/disable device power management per
power state.
Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
That is option has shown confusing on it is attempt to prevent
system pm doing device power management. Lets address this
problem properly.
Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
Instead of chapters, make device runtime power management and
system-managed device power management sections.
Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
There is a whole section dedicated to power domains. The brief
information in device power management was not adding anything.
Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
The following changes:
- Generally reword all the paragraphs to hopefully by clearer and
easier to read by using more straighforward and direct wording,
and avoiding run on sentences and ambiguous/wrong grammar, etc.
- Move Examples to the bottom of the page.
- Fix a typo in the code expression where there was an extra
parentheses.
Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
Update system pm diagram to reflect recent changes in the subysystem.
Use graphviz to create this new diagram.
Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
s/System Power Management/System Managed Device Power Management/g
System Power Management is confusing and does not tell
anything about device. Change it for something more explicit.
Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
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>
samples/boards/nrf/system_off does not enable CONFIG_PM so
it should not be listed as an example in system power management
documentation.
Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
Function prototype in PM device implementation documentation had the
incorrect prototype for device power management. Fix this to align
with the correct prototype.
Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
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>
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>
Includes reference to esp32 deep sleep sample code
to system power management documentation,
Signed-off-by: Glauber Maroto Ferreira <glauber.ferreira@espressif.com>
Device power management introduction was mentioning an APIs
that no longer exists and also using a wrong nomenclature for
device runtime pm.
Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
Document the limitations of system power management when it comes to
transitions that are run from the idle thread.
Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
