Commit | Line | Data |
---|---|---|
f721889f RW |
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> | |
313162d0 PG |
13 | #include <linux/mutex.h> |
14 | #include <linux/pm.h> | |
4f042cda | 15 | #include <linux/err.h> |
c8aa130b | 16 | #include <linux/of.h> |
f721889f | 17 | |
17b75eca RW |
18 | enum gpd_status { |
19 | GPD_STATE_ACTIVE = 0, /* PM domain is active */ | |
17877eb5 | 20 | GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */ |
17b75eca | 21 | GPD_STATE_BUSY, /* Something is happening to the PM domain */ |
c6d22b37 | 22 | GPD_STATE_REPEAT, /* Power off in progress, to be repeated */ |
17b75eca RW |
23 | GPD_STATE_POWER_OFF, /* PM domain is off */ |
24 | }; | |
596ba34b | 25 | |
f721889f RW |
26 | struct dev_power_governor { |
27 | bool (*power_down_ok)(struct dev_pm_domain *domain); | |
b02c999a | 28 | bool (*stop_ok)(struct device *dev); |
f721889f RW |
29 | }; |
30 | ||
d5e4cbfe RW |
31 | struct gpd_dev_ops { |
32 | int (*start)(struct device *dev); | |
33 | int (*stop)(struct device *dev); | |
ecf00475 RW |
34 | int (*save_state)(struct device *dev); |
35 | int (*restore_state)(struct device *dev); | |
d23b9b00 RW |
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); | |
d5e4cbfe RW |
44 | bool (*active_wakeup)(struct device *dev); |
45 | }; | |
46 | ||
f721889f RW |
47 | struct generic_pm_domain { |
48 | struct dev_pm_domain domain; /* PM domain operations */ | |
5125bbf3 | 49 | struct list_head gpd_list_node; /* Node in the global PM domains list */ |
5063ce15 RW |
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 */ | |
f721889f RW |
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; | |
e84b2c20 | 56 | char *name; |
f721889f | 57 | unsigned int in_progress; /* Number of devices being suspended now */ |
c4bb3160 | 58 | atomic_t sd_count; /* Number of subdomains with power "on" */ |
17b75eca RW |
59 | enum gpd_status status; /* Current state of the domain */ |
60 | wait_queue_head_t status_wait_queue; | |
c6d22b37 RW |
61 | struct task_struct *poweroff_task; /* Powering off task */ |
62 | unsigned int resume_count; /* Number of devices being resumed */ | |
596ba34b RW |
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 */ | |
0aa2a221 | 67 | bool dev_irq_safe; /* Device callbacks are IRQ-safe */ |
f721889f | 68 | int (*power_off)(struct generic_pm_domain *domain); |
221e9b58 | 69 | s64 power_off_latency_ns; |
f721889f | 70 | int (*power_on)(struct generic_pm_domain *domain); |
221e9b58 | 71 | s64 power_on_latency_ns; |
d5e4cbfe | 72 | struct gpd_dev_ops dev_ops; |
221e9b58 RW |
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; | |
c8aa130b | 76 | struct device_node *of_node; /* Node in device tree */ |
f721889f RW |
77 | }; |
78 | ||
596ba34b RW |
79 | static 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 | ||
5063ce15 RW |
84 | struct 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 | ||
b02c999a RW |
91 | struct gpd_timing_data { |
92 | s64 stop_latency_ns; | |
93 | s64 start_latency_ns; | |
221e9b58 RW |
94 | s64 save_state_latency_ns; |
95 | s64 restore_state_latency_ns; | |
b02c999a RW |
96 | s64 break_even_ns; |
97 | }; | |
98 | ||
cd0ea672 RW |
99 | struct generic_pm_domain_data { |
100 | struct pm_domain_data base; | |
d5e4cbfe | 101 | struct gpd_dev_ops ops; |
b02c999a | 102 | struct gpd_timing_data td; |
cd0ea672 | 103 | bool need_restore; |
1e78a0c7 | 104 | bool always_on; |
cd0ea672 RW |
105 | }; |
106 | ||
9b4f617b | 107 | #ifdef CONFIG_PM_GENERIC_DOMAINS |
cd0ea672 RW |
108 | static 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 | ||
d5e4cbfe RW |
113 | static 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 | ||
b02c999a RW |
118 | extern struct dev_power_governor simple_qos_governor; |
119 | ||
120 | extern struct generic_pm_domain *dev_to_genpd(struct device *dev); | |
121 | extern int __pm_genpd_add_device(struct generic_pm_domain *genpd, | |
122 | struct device *dev, | |
123 | struct gpd_timing_data *td); | |
124 | ||
c8aa130b TA |
125 | extern int __pm_genpd_of_add_device(struct device_node *genpd_node, |
126 | struct device *dev, | |
127 | struct gpd_timing_data *td); | |
128 | ||
b02c999a RW |
129 | static 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 | ||
c8aa130b TA |
135 | static 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 | ||
f721889f RW |
141 | extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
142 | struct device *dev); | |
1e78a0c7 | 143 | extern void pm_genpd_dev_always_on(struct device *dev, bool val); |
f721889f RW |
144 | extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, |
145 | struct generic_pm_domain *new_subdomain); | |
146 | extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, | |
147 | struct generic_pm_domain *target); | |
b02c999a RW |
148 | extern int pm_genpd_add_callbacks(struct device *dev, |
149 | struct gpd_dev_ops *ops, | |
150 | struct gpd_timing_data *td); | |
151 | extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td); | |
f721889f RW |
152 | extern void pm_genpd_init(struct generic_pm_domain *genpd, |
153 | struct dev_power_governor *gov, bool is_off); | |
b02c999a | 154 | |
18b4f3f5 | 155 | extern int pm_genpd_poweron(struct generic_pm_domain *genpd); |
b02c999a RW |
156 | |
157 | extern bool default_stop_ok(struct device *dev); | |
158 | ||
925b44a2 | 159 | extern struct dev_power_governor pm_domain_always_on_gov; |
f721889f | 160 | #else |
b02c999a | 161 | |
b642631d MD |
162 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
163 | { | |
164 | return ERR_PTR(-ENOSYS); | |
165 | } | |
b02c999a RW |
166 | static inline struct generic_pm_domain *dev_to_genpd(struct device *dev) |
167 | { | |
168 | return ERR_PTR(-ENOSYS); | |
169 | } | |
170 | static 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 | } | |
f721889f RW |
176 | static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, |
177 | struct device *dev) | |
178 | { | |
179 | return -ENOSYS; | |
180 | } | |
181 | static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, | |
182 | struct device *dev) | |
183 | { | |
184 | return -ENOSYS; | |
185 | } | |
1e78a0c7 | 186 | static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {} |
f721889f RW |
187 | static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, |
188 | struct generic_pm_domain *new_sd) | |
189 | { | |
190 | return -ENOSYS; | |
191 | } | |
192 | static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, | |
193 | struct generic_pm_domain *target) | |
194 | { | |
195 | return -ENOSYS; | |
196 | } | |
d5e4cbfe | 197 | static inline int pm_genpd_add_callbacks(struct device *dev, |
b02c999a RW |
198 | struct gpd_dev_ops *ops, |
199 | struct gpd_timing_data *td) | |
d5e4cbfe RW |
200 | { |
201 | return -ENOSYS; | |
202 | } | |
b02c999a | 203 | static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td) |
d5e4cbfe RW |
204 | { |
205 | return -ENOSYS; | |
206 | } | |
b642631d MD |
207 | static inline void pm_genpd_init(struct generic_pm_domain *genpd, |
208 | struct dev_power_governor *gov, bool is_off) | |
b02c999a RW |
209 | { |
210 | } | |
18b4f3f5 MD |
211 | static inline int pm_genpd_poweron(struct generic_pm_domain *genpd) |
212 | { | |
213 | return -ENOSYS; | |
214 | } | |
b02c999a RW |
215 | static inline bool default_stop_ok(struct device *dev) |
216 | { | |
217 | return false; | |
218 | } | |
b642631d | 219 | #define simple_qos_governor NULL |
925b44a2 | 220 | #define pm_domain_always_on_gov NULL |
17f2ae7f RW |
221 | #endif |
222 | ||
b02c999a RW |
223 | static inline int pm_genpd_remove_callbacks(struct device *dev) |
224 | { | |
225 | return __pm_genpd_remove_callbacks(dev, true); | |
226 | } | |
227 | ||
17f2ae7f RW |
228 | #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME |
229 | extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd); | |
230 | extern void pm_genpd_poweroff_unused(void); | |
231 | #else | |
0bc5b2de | 232 | static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {} |
17f2ae7f | 233 | static inline void pm_genpd_poweroff_unused(void) {} |
f721889f RW |
234 | #endif |
235 | ||
236 | #endif /* _LINUX_PM_DOMAIN_H */ |