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 VK |
81 | struct opp_table *dev_pm_opp_get_opp_table(struct device *dev); |
82 | void dev_pm_opp_put_opp_table(struct opp_table *opp_table); | |
83 | ||
47d43ba7 | 84 | unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp); |
e1f60b29 | 85 | |
47d43ba7 | 86 | unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp); |
e1f60b29 | 87 | |
19445b25 BZ |
88 | bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp); |
89 | ||
5d4879cd | 90 | int dev_pm_opp_get_opp_count(struct device *dev); |
3ca9bb33 | 91 | unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev); |
655c9df9 | 92 | unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev); |
21743447 | 93 | unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev); |
3aa26a3b | 94 | unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev); |
e1f60b29 | 95 | |
47d43ba7 NM |
96 | struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev, |
97 | unsigned long freq, | |
98 | bool available); | |
e1f60b29 | 99 | |
47d43ba7 NM |
100 | struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev, |
101 | unsigned long *freq); | |
e1f60b29 | 102 | |
47d43ba7 NM |
103 | struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev, |
104 | unsigned long *freq); | |
7034764a | 105 | void dev_pm_opp_put(struct dev_pm_opp *opp); |
e1f60b29 | 106 | |
5d4879cd NM |
107 | int dev_pm_opp_add(struct device *dev, unsigned long freq, |
108 | unsigned long u_volt); | |
129eec55 | 109 | void dev_pm_opp_remove(struct device *dev, unsigned long freq); |
e1f60b29 | 110 | |
5d4879cd | 111 | int dev_pm_opp_enable(struct device *dev, unsigned long freq); |
e1f60b29 | 112 | |
5d4879cd | 113 | int dev_pm_opp_disable(struct device *dev, unsigned long freq); |
e1f60b29 | 114 | |
dc2c9ad5 VK |
115 | int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb); |
116 | int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb); | |
117 | ||
fa30184d VK |
118 | struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count); |
119 | void dev_pm_opp_put_supported_hw(struct opp_table *opp_table); | |
120 | struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name); | |
121 | void dev_pm_opp_put_prop_name(struct opp_table *opp_table); | |
dfbe4678 VK |
122 | struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count); |
123 | void dev_pm_opp_put_regulators(struct opp_table *opp_table); | |
829a4e8c VK |
124 | struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name); |
125 | void dev_pm_opp_put_clkname(struct opp_table *opp_table); | |
fa30184d VK |
126 | struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data)); |
127 | void dev_pm_opp_register_put_opp_helper(struct opp_table *opp_table); | |
6a0712f6 | 128 | int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq); |
ddbb74bc AB |
129 | int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask); |
130 | int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask); | |
411466c5 SH |
131 | void dev_pm_opp_remove_table(struct device *dev); |
132 | void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask); | |
e1f60b29 | 133 | #else |
f067a982 VK |
134 | static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev) |
135 | { | |
136 | return ERR_PTR(-ENOTSUPP); | |
137 | } | |
138 | ||
139 | static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {} | |
140 | ||
47d43ba7 | 141 | static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp) |
e1f60b29 NM |
142 | { |
143 | return 0; | |
144 | } | |
145 | ||
47d43ba7 | 146 | static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp) |
e1f60b29 NM |
147 | { |
148 | return 0; | |
149 | } | |
150 | ||
19445b25 BZ |
151 | static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp) |
152 | { | |
153 | return false; | |
154 | } | |
155 | ||
5d4879cd | 156 | static inline int dev_pm_opp_get_opp_count(struct device *dev) |
e1f60b29 NM |
157 | { |
158 | return 0; | |
159 | } | |
160 | ||
3ca9bb33 VK |
161 | static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev) |
162 | { | |
163 | return 0; | |
164 | } | |
165 | ||
655c9df9 VK |
166 | static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev) |
167 | { | |
168 | return 0; | |
169 | } | |
170 | ||
21743447 VK |
171 | static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev) |
172 | { | |
173 | return 0; | |
174 | } | |
175 | ||
3aa26a3b | 176 | static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev) |
4eafbd15 | 177 | { |
3aa26a3b | 178 | return 0; |
4eafbd15 BZ |
179 | } |
180 | ||
47d43ba7 | 181 | static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev, |
e1f60b29 NM |
182 | unsigned long freq, bool available) |
183 | { | |
d708b384 | 184 | return ERR_PTR(-ENOTSUPP); |
e1f60b29 NM |
185 | } |
186 | ||
47d43ba7 | 187 | static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev, |
e1f60b29 NM |
188 | unsigned long *freq) |
189 | { | |
d708b384 | 190 | return ERR_PTR(-ENOTSUPP); |
e1f60b29 NM |
191 | } |
192 | ||
47d43ba7 | 193 | static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev, |
e1f60b29 NM |
194 | unsigned long *freq) |
195 | { | |
d708b384 | 196 | return ERR_PTR(-ENOTSUPP); |
e1f60b29 NM |
197 | } |
198 | ||
7034764a VK |
199 | static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {} |
200 | ||
5d4879cd | 201 | static inline int dev_pm_opp_add(struct device *dev, unsigned long freq, |
e1f60b29 NM |
202 | unsigned long u_volt) |
203 | { | |
d708b384 | 204 | return -ENOTSUPP; |
e1f60b29 NM |
205 | } |
206 | ||
129eec55 VK |
207 | static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq) |
208 | { | |
209 | } | |
210 | ||
5d4879cd | 211 | static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq) |
e1f60b29 NM |
212 | { |
213 | return 0; | |
214 | } | |
215 | ||
5d4879cd | 216 | static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq) |
e1f60b29 NM |
217 | { |
218 | return 0; | |
219 | } | |
03ca370f | 220 | |
dc2c9ad5 | 221 | static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb) |
03ca370f | 222 | { |
dc2c9ad5 VK |
223 | return -ENOTSUPP; |
224 | } | |
225 | ||
226 | static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb) | |
227 | { | |
228 | return -ENOTSUPP; | |
03ca370f | 229 | } |
7de36b0a | 230 | |
fa30184d VK |
231 | static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, |
232 | const u32 *versions, | |
233 | unsigned int count) | |
7de36b0a | 234 | { |
fa30184d | 235 | return ERR_PTR(-ENOTSUPP); |
7de36b0a VK |
236 | } |
237 | ||
fa30184d | 238 | static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {} |
7de36b0a | 239 | |
fa30184d | 240 | static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, |
4dab160e VK |
241 | int (*set_opp)(struct dev_pm_set_opp_data *data)) |
242 | { | |
fa30184d | 243 | return ERR_PTR(-ENOTSUPP); |
4dab160e VK |
244 | } |
245 | ||
fa30184d | 246 | static inline void dev_pm_opp_register_put_opp_helper(struct opp_table *opp_table) {} |
4dab160e | 247 | |
fa30184d | 248 | static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name) |
01fb4d3c | 249 | { |
fa30184d | 250 | return ERR_PTR(-ENOTSUPP); |
01fb4d3c VK |
251 | } |
252 | ||
fa30184d | 253 | static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {} |
01fb4d3c | 254 | |
dfbe4678 | 255 | static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count) |
9f8ea969 | 256 | { |
91291d9a | 257 | return ERR_PTR(-ENOTSUPP); |
9f8ea969 VK |
258 | } |
259 | ||
dfbe4678 | 260 | static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {} |
9f8ea969 | 261 | |
829a4e8c VK |
262 | static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name) |
263 | { | |
264 | return ERR_PTR(-ENOTSUPP); | |
265 | } | |
266 | ||
267 | static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {} | |
268 | ||
6a0712f6 VK |
269 | static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq) |
270 | { | |
d708b384 | 271 | return -ENOTSUPP; |
6a0712f6 VK |
272 | } |
273 | ||
ddbb74bc | 274 | static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask) |
642aa8ce | 275 | { |
d708b384 | 276 | return -ENOTSUPP; |
642aa8ce VK |
277 | } |
278 | ||
ddbb74bc | 279 | static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask) |
6f707daa VK |
280 | { |
281 | return -EINVAL; | |
282 | } | |
283 | ||
411466c5 SH |
284 | static inline void dev_pm_opp_remove_table(struct device *dev) |
285 | { | |
286 | } | |
287 | ||
288 | static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask) | |
289 | { | |
290 | } | |
291 | ||
a96d69d1 | 292 | #endif /* CONFIG_PM_OPP */ |
e1f60b29 | 293 | |
d6561bb2 | 294 | #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF) |
8f8d37b2 VK |
295 | int dev_pm_opp_of_add_table(struct device *dev); |
296 | void dev_pm_opp_of_remove_table(struct device *dev); | |
ddbb74bc AB |
297 | int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask); |
298 | void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask); | |
299 | int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask); | |
0764c604 | 300 | struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev); |
d6561bb2 | 301 | #else |
8f8d37b2 | 302 | static inline int dev_pm_opp_of_add_table(struct device *dev) |
d6561bb2 | 303 | { |
d708b384 | 304 | return -ENOTSUPP; |
d6561bb2 | 305 | } |
129eec55 | 306 | |
8f8d37b2 | 307 | static inline void dev_pm_opp_of_remove_table(struct device *dev) |
129eec55 VK |
308 | { |
309 | } | |
8d4d4e98 | 310 | |
ddbb74bc | 311 | static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask) |
8d4d4e98 | 312 | { |
d708b384 | 313 | return -ENOTSUPP; |
8d4d4e98 VK |
314 | } |
315 | ||
ddbb74bc | 316 | static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask) |
8d4d4e98 VK |
317 | { |
318 | } | |
319 | ||
ddbb74bc | 320 | static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask) |
8d4d4e98 | 321 | { |
d708b384 | 322 | return -ENOTSUPP; |
8d4d4e98 | 323 | } |
0764c604 DG |
324 | |
325 | static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev) | |
326 | { | |
327 | return NULL; | |
328 | } | |
d6561bb2 SG |
329 | #endif |
330 | ||
e1f60b29 | 331 | #endif /* __LINUX_OPP_H__ */ |