GNU Linux-libre 4.9.318-gnu1
[releases.git] / include / linux / pm_opp.h
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>
18 #include <linux/notifier.h>
19
20 struct dev_pm_opp;
21 struct device;
22 struct opp_table;
23
24 enum dev_pm_opp_event {
25         OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
26 };
27
28 #if defined(CONFIG_PM_OPP)
29
30 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
31
32 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
33
34 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
35
36 int dev_pm_opp_get_opp_count(struct device *dev);
37 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
38 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
39 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
40 struct dev_pm_opp *dev_pm_opp_get_suspend_opp(struct device *dev);
41
42 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
43                                               unsigned long freq,
44                                               bool available);
45
46 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
47                                               unsigned long *freq);
48
49 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
50                                              unsigned long *freq);
51
52 int dev_pm_opp_add(struct device *dev, unsigned long freq,
53                    unsigned long u_volt);
54 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
55
56 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
57
58 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
59
60 struct srcu_notifier_head *dev_pm_opp_get_notifier(struct device *dev);
61 int dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions,
62                                 unsigned int count);
63 void dev_pm_opp_put_supported_hw(struct device *dev);
64 int dev_pm_opp_set_prop_name(struct device *dev, const char *name);
65 void dev_pm_opp_put_prop_name(struct device *dev);
66 struct opp_table *dev_pm_opp_set_regulator(struct device *dev, const char *name);
67 void dev_pm_opp_put_regulator(struct opp_table *opp_table);
68 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
69 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
70 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
71 void dev_pm_opp_remove_table(struct device *dev);
72 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
73 #else
74 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
75 {
76         return 0;
77 }
78
79 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
80 {
81         return 0;
82 }
83
84 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
85 {
86         return false;
87 }
88
89 static inline int dev_pm_opp_get_opp_count(struct device *dev)
90 {
91         return 0;
92 }
93
94 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
95 {
96         return 0;
97 }
98
99 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
100 {
101         return 0;
102 }
103
104 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
105 {
106         return 0;
107 }
108
109 static inline struct dev_pm_opp *dev_pm_opp_get_suspend_opp(struct device *dev)
110 {
111         return NULL;
112 }
113
114 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
115                                         unsigned long freq, bool available)
116 {
117         return ERR_PTR(-ENOTSUPP);
118 }
119
120 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
121                                         unsigned long *freq)
122 {
123         return ERR_PTR(-ENOTSUPP);
124 }
125
126 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
127                                         unsigned long *freq)
128 {
129         return ERR_PTR(-ENOTSUPP);
130 }
131
132 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
133                                         unsigned long u_volt)
134 {
135         return -ENOTSUPP;
136 }
137
138 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
139 {
140 }
141
142 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
143 {
144         return 0;
145 }
146
147 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
148 {
149         return 0;
150 }
151
152 static inline struct srcu_notifier_head *dev_pm_opp_get_notifier(
153                                                         struct device *dev)
154 {
155         return ERR_PTR(-ENOTSUPP);
156 }
157
158 static inline int dev_pm_opp_set_supported_hw(struct device *dev,
159                                               const u32 *versions,
160                                               unsigned int count)
161 {
162         return -ENOTSUPP;
163 }
164
165 static inline void dev_pm_opp_put_supported_hw(struct device *dev) {}
166
167 static inline int dev_pm_opp_set_prop_name(struct device *dev, const char *name)
168 {
169         return -ENOTSUPP;
170 }
171
172 static inline void dev_pm_opp_put_prop_name(struct device *dev) {}
173
174 static inline struct opp_table *dev_pm_opp_set_regulator(struct device *dev, const char *name)
175 {
176         return ERR_PTR(-ENOTSUPP);
177 }
178
179 static inline void dev_pm_opp_put_regulator(struct opp_table *opp_table) {}
180
181 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
182 {
183         return -ENOTSUPP;
184 }
185
186 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
187 {
188         return -ENOTSUPP;
189 }
190
191 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
192 {
193         return -EINVAL;
194 }
195
196 static inline void dev_pm_opp_remove_table(struct device *dev)
197 {
198 }
199
200 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
201 {
202 }
203
204 #endif          /* CONFIG_PM_OPP */
205
206 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
207 int dev_pm_opp_of_add_table(struct device *dev);
208 void dev_pm_opp_of_remove_table(struct device *dev);
209 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
210 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
211 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
212 #else
213 static inline int dev_pm_opp_of_add_table(struct device *dev)
214 {
215         return -ENOTSUPP;
216 }
217
218 static inline void dev_pm_opp_of_remove_table(struct device *dev)
219 {
220 }
221
222 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
223 {
224         return -ENOTSUPP;
225 }
226
227 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
228 {
229 }
230
231 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
232 {
233         return -ENOTSUPP;
234 }
235 #endif
236
237 #endif          /* __LINUX_OPP_H__ */