Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
a3c98b8b MH |
2 | /* |
3 | * devfreq: Generic Dynamic Voltage and Frequency Scaling (DVFS) Framework | |
4 | * for Non-CPU Devices. | |
5 | * | |
6 | * Copyright (C) 2011 Samsung Electronics | |
7 | * MyungJoo Ham <myungjoo.ham@samsung.com> | |
a3c98b8b MH |
8 | */ |
9 | ||
10 | #ifndef __LINUX_DEVFREQ_H__ | |
11 | #define __LINUX_DEVFREQ_H__ | |
12 | ||
13 | #include <linux/device.h> | |
14 | #include <linux/notifier.h> | |
e4db1c74 | 15 | #include <linux/pm_opp.h> |
27dbc542 | 16 | #include <linux/pm_qos.h> |
a3c98b8b | 17 | |
aa7c352f CC |
18 | /* DEVFREQ governor name */ |
19 | #define DEVFREQ_GOV_SIMPLE_ONDEMAND "simple_ondemand" | |
20 | #define DEVFREQ_GOV_PERFORMANCE "performance" | |
21 | #define DEVFREQ_GOV_POWERSAVE "powersave" | |
22 | #define DEVFREQ_GOV_USERSPACE "userspace" | |
23 | #define DEVFREQ_GOV_PASSIVE "passive" | |
24 | ||
0fe3a664 CC |
25 | /* DEVFREQ notifier interface */ |
26 | #define DEVFREQ_TRANSITION_NOTIFIER (0) | |
27 | ||
28 | /* Transition notifiers of DEVFREQ_TRANSITION_NOTIFIER */ | |
29 | #define DEVFREQ_PRECHANGE (0) | |
30 | #define DEVFREQ_POSTCHANGE (1) | |
31 | ||
4dc3bab8 CC |
32 | /* DEVFREQ work timers */ |
33 | enum devfreq_timer { | |
34 | DEVFREQ_TIMER_DEFERRABLE = 0, | |
35 | DEVFREQ_TIMER_DELAYED, | |
36 | DEVFREQ_TIMER_NUM, | |
37 | }; | |
38 | ||
a3c98b8b | 39 | struct devfreq; |
3ea6b700 | 40 | struct devfreq_governor; |
a03dacb0 | 41 | struct devfreq_cpu_data; |
1224451b | 42 | struct thermal_cooling_device; |
a3c98b8b MH |
43 | |
44 | /** | |
45 | * struct devfreq_dev_status - Data given from devfreq user device to | |
46 | * governors. Represents the performance | |
47 | * statistics. | |
e09651fc | 48 | * @total_time: The total time represented by this instance of |
a3c98b8b | 49 | * devfreq_dev_status |
e09651fc | 50 | * @busy_time: The time that the device was working among the |
a3c98b8b | 51 | * total_time. |
e09651fc NM |
52 | * @current_frequency: The operating frequency. |
53 | * @private_data: An entry not specified by the devfreq framework. | |
a3c98b8b MH |
54 | * A device and a specific governor may have their |
55 | * own protocol with private_data. However, because | |
56 | * this is governor-specific, a governor using this | |
57 | * will be only compatible with devices aware of it. | |
58 | */ | |
59 | struct devfreq_dev_status { | |
60 | /* both since the last measure */ | |
61 | unsigned long total_time; | |
62 | unsigned long busy_time; | |
63 | unsigned long current_frequency; | |
1a51cfdc | 64 | void *private_data; |
a3c98b8b MH |
65 | }; |
66 | ||
ab5f299f MH |
67 | /* |
68 | * The resulting frequency should be at most this. (this bound is the | |
69 | * least upper bound; thus, the resulting freq should be lower or same) | |
70 | * If the flag is not set, the resulting frequency should be at most the | |
71 | * bound (greatest lower bound) | |
72 | */ | |
73 | #define DEVFREQ_FLAG_LEAST_UPPER_BOUND 0x1 | |
74 | ||
a3c98b8b MH |
75 | /** |
76 | * struct devfreq_dev_profile - Devfreq's user device profile | |
e09651fc | 77 | * @initial_freq: The operating frequency when devfreq_add_device() is |
a3c98b8b | 78 | * called. |
e09651fc | 79 | * @polling_ms: The polling interval in ms. 0 disables polling. |
4dc3bab8 | 80 | * @timer: Timer type is either deferrable or delayed timer. |
e09651fc | 81 | * @target: The device should set its operating frequency at |
a3c98b8b MH |
82 | * freq or lowest-upper-than-freq value. If freq is |
83 | * higher than any operable frequency, set maximum. | |
84 | * Before returning, target function should set | |
85 | * freq at the current frequency. | |
ab5f299f MH |
86 | * The "flags" parameter's possible values are |
87 | * explained above with "DEVFREQ_FLAG_*" macros. | |
e09651fc | 88 | * @get_dev_status: The device should provide the current performance |
d54cdf3f MH |
89 | * status to devfreq. Governors are recommended not to |
90 | * use this directly. Instead, governors are recommended | |
91 | * to use devfreq_update_stats() along with | |
92 | * devfreq.last_status. | |
e09651fc | 93 | * @get_cur_freq: The device should provide the current frequency |
7f98a905 | 94 | * at which it is operating. |
e09651fc | 95 | * @exit: An optional callback that is called when devfreq |
a3c98b8b MH |
96 | * is removing the devfreq object due to error or |
97 | * from devfreq_remove_device() call. If the user | |
98 | * has registered devfreq->nb at a notifier-head, | |
99 | * this is the time to unregister it. | |
416b46a2 CC |
100 | * @freq_table: Optional list of frequencies to support statistics |
101 | * and freq_table must be generated in ascending order. | |
102 | * @max_state: The size of freq_table. | |
1224451b DL |
103 | * |
104 | * @is_cooling_device: A self-explanatory boolean giving the device a | |
105 | * cooling effect property. | |
a3c98b8b MH |
106 | */ |
107 | struct devfreq_dev_profile { | |
108 | unsigned long initial_freq; | |
109 | unsigned int polling_ms; | |
4dc3bab8 | 110 | enum devfreq_timer timer; |
1224451b | 111 | bool is_cooling_device; |
a3c98b8b | 112 | |
ab5f299f | 113 | int (*target)(struct device *dev, unsigned long *freq, u32 flags); |
a3c98b8b MH |
114 | int (*get_dev_status)(struct device *dev, |
115 | struct devfreq_dev_status *stat); | |
7f98a905 | 116 | int (*get_cur_freq)(struct device *dev, unsigned long *freq); |
a3c98b8b | 117 | void (*exit)(struct device *dev); |
e552bbaf | 118 | |
0ec09ac2 | 119 | unsigned long *freq_table; |
e552bbaf | 120 | unsigned int max_state; |
a3c98b8b MH |
121 | }; |
122 | ||
1ebd0bc0 KK |
123 | /** |
124 | * struct devfreq_stats - Statistics of devfreq device behavior | |
125 | * @total_trans: Number of devfreq transitions. | |
126 | * @trans_table: Statistics of devfreq transitions. | |
127 | * @time_in_state: Statistics of devfreq states. | |
128 | * @last_update: The last time stats were updated. | |
129 | */ | |
130 | struct devfreq_stats { | |
131 | unsigned int total_trans; | |
132 | unsigned int *trans_table; | |
133 | u64 *time_in_state; | |
134 | u64 last_update; | |
135 | }; | |
136 | ||
a3c98b8b MH |
137 | /** |
138 | * struct devfreq - Device devfreq structure | |
e09651fc | 139 | * @node: list node - contains the devices with devfreq that have been |
a3c98b8b | 140 | * registered. |
e09651fc NM |
141 | * @lock: a mutex to protect accessing devfreq. |
142 | * @dev: device registered by devfreq class. dev.parent is the device | |
a3c98b8b | 143 | * using devfreq. |
e09651fc NM |
144 | * @profile: device-specific devfreq profile |
145 | * @governor: method how to choose frequency based on the usage. | |
26f9c7cc | 146 | * @opp_table: Reference to OPP table of dev.parent, if one exists. |
e09651fc | 147 | * @nb: notifier block used to notify devfreq object that it should |
a3c98b8b MH |
148 | * reevaluate operable frequencies. Devfreq users may use |
149 | * devfreq.nb to the corresponding register notifier call chain. | |
e09651fc | 150 | * @work: delayed work for load monitoring. |
b5d281f6 CM |
151 | * @freq_table: current frequency table used by the devfreq driver. |
152 | * @max_state: count of entry present in the frequency table. | |
e09651fc | 153 | * @previous_freq: previously configured frequency value. |
54cb5740 | 154 | * @last_status: devfreq user device info, performance statistics |
5fdded84 KF |
155 | * @data: devfreq driver pass to governors, governor should not change it. |
156 | * @governor_data: private data for governors, devfreq core doesn't touch it. | |
27dbc542 LC |
157 | * @user_min_freq_req: PM QoS minimum frequency request from user (via sysfs) |
158 | * @user_max_freq_req: PM QoS maximum frequency request from user (via sysfs) | |
f1d981ea CC |
159 | * @scaling_min_freq: Limit minimum frequency requested by OPP interface |
160 | * @scaling_max_freq: Limit maximum frequency requested by OPP interface | |
e09651fc | 161 | * @stop_polling: devfreq polling status of a device. |
83f8ca45 LL |
162 | * @suspend_freq: frequency of a device set during suspend phase. |
163 | * @resume_freq: frequency of a device set in resume phase. | |
164 | * @suspend_count: suspend requests counter for a device. | |
1ebd0bc0 | 165 | * @stats: Statistics of devfreq device behavior |
0fe3a664 | 166 | * @transition_notifier_list: list head of DEVFREQ_TRANSITION_NOTIFIER notifier |
1224451b | 167 | * @cdev: Cooling device pointer if the devfreq has cooling property |
05d7ae15 LC |
168 | * @nb_min: Notifier block for DEV_PM_QOS_MIN_FREQUENCY |
169 | * @nb_max: Notifier block for DEV_PM_QOS_MAX_FREQUENCY | |
a3c98b8b | 170 | * |
54cb5740 | 171 | * This structure stores the devfreq information for a given device. |
a3c98b8b MH |
172 | * |
173 | * Note that when a governor accesses entries in struct devfreq in its | |
174 | * functions except for the context of callbacks defined in struct | |
175 | * devfreq_governor, the governor should protect its access with the | |
176 | * struct mutex lock in struct devfreq. A governor may use this mutex | |
7a51320e | 177 | * to protect its own private data in ``void *data`` as well. |
a3c98b8b MH |
178 | */ |
179 | struct devfreq { | |
180 | struct list_head node; | |
181 | ||
182 | struct mutex lock; | |
183 | struct device dev; | |
184 | struct devfreq_dev_profile *profile; | |
185 | const struct devfreq_governor *governor; | |
26f9c7cc | 186 | struct opp_table *opp_table; |
a3c98b8b | 187 | struct notifier_block nb; |
7e6fdd4b | 188 | struct delayed_work work; |
a3c98b8b | 189 | |
b5d281f6 CM |
190 | unsigned long *freq_table; |
191 | unsigned int max_state; | |
192 | ||
a3c98b8b | 193 | unsigned long previous_freq; |
08e75e75 | 194 | struct devfreq_dev_status last_status; |
a3c98b8b | 195 | |
5fdded84 KF |
196 | void *data; |
197 | void *governor_data; | |
a3c98b8b | 198 | |
27dbc542 LC |
199 | struct dev_pm_qos_request user_min_freq_req; |
200 | struct dev_pm_qos_request user_max_freq_req; | |
f1d981ea CC |
201 | unsigned long scaling_min_freq; |
202 | unsigned long scaling_max_freq; | |
7e6fdd4b | 203 | bool stop_polling; |
e552bbaf | 204 | |
83f8ca45 LL |
205 | unsigned long suspend_freq; |
206 | unsigned long resume_freq; | |
207 | atomic_t suspend_count; | |
208 | ||
1ebd0bc0 KK |
209 | /* information for device frequency transitions */ |
210 | struct devfreq_stats stats; | |
0fe3a664 CC |
211 | |
212 | struct srcu_notifier_head transition_notifier_list; | |
05d7ae15 | 213 | |
1224451b DL |
214 | /* Pointer to the cooling device if used for thermal mitigation */ |
215 | struct thermal_cooling_device *cdev; | |
216 | ||
05d7ae15 LC |
217 | struct notifier_block nb_min; |
218 | struct notifier_block nb_max; | |
0fe3a664 CC |
219 | }; |
220 | ||
221 | struct devfreq_freqs { | |
222 | unsigned long old; | |
223 | unsigned long new; | |
a3c98b8b MH |
224 | }; |
225 | ||
226 | #if defined(CONFIG_PM_DEVFREQ) | |
6d743493 CC |
227 | struct devfreq *devfreq_add_device(struct device *dev, |
228 | struct devfreq_dev_profile *profile, | |
229 | const char *governor_name, | |
230 | void *data); | |
231 | int devfreq_remove_device(struct devfreq *devfreq); | |
232 | struct devfreq *devm_devfreq_add_device(struct device *dev, | |
233 | struct devfreq_dev_profile *profile, | |
234 | const char *governor_name, | |
235 | void *data); | |
236 | void devm_devfreq_remove_device(struct device *dev, struct devfreq *devfreq); | |
de9c7394 | 237 | |
464ed18e | 238 | /* Supposed to be called by PM callbacks */ |
6d743493 CC |
239 | int devfreq_suspend_device(struct devfreq *devfreq); |
240 | int devfreq_resume_device(struct devfreq *devfreq); | |
a3c98b8b | 241 | |
6d743493 CC |
242 | void devfreq_suspend(void); |
243 | void devfreq_resume(void); | |
59031956 | 244 | |
3e2ac979 | 245 | /* update_devfreq() - Reevaluate the device and configure frequency */ |
6d743493 | 246 | int update_devfreq(struct devfreq *devfreq); |
b596d895 | 247 | |
a3c98b8b | 248 | /* Helper functions for devfreq user device driver with OPP. */ |
6d743493 CC |
249 | struct dev_pm_opp *devfreq_recommended_opp(struct device *dev, |
250 | unsigned long *freq, u32 flags); | |
251 | int devfreq_register_opp_notifier(struct device *dev, | |
252 | struct devfreq *devfreq); | |
253 | int devfreq_unregister_opp_notifier(struct device *dev, | |
254 | struct devfreq *devfreq); | |
255 | int devm_devfreq_register_opp_notifier(struct device *dev, | |
256 | struct devfreq *devfreq); | |
257 | void devm_devfreq_unregister_opp_notifier(struct device *dev, | |
258 | struct devfreq *devfreq); | |
259 | int devfreq_register_notifier(struct devfreq *devfreq, | |
260 | struct notifier_block *nb, | |
261 | unsigned int list); | |
262 | int devfreq_unregister_notifier(struct devfreq *devfreq, | |
263 | struct notifier_block *nb, | |
264 | unsigned int list); | |
265 | int devm_devfreq_register_notifier(struct device *dev, | |
0fe3a664 CC |
266 | struct devfreq *devfreq, |
267 | struct notifier_block *nb, | |
268 | unsigned int list); | |
6d743493 | 269 | void devm_devfreq_unregister_notifier(struct device *dev, |
0fe3a664 CC |
270 | struct devfreq *devfreq, |
271 | struct notifier_block *nb, | |
272 | unsigned int list); | |
7b38b7b0 | 273 | struct devfreq *devfreq_get_devfreq_by_node(struct device_node *node); |
86d90fd9 CC |
274 | struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, |
275 | const char *phandle_name, int index); | |
dbd7a2a9 | 276 | #endif /* CONFIG_PM_DEVFREQ */ |
8f510aeb | 277 | |
ce26c5bb | 278 | /** |
7a51320e | 279 | * struct devfreq_simple_ondemand_data - ``void *data`` fed to struct devfreq |
ce26c5bb | 280 | * and devfreq_add_device |
e09651fc | 281 | * @upthreshold: If the load is over this value, the frequency jumps. |
ce26c5bb | 282 | * Specify 0 to use the default. Valid value = 0 to 100. |
e09651fc | 283 | * @downdifferential: If the load is under upthreshold - downdifferential, |
ce26c5bb MH |
284 | * the governor may consider slowing the frequency down. |
285 | * Specify 0 to use the default. Valid value = 0 to 100. | |
286 | * downdifferential < upthreshold must hold. | |
287 | * | |
288 | * If the fed devfreq_simple_ondemand_data pointer is NULL to the governor, | |
289 | * the governor uses the default values. | |
290 | */ | |
291 | struct devfreq_simple_ondemand_data { | |
292 | unsigned int upthreshold; | |
293 | unsigned int downdifferential; | |
294 | }; | |
ce26c5bb | 295 | |
a03dacb0 SK |
296 | enum devfreq_parent_dev_type { |
297 | DEVFREQ_PARENT_DEV, | |
298 | CPUFREQ_PARENT_DEV, | |
299 | }; | |
300 | ||
99613311 | 301 | /** |
7a51320e | 302 | * struct devfreq_passive_data - ``void *data`` fed to struct devfreq |
99613311 CC |
303 | * and devfreq_add_device |
304 | * @parent: the devfreq instance of parent device. | |
305 | * @get_target_freq: Optional callback, Returns desired operating frequency | |
306 | * for the device using passive governor. That is called | |
307 | * when passive governor should decide the next frequency | |
308 | * by using the new frequency of parent devfreq device | |
309 | * using governors except for passive governor. | |
310 | * If the devfreq device has the specific method to decide | |
311 | * the next frequency, should use this callback. | |
a03dacb0 SK |
312 | * @parent_type: the parent type of the device. |
313 | * @this: the devfreq instance of own device. | |
314 | * @nb: the notifier block for DEVFREQ_TRANSITION_NOTIFIER or | |
315 | * CPUFREQ_TRANSITION_NOTIFIER list. | |
26984d9d | 316 | * @cpu_data_list: the list of cpu frequency data for all cpufreq_policy. |
99613311 CC |
317 | * |
318 | * The devfreq_passive_data have to set the devfreq instance of parent | |
319 | * device with governors except for the passive governor. But, don't need to | |
320 | * initialize the 'this' and 'nb' field because the devfreq core will handle | |
321 | * them. | |
322 | */ | |
323 | struct devfreq_passive_data { | |
324 | /* Should set the devfreq instance of parent device */ | |
325 | struct devfreq *parent; | |
326 | ||
327 | /* Optional callback to decide the next frequency of passvice device */ | |
328 | int (*get_target_freq)(struct devfreq *this, unsigned long *freq); | |
329 | ||
a03dacb0 SK |
330 | /* Should set the type of parent device */ |
331 | enum devfreq_parent_dev_type parent_type; | |
332 | ||
99613311 CC |
333 | /* For passive governor's internal use. Don't need to set them */ |
334 | struct devfreq *this; | |
335 | struct notifier_block nb; | |
26984d9d | 336 | struct list_head cpu_data_list; |
99613311 | 337 | }; |
99613311 | 338 | |
dbd7a2a9 | 339 | #if !defined(CONFIG_PM_DEVFREQ) |
5faaa035 | 340 | static inline struct devfreq *devfreq_add_device(struct device *dev, |
6d743493 CC |
341 | struct devfreq_dev_profile *profile, |
342 | const char *governor_name, | |
343 | void *data) | |
a3c98b8b | 344 | { |
8cd84092 | 345 | return ERR_PTR(-ENOSYS); |
a3c98b8b MH |
346 | } |
347 | ||
5faaa035 | 348 | static inline int devfreq_remove_device(struct devfreq *devfreq) |
a3c98b8b MH |
349 | { |
350 | return 0; | |
351 | } | |
352 | ||
8cd84092 CC |
353 | static inline struct devfreq *devm_devfreq_add_device(struct device *dev, |
354 | struct devfreq_dev_profile *profile, | |
355 | const char *governor_name, | |
356 | void *data) | |
357 | { | |
358 | return ERR_PTR(-ENOSYS); | |
359 | } | |
360 | ||
361 | static inline void devm_devfreq_remove_device(struct device *dev, | |
362 | struct devfreq *devfreq) | |
363 | { | |
364 | } | |
365 | ||
5faaa035 | 366 | static inline int devfreq_suspend_device(struct devfreq *devfreq) |
206c30cf RV |
367 | { |
368 | return 0; | |
369 | } | |
370 | ||
5faaa035 | 371 | static inline int devfreq_resume_device(struct devfreq *devfreq) |
206c30cf RV |
372 | { |
373 | return 0; | |
374 | } | |
375 | ||
59031956 LL |
376 | static inline void devfreq_suspend(void) {} |
377 | static inline void devfreq_resume(void) {} | |
378 | ||
47d43ba7 | 379 | static inline struct dev_pm_opp *devfreq_recommended_opp(struct device *dev, |
6d743493 | 380 | unsigned long *freq, u32 flags) |
a3c98b8b | 381 | { |
5faaa035 | 382 | return ERR_PTR(-EINVAL); |
a3c98b8b MH |
383 | } |
384 | ||
5faaa035 | 385 | static inline int devfreq_register_opp_notifier(struct device *dev, |
6d743493 | 386 | struct devfreq *devfreq) |
a3c98b8b MH |
387 | { |
388 | return -EINVAL; | |
389 | } | |
390 | ||
5faaa035 | 391 | static inline int devfreq_unregister_opp_notifier(struct device *dev, |
6d743493 | 392 | struct devfreq *devfreq) |
a3c98b8b MH |
393 | { |
394 | return -EINVAL; | |
395 | } | |
396 | ||
d5b040d0 | 397 | static inline int devm_devfreq_register_opp_notifier(struct device *dev, |
6d743493 | 398 | struct devfreq *devfreq) |
d5b040d0 CC |
399 | { |
400 | return -EINVAL; | |
401 | } | |
402 | ||
403 | static inline void devm_devfreq_unregister_opp_notifier(struct device *dev, | |
6d743493 | 404 | struct devfreq *devfreq) |
d5b040d0 CC |
405 | { |
406 | } | |
08e75e75 | 407 | |
0fe3a664 CC |
408 | static inline int devfreq_register_notifier(struct devfreq *devfreq, |
409 | struct notifier_block *nb, | |
410 | unsigned int list) | |
411 | { | |
412 | return 0; | |
413 | } | |
414 | ||
415 | static inline int devfreq_unregister_notifier(struct devfreq *devfreq, | |
416 | struct notifier_block *nb, | |
417 | unsigned int list) | |
418 | { | |
419 | return 0; | |
420 | } | |
421 | ||
422 | static inline int devm_devfreq_register_notifier(struct device *dev, | |
6d743493 CC |
423 | struct devfreq *devfreq, |
424 | struct notifier_block *nb, | |
425 | unsigned int list) | |
0fe3a664 CC |
426 | { |
427 | return 0; | |
428 | } | |
429 | ||
430 | static inline void devm_devfreq_unregister_notifier(struct device *dev, | |
6d743493 CC |
431 | struct devfreq *devfreq, |
432 | struct notifier_block *nb, | |
433 | unsigned int list) | |
0fe3a664 CC |
434 | { |
435 | } | |
436 | ||
7b38b7b0 LC |
437 | static inline struct devfreq *devfreq_get_devfreq_by_node(struct device_node *node) |
438 | { | |
439 | return ERR_PTR(-ENODEV); | |
440 | } | |
441 | ||
8f510aeb | 442 | static inline struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, |
86d90fd9 | 443 | const char *phandle_name, int index) |
8f510aeb CC |
444 | { |
445 | return ERR_PTR(-ENODEV); | |
446 | } | |
447 | ||
08e75e75 JM |
448 | static inline int devfreq_update_stats(struct devfreq *df) |
449 | { | |
450 | return -EINVAL; | |
451 | } | |
a3c98b8b MH |
452 | #endif /* CONFIG_PM_DEVFREQ */ |
453 | ||
454 | #endif /* __LINUX_DEVFREQ_H__ */ |