1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Generic OPP Interface
5 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
11 #ifndef __LINUX_OPP_H__
12 #define __LINUX_OPP_H__
14 #include <linux/energy_model.h>
15 #include <linux/err.h>
16 #include <linux/notifier.h>
24 enum dev_pm_opp_event {
25 OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
26 OPP_EVENT_ADJUST_VOLTAGE,
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 * @u_watt: Power used by the device in microwatts
37 * This structure stores the voltage/current/power values for a single power
40 struct dev_pm_opp_supply {
42 unsigned long u_volt_min;
43 unsigned long u_volt_max;
49 * struct dev_pm_opp_icc_bw - Interconnect bandwidth values
50 * @avg: Average bandwidth corresponding to this OPP (in icc units)
51 * @peak: Peak bandwidth corresponding to this OPP (in icc units)
53 * This structure stores the bandwidth values for a single interconnect path.
55 struct dev_pm_opp_icc_bw {
60 typedef int (*config_regulators_t)(struct device *dev,
61 struct dev_pm_opp *old_opp, struct dev_pm_opp *new_opp,
62 struct regulator **regulators, unsigned int count);
64 typedef int (*config_clks_t)(struct device *dev, struct opp_table *opp_table,
65 struct dev_pm_opp *opp, void *data, bool scaling_down);
68 * struct dev_pm_opp_config - Device OPP configuration values
69 * @clk_names: Clk names, NULL terminated array.
70 * @config_clks: Custom set clk helper.
71 * @prop_name: Name to postfix to properties.
72 * @config_regulators: Custom set regulator helper.
73 * @supported_hw: Array of hierarchy of versions to match.
74 * @supported_hw_count: Number of elements in the array.
75 * @regulator_names: Array of pointers to the names of the regulator, NULL terminated.
76 * @genpd_names: Null terminated array of pointers containing names of genpd to
78 * @virt_devs: Pointer to return the array of virtual devices.
80 * This structure contains platform specific OPP configurations for the device.
82 struct dev_pm_opp_config {
84 const char * const *clk_names;
85 config_clks_t config_clks;
86 const char *prop_name;
87 config_regulators_t config_regulators;
88 const unsigned int *supported_hw;
89 unsigned int supported_hw_count;
90 const char * const *regulator_names;
91 const char * const *genpd_names;
92 struct device ***virt_devs;
95 #if defined(CONFIG_PM_OPP)
97 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
98 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
100 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
102 int dev_pm_opp_get_supplies(struct dev_pm_opp *opp, struct dev_pm_opp_supply *supplies);
104 unsigned long dev_pm_opp_get_power(struct dev_pm_opp *opp);
106 unsigned long dev_pm_opp_get_freq_indexed(struct dev_pm_opp *opp, u32 index);
108 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
110 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
113 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
115 int dev_pm_opp_get_opp_count(struct device *dev);
116 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
117 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
118 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
119 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
121 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
126 dev_pm_opp_find_freq_exact_indexed(struct device *dev, unsigned long freq,
127 u32 index, bool available);
129 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
130 unsigned long *freq);
132 struct dev_pm_opp *dev_pm_opp_find_freq_floor_indexed(struct device *dev,
133 unsigned long *freq, u32 index);
135 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
136 unsigned long *freq);
138 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_indexed(struct device *dev,
139 unsigned long *freq, u32 index);
141 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
144 struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
145 unsigned int *level);
147 struct dev_pm_opp *dev_pm_opp_find_bw_ceil(struct device *dev,
148 unsigned int *bw, int index);
150 struct dev_pm_opp *dev_pm_opp_find_bw_floor(struct device *dev,
151 unsigned int *bw, int index);
153 void dev_pm_opp_put(struct dev_pm_opp *opp);
155 int dev_pm_opp_add(struct device *dev, unsigned long freq,
156 unsigned long u_volt);
157 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
158 void dev_pm_opp_remove_all_dynamic(struct device *dev);
160 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
161 unsigned long u_volt, unsigned long u_volt_min,
162 unsigned long u_volt_max);
164 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
166 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
168 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
169 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
171 int dev_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config);
172 int devm_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config);
173 void dev_pm_opp_clear_config(int token);
174 int dev_pm_opp_config_clks_simple(struct device *dev,
175 struct opp_table *opp_table, struct dev_pm_opp *opp, void *data,
178 struct 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);
179 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
180 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
181 int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp);
182 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
183 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
184 void dev_pm_opp_remove_table(struct device *dev);
185 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
186 int dev_pm_opp_sync_regulators(struct device *dev);
188 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
190 return ERR_PTR(-EOPNOTSUPP);
193 static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
195 return ERR_PTR(-EOPNOTSUPP);
198 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
200 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
205 static inline int dev_pm_opp_get_supplies(struct dev_pm_opp *opp, struct dev_pm_opp_supply *supplies)
210 static inline unsigned long dev_pm_opp_get_power(struct dev_pm_opp *opp)
215 static inline unsigned long dev_pm_opp_get_freq_indexed(struct dev_pm_opp *opp, u32 index)
220 static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
226 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
232 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
237 static inline int dev_pm_opp_get_opp_count(struct device *dev)
242 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
247 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
252 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
257 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
262 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
263 unsigned long freq, bool available)
265 return ERR_PTR(-EOPNOTSUPP);
268 static inline struct dev_pm_opp *
269 dev_pm_opp_find_freq_exact_indexed(struct device *dev, unsigned long freq,
270 u32 index, bool available)
272 return ERR_PTR(-EOPNOTSUPP);
275 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
278 return ERR_PTR(-EOPNOTSUPP);
281 static inline struct dev_pm_opp *
282 dev_pm_opp_find_freq_floor_indexed(struct device *dev, unsigned long *freq, u32 index)
284 return ERR_PTR(-EOPNOTSUPP);
287 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
290 return ERR_PTR(-EOPNOTSUPP);
293 static inline struct dev_pm_opp *
294 dev_pm_opp_find_freq_ceil_indexed(struct device *dev, unsigned long *freq, u32 index)
296 return ERR_PTR(-EOPNOTSUPP);
299 static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
302 return ERR_PTR(-EOPNOTSUPP);
305 static inline struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
308 return ERR_PTR(-EOPNOTSUPP);
311 static inline struct dev_pm_opp *dev_pm_opp_find_bw_ceil(struct device *dev,
312 unsigned int *bw, int index)
314 return ERR_PTR(-EOPNOTSUPP);
317 static inline struct dev_pm_opp *dev_pm_opp_find_bw_floor(struct device *dev,
318 unsigned int *bw, int index)
320 return ERR_PTR(-EOPNOTSUPP);
323 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
325 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
326 unsigned long u_volt)
331 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
335 static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
340 dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
341 unsigned long u_volt, unsigned long u_volt_min,
342 unsigned long u_volt_max)
347 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
352 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
357 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
362 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
367 static inline int dev_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config)
372 static inline int devm_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config)
377 static inline void dev_pm_opp_clear_config(int token) {}
379 static inline int dev_pm_opp_config_clks_simple(struct device *dev,
380 struct opp_table *opp_table, struct dev_pm_opp *opp, void *data,
386 static inline struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table,
387 struct opp_table *dst_table, struct dev_pm_opp *src_opp)
389 return ERR_PTR(-EOPNOTSUPP);
392 static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
397 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
402 static inline int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp)
407 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
412 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
417 static inline void dev_pm_opp_remove_table(struct device *dev)
421 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
425 static inline int dev_pm_opp_sync_regulators(struct device *dev)
430 #endif /* CONFIG_PM_OPP */
432 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
433 int dev_pm_opp_of_add_table(struct device *dev);
434 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
435 int devm_pm_opp_of_add_table_indexed(struct device *dev, int index);
436 void dev_pm_opp_of_remove_table(struct device *dev);
437 int devm_pm_opp_of_add_table(struct device *dev);
438 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
439 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
440 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
441 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
442 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
443 int of_get_required_opp_performance_state(struct device_node *np, int index);
444 int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table);
445 int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus);
446 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
448 em_dev_unregister_perf_domain(dev);
451 static inline int dev_pm_opp_of_add_table(struct device *dev)
456 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
461 static inline int devm_pm_opp_of_add_table_indexed(struct device *dev, int index)
466 static inline void dev_pm_opp_of_remove_table(struct device *dev)
470 static inline int devm_pm_opp_of_add_table(struct device *dev)
475 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
480 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
484 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
489 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
494 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
499 static inline int dev_pm_opp_of_register_em(struct device *dev,
500 struct cpumask *cpus)
505 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
509 static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
514 static inline int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table)
520 /* OPP Configuration helpers */
522 /* Regulators helpers */
523 static inline int dev_pm_opp_set_regulators(struct device *dev,
524 const char * const names[])
526 struct dev_pm_opp_config config = {
527 .regulator_names = names,
530 return dev_pm_opp_set_config(dev, &config);
533 static inline void dev_pm_opp_put_regulators(int token)
535 dev_pm_opp_clear_config(token);
538 static inline int devm_pm_opp_set_regulators(struct device *dev,
539 const char * const names[])
541 struct dev_pm_opp_config config = {
542 .regulator_names = names,
545 return devm_pm_opp_set_config(dev, &config);
548 /* Supported-hw helpers */
549 static inline int dev_pm_opp_set_supported_hw(struct device *dev,
553 struct dev_pm_opp_config config = {
554 .supported_hw = versions,
555 .supported_hw_count = count,
558 return dev_pm_opp_set_config(dev, &config);
561 static inline void dev_pm_opp_put_supported_hw(int token)
563 dev_pm_opp_clear_config(token);
566 static inline int devm_pm_opp_set_supported_hw(struct device *dev,
570 struct dev_pm_opp_config config = {
571 .supported_hw = versions,
572 .supported_hw_count = count,
575 return devm_pm_opp_set_config(dev, &config);
578 /* clkname helpers */
579 static inline int dev_pm_opp_set_clkname(struct device *dev, const char *name)
581 const char *names[] = { name, NULL };
582 struct dev_pm_opp_config config = {
586 return dev_pm_opp_set_config(dev, &config);
589 static inline void dev_pm_opp_put_clkname(int token)
591 dev_pm_opp_clear_config(token);
594 static inline int devm_pm_opp_set_clkname(struct device *dev, const char *name)
596 const char *names[] = { name, NULL };
597 struct dev_pm_opp_config config = {
601 return devm_pm_opp_set_config(dev, &config);
604 /* config-regulators helpers */
605 static inline int dev_pm_opp_set_config_regulators(struct device *dev,
606 config_regulators_t helper)
608 struct dev_pm_opp_config config = {
609 .config_regulators = helper,
612 return dev_pm_opp_set_config(dev, &config);
615 static inline void dev_pm_opp_put_config_regulators(int token)
617 dev_pm_opp_clear_config(token);
621 static inline int dev_pm_opp_attach_genpd(struct device *dev,
622 const char * const *names,
623 struct device ***virt_devs)
625 struct dev_pm_opp_config config = {
626 .genpd_names = names,
627 .virt_devs = virt_devs,
630 return dev_pm_opp_set_config(dev, &config);
633 static inline void dev_pm_opp_detach_genpd(int token)
635 dev_pm_opp_clear_config(token);
638 static inline int devm_pm_opp_attach_genpd(struct device *dev,
639 const char * const *names,
640 struct device ***virt_devs)
642 struct dev_pm_opp_config config = {
643 .genpd_names = names,
644 .virt_devs = virt_devs,
647 return devm_pm_opp_set_config(dev, &config);
650 /* prop-name helpers */
651 static inline int dev_pm_opp_set_prop_name(struct device *dev, const char *name)
653 struct dev_pm_opp_config config = {
657 return dev_pm_opp_set_config(dev, &config);
660 static inline void dev_pm_opp_put_prop_name(int token)
662 dev_pm_opp_clear_config(token);
665 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
667 return dev_pm_opp_get_freq_indexed(opp, 0);
670 #endif /* __LINUX_OPP_H__ */