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