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 {
61 * struct dev_pm_opp_info - OPP freq/voltage/current values
62 * @rate: Target clk rate in hz
63 * @supplies: Array of voltage/current values for all power supplies
65 * This structure stores the freq/voltage/current values for a single OPP.
67 struct dev_pm_opp_info {
69 struct dev_pm_opp_supply *supplies;
73 * struct dev_pm_set_opp_data - Set OPP data
74 * @old_opp: Old OPP info
75 * @new_opp: New OPP info
76 * @regulators: Array of regulator pointers
77 * @regulator_count: Number of regulators
78 * @clk: Pointer to clk
79 * @dev: Pointer to the struct device
81 * This structure contains all information required for setting an OPP.
83 struct dev_pm_set_opp_data {
84 struct dev_pm_opp_info old_opp;
85 struct dev_pm_opp_info new_opp;
87 struct regulator **regulators;
88 unsigned int regulator_count;
93 #if defined(CONFIG_PM_OPP)
95 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
96 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
98 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
100 unsigned long dev_pm_opp_get_power(struct dev_pm_opp *opp);
102 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
104 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
106 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
109 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
111 int dev_pm_opp_get_opp_count(struct device *dev);
112 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
113 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
114 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
115 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
117 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
120 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
122 struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
123 unsigned int *level);
125 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
126 unsigned long *freq);
127 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
128 unsigned long u_volt);
130 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
131 unsigned long *freq);
132 void dev_pm_opp_put(struct dev_pm_opp *opp);
134 int dev_pm_opp_add(struct device *dev, unsigned long freq,
135 unsigned long u_volt);
136 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
137 void dev_pm_opp_remove_all_dynamic(struct device *dev);
139 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
140 unsigned long u_volt, unsigned long u_volt_min,
141 unsigned long u_volt_max);
143 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
145 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
147 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
148 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
150 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
151 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
152 int devm_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
153 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
154 void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
155 struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
156 void dev_pm_opp_put_regulators(struct opp_table *opp_table);
157 int devm_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
158 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name);
159 void dev_pm_opp_put_clkname(struct opp_table *opp_table);
160 int devm_pm_opp_set_clkname(struct device *dev, const char *name);
161 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
162 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
163 int devm_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
164 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char * const *names, struct device ***virt_devs);
165 void dev_pm_opp_detach_genpd(struct opp_table *opp_table);
166 int devm_pm_opp_attach_genpd(struct device *dev, const char * const *names, struct device ***virt_devs);
167 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);
168 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
169 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
170 int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp);
171 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
172 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
173 void dev_pm_opp_remove_table(struct device *dev);
174 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
175 int dev_pm_opp_sync_regulators(struct device *dev);
177 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
179 return ERR_PTR(-EOPNOTSUPP);
182 static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
184 return ERR_PTR(-EOPNOTSUPP);
187 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
189 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
194 static inline unsigned long dev_pm_opp_get_power(struct dev_pm_opp *opp)
199 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
204 static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
210 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
216 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
221 static inline int dev_pm_opp_get_opp_count(struct device *dev)
226 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
231 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
236 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
241 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
246 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
247 unsigned long freq, bool available)
249 return ERR_PTR(-EOPNOTSUPP);
252 static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
255 return ERR_PTR(-EOPNOTSUPP);
258 static inline struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
261 return ERR_PTR(-EOPNOTSUPP);
264 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
267 return ERR_PTR(-EOPNOTSUPP);
270 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
271 unsigned long u_volt)
273 return ERR_PTR(-EOPNOTSUPP);
276 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
279 return ERR_PTR(-EOPNOTSUPP);
282 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
284 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
285 unsigned long u_volt)
290 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
294 static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
299 dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
300 unsigned long u_volt, unsigned long u_volt_min,
301 unsigned long u_volt_max)
306 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
311 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
316 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
321 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
326 static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
330 return ERR_PTR(-EOPNOTSUPP);
333 static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
335 static inline int devm_pm_opp_set_supported_hw(struct device *dev,
342 static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
343 int (*set_opp)(struct dev_pm_set_opp_data *data))
345 return ERR_PTR(-EOPNOTSUPP);
348 static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
350 static inline int devm_pm_opp_register_set_opp_helper(struct device *dev,
351 int (*set_opp)(struct dev_pm_set_opp_data *data))
356 static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
358 return ERR_PTR(-EOPNOTSUPP);
361 static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
363 static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
365 return ERR_PTR(-EOPNOTSUPP);
368 static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
370 static inline int devm_pm_opp_set_regulators(struct device *dev,
371 const char * const names[],
377 static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
379 return ERR_PTR(-EOPNOTSUPP);
382 static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
384 static inline int devm_pm_opp_set_clkname(struct device *dev, const char *name)
389 static inline struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char * const *names, struct device ***virt_devs)
391 return ERR_PTR(-EOPNOTSUPP);
394 static inline void dev_pm_opp_detach_genpd(struct opp_table *opp_table) {}
396 static inline int devm_pm_opp_attach_genpd(struct device *dev,
397 const char * const *names,
398 struct device ***virt_devs)
403 static inline struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table,
404 struct opp_table *dst_table, struct dev_pm_opp *src_opp)
406 return ERR_PTR(-EOPNOTSUPP);
409 static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
414 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
419 static inline int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp)
424 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
429 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
434 static inline void dev_pm_opp_remove_table(struct device *dev)
438 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
442 static inline int dev_pm_opp_sync_regulators(struct device *dev)
447 #endif /* CONFIG_PM_OPP */
449 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
450 int dev_pm_opp_of_add_table(struct device *dev);
451 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
452 int devm_pm_opp_of_add_table_indexed(struct device *dev, int index);
453 int dev_pm_opp_of_add_table_noclk(struct device *dev, int index);
454 int devm_pm_opp_of_add_table_noclk(struct device *dev, int index);
455 void dev_pm_opp_of_remove_table(struct device *dev);
456 int devm_pm_opp_of_add_table(struct device *dev);
457 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
458 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
459 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
460 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
461 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
462 int of_get_required_opp_performance_state(struct device_node *np, int index);
463 int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table);
464 int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus);
465 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
467 em_dev_unregister_perf_domain(dev);
470 static inline int dev_pm_opp_of_add_table(struct device *dev)
475 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
480 static inline int devm_pm_opp_of_add_table_indexed(struct device *dev, int index)
485 static inline int dev_pm_opp_of_add_table_noclk(struct device *dev, int index)
490 static inline int devm_pm_opp_of_add_table_noclk(struct device *dev, int index)
495 static inline void dev_pm_opp_of_remove_table(struct device *dev)
499 static inline int devm_pm_opp_of_add_table(struct device *dev)
504 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
509 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
513 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
518 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
523 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
528 static inline int dev_pm_opp_of_register_em(struct device *dev,
529 struct cpumask *cpus)
534 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
538 static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
543 static inline int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table)
549 #endif /* __LINUX_OPP_H__ */