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/cpumask.h>
  15 #include <linux/completion.h>
  16 #include <linux/kobject.h>
  17 #include <linux/notifier.h>
  18 #include <linux/sysfs.h>
  19
  20 /*********************************************************************
  21  *                        CPUFREQ INTERFACE                          *
  22  *********************************************************************/
  23 /*
  24  * Frequency values here are CPU kHz
  25  *
  26  * Maximum transition latency is in nanoseconds - if it's unknown,
  27  * CPUFREQ_ETERNAL shall be used.
  28  */
  29
  30 #define CPUFREQ_ETERNAL                 (-1)
  31 #define CPUFREQ_NAME_LEN                16
  32 /* Print length for names. Extra 1 space for accomodating '\n' in prints */
  33 #define CPUFREQ_NAME_PLEN               (CPUFREQ_NAME_LEN + 1)
  34
  35 struct cpufreq_governor;
  36
  37 struct cpufreq_freqs {
  38         unsigned int cpu;       /* cpu nr */
  39         unsigned int old;
  40         unsigned int new;
  41         u8 flags;               /* flags of cpufreq_driver, see below. */
  42 };
  43
  44 struct cpufreq_cpuinfo {
  45         unsigned int            max_freq;
  46         unsigned int            min_freq;
  47
  48         /* in 10^(-9) s = nanoseconds */
  49         unsigned int            transition_latency;
  50 };
  51
  52 struct cpufreq_real_policy {
  53         unsigned int            min;    /* in kHz */
  54         unsigned int            max;    /* in kHz */
  55         unsigned int            policy; /* see above */
  56         struct cpufreq_governor *governor; /* see below */
  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
  64         unsigned int            shared_type; /* ACPI: ANY or ALL affected CPUs
  65                                                 should set cpufreq */
  66         unsigned int            cpu;    /* cpu nr of CPU managing this policy */
  67         unsigned int            last_cpu; /* cpu nr of previous CPU that managed
  68                                            * this policy */
  69         struct cpufreq_cpuinfo  cpuinfo;/* see above */
  70
  71         unsigned int            min;    /* in kHz */
  72         unsigned int            max;    /* in kHz */
  73         unsigned int            cur;    /* in kHz, only needed if cpufreq
  74                                          * governors are used */
  75         unsigned int            policy; /* see above */
  76         struct cpufreq_governor *governor; /* see below */
  77         void                    *governor_data;
  78         bool                    governor_enabled; /* governor start/stop flag */
  79
  80         struct work_struct      update; /* if update_policy() needs to be
  81                                          * called, but you're in IRQ context */
  82
  83         struct cpufreq_real_policy      user_policy;
  84
  85         struct list_head        policy_list;
  86         struct kobject          kobj;
  87         struct completion       kobj_unregister;
  88
  89         /*
  90          * The rules for this semaphore:
  91          * - Any routine that wants to read from the policy structure will
  92          *   do a down_read on this semaphore.
  93          * - Any routine that will write to the policy structure and/or may take away
  94          *   the policy altogether (eg. CPU hotplug), will hold this lock in write
  95          *   mode before doing so.
  96          *
  97          * Additional rules:
  98          * - Lock should not be held across
  99          *     __cpufreq_governor(data, CPUFREQ_GOV_POLICY_EXIT);
 100          */
 101         struct rw_semaphore     rwsem;
 102 };
 103
 104 /* Only for ACPI */
 105 #define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
 106 #define CPUFREQ_SHARED_TYPE_HW   (1) /* HW does needed coordination */
 107 #define CPUFREQ_SHARED_TYPE_ALL  (2) /* All dependent CPUs should set freq */
 108 #define CPUFREQ_SHARED_TYPE_ANY  (3) /* Freq can be set from any dependent CPU*/
 109
 110 struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
 111 void cpufreq_cpu_put(struct cpufreq_policy *policy);
 112
 113 static inline bool policy_is_shared(struct cpufreq_policy *policy)
 114 {
 115         return cpumask_weight(policy->cpus) > 1;
 116 }
 117
 118 /* /sys/devices/system/cpu/cpufreq: entry point for global variables */
 119 extern struct kobject *cpufreq_global_kobject;
 120 int cpufreq_get_global_kobject(void);
 121 void cpufreq_put_global_kobject(void);
 122 int cpufreq_sysfs_create_file(const struct attribute *attr);
 123 void cpufreq_sysfs_remove_file(const struct attribute *attr);
 124
 125 #ifdef CONFIG_CPU_FREQ
 126 unsigned int cpufreq_get(unsigned int cpu);
 127 unsigned int cpufreq_quick_get(unsigned int cpu);
 128 unsigned int cpufreq_quick_get_max(unsigned int cpu);
 129 void disable_cpufreq(void);
 130
 131 u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
 132 int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
 133 int cpufreq_update_policy(unsigned int cpu);
 134 bool have_governor_per_policy(void);
 135 struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
 136 #else
 137 static inline unsigned int cpufreq_get(unsigned int cpu)
 138 {
 139         return 0;
 140 }
 141 static inline unsigned int cpufreq_quick_get(unsigned int cpu)
 142 {
 143         return 0;
 144 }
 145 static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
 146 {
 147         return 0;
 148 }
 149 static inline void disable_cpufreq(void) { }
 150 #endif
 151
 152 /*********************************************************************
 153  *                      CPUFREQ DRIVER INTERFACE                     *
 154  *********************************************************************/
 155
 156 #define CPUFREQ_RELATION_L 0  /* lowest frequency at or above target */
 157 #define CPUFREQ_RELATION_H 1  /* highest frequency below or at target */
 158
 159 struct freq_attr {
 160         struct attribute attr;
 161         ssize_t (*show)(struct cpufreq_policy *, char *);
 162         ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
 163 };
 164
 165 #define cpufreq_freq_attr_ro(_name)             \
 166 static struct freq_attr _name =                 \
 167 __ATTR(_name, 0444, show_##_name, NULL)
 168
 169 #define cpufreq_freq_attr_ro_perm(_name, _perm) \
 170 static struct freq_attr _name =                 \
 171 __ATTR(_name, _perm, show_##_name, NULL)
 172
 173 #define cpufreq_freq_attr_rw(_name)             \
 174 static struct freq_attr _name =                 \
 175 __ATTR(_name, 0644, show_##_name, store_##_name)
 176
 177 struct global_attr {
 178         struct attribute attr;
 179         ssize_t (*show)(struct kobject *kobj,
 180                         struct attribute *attr, char *buf);
 181         ssize_t (*store)(struct kobject *a, struct attribute *b,
 182                          const char *c, size_t count);
 183 };
 184
 185 #define define_one_global_ro(_name)             \
 186 static struct global_attr _name =               \
 187 __ATTR(_name, 0444, show_##_name, NULL)
 188
 189 #define define_one_global_rw(_name)             \
 190 static struct global_attr _name =               \
 191 __ATTR(_name, 0644, show_##_name, store_##_name)
 192
 193
 194 struct cpufreq_driver {
 195         char                    name[CPUFREQ_NAME_LEN];
 196         u8                      flags;
 197
 198         /* needed by all drivers */
 199         int     (*init)         (struct cpufreq_policy *policy);
 200         int     (*verify)       (struct cpufreq_policy *policy);
 201
 202         /* define one out of two */
 203         int     (*setpolicy)    (struct cpufreq_policy *policy);
 204         int     (*target)       (struct cpufreq_policy *policy, /* Deprecated */
 205                                  unsigned int target_freq,
 206                                  unsigned int relation);
 207         int     (*target_index) (struct cpufreq_policy *policy,
 208                                  unsigned int index);
 209
 210         /* should be defined, if possible */
 211         unsigned int    (*get)  (unsigned int cpu);
 212
 213         /* optional */
 214         int     (*bios_limit)   (int cpu, unsigned int *limit);
 215
 216         int     (*exit)         (struct cpufreq_policy *policy);
 217         int     (*suspend)      (struct cpufreq_policy *policy);
 218         int     (*resume)       (struct cpufreq_policy *policy);
 219         struct freq_attr        **attr;
 220 };
 221
 222 /* flags */
 223 #define CPUFREQ_STICKY          (1 << 0)        /* driver isn't removed even if
 224                                                    all ->init() calls failed */
 225 #define CPUFREQ_CONST_LOOPS     (1 << 1)        /* loops_per_jiffy or other
 226                                                    kernel "constants" aren't
 227                                                    affected by frequency
 228                                                    transitions */
 229 #define CPUFREQ_PM_NO_WARN      (1 << 2)        /* don't warn on suspend/resume
 230                                                    speed mismatches */
 231
 232 /*
 233  * This should be set by platforms having multiple clock-domains, i.e.
 234  * supporting multiple policies. With this sysfs directories of governor would
 235  * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
 236  * governor with different tunables for different clusters.
 237  */
 238 #define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
 239
 240 /*
 241  * Driver will do POSTCHANGE notifications from outside of their ->target()
 242  * routine and so must set cpufreq_driver->flags with this flag, so that core
 243  * can handle them specially.
 244  */
 245 #define CPUFREQ_ASYNC_NOTIFICATION  (1 << 4)
 246
 247 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
 248 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
 249
 250 const char *cpufreq_get_current_driver(void);
 251
 252 static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
 253                 unsigned int min, unsigned int max)
 254 {
 255         if (policy->min < min)
 256                 policy->min = min;
 257         if (policy->max < min)
 258                 policy->max = min;
 259         if (policy->min > max)
 260                 policy->min = max;
 261         if (policy->max > max)
 262                 policy->max = max;
 263         if (policy->min > policy->max)
 264                 policy->min = policy->max;
 265         return;
 266 }
 267
 268 static inline void
 269 cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
 270 {
 271         cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
 272                         policy->cpuinfo.max_freq);
 273 }
 274
 275 /*********************************************************************
 276  *                     CPUFREQ NOTIFIER INTERFACE                    *
 277  *********************************************************************/
 278
 279 #define CPUFREQ_TRANSITION_NOTIFIER     (0)
 280 #define CPUFREQ_POLICY_NOTIFIER         (1)
 281
 282 /* Transition notifiers */
 283 #define CPUFREQ_PRECHANGE               (0)
 284 #define CPUFREQ_POSTCHANGE              (1)
 285 #define CPUFREQ_RESUMECHANGE            (8)
 286 #define CPUFREQ_SUSPENDCHANGE           (9)
 287
 288 /* Policy Notifiers  */
 289 #define CPUFREQ_ADJUST                  (0)
 290 #define CPUFREQ_INCOMPATIBLE            (1)
 291 #define CPUFREQ_NOTIFY                  (2)
 292 #define CPUFREQ_START                   (3)
 293 #define CPUFREQ_UPDATE_POLICY_CPU       (4)
 294
 295 #ifdef CONFIG_CPU_FREQ
 296 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
 297 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
 298
 299 void cpufreq_notify_transition(struct cpufreq_policy *policy,
 300                 struct cpufreq_freqs *freqs, unsigned int state);
 301
 302 #else /* CONFIG_CPU_FREQ */
 303 static inline int cpufreq_register_notifier(struct notifier_block *nb,
 304                                                 unsigned int list)
 305 {
 306         return 0;
 307 }
 308 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
 309                                                 unsigned int list)
 310 {
 311         return 0;
 312 }
 313 #endif /* !CONFIG_CPU_FREQ */
 314
 315 /**
 316  * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
 317  * safe)
 318  * @old:   old value
 319  * @div:   divisor
 320  * @mult:  multiplier
 321  *
 322  *
 323  * new = old * mult / div
 324  */
 325 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
 326                 u_int mult)
 327 {
 328 #if BITS_PER_LONG == 32
 329         u64 result = ((u64) old) * ((u64) mult);
 330         do_div(result, div);
 331         return (unsigned long) result;
 332
 333 #elif BITS_PER_LONG == 64
 334         unsigned long result = old * ((u64) mult);
 335         result /= div;
 336         return result;
 337 #endif
 338 }
 339
 340 /*********************************************************************
 341  *                          CPUFREQ GOVERNORS                        *
 342  *********************************************************************/
 343
 344 /*
 345  * If (cpufreq_driver->target) exists, the ->governor decides what frequency
 346  * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
 347  * two generic policies are available:
 348  */
 349 #define CPUFREQ_POLICY_POWERSAVE        (1)
 350 #define CPUFREQ_POLICY_PERFORMANCE      (2)
 351
 352 /* Governor Events */
 353 #define CPUFREQ_GOV_START       1
 354 #define CPUFREQ_GOV_STOP        2
 355 #define CPUFREQ_GOV_LIMITS      3
 356 #define CPUFREQ_GOV_POLICY_INIT 4
 357 #define CPUFREQ_GOV_POLICY_EXIT 5
 358
 359 struct cpufreq_governor {
 360         char    name[CPUFREQ_NAME_LEN];
 361         int     initialized;
 362         int     (*governor)     (struct cpufreq_policy *policy,
 363                                  unsigned int event);
 364         ssize_t (*show_setspeed)        (struct cpufreq_policy *policy,
 365                                          char *buf);
 366         int     (*store_setspeed)       (struct cpufreq_policy *policy,
 367                                          unsigned int freq);
 368         unsigned int max_transition_latency; /* HW must be able to switch to
 369                         next freq faster than this value in nano secs or we
 370                         will fallback to performance governor */
 371         struct list_head        governor_list;
 372         struct module           *owner;
 373 };
 374
 375 /* Pass a target to the cpufreq driver */
 376 int cpufreq_driver_target(struct cpufreq_policy *policy,
 377                                  unsigned int target_freq,
 378                                  unsigned int relation);
 379 int __cpufreq_driver_target(struct cpufreq_policy *policy,
 380                                    unsigned int target_freq,
 381                                    unsigned int relation);
 382 int cpufreq_register_governor(struct cpufreq_governor *governor);
 383 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
 384
 385 /* CPUFREQ DEFAULT GOVERNOR */
 386 /*
 387  * Performance governor is fallback governor if any other gov failed to auto
 388  * load due latency restrictions
 389  */
 390 #ifdef CONFIG_CPU_FREQ_GOV_PERFORMANCE
 391 extern struct cpufreq_governor cpufreq_gov_performance;
 392 #endif
 393 #ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE
 394 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_performance)
 395 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_POWERSAVE)
 396 extern struct cpufreq_governor cpufreq_gov_powersave;
 397 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_powersave)
 398 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_USERSPACE)
 399 extern struct cpufreq_governor cpufreq_gov_userspace;
 400 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_userspace)
 401 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_ONDEMAND)
 402 extern struct cpufreq_governor cpufreq_gov_ondemand;
 403 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_ondemand)
 404 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_CONSERVATIVE)
 405 extern struct cpufreq_governor cpufreq_gov_conservative;
 406 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_conservative)
 407 #endif
 408
 409 /*********************************************************************
 410  *                     FREQUENCY TABLE HELPERS                       *
 411  *********************************************************************/
 412
 413 #define CPUFREQ_ENTRY_INVALID ~0
 414 #define CPUFREQ_TABLE_END     ~1
 415
 416 struct cpufreq_frequency_table {
 417         unsigned int    driver_data; /* driver specific data, not used by core */
 418         unsigned int    frequency; /* kHz - doesn't need to be in ascending
 419                                     * order */
 420 };
 421
 422 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
 423                                     struct cpufreq_frequency_table *table);
 424
 425 int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
 426                                    struct cpufreq_frequency_table *table);
 427 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
 428
 429 int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
 430                                    struct cpufreq_frequency_table *table,
 431                                    unsigned int target_freq,
 432                                    unsigned int relation,
 433                                    unsigned int *index);
 434
 435 void cpufreq_frequency_table_update_policy_cpu(struct cpufreq_policy *policy);
 436 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
 437
 438 /* the following funtion is for cpufreq core use only */
 439 struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu);
 440
 441 /* the following are really really optional */
 442 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
 443 extern struct freq_attr *cpufreq_generic_attr[];
 444 void cpufreq_frequency_table_get_attr(struct cpufreq_frequency_table *table,
 445                                       unsigned int cpu);
 446 void cpufreq_frequency_table_put_attr(unsigned int cpu);
 447 int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
 448                                       struct cpufreq_frequency_table *table);
 449
 450 int cpufreq_generic_init(struct cpufreq_policy *policy,
 451                 struct cpufreq_frequency_table *table,
 452                 unsigned int transition_latency);
 453 static inline int cpufreq_generic_exit(struct cpufreq_policy *policy)
 454 {
 455         cpufreq_frequency_table_put_attr(policy->cpu);
 456         return 0;
 457 }
 458
 459 #endif /* _LINUX_CPUFREQ_H */