PM / OPP: Support adjusting OPP voltages at runtime
[firefly-linux-kernel-4.4.55.git] / include / linux / pm_opp.h
1 /*
2  * Generic OPP Interface
3  *
4  * Copyright (C) 2009-2010 Texas Instruments Incorporated.
5  *      Nishanth Menon
6  *      Romit Dasgupta
7  *      Kevin Hilman
8  *
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.
12  */
13
14 #ifndef __LINUX_OPP_H__
15 #define __LINUX_OPP_H__
16
17 #include <linux/err.h>
18 #include <linux/notifier.h>
19
20 struct dev_pm_opp;
21 struct device;
22
23 enum dev_pm_opp_event {
24         OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
25         OPP_EVENT_ADJUST_VOLTAGE,
26 };
27
28 #if defined(CONFIG_PM_OPP)
29
30 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
31
32 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
33
34 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
35
36 int dev_pm_opp_get_opp_count(struct device *dev);
37 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
38 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
39 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
40 struct dev_pm_opp *dev_pm_opp_get_suspend_opp(struct device *dev);
41
42 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
43                                               unsigned long freq,
44                                               bool available);
45
46 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
47                                               unsigned long *freq);
48
49 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
50                                              unsigned long *freq);
51
52 int dev_pm_opp_add(struct device *dev, unsigned long freq,
53                    unsigned long u_volt);
54 void dev_pm_opp_remove(struct device *dev, unsigned long freq);
55
56 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
57                               unsigned long u_volt);
58
59 int dev_pm_opp_enable(struct device *dev, unsigned long freq);
60
61 int dev_pm_opp_disable(struct device *dev, unsigned long freq);
62
63 struct srcu_notifier_head *dev_pm_opp_get_notifier(struct device *dev);
64 int dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions,
65                                 unsigned int count);
66 void dev_pm_opp_put_supported_hw(struct device *dev);
67 int dev_pm_opp_set_prop_name(struct device *dev, const char *name);
68 void dev_pm_opp_put_prop_name(struct device *dev);
69 int dev_pm_opp_set_regulator(struct device *dev, const char *name);
70 void dev_pm_opp_put_regulator(struct device *dev);
71 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
72 #else
73 static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
74 {
75         return 0;
76 }
77
78 static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
79 {
80         return 0;
81 }
82
83 static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
84 {
85         return false;
86 }
87
88 static inline int dev_pm_opp_get_opp_count(struct device *dev)
89 {
90         return 0;
91 }
92
93 static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
94 {
95         return 0;
96 }
97
98 static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
99 {
100         return 0;
101 }
102
103 static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
104 {
105         return 0;
106 }
107
108 static inline struct dev_pm_opp *dev_pm_opp_get_suspend_opp(struct device *dev)
109 {
110         return NULL;
111 }
112
113 static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
114                                         unsigned long freq, bool available)
115 {
116         return ERR_PTR(-EINVAL);
117 }
118
119 static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
120                                         unsigned long *freq)
121 {
122         return ERR_PTR(-EINVAL);
123 }
124
125 static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
126                                         unsigned long *freq)
127 {
128         return ERR_PTR(-EINVAL);
129 }
130
131 static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
132                                         unsigned long u_volt)
133 {
134         return -EINVAL;
135 }
136
137 static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
138 {
139 }
140
141 static inline int
142 dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
143                           unsigned long u_volt)
144 {
145         return 0;
146 }
147
148 static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
149 {
150         return 0;
151 }
152
153 static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
154 {
155         return 0;
156 }
157
158 static inline struct srcu_notifier_head *dev_pm_opp_get_notifier(
159                                                         struct device *dev)
160 {
161         return ERR_PTR(-EINVAL);
162 }
163
164 static inline int dev_pm_opp_set_supported_hw(struct device *dev,
165                                               const u32 *versions,
166                                               unsigned int count)
167 {
168         return -EINVAL;
169 }
170
171 static inline void dev_pm_opp_put_supported_hw(struct device *dev) {}
172
173 static inline int dev_pm_opp_set_prop_name(struct device *dev, const char *name)
174 {
175         return -EINVAL;
176 }
177
178 static inline void dev_pm_opp_put_prop_name(struct device *dev) {}
179
180 static inline int dev_pm_opp_set_regulator(struct device *dev, const char *name)
181 {
182         return -EINVAL;
183 }
184
185 static inline void dev_pm_opp_put_regulator(struct device *dev) {}
186
187 static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
188 {
189         return -EINVAL;
190 }
191
192 #endif          /* CONFIG_PM_OPP */
193
194 #if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
195 int dev_pm_opp_of_add_table(struct device *dev);
196 void dev_pm_opp_of_remove_table(struct device *dev);
197 int dev_pm_opp_of_cpumask_add_table(cpumask_var_t cpumask);
198 void dev_pm_opp_of_cpumask_remove_table(cpumask_var_t cpumask);
199 int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, cpumask_var_t cpumask);
200 int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, cpumask_var_t cpumask);
201 #else
202 static inline int dev_pm_opp_of_add_table(struct device *dev)
203 {
204         return -EINVAL;
205 }
206
207 static inline void dev_pm_opp_of_remove_table(struct device *dev)
208 {
209 }
210
211 static inline int dev_pm_opp_of_cpumask_add_table(cpumask_var_t cpumask)
212 {
213         return -ENOSYS;
214 }
215
216 static inline void dev_pm_opp_of_cpumask_remove_table(cpumask_var_t cpumask)
217 {
218 }
219
220 static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, cpumask_var_t cpumask)
221 {
222         return -ENOSYS;
223 }
224
225 static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, cpumask_var_t cpumask)
226 {
227         return -ENOSYS;
228 }
229 #endif
230
231 #endif          /* __LINUX_OPP_H__ */