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