arch/x86/kernel/microcode_core.c

   1 /*
   2  *      Intel CPU Microcode Update Driver for Linux
   3  *
   4  *      Copyright (C) 2000-2006 Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
   5  *                    2006      Shaohua Li <shaohua.li@intel.com>
   6  *
   7  *      This driver allows to upgrade microcode on Intel processors
   8  *      belonging to IA-32 family - PentiumPro, Pentium II,
   9  *      Pentium III, Xeon, Pentium 4, etc.
  10  *
  11  *      Reference: Section 8.11 of Volume 3a, IA-32 Intel? Architecture
  12  *      Software Developer's Manual
  13  *      Order Number 253668 or free download from:
  14  *
  15  *      http://developer.intel.com/Assets/PDF/manual/253668.pdf
  16  *
  17  *      For more information, go to http://www.urbanmyth.org/microcode
  18  *
  19  *      This program is free software; you can redistribute it and/or
  20  *      modify it under the terms of the GNU General Public License
  21  *      as published by the Free Software Foundation; either version
  22  *      2 of the License, or (at your option) any later version.
  23  *
  24  *      1.0     16 Feb 2000, Tigran Aivazian <tigran@sco.com>
  25  *              Initial release.
  26  *      1.01    18 Feb 2000, Tigran Aivazian <tigran@sco.com>
  27  *              Added read() support + cleanups.
  28  *      1.02    21 Feb 2000, Tigran Aivazian <tigran@sco.com>
  29  *              Added 'device trimming' support. open(O_WRONLY) zeroes
  30  *              and frees the saved copy of applied microcode.
  31  *      1.03    29 Feb 2000, Tigran Aivazian <tigran@sco.com>
  32  *              Made to use devfs (/dev/cpu/microcode) + cleanups.
  33  *      1.04    06 Jun 2000, Simon Trimmer <simon@veritas.com>
  34  *              Added misc device support (now uses both devfs and misc).
  35  *              Added MICROCODE_IOCFREE ioctl to clear memory.
  36  *      1.05    09 Jun 2000, Simon Trimmer <simon@veritas.com>
  37  *              Messages for error cases (non Intel & no suitable microcode).
  38  *      1.06    03 Aug 2000, Tigran Aivazian <tigran@veritas.com>
  39  *              Removed ->release(). Removed exclusive open and status bitmap.
  40  *              Added microcode_rwsem to serialize read()/write()/ioctl().
  41  *              Removed global kernel lock usage.
  42  *      1.07    07 Sep 2000, Tigran Aivazian <tigran@veritas.com>
  43  *              Write 0 to 0x8B msr and then cpuid before reading revision,
  44  *              so that it works even if there were no update done by the
  45  *              BIOS. Otherwise, reading from 0x8B gives junk (which happened
  46  *              to be 0 on my machine which is why it worked even when I
  47  *              disabled update by the BIOS)
  48  *              Thanks to Eric W. Biederman <ebiederman@lnxi.com> for the fix.
  49  *      1.08    11 Dec 2000, Richard Schaal <richard.schaal@intel.com> and
  50  *                           Tigran Aivazian <tigran@veritas.com>
  51  *              Intel Pentium 4 processor support and bugfixes.
  52  *      1.09    30 Oct 2001, Tigran Aivazian <tigran@veritas.com>
  53  *              Bugfix for HT (Hyper-Threading) enabled processors
  54  *              whereby processor resources are shared by all logical processors
  55  *              in a single CPU package.
  56  *      1.10    28 Feb 2002 Asit K Mallick <asit.k.mallick@intel.com> and
  57  *              Tigran Aivazian <tigran@veritas.com>,
  58  *              Serialize updates as required on HT processors due to
  59  *              speculative nature of implementation.
  60  *      1.11    22 Mar 2002 Tigran Aivazian <tigran@veritas.com>
  61  *              Fix the panic when writing zero-length microcode chunk.
  62  *      1.12    29 Sep 2003 Nitin Kamble <nitin.a.kamble@intel.com>,
  63  *              Jun Nakajima <jun.nakajima@intel.com>
  64  *              Support for the microcode updates in the new format.
  65  *      1.13    10 Oct 2003 Tigran Aivazian <tigran@veritas.com>
  66  *              Removed ->read() method and obsoleted MICROCODE_IOCFREE ioctl
  67  *              because we no longer hold a copy of applied microcode
  68  *              in kernel memory.
  69  *      1.14    25 Jun 2004 Tigran Aivazian <tigran@veritas.com>
  70  *              Fix sigmatch() macro to handle old CPUs with pf == 0.
  71  *              Thanks to Stuart Swales for pointing out this bug.
  72  */
  73
  74 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  75
  76 #include <linux/platform_device.h>
  77 #include <linux/miscdevice.h>
  78 #include <linux/capability.h>
  79 #include <linux/kernel.h>
  80 #include <linux/module.h>
  81 #include <linux/mutex.h>
  82 #include <linux/cpu.h>
  83 #include <linux/fs.h>
  84 #include <linux/mm.h>
  85 #include <linux/syscore_ops.h>
  86
  87 #include <asm/microcode.h>
  88 #include <asm/processor.h>
  89
  90 MODULE_DESCRIPTION("Microcode Update Driver");
  91 MODULE_AUTHOR("Tigran Aivazian <tigran@aivazian.fsnet.co.uk>");
  92 MODULE_LICENSE("GPL");
  93
  94 #define MICROCODE_VERSION       "2.00"
  95
  96 static struct microcode_ops     *microcode_ops;
  97
  98 /*
  99  * Synchronization.
 100  *
 101  * All non cpu-hotplug-callback call sites use:
 102  *
 103  * - microcode_mutex to synchronize with each other;
 104  * - get/put_online_cpus() to synchronize with
 105  *   the cpu-hotplug-callback call sites.
 106  *
 107  * We guarantee that only a single cpu is being
 108  * updated at any particular moment of time.
 109  */
 110 static DEFINE_MUTEX(microcode_mutex);
 111
 112 struct ucode_cpu_info           ucode_cpu_info[NR_CPUS];
 113 EXPORT_SYMBOL_GPL(ucode_cpu_info);
 114
 115 /*
 116  * Operations that are run on a target cpu:
 117  */
 118
 119 struct cpu_info_ctx {
 120         struct cpu_signature    *cpu_sig;
 121         int                     err;
 122 };
 123
 124 static void collect_cpu_info_local(void *arg)
 125 {
 126         struct cpu_info_ctx *ctx = arg;
 127
 128         ctx->err = microcode_ops->collect_cpu_info(smp_processor_id(),
 129                                                    ctx->cpu_sig);
 130 }
 131
 132 static int collect_cpu_info_on_target(int cpu, struct cpu_signature *cpu_sig)
 133 {
 134         struct cpu_info_ctx ctx = { .cpu_sig = cpu_sig, .err = 0 };
 135         int ret;
 136
 137         ret = smp_call_function_single(cpu, collect_cpu_info_local, &ctx, 1);
 138         if (!ret)
 139                 ret = ctx.err;
 140
 141         return ret;
 142 }
 143
 144 static int collect_cpu_info(int cpu)
 145 {
 146         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 147         int ret;
 148
 149         memset(uci, 0, sizeof(*uci));
 150
 151         ret = collect_cpu_info_on_target(cpu, &uci->cpu_sig);
 152         if (!ret)
 153                 uci->valid = 1;
 154
 155         return ret;
 156 }
 157
 158 struct apply_microcode_ctx {
 159         int err;
 160 };
 161
 162 static void apply_microcode_local(void *arg)
 163 {
 164         struct apply_microcode_ctx *ctx = arg;
 165
 166         ctx->err = microcode_ops->apply_microcode(smp_processor_id());
 167 }
 168
 169 static int apply_microcode_on_target(int cpu)
 170 {
 171         struct apply_microcode_ctx ctx = { .err = 0 };
 172         int ret;
 173
 174         ret = smp_call_function_single(cpu, apply_microcode_local, &ctx, 1);
 175         if (!ret)
 176                 ret = ctx.err;
 177
 178         return ret;
 179 }
 180
 181 #ifdef CONFIG_MICROCODE_OLD_INTERFACE
 182 static int do_microcode_update(const void __user *buf, size_t size)
 183 {
 184         int error = 0;
 185         int cpu;
 186
 187         for_each_online_cpu(cpu) {
 188                 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 189                 enum ucode_state ustate;
 190
 191                 if (!uci->valid)
 192                         continue;
 193
 194                 ustate = microcode_ops->request_microcode_user(cpu, buf, size);
 195                 if (ustate == UCODE_ERROR) {
 196                         error = -1;
 197                         break;
 198                 } else if (ustate == UCODE_OK)
 199                         apply_microcode_on_target(cpu);
 200         }
 201
 202         return error;
 203 }
 204
 205 static int microcode_open(struct inode *inode, struct file *file)
 206 {
 207         return capable(CAP_SYS_RAWIO) ? nonseekable_open(inode, file) : -EPERM;
 208 }
 209
 210 static ssize_t microcode_write(struct file *file, const char __user *buf,
 211                                size_t len, loff_t *ppos)
 212 {
 213         ssize_t ret = -EINVAL;
 214
 215         if ((len >> PAGE_SHIFT) > totalram_pages) {
 216                 pr_err("too much data (max %ld pages)\n", totalram_pages);
 217                 return ret;
 218         }
 219
 220         get_online_cpus();
 221         mutex_lock(&microcode_mutex);
 222
 223         if (do_microcode_update(buf, len) == 0)
 224                 ret = (ssize_t)len;
 225
 226         mutex_unlock(&microcode_mutex);
 227         put_online_cpus();
 228
 229         return ret;
 230 }
 231
 232 static const struct file_operations microcode_fops = {
 233         .owner                  = THIS_MODULE,
 234         .write                  = microcode_write,
 235         .open                   = microcode_open,
 236         .llseek         = no_llseek,
 237 };
 238
 239 static struct miscdevice microcode_dev = {
 240         .minor                  = MICROCODE_MINOR,
 241         .name                   = "microcode",
 242         .nodename               = "cpu/microcode",
 243         .fops                   = &microcode_fops,
 244 };
 245
 246 static int __init microcode_dev_init(void)
 247 {
 248         int error;
 249
 250         error = misc_register(&microcode_dev);
 251         if (error) {
 252                 pr_err("can't misc_register on minor=%d\n", MICROCODE_MINOR);
 253                 return error;
 254         }
 255
 256         return 0;
 257 }
 258
 259 static void __exit microcode_dev_exit(void)
 260 {
 261         misc_deregister(&microcode_dev);
 262 }
 263
 264 MODULE_ALIAS_MISCDEV(MICROCODE_MINOR);
 265 MODULE_ALIAS("devname:cpu/microcode");
 266 #else
 267 #define microcode_dev_init()    0
 268 #define microcode_dev_exit()    do { } while (0)
 269 #endif
 270
 271 /* fake device for request_firmware */
 272 static struct platform_device   *microcode_pdev;
 273
 274 static int reload_for_cpu(int cpu)
 275 {
 276         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 277         int err = 0;
 278
 279         mutex_lock(&microcode_mutex);
 280         if (uci->valid) {
 281                 enum ucode_state ustate;
 282
 283                 ustate = microcode_ops->request_microcode_fw(cpu, &microcode_pdev->dev);
 284                 if (ustate == UCODE_OK)
 285                         apply_microcode_on_target(cpu);
 286                 else
 287                         if (ustate == UCODE_ERROR)
 288                                 err = -EINVAL;
 289         }
 290         mutex_unlock(&microcode_mutex);
 291
 292         return err;
 293 }
 294
 295 static ssize_t reload_store(struct sys_device *dev,
 296                             struct sysdev_attribute *attr,
 297                             const char *buf, size_t size)
 298 {
 299         unsigned long val;
 300         int cpu = dev->id;
 301         ssize_t ret = 0;
 302
 303         ret = kstrtoul(buf, 0, &val);
 304         if (ret)
 305                 return ret;
 306
 307         if (val == 1) {
 308                 get_online_cpus();
 309                 if (cpu_online(cpu))
 310                         ret = reload_for_cpu(cpu);
 311                 put_online_cpus();
 312         }
 313
 314         if (!ret)
 315                 ret = size;
 316
 317         return ret;
 318 }
 319
 320 static ssize_t version_show(struct sys_device *dev,
 321                         struct sysdev_attribute *attr, char *buf)
 322 {
 323         struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
 324
 325         return sprintf(buf, "0x%x\n", uci->cpu_sig.rev);
 326 }
 327
 328 static ssize_t pf_show(struct sys_device *dev,
 329                         struct sysdev_attribute *attr, char *buf)
 330 {
 331         struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
 332
 333         return sprintf(buf, "0x%x\n", uci->cpu_sig.pf);
 334 }
 335
 336 static SYSDEV_ATTR(reload, 0200, NULL, reload_store);
 337 static SYSDEV_ATTR(version, 0400, version_show, NULL);
 338 static SYSDEV_ATTR(processor_flags, 0400, pf_show, NULL);
 339
 340 static struct attribute *mc_default_attrs[] = {
 341         &attr_reload.attr,
 342         &attr_version.attr,
 343         &attr_processor_flags.attr,
 344         NULL
 345 };
 346
 347 static struct attribute_group mc_attr_group = {
 348         .attrs                  = mc_default_attrs,
 349         .name                   = "microcode",
 350 };
 351
 352 static void microcode_fini_cpu(int cpu)
 353 {
 354         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 355
 356         microcode_ops->microcode_fini_cpu(cpu);
 357         uci->valid = 0;
 358 }
 359
 360 static enum ucode_state microcode_resume_cpu(int cpu)
 361 {
 362         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 363
 364         if (!uci->mc)
 365                 return UCODE_NFOUND;
 366
 367         pr_debug("CPU%d updated upon resume\n", cpu);
 368         apply_microcode_on_target(cpu);
 369
 370         return UCODE_OK;
 371 }
 372
 373 static enum ucode_state microcode_init_cpu(int cpu)
 374 {
 375         enum ucode_state ustate;
 376
 377         if (collect_cpu_info(cpu))
 378                 return UCODE_ERROR;
 379
 380         /* --dimm. Trigger a delayed update? */
 381         if (system_state != SYSTEM_RUNNING)
 382                 return UCODE_NFOUND;
 383
 384         ustate = microcode_ops->request_microcode_fw(cpu, &microcode_pdev->dev);
 385
 386         if (ustate == UCODE_OK) {
 387                 pr_debug("CPU%d updated upon init\n", cpu);
 388                 apply_microcode_on_target(cpu);
 389         }
 390
 391         return ustate;
 392 }
 393
 394 static enum ucode_state microcode_update_cpu(int cpu)
 395 {
 396         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 397         enum ucode_state ustate;
 398
 399         if (uci->valid)
 400                 ustate = microcode_resume_cpu(cpu);
 401         else
 402                 ustate = microcode_init_cpu(cpu);
 403
 404         return ustate;
 405 }
 406
 407 static int mc_sysdev_add(struct sys_device *sys_dev)
 408 {
 409         int err, cpu = sys_dev->id;
 410
 411         if (!cpu_online(cpu))
 412                 return 0;
 413
 414         pr_debug("CPU%d added\n", cpu);
 415
 416         err = sysfs_create_group(&sys_dev->kobj, &mc_attr_group);
 417         if (err)
 418                 return err;
 419
 420         if (microcode_init_cpu(cpu) == UCODE_ERROR)
 421                 return -EINVAL;
 422
 423         return err;
 424 }
 425
 426 static int mc_sysdev_remove(struct sys_device *sys_dev)
 427 {
 428         int cpu = sys_dev->id;
 429
 430         if (!cpu_online(cpu))
 431                 return 0;
 432
 433         pr_debug("CPU%d removed\n", cpu);
 434         microcode_fini_cpu(cpu);
 435         sysfs_remove_group(&sys_dev->kobj, &mc_attr_group);
 436         return 0;
 437 }
 438
 439 static struct sysdev_driver mc_sysdev_driver = {
 440         .add                    = mc_sysdev_add,
 441         .remove                 = mc_sysdev_remove,
 442 };
 443
 444 /**
 445  * mc_bp_resume - Update boot CPU microcode during resume.
 446  */
 447 static void mc_bp_resume(void)
 448 {
 449         int cpu = smp_processor_id();
 450         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 451
 452         if (uci->valid && uci->mc)
 453                 microcode_ops->apply_microcode(cpu);
 454 }
 455
 456 static struct syscore_ops mc_syscore_ops = {
 457         .resume                 = mc_bp_resume,
 458 };
 459
 460 static __cpuinit int
 461 mc_cpu_callback(struct notifier_block *nb, unsigned long action, void *hcpu)
 462 {
 463         unsigned int cpu = (unsigned long)hcpu;
 464         struct sys_device *sys_dev;
 465
 466         sys_dev = get_cpu_sysdev(cpu);
 467         switch (action) {
 468         case CPU_ONLINE:
 469         case CPU_ONLINE_FROZEN:
 470                 microcode_update_cpu(cpu);
 471         case CPU_DOWN_FAILED:
 472         case CPU_DOWN_FAILED_FROZEN:
 473                 pr_debug("CPU%d added\n", cpu);
 474                 if (sysfs_create_group(&sys_dev->kobj, &mc_attr_group))
 475                         pr_err("Failed to create group for CPU%d\n", cpu);
 476                 break;
 477         case CPU_DOWN_PREPARE:
 478         case CPU_DOWN_PREPARE_FROZEN:
 479                 /* Suspend is in progress, only remove the interface */
 480                 sysfs_remove_group(&sys_dev->kobj, &mc_attr_group);
 481                 pr_debug("CPU%d removed\n", cpu);
 482                 break;
 483
 484         /*
 485          * When a CPU goes offline, don't free up or invalidate the copy of
 486          * the microcode in kernel memory, so that we can reuse it when the
 487          * CPU comes back online without unnecessarily requesting the userspace
 488          * for it again.
 489          */
 490         case CPU_UP_CANCELED_FROZEN:
 491                 /* The CPU refused to come up during a system resume */
 492                 microcode_fini_cpu(cpu);
 493                 break;
 494         }
 495         return NOTIFY_OK;
 496 }
 497
 498 static struct notifier_block __refdata mc_cpu_notifier = {
 499         .notifier_call  = mc_cpu_callback,
 500 };
 501
 502 static int __init microcode_init(void)
 503 {
 504         struct cpuinfo_x86 *c = &cpu_data(0);
 505         int error;
 506
 507         if (c->x86_vendor == X86_VENDOR_INTEL)
 508                 microcode_ops = init_intel_microcode();
 509         else if (c->x86_vendor == X86_VENDOR_AMD)
 510                 microcode_ops = init_amd_microcode();
 511
 512         if (!microcode_ops) {
 513                 pr_err("no support for this CPU vendor\n");
 514                 return -ENODEV;
 515         }
 516
 517         microcode_pdev = platform_device_register_simple("microcode", -1,
 518                                                          NULL, 0);
 519         if (IS_ERR(microcode_pdev))
 520                 return PTR_ERR(microcode_pdev);
 521
 522         get_online_cpus();
 523         mutex_lock(&microcode_mutex);
 524
 525         error = sysdev_driver_register(&cpu_sysdev_class, &mc_sysdev_driver);
 526
 527         mutex_unlock(&microcode_mutex);
 528         put_online_cpus();
 529
 530         if (error)
 531                 goto out_pdev;
 532
 533         error = microcode_dev_init();
 534         if (error)
 535                 goto out_sysdev_driver;
 536
 537         register_syscore_ops(&mc_syscore_ops);
 538         register_hotcpu_notifier(&mc_cpu_notifier);
 539
 540         pr_info("Microcode Update Driver: v" MICROCODE_VERSION
 541                 " <tigran@aivazian.fsnet.co.uk>, Peter Oruba\n");
 542
 543         return 0;
 544
 545 out_sysdev_driver:
 546         get_online_cpus();
 547         mutex_lock(&microcode_mutex);
 548
 549         sysdev_driver_unregister(&cpu_sysdev_class, &mc_sysdev_driver);
 550
 551         mutex_unlock(&microcode_mutex);
 552         put_online_cpus();
 553
 554 out_pdev:
 555         platform_device_unregister(microcode_pdev);
 556         return error;
 557
 558 }
 559 module_init(microcode_init);
 560
 561 static void __exit microcode_exit(void)
 562 {
 563         microcode_dev_exit();
 564
 565         unregister_hotcpu_notifier(&mc_cpu_notifier);
 566         unregister_syscore_ops(&mc_syscore_ops);
 567
 568         get_online_cpus();
 569         mutex_lock(&microcode_mutex);
 570
 571         sysdev_driver_unregister(&cpu_sysdev_class, &mc_sysdev_driver);
 572
 573         mutex_unlock(&microcode_mutex);
 574         put_online_cpus();
 575
 576         platform_device_unregister(microcode_pdev);
 577
 578         microcode_ops = NULL;
 579
 580         pr_info("Microcode Update Driver: v" MICROCODE_VERSION " removed.\n");
 581 }
 582 module_exit(microcode_exit);