2 * Generic OPP Interface
4 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #ifndef __LINUX_OPP_H__
15 #define __LINUX_OPP_H__
17 #include <linux/err.h>
18 #include <linux/notifier.h>
26 enum dev_pm_opp_event {
27 OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
31 * struct dev_pm_opp_supply - Power supply voltage/current values
32 * @u_volt: Target voltage in microvolts corresponding to this OPP
33 * @u_volt_min: Minimum voltage in microvolts corresponding to this OPP
34 * @u_volt_max: Maximum voltage in microvolts corresponding to this OPP
35 * @u_amp: Maximum current drawn by the device in microamperes
37 * This structure stores the voltage/current values for a single power supply.
39 struct dev_pm_opp_supply {
41 unsigned long u_volt_min;
42 unsigned long u_volt_max;
47 * struct dev_pm_opp_info - OPP freq/voltage/current values
48 * @rate: Target clk rate in hz
49 * @supplies: Array of voltage/current values for all power supplies
51 * This structure stores the freq/voltage/current values for a single OPP.
53 struct dev_pm_opp_info {
55 struct dev_pm_opp_supply *supplies;
59 * struct dev_pm_set_opp_data - Set OPP data
60 * @old_opp: Old OPP info
61 * @new_opp: New OPP info
62 * @regulators: Array of regulator pointers
63 * @regulator_count: Number of regulators
64 * @clk: Pointer to clk
65 * @dev: Pointer to the struct device
67 * This structure contains all information required for setting an OPP.
69 struct dev_pm_set_opp_data {
70 struct dev_pm_opp_info old_opp;
71 struct dev_pm_opp_info new_opp;
73 struct regulator **regulators;
74 unsigned int regulator_count;
79 #if defined(CONFIG_PM_OPP)
81 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
82 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index);
83 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
85 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
87 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
89 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
91 int dev_pm_opp_get_opp_count(struct device *dev);
92 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
93 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
94 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
95 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
97 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
101 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
102 unsigned long *freq);
104 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
105 unsigned long *freq);
106 void dev_pm_opp_put(struct dev_pm_opp *opp);
108 int dev_pm_opp_add(struct device *dev, unsigned long freq,
109 unsigned long u_volt);
110 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
111 void dev_pm_opp_remove_all_dynamic(struct device *dev);
113 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
115 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
117 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
118 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
120 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
121 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
122 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
123 void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
124 struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
125 void dev_pm_opp_put_regulators(struct opp_table *opp_table);
126 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name);
127 void dev_pm_opp_put_clkname(struct opp_table *opp_table);
128 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
129 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
130 struct opp_table *dev_pm_opp_set_genpd_virt_dev(struct device *dev, struct device *virt_dev, int index);
131 void dev_pm_opp_put_genpd_virt_dev(struct opp_table *opp_table, struct device *virt_dev);
132 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
133 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
134 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
135 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
136 void dev_pm_opp_remove_table(struct device *dev);
137 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
139 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
141 return ERR_PTR(-ENOTSUPP);
144 static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
146 return ERR_PTR(-ENOTSUPP);
149 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
151 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
156 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
161 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
166 static inline int dev_pm_opp_get_opp_count(struct device *dev)
171 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
176 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
181 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
186 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
191 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
192 unsigned long freq, bool available)
194 return ERR_PTR(-ENOTSUPP);
197 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
200 return ERR_PTR(-ENOTSUPP);
203 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
206 return ERR_PTR(-ENOTSUPP);
209 static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
211 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
212 unsigned long u_volt)
217 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
221 static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
225 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
230 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
235 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
240 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
245 static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
249 return ERR_PTR(-ENOTSUPP);
252 static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
254 static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
255 int (*set_opp)(struct dev_pm_set_opp_data *data))
257 return ERR_PTR(-ENOTSUPP);
260 static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
262 static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
264 return ERR_PTR(-ENOTSUPP);
267 static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
269 static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
271 return ERR_PTR(-ENOTSUPP);
274 static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
276 static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name)
278 return ERR_PTR(-ENOTSUPP);
281 static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
283 static inline struct opp_table *dev_pm_opp_set_genpd_virt_dev(struct device *dev, struct device *virt_dev, int index)
285 return ERR_PTR(-ENOTSUPP);
288 static inline void dev_pm_opp_put_genpd_virt_dev(struct opp_table *opp_table, struct device *virt_dev) {}
290 static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
295 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
300 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
305 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
310 static inline void dev_pm_opp_remove_table(struct device *dev)
314 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
318 #endif /* CONFIG_PM_OPP */
320 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
321 int dev_pm_opp_of_add_table(struct device *dev);
322 int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
323 void dev_pm_opp_of_remove_table(struct device *dev);
324 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
325 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
326 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
327 struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
328 struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
329 int of_get_required_opp_performance_state(struct device_node *np, int index);
331 static inline int dev_pm_opp_of_add_table(struct device *dev)
336 static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
341 static inline void dev_pm_opp_of_remove_table(struct device *dev)
345 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
350 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
354 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
359 static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
364 static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
368 static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
374 #endif /* __LINUX_OPP_H__ */