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/platform_device.h>
17 #include <linux/capability.h>
18 #include <linux/miscdevice.h>
19 #include <linux/firmware.h>
20 #include <linux/spinlock.h>
21 #include <linux/cpumask.h>
22 #include <linux/pci_ids.h>
23 #include <linux/uaccess.h>
24 #include <linux/vmalloc.h>
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/mutex.h>
28 #include <linux/sched.h>
29 #include <linux/init.h>
30 #include <linux/slab.h>
31 #include <linux/cpu.h>
32 #include <linux/pci.h>
36 #include <asm/microcode.h>
37 #include <asm/processor.h>
40 MODULE_DESCRIPTION("AMD Microcode Update Driver");
41 MODULE_AUTHOR("Peter Oruba");
42 MODULE_LICENSE("GPL v2");
44 #define UCODE_MAGIC 0x00414d44
45 #define UCODE_EQUIV_CPU_TABLE_TYPE 0x00000000
46 #define UCODE_UCODE_TYPE 0x00000001
48 struct equiv_cpu_entry {
50 u32 fixed_errata_mask;
51 u32 fixed_errata_compare;
54 } __attribute__((packed));
56 struct microcode_header_amd {
62 u32 mc_patch_data_checksum;
71 } __attribute__((packed));
73 struct microcode_amd {
74 struct microcode_header_amd hdr;
78 #define UCODE_MAX_SIZE 2048
79 #define UCODE_CONTAINER_SECTION_HDR 8
80 #define UCODE_CONTAINER_HEADER_SIZE 12
82 /* serialize access to the physical write */
83 static DEFINE_SPINLOCK(microcode_update_lock);
85 static struct equiv_cpu_entry *equiv_cpu_table;
87 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
89 struct cpuinfo_x86 *c = &cpu_data(cpu);
92 memset(csig, 0, sizeof(*csig));
93 if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
94 printk(KERN_WARNING "microcode: CPU%d: AMD CPU family 0x%x not "
95 "supported\n", cpu, c->x86);
98 rdmsr(MSR_AMD64_PATCH_LEVEL, csig->rev, dummy);
99 printk(KERN_INFO "microcode: CPU%d: patch_level=0x%x\n", cpu, csig->rev);
103 static int get_matching_microcode(int cpu, void *mc, int rev)
105 struct microcode_header_amd *mc_header = mc;
106 unsigned int current_cpu_id;
107 u16 equiv_cpu_id = 0;
110 BUG_ON(equiv_cpu_table == NULL);
111 current_cpu_id = cpuid_eax(0x00000001);
113 while (equiv_cpu_table[i].installed_cpu != 0) {
114 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
115 equiv_cpu_id = equiv_cpu_table[i].equiv_cpu;
122 printk(KERN_WARNING "microcode: CPU%d: cpu revision "
123 "not listed in equivalent cpu table\n", cpu);
127 if (mc_header->processor_rev_id != equiv_cpu_id) {
128 printk(KERN_ERR "microcode: CPU%d: patch mismatch "
129 "(processor_rev_id: %x, equiv_cpu_id: %x)\n",
130 cpu, mc_header->processor_rev_id, equiv_cpu_id);
134 /* ucode might be chipset specific -- currently we don't support this */
135 if (mc_header->nb_dev_id || mc_header->sb_dev_id) {
136 printk(KERN_ERR "microcode: CPU%d: loading of chipset "
137 "specific code not yet supported\n", cpu);
141 if (mc_header->patch_id <= rev)
147 static void apply_microcode_amd(int cpu)
151 int cpu_num = raw_smp_processor_id();
152 struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
153 struct microcode_amd *mc_amd = uci->mc;
155 /* We should bind the task to the CPU */
156 BUG_ON(cpu_num != cpu);
161 spin_lock_irqsave(µcode_update_lock, flags);
162 wrmsrl(MSR_AMD64_PATCH_LOADER, (u64)(long)&mc_amd->hdr.data_code);
163 /* get patch id after patching */
164 rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
165 spin_unlock_irqrestore(µcode_update_lock, flags);
167 /* check current patch id and patch's id for match */
168 if (rev != mc_amd->hdr.patch_id) {
169 printk(KERN_ERR "microcode: CPU%d: update failed "
170 "(for patch_level=0x%x)\n", cpu, mc_amd->hdr.patch_id);
174 printk(KERN_INFO "microcode: CPU%d: updated (new patch_level=0x%x)\n",
177 uci->cpu_sig.rev = rev;
180 static int get_ucode_data(void *to, const u8 *from, size_t n)
187 get_next_ucode(const u8 *buf, unsigned int size, unsigned int *mc_size)
189 unsigned int total_size;
190 u8 section_hdr[UCODE_CONTAINER_SECTION_HDR];
193 if (get_ucode_data(section_hdr, buf, UCODE_CONTAINER_SECTION_HDR))
196 if (section_hdr[0] != UCODE_UCODE_TYPE) {
197 printk(KERN_ERR "microcode: error: invalid type field in "
198 "container file section header\n");
202 total_size = (unsigned long) (section_hdr[4] + (section_hdr[5] << 8));
204 printk(KERN_DEBUG "microcode: size %u, total_size %u\n",
207 if (total_size > size || total_size > UCODE_MAX_SIZE) {
208 printk(KERN_ERR "microcode: error: size mismatch\n");
212 mc = vmalloc(UCODE_MAX_SIZE);
214 memset(mc, 0, UCODE_MAX_SIZE);
215 if (get_ucode_data(mc, buf + UCODE_CONTAINER_SECTION_HDR,
220 *mc_size = total_size + UCODE_CONTAINER_SECTION_HDR;
225 static int install_equiv_cpu_table(const u8 *buf)
227 u8 *container_hdr[UCODE_CONTAINER_HEADER_SIZE];
228 unsigned int *buf_pos = (unsigned int *)container_hdr;
231 if (get_ucode_data(&container_hdr, buf, UCODE_CONTAINER_HEADER_SIZE))
236 if (buf_pos[1] != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
237 printk(KERN_ERR "microcode: error: invalid type field in "
238 "container file section header\n");
242 equiv_cpu_table = (struct equiv_cpu_entry *) vmalloc(size);
243 if (!equiv_cpu_table) {
244 printk(KERN_ERR "microcode: failed to allocate "
245 "equivalent CPU table\n");
249 buf += UCODE_CONTAINER_HEADER_SIZE;
250 if (get_ucode_data(equiv_cpu_table, buf, size)) {
251 vfree(equiv_cpu_table);
255 return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
258 static void free_equiv_cpu_table(void)
260 if (equiv_cpu_table) {
261 vfree(equiv_cpu_table);
262 equiv_cpu_table = NULL;
266 static int generic_load_microcode(int cpu, const u8 *data, size_t size)
268 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
269 const u8 *ucode_ptr = data;
272 int new_rev = uci->cpu_sig.rev;
273 unsigned int leftover;
274 unsigned long offset;
276 offset = install_equiv_cpu_table(ucode_ptr);
278 printk(KERN_ERR "microcode: failed to create "
279 "equivalent cpu table\n");
284 leftover = size - offset;
287 unsigned int uninitialized_var(mc_size);
288 struct microcode_header_amd *mc_header;
290 mc = get_next_ucode(ucode_ptr, leftover, &mc_size);
294 mc_header = (struct microcode_header_amd *)mc;
295 if (get_matching_microcode(cpu, mc, new_rev)) {
298 new_rev = mc_header->patch_id;
303 ucode_ptr += mc_size;
312 pr_debug("microcode: CPU%d found a matching microcode "
313 "update with version 0x%x (current=0x%x)\n",
314 cpu, new_rev, uci->cpu_sig.rev);
319 free_equiv_cpu_table();
321 return (int)leftover;
324 static int request_microcode_fw(int cpu, struct device *device)
326 const char *fw_name = "amd-ucode/microcode_amd.bin";
327 const struct firmware *firmware;
330 /* We should bind the task to the CPU */
331 BUG_ON(cpu != raw_smp_processor_id());
333 ret = request_firmware(&firmware, fw_name, device);
335 printk(KERN_ERR "microcode: failed to load file %s\n", fw_name);
339 ret = generic_load_microcode(cpu, firmware->data, firmware->size);
341 release_firmware(firmware);
346 static int request_microcode_user(int cpu, const void __user *buf, size_t size)
348 printk(KERN_INFO "microcode: AMD microcode update via "
349 "/dev/cpu/microcode not supported\n");
353 static void microcode_fini_cpu_amd(int cpu)
355 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
361 static struct microcode_ops microcode_amd_ops = {
362 .request_microcode_user = request_microcode_user,
363 .request_microcode_fw = request_microcode_fw,
364 .collect_cpu_info = collect_cpu_info_amd,
365 .apply_microcode = apply_microcode_amd,
366 .microcode_fini_cpu = microcode_fini_cpu_amd,
369 struct microcode_ops * __init init_amd_microcode(void)
371 return µcode_amd_ops;