OSDN Git Service

sched/core: Add try_get_task_stack() and put_task_stack()
[sagit-ice-cold/kernel_xiaomi_msm8998.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          * Additional rules:
105          * - Lock should not be held across
106          *     __cpufreq_governor(data, CPUFREQ_GOV_POLICY_EXIT);
107          */
108         struct rw_semaphore     rwsem;
109
110         /* Synchronization for frequency transitions */
111         bool                    transition_ongoing; /* Tracks transition status */
112         spinlock_t              transition_lock;
113         wait_queue_head_t       transition_wait;
114         struct task_struct      *transition_task; /* Task which is doing the transition */
115
116         /* cpufreq-stats */
117         struct cpufreq_stats    *stats;
118
119         /* For cpufreq driver's internal use */
120         void                    *driver_data;
121 };
122
123 /* Only for ACPI */
124 #define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
125 #define CPUFREQ_SHARED_TYPE_HW   (1) /* HW does needed coordination */
126 #define CPUFREQ_SHARED_TYPE_ALL  (2) /* All dependent CPUs should set freq */
127 #define CPUFREQ_SHARED_TYPE_ANY  (3) /* Freq can be set from any dependent CPU*/
128
129 #ifdef CONFIG_CPU_FREQ
130 struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
131 struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
132 void cpufreq_cpu_put(struct cpufreq_policy *policy);
133 #else
134 static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu)
135 {
136         return NULL;
137 }
138 static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
139 {
140         return NULL;
141 }
142 static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
143 #endif
144
145 static inline bool policy_is_shared(struct cpufreq_policy *policy)
146 {
147         return cpumask_weight(policy->cpus) > 1;
148 }
149
150 /* /sys/devices/system/cpu/cpufreq: entry point for global variables */
151 extern struct kobject *cpufreq_global_kobject;
152
153 #ifdef CONFIG_CPU_FREQ
154 unsigned int cpufreq_get(unsigned int cpu);
155 unsigned int cpufreq_quick_get(unsigned int cpu);
156 unsigned int cpufreq_quick_get_max(unsigned int cpu);
157 void disable_cpufreq(void);
158
159 u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
160 int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
161 int cpufreq_update_policy(unsigned int cpu);
162 bool have_governor_per_policy(void);
163 struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
164 #else
165 static inline unsigned int cpufreq_get(unsigned int cpu)
166 {
167         return 0;
168 }
169 static inline unsigned int cpufreq_quick_get(unsigned int cpu)
170 {
171         return 0;
172 }
173 static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
174 {
175         return 0;
176 }
177 static inline void disable_cpufreq(void) { }
178 #endif
179
180 /*********************************************************************
181  *                      CPUFREQ DRIVER INTERFACE                     *
182  *********************************************************************/
183
184 #define CPUFREQ_RELATION_L 0  /* lowest frequency at or above target */
185 #define CPUFREQ_RELATION_H 1  /* highest frequency below or at target */
186 #define CPUFREQ_RELATION_C 2  /* closest frequency to target */
187
188 struct freq_attr {
189         struct attribute attr;
190         ssize_t (*show)(struct cpufreq_policy *, char *);
191         ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
192 };
193
194 #define cpufreq_freq_attr_ro(_name)             \
195 static struct freq_attr _name =                 \
196 __ATTR(_name, 0444, show_##_name, NULL)
197
198 #define cpufreq_freq_attr_ro_perm(_name, _perm) \
199 static struct freq_attr _name =                 \
200 __ATTR(_name, _perm, show_##_name, NULL)
201
202 #define cpufreq_freq_attr_rw(_name)             \
203 static struct freq_attr _name =                 \
204 __ATTR(_name, 0644, show_##_name, store_##_name)
205
206 #define define_one_global_ro(_name)             \
207 static struct kobj_attribute _name =            \
208 __ATTR(_name, 0444, show_##_name, NULL)
209
210 #define define_one_global_rw(_name)             \
211 static struct kobj_attribute _name =            \
212 __ATTR(_name, 0644, show_##_name, store_##_name)
213
214
215 struct cpufreq_driver {
216         char            name[CPUFREQ_NAME_LEN];
217         u8              flags;
218         void            *driver_data;
219
220         /* needed by all drivers */
221         int             (*init)(struct cpufreq_policy *policy);
222         int             (*verify)(struct cpufreq_policy *policy);
223
224         /* define one out of two */
225         int             (*setpolicy)(struct cpufreq_policy *policy);
226
227         /*
228          * On failure, should always restore frequency to policy->restore_freq
229          * (i.e. old freq).
230          */
231         int             (*target)(struct cpufreq_policy *policy,
232                                   unsigned int target_freq,
233                                   unsigned int relation);       /* Deprecated */
234         int             (*target_index)(struct cpufreq_policy *policy,
235                                         unsigned int index);
236         /*
237          * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION
238          * unset.
239          *
240          * get_intermediate should return a stable intermediate frequency
241          * platform wants to switch to and target_intermediate() should set CPU
242          * to to that frequency, before jumping to the frequency corresponding
243          * to 'index'. Core will take care of sending notifications and driver
244          * doesn't have to handle them in target_intermediate() or
245          * target_index().
246          *
247          * Drivers can return '0' from get_intermediate() in case they don't
248          * wish to switch to intermediate frequency for some target frequency.
249          * In that case core will directly call ->target_index().
250          */
251         unsigned int    (*get_intermediate)(struct cpufreq_policy *policy,
252                                             unsigned int index);
253         int             (*target_intermediate)(struct cpufreq_policy *policy,
254                                                unsigned int index);
255
256         /* should be defined, if possible */
257         unsigned int    (*get)(unsigned int cpu);
258
259         /* optional */
260         int             (*bios_limit)(int cpu, unsigned int *limit);
261
262         int             (*exit)(struct cpufreq_policy *policy);
263         void            (*stop_cpu)(struct cpufreq_policy *policy);
264         int             (*suspend)(struct cpufreq_policy *policy);
265         int             (*resume)(struct cpufreq_policy *policy);
266
267         /* Will be called after the driver is fully initialized */
268         void            (*ready)(struct cpufreq_policy *policy);
269
270         struct freq_attr **attr;
271
272         /* platform specific boost support code */
273         bool            boost_supported;
274         bool            boost_enabled;
275         int             (*set_boost)(int state);
276 };
277
278 /* flags */
279 #define CPUFREQ_STICKY          (1 << 0)        /* driver isn't removed even if
280                                                    all ->init() calls failed */
281 #define CPUFREQ_CONST_LOOPS     (1 << 1)        /* loops_per_jiffy or other
282                                                    kernel "constants" aren't
283                                                    affected by frequency
284                                                    transitions */
285 #define CPUFREQ_PM_NO_WARN      (1 << 2)        /* don't warn on suspend/resume
286                                                    speed mismatches */
287
288 /*
289  * This should be set by platforms having multiple clock-domains, i.e.
290  * supporting multiple policies. With this sysfs directories of governor would
291  * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
292  * governor with different tunables for different clusters.
293  */
294 #define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
295
296 /*
297  * Driver will do POSTCHANGE notifications from outside of their ->target()
298  * routine and so must set cpufreq_driver->flags with this flag, so that core
299  * can handle them specially.
300  */
301 #define CPUFREQ_ASYNC_NOTIFICATION  (1 << 4)
302
303 /*
304  * Set by drivers which want cpufreq core to check if CPU is running at a
305  * frequency present in freq-table exposed by the driver. For these drivers if
306  * CPU is found running at an out of table freq, we will try to set it to a freq
307  * from the table. And if that fails, we will stop further boot process by
308  * issuing a BUG_ON().
309  */
310 #define CPUFREQ_NEED_INITIAL_FREQ_CHECK (1 << 5)
311
312 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
313 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
314
315 const char *cpufreq_get_current_driver(void);
316 void *cpufreq_get_driver_data(void);
317
318 static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
319                 unsigned int min, unsigned int max)
320 {
321         if (policy->min < min)
322                 policy->min = min;
323         if (policy->max < min)
324                 policy->max = min;
325         if (policy->min > max)
326                 policy->min = max;
327         if (policy->max > max)
328                 policy->max = max;
329         if (policy->min > policy->max)
330                 policy->min = policy->max;
331         return;
332 }
333
334 static inline void
335 cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
336 {
337         cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
338                         policy->cpuinfo.max_freq);
339 }
340
341 #ifdef CONFIG_CPU_FREQ
342 void cpufreq_suspend(void);
343 void cpufreq_resume(void);
344 int cpufreq_generic_suspend(struct cpufreq_policy *policy);
345 #else
346 static inline void cpufreq_suspend(void) {}
347 static inline void cpufreq_resume(void) {}
348 #endif
349
350 /*********************************************************************
351  *                     CPUFREQ NOTIFIER INTERFACE                    *
352  *********************************************************************/
353
354 #define CPUFREQ_TRANSITION_NOTIFIER     (0)
355 #define CPUFREQ_POLICY_NOTIFIER         (1)
356
357 /* Transition notifiers */
358 #define CPUFREQ_PRECHANGE               (0)
359 #define CPUFREQ_POSTCHANGE              (1)
360
361 /* Policy Notifiers  */
362 #define CPUFREQ_ADJUST                  (0)
363 #define CPUFREQ_NOTIFY                  (1)
364 #define CPUFREQ_START                   (2)
365 #define CPUFREQ_CREATE_POLICY           (3)
366 #define CPUFREQ_REMOVE_POLICY           (4)
367
368 #ifdef CONFIG_CPU_FREQ
369 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
370 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
371
372 void cpufreq_freq_transition_begin(struct cpufreq_policy *policy,
373                 struct cpufreq_freqs *freqs);
374 void cpufreq_freq_transition_end(struct cpufreq_policy *policy,
375                 struct cpufreq_freqs *freqs, int transition_failed);
376
377 #else /* CONFIG_CPU_FREQ */
378 static inline int cpufreq_register_notifier(struct notifier_block *nb,
379                                                 unsigned int list)
380 {
381         return 0;
382 }
383 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
384                                                 unsigned int list)
385 {
386         return 0;
387 }
388 #endif /* !CONFIG_CPU_FREQ */
389
390 /**
391  * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
392  * safe)
393  * @old:   old value
394  * @div:   divisor
395  * @mult:  multiplier
396  *
397  *
398  * new = old * mult / div
399  */
400 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
401                 u_int mult)
402 {
403 #if BITS_PER_LONG == 32
404         u64 result = ((u64) old) * ((u64) mult);
405         do_div(result, div);
406         return (unsigned long) result;
407
408 #elif BITS_PER_LONG == 64
409         unsigned long result = old * ((u64) mult);
410         result /= div;
411         return result;
412 #endif
413 }
414
415 /*********************************************************************
416  *                          CPUFREQ GOVERNORS                        *
417  *********************************************************************/
418
419 /*
420  * If (cpufreq_driver->target) exists, the ->governor decides what frequency
421  * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
422  * two generic policies are available:
423  */
424 #define CPUFREQ_POLICY_POWERSAVE        (1)
425 #define CPUFREQ_POLICY_PERFORMANCE      (2)
426
427 /* Governor Events */
428 #define CPUFREQ_GOV_START       1
429 #define CPUFREQ_GOV_STOP        2
430 #define CPUFREQ_GOV_LIMITS      3
431 #define CPUFREQ_GOV_POLICY_INIT 4
432 #define CPUFREQ_GOV_POLICY_EXIT 5
433
434 struct cpufreq_governor {
435         char    name[CPUFREQ_NAME_LEN];
436         int     initialized;
437         int     (*governor)     (struct cpufreq_policy *policy,
438                                  unsigned int event);
439         ssize_t (*show_setspeed)        (struct cpufreq_policy *policy,
440                                          char *buf);
441         int     (*store_setspeed)       (struct cpufreq_policy *policy,
442                                          unsigned int freq);
443         unsigned int max_transition_latency; /* HW must be able to switch to
444                         next freq faster than this value in nano secs or we
445                         will fallback to performance governor */
446         struct list_head        governor_list;
447         struct module           *owner;
448 };
449
450 /* Pass a target to the cpufreq driver */
451 int cpufreq_driver_target(struct cpufreq_policy *policy,
452                                  unsigned int target_freq,
453                                  unsigned int relation);
454 int __cpufreq_driver_target(struct cpufreq_policy *policy,
455                                    unsigned int target_freq,
456                                    unsigned int relation);
457 int cpufreq_register_governor(struct cpufreq_governor *governor);
458 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
459
460 /* CPUFREQ DEFAULT GOVERNOR */
461 /*
462  * Performance governor is fallback governor if any other gov failed to auto
463  * load due latency restrictions
464  */
465 #ifdef CONFIG_CPU_FREQ_GOV_PERFORMANCE
466 extern struct cpufreq_governor cpufreq_gov_performance;
467 #endif
468 #ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE
469 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_performance)
470 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_POWERSAVE)
471 extern struct cpufreq_governor cpufreq_gov_powersave;
472 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_powersave)
473 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_USERSPACE)
474 extern struct cpufreq_governor cpufreq_gov_userspace;
475 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_userspace)
476 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_ONDEMAND)
477 extern struct cpufreq_governor cpufreq_gov_ondemand;
478 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_ondemand)
479 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_CONSERVATIVE)
480 extern struct cpufreq_governor cpufreq_gov_conservative;
481 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_conservative)
482 #endif
483
484 /*********************************************************************
485  *                     FREQUENCY TABLE HELPERS                       *
486  *********************************************************************/
487
488 /* Special Values of .frequency field */
489 #define CPUFREQ_ENTRY_INVALID   ~0u
490 #define CPUFREQ_TABLE_END       ~1u
491 /* Special Values of .flags field */
492 #define CPUFREQ_BOOST_FREQ      (1 << 0)
493
494 struct cpufreq_frequency_table {
495         unsigned int    flags;
496         unsigned int    driver_data; /* driver specific data, not used by core */
497         unsigned int    frequency; /* kHz - doesn't need to be in ascending
498                                     * order */
499 };
500
501 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP)
502 int dev_pm_opp_init_cpufreq_table(struct device *dev,
503                                   struct cpufreq_frequency_table **table);
504 void dev_pm_opp_free_cpufreq_table(struct device *dev,
505                                    struct cpufreq_frequency_table **table);
506 #else
507 static inline int dev_pm_opp_init_cpufreq_table(struct device *dev,
508                                                 struct cpufreq_frequency_table
509                                                 **table)
510 {
511         return -EINVAL;
512 }
513
514 static inline void dev_pm_opp_free_cpufreq_table(struct device *dev,
515                                                  struct cpufreq_frequency_table
516                                                  **table)
517 {
518 }
519 #endif
520
521 static inline bool cpufreq_next_valid(struct cpufreq_frequency_table **pos)
522 {
523         while ((*pos)->frequency != CPUFREQ_TABLE_END)
524                 if ((*pos)->frequency != CPUFREQ_ENTRY_INVALID)
525                         return true;
526                 else
527                         (*pos)++;
528         return false;
529 }
530
531 /*
532  * cpufreq_for_each_entry -     iterate over a cpufreq_frequency_table
533  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
534  * @table:      the cpufreq_frequency_table * to iterate over.
535  */
536
537 #define cpufreq_for_each_entry(pos, table)      \
538         for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
539
540 /*
541  * cpufreq_for_each_valid_entry -     iterate over a cpufreq_frequency_table
542  *      excluding CPUFREQ_ENTRY_INVALID frequencies.
543  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
544  * @table:      the cpufreq_frequency_table * to iterate over.
545  */
546
547 #define cpufreq_for_each_valid_entry(pos, table)        \
548         for (pos = table; cpufreq_next_valid(&pos); pos++)
549
550 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
551                                     struct cpufreq_frequency_table *table);
552
553 int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
554                                    struct cpufreq_frequency_table *table);
555 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
556
557 int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
558                                    struct cpufreq_frequency_table *table,
559                                    unsigned int target_freq,
560                                    unsigned int relation,
561                                    unsigned int *index);
562 int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
563                 unsigned int freq);
564
565 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
566
567 #ifdef CONFIG_CPU_FREQ
568 int cpufreq_boost_trigger_state(int state);
569 int cpufreq_boost_supported(void);
570 int cpufreq_boost_enabled(void);
571 int cpufreq_enable_boost_support(void);
572 bool policy_has_boost_freq(struct cpufreq_policy *policy);
573 #else
574 static inline int cpufreq_boost_trigger_state(int state)
575 {
576         return 0;
577 }
578 static inline int cpufreq_boost_supported(void)
579 {
580         return 0;
581 }
582 static inline int cpufreq_boost_enabled(void)
583 {
584         return 0;
585 }
586
587 static inline int cpufreq_enable_boost_support(void)
588 {
589         return -EINVAL;
590 }
591
592 static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
593 {
594         return false;
595 }
596 #endif
597 /* the following funtion is for cpufreq core use only */
598 struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu);
599
600 /* the following are really really optional */
601 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
602 extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
603 extern struct freq_attr *cpufreq_generic_attr[];
604 int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
605                                       struct cpufreq_frequency_table *table);
606
607 unsigned int cpufreq_generic_get(unsigned int cpu);
608 int cpufreq_generic_init(struct cpufreq_policy *policy,
609                 struct cpufreq_frequency_table *table,
610                 unsigned int transition_latency);
611 #endif /* _LINUX_CPUFREQ_H */