arch/x86/kernel/microcode_intel.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
  74 /* #define DEBUG */ /* pr_debug */
  75 #include <linux/capability.h>
  76 #include <linux/kernel.h>
  77 #include <linux/init.h>
  78 #include <linux/sched.h>
  79 #include <linux/smp_lock.h>
  80 #include <linux/cpumask.h>
  81 #include <linux/module.h>
  82 #include <linux/slab.h>
  83 #include <linux/vmalloc.h>
  84 #include <linux/miscdevice.h>
  85 #include <linux/spinlock.h>
  86 #include <linux/mm.h>
  87 #include <linux/fs.h>
  88 #include <linux/mutex.h>
  89 #include <linux/cpu.h>
  90 #include <linux/firmware.h>
  91 #include <linux/platform_device.h>
  92
  93 #include <asm/msr.h>
  94 #include <asm/uaccess.h>
  95 #include <asm/processor.h>
  96 #include <asm/microcode.h>
  97
  98 MODULE_DESCRIPTION("Microcode Update Driver");
  99 MODULE_AUTHOR("Tigran Aivazian <tigran@aivazian.fsnet.co.uk>");
 100 MODULE_LICENSE("GPL");
 101
 102 #define DEFAULT_UCODE_DATASIZE  (2000)
 103 #define MC_HEADER_SIZE          (sizeof(struct microcode_header_intel))
 104 #define DEFAULT_UCODE_TOTALSIZE (DEFAULT_UCODE_DATASIZE + MC_HEADER_SIZE)
 105 #define EXT_HEADER_SIZE         (sizeof(struct extended_sigtable))
 106 #define EXT_SIGNATURE_SIZE      (sizeof(struct extended_signature))
 107 #define DWSIZE                  (sizeof(u32))
 108 #define get_totalsize(mc) \
 109         (((struct microcode_intel *)mc)->hdr.totalsize ? \
 110          ((struct microcode_intel *)mc)->hdr.totalsize : \
 111          DEFAULT_UCODE_TOTALSIZE)
 112
 113 #define get_datasize(mc) \
 114         (((struct microcode_intel *)mc)->hdr.datasize ? \
 115          ((struct microcode_intel *)mc)->hdr.datasize : DEFAULT_UCODE_DATASIZE)
 116
 117 #define sigmatch(s1, s2, p1, p2) \
 118         (((s1) == (s2)) && (((p1) & (p2)) || (((p1) == 0) && ((p2) == 0))))
 119
 120 #define exttable_size(et) ((et)->count * EXT_SIGNATURE_SIZE + EXT_HEADER_SIZE)
 121
 122 /* serialize access to the physical write to MSR 0x79 */
 123 static DEFINE_SPINLOCK(microcode_update_lock);
 124
 125 /* no concurrent ->write()s are allowed on /dev/cpu/microcode */
 126 extern struct mutex microcode_mutex;
 127
 128 extern struct ucode_cpu_info ucode_cpu_info[NR_CPUS];
 129
 130 static void collect_cpu_info(int cpu_num)
 131 {
 132         struct cpuinfo_x86 *c = &cpu_data(cpu_num);
 133         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 134         unsigned int val[2];
 135
 136         /* We should bind the task to the CPU */
 137         BUG_ON(raw_smp_processor_id() != cpu_num);
 138         uci->pf = uci->rev = 0;
 139         uci->mc.mc_intel = NULL;
 140         uci->valid = 1;
 141
 142         if (c->x86_vendor != X86_VENDOR_INTEL || c->x86 < 6 ||
 143             cpu_has(c, X86_FEATURE_IA64)) {
 144                 printk(KERN_ERR "microcode: CPU%d not a capable Intel "
 145                         "processor\n", cpu_num);
 146                 uci->valid = 0;
 147                 return;
 148         }
 149
 150         uci->sig = cpuid_eax(0x00000001);
 151
 152         if ((c->x86_model >= 5) || (c->x86 > 6)) {
 153                 /* get processor flags from MSR 0x17 */
 154                 rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
 155                 uci->pf = 1 << ((val[1] >> 18) & 7);
 156         }
 157
 158         wrmsr(MSR_IA32_UCODE_REV, 0, 0);
 159         /* see notes above for revision 1.07.  Apparent chip bug */
 160         sync_core();
 161         /* get the current revision from MSR 0x8B */
 162         rdmsr(MSR_IA32_UCODE_REV, val[0], uci->rev);
 163         pr_debug("microcode: collect_cpu_info : sig=0x%x, pf=0x%x, rev=0x%x\n",
 164                         uci->sig, uci->pf, uci->rev);
 165 }
 166
 167 static inline int microcode_update_match(int cpu_num,
 168         struct microcode_header_intel *mc_header, int sig, int pf)
 169 {
 170         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 171
 172         if (!sigmatch(sig, uci->sig, pf, uci->pf)
 173                 || mc_header->rev <= uci->rev)
 174                 return 0;
 175         return 1;
 176 }
 177
 178 static int microcode_sanity_check(void *mc)
 179 {
 180         struct microcode_header_intel *mc_header = mc;
 181         struct extended_sigtable *ext_header = NULL;
 182         struct extended_signature *ext_sig;
 183         unsigned long total_size, data_size, ext_table_size;
 184         int sum, orig_sum, ext_sigcount = 0, i;
 185
 186         total_size = get_totalsize(mc_header);
 187         data_size = get_datasize(mc_header);
 188         if (data_size + MC_HEADER_SIZE > total_size) {
 189                 printk(KERN_ERR "microcode: error! "
 190                         "Bad data size in microcode data file\n");
 191                 return -EINVAL;
 192         }
 193
 194         if (mc_header->ldrver != 1 || mc_header->hdrver != 1) {
 195                 printk(KERN_ERR "microcode: error! "
 196                         "Unknown microcode update format\n");
 197                 return -EINVAL;
 198         }
 199         ext_table_size = total_size - (MC_HEADER_SIZE + data_size);
 200         if (ext_table_size) {
 201                 if ((ext_table_size < EXT_HEADER_SIZE)
 202                  || ((ext_table_size - EXT_HEADER_SIZE) % EXT_SIGNATURE_SIZE)) {
 203                         printk(KERN_ERR "microcode: error! "
 204                                 "Small exttable size in microcode data file\n");
 205                         return -EINVAL;
 206                 }
 207                 ext_header = mc + MC_HEADER_SIZE + data_size;
 208                 if (ext_table_size != exttable_size(ext_header)) {
 209                         printk(KERN_ERR "microcode: error! "
 210                                 "Bad exttable size in microcode data file\n");
 211                         return -EFAULT;
 212                 }
 213                 ext_sigcount = ext_header->count;
 214         }
 215
 216         /* check extended table checksum */
 217         if (ext_table_size) {
 218                 int ext_table_sum = 0;
 219                 int *ext_tablep = (int *)ext_header;
 220
 221                 i = ext_table_size / DWSIZE;
 222                 while (i--)
 223                         ext_table_sum += ext_tablep[i];
 224                 if (ext_table_sum) {
 225                         printk(KERN_WARNING "microcode: aborting, "
 226                                 "bad extended signature table checksum\n");
 227                         return -EINVAL;
 228                 }
 229         }
 230
 231         /* calculate the checksum */
 232         orig_sum = 0;
 233         i = (MC_HEADER_SIZE + data_size) / DWSIZE;
 234         while (i--)
 235                 orig_sum += ((int *)mc)[i];
 236         if (orig_sum) {
 237                 printk(KERN_ERR "microcode: aborting, bad checksum\n");
 238                 return -EINVAL;
 239         }
 240         if (!ext_table_size)
 241                 return 0;
 242         /* check extended signature checksum */
 243         for (i = 0; i < ext_sigcount; i++) {
 244                 ext_sig = (void *)ext_header + EXT_HEADER_SIZE +
 245                           EXT_SIGNATURE_SIZE * i;
 246                 sum = orig_sum
 247                         - (mc_header->sig + mc_header->pf + mc_header->cksum)
 248                         + (ext_sig->sig + ext_sig->pf + ext_sig->cksum);
 249                 if (sum) {
 250                         printk(KERN_ERR "microcode: aborting, bad checksum\n");
 251                         return -EINVAL;
 252                 }
 253         }
 254         return 0;
 255 }
 256
 257 /*
 258  * return 0 - no update found
 259  * return 1 - found update
 260  * return < 0 - error
 261  */
 262 static int get_matching_microcode(void *mc, int cpu)
 263 {
 264         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 265         struct microcode_header_intel *mc_header = mc;
 266         struct extended_sigtable *ext_header;
 267         unsigned long total_size = get_totalsize(mc_header);
 268         int ext_sigcount, i;
 269         struct extended_signature *ext_sig;
 270         void *new_mc;
 271
 272         if (microcode_update_match(cpu, mc_header,
 273                         mc_header->sig, mc_header->pf))
 274                 goto find;
 275
 276         if (total_size <= get_datasize(mc_header) + MC_HEADER_SIZE)
 277                 return 0;
 278
 279         ext_header = mc + get_datasize(mc_header) + MC_HEADER_SIZE;
 280         ext_sigcount = ext_header->count;
 281         ext_sig = (void *)ext_header + EXT_HEADER_SIZE;
 282         for (i = 0; i < ext_sigcount; i++) {
 283                 if (microcode_update_match(cpu, mc_header,
 284                                 ext_sig->sig, ext_sig->pf))
 285                         goto find;
 286                 ext_sig++;
 287         }
 288         return 0;
 289 find:
 290         pr_debug("microcode: CPU%d found a matching microcode update with"
 291                  " version 0x%x (current=0x%x)\n",
 292                  cpu, mc_header->rev, uci->rev);
 293         new_mc = vmalloc(total_size);
 294         if (!new_mc) {
 295                 printk(KERN_ERR "microcode: error! Can not allocate memory\n");
 296                 return -ENOMEM;
 297         }
 298
 299         /* free previous update file */
 300         vfree(uci->mc.mc_intel);
 301
 302         memcpy(new_mc, mc, total_size);
 303         uci->mc.mc_intel = new_mc;
 304         return 1;
 305 }
 306
 307 static void apply_microcode(int cpu)
 308 {
 309         unsigned long flags;
 310         unsigned int val[2];
 311         int cpu_num = raw_smp_processor_id();
 312         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 313
 314         /* We should bind the task to the CPU */
 315         BUG_ON(cpu_num != cpu);
 316
 317         if (uci->mc.mc_intel == NULL)
 318                 return;
 319
 320         /* serialize access to the physical write to MSR 0x79 */
 321         spin_lock_irqsave(&microcode_update_lock, flags);
 322
 323         /* write microcode via MSR 0x79 */
 324         wrmsr(MSR_IA32_UCODE_WRITE,
 325               (unsigned long) uci->mc.mc_intel->bits,
 326               (unsigned long) uci->mc.mc_intel->bits >> 16 >> 16);
 327         wrmsr(MSR_IA32_UCODE_REV, 0, 0);
 328
 329         /* see notes above for revision 1.07.  Apparent chip bug */
 330         sync_core();
 331
 332         /* get the current revision from MSR 0x8B */
 333         rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
 334
 335         spin_unlock_irqrestore(&microcode_update_lock, flags);
 336         if (val[1] != uci->mc.mc_intel->hdr.rev) {
 337                 printk(KERN_ERR "microcode: CPU%d update from revision "
 338                         "0x%x to 0x%x failed\n", cpu_num, uci->rev, val[1]);
 339                 return;
 340         }
 341         printk(KERN_INFO "microcode: CPU%d updated from revision "
 342                "0x%x to 0x%x, date = %04x-%02x-%02x \n",
 343                 cpu_num, uci->rev, val[1],
 344                 uci->mc.mc_intel->hdr.date & 0xffff,
 345                 uci->mc.mc_intel->hdr.date >> 24,
 346                 (uci->mc.mc_intel->hdr.date >> 16) & 0xff);
 347         uci->rev = val[1];
 348 }
 349
 350 #ifdef CONFIG_MICROCODE_OLD_INTERFACE
 351 extern void __user *user_buffer;        /* user area microcode data buffer */
 352 extern unsigned int user_buffer_size;   /* it's size */
 353
 354 static long get_next_ucode(void **mc, long offset)
 355 {
 356         struct microcode_header_intel mc_header;
 357         unsigned long total_size;
 358
 359         /* No more data */
 360         if (offset >= user_buffer_size)
 361                 return 0;
 362         if (copy_from_user(&mc_header, user_buffer + offset, MC_HEADER_SIZE)) {
 363                 printk(KERN_ERR "microcode: error! Can not read user data\n");
 364                 return -EFAULT;
 365         }
 366         total_size = get_totalsize(&mc_header);
 367         if (offset + total_size > user_buffer_size) {
 368                 printk(KERN_ERR "microcode: error! Bad total size in microcode "
 369                                 "data file\n");
 370                 return -EINVAL;
 371         }
 372         *mc = vmalloc(total_size);
 373         if (!*mc)
 374                 return -ENOMEM;
 375         if (copy_from_user(*mc, user_buffer + offset, total_size)) {
 376                 printk(KERN_ERR "microcode: error! Can not read user data\n");
 377                 vfree(*mc);
 378                 return -EFAULT;
 379         }
 380         return offset + total_size;
 381 }
 382 #endif
 383
 384 static long get_next_ucode_from_buffer(void **mc, const u8 *buf,
 385         unsigned long size, long offset)
 386 {
 387         struct microcode_header_intel *mc_header;
 388         unsigned long total_size;
 389
 390         /* No more data */
 391         if (offset >= size)
 392                 return 0;
 393         mc_header = (struct microcode_header_intel *)(buf + offset);
 394         total_size = get_totalsize(mc_header);
 395
 396         if (offset + total_size > size) {
 397                 printk(KERN_ERR "microcode: error! Bad data in microcode data file\n");
 398                 return -EINVAL;
 399         }
 400
 401         *mc = vmalloc(total_size);
 402         if (!*mc) {
 403                 printk(KERN_ERR "microcode: error! Can not allocate memory\n");
 404                 return -ENOMEM;
 405         }
 406         memcpy(*mc, buf + offset, total_size);
 407         return offset + total_size;
 408 }
 409
 410 /* fake device for request_firmware */
 411 extern struct platform_device *microcode_pdev;
 412
 413 static int cpu_request_microcode(int cpu)
 414 {
 415         char name[30];
 416         struct cpuinfo_x86 *c = &cpu_data(cpu);
 417         const struct firmware *firmware;
 418         const u8 *buf;
 419         unsigned long size;
 420         long offset = 0;
 421         int error;
 422         void *mc;
 423
 424         /* We should bind the task to the CPU */
 425         BUG_ON(cpu != raw_smp_processor_id());
 426         sprintf(name, "intel-ucode/%02x-%02x-%02x",
 427                 c->x86, c->x86_model, c->x86_mask);
 428         error = request_firmware(&firmware, name, &microcode_pdev->dev);
 429         if (error) {
 430                 pr_debug("microcode: data file %s load failed\n", name);
 431                 return error;
 432         }
 433         buf = firmware->data;
 434         size = firmware->size;
 435         while ((offset = get_next_ucode_from_buffer(&mc, buf, size, offset))
 436                         > 0) {
 437                 error = microcode_sanity_check(mc);
 438                 if (error)
 439                         break;
 440                 error = get_matching_microcode(mc, cpu);
 441                 if (error < 0)
 442                         break;
 443                 /*
 444                  * It's possible the data file has multiple matching ucode,
 445                  * lets keep searching till the latest version
 446                  */
 447                 if (error == 1) {
 448                         apply_microcode(cpu);
 449                         error = 0;
 450                 }
 451                 vfree(mc);
 452         }
 453         if (offset > 0)
 454                 vfree(mc);
 455         if (offset < 0)
 456                 error = offset;
 457         release_firmware(firmware);
 458
 459         return error;
 460 }
 461
 462 static int apply_microcode_check_cpu(int cpu)
 463 {
 464         struct cpuinfo_x86 *c = &cpu_data(cpu);
 465         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 466         cpumask_t old;
 467         unsigned int val[2];
 468         int err = 0;
 469
 470         /* Check if the microcode is available */
 471         if (!uci->mc.mc_intel)
 472                 return 0;
 473
 474         old = current->cpus_allowed;
 475         set_cpus_allowed_ptr(current, &cpumask_of_cpu(cpu));
 476
 477         /* Check if the microcode we have in memory matches the CPU */
 478         if (c->x86_vendor != X86_VENDOR_INTEL || c->x86 < 6 ||
 479             cpu_has(c, X86_FEATURE_IA64) || uci->sig != cpuid_eax(0x00000001))
 480                 err = -EINVAL;
 481
 482         if (!err && ((c->x86_model >= 5) || (c->x86 > 6))) {
 483                 /* get processor flags from MSR 0x17 */
 484                 rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
 485                 if (uci->pf != (1 << ((val[1] >> 18) & 7)))
 486                         err = -EINVAL;
 487         }
 488
 489         if (!err) {
 490                 wrmsr(MSR_IA32_UCODE_REV, 0, 0);
 491                 /* see notes above for revision 1.07.  Apparent chip bug */
 492                 sync_core();
 493                 /* get the current revision from MSR 0x8B */
 494                 rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
 495                 if (uci->rev != val[1])
 496                         err = -EINVAL;
 497         }
 498
 499         if (!err)
 500                 apply_microcode(cpu);
 501         else
 502                 printk(KERN_ERR "microcode: Could not apply microcode to CPU%d:"
 503                         " sig=0x%x, pf=0x%x, rev=0x%x\n",
 504                         cpu, uci->sig, uci->pf, uci->rev);
 505
 506         set_cpus_allowed_ptr(current, &old);
 507         return err;
 508 }
 509
 510 static void microcode_fini_cpu(int cpu)
 511 {
 512         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 513
 514         mutex_lock(&microcode_mutex);
 515         uci->valid = 0;
 516         vfree(uci->mc.mc_intel);
 517         uci->mc.mc_intel = NULL;
 518         mutex_unlock(&microcode_mutex);
 519 }
 520
 521 static struct microcode_ops microcode_intel_ops = {
 522         .get_next_ucode                   = get_next_ucode,
 523         .get_matching_microcode           = get_matching_microcode,
 524         .microcode_sanity_check           = microcode_sanity_check,
 525         .apply_microcode_check_cpu        = apply_microcode_check_cpu,
 526         .cpu_request_microcode            = cpu_request_microcode,
 527         .collect_cpu_info                 = collect_cpu_info,
 528         .apply_microcode                  = apply_microcode,
 529         .microcode_fini_cpu               = microcode_fini_cpu,
 530 };
 531
 532 static int __init microcode_intel_module_init(void)
 533 {
 534         struct cpuinfo_x86 *c = &cpu_data(0);
 535
 536         if (c->x86_vendor != X86_VENDOR_INTEL) {
 537                 printk(KERN_ERR "microcode: CPU platform is not Intel-capable\n");
 538                 return -ENODEV;
 539         }
 540
 541         return microcode_init(&microcode_intel_ops, THIS_MODULE);
 542 }
 543
 544 static void __exit microcode_intel_module_exit(void)
 545 {
 546         microcode_exit();
 547 }
 548
 549 module_init(microcode_intel_module_init)
 550 module_exit(microcode_intel_module_exit)