arch/x86/kernel/microcode_amd.c

   1 /*
   2  *  AMD CPU Microcode Update Driver for Linux
   3  *  Copyright (C) 2008 Advanced Micro Devices Inc.
   4  *
   5  *  Author: Peter Oruba <peter.oruba@amd.com>
   6  *
   7  *  Based on work by:
   8  *  Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
   9  *
  10  *  This driver allows to upgrade microcode on AMD
  11  *  family 0x10 and 0x11 processors.
  12  *
  13  *  Licensed under the terms of the GNU General Public
  14  *  License version 2. See file COPYING for details.
  15 */
  16
  17 #include <linux/capability.h>
  18 #include <linux/kernel.h>
  19 #include <linux/init.h>
  20 #include <linux/sched.h>
  21 #include <linux/cpumask.h>
  22 #include <linux/module.h>
  23 #include <linux/slab.h>
  24 #include <linux/vmalloc.h>
  25 #include <linux/miscdevice.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/mm.h>
  28 #include <linux/fs.h>
  29 #include <linux/mutex.h>
  30 #include <linux/cpu.h>
  31 #include <linux/firmware.h>
  32 #include <linux/platform_device.h>
  33 #include <linux/pci.h>
  34 #include <linux/pci_ids.h>
  35 #include <linux/uaccess.h>
  36
  37 #include <asm/msr.h>
  38 #include <asm/processor.h>
  39 #include <asm/microcode.h>
  40
  41 MODULE_DESCRIPTION("AMD Microcode Update Driver");
  42 MODULE_AUTHOR("Peter Oruba");
  43 MODULE_LICENSE("GPL v2");
  44
  45 #define UCODE_MAGIC                0x00414d44
  46 #define UCODE_EQUIV_CPU_TABLE_TYPE 0x00000000
  47 #define UCODE_UCODE_TYPE           0x00000001
  48
  49 struct equiv_cpu_entry {
  50         unsigned int installed_cpu;
  51         unsigned int fixed_errata_mask;
  52         unsigned int fixed_errata_compare;
  53         unsigned int equiv_cpu;
  54 };
  55
  56 struct microcode_header_amd {
  57         unsigned int  data_code;
  58         unsigned int  patch_id;
  59         unsigned char mc_patch_data_id[2];
  60         unsigned char mc_patch_data_len;
  61         unsigned char init_flag;
  62         unsigned int  mc_patch_data_checksum;
  63         unsigned int  nb_dev_id;
  64         unsigned int  sb_dev_id;
  65         u16 processor_rev_id;
  66         unsigned char nb_rev_id;
  67         unsigned char sb_rev_id;
  68         unsigned char bios_api_rev;
  69         unsigned char reserved1[3];
  70         unsigned int  match_reg[8];
  71 };
  72
  73 struct microcode_amd {
  74         struct microcode_header_amd hdr;
  75         unsigned int mpb[0];
  76 };
  77
  78 #define UCODE_MAX_SIZE          (2048)
  79 #define DEFAULT_UCODE_DATASIZE  (896)
  80 #define MC_HEADER_SIZE          (sizeof(struct microcode_header_amd))
  81 #define DEFAULT_UCODE_TOTALSIZE (DEFAULT_UCODE_DATASIZE + MC_HEADER_SIZE)
  82 #define DWSIZE                  (sizeof(u32))
  83 /* For now we support a fixed ucode total size only */
  84 #define get_totalsize(mc) \
  85         ((((struct microcode_amd *)mc)->hdr.mc_patch_data_len * 28) \
  86          + MC_HEADER_SIZE)
  87
  88 /* serialize access to the physical write */
  89 static DEFINE_SPINLOCK(microcode_update_lock);
  90
  91 static struct equiv_cpu_entry *equiv_cpu_table;
  92
  93 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
  94 {
  95         struct cpuinfo_x86 *c = &cpu_data(cpu);
  96         u32 dummy;
  97
  98         memset(csig, 0, sizeof(*csig));
  99
 100         if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
 101                 printk(KERN_ERR "microcode: CPU%d not a capable AMD processor\n",
 102                        cpu);
 103                 return -1;
 104         }
 105
 106         rdmsr(MSR_AMD64_PATCH_LEVEL, csig->rev, dummy);
 107
 108         printk(KERN_INFO "microcode: collect_cpu_info_amd : patch_id=0x%x\n",
 109                 csig->rev);
 110
 111         return 0;
 112 }
 113
 114 static int get_matching_microcode(int cpu, void *mc, int rev)
 115 {
 116         struct microcode_header_amd *mc_header = mc;
 117         struct pci_dev *nb_pci_dev, *sb_pci_dev;
 118         unsigned int current_cpu_id;
 119         unsigned int equiv_cpu_id = 0x00;
 120         unsigned int i = 0;
 121
 122         BUG_ON(equiv_cpu_table == NULL);
 123         current_cpu_id = cpuid_eax(0x00000001);
 124
 125         while (equiv_cpu_table[i].installed_cpu != 0) {
 126                 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
 127                         equiv_cpu_id = equiv_cpu_table[i].equiv_cpu & 0xffff;
 128                         break;
 129                 }
 130                 i++;
 131         }
 132
 133         if (!equiv_cpu_id) {
 134                 printk(KERN_ERR "microcode: CPU%d cpu_id "
 135                        "not found in equivalent cpu table\n", cpu);
 136                 return 0;
 137         }
 138
 139         if (mc_header->processor_rev_id != equiv_cpu_id) {
 140                 printk(KERN_ERR "microcode: CPU%d patch does not match "
 141                        "(processor_rev_id: %x, eqiv_cpu_id: %x)\n",
 142                        cpu, mc_header->processor_rev_id, equiv_cpu_id);
 143                 return 0;
 144         }
 145
 146         /* ucode may be northbridge specific */
 147         if (mc_header->nb_dev_id) {
 148                 nb_pci_dev = pci_get_device(PCI_VENDOR_ID_AMD,
 149                                             (mc_header->nb_dev_id & 0xff),
 150                                             NULL);
 151                 if ((!nb_pci_dev) ||
 152                     (mc_header->nb_rev_id != nb_pci_dev->revision)) {
 153                         printk(KERN_ERR "microcode: CPU%d NB mismatch\n", cpu);
 154                         pci_dev_put(nb_pci_dev);
 155                         return 0;
 156                 }
 157                 pci_dev_put(nb_pci_dev);
 158         }
 159
 160         /* ucode may be southbridge specific */
 161         if (mc_header->sb_dev_id) {
 162                 sb_pci_dev = pci_get_device(PCI_VENDOR_ID_AMD,
 163                                             (mc_header->sb_dev_id & 0xff),
 164                                             NULL);
 165                 if ((!sb_pci_dev) ||
 166                     (mc_header->sb_rev_id != sb_pci_dev->revision)) {
 167                         printk(KERN_ERR "microcode: CPU%d SB mismatch\n", cpu);
 168                         pci_dev_put(sb_pci_dev);
 169                         return 0;
 170                 }
 171                 pci_dev_put(sb_pci_dev);
 172         }
 173
 174         if (mc_header->patch_id <= rev)
 175                 return 0;
 176
 177         return 1;
 178 }
 179
 180 static void apply_microcode_amd(int cpu)
 181 {
 182         unsigned long flags;
 183         u32 rev, dummy;
 184         int cpu_num = raw_smp_processor_id();
 185         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 186         struct microcode_amd *mc_amd = uci->mc;
 187
 188         /* We should bind the task to the CPU */
 189         BUG_ON(cpu_num != cpu);
 190
 191         if (mc_amd == NULL)
 192                 return;
 193
 194         spin_lock_irqsave(&microcode_update_lock, flags);
 195         wrmsrl(MSR_AMD64_PATCH_LOADER, &mc_amd->hdr.data_code);
 196         /* get patch id after patching */
 197         rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
 198         spin_unlock_irqrestore(&microcode_update_lock, flags);
 199
 200         /* check current patch id and patch's id for match */
 201         if (rev != mc_amd->hdr.patch_id) {
 202                 printk(KERN_ERR "microcode: CPU%d update from revision "
 203                        "0x%x to 0x%x failed\n", cpu_num,
 204                        mc_amd->hdr.patch_id, rev);
 205                 return;
 206         }
 207
 208         printk(KERN_INFO "microcode: CPU%d updated from revision "
 209                "0x%x to 0x%x\n",
 210                cpu_num, uci->cpu_sig.rev, mc_amd->hdr.patch_id);
 211
 212         uci->cpu_sig.rev = rev;
 213 }
 214
 215 static int get_ucode_data(void *to, const u8 *from, size_t n)
 216 {
 217         memcpy(to, from, n);
 218         return 0;
 219 }
 220
 221 static void *get_next_ucode(const u8 *buf, unsigned int size,
 222                             unsigned int *mc_size)
 223 {
 224         unsigned int total_size;
 225 #define UCODE_CONTAINER_SECTION_HDR     8
 226         u8 section_hdr[UCODE_CONTAINER_SECTION_HDR];
 227         void *mc;
 228
 229         if (get_ucode_data(section_hdr, buf, UCODE_CONTAINER_SECTION_HDR))
 230                 return NULL;
 231
 232         if (section_hdr[0] != UCODE_UCODE_TYPE) {
 233                 printk(KERN_ERR "microcode: error! "
 234                        "Wrong microcode payload type field\n");
 235                 return NULL;
 236         }
 237
 238         total_size = (unsigned long) (section_hdr[4] + (section_hdr[5] << 8));
 239
 240         printk(KERN_INFO "microcode: size %u, total_size %u\n",
 241                 size, total_size);
 242
 243         if (total_size > size || total_size > UCODE_MAX_SIZE) {
 244                 printk(KERN_ERR "microcode: error! Bad data in microcode data file\n");
 245                 return NULL;
 246         }
 247
 248         mc = vmalloc(UCODE_MAX_SIZE);
 249         if (mc) {
 250                 memset(mc, 0, UCODE_MAX_SIZE);
 251                 if (get_ucode_data(mc, buf + UCODE_CONTAINER_SECTION_HDR,
 252                                    total_size)) {
 253                         vfree(mc);
 254                         mc = NULL;
 255                 } else
 256                         *mc_size = total_size + UCODE_CONTAINER_SECTION_HDR;
 257         }
 258 #undef UCODE_CONTAINER_SECTION_HDR
 259         return mc;
 260 }
 261
 262
 263 static int install_equiv_cpu_table(const u8 *buf)
 264 {
 265 #define UCODE_CONTAINER_HEADER_SIZE     12
 266         u8 *container_hdr[UCODE_CONTAINER_HEADER_SIZE];
 267         unsigned int *buf_pos = (unsigned int *)container_hdr;
 268         unsigned long size;
 269
 270         if (get_ucode_data(&container_hdr, buf, UCODE_CONTAINER_HEADER_SIZE))
 271                 return 0;
 272
 273         size = buf_pos[2];
 274
 275         if (buf_pos[1] != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
 276                 printk(KERN_ERR "microcode: error! "
 277                        "Wrong microcode equivalent cpu table\n");
 278                 return 0;
 279         }
 280
 281         equiv_cpu_table = (struct equiv_cpu_entry *) vmalloc(size);
 282         if (!equiv_cpu_table) {
 283                 printk(KERN_ERR "microcode: error, can't allocate memory for equiv CPU table\n");
 284                 return 0;
 285         }
 286
 287         buf += UCODE_CONTAINER_HEADER_SIZE;
 288         if (get_ucode_data(equiv_cpu_table, buf, size)) {
 289                 vfree(equiv_cpu_table);
 290                 return 0;
 291         }
 292
 293         return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
 294 #undef UCODE_CONTAINER_HEADER_SIZE
 295 }
 296
 297 static void free_equiv_cpu_table(void)
 298 {
 299         if (equiv_cpu_table) {
 300                 vfree(equiv_cpu_table);
 301                 equiv_cpu_table = NULL;
 302         }
 303 }
 304
 305 static int generic_load_microcode(int cpu, const u8 *data, size_t size)
 306 {
 307         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 308         const u8 *ucode_ptr = data;
 309         void *new_mc = NULL;
 310         void *mc;
 311         int new_rev = uci->cpu_sig.rev;
 312         unsigned int leftover;
 313         unsigned long offset;
 314
 315         offset = install_equiv_cpu_table(ucode_ptr);
 316         if (!offset) {
 317                 printk(KERN_ERR "microcode: installing equivalent cpu table failed\n");
 318                 return -EINVAL;
 319         }
 320
 321         ucode_ptr += offset;
 322         leftover = size - offset;
 323
 324         while (leftover) {
 325                 unsigned int uninitialized_var(mc_size);
 326                 struct microcode_header_amd *mc_header;
 327
 328                 mc = get_next_ucode(ucode_ptr, leftover, &mc_size);
 329                 if (!mc)
 330                         break;
 331
 332                 mc_header = (struct microcode_header_amd *)mc;
 333                 if (get_matching_microcode(cpu, mc, new_rev)) {
 334                         if (new_mc)
 335                                 vfree(new_mc);
 336                         new_rev = mc_header->patch_id;
 337                         new_mc  = mc;
 338                 } else
 339                         vfree(mc);
 340
 341                 ucode_ptr += mc_size;
 342                 leftover  -= mc_size;
 343         }
 344
 345         if (new_mc) {
 346                 if (!leftover) {
 347                         if (uci->mc)
 348                                 vfree(uci->mc);
 349                         uci->mc = new_mc;
 350                         pr_debug("microcode: CPU%d found a matching microcode "
 351                                  "update with version 0x%x (current=0x%x)\n",
 352                                  cpu, new_rev, uci->cpu_sig.rev);
 353                 } else
 354                         vfree(new_mc);
 355         }
 356
 357         free_equiv_cpu_table();
 358
 359         return (int)leftover;
 360 }
 361
 362 static int request_microcode_fw(int cpu, struct device *device)
 363 {
 364         const char *fw_name = "amd-ucode/microcode_amd.bin";
 365         const struct firmware *firmware;
 366         int ret;
 367
 368         /* We should bind the task to the CPU */
 369         BUG_ON(cpu != raw_smp_processor_id());
 370
 371         ret = request_firmware(&firmware, fw_name, device);
 372         if (ret) {
 373                 printk(KERN_ERR "microcode: ucode data file %s load failed\n",
 374                        fw_name);
 375                 return ret;
 376         }
 377
 378         ret = generic_load_microcode(cpu, firmware->data, firmware->size);
 379
 380         release_firmware(firmware);
 381
 382         return ret;
 383 }
 384
 385 static int request_microcode_user(int cpu, const void __user *buf, size_t size)
 386 {
 387         printk(KERN_WARNING "microcode: AMD microcode update via "
 388                "/dev/cpu/microcode is not supported\n");
 389         return -1;
 390 }
 391
 392 static void microcode_fini_cpu_amd(int cpu)
 393 {
 394         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 395
 396         vfree(uci->mc);
 397         uci->mc = NULL;
 398 }
 399
 400 static struct microcode_ops microcode_amd_ops = {
 401         .request_microcode_user           = request_microcode_user,
 402         .request_microcode_fw             = request_microcode_fw,
 403         .collect_cpu_info                 = collect_cpu_info_amd,
 404         .apply_microcode                  = apply_microcode_amd,
 405         .microcode_fini_cpu               = microcode_fini_cpu_amd,
 406 };
 407
 408 struct microcode_ops * __init init_amd_microcode(void)
 409 {
 410         return &microcode_amd_ops;
 411 }