Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * pm_domain.h - Definitions and headers related to device power domains.
3 *
4 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
5 *
6 * This file is released under the GPLv2.
7 */
8
9#ifndef _LINUX_PM_DOMAIN_H
10#define _LINUX_PM_DOMAIN_H
11
12#include <linux/device.h>
13#include <linux/mutex.h>
14#include <linux/pm.h>
15#include <linux/err.h>
16#include <linux/of.h>
17
18enum gpd_status {
19 GPD_STATE_ACTIVE = 0, /* PM domain is active */
20 GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */
21 GPD_STATE_BUSY, /* Something is happening to the PM domain */
22 GPD_STATE_REPEAT, /* Power off in progress, to be repeated */
23 GPD_STATE_POWER_OFF, /* PM domain is off */
24};
25
26struct dev_power_governor {
27 bool (*power_down_ok)(struct dev_pm_domain *domain);
28 bool (*stop_ok)(struct device *dev);
29};
30
31struct gpd_dev_ops {
32 int (*start)(struct device *dev);
33 int (*stop)(struct device *dev);
34 int (*save_state)(struct device *dev);
35 int (*restore_state)(struct device *dev);
36 int (*suspend)(struct device *dev);
37 int (*suspend_late)(struct device *dev);
38 int (*resume_early)(struct device *dev);
39 int (*resume)(struct device *dev);
40 int (*freeze)(struct device *dev);
41 int (*freeze_late)(struct device *dev);
42 int (*thaw_early)(struct device *dev);
43 int (*thaw)(struct device *dev);
44 bool (*active_wakeup)(struct device *dev);
45};
46
47struct generic_pm_domain {
48 struct dev_pm_domain domain; /* PM domain operations */
49 struct list_head gpd_list_node; /* Node in the global PM domains list */
50 struct list_head master_links; /* Links with PM domain as a master */
51 struct list_head slave_links; /* Links with PM domain as a slave */
52 struct list_head dev_list; /* List of devices */
53 struct mutex lock;
54 struct dev_power_governor *gov;
55 struct work_struct power_off_work;
56 char *name;
57 unsigned int in_progress; /* Number of devices being suspended now */
58 atomic_t sd_count; /* Number of subdomains with power "on" */
59 enum gpd_status status; /* Current state of the domain */
60 wait_queue_head_t status_wait_queue;
61 struct task_struct *poweroff_task; /* Powering off task */
62 unsigned int resume_count; /* Number of devices being resumed */
63 unsigned int device_count; /* Number of devices */
64 unsigned int suspended_count; /* System suspend device counter */
65 unsigned int prepared_count; /* Suspend counter of prepared devices */
66 bool suspend_power_off; /* Power status before system suspend */
67 bool dev_irq_safe; /* Device callbacks are IRQ-safe */
68 int (*power_off)(struct generic_pm_domain *domain);
69 s64 power_off_latency_ns;
70 int (*power_on)(struct generic_pm_domain *domain);
71 s64 power_on_latency_ns;
72 struct gpd_dev_ops dev_ops;
73 s64 break_even_ns; /* Power break even for the entire domain. */
74 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
75 ktime_t power_off_time;
76 struct device_node *of_node; /* Node in device tree */
77};
78
79static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
80{
81 return container_of(pd, struct generic_pm_domain, domain);
82}
83
84struct gpd_link {
85 struct generic_pm_domain *master;
86 struct list_head master_node;
87 struct generic_pm_domain *slave;
88 struct list_head slave_node;
89};
90
91struct gpd_timing_data {
92 s64 stop_latency_ns;
93 s64 start_latency_ns;
94 s64 save_state_latency_ns;
95 s64 restore_state_latency_ns;
96 s64 break_even_ns;
97};
98
99struct generic_pm_domain_data {
100 struct pm_domain_data base;
101 struct gpd_dev_ops ops;
102 struct gpd_timing_data td;
103 bool need_restore;
104 bool always_on;
105};
106
107#ifdef CONFIG_PM_GENERIC_DOMAINS
108static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
109{
110 return container_of(pdd, struct generic_pm_domain_data, base);
111}
112
113static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
114{
115 return to_gpd_data(dev->power.subsys_data->domain_data);
116}
117
118extern struct dev_power_governor simple_qos_governor;
119
120extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
121extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
122 struct device *dev,
123 struct gpd_timing_data *td);
124
125extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
126 struct device *dev,
127 struct gpd_timing_data *td);
128
129static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
130 struct device *dev)
131{
132 return __pm_genpd_add_device(genpd, dev, NULL);
133}
134
135static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
136 struct device *dev)
137{
138 return __pm_genpd_of_add_device(genpd_node, dev, NULL);
139}
140
141extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
142 struct device *dev);
143extern void pm_genpd_dev_always_on(struct device *dev, bool val);
144extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
145 struct generic_pm_domain *new_subdomain);
146extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
147 struct generic_pm_domain *target);
148extern int pm_genpd_add_callbacks(struct device *dev,
149 struct gpd_dev_ops *ops,
150 struct gpd_timing_data *td);
151extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
152extern void pm_genpd_init(struct generic_pm_domain *genpd,
153 struct dev_power_governor *gov, bool is_off);
154
155extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
156
157extern bool default_stop_ok(struct device *dev);
158
159extern struct dev_power_governor pm_domain_always_on_gov;
160#else
161
162static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
163{
164 return ERR_PTR(-ENOSYS);
165}
166static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
167{
168 return ERR_PTR(-ENOSYS);
169}
170static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
171 struct device *dev,
172 struct gpd_timing_data *td)
173{
174 return -ENOSYS;
175}
176static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
177 struct device *dev)
178{
179 return -ENOSYS;
180}
181static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
182 struct device *dev)
183{
184 return -ENOSYS;
185}
186static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {}
187static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
188 struct generic_pm_domain *new_sd)
189{
190 return -ENOSYS;
191}
192static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
193 struct generic_pm_domain *target)
194{
195 return -ENOSYS;
196}
197static inline int pm_genpd_add_callbacks(struct device *dev,
198 struct gpd_dev_ops *ops,
199 struct gpd_timing_data *td)
200{
201 return -ENOSYS;
202}
203static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
204{
205 return -ENOSYS;
206}
207static inline void pm_genpd_init(struct generic_pm_domain *genpd,
208 struct dev_power_governor *gov, bool is_off)
209{
210}
211static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
212{
213 return -ENOSYS;
214}
215static inline bool default_stop_ok(struct device *dev)
216{
217 return false;
218}
219#define simple_qos_governor NULL
220#define pm_domain_always_on_gov NULL
221#endif
222
223static inline int pm_genpd_remove_callbacks(struct device *dev)
224{
225 return __pm_genpd_remove_callbacks(dev, true);
226}
227
228#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
229extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
230extern void pm_genpd_poweroff_unused(void);
231#else
232static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
233static inline void pm_genpd_poweroff_unused(void) {}
234#endif
235
236#endif /* _LINUX_PM_DOMAIN_H */