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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  18
  19 #include <linux/firmware.h>
  20 #include <linux/pci_ids.h>
  21 #include <linux/uaccess.h>
  22 #include <linux/vmalloc.h>
  23 #include <linux/kernel.h>
  24 #include <linux/module.h>
  25 #include <linux/pci.h>
  26
  27 #include <asm/microcode.h>
  28 #include <asm/processor.h>
  29 #include <asm/msr.h>
  30
  31 MODULE_DESCRIPTION("AMD Microcode Update Driver");
  32 MODULE_AUTHOR("Peter Oruba");
  33 MODULE_LICENSE("GPL v2");
  34
  35 #define UCODE_MAGIC                0x00414d44
  36 #define UCODE_EQUIV_CPU_TABLE_TYPE 0x00000000
  37 #define UCODE_UCODE_TYPE           0x00000001
  38
  39 struct equiv_cpu_entry {
  40         u32     installed_cpu;
  41         u32     fixed_errata_mask;
  42         u32     fixed_errata_compare;
  43         u16     equiv_cpu;
  44         u16     res;
  45 } __attribute__((packed));
  46
  47 struct microcode_header_amd {
  48         u32     data_code;
  49         u32     patch_id;
  50         u16     mc_patch_data_id;
  51         u8      mc_patch_data_len;
  52         u8      init_flag;
  53         u32     mc_patch_data_checksum;
  54         u32     nb_dev_id;
  55         u32     sb_dev_id;
  56         u16     processor_rev_id;
  57         u8      nb_rev_id;
  58         u8      sb_rev_id;
  59         u8      bios_api_rev;
  60         u8      reserved1[3];
  61         u32     match_reg[8];
  62 } __attribute__((packed));
  63
  64 struct microcode_amd {
  65         struct microcode_header_amd     hdr;
  66         unsigned int                    mpb[0];
  67 };
  68
  69 #define SECTION_HDR_SIZE        8
  70 #define CONTAINER_HDR_SZ        12
  71
  72 static struct equiv_cpu_entry *equiv_cpu_table;
  73
  74 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
  75 {
  76         struct cpuinfo_x86 *c = &cpu_data(cpu);
  77
  78         if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
  79                 pr_warning("CPU%d: family %d not supported\n", cpu, c->x86);
  80                 return -1;
  81         }
  82
  83         csig->rev = c->microcode;
  84         pr_info("CPU%d: patch_level=0x%08x\n", cpu, csig->rev);
  85
  86         return 0;
  87 }
  88
  89 static int get_matching_microcode(int cpu, struct microcode_header_amd *mc_hdr,
  90                                   int rev)
  91 {
  92         unsigned int current_cpu_id;
  93         u16 equiv_cpu_id = 0;
  94         unsigned int i = 0;
  95
  96         BUG_ON(equiv_cpu_table == NULL);
  97         current_cpu_id = cpuid_eax(0x00000001);
  98
  99         while (equiv_cpu_table[i].installed_cpu != 0) {
 100                 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
 101                         equiv_cpu_id = equiv_cpu_table[i].equiv_cpu;
 102                         break;
 103                 }
 104                 i++;
 105         }
 106
 107         if (!equiv_cpu_id)
 108                 return 0;
 109
 110         if (mc_hdr->processor_rev_id != equiv_cpu_id)
 111                 return 0;
 112
 113         /* ucode might be chipset specific -- currently we don't support this */
 114         if (mc_hdr->nb_dev_id || mc_hdr->sb_dev_id) {
 115                 pr_err("CPU%d: chipset specific code not yet supported\n",
 116                        cpu);
 117                 return 0;
 118         }
 119
 120         if (mc_hdr->patch_id <= rev)
 121                 return 0;
 122
 123         return 1;
 124 }
 125
 126 static int apply_microcode_amd(int cpu)
 127 {
 128         u32 rev, dummy;
 129         int cpu_num = raw_smp_processor_id();
 130         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 131         struct microcode_amd *mc_amd = uci->mc;
 132         struct cpuinfo_x86 *c = &cpu_data(cpu);
 133
 134         /* We should bind the task to the CPU */
 135         BUG_ON(cpu_num != cpu);
 136
 137         if (mc_amd == NULL)
 138                 return 0;
 139
 140         wrmsrl(MSR_AMD64_PATCH_LOADER, (u64)(long)&mc_amd->hdr.data_code);
 141         /* get patch id after patching */
 142         rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
 143
 144         /* check current patch id and patch's id for match */
 145         if (rev != mc_amd->hdr.patch_id) {
 146                 pr_err("CPU%d: update failed for patch_level=0x%08x\n",
 147                        cpu, mc_amd->hdr.patch_id);
 148                 return -1;
 149         }
 150
 151         pr_info("CPU%d: new patch_level=0x%08x\n", cpu, rev);
 152         uci->cpu_sig.rev = rev;
 153         c->microcode = rev;
 154
 155         return 0;
 156 }
 157
 158 static unsigned int verify_ucode_size(int cpu, const u8 *buf, unsigned int size)
 159 {
 160         struct cpuinfo_x86 *c = &cpu_data(cpu);
 161         u32 max_size, actual_size;
 162
 163 #define F1XH_MPB_MAX_SIZE 2048
 164 #define F14H_MPB_MAX_SIZE 1824
 165 #define F15H_MPB_MAX_SIZE 4096
 166 #define F16H_MPB_MAX_SIZE 3458
 167
 168         switch (c->x86) {
 169         case 0x14:
 170                 max_size = F14H_MPB_MAX_SIZE;
 171                 break;
 172         case 0x15:
 173                 max_size = F15H_MPB_MAX_SIZE;
 174                 break;
 175         case 0x16:
 176                 max_size = F16H_MPB_MAX_SIZE;
 177                 break;
 178         default:
 179                 max_size = F1XH_MPB_MAX_SIZE;
 180                 break;
 181         }
 182
 183         actual_size = *(u32 *)(buf + 4);
 184
 185         if (actual_size + SECTION_HDR_SIZE > size || actual_size > max_size) {
 186                 pr_err("section size mismatch\n");
 187                 return 0;
 188         }
 189
 190         return actual_size;
 191 }
 192
 193 static struct microcode_header_amd *
 194 get_next_ucode(int cpu, const u8 *buf, unsigned int size, unsigned int *mc_size)
 195 {
 196         struct microcode_header_amd *mc = NULL;
 197         unsigned int actual_size = 0;
 198
 199         if (*(u32 *)buf != UCODE_UCODE_TYPE) {
 200                 pr_err("invalid type field in container file section header\n");
 201                 goto out;
 202         }
 203
 204         actual_size = verify_ucode_size(cpu, buf, size);
 205         if (!actual_size)
 206                 goto out;
 207
 208         mc = vzalloc(actual_size);
 209         if (!mc)
 210                 goto out;
 211
 212         get_ucode_data(mc, buf + SECTION_HDR_SIZE, actual_size);
 213         *mc_size = actual_size + SECTION_HDR_SIZE;
 214
 215 out:
 216         return mc;
 217 }
 218
 219 static int install_equiv_cpu_table(const u8 *buf)
 220 {
 221         unsigned int *ibuf = (unsigned int *)buf;
 222         unsigned int type = ibuf[1];
 223         unsigned int size = ibuf[2];
 224
 225         if (type != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
 226                 pr_err("empty section/"
 227                        "invalid type field in container file section header\n");
 228                 return -EINVAL;
 229         }
 230
 231         equiv_cpu_table = vmalloc(size);
 232         if (!equiv_cpu_table) {
 233                 pr_err("failed to allocate equivalent CPU table\n");
 234                 return -ENOMEM;
 235         }
 236
 237         get_ucode_data(equiv_cpu_table, buf + CONTAINER_HDR_SZ, size);
 238
 239         /* add header length */
 240         return size + CONTAINER_HDR_SZ;
 241 }
 242
 243 static void free_equiv_cpu_table(void)
 244 {
 245         vfree(equiv_cpu_table);
 246         equiv_cpu_table = NULL;
 247 }
 248
 249 static enum ucode_state
 250 generic_load_microcode(int cpu, const u8 *data, size_t size)
 251 {
 252         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 253         struct microcode_header_amd *mc_hdr = NULL;
 254         unsigned int mc_size, leftover;
 255         int offset;
 256         const u8 *ucode_ptr = data;
 257         void *new_mc = NULL;
 258         unsigned int new_rev = uci->cpu_sig.rev;
 259         enum ucode_state state = UCODE_OK;
 260
 261         offset = install_equiv_cpu_table(ucode_ptr);
 262         if (offset < 0) {
 263                 pr_err("failed to create equivalent cpu table\n");
 264                 return UCODE_ERROR;
 265         }
 266
 267         ucode_ptr += offset;
 268         leftover = size - offset;
 269
 270         while (leftover) {
 271                 mc_hdr = get_next_ucode(cpu, ucode_ptr, leftover, &mc_size);
 272                 if (!mc_hdr)
 273                         break;
 274
 275                 if (get_matching_microcode(cpu, mc_hdr, new_rev)) {
 276                         vfree(new_mc);
 277                         new_rev = mc_hdr->patch_id;
 278                         new_mc  = mc_hdr;
 279                 } else
 280                         vfree(mc_hdr);
 281
 282                 ucode_ptr += mc_size;
 283                 leftover  -= mc_size;
 284         }
 285
 286         if (!new_mc) {
 287                 state = UCODE_NFOUND;
 288                 goto free_table;
 289         }
 290
 291         if (!leftover) {
 292                 vfree(uci->mc);
 293                 uci->mc = new_mc;
 294                 pr_debug("CPU%d update ucode (0x%08x -> 0x%08x)\n",
 295                          cpu, uci->cpu_sig.rev, new_rev);
 296         } else {
 297                 vfree(new_mc);
 298                 state = UCODE_ERROR;
 299         }
 300
 301 free_table:
 302         free_equiv_cpu_table();
 303
 304         return state;
 305 }
 306
 307 /*
 308  * AMD microcode firmware naming convention, up to family 15h they are in
 309  * the legacy file:
 310  *
 311  *    amd-ucode/microcode_amd.bin
 312  *
 313  * This legacy file is always smaller than 2K in size.
 314  *
 315  * Starting at family 15h they are in family specific firmware files:
 316  *
 317  *    amd-ucode/microcode_amd_fam15h.bin
 318  *    amd-ucode/microcode_amd_fam16h.bin
 319  *    ...
 320  *
 321  * These might be larger than 2K.
 322  */
 323 static enum ucode_state request_microcode_amd(int cpu, struct device *device)
 324 {
 325         char fw_name[36] = "amd-ucode/microcode_amd.bin";
 326         const struct firmware *fw;
 327         enum ucode_state ret = UCODE_NFOUND;
 328         struct cpuinfo_x86 *c = &cpu_data(cpu);
 329
 330         if (c->x86 >= 0x15)
 331                 snprintf(fw_name, sizeof(fw_name), "amd-ucode/microcode_amd_fam%.2xh.bin", c->x86);
 332
 333         if (request_firmware(&fw, (const char *)fw_name, device)) {
 334                 pr_err("failed to load file %s\n", fw_name);
 335                 goto out;
 336         }
 337
 338         ret = UCODE_ERROR;
 339         if (*(u32 *)fw->data != UCODE_MAGIC) {
 340                 pr_err("invalid magic value (0x%08x)\n", *(u32 *)fw->data);
 341                 goto fw_release;
 342         }
 343
 344         ret = generic_load_microcode(cpu, fw->data, fw->size);
 345
 346 fw_release:
 347         release_firmware(fw);
 348
 349 out:
 350         return ret;
 351 }
 352
 353 static enum ucode_state
 354 request_microcode_user(int cpu, const void __user *buf, size_t size)
 355 {
 356         pr_info("AMD microcode update via /dev/cpu/microcode not supported\n");
 357         return UCODE_ERROR;
 358 }
 359
 360 static void microcode_fini_cpu_amd(int cpu)
 361 {
 362         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 363
 364         vfree(uci->mc);
 365         uci->mc = NULL;
 366 }
 367
 368 static struct microcode_ops microcode_amd_ops = {
 369         .request_microcode_user           = request_microcode_user,
 370         .request_microcode_fw             = request_microcode_amd,
 371         .collect_cpu_info                 = collect_cpu_info_amd,
 372         .apply_microcode                  = apply_microcode_amd,
 373         .microcode_fini_cpu               = microcode_fini_cpu_amd,
 374 };
 375
 376 struct microcode_ops * __init init_amd_microcode(void)
 377 {
 378         return &microcode_amd_ops;
 379 }