Revert "cpufreq: Drop rwsem lock around CPUFREQ_GOV_POLICY_EXIT"
[deliverable/linux.git] / include / linux / cpufreq.h
1 /*
2 * linux/include/linux/cpufreq.h
3 *
4 * Copyright (C) 2001 Russell King
5 * (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 */
11 #ifndef _LINUX_CPUFREQ_H
12 #define _LINUX_CPUFREQ_H
13
14 #include <linux/clk.h>
15 #include <linux/cpumask.h>
16 #include <linux/completion.h>
17 #include <linux/kobject.h>
18 #include <linux/notifier.h>
19 #include <linux/spinlock.h>
20 #include <linux/sysfs.h>
21
22 /*********************************************************************
23 * CPUFREQ INTERFACE *
24 *********************************************************************/
25 /*
26 * Frequency values here are CPU kHz
27 *
28 * Maximum transition latency is in nanoseconds - if it's unknown,
29 * CPUFREQ_ETERNAL shall be used.
30 */
31
32 #define CPUFREQ_ETERNAL (-1)
33 #define CPUFREQ_NAME_LEN 16
34 /* Print length for names. Extra 1 space for accomodating '\n' in prints */
35 #define CPUFREQ_NAME_PLEN (CPUFREQ_NAME_LEN + 1)
36
37 struct cpufreq_governor;
38
39 struct cpufreq_freqs {
40 unsigned int cpu; /* cpu nr */
41 unsigned int old;
42 unsigned int new;
43 u8 flags; /* flags of cpufreq_driver, see below. */
44 };
45
46 struct cpufreq_cpuinfo {
47 unsigned int max_freq;
48 unsigned int min_freq;
49
50 /* in 10^(-9) s = nanoseconds */
51 unsigned int transition_latency;
52 };
53
54 struct cpufreq_user_policy {
55 unsigned int min; /* in kHz */
56 unsigned int max; /* in kHz */
57 };
58
59 struct cpufreq_policy {
60 /* CPUs sharing clock, require sw coordination */
61 cpumask_var_t cpus; /* Online CPUs only */
62 cpumask_var_t related_cpus; /* Online + Offline CPUs */
63 cpumask_var_t real_cpus; /* Related and present */
64
65 unsigned int shared_type; /* ACPI: ANY or ALL affected CPUs
66 should set cpufreq */
67 unsigned int cpu; /* cpu managing this policy, must be online */
68
69 struct clk *clk;
70 struct cpufreq_cpuinfo cpuinfo;/* see above */
71
72 unsigned int min; /* in kHz */
73 unsigned int max; /* in kHz */
74 unsigned int cur; /* in kHz, only needed if cpufreq
75 * governors are used */
76 unsigned int restore_freq; /* = policy->cur before transition */
77 unsigned int suspend_freq; /* freq to set during suspend */
78
79 unsigned int policy; /* see above */
80 unsigned int last_policy; /* policy before unplug */
81 struct cpufreq_governor *governor; /* see below */
82 void *governor_data;
83 bool governor_enabled; /* governor start/stop flag */
84 char last_governor[CPUFREQ_NAME_LEN]; /* last governor used */
85
86 struct work_struct update; /* if update_policy() needs to be
87 * called, but you're in IRQ context */
88
89 struct cpufreq_user_policy user_policy;
90 struct cpufreq_frequency_table *freq_table;
91
92 struct list_head policy_list;
93 struct kobject kobj;
94 struct completion kobj_unregister;
95
96 /*
97 * The rules for this semaphore:
98 * - Any routine that wants to read from the policy structure will
99 * do a down_read on this semaphore.
100 * - Any routine that will write to the policy structure and/or may take away
101 * the policy altogether (eg. CPU hotplug), will hold this lock in write
102 * mode before doing so.
103 */
104 struct rw_semaphore rwsem;
105
106 /* Synchronization for frequency transitions */
107 bool transition_ongoing; /* Tracks transition status */
108 spinlock_t transition_lock;
109 wait_queue_head_t transition_wait;
110 struct task_struct *transition_task; /* Task which is doing the transition */
111
112 /* cpufreq-stats */
113 struct cpufreq_stats *stats;
114
115 /* For cpufreq driver's internal use */
116 void *driver_data;
117 };
118
119 /* Only for ACPI */
120 #define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
121 #define CPUFREQ_SHARED_TYPE_HW (1) /* HW does needed coordination */
122 #define CPUFREQ_SHARED_TYPE_ALL (2) /* All dependent CPUs should set freq */
123 #define CPUFREQ_SHARED_TYPE_ANY (3) /* Freq can be set from any dependent CPU*/
124
125 #ifdef CONFIG_CPU_FREQ
126 struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
127 struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
128 void cpufreq_cpu_put(struct cpufreq_policy *policy);
129 #else
130 static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu)
131 {
132 return NULL;
133 }
134 static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
135 {
136 return NULL;
137 }
138 static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
139 #endif
140
141 static inline bool policy_is_shared(struct cpufreq_policy *policy)
142 {
143 return cpumask_weight(policy->cpus) > 1;
144 }
145
146 /* /sys/devices/system/cpu/cpufreq: entry point for global variables */
147 extern struct kobject *cpufreq_global_kobject;
148
149 #ifdef CONFIG_CPU_FREQ
150 void cpufreq_update_util(u64 time, unsigned long util, unsigned long max);
151
152 /**
153 * cpufreq_trigger_update - Trigger CPU performance state evaluation if needed.
154 * @time: Current time.
155 *
156 * The way cpufreq is currently arranged requires it to evaluate the CPU
157 * performance state (frequency/voltage) on a regular basis to prevent it from
158 * being stuck in a completely inadequate performance level for too long.
159 * That is not guaranteed to happen if the updates are only triggered from CFS,
160 * though, because they may not be coming in if RT or deadline tasks are active
161 * all the time (or there are RT and DL tasks only).
162 *
163 * As a workaround for that issue, this function is called by the RT and DL
164 * sched classes to trigger extra cpufreq updates to prevent it from stalling,
165 * but that really is a band-aid. Going forward it should be replaced with
166 * solutions targeted more specifically at RT and DL tasks.
167 */
168 static inline void cpufreq_trigger_update(u64 time)
169 {
170 cpufreq_update_util(time, ULONG_MAX, 0);
171 }
172
173 struct update_util_data {
174 void (*func)(struct update_util_data *data,
175 u64 time, unsigned long util, unsigned long max);
176 };
177
178 void cpufreq_set_update_util_data(int cpu, struct update_util_data *data);
179
180 unsigned int cpufreq_get(unsigned int cpu);
181 unsigned int cpufreq_quick_get(unsigned int cpu);
182 unsigned int cpufreq_quick_get_max(unsigned int cpu);
183 void disable_cpufreq(void);
184
185 u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
186 int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
187 int cpufreq_update_policy(unsigned int cpu);
188 bool have_governor_per_policy(void);
189 struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
190 #else
191 static inline void cpufreq_update_util(u64 time, unsigned long util,
192 unsigned long max) {}
193 static inline void cpufreq_trigger_update(u64 time) {}
194
195 static inline unsigned int cpufreq_get(unsigned int cpu)
196 {
197 return 0;
198 }
199 static inline unsigned int cpufreq_quick_get(unsigned int cpu)
200 {
201 return 0;
202 }
203 static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
204 {
205 return 0;
206 }
207 static inline void disable_cpufreq(void) { }
208 #endif
209
210 /*********************************************************************
211 * CPUFREQ DRIVER INTERFACE *
212 *********************************************************************/
213
214 #define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */
215 #define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */
216 #define CPUFREQ_RELATION_C 2 /* closest frequency to target */
217
218 struct freq_attr {
219 struct attribute attr;
220 ssize_t (*show)(struct cpufreq_policy *, char *);
221 ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
222 };
223
224 #define cpufreq_freq_attr_ro(_name) \
225 static struct freq_attr _name = \
226 __ATTR(_name, 0444, show_##_name, NULL)
227
228 #define cpufreq_freq_attr_ro_perm(_name, _perm) \
229 static struct freq_attr _name = \
230 __ATTR(_name, _perm, show_##_name, NULL)
231
232 #define cpufreq_freq_attr_rw(_name) \
233 static struct freq_attr _name = \
234 __ATTR(_name, 0644, show_##_name, store_##_name)
235
236 struct global_attr {
237 struct attribute attr;
238 ssize_t (*show)(struct kobject *kobj,
239 struct attribute *attr, char *buf);
240 ssize_t (*store)(struct kobject *a, struct attribute *b,
241 const char *c, size_t count);
242 };
243
244 #define define_one_global_ro(_name) \
245 static struct global_attr _name = \
246 __ATTR(_name, 0444, show_##_name, NULL)
247
248 #define define_one_global_rw(_name) \
249 static struct global_attr _name = \
250 __ATTR(_name, 0644, show_##_name, store_##_name)
251
252
253 struct cpufreq_driver {
254 char name[CPUFREQ_NAME_LEN];
255 u8 flags;
256 void *driver_data;
257
258 /* needed by all drivers */
259 int (*init)(struct cpufreq_policy *policy);
260 int (*verify)(struct cpufreq_policy *policy);
261
262 /* define one out of two */
263 int (*setpolicy)(struct cpufreq_policy *policy);
264
265 /*
266 * On failure, should always restore frequency to policy->restore_freq
267 * (i.e. old freq).
268 */
269 int (*target)(struct cpufreq_policy *policy,
270 unsigned int target_freq,
271 unsigned int relation); /* Deprecated */
272 int (*target_index)(struct cpufreq_policy *policy,
273 unsigned int index);
274 /*
275 * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION
276 * unset.
277 *
278 * get_intermediate should return a stable intermediate frequency
279 * platform wants to switch to and target_intermediate() should set CPU
280 * to to that frequency, before jumping to the frequency corresponding
281 * to 'index'. Core will take care of sending notifications and driver
282 * doesn't have to handle them in target_intermediate() or
283 * target_index().
284 *
285 * Drivers can return '0' from get_intermediate() in case they don't
286 * wish to switch to intermediate frequency for some target frequency.
287 * In that case core will directly call ->target_index().
288 */
289 unsigned int (*get_intermediate)(struct cpufreq_policy *policy,
290 unsigned int index);
291 int (*target_intermediate)(struct cpufreq_policy *policy,
292 unsigned int index);
293
294 /* should be defined, if possible */
295 unsigned int (*get)(unsigned int cpu);
296
297 /* optional */
298 int (*bios_limit)(int cpu, unsigned int *limit);
299
300 int (*exit)(struct cpufreq_policy *policy);
301 void (*stop_cpu)(struct cpufreq_policy *policy);
302 int (*suspend)(struct cpufreq_policy *policy);
303 int (*resume)(struct cpufreq_policy *policy);
304
305 /* Will be called after the driver is fully initialized */
306 void (*ready)(struct cpufreq_policy *policy);
307
308 struct freq_attr **attr;
309
310 /* platform specific boost support code */
311 bool boost_enabled;
312 int (*set_boost)(int state);
313 };
314
315 /* flags */
316 #define CPUFREQ_STICKY (1 << 0) /* driver isn't removed even if
317 all ->init() calls failed */
318 #define CPUFREQ_CONST_LOOPS (1 << 1) /* loops_per_jiffy or other
319 kernel "constants" aren't
320 affected by frequency
321 transitions */
322 #define CPUFREQ_PM_NO_WARN (1 << 2) /* don't warn on suspend/resume
323 speed mismatches */
324
325 /*
326 * This should be set by platforms having multiple clock-domains, i.e.
327 * supporting multiple policies. With this sysfs directories of governor would
328 * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
329 * governor with different tunables for different clusters.
330 */
331 #define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
332
333 /*
334 * Driver will do POSTCHANGE notifications from outside of their ->target()
335 * routine and so must set cpufreq_driver->flags with this flag, so that core
336 * can handle them specially.
337 */
338 #define CPUFREQ_ASYNC_NOTIFICATION (1 << 4)
339
340 /*
341 * Set by drivers which want cpufreq core to check if CPU is running at a
342 * frequency present in freq-table exposed by the driver. For these drivers if
343 * CPU is found running at an out of table freq, we will try to set it to a freq
344 * from the table. And if that fails, we will stop further boot process by
345 * issuing a BUG_ON().
346 */
347 #define CPUFREQ_NEED_INITIAL_FREQ_CHECK (1 << 5)
348
349 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
350 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
351
352 const char *cpufreq_get_current_driver(void);
353 void *cpufreq_get_driver_data(void);
354
355 static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
356 unsigned int min, unsigned int max)
357 {
358 if (policy->min < min)
359 policy->min = min;
360 if (policy->max < min)
361 policy->max = min;
362 if (policy->min > max)
363 policy->min = max;
364 if (policy->max > max)
365 policy->max = max;
366 if (policy->min > policy->max)
367 policy->min = policy->max;
368 return;
369 }
370
371 static inline void
372 cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
373 {
374 cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
375 policy->cpuinfo.max_freq);
376 }
377
378 #ifdef CONFIG_CPU_FREQ
379 void cpufreq_suspend(void);
380 void cpufreq_resume(void);
381 int cpufreq_generic_suspend(struct cpufreq_policy *policy);
382 #else
383 static inline void cpufreq_suspend(void) {}
384 static inline void cpufreq_resume(void) {}
385 #endif
386
387 /*********************************************************************
388 * CPUFREQ NOTIFIER INTERFACE *
389 *********************************************************************/
390
391 #define CPUFREQ_TRANSITION_NOTIFIER (0)
392 #define CPUFREQ_POLICY_NOTIFIER (1)
393
394 /* Transition notifiers */
395 #define CPUFREQ_PRECHANGE (0)
396 #define CPUFREQ_POSTCHANGE (1)
397
398 /* Policy Notifiers */
399 #define CPUFREQ_ADJUST (0)
400 #define CPUFREQ_NOTIFY (1)
401 #define CPUFREQ_START (2)
402 #define CPUFREQ_CREATE_POLICY (3)
403 #define CPUFREQ_REMOVE_POLICY (4)
404
405 #ifdef CONFIG_CPU_FREQ
406 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
407 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
408
409 void cpufreq_freq_transition_begin(struct cpufreq_policy *policy,
410 struct cpufreq_freqs *freqs);
411 void cpufreq_freq_transition_end(struct cpufreq_policy *policy,
412 struct cpufreq_freqs *freqs, int transition_failed);
413
414 #else /* CONFIG_CPU_FREQ */
415 static inline int cpufreq_register_notifier(struct notifier_block *nb,
416 unsigned int list)
417 {
418 return 0;
419 }
420 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
421 unsigned int list)
422 {
423 return 0;
424 }
425 #endif /* !CONFIG_CPU_FREQ */
426
427 /**
428 * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
429 * safe)
430 * @old: old value
431 * @div: divisor
432 * @mult: multiplier
433 *
434 *
435 * new = old * mult / div
436 */
437 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
438 u_int mult)
439 {
440 #if BITS_PER_LONG == 32
441 u64 result = ((u64) old) * ((u64) mult);
442 do_div(result, div);
443 return (unsigned long) result;
444
445 #elif BITS_PER_LONG == 64
446 unsigned long result = old * ((u64) mult);
447 result /= div;
448 return result;
449 #endif
450 }
451
452 /*********************************************************************
453 * CPUFREQ GOVERNORS *
454 *********************************************************************/
455
456 /*
457 * If (cpufreq_driver->target) exists, the ->governor decides what frequency
458 * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
459 * two generic policies are available:
460 */
461 #define CPUFREQ_POLICY_POWERSAVE (1)
462 #define CPUFREQ_POLICY_PERFORMANCE (2)
463
464 /* Governor Events */
465 #define CPUFREQ_GOV_START 1
466 #define CPUFREQ_GOV_STOP 2
467 #define CPUFREQ_GOV_LIMITS 3
468 #define CPUFREQ_GOV_POLICY_INIT 4
469 #define CPUFREQ_GOV_POLICY_EXIT 5
470
471 struct cpufreq_governor {
472 char name[CPUFREQ_NAME_LEN];
473 int initialized;
474 int (*governor) (struct cpufreq_policy *policy,
475 unsigned int event);
476 ssize_t (*show_setspeed) (struct cpufreq_policy *policy,
477 char *buf);
478 int (*store_setspeed) (struct cpufreq_policy *policy,
479 unsigned int freq);
480 unsigned int max_transition_latency; /* HW must be able to switch to
481 next freq faster than this value in nano secs or we
482 will fallback to performance governor */
483 struct list_head governor_list;
484 struct module *owner;
485 };
486
487 /* Pass a target to the cpufreq driver */
488 int cpufreq_driver_target(struct cpufreq_policy *policy,
489 unsigned int target_freq,
490 unsigned int relation);
491 int __cpufreq_driver_target(struct cpufreq_policy *policy,
492 unsigned int target_freq,
493 unsigned int relation);
494 int cpufreq_register_governor(struct cpufreq_governor *governor);
495 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
496
497 struct cpufreq_governor *cpufreq_default_governor(void);
498 struct cpufreq_governor *cpufreq_fallback_governor(void);
499
500 /*********************************************************************
501 * FREQUENCY TABLE HELPERS *
502 *********************************************************************/
503
504 /* Special Values of .frequency field */
505 #define CPUFREQ_ENTRY_INVALID ~0u
506 #define CPUFREQ_TABLE_END ~1u
507 /* Special Values of .flags field */
508 #define CPUFREQ_BOOST_FREQ (1 << 0)
509
510 struct cpufreq_frequency_table {
511 unsigned int flags;
512 unsigned int driver_data; /* driver specific data, not used by core */
513 unsigned int frequency; /* kHz - doesn't need to be in ascending
514 * order */
515 };
516
517 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP)
518 int dev_pm_opp_init_cpufreq_table(struct device *dev,
519 struct cpufreq_frequency_table **table);
520 void dev_pm_opp_free_cpufreq_table(struct device *dev,
521 struct cpufreq_frequency_table **table);
522 #else
523 static inline int dev_pm_opp_init_cpufreq_table(struct device *dev,
524 struct cpufreq_frequency_table
525 **table)
526 {
527 return -EINVAL;
528 }
529
530 static inline void dev_pm_opp_free_cpufreq_table(struct device *dev,
531 struct cpufreq_frequency_table
532 **table)
533 {
534 }
535 #endif
536
537 static inline bool cpufreq_next_valid(struct cpufreq_frequency_table **pos)
538 {
539 while ((*pos)->frequency != CPUFREQ_TABLE_END)
540 if ((*pos)->frequency != CPUFREQ_ENTRY_INVALID)
541 return true;
542 else
543 (*pos)++;
544 return false;
545 }
546
547 /*
548 * cpufreq_for_each_entry - iterate over a cpufreq_frequency_table
549 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
550 * @table: the cpufreq_frequency_table * to iterate over.
551 */
552
553 #define cpufreq_for_each_entry(pos, table) \
554 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
555
556 /*
557 * cpufreq_for_each_valid_entry - iterate over a cpufreq_frequency_table
558 * excluding CPUFREQ_ENTRY_INVALID frequencies.
559 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
560 * @table: the cpufreq_frequency_table * to iterate over.
561 */
562
563 #define cpufreq_for_each_valid_entry(pos, table) \
564 for (pos = table; cpufreq_next_valid(&pos); pos++)
565
566 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
567 struct cpufreq_frequency_table *table);
568
569 int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
570 struct cpufreq_frequency_table *table);
571 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
572
573 int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
574 struct cpufreq_frequency_table *table,
575 unsigned int target_freq,
576 unsigned int relation,
577 unsigned int *index);
578 int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
579 unsigned int freq);
580
581 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
582
583 #ifdef CONFIG_CPU_FREQ
584 int cpufreq_boost_trigger_state(int state);
585 int cpufreq_boost_enabled(void);
586 int cpufreq_enable_boost_support(void);
587 bool policy_has_boost_freq(struct cpufreq_policy *policy);
588 #else
589 static inline int cpufreq_boost_trigger_state(int state)
590 {
591 return 0;
592 }
593 static inline int cpufreq_boost_enabled(void)
594 {
595 return 0;
596 }
597
598 static inline int cpufreq_enable_boost_support(void)
599 {
600 return -EINVAL;
601 }
602
603 static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
604 {
605 return false;
606 }
607 #endif
608 /* the following funtion is for cpufreq core use only */
609 struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu);
610
611 /* the following are really really optional */
612 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
613 extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
614 extern struct freq_attr *cpufreq_generic_attr[];
615 int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
616 struct cpufreq_frequency_table *table);
617
618 unsigned int cpufreq_generic_get(unsigned int cpu);
619 int cpufreq_generic_init(struct cpufreq_policy *policy,
620 struct cpufreq_frequency_table *table,
621 unsigned int transition_latency);
622 #endif /* _LINUX_CPUFREQ_H */
This page took 0.099411 seconds and 5 git commands to generate.