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 #include <linux/perf_event.h>
  15 #include <linux/tboot.h>
  16 #include <linux/dmi.h>
  17
  18 #include <asm/pgtable.h>
  19 #include <asm/proto.h>
  20 #include <asm/mtrr.h>
  21 #include <asm/page.h>
  22 #include <asm/mce.h>
  23 #include <asm/suspend.h>
  24 #include <asm/fpu/internal.h>
  25 #include <asm/debugreg.h>
  26 #include <asm/cpu.h>
  27 #include <asm/mmu_context.h>
  28 #include <asm/cpu_device_id.h>
  29
  30 #ifdef CONFIG_X86_32
  31 __visible unsigned long saved_context_ebx;
  32 __visible unsigned long saved_context_esp, saved_context_ebp;
  33 __visible unsigned long saved_context_esi, saved_context_edi;
  34 __visible unsigned long saved_context_eflags;
  35 #endif
  36 struct saved_context saved_context;
  37
  38 static void msr_save_context(struct saved_context *ctxt)
  39 {
  40         struct saved_msr *msr = ctxt->saved_msrs.array;
  41         struct saved_msr *end = msr + ctxt->saved_msrs.num;
  42
  43         while (msr < end) {
  44                 msr->valid = !rdmsrl_safe(msr->info.msr_no, &msr->info.reg.q);
  45                 msr++;
  46         }
  47 }
  48
  49 static void msr_restore_context(struct saved_context *ctxt)
  50 {
  51         struct saved_msr *msr = ctxt->saved_msrs.array;
  52         struct saved_msr *end = msr + ctxt->saved_msrs.num;
  53
  54         while (msr < end) {
  55                 if (msr->valid)
  56                         wrmsrl(msr->info.msr_no, msr->info.reg.q);
  57                 msr++;
  58         }
  59 }
  60
  61 /**
  62  *      __save_processor_state - save CPU registers before creating a
  63  *              hibernation image and before restoring the memory state from it
  64  *      @ctxt - structure to store the registers contents in
  65  *
  66  *      NOTE: If there is a CPU register the modification of which by the
  67  *      boot kernel (ie. the kernel used for loading the hibernation image)
  68  *      might affect the operations of the restored target kernel (ie. the one
  69  *      saved in the hibernation image), then its contents must be saved by this
  70  *      function.  In other words, if kernel A is hibernated and different
  71  *      kernel B is used for loading the hibernation image into memory, the
  72  *      kernel A's __save_processor_state() function must save all registers
  73  *      needed by kernel A, so that it can operate correctly after the resume
  74  *      regardless of what kernel B does in the meantime.
  75  */
  76 static void __save_processor_state(struct saved_context *ctxt)
  77 {
  78 #ifdef CONFIG_X86_32
  79         mtrr_save_fixed_ranges(NULL);
  80 #endif
  81         kernel_fpu_begin();
  82
  83         /*
  84          * descriptor tables
  85          */
  86         store_idt(&ctxt->idt);
  87
  88         /*
  89          * We save it here, but restore it only in the hibernate case.
  90          * For ACPI S3 resume, this is loaded via 'early_gdt_desc' in 64-bit
  91          * mode in "secondary_startup_64". In 32-bit mode it is done via
  92          * 'pmode_gdt' in wakeup_start.
  93          */
  94         ctxt->gdt_desc.size = GDT_SIZE - 1;
  95         ctxt->gdt_desc.address = (unsigned long)get_cpu_gdt_table(smp_processor_id());
  96
  97         store_tr(ctxt->tr);
  98
  99         /* XMM0..XMM15 should be handled by kernel_fpu_begin(). */
 100         /*
 101          * segment registers
 102          */
 103 #ifdef CONFIG_X86_32_LAZY_GS
 104         savesegment(gs, ctxt->gs);
 105 #endif
 106 #ifdef CONFIG_X86_64
 107         savesegment(gs, ctxt->gs);
 108         savesegment(fs, ctxt->fs);
 109         savesegment(ds, ctxt->ds);
 110         savesegment(es, ctxt->es);
 111
 112         rdmsrl(MSR_FS_BASE, ctxt->fs_base);
 113         rdmsrl(MSR_GS_BASE, ctxt->kernelmode_gs_base);
 114         rdmsrl(MSR_KERNEL_GS_BASE, ctxt->usermode_gs_base);
 115         mtrr_save_fixed_ranges(NULL);
 116
 117         rdmsrl(MSR_EFER, ctxt->efer);
 118 #endif
 119
 120         /*
 121          * control registers
 122          */
 123         ctxt->cr0 = read_cr0();
 124         ctxt->cr2 = read_cr2();
 125         ctxt->cr3 = read_cr3();
 126         ctxt->cr4 = __read_cr4();
 127 #ifdef CONFIG_X86_64
 128         ctxt->cr8 = read_cr8();
 129 #endif
 130         ctxt->misc_enable_saved = !rdmsrl_safe(MSR_IA32_MISC_ENABLE,
 131                                                &ctxt->misc_enable);
 132         msr_save_context(ctxt);
 133 }
 134
 135 /* Needed by apm.c */
 136 void save_processor_state(void)
 137 {
 138         __save_processor_state(&saved_context);
 139         x86_platform.save_sched_clock_state();
 140 }
 141 #ifdef CONFIG_X86_32
 142 EXPORT_SYMBOL(save_processor_state);
 143 #endif
 144
 145 static void do_fpu_end(void)
 146 {
 147         /*
 148          * Restore FPU regs if necessary.
 149          */
 150         kernel_fpu_end();
 151 }
 152
 153 static void fix_processor_context(void)
 154 {
 155         int cpu = smp_processor_id();
 156         struct tss_struct *t = &per_cpu(cpu_tss, cpu);
 157 #ifdef CONFIG_X86_64
 158         struct desc_struct *desc = get_cpu_gdt_table(cpu);
 159         tss_desc tss;
 160 #endif
 161         set_tss_desc(cpu, t);   /*
 162                                  * This just modifies memory; should not be
 163                                  * necessary. But... This is necessary, because
 164                                  * 386 hardware has concept of busy TSS or some
 165                                  * similar stupidity.
 166                                  */
 167
 168 #ifdef CONFIG_X86_64
 169         memcpy(&tss, &desc[GDT_ENTRY_TSS], sizeof(tss_desc));
 170         tss.type = 0x9; /* The available 64-bit TSS (see AMD vol 2, pg 91 */
 171         write_gdt_entry(desc, GDT_ENTRY_TSS, &tss, DESC_TSS);
 172
 173         syscall_init();                         /* This sets MSR_*STAR and related */
 174 #else
 175         if (boot_cpu_has(X86_FEATURE_SEP))
 176                 enable_sep_cpu();
 177 #endif
 178         load_TR_desc();                         /* This does ltr */
 179         load_mm_ldt(current->active_mm);        /* This does lldt */
 180
 181         fpu__resume_cpu();
 182 }
 183
 184 /**
 185  * __restore_processor_state - restore the contents of CPU registers saved
 186  *                             by __save_processor_state()
 187  * @ctxt - structure to load the registers contents from
 188  *
 189  * The asm code that gets us here will have restored a usable GDT, although
 190  * it will be pointing to the wrong alias.
 191  */
 192 static void notrace __restore_processor_state(struct saved_context *ctxt)
 193 {
 194         if (ctxt->misc_enable_saved)
 195                 wrmsrl(MSR_IA32_MISC_ENABLE, ctxt->misc_enable);
 196         /*
 197          * control registers
 198          */
 199         /* cr4 was introduced in the Pentium CPU */
 200 #ifdef CONFIG_X86_32
 201         if (ctxt->cr4)
 202                 __write_cr4(ctxt->cr4);
 203 #else
 204 /* CONFIG X86_64 */
 205         wrmsrl(MSR_EFER, ctxt->efer);
 206         write_cr8(ctxt->cr8);
 207         __write_cr4(ctxt->cr4);
 208 #endif
 209         write_cr3(ctxt->cr3);
 210         write_cr2(ctxt->cr2);
 211         write_cr0(ctxt->cr0);
 212
 213         /* Restore the IDT. */
 214         load_idt(&ctxt->idt);
 215
 216         /*
 217          * Just in case the asm code got us here with the SS, DS, or ES
 218          * out of sync with the GDT, update them.
 219          */
 220         loadsegment(ss, __KERNEL_DS);
 221         loadsegment(ds, __USER_DS);
 222         loadsegment(es, __USER_DS);
 223
 224         /*
 225          * Restore percpu access.  Percpu access can happen in exception
 226          * handlers or in complicated helpers like load_gs_index().
 227          */
 228 #ifdef CONFIG_X86_64
 229         wrmsrl(MSR_GS_BASE, ctxt->kernelmode_gs_base);
 230 #else
 231         loadsegment(fs, __KERNEL_PERCPU);
 232         loadsegment(gs, __KERNEL_STACK_CANARY);
 233 #endif
 234
 235         /* Restore the TSS, RO GDT, LDT, and usermode-relevant MSRs. */
 236         fix_processor_context();
 237
 238         /*
 239          * Now that we have descriptor tables fully restored and working
 240          * exception handling, restore the usermode segments.
 241          */
 242 #ifdef CONFIG_X86_64
 243         loadsegment(ds, ctxt->es);
 244         loadsegment(es, ctxt->es);
 245         loadsegment(fs, ctxt->fs);
 246         load_gs_index(ctxt->gs);
 247
 248         /*
 249          * Restore FSBASE and GSBASE after restoring the selectors, since
 250          * restoring the selectors clobbers the bases.  Keep in mind
 251          * that MSR_KERNEL_GS_BASE is horribly misnamed.
 252          */
 253         wrmsrl(MSR_FS_BASE, ctxt->fs_base);
 254         wrmsrl(MSR_KERNEL_GS_BASE, ctxt->usermode_gs_base);
 255 #elif defined(CONFIG_X86_32_LAZY_GS)
 256         loadsegment(gs, ctxt->gs);
 257 #endif
 258
 259         do_fpu_end();
 260         x86_platform.restore_sched_clock_state();
 261         mtrr_bp_restore();
 262         perf_restore_debug_store();
 263         msr_restore_context(ctxt);
 264 }
 265
 266 /* Needed by apm.c */
 267 void notrace restore_processor_state(void)
 268 {
 269         __restore_processor_state(&saved_context);
 270 }
 271 #ifdef CONFIG_X86_32
 272 EXPORT_SYMBOL(restore_processor_state);
 273 #endif
 274
 275 #if defined(CONFIG_HIBERNATION) && defined(CONFIG_HOTPLUG_CPU)
 276 static void resume_play_dead(void)
 277 {
 278         play_dead_common();
 279         tboot_shutdown(TB_SHUTDOWN_WFS);
 280         hlt_play_dead();
 281 }
 282
 283 int hibernate_resume_nonboot_cpu_disable(void)
 284 {
 285         void (*play_dead)(void) = smp_ops.play_dead;
 286         int ret;
 287
 288         /*
 289          * Ensure that MONITOR/MWAIT will not be used in the "play dead" loop
 290          * during hibernate image restoration, because it is likely that the
 291          * monitored address will be actually written to at that time and then
 292          * the "dead" CPU will attempt to execute instructions again, but the
 293          * address in its instruction pointer may not be possible to resolve
 294          * any more at that point (the page tables used by it previously may
 295          * have been overwritten by hibernate image data).
 296          *
 297          * First, make sure that we wake up all the potentially disabled SMT
 298          * threads which have been initially brought up and then put into
 299          * mwait/cpuidle sleep.
 300          * Those will be put to proper (not interfering with hibernation
 301          * resume) sleep afterwards, and the resumed kernel will decide itself
 302          * what to do with them.
 303          */
 304         ret = cpuhp_smt_enable();
 305         if (ret)
 306                 return ret;
 307         smp_ops.play_dead = resume_play_dead;
 308         ret = disable_nonboot_cpus();
 309         smp_ops.play_dead = play_dead;
 310         return ret;
 311 }
 312 #endif
 313
 314 /*
 315  * When bsp_check() is called in hibernate and suspend, cpu hotplug
 316  * is disabled already. So it's unnessary to handle race condition between
 317  * cpumask query and cpu hotplug.
 318  */
 319 static int bsp_check(void)
 320 {
 321         if (cpumask_first(cpu_online_mask) != 0) {
 322                 pr_warn("CPU0 is offline.\n");
 323                 return -ENODEV;
 324         }
 325
 326         return 0;
 327 }
 328
 329 static int bsp_pm_callback(struct notifier_block *nb, unsigned long action,
 330                            void *ptr)
 331 {
 332         int ret = 0;
 333
 334         switch (action) {
 335         case PM_SUSPEND_PREPARE:
 336         case PM_HIBERNATION_PREPARE:
 337                 ret = bsp_check();
 338                 break;
 339 #ifdef CONFIG_DEBUG_HOTPLUG_CPU0
 340         case PM_RESTORE_PREPARE:
 341                 /*
 342                  * When system resumes from hibernation, online CPU0 because
 343                  * 1. it's required for resume and
 344                  * 2. the CPU was online before hibernation
 345                  */
 346                 if (!cpu_online(0))
 347                         _debug_hotplug_cpu(0, 1);
 348                 break;
 349         case PM_POST_RESTORE:
 350                 /*
 351                  * When a resume really happens, this code won't be called.
 352                  *
 353                  * This code is called only when user space hibernation software
 354                  * prepares for snapshot device during boot time. So we just
 355                  * call _debug_hotplug_cpu() to restore to CPU0's state prior to
 356                  * preparing the snapshot device.
 357                  *
 358                  * This works for normal boot case in our CPU0 hotplug debug
 359                  * mode, i.e. CPU0 is offline and user mode hibernation
 360                  * software initializes during boot time.
 361                  *
 362                  * If CPU0 is online and user application accesses snapshot
 363                  * device after boot time, this will offline CPU0 and user may
 364                  * see different CPU0 state before and after accessing
 365                  * the snapshot device. But hopefully this is not a case when
 366                  * user debugging CPU0 hotplug. Even if users hit this case,
 367                  * they can easily online CPU0 back.
 368                  *
 369                  * To simplify this debug code, we only consider normal boot
 370                  * case. Otherwise we need to remember CPU0's state and restore
 371                  * to that state and resolve racy conditions etc.
 372                  */
 373                 _debug_hotplug_cpu(0, 0);
 374                 break;
 375 #endif
 376         default:
 377                 break;
 378         }
 379         return notifier_from_errno(ret);
 380 }
 381
 382 static int __init bsp_pm_check_init(void)
 383 {
 384         /*
 385          * Set this bsp_pm_callback as lower priority than
 386          * cpu_hotplug_pm_callback. So cpu_hotplug_pm_callback will be called
 387          * earlier to disable cpu hotplug before bsp online check.
 388          */
 389         pm_notifier(bsp_pm_callback, -INT_MAX);
 390         return 0;
 391 }
 392
 393 core_initcall(bsp_pm_check_init);
 394
 395 static int msr_build_context(const u32 *msr_id, const int num)
 396 {
 397         struct saved_msrs *saved_msrs = &saved_context.saved_msrs;
 398         struct saved_msr *msr_array;
 399         int total_num;
 400         int i, j;
 401
 402         total_num = saved_msrs->num + num;
 403
 404         msr_array = kmalloc_array(total_num, sizeof(struct saved_msr), GFP_KERNEL);
 405         if (!msr_array) {
 406                 pr_err("x86/pm: Can not allocate memory to save/restore MSRs during suspend.\n");
 407                 return -ENOMEM;
 408         }
 409
 410         if (saved_msrs->array) {
 411                 /*
 412                  * Multiple callbacks can invoke this function, so copy any
 413                  * MSR save requests from previous invocations.
 414                  */
 415                 memcpy(msr_array, saved_msrs->array,
 416                        sizeof(struct saved_msr) * saved_msrs->num);
 417
 418                 kfree(saved_msrs->array);
 419         }
 420
 421         for (i = saved_msrs->num, j = 0; i < total_num; i++, j++) {
 422                 msr_array[i].info.msr_no        = msr_id[j];
 423                 msr_array[i].valid              = false;
 424                 msr_array[i].info.reg.q         = 0;
 425         }
 426         saved_msrs->num   = total_num;
 427         saved_msrs->array = msr_array;
 428
 429         return 0;
 430 }
 431
 432 /*
 433  * The following sections are a quirk framework for problematic BIOSen:
 434  * Sometimes MSRs are modified by the BIOSen after suspended to
 435  * RAM, this might cause unexpected behavior after wakeup.
 436  * Thus we save/restore these specified MSRs across suspend/resume
 437  * in order to work around it.
 438  *
 439  * For any further problematic BIOSen/platforms,
 440  * please add your own function similar to msr_initialize_bdw.
 441  */
 442 static int msr_initialize_bdw(const struct dmi_system_id *d)
 443 {
 444         /* Add any extra MSR ids into this array. */
 445         u32 bdw_msr_id[] = { MSR_IA32_THERM_CONTROL };
 446
 447         pr_info("x86/pm: %s detected, MSR saving is needed during suspending.\n", d->ident);
 448         return msr_build_context(bdw_msr_id, ARRAY_SIZE(bdw_msr_id));
 449 }
 450
 451 static struct dmi_system_id msr_save_dmi_table[] = {
 452         {
 453          .callback = msr_initialize_bdw,
 454          .ident = "BROADWELL BDX_EP",
 455          .matches = {
 456                 DMI_MATCH(DMI_PRODUCT_NAME, "GRANTLEY"),
 457                 DMI_MATCH(DMI_PRODUCT_VERSION, "E63448-400"),
 458                 },
 459         },
 460         {}
 461 };
 462
 463 static int msr_save_cpuid_features(const struct x86_cpu_id *c)
 464 {
 465         u32 cpuid_msr_id[] = {
 466                 MSR_AMD64_CPUID_FN_1,
 467         };
 468
 469         pr_info("x86/pm: family %#hx cpu detected, MSR saving is needed during suspending.\n",
 470                 c->family);
 471
 472         return msr_build_context(cpuid_msr_id, ARRAY_SIZE(cpuid_msr_id));
 473 }
 474
 475 static const struct x86_cpu_id msr_save_cpu_table[] = {
 476         {
 477                 .vendor = X86_VENDOR_AMD,
 478                 .family = 0x15,
 479                 .model = X86_MODEL_ANY,
 480                 .feature = X86_FEATURE_ANY,
 481                 .driver_data = (kernel_ulong_t)msr_save_cpuid_features,
 482         },
 483         {
 484                 .vendor = X86_VENDOR_AMD,
 485                 .family = 0x16,
 486                 .model = X86_MODEL_ANY,
 487                 .feature = X86_FEATURE_ANY,
 488                 .driver_data = (kernel_ulong_t)msr_save_cpuid_features,
 489         },
 490         {}
 491 };
 492
 493 typedef int (*pm_cpu_match_t)(const struct x86_cpu_id *);
 494 static int pm_cpu_check(const struct x86_cpu_id *c)
 495 {
 496         const struct x86_cpu_id *m;
 497         int ret = 0;
 498
 499         m = x86_match_cpu(msr_save_cpu_table);
 500         if (m) {
 501                 pm_cpu_match_t fn;
 502
 503                 fn = (pm_cpu_match_t)m->driver_data;
 504                 ret = fn(m);
 505         }
 506
 507         return ret;
 508 }
 509
 510 static int pm_check_save_msr(void)
 511 {
 512         dmi_check_system(msr_save_dmi_table);
 513         pm_cpu_check(msr_save_cpu_table);
 514
 515         return 0;
 516 }
 517
 518 device_initcall(pm_check_save_msr);