device_runtime.h File Reference

Header file for the Device Runtime Power Management API. More...

#include <zephyr/device.h>
#include <zephyr/kernel.h>

Go to the source code of this file.

Macros
#define	LOG_DBG_PM_DEVICE_RUNTIME_GET(dev, ...)
	Writes a "failed to resume" debug message to the log.
#define	LOG_WRN_PM_DEVICE_RUNTIME_GET(dev, ...)
	Writes a "failed to resume" warning message to the log.
#define	LOG_ERR_PM_DEVICE_RUNTIME_GET(dev, ...)
	Writes a "failed to resume" error message to the log.
#define	LOG_DBG_PM_DEVICE_RUNTIME_PUT(dev, ...)
	Writes a "failed to suspend" debug message to the log.
#define	LOG_WRN_PM_DEVICE_RUNTIME_PUT(dev, ...)
	Writes a "failed to suspend" warning message to the log.
#define	LOG_ERR_PM_DEVICE_RUNTIME_PUT(dev, ...)
	Writes a "failed to suspend" error message to the log.
#define	LOG_INST_DBG_PM_DEVICE_RUNTIME_GET(_log_inst, dev, ...)
	Writes a "failed to resume" debug message to the log for the logging instance.
#define	LOG_INST_WRN_PM_DEVICE_RUNTIME_GET(_log_inst, dev, ...)
	Writes a "failed to resume" warning message to the log for the logging instance.
#define	LOG_INST_ERR_PM_DEVICE_RUNTIME_GET(_log_inst, dev, ...)
	Writes a "failed to resume" error message to the log for the logging instance.
#define	LOG_INST_DBG_PM_DEVICE_RUNTIME_PUT(_log_inst, dev, ...)
	Writes a "failed to suspend" debug message to the log for the logging instance.
#define	LOG_INST_WRN_PM_DEVICE_RUNTIME_PUT(_log_inst, dev, ...)
	Writes a "failed to suspend" warning message to the log for the logging instance.
#define	LOG_INST_ERR_PM_DEVICE_RUNTIME_PUT(_log_inst, dev, ...)
	Writes a "failed to suspend" error message to the log for the logging instance.

Functions
int	pm_device_runtime_auto_enable (const struct device *dev)
	Automatically enable device runtime based on devicetree properties.
int	pm_device_runtime_enable (const struct device *dev)
	Enable device runtime PM.
int	pm_device_runtime_disable (const struct device *dev)
	Disable device runtime PM.
int	pm_device_runtime_get (const struct device *dev)
	Resume a device based on usage count.
int	pm_device_runtime_put (const struct device *dev)
	Suspend a device based on usage count.
int	pm_device_runtime_put_async (const struct device *dev, k_timeout_t delay)
	Suspend a device based on usage count (asynchronously).
bool	pm_device_runtime_is_enabled (const struct device *dev)
	Check if device runtime is enabled for a given device.
int	pm_device_runtime_usage (const struct device *dev)
	Return the current device usage counter.

Detailed Description

Header file for the Device Runtime Power Management API.