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