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> |
6ff7bb0d | 17 | #include <linux/notifier.h> |
f721889f | 18 | |
c11f6f5b UH |
19 | /* Defines used for the flags field in the struct generic_pm_domain */ |
20 | #define GENPD_FLAG_PM_CLK (1U << 0) /* PM domain uses PM clk */ | |
21 | ||
fc5cbf0c AH |
22 | #define GENPD_MAX_NUM_STATES 8 /* Number of possible low power states */ |
23 | ||
17b75eca RW |
24 | enum gpd_status { |
25 | GPD_STATE_ACTIVE = 0, /* PM domain is active */ | |
17b75eca RW |
26 | GPD_STATE_POWER_OFF, /* PM domain is off */ |
27 | }; | |
596ba34b | 28 | |
f721889f RW |
29 | struct dev_power_governor { |
30 | bool (*power_down_ok)(struct dev_pm_domain *domain); | |
9df3921e | 31 | bool (*suspend_ok)(struct device *dev); |
f721889f RW |
32 | }; |
33 | ||
d5e4cbfe RW |
34 | struct gpd_dev_ops { |
35 | int (*start)(struct device *dev); | |
36 | int (*stop)(struct device *dev); | |
37 | bool (*active_wakeup)(struct device *dev); | |
38 | }; | |
39 | ||
fc5cbf0c AH |
40 | struct genpd_power_state { |
41 | s64 power_off_latency_ns; | |
42 | s64 power_on_latency_ns; | |
43 | }; | |
44 | ||
f721889f RW |
45 | struct generic_pm_domain { |
46 | struct dev_pm_domain domain; /* PM domain operations */ | |
5125bbf3 | 47 | struct list_head gpd_list_node; /* Node in the global PM domains list */ |
5063ce15 RW |
48 | struct list_head master_links; /* Links with PM domain as a master */ |
49 | struct list_head slave_links; /* Links with PM domain as a slave */ | |
f721889f RW |
50 | struct list_head dev_list; /* List of devices */ |
51 | struct mutex lock; | |
52 | struct dev_power_governor *gov; | |
53 | struct work_struct power_off_work; | |
de0aa06d JH |
54 | struct fwnode_handle *provider; /* Identity of the domain provider */ |
55 | bool has_provider; | |
d07e9c17 | 56 | const char *name; |
c4bb3160 | 57 | atomic_t sd_count; /* Number of subdomains with power "on" */ |
17b75eca | 58 | enum gpd_status status; /* Current state of the domain */ |
596ba34b RW |
59 | unsigned int device_count; /* Number of devices */ |
60 | unsigned int suspended_count; /* System suspend device counter */ | |
61 | unsigned int prepared_count; /* Suspend counter of prepared devices */ | |
f721889f RW |
62 | int (*power_off)(struct generic_pm_domain *domain); |
63 | int (*power_on)(struct generic_pm_domain *domain); | |
d5e4cbfe | 64 | struct gpd_dev_ops dev_ops; |
221e9b58 | 65 | s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ |
6ff7bb0d RW |
66 | bool max_off_time_changed; |
67 | bool cached_power_down_ok; | |
c16561e8 UH |
68 | int (*attach_dev)(struct generic_pm_domain *domain, |
69 | struct device *dev); | |
70 | void (*detach_dev)(struct generic_pm_domain *domain, | |
71 | struct device *dev); | |
c11f6f5b | 72 | unsigned int flags; /* Bit field of configs for genpd */ |
fc5cbf0c AH |
73 | struct genpd_power_state states[GENPD_MAX_NUM_STATES]; |
74 | unsigned int state_count; /* number of states */ | |
75 | unsigned int state_idx; /* state that genpd will go to when off */ | |
76 | ||
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 | 91 | struct gpd_timing_data { |
2b1d88cd UH |
92 | s64 suspend_latency_ns; |
93 | s64 resume_latency_ns; | |
a5bef810 | 94 | s64 effective_constraint_ns; |
6ff7bb0d | 95 | bool constraint_changed; |
9df3921e | 96 | bool cached_suspend_ok; |
b02c999a RW |
97 | }; |
98 | ||
00e7c295 UH |
99 | struct pm_domain_data { |
100 | struct list_head list_node; | |
101 | struct device *dev; | |
102 | }; | |
103 | ||
cd0ea672 RW |
104 | struct generic_pm_domain_data { |
105 | struct pm_domain_data base; | |
b02c999a | 106 | struct gpd_timing_data td; |
6ff7bb0d | 107 | struct notifier_block nb; |
cd0ea672 RW |
108 | }; |
109 | ||
9b4f617b | 110 | #ifdef CONFIG_PM_GENERIC_DOMAINS |
cd0ea672 RW |
111 | static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) |
112 | { | |
113 | return container_of(pdd, struct generic_pm_domain_data, base); | |
114 | } | |
115 | ||
d5e4cbfe RW |
116 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
117 | { | |
118 | return to_gpd_data(dev->power.subsys_data->domain_data); | |
119 | } | |
120 | ||
b02c999a RW |
121 | extern int __pm_genpd_add_device(struct generic_pm_domain *genpd, |
122 | struct device *dev, | |
123 | struct gpd_timing_data *td); | |
124 | ||
f721889f RW |
125 | extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
126 | struct device *dev); | |
127 | extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, | |
128 | struct generic_pm_domain *new_subdomain); | |
129 | extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, | |
130 | struct generic_pm_domain *target); | |
7eb231c3 UH |
131 | extern int pm_genpd_init(struct generic_pm_domain *genpd, |
132 | struct dev_power_governor *gov, bool is_off); | |
3fe57710 | 133 | extern int pm_genpd_remove(struct generic_pm_domain *genpd); |
b02c999a | 134 | |
ae3c511c | 135 | extern struct dev_power_governor simple_qos_governor; |
925b44a2 | 136 | extern struct dev_power_governor pm_domain_always_on_gov; |
f721889f | 137 | #else |
b02c999a | 138 | |
b642631d MD |
139 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
140 | { | |
141 | return ERR_PTR(-ENOSYS); | |
142 | } | |
b02c999a RW |
143 | static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, |
144 | struct device *dev, | |
145 | struct gpd_timing_data *td) | |
146 | { | |
147 | return -ENOSYS; | |
148 | } | |
f721889f RW |
149 | static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
150 | struct device *dev) | |
151 | { | |
152 | return -ENOSYS; | |
153 | } | |
154 | static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, | |
155 | struct generic_pm_domain *new_sd) | |
156 | { | |
157 | return -ENOSYS; | |
158 | } | |
159 | static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, | |
160 | struct generic_pm_domain *target) | |
161 | { | |
162 | return -ENOSYS; | |
163 | } | |
7eb231c3 UH |
164 | static inline int pm_genpd_init(struct generic_pm_domain *genpd, |
165 | struct dev_power_governor *gov, bool is_off) | |
b02c999a | 166 | { |
7eb231c3 | 167 | return -ENOSYS; |
b02c999a | 168 | } |
3fe57710 JH |
169 | static inline int pm_genpd_remove(struct generic_pm_domain *genpd) |
170 | { | |
171 | return -ENOTSUPP; | |
172 | } | |
17f2ae7f RW |
173 | #endif |
174 | ||
b5abb085 RW |
175 | static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, |
176 | struct device *dev) | |
177 | { | |
178 | return __pm_genpd_add_device(genpd, dev, NULL); | |
179 | } | |
180 | ||
77f827de | 181 | #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP |
d47e6464 UH |
182 | extern void pm_genpd_syscore_poweroff(struct device *dev); |
183 | extern void pm_genpd_syscore_poweron(struct device *dev); | |
77f827de | 184 | #else |
d47e6464 UH |
185 | static inline void pm_genpd_syscore_poweroff(struct device *dev) {} |
186 | static inline void pm_genpd_syscore_poweron(struct device *dev) {} | |
77f827de RW |
187 | #endif |
188 | ||
aa42240a TF |
189 | /* OF PM domain providers */ |
190 | struct of_device_id; | |
191 | ||
192 | struct genpd_onecell_data { | |
193 | struct generic_pm_domain **domains; | |
194 | unsigned int num_domains; | |
195 | }; | |
196 | ||
aa42240a | 197 | #ifdef CONFIG_PM_GENERIC_DOMAINS_OF |
892ebdcc JH |
198 | int of_genpd_add_provider_simple(struct device_node *np, |
199 | struct generic_pm_domain *genpd); | |
200 | int of_genpd_add_provider_onecell(struct device_node *np, | |
201 | struct genpd_onecell_data *data); | |
aa42240a | 202 | void of_genpd_del_provider(struct device_node *np); |
ec69572b JH |
203 | extern int of_genpd_add_device(struct of_phandle_args *args, |
204 | struct device *dev); | |
205 | extern int of_genpd_add_subdomain(struct of_phandle_args *parent, | |
206 | struct of_phandle_args *new_subdomain); | |
aa42240a TF |
207 | |
208 | int genpd_dev_pm_attach(struct device *dev); | |
209 | #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ | |
892ebdcc JH |
210 | static inline int of_genpd_add_provider_simple(struct device_node *np, |
211 | struct generic_pm_domain *genpd) | |
aa42240a | 212 | { |
892ebdcc JH |
213 | return -ENOTSUPP; |
214 | } | |
215 | ||
216 | static inline int of_genpd_add_provider_onecell(struct device_node *np, | |
217 | struct genpd_onecell_data *data) | |
218 | { | |
219 | return -ENOTSUPP; | |
aa42240a | 220 | } |
aa42240a | 221 | |
892ebdcc | 222 | static inline void of_genpd_del_provider(struct device_node *np) {} |
aa42240a | 223 | |
ec69572b JH |
224 | static inline int of_genpd_add_device(struct of_phandle_args *args, |
225 | struct device *dev) | |
226 | { | |
227 | return -ENODEV; | |
228 | } | |
229 | ||
230 | static inline int of_genpd_add_subdomain(struct of_phandle_args *parent, | |
231 | struct of_phandle_args *new_subdomain) | |
232 | { | |
233 | return -ENODEV; | |
234 | } | |
235 | ||
aa42240a TF |
236 | static inline int genpd_dev_pm_attach(struct device *dev) |
237 | { | |
238 | return -ENODEV; | |
239 | } | |
240 | #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ | |
241 | ||
f48c767c UH |
242 | #ifdef CONFIG_PM |
243 | extern int dev_pm_domain_attach(struct device *dev, bool power_on); | |
244 | extern void dev_pm_domain_detach(struct device *dev, bool power_off); | |
989561de | 245 | extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd); |
f48c767c UH |
246 | #else |
247 | static inline int dev_pm_domain_attach(struct device *dev, bool power_on) | |
248 | { | |
249 | return -ENODEV; | |
250 | } | |
251 | static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {} | |
989561de TV |
252 | static inline void dev_pm_domain_set(struct device *dev, |
253 | struct dev_pm_domain *pd) {} | |
f48c767c UH |
254 | #endif |
255 | ||
f721889f | 256 | #endif /* _LINUX_PM_DOMAIN_H */ |