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 unter the terms of the GNU General Public
14 * License version 2. See file COPYING for details.
17 #include <linux/capability.h>
18 #include <linux/kernel.h>
19 #include <linux/init.h>
20 #include <linux/sched.h>
21 #include <linux/cpumask.h>
22 #include <linux/module.h>
23 #include <linux/slab.h>
24 #include <linux/vmalloc.h>
25 #include <linux/miscdevice.h>
26 #include <linux/spinlock.h>
29 #include <linux/mutex.h>
30 #include <linux/cpu.h>
31 #include <linux/firmware.h>
32 #include <linux/platform_device.h>
33 #include <linux/pci.h>
34 #include <linux/pci_ids.h>
37 #include <asm/uaccess.h>
38 #include <asm/processor.h>
39 #include <asm/microcode.h>
41 MODULE_DESCRIPTION("AMD Microcode Update Driver");
42 MODULE_AUTHOR("Peter Oruba <peter.oruba@amd.com>");
43 MODULE_LICENSE("GPL v2");
45 #define UCODE_MAGIC 0x00414d44
46 #define UCODE_EQUIV_CPU_TABLE_TYPE 0x00000000
47 #define UCODE_UCODE_TYPE 0x00000001
49 struct equiv_cpu_entry {
50 unsigned int installed_cpu;
51 unsigned int fixed_errata_mask;
52 unsigned int fixed_errata_compare;
53 unsigned int equiv_cpu;
56 struct microcode_header_amd {
57 unsigned int data_code;
58 unsigned int patch_id;
59 unsigned char mc_patch_data_id[2];
60 unsigned char mc_patch_data_len;
61 unsigned char init_flag;
62 unsigned int mc_patch_data_checksum;
63 unsigned int nb_dev_id;
64 unsigned int sb_dev_id;
65 unsigned char processor_rev_id[2];
66 unsigned char nb_rev_id;
67 unsigned char sb_rev_id;
68 unsigned char bios_api_rev;
69 unsigned char reserved1[3];
70 unsigned int match_reg[8];
73 struct microcode_amd {
74 struct microcode_header_amd hdr;
78 #define UCODE_MAX_SIZE (2048)
79 #define DEFAULT_UCODE_DATASIZE (896)
80 #define MC_HEADER_SIZE (sizeof(struct microcode_header_amd))
81 #define DEFAULT_UCODE_TOTALSIZE (DEFAULT_UCODE_DATASIZE + MC_HEADER_SIZE)
82 #define DWSIZE (sizeof(u32))
83 /* For now we support a fixed ucode total size only */
84 #define get_totalsize(mc) \
85 ((((struct microcode_amd *)mc)->hdr.mc_patch_data_len * 28) \
88 /* serialize access to the physical write */
89 static DEFINE_SPINLOCK(microcode_update_lock);
91 static struct equiv_cpu_entry *equiv_cpu_table;
93 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
95 struct cpuinfo_x86 *c = &cpu_data(cpu);
97 memset(csig, 0, sizeof(*csig));
99 if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
100 printk(KERN_ERR "microcode: CPU%d not a capable AMD processor\n",
105 asm volatile("movl %1, %%ecx; rdmsr"
107 : "i" (0x0000008B) : "ecx");
109 printk(KERN_INFO "microcode: collect_cpu_info_amd : patch_id=0x%x\n",
115 static int get_matching_microcode(int cpu, void *mc, int rev)
117 struct microcode_header_amd *mc_header = mc;
118 struct pci_dev *nb_pci_dev, *sb_pci_dev;
119 unsigned int current_cpu_id;
120 unsigned int equiv_cpu_id = 0x00;
124 * FIXME! dimm: do we need this? Why an update via /dev/... is different
125 * from the one via firmware?
127 * This is a tricky part. We might be called from a write operation
128 * to the device file instead of the usual process of firmware
129 * loading. This routine needs to be able to distinguish both
130 * cases. This is done by checking if there alread is a equivalent
131 * CPU table installed. If not, we're written through
132 * /dev/cpu/microcode.
133 * Since we ignore all checks. The error case in which going through
134 * firmware loading and that table is not loaded has already been
137 BUG_ON(equiv_cpu_table == NULL);
139 if (equiv_cpu_table == NULL) {
140 printk(KERN_INFO "microcode: CPU%d microcode update with "
141 "version 0x%x (current=0x%x)\n",
142 cpu, mc_header->patch_id, uci->cpu_sig.rev);
146 current_cpu_id = cpuid_eax(0x00000001);
148 while (equiv_cpu_table[i].installed_cpu != 0) {
149 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
150 equiv_cpu_id = equiv_cpu_table[i].equiv_cpu;
157 printk(KERN_ERR "microcode: CPU%d cpu_id "
158 "not found in equivalent cpu table \n", cpu);
162 if ((mc_header->processor_rev_id[0]) != (equiv_cpu_id & 0xff)) {
164 "microcode: CPU%d patch does not match "
165 "(patch is %x, cpu extended is %x) \n",
166 cpu, mc_header->processor_rev_id[0],
167 (equiv_cpu_id & 0xff));
171 if ((mc_header->processor_rev_id[1]) != ((equiv_cpu_id >> 16) & 0xff)) {
172 printk(KERN_ERR "microcode: CPU%d patch does not match "
173 "(patch is %x, cpu base id is %x) \n",
174 cpu, mc_header->processor_rev_id[1],
175 ((equiv_cpu_id >> 16) & 0xff));
180 /* ucode may be northbridge specific */
181 if (mc_header->nb_dev_id) {
182 nb_pci_dev = pci_get_device(PCI_VENDOR_ID_AMD,
183 (mc_header->nb_dev_id & 0xff),
186 (mc_header->nb_rev_id != nb_pci_dev->revision)) {
187 printk(KERN_ERR "microcode: CPU%d NB mismatch \n", cpu);
188 pci_dev_put(nb_pci_dev);
191 pci_dev_put(nb_pci_dev);
194 /* ucode may be southbridge specific */
195 if (mc_header->sb_dev_id) {
196 sb_pci_dev = pci_get_device(PCI_VENDOR_ID_AMD,
197 (mc_header->sb_dev_id & 0xff),
200 (mc_header->sb_rev_id != sb_pci_dev->revision)) {
201 printk(KERN_ERR "microcode: CPU%d SB mismatch \n", cpu);
202 pci_dev_put(sb_pci_dev);
205 pci_dev_put(sb_pci_dev);
208 if (mc_header->patch_id <= rev)
214 static void apply_microcode_amd(int cpu)
217 unsigned int eax, edx;
219 int cpu_num = raw_smp_processor_id();
220 struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
221 struct microcode_amd *mc_amd = uci->mc;
224 /* We should bind the task to the CPU */
225 BUG_ON(cpu_num != cpu);
230 spin_lock_irqsave(µcode_update_lock, flags);
232 addr = (unsigned long)&mc_amd->hdr.data_code;
233 edx = (unsigned int)(((unsigned long)upper_32_bits(addr)));
234 eax = (unsigned int)(((unsigned long)lower_32_bits(addr)));
236 asm volatile("movl %0, %%ecx; wrmsr" :
237 : "i" (0xc0010020), "a" (eax), "d" (edx) : "ecx");
239 /* get patch id after patching */
240 asm volatile("movl %1, %%ecx; rdmsr"
242 : "i" (0x0000008B) : "ecx");
244 spin_unlock_irqrestore(µcode_update_lock, flags);
246 /* check current patch id and patch's id for match */
247 if (rev != mc_amd->hdr.patch_id) {
248 printk(KERN_ERR "microcode: CPU%d update from revision "
249 "0x%x to 0x%x failed\n", cpu_num,
250 mc_amd->hdr.patch_id, rev);
254 printk(KERN_INFO "microcode: CPU%d updated from revision "
256 cpu_num, uci->cpu_sig.rev, mc_amd->hdr.patch_id);
258 uci->cpu_sig.rev = rev;
261 static void * get_next_ucode(u8 *buf, unsigned int size,
262 int (*get_ucode_data)(void *, const void *, size_t),
263 unsigned int *mc_size)
265 unsigned int total_size;
266 #define UCODE_UNKNOWN_HDR 8
267 u8 hdr[UCODE_UNKNOWN_HDR];
270 if (get_ucode_data(hdr, buf, UCODE_UNKNOWN_HDR))
273 if (hdr[0] != UCODE_UCODE_TYPE) {
274 printk(KERN_ERR "microcode: error! "
275 "Wrong microcode payload type field\n");
279 /* FIXME! dimm: Why not by means of get_totalsize(hdr)? */
280 total_size = (unsigned long) (hdr[4] + (hdr[5] << 8));
282 printk(KERN_INFO "microcode: size %u, total_size %u\n",
285 if (total_size > size || total_size > UCODE_MAX_SIZE) {
286 printk(KERN_ERR "microcode: error! Bad data in microcode data file\n");
290 mc = vmalloc(UCODE_MAX_SIZE);
292 memset(mc, 0, UCODE_MAX_SIZE);
293 if (get_ucode_data(mc, buf + UCODE_UNKNOWN_HDR, total_size)) {
297 *mc_size = total_size + UCODE_UNKNOWN_HDR;
299 #undef UCODE_UNKNOWN_HDR
304 static int install_equiv_cpu_table(u8 *buf,
305 int (*get_ucode_data)(void *, const void *, size_t))
307 #define UCODE_CONTAINER_HEADER_SIZE 12
308 u8 *container_hdr[UCODE_CONTAINER_HEADER_SIZE];
309 unsigned int *buf_pos = (unsigned int *)container_hdr;
312 if (get_ucode_data(&container_hdr, buf, UCODE_CONTAINER_HEADER_SIZE))
317 if (buf_pos[1] != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
318 printk(KERN_ERR "microcode: error! "
319 "Wrong microcode equivalnet cpu table\n");
323 equiv_cpu_table = (struct equiv_cpu_entry *) vmalloc(size);
324 if (!equiv_cpu_table) {
325 printk(KERN_ERR "microcode: error, can't allocate memory for equiv CPU table\n");
329 buf += UCODE_CONTAINER_HEADER_SIZE;
330 if (get_ucode_data(equiv_cpu_table, buf, size)) {
331 vfree(equiv_cpu_table);
335 return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
336 #undef UCODE_CONTAINER_HEADER_SIZE
339 static void free_equiv_cpu_table(void)
341 if (equiv_cpu_table) {
342 vfree(equiv_cpu_table);
343 equiv_cpu_table = NULL;
347 static int generic_load_microcode(int cpu, void *data, size_t size,
348 int (*get_ucode_data)(void *, const void *, size_t))
350 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
351 u8 *ucode_ptr = data, *new_mc = NULL, *mc;
352 int new_rev = uci->cpu_sig.rev;
353 unsigned int leftover;
354 unsigned long offset;
356 offset = install_equiv_cpu_table(ucode_ptr, get_ucode_data);
358 printk(KERN_ERR "microcode: installing equivalent cpu table failed\n");
363 leftover = size - offset;
366 unsigned int mc_size;
367 struct microcode_header_amd *mc_header;
369 mc = get_next_ucode(ucode_ptr, leftover, get_ucode_data, &mc_size);
373 mc_header = (struct microcode_header_amd *)mc;
374 if (get_matching_microcode(cpu, mc, new_rev)) {
377 new_rev = mc_header->patch_id;
382 ucode_ptr += mc_size;
391 pr_debug("microcode: CPU%d found a matching microcode update with"
392 " version 0x%x (current=0x%x)\n",
393 cpu, new_rev, uci->cpu_sig.rev);
398 free_equiv_cpu_table();
400 return (int)leftover;
403 static int get_ucode_fw(void *to, const void *from, size_t n)
409 static int request_microcode_fw(int cpu, struct device *device)
411 const char *fw_name = "amd-ucode/microcode_amd.bin";
412 const struct firmware *firmware;
415 /* We should bind the task to the CPU */
416 BUG_ON(cpu != raw_smp_processor_id());
418 ret = request_firmware(&firmware, fw_name, device);
420 printk(KERN_ERR "microcode: ucode data file %s load failed\n", fw_name);
424 ret = generic_load_microcode(cpu, (void*)firmware->data, firmware->size,
427 release_firmware(firmware);
432 static int get_ucode_user(void *to, const void *from, size_t n)
434 return copy_from_user(to, from, n);
437 static int request_microcode_user(int cpu, const void __user *buf, size_t size)
439 /* We should bind the task to the CPU */
440 BUG_ON(cpu != raw_smp_processor_id());
442 return generic_load_microcode(cpu, (void*)buf, size, &get_ucode_user);
445 static void microcode_fini_cpu_amd(int cpu)
447 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
453 static struct microcode_ops microcode_amd_ops = {
454 .request_microcode_user = request_microcode_user,
455 .request_microcode_fw = request_microcode_fw,
456 .collect_cpu_info = collect_cpu_info_amd,
457 .apply_microcode = apply_microcode_amd,
458 .microcode_fini_cpu = microcode_fini_cpu_amd,
461 struct microcode_ops * __init init_amd_microcode(void)
463 return µcode_amd_ops;