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_MAX_SIZE                  2048
  70 #define UCODE_CONTAINER_SECTION_HDR     8
  71 #define UCODE_CONTAINER_HEADER_SIZE     12
  72
  73 static struct equiv_cpu_entry *equiv_cpu_table;
  74
  75 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
  76 {
  77         struct cpuinfo_x86 *c = &cpu_data(cpu);
  78         u32 dummy;
  79
  80         memset(csig, 0, sizeof(*csig));
  81         if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
  82                 pr_warning("microcode: CPU%d: AMD CPU family 0x%x not "
  83                            "supported\n", cpu, c->x86);
  84                 return -1;
  85         }
  86         rdmsr(MSR_AMD64_PATCH_LEVEL, csig->rev, dummy);
  87         pr_info("CPU%d: patch_level=0x%x\n", cpu, csig->rev);
  88         return 0;
  89 }
  90
  91 static int get_matching_microcode(int cpu, struct microcode_header_amd *mc_hdr,
  92                                   int rev)
  93 {
  94         unsigned int current_cpu_id;
  95         u16 equiv_cpu_id = 0;
  96         unsigned int i = 0;
  97
  98         BUG_ON(equiv_cpu_table == NULL);
  99         current_cpu_id = cpuid_eax(0x00000001);
 100
 101         while (equiv_cpu_table[i].installed_cpu != 0) {
 102                 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
 103                         equiv_cpu_id = equiv_cpu_table[i].equiv_cpu;
 104                         break;
 105                 }
 106                 i++;
 107         }
 108
 109         if (!equiv_cpu_id)
 110                 return 0;
 111
 112         if (mc_hdr->processor_rev_id != equiv_cpu_id)
 113                 return 0;
 114
 115         /* ucode might be chipset specific -- currently we don't support this */
 116         if (mc_hdr->nb_dev_id || mc_hdr->sb_dev_id) {
 117                 pr_err("CPU%d: loading of chipset specific code not yet supported\n",
 118                        cpu);
 119                 return 0;
 120         }
 121
 122         if (mc_hdr->patch_id <= rev)
 123                 return 0;
 124
 125         return 1;
 126 }
 127
 128 static int apply_microcode_amd(int cpu)
 129 {
 130         u32 rev, dummy;
 131         int cpu_num = raw_smp_processor_id();
 132         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
 133         struct microcode_amd *mc_amd = uci->mc;
 134
 135         /* We should bind the task to the CPU */
 136         BUG_ON(cpu_num != cpu);
 137
 138         if (mc_amd == NULL)
 139                 return 0;
 140
 141         wrmsrl(MSR_AMD64_PATCH_LOADER, (u64)(long)&mc_amd->hdr.data_code);
 142         /* get patch id after patching */
 143         rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
 144
 145         /* check current patch id and patch's id for match */
 146         if (rev != mc_amd->hdr.patch_id) {
 147                 pr_err("CPU%d: update failed (for patch_level=0x%x)\n",
 148                        cpu, mc_amd->hdr.patch_id);
 149                 return -1;
 150         }
 151
 152         pr_info("CPU%d: updated (new patch_level=0x%x)\n", cpu, rev);
 153         uci->cpu_sig.rev = rev;
 154
 155         return 0;
 156 }
 157
 158 static struct microcode_header_amd *
 159 get_next_ucode(const u8 *buf, unsigned int size, unsigned int *mc_size)
 160 {
 161         struct microcode_header_amd *mc;
 162         unsigned int total_size;
 163
 164         if (buf[0] != UCODE_UCODE_TYPE) {
 165                 pr_err("error: invalid type field in container file section header\n");
 166                 return NULL;
 167         }
 168
 169         total_size = buf[4] + (buf[5] << 8);
 170
 171         if (total_size > size || total_size > UCODE_MAX_SIZE) {
 172                 pr_err("error: size mismatch\n");
 173                 return NULL;
 174         }
 175
 176         mc = vzalloc(UCODE_MAX_SIZE);
 177         if (!mc)
 178                 return NULL;
 179
 180         get_ucode_data(mc, buf + UCODE_CONTAINER_SECTION_HDR, total_size);
 181         *mc_size = total_size + UCODE_CONTAINER_SECTION_HDR;
 182
 183         return mc;
 184 }
 185
 186 static int install_equiv_cpu_table(const u8 *buf)
 187 {
 188         unsigned int *ibuf = (unsigned int *)buf;
 189         unsigned int type = ibuf[1];
 190         unsigned int size = ibuf[2];
 191
 192         if (type != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
 193                 pr_err("error: invalid type field in container file section header\n");
 194                 return -EINVAL;
 195         }
 196
 197         equiv_cpu_table = vmalloc(size);
 198         if (!equiv_cpu_table) {
 199                 pr_err("failed to allocate equivalent CPU table\n");
 200                 return -ENOMEM;
 201         }
 202
 203         get_ucode_data(equiv_cpu_table, buf + UCODE_CONTAINER_HEADER_SIZE, size);
 204
 205         return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
 206 }
 207
 208 static void free_equiv_cpu_table(void)
 209 {
 210         vfree(equiv_cpu_table);
 211         equiv_cpu_table = NULL;
 212 }
 213
 214 static enum ucode_state
 215 generic_load_microcode(int cpu, const u8 *data, size_t size)
 216 {
 217         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 218         struct microcode_header_amd *mc_hdr = NULL;
 219         unsigned int mc_size, leftover;
 220         unsigned long offset;
 221         const u8 *ucode_ptr = data;
 222         void *new_mc = NULL;
 223         int new_rev = uci->cpu_sig.rev;
 224         enum ucode_state state = UCODE_OK;
 225
 226         offset = install_equiv_cpu_table(ucode_ptr);
 227         if (offset < 0) {
 228                 pr_err("failed to create equivalent cpu table\n");
 229                 return UCODE_ERROR;
 230         }
 231
 232         ucode_ptr += offset;
 233         leftover = size - offset;
 234
 235         while (leftover) {
 236                 mc_hdr = get_next_ucode(ucode_ptr, leftover, &mc_size);
 237                 if (!mc_hdr)
 238                         break;
 239
 240                 if (get_matching_microcode(cpu, mc_hdr, new_rev)) {
 241                         vfree(new_mc);
 242                         new_rev = mc_hdr->patch_id;
 243                         new_mc  = mc_hdr;
 244                 } else
 245                         vfree(mc_hdr);
 246
 247                 ucode_ptr += mc_size;
 248                 leftover  -= mc_size;
 249         }
 250
 251         if (!new_mc) {
 252                 state = UCODE_NFOUND;
 253                 goto free_table;
 254         }
 255
 256         if (!leftover) {
 257                 vfree(uci->mc);
 258                 uci->mc = new_mc;
 259                 pr_debug("CPU%d update ucode to version 0x%x (from 0x%x)\n",
 260                          cpu, new_rev, uci->cpu_sig.rev);
 261         } else {
 262                 vfree(new_mc);
 263                 state = UCODE_ERROR;
 264         }
 265
 266 free_table:
 267         free_equiv_cpu_table();
 268
 269         return state;
 270 }
 271
 272 static enum ucode_state request_microcode_amd(int cpu, struct device *device)
 273 {
 274         const char *fw_name = "amd-ucode/microcode_amd.bin";
 275         const struct firmware *fw;
 276         enum ucode_state ret = UCODE_NFOUND;
 277
 278         if (request_firmware(&fw, fw_name, device)) {
 279                 printk(KERN_ERR "microcode: failed to load file %s\n", fw_name);
 280                 goto out;
 281         }
 282
 283         ret = UCODE_ERROR;
 284         if (*(u32 *)fw->data != UCODE_MAGIC) {
 285                 pr_err("Invalid UCODE_MAGIC (0x%08x)\n", *(u32 *)fw->data);
 286                 goto fw_release;
 287         }
 288
 289         ret = generic_load_microcode(cpu, fw->data, fw->size);
 290
 291 fw_release:
 292         release_firmware(fw);
 293
 294 out:
 295         return ret;
 296 }
 297
 298 static enum ucode_state
 299 request_microcode_user(int cpu, const void __user *buf, size_t size)
 300 {
 301         pr_info("AMD microcode update via /dev/cpu/microcode not supported\n");
 302         return UCODE_ERROR;
 303 }
 304
 305 static void microcode_fini_cpu_amd(int cpu)
 306 {
 307         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 308
 309         vfree(uci->mc);
 310         uci->mc = NULL;
 311 }
 312
 313 static struct microcode_ops microcode_amd_ops = {
 314         .request_microcode_user           = request_microcode_user,
 315         .request_microcode_fw             = request_microcode_amd,
 316         .collect_cpu_info                 = collect_cpu_info_amd,
 317         .apply_microcode                  = apply_microcode_amd,
 318         .microcode_fini_cpu               = microcode_fini_cpu_amd,
 319 };
 320
 321 struct microcode_ops * __init init_amd_microcode(void)
 322 {
 323         return &microcode_amd_ops;
 324 }