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 void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
84 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
86 unsigned long dev_pm_opp_get_freq(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,
100 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
101 unsigned long *freq);
103 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
104 unsigned long *freq);
106 int dev_pm_opp_add(struct device *dev, unsigned long freq,
107 unsigned long u_volt);
108 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
110 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
112 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
114 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
115 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
117 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
118 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
119 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
120 void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
121 struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
122 void dev_pm_opp_put_regulators(struct opp_table *opp_table);
123 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
124 void dev_pm_opp_register_put_opp_helper(struct opp_table *opp_table);
125 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
126 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
127 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
128 void dev_pm_opp_remove_table(struct device *dev);
129 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
131 static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
133 return ERR_PTR(-ENOTSUPP);
136 static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
138 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
143 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
148 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
153 static inline int dev_pm_opp_get_opp_count(struct device *dev)
158 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
163 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
168 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
173 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
178 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
179 unsigned long freq, bool available)
181 return ERR_PTR(-ENOTSUPP);
184 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
187 return ERR_PTR(-ENOTSUPP);
190 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
193 return ERR_PTR(-ENOTSUPP);
196 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
197 unsigned long u_volt)
202 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
206 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
211 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
216 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
221 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
226 static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
230 return ERR_PTR(-ENOTSUPP);
233 static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
235 static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
236 int (*set_opp)(struct dev_pm_set_opp_data *data))
238 return ERR_PTR(-ENOTSUPP);
241 static inline void dev_pm_opp_register_put_opp_helper(struct opp_table *opp_table) {}
243 static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
245 return ERR_PTR(-ENOTSUPP);
248 static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
250 static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
252 return ERR_PTR(-ENOTSUPP);
255 static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
257 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
262 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
267 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
272 static inline void dev_pm_opp_remove_table(struct device *dev)
276 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
280 #endif /* CONFIG_PM_OPP */
282 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
283 int dev_pm_opp_of_add_table(struct device *dev);
284 void dev_pm_opp_of_remove_table(struct device *dev);
285 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
286 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
287 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
289 static inline int dev_pm_opp_of_add_table(struct device *dev)
294 static inline void dev_pm_opp_of_remove_table(struct device *dev)
298 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
303 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
307 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
313 #endif /* __LINUX_OPP_H__ */