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