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/err.h>
15 #include <linux/notifier.h>
23 enum dev_pm_opp_event {
24 OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
28 * struct dev_pm_opp_supply - Power supply voltage/current values
29 * @u_volt: Target voltage in microvolts corresponding to this OPP
30 * @u_volt_min: Minimum voltage in microvolts corresponding to this OPP
31 * @u_volt_max: Maximum voltage in microvolts corresponding to this OPP
32 * @u_amp: Maximum current drawn by the device in microamperes
34 * This structure stores the voltage/current values for a single power supply.
36 struct dev_pm_opp_supply {
38 unsigned long u_volt_min;
39 unsigned long u_volt_max;
44 * struct dev_pm_opp_info - OPP freq/voltage/current values
45 * @rate: Target clk rate in hz
46 * @supplies: Array of voltage/current values for all power supplies
48 * This structure stores the freq/voltage/current values for a single OPP.
50 struct dev_pm_opp_info {
52 struct dev_pm_opp_supply *supplies;
56 * struct dev_pm_set_opp_data - Set OPP data
57 * @old_opp: Old OPP info
58 * @new_opp: New OPP info
59 * @regulators: Array of regulator pointers
60 * @regulator_count: Number of regulators
61 * @clk: Pointer to clk
62 * @dev: Pointer to the struct device
64 * This structure contains all information required for setting an OPP.
66 struct dev_pm_set_opp_data {
67 struct dev_pm_opp_info old_opp;
68 struct dev_pm_opp_info new_opp;
70 struct regulator **regulators;
71 unsigned int regulator_count;
76 #if defined(CONFIG_PM_OPP)
78 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
79 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index);
80 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
82 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
84 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
86 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
88 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
90 int dev_pm_opp_get_opp_count(struct device *dev);
91 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
92 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
93 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
94 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
96 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
99 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
102 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
103 unsigned long *freq);
104 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
105 unsigned long u_volt);
107 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
108 unsigned long *freq);
109 void dev_pm_opp_put(struct dev_pm_opp *opp);
111 int dev_pm_opp_add(struct device *dev, unsigned long freq,
112 unsigned long u_volt);
113 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
114 void dev_pm_opp_remove_all_dynamic(struct device *dev);
116 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
118 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
120 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
121 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
123 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
124 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
125 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
126 void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
127 struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
128 void dev_pm_opp_put_regulators(struct opp_table *opp_table);
129 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name);
130 void dev_pm_opp_put_clkname(struct opp_table *opp_table);
131 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
132 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
133 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs);
134 void dev_pm_opp_detach_genpd(struct opp_table *opp_table);
135 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
136 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
137 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
138 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
139 void dev_pm_opp_remove_table(struct device *dev);
140 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
142 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
144 return ERR_PTR(-ENOTSUPP);
147 static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
149 return ERR_PTR(-ENOTSUPP);
152 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
154 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
159 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
164 static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
169 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
174 static inline int dev_pm_opp_get_opp_count(struct device *dev)
179 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
184 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
189 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
194 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
199 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
200 unsigned long freq, bool available)
202 return ERR_PTR(-ENOTSUPP);
205 static inline struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
208 return ERR_PTR(-ENOTSUPP);
211 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
214 return ERR_PTR(-ENOTSUPP);
217 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
218 unsigned long u_volt)
220 return ERR_PTR(-ENOTSUPP);
223 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
226 return ERR_PTR(-ENOTSUPP);
229 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
231 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
232 unsigned long u_volt)
237 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
241 static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
245 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
250 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
255 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
260 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
265 static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
269 return ERR_PTR(-ENOTSUPP);
272 static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
274 static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
275 int (*set_opp)(struct dev_pm_set_opp_data *data))
277 return ERR_PTR(-ENOTSUPP);
280 static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
282 static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
284 return ERR_PTR(-ENOTSUPP);
287 static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
289 static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
291 return ERR_PTR(-ENOTSUPP);
294 static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
296 static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name)
298 return ERR_PTR(-ENOTSUPP);
301 static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
303 static inline struct opp_table *dev_pm_opp_attach_genpd(struct device *dev, const char **names, struct device ***virt_devs)
305 return ERR_PTR(-ENOTSUPP);
308 static inline void dev_pm_opp_detach_genpd(struct opp_table *opp_table) {}
310 static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
315 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
320 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
325 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
330 static inline void dev_pm_opp_remove_table(struct device *dev)
334 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
338 #endif /* CONFIG_PM_OPP */
340 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
341 int dev_pm_opp_of_add_table(struct device *dev);
342 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
343 void dev_pm_opp_of_remove_table(struct device *dev);
344 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
345 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
346 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
347 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
348 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
349 int of_get_required_opp_performance_state(struct device_node *np, int index);
350 void dev_pm_opp_of_register_em(struct cpumask *cpus);
352 static inline int dev_pm_opp_of_add_table(struct device *dev)
357 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
362 static inline void dev_pm_opp_of_remove_table(struct device *dev)
366 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
371 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
375 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
380 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
385 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
390 static inline void dev_pm_opp_of_register_em(struct cpumask *cpus)
394 static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
400 #endif /* __LINUX_OPP_H__ */