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