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