x86: microcode_amd: fix compile warning
[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         unsigned int installed_cpu;
51         unsigned int fixed_errata_mask;
52         unsigned int fixed_errata_compare;
53         unsigned int equiv_cpu;
54 };
55
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         u16 processor_rev_id;
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];
71 };
72
73 struct microcode_amd {
74         struct microcode_header_amd hdr;
75         unsigned int mpb[0];
76 };
77
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) \
86          + MC_HEADER_SIZE)
87
88 /* serialize access to the physical write */
89 static DEFINE_SPINLOCK(microcode_update_lock);
90
91 static struct equiv_cpu_entry *equiv_cpu_table;
92
93 static int collect_cpu_info_amd(int cpu, struct cpu_signature *csig)
94 {
95         struct cpuinfo_x86 *c = &cpu_data(cpu);
96
97         memset(csig, 0, sizeof(*csig));
98
99         if (c->x86_vendor != X86_VENDOR_AMD || c->x86 < 0x10) {
100                 printk(KERN_ERR "microcode: CPU%d not a capable AMD processor\n",
101                        cpu);
102                 return -1;
103         }
104
105         asm volatile("movl %1, %%ecx; rdmsr"
106                      : "=a" (csig->rev)
107                      : "i" (0x0000008B) : "ecx");
108
109         printk(KERN_INFO "microcode: collect_cpu_info_amd : patch_id=0x%x\n",
110                 csig->rev);
111
112         return 0;
113 }
114
115 static int get_matching_microcode(int cpu, void *mc, int rev)
116 {
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;
121         unsigned int i = 0;
122
123         BUG_ON(equiv_cpu_table == NULL);
124         current_cpu_id = cpuid_eax(0x00000001);
125
126         while (equiv_cpu_table[i].installed_cpu != 0) {
127                 if (current_cpu_id == equiv_cpu_table[i].installed_cpu) {
128                         equiv_cpu_id = equiv_cpu_table[i].equiv_cpu & 0xffff;
129                         break;
130                 }
131                 i++;
132         }
133
134         if (!equiv_cpu_id) {
135                 printk(KERN_ERR "microcode: CPU%d cpu_id "
136                        "not found in equivalent cpu table\n", cpu);
137                 return 0;
138         }
139
140         if (mc_header->processor_rev_id != equiv_cpu_id) {
141                 printk(KERN_ERR "microcode: CPU%d patch does not match "
142                        "(processor_rev_id: %x, eqiv_cpu_id: %x)\n",
143                        cpu, mc_header->processor_rev_id, equiv_cpu_id);
144                 return 0;
145         }
146
147         /* ucode may be northbridge specific */
148         if (mc_header->nb_dev_id) {
149                 nb_pci_dev = pci_get_device(PCI_VENDOR_ID_AMD,
150                                             (mc_header->nb_dev_id & 0xff),
151                                             NULL);
152                 if ((!nb_pci_dev) ||
153                     (mc_header->nb_rev_id != nb_pci_dev->revision)) {
154                         printk(KERN_ERR "microcode: CPU%d NB mismatch\n", cpu);
155                         pci_dev_put(nb_pci_dev);
156                         return 0;
157                 }
158                 pci_dev_put(nb_pci_dev);
159         }
160
161         /* ucode may be southbridge specific */
162         if (mc_header->sb_dev_id) {
163                 sb_pci_dev = pci_get_device(PCI_VENDOR_ID_AMD,
164                                             (mc_header->sb_dev_id & 0xff),
165                                             NULL);
166                 if ((!sb_pci_dev) ||
167                     (mc_header->sb_rev_id != sb_pci_dev->revision)) {
168                         printk(KERN_ERR "microcode: CPU%d SB mismatch\n", cpu);
169                         pci_dev_put(sb_pci_dev);
170                         return 0;
171                 }
172                 pci_dev_put(sb_pci_dev);
173         }
174
175         if (mc_header->patch_id <= rev)
176                 return 0;
177
178         return 1;
179 }
180
181 static void apply_microcode_amd(int cpu)
182 {
183         unsigned long flags;
184         unsigned int eax, edx;
185         unsigned int rev;
186         int cpu_num = raw_smp_processor_id();
187         struct ucode_cpu_info *uci = ucode_cpu_info + cpu_num;
188         struct microcode_amd *mc_amd = uci->mc;
189         unsigned long addr;
190
191         /* We should bind the task to the CPU */
192         BUG_ON(cpu_num != cpu);
193
194         if (mc_amd == NULL)
195                 return;
196
197         spin_lock_irqsave(&microcode_update_lock, flags);
198
199         addr = (unsigned long)&mc_amd->hdr.data_code;
200         edx = (unsigned int)(((unsigned long)upper_32_bits(addr)));
201         eax = (unsigned int)(((unsigned long)lower_32_bits(addr)));
202
203         asm volatile("movl %0, %%ecx; wrmsr" :
204                      : "i" (0xc0010020), "a" (eax), "d" (edx) : "ecx");
205
206         /* get patch id after patching */
207         asm volatile("movl %1, %%ecx; rdmsr"
208                      : "=a" (rev)
209                      : "i" (0x0000008B) : "ecx");
210
211         spin_unlock_irqrestore(&microcode_update_lock, flags);
212
213         /* check current patch id and patch's id for match */
214         if (rev != mc_amd->hdr.patch_id) {
215                 printk(KERN_ERR "microcode: CPU%d update from revision "
216                        "0x%x to 0x%x failed\n", cpu_num,
217                        mc_amd->hdr.patch_id, rev);
218                 return;
219         }
220
221         printk(KERN_INFO "microcode: CPU%d updated from revision "
222                "0x%x to 0x%x\n",
223                cpu_num, uci->cpu_sig.rev, mc_amd->hdr.patch_id);
224
225         uci->cpu_sig.rev = rev;
226 }
227
228 static void *get_next_ucode(const u8 *buf, unsigned int size,
229                         int (*get_ucode_data)(void *, const u8 *, size_t),
230                         unsigned int *mc_size)
231 {
232         unsigned int total_size;
233 #define UCODE_CONTAINER_SECTION_HDR     8
234         u8 section_hdr[UCODE_CONTAINER_SECTION_HDR];
235         void *mc;
236
237         if (get_ucode_data(section_hdr, buf, UCODE_CONTAINER_SECTION_HDR))
238                 return NULL;
239
240         if (section_hdr[0] != UCODE_UCODE_TYPE) {
241                 printk(KERN_ERR "microcode: error! "
242                        "Wrong microcode payload type field\n");
243                 return NULL;
244         }
245
246         total_size = (unsigned long) (section_hdr[4] + (section_hdr[5] << 8));
247
248         printk(KERN_INFO "microcode: size %u, total_size %u\n",
249                 size, total_size);
250
251         if (total_size > size || total_size > UCODE_MAX_SIZE) {
252                 printk(KERN_ERR "microcode: error! Bad data in microcode data file\n");
253                 return NULL;
254         }
255
256         mc = vmalloc(UCODE_MAX_SIZE);
257         if (mc) {
258                 memset(mc, 0, UCODE_MAX_SIZE);
259                 if (get_ucode_data(mc, buf + UCODE_CONTAINER_SECTION_HDR,
260                                    total_size)) {
261                         vfree(mc);
262                         mc = NULL;
263                 } else
264                         *mc_size = total_size + UCODE_CONTAINER_SECTION_HDR;
265         }
266 #undef UCODE_CONTAINER_SECTION_HDR
267         return mc;
268 }
269
270
271 static int install_equiv_cpu_table(const u8 *buf,
272                 int (*get_ucode_data)(void *, const u8 *, size_t))
273 {
274 #define UCODE_CONTAINER_HEADER_SIZE     12
275         u8 *container_hdr[UCODE_CONTAINER_HEADER_SIZE];
276         unsigned int *buf_pos = (unsigned int *)container_hdr;
277         unsigned long size;
278
279         if (get_ucode_data(&container_hdr, buf, UCODE_CONTAINER_HEADER_SIZE))
280                 return 0;
281
282         size = buf_pos[2];
283
284         if (buf_pos[1] != UCODE_EQUIV_CPU_TABLE_TYPE || !size) {
285                 printk(KERN_ERR "microcode: error! "
286                        "Wrong microcode equivalent cpu table\n");
287                 return 0;
288         }
289
290         equiv_cpu_table = (struct equiv_cpu_entry *) vmalloc(size);
291         if (!equiv_cpu_table) {
292                 printk(KERN_ERR "microcode: error, can't allocate memory for equiv CPU table\n");
293                 return 0;
294         }
295
296         buf += UCODE_CONTAINER_HEADER_SIZE;
297         if (get_ucode_data(equiv_cpu_table, buf, size)) {
298                 vfree(equiv_cpu_table);
299                 return 0;
300         }
301
302         return size + UCODE_CONTAINER_HEADER_SIZE; /* add header length */
303 #undef UCODE_CONTAINER_HEADER_SIZE
304 }
305
306 static void free_equiv_cpu_table(void)
307 {
308         if (equiv_cpu_table) {
309                 vfree(equiv_cpu_table);
310                 equiv_cpu_table = NULL;
311         }
312 }
313
314 static int generic_load_microcode(int cpu, const u8 *data, size_t size,
315                 int (*get_ucode_data)(void *, const u8 *, size_t))
316 {
317         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
318         const u8 *ucode_ptr = data;
319         void *new_mc = NULL;
320         void *mc;
321         int new_rev = uci->cpu_sig.rev;
322         unsigned int leftover;
323         unsigned long offset;
324
325         offset = install_equiv_cpu_table(ucode_ptr, get_ucode_data);
326         if (!offset) {
327                 printk(KERN_ERR "microcode: installing equivalent cpu table failed\n");
328                 return -EINVAL;
329         }
330
331         ucode_ptr += offset;
332         leftover = size - offset;
333
334         while (leftover) {
335                 unsigned int uninitialized_var(mc_size);
336                 struct microcode_header_amd *mc_header;
337
338                 mc = get_next_ucode(ucode_ptr, leftover, get_ucode_data,
339                                     &mc_size);
340                 if (!mc)
341                         break;
342
343                 mc_header = (struct microcode_header_amd *)mc;
344                 if (get_matching_microcode(cpu, mc, new_rev)) {
345                         if (new_mc)
346                                 vfree(new_mc);
347                         new_rev = mc_header->patch_id;
348                         new_mc  = mc;
349                 } else
350                         vfree(mc);
351
352                 ucode_ptr += mc_size;
353                 leftover  -= mc_size;
354         }
355
356         if (new_mc) {
357                 if (!leftover) {
358                         if (uci->mc)
359                                 vfree(uci->mc);
360                         uci->mc = new_mc;
361                         pr_debug("microcode: CPU%d found a matching microcode "
362                                  "update with version 0x%x (current=0x%x)\n",
363                                  cpu, new_rev, uci->cpu_sig.rev);
364                 } else
365                         vfree(new_mc);
366         }
367
368         free_equiv_cpu_table();
369
370         return (int)leftover;
371 }
372
373 static int get_ucode_fw(void *to, const u8 *from, size_t n)
374 {
375         memcpy(to, from, n);
376         return 0;
377 }
378
379 static int request_microcode_fw(int cpu, struct device *device)
380 {
381         const char *fw_name = "amd-ucode/microcode_amd.bin";
382         const struct firmware *firmware;
383         int ret;
384
385         /* We should bind the task to the CPU */
386         BUG_ON(cpu != raw_smp_processor_id());
387
388         ret = request_firmware(&firmware, fw_name, device);
389         if (ret) {
390                 printk(KERN_ERR "microcode: ucode data file %s load failed\n",
391                        fw_name);
392                 return ret;
393         }
394
395         ret = generic_load_microcode(cpu, firmware->data, firmware->size,
396                         &get_ucode_fw);
397
398         release_firmware(firmware);
399
400         return ret;
401 }
402
403 static int request_microcode_user(int cpu, const void __user *buf, size_t size)
404 {
405         printk(KERN_WARNING "microcode: AMD microcode update via "
406                "/dev/cpu/microcode is not supported\n");
407         return -1;
408 }
409
410 static void microcode_fini_cpu_amd(int cpu)
411 {
412         struct ucode_cpu_info *uci = ucode_cpu_info + cpu;
413
414         vfree(uci->mc);
415         uci->mc = NULL;
416 }
417
418 static struct microcode_ops microcode_amd_ops = {
419         .request_microcode_user           = request_microcode_user,
420         .request_microcode_fw             = request_microcode_fw,
421         .collect_cpu_info                 = collect_cpu_info_amd,
422         .apply_microcode                  = apply_microcode_amd,
423         .microcode_fini_cpu               = microcode_fini_cpu_amd,
424 };
425
426 struct microcode_ops * __init init_amd_microcode(void)
427 {
428         return &microcode_amd_ops;
429 }