Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Generic OPP Interface
4 *
5 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
6 * Nishanth Menon
7 * Romit Dasgupta
8 * Kevin Hilman
9 */
10
11#ifndef __LINUX_OPP_H__
12#define __LINUX_OPP_H__
13
14#include <linux/energy_model.h>
15#include <linux/err.h>
16#include <linux/notifier.h>
17
18struct clk;
19struct regulator;
20struct dev_pm_opp;
21struct device;
22struct opp_table;
23
24enum dev_pm_opp_event {
25 OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
26 OPP_EVENT_ADJUST_VOLTAGE,
27};
28
29/**
30 * struct dev_pm_opp_supply - Power supply voltage/current values
31 * @u_volt: Target voltage in microvolts corresponding to this OPP
32 * @u_volt_min: Minimum voltage in microvolts corresponding to this OPP
33 * @u_volt_max: Maximum voltage in microvolts corresponding to this OPP
34 * @u_amp: Maximum current drawn by the device in microamperes
35 *
36 * This structure stores the voltage/current values for a single power supply.
37 */
38struct dev_pm_opp_supply {
39 unsigned long u_volt;
40 unsigned long u_volt_min;
41 unsigned long u_volt_max;
42 unsigned long u_amp;
43};
44
45/**
46 * struct dev_pm_opp_icc_bw - Interconnect bandwidth values
47 * @avg: Average bandwidth corresponding to this OPP (in icc units)
48 * @peak: Peak bandwidth corresponding to this OPP (in icc units)
49 *
50 * This structure stores the bandwidth values for a single interconnect path.
51 */
52struct dev_pm_opp_icc_bw {
53 u32 avg;
54 u32 peak;
55};
56
57/**
58 * struct dev_pm_opp_info - OPP freq/voltage/current values
59 * @rate: Target clk rate in hz
60 * @supplies: Array of voltage/current values for all power supplies
61 *
62 * This structure stores the freq/voltage/current values for a single OPP.
63 */
64struct dev_pm_opp_info {
65 unsigned long rate;
66 struct dev_pm_opp_supply *supplies;
67};
68
69/**
70 * struct dev_pm_set_opp_data - Set OPP data
71 * @old_opp: Old OPP info
72 * @new_opp: New OPP info
73 * @regulators: Array of regulator pointers
74 * @regulator_count: Number of regulators
75 * @clk: Pointer to clk
76 * @dev: Pointer to the struct device
77 *
78 * This structure contains all information required for setting an OPP.
79 */
80struct dev_pm_set_opp_data {
81 struct dev_pm_opp_info old_opp;
82 struct dev_pm_opp_info new_opp;
83
84 struct regulator **regulators;
85 unsigned int regulator_count;
86 struct clk *clk;
87 struct device *dev;
88};
89
90#if defined(CONFIG_PM_OPP)
91
92struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
93void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
94
95unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
96
97unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
98
99unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
100
101unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
102 unsigned int index);
103
104bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
105
106int dev_pm_opp_get_opp_count(struct device *dev);
107unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
108unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
109unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
110unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
111
112struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
113 unsigned long freq,
114 bool available);
115struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
116 unsigned int level);
117struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
118 unsigned int *level);
119
120struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
121 unsigned long *freq);
122struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
123 unsigned long u_volt);
124
125struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
126 unsigned long *freq);
127void dev_pm_opp_put(struct dev_pm_opp *opp);
128
129int dev_pm_opp_add(struct device *dev, unsigned long freq,
130 unsigned long u_volt);
131void dev_pm_opp_remove(struct device *dev, unsigned long freq);
132void dev_pm_opp_remove_all_dynamic(struct device *dev);
133
134int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
135 unsigned long u_volt, unsigned long u_volt_min,
136 unsigned long u_volt_max);
137
138int dev_pm_opp_enable(struct device *dev, unsigned long freq);
139
140int dev_pm_opp_disable(struct device *dev, unsigned long freq);
141
142int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
143int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
144
145struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
146void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
147struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
148void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
149struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
150void dev_pm_opp_put_regulators(struct opp_table *opp_table);
151struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name);
152void dev_pm_opp_put_clkname(struct opp_table *opp_table);
153struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
154void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
155struct opp_table *devm_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
156struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs);
157void dev_pm_opp_detach_genpd(struct opp_table *opp_table);
158struct opp_table *devm_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs);
159struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table, struct opp_table *dst_table, struct dev_pm_opp *src_opp);
160int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
161int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
162int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp);
163int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
164int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
165void dev_pm_opp_remove_table(struct device *dev);
166void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
167int dev_pm_opp_sync_regulators(struct device *dev);
168#else
169static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
170{
171 return ERR_PTR(-EOPNOTSUPP);
172}
173
174static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
175{
176 return ERR_PTR(-EOPNOTSUPP);
177}
178
179static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
180
181static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
182{
183 return 0;
184}
185
186static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
187{
188 return 0;
189}
190
191static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
192{
193 return 0;
194}
195
196static inline
197unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
198 unsigned int index)
199{
200 return 0;
201}
202
203static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
204{
205 return false;
206}
207
208static inline int dev_pm_opp_get_opp_count(struct device *dev)
209{
210 return 0;
211}
212
213static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
214{
215 return 0;
216}
217
218static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
219{
220 return 0;
221}
222
223static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
224{
225 return 0;
226}
227
228static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
229{
230 return 0;
231}
232
233static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
234 unsigned long freq, bool available)
235{
236 return ERR_PTR(-EOPNOTSUPP);
237}
238
239static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
240 unsigned int level)
241{
242 return ERR_PTR(-EOPNOTSUPP);
243}
244
245static inline struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
246 unsigned int *level)
247{
248 return ERR_PTR(-EOPNOTSUPP);
249}
250
251static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
252 unsigned long *freq)
253{
254 return ERR_PTR(-EOPNOTSUPP);
255}
256
257static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
258 unsigned long u_volt)
259{
260 return ERR_PTR(-EOPNOTSUPP);
261}
262
263static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
264 unsigned long *freq)
265{
266 return ERR_PTR(-EOPNOTSUPP);
267}
268
269static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
270
271static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
272 unsigned long u_volt)
273{
274 return -EOPNOTSUPP;
275}
276
277static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
278{
279}
280
281static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
282{
283}
284
285static inline int
286dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
287 unsigned long u_volt, unsigned long u_volt_min,
288 unsigned long u_volt_max)
289{
290 return 0;
291}
292
293static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
294{
295 return 0;
296}
297
298static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
299{
300 return 0;
301}
302
303static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
304{
305 return -EOPNOTSUPP;
306}
307
308static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
309{
310 return -EOPNOTSUPP;
311}
312
313static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
314 const u32 *versions,
315 unsigned int count)
316{
317 return ERR_PTR(-EOPNOTSUPP);
318}
319
320static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
321
322static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
323 int (*set_opp)(struct dev_pm_set_opp_data *data))
324{
325 return ERR_PTR(-EOPNOTSUPP);
326}
327
328static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
329
330static inline struct opp_table *
331devm_pm_opp_register_set_opp_helper(struct device *dev,
332 int (*set_opp)(struct dev_pm_set_opp_data *data))
333{
334 return ERR_PTR(-EOPNOTSUPP);
335}
336
337static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
338{
339 return ERR_PTR(-EOPNOTSUPP);
340}
341
342static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
343
344static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
345{
346 return ERR_PTR(-EOPNOTSUPP);
347}
348
349static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
350
351static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
352{
353 return ERR_PTR(-EOPNOTSUPP);
354}
355
356static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
357
358static inline struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs)
359{
360 return ERR_PTR(-EOPNOTSUPP);
361}
362
363static inline void dev_pm_opp_detach_genpd(struct opp_table *opp_table) {}
364
365static inline struct opp_table *devm_pm_opp_attach_genpd(struct device *dev,
366 const char **names, struct device ***virt_devs)
367{
368 return ERR_PTR(-EOPNOTSUPP);
369}
370
371static inline struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table,
372 struct opp_table *dst_table, struct dev_pm_opp *src_opp)
373{
374 return ERR_PTR(-EOPNOTSUPP);
375}
376
377static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
378{
379 return -EOPNOTSUPP;
380}
381
382static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
383{
384 return -EOPNOTSUPP;
385}
386
387static inline int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp)
388{
389 return -EOPNOTSUPP;
390}
391
392static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
393{
394 return -EOPNOTSUPP;
395}
396
397static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
398{
399 return -EINVAL;
400}
401
402static inline void dev_pm_opp_remove_table(struct device *dev)
403{
404}
405
406static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
407{
408}
409
410static inline int dev_pm_opp_sync_regulators(struct device *dev)
411{
412 return -EOPNOTSUPP;
413}
414
415#endif /* CONFIG_PM_OPP */
416
417#if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
418int dev_pm_opp_of_add_table(struct device *dev);
419int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
420int dev_pm_opp_of_add_table_noclk(struct device *dev, int index);
421void dev_pm_opp_of_remove_table(struct device *dev);
422int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
423void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
424int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
425struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
426struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
427int of_get_required_opp_performance_state(struct device_node *np, int index);
428int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table);
429int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus);
430static inline void dev_pm_opp_of_unregister_em(struct device *dev)
431{
432 em_dev_unregister_perf_domain(dev);
433}
434#else
435static inline int dev_pm_opp_of_add_table(struct device *dev)
436{
437 return -EOPNOTSUPP;
438}
439
440static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
441{
442 return -EOPNOTSUPP;
443}
444
445static inline int dev_pm_opp_of_add_table_noclk(struct device *dev, int index)
446{
447 return -EOPNOTSUPP;
448}
449
450static inline void dev_pm_opp_of_remove_table(struct device *dev)
451{
452}
453
454static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
455{
456 return -EOPNOTSUPP;
457}
458
459static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
460{
461}
462
463static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
464{
465 return -EOPNOTSUPP;
466}
467
468static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
469{
470 return NULL;
471}
472
473static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
474{
475 return NULL;
476}
477
478static inline int dev_pm_opp_of_register_em(struct device *dev,
479 struct cpumask *cpus)
480{
481 return -EOPNOTSUPP;
482}
483
484static inline void dev_pm_opp_of_unregister_em(struct device *dev)
485{
486}
487
488static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
489{
490 return -EOPNOTSUPP;
491}
492
493static inline int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table)
494{
495 return -EOPNOTSUPP;
496}
497#endif
498
499#endif /* __LINUX_OPP_H__ */