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 UCODE_CONTAINER_SECTION_HDR     8
  70 #define UCODE_CONTAINER_HEADER_SIZE     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         u32 dummy;
  78
  79         if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
  80                 pr_warning("CPU%d: family %d not supported\n", cpu, c->x86);
  81                 return -1;
  82         }
  83
  84         rdmsr(MSR_AMD64_PATCH_LEVEL, csig->rev, dummy);
  85         pr_info("CPU%d: patch_level=0x%08x\n", cpu, csig->rev);
  86
  87         return 0;
  88 }
  89
  90 static int get_matching_microcode(int cpu, struct microcode_header_amd *mc_hdr,
  91                                   int rev)
  92 {
  93         unsigned int current_cpu_id;
  94         u16 equiv_cpu_id = 0;
  95         unsigned int i = 0;
  96
  97         BUG_ON(equiv_cpu_table == NULL);
  98         current_cpu_id = cpuid_eax(0x00000001);
  99
 100         while (equiv_cpu_table[i].installed_cpu != 0) {
 101                 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
 102                         equiv_cpu_id = equiv_cpu_table[i].equiv_cpu;
 103                         break;
 104                 }
 105                 i++;
 106         }
 107
 108         if (!equiv_cpu_id)
 109                 return 0;
 110
 111         if (mc_hdr->processor_rev_id != equiv_cpu_id)
 112                 return 0;
 113
 114         /* ucode might be chipset specific -- currently we don't support this */
 115         if (mc_hdr->nb_dev_id || mc_hdr->sb_dev_id) {
 116                 pr_err("CPU%d: chipset specific code not yet supported\n",
 117                        cpu);
 118                 return 0;
 119         }
 120
 121         if (mc_hdr->patch_id <= rev)
 122                 return 0;
 123
 124         return 1;
 125 }
 126
 127 static int apply_microcode_amd(int cpu)
 128 {
 129         u32 rev, dummy;
 130         int cpu_num = raw_smp_processor_id();
 131         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 132         struct microcode_amd *mc_amd = uci->mc;
 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
 154         return 0;
 155 }
 156
 157 static unsigned int verify_ucode_size(int cpu, const u8 *buf, unsigned int size)
 158 {
 159         struct cpuinfo_x86 *c = &cpu_data(cpu);
 160         unsigned int max_size, actual_size;
 161
 162 #define F1XH_MPB_MAX_SIZE 2048
 163 #define F14H_MPB_MAX_SIZE 1824
 164 #define F15H_MPB_MAX_SIZE 4096
 165 #define F16H_MPB_MAX_SIZE 3458
 166
 167         switch (c->x86) {
 168         case 0x14:
 169                 max_size = F14H_MPB_MAX_SIZE;
 170                 break;
 171         case 0x15:
 172                 max_size = F15H_MPB_MAX_SIZE;
 173                 break;
 174         case 0x16:
 175                 max_size = F16H_MPB_MAX_SIZE;
 176                 break;
 177         default:
 178                 max_size = F1XH_MPB_MAX_SIZE;
 179                 break;
 180         }
 181
 182         actual_size = buf[4] + (buf[5] << 8);
 183
 184         if (actual_size > size || actual_size > max_size) {
 185                 pr_err("section size mismatch\n");
 186                 return 0;
 187         }
 188
 189         return actual_size;
 190 }
 191
 192 static struct microcode_header_amd *
 193 get_next_ucode(int cpu, const u8 *buf, unsigned int size, unsigned int *mc_size)
 194 {
 195         struct microcode_header_amd *mc = NULL;
 196         unsigned int actual_size = 0;
 197
 198         if (buf[0] != UCODE_UCODE_TYPE) {
 199                 pr_err("invalid type field in container file section header\n");
 200                 goto out;
 201         }
 202
 203         actual_size = verify_ucode_size(cpu, buf, size);
 204         if (!actual_size)
 205                 goto out;
 206
 207         mc = vzalloc(actual_size);
 208         if (!mc)
 209                 goto out;
 210
 211         get_ucode_data(mc, buf + UCODE_CONTAINER_SECTION_HDR, actual_size);
 212         *mc_size = actual_size + UCODE_CONTAINER_SECTION_HDR;
 213
 214 out:
 215         return mc;
 216 }
 217
 218 static int install_equiv_cpu_table(const u8 *buf)
 219 {
 220         unsigned int *ibuf = (unsigned int *)buf;
 221         unsigned int type = ibuf[1];
 222         unsigned int size = ibuf[2];
 223
 224         if (type != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
 225                 pr_err("empty section/"
 226                        "invalid type field in container file section header\n");
 227                 return -EINVAL;
 228         }
 229
 230         equiv_cpu_table = vmalloc(size);
 231         if (!equiv_cpu_table) {
 232                 pr_err("failed to allocate equivalent CPU table\n");
 233                 return -ENOMEM;
 234         }
 235
 236         get_ucode_data(equiv_cpu_table, buf + UCODE_CONTAINER_HEADER_SIZE, size);
 237
 238         return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
 239 }
 240
 241 static void free_equiv_cpu_table(void)
 242 {
 243         vfree(equiv_cpu_table);
 244         equiv_cpu_table = NULL;
 245 }
 246
 247 static enum ucode_state
 248 generic_load_microcode(int cpu, const u8 *data, size_t size)
 249 {
 250         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 251         struct microcode_header_amd *mc_hdr = NULL;
 252         unsigned int mc_size, leftover;
 253         int offset;
 254         const u8 *ucode_ptr = data;
 255         void *new_mc = NULL;
 256         unsigned int new_rev = uci->cpu_sig.rev;
 257         enum ucode_state state = UCODE_OK;
 258
 259         offset = install_equiv_cpu_table(ucode_ptr);
 260         if (offset < 0) {
 261                 pr_err("failed to create equivalent cpu table\n");
 262                 return UCODE_ERROR;
 263         }
 264
 265         ucode_ptr += offset;
 266         leftover = size - offset;
 267
 268         while (leftover) {
 269                 mc_hdr = get_next_ucode(cpu, ucode_ptr, leftover, &mc_size);
 270                 if (!mc_hdr)
 271                         break;
 272
 273                 if (get_matching_microcode(cpu, mc_hdr, new_rev)) {
 274                         vfree(new_mc);
 275                         new_rev = mc_hdr->patch_id;
 276                         new_mc  = mc_hdr;
 277                 } else
 278                         vfree(mc_hdr);
 279
 280                 ucode_ptr += mc_size;
 281                 leftover  -= mc_size;
 282         }
 283
 284         if (!new_mc) {
 285                 state = UCODE_NFOUND;
 286                 goto free_table;
 287         }
 288
 289         if (!leftover) {
 290                 vfree(uci->mc);
 291                 uci->mc = new_mc;
 292                 pr_debug("CPU%d update ucode (0x%08x -> 0x%08x)\n",
 293                          cpu, uci->cpu_sig.rev, new_rev);
 294         } else {
 295                 vfree(new_mc);
 296                 state = UCODE_ERROR;
 297         }
 298
 299 free_table:
 300         free_equiv_cpu_table();
 301
 302         return state;
 303 }
 304
 305 /*
 306  * AMD microcode firmware naming convention, up to family 15h they are in
 307  * the legacy file:
 308  *
 309  *    amd-ucode/microcode_amd.bin
 310  *
 311  * This legacy file is always smaller than 2K in size.
 312  *
 313  * Starting at family 15h they are in family specific firmware files:
 314  *
 315  *    amd-ucode/microcode_amd_fam15h.bin
 316  *    amd-ucode/microcode_amd_fam16h.bin
 317  *    ...
 318  *
 319  * These might be larger than 2K.
 320  */
 321 static enum ucode_state request_microcode_amd(int cpu, struct device *device)
 322 {
 323         char fw_name[36] = "amd-ucode/microcode_amd.bin";
 324         const struct firmware *fw;
 325         enum ucode_state ret = UCODE_NFOUND;
 326         struct cpuinfo_x86 *c = &cpu_data(cpu);
 327
 328         if (c->x86 >= 0x15)
 329                 snprintf(fw_name, sizeof(fw_name), "amd-ucode/microcode_amd_fam%.2xh.bin", c->x86);
 330
 331         if (request_firmware(&fw, (const char *)fw_name, device)) {
 332                 pr_err("failed to load file %s\n", fw_name);
 333                 goto out;
 334         }
 335
 336         ret = UCODE_ERROR;
 337         if (*(u32 *)fw->data != UCODE_MAGIC) {
 338                 pr_err("invalid magic value (0x%08x)\n", *(u32 *)fw->data);
 339                 goto fw_release;
 340         }
 341
 342         ret = generic_load_microcode(cpu, fw->data, fw->size);
 343
 344 fw_release:
 345         release_firmware(fw);
 346
 347 out:
 348         return ret;
 349 }
 350
 351 static enum ucode_state
 352 request_microcode_user(int cpu, const void __user *buf, size_t size)
 353 {
 354         pr_info("AMD microcode update via /dev/cpu/microcode not supported\n");
 355         return UCODE_ERROR;
 356 }
 357
 358 static void microcode_fini_cpu_amd(int cpu)
 359 {
 360         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 361
 362         vfree(uci->mc);
 363         uci->mc = NULL;
 364 }
 365
 366 static struct microcode_ops microcode_amd_ops = {
 367         .request_microcode_user           = request_microcode_user,
 368         .request_microcode_fw             = request_microcode_amd,
 369         .collect_cpu_info                 = collect_cpu_info_amd,
 370         .apply_microcode                  = apply_microcode_amd,
 371         .microcode_fini_cpu               = microcode_fini_cpu_amd,
 372 };
 373
 374 struct microcode_ops * __init init_amd_microcode(void)
 375 {
 376         return &microcode_amd_ops;
 377 }