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 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
 241 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
 242
 243 const char *cpufreq_get_current_driver(void);
 244
 245 static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
 246                 unsigned int min, unsigned int max)
 247 {
 248         if (policy->min < min)
 249                 policy->min = min;
 250         if (policy->max < min)
 251                 policy->max = min;
 252         if (policy->min > max)
 253                 policy->min = max;
 254         if (policy->max > max)
 255                 policy->max = max;
 256         if (policy->min > policy->max)
 257                 policy->min = policy->max;
 258         return;
 259 }
 260
 261 static inline void
 262 cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
 263 {
 264         cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
 265                         policy->cpuinfo.max_freq);
 266 }
 267
 268 /*********************************************************************
 269  *                     CPUFREQ NOTIFIER INTERFACE                    *
 270  *********************************************************************/
 271
 272 #define CPUFREQ_TRANSITION_NOTIFIER     (0)
 273 #define CPUFREQ_POLICY_NOTIFIER         (1)
 274
 275 /* Transition notifiers */
 276 #define CPUFREQ_PRECHANGE               (0)
 277 #define CPUFREQ_POSTCHANGE              (1)
 278 #define CPUFREQ_RESUMECHANGE            (8)
 279 #define CPUFREQ_SUSPENDCHANGE           (9)
 280
 281 /* Policy Notifiers  */
 282 #define CPUFREQ_ADJUST                  (0)
 283 #define CPUFREQ_INCOMPATIBLE            (1)
 284 #define CPUFREQ_NOTIFY                  (2)
 285 #define CPUFREQ_START                   (3)
 286 #define CPUFREQ_UPDATE_POLICY_CPU       (4)
 287
 288 #ifdef CONFIG_CPU_FREQ
 289 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
 290 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
 291
 292 void cpufreq_notify_transition(struct cpufreq_policy *policy,
 293                 struct cpufreq_freqs *freqs, unsigned int state);
 294
 295 #else /* CONFIG_CPU_FREQ */
 296 static inline int cpufreq_register_notifier(struct notifier_block *nb,
 297                                                 unsigned int list)
 298 {
 299         return 0;
 300 }
 301 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
 302                                                 unsigned int list)
 303 {
 304         return 0;
 305 }
 306 #endif /* !CONFIG_CPU_FREQ */
 307
 308 /**
 309  * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
 310  * safe)
 311  * @old:   old value
 312  * @div:   divisor
 313  * @mult:  multiplier
 314  *
 315  *
 316  * new = old * mult / div
 317  */
 318 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
 319                 u_int mult)
 320 {
 321 #if BITS_PER_LONG == 32
 322         u64 result = ((u64) old) * ((u64) mult);
 323         do_div(result, div);
 324         return (unsigned long) result;
 325
 326 #elif BITS_PER_LONG == 64
 327         unsigned long result = old * ((u64) mult);
 328         result /= div;
 329         return result;
 330 #endif
 331 }
 332
 333 /*********************************************************************
 334  *                          CPUFREQ GOVERNORS                        *
 335  *********************************************************************/
 336
 337 /*
 338  * If (cpufreq_driver->target) exists, the ->governor decides what frequency
 339  * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
 340  * two generic policies are available:
 341  */
 342 #define CPUFREQ_POLICY_POWERSAVE        (1)
 343 #define CPUFREQ_POLICY_PERFORMANCE      (2)
 344
 345 /* Governor Events */
 346 #define CPUFREQ_GOV_START       1
 347 #define CPUFREQ_GOV_STOP        2
 348 #define CPUFREQ_GOV_LIMITS      3
 349 #define CPUFREQ_GOV_POLICY_INIT 4
 350 #define CPUFREQ_GOV_POLICY_EXIT 5
 351
 352 struct cpufreq_governor {
 353         char    name[CPUFREQ_NAME_LEN];
 354         int     initialized;
 355         int     (*governor)     (struct cpufreq_policy *policy,
 356                                  unsigned int event);
 357         ssize_t (*show_setspeed)        (struct cpufreq_policy *policy,
 358                                          char *buf);
 359         int     (*store_setspeed)       (struct cpufreq_policy *policy,
 360                                          unsigned int freq);
 361         unsigned int max_transition_latency; /* HW must be able to switch to
 362                         next freq faster than this value in nano secs or we
 363                         will fallback to performance governor */
 364         struct list_head        governor_list;
 365         struct module           *owner;
 366 };
 367
 368 /* Pass a target to the cpufreq driver */
 369 int cpufreq_driver_target(struct cpufreq_policy *policy,
 370                                  unsigned int target_freq,
 371                                  unsigned int relation);
 372 int __cpufreq_driver_target(struct cpufreq_policy *policy,
 373                                    unsigned int target_freq,
 374                                    unsigned int relation);
 375 int cpufreq_register_governor(struct cpufreq_governor *governor);
 376 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
 377
 378 /* CPUFREQ DEFAULT GOVERNOR */
 379 /*
 380  * Performance governor is fallback governor if any other gov failed to auto
 381  * load due latency restrictions
 382  */
 383 #ifdef CONFIG_CPU_FREQ_GOV_PERFORMANCE
 384 extern struct cpufreq_governor cpufreq_gov_performance;
 385 #endif
 386 #ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE
 387 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_performance)
 388 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_POWERSAVE)
 389 extern struct cpufreq_governor cpufreq_gov_powersave;
 390 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_powersave)
 391 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_USERSPACE)
 392 extern struct cpufreq_governor cpufreq_gov_userspace;
 393 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_userspace)
 394 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_ONDEMAND)
 395 extern struct cpufreq_governor cpufreq_gov_ondemand;
 396 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_ondemand)
 397 #elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_CONSERVATIVE)
 398 extern struct cpufreq_governor cpufreq_gov_conservative;
 399 #define CPUFREQ_DEFAULT_GOVERNOR        (&cpufreq_gov_conservative)
 400 #endif
 401
 402 /*********************************************************************
 403  *                     FREQUENCY TABLE HELPERS                       *
 404  *********************************************************************/
 405
 406 #define CPUFREQ_ENTRY_INVALID ~0
 407 #define CPUFREQ_TABLE_END     ~1
 408
 409 struct cpufreq_frequency_table {
 410         unsigned int    driver_data; /* driver specific data, not used by core */
 411         unsigned int    frequency; /* kHz - doesn't need to be in ascending
 412                                     * order */
 413 };
 414
 415 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
 416                                     struct cpufreq_frequency_table *table);
 417
 418 int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
 419                                    struct cpufreq_frequency_table *table);
 420 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
 421
 422 int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
 423                                    struct cpufreq_frequency_table *table,
 424                                    unsigned int target_freq,
 425                                    unsigned int relation,
 426                                    unsigned int *index);
 427
 428 void cpufreq_frequency_table_update_policy_cpu(struct cpufreq_policy *policy);
 429 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
 430
 431 /* the following funtion is for cpufreq core use only */
 432 struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu);
 433
 434 /* the following are really really optional */
 435 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
 436 extern struct freq_attr *cpufreq_generic_attr[];
 437 void cpufreq_frequency_table_get_attr(struct cpufreq_frequency_table *table,
 438                                       unsigned int cpu);
 439 void cpufreq_frequency_table_put_attr(unsigned int cpu);
 440 int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
 441                                       struct cpufreq_frequency_table *table);
 442
 443 int cpufreq_generic_init(struct cpufreq_policy *policy,
 444                 struct cpufreq_frequency_table *table,
 445                 unsigned int transition_latency);
 446 static inline int cpufreq_generic_exit(struct cpufreq_policy *policy)
 447 {
 448         cpufreq_frequency_table_put_attr(policy->cpu);
 449         return 0;
 450 }
 451
 452 #endif /* _LINUX_CPUFREQ_H */