Merge branch 'tunnels'
[linux.git] / drivers / idle / intel_idle.c
1 /*
2  * intel_idle.c - native hardware idle loop for modern Intel processors
3  *
4  * Copyright (c) 2013, Intel Corporation.
5  * Len Brown <len.brown@intel.com>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms and conditions of the GNU General Public License,
9  * version 2, as published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along with
17  * this program; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19  */
20
21 /*
22  * intel_idle is a cpuidle driver that loads on specific Intel processors
23  * in lieu of the legacy ACPI processor_idle driver.  The intent is to
24  * make Linux more efficient on these processors, as intel_idle knows
25  * more than ACPI, as well as make Linux more immune to ACPI BIOS bugs.
26  */
27
28 /*
29  * Design Assumptions
30  *
31  * All CPUs have same idle states as boot CPU
32  *
33  * Chipset BM_STS (bus master status) bit is a NOP
34  *      for preventing entry into deep C-stats
35  */
36
37 /*
38  * Known limitations
39  *
40  * The driver currently initializes for_each_online_cpu() upon modprobe.
41  * It it unaware of subsequent processors hot-added to the system.
42  * This means that if you boot with maxcpus=n and later online
43  * processors above n, those processors will use C1 only.
44  *
45  * ACPI has a .suspend hack to turn off deep c-statees during suspend
46  * to avoid complications with the lapic timer workaround.
47  * Have not seen issues with suspend, but may need same workaround here.
48  *
49  * There is currently no kernel-based automatic probing/loading mechanism
50  * if the driver is built as a module.
51  */
52
53 /* un-comment DEBUG to enable pr_debug() statements */
54 #define DEBUG
55
56 #include <linux/kernel.h>
57 #include <linux/cpuidle.h>
58 #include <linux/clockchips.h>
59 #include <trace/events/power.h>
60 #include <linux/sched.h>
61 #include <linux/notifier.h>
62 #include <linux/cpu.h>
63 #include <linux/module.h>
64 #include <asm/cpu_device_id.h>
65 #include <asm/mwait.h>
66 #include <asm/msr.h>
67
68 #define INTEL_IDLE_VERSION "0.4"
69 #define PREFIX "intel_idle: "
70
71 static struct cpuidle_driver intel_idle_driver = {
72         .name = "intel_idle",
73         .owner = THIS_MODULE,
74 };
75 /* intel_idle.max_cstate=0 disables driver */
76 static int max_cstate = CPUIDLE_STATE_MAX - 1;
77
78 static unsigned int mwait_substates;
79
80 #define LAPIC_TIMER_ALWAYS_RELIABLE 0xFFFFFFFF
81 /* Reliable LAPIC Timer States, bit 1 for C1 etc.  */
82 static unsigned int lapic_timer_reliable_states = (1 << 1);      /* Default to only C1 */
83
84 struct idle_cpu {
85         struct cpuidle_state *state_table;
86
87         /*
88          * Hardware C-state auto-demotion may not always be optimal.
89          * Indicate which enable bits to clear here.
90          */
91         unsigned long auto_demotion_disable_flags;
92         bool disable_promotion_to_c1e;
93 };
94
95 static const struct idle_cpu *icpu;
96 static struct cpuidle_device __percpu *intel_idle_cpuidle_devices;
97 static int intel_idle(struct cpuidle_device *dev,
98                         struct cpuidle_driver *drv, int index);
99 static int intel_idle_cpu_init(int cpu);
100
101 static struct cpuidle_state *cpuidle_state_table;
102
103 /*
104  * Set this flag for states where the HW flushes the TLB for us
105  * and so we don't need cross-calls to keep it consistent.
106  * If this flag is set, SW flushes the TLB, so even if the
107  * HW doesn't do the flushing, this flag is safe to use.
108  */
109 #define CPUIDLE_FLAG_TLB_FLUSHED        0x10000
110
111 /*
112  * MWAIT takes an 8-bit "hint" in EAX "suggesting"
113  * the C-state (top nibble) and sub-state (bottom nibble)
114  * 0x00 means "MWAIT(C1)", 0x10 means "MWAIT(C2)" etc.
115  *
116  * We store the hint at the top of our "flags" for each state.
117  */
118 #define flg2MWAIT(flags) (((flags) >> 24) & 0xFF)
119 #define MWAIT2flg(eax) ((eax & 0xFF) << 24)
120
121 /*
122  * States are indexed by the cstate number,
123  * which is also the index into the MWAIT hint array.
124  * Thus C0 is a dummy.
125  */
126 static struct cpuidle_state nehalem_cstates[] = {
127         {
128                 .name = "C1-NHM",
129                 .desc = "MWAIT 0x00",
130                 .flags = MWAIT2flg(0x00) | CPUIDLE_FLAG_TIME_VALID,
131                 .exit_latency = 3,
132                 .target_residency = 6,
133                 .enter = &intel_idle },
134         {
135                 .name = "C1E-NHM",
136                 .desc = "MWAIT 0x01",
137                 .flags = MWAIT2flg(0x01) | CPUIDLE_FLAG_TIME_VALID,
138                 .exit_latency = 10,
139                 .target_residency = 20,
140                 .enter = &intel_idle },
141         {
142                 .name = "C3-NHM",
143                 .desc = "MWAIT 0x10",
144                 .flags = MWAIT2flg(0x10) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
145                 .exit_latency = 20,
146                 .target_residency = 80,
147                 .enter = &intel_idle },
148         {
149                 .name = "C6-NHM",
150                 .desc = "MWAIT 0x20",
151                 .flags = MWAIT2flg(0x20) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
152                 .exit_latency = 200,
153                 .target_residency = 800,
154                 .enter = &intel_idle },
155         {
156                 .enter = NULL }
157 };
158
159 static struct cpuidle_state snb_cstates[] = {
160         {
161                 .name = "C1-SNB",
162                 .desc = "MWAIT 0x00",
163                 .flags = MWAIT2flg(0x00) | CPUIDLE_FLAG_TIME_VALID,
164                 .exit_latency = 2,
165                 .target_residency = 2,
166                 .enter = &intel_idle },
167         {
168                 .name = "C1E-SNB",
169                 .desc = "MWAIT 0x01",
170                 .flags = MWAIT2flg(0x01) | CPUIDLE_FLAG_TIME_VALID,
171                 .exit_latency = 10,
172                 .target_residency = 20,
173                 .enter = &intel_idle },
174         {
175                 .name = "C3-SNB",
176                 .desc = "MWAIT 0x10",
177                 .flags = MWAIT2flg(0x10) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
178                 .exit_latency = 80,
179                 .target_residency = 211,
180                 .enter = &intel_idle },
181         {
182                 .name = "C6-SNB",
183                 .desc = "MWAIT 0x20",
184                 .flags = MWAIT2flg(0x20) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
185                 .exit_latency = 104,
186                 .target_residency = 345,
187                 .enter = &intel_idle },
188         {
189                 .name = "C7-SNB",
190                 .desc = "MWAIT 0x30",
191                 .flags = MWAIT2flg(0x30) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
192                 .exit_latency = 109,
193                 .target_residency = 345,
194                 .enter = &intel_idle },
195         {
196                 .enter = NULL }
197 };
198
199 static struct cpuidle_state ivb_cstates[] = {
200         {
201                 .name = "C1-IVB",
202                 .desc = "MWAIT 0x00",
203                 .flags = MWAIT2flg(0x00) | CPUIDLE_FLAG_TIME_VALID,
204                 .exit_latency = 1,
205                 .target_residency = 1,
206                 .enter = &intel_idle },
207         {
208                 .name = "C1E-IVB",
209                 .desc = "MWAIT 0x01",
210                 .flags = MWAIT2flg(0x01) | CPUIDLE_FLAG_TIME_VALID,
211                 .exit_latency = 10,
212                 .target_residency = 20,
213                 .enter = &intel_idle },
214         {
215                 .name = "C3-IVB",
216                 .desc = "MWAIT 0x10",
217                 .flags = MWAIT2flg(0x10) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
218                 .exit_latency = 59,
219                 .target_residency = 156,
220                 .enter = &intel_idle },
221         {
222                 .name = "C6-IVB",
223                 .desc = "MWAIT 0x20",
224                 .flags = MWAIT2flg(0x20) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
225                 .exit_latency = 80,
226                 .target_residency = 300,
227                 .enter = &intel_idle },
228         {
229                 .name = "C7-IVB",
230                 .desc = "MWAIT 0x30",
231                 .flags = MWAIT2flg(0x30) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
232                 .exit_latency = 87,
233                 .target_residency = 300,
234                 .enter = &intel_idle },
235         {
236                 .enter = NULL }
237 };
238
239 static struct cpuidle_state hsw_cstates[] = {
240         {
241                 .name = "C1-HSW",
242                 .desc = "MWAIT 0x00",
243                 .flags = MWAIT2flg(0x00) | CPUIDLE_FLAG_TIME_VALID,
244                 .exit_latency = 2,
245                 .target_residency = 2,
246                 .enter = &intel_idle },
247         {
248                 .name = "C1E-HSW",
249                 .desc = "MWAIT 0x01",
250                 .flags = MWAIT2flg(0x01) | CPUIDLE_FLAG_TIME_VALID,
251                 .exit_latency = 10,
252                 .target_residency = 20,
253                 .enter = &intel_idle },
254         {
255                 .name = "C3-HSW",
256                 .desc = "MWAIT 0x10",
257                 .flags = MWAIT2flg(0x10) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
258                 .exit_latency = 33,
259                 .target_residency = 100,
260                 .enter = &intel_idle },
261         {
262                 .name = "C6-HSW",
263                 .desc = "MWAIT 0x20",
264                 .flags = MWAIT2flg(0x20) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
265                 .exit_latency = 133,
266                 .target_residency = 400,
267                 .enter = &intel_idle },
268         {
269                 .name = "C7s-HSW",
270                 .desc = "MWAIT 0x32",
271                 .flags = MWAIT2flg(0x32) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
272                 .exit_latency = 166,
273                 .target_residency = 500,
274                 .enter = &intel_idle },
275         {
276                 .name = "C8-HSW",
277                 .desc = "MWAIT 0x40",
278                 .flags = MWAIT2flg(0x40) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
279                 .exit_latency = 300,
280                 .target_residency = 900,
281                 .enter = &intel_idle },
282         {
283                 .name = "C9-HSW",
284                 .desc = "MWAIT 0x50",
285                 .flags = MWAIT2flg(0x50) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
286                 .exit_latency = 600,
287                 .target_residency = 1800,
288                 .enter = &intel_idle },
289         {
290                 .name = "C10-HSW",
291                 .desc = "MWAIT 0x60",
292                 .flags = MWAIT2flg(0x60) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
293                 .exit_latency = 2600,
294                 .target_residency = 7700,
295                 .enter = &intel_idle },
296         {
297                 .enter = NULL }
298 };
299
300 static struct cpuidle_state atom_cstates[] = {
301         {
302                 .name = "C1E-ATM",
303                 .desc = "MWAIT 0x00",
304                 .flags = MWAIT2flg(0x00) | CPUIDLE_FLAG_TIME_VALID,
305                 .exit_latency = 10,
306                 .target_residency = 20,
307                 .enter = &intel_idle },
308         {
309                 .name = "C2-ATM",
310                 .desc = "MWAIT 0x10",
311                 .flags = MWAIT2flg(0x10) | CPUIDLE_FLAG_TIME_VALID,
312                 .exit_latency = 20,
313                 .target_residency = 80,
314                 .enter = &intel_idle },
315         {
316                 .name = "C4-ATM",
317                 .desc = "MWAIT 0x30",
318                 .flags = MWAIT2flg(0x30) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
319                 .exit_latency = 100,
320                 .target_residency = 400,
321                 .enter = &intel_idle },
322         {
323                 .name = "C6-ATM",
324                 .desc = "MWAIT 0x52",
325                 .flags = MWAIT2flg(0x52) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
326                 .exit_latency = 140,
327                 .target_residency = 560,
328                 .enter = &intel_idle },
329         {
330                 .enter = NULL }
331 };
332 static struct cpuidle_state avn_cstates[] = {
333         {
334                 .name = "C1-AVN",
335                 .desc = "MWAIT 0x00",
336                 .flags = MWAIT2flg(0x00) | CPUIDLE_FLAG_TIME_VALID,
337                 .exit_latency = 2,
338                 .target_residency = 2,
339                 .enter = &intel_idle },
340         {
341                 .name = "C6-AVN",
342                 .desc = "MWAIT 0x51",
343                 .flags = MWAIT2flg(0x51) | CPUIDLE_FLAG_TIME_VALID | CPUIDLE_FLAG_TLB_FLUSHED,
344                 .exit_latency = 15,
345                 .target_residency = 45,
346                 .enter = &intel_idle },
347         {
348                 .enter = NULL }
349 };
350
351 /**
352  * intel_idle
353  * @dev: cpuidle_device
354  * @drv: cpuidle driver
355  * @index: index of cpuidle state
356  *
357  * Must be called under local_irq_disable().
358  */
359 static int intel_idle(struct cpuidle_device *dev,
360                 struct cpuidle_driver *drv, int index)
361 {
362         unsigned long ecx = 1; /* break on interrupt flag */
363         struct cpuidle_state *state = &drv->states[index];
364         unsigned long eax = flg2MWAIT(state->flags);
365         unsigned int cstate;
366         int cpu = smp_processor_id();
367
368         cstate = (((eax) >> MWAIT_SUBSTATE_SIZE) & MWAIT_CSTATE_MASK) + 1;
369
370         /*
371          * leave_mm() to avoid costly and often unnecessary wakeups
372          * for flushing the user TLB's associated with the active mm.
373          */
374         if (state->flags & CPUIDLE_FLAG_TLB_FLUSHED)
375                 leave_mm(cpu);
376
377         if (!(lapic_timer_reliable_states & (1 << (cstate))))
378                 clockevents_notify(CLOCK_EVT_NOTIFY_BROADCAST_ENTER, &cpu);
379
380         mwait_idle_with_hints(eax, ecx);
381
382         if (!(lapic_timer_reliable_states & (1 << (cstate))))
383                 clockevents_notify(CLOCK_EVT_NOTIFY_BROADCAST_EXIT, &cpu);
384
385         return index;
386 }
387
388 static void __setup_broadcast_timer(void *arg)
389 {
390         unsigned long reason = (unsigned long)arg;
391         int cpu = smp_processor_id();
392
393         reason = reason ?
394                 CLOCK_EVT_NOTIFY_BROADCAST_ON : CLOCK_EVT_NOTIFY_BROADCAST_OFF;
395
396         clockevents_notify(reason, &cpu);
397 }
398
399 static int cpu_hotplug_notify(struct notifier_block *n,
400                               unsigned long action, void *hcpu)
401 {
402         int hotcpu = (unsigned long)hcpu;
403         struct cpuidle_device *dev;
404
405         switch (action & ~CPU_TASKS_FROZEN) {
406         case CPU_ONLINE:
407
408                 if (lapic_timer_reliable_states != LAPIC_TIMER_ALWAYS_RELIABLE)
409                         smp_call_function_single(hotcpu, __setup_broadcast_timer,
410                                                  (void *)true, 1);
411
412                 /*
413                  * Some systems can hotplug a cpu at runtime after
414                  * the kernel has booted, we have to initialize the
415                  * driver in this case
416                  */
417                 dev = per_cpu_ptr(intel_idle_cpuidle_devices, hotcpu);
418                 if (!dev->registered)
419                         intel_idle_cpu_init(hotcpu);
420
421                 break;
422         }
423         return NOTIFY_OK;
424 }
425
426 static struct notifier_block cpu_hotplug_notifier = {
427         .notifier_call = cpu_hotplug_notify,
428 };
429
430 static void auto_demotion_disable(void *dummy)
431 {
432         unsigned long long msr_bits;
433
434         rdmsrl(MSR_NHM_SNB_PKG_CST_CFG_CTL, msr_bits);
435         msr_bits &= ~(icpu->auto_demotion_disable_flags);
436         wrmsrl(MSR_NHM_SNB_PKG_CST_CFG_CTL, msr_bits);
437 }
438 static void c1e_promotion_disable(void *dummy)
439 {
440         unsigned long long msr_bits;
441
442         rdmsrl(MSR_IA32_POWER_CTL, msr_bits);
443         msr_bits &= ~0x2;
444         wrmsrl(MSR_IA32_POWER_CTL, msr_bits);
445 }
446
447 static const struct idle_cpu idle_cpu_nehalem = {
448         .state_table = nehalem_cstates,
449         .auto_demotion_disable_flags = NHM_C1_AUTO_DEMOTE | NHM_C3_AUTO_DEMOTE,
450         .disable_promotion_to_c1e = true,
451 };
452
453 static const struct idle_cpu idle_cpu_atom = {
454         .state_table = atom_cstates,
455 };
456
457 static const struct idle_cpu idle_cpu_lincroft = {
458         .state_table = atom_cstates,
459         .auto_demotion_disable_flags = ATM_LNC_C6_AUTO_DEMOTE,
460 };
461
462 static const struct idle_cpu idle_cpu_snb = {
463         .state_table = snb_cstates,
464         .disable_promotion_to_c1e = true,
465 };
466
467 static const struct idle_cpu idle_cpu_ivb = {
468         .state_table = ivb_cstates,
469         .disable_promotion_to_c1e = true,
470 };
471
472 static const struct idle_cpu idle_cpu_hsw = {
473         .state_table = hsw_cstates,
474         .disable_promotion_to_c1e = true,
475 };
476
477 static const struct idle_cpu idle_cpu_avn = {
478         .state_table = avn_cstates,
479         .disable_promotion_to_c1e = true,
480 };
481
482 #define ICPU(model, cpu) \
483         { X86_VENDOR_INTEL, 6, model, X86_FEATURE_MWAIT, (unsigned long)&cpu }
484
485 static const struct x86_cpu_id intel_idle_ids[] = {
486         ICPU(0x1a, idle_cpu_nehalem),
487         ICPU(0x1e, idle_cpu_nehalem),
488         ICPU(0x1f, idle_cpu_nehalem),
489         ICPU(0x25, idle_cpu_nehalem),
490         ICPU(0x2c, idle_cpu_nehalem),
491         ICPU(0x2e, idle_cpu_nehalem),
492         ICPU(0x1c, idle_cpu_atom),
493         ICPU(0x26, idle_cpu_lincroft),
494         ICPU(0x2f, idle_cpu_nehalem),
495         ICPU(0x2a, idle_cpu_snb),
496         ICPU(0x2d, idle_cpu_snb),
497         ICPU(0x3a, idle_cpu_ivb),
498         ICPU(0x3e, idle_cpu_ivb),
499         ICPU(0x3c, idle_cpu_hsw),
500         ICPU(0x3f, idle_cpu_hsw),
501         ICPU(0x45, idle_cpu_hsw),
502         ICPU(0x46, idle_cpu_hsw),
503         ICPU(0x4D, idle_cpu_avn),
504         {}
505 };
506 MODULE_DEVICE_TABLE(x86cpu, intel_idle_ids);
507
508 /*
509  * intel_idle_probe()
510  */
511 static int __init intel_idle_probe(void)
512 {
513         unsigned int eax, ebx, ecx;
514         const struct x86_cpu_id *id;
515
516         if (max_cstate == 0) {
517                 pr_debug(PREFIX "disabled\n");
518                 return -EPERM;
519         }
520
521         id = x86_match_cpu(intel_idle_ids);
522         if (!id) {
523                 if (boot_cpu_data.x86_vendor == X86_VENDOR_INTEL &&
524                     boot_cpu_data.x86 == 6)
525                         pr_debug(PREFIX "does not run on family %d model %d\n",
526                                 boot_cpu_data.x86, boot_cpu_data.x86_model);
527                 return -ENODEV;
528         }
529
530         if (boot_cpu_data.cpuid_level < CPUID_MWAIT_LEAF)
531                 return -ENODEV;
532
533         cpuid(CPUID_MWAIT_LEAF, &eax, &ebx, &ecx, &mwait_substates);
534
535         if (!(ecx & CPUID5_ECX_EXTENSIONS_SUPPORTED) ||
536             !(ecx & CPUID5_ECX_INTERRUPT_BREAK) ||
537             !mwait_substates)
538                         return -ENODEV;
539
540         pr_debug(PREFIX "MWAIT substates: 0x%x\n", mwait_substates);
541
542         icpu = (const struct idle_cpu *)id->driver_data;
543         cpuidle_state_table = icpu->state_table;
544
545         if (boot_cpu_has(X86_FEATURE_ARAT))     /* Always Reliable APIC Timer */
546                 lapic_timer_reliable_states = LAPIC_TIMER_ALWAYS_RELIABLE;
547         else
548                 on_each_cpu(__setup_broadcast_timer, (void *)true, 1);
549
550         pr_debug(PREFIX "v" INTEL_IDLE_VERSION
551                 " model 0x%X\n", boot_cpu_data.x86_model);
552
553         pr_debug(PREFIX "lapic_timer_reliable_states 0x%x\n",
554                 lapic_timer_reliable_states);
555         return 0;
556 }
557
558 /*
559  * intel_idle_cpuidle_devices_uninit()
560  * unregister, free cpuidle_devices
561  */
562 static void intel_idle_cpuidle_devices_uninit(void)
563 {
564         int i;
565         struct cpuidle_device *dev;
566
567         for_each_online_cpu(i) {
568                 dev = per_cpu_ptr(intel_idle_cpuidle_devices, i);
569                 cpuidle_unregister_device(dev);
570         }
571
572         free_percpu(intel_idle_cpuidle_devices);
573         return;
574 }
575 /*
576  * intel_idle_cpuidle_driver_init()
577  * allocate, initialize cpuidle_states
578  */
579 static int __init intel_idle_cpuidle_driver_init(void)
580 {
581         int cstate;
582         struct cpuidle_driver *drv = &intel_idle_driver;
583
584         drv->state_count = 1;
585
586         for (cstate = 0; cstate < CPUIDLE_STATE_MAX; ++cstate) {
587                 int num_substates, mwait_hint, mwait_cstate, mwait_substate;
588
589                 if (cpuidle_state_table[cstate].enter == NULL)
590                         break;
591
592                 if (cstate + 1 > max_cstate) {
593                         printk(PREFIX "max_cstate %d reached\n",
594                                 max_cstate);
595                         break;
596                 }
597
598                 mwait_hint = flg2MWAIT(cpuidle_state_table[cstate].flags);
599                 mwait_cstate = MWAIT_HINT2CSTATE(mwait_hint);
600                 mwait_substate = MWAIT_HINT2SUBSTATE(mwait_hint);
601
602                 /* does the state exist in CPUID.MWAIT? */
603                 num_substates = (mwait_substates >> ((mwait_cstate + 1) * 4))
604                                         & MWAIT_SUBSTATE_MASK;
605
606                 /* if sub-state in table is not enumerated by CPUID */
607                 if ((mwait_substate + 1) > num_substates)
608                         continue;
609
610                 if (((mwait_cstate + 1) > 2) &&
611                         !boot_cpu_has(X86_FEATURE_NONSTOP_TSC))
612                         mark_tsc_unstable("TSC halts in idle"
613                                         " states deeper than C2");
614
615                 drv->states[drv->state_count] = /* structure copy */
616                         cpuidle_state_table[cstate];
617
618                 drv->state_count += 1;
619         }
620
621         if (icpu->auto_demotion_disable_flags)
622                 on_each_cpu(auto_demotion_disable, NULL, 1);
623
624         if (icpu->disable_promotion_to_c1e)     /* each-cpu is redundant */
625                 on_each_cpu(c1e_promotion_disable, NULL, 1);
626
627         return 0;
628 }
629
630
631 /*
632  * intel_idle_cpu_init()
633  * allocate, initialize, register cpuidle_devices
634  * @cpu: cpu/core to initialize
635  */
636 static int intel_idle_cpu_init(int cpu)
637 {
638         struct cpuidle_device *dev;
639
640         dev = per_cpu_ptr(intel_idle_cpuidle_devices, cpu);
641
642         dev->cpu = cpu;
643
644         if (cpuidle_register_device(dev)) {
645                 pr_debug(PREFIX "cpuidle_register_device %d failed!\n", cpu);
646                 intel_idle_cpuidle_devices_uninit();
647                 return -EIO;
648         }
649
650         if (icpu->auto_demotion_disable_flags)
651                 smp_call_function_single(cpu, auto_demotion_disable, NULL, 1);
652
653         if (icpu->disable_promotion_to_c1e)
654                 smp_call_function_single(cpu, c1e_promotion_disable, NULL, 1);
655
656         return 0;
657 }
658
659 static int __init intel_idle_init(void)
660 {
661         int retval, i;
662
663         /* Do not load intel_idle at all for now if idle= is passed */
664         if (boot_option_idle_override != IDLE_NO_OVERRIDE)
665                 return -ENODEV;
666
667         retval = intel_idle_probe();
668         if (retval)
669                 return retval;
670
671         intel_idle_cpuidle_driver_init();
672         retval = cpuidle_register_driver(&intel_idle_driver);
673         if (retval) {
674                 struct cpuidle_driver *drv = cpuidle_get_driver();
675                 printk(KERN_DEBUG PREFIX "intel_idle yielding to %s",
676                         drv ? drv->name : "none");
677                 return retval;
678         }
679
680         intel_idle_cpuidle_devices = alloc_percpu(struct cpuidle_device);
681         if (intel_idle_cpuidle_devices == NULL)
682                 return -ENOMEM;
683
684         cpu_notifier_register_begin();
685
686         for_each_online_cpu(i) {
687                 retval = intel_idle_cpu_init(i);
688                 if (retval) {
689                         cpu_notifier_register_done();
690                         cpuidle_unregister_driver(&intel_idle_driver);
691                         return retval;
692                 }
693         }
694         __register_cpu_notifier(&cpu_hotplug_notifier);
695
696         cpu_notifier_register_done();
697
698         return 0;
699 }
700
701 static void __exit intel_idle_exit(void)
702 {
703         intel_idle_cpuidle_devices_uninit();
704         cpuidle_unregister_driver(&intel_idle_driver);
705
706         cpu_notifier_register_begin();
707
708         if (lapic_timer_reliable_states != LAPIC_TIMER_ALWAYS_RELIABLE)
709                 on_each_cpu(__setup_broadcast_timer, (void *)false, 1);
710         __unregister_cpu_notifier(&cpu_hotplug_notifier);
711
712         cpu_notifier_register_done();
713
714         return;
715 }
716
717 module_init(intel_idle_init);
718 module_exit(intel_idle_exit);
719
720 module_param(max_cstate, int, 0444);
721
722 MODULE_AUTHOR("Len Brown <len.brown@intel.com>");
723 MODULE_DESCRIPTION("Cpuidle driver for Intel Hardware v" INTEL_IDLE_VERSION);
724 MODULE_LICENSE("GPL");