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