drivers/cpuidle/cpuidle.c

   1 /*
   2  * cpuidle.c - core cpuidle infrastructure
   3  *
   4  * (C) 2006-2007 Venkatesh Pallipadi <[email protected]>
   5  *               Shaohua Li <[email protected]>
   6  *               Adam Belay <[email protected]>
   7  *
   8  * This code is licenced under the GPL.
   9  */
  10
  11 #include <linux/clockchips.h>
  12 #include <linux/kernel.h>
  13 #include <linux/mutex.h>
  14 #include <linux/sched.h>
  15 #include <linux/notifier.h>
  16 #include <linux/pm_qos.h>
  17 #include <linux/cpu.h>
  18 #include <linux/cpuidle.h>
  19 #include <linux/ktime.h>
  20 #include <linux/hrtimer.h>
  21 #include <linux/module.h>
  22 #include <linux/suspend.h>
  23 #include <linux/tick.h>
  24 #include <trace/events/power.h>
  25
  26 #include "cpuidle.h"
  27
  28 DEFINE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
  29 DEFINE_PER_CPU(struct cpuidle_device, cpuidle_dev);
  30
  31 DEFINE_MUTEX(cpuidle_lock);
  32 LIST_HEAD(cpuidle_detected_devices);
  33
  34 static int enabled_devices;
  35 static int off __read_mostly;
  36 static int initialized __read_mostly;
  37
  38 int cpuidle_disabled(void)
  39 {
  40         return off;
  41 }
  42 void disable_cpuidle(void)
  43 {
  44         off = 1;
  45 }
  46
  47 bool cpuidle_not_available(struct cpuidle_driver *drv,
  48                            struct cpuidle_device *dev)
  49 {
  50         return off || !initialized || !drv || !dev || !dev->enabled;
  51 }
  52
  53 /**
  54  * cpuidle_play_dead - cpu off-lining
  55  *
  56  * Returns in case of an error or no driver
  57  */
  58 int cpuidle_play_dead(void)
  59 {
  60         struct cpuidle_device *dev = __this_cpu_read(cpuidle_devices);
  61         struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
  62         int i;
  63
  64         if (!drv)
  65                 return -ENODEV;
  66
  67         /* Find lowest-power state that supports long-term idle */
  68         for (i = drv->state_count - 1; i >= CPUIDLE_DRIVER_STATE_START; i--)
  69                 if (drv->states[i].enter_dead)
  70                         return drv->states[i].enter_dead(dev, i);
  71
  72         return -ENODEV;
  73 }
  74
  75 static int find_deepest_state(struct cpuidle_driver *drv,
  76                               struct cpuidle_device *dev, bool freeze)
  77 {
  78         unsigned int latency_req = 0;
  79         int i, ret = freeze ? -1 : CPUIDLE_DRIVER_STATE_START - 1;
  80
  81         for (i = CPUIDLE_DRIVER_STATE_START; i < drv->state_count; i++) {
  82                 struct cpuidle_state *s = &drv->states[i];
  83                 struct cpuidle_state_usage *su = &dev->states_usage[i];
  84
  85                 if (s->disabled || su->disable || s->exit_latency <= latency_req
  86                     || (freeze && !s->enter_freeze))
  87                         continue;
  88
  89                 latency_req = s->exit_latency;
  90                 ret = i;
  91         }
  92         return ret;
  93 }
  94
  95 /**
  96  * cpuidle_find_deepest_state - Find the deepest available idle state.
  97  * @drv: cpuidle driver for the given CPU.
  98  * @dev: cpuidle device for the given CPU.
  99  */
 100 int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
 101                                struct cpuidle_device *dev)
 102 {
 103         return find_deepest_state(drv, dev, false);
 104 }
 105
 106 static void enter_freeze_proper(struct cpuidle_driver *drv,
 107                                 struct cpuidle_device *dev, int index)
 108 {
 109         tick_freeze();
 110         /*
 111          * The state used here cannot be a "coupled" one, because the "coupled"
 112          * cpuidle mechanism enables interrupts and doing that with timekeeping
 113          * suspended is generally unsafe.
 114          */
 115         drv->states[index].enter_freeze(dev, drv, index);
 116         WARN_ON(!irqs_disabled());
 117         /*
 118          * timekeeping_resume() that will be called by tick_unfreeze() for the
 119          * last CPU executing it calls functions containing RCU read-side
 120          * critical sections, so tell RCU about that.
 121          */
 122         RCU_NONIDLE(tick_unfreeze());
 123 }
 124
 125 /**
 126  * cpuidle_enter_freeze - Enter an idle state suitable for suspend-to-idle.
 127  * @drv: cpuidle driver for the given CPU.
 128  * @dev: cpuidle device for the given CPU.
 129  *
 130  * If there are states with the ->enter_freeze callback, find the deepest of
 131  * them and enter it with frozen tick.
 132  */
 133 int cpuidle_enter_freeze(struct cpuidle_driver *drv, struct cpuidle_device *dev)
 134 {
 135         int index;
 136
 137         /*
 138          * Find the deepest state with ->enter_freeze present, which guarantees
 139          * that interrupts won't be enabled when it exits and allows the tick to
 140          * be frozen safely.
 141          */
 142         index = find_deepest_state(drv, dev, true);
 143         if (index >= 0)
 144                 enter_freeze_proper(drv, dev, index);
 145
 146         return index;
 147 }
 148
 149 /**
 150  * cpuidle_enter_state - enter the state and update stats
 151  * @dev: cpuidle device for this cpu
 152  * @drv: cpuidle driver for this cpu
 153  * @next_state: index into drv->states of the state to enter
 154  */
 155 int cpuidle_enter_state(struct cpuidle_device *dev, struct cpuidle_driver *drv,
 156                         int index)
 157 {
 158         int entered_state;
 159
 160         struct cpuidle_state *target_state = &drv->states[index];
 161         ktime_t time_start, time_end;
 162         s64 diff;
 163
 164         trace_cpu_idle_rcuidle(index, dev->cpu);
 165         time_start = ktime_get();
 166
 167         entered_state = target_state->enter(dev, drv, index);
 168
 169         time_end = ktime_get();
 170         trace_cpu_idle_rcuidle(PWR_EVENT_EXIT, dev->cpu);
 171
 172         if (!cpuidle_state_is_coupled(dev, drv, entered_state))
 173                 local_irq_enable();
 174
 175         diff = ktime_to_us(ktime_sub(time_end, time_start));
 176         if (diff > INT_MAX)
 177                 diff = INT_MAX;
 178
 179         dev->last_residency = (int) diff;
 180
 181         if (entered_state >= 0) {
 182                 /* Update cpuidle counters */
 183                 /* This can be moved to within driver enter routine
 184                  * but that results in multiple copies of same code.
 185                  */
 186                 dev->states_usage[entered_state].time += dev->last_residency;
 187                 dev->states_usage[entered_state].usage++;
 188         } else {
 189                 dev->last_residency = 0;
 190         }
 191
 192         return entered_state;
 193 }
 194
 195 /**
 196  * cpuidle_select - ask the cpuidle framework to choose an idle state
 197  *
 198  * @drv: the cpuidle driver
 199  * @dev: the cpuidle device
 200  *
 201  * Returns the index of the idle state.
 202  */
 203 int cpuidle_select(struct cpuidle_driver *drv, struct cpuidle_device *dev)
 204 {
 205         return cpuidle_curr_governor->select(drv, dev);
 206 }
 207
 208 /**
 209  * cpuidle_enter - enter into the specified idle state
 210  *
 211  * @drv:   the cpuidle driver tied with the cpu
 212  * @dev:   the cpuidle device
 213  * @index: the index in the idle state table
 214  *
 215  * Returns the index in the idle state, < 0 in case of error.
 216  * The error code depends on the backend driver
 217  */
 218 int cpuidle_enter(struct cpuidle_driver *drv, struct cpuidle_device *dev,
 219                   int index)
 220 {
 221         if (cpuidle_state_is_coupled(dev, drv, index))
 222                 return cpuidle_enter_state_coupled(dev, drv, index);
 223         return cpuidle_enter_state(dev, drv, index);
 224 }
 225
 226 /**
 227  * cpuidle_reflect - tell the underlying governor what was the state
 228  * we were in
 229  *
 230  * @dev  : the cpuidle device
 231  * @index: the index in the idle state table
 232  *
 233  */
 234 void cpuidle_reflect(struct cpuidle_device *dev, int index)
 235 {
 236         if (cpuidle_curr_governor->reflect)
 237                 cpuidle_curr_governor->reflect(dev, index);
 238 }
 239
 240 /**
 241  * cpuidle_install_idle_handler - installs the cpuidle idle loop handler
 242  */
 243 void cpuidle_install_idle_handler(void)
 244 {
 245         if (enabled_devices) {
 246                 /* Make sure all changes finished before we switch to new idle */
 247                 smp_wmb();
 248                 initialized = 1;
 249         }
 250 }
 251
 252 /**
 253  * cpuidle_uninstall_idle_handler - uninstalls the cpuidle idle loop handler
 254  */
 255 void cpuidle_uninstall_idle_handler(void)
 256 {
 257         if (enabled_devices) {
 258                 initialized = 0;
 259                 wake_up_all_idle_cpus();
 260         }
 261
 262         /*
 263          * Make sure external observers (such as the scheduler)
 264          * are done looking at pointed idle states.
 265          */
 266         synchronize_rcu();
 267 }
 268
 269 /**
 270  * cpuidle_pause_and_lock - temporarily disables CPUIDLE
 271  */
 272 void cpuidle_pause_and_lock(void)
 273 {
 274         mutex_lock(&cpuidle_lock);
 275         cpuidle_uninstall_idle_handler();
 276 }
 277
 278 EXPORT_SYMBOL_GPL(cpuidle_pause_and_lock);
 279
 280 /**
 281  * cpuidle_resume_and_unlock - resumes CPUIDLE operation
 282  */
 283 void cpuidle_resume_and_unlock(void)
 284 {
 285         cpuidle_install_idle_handler();
 286         mutex_unlock(&cpuidle_lock);
 287 }
 288
 289 EXPORT_SYMBOL_GPL(cpuidle_resume_and_unlock);
 290
 291 /* Currently used in suspend/resume path to suspend cpuidle */
 292 void cpuidle_pause(void)
 293 {
 294         mutex_lock(&cpuidle_lock);
 295         cpuidle_uninstall_idle_handler();
 296         mutex_unlock(&cpuidle_lock);
 297 }
 298
 299 /* Currently used in suspend/resume path to resume cpuidle */
 300 void cpuidle_resume(void)
 301 {
 302         mutex_lock(&cpuidle_lock);
 303         cpuidle_install_idle_handler();
 304         mutex_unlock(&cpuidle_lock);
 305 }
 306
 307 /**
 308  * cpuidle_enable_device - enables idle PM for a CPU
 309  * @dev: the CPU
 310  *
 311  * This function must be called between cpuidle_pause_and_lock and
 312  * cpuidle_resume_and_unlock when used externally.
 313  */
 314 int cpuidle_enable_device(struct cpuidle_device *dev)
 315 {
 316         int ret;
 317         struct cpuidle_driver *drv;
 318
 319         if (!dev)
 320                 return -EINVAL;
 321
 322         if (dev->enabled)
 323                 return 0;
 324
 325         drv = cpuidle_get_cpu_driver(dev);
 326
 327         if (!drv || !cpuidle_curr_governor)
 328                 return -EIO;
 329
 330         if (!dev->registered)
 331                 return -EINVAL;
 332
 333         if (!dev->state_count)
 334                 dev->state_count = drv->state_count;
 335
 336         ret = cpuidle_add_device_sysfs(dev);
 337         if (ret)
 338                 return ret;
 339
 340         if (cpuidle_curr_governor->enable &&
 341             (ret = cpuidle_curr_governor->enable(drv, dev)))
 342                 goto fail_sysfs;
 343
 344         smp_wmb();
 345
 346         dev->enabled = 1;
 347
 348         enabled_devices++;
 349         return 0;
 350
 351 fail_sysfs:
 352         cpuidle_remove_device_sysfs(dev);
 353
 354         return ret;
 355 }
 356
 357 EXPORT_SYMBOL_GPL(cpuidle_enable_device);
 358
 359 /**
 360  * cpuidle_disable_device - disables idle PM for a CPU
 361  * @dev: the CPU
 362  *
 363  * This function must be called between cpuidle_pause_and_lock and
 364  * cpuidle_resume_and_unlock when used externally.
 365  */
 366 void cpuidle_disable_device(struct cpuidle_device *dev)
 367 {
 368         struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
 369
 370         if (!dev || !dev->enabled)
 371                 return;
 372
 373         if (!drv || !cpuidle_curr_governor)
 374                 return;
 375
 376         dev->enabled = 0;
 377
 378         if (cpuidle_curr_governor->disable)
 379                 cpuidle_curr_governor->disable(drv, dev);
 380
 381         cpuidle_remove_device_sysfs(dev);
 382         enabled_devices--;
 383 }
 384
 385 EXPORT_SYMBOL_GPL(cpuidle_disable_device);
 386
 387 static void __cpuidle_unregister_device(struct cpuidle_device *dev)
 388 {
 389         struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
 390
 391         list_del(&dev->device_list);
 392         per_cpu(cpuidle_devices, dev->cpu) = NULL;
 393         module_put(drv->owner);
 394 }
 395
 396 static void __cpuidle_device_init(struct cpuidle_device *dev)
 397 {
 398         memset(dev->states_usage, 0, sizeof(dev->states_usage));
 399         dev->last_residency = 0;
 400 }
 401
 402 /**
 403  * __cpuidle_register_device - internal register function called before register
 404  * and enable routines
 405  * @dev: the cpu
 406  *
 407  * cpuidle_lock mutex must be held before this is called
 408  */
 409 static int __cpuidle_register_device(struct cpuidle_device *dev)
 410 {
 411         int ret;
 412         struct cpuidle_driver *drv = cpuidle_get_cpu_driver(dev);
 413
 414         if (!try_module_get(drv->owner))
 415                 return -EINVAL;
 416
 417         per_cpu(cpuidle_devices, dev->cpu) = dev;
 418         list_add(&dev->device_list, &cpuidle_detected_devices);
 419
 420         ret = cpuidle_coupled_register_device(dev);
 421         if (ret)
 422                 __cpuidle_unregister_device(dev);
 423         else
 424                 dev->registered = 1;
 425
 426         return ret;
 427 }
 428
 429 /**
 430  * cpuidle_register_device - registers a CPU's idle PM feature
 431  * @dev: the cpu
 432  */
 433 int cpuidle_register_device(struct cpuidle_device *dev)
 434 {
 435         int ret = -EBUSY;
 436
 437         if (!dev)
 438                 return -EINVAL;
 439
 440         mutex_lock(&cpuidle_lock);
 441
 442         if (dev->registered)
 443                 goto out_unlock;
 444
 445         __cpuidle_device_init(dev);
 446
 447         ret = __cpuidle_register_device(dev);
 448         if (ret)
 449                 goto out_unlock;
 450
 451         ret = cpuidle_add_sysfs(dev);
 452         if (ret)
 453                 goto out_unregister;
 454
 455         ret = cpuidle_enable_device(dev);
 456         if (ret)
 457                 goto out_sysfs;
 458
 459         cpuidle_install_idle_handler();
 460
 461 out_unlock:
 462         mutex_unlock(&cpuidle_lock);
 463
 464         return ret;
 465
 466 out_sysfs:
 467         cpuidle_remove_sysfs(dev);
 468 out_unregister:
 469         __cpuidle_unregister_device(dev);
 470         goto out_unlock;
 471 }
 472
 473 EXPORT_SYMBOL_GPL(cpuidle_register_device);
 474
 475 /**
 476  * cpuidle_unregister_device - unregisters a CPU's idle PM feature
 477  * @dev: the cpu
 478  */
 479 void cpuidle_unregister_device(struct cpuidle_device *dev)
 480 {
 481         if (!dev || dev->registered == 0)
 482                 return;
 483
 484         cpuidle_pause_and_lock();
 485
 486         cpuidle_disable_device(dev);
 487
 488         cpuidle_remove_sysfs(dev);
 489
 490         __cpuidle_unregister_device(dev);
 491
 492         cpuidle_coupled_unregister_device(dev);
 493
 494         cpuidle_resume_and_unlock();
 495 }
 496
 497 EXPORT_SYMBOL_GPL(cpuidle_unregister_device);
 498
 499 /**
 500  * cpuidle_unregister: unregister a driver and the devices. This function
 501  * can be used only if the driver has been previously registered through
 502  * the cpuidle_register function.
 503  *
 504  * @drv: a valid pointer to a struct cpuidle_driver
 505  */
 506 void cpuidle_unregister(struct cpuidle_driver *drv)
 507 {
 508         int cpu;
 509         struct cpuidle_device *device;
 510
 511         for_each_cpu(cpu, drv->cpumask) {
 512                 device = &per_cpu(cpuidle_dev, cpu);
 513                 cpuidle_unregister_device(device);
 514         }
 515
 516         cpuidle_unregister_driver(drv);
 517 }
 518 EXPORT_SYMBOL_GPL(cpuidle_unregister);
 519
 520 /**
 521  * cpuidle_register: registers the driver and the cpu devices with the
 522  * coupled_cpus passed as parameter. This function is used for all common
 523  * initialization pattern there are in the arch specific drivers. The
 524  * devices is globally defined in this file.
 525  *
 526  * @drv         : a valid pointer to a struct cpuidle_driver
 527  * @coupled_cpus: a cpumask for the coupled states
 528  *
 529  * Returns 0 on success, < 0 otherwise
 530  */
 531 int cpuidle_register(struct cpuidle_driver *drv,
 532                      const struct cpumask *const coupled_cpus)
 533 {
 534         int ret, cpu;
 535         struct cpuidle_device *device;
 536
 537         ret = cpuidle_register_driver(drv);
 538         if (ret) {
 539                 pr_err("failed to register cpuidle driver\n");
 540                 return ret;
 541         }
 542
 543         for_each_cpu(cpu, drv->cpumask) {
 544                 device = &per_cpu(cpuidle_dev, cpu);
 545                 device->cpu = cpu;
 546
 547 #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
 548                 /*
 549                  * On multiplatform for ARM, the coupled idle states could be
 550                  * enabled in the kernel even if the cpuidle driver does not
 551                  * use it. Note, coupled_cpus is a struct copy.
 552                  */
 553                 if (coupled_cpus)
 554                         device->coupled_cpus = *coupled_cpus;
 555 #endif
 556                 ret = cpuidle_register_device(device);
 557                 if (!ret)
 558                         continue;
 559
 560                 pr_err("Failed to register cpuidle device for cpu%d\n", cpu);
 561
 562                 cpuidle_unregister(drv);
 563                 break;
 564         }
 565
 566         return ret;
 567 }
 568 EXPORT_SYMBOL_GPL(cpuidle_register);
 569
 570 #ifdef CONFIG_SMP
 571
 572 /*
 573  * This function gets called when a part of the kernel has a new latency
 574  * requirement.  This means we need to get all processors out of their C-state,
 575  * and then recalculate a new suitable C-state. Just do a cross-cpu IPI; that
 576  * wakes them all right up.
 577  */
 578 static int cpuidle_latency_notify(struct notifier_block *b,
 579                 unsigned long l, void *v)
 580 {
 581         wake_up_all_idle_cpus();
 582         return NOTIFY_OK;
 583 }
 584
 585 static struct notifier_block cpuidle_latency_notifier = {
 586         .notifier_call = cpuidle_latency_notify,
 587 };
 588
 589 static inline void latency_notifier_init(struct notifier_block *n)
 590 {
 591         pm_qos_add_notifier(PM_QOS_CPU_DMA_LATENCY, n);
 592 }
 593
 594 #else /* CONFIG_SMP */
 595
 596 #define latency_notifier_init(x) do { } while (0)
 597
 598 #endif /* CONFIG_SMP */
 599
 600 /**
 601  * cpuidle_init - core initializer
 602  */
 603 static int __init cpuidle_init(void)
 604 {
 605         int ret;
 606
 607         if (cpuidle_disabled())
 608                 return -ENODEV;
 609
 610         ret = cpuidle_add_interface(cpu_subsys.dev_root);
 611         if (ret)
 612                 return ret;
 613
 614         latency_notifier_init(&cpuidle_latency_notifier);
 615
 616         return 0;
 617 }
 618
 619 module_param(off, int, 0444);
 620 core_initcall(cpuidle_init);