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