arch/x86/power/cpu.c

   1 /*
   2  * Suspend support specific for i386/x86-64.
   3  *
   4  * Distribute under GPLv2
   5  *
   6  * Copyright (c) 2007 Rafael J. Wysocki <rjw@sisk.pl>
   7  * Copyright (c) 2002 Pavel Machek <pavel@ucw.cz>
   8  * Copyright (c) 2001 Patrick Mochel <mochel@osdl.org>
   9  */
  10
  11 #include <linux/suspend.h>
  12 #include <linux/export.h>
  13 #include <linux/smp.h>
  14
  15 #include <asm/pgtable.h>
  16 #include <asm/proto.h>
  17 #include <asm/mtrr.h>
  18 #include <asm/page.h>
  19 #include <asm/mce.h>
  20 #include <asm/xcr.h>
  21 #include <asm/suspend.h>
  22 #include <asm/debugreg.h>
  23 #include <asm/fpu-internal.h> /* pcntxt_mask */
  24 #include <asm/cpu.h>
  25
  26 #ifdef CONFIG_X86_32
  27 static struct saved_context saved_context;
  28
  29 unsigned long saved_context_ebx;
  30 unsigned long saved_context_esp, saved_context_ebp;
  31 unsigned long saved_context_esi, saved_context_edi;
  32 unsigned long saved_context_eflags;
  33 #else
  34 /* CONFIG_X86_64 */
  35 struct saved_context saved_context;
  36 #endif
  37
  38 /**
  39  *      __save_processor_state - save CPU registers before creating a
  40  *              hibernation image and before restoring the memory state from it
  41  *      @ctxt - structure to store the registers contents in
  42  *
  43  *      NOTE: If there is a CPU register the modification of which by the
  44  *      boot kernel (ie. the kernel used for loading the hibernation image)
  45  *      might affect the operations of the restored target kernel (ie. the one
  46  *      saved in the hibernation image), then its contents must be saved by this
  47  *      function.  In other words, if kernel A is hibernated and different
  48  *      kernel B is used for loading the hibernation image into memory, the
  49  *      kernel A's __save_processor_state() function must save all registers
  50  *      needed by kernel A, so that it can operate correctly after the resume
  51  *      regardless of what kernel B does in the meantime.
  52  */
  53 static void __save_processor_state(struct saved_context *ctxt)
  54 {
  55 #ifdef CONFIG_X86_32
  56         mtrr_save_fixed_ranges(NULL);
  57 #endif
  58         kernel_fpu_begin();
  59
  60         /*
  61          * descriptor tables
  62          */
  63 #ifdef CONFIG_X86_32
  64         store_gdt(&ctxt->gdt);
  65         store_idt(&ctxt->idt);
  66 #else
  67 /* CONFIG_X86_64 */
  68         store_idt((struct desc_ptr *)&ctxt->idt_limit);
  69 #endif
  70         store_tr(ctxt->tr);
  71
  72         /* XMM0..XMM15 should be handled by kernel_fpu_begin(). */
  73         /*
  74          * segment registers
  75          */
  76 #ifdef CONFIG_X86_32
  77         savesegment(es, ctxt->es);
  78         savesegment(fs, ctxt->fs);
  79         savesegment(gs, ctxt->gs);
  80         savesegment(ss, ctxt->ss);
  81 #else
  82 /* CONFIG_X86_64 */
  83         asm volatile ("movw %%ds, %0" : "=m" (ctxt->ds));
  84         asm volatile ("movw %%es, %0" : "=m" (ctxt->es));
  85         asm volatile ("movw %%fs, %0" : "=m" (ctxt->fs));
  86         asm volatile ("movw %%gs, %0" : "=m" (ctxt->gs));
  87         asm volatile ("movw %%ss, %0" : "=m" (ctxt->ss));
  88
  89         rdmsrl(MSR_FS_BASE, ctxt->fs_base);
  90         rdmsrl(MSR_GS_BASE, ctxt->gs_base);
  91         rdmsrl(MSR_KERNEL_GS_BASE, ctxt->gs_kernel_base);
  92         mtrr_save_fixed_ranges(NULL);
  93
  94         rdmsrl(MSR_EFER, ctxt->efer);
  95 #endif
  96
  97         /*
  98          * control registers
  99          */
 100         ctxt->cr0 = read_cr0();
 101         ctxt->cr2 = read_cr2();
 102         ctxt->cr3 = read_cr3();
 103 #ifdef CONFIG_X86_32
 104         ctxt->cr4 = read_cr4_safe();
 105 #else
 106 /* CONFIG_X86_64 */
 107         ctxt->cr4 = read_cr4();
 108         ctxt->cr8 = read_cr8();
 109 #endif
 110         ctxt->misc_enable_saved = !rdmsrl_safe(MSR_IA32_MISC_ENABLE,
 111                                                &ctxt->misc_enable);
 112 }
 113
 114 /* Needed by apm.c */
 115 void save_processor_state(void)
 116 {
 117         __save_processor_state(&saved_context);
 118         x86_platform.save_sched_clock_state();
 119 }
 120 #ifdef CONFIG_X86_32
 121 EXPORT_SYMBOL(save_processor_state);
 122 #endif
 123
 124 static void do_fpu_end(void)
 125 {
 126         /*
 127          * Restore FPU regs if necessary.
 128          */
 129         kernel_fpu_end();
 130 }
 131
 132 static void fix_processor_context(void)
 133 {
 134         int cpu = smp_processor_id();
 135         struct tss_struct *t = &per_cpu(init_tss, cpu);
 136
 137         set_tss_desc(cpu, t);   /*
 138                                  * This just modifies memory; should not be
 139                                  * necessary. But... This is necessary, because
 140                                  * 386 hardware has concept of busy TSS or some
 141                                  * similar stupidity.
 142                                  */
 143
 144 #ifdef CONFIG_X86_64
 145         get_cpu_gdt_table(cpu)[GDT_ENTRY_TSS].type = 9;
 146
 147         syscall_init();                         /* This sets MSR_*STAR and related */
 148 #endif
 149         load_TR_desc();                         /* This does ltr */
 150         load_LDT(&current->active_mm->context); /* This does lldt */
 151 }
 152
 153 /**
 154  *      __restore_processor_state - restore the contents of CPU registers saved
 155  *              by __save_processor_state()
 156  *      @ctxt - structure to load the registers contents from
 157  */
 158 static void __restore_processor_state(struct saved_context *ctxt)
 159 {
 160         if (ctxt->misc_enable_saved)
 161                 wrmsrl(MSR_IA32_MISC_ENABLE, ctxt->misc_enable);
 162         /*
 163          * control registers
 164          */
 165         /* cr4 was introduced in the Pentium CPU */
 166 #ifdef CONFIG_X86_32
 167         if (ctxt->cr4)
 168                 write_cr4(ctxt->cr4);
 169 #else
 170 /* CONFIG X86_64 */
 171         wrmsrl(MSR_EFER, ctxt->efer);
 172         write_cr8(ctxt->cr8);
 173         write_cr4(ctxt->cr4);
 174 #endif
 175         write_cr3(ctxt->cr3);
 176         write_cr2(ctxt->cr2);
 177         write_cr0(ctxt->cr0);
 178
 179         /*
 180          * now restore the descriptor tables to their proper values
 181          * ltr is done i fix_processor_context().
 182          */
 183 #ifdef CONFIG_X86_32
 184         load_gdt(&ctxt->gdt);
 185         load_idt(&ctxt->idt);
 186 #else
 187 /* CONFIG_X86_64 */
 188         load_idt((const struct desc_ptr *)&ctxt->idt_limit);
 189 #endif
 190
 191         /*
 192          * segment registers
 193          */
 194 #ifdef CONFIG_X86_32
 195         loadsegment(es, ctxt->es);
 196         loadsegment(fs, ctxt->fs);
 197         loadsegment(gs, ctxt->gs);
 198         loadsegment(ss, ctxt->ss);
 199
 200         /*
 201          * sysenter MSRs
 202          */
 203         if (boot_cpu_has(X86_FEATURE_SEP))
 204                 enable_sep_cpu();
 205 #else
 206 /* CONFIG_X86_64 */
 207         asm volatile ("movw %0, %%ds" :: "r" (ctxt->ds));
 208         asm volatile ("movw %0, %%es" :: "r" (ctxt->es));
 209         asm volatile ("movw %0, %%fs" :: "r" (ctxt->fs));
 210         load_gs_index(ctxt->gs);
 211         asm volatile ("movw %0, %%ss" :: "r" (ctxt->ss));
 212
 213         wrmsrl(MSR_FS_BASE, ctxt->fs_base);
 214         wrmsrl(MSR_GS_BASE, ctxt->gs_base);
 215         wrmsrl(MSR_KERNEL_GS_BASE, ctxt->gs_kernel_base);
 216 #endif
 217
 218         /*
 219          * restore XCR0 for xsave capable cpu's.
 220          */
 221         if (cpu_has_xsave)
 222                 xsetbv(XCR_XFEATURE_ENABLED_MASK, pcntxt_mask);
 223
 224         fix_processor_context();
 225
 226         do_fpu_end();
 227         x86_platform.restore_sched_clock_state();
 228         mtrr_bp_restore();
 229 }
 230
 231 /* Needed by apm.c */
 232 void restore_processor_state(void)
 233 {
 234         __restore_processor_state(&saved_context);
 235 }
 236 #ifdef CONFIG_X86_32
 237 EXPORT_SYMBOL(restore_processor_state);
 238 #endif
 239
 240 /*
 241  * When bsp_check() is called in hibernate and suspend, cpu hotplug
 242  * is disabled already. So it's unnessary to handle race condition between
 243  * cpumask query and cpu hotplug.
 244  */
 245 static int bsp_check(void)
 246 {
 247         if (cpumask_first(cpu_online_mask) != 0) {
 248                 pr_warn("CPU0 is offline.\n");
 249                 return -ENODEV;
 250         }
 251
 252         return 0;
 253 }
 254
 255 static int bsp_pm_callback(struct notifier_block *nb, unsigned long action,
 256                            void *ptr)
 257 {
 258         int ret = 0;
 259
 260         switch (action) {
 261         case PM_SUSPEND_PREPARE:
 262         case PM_HIBERNATION_PREPARE:
 263                 ret = bsp_check();
 264                 break;
 265 #ifdef CONFIG_DEBUG_HOTPLUG_CPU0
 266         case PM_RESTORE_PREPARE:
 267                 /*
 268                  * When system resumes from hibernation, online CPU0 because
 269                  * 1. it's required for resume and
 270                  * 2. the CPU was online before hibernation
 271                  */
 272                 if (!cpu_online(0))
 273                         _debug_hotplug_cpu(0, 1);
 274                 break;
 275         case PM_POST_RESTORE:
 276                 /*
 277                  * When a resume really happens, this code won't be called.
 278                  *
 279                  * This code is called only when user space hibernation software
 280                  * prepares for snapshot device during boot time. So we just
 281                  * call _debug_hotplug_cpu() to restore to CPU0's state prior to
 282                  * preparing the snapshot device.
 283                  *
 284                  * This works for normal boot case in our CPU0 hotplug debug
 285                  * mode, i.e. CPU0 is offline and user mode hibernation
 286                  * software initializes during boot time.
 287                  *
 288                  * If CPU0 is online and user application accesses snapshot
 289                  * device after boot time, this will offline CPU0 and user may
 290                  * see different CPU0 state before and after accessing
 291                  * the snapshot device. But hopefully this is not a case when
 292                  * user debugging CPU0 hotplug. Even if users hit this case,
 293                  * they can easily online CPU0 back.
 294                  *
 295                  * To simplify this debug code, we only consider normal boot
 296                  * case. Otherwise we need to remember CPU0's state and restore
 297                  * to that state and resolve racy conditions etc.
 298                  */
 299                 _debug_hotplug_cpu(0, 0);
 300                 break;
 301 #endif
 302         default:
 303                 break;
 304         }
 305         return notifier_from_errno(ret);
 306 }
 307
 308 static int __init bsp_pm_check_init(void)
 309 {
 310         /*
 311          * Set this bsp_pm_callback as lower priority than
 312          * cpu_hotplug_pm_callback. So cpu_hotplug_pm_callback will be called
 313          * earlier to disable cpu hotplug before bsp online check.
 314          */
 315         pm_notifier(bsp_pm_callback, -INT_MAX);
 316         return 0;
 317 }
 318
 319 core_initcall(bsp_pm_check_init);