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;
48 typedef int (*config_regulators_t)(struct device *dev,
49 struct dev_pm_opp *old_opp, struct dev_pm_opp *new_opp,
50 struct regulator **regulators, unsigned int count);
52 typedef int (*config_clks_t)(struct device *dev, struct opp_table *opp_table,
53 struct dev_pm_opp *opp, void *data, bool scaling_down);
56 * struct dev_pm_opp_config - Device OPP configuration values
57 * @clk_names: Clk names, NULL terminated array.
58 * @config_clks: Custom set clk helper.
59 * @prop_name: Name to postfix to properties.
60 * @config_regulators: Custom set regulator helper.
61 * @supported_hw: Array of hierarchy of versions to match.
62 * @supported_hw_count: Number of elements in the array.
63 * @regulator_names: Array of pointers to the names of the regulator, NULL terminated.
64 * @genpd_names: Null terminated array of pointers containing names of genpd to
65 * attach. Mutually exclusive with required_devs.
66 * @virt_devs: Pointer to return the array of genpd virtual devices. Mutually
67 * exclusive with required_devs.
68 * @required_devs: Required OPP devices. Mutually exclusive with genpd_names/virt_devs.
70 * This structure contains platform specific OPP configurations for the device.
72 struct dev_pm_opp_config {
74 const char * const *clk_names;
75 config_clks_t config_clks;
76 const char *prop_name;
77 config_regulators_t config_regulators;
78 const unsigned int *supported_hw;
79 unsigned int supported_hw_count;
80 const char * const *regulator_names;
81 const char * const *genpd_names;
82 struct device ***virt_devs;
83 struct device **required_devs;
86 #define OPP_LEVEL_UNSET U32_MAX
89 * struct dev_pm_opp_data - The data to use to initialize an OPP.
90 * @level: The performance level for the OPP. Set level to OPP_LEVEL_UNSET if
91 * level field isn't used.
92 * @freq: The clock rate in Hz for the OPP.
93 * @u_volt: The voltage in uV for the OPP.
95 struct dev_pm_opp_data {
101 #if defined(CONFIG_PM_OPP)
103 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
104 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
106 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
108 int dev_pm_opp_get_supplies(struct dev_pm_opp *opp, struct dev_pm_opp_supply *supplies);
110 unsigned long dev_pm_opp_get_power(struct dev_pm_opp *opp);
112 unsigned long dev_pm_opp_get_freq_indexed(struct dev_pm_opp *opp, u32 index);
114 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
116 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
119 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
121 int dev_pm_opp_get_opp_count(struct device *dev);
122 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
123 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
124 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
125 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
127 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
132 dev_pm_opp_find_freq_exact_indexed(struct device *dev, unsigned long freq,
133 u32 index, bool available);
135 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
136 unsigned long *freq);
138 struct dev_pm_opp *dev_pm_opp_find_freq_floor_indexed(struct device *dev,
139 unsigned long *freq, u32 index);
141 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
142 unsigned long *freq);
144 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_indexed(struct device *dev,
145 unsigned long *freq, u32 index);
147 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
150 struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
151 unsigned int *level);
153 struct dev_pm_opp *dev_pm_opp_find_level_floor(struct device *dev,
154 unsigned int *level);
156 struct dev_pm_opp *dev_pm_opp_find_bw_ceil(struct device *dev,
157 unsigned int *bw, int index);
159 struct dev_pm_opp *dev_pm_opp_find_bw_floor(struct device *dev,
160 unsigned int *bw, int index);
162 void dev_pm_opp_put(struct dev_pm_opp *opp);
164 int dev_pm_opp_add_dynamic(struct device *dev, struct dev_pm_opp_data *opp);
166 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
167 void dev_pm_opp_remove_all_dynamic(struct device *dev);
169 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
170 unsigned long u_volt, unsigned long u_volt_min,
171 unsigned long u_volt_max);
173 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
175 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
177 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
178 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
180 int dev_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config);
181 int devm_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config);
182 void dev_pm_opp_clear_config(int token);
183 int dev_pm_opp_config_clks_simple(struct device *dev,
184 struct opp_table *opp_table, struct dev_pm_opp *opp, void *data,
187 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);
188 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
189 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
190 int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp);
191 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
192 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
193 void dev_pm_opp_remove_table(struct device *dev);
194 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
195 int dev_pm_opp_sync_regulators(struct device *dev);
197 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
199 return ERR_PTR(-EOPNOTSUPP);
202 static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
204 return ERR_PTR(-EOPNOTSUPP);
207 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
209 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
214 static inline int dev_pm_opp_get_supplies(struct dev_pm_opp *opp, struct dev_pm_opp_supply *supplies)
219 static inline unsigned long dev_pm_opp_get_power(struct dev_pm_opp *opp)
224 static inline unsigned long dev_pm_opp_get_freq_indexed(struct dev_pm_opp *opp, u32 index)
229 static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
235 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
241 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
246 static inline int dev_pm_opp_get_opp_count(struct device *dev)
251 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
256 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
261 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
266 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
271 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
272 unsigned long freq, bool available)
274 return ERR_PTR(-EOPNOTSUPP);
277 static inline struct dev_pm_opp *
278 dev_pm_opp_find_freq_exact_indexed(struct device *dev, unsigned long freq,
279 u32 index, bool available)
281 return ERR_PTR(-EOPNOTSUPP);
284 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
287 return ERR_PTR(-EOPNOTSUPP);
290 static inline struct dev_pm_opp *
291 dev_pm_opp_find_freq_floor_indexed(struct device *dev, unsigned long *freq, u32 index)
293 return ERR_PTR(-EOPNOTSUPP);
296 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
299 return ERR_PTR(-EOPNOTSUPP);
302 static inline struct dev_pm_opp *
303 dev_pm_opp_find_freq_ceil_indexed(struct device *dev, unsigned long *freq, u32 index)
305 return ERR_PTR(-EOPNOTSUPP);
308 static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
311 return ERR_PTR(-EOPNOTSUPP);
314 static inline struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
317 return ERR_PTR(-EOPNOTSUPP);
320 static inline struct dev_pm_opp *dev_pm_opp_find_level_floor(struct device *dev,
323 return ERR_PTR(-EOPNOTSUPP);
326 static inline struct dev_pm_opp *dev_pm_opp_find_bw_ceil(struct device *dev,
327 unsigned int *bw, int index)
329 return ERR_PTR(-EOPNOTSUPP);
332 static inline struct dev_pm_opp *dev_pm_opp_find_bw_floor(struct device *dev,
333 unsigned int *bw, int index)
335 return ERR_PTR(-EOPNOTSUPP);
338 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
341 dev_pm_opp_add_dynamic(struct device *dev, struct dev_pm_opp_data *opp)
346 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
350 static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
355 dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
356 unsigned long u_volt, unsigned long u_volt_min,
357 unsigned long u_volt_max)
362 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
367 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
372 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
377 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
382 static inline int dev_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config)
387 static inline int devm_pm_opp_set_config(struct device *dev, struct dev_pm_opp_config *config)
392 static inline void dev_pm_opp_clear_config(int token) {}
394 static inline int dev_pm_opp_config_clks_simple(struct device *dev,
395 struct opp_table *opp_table, struct dev_pm_opp *opp, void *data,
401 static inline struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table,
402 struct opp_table *dst_table, struct dev_pm_opp *src_opp)
404 return ERR_PTR(-EOPNOTSUPP);
407 static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
412 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
417 static inline int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp)
422 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
427 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
432 static inline void dev_pm_opp_remove_table(struct device *dev)
436 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
440 static inline int dev_pm_opp_sync_regulators(struct device *dev)
445 #endif /* CONFIG_PM_OPP */
447 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
448 int dev_pm_opp_of_add_table(struct device *dev);
449 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
450 int devm_pm_opp_of_add_table_indexed(struct device *dev, int index);
451 void dev_pm_opp_of_remove_table(struct device *dev);
452 int devm_pm_opp_of_add_table(struct device *dev);
453 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
454 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
455 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
456 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
457 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
458 int of_get_required_opp_performance_state(struct device_node *np, int index);
459 int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table);
460 int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus);
461 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
463 em_dev_unregister_perf_domain(dev);
466 static inline int dev_pm_opp_of_add_table(struct device *dev)
471 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
476 static inline int devm_pm_opp_of_add_table_indexed(struct device *dev, int index)
481 static inline void dev_pm_opp_of_remove_table(struct device *dev)
485 static inline int devm_pm_opp_of_add_table(struct device *dev)
490 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
495 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
499 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
504 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
509 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
514 static inline int dev_pm_opp_of_register_em(struct device *dev,
515 struct cpumask *cpus)
520 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
524 static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
529 static inline int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table)
535 /* OPP Configuration helpers */
537 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
538 unsigned long u_volt)
540 struct dev_pm_opp_data data = {
545 return dev_pm_opp_add_dynamic(dev, &data);
548 /* Regulators helpers */
549 static inline int dev_pm_opp_set_regulators(struct device *dev,
550 const char * const names[])
552 struct dev_pm_opp_config config = {
553 .regulator_names = names,
556 return dev_pm_opp_set_config(dev, &config);
559 static inline void dev_pm_opp_put_regulators(int token)
561 dev_pm_opp_clear_config(token);
564 static inline int devm_pm_opp_set_regulators(struct device *dev,
565 const char * const names[])
567 struct dev_pm_opp_config config = {
568 .regulator_names = names,
571 return devm_pm_opp_set_config(dev, &config);
574 /* Supported-hw helpers */
575 static inline int dev_pm_opp_set_supported_hw(struct device *dev,
579 struct dev_pm_opp_config config = {
580 .supported_hw = versions,
581 .supported_hw_count = count,
584 return dev_pm_opp_set_config(dev, &config);
587 static inline void dev_pm_opp_put_supported_hw(int token)
589 dev_pm_opp_clear_config(token);
592 static inline int devm_pm_opp_set_supported_hw(struct device *dev,
596 struct dev_pm_opp_config config = {
597 .supported_hw = versions,
598 .supported_hw_count = count,
601 return devm_pm_opp_set_config(dev, &config);
604 /* clkname helpers */
605 static inline int dev_pm_opp_set_clkname(struct device *dev, const char *name)
607 const char *names[] = { name, NULL };
608 struct dev_pm_opp_config config = {
612 return dev_pm_opp_set_config(dev, &config);
615 static inline void dev_pm_opp_put_clkname(int token)
617 dev_pm_opp_clear_config(token);
620 static inline int devm_pm_opp_set_clkname(struct device *dev, const char *name)
622 const char *names[] = { name, NULL };
623 struct dev_pm_opp_config config = {
627 return devm_pm_opp_set_config(dev, &config);
630 /* config-regulators helpers */
631 static inline int dev_pm_opp_set_config_regulators(struct device *dev,
632 config_regulators_t helper)
634 struct dev_pm_opp_config config = {
635 .config_regulators = helper,
638 return dev_pm_opp_set_config(dev, &config);
641 static inline void dev_pm_opp_put_config_regulators(int token)
643 dev_pm_opp_clear_config(token);
647 static inline int dev_pm_opp_attach_genpd(struct device *dev,
648 const char * const *names,
649 struct device ***virt_devs)
651 struct dev_pm_opp_config config = {
652 .genpd_names = names,
653 .virt_devs = virt_devs,
656 return dev_pm_opp_set_config(dev, &config);
659 static inline void dev_pm_opp_detach_genpd(int token)
661 dev_pm_opp_clear_config(token);
664 static inline int devm_pm_opp_attach_genpd(struct device *dev,
665 const char * const *names,
666 struct device ***virt_devs)
668 struct dev_pm_opp_config config = {
669 .genpd_names = names,
670 .virt_devs = virt_devs,
673 return devm_pm_opp_set_config(dev, &config);
676 /* prop-name helpers */
677 static inline int dev_pm_opp_set_prop_name(struct device *dev, const char *name)
679 struct dev_pm_opp_config config = {
683 return dev_pm_opp_set_config(dev, &config);
686 static inline void dev_pm_opp_put_prop_name(int token)
688 dev_pm_opp_clear_config(token);
691 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
693 return dev_pm_opp_get_freq_indexed(opp, 0);
696 #endif /* __LINUX_OPP_H__ */