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