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
20struct clk;
21struct regulator;
22struct dev_pm_opp;
23struct device;
24struct opp_table;
25
26enum dev_pm_opp_event {
27 OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
28};
29
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
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
79#if defined(CONFIG_PM_OPP)
80
81struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
82struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index);
83void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
84
85unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
86
87unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
88
89unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
90
91bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
92
93int dev_pm_opp_get_opp_count(struct device *dev);
94unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
95unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
96unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
97unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
98
99struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
100 unsigned long freq,
101 bool available);
102
103struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
104 unsigned long *freq);
105
106struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
107 unsigned long *freq);
108void dev_pm_opp_put(struct dev_pm_opp *opp);
109
110int dev_pm_opp_add(struct device *dev, unsigned long freq,
111 unsigned long u_volt);
112void dev_pm_opp_remove(struct device *dev, unsigned long freq);
113void dev_pm_opp_remove_all_dynamic(struct device *dev);
114
115int dev_pm_opp_enable(struct device *dev, unsigned long freq);
116
117int dev_pm_opp_disable(struct device *dev, unsigned long freq);
118
119int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
120int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
121
122struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
123void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
124struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
125void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
126struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
127void dev_pm_opp_put_regulators(struct opp_table *opp_table);
128struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name);
129void dev_pm_opp_put_clkname(struct opp_table *opp_table);
130struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
131void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
132struct opp_table *dev_pm_opp_set_genpd_virt_dev(struct device *dev, struct device *virt_dev, int index);
133void dev_pm_opp_put_genpd_virt_dev(struct opp_table *opp_table, struct device *virt_dev);
134int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
135int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
136int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
137int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
138void dev_pm_opp_remove_table(struct device *dev);
139void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
140#else
141static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
142{
143 return ERR_PTR(-ENOTSUPP);
144}
145
146static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
147{
148 return ERR_PTR(-ENOTSUPP);
149}
150
151static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
152
153static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
154{
155 return 0;
156}
157
158static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
159{
160 return 0;
161}
162
163static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
164{
165 return 0;
166}
167
168static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
169{
170 return false;
171}
172
173static inline int dev_pm_opp_get_opp_count(struct device *dev)
174{
175 return 0;
176}
177
178static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
179{
180 return 0;
181}
182
183static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
184{
185 return 0;
186}
187
188static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
189{
190 return 0;
191}
192
193static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
194{
195 return 0;
196}
197
198static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
199 unsigned long freq, bool available)
200{
201 return ERR_PTR(-ENOTSUPP);
202}
203
204static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
205 unsigned long *freq)
206{
207 return ERR_PTR(-ENOTSUPP);
208}
209
210static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
211 unsigned long *freq)
212{
213 return ERR_PTR(-ENOTSUPP);
214}
215
216static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
217
218static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
219 unsigned long u_volt)
220{
221 return -ENOTSUPP;
222}
223
224static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
225{
226}
227
228static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
229{
230}
231
232static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
233{
234 return 0;
235}
236
237static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
238{
239 return 0;
240}
241
242static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
243{
244 return -ENOTSUPP;
245}
246
247static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
248{
249 return -ENOTSUPP;
250}
251
252static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
253 const u32 *versions,
254 unsigned int count)
255{
256 return ERR_PTR(-ENOTSUPP);
257}
258
259static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
260
261static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
262 int (*set_opp)(struct dev_pm_set_opp_data *data))
263{
264 return ERR_PTR(-ENOTSUPP);
265}
266
267static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
268
269static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
270{
271 return ERR_PTR(-ENOTSUPP);
272}
273
274static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
275
276static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
277{
278 return ERR_PTR(-ENOTSUPP);
279}
280
281static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
282
283static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name)
284{
285 return ERR_PTR(-ENOTSUPP);
286}
287
288static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
289
290static inline struct opp_table *dev_pm_opp_set_genpd_virt_dev(struct device *dev, struct device *virt_dev, int index)
291{
292 return ERR_PTR(-ENOTSUPP);
293}
294
295static inline void dev_pm_opp_put_genpd_virt_dev(struct opp_table *opp_table, struct device *virt_dev) {}
296
297static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
298{
299 return -ENOTSUPP;
300}
301
302static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
303{
304 return -ENOTSUPP;
305}
306
307static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
308{
309 return -ENOTSUPP;
310}
311
312static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
313{
314 return -EINVAL;
315}
316
317static inline void dev_pm_opp_remove_table(struct device *dev)
318{
319}
320
321static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
322{
323}
324
325#endif /* CONFIG_PM_OPP */
326
327#if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
328int dev_pm_opp_of_add_table(struct device *dev);
329int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
330void dev_pm_opp_of_remove_table(struct device *dev);
331int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
332void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
333int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
334struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
335struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
336int of_get_required_opp_performance_state(struct device_node *np, int index);
337void dev_pm_opp_of_register_em(struct cpumask *cpus);
338#else
339static inline int dev_pm_opp_of_add_table(struct device *dev)
340{
341 return -ENOTSUPP;
342}
343
344static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
345{
346 return -ENOTSUPP;
347}
348
349static inline void dev_pm_opp_of_remove_table(struct device *dev)
350{
351}
352
353static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
354{
355 return -ENOTSUPP;
356}
357
358static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
359{
360}
361
362static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
363{
364 return -ENOTSUPP;
365}
366
367static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
368{
369 return NULL;
370}
371
372static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
373{
374 return NULL;
375}
376
377static inline void dev_pm_opp_of_register_em(struct cpumask *cpus)
378{
379}
380
381static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
382{
383 return -ENOTSUPP;
384}
385#endif
386
387#endif /* __LINUX_OPP_H__ */
388