doc: pm: document system pm limitations

Document the limitations of system power management when it comes to transitions that are run from the idle thread. Signed-off-by: Jordan Yates <[email protected]>
benys · May 6, 2022 · 37e7817 · 37e7817
1 parent 775030e
commit 37e7817
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/doc/services/pm/device.rst b/doc/services/pm/device.rst
@@ -73,6 +73,12 @@ in transition between power states:
 * Gate/Un-gate power.
 * Mask/Un-mask interrupts.
 
+.. note::
+
+   When using :ref:`pm-system`, device transitions can be run from the idle thread.
+   As functions in this context cannot block, transitions that intend to use blocking
+   API's **must** check whether they can do so with :c:func:`k_can_yield`.
+
 Device Model with Power Management Support
 ******************************************
 

diff --git a/doc/services/pm/system.rst b/doc/services/pm/system.rst
@@ -1,3 +1,5 @@
+.. _pm-system:
+
 System Power Management
 #######################