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