Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
device.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2015 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_PM_DEVICE_H_
8#define ZEPHYR_INCLUDE_PM_DEVICE_H_
9
10#include <zephyr/device.h>
11#include <zephyr/kernel.h>
12#include <zephyr/sys/atomic.h>
14
15#ifdef __cplusplus
16extern "C" {
17#endif
18
28struct device;
29
31enum pm_device_flag {
33 PM_DEVICE_FLAG_BUSY,
35 PM_DEVICE_FLAG_TURN_ON_FAILED,
37 PM_DEVICE_FLAG_PD_CLAIMED,
42 PM_DEVICE_FLAG_WS_CAPABLE,
44 PM_DEVICE_FLAG_WS_ENABLED,
46 PM_DEVICE_FLAG_RUNTIME_ENABLED,
48 PM_DEVICE_FLAG_PD,
50 PM_DEVICE_FLAG_RUNTIME_AUTO,
52 PM_DEVICE_FLAG_ISR_SAFE,
53};
54
65#define PM_DEVICE_ISR_SAFE 1
66
142
162
173typedef int (*pm_device_action_cb_t)(const struct device *dev,
174 enum pm_device_action action);
175
184typedef bool (*pm_device_action_failed_cb_t)(const struct device *dev,
185 int err);
186
200#if defined(CONFIG_PM_DEVICE_RUNTIME) || defined(__DOXYGEN__)
203#endif /* CONFIG_PM_DEVICE_RUNTIME */
204#ifdef CONFIG_PM_DEVICE_POWER_DOMAIN
206 const struct device *domain;
207#endif /* CONFIG_PM_DEVICE_POWER_DOMAIN */
208};
209
217struct pm_device {
220#if defined(CONFIG_PM_DEVICE_RUNTIME) || defined(__DOXYGEN__)
222 const struct device *dev;
224 struct k_sem lock;
227#if defined(CONFIG_PM_DEVICE_RUNTIME_ASYNC) || defined(__DOXYGEN__)
230#endif /* CONFIG_PM_DEVICE_RUNTIME_ASYNC */
231#endif /* CONFIG_PM_DEVICE_RUNTIME */
232};
233
244#if defined(CONFIG_PM_DEVICE_RUNTIME) || defined(__DOXYGEN__)
247#endif
248};
249
250/* Base part must be the first element. */
251BUILD_ASSERT(offsetof(struct pm_device, base) == 0);
252BUILD_ASSERT(offsetof(struct pm_device_isr, base) == 0);
253
256#ifdef CONFIG_PM_DEVICE_RUNTIME
257#define Z_PM_DEVICE_RUNTIME_INIT(obj) \
258 .lock = Z_SEM_INITIALIZER(obj.lock, 1, 1), \
259 .event = Z_EVENT_INITIALIZER(obj.event),
260#else
261#define Z_PM_DEVICE_RUNTIME_INIT(obj)
262#endif /* CONFIG_PM_DEVICE_RUNTIME */
263
264#ifdef CONFIG_PM_DEVICE_POWER_DOMAIN
265#define Z_PM_DEVICE_POWER_DOMAIN_INIT(_node_id) \
266 .domain = DEVICE_DT_GET_OR_NULL(DT_PHANDLE(_node_id, \
267 power_domains)),
268#else
269#define Z_PM_DEVICE_POWER_DOMAIN_INIT(obj)
270#endif /* CONFIG_PM_DEVICE_POWER_DOMAIN */
271
277#define Z_PM_DEVICE_FLAGS(node_id) \
278 (COND_CODE_1( \
279 DT_NODE_EXISTS(node_id), \
280 ((DT_PROP_OR(node_id, wakeup_source, 0) \
281 << PM_DEVICE_FLAG_WS_CAPABLE) | \
282 (DT_PROP_OR(node_id, zephyr_pm_device_runtime_auto, 0) \
283 << PM_DEVICE_FLAG_RUNTIME_AUTO) | \
284 (DT_NODE_HAS_COMPAT(node_id, power_domain) << \
285 PM_DEVICE_FLAG_PD)), \
286 (0)))
287
299#define Z_PM_DEVICE_BASE_INIT(obj, node_id, pm_action_cb, _flags) \
300 { \
301 .flags = ATOMIC_INIT(Z_PM_DEVICE_FLAGS(node_id) | (_flags)), \
302 .state = PM_DEVICE_STATE_ACTIVE, \
303 .action_cb = pm_action_cb, \
304 Z_PM_DEVICE_POWER_DOMAIN_INIT(node_id) \
305 }
306
317#define Z_PM_DEVICE_INIT(obj, node_id, pm_action_cb, isr_safe) \
318 { \
319 .base = Z_PM_DEVICE_BASE_INIT(obj, node_id, pm_action_cb, \
320 isr_safe ? BIT(PM_DEVICE_FLAG_ISR_SAFE) : 0), \
321 COND_CODE_1(isr_safe, (), (Z_PM_DEVICE_RUNTIME_INIT(obj))) \
322 }
323
329#define Z_PM_DEVICE_NAME(dev_id) _CONCAT(__pm_device_, dev_id)
330
331#ifdef CONFIG_PM
343#define Z_PM_DEVICE_DEFINE_SLOT(dev_id) \
344 static STRUCT_SECTION_ITERABLE_ALTERNATE(pm_device_slots, device, \
345 _CONCAT(__pm_slot_, dev_id))
346#else
347#define Z_PM_DEVICE_DEFINE_SLOT(dev_id)
348#endif /* CONFIG_PM */
349
350#ifdef CONFIG_PM_DEVICE
358#define Z_PM_DEVICE_DEFINE(node_id, dev_id, pm_action_cb, isr_safe) \
359 Z_PM_DEVICE_DEFINE_SLOT(dev_id); \
360 static struct COND_CODE_1(isr_safe, (pm_device_isr), (pm_device)) \
361 Z_PM_DEVICE_NAME(dev_id) = \
362 Z_PM_DEVICE_INIT(Z_PM_DEVICE_NAME(dev_id), node_id, \
363 pm_action_cb, isr_safe)
364
370#define Z_PM_DEVICE_GET(dev_id) ((struct pm_device_base *)&Z_PM_DEVICE_NAME(dev_id))
371
372#else
373#define Z_PM_DEVICE_DEFINE(node_id, dev_id, pm_action_cb, isr_safe)
374#define Z_PM_DEVICE_GET(dev_id) NULL
375#endif /* CONFIG_PM_DEVICE */
376
390#define PM_DEVICE_DEFINE(dev_id, pm_action_cb, ...) \
391 Z_PM_DEVICE_DEFINE(DT_INVALID_NODE, dev_id, pm_action_cb, \
392 COND_CODE_1(IS_EMPTY(__VA_ARGS__), (0), (__VA_ARGS__)))
393
405#define PM_DEVICE_DT_DEFINE(node_id, pm_action_cb, ...) \
406 Z_PM_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_ID(node_id), pm_action_cb, \
407 COND_CODE_1(IS_EMPTY(__VA_ARGS__), (0), (__VA_ARGS__)))
408
420#define PM_DEVICE_DT_INST_DEFINE(idx, pm_action_cb, ...) \
421 Z_PM_DEVICE_DEFINE(DT_DRV_INST(idx), \
422 Z_DEVICE_DT_DEV_ID(DT_DRV_INST(idx)), \
423 pm_action_cb, \
424 COND_CODE_1(IS_EMPTY(__VA_ARGS__), (0), (__VA_ARGS__)))
425
434#define PM_DEVICE_GET(dev_id) \
435 Z_PM_DEVICE_GET(dev_id)
436
445#define PM_DEVICE_DT_GET(node_id) \
446 PM_DEVICE_GET(Z_DEVICE_DT_DEV_ID(node_id))
447
456#define PM_DEVICE_DT_INST_GET(idx) \
457 PM_DEVICE_DT_GET(DT_DRV_INST(idx))
458
465
483int pm_device_action_run(const struct device *dev,
484 enum pm_device_action action);
485
497 enum pm_device_action action,
499
500#if defined(CONFIG_PM_DEVICE) || defined(__DOXYGEN__)
510int pm_device_state_get(const struct device *dev,
511 enum pm_device_state *state);
512
524static inline void pm_device_init_suspended(const struct device *dev)
525{
526 struct pm_device_base *pm = dev->pm_base;
527
529}
530
544static inline void pm_device_init_off(const struct device *dev)
545{
546 struct pm_device_base *pm = dev->pm_base;
547
549}
550
562void pm_device_busy_set(const struct device *dev);
563
571void pm_device_busy_clear(const struct device *dev);
572
580
589bool pm_device_is_busy(const struct device *dev);
590
604bool pm_device_wakeup_enable(const struct device *dev, bool enable);
605
614bool pm_device_wakeup_is_enabled(const struct device *dev);
615
624bool pm_device_wakeup_is_capable(const struct device *dev);
625
634bool pm_device_on_power_domain(const struct device *dev);
635
649int pm_device_power_domain_add(const struct device *dev,
650 const struct device *domain);
651
665 const struct device *domain);
666
676bool pm_device_is_powered(const struct device *dev);
677
702
722#else
723static inline int pm_device_state_get(const struct device *dev,
725{
726 ARG_UNUSED(dev);
727
729
730 return 0;
731}
732
733static inline void pm_device_init_suspended(const struct device *dev)
734{
735 ARG_UNUSED(dev);
736}
737static inline void pm_device_init_off(const struct device *dev)
738{
739 ARG_UNUSED(dev);
740}
741static inline void pm_device_busy_set(const struct device *dev)
742{
743 ARG_UNUSED(dev);
744}
745static inline void pm_device_busy_clear(const struct device *dev)
746{
747 ARG_UNUSED(dev);
748}
749static inline bool pm_device_is_any_busy(void) { return false; }
750static inline bool pm_device_is_busy(const struct device *dev)
751{
752 ARG_UNUSED(dev);
753 return false;
754}
755static inline bool pm_device_wakeup_enable(const struct device *dev,
756 bool enable)
757{
758 ARG_UNUSED(dev);
759 ARG_UNUSED(enable);
760 return false;
761}
762static inline bool pm_device_wakeup_is_enabled(const struct device *dev)
763{
764 ARG_UNUSED(dev);
765 return false;
766}
767static inline bool pm_device_wakeup_is_capable(const struct device *dev)
768{
769 ARG_UNUSED(dev);
770 return false;
771}
772static inline bool pm_device_on_power_domain(const struct device *dev)
773{
774 ARG_UNUSED(dev);
775 return false;
776}
777
778static inline int pm_device_power_domain_add(const struct device *dev,
779 const struct device *domain)
780{
781 ARG_UNUSED(dev);
782 ARG_UNUSED(domain);
783 return -ENOSYS;
784}
785
786static inline int pm_device_power_domain_remove(const struct device *dev,
787 const struct device *domain)
788{
789 ARG_UNUSED(dev);
790 ARG_UNUSED(domain);
791 return -ENOSYS;
792}
793
794static inline bool pm_device_is_powered(const struct device *dev)
795{
796 ARG_UNUSED(dev);
797 return true;
798}
799
800static inline int pm_device_driver_init(const struct device *dev, pm_device_action_cb_t action_cb)
801{
802 int rc;
803
804 /* When power management is not enabled, all drivers should initialise to active state */
806 if ((rc < 0) && (rc != -ENOTSUP)) {
807 return rc;
808 }
809
811 if (rc < 0) {
812 return rc;
813 }
814
815 return 0;
816}
817
818static inline int pm_device_driver_deinit(const struct device *dev, pm_device_action_cb_t action_cb)
819{
821}
822
823#endif /* CONFIG_PM_DEVICE */
824
827#ifdef __cplusplus
828}
829#endif
830
831#endif
long atomic_t
Definition atomic_types.h:15
bool pm_device_wakeup_is_enabled(const struct device *dev)
Check if a device is enabled as a wake up source.
int pm_device_power_domain_remove(const struct device *dev, const struct device *domain)
Remove a device from a power domain.
bool pm_device_on_power_domain(const struct device *dev)
Check if the device is on a switchable power domain.
int pm_device_action_run(const struct device *dev, enum pm_device_action action)
Run a pm action on a device.
static void pm_device_init_suspended(const struct device *dev)
Initialize a device state to PM_DEVICE_STATE_SUSPENDED.
Definition device.h:524
pm_device_state
Device power states.
Definition device.h:68
bool pm_device_wakeup_enable(const struct device *dev, bool enable)
Enable or disable a device as a wake up source.
void pm_device_children_action_run(const struct device *dev, enum pm_device_action action, pm_device_action_failed_cb_t failure_cb)
Run a pm action on all children of a device.
void pm_device_busy_set(const struct device *dev)
Mark a device as busy.
int(* pm_device_action_cb_t)(const struct device *dev, enum pm_device_action action)
Device PM action callback.
Definition device.h:173
void pm_device_busy_clear(const struct device *dev)
Clear a device busy status.
bool pm_device_is_busy(const struct device *dev)
Check if a device is busy.
bool(* pm_device_action_failed_cb_t)(const struct device *dev, int err)
Device PM action failed callback.
Definition device.h:184
bool pm_device_is_powered(const struct device *dev)
Check if the device is currently powered.
int pm_device_power_domain_add(const struct device *dev, const struct device *domain)
Add a device to a power domain.
bool pm_device_wakeup_is_capable(const struct device *dev)
Check if a device is wake up capable.
const char * pm_device_state_str(enum pm_device_state state)
Get name of device PM state.
int pm_device_driver_init(const struct device *dev, pm_device_action_cb_t action_cb)
Move a device driver into its initial device power state.
int pm_device_driver_deinit(const struct device *dev, pm_device_action_cb_t action_cb)
Prepare PM device for device driver deinit.
bool pm_device_is_any_busy(void)
Check if any device is busy.
pm_device_action
Device PM actions.
Definition device.h:144
static void pm_device_init_off(const struct device *dev)
Initialize a device state to PM_DEVICE_STATE_OFF.
Definition device.h:544
int pm_device_state_get(const struct device *dev, enum pm_device_state *state)
Obtain the power state of a device.
@ PM_DEVICE_STATE_SUSPENDED
Device hardware is powered, but the device is not needed by the system.
Definition device.h:99
@ PM_DEVICE_STATE_OFF
Device hardware is not powered.
Definition device.h:140
@ PM_DEVICE_STATE_SUSPENDING
Device hardware is powered, but the device has been scheduled to be suspended, as it is no longer nee...
Definition device.h:116
@ PM_DEVICE_STATE_ACTIVE
Device hardware is powered, and the device is needed by the system.
Definition device.h:75
@ PM_DEVICE_ACTION_TURN_OFF
Turn off.
Definition device.h:154
@ PM_DEVICE_ACTION_SUSPEND
Suspend.
Definition device.h:146
@ PM_DEVICE_ACTION_RESUME
Resume.
Definition device.h:148
@ PM_DEVICE_ACTION_TURN_ON
Turn on.
Definition device.h:160
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define ENOTSUP
Unsupported value.
Definition errno.h:114
Public kernel APIs.
state
Definition parser_state.h:29
#define bool
Definition stdbool.h:13
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
struct pm_device_base * pm_base
Definition device.h:542
Event Structure.
Definition kernel.h:2356
Semaphore structure.
Definition kernel.h:3275
Kernel Spin Lock.
Definition spinlock.h:45
A structure used to submit work after a delay.
Definition kernel.h:4101
Device PM info.
Definition device.h:193
uint32_t usage
Device usage count.
Definition device.h:202
pm_device_action_cb_t action_cb
Device PM action callback.
Definition device.h:199
enum pm_device_state state
Device power state.
Definition device.h:197
atomic_t flags
Device PM status flags.
Definition device.h:195
Runtime PM info for device with synchronous PM.
Definition device.h:241
struct k_spinlock lock
Lock to synchronize the synchronous get/put operations.
Definition device.h:246
struct pm_device_base base
Base info.
Definition device.h:243
Runtime PM info for device with generic PM.
Definition device.h:217
struct k_work_delayable work
Work object for asynchronous calls.
Definition device.h:229
struct k_event event
Event var to listen to the sync request events.
Definition device.h:226
struct k_sem lock
Lock to synchronize the get/put operations.
Definition device.h:224
const struct device * dev
Pointer to the device.
Definition device.h:222
struct pm_device_base base
Base info.
Definition device.h:219