bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

pm: device_runtime: add zephyr,pm-device-runtime-auto

Browse Source 
Add the `zephyr,pm-device-runtime-auto` flag to `pm.yaml` and
`struct pm_device`.

This flag is intended to signify to the boot system that device runtime
PM should be automatically enabled on the device after the init function
has run.

Only run `pm_device_runtime_auto_enable` function on a device if
initialisation succeeded. This prevents actions being run on devices
that are not ready.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
This commit is contained in:
Jordan Yates 2022-03-12 21:10:42 +10:00 committed by Anas Nashif
parent f1111dd679
commit db3d51bb7d
5 changed files with 54 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
dts/bindings/base/pm.yaml
View File

@ -24,3 +24,9 @@ properties:
The device will be notified when the power domain it belongs to is either
suspended or resumed.
zephyr,pm-device-runtime-auto:
type: boolean
description: |
Automatically configure the device for runtime power management after the
init function runs.

20
include/zephyr/pm/device.h
View File

@ -45,8 +45,10 @@ enum pm_device_flag {
PM_DEVICE_FLAG_RUNTIME_ENABLED,
/** Indicates if the device pm is locked. */
PM_DEVICE_FLAG_STATE_LOCKED,
/** Indicateds if the device is used as a power domain */
/** Indicates if the device is used as a power domain */
PM_DEVICE_FLAG_PD,
/** Indicates if device runtime PM should be automatically enabled */
PM_DEVICE_FLAG_RUNTIME_AUTO,
};
/** @endcond */
@ -168,13 +170,15 @@ struct pm_device {
*
* @param node_id Devicetree node for the initialized device (can be invalid).
*/
#define Z_PM_DEVICE_FLAGS(node_id) \
(COND_CODE_1( \
DT_NODE_EXISTS(node_id), \
((DT_PROP_OR(node_id, wakeup_source, 0) \
<< PM_DEVICE_FLAG_WS_CAPABLE) | \
(DT_NODE_HAS_COMPAT(node_id, power_domain) << \
PM_DEVICE_FLAG_PD)), \
#define Z_PM_DEVICE_FLAGS(node_id) \
(COND_CODE_1( \
DT_NODE_EXISTS(node_id), \
((DT_PROP_OR(node_id, wakeup_source, 0) \
<< PM_DEVICE_FLAG_WS_CAPABLE) | \
(DT_PROP_OR(node_id, zephyr_pm_device_runtime_auto, 0) \
<< PM_DEVICE_FLAG_RUNTIME_AUTO) | \
(DT_NODE_HAS_COMPAT(node_id, power_domain) << \
PM_DEVICE_FLAG_PD)), \
(0)))
/**

20
include/zephyr/pm/device_runtime.h
View File

@ -22,6 +22,20 @@ extern "C" {
*/
#if defined(CONFIG_PM_DEVICE_RUNTIME) || defined(__DOXYGEN__)
/**
* @brief Automatically enable device runtime based on devicetree properties
*
* @note Must not be called from application code. See the
* zephyr,pm-device-runtime-auto property in pm.yaml and z_sys_init_run_level.
*
* @param dev Device instance.
*
* @retval 0 If the device runtime PM is enabled successfully or it has not
* been requested for this device in devicetree.
* @retval -errno Other negative errno, result of enabled device runtime PM.
*/
int pm_device_runtime_auto_enable(const struct device *dev);
/**
* @brief Enable device runtime PM
*
@ -142,6 +156,12 @@ bool pm_device_runtime_is_enabled(const struct device *dev);
#else
static inline int pm_device_runtime_auto_enable(const struct device *dev)
{
ARG_UNUSED(dev);
return 0;
}
static inline int pm_device_runtime_enable(const struct device *dev)
{
ARG_UNUSED(dev);

5
kernel/init.c
View File

@ -34,6 +34,7 @@
#include <kswap.h>
#include <zephyr/timing/timing.h>
#include <zephyr/logging/log.h>
#include <zephyr/pm/device_runtime.h>
LOG_MODULE_REGISTER(os, CONFIG_KERNEL_LOG_LEVEL);
/* the only struct z_kernel instance */
@ -261,6 +262,10 @@ static void z_sys_init_run_level(enum init_level level)
dev->state->init_res = rc;
}
dev->state->initialized = true;
if (rc == 0) {
/* Run automatic device runtime enablement */
(void)pm_device_runtime_auto_enable(dev);
}
}
}
}

11
subsys/pm/device_runtime.c
View File

@ -242,6 +242,17 @@ int pm_device_runtime_put_async(const struct device *dev)
return ret;
}
int pm_device_runtime_auto_enable(const struct device *dev)
{
struct pm_device *pm = dev->pm;
/* No action needed if PM_DEVICE_FLAG_RUNTIME_AUTO is not enabled */
if (!pm || !atomic_test_bit(&pm->flags, PM_DEVICE_FLAG_RUNTIME_AUTO)) {
return 0;
}
return pm_device_runtime_enable(dev);
}
int pm_device_runtime_enable(const struct device *dev)
{
int ret = 0;