]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/pm_opp.h
mm/hotplug: invalid PFNs from pfn_to_online_page()
[mirror_ubuntu-bionic-kernel.git] / include / linux / pm_opp.h
CommitLineData
e1f60b29
NM
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>
03ca370f 18#include <linux/notifier.h>
e1f60b29 19
94735585
VK
20struct clk;
21struct regulator;
47d43ba7 22struct dev_pm_opp;
313162d0 23struct device;
91291d9a 24struct opp_table;
e1f60b29 25
47d43ba7 26enum dev_pm_opp_event {
129eec55 27 OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
7c999515 28 OPP_EVENT_ADJUST_VOLTAGE,
03ca370f
MH
29};
30
0f0fe7e0
VK
31/**
32 * struct dev_pm_opp_supply - Power supply voltage/current values
33 * @u_volt: Target voltage in microvolts corresponding to this OPP
34 * @u_volt_min: Minimum voltage in microvolts corresponding to this OPP
35 * @u_volt_max: Maximum voltage in microvolts corresponding to this OPP
36 * @u_amp: Maximum current drawn by the device in microamperes
37 *
38 * This structure stores the voltage/current values for a single power supply.
39 */
40struct dev_pm_opp_supply {
41 unsigned long u_volt;
42 unsigned long u_volt_min;
43 unsigned long u_volt_max;
44 unsigned long u_amp;
45};
46
94735585
VK
47/**
48 * struct dev_pm_opp_info - OPP freq/voltage/current values
49 * @rate: Target clk rate in hz
50 * @supplies: Array of voltage/current values for all power supplies
51 *
52 * This structure stores the freq/voltage/current values for a single OPP.
53 */
54struct dev_pm_opp_info {
55 unsigned long rate;
56 struct dev_pm_opp_supply *supplies;
57};
58
59/**
60 * struct dev_pm_set_opp_data - Set OPP data
61 * @old_opp: Old OPP info
62 * @new_opp: New OPP info
63 * @regulators: Array of regulator pointers
64 * @regulator_count: Number of regulators
65 * @clk: Pointer to clk
66 * @dev: Pointer to the struct device
67 *
68 * This structure contains all information required for setting an OPP.
69 */
70struct dev_pm_set_opp_data {
71 struct dev_pm_opp_info old_opp;
72 struct dev_pm_opp_info new_opp;
73
74 struct regulator **regulators;
75 unsigned int regulator_count;
76 struct clk *clk;
77 struct device *dev;
78};
79
e1f60b29
NM
80#if defined(CONFIG_PM_OPP)
81
f067a982
VK
82struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
83void dev_pm_opp_put_opp_table(struct opp_table *opp_table);
84
47d43ba7 85unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
e1f60b29 86
47d43ba7 87unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
7e394e8a 88struct regulator *dev_pm_opp_get_regulator(struct device *dev);
e1f60b29 89
19445b25
BZ
90bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
91
5d4879cd 92int dev_pm_opp_get_opp_count(struct device *dev);
3ca9bb33 93unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
655c9df9 94unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
21743447 95unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
3aa26a3b 96unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
e1f60b29 97
47d43ba7
NM
98struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
99 unsigned long freq,
100 bool available);
e1f60b29 101
47d43ba7
NM
102struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
103 unsigned long *freq);
e1f60b29 104
47d43ba7
NM
105struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
106 unsigned long *freq);
7034764a 107void dev_pm_opp_put(struct dev_pm_opp *opp);
e1f60b29 108
5d4879cd
NM
109int dev_pm_opp_add(struct device *dev, unsigned long freq,
110 unsigned long u_volt);
129eec55 111void dev_pm_opp_remove(struct device *dev, unsigned long freq);
e1f60b29 112
7c999515
SB
113int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
114 unsigned long u_volt);
115
5d4879cd 116int dev_pm_opp_enable(struct device *dev, unsigned long freq);
e1f60b29 117
5d4879cd 118int dev_pm_opp_disable(struct device *dev, unsigned long freq);
e1f60b29 119
dc2c9ad5
VK
120int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
121int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
122
fa30184d
VK
123struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
124void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
125struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
126void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
dfbe4678
VK
127struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
128void dev_pm_opp_put_regulators(struct opp_table *opp_table);
829a4e8c
VK
129struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name);
130void dev_pm_opp_put_clkname(struct opp_table *opp_table);
fa30184d 131struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
604a7aeb 132void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
b6aa9836
VK
133struct opp_table *dev_pm_opp_register_get_pstate_helper(struct device *dev, int (*get_pstate)(struct device *dev, unsigned long rate));
134void dev_pm_opp_unregister_get_pstate_helper(struct opp_table *opp_table);
6a0712f6 135int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
ddbb74bc
AB
136int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
137int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
411466c5
SH
138void dev_pm_opp_remove_table(struct device *dev);
139void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
e1f60b29 140#else
f067a982
VK
141static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
142{
143 return ERR_PTR(-ENOTSUPP);
144}
145
146static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
147
47d43ba7 148static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
e1f60b29
NM
149{
150 return 0;
151}
152
47d43ba7 153static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
e1f60b29
NM
154{
155 return 0;
156}
157
19445b25
BZ
158static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
159{
160 return false;
161}
162
5d4879cd 163static inline int dev_pm_opp_get_opp_count(struct device *dev)
e1f60b29
NM
164{
165 return 0;
166}
167
3ca9bb33
VK
168static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
169{
170 return 0;
171}
172
655c9df9
VK
173static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
174{
175 return 0;
176}
177
21743447
VK
178static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
179{
180 return 0;
181}
182
3aa26a3b 183static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
4eafbd15 184{
3aa26a3b 185 return 0;
4eafbd15
BZ
186}
187
47d43ba7 188static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
e1f60b29
NM
189 unsigned long freq, bool available)
190{
d708b384 191 return ERR_PTR(-ENOTSUPP);
e1f60b29
NM
192}
193
47d43ba7 194static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
e1f60b29
NM
195 unsigned long *freq)
196{
d708b384 197 return ERR_PTR(-ENOTSUPP);
e1f60b29
NM
198}
199
47d43ba7 200static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
e1f60b29
NM
201 unsigned long *freq)
202{
d708b384 203 return ERR_PTR(-ENOTSUPP);
e1f60b29
NM
204}
205
7034764a
VK
206static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
207
5d4879cd 208static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
e1f60b29
NM
209 unsigned long u_volt)
210{
d708b384 211 return -ENOTSUPP;
e1f60b29
NM
212}
213
129eec55
VK
214static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
215{
216}
217
7c999515
SB
218static inline int
219dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
220 unsigned long u_volt)
221{
222 return 0;
223}
224
5d4879cd 225static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
e1f60b29
NM
226{
227 return 0;
228}
229
5d4879cd 230static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
e1f60b29
NM
231{
232 return 0;
233}
03ca370f 234
dc2c9ad5 235static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
03ca370f 236{
dc2c9ad5
VK
237 return -ENOTSUPP;
238}
239
240static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
241{
242 return -ENOTSUPP;
03ca370f 243}
7de36b0a 244
fa30184d
VK
245static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
246 const u32 *versions,
247 unsigned int count)
7de36b0a 248{
fa30184d 249 return ERR_PTR(-ENOTSUPP);
7de36b0a
VK
250}
251
fa30184d 252static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
7de36b0a 253
fa30184d 254static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
4dab160e
VK
255 int (*set_opp)(struct dev_pm_set_opp_data *data))
256{
fa30184d 257 return ERR_PTR(-ENOTSUPP);
4dab160e
VK
258}
259
604a7aeb 260static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
4dab160e 261
b6aa9836
VK
262static inline struct opp_table *dev_pm_opp_register_get_pstate_helper(struct device *dev,
263 int (*get_pstate)(struct device *dev, unsigned long rate))
264{
265 return ERR_PTR(-ENOTSUPP);
266}
267
268static inline void dev_pm_opp_unregister_get_pstate_helper(struct opp_table *opp_table) {}
269
fa30184d 270static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
01fb4d3c 271{
fa30184d 272 return ERR_PTR(-ENOTSUPP);
01fb4d3c
VK
273}
274
fa30184d 275static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
01fb4d3c 276
dfbe4678 277static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
9f8ea969 278{
91291d9a 279 return ERR_PTR(-ENOTSUPP);
9f8ea969
VK
280}
281
dfbe4678 282static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
9f8ea969 283
829a4e8c
VK
284static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name)
285{
286 return ERR_PTR(-ENOTSUPP);
287}
288
289static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
290
6a0712f6
VK
291static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
292{
d708b384 293 return -ENOTSUPP;
6a0712f6
VK
294}
295
ddbb74bc 296static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
642aa8ce 297{
d708b384 298 return -ENOTSUPP;
642aa8ce
VK
299}
300
ddbb74bc 301static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
6f707daa
VK
302{
303 return -EINVAL;
304}
305
411466c5
SH
306static inline void dev_pm_opp_remove_table(struct device *dev)
307{
308}
309
310static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
311{
312}
313
a96d69d1 314#endif /* CONFIG_PM_OPP */
e1f60b29 315
d6561bb2 316#if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
8f8d37b2
VK
317int dev_pm_opp_of_add_table(struct device *dev);
318void dev_pm_opp_of_remove_table(struct device *dev);
ddbb74bc
AB
319int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
320void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
321int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
0764c604 322struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
d6561bb2 323#else
8f8d37b2 324static inline int dev_pm_opp_of_add_table(struct device *dev)
d6561bb2 325{
d708b384 326 return -ENOTSUPP;
d6561bb2 327}
129eec55 328
8f8d37b2 329static inline void dev_pm_opp_of_remove_table(struct device *dev)
129eec55
VK
330{
331}
8d4d4e98 332
ddbb74bc 333static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
8d4d4e98 334{
d708b384 335 return -ENOTSUPP;
8d4d4e98
VK
336}
337
ddbb74bc 338static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
8d4d4e98
VK
339{
340}
341
ddbb74bc 342static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
8d4d4e98 343{
d708b384 344 return -ENOTSUPP;
8d4d4e98 345}
0764c604
DG
346
347static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
348{
349 return NULL;
350}
d6561bb2
SG
351#endif
352
e1f60b29 353#endif /* __LINUX_OPP_H__ */