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 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
83 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
85 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
87 int dev_pm_opp_get_opp_count(struct device *dev);
88 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
89 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
90 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
91 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
93 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
97 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
100 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
101 unsigned long *freq);
103 int dev_pm_opp_add(struct device *dev, unsigned long freq,
104 unsigned long u_volt);
105 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
107 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
109 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
111 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
112 int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
114 int dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions,
116 void dev_pm_opp_put_supported_hw(struct device *dev);
117 int dev_pm_opp_set_prop_name(struct device *dev, const char *name);
118 void dev_pm_opp_put_prop_name(struct device *dev);
119 struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
120 void dev_pm_opp_put_regulators(struct opp_table *opp_table);
121 int dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
122 void dev_pm_opp_register_put_opp_helper(struct device *dev);
123 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
124 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
125 int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
126 void dev_pm_opp_remove_table(struct device *dev);
127 void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
129 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
134 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
139 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
144 static inline int dev_pm_opp_get_opp_count(struct device *dev)
149 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
154 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
159 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
164 static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
169 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
170 unsigned long freq, bool available)
172 return ERR_PTR(-ENOTSUPP);
175 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
178 return ERR_PTR(-ENOTSUPP);
181 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
184 return ERR_PTR(-ENOTSUPP);
187 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
188 unsigned long u_volt)
193 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
197 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
202 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
207 static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
212 static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
217 static inline int dev_pm_opp_set_supported_hw(struct device *dev,
224 static inline void dev_pm_opp_put_supported_hw(struct device *dev) {}
226 static inline int dev_pm_opp_register_set_opp_helper(struct device *dev,
227 int (*set_opp)(struct dev_pm_set_opp_data *data))
232 static inline void dev_pm_opp_register_put_opp_helper(struct device *dev) {}
234 static inline int dev_pm_opp_set_prop_name(struct device *dev, const char *name)
239 static inline void dev_pm_opp_put_prop_name(struct device *dev) {}
241 static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
243 return ERR_PTR(-ENOTSUPP);
246 static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
248 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
253 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
258 static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
263 static inline void dev_pm_opp_remove_table(struct device *dev)
267 static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
271 #endif /* CONFIG_PM_OPP */
273 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
274 int dev_pm_opp_of_add_table(struct device *dev);
275 void dev_pm_opp_of_remove_table(struct device *dev);
276 int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
277 void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
278 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
280 static inline int dev_pm_opp_of_add_table(struct device *dev)
285 static inline void dev_pm_opp_of_remove_table(struct device *dev)
289 static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
294 static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
298 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
304 #endif /* __LINUX_OPP_H__ */