drivers/cpuidle/cpuidle.c

   1 /*
   2  * cpuidle.c - core cpuidle infrastructure
   3  *
   4  * (C) 2006-2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
   5  *               Shaohua Li <shaohua.li@intel.com>
   6  *               Adam Belay <abelay@novell.com>
   7  *
   8  * This code is licenced under the GPL.
   9  */
  10
  11 #include <linux/kernel.h>
  12 #include <linux/mutex.h>
  13 #include <linux/sched.h>
  14 #include <linux/notifier.h>
  15 #include <linux/pm_qos.h>
  16 #include <linux/cpu.h>
  17 #include <linux/cpuidle.h>
  18 #include <linux/ktime.h>
  19 #include <linux/hrtimer.h>
  20 #include <linux/module.h>
  21 #include <trace/events/power.h>
  22
  23 #include "cpuidle.h"
  24
  25 DEFINE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
  26
  27 DEFINE_MUTEX(cpuidle_lock);
  28 LIST_HEAD(cpuidle_detected_devices);
  29
  30 static int enabled_devices;
  31 static int off __read_mostly;
  32 static int initialized __read_mostly;
  33
  34 int cpuidle_disabled(void)
  35 {
  36         return off;
  37 }
  38 void disable_cpuidle(void)
  39 {
  40         off = 1;
  41 }
  42
  43 static int __cpuidle_register_device(struct cpuidle_device *dev);
  44
  45 static inline int cpuidle_enter(struct cpuidle_device *dev,
  46                                 struct cpuidle_driver *drv, int index)
  47 {
  48         struct cpuidle_state *target_state = &drv->states[index];
  49         return target_state->enter(dev, drv, index);
  50 }
  51
  52 static inline int cpuidle_enter_tk(struct cpuidle_device *dev,
  53                                struct cpuidle_driver *drv, int index)
  54 {
  55         return cpuidle_wrap_enter(dev, drv, index, cpuidle_enter);
  56 }
  57
  58 typedef int (*cpuidle_enter_t)(struct cpuidle_device *dev,
  59                                struct cpuidle_driver *drv, int index);
  60
  61 static cpuidle_enter_t cpuidle_enter_ops;
  62
  63 /**
  64  * cpuidle_play_dead - cpu off-lining
  65  *
  66  * Returns in case of an error or no driver
  67  */
  68 int cpuidle_play_dead(void)
  69 {
  70         struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
  71         struct cpuidle_driver *drv = cpuidle_get_driver();
  72         int i, dead_state = -1;
  73         int power_usage = -1;
  74
  75         if (!drv)
  76                 return -ENODEV;
  77
  78         /* Find lowest-power state that supports long-term idle */
  79         for (i = CPUIDLE_DRIVER_STATE_START; i < drv->state_count; i++) {
  80                 struct cpuidle_state *s = &drv->states[i];
  81
  82                 if (s->power_usage < power_usage && s->enter_dead) {
  83                         power_usage = s->power_usage;
  84                         dead_state = i;
  85                 }
  86         }
  87
  88         if (dead_state != -1)
  89                 return drv->states[dead_state].enter_dead(dev, dead_state);
  90
  91         return -ENODEV;
  92 }
  93
  94 /**
  95  * cpuidle_enter_state - enter the state and update stats
  96  * @dev: cpuidle device for this cpu
  97  * @drv: cpuidle driver for this cpu
  98  * @next_state: index into drv->states of the state to enter
  99  */
 100 int cpuidle_enter_state(struct cpuidle_device *dev, struct cpuidle_driver *drv,
 101                 int next_state)
 102 {
 103         int entered_state;
 104
 105         entered_state = cpuidle_enter_ops(dev, drv, next_state);
 106
 107         if (entered_state >= 0) {
 108                 /* Update cpuidle counters */
 109                 /* This can be moved to within driver enter routine
 110                  * but that results in multiple copies of same code.
 111                  */
 112                 dev->states_usage[entered_state].time +=
 113                                 (unsigned long long)dev->last_residency;
 114                 dev->states_usage[entered_state].usage++;
 115         } else {
 116                 dev->last_residency = 0;
 117         }
 118
 119         return entered_state;
 120 }
 121
 122 /**
 123  * cpuidle_idle_call - the main idle loop
 124  *
 125  * NOTE: no locks or semaphores should be used here
 126  * return non-zero on failure
 127  */
 128 int cpuidle_idle_call(void)
 129 {
 130         struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
 131         struct cpuidle_driver *drv = cpuidle_get_driver();
 132         int next_state, entered_state;
 133
 134         if (off)
 135                 return -ENODEV;
 136
 137         if (!initialized)
 138                 return -ENODEV;
 139
 140         /* check if the device is ready */
 141         if (!dev || !dev->enabled)
 142                 return -EBUSY;
 143
 144         /* ask the governor for the next state */
 145         next_state = cpuidle_curr_governor->select(drv, dev);
 146         if (need_resched()) {
 147                 dev->last_residency = 0;
 148                 /* give the governor an opportunity to reflect on the outcome */
 149                 if (cpuidle_curr_governor->reflect)
 150                         cpuidle_curr_governor->reflect(dev, next_state);
 151                 local_irq_enable();
 152                 return 0;
 153         }
 154
 155         trace_power_start_rcuidle(POWER_CSTATE, next_state, dev->cpu);
 156         trace_cpu_idle_rcuidle(next_state, dev->cpu);
 157
 158         if (cpuidle_state_is_coupled(dev, drv, next_state))
 159                 entered_state = cpuidle_enter_state_coupled(dev, drv,
 160                                                             next_state);
 161         else
 162                 entered_state = cpuidle_enter_state(dev, drv, next_state);
 163
 164         trace_power_end_rcuidle(dev->cpu);
 165         trace_cpu_idle_rcuidle(PWR_EVENT_EXIT, dev->cpu);
 166
 167         /* give the governor an opportunity to reflect on the outcome */
 168         if (cpuidle_curr_governor->reflect)
 169                 cpuidle_curr_governor->reflect(dev, entered_state);
 170
 171         return 0;
 172 }
 173
 174 /**
 175  * cpuidle_install_idle_handler - installs the cpuidle idle loop handler
 176  */
 177 void cpuidle_install_idle_handler(void)
 178 {
 179         if (enabled_devices) {
 180                 /* Make sure all changes finished before we switch to new idle */
 181                 smp_wmb();
 182                 initialized = 1;
 183         }
 184 }
 185
 186 /**
 187  * cpuidle_uninstall_idle_handler - uninstalls the cpuidle idle loop handler
 188  */
 189 void cpuidle_uninstall_idle_handler(void)
 190 {
 191         if (enabled_devices) {
 192                 initialized = 0;
 193                 kick_all_cpus_sync();
 194         }
 195 }
 196
 197 /**
 198  * cpuidle_pause_and_lock - temporarily disables CPUIDLE
 199  */
 200 void cpuidle_pause_and_lock(void)
 201 {
 202         mutex_lock(&cpuidle_lock);
 203         cpuidle_uninstall_idle_handler();
 204 }
 205
 206 EXPORT_SYMBOL_GPL(cpuidle_pause_and_lock);
 207
 208 /**
 209  * cpuidle_resume_and_unlock - resumes CPUIDLE operation
 210  */
 211 void cpuidle_resume_and_unlock(void)
 212 {
 213         cpuidle_install_idle_handler();
 214         mutex_unlock(&cpuidle_lock);
 215 }
 216
 217 EXPORT_SYMBOL_GPL(cpuidle_resume_and_unlock);
 218
 219 /* Currently used in suspend/resume path to suspend cpuidle */
 220 void cpuidle_pause(void)
 221 {
 222         mutex_lock(&cpuidle_lock);
 223         cpuidle_uninstall_idle_handler();
 224         mutex_unlock(&cpuidle_lock);
 225 }
 226
 227 /* Currently used in suspend/resume path to resume cpuidle */
 228 void cpuidle_resume(void)
 229 {
 230         mutex_lock(&cpuidle_lock);
 231         cpuidle_install_idle_handler();
 232         mutex_unlock(&cpuidle_lock);
 233 }
 234
 235 /**
 236  * cpuidle_wrap_enter - performs timekeeping and irqen around enter function
 237  * @dev: pointer to a valid cpuidle_device object
 238  * @drv: pointer to a valid cpuidle_driver object
 239  * @index: index of the target cpuidle state.
 240  */
 241 int cpuidle_wrap_enter(struct cpuidle_device *dev,
 242                                 struct cpuidle_driver *drv, int index,
 243                                 int (*enter)(struct cpuidle_device *dev,
 244                                         struct cpuidle_driver *drv, int index))
 245 {
 246         ktime_t time_start, time_end;
 247         s64 diff;
 248
 249         time_start = ktime_get();
 250
 251         index = enter(dev, drv, index);
 252
 253         time_end = ktime_get();
 254
 255         local_irq_enable();
 256
 257         diff = ktime_to_us(ktime_sub(time_end, time_start));
 258         if (diff > INT_MAX)
 259                 diff = INT_MAX;
 260
 261         dev->last_residency = (int) diff;
 262
 263         return index;
 264 }
 265
 266 #ifdef CONFIG_ARCH_HAS_CPU_RELAX
 267 static int poll_idle(struct cpuidle_device *dev,
 268                 struct cpuidle_driver *drv, int index)
 269 {
 270         ktime_t t1, t2;
 271         s64 diff;
 272
 273         t1 = ktime_get();
 274         local_irq_enable();
 275         while (!need_resched())
 276                 cpu_relax();
 277
 278         t2 = ktime_get();
 279         diff = ktime_to_us(ktime_sub(t2, t1));
 280         if (diff > INT_MAX)
 281                 diff = INT_MAX;
 282
 283         dev->last_residency = (int) diff;
 284
 285         return index;
 286 }
 287
 288 static void poll_idle_init(struct cpuidle_driver *drv)
 289 {
 290         struct cpuidle_state *state = &drv->states[0];
 291
 292         snprintf(state->name, CPUIDLE_NAME_LEN, "POLL");
 293         snprintf(state->desc, CPUIDLE_DESC_LEN, "CPUIDLE CORE POLL IDLE");
 294         state->exit_latency = 0;
 295         state->target_residency = 0;
 296         state->power_usage = -1;
 297         state->flags = 0;
 298         state->enter = poll_idle;
 299         state->disabled = false;
 300 }
 301 #else
 302 static void poll_idle_init(struct cpuidle_driver *drv) {}
 303 #endif /* CONFIG_ARCH_HAS_CPU_RELAX */
 304
 305 /**
 306  * cpuidle_enable_device - enables idle PM for a CPU
 307  * @dev: the CPU
 308  *
 309  * This function must be called between cpuidle_pause_and_lock and
 310  * cpuidle_resume_and_unlock when used externally.
 311  */
 312 int cpuidle_enable_device(struct cpuidle_device *dev)
 313 {
 314         int ret, i;
 315         struct cpuidle_driver *drv = cpuidle_get_driver();
 316
 317         if (!dev)
 318                 return -EINVAL;
 319
 320         if (dev->enabled)
 321                 return 0;
 322         if (!drv || !cpuidle_curr_governor)
 323                 return -EIO;
 324         if (!dev->state_count)
 325                 dev->state_count = drv->state_count;
 326
 327         if (dev->registered == 0) {
 328                 ret = __cpuidle_register_device(dev);
 329                 if (ret)
 330                         return ret;
 331         }
 332
 333         cpuidle_enter_ops = drv->en_core_tk_irqen ?
 334                 cpuidle_enter_tk : cpuidle_enter;
 335
 336         poll_idle_init(drv);
 337
 338         if ((ret = cpuidle_add_state_sysfs(dev)))
 339                 return ret;
 340
 341         if (cpuidle_curr_governor->enable &&
 342             (ret = cpuidle_curr_governor->enable(drv, dev)))
 343                 goto fail_sysfs;
 344
 345         for (i = 0; i < dev->state_count; i++) {
 346                 dev->states_usage[i].usage = 0;
 347                 dev->states_usage[i].time = 0;
 348         }
 349         dev->last_residency = 0;
 350
 351         smp_wmb();
 352
 353         dev->enabled = 1;
 354
 355         enabled_devices++;
 356         return 0;
 357
 358 fail_sysfs:
 359         cpuidle_remove_state_sysfs(dev);
 360
 361         return ret;
 362 }
 363
 364 EXPORT_SYMBOL_GPL(cpuidle_enable_device);
 365
 366 /**
 367  * cpuidle_disable_device - disables idle PM for a CPU
 368  * @dev: the CPU
 369  *
 370  * This function must be called between cpuidle_pause_and_lock and
 371  * cpuidle_resume_and_unlock when used externally.
 372  */
 373 void cpuidle_disable_device(struct cpuidle_device *dev)
 374 {
 375         if (!dev || !dev->enabled)
 376                 return;
 377         if (!cpuidle_get_driver() || !cpuidle_curr_governor)
 378                 return;
 379
 380         dev->enabled = 0;
 381
 382         if (cpuidle_curr_governor->disable)
 383                 cpuidle_curr_governor->disable(cpuidle_get_driver(), dev);
 384
 385         cpuidle_remove_state_sysfs(dev);
 386         enabled_devices--;
 387 }
 388
 389 EXPORT_SYMBOL_GPL(cpuidle_disable_device);
 390
 391 /**
 392  * __cpuidle_register_device - internal register function called before register
 393  * and enable routines
 394  * @dev: the cpu
 395  *
 396  * cpuidle_lock mutex must be held before this is called
 397  */
 398 static int __cpuidle_register_device(struct cpuidle_device *dev)
 399 {
 400         int ret;
 401         struct cpuidle_driver *cpuidle_driver = cpuidle_get_driver();
 402
 403         if (!try_module_get(cpuidle_driver->owner))
 404                 return -EINVAL;
 405
 406         per_cpu(cpuidle_devices, dev->cpu) = dev;
 407         list_add(&dev->device_list, &cpuidle_detected_devices);
 408         ret = cpuidle_add_sysfs(dev);
 409         if (ret)
 410                 goto err_sysfs;
 411
 412         ret = cpuidle_coupled_register_device(dev);
 413         if (ret)
 414                 goto err_coupled;
 415
 416         dev->registered = 1;
 417         return 0;
 418
 419 err_coupled:
 420         cpuidle_remove_sysfs(dev);
 421 err_sysfs:
 422         list_del(&dev->device_list);
 423         per_cpu(cpuidle_devices, dev->cpu) = NULL;
 424         module_put(cpuidle_driver->owner);
 425         return ret;
 426 }
 427
 428 /**
 429  * cpuidle_register_device - registers a CPU's idle PM feature
 430  * @dev: the cpu
 431  */
 432 int cpuidle_register_device(struct cpuidle_device *dev)
 433 {
 434         int ret;
 435
 436         if (!dev)
 437                 return -EINVAL;
 438
 439         mutex_lock(&cpuidle_lock);
 440
 441         if ((ret = __cpuidle_register_device(dev))) {
 442                 mutex_unlock(&cpuidle_lock);
 443                 return ret;
 444         }
 445
 446         cpuidle_enable_device(dev);
 447         cpuidle_install_idle_handler();
 448
 449         mutex_unlock(&cpuidle_lock);
 450
 451         return 0;
 452
 453 }
 454
 455 EXPORT_SYMBOL_GPL(cpuidle_register_device);
 456
 457 /**
 458  * cpuidle_unregister_device - unregisters a CPU's idle PM feature
 459  * @dev: the cpu
 460  */
 461 void cpuidle_unregister_device(struct cpuidle_device *dev)
 462 {
 463         struct cpuidle_driver *cpuidle_driver = cpuidle_get_driver();
 464
 465         if (dev->registered == 0)
 466                 return;
 467
 468         cpuidle_pause_and_lock();
 469
 470         cpuidle_disable_device(dev);
 471
 472         cpuidle_remove_sysfs(dev);
 473         list_del(&dev->device_list);
 474         per_cpu(cpuidle_devices, dev->cpu) = NULL;
 475
 476         cpuidle_coupled_unregister_device(dev);
 477
 478         cpuidle_resume_and_unlock();
 479
 480         module_put(cpuidle_driver->owner);
 481 }
 482
 483 EXPORT_SYMBOL_GPL(cpuidle_unregister_device);
 484
 485 #ifdef CONFIG_SMP
 486
 487 static void smp_callback(void *v)
 488 {
 489         /* we already woke the CPU up, nothing more to do */
 490 }
 491
 492 /*
 493  * This function gets called when a part of the kernel has a new latency
 494  * requirement.  This means we need to get all processors out of their C-state,
 495  * and then recalculate a new suitable C-state. Just do a cross-cpu IPI; that
 496  * wakes them all right up.
 497  */
 498 static int cpuidle_latency_notify(struct notifier_block *b,
 499                 unsigned long l, void *v)
 500 {
 501         smp_call_function(smp_callback, NULL, 1);
 502         return NOTIFY_OK;
 503 }
 504
 505 static struct notifier_block cpuidle_latency_notifier = {
 506         .notifier_call = cpuidle_latency_notify,
 507 };
 508
 509 static inline void latency_notifier_init(struct notifier_block *n)
 510 {
 511         pm_qos_add_notifier(PM_QOS_CPU_DMA_LATENCY, n);
 512 }
 513
 514 #else /* CONFIG_SMP */
 515
 516 #define latency_notifier_init(x) do { } while (0)
 517
 518 #endif /* CONFIG_SMP */
 519
 520 /**
 521  * cpuidle_init - core initializer
 522  */
 523 static int __init cpuidle_init(void)
 524 {
 525         int ret;
 526
 527         if (cpuidle_disabled())
 528                 return -ENODEV;
 529
 530         ret = cpuidle_add_interface(cpu_subsys.dev_root);
 531         if (ret)
 532                 return ret;
 533
 534         latency_notifier_init(&cpuidle_latency_notifier);
 535
 536         return 0;
 537 }
 538
 539 module_param(off, int, 0444);
 540 core_initcall(cpuidle_init);