2 * AMD CPU Microcode Update Driver for Linux
3 * Copyright (C) 2008 Advanced Micro Devices Inc.
5 * Author: Peter Oruba <peter.oruba@amd.com>
8 * Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
10 * This driver allows to upgrade microcode on AMD
11 * family 0x10 and 0x11 processors.
13 * Licensed under the terms of the GNU General Public
14 * License version 2. See file COPYING for details.
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>
24 #include <asm/microcode.h>
25 #include <asm/processor.h>
28 MODULE_DESCRIPTION("AMD Microcode Update Driver");
29 MODULE_AUTHOR("Peter Oruba");
30 MODULE_LICENSE("GPL v2");
32 #define UCODE_MAGIC 0x00414d44
33 #define UCODE_EQUIV_CPU_TABLE_TYPE 0x00000000
34 #define UCODE_UCODE_TYPE 0x00000001
36 struct equiv_cpu_entry {
38 u32 fixed_errata_mask;
39 u32 fixed_errata_compare;
42 } __attribute__((packed));
44 struct microcode_header_amd {
50 u32 mc_patch_data_checksum;
59 } __attribute__((packed));
61 struct microcode_amd {
62 struct microcode_header_amd hdr;
66 #define UCODE_MAX_SIZE 2048
67 #define UCODE_CONTAINER_SECTION_HDR 8
68 #define UCODE_CONTAINER_HEADER_SIZE 12
70 static struct equiv_cpu_entry *equiv_cpu_table;
72 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
74 struct cpuinfo_x86 *c = &cpu_data(cpu);
77 memset(csig, 0, sizeof(*csig));
78 if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
79 printk(KERN_WARNING "microcode: CPU%d: AMD CPU family 0x%x not "
80 "supported\n", cpu, c->x86);
83 rdmsr(MSR_AMD64_PATCH_LEVEL, csig->rev, dummy);
84 printk(KERN_INFO "microcode: CPU%d: patch_level=0x%x\n", cpu, csig->rev);
88 static int get_matching_microcode(int cpu, void *mc, int rev)
90 struct microcode_header_amd *mc_header = mc;
91 unsigned int current_cpu_id;
95 BUG_ON(equiv_cpu_table == NULL);
96 current_cpu_id = cpuid_eax(0x00000001);
98 while (equiv_cpu_table[i].installed_cpu != 0) {
99 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
100 equiv_cpu_id = equiv_cpu_table[i].equiv_cpu;
107 printk(KERN_WARNING "microcode: CPU%d: cpu revision "
108 "not listed in equivalent cpu table\n", cpu);
112 if (mc_header->processor_rev_id != equiv_cpu_id) {
113 printk(KERN_ERR "microcode: CPU%d: patch mismatch "
114 "(processor_rev_id: %x, equiv_cpu_id: %x)\n",
115 cpu, mc_header->processor_rev_id, equiv_cpu_id);
119 /* ucode might be chipset specific -- currently we don't support this */
120 if (mc_header->nb_dev_id || mc_header->sb_dev_id) {
121 printk(KERN_ERR "microcode: CPU%d: loading of chipset "
122 "specific code not yet supported\n", cpu);
126 if (mc_header->patch_id <= rev)
132 static int apply_microcode_amd(int cpu)
135 int cpu_num = raw_smp_processor_id();
136 struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
137 struct microcode_amd *mc_amd = uci->mc;
139 /* We should bind the task to the CPU */
140 BUG_ON(cpu_num != cpu);
145 wrmsrl(MSR_AMD64_PATCH_LOADER, (u64)(long)&mc_amd->hdr.data_code);
146 /* get patch id after patching */
147 rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
149 /* check current patch id and patch's id for match */
150 if (rev != mc_amd->hdr.patch_id) {
151 printk(KERN_ERR "microcode: CPU%d: update failed "
152 "(for patch_level=0x%x)\n", cpu, mc_amd->hdr.patch_id);
156 printk(KERN_INFO "microcode: CPU%d: updated (new patch_level=0x%x)\n",
159 uci->cpu_sig.rev = rev;
164 static int get_ucode_data(void *to, const u8 *from, size_t n)
171 get_next_ucode(const u8 *buf, unsigned int size, unsigned int *mc_size)
173 unsigned int total_size;
174 u8 section_hdr[UCODE_CONTAINER_SECTION_HDR];
177 if (get_ucode_data(section_hdr, buf, UCODE_CONTAINER_SECTION_HDR))
180 if (section_hdr[0] != UCODE_UCODE_TYPE) {
181 printk(KERN_ERR "microcode: error: invalid type field in "
182 "container file section header\n");
186 total_size = (unsigned long) (section_hdr[4] + (section_hdr[5] << 8));
188 printk(KERN_DEBUG "microcode: size %u, total_size %u\n",
191 if (total_size > size || total_size > UCODE_MAX_SIZE) {
192 printk(KERN_ERR "microcode: error: size mismatch\n");
196 mc = vmalloc(UCODE_MAX_SIZE);
198 memset(mc, 0, UCODE_MAX_SIZE);
199 if (get_ucode_data(mc, buf + UCODE_CONTAINER_SECTION_HDR,
204 *mc_size = total_size + UCODE_CONTAINER_SECTION_HDR;
209 static int install_equiv_cpu_table(const u8 *buf)
211 u8 *container_hdr[UCODE_CONTAINER_HEADER_SIZE];
212 unsigned int *buf_pos = (unsigned int *)container_hdr;
215 if (get_ucode_data(&container_hdr, buf, UCODE_CONTAINER_HEADER_SIZE))
220 if (buf_pos[1] != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
221 printk(KERN_ERR "microcode: error: invalid type field in "
222 "container file section header\n");
226 equiv_cpu_table = (struct equiv_cpu_entry *) vmalloc(size);
227 if (!equiv_cpu_table) {
228 printk(KERN_ERR "microcode: failed to allocate "
229 "equivalent CPU table\n");
233 buf += UCODE_CONTAINER_HEADER_SIZE;
234 if (get_ucode_data(equiv_cpu_table, buf, size)) {
235 vfree(equiv_cpu_table);
239 return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
242 static void free_equiv_cpu_table(void)
244 vfree(equiv_cpu_table);
245 equiv_cpu_table = NULL;
248 static enum ucode_state
249 generic_load_microcode(int cpu, const u8 *data, size_t size)
251 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
252 const u8 *ucode_ptr = data;
255 int new_rev = uci->cpu_sig.rev;
256 unsigned int leftover;
257 unsigned long offset;
258 enum ucode_state state = UCODE_OK;
260 offset = install_equiv_cpu_table(ucode_ptr);
262 printk(KERN_ERR "microcode: failed to create "
263 "equivalent cpu table\n");
268 leftover = size - offset;
271 unsigned int uninitialized_var(mc_size);
272 struct microcode_header_amd *mc_header;
274 mc = get_next_ucode(ucode_ptr, leftover, &mc_size);
278 mc_header = (struct microcode_header_amd *)mc;
279 if (get_matching_microcode(cpu, mc, new_rev)) {
281 new_rev = mc_header->patch_id;
286 ucode_ptr += mc_size;
294 pr_debug("microcode: CPU%d found a matching microcode "
295 "update with version 0x%x (current=0x%x)\n",
296 cpu, new_rev, uci->cpu_sig.rev);
302 state = UCODE_NFOUND;
304 free_equiv_cpu_table();
309 static enum ucode_state request_microcode_fw(int cpu, struct device *device)
311 const char *fw_name = "amd-ucode/microcode_amd.bin";
312 const struct firmware *firmware;
313 enum ucode_state ret;
315 if (request_firmware(&firmware, fw_name, device)) {
316 printk(KERN_ERR "microcode: failed to load file %s\n", fw_name);
320 ret = generic_load_microcode(cpu, firmware->data, firmware->size);
322 release_firmware(firmware);
327 static enum ucode_state
328 request_microcode_user(int cpu, const void __user *buf, size_t size)
330 printk(KERN_INFO "microcode: AMD microcode update via "
331 "/dev/cpu/microcode not supported\n");
335 static void microcode_fini_cpu_amd(int cpu)
337 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
343 static struct microcode_ops microcode_amd_ops = {
344 .request_microcode_user = request_microcode_user,
345 .request_microcode_fw = request_microcode_fw,
346 .collect_cpu_info = collect_cpu_info_amd,
347 .apply_microcode = apply_microcode_amd,
348 .microcode_fini_cpu = microcode_fini_cpu_amd,
351 struct microcode_ops * __init init_amd_microcode(void)
353 return µcode_amd_ops;