michaelh/zephyr
1
0
Fork 0
Code Releases Activity

pm: Supplement pm_device_is_powered doc

Browse source 
Supplement the documentation pm_device_is_powered()
adding that a device is assumed powered in case
the device does not support PM or is not on a power domain.

Signed-off-by: Marcel Krüger <marcel.krueger@ithinx.io>
This commit is contained in:
Marcel Krüger 2023-07-11 16:55:04 +02:00 • committed by Carles Cufí
commit 8d6f74ad1f
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
include/zephyr/pm/device.h
View file

@ -576,7 +576,8 @@ int pm_device_power_domain_remove(const struct device *dev,
*
* @param dev Device instance.
*
* @retval true If device is currently powered
* @retval true If device is currently powered, or is assumed to be powered
* (i.e. it does not support PM or is not under a PM domain)
* @retval false If device is not currently powered
*/
bool pm_device_is_powered(const struct device *dev);