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 static int collect_cpu_info(int cpu_num, struct cpu_signature *csig)
 126 {
 127         struct cpuinfo_x86 *c = &cpu_data(cpu_num);
 128         unsigned int val[2];
 129
 130         memset(csig, 0, sizeof(*csig));
 131
 132         if (c->x86_vendor != X86_VENDOR_INTEL || c->x86 < 6 ||
 133             cpu_has(c, X86_FEATURE_IA64)) {
 134                 printk(KERN_ERR "microcode: CPU%d not a capable Intel "
 135                         "processor\n", cpu_num);
 136                 return -1;
 137         }
 138
 139         csig->sig = cpuid_eax(0x00000001);
 140
 141         if ((c->x86_model >= 5) || (c->x86 > 6)) {
 142                 /* get processor flags from MSR 0x17 */
 143                 rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
 144                 csig->pf = 1 << ((val[1] >> 18) & 7);
 145         }
 146
 147         wrmsr(MSR_IA32_UCODE_REV, 0, 0);
 148         /* see notes above for revision 1.07.  Apparent chip bug */
 149         sync_core();
 150         /* get the current revision from MSR 0x8B */
 151         rdmsr(MSR_IA32_UCODE_REV, val[0], csig->rev);
 152         pr_debug("microcode: collect_cpu_info : sig=0x%x, pf=0x%x, rev=0x%x\n",
 153                         csig->sig, csig->pf, csig->rev);
 154
 155         return 0;
 156 }
 157
 158 static inline int microcode_update_match(int cpu_num,
 159         struct microcode_header_intel *mc_header, int sig, int pf)
 160 {
 161         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 162
 163         if (!sigmatch(sig, uci->cpu_sig.sig, pf, uci->cpu_sig.pf)
 164                 || mc_header->rev <= uci->cpu_sig.rev)
 165                 return 0;
 166         return 1;
 167 }
 168
 169 static int microcode_sanity_check(void *mc)
 170 {
 171         struct microcode_header_intel *mc_header = mc;
 172         struct extended_sigtable *ext_header = NULL;
 173         struct extended_signature *ext_sig;
 174         unsigned long total_size, data_size, ext_table_size;
 175         int sum, orig_sum, ext_sigcount = 0, i;
 176
 177         total_size = get_totalsize(mc_header);
 178         data_size = get_datasize(mc_header);
 179         if (data_size + MC_HEADER_SIZE > total_size) {
 180                 printk(KERN_ERR "microcode: error! "
 181                         "Bad data size in microcode data file\n");
 182                 return -EINVAL;
 183         }
 184
 185         if (mc_header->ldrver != 1 || mc_header->hdrver != 1) {
 186                 printk(KERN_ERR "microcode: error! "
 187                         "Unknown microcode update format\n");
 188                 return -EINVAL;
 189         }
 190         ext_table_size = total_size - (MC_HEADER_SIZE + data_size);
 191         if (ext_table_size) {
 192                 if ((ext_table_size < EXT_HEADER_SIZE)
 193                  || ((ext_table_size - EXT_HEADER_SIZE) % EXT_SIGNATURE_SIZE)) {
 194                         printk(KERN_ERR "microcode: error! "
 195                                 "Small exttable size in microcode data file\n");
 196                         return -EINVAL;
 197                 }
 198                 ext_header = mc + MC_HEADER_SIZE + data_size;
 199                 if (ext_table_size != exttable_size(ext_header)) {
 200                         printk(KERN_ERR "microcode: error! "
 201                                 "Bad exttable size in microcode data file\n");
 202                         return -EFAULT;
 203                 }
 204                 ext_sigcount = ext_header->count;
 205         }
 206
 207         /* check extended table checksum */
 208         if (ext_table_size) {
 209                 int ext_table_sum = 0;
 210                 int *ext_tablep = (int *)ext_header;
 211
 212                 i = ext_table_size / DWSIZE;
 213                 while (i--)
 214                         ext_table_sum += ext_tablep[i];
 215                 if (ext_table_sum) {
 216                         printk(KERN_WARNING "microcode: aborting, "
 217                                 "bad extended signature table checksum\n");
 218                         return -EINVAL;
 219                 }
 220         }
 221
 222         /* calculate the checksum */
 223         orig_sum = 0;
 224         i = (MC_HEADER_SIZE + data_size) / DWSIZE;
 225         while (i--)
 226                 orig_sum += ((int *)mc)[i];
 227         if (orig_sum) {
 228                 printk(KERN_ERR "microcode: aborting, bad checksum\n");
 229                 return -EINVAL;
 230         }
 231         if (!ext_table_size)
 232                 return 0;
 233         /* check extended signature checksum */
 234         for (i = 0; i < ext_sigcount; i++) {
 235                 ext_sig = (void *)ext_header + EXT_HEADER_SIZE +
 236                           EXT_SIGNATURE_SIZE * i;
 237                 sum = orig_sum
 238                         - (mc_header->sig + mc_header->pf + mc_header->cksum)
 239                         + (ext_sig->sig + ext_sig->pf + ext_sig->cksum);
 240                 if (sum) {
 241                         printk(KERN_ERR "microcode: aborting, bad checksum\n");
 242                         return -EINVAL;
 243                 }
 244         }
 245         return 0;
 246 }
 247
 248 /*
 249  * return 0 - no update found
 250  * return 1 - found update
 251  * return < 0 - error
 252  */
 253 static int get_matching_microcode(void *mc, int cpu)
 254 {
 255         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 256         struct microcode_header_intel *mc_header = mc;
 257         struct extended_sigtable *ext_header;
 258         unsigned long total_size = get_totalsize(mc_header);
 259         int ext_sigcount, i;
 260         struct extended_signature *ext_sig;
 261         void *new_mc;
 262
 263         if (microcode_update_match(cpu, mc_header,
 264                         mc_header->sig, mc_header->pf))
 265                 goto find;
 266
 267         if (total_size <= get_datasize(mc_header) + MC_HEADER_SIZE)
 268                 return 0;
 269
 270         ext_header = mc + get_datasize(mc_header) + MC_HEADER_SIZE;
 271         ext_sigcount = ext_header->count;
 272         ext_sig = (void *)ext_header + EXT_HEADER_SIZE;
 273         for (i = 0; i < ext_sigcount; i++) {
 274                 if (microcode_update_match(cpu, mc_header,
 275                                 ext_sig->sig, ext_sig->pf))
 276                         goto find;
 277                 ext_sig++;
 278         }
 279         return 0;
 280 find:
 281         pr_debug("microcode: CPU%d found a matching microcode update with"
 282                  " version 0x%x (current=0x%x)\n",
 283                  cpu, mc_header->rev, uci->cpu_sig.rev);
 284         new_mc = vmalloc(total_size);
 285         if (!new_mc) {
 286                 printk(KERN_ERR "microcode: error! Can not allocate memory\n");
 287                 return -ENOMEM;
 288         }
 289
 290         /* free previous update file */
 291         vfree(uci->mc.mc_intel);
 292
 293         memcpy(new_mc, mc, total_size);
 294         uci->mc.mc_intel = new_mc;
 295         return 1;
 296 }
 297
 298 static void apply_microcode(int cpu)
 299 {
 300         unsigned long flags;
 301         unsigned int val[2];
 302         int cpu_num = raw_smp_processor_id();
 303         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 304
 305         /* We should bind the task to the CPU */
 306         BUG_ON(cpu_num != cpu);
 307
 308         if (uci->mc.mc_intel == NULL)
 309                 return;
 310
 311         /* serialize access to the physical write to MSR 0x79 */
 312         spin_lock_irqsave(&microcode_update_lock, flags);
 313
 314         /* write microcode via MSR 0x79 */
 315         wrmsr(MSR_IA32_UCODE_WRITE,
 316               (unsigned long) uci->mc.mc_intel->bits,
 317               (unsigned long) uci->mc.mc_intel->bits >> 16 >> 16);
 318         wrmsr(MSR_IA32_UCODE_REV, 0, 0);
 319
 320         /* see notes above for revision 1.07.  Apparent chip bug */
 321         sync_core();
 322
 323         /* get the current revision from MSR 0x8B */
 324         rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
 325
 326         spin_unlock_irqrestore(&microcode_update_lock, flags);
 327         if (val[1] != uci->mc.mc_intel->hdr.rev) {
 328                 printk(KERN_ERR "microcode: CPU%d update from revision "
 329                         "0x%x to 0x%x failed\n", cpu_num, uci->cpu_sig.rev, val[1]);
 330                 return;
 331         }
 332         printk(KERN_INFO "microcode: CPU%d updated from revision "
 333                "0x%x to 0x%x, date = %04x-%02x-%02x \n",
 334                 cpu_num, uci->cpu_sig.rev, val[1],
 335                 uci->mc.mc_intel->hdr.date & 0xffff,
 336                 uci->mc.mc_intel->hdr.date >> 24,
 337                 (uci->mc.mc_intel->hdr.date >> 16) & 0xff);
 338         uci->cpu_sig.rev = val[1];
 339 }
 340
 341 #ifdef CONFIG_MICROCODE_OLD_INTERFACE
 342 extern void __user *user_buffer;        /* user area microcode data buffer */
 343 extern unsigned int user_buffer_size;   /* it's size */
 344
 345 static long get_next_ucode(void **mc, long offset)
 346 {
 347         struct microcode_header_intel mc_header;
 348         unsigned long total_size;
 349
 350         /* No more data */
 351         if (offset >= user_buffer_size)
 352                 return 0;
 353         if (copy_from_user(&mc_header, user_buffer + offset, MC_HEADER_SIZE)) {
 354                 printk(KERN_ERR "microcode: error! Can not read user data\n");
 355                 return -EFAULT;
 356         }
 357         total_size = get_totalsize(&mc_header);
 358         if (offset + total_size > user_buffer_size) {
 359                 printk(KERN_ERR "microcode: error! Bad total size in microcode "
 360                                 "data file\n");
 361                 return -EINVAL;
 362         }
 363         *mc = vmalloc(total_size);
 364         if (!*mc)
 365                 return -ENOMEM;
 366         if (copy_from_user(*mc, user_buffer + offset, total_size)) {
 367                 printk(KERN_ERR "microcode: error! Can not read user data\n");
 368                 vfree(*mc);
 369                 return -EFAULT;
 370         }
 371         return offset + total_size;
 372 }
 373 #endif
 374
 375 static long get_next_ucode_from_buffer(void **mc, const u8 *buf,
 376         unsigned long size, long offset)
 377 {
 378         struct microcode_header_intel *mc_header;
 379         unsigned long total_size;
 380
 381         /* No more data */
 382         if (offset >= size)
 383                 return 0;
 384         mc_header = (struct microcode_header_intel *)(buf + offset);
 385         total_size = get_totalsize(mc_header);
 386
 387         if (offset + total_size > size) {
 388                 printk(KERN_ERR "microcode: error! Bad data in microcode data file\n");
 389                 return -EINVAL;
 390         }
 391
 392         *mc = vmalloc(total_size);
 393         if (!*mc) {
 394                 printk(KERN_ERR "microcode: error! Can not allocate memory\n");
 395                 return -ENOMEM;
 396         }
 397         memcpy(*mc, buf + offset, total_size);
 398         return offset + total_size;
 399 }
 400
 401 /* fake device for request_firmware */
 402 extern struct platform_device *microcode_pdev;
 403
 404 static int cpu_request_microcode(int cpu)
 405 {
 406         char name[30];
 407         struct cpuinfo_x86 *c = &cpu_data(cpu);
 408         const struct firmware *firmware;
 409         const u8 *buf;
 410         unsigned long size;
 411         long offset = 0;
 412         int error;
 413         void *mc;
 414
 415         /* We should bind the task to the CPU */
 416         BUG_ON(cpu != raw_smp_processor_id());
 417         sprintf(name, "intel-ucode/%02x-%02x-%02x",
 418                 c->x86, c->x86_model, c->x86_mask);
 419         error = request_firmware(&firmware, name, &microcode_pdev->dev);
 420         if (error) {
 421                 pr_debug("microcode: data file %s load failed\n", name);
 422                 return error;
 423         }
 424         buf = firmware->data;
 425         size = firmware->size;
 426         while ((offset = get_next_ucode_from_buffer(&mc, buf, size, offset))
 427                         > 0) {
 428                 error = microcode_sanity_check(mc);
 429                 if (error)
 430                         break;
 431                 error = get_matching_microcode(mc, cpu);
 432                 if (error < 0)
 433                         break;
 434                 /*
 435                  * It's possible the data file has multiple matching ucode,
 436                  * lets keep searching till the latest version
 437                  */
 438                 if (error == 1) {
 439                         apply_microcode(cpu);
 440                         error = 0;
 441                 }
 442                 vfree(mc);
 443         }
 444         if (offset > 0)
 445                 vfree(mc);
 446         if (offset < 0)
 447                 error = offset;
 448         release_firmware(firmware);
 449
 450         return error;
 451 }
 452
 453 static void microcode_fini_cpu(int cpu)
 454 {
 455         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 456
 457         vfree(uci->mc.mc_intel);
 458         uci->mc.mc_intel = NULL;
 459 }
 460
 461 static struct microcode_ops microcode_intel_ops = {
 462         .get_next_ucode                   = get_next_ucode,
 463         .get_matching_microcode           = get_matching_microcode,
 464         .microcode_sanity_check           = microcode_sanity_check,
 465         .cpu_request_microcode            = cpu_request_microcode,
 466         .collect_cpu_info                 = collect_cpu_info,
 467         .apply_microcode                  = apply_microcode,
 468         .microcode_fini_cpu               = microcode_fini_cpu,
 469 };
 470
 471 static int __init microcode_intel_module_init(void)
 472 {
 473         struct cpuinfo_x86 *c = &cpu_data(0);
 474
 475         if (c->x86_vendor != X86_VENDOR_INTEL) {
 476                 printk(KERN_ERR "microcode: CPU platform is not Intel-capable\n");
 477                 return -ENODEV;
 478         }
 479
 480         return microcode_init(&microcode_intel_ops, THIS_MODULE);
 481 }
 482
 483 static void __exit microcode_intel_module_exit(void)
 484 {
 485         microcode_exit();
 486 }
 487
 488 module_init(microcode_intel_module_init)
 489 module_exit(microcode_intel_module_exit)