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