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