Commit | Line | Data |
---|---|---|
e1f60b29 NM |
1 | /* |
2 | * Generic OPP Interface | |
3 | * | |
4 | * Copyright (C) 2009-2010 Texas Instruments Incorporated. | |
5 | * Nishanth Menon | |
6 | * Romit Dasgupta | |
7 | * Kevin Hilman | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License version 2 as | |
11 | * published by the Free Software Foundation. | |
12 | */ | |
13 | ||
14 | #ifndef __LINUX_OPP_H__ | |
15 | #define __LINUX_OPP_H__ | |
16 | ||
17 | #include <linux/err.h> | |
03ca370f | 18 | #include <linux/notifier.h> |
e1f60b29 | 19 | |
94735585 VK |
20 | struct clk; |
21 | struct regulator; | |
47d43ba7 | 22 | struct dev_pm_opp; |
313162d0 | 23 | struct device; |
91291d9a | 24 | struct opp_table; |
e1f60b29 | 25 | |
47d43ba7 | 26 | enum dev_pm_opp_event { |
129eec55 | 27 | OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE, |
03ca370f MH |
28 | }; |
29 | ||
0f0fe7e0 VK |
30 | /** |
31 | * struct dev_pm_opp_supply - Power supply voltage/current values | |
32 | * @u_volt: Target voltage in microvolts corresponding to this OPP | |
33 | * @u_volt_min: Minimum voltage in microvolts corresponding to this OPP | |
34 | * @u_volt_max: Maximum voltage in microvolts corresponding to this OPP | |
35 | * @u_amp: Maximum current drawn by the device in microamperes | |
36 | * | |
37 | * This structure stores the voltage/current values for a single power supply. | |
38 | */ | |
39 | struct dev_pm_opp_supply { | |
40 | unsigned long u_volt; | |
41 | unsigned long u_volt_min; | |
42 | unsigned long u_volt_max; | |
43 | unsigned long u_amp; | |
44 | }; | |
45 | ||
94735585 VK |
46 | /** |
47 | * struct dev_pm_opp_info - OPP freq/voltage/current values | |
48 | * @rate: Target clk rate in hz | |
49 | * @supplies: Array of voltage/current values for all power supplies | |
50 | * | |
51 | * This structure stores the freq/voltage/current values for a single OPP. | |
52 | */ | |
53 | struct dev_pm_opp_info { | |
54 | unsigned long rate; | |
55 | struct dev_pm_opp_supply *supplies; | |
56 | }; | |
57 | ||
58 | /** | |
59 | * struct dev_pm_set_opp_data - Set OPP data | |
60 | * @old_opp: Old OPP info | |
61 | * @new_opp: New OPP info | |
62 | * @regulators: Array of regulator pointers | |
63 | * @regulator_count: Number of regulators | |
64 | * @clk: Pointer to clk | |
65 | * @dev: Pointer to the struct device | |
66 | * | |
67 | * This structure contains all information required for setting an OPP. | |
68 | */ | |
69 | struct dev_pm_set_opp_data { | |
70 | struct dev_pm_opp_info old_opp; | |
71 | struct dev_pm_opp_info new_opp; | |
72 | ||
73 | struct regulator **regulators; | |
74 | unsigned int regulator_count; | |
75 | struct clk *clk; | |
76 | struct device *dev; | |
77 | }; | |
78 | ||
e1f60b29 NM |
79 | #if defined(CONFIG_PM_OPP) |
80 | ||
f067a982 | 81 | struct opp_table *dev_pm_opp_get_opp_table(struct device *dev); |
eb7c8743 | 82 | struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index); |
f067a982 VK |
83 | void dev_pm_opp_put_opp_table(struct opp_table *opp_table); |
84 | ||
47d43ba7 | 85 | unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp); |
e1f60b29 | 86 | |
47d43ba7 | 87 | unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp); |
e1f60b29 | 88 | |
19445b25 BZ |
89 | bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp); |
90 | ||
5d4879cd | 91 | int dev_pm_opp_get_opp_count(struct device *dev); |
3ca9bb33 | 92 | unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev); |
655c9df9 | 93 | unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev); |
21743447 | 94 | unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev); |
3aa26a3b | 95 | unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev); |
e1f60b29 | 96 | |
47d43ba7 NM |
97 | struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev, |
98 | unsigned long freq, | |
99 | bool available); | |
e1f60b29 | 100 | |
47d43ba7 NM |
101 | struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev, |
102 | unsigned long *freq); | |
e1f60b29 | 103 | |
47d43ba7 NM |
104 | struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev, |
105 | unsigned long *freq); | |
7034764a | 106 | void dev_pm_opp_put(struct dev_pm_opp *opp); |
e1f60b29 | 107 | |
5d4879cd NM |
108 | int dev_pm_opp_add(struct device *dev, unsigned long freq, |
109 | unsigned long u_volt); | |
129eec55 | 110 | void dev_pm_opp_remove(struct device *dev, unsigned long freq); |
e1f60b29 | 111 | |
5d4879cd | 112 | int dev_pm_opp_enable(struct device *dev, unsigned long freq); |
e1f60b29 | 113 | |
5d4879cd | 114 | int dev_pm_opp_disable(struct device *dev, unsigned long freq); |
e1f60b29 | 115 | |
dc2c9ad5 VK |
116 | int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb); |
117 | int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb); | |
118 | ||
fa30184d VK |
119 | struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count); |
120 | void dev_pm_opp_put_supported_hw(struct opp_table *opp_table); | |
121 | struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name); | |
122 | void dev_pm_opp_put_prop_name(struct opp_table *opp_table); | |
dfbe4678 VK |
123 | struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count); |
124 | void dev_pm_opp_put_regulators(struct opp_table *opp_table); | |
829a4e8c VK |
125 | struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name); |
126 | void dev_pm_opp_put_clkname(struct opp_table *opp_table); | |
fa30184d | 127 | struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data)); |
604a7aeb | 128 | void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table); |
6a0712f6 | 129 | int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq); |
ddbb74bc AB |
130 | int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask); |
131 | int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask); | |
411466c5 SH |
132 | void dev_pm_opp_remove_table(struct device *dev); |
133 | void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask); | |
e1f60b29 | 134 | #else |
f067a982 VK |
135 | static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev) |
136 | { | |
137 | return ERR_PTR(-ENOTSUPP); | |
138 | } | |
139 | ||
eb7c8743 VK |
140 | static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index) |
141 | { | |
142 | return ERR_PTR(-ENOTSUPP); | |
143 | } | |
144 | ||
f067a982 VK |
145 | static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {} |
146 | ||
47d43ba7 | 147 | static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp) |
e1f60b29 NM |
148 | { |
149 | return 0; | |
150 | } | |
151 | ||
47d43ba7 | 152 | static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp) |
e1f60b29 NM |
153 | { |
154 | return 0; | |
155 | } | |
156 | ||
19445b25 BZ |
157 | static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp) |
158 | { | |
159 | return false; | |
160 | } | |
161 | ||
5d4879cd | 162 | static inline int dev_pm_opp_get_opp_count(struct device *dev) |
e1f60b29 NM |
163 | { |
164 | return 0; | |
165 | } | |
166 | ||
3ca9bb33 VK |
167 | static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev) |
168 | { | |
169 | return 0; | |
170 | } | |
171 | ||
655c9df9 VK |
172 | static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev) |
173 | { | |
174 | return 0; | |
175 | } | |
176 | ||
21743447 VK |
177 | static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev) |
178 | { | |
179 | return 0; | |
180 | } | |
181 | ||
3aa26a3b | 182 | static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev) |
4eafbd15 | 183 | { |
3aa26a3b | 184 | return 0; |
4eafbd15 BZ |
185 | } |
186 | ||
47d43ba7 | 187 | static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev, |
e1f60b29 NM |
188 | unsigned long freq, bool available) |
189 | { | |
d708b384 | 190 | return ERR_PTR(-ENOTSUPP); |
e1f60b29 NM |
191 | } |
192 | ||
47d43ba7 | 193 | static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev, |
e1f60b29 NM |
194 | unsigned long *freq) |
195 | { | |
d708b384 | 196 | return ERR_PTR(-ENOTSUPP); |
e1f60b29 NM |
197 | } |
198 | ||
47d43ba7 | 199 | static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev, |
e1f60b29 NM |
200 | unsigned long *freq) |
201 | { | |
d708b384 | 202 | return ERR_PTR(-ENOTSUPP); |
e1f60b29 NM |
203 | } |
204 | ||
7034764a VK |
205 | static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {} |
206 | ||
5d4879cd | 207 | static inline int dev_pm_opp_add(struct device *dev, unsigned long freq, |
e1f60b29 NM |
208 | unsigned long u_volt) |
209 | { | |
d708b384 | 210 | return -ENOTSUPP; |
e1f60b29 NM |
211 | } |
212 | ||
129eec55 VK |
213 | static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq) |
214 | { | |
215 | } | |
216 | ||
5d4879cd | 217 | static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq) |
e1f60b29 NM |
218 | { |
219 | return 0; | |
220 | } | |
221 | ||
5d4879cd | 222 | static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq) |
e1f60b29 NM |
223 | { |
224 | return 0; | |
225 | } | |
03ca370f | 226 | |
dc2c9ad5 | 227 | static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb) |
03ca370f | 228 | { |
dc2c9ad5 VK |
229 | return -ENOTSUPP; |
230 | } | |
231 | ||
232 | static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb) | |
233 | { | |
234 | return -ENOTSUPP; | |
03ca370f | 235 | } |
7de36b0a | 236 | |
fa30184d VK |
237 | static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, |
238 | const u32 *versions, | |
239 | unsigned int count) | |
7de36b0a | 240 | { |
fa30184d | 241 | return ERR_PTR(-ENOTSUPP); |
7de36b0a VK |
242 | } |
243 | ||
fa30184d | 244 | static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {} |
7de36b0a | 245 | |
fa30184d | 246 | static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, |
4dab160e VK |
247 | int (*set_opp)(struct dev_pm_set_opp_data *data)) |
248 | { | |
fa30184d | 249 | return ERR_PTR(-ENOTSUPP); |
4dab160e VK |
250 | } |
251 | ||
604a7aeb | 252 | static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {} |
4dab160e | 253 | |
fa30184d | 254 | static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name) |
01fb4d3c | 255 | { |
fa30184d | 256 | return ERR_PTR(-ENOTSUPP); |
01fb4d3c VK |
257 | } |
258 | ||
fa30184d | 259 | static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {} |
01fb4d3c | 260 | |
dfbe4678 | 261 | static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count) |
9f8ea969 | 262 | { |
91291d9a | 263 | return ERR_PTR(-ENOTSUPP); |
9f8ea969 VK |
264 | } |
265 | ||
dfbe4678 | 266 | static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {} |
9f8ea969 | 267 | |
829a4e8c VK |
268 | static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name) |
269 | { | |
270 | return ERR_PTR(-ENOTSUPP); | |
271 | } | |
272 | ||
273 | static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {} | |
274 | ||
6a0712f6 VK |
275 | static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq) |
276 | { | |
d708b384 | 277 | return -ENOTSUPP; |
6a0712f6 VK |
278 | } |
279 | ||
ddbb74bc | 280 | static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask) |
642aa8ce | 281 | { |
d708b384 | 282 | return -ENOTSUPP; |
642aa8ce VK |
283 | } |
284 | ||
ddbb74bc | 285 | static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask) |
6f707daa VK |
286 | { |
287 | return -EINVAL; | |
288 | } | |
289 | ||
411466c5 SH |
290 | static inline void dev_pm_opp_remove_table(struct device *dev) |
291 | { | |
292 | } | |
293 | ||
294 | static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask) | |
295 | { | |
296 | } | |
297 | ||
a96d69d1 | 298 | #endif /* CONFIG_PM_OPP */ |
e1f60b29 | 299 | |
d6561bb2 | 300 | #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF) |
8f8d37b2 | 301 | int dev_pm_opp_of_add_table(struct device *dev); |
fa9b274f | 302 | int dev_pm_opp_of_add_table_indexed(struct device *dev, int index); |
8f8d37b2 | 303 | void dev_pm_opp_of_remove_table(struct device *dev); |
ddbb74bc AB |
304 | int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask); |
305 | void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask); | |
306 | int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask); | |
0764c604 | 307 | struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev); |
a88bd2a5 | 308 | struct dev_pm_opp *of_dev_pm_opp_find_required_opp(struct device *dev, struct device_node *np); |
e2f4b5f8 | 309 | struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp); |
d6561bb2 | 310 | #else |
8f8d37b2 | 311 | static inline int dev_pm_opp_of_add_table(struct device *dev) |
d6561bb2 | 312 | { |
d708b384 | 313 | return -ENOTSUPP; |
d6561bb2 | 314 | } |
129eec55 | 315 | |
fa9b274f VK |
316 | static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index) |
317 | { | |
318 | return -ENOTSUPP; | |
319 | } | |
320 | ||
8f8d37b2 | 321 | static inline void dev_pm_opp_of_remove_table(struct device *dev) |
129eec55 VK |
322 | { |
323 | } | |
8d4d4e98 | 324 | |
ddbb74bc | 325 | static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask) |
8d4d4e98 | 326 | { |
d708b384 | 327 | return -ENOTSUPP; |
8d4d4e98 VK |
328 | } |
329 | ||
ddbb74bc | 330 | static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask) |
8d4d4e98 VK |
331 | { |
332 | } | |
333 | ||
ddbb74bc | 334 | static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask) |
8d4d4e98 | 335 | { |
d708b384 | 336 | return -ENOTSUPP; |
8d4d4e98 | 337 | } |
0764c604 DG |
338 | |
339 | static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev) | |
340 | { | |
341 | return NULL; | |
342 | } | |
a88bd2a5 VK |
343 | |
344 | static inline struct dev_pm_opp *of_dev_pm_opp_find_required_opp(struct device *dev, struct device_node *np) | |
345 | { | |
346 | return NULL; | |
347 | } | |
e2f4b5f8 VK |
348 | static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp) |
349 | { | |
350 | return NULL; | |
351 | } | |
d6561bb2 SG |
352 | #endif |
353 | ||
e1f60b29 | 354 | #endif /* __LINUX_OPP_H__ */ |