Commit | Line | Data |
---|---|---|
3e135d88 PO |
1 | /* |
2 | * Intel CPU Microcode Update Driver for Linux | |
3 | * | |
4 | * Copyright (C) 2000-2006 Tigran Aivazian <tigran@aivazian.fsnet.co.uk> | |
5 | * 2006 Shaohua Li <shaohua.li@intel.com> | |
6 | * | |
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. | |
10 | * | |
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: | |
14 | * | |
15 | * http://developer.intel.com/design/pentium4/manuals/253668.htm | |
16 | * | |
17 | * For more information, go to http://www.urbanmyth.org/microcode | |
18 | * | |
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. | |
23 | * | |
24 | * 1.0 16 Feb 2000, Tigran Aivazian <tigran@sco.com> | |
25 | * Initial release. | |
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 speculative | |
59 | * 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 | |
68 | * in kernel memory. | |
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. | |
72 | */ | |
73 | ||
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> | |
86 | #include <linux/mm.h> | |
87 | #include <linux/fs.h> | |
88 | #include <linux/mutex.h> | |
89 | #include <linux/cpu.h> | |
90 | #include <linux/firmware.h> | |
91 | #include <linux/platform_device.h> | |
92 | ||
93 | #include <asm/msr.h> | |
94 | #include <asm/uaccess.h> | |
95 | #include <asm/processor.h> | |
96 | #include <asm/microcode.h> | |
97 | ||
98 | MODULE_DESCRIPTION("Microcode Update Driver"); | |
99 | MODULE_AUTHOR("Tigran Aivazian <tigran@aivazian.fsnet.co.uk>"); | |
100 | MODULE_LICENSE("GPL"); | |
101 | ||
8d86f390 | 102 | #define MICROCODE_VERSION "2.00" |
3e135d88 | 103 | |
8d86f390 | 104 | struct microcode_ops *microcode_ops; |
3e135d88 | 105 | |
8d86f390 PO |
106 | /* no concurrent ->write()s are allowed on /dev/cpu/microcode */ |
107 | static DEFINE_MUTEX(microcode_mutex); | |
108 | EXPORT_SYMBOL_GPL(microcode_mutex); | |
3e135d88 | 109 | |
8d86f390 PO |
110 | static struct ucode_cpu_info ucode_cpu_info[NR_CPUS]; |
111 | EXPORT_SYMBOL_GPL(ucode_cpu_info); | |
3e135d88 PO |
112 | |
113 | #ifdef CONFIG_MICROCODE_OLD_INTERFACE | |
8d86f390 PO |
114 | static void __user *user_buffer; /* user area microcode data buffer */ |
115 | EXPORT_SYMBOL_GPL(user_buffer); | |
116 | static unsigned int user_buffer_size; /* it's size */ | |
117 | EXPORT_SYMBOL_GPL(user_buffer_size); | |
3e135d88 PO |
118 | |
119 | static int do_microcode_update (void) | |
120 | { | |
121 | long cursor = 0; | |
122 | int error = 0; | |
123 | void *new_mc = NULL; | |
124 | int cpu; | |
125 | cpumask_t old; | |
126 | cpumask_of_cpu_ptr_declare(newmask); | |
127 | ||
128 | old = current->cpus_allowed; | |
129 | ||
8d86f390 PO |
130 | while ((cursor = microcode_ops->get_next_ucode(&new_mc, cursor)) > 0) { |
131 | error = microcode_ops->microcode_sanity_check(new_mc); | |
3e135d88 PO |
132 | if (error) |
133 | goto out; | |
134 | /* | |
135 | * It's possible the data file has multiple matching ucode, | |
136 | * lets keep searching till the latest version | |
137 | */ | |
138 | for_each_online_cpu(cpu) { | |
139 | struct ucode_cpu_info *uci = ucode_cpu_info + cpu; | |
140 | ||
141 | if (!uci->valid) | |
142 | continue; | |
143 | cpumask_of_cpu_ptr_next(newmask, cpu); | |
144 | set_cpus_allowed_ptr(current, newmask); | |
8d86f390 PO |
145 | error = microcode_ops->get_matching_microcode(new_mc, |
146 | cpu); | |
3e135d88 PO |
147 | if (error < 0) |
148 | goto out; | |
149 | if (error == 1) | |
8d86f390 | 150 | microcode_ops->apply_microcode(cpu); |
3e135d88 PO |
151 | } |
152 | vfree(new_mc); | |
153 | } | |
154 | out: | |
155 | if (cursor > 0) | |
156 | vfree(new_mc); | |
157 | if (cursor < 0) | |
158 | error = cursor; | |
159 | set_cpus_allowed_ptr(current, &old); | |
160 | return error; | |
161 | } | |
162 | ||
163 | static int microcode_open (struct inode *unused1, struct file *unused2) | |
164 | { | |
165 | cycle_kernel_lock(); | |
166 | return capable(CAP_SYS_RAWIO) ? 0 : -EPERM; | |
167 | } | |
168 | ||
169 | static ssize_t microcode_write (struct file *file, const char __user *buf, size_t len, loff_t *ppos) | |
170 | { | |
171 | ssize_t ret; | |
172 | ||
173 | if ((len >> PAGE_SHIFT) > num_physpages) { | |
174 | printk(KERN_ERR "microcode: too much data (max %ld pages)\n", num_physpages); | |
175 | return -EINVAL; | |
176 | } | |
177 | ||
178 | get_online_cpus(); | |
179 | mutex_lock(µcode_mutex); | |
180 | ||
181 | user_buffer = (void __user *) buf; | |
182 | user_buffer_size = (int) len; | |
183 | ||
184 | ret = do_microcode_update(); | |
185 | if (!ret) | |
186 | ret = (ssize_t)len; | |
187 | ||
188 | mutex_unlock(µcode_mutex); | |
189 | put_online_cpus(); | |
190 | ||
191 | return ret; | |
192 | } | |
193 | ||
194 | static const struct file_operations microcode_fops = { | |
195 | .owner = THIS_MODULE, | |
196 | .write = microcode_write, | |
197 | .open = microcode_open, | |
198 | }; | |
199 | ||
200 | static struct miscdevice microcode_dev = { | |
201 | .minor = MICROCODE_MINOR, | |
202 | .name = "microcode", | |
203 | .fops = µcode_fops, | |
204 | }; | |
205 | ||
206 | static int __init microcode_dev_init (void) | |
207 | { | |
208 | int error; | |
209 | ||
210 | error = misc_register(µcode_dev); | |
211 | if (error) { | |
212 | printk(KERN_ERR | |
213 | "microcode: can't misc_register on minor=%d\n", | |
214 | MICROCODE_MINOR); | |
215 | return error; | |
216 | } | |
217 | ||
218 | return 0; | |
219 | } | |
220 | ||
221 | static void microcode_dev_exit (void) | |
222 | { | |
223 | misc_deregister(µcode_dev); | |
224 | } | |
225 | ||
226 | MODULE_ALIAS_MISCDEV(MICROCODE_MINOR); | |
227 | #else | |
228 | #define microcode_dev_init() 0 | |
229 | #define microcode_dev_exit() do { } while(0) | |
230 | #endif | |
231 | ||
232 | /* fake device for request_firmware */ | |
8d86f390 PO |
233 | static struct platform_device *microcode_pdev; |
234 | EXPORT_SYMBOL_GPL(microcode_pdev); | |
3e135d88 PO |
235 | |
236 | static void microcode_init_cpu(int cpu, int resume) | |
237 | { | |
238 | cpumask_t old; | |
239 | cpumask_of_cpu_ptr(newmask, cpu); | |
240 | struct ucode_cpu_info *uci = ucode_cpu_info + cpu; | |
241 | ||
242 | old = current->cpus_allowed; | |
243 | ||
244 | set_cpus_allowed_ptr(current, newmask); | |
245 | mutex_lock(µcode_mutex); | |
8d86f390 | 246 | microcode_ops->collect_cpu_info(cpu); |
3e135d88 | 247 | if (uci->valid && system_state == SYSTEM_RUNNING && !resume) |
8d86f390 | 248 | microcode_ops->cpu_request_microcode(cpu); |
3e135d88 PO |
249 | mutex_unlock(µcode_mutex); |
250 | set_cpus_allowed_ptr(current, &old); | |
251 | } | |
252 | ||
253 | static ssize_t reload_store(struct sys_device *dev, | |
254 | struct sysdev_attribute *attr, | |
255 | const char *buf, size_t sz) | |
256 | { | |
257 | struct ucode_cpu_info *uci = ucode_cpu_info + dev->id; | |
258 | char *end; | |
259 | unsigned long val = simple_strtoul(buf, &end, 0); | |
260 | int err = 0; | |
261 | int cpu = dev->id; | |
262 | ||
263 | if (end == buf) | |
264 | return -EINVAL; | |
265 | if (val == 1) { | |
266 | cpumask_t old; | |
267 | cpumask_of_cpu_ptr(newmask, cpu); | |
268 | ||
269 | old = current->cpus_allowed; | |
270 | ||
271 | get_online_cpus(); | |
272 | set_cpus_allowed_ptr(current, newmask); | |
273 | ||
274 | mutex_lock(µcode_mutex); | |
275 | if (uci->valid) | |
8d86f390 | 276 | err = microcode_ops->cpu_request_microcode(cpu); |
3e135d88 PO |
277 | mutex_unlock(µcode_mutex); |
278 | put_online_cpus(); | |
279 | set_cpus_allowed_ptr(current, &old); | |
280 | } | |
281 | if (err) | |
282 | return err; | |
283 | return sz; | |
284 | } | |
285 | ||
286 | static ssize_t version_show(struct sys_device *dev, | |
287 | struct sysdev_attribute *attr, char *buf) | |
288 | { | |
289 | struct ucode_cpu_info *uci = ucode_cpu_info + dev->id; | |
290 | ||
291 | return sprintf(buf, "0x%x\n", uci->rev); | |
292 | } | |
293 | ||
294 | static ssize_t pf_show(struct sys_device *dev, | |
295 | struct sysdev_attribute *attr, char *buf) | |
296 | { | |
297 | struct ucode_cpu_info *uci = ucode_cpu_info + dev->id; | |
298 | ||
299 | return sprintf(buf, "0x%x\n", uci->pf); | |
300 | } | |
301 | ||
302 | static SYSDEV_ATTR(reload, 0200, NULL, reload_store); | |
303 | static SYSDEV_ATTR(version, 0400, version_show, NULL); | |
304 | static SYSDEV_ATTR(processor_flags, 0400, pf_show, NULL); | |
305 | ||
306 | static struct attribute *mc_default_attrs[] = { | |
307 | &attr_reload.attr, | |
308 | &attr_version.attr, | |
309 | &attr_processor_flags.attr, | |
310 | NULL | |
311 | }; | |
312 | ||
313 | static struct attribute_group mc_attr_group = { | |
314 | .attrs = mc_default_attrs, | |
315 | .name = "microcode", | |
316 | }; | |
317 | ||
318 | static int __mc_sysdev_add(struct sys_device *sys_dev, int resume) | |
319 | { | |
320 | int err, cpu = sys_dev->id; | |
321 | struct ucode_cpu_info *uci = ucode_cpu_info + cpu; | |
322 | ||
323 | if (!cpu_online(cpu)) | |
324 | return 0; | |
325 | ||
326 | pr_debug("microcode: CPU%d added\n", cpu); | |
327 | memset(uci, 0, sizeof(*uci)); | |
328 | ||
329 | err = sysfs_create_group(&sys_dev->kobj, &mc_attr_group); | |
330 | if (err) | |
331 | return err; | |
332 | ||
333 | microcode_init_cpu(cpu, resume); | |
334 | ||
335 | return 0; | |
336 | } | |
337 | ||
338 | static int mc_sysdev_add(struct sys_device *sys_dev) | |
339 | { | |
340 | return __mc_sysdev_add(sys_dev, 0); | |
341 | } | |
342 | ||
343 | static int mc_sysdev_remove(struct sys_device *sys_dev) | |
344 | { | |
345 | int cpu = sys_dev->id; | |
346 | ||
347 | if (!cpu_online(cpu)) | |
348 | return 0; | |
349 | ||
350 | pr_debug("microcode: CPU%d removed\n", cpu); | |
8d86f390 | 351 | microcode_ops->microcode_fini_cpu(cpu); |
3e135d88 PO |
352 | sysfs_remove_group(&sys_dev->kobj, &mc_attr_group); |
353 | return 0; | |
354 | } | |
355 | ||
356 | static int mc_sysdev_resume(struct sys_device *dev) | |
357 | { | |
358 | int cpu = dev->id; | |
359 | ||
360 | if (!cpu_online(cpu)) | |
361 | return 0; | |
362 | pr_debug("microcode: CPU%d resumed\n", cpu); | |
363 | /* only CPU 0 will apply ucode here */ | |
8d86f390 | 364 | microcode_ops->apply_microcode(0); |
3e135d88 PO |
365 | return 0; |
366 | } | |
367 | ||
368 | static struct sysdev_driver mc_sysdev_driver = { | |
369 | .add = mc_sysdev_add, | |
370 | .remove = mc_sysdev_remove, | |
371 | .resume = mc_sysdev_resume, | |
372 | }; | |
373 | ||
374 | static __cpuinit int | |
375 | mc_cpu_callback(struct notifier_block *nb, unsigned long action, void *hcpu) | |
376 | { | |
377 | unsigned int cpu = (unsigned long)hcpu; | |
378 | struct sys_device *sys_dev; | |
379 | ||
380 | sys_dev = get_cpu_sysdev(cpu); | |
381 | switch (action) { | |
382 | case CPU_UP_CANCELED_FROZEN: | |
383 | /* The CPU refused to come up during a system resume */ | |
8d86f390 | 384 | microcode_ops->microcode_fini_cpu(cpu); |
3e135d88 PO |
385 | break; |
386 | case CPU_ONLINE: | |
387 | case CPU_DOWN_FAILED: | |
388 | mc_sysdev_add(sys_dev); | |
389 | break; | |
390 | case CPU_ONLINE_FROZEN: | |
391 | /* System-wide resume is in progress, try to apply microcode */ | |
8d86f390 | 392 | if (microcode_ops->apply_microcode_check_cpu(cpu)) { |
3e135d88 | 393 | /* The application of microcode failed */ |
8d86f390 | 394 | microcode_ops->microcode_fini_cpu(cpu); |
3e135d88 PO |
395 | __mc_sysdev_add(sys_dev, 1); |
396 | break; | |
397 | } | |
398 | case CPU_DOWN_FAILED_FROZEN: | |
399 | if (sysfs_create_group(&sys_dev->kobj, &mc_attr_group)) | |
400 | printk(KERN_ERR "microcode: Failed to create the sysfs " | |
401 | "group for CPU%d\n", cpu); | |
402 | break; | |
403 | case CPU_DOWN_PREPARE: | |
404 | mc_sysdev_remove(sys_dev); | |
405 | break; | |
406 | case CPU_DOWN_PREPARE_FROZEN: | |
407 | /* Suspend is in progress, only remove the interface */ | |
408 | sysfs_remove_group(&sys_dev->kobj, &mc_attr_group); | |
409 | break; | |
410 | } | |
411 | return NOTIFY_OK; | |
412 | } | |
413 | ||
414 | static struct notifier_block __refdata mc_cpu_notifier = { | |
415 | .notifier_call = mc_cpu_callback, | |
416 | }; | |
417 | ||
45b1e23e | 418 | int microcode_init(void *opaque, struct module *module) |
3e135d88 | 419 | { |
8d86f390 | 420 | struct microcode_ops *ops = (struct microcode_ops *)opaque; |
3e135d88 PO |
421 | int error; |
422 | ||
8d86f390 PO |
423 | if (microcode_ops) { |
424 | printk(KERN_ERR "microcode: already loaded the other module\n"); | |
425 | return -EEXIST; | |
426 | } | |
427 | ||
428 | microcode_ops = ops; | |
3e135d88 PO |
429 | |
430 | error = microcode_dev_init(); | |
431 | if (error) | |
432 | return error; | |
433 | microcode_pdev = platform_device_register_simple("microcode", -1, | |
434 | NULL, 0); | |
435 | if (IS_ERR(microcode_pdev)) { | |
436 | microcode_dev_exit(); | |
437 | return PTR_ERR(microcode_pdev); | |
438 | } | |
439 | ||
440 | get_online_cpus(); | |
441 | error = sysdev_driver_register(&cpu_sysdev_class, &mc_sysdev_driver); | |
442 | put_online_cpus(); | |
443 | if (error) { | |
444 | microcode_dev_exit(); | |
445 | platform_device_unregister(microcode_pdev); | |
446 | return error; | |
447 | } | |
448 | ||
449 | register_hotcpu_notifier(&mc_cpu_notifier); | |
8d86f390 PO |
450 | |
451 | printk(KERN_INFO | |
452 | "Microcode Update Driver: v" MICROCODE_VERSION | |
453 | " <tigran@aivazian.fsnet.co.uk>" | |
454 | " <peter.oruba@amd.com>\n"); | |
455 | ||
3e135d88 PO |
456 | return 0; |
457 | } | |
8d86f390 | 458 | EXPORT_SYMBOL_GPL(microcode_init); |
3e135d88 | 459 | |
45b1e23e | 460 | void __exit microcode_exit (void) |
3e135d88 PO |
461 | { |
462 | microcode_dev_exit(); | |
463 | ||
464 | unregister_hotcpu_notifier(&mc_cpu_notifier); | |
465 | ||
466 | get_online_cpus(); | |
467 | sysdev_driver_unregister(&cpu_sysdev_class, &mc_sysdev_driver); | |
468 | put_online_cpus(); | |
469 | ||
470 | platform_device_unregister(microcode_pdev); | |
3e135d88 | 471 | |
8d86f390 PO |
472 | microcode_ops = NULL; |
473 | ||
474 | printk(KERN_INFO | |
475 | "Microcode Update Driver: v" MICROCODE_VERSION " removed.\n"); | |
476 | } | |
477 | EXPORT_SYMBOL_GPL(microcode_exit); |