2 * Intel CPU Microcode Update Driver for Linux
4 * Copyright (C) 2000-2006 Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
5 * 2006 Shaohua Li <shaohua.li@intel.com>
7 * This driver allows to upgrade microcode on Intel processors
8 * belonging to IA-32 family - PentiumPro, Pentium II,
9 * Pentium III, Xeon, Pentium 4, etc.
11 * Reference: Section 8.11 of Volume 3a, IA-32 Intel? Architecture
12 * Software Developer's Manual
13 * Order Number 253668 or free download from:
15 * http://developer.intel.com/design/pentium4/manuals/253668.htm
17 * For more information, go to http://www.urbanmyth.org/microcode
19 * This program is free software; you can redistribute it and/or
20 * modify it under the terms of the GNU General Public License
21 * as published by the Free Software Foundation; either version
22 * 2 of the License, or (at your option) any later version.
24 * 1.0 16 Feb 2000, Tigran Aivazian <tigran@sco.com>
26 * 1.01 18 Feb 2000, Tigran Aivazian <tigran@sco.com>
27 * Added read() support + cleanups.
28 * 1.02 21 Feb 2000, Tigran Aivazian <tigran@sco.com>
29 * Added 'device trimming' support. open(O_WRONLY) zeroes
30 * and frees the saved copy of applied microcode.
31 * 1.03 29 Feb 2000, Tigran Aivazian <tigran@sco.com>
32 * Made to use devfs (/dev/cpu/microcode) + cleanups.
33 * 1.04 06 Jun 2000, Simon Trimmer <simon@veritas.com>
34 * Added misc device support (now uses both devfs and misc).
35 * Added MICROCODE_IOCFREE ioctl to clear memory.
36 * 1.05 09 Jun 2000, Simon Trimmer <simon@veritas.com>
37 * Messages for error cases (non Intel & no suitable microcode).
38 * 1.06 03 Aug 2000, Tigran Aivazian <tigran@veritas.com>
39 * Removed ->release(). Removed exclusive open and status bitmap.
40 * Added microcode_rwsem to serialize read()/write()/ioctl().
41 * Removed global kernel lock usage.
42 * 1.07 07 Sep 2000, Tigran Aivazian <tigran@veritas.com>
43 * Write 0 to 0x8B msr and then cpuid before reading revision,
44 * so that it works even if there were no update done by the
45 * BIOS. Otherwise, reading from 0x8B gives junk (which happened
46 * to be 0 on my machine which is why it worked even when I
47 * disabled update by the BIOS)
48 * Thanks to Eric W. Biederman <ebiederman@lnxi.com> for the fix.
49 * 1.08 11 Dec 2000, Richard Schaal <richard.schaal@intel.com> and
50 * Tigran Aivazian <tigran@veritas.com>
51 * Intel Pentium 4 processor support and bugfixes.
52 * 1.09 30 Oct 2001, Tigran Aivazian <tigran@veritas.com>
53 * Bugfix for HT (Hyper-Threading) enabled processors
54 * whereby processor resources are shared by all logical processors
55 * in a single CPU package.
56 * 1.10 28 Feb 2002 Asit K Mallick <asit.k.mallick@intel.com> and
57 * Tigran Aivazian <tigran@veritas.com>,
58 * Serialize updates as required on HT processors due to
59 * speculative nature of implementation.
60 * 1.11 22 Mar 2002 Tigran Aivazian <tigran@veritas.com>
61 * Fix the panic when writing zero-length microcode chunk.
62 * 1.12 29 Sep 2003 Nitin Kamble <nitin.a.kamble@intel.com>,
63 * Jun Nakajima <jun.nakajima@intel.com>
64 * Support for the microcode updates in the new format.
65 * 1.13 10 Oct 2003 Tigran Aivazian <tigran@veritas.com>
66 * Removed ->read() method and obsoleted MICROCODE_IOCFREE ioctl
67 * because we no longer hold a copy of applied microcode
69 * 1.14 25 Jun 2004 Tigran Aivazian <tigran@veritas.com>
70 * Fix sigmatch() macro to handle old CPUs with pf == 0.
71 * Thanks to Stuart Swales for pointing out this bug.
74 /* #define DEBUG */ /* pr_debug */
75 #include <linux/capability.h>
76 #include <linux/kernel.h>
77 #include <linux/init.h>
78 #include <linux/sched.h>
79 #include <linux/smp_lock.h>
80 #include <linux/cpumask.h>
81 #include <linux/module.h>
82 #include <linux/slab.h>
83 #include <linux/vmalloc.h>
84 #include <linux/miscdevice.h>
85 #include <linux/spinlock.h>
88 #include <linux/mutex.h>
89 #include <linux/cpu.h>
90 #include <linux/firmware.h>
91 #include <linux/platform_device.h>
94 #include <asm/uaccess.h>
95 #include <asm/processor.h>
96 #include <asm/microcode.h>
98 MODULE_DESCRIPTION("Microcode Update Driver");
99 MODULE_AUTHOR("Tigran Aivazian <tigran@aivazian.fsnet.co.uk>");
100 MODULE_LICENSE("GPL");
102 #define DEFAULT_UCODE_DATASIZE (2000)
103 #define MC_HEADER_SIZE (sizeof(struct microcode_header_intel))
104 #define DEFAULT_UCODE_TOTALSIZE (DEFAULT_UCODE_DATASIZE + MC_HEADER_SIZE)
105 #define EXT_HEADER_SIZE (sizeof(struct extended_sigtable))
106 #define EXT_SIGNATURE_SIZE (sizeof(struct extended_signature))
107 #define DWSIZE (sizeof(u32))
108 #define get_totalsize(mc) \
109 (((struct microcode_intel *)mc)->hdr.totalsize ? \
110 ((struct microcode_intel *)mc)->hdr.totalsize : \
111 DEFAULT_UCODE_TOTALSIZE)
113 #define get_datasize(mc) \
114 (((struct microcode_intel *)mc)->hdr.datasize ? \
115 ((struct microcode_intel *)mc)->hdr.datasize : DEFAULT_UCODE_DATASIZE)
117 #define sigmatch(s1, s2, p1, p2) \
118 (((s1) == (s2)) && (((p1) & (p2)) || (((p1) == 0) && ((p2) == 0))))
120 #define exttable_size(et) ((et)->count * EXT_SIGNATURE_SIZE + EXT_HEADER_SIZE)
122 /* serialize access to the physical write to MSR 0x79 */
123 static DEFINE_SPINLOCK(microcode_update_lock);
125 static int collect_cpu_info(int cpu_num, struct cpu_signature *csig)
127 struct cpuinfo_x86 *c = &cpu_data(cpu_num);
130 memset(csig, 0, sizeof(*csig));
132 if (c->x86_vendor != X86_VENDOR_INTEL || c->x86 < 6 ||
133 cpu_has(c, X86_FEATURE_IA64)) {
134 printk(KERN_ERR "microcode: CPU%d not a capable Intel "
135 "processor\n", cpu_num);
139 csig->sig = cpuid_eax(0x00000001);
141 if ((c->x86_model >= 5) || (c->x86 > 6)) {
142 /* get processor flags from MSR 0x17 */
143 rdmsr(MSR_IA32_PLATFORM_ID, val[0], val[1]);
144 csig->pf = 1 << ((val[1] >> 18) & 7);
147 wrmsr(MSR_IA32_UCODE_REV, 0, 0);
148 /* see notes above for revision 1.07. Apparent chip bug */
150 /* get the current revision from MSR 0x8B */
151 rdmsr(MSR_IA32_UCODE_REV, val[0], csig->rev);
152 pr_debug("microcode: collect_cpu_info : sig=0x%x, pf=0x%x, rev=0x%x\n",
153 csig->sig, csig->pf, csig->rev);
158 static inline int update_match_cpu(struct cpu_signature *csig, int sig, int pf)
160 return (!sigmatch(sig, csig->sig, pf, csig->pf)) ? 0 : 1;
164 update_match_revision(struct microcode_header_intel *mc_header, int rev)
166 return (mc_header->rev <= rev) ? 0 : 1;
169 static int microcode_sanity_check(void *mc)
171 struct microcode_header_intel *mc_header = mc;
172 struct extended_sigtable *ext_header = NULL;
173 struct extended_signature *ext_sig;
174 unsigned long total_size, data_size, ext_table_size;
175 int sum, orig_sum, ext_sigcount = 0, i;
177 total_size = get_totalsize(mc_header);
178 data_size = get_datasize(mc_header);
179 if (data_size + MC_HEADER_SIZE > total_size) {
180 printk(KERN_ERR "microcode: error! "
181 "Bad data size in microcode data file\n");
185 if (mc_header->ldrver != 1 || mc_header->hdrver != 1) {
186 printk(KERN_ERR "microcode: error! "
187 "Unknown microcode update format\n");
190 ext_table_size = total_size - (MC_HEADER_SIZE + data_size);
191 if (ext_table_size) {
192 if ((ext_table_size < EXT_HEADER_SIZE)
193 || ((ext_table_size - EXT_HEADER_SIZE) % EXT_SIGNATURE_SIZE)) {
194 printk(KERN_ERR "microcode: error! "
195 "Small exttable size in microcode data file\n");
198 ext_header = mc + MC_HEADER_SIZE + data_size;
199 if (ext_table_size != exttable_size(ext_header)) {
200 printk(KERN_ERR "microcode: error! "
201 "Bad exttable size in microcode data file\n");
204 ext_sigcount = ext_header->count;
207 /* check extended table checksum */
208 if (ext_table_size) {
209 int ext_table_sum = 0;
210 int *ext_tablep = (int *)ext_header;
212 i = ext_table_size / DWSIZE;
214 ext_table_sum += ext_tablep[i];
216 printk(KERN_WARNING "microcode: aborting, "
217 "bad extended signature table checksum\n");
222 /* calculate the checksum */
224 i = (MC_HEADER_SIZE + data_size) / DWSIZE;
226 orig_sum += ((int *)mc)[i];
228 printk(KERN_ERR "microcode: aborting, bad checksum\n");
233 /* check extended signature checksum */
234 for (i = 0; i < ext_sigcount; i++) {
235 ext_sig = (void *)ext_header + EXT_HEADER_SIZE +
236 EXT_SIGNATURE_SIZE * i;
238 - (mc_header->sig + mc_header->pf + mc_header->cksum)
239 + (ext_sig->sig + ext_sig->pf + ext_sig->cksum);
241 printk(KERN_ERR "microcode: aborting, bad checksum\n");
249 * return 0 - no update found
250 * return 1 - found update
253 get_matching_microcode(struct cpu_signature *cpu_sig, void *mc, int rev)
255 struct microcode_header_intel *mc_header = mc;
256 struct extended_sigtable *ext_header;
257 unsigned long total_size = get_totalsize(mc_header);
259 struct extended_signature *ext_sig;
261 if (!update_match_revision(mc_header, rev))
264 if (update_match_cpu(cpu_sig, mc_header->sig, mc_header->pf))
267 /* Look for ext. headers: */
268 if (total_size <= get_datasize(mc_header) + MC_HEADER_SIZE)
271 ext_header = mc + get_datasize(mc_header) + MC_HEADER_SIZE;
272 ext_sigcount = ext_header->count;
273 ext_sig = (void *)ext_header + EXT_HEADER_SIZE;
275 for (i = 0; i < ext_sigcount; i++) {
276 if (update_match_cpu(cpu_sig, ext_sig->sig, ext_sig->pf))
283 static void apply_microcode(int cpu)
287 int cpu_num = raw_smp_processor_id();
288 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
290 /* We should bind the task to the CPU */
291 BUG_ON(cpu_num != cpu);
293 if (uci->mc.mc_intel == NULL)
296 /* serialize access to the physical write to MSR 0x79 */
297 spin_lock_irqsave(µcode_update_lock, flags);
299 /* write microcode via MSR 0x79 */
300 wrmsr(MSR_IA32_UCODE_WRITE,
301 (unsigned long) uci->mc.mc_intel->bits,
302 (unsigned long) uci->mc.mc_intel->bits >> 16 >> 16);
303 wrmsr(MSR_IA32_UCODE_REV, 0, 0);
305 /* see notes above for revision 1.07. Apparent chip bug */
308 /* get the current revision from MSR 0x8B */
309 rdmsr(MSR_IA32_UCODE_REV, val[0], val[1]);
311 spin_unlock_irqrestore(µcode_update_lock, flags);
312 if (val[1] != uci->mc.mc_intel->hdr.rev) {
313 printk(KERN_ERR "microcode: CPU%d update from revision "
314 "0x%x to 0x%x failed\n", cpu_num, uci->cpu_sig.rev, val[1]);
317 printk(KERN_INFO "microcode: CPU%d updated from revision "
318 "0x%x to 0x%x, date = %04x-%02x-%02x \n",
319 cpu_num, uci->cpu_sig.rev, val[1],
320 uci->mc.mc_intel->hdr.date & 0xffff,
321 uci->mc.mc_intel->hdr.date >> 24,
322 (uci->mc.mc_intel->hdr.date >> 16) & 0xff);
323 uci->cpu_sig.rev = val[1];
326 static int generic_load_microcode(int cpu, void *data, size_t size,
327 int (*get_ucode_data)(void *, const void *, size_t))
329 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
330 u8 *ucode_ptr = data, *new_mc = NULL, *mc;
331 int new_rev = uci->cpu_sig.rev;
332 unsigned int leftover = size;
335 struct microcode_header_intel mc_header;
336 unsigned int mc_size;
338 if (get_ucode_data(&mc_header, ucode_ptr, sizeof(mc_header)))
341 mc_size = get_totalsize(&mc_header);
342 if (!mc_size || mc_size > leftover) {
343 printk(KERN_ERR "microcode: error!"
344 "Bad data in microcode data file\n");
348 mc = vmalloc(mc_size);
352 if (get_ucode_data(mc, ucode_ptr, mc_size) ||
353 microcode_sanity_check(mc) < 0) {
358 if (get_matching_microcode(&uci->cpu_sig, mc, new_rev)) {
359 new_rev = mc_header.rev;
364 ucode_ptr += mc_size;
370 if (uci->mc.mc_intel)
371 vfree(uci->mc.mc_intel);
372 uci->mc.mc_intel = (struct microcode_intel *)new_mc;
373 pr_debug("microcode: CPU%d found a matching microcode update with"
374 " version 0x%x (current=0x%x)\n",
375 cpu, uci->mc.mc_intel->hdr.rev, uci->cpu_sig.rev);
380 return (int)leftover;
383 static int get_ucode_fw(void *to, const void *from, size_t n)
389 static int request_microcode_fw(int cpu, struct device *device)
392 struct cpuinfo_x86 *c = &cpu_data(cpu);
393 const struct firmware *firmware;
396 /* We should bind the task to the CPU */
397 BUG_ON(cpu != raw_smp_processor_id());
398 sprintf(name, "intel-ucode/%02x-%02x-%02x",
399 c->x86, c->x86_model, c->x86_mask);
400 ret = request_firmware(&firmware, name, device);
402 pr_debug("microcode: data file %s load failed\n", name);
406 ret = generic_load_microcode(cpu, (void*)firmware->data, firmware->size,
409 release_firmware(firmware);
414 static int get_ucode_user(void *to, const void *from, size_t n)
416 return copy_from_user(to, from, n);
419 static int request_microcode_user(int cpu, const void __user *buf, size_t size)
421 /* We should bind the task to the CPU */
422 BUG_ON(cpu != raw_smp_processor_id());
424 return generic_load_microcode(cpu, (void*)buf, size, &get_ucode_user);
427 static void microcode_fini_cpu(int cpu)
429 struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
431 vfree(uci->mc.mc_intel);
432 uci->mc.mc_intel = NULL;
435 static struct microcode_ops microcode_intel_ops = {
436 .request_microcode_user = request_microcode_user,
437 .request_microcode_fw = request_microcode_fw,
438 .collect_cpu_info = collect_cpu_info,
439 .apply_microcode = apply_microcode,
440 .microcode_fini_cpu = microcode_fini_cpu,
443 static int __init microcode_intel_module_init(void)
445 struct cpuinfo_x86 *c = &cpu_data(0);
447 if (c->x86_vendor != X86_VENDOR_INTEL) {
448 printk(KERN_ERR "microcode: CPU platform is not Intel-capable\n");
452 return microcode_init(µcode_intel_ops, THIS_MODULE);
455 static void __exit microcode_intel_module_exit(void)
460 module_init(microcode_intel_module_init)
461 module_exit(microcode_intel_module_exit)