device_runtime.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 Intel Corporation.
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_PM_DEVICE_RUNTIME_H_
#define ZEPHYR_INCLUDE_PM_DEVICE_RUNTIME_H_
 
#include <device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(CONFIG_PM_DEVICE_RUNTIME) || defined(__DOXYGEN__)
int pm_device_runtime_enable(const struct device *dev);
 
int pm_device_runtime_disable(const struct device *dev);
 
int pm_device_runtime_get(const struct device *dev);
 
int pm_device_runtime_put(const struct device *dev);
 
int pm_device_runtime_put_async(const struct device *dev);
 
bool pm_device_runtime_is_enabled(const struct device *dev);
 
static inline void pm_device_runtime_init_suspended(const struct device *dev)
{
        struct pm_device *pm = dev->pm;
 
        pm->state = PM_DEVICE_STATE_SUSPENDED;
}
 
static inline void pm_device_runtime_init_off(const struct device *dev)
{
        struct pm_device *pm = dev->pm;
 
        pm->state = PM_DEVICE_STATE_OFF;
}
 
#else
static inline int pm_device_runtime_enable(const struct device *dev) { return -ENOSYS; }
static inline int pm_device_runtime_disable(const struct device *dev) { return -ENOSYS; }
static inline int pm_device_runtime_get(const struct device *dev) { return 0; }
static inline int pm_device_runtime_put(const struct device *dev) { return 0; }
static inline int pm_device_runtime_put_async(const struct device *dev) { return 0; }
static inline bool pm_device_runtime_is_enabled(const struct device *dev) { return false; }
static inline void pm_device_runtime_init_suspended(const struct device *dev) { }
static inline void pm_device_runtime_init_off(const struct device *dev) { }
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_PM_DEVICE_RUNTIME_H_ */