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
36 * This structure stores the voltage/current values for a single power supply.
38 struct dev_pm_opp_supply {
40 unsigned long u_volt_min;
41 unsigned long u_volt_max;
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)
50 * This structure stores the bandwidth values for a single interconnect path.
52 struct dev_pm_opp_icc_bw {
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
62 * This structure stores the freq/voltage/current values for a single OPP.
64 struct dev_pm_opp_info {
66 struct dev_pm_opp_supply *supplies;
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
78 * This structure contains all information required for setting an OPP.
80 struct dev_pm_set_opp_data {
81 struct dev_pm_opp_info old_opp;
82 struct dev_pm_opp_info new_opp;
84 struct regulator **regulators;
85 unsigned int regulator_count;
90 #if defined(CONFIG_PM_OPP)
92 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
93 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
95 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
97 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
99 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
101 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
104 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
106 int dev_pm_opp_get_opp_count(struct device *dev);
107 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
108 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
109 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
110 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
112 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
115 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
117 struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
118 unsigned int *level);
120 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
121 unsigned long *freq);
122 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
123 unsigned long u_volt);
125 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
126 unsigned long *freq);
127 void dev_pm_opp_put(struct dev_pm_opp *opp);
129 int dev_pm_opp_add(struct device *dev, unsigned long freq,
130 unsigned long u_volt);
131 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
132 void dev_pm_opp_remove_all_dynamic(struct device *dev);
134 int 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);
138 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
140 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
142 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
143 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
145 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
146 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
147 int devm_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
148 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
149 void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
150 struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
151 void dev_pm_opp_put_regulators(struct opp_table *opp_table);
152 int devm_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
153 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name);
154 void dev_pm_opp_put_clkname(struct opp_table *opp_table);
155 int devm_pm_opp_set_clkname(struct device *dev, const char *name);
156 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
157 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
158 int devm_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
159 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char * const *names, struct device ***virt_devs);
160 void dev_pm_opp_detach_genpd(struct opp_table *opp_table);
161 int devm_pm_opp_attach_genpd(struct device *dev, const char * const *names, struct device ***virt_devs);
162 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);
163 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
164 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
165 int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp);
166 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
167 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
168 void dev_pm_opp_remove_table(struct device *dev);
169 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
170 int dev_pm_opp_sync_regulators(struct device *dev);
172 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
174 return ERR_PTR(-EOPNOTSUPP);
177 static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
179 return ERR_PTR(-EOPNOTSUPP);
182 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
184 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
189 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
194 static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
200 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
206 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
211 static inline int dev_pm_opp_get_opp_count(struct device *dev)
216 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
221 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
226 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
231 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
236 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
237 unsigned long freq, bool available)
239 return ERR_PTR(-EOPNOTSUPP);
242 static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
245 return ERR_PTR(-EOPNOTSUPP);
248 static inline struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
251 return ERR_PTR(-EOPNOTSUPP);
254 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
257 return ERR_PTR(-EOPNOTSUPP);
260 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
261 unsigned long u_volt)
263 return ERR_PTR(-EOPNOTSUPP);
266 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
269 return ERR_PTR(-EOPNOTSUPP);
272 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
274 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
275 unsigned long u_volt)
280 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
284 static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
289 dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
290 unsigned long u_volt, unsigned long u_volt_min,
291 unsigned long u_volt_max)
296 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
301 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
306 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
311 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
316 static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
320 return ERR_PTR(-EOPNOTSUPP);
323 static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
325 static inline int devm_pm_opp_set_supported_hw(struct device *dev,
332 static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
333 int (*set_opp)(struct dev_pm_set_opp_data *data))
335 return ERR_PTR(-EOPNOTSUPP);
338 static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
340 static inline int devm_pm_opp_register_set_opp_helper(struct device *dev,
341 int (*set_opp)(struct dev_pm_set_opp_data *data))
346 static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
348 return ERR_PTR(-EOPNOTSUPP);
351 static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
353 static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
355 return ERR_PTR(-EOPNOTSUPP);
358 static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
360 static inline int devm_pm_opp_set_regulators(struct device *dev,
361 const char * const names[],
367 static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
369 return ERR_PTR(-EOPNOTSUPP);
372 static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
374 static inline int devm_pm_opp_set_clkname(struct device *dev, const char *name)
379 static inline struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char * const *names, struct device ***virt_devs)
381 return ERR_PTR(-EOPNOTSUPP);
384 static inline void dev_pm_opp_detach_genpd(struct opp_table *opp_table) {}
386 static inline int devm_pm_opp_attach_genpd(struct device *dev,
387 const char * const *names,
388 struct device ***virt_devs)
393 static inline struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table,
394 struct opp_table *dst_table, struct dev_pm_opp *src_opp)
396 return ERR_PTR(-EOPNOTSUPP);
399 static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
404 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
409 static inline int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp)
414 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
419 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
424 static inline void dev_pm_opp_remove_table(struct device *dev)
428 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
432 static inline int dev_pm_opp_sync_regulators(struct device *dev)
437 #endif /* CONFIG_PM_OPP */
439 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
440 int dev_pm_opp_of_add_table(struct device *dev);
441 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
442 int devm_pm_opp_of_add_table_indexed(struct device *dev, int index);
443 int dev_pm_opp_of_add_table_noclk(struct device *dev, int index);
444 int devm_pm_opp_of_add_table_noclk(struct device *dev, int index);
445 void dev_pm_opp_of_remove_table(struct device *dev);
446 int devm_pm_opp_of_add_table(struct device *dev);
447 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
448 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
449 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
450 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
451 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
452 int of_get_required_opp_performance_state(struct device_node *np, int index);
453 int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table);
454 int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus);
455 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
457 em_dev_unregister_perf_domain(dev);
460 static inline int dev_pm_opp_of_add_table(struct device *dev)
465 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
470 static inline int devm_pm_opp_of_add_table_indexed(struct device *dev, int index)
475 static inline int dev_pm_opp_of_add_table_noclk(struct device *dev, int index)
480 static inline int devm_pm_opp_of_add_table_noclk(struct device *dev, int index)
485 static inline void dev_pm_opp_of_remove_table(struct device *dev)
489 static inline int devm_pm_opp_of_add_table(struct device *dev)
494 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
499 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
503 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
508 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
513 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
518 static inline int dev_pm_opp_of_register_em(struct device *dev,
519 struct cpumask *cpus)
524 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
528 static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
533 static inline int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table)
539 #endif /* __LINUX_OPP_H__ */