Skip to content

Commit 7f66768

Browse files
Flavio Ceolinnashif
authored andcommitted
docs: pm: Fix device busy information
Remove invalid information about device busy API. Signed-off-by: Flavio Ceolin <[email protected]>
1 parent ffcba96 commit 7f66768

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

doc/reference/power_management/index.rst

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -327,22 +327,9 @@ off, then such transactions would be left in an inconsistent state. This
327327
infrastructure guards such transactions by indicating to the SOC interface that
328328
the device is in the middle of a hardware transaction.
329329

330-
When the :code:`pm_system_suspend()` is called, the SOC interface checks if any device
331-
is busy. The SOC interface can then decide to execute a power management scheme other than deep sleep or
332-
to defer power management operations until the next call of
333-
:code:`pm_system_suspend()`.
334-
335-
An alternative to using the busy status mechanism is to use the
336-
`distributed method`_ of device power management. In such a method where the
337-
device power management is handled in a distributed manner rather than centrally in
338-
:code:`pm_system_suspend()`, the decision to enter deep sleep can be made based
339-
on whether all devices are already turned off.
340-
341-
This feature can be also used to emulate a hardware feature found in some SOCs
342-
that causes the system to automatically enter deep sleep when all devices are idle.
343-
In such an usage, the busy status can be set by default and cleared as each
344-
device becomes idle. When :code:`pm_system_suspend()` is called, deep sleep can
345-
be entered if no device is found to be busy.
330+
When the :c:func:`pm_system_suspend()` is called, depending on the power state
331+
returned by the policy manager, the system may suspend or put devices in low
332+
power if they are not marked as busy.
346333

347334
Here are the APIs used to set, clear, and check the busy status of devices.
348335

@@ -377,6 +364,8 @@ Check Busy Status of Single Device API
377364
Checks whether a device is busy. The API returns 0 if the device
378365
is not busy.
379366

367+
This API is used by the system power management.
368+
380369
Check Busy Status of All Devices API
381370
------------------------------------
382371

0 commit comments

Comments
 (0)