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/design/pentium4/manuals/253668.htm
  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 #include <linux/platform_device.h>
  74 #include <linux/miscdevice.h>
  75 #include <linux/capability.h>
  76 #include <linux/smp_lock.h>
  77 #include <linux/kernel.h>
  78 #include <linux/module.h>
  79 #include <linux/mutex.h>
  80 #include <linux/cpu.h>
  81 #include <linux/fs.h>
  82 #include <linux/mm.h>
  83
  84 #include <asm/microcode.h>
  85 #include <asm/processor.h>
  86
  87 MODULE_DESCRIPTION("Microcode Update Driver");
  88 MODULE_AUTHOR("Tigran Aivazian <tigran@aivazian.fsnet.co.uk>");
  89 MODULE_LICENSE("GPL");
  90
  91 #define MICROCODE_VERSION       "2.00"
  92
  93 static struct microcode_ops     *microcode_ops;
  94
  95 /*
  96  * Synchronization.
  97  *
  98  * All non cpu-hotplug-callback call sites use:
  99  *
 100  * - microcode_mutex to synchronize with each other;
 101  * - get/put_online_cpus() to synchronize with
 102  *   the cpu-hotplug-callback call sites.
 103  *
 104  * We guarantee that only a single cpu is being
 105  * updated at any particular moment of time.
 106  */
 107 static DEFINE_MUTEX(microcode_mutex);
 108
 109 struct ucode_cpu_info           ucode_cpu_info[NR_CPUS];
 110 EXPORT_SYMBOL_GPL(ucode_cpu_info);
 111
 112 /*
 113  * Operations that are run on a target cpu:
 114  */
 115
 116 struct cpu_info_ctx {
 117         struct cpu_signature    *cpu_sig;
 118         int                     err;
 119 };
 120
 121 static void collect_cpu_info_local(void *arg)
 122 {
 123         struct cpu_info_ctx *ctx = arg;
 124
 125         ctx->err = microcode_ops->collect_cpu_info(smp_processor_id(),
 126                                                    ctx->cpu_sig);
 127 }
 128
 129 static int collect_cpu_info_on_target(int cpu, struct cpu_signature *cpu_sig)
 130 {
 131         struct cpu_info_ctx ctx = { .cpu_sig = cpu_sig, .err = 0 };
 132         int ret;
 133
 134         ret = smp_call_function_single(cpu, collect_cpu_info_local, &ctx, 1);
 135         if (!ret)
 136                 ret = ctx.err;
 137
 138         return ret;
 139 }
 140
 141 static int collect_cpu_info(int cpu)
 142 {
 143         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 144         int ret;
 145
 146         memset(uci, 0, sizeof(*uci));
 147
 148         ret = collect_cpu_info_on_target(cpu, &uci->cpu_sig);
 149         if (!ret)
 150                 uci->valid = 1;
 151
 152         return ret;
 153 }
 154
 155 struct apply_microcode_ctx {
 156         int err;
 157 };
 158
 159 static void apply_microcode_local(void *arg)
 160 {
 161         struct apply_microcode_ctx *ctx = arg;
 162
 163         ctx->err = microcode_ops->apply_microcode(smp_processor_id());
 164 }
 165
 166 static int apply_microcode_on_target(int cpu)
 167 {
 168         struct apply_microcode_ctx ctx = { .err = 0 };
 169         int ret;
 170
 171         ret = smp_call_function_single(cpu, apply_microcode_local, &ctx, 1);
 172         if (!ret)
 173                 ret = ctx.err;
 174
 175         return ret;
 176 }
 177
 178 #ifdef CONFIG_MICROCODE_OLD_INTERFACE
 179 static int do_microcode_update(const void __user *buf, size_t size)
 180 {
 181         int error = 0;
 182         int cpu;
 183
 184         for_each_online_cpu(cpu) {
 185                 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 186                 enum ucode_state ustate;
 187
 188                 if (!uci->valid)
 189                         continue;
 190
 191                 ustate = microcode_ops->request_microcode_user(cpu, buf, size);
 192                 if (ustate == UCODE_ERROR) {
 193                         error = -1;
 194                         break;
 195                 } else if (ustate == UCODE_OK)
 196                         apply_microcode_on_target(cpu);
 197         }
 198
 199         return error;
 200 }
 201
 202 static int microcode_open(struct inode *unused1, struct file *unused2)
 203 {
 204         cycle_kernel_lock();
 205         return capable(CAP_SYS_RAWIO) ? 0 : -EPERM;
 206 }
 207
 208 static ssize_t microcode_write(struct file *file, const char __user *buf,
 209                                size_t len, loff_t *ppos)
 210 {
 211         ssize_t ret = -EINVAL;
 212
 213         if ((len >> PAGE_SHIFT) > num_physpages) {
 214                 pr_err("microcode: too much data (max %ld pages)\n", num_physpages);
 215                 return ret;
 216         }
 217
 218         get_online_cpus();
 219         mutex_lock(&microcode_mutex);
 220
 221         if (do_microcode_update(buf, len) == 0)
 222                 ret = (ssize_t)len;
 223
 224         mutex_unlock(&microcode_mutex);
 225         put_online_cpus();
 226
 227         return ret;
 228 }
 229
 230 static const struct file_operations microcode_fops = {
 231         .owner                  = THIS_MODULE,
 232         .write                  = microcode_write,
 233         .open                   = microcode_open,
 234 };
 235
 236 static struct miscdevice microcode_dev = {
 237         .minor                  = MICROCODE_MINOR,
 238         .name                   = "microcode",
 239         .fops                   = &microcode_fops,
 240 };
 241
 242 static int __init microcode_dev_init(void)
 243 {
 244         int error;
 245
 246         error = misc_register(&microcode_dev);
 247         if (error) {
 248                 pr_err("microcode: can't misc_register on minor=%d\n", MICROCODE_MINOR);
 249                 return error;
 250         }
 251
 252         return 0;
 253 }
 254
 255 static void microcode_dev_exit(void)
 256 {
 257         misc_deregister(&microcode_dev);
 258 }
 259
 260 MODULE_ALIAS_MISCDEV(MICROCODE_MINOR);
 261 #else
 262 #define microcode_dev_init()    0
 263 #define microcode_dev_exit()    do { } while (0)
 264 #endif
 265
 266 /* fake device for request_firmware */
 267 static struct platform_device   *microcode_pdev;
 268
 269 static int reload_for_cpu(int cpu)
 270 {
 271         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 272         int err = 0;
 273
 274         mutex_lock(&microcode_mutex);
 275         if (uci->valid) {
 276                 enum ucode_state ustate;
 277
 278                 ustate = microcode_ops->request_microcode_fw(cpu, &microcode_pdev->dev);
 279                 if (ustate == UCODE_OK)
 280                         apply_microcode_on_target(cpu);
 281                 else
 282                         if (ustate == UCODE_ERROR)
 283                                 err = -EINVAL;
 284         }
 285         mutex_unlock(&microcode_mutex);
 286
 287         return err;
 288 }
 289
 290 static ssize_t reload_store(struct sys_device *dev,
 291                             struct sysdev_attribute *attr,
 292                             const char *buf, size_t size)
 293 {
 294         unsigned long val;
 295         int cpu = dev->id;
 296         int ret = 0;
 297         char *end;
 298
 299         val = simple_strtoul(buf, &end, 0);
 300         if (end == buf)
 301                 return -EINVAL;
 302
 303         if (val == 1) {
 304                 get_online_cpus();
 305                 if (cpu_online(cpu))
 306                         ret = reload_for_cpu(cpu);
 307                 put_online_cpus();
 308         }
 309
 310         if (!ret)
 311                 ret = size;
 312
 313         return ret;
 314 }
 315
 316 static ssize_t version_show(struct sys_device *dev,
 317                         struct sysdev_attribute *attr, char *buf)
 318 {
 319         struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
 320
 321         return sprintf(buf, "0x%x\n", uci->cpu_sig.rev);
 322 }
 323
 324 static ssize_t pf_show(struct sys_device *dev,
 325                         struct sysdev_attribute *attr, char *buf)
 326 {
 327         struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
 328
 329         return sprintf(buf, "0x%x\n", uci->cpu_sig.pf);
 330 }
 331
 332 static SYSDEV_ATTR(reload, 0200, NULL, reload_store);
 333 static SYSDEV_ATTR(version, 0400, version_show, NULL);
 334 static SYSDEV_ATTR(processor_flags, 0400, pf_show, NULL);
 335
 336 static struct attribute *mc_default_attrs[] = {
 337         &attr_reload.attr,
 338         &attr_version.attr,
 339         &attr_processor_flags.attr,
 340         NULL
 341 };
 342
 343 static struct attribute_group mc_attr_group = {
 344         .attrs                  = mc_default_attrs,
 345         .name                   = "microcode",
 346 };
 347
 348 static void microcode_fini_cpu(int cpu)
 349 {
 350         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 351
 352         microcode_ops->microcode_fini_cpu(cpu);
 353         uci->valid = 0;
 354 }
 355
 356 static enum ucode_state microcode_resume_cpu(int cpu)
 357 {
 358         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 359
 360         if (!uci->mc)
 361                 return UCODE_NFOUND;
 362
 363         pr_debug("microcode: CPU%d updated upon resume\n", cpu);
 364         apply_microcode_on_target(cpu);
 365
 366         return UCODE_OK;
 367 }
 368
 369 static enum ucode_state microcode_init_cpu(int cpu)
 370 {
 371         enum ucode_state ustate;
 372
 373         if (collect_cpu_info(cpu))
 374                 return UCODE_ERROR;
 375
 376         /* --dimm. Trigger a delayed update? */
 377         if (system_state != SYSTEM_RUNNING)
 378                 return UCODE_NFOUND;
 379
 380         ustate = microcode_ops->request_microcode_fw(cpu, &microcode_pdev->dev);
 381
 382         if (ustate == UCODE_OK) {
 383                 pr_debug("microcode: CPU%d updated upon init\n", cpu);
 384                 apply_microcode_on_target(cpu);
 385         }
 386
 387         return ustate;
 388 }
 389
 390 static enum ucode_state microcode_update_cpu(int cpu)
 391 {
 392         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 393         enum ucode_state ustate;
 394
 395         if (uci->valid)
 396                 ustate = microcode_resume_cpu(cpu);
 397         else
 398                 ustate = microcode_init_cpu(cpu);
 399
 400         return ustate;
 401 }
 402
 403 static int mc_sysdev_add(struct sys_device *sys_dev)
 404 {
 405         int err, cpu = sys_dev->id;
 406
 407         if (!cpu_online(cpu))
 408                 return 0;
 409
 410         pr_debug("microcode: CPU%d added\n", cpu);
 411
 412         err = sysfs_create_group(&sys_dev->kobj, &mc_attr_group);
 413         if (err)
 414                 return err;
 415
 416         if (microcode_init_cpu(cpu) == UCODE_ERROR)
 417                 err = -EINVAL;
 418
 419         return err;
 420 }
 421
 422 static int mc_sysdev_remove(struct sys_device *sys_dev)
 423 {
 424         int cpu = sys_dev->id;
 425
 426         if (!cpu_online(cpu))
 427                 return 0;
 428
 429         pr_debug("microcode: CPU%d removed\n", cpu);
 430         microcode_fini_cpu(cpu);
 431         sysfs_remove_group(&sys_dev->kobj, &mc_attr_group);
 432         return 0;
 433 }
 434
 435 static int mc_sysdev_resume(struct sys_device *dev)
 436 {
 437         int cpu = dev->id;
 438         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 439
 440         if (!cpu_online(cpu))
 441                 return 0;
 442
 443         /*
 444          * All non-bootup cpus are still disabled,
 445          * so only CPU 0 will apply ucode here.
 446          *
 447          * Moreover, there can be no concurrent
 448          * updates from any other places at this point.
 449          */
 450         WARN_ON(cpu != 0);
 451
 452         if (uci->valid && uci->mc)
 453                 microcode_ops->apply_microcode(cpu);
 454
 455         return 0;
 456 }
 457
 458 static struct sysdev_driver mc_sysdev_driver = {
 459         .add                    = mc_sysdev_add,
 460         .remove                 = mc_sysdev_remove,
 461         .resume                 = mc_sysdev_resume,
 462 };
 463
 464 static __cpuinit int
 465 mc_cpu_callback(struct notifier_block *nb, unsigned long action, void *hcpu)
 466 {
 467         unsigned int cpu = (unsigned long)hcpu;
 468         struct sys_device *sys_dev;
 469
 470         sys_dev = get_cpu_sysdev(cpu);
 471         switch (action) {
 472         case CPU_ONLINE:
 473         case CPU_ONLINE_FROZEN:
 474                 microcode_update_cpu(cpu);
 475         case CPU_DOWN_FAILED:
 476         case CPU_DOWN_FAILED_FROZEN:
 477                 pr_debug("microcode: CPU%d added\n", cpu);
 478                 if (sysfs_create_group(&sys_dev->kobj, &mc_attr_group))
 479                         pr_err("microcode: Failed to create group for CPU%d\n", cpu);
 480                 break;
 481         case CPU_DOWN_PREPARE:
 482         case CPU_DOWN_PREPARE_FROZEN:
 483                 /* Suspend is in progress, only remove the interface */
 484                 sysfs_remove_group(&sys_dev->kobj, &mc_attr_group);
 485                 pr_debug("microcode: CPU%d removed\n", cpu);
 486                 break;
 487         case CPU_DEAD:
 488         case CPU_UP_CANCELED_FROZEN:
 489                 /* The CPU refused to come up during a system resume */
 490                 microcode_fini_cpu(cpu);
 491                 break;
 492         }
 493         return NOTIFY_OK;
 494 }
 495
 496 static struct notifier_block __refdata mc_cpu_notifier = {
 497         .notifier_call  = mc_cpu_callback,
 498 };
 499
 500 static int __init microcode_init(void)
 501 {
 502         struct cpuinfo_x86 *c = &cpu_data(0);
 503         int error;
 504
 505         if (c->x86_vendor == X86_VENDOR_INTEL)
 506                 microcode_ops = init_intel_microcode();
 507         else if (c->x86_vendor == X86_VENDOR_AMD)
 508                 microcode_ops = init_amd_microcode();
 509
 510         if (!microcode_ops) {
 511                 pr_err("microcode: no support for this CPU vendor\n");
 512                 return -ENODEV;
 513         }
 514
 515         microcode_pdev = platform_device_register_simple("microcode", -1,
 516                                                          NULL, 0);
 517         if (IS_ERR(microcode_pdev)) {
 518                 microcode_dev_exit();
 519                 return PTR_ERR(microcode_pdev);
 520         }
 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                 platform_device_unregister(microcode_pdev);
 532                 return error;
 533         }
 534
 535         error = microcode_dev_init();
 536         if (error)
 537                 return error;
 538
 539         register_hotcpu_notifier(&mc_cpu_notifier);
 540
 541         pr_info("Microcode Update Driver: v" MICROCODE_VERSION
 542                " <tigran@aivazian.fsnet.co.uk>,"
 543                " Peter Oruba\n");
 544
 545         return 0;
 546 }
 547 module_init(microcode_init);
 548
 549 static void __exit microcode_exit(void)
 550 {
 551         microcode_dev_exit();
 552
 553         unregister_hotcpu_notifier(&mc_cpu_notifier);
 554
 555         get_online_cpus();
 556         mutex_lock(&microcode_mutex);
 557
 558         sysdev_driver_unregister(&cpu_sysdev_class, &mc_sysdev_driver);
 559
 560         mutex_unlock(&microcode_mutex);
 561         put_online_cpus();
 562
 563         platform_device_unregister(microcode_pdev);
 564
 565         microcode_ops = NULL;
 566
 567         pr_info("Microcode Update Driver: v" MICROCODE_VERSION " removed.\n");
 568 }
 569 module_exit(microcode_exit);