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