arch/x86/kernel/microcode.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 MICROCODE_VERSION       "2.00"
 103
 104 struct microcode_ops *microcode_ops;
 105
 106 /* no concurrent ->write()s are allowed on /dev/cpu/microcode */
 107 DEFINE_MUTEX(microcode_mutex);
 108 EXPORT_SYMBOL_GPL(microcode_mutex);
 109
 110 struct ucode_cpu_info ucode_cpu_info[NR_CPUS];
 111 EXPORT_SYMBOL_GPL(ucode_cpu_info);
 112
 113 #ifdef CONFIG_MICROCODE_OLD_INTERFACE
 114 void __user *user_buffer;               /* user area microcode data buffer */
 115 EXPORT_SYMBOL_GPL(user_buffer);
 116 unsigned int user_buffer_size;          /* it's size */
 117 EXPORT_SYMBOL_GPL(user_buffer_size);
 118
 119 static int do_microcode_update(void)
 120 {
 121         long cursor = 0;
 122         int error = 0;
 123         void *new_mc = NULL;
 124         int cpu;
 125         cpumask_t old;
 126
 127         old = current->cpus_allowed;
 128
 129         while ((cursor = microcode_ops->get_next_ucode(&new_mc, cursor)) > 0) {
 130                 if (microcode_ops->microcode_sanity_check != NULL)
 131                         error = microcode_ops->microcode_sanity_check(new_mc);
 132                 if (error)
 133                         goto out;
 134                 /*
 135                  * It's possible the data file has multiple matching ucode,
 136                  * lets keep searching till the latest version
 137                  */
 138                 for_each_online_cpu(cpu) {
 139                         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 140
 141                         if (!uci->valid)
 142                                 continue;
 143                         set_cpus_allowed_ptr(current, &cpumask_of_cpu(cpu));
 144                         error = microcode_ops->get_matching_microcode(new_mc,
 145                                                                       cpu);
 146                         if (error < 0)
 147                                 goto out;
 148                         if (error == 1)
 149                                 microcode_ops->apply_microcode(cpu);
 150                 }
 151                 vfree(new_mc);
 152         }
 153 out:
 154         if (cursor > 0)
 155                 vfree(new_mc);
 156         if (cursor < 0)
 157                 error = cursor;
 158         set_cpus_allowed_ptr(current, &old);
 159         return error;
 160 }
 161
 162 static int microcode_open(struct inode *unused1, struct file *unused2)
 163 {
 164         cycle_kernel_lock();
 165         return capable(CAP_SYS_RAWIO) ? 0 : -EPERM;
 166 }
 167
 168 static ssize_t microcode_write(struct file *file, const char __user *buf,
 169                                size_t len, loff_t *ppos)
 170 {
 171         ssize_t ret;
 172
 173         if ((len >> PAGE_SHIFT) > num_physpages) {
 174                 printk(KERN_ERR "microcode: too much data (max %ld pages)\n",
 175                        num_physpages);
 176                 return -EINVAL;
 177         }
 178
 179         get_online_cpus();
 180         mutex_lock(&microcode_mutex);
 181
 182         user_buffer = (void __user *) buf;
 183         user_buffer_size = (int) len;
 184
 185         ret = do_microcode_update();
 186         if (!ret)
 187                 ret = (ssize_t)len;
 188
 189         mutex_unlock(&microcode_mutex);
 190         put_online_cpus();
 191
 192         return ret;
 193 }
 194
 195 static const struct file_operations microcode_fops = {
 196         .owner          = THIS_MODULE,
 197         .write          = microcode_write,
 198         .open           = microcode_open,
 199 };
 200
 201 static struct miscdevice microcode_dev = {
 202         .minor          = MICROCODE_MINOR,
 203         .name           = "microcode",
 204         .fops           = &microcode_fops,
 205 };
 206
 207 static int __init microcode_dev_init(void)
 208 {
 209         int error;
 210
 211         error = misc_register(&microcode_dev);
 212         if (error) {
 213                 printk(KERN_ERR
 214                         "microcode: can't misc_register on minor=%d\n",
 215                         MICROCODE_MINOR);
 216                 return error;
 217         }
 218
 219         return 0;
 220 }
 221
 222 static void microcode_dev_exit(void)
 223 {
 224         misc_deregister(&microcode_dev);
 225 }
 226
 227 MODULE_ALIAS_MISCDEV(MICROCODE_MINOR);
 228 #else
 229 #define microcode_dev_init() 0
 230 #define microcode_dev_exit() do { } while (0)
 231 #endif
 232
 233 /* fake device for request_firmware */
 234 struct platform_device *microcode_pdev;
 235 EXPORT_SYMBOL_GPL(microcode_pdev);
 236
 237 static void microcode_init_cpu(int cpu, int resume)
 238 {
 239         cpumask_t old;
 240         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 241
 242         old = current->cpus_allowed;
 243
 244         set_cpus_allowed_ptr(current, &cpumask_of_cpu(cpu));
 245         mutex_lock(&microcode_mutex);
 246         microcode_ops->collect_cpu_info(cpu);
 247         if (uci->valid && system_state == SYSTEM_RUNNING && !resume)
 248                 microcode_ops->cpu_request_microcode(cpu);
 249         mutex_unlock(&microcode_mutex);
 250         set_cpus_allowed_ptr(current, &old);
 251 }
 252
 253 static ssize_t reload_store(struct sys_device *dev,
 254                             struct sysdev_attribute *attr,
 255                             const char *buf, size_t sz)
 256 {
 257         struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
 258         char *end;
 259         unsigned long val = simple_strtoul(buf, &end, 0);
 260         int err = 0;
 261         int cpu = dev->id;
 262
 263         if (end == buf)
 264                 return -EINVAL;
 265         if (val == 1) {
 266                 cpumask_t old = current->cpus_allowed;
 267
 268                 get_online_cpus();
 269                 set_cpus_allowed_ptr(current, &cpumask_of_cpu(cpu));
 270
 271                 mutex_lock(&microcode_mutex);
 272                 if (uci->valid)
 273                         err = microcode_ops->cpu_request_microcode(cpu);
 274                 mutex_unlock(&microcode_mutex);
 275                 put_online_cpus();
 276                 set_cpus_allowed_ptr(current, &old);
 277         }
 278         if (err)
 279                 return err;
 280         return sz;
 281 }
 282
 283 static ssize_t version_show(struct sys_device *dev,
 284                         struct sysdev_attribute *attr, char *buf)
 285 {
 286         struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
 287
 288         return sprintf(buf, "0x%x\n", uci->rev);
 289 }
 290
 291 static ssize_t pf_show(struct sys_device *dev,
 292                         struct sysdev_attribute *attr, char *buf)
 293 {
 294         struct ucode_cpu_info *uci = ucode_cpu_info + dev->id;
 295
 296         return sprintf(buf, "0x%x\n", uci->pf);
 297 }
 298
 299 static SYSDEV_ATTR(reload, 0200, NULL, reload_store);
 300 static SYSDEV_ATTR(version, 0400, version_show, NULL);
 301 static SYSDEV_ATTR(processor_flags, 0400, pf_show, NULL);
 302
 303 static struct attribute *mc_default_attrs[] = {
 304         &attr_reload.attr,
 305         &attr_version.attr,
 306         &attr_processor_flags.attr,
 307         NULL
 308 };
 309
 310 static struct attribute_group mc_attr_group = {
 311         .attrs = mc_default_attrs,
 312         .name = "microcode",
 313 };
 314
 315 static int __mc_sysdev_add(struct sys_device *sys_dev, int resume)
 316 {
 317         int err, cpu = sys_dev->id;
 318         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 319
 320         if (!cpu_online(cpu))
 321                 return 0;
 322
 323         pr_debug("microcode: CPU%d added\n", cpu);
 324         memset(uci, 0, sizeof(*uci));
 325
 326         err = sysfs_create_group(&sys_dev->kobj, &mc_attr_group);
 327         if (err)
 328                 return err;
 329
 330         microcode_init_cpu(cpu, resume);
 331
 332         return 0;
 333 }
 334
 335 static int mc_sysdev_add(struct sys_device *sys_dev)
 336 {
 337         return __mc_sysdev_add(sys_dev, 0);
 338 }
 339
 340 static int mc_sysdev_remove(struct sys_device *sys_dev)
 341 {
 342         int cpu = sys_dev->id;
 343
 344         if (!cpu_online(cpu))
 345                 return 0;
 346
 347         pr_debug("microcode: CPU%d removed\n", cpu);
 348         microcode_ops->microcode_fini_cpu(cpu);
 349         sysfs_remove_group(&sys_dev->kobj, &mc_attr_group);
 350         return 0;
 351 }
 352
 353 static int mc_sysdev_resume(struct sys_device *dev)
 354 {
 355         int cpu = dev->id;
 356
 357         if (!cpu_online(cpu))
 358                 return 0;
 359         pr_debug("microcode: CPU%d resumed\n", cpu);
 360         /* only CPU 0 will apply ucode here */
 361         microcode_ops->apply_microcode(0);
 362         return 0;
 363 }
 364
 365 static struct sysdev_driver mc_sysdev_driver = {
 366         .add = mc_sysdev_add,
 367         .remove = mc_sysdev_remove,
 368         .resume = mc_sysdev_resume,
 369 };
 370
 371 static __cpuinit int
 372 mc_cpu_callback(struct notifier_block *nb, unsigned long action, void *hcpu)
 373 {
 374         unsigned int cpu = (unsigned long)hcpu;
 375         struct sys_device *sys_dev;
 376
 377         sys_dev = get_cpu_sysdev(cpu);
 378         switch (action) {
 379         case CPU_UP_CANCELED_FROZEN:
 380                 /* The CPU refused to come up during a system resume */
 381                 microcode_ops->microcode_fini_cpu(cpu);
 382                 break;
 383         case CPU_ONLINE:
 384         case CPU_DOWN_FAILED:
 385                 mc_sysdev_add(sys_dev);
 386                 break;
 387         case CPU_ONLINE_FROZEN:
 388                 /* System-wide resume is in progress, try to apply microcode */
 389                 if (microcode_ops->apply_microcode_check_cpu(cpu)) {
 390                         /* The application of microcode failed */
 391                         microcode_ops->microcode_fini_cpu(cpu);
 392                         __mc_sysdev_add(sys_dev, 1);
 393                         break;
 394                 }
 395         case CPU_DOWN_FAILED_FROZEN:
 396                 if (sysfs_create_group(&sys_dev->kobj, &mc_attr_group))
 397                         printk(KERN_ERR "microcode: Failed to create the sysfs "
 398                                 "group for CPU%d\n", cpu);
 399                 break;
 400         case CPU_DOWN_PREPARE:
 401                 mc_sysdev_remove(sys_dev);
 402                 break;
 403         case CPU_DOWN_PREPARE_FROZEN:
 404                 /* Suspend is in progress, only remove the interface */
 405                 sysfs_remove_group(&sys_dev->kobj, &mc_attr_group);
 406                 break;
 407         }
 408         return NOTIFY_OK;
 409 }
 410
 411 static struct notifier_block __refdata mc_cpu_notifier = {
 412         .notifier_call = mc_cpu_callback,
 413 };
 414
 415 int microcode_init(void *opaque, struct module *module)
 416 {
 417         struct microcode_ops *ops = (struct microcode_ops *)opaque;
 418         int error;
 419
 420         if (microcode_ops) {
 421                 printk(KERN_ERR "microcode: already loaded the other module\n");
 422                 return -EEXIST;
 423         }
 424
 425         microcode_ops = ops;
 426
 427         error = microcode_dev_init();
 428         if (error)
 429                 return error;
 430         microcode_pdev = platform_device_register_simple("microcode", -1,
 431                                                          NULL, 0);
 432         if (IS_ERR(microcode_pdev)) {
 433                 microcode_dev_exit();
 434                 return PTR_ERR(microcode_pdev);
 435         }
 436
 437         get_online_cpus();
 438         error = sysdev_driver_register(&cpu_sysdev_class, &mc_sysdev_driver);
 439         put_online_cpus();
 440         if (error) {
 441                 microcode_dev_exit();
 442                 platform_device_unregister(microcode_pdev);
 443                 return error;
 444         }
 445
 446         register_hotcpu_notifier(&mc_cpu_notifier);
 447
 448         printk(KERN_INFO
 449                "Microcode Update Driver: v" MICROCODE_VERSION
 450                " <tigran@aivazian.fsnet.co.uk>"
 451                " <peter.oruba@amd.com>\n");
 452
 453         return 0;
 454 }
 455 EXPORT_SYMBOL_GPL(microcode_init);
 456
 457 void __exit microcode_exit(void)
 458 {
 459         microcode_dev_exit();
 460
 461         unregister_hotcpu_notifier(&mc_cpu_notifier);
 462
 463         get_online_cpus();
 464         sysdev_driver_unregister(&cpu_sysdev_class, &mc_sysdev_driver);
 465         put_online_cpus();
 466
 467         platform_device_unregister(microcode_pdev);
 468
 469         microcode_ops = NULL;
 470
 471         printk(KERN_INFO
 472                "Microcode Update Driver: v" MICROCODE_VERSION " removed.\n");
 473 }
 474 EXPORT_SYMBOL_GPL(microcode_exit);