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_table(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         struct tss_struct *t = &per_cpu(cpu_tss, cpu);
 159 #ifdef CONFIG_X86_64
 160         struct desc_struct *desc = get_cpu_gdt_table(cpu);
 161         tss_desc tss;
 162 #endif
 163         set_tss_desc(cpu, t);   /*
 164                                  * This just modifies memory; should not be
 165                                  * necessary. But... This is necessary, because
 166                                  * 386 hardware has concept of busy TSS or some
 167                                  * similar stupidity.
 168                                  */
 169
 170 #ifdef CONFIG_X86_64
 171         memcpy(&tss, &desc[GDT_ENTRY_TSS], sizeof(tss_desc));
 172         tss.type = 0x9; /* The available 64-bit TSS (see AMD vol 2, pg 91 */
 173         write_gdt_entry(desc, GDT_ENTRY_TSS, &tss, DESC_TSS);
 174
 175         syscall_init();                         /* This sets MSR_*STAR and related */
 176 #else
 177         if (boot_cpu_has(X86_FEATURE_SEP))
 178                 enable_sep_cpu();
 179 #endif
 180         load_TR_desc();                         /* This does ltr */
 181         load_mm_ldt(current->active_mm);        /* This does lldt */
 182
 183         fpu__resume_cpu();
 184 }
 185
 186 /**
 187  * __restore_processor_state - restore the contents of CPU registers saved
 188  *                             by __save_processor_state()
 189  * @ctxt - structure to load the registers contents from
 190  *
 191  * The asm code that gets us here will have restored a usable GDT, although
 192  * it will be pointing to the wrong alias.
 193  */
 194 static void notrace __restore_processor_state(struct saved_context *ctxt)
 195 {
 196         if (ctxt->misc_enable_saved)
 197                 wrmsrl(MSR_IA32_MISC_ENABLE, ctxt->misc_enable);
 198         /*
 199          * control registers
 200          */
 201         /* cr4 was introduced in the Pentium CPU */
 202 #ifdef CONFIG_X86_32
 203         if (ctxt->cr4)
 204                 __write_cr4(ctxt->cr4);
 205 #else
 206 /* CONFIG X86_64 */
 207         wrmsrl(MSR_EFER, ctxt->efer);
 208         write_cr8(ctxt->cr8);
 209         __write_cr4(ctxt->cr4);
 210 #endif
 211         write_cr3(ctxt->cr3);
 212         write_cr2(ctxt->cr2);
 213         write_cr0(ctxt->cr0);
 214
 215         /* Restore the IDT. */
 216         load_idt(&ctxt->idt);
 217
 218         /*
 219          * Just in case the asm code got us here with the SS, DS, or ES
 220          * out of sync with the GDT, update them.
 221          */
 222         loadsegment(ss, __KERNEL_DS);
 223         loadsegment(ds, __USER_DS);
 224         loadsegment(es, __USER_DS);
 225
 226         /*
 227          * Restore percpu access.  Percpu access can happen in exception
 228          * handlers or in complicated helpers like load_gs_index().
 229          */
 230 #ifdef CONFIG_X86_64
 231         wrmsrl(MSR_GS_BASE, ctxt->kernelmode_gs_base);
 232 #else
 233         loadsegment(fs, __KERNEL_PERCPU);
 234         loadsegment(gs, __KERNEL_STACK_CANARY);
 235 #endif
 236
 237         /* Restore the TSS, RO GDT, LDT, and usermode-relevant MSRs. */
 238         fix_processor_context();
 239
 240         /*
 241          * Now that we have descriptor tables fully restored and working
 242          * exception handling, restore the usermode segments.
 243          */
 244 #ifdef CONFIG_X86_64
 245         loadsegment(ds, ctxt->es);
 246         loadsegment(es, ctxt->es);
 247         loadsegment(fs, ctxt->fs);
 248         load_gs_index(ctxt->gs);
 249
 250         /*
 251          * Restore FSBASE and GSBASE after restoring the selectors, since
 252          * restoring the selectors clobbers the bases.  Keep in mind
 253          * that MSR_KERNEL_GS_BASE is horribly misnamed.
 254          */
 255         wrmsrl(MSR_FS_BASE, ctxt->fs_base);
 256         wrmsrl(MSR_KERNEL_GS_BASE, ctxt->usermode_gs_base);
 257 #elif defined(CONFIG_X86_32_LAZY_GS)
 258         loadsegment(gs, ctxt->gs);
 259 #endif
 260
 261         do_fpu_end();
 262         x86_platform.restore_sched_clock_state();
 263         mtrr_bp_restore();
 264         perf_restore_debug_store();
 265
 266         microcode_bsp_resume();
 267
 268         /*
 269          * This needs to happen after the microcode has been updated upon resume
 270          * because some of the MSRs are "emulated" in microcode.
 271          */
 272         msr_restore_context(ctxt);
 273 }
 274
 275 /* Needed by apm.c */
 276 void notrace restore_processor_state(void)
 277 {
 278         __restore_processor_state(&saved_context);
 279 }
 280 #ifdef CONFIG_X86_32
 281 EXPORT_SYMBOL(restore_processor_state);
 282 #endif
 283
 284 #if defined(CONFIG_HIBERNATION) && defined(CONFIG_HOTPLUG_CPU)
 285 static void resume_play_dead(void)
 286 {
 287         play_dead_common();
 288         tboot_shutdown(TB_SHUTDOWN_WFS);
 289         hlt_play_dead();
 290 }
 291
 292 int hibernate_resume_nonboot_cpu_disable(void)
 293 {
 294         void (*play_dead)(void) = smp_ops.play_dead;
 295         int ret;
 296
 297         /*
 298          * Ensure that MONITOR/MWAIT will not be used in the "play dead" loop
 299          * during hibernate image restoration, because it is likely that the
 300          * monitored address will be actually written to at that time and then
 301          * the "dead" CPU will attempt to execute instructions again, but the
 302          * address in its instruction pointer may not be possible to resolve
 303          * any more at that point (the page tables used by it previously may
 304          * have been overwritten by hibernate image data).
 305          *
 306          * First, make sure that we wake up all the potentially disabled SMT
 307          * threads which have been initially brought up and then put into
 308          * mwait/cpuidle sleep.
 309          * Those will be put to proper (not interfering with hibernation
 310          * resume) sleep afterwards, and the resumed kernel will decide itself
 311          * what to do with them.
 312          */
 313         ret = cpuhp_smt_enable();
 314         if (ret)
 315                 return ret;
 316         smp_ops.play_dead = resume_play_dead;
 317         ret = disable_nonboot_cpus();
 318         smp_ops.play_dead = play_dead;
 319         return ret;
 320 }
 321 #endif
 322
 323 /*
 324  * When bsp_check() is called in hibernate and suspend, cpu hotplug
 325  * is disabled already. So it's unnessary to handle race condition between
 326  * cpumask query and cpu hotplug.
 327  */
 328 static int bsp_check(void)
 329 {
 330         if (cpumask_first(cpu_online_mask) != 0) {
 331                 pr_warn("CPU0 is offline.\n");
 332                 return -ENODEV;
 333         }
 334
 335         return 0;
 336 }
 337
 338 static int bsp_pm_callback(struct notifier_block *nb, unsigned long action,
 339                            void *ptr)
 340 {
 341         int ret = 0;
 342
 343         switch (action) {
 344         case PM_SUSPEND_PREPARE:
 345         case PM_HIBERNATION_PREPARE:
 346                 ret = bsp_check();
 347                 break;
 348 #ifdef CONFIG_DEBUG_HOTPLUG_CPU0
 349         case PM_RESTORE_PREPARE:
 350                 /*
 351                  * When system resumes from hibernation, online CPU0 because
 352                  * 1. it's required for resume and
 353                  * 2. the CPU was online before hibernation
 354                  */
 355                 if (!cpu_online(0))
 356                         _debug_hotplug_cpu(0, 1);
 357                 break;
 358         case PM_POST_RESTORE:
 359                 /*
 360                  * When a resume really happens, this code won't be called.
 361                  *
 362                  * This code is called only when user space hibernation software
 363                  * prepares for snapshot device during boot time. So we just
 364                  * call _debug_hotplug_cpu() to restore to CPU0's state prior to
 365                  * preparing the snapshot device.
 366                  *
 367                  * This works for normal boot case in our CPU0 hotplug debug
 368                  * mode, i.e. CPU0 is offline and user mode hibernation
 369                  * software initializes during boot time.
 370                  *
 371                  * If CPU0 is online and user application accesses snapshot
 372                  * device after boot time, this will offline CPU0 and user may
 373                  * see different CPU0 state before and after accessing
 374                  * the snapshot device. But hopefully this is not a case when
 375                  * user debugging CPU0 hotplug. Even if users hit this case,
 376                  * they can easily online CPU0 back.
 377                  *
 378                  * To simplify this debug code, we only consider normal boot
 379                  * case. Otherwise we need to remember CPU0's state and restore
 380                  * to that state and resolve racy conditions etc.
 381                  */
 382                 _debug_hotplug_cpu(0, 0);
 383                 break;
 384 #endif
 385         default:
 386                 break;
 387         }
 388         return notifier_from_errno(ret);
 389 }
 390
 391 static int __init bsp_pm_check_init(void)
 392 {
 393         /*
 394          * Set this bsp_pm_callback as lower priority than
 395          * cpu_hotplug_pm_callback. So cpu_hotplug_pm_callback will be called
 396          * earlier to disable cpu hotplug before bsp online check.
 397          */
 398         pm_notifier(bsp_pm_callback, -INT_MAX);
 399         return 0;
 400 }
 401
 402 core_initcall(bsp_pm_check_init);
 403
 404 static int msr_build_context(const u32 *msr_id, const int num)
 405 {
 406         struct saved_msrs *saved_msrs = &saved_context.saved_msrs;
 407         struct saved_msr *msr_array;
 408         int total_num;
 409         int i, j;
 410
 411         total_num = saved_msrs->num + num;
 412
 413         msr_array = kmalloc_array(total_num, sizeof(struct saved_msr), GFP_KERNEL);
 414         if (!msr_array) {
 415                 pr_err("x86/pm: Can not allocate memory to save/restore MSRs during suspend.\n");
 416                 return -ENOMEM;
 417         }
 418
 419         if (saved_msrs->array) {
 420                 /*
 421                  * Multiple callbacks can invoke this function, so copy any
 422                  * MSR save requests from previous invocations.
 423                  */
 424                 memcpy(msr_array, saved_msrs->array,
 425                        sizeof(struct saved_msr) * saved_msrs->num);
 426
 427                 kfree(saved_msrs->array);
 428         }
 429
 430         for (i = saved_msrs->num, j = 0; i < total_num; i++, j++) {
 431                 u64 dummy;
 432
 433                 msr_array[i].info.msr_no        = msr_id[j];
 434                 msr_array[i].valid              = !rdmsrl_safe(msr_id[j], &dummy);
 435                 msr_array[i].info.reg.q         = 0;
 436         }
 437         saved_msrs->num   = total_num;
 438         saved_msrs->array = msr_array;
 439
 440         return 0;
 441 }
 442
 443 /*
 444  * The following sections are a quirk framework for problematic BIOSen:
 445  * Sometimes MSRs are modified by the BIOSen after suspended to
 446  * RAM, this might cause unexpected behavior after wakeup.
 447  * Thus we save/restore these specified MSRs across suspend/resume
 448  * in order to work around it.
 449  *
 450  * For any further problematic BIOSen/platforms,
 451  * please add your own function similar to msr_initialize_bdw.
 452  */
 453 static int msr_initialize_bdw(const struct dmi_system_id *d)
 454 {
 455         /* Add any extra MSR ids into this array. */
 456         u32 bdw_msr_id[] = { MSR_IA32_THERM_CONTROL };
 457
 458         pr_info("x86/pm: %s detected, MSR saving is needed during suspending.\n", d->ident);
 459         return msr_build_context(bdw_msr_id, ARRAY_SIZE(bdw_msr_id));
 460 }
 461
 462 static struct dmi_system_id msr_save_dmi_table[] = {
 463         {
 464          .callback = msr_initialize_bdw,
 465          .ident = "BROADWELL BDX_EP",
 466          .matches = {
 467                 DMI_MATCH(DMI_PRODUCT_NAME, "GRANTLEY"),
 468                 DMI_MATCH(DMI_PRODUCT_VERSION, "E63448-400"),
 469                 },
 470         },
 471         {}
 472 };
 473
 474 static int msr_save_cpuid_features(const struct x86_cpu_id *c)
 475 {
 476         u32 cpuid_msr_id[] = {
 477                 MSR_AMD64_CPUID_FN_1,
 478         };
 479
 480         pr_info("x86/pm: family %#hx cpu detected, MSR saving is needed during suspending.\n",
 481                 c->family);
 482
 483         return msr_build_context(cpuid_msr_id, ARRAY_SIZE(cpuid_msr_id));
 484 }
 485
 486 static const struct x86_cpu_id msr_save_cpu_table[] = {
 487         {
 488                 .vendor = X86_VENDOR_AMD,
 489                 .family = 0x15,
 490                 .model = X86_MODEL_ANY,
 491                 .feature = X86_FEATURE_ANY,
 492                 .driver_data = (kernel_ulong_t)msr_save_cpuid_features,
 493         },
 494         {
 495                 .vendor = X86_VENDOR_AMD,
 496                 .family = 0x16,
 497                 .model = X86_MODEL_ANY,
 498                 .feature = X86_FEATURE_ANY,
 499                 .driver_data = (kernel_ulong_t)msr_save_cpuid_features,
 500         },
 501         {}
 502 };
 503
 504 typedef int (*pm_cpu_match_t)(const struct x86_cpu_id *);
 505 static int pm_cpu_check(const struct x86_cpu_id *c)
 506 {
 507         const struct x86_cpu_id *m;
 508         int ret = 0;
 509
 510         m = x86_match_cpu(msr_save_cpu_table);
 511         if (m) {
 512                 pm_cpu_match_t fn;
 513
 514                 fn = (pm_cpu_match_t)m->driver_data;
 515                 ret = fn(m);
 516         }
 517
 518         return ret;
 519 }
 520
 521 static void pm_save_spec_msr(void)
 522 {
 523         u32 spec_msr_id[] = {
 524                 MSR_IA32_SPEC_CTRL,
 525                 MSR_IA32_TSX_CTRL,
 526                 MSR_TSX_FORCE_ABORT,
 527                 MSR_IA32_MCU_OPT_CTRL,
 528                 MSR_AMD64_LS_CFG,
 529         };
 530
 531         msr_build_context(spec_msr_id, ARRAY_SIZE(spec_msr_id));
 532 }
 533
 534 static int pm_check_save_msr(void)
 535 {
 536         dmi_check_system(msr_save_dmi_table);
 537         pm_cpu_check(msr_save_cpu_table);
 538         pm_save_spec_msr();
 539
 540         return 0;
 541 }
 542
 543 device_initcall(pm_check_save_msr);