projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 499
[linux-2.6-block.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,
03ca370f
MH		 28};
29
0f0fe7e0
VK		 30/**
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
36 *
37 * This structure stores the voltage/current values for a single power supply.
38 */
39struct dev_pm_opp_supply {
40 unsigned long u_volt;
41 unsigned long u_volt_min;
42 unsigned long u_volt_max;
43 unsigned long u_amp;
44};
45
94735585
VK		 46/**
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
50 *
51 * This structure stores the freq/voltage/current values for a single OPP.
52 */
53struct dev_pm_opp_info {
54 unsigned long rate;
55 struct dev_pm_opp_supply *supplies;
56};
57
58/**
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
66 *
67 * This structure contains all information required for setting an OPP.
68 */
69struct dev_pm_set_opp_data {
70 struct dev_pm_opp_info old_opp;
71 struct dev_pm_opp_info new_opp;
72
73 struct regulator **regulators;
74 unsigned int regulator_count;
75 struct clk *clk;
76 struct device *dev;
77};
78
e1f60b29
NM		 79#if defined(CONFIG_PM_OPP)
80
f067a982 81struct opp_table *dev_pm_opp_get_opp_table(struct device *dev);
eb7c8743 82struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index);
f067a982
VK		 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);
e1f60b29 88
5b93ac54
RN		 89unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp);
90
19445b25
BZ		 91bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
92
5d4879cd 93int dev_pm_opp_get_opp_count(struct device *dev);
3ca9bb33 94unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
655c9df9 95unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
21743447 96unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
3aa26a3b 97unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev);
e1f60b29 98
47d43ba7
NM		 99struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
100 unsigned long freq,
101 bool available);
e1f60b29 102
47d43ba7
NM		 103struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
104 unsigned long *freq);
2f36bde0
AC		 105struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
106 unsigned long u_volt);
e1f60b29 107
47d43ba7
NM		 108struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
109 unsigned long *freq);
7034764a 110void dev_pm_opp_put(struct dev_pm_opp *opp);
e1f60b29 111
5d4879cd
NM		 112int dev_pm_opp_add(struct device *dev, unsigned long freq,
113 unsigned long u_volt);
129eec55 114void dev_pm_opp_remove(struct device *dev, unsigned long freq);
1690d8bb 115void dev_pm_opp_remove_all_dynamic(struct device *dev);
e1f60b29 116
5d4879cd 117int dev_pm_opp_enable(struct device *dev, unsigned long freq);
e1f60b29 118
5d4879cd 119int dev_pm_opp_disable(struct device *dev, unsigned long freq);
e1f60b29 120
dc2c9ad5
VK		 121int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb);
122int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb);
123
fa30184d
VK		 124struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions, unsigned int count);
125void dev_pm_opp_put_supported_hw(struct opp_table *opp_table);
126struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name);
127void dev_pm_opp_put_prop_name(struct opp_table *opp_table);
dfbe4678
VK		 128struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
129void dev_pm_opp_put_regulators(struct opp_table *opp_table);
829a4e8c
VK		 130struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name);
131void dev_pm_opp_put_clkname(struct opp_table *opp_table);
fa30184d 132struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
604a7aeb 133void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table);
4f018bc0
VK		 134struct opp_table *dev_pm_opp_set_genpd_virt_dev(struct device *dev, struct device *virt_dev, int index);
135void dev_pm_opp_put_genpd_virt_dev(struct opp_table *opp_table, struct device *virt_dev);
c8a59103 136int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate);
6a0712f6 137int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
ddbb74bc
AB		 138int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
139int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
411466c5
SH		 140void dev_pm_opp_remove_table(struct device *dev);
141void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
e1f60b29 142#else
f067a982
VK		 143static inline struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
144{
145 return ERR_PTR(-ENOTSUPP);
146}
147
eb7c8743
VK		 148static inline struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev, int index)
149{
150 return ERR_PTR(-ENOTSUPP);
151}
152
f067a982
VK		 153static inline void dev_pm_opp_put_opp_table(struct opp_table *opp_table) {}
154
47d43ba7 155static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
e1f60b29
NM		 156{
157 return 0;
158}
159
47d43ba7 160static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
e1f60b29
NM		 161{
162 return 0;
163}
164
5b93ac54
RN		 165static inline unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
166{
167 return 0;
168}
169
19445b25
BZ		 170static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
171{
172 return false;
173}
174
5d4879cd 175static inline int dev_pm_opp_get_opp_count(struct device *dev)
e1f60b29
NM		 176{
177 return 0;
178}
179
3ca9bb33
VK		 180static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
181{
182 return 0;
183}
184
655c9df9
VK		 185static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
186{
187 return 0;
188}
189
21743447
VK		 190static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
191{
192 return 0;
193}
194
3aa26a3b 195static inline unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
4eafbd15 196{
3aa26a3b 197 return 0;
4eafbd15
BZ		 198}
199
47d43ba7 200static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
e1f60b29
NM		 201 unsigned long freq, bool available)
202{
d708b384 203 return ERR_PTR(-ENOTSUPP);
e1f60b29
NM		 204}
205
47d43ba7 206static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
e1f60b29
NM		 207 unsigned long *freq)
208{
d708b384 209 return ERR_PTR(-ENOTSUPP);
e1f60b29
NM		 210}
211
2f36bde0
AC		 212static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
213 unsigned long u_volt)
214{
215 return ERR_PTR(-ENOTSUPP);
216}
217
47d43ba7 218static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
e1f60b29
NM		 219 unsigned long *freq)
220{
d708b384 221 return ERR_PTR(-ENOTSUPP);
e1f60b29
NM		 222}
223
7034764a
VK		 224static inline void dev_pm_opp_put(struct dev_pm_opp *opp) {}
225
5d4879cd 226static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
e1f60b29
NM		 227 unsigned long u_volt)
228{
d708b384 229 return -ENOTSUPP;
e1f60b29
NM		 230}
231
129eec55
VK		 232static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
233{
234}
235
1690d8bb
VK		 236static inline void dev_pm_opp_remove_all_dynamic(struct device *dev)
237{
238}
239
5d4879cd 240static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
e1f60b29
NM		 241{
242 return 0;
243}
244
5d4879cd 245static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
e1f60b29
NM		 246{
247 return 0;
248}
03ca370f 249
dc2c9ad5 250static inline int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
03ca370f 251{
dc2c9ad5
VK		 252 return -ENOTSUPP;
253}
254
255static inline int dev_pm_opp_unregister_notifier(struct device *dev, struct notifier_block *nb)
256{
257 return -ENOTSUPP;
03ca370f 258}
7de36b0a 259
fa30184d
VK		 260static inline struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
261 const u32 *versions,
262 unsigned int count)
7de36b0a 263{
fa30184d 264 return ERR_PTR(-ENOTSUPP);
7de36b0a
VK		 265}
266
fa30184d 267static inline void dev_pm_opp_put_supported_hw(struct opp_table *opp_table) {}
7de36b0a 268
fa30184d 269static inline struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
4dab160e
VK		 270 int (*set_opp)(struct dev_pm_set_opp_data *data))
271{
fa30184d 272 return ERR_PTR(-ENOTSUPP);
4dab160e
VK		 273}
274
604a7aeb 275static inline void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table) {}
4dab160e 276
fa30184d 277static inline struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
01fb4d3c 278{
fa30184d 279 return ERR_PTR(-ENOTSUPP);
01fb4d3c
VK		 280}
281
fa30184d 282static inline void dev_pm_opp_put_prop_name(struct opp_table *opp_table) {}
01fb4d3c 283
dfbe4678 284static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
9f8ea969 285{
91291d9a 286 return ERR_PTR(-ENOTSUPP);
9f8ea969
VK		 287}
288
dfbe4678 289static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
9f8ea969 290
829a4e8c
VK		 291static inline struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char * name)
292{
293 return ERR_PTR(-ENOTSUPP);
294}
295
296static inline void dev_pm_opp_put_clkname(struct opp_table *opp_table) {}
297
4f018bc0
VK		 298static inline struct opp_table *dev_pm_opp_set_genpd_virt_dev(struct device *dev, struct device *virt_dev, int index)
299{
300 return ERR_PTR(-ENOTSUPP);
301}
302
303static inline void dev_pm_opp_put_genpd_virt_dev(struct opp_table *opp_table, struct device *virt_dev) {}
c8a59103
VK		 304
305static inline int dev_pm_opp_xlate_performance_state(struct opp_table *src_table, struct opp_table *dst_table, unsigned int pstate)
306{
307 return -ENOTSUPP;
308}
309
6a0712f6
VK		 310static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
311{
d708b384 312 return -ENOTSUPP;
6a0712f6
VK		 313}
314
ddbb74bc 315static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
642aa8ce 316{
d708b384 317 return -ENOTSUPP;
642aa8ce
VK		 318}
319
ddbb74bc 320static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
6f707daa
VK		 321{
322 return -EINVAL;
323}
324
411466c5
SH		 325static inline void dev_pm_opp_remove_table(struct device *dev)
326{
327}
328
329static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
330{
331}
332
a96d69d1 333#endif /* CONFIG_PM_OPP */
e1f60b29 334
d6561bb2 335#if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
8f8d37b2 336int dev_pm_opp_of_add_table(struct device *dev);
fa9b274f 337int dev_pm_opp_of_add_table_indexed(struct device *dev, int index);
8f8d37b2 338void dev_pm_opp_of_remove_table(struct device *dev);
ddbb74bc
AB		 339int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
340void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
341int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
0764c604 342struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev);
e2f4b5f8 343struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp);
2feb5a89 344int of_get_required_opp_performance_state(struct device_node *np, int index);
a4f342b9 345void dev_pm_opp_of_register_em(struct cpumask *cpus);
d6561bb2 346#else
8f8d37b2 347static inline int dev_pm_opp_of_add_table(struct device *dev)
d6561bb2 348{
d708b384 349 return -ENOTSUPP;
d6561bb2 350}
129eec55 351
fa9b274f
VK		 352static inline int dev_pm_opp_of_add_table_indexed(struct device *dev, int index)
353{
354 return -ENOTSUPP;
355}
356
8f8d37b2 357static inline void dev_pm_opp_of_remove_table(struct device *dev)
129eec55
VK		 358{
359}
8d4d4e98 360
ddbb74bc 361static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
8d4d4e98 362{
d708b384 363 return -ENOTSUPP;
8d4d4e98
VK		 364}
365
ddbb74bc 366static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
8d4d4e98
VK		 367{
368}
369
ddbb74bc 370static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
8d4d4e98 371{
d708b384 372 return -ENOTSUPP;
8d4d4e98 373}
0764c604
DG		 374
375static inline struct device_node *dev_pm_opp_of_get_opp_desc_node(struct device *dev)
376{
377 return NULL;
378}
a88bd2a5 379
e2f4b5f8
VK		 380static inline struct device_node *dev_pm_opp_get_of_node(struct dev_pm_opp *opp)
381{
382 return NULL;
383}
a4f342b9
QP		 384
385static inline void dev_pm_opp_of_register_em(struct cpumask *cpus)
386{
387}
388
2feb5a89 389static inline int of_get_required_opp_performance_state(struct device_node *np, int index)
4c6a343e 390{
2feb5a89 391 return -ENOTSUPP;
4c6a343e 392}
d6561bb2
SG		 393#endif
394
e1f60b29 395#endif /* __LINUX_OPP_H__ */
Linux 6.x block layer and io_uring tree(s)