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 #include <linux/firmware.h>
  17 #include <linux/pci_ids.h>
  18 #include <linux/uaccess.h>
  19 #include <linux/vmalloc.h>
  20 #include <linux/kernel.h>
  21 #include <linux/module.h>
  22 #include <linux/pci.h>
  23
  24 #include <asm/microcode.h>
  25 #include <asm/processor.h>
  26 #include <asm/msr.h>
  27
  28 MODULE_DESCRIPTION("AMD Microcode Update Driver");
  29 MODULE_AUTHOR("Peter Oruba");
  30 MODULE_LICENSE("GPL v2");
  31
  32 #define UCODE_MAGIC                0x00414d44
  33 #define UCODE_EQUIV_CPU_TABLE_TYPE 0x00000000
  34 #define UCODE_UCODE_TYPE           0x00000001
  35
  36 const struct firmware *firmware;
  37
  38 struct equiv_cpu_entry {
  39         u32     installed_cpu;
  40         u32     fixed_errata_mask;
  41         u32     fixed_errata_compare;
  42         u16     equiv_cpu;
  43         u16     res;
  44 } __attribute__((packed));
  45
  46 struct microcode_header_amd {
  47         u32     data_code;
  48         u32     patch_id;
  49         u16     mc_patch_data_id;
  50         u8      mc_patch_data_len;
  51         u8      init_flag;
  52         u32     mc_patch_data_checksum;
  53         u32     nb_dev_id;
  54         u32     sb_dev_id;
  55         u16     processor_rev_id;
  56         u8      nb_rev_id;
  57         u8      sb_rev_id;
  58         u8      bios_api_rev;
  59         u8      reserved1[3];
  60         u32     match_reg[8];
  61 } __attribute__((packed));
  62
  63 struct microcode_amd {
  64         struct microcode_header_amd     hdr;
  65         unsigned int                    mpb[0];
  66 };
  67
  68 #define UCODE_MAX_SIZE                  2048
  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         memset(csig, 0, sizeof(*csig));
  80         if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
  81                 pr_warning("microcode: CPU%d: AMD CPU family 0x%x not "
  82                            "supported\n", cpu, c->x86);
  83                 return -1;
  84         }
  85         rdmsr(MSR_AMD64_PATCH_LEVEL, csig->rev, dummy);
  86         pr_info("microcode: CPU%d: patch_level=0x%x\n", cpu, csig->rev);
  87         return 0;
  88 }
  89
  90 static int get_matching_microcode(int cpu, void *mc, int rev)
  91 {
  92         struct microcode_header_amd *mc_header = mc;
  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_header->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_header->nb_dev_id || mc_header->sb_dev_id) {
 116                 pr_err(KERN_ERR "microcode: CPU%d: loading of chipset "
 117                        "specific code not yet supported\n", cpu);
 118                 return 0;
 119         }
 120
 121         if (mc_header->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("microcode: CPU%d: update failed "
 147                        "(for patch_level=0x%x)\n", cpu, mc_amd->hdr.patch_id);
 148                 return -1;
 149         }
 150
 151         pr_info("microcode: CPU%d: updated (new patch_level=0x%x)\n", cpu, rev);
 152         uci->cpu_sig.rev = rev;
 153
 154         return 0;
 155 }
 156
 157 static int get_ucode_data(void *to, const u8 *from, size_t n)
 158 {
 159         memcpy(to, from, n);
 160         return 0;
 161 }
 162
 163 static void *
 164 get_next_ucode(const u8 *buf, unsigned int size, unsigned int *mc_size)
 165 {
 166         unsigned int total_size;
 167         u8 section_hdr[UCODE_CONTAINER_SECTION_HDR];
 168         void *mc;
 169
 170         if (get_ucode_data(section_hdr, buf, UCODE_CONTAINER_SECTION_HDR))
 171                 return NULL;
 172
 173         if (section_hdr[0] != UCODE_UCODE_TYPE) {
 174                 pr_err("microcode: error: invalid type field in "
 175                        "container file section header\n");
 176                 return NULL;
 177         }
 178
 179         total_size = (unsigned long) (section_hdr[4] + (section_hdr[5] << 8));
 180
 181         if (total_size > size || total_size > UCODE_MAX_SIZE) {
 182                 pr_err("microcode: error: size mismatch\n");
 183                 return NULL;
 184         }
 185
 186         mc = vmalloc(UCODE_MAX_SIZE);
 187         if (mc) {
 188                 memset(mc, 0, UCODE_MAX_SIZE);
 189                 if (get_ucode_data(mc, buf + UCODE_CONTAINER_SECTION_HDR,
 190                                    total_size)) {
 191                         vfree(mc);
 192                         mc = NULL;
 193                 } else
 194                         *mc_size = total_size + UCODE_CONTAINER_SECTION_HDR;
 195         }
 196         return mc;
 197 }
 198
 199 static int install_equiv_cpu_table(const u8 *buf)
 200 {
 201         u8 *container_hdr[UCODE_CONTAINER_HEADER_SIZE];
 202         unsigned int *buf_pos = (unsigned int *)container_hdr;
 203         unsigned long size;
 204
 205         if (get_ucode_data(&container_hdr, buf, UCODE_CONTAINER_HEADER_SIZE))
 206                 return 0;
 207
 208         size = buf_pos[2];
 209
 210         if (buf_pos[1] != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
 211                 pr_err("microcode: error: invalid type field in "
 212                        "container file section header\n");
 213                 return 0;
 214         }
 215
 216         equiv_cpu_table = (struct equiv_cpu_entry *) vmalloc(size);
 217         if (!equiv_cpu_table) {
 218                 pr_err("microcode: failed to allocate equivalent CPU table\n");
 219                 return 0;
 220         }
 221
 222         buf += UCODE_CONTAINER_HEADER_SIZE;
 223         if (get_ucode_data(equiv_cpu_table, buf, size)) {
 224                 vfree(equiv_cpu_table);
 225                 return 0;
 226         }
 227
 228         return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
 229 }
 230
 231 static void free_equiv_cpu_table(void)
 232 {
 233         vfree(equiv_cpu_table);
 234         equiv_cpu_table = NULL;
 235 }
 236
 237 static enum ucode_state
 238 generic_load_microcode(int cpu, const u8 *data, size_t size)
 239 {
 240         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 241         const u8 *ucode_ptr = data;
 242         void *new_mc = NULL;
 243         void *mc;
 244         int new_rev = uci->cpu_sig.rev;
 245         unsigned int leftover;
 246         unsigned long offset;
 247         enum ucode_state state = UCODE_OK;
 248
 249         offset = install_equiv_cpu_table(ucode_ptr);
 250         if (!offset) {
 251                 pr_err("microcode: failed to create equivalent cpu table\n");
 252                 return UCODE_ERROR;
 253         }
 254
 255         ucode_ptr += offset;
 256         leftover = size - offset;
 257
 258         while (leftover) {
 259                 unsigned int uninitialized_var(mc_size);
 260                 struct microcode_header_amd *mc_header;
 261
 262                 mc = get_next_ucode(ucode_ptr, leftover, &mc_size);
 263                 if (!mc)
 264                         break;
 265
 266                 mc_header = (struct microcode_header_amd *)mc;
 267                 if (get_matching_microcode(cpu, mc, new_rev)) {
 268                         vfree(new_mc);
 269                         new_rev = mc_header->patch_id;
 270                         new_mc  = mc;
 271                 } else
 272                         vfree(mc);
 273
 274                 ucode_ptr += mc_size;
 275                 leftover  -= mc_size;
 276         }
 277
 278         if (new_mc) {
 279                 if (!leftover) {
 280                         vfree(uci->mc);
 281                         uci->mc = new_mc;
 282                         pr_debug("microcode: CPU%d found a matching microcode "
 283                                  "update with version 0x%x (current=0x%x)\n",
 284                                  cpu, new_rev, uci->cpu_sig.rev);
 285                 } else {
 286                         vfree(new_mc);
 287                         state = UCODE_ERROR;
 288                 }
 289         } else
 290                 state = UCODE_NFOUND;
 291
 292         free_equiv_cpu_table();
 293
 294         return state;
 295 }
 296
 297 static enum ucode_state request_microcode_fw(int cpu, struct device *device)
 298 {
 299         enum ucode_state ret;
 300
 301         if (firmware == NULL)
 302                 return UCODE_NFOUND;
 303
 304         if (*(u32 *)firmware->data != UCODE_MAGIC) {
 305                 pr_err("microcode: invalid UCODE_MAGIC (0x%08x)\n",
 306                        *(u32 *)firmware->data);
 307                 return UCODE_ERROR;
 308         }
 309
 310         ret = generic_load_microcode(cpu, firmware->data, firmware->size);
 311
 312         return ret;
 313 }
 314
 315 static enum ucode_state
 316 request_microcode_user(int cpu, const void __user *buf, size_t size)
 317 {
 318         pr_info("microcode: AMD microcode update via "
 319                 "/dev/cpu/microcode not supported\n");
 320         return UCODE_ERROR;
 321 }
 322
 323 static void microcode_fini_cpu_amd(int cpu)
 324 {
 325         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
 326
 327         vfree(uci->mc);
 328         uci->mc = NULL;
 329 }
 330
 331 void init_microcode_amd(struct device *device)
 332 {
 333         const char *fw_name = "amd-ucode/microcode_amd.bin";
 334         if (request_firmware(&firmware, fw_name, device))
 335                 pr_err("microcode: failed to load file %s\n", fw_name);
 336 }
 337
 338 void fini_microcode_amd(void)
 339 {
 340         release_firmware(firmware);
 341 }
 342
 343 static struct microcode_ops microcode_amd_ops = {
 344         .init                             = init_microcode_amd,
 345         .fini                             = fini_microcode_amd,
 346         .request_microcode_user           = request_microcode_user,
 347         .request_microcode_fw             = request_microcode_fw,
 348         .collect_cpu_info                 = collect_cpu_info_amd,
 349         .apply_microcode                  = apply_microcode_amd,
 350         .microcode_fini_cpu               = microcode_fini_cpu_amd,
 351 };
 352
 353 struct microcode_ops * __init init_amd_microcode(void)
 354 {
 355         return &microcode_amd_ops;
 356 }