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;
96 * struct dev_pm_opp_data - The data to use to initialize an OPP.
97 * @level: The performance level for the OPP.
98 * @freq: The clock rate in Hz for the OPP.
99 * @u_volt: The voltage in uV for the OPP.
101 struct dev_pm_opp_data {
104 unsigned long u_volt;
107 #if defined(CONFIG_PM_OPP)
109 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
110 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
112 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
114 int dev_pm_opp_get_supplies(struct dev_pm_opp *opp, struct dev_pm_opp_supply *supplies);
116 unsigned long dev_pm_opp_get_power(struct dev_pm_opp *opp);
118 unsigned long dev_pm_opp_get_freq_indexed(struct dev_pm_opp *opp, u32 index);
120 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
122 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
125 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
127 int dev_pm_opp_get_opp_count(struct device *dev);
128 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
129 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
130 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
131 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
133 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
138 dev_pm_opp_find_freq_exact_indexed(struct device *dev, unsigned long freq,
139 u32 index, bool available);
141 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
142 unsigned long *freq);
144 struct dev_pm_opp *dev_pm_opp_find_freq_floor_indexed(struct device *dev,
145 unsigned long *freq, u32 index);
147 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
148 unsigned long *freq);
150 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_indexed(struct device *dev,
151 unsigned long *freq, u32 index);
153 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
156 struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
157 unsigned int *level);
159 struct dev_pm_opp *dev_pm_opp_find_level_floor(struct device *dev,
160 unsigned long *level);
162 struct dev_pm_opp *dev_pm_opp_find_bw_ceil(struct device *dev,
163 unsigned int *bw, int index);
165 struct dev_pm_opp *dev_pm_opp_find_bw_floor(struct device *dev,
166 unsigned int *bw, int index);
168 void dev_pm_opp_put(struct dev_pm_opp *opp);
170 int dev_pm_opp_add_dynamic(struct device *dev, struct dev_pm_opp_data *opp);
172 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
173 void dev_pm_opp_remove_all_dynamic(struct device *dev);
175 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
176 unsigned long u_volt, unsigned long u_volt_min,
177 unsigned long u_volt_max);
179 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
181 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
183 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
184 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
186 int dev_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config);
187 int devm_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config);
188 void dev_pm_opp_clear_config(int token);
189 int dev_pm_opp_config_clks_simple(struct device *dev,
190 struct opp_table *opp_table, struct dev_pm_opp *opp, void *data,
193 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);
194 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
195 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
196 int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp);
197 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
198 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
199 void dev_pm_opp_remove_table(struct device *dev);
200 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
201 int dev_pm_opp_sync_regulators(struct device *dev);
203 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
205 return ERR_PTR(-EOPNOTSUPP);
208 static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
210 return ERR_PTR(-EOPNOTSUPP);
213 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
215 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
220 static inline int dev_pm_opp_get_supplies(struct dev_pm_opp *opp, struct dev_pm_opp_supply *supplies)
225 static inline unsigned long dev_pm_opp_get_power(struct dev_pm_opp *opp)
230 static inline unsigned long dev_pm_opp_get_freq_indexed(struct dev_pm_opp *opp, u32 index)
235 static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
241 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
247 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
252 static inline int dev_pm_opp_get_opp_count(struct device *dev)
257 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
262 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
267 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
272 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
277 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
278 unsigned long freq, bool available)
280 return ERR_PTR(-EOPNOTSUPP);
283 static inline struct dev_pm_opp *
284 dev_pm_opp_find_freq_exact_indexed(struct device *dev, unsigned long freq,
285 u32 index, bool available)
287 return ERR_PTR(-EOPNOTSUPP);
290 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
293 return ERR_PTR(-EOPNOTSUPP);
296 static inline struct dev_pm_opp *
297 dev_pm_opp_find_freq_floor_indexed(struct device *dev, unsigned long *freq, u32 index)
299 return ERR_PTR(-EOPNOTSUPP);
302 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
305 return ERR_PTR(-EOPNOTSUPP);
308 static inline struct dev_pm_opp *
309 dev_pm_opp_find_freq_ceil_indexed(struct device *dev, unsigned long *freq, u32 index)
311 return ERR_PTR(-EOPNOTSUPP);
314 static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
317 return ERR_PTR(-EOPNOTSUPP);
320 static inline struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
323 return ERR_PTR(-EOPNOTSUPP);
326 static inline struct dev_pm_opp *dev_pm_opp_find_level_floor(struct device *dev,
327 unsigned long *level)
329 return ERR_PTR(-EOPNOTSUPP);
332 static inline struct dev_pm_opp *dev_pm_opp_find_bw_ceil(struct device *dev,
333 unsigned int *bw, int index)
335 return ERR_PTR(-EOPNOTSUPP);
338 static inline struct dev_pm_opp *dev_pm_opp_find_bw_floor(struct device *dev,
339 unsigned int *bw, int index)
341 return ERR_PTR(-EOPNOTSUPP);
344 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
347 dev_pm_opp_add_dynamic(struct device *dev, struct dev_pm_opp_data *opp)
352 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
356 static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
361 dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
362 unsigned long u_volt, unsigned long u_volt_min,
363 unsigned long u_volt_max)
368 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
373 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
378 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
383 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
388 static inline int dev_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config)
393 static inline int devm_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config)
398 static inline void dev_pm_opp_clear_config(int token) {}
400 static inline int dev_pm_opp_config_clks_simple(struct device *dev,
401 struct opp_table *opp_table, struct dev_pm_opp *opp, void *data,
407 static inline struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table,
408 struct opp_table *dst_table, struct dev_pm_opp *src_opp)
410 return ERR_PTR(-EOPNOTSUPP);
413 static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
418 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
423 static inline int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp)
428 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
433 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
438 static inline void dev_pm_opp_remove_table(struct device *dev)
442 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
446 static inline int dev_pm_opp_sync_regulators(struct device *dev)
451 #endif /* CONFIG_PM_OPP */
453 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
454 int dev_pm_opp_of_add_table(struct device *dev);
455 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
456 int devm_pm_opp_of_add_table_indexed(struct device *dev, int index);
457 void dev_pm_opp_of_remove_table(struct device *dev);
458 int devm_pm_opp_of_add_table(struct device *dev);
459 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
460 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
461 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
462 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
463 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
464 int of_get_required_opp_performance_state(struct device_node *np, int index);
465 int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table);
466 int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus);
467 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
469 em_dev_unregister_perf_domain(dev);
472 static inline int dev_pm_opp_of_add_table(struct device *dev)
477 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
482 static inline int devm_pm_opp_of_add_table_indexed(struct device *dev, int index)
487 static inline void dev_pm_opp_of_remove_table(struct device *dev)
491 static inline int devm_pm_opp_of_add_table(struct device *dev)
496 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
501 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
505 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
510 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
515 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
520 static inline int dev_pm_opp_of_register_em(struct device *dev,
521 struct cpumask *cpus)
526 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
530 static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
535 static inline int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table)
541 /* OPP Configuration helpers */
543 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
544 unsigned long u_volt)
546 struct dev_pm_opp_data data = {
551 return dev_pm_opp_add_dynamic(dev, &data);
554 /* Regulators helpers */
555 static inline int dev_pm_opp_set_regulators(struct device *dev,
556 const char * const names[])
558 struct dev_pm_opp_config config = {
559 .regulator_names = names,
562 return dev_pm_opp_set_config(dev, &config);
565 static inline void dev_pm_opp_put_regulators(int token)
567 dev_pm_opp_clear_config(token);
570 static inline int devm_pm_opp_set_regulators(struct device *dev,
571 const char * const names[])
573 struct dev_pm_opp_config config = {
574 .regulator_names = names,
577 return devm_pm_opp_set_config(dev, &config);
580 /* Supported-hw helpers */
581 static inline int dev_pm_opp_set_supported_hw(struct device *dev,
585 struct dev_pm_opp_config config = {
586 .supported_hw = versions,
587 .supported_hw_count = count,
590 return dev_pm_opp_set_config(dev, &config);
593 static inline void dev_pm_opp_put_supported_hw(int token)
595 dev_pm_opp_clear_config(token);
598 static inline int devm_pm_opp_set_supported_hw(struct device *dev,
602 struct dev_pm_opp_config config = {
603 .supported_hw = versions,
604 .supported_hw_count = count,
607 return devm_pm_opp_set_config(dev, &config);
610 /* clkname helpers */
611 static inline int dev_pm_opp_set_clkname(struct device *dev, const char *name)
613 const char *names[] = { name, NULL };
614 struct dev_pm_opp_config config = {
618 return dev_pm_opp_set_config(dev, &config);
621 static inline void dev_pm_opp_put_clkname(int token)
623 dev_pm_opp_clear_config(token);
626 static inline int devm_pm_opp_set_clkname(struct device *dev, const char *name)
628 const char *names[] = { name, NULL };
629 struct dev_pm_opp_config config = {
633 return devm_pm_opp_set_config(dev, &config);
636 /* config-regulators helpers */
637 static inline int dev_pm_opp_set_config_regulators(struct device *dev,
638 config_regulators_t helper)
640 struct dev_pm_opp_config config = {
641 .config_regulators = helper,
644 return dev_pm_opp_set_config(dev, &config);
647 static inline void dev_pm_opp_put_config_regulators(int token)
649 dev_pm_opp_clear_config(token);
653 static inline int dev_pm_opp_attach_genpd(struct device *dev,
654 const char * const *names,
655 struct device ***virt_devs)
657 struct dev_pm_opp_config config = {
658 .genpd_names = names,
659 .virt_devs = virt_devs,
662 return dev_pm_opp_set_config(dev, &config);
665 static inline void dev_pm_opp_detach_genpd(int token)
667 dev_pm_opp_clear_config(token);
670 static inline int devm_pm_opp_attach_genpd(struct device *dev,
671 const char * const *names,
672 struct device ***virt_devs)
674 struct dev_pm_opp_config config = {
675 .genpd_names = names,
676 .virt_devs = virt_devs,
679 return devm_pm_opp_set_config(dev, &config);
682 /* prop-name helpers */
683 static inline int dev_pm_opp_set_prop_name(struct device *dev, const char *name)
685 struct dev_pm_opp_config config = {
689 return dev_pm_opp_set_config(dev, &config);
692 static inline void dev_pm_opp_put_prop_name(int token)
694 dev_pm_opp_clear_config(token);
697 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
699 return dev_pm_opp_get_freq_indexed(opp, 0);
702 #endif /* __LINUX_OPP_H__ */