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         u32     installed_cpu;
  51         u32     fixed_errata_mask;
  52         u32     fixed_errata_compare;
  53         u16     equiv_cpu;
  54         u16     res;
  55 } __attribute__((packed));
  56
  57 struct microcode_header_amd {
  58         u32     data_code;
  59         u32     patch_id;
  60         u16     mc_patch_data_id;
  61         u8      mc_patch_data_len;
  62         u8      init_flag;
  63         u32     mc_patch_data_checksum;
  64         u32     nb_dev_id;
  65         u32     sb_dev_id;
  66         u16     processor_rev_id;
  67         u8      nb_rev_id;
  68         u8      sb_rev_id;
  69         u8      bios_api_rev;
  70         u8      reserved1[3];
  71         u32     match_reg[8];
  72 } __attribute__((packed));
  73
  74 struct microcode_amd {
  75         struct microcode_header_amd hdr;
  76         unsigned int mpb[0];
  77 };
  78
  79 #define UCODE_MAX_SIZE                  2048
  80 #define UCODE_CONTAINER_SECTION_HDR     8
  81 #define UCODE_CONTAINER_HEADER_SIZE     12
  82
  83 /* serialize access to the physical write */
  84 static DEFINE_SPINLOCK(microcode_update_lock);
  85
  86 static struct equiv_cpu_entry *equiv_cpu_table;
  87
  88 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
  89 {
  90         struct cpuinfo_x86 *c = &cpu_data(cpu);
  91         u32 dummy;
  92
  93         memset(csig, 0, sizeof(*csig));
  94
  95         if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
  96                 printk(KERN_ERR "microcode: CPU%d not a capable AMD processor\n",
  97                        cpu);
  98                 return -1;
  99         }
 100
 101         rdmsr(MSR_AMD64_PATCH_LEVEL, csig->rev, dummy);
 102
 103         printk(KERN_INFO "microcode: collect_cpu_info_amd : patch_id=0x%x\n",
 104                 csig->rev);
 105
 106         return 0;
 107 }
 108
 109 static int get_matching_microcode(int cpu, void *mc, int rev)
 110 {
 111         struct microcode_header_amd *mc_header = mc;
 112         unsigned int current_cpu_id;
 113         u16 equiv_cpu_id = 0;
 114         unsigned int i = 0;
 115
 116         BUG_ON(equiv_cpu_table == NULL);
 117         current_cpu_id = cpuid_eax(0x00000001);
 118
 119         while (equiv_cpu_table[i].installed_cpu != 0) {
 120                 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
 121                         equiv_cpu_id = equiv_cpu_table[i].equiv_cpu;
 122                         break;
 123                 }
 124                 i++;
 125         }
 126
 127         if (!equiv_cpu_id) {
 128                 printk(KERN_ERR "microcode: CPU%d cpu_id "
 129                        "not found in equivalent cpu table\n", cpu);
 130                 return 0;
 131         }
 132
 133         if (mc_header->processor_rev_id != equiv_cpu_id) {
 134                 printk(KERN_ERR "microcode: CPU%d patch does not match "
 135                        "(processor_rev_id: %x, eqiv_cpu_id: %x)\n",
 136                        cpu, mc_header->processor_rev_id, equiv_cpu_id);
 137                 return 0;
 138         }
 139
 140         /* ucode might be chipset specific -- currently we don't support this */
 141         if (mc_header->nb_dev_id || mc_header->sb_dev_id) {
 142                 printk(KERN_WARNING "microcode: CPU%d loading of chipset "
 143                        "specific code not yet supported\n", cpu);
 144                 return 0;
 145         }
 146
 147         if (mc_header->patch_id <= rev)
 148                 return 0;
 149
 150         return 1;
 151 }
 152
 153 static void apply_microcode_amd(int cpu)
 154 {
 155         unsigned long flags;
 156         u32 rev, dummy;
 157         int cpu_num = raw_smp_processor_id();
 158         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 159         struct microcode_amd *mc_amd = uci->mc;
 160
 161         /* We should bind the task to the CPU */
 162         BUG_ON(cpu_num != cpu);
 163
 164         if (mc_amd == NULL)
 165                 return;
 166
 167         spin_lock_irqsave(&microcode_update_lock, flags);
 168         wrmsrl(MSR_AMD64_PATCH_LOADER, &mc_amd->hdr.data_code);
 169         /* get patch id after patching */
 170         rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
 171         spin_unlock_irqrestore(&microcode_update_lock, flags);
 172
 173         /* check current patch id and patch's id for match */
 174         if (rev != mc_amd->hdr.patch_id) {
 175                 printk(KERN_ERR "microcode: CPU%d update from revision "
 176                        "0x%x to 0x%x failed\n", cpu_num,
 177                        mc_amd->hdr.patch_id, rev);
 178                 return;
 179         }
 180
 181         printk(KERN_INFO "microcode: CPU%d updated from revision "
 182                "0x%x to 0x%x\n",
 183                cpu_num, uci->cpu_sig.rev, mc_amd->hdr.patch_id);
 184
 185         uci->cpu_sig.rev = rev;
 186 }
 187
 188 static int get_ucode_data(void *to, const u8 *from, size_t n)
 189 {
 190         memcpy(to, from, n);
 191         return 0;
 192 }
 193
 194 static void *get_next_ucode(const u8 *buf, unsigned int size,
 195                             unsigned int *mc_size)
 196 {
 197         unsigned int total_size;
 198         u8 section_hdr[UCODE_CONTAINER_SECTION_HDR];
 199         void *mc;
 200
 201         if (get_ucode_data(section_hdr, buf, UCODE_CONTAINER_SECTION_HDR))
 202                 return NULL;
 203
 204         if (section_hdr[0] != UCODE_UCODE_TYPE) {
 205                 printk(KERN_ERR "microcode: error! "
 206                        "Wrong microcode payload type field\n");
 207                 return NULL;
 208         }
 209
 210         total_size = (unsigned long) (section_hdr[4] + (section_hdr[5] << 8));
 211
 212         printk(KERN_INFO "microcode: size %u, total_size %u\n",
 213                 size, total_size);
 214
 215         if (total_size > size || total_size > UCODE_MAX_SIZE) {
 216                 printk(KERN_ERR "microcode: error! Bad data in microcode data file\n");
 217                 return NULL;
 218         }
 219
 220         mc = vmalloc(UCODE_MAX_SIZE);
 221         if (mc) {
 222                 memset(mc, 0, UCODE_MAX_SIZE);
 223                 if (get_ucode_data(mc, buf + UCODE_CONTAINER_SECTION_HDR,
 224                                    total_size)) {
 225                         vfree(mc);
 226                         mc = NULL;
 227                 } else
 228                         *mc_size = total_size + UCODE_CONTAINER_SECTION_HDR;
 229         }
 230         return mc;
 231 }
 232
 233
 234 static int install_equiv_cpu_table(const u8 *buf)
 235 {
 236         u8 *container_hdr[UCODE_CONTAINER_HEADER_SIZE];
 237         unsigned int *buf_pos = (unsigned int *)container_hdr;
 238         unsigned long size;
 239
 240         if (get_ucode_data(&container_hdr, buf, UCODE_CONTAINER_HEADER_SIZE))
 241                 return 0;
 242
 243         size = buf_pos[2];
 244
 245         if (buf_pos[1] != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
 246                 printk(KERN_ERR "microcode: error! "
 247                        "Wrong microcode equivalent cpu table\n");
 248                 return 0;
 249         }
 250
 251         equiv_cpu_table = (struct equiv_cpu_entry *) vmalloc(size);
 252         if (!equiv_cpu_table) {
 253                 printk(KERN_ERR "microcode: error, can't allocate memory for equiv CPU table\n");
 254                 return 0;
 255         }
 256
 257         buf += UCODE_CONTAINER_HEADER_SIZE;
 258         if (get_ucode_data(equiv_cpu_table, buf, size)) {
 259                 vfree(equiv_cpu_table);
 260                 return 0;
 261         }
 262
 263         return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
 264 }
 265
 266 static void free_equiv_cpu_table(void)
 267 {
 268         if (equiv_cpu_table) {
 269                 vfree(equiv_cpu_table);
 270                 equiv_cpu_table = NULL;
 271         }
 272 }
 273
 274 static int generic_load_microcode(int cpu, const u8 *data, size_t size)
 275 {
 276         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 277         const u8 *ucode_ptr = data;
 278         void *new_mc = NULL;
 279         void *mc;
 280         int new_rev = uci->cpu_sig.rev;
 281         unsigned int leftover;
 282         unsigned long offset;
 283
 284         offset = install_equiv_cpu_table(ucode_ptr);
 285         if (!offset) {
 286                 printk(KERN_ERR "microcode: installing equivalent cpu table failed\n");
 287                 return -EINVAL;
 288         }
 289
 290         ucode_ptr += offset;
 291         leftover = size - offset;
 292
 293         while (leftover) {
 294                 unsigned int uninitialized_var(mc_size);
 295                 struct microcode_header_amd *mc_header;
 296
 297                 mc = get_next_ucode(ucode_ptr, leftover, &mc_size);
 298                 if (!mc)
 299                         break;
 300
 301                 mc_header = (struct microcode_header_amd *)mc;
 302                 if (get_matching_microcode(cpu, mc, new_rev)) {
 303                         if (new_mc)
 304                                 vfree(new_mc);
 305                         new_rev = mc_header->patch_id;
 306                         new_mc  = mc;
 307                 } else
 308                         vfree(mc);
 309
 310                 ucode_ptr += mc_size;
 311                 leftover  -= mc_size;
 312         }
 313
 314         if (new_mc) {
 315                 if (!leftover) {
 316                         if (uci->mc)
 317                                 vfree(uci->mc);
 318                         uci->mc = new_mc;
 319                         pr_debug("microcode: CPU%d found a matching microcode "
 320                                  "update with version 0x%x (current=0x%x)\n",
 321                                  cpu, new_rev, uci->cpu_sig.rev);
 322                 } else
 323                         vfree(new_mc);
 324         }
 325
 326         free_equiv_cpu_table();
 327
 328         return (int)leftover;
 329 }
 330
 331 static int request_microcode_fw(int cpu, struct device *device)
 332 {
 333         const char *fw_name = "amd-ucode/microcode_amd.bin";
 334         const struct firmware *firmware;
 335         int ret;
 336
 337         /* We should bind the task to the CPU */
 338         BUG_ON(cpu != raw_smp_processor_id());
 339
 340         ret = request_firmware(&firmware, fw_name, device);
 341         if (ret) {
 342                 printk(KERN_ERR "microcode: ucode data file %s load failed\n",
 343                        fw_name);
 344                 return ret;
 345         }
 346
 347         ret = generic_load_microcode(cpu, firmware->data, firmware->size);
 348
 349         release_firmware(firmware);
 350
 351         return ret;
 352 }
 353
 354 static int request_microcode_user(int cpu, const void __user *buf, size_t size)
 355 {
 356         printk(KERN_WARNING "microcode: AMD microcode update via "
 357                "/dev/cpu/microcode is not supported\n");
 358         return -1;
 359 }
 360
 361 static void microcode_fini_cpu_amd(int cpu)
 362 {
 363         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 364
 365         vfree(uci->mc);
 366         uci->mc = NULL;
 367 }
 368
 369 static struct microcode_ops microcode_amd_ops = {
 370         .request_microcode_user           = request_microcode_user,
 371         .request_microcode_fw             = request_microcode_fw,
 372         .collect_cpu_info                 = collect_cpu_info_amd,
 373         .apply_microcode                  = apply_microcode_amd,
 374         .microcode_fini_cpu               = microcode_fini_cpu_amd,
 375 };
 376
 377 struct microcode_ops * __init init_amd_microcode(void)
 378 {
 379         return &microcode_amd_ops;
 380 }