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 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
148 void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
149 struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
150 void dev_pm_opp_put_regulators(struct opp_table *opp_table);
151 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name);
152 void dev_pm_opp_put_clkname(struct opp_table *opp_table);
153 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
154 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
155 struct opp_table *devm_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
156 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs);
157 void dev_pm_opp_detach_genpd(struct opp_table *opp_table);
158 struct opp_table *devm_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs);
159 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);
160 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
161 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
162 int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp);
163 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
164 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
165 void dev_pm_opp_remove_table(struct device *dev);
166 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
167 int dev_pm_opp_sync_regulators(struct device *dev);
169 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
171 return ERR_PTR(-EOPNOTSUPP);
174 static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
176 return ERR_PTR(-EOPNOTSUPP);
179 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
181 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
186 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
191 static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
197 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
203 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
208 static inline int dev_pm_opp_get_opp_count(struct device *dev)
213 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
218 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
223 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
228 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
233 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
234 unsigned long freq, bool available)
236 return ERR_PTR(-EOPNOTSUPP);
239 static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
242 return ERR_PTR(-EOPNOTSUPP);
245 static inline struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
248 return ERR_PTR(-EOPNOTSUPP);
251 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
254 return ERR_PTR(-EOPNOTSUPP);
257 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
258 unsigned long u_volt)
260 return ERR_PTR(-EOPNOTSUPP);
263 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
266 return ERR_PTR(-EOPNOTSUPP);
269 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
271 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
272 unsigned long u_volt)
277 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
281 static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
286 dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
287 unsigned long u_volt, unsigned long u_volt_min,
288 unsigned long u_volt_max)
293 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
298 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
303 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
308 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
313 static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
317 return ERR_PTR(-EOPNOTSUPP);
320 static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
322 static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
323 int (*set_opp)(struct dev_pm_set_opp_data *data))
325 return ERR_PTR(-EOPNOTSUPP);
328 static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
330 static inline struct opp_table *
331 devm_pm_opp_register_set_opp_helper(struct device *dev,
332 int (*set_opp)(struct dev_pm_set_opp_data *data))
334 return ERR_PTR(-EOPNOTSUPP);
337 static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
339 return ERR_PTR(-EOPNOTSUPP);
342 static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
344 static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
346 return ERR_PTR(-EOPNOTSUPP);
349 static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
351 static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
353 return ERR_PTR(-EOPNOTSUPP);
356 static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
358 static inline struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs)
360 return ERR_PTR(-EOPNOTSUPP);
363 static inline void dev_pm_opp_detach_genpd(struct opp_table *opp_table) {}
365 static inline struct opp_table *devm_pm_opp_attach_genpd(struct device *dev,
366 const char **names, struct device ***virt_devs)
368 return ERR_PTR(-EOPNOTSUPP);
371 static inline struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table,
372 struct opp_table *dst_table, struct dev_pm_opp *src_opp)
374 return ERR_PTR(-EOPNOTSUPP);
377 static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
382 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
387 static inline int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp)
392 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
397 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
402 static inline void dev_pm_opp_remove_table(struct device *dev)
406 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
410 static inline int dev_pm_opp_sync_regulators(struct device *dev)
415 #endif /* CONFIG_PM_OPP */
417 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
418 int dev_pm_opp_of_add_table(struct device *dev);
419 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
420 int dev_pm_opp_of_add_table_noclk(struct device *dev, int index);
421 void dev_pm_opp_of_remove_table(struct device *dev);
422 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
423 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
424 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
425 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
426 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
427 int of_get_required_opp_performance_state(struct device_node *np, int index);
428 int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table);
429 int dev_pm_opp_of_register_em(struct device *dev, struct cpumask *cpus);
430 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
432 em_dev_unregister_perf_domain(dev);
435 static inline int dev_pm_opp_of_add_table(struct device *dev)
440 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
445 static inline int dev_pm_opp_of_add_table_noclk(struct device *dev, int index)
450 static inline void dev_pm_opp_of_remove_table(struct device *dev)
454 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
459 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
463 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
468 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
473 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
478 static inline int dev_pm_opp_of_register_em(struct device *dev,
479 struct cpumask *cpus)
484 static inline void dev_pm_opp_of_unregister_em(struct device *dev)
488 static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
493 static inline int dev_pm_opp_of_find_icc_paths(struct device *dev, struct opp_table *opp_table)
499 #endif /* __LINUX_OPP_H__ */