Merge branches 'fixes', 'cleanups' and 'boards'
[linux-2.6] / arch / x86 / kernel / microcode_amd.c
1 /*
2  *  AMD CPU Microcode Update Driver for Linux
3  *  Copyright (C) 2008 Advanced Micro Devices Inc.
4  *
5  *  Author: Peter Oruba <peter.oruba@amd.com>
6  *
7  *  Based on work by:
8  *  Tigran Aivazian <tigran@aivazian.fsnet.co.uk>
9  *
10  *  This driver allows to upgrade microcode on AMD
11  *  family 0x10 and 0x11 processors.
12  *
13  *  Licensed under the terms of the GNU General Public
14  *  License version 2. See file COPYING for details.
15 */
16
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>
27 #include <linux/mm.h>
28 #include <linux/fs.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>
35 #include <linux/uaccess.h>
36
37 #include <asm/msr.h>
38 #include <asm/processor.h>
39 #include <asm/microcode.h>
40
41 MODULE_DESCRIPTION("AMD Microcode Update Driver");
42 MODULE_AUTHOR("Peter Oruba");
43 MODULE_LICENSE("GPL v2");
44
45 #define UCODE_MAGIC                0x00414d44
46 #define UCODE_EQUIV_CPU_TABLE_TYPE 0x00000000
47 #define UCODE_UCODE_TYPE           0x00000001
48
49 struct equiv_cpu_entry {
50         u32     installed_cpu;
51         u32     fixed_errata_mask;
52         u32     fixed_errata_compare;
53         u16     equiv_cpu;
54         u16     res;
55 } __attribute__((packed));
56
57 struct microcode_header_amd {
58         u32     data_code;
59         u32     patch_id;
60         u16     mc_patch_data_id;
61         u8      mc_patch_data_len;
62         u8      init_flag;
63         u32     mc_patch_data_checksum;
64         u32     nb_dev_id;
65         u32     sb_dev_id;
66         u16     processor_rev_id;
67         u8      nb_rev_id;
68         u8      sb_rev_id;
69         u8      bios_api_rev;
70         u8      reserved1[3];
71         u32     match_reg[8];
72 } __attribute__((packed));
73
74 struct microcode_amd {
75         struct microcode_header_amd hdr;
76         unsigned int mpb[0];
77 };
78
79 #define UCODE_MAX_SIZE                  2048
80 #define UCODE_CONTAINER_SECTION_HDR     8
81 #define UCODE_CONTAINER_HEADER_SIZE     12
82
83 /* serialize access to the physical write */
84 static DEFINE_SPINLOCK(microcode_update_lock);
85
86 static struct equiv_cpu_entry *equiv_cpu_table;
87
88 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
89 {
90         struct cpuinfo_x86 *c = &cpu_data(cpu);
91         u32 dummy;
92
93         memset(csig, 0, sizeof(*csig));
94         if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
95                 printk(KERN_WARNING "microcode: CPU%d: AMD CPU family 0x%x not "
96                        "supported\n", cpu, c->x86);
97                 return -1;
98         }
99         rdmsr(MSR_AMD64_PATCH_LEVEL, csig->rev, dummy);
100         printk(KERN_INFO "microcode: CPU%d: patch_level=0x%x\n", cpu, csig->rev);
101         return 0;
102 }
103
104 static int get_matching_microcode(int cpu, void *mc, int rev)
105 {
106         struct microcode_header_amd *mc_header = mc;
107         unsigned int current_cpu_id;
108         u16 equiv_cpu_id = 0;
109         unsigned int i = 0;
110
111         BUG_ON(equiv_cpu_table == NULL);
112         current_cpu_id = cpuid_eax(0x00000001);
113
114         while (equiv_cpu_table[i].installed_cpu != 0) {
115                 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
116                         equiv_cpu_id = equiv_cpu_table[i].equiv_cpu;
117                         break;
118                 }
119                 i++;
120         }
121
122         if (!equiv_cpu_id) {
123                 printk(KERN_WARNING "microcode: CPU%d: cpu revision "
124                        "not listed in equivalent cpu table\n", cpu);
125                 return 0;
126         }
127
128         if (mc_header->processor_rev_id != equiv_cpu_id) {
129                 printk(KERN_ERR "microcode: CPU%d: patch mismatch "
130                        "(processor_rev_id: %x, equiv_cpu_id: %x)\n",
131                        cpu, mc_header->processor_rev_id, equiv_cpu_id);
132                 return 0;
133         }
134
135         /* ucode might be chipset specific -- currently we don't support this */
136         if (mc_header->nb_dev_id || mc_header->sb_dev_id) {
137                 printk(KERN_ERR "microcode: CPU%d: loading of chipset "
138                        "specific code not yet supported\n", cpu);
139                 return 0;
140         }
141
142         if (mc_header->patch_id <= rev)
143                 return 0;
144
145         return 1;
146 }
147
148 static void apply_microcode_amd(int cpu)
149 {
150         unsigned long flags;
151         u32 rev, dummy;
152         int cpu_num = raw_smp_processor_id();
153         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
154         struct microcode_amd *mc_amd = uci->mc;
155
156         /* We should bind the task to the CPU */
157         BUG_ON(cpu_num != cpu);
158
159         if (mc_amd == NULL)
160                 return;
161
162         spin_lock_irqsave(&microcode_update_lock, flags);
163         wrmsrl(MSR_AMD64_PATCH_LOADER, (u64)(long)&mc_amd->hdr.data_code);
164         /* get patch id after patching */
165         rdmsr(MSR_AMD64_PATCH_LEVEL, rev, dummy);
166         spin_unlock_irqrestore(&microcode_update_lock, flags);
167
168         /* check current patch id and patch's id for match */
169         if (rev != mc_amd->hdr.patch_id) {
170                 printk(KERN_ERR "microcode: CPU%d: update failed "
171                        "(for patch_level=0x%x)\n", cpu, mc_amd->hdr.patch_id);
172                 return;
173         }
174
175         printk(KERN_INFO "microcode: CPU%d: updated (new patch_level=0x%x)\n",
176                cpu, rev);
177
178         uci->cpu_sig.rev = rev;
179 }
180
181 static int get_ucode_data(void *to, const u8 *from, size_t n)
182 {
183         memcpy(to, from, n);
184         return 0;
185 }
186
187 static void *get_next_ucode(const u8 *buf, unsigned int size,
188                             unsigned int *mc_size)
189 {
190         unsigned int total_size;
191         u8 section_hdr[UCODE_CONTAINER_SECTION_HDR];
192         void *mc;
193
194         if (get_ucode_data(section_hdr, buf, UCODE_CONTAINER_SECTION_HDR))
195                 return NULL;
196
197         if (section_hdr[0] != UCODE_UCODE_TYPE) {
198                 printk(KERN_ERR "microcode: error: invalid type field in "
199                        "container file section header\n");
200                 return NULL;
201         }
202
203         total_size = (unsigned long) (section_hdr[4] + (section_hdr[5] << 8));
204
205         printk(KERN_DEBUG "microcode: size %u, total_size %u\n",
206                size, total_size);
207
208         if (total_size > size || total_size > UCODE_MAX_SIZE) {
209                 printk(KERN_ERR "microcode: error: size mismatch\n");
210                 return NULL;
211         }
212
213         mc = vmalloc(UCODE_MAX_SIZE);
214         if (mc) {
215                 memset(mc, 0, UCODE_MAX_SIZE);
216                 if (get_ucode_data(mc, buf + UCODE_CONTAINER_SECTION_HDR,
217                                    total_size)) {
218                         vfree(mc);
219                         mc = NULL;
220                 } else
221                         *mc_size = total_size + UCODE_CONTAINER_SECTION_HDR;
222         }
223         return mc;
224 }
225
226
227 static int install_equiv_cpu_table(const u8 *buf)
228 {
229         u8 *container_hdr[UCODE_CONTAINER_HEADER_SIZE];
230         unsigned int *buf_pos = (unsigned int *)container_hdr;
231         unsigned long size;
232
233         if (get_ucode_data(&container_hdr, buf, UCODE_CONTAINER_HEADER_SIZE))
234                 return 0;
235
236         size = buf_pos[2];
237
238         if (buf_pos[1] != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
239                 printk(KERN_ERR "microcode: error: invalid type field in "
240                        "container file section header\n");
241                 return 0;
242         }
243
244         equiv_cpu_table = (struct equiv_cpu_entry *) vmalloc(size);
245         if (!equiv_cpu_table) {
246                 printk(KERN_ERR "microcode: failed to allocate "
247                        "equivalent CPU table\n");
248                 return 0;
249         }
250
251         buf += UCODE_CONTAINER_HEADER_SIZE;
252         if (get_ucode_data(equiv_cpu_table, buf, size)) {
253                 vfree(equiv_cpu_table);
254                 return 0;
255         }
256
257         return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
258 }
259
260 static void free_equiv_cpu_table(void)
261 {
262         if (equiv_cpu_table) {
263                 vfree(equiv_cpu_table);
264                 equiv_cpu_table = NULL;
265         }
266 }
267
268 static int generic_load_microcode(int cpu, const u8 *data, size_t size)
269 {
270         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
271         const u8 *ucode_ptr = data;
272         void *new_mc = NULL;
273         void *mc;
274         int new_rev = uci->cpu_sig.rev;
275         unsigned int leftover;
276         unsigned long offset;
277
278         offset = install_equiv_cpu_table(ucode_ptr);
279         if (!offset) {
280                 printk(KERN_ERR "microcode: failed to create "
281                        "equivalent cpu table\n");
282                 return -EINVAL;
283         }
284
285         ucode_ptr += offset;
286         leftover = size - offset;
287
288         while (leftover) {
289                 unsigned int uninitialized_var(mc_size);
290                 struct microcode_header_amd *mc_header;
291
292                 mc = get_next_ucode(ucode_ptr, leftover, &mc_size);
293                 if (!mc)
294                         break;
295
296                 mc_header = (struct microcode_header_amd *)mc;
297                 if (get_matching_microcode(cpu, mc, new_rev)) {
298                         if (new_mc)
299                                 vfree(new_mc);
300                         new_rev = mc_header->patch_id;
301                         new_mc  = mc;
302                 } else
303                         vfree(mc);
304
305                 ucode_ptr += mc_size;
306                 leftover  -= mc_size;
307         }
308
309         if (new_mc) {
310                 if (!leftover) {
311                         if (uci->mc)
312                                 vfree(uci->mc);
313                         uci->mc = new_mc;
314                         pr_debug("microcode: CPU%d found a matching microcode "
315                                  "update with version 0x%x (current=0x%x)\n",
316                                  cpu, new_rev, uci->cpu_sig.rev);
317                 } else
318                         vfree(new_mc);
319         }
320
321         free_equiv_cpu_table();
322
323         return (int)leftover;
324 }
325
326 static int request_microcode_fw(int cpu, struct device *device)
327 {
328         const char *fw_name = "amd-ucode/microcode_amd.bin";
329         const struct firmware *firmware;
330         int ret;
331
332         /* We should bind the task to the CPU */
333         BUG_ON(cpu != raw_smp_processor_id());
334
335         ret = request_firmware(&firmware, fw_name, device);
336         if (ret) {
337                 printk(KERN_ERR "microcode: failed to load file %s\n", fw_name);
338                 return ret;
339         }
340
341         ret = generic_load_microcode(cpu, firmware->data, firmware->size);
342
343         release_firmware(firmware);
344
345         return ret;
346 }
347
348 static int request_microcode_user(int cpu, const void __user *buf, size_t size)
349 {
350         printk(KERN_INFO "microcode: AMD microcode update via "
351                "/dev/cpu/microcode not supported\n");
352         return -1;
353 }
354
355 static void microcode_fini_cpu_amd(int cpu)
356 {
357         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
358
359         vfree(uci->mc);
360         uci->mc = NULL;
361 }
362
363 static struct microcode_ops microcode_amd_ops = {
364         .request_microcode_user           = request_microcode_user,
365         .request_microcode_fw             = request_microcode_fw,
366         .collect_cpu_info                 = collect_cpu_info_amd,
367         .apply_microcode                  = apply_microcode_amd,
368         .microcode_fini_cpu               = microcode_fini_cpu_amd,
369 };
370
371 struct microcode_ops * __init init_amd_microcode(void)
372 {
373         return &microcode_amd_ops;
374 }
375