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