BACKPORT: haswell: use asmlinkage for assembly-called funcs
[gnutoo-for-coreboot:coreboot.git] / src / cpu / intel / haswell / mp_init.c
1 /*
2  * This file is part of the coreboot project.
3  *
4  * Copyright (C) 2013 ChromeOS Authors
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License as
8  * published by the Free Software Foundation; version 2 of
9  * the License.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
19  * MA 02110-1301 USA
20  */
21
22 #include <console/console.h>
23 #include <stdint.h>
24 #include <rmodule.h>
25 #include <arch/cpu.h>
26 #include <cpu/cpu.h>
27 #include <cpu/intel/microcode.h>
28 #include <cpu/x86/cache.h>
29 #include <cpu/x86/lapic.h>
30 #include <cpu/x86/msr.h>
31 #include <cpu/x86/mtrr.h>
32 #include <cpu/x86/smm.h>
33 #include <delay.h>
34 #include <device/device.h>
35 #include <device/path.h>
36 #include <lib.h>
37 #include <smp/atomic.h>
38 #include <smp/spinlock.h>
39 #include "haswell.h"
40
41 /* This needs to match the layout in the .module_parametrs section. */
42 struct sipi_params {
43         u16 gdtlimit;
44         u32 gdt;
45         u16 unused;
46         u32 idt_ptr;
47         u32 stack_top;
48         u32 stack_size;
49         u32 microcode_ptr;
50         u32 msr_table_ptr;
51         u32 msr_count;
52         u32 c_handler;
53         u32 c_handler_arg;
54         u8 apic_to_cpu_num[CONFIG_MAX_CPUS];
55 } __attribute__((packed));
56
57 /* This also needs to match the assembly code for saved MSR encoding. */
58 struct saved_msr {
59         u32 index;
60         u32 lo;
61         u32 hi;
62 } __attribute__((packed));
63
64
65 /* The sipi vector rmodule is included in the ramstage using 'objdump -B'. */
66 extern char _binary_sipi_vector_start[];
67 /* These symbols are defined in c_start.S. */
68 extern char gdt[];
69 extern char gdt_end[];
70 extern char idtarg[];
71
72 /* This table keeps track of each CPU's APIC id. */
73 static u8 apic_id_table[CONFIG_MAX_CPUS];
74 static device_t cpu_devs[CONFIG_MAX_CPUS];
75
76 /* Number of APs checked that have checked in. */
77 static atomic_t num_aps;
78 /* Number of APs that have relocated their SMM handler. */
79 static atomic_t num_aps_relocated_smm;
80 /* Barrier to stop APs from performing SMM relcoation. */
81 static int smm_relocation_barrier_begin __attribute__ ((aligned (64)));
82
83 static inline void mfence(void)
84 {
85         __asm__ __volatile__("mfence\t\n": : :"memory");
86 }
87
88 static inline void wait_for_barrier(volatile int *barrier)
89 {
90         while (*barrier == 0) {
91                 asm ("pause");
92         }
93 }
94
95 static inline void release_barrier(volatile int *barrier)
96 {
97         *barrier = 1;
98 }
99
100 static void ap_wait_for_smm_relocation_begin(void)
101 {
102         wait_for_barrier(&smm_relocation_barrier_begin);
103 }
104
105 /* This function pointer is used by the non-BSP CPUs to initiate relocation. It
106  * points to either a serial or parallel SMM initiation. */
107 static void (*ap_initiate_smm_relocation)(void) = &smm_initiate_relocation;
108
109
110 /* Returns 1 if timeout waiting for APs. 0 if target aps found. */
111 static int wait_for_aps(atomic_t *val, int target, int total_delay,
112                         int delay_step)
113 {
114         int timeout = 0;
115         int delayed = 0;
116         while (atomic_read(val) != target) {
117                 udelay(delay_step);
118                 delayed += delay_step;
119                 if (delayed >= total_delay) {
120                         timeout = 1;
121                         break;
122                 }
123         }
124
125         return timeout;
126 }
127
128 void release_aps_for_smm_relocation(int do_parallel)
129 {
130         /* Change the AP SMM initiation function, and ensure it is visible
131          * before releasing the APs. */
132         if (do_parallel) {
133                 ap_initiate_smm_relocation = &smm_initiate_relocation_parallel;
134                 mfence();
135         }
136         release_barrier(&smm_relocation_barrier_begin);
137         /* Wait for CPUs to relocate their SMM handler up to 100ms. */
138         if (wait_for_aps(&num_aps_relocated_smm, atomic_read(&num_aps),
139                          100000 /* 100 ms */, 200 /* us */))
140                 printk(BIOS_DEBUG, "Timed out waiting for AP SMM relocation\n");
141 }
142
143 /* The mtrr code sets up ROM caching on the BSP, but not the others. However,
144  * the boot loader payload disables this. In order for Linux not to complain
145  * ensure the caching is disabled for tha APs before going to sleep. */
146 static void cleanup_rom_caching(void)
147 {
148         x86_mtrr_disable_rom_caching();
149 }
150
151 /* By the time APs call ap_init() caching has been setup, and microcode has
152  * been loaded. */
153 static void asmlinkage ap_init(unsigned int cpu, void *microcode_ptr)
154 {
155         struct cpu_info *info;
156
157         /* Signal that the AP has arrived. */
158         atomic_inc(&num_aps);
159
160         /* Ensure the local apic is enabled */
161         enable_lapic();
162
163         info = cpu_info();
164         info->index = cpu;
165         info->cpu = cpu_devs[cpu];
166
167         apic_id_table[info->index] = lapicid();
168         info->cpu->path.apic.apic_id = apic_id_table[info->index];
169
170         /* Call through the cpu driver's initialization. */
171         cpu_initialize(info->index);
172
173         ap_wait_for_smm_relocation_begin();
174
175         ap_initiate_smm_relocation();
176
177         /* Indicate that SMM relocation has occured on this thread. */
178         atomic_inc(&num_aps_relocated_smm);
179
180         /* After SMM relocation a 2nd microcode load is required. */
181         intel_microcode_load_unlocked(microcode_ptr);
182
183         /* The MTRR resources are core scoped. Therefore, there is no need
184          * to do the same work twice. Additionally, this check keeps the
185          * ROM cache enabled on the BSP since its hyperthread sibling won't
186          * call cleanup_rom_caching(). */
187         if ((lapicid() & 1) == 0)
188                 cleanup_rom_caching();
189
190         /* FIXME(adurbin): park CPUs properly -- preferably somewhere in a
191          * reserved part of memory that the OS cannot get to. */
192         stop_this_cpu();
193 }
194
195 static void setup_default_sipi_vector_params(struct sipi_params *sp)
196 {
197         int i;
198
199         sp->gdt = (u32)&gdt;
200         sp->gdtlimit = (u32)&gdt_end - (u32)&gdt - 1;
201         sp->idt_ptr = (u32)&idtarg;
202         sp->stack_size = CONFIG_STACK_SIZE;
203         sp->stack_top = (u32)&_estack;
204         /* Adjust the stack top to take into account cpu_info. */
205         sp->stack_top -= sizeof(struct cpu_info);
206         /* Default to linear APIC id space. */
207         for (i = 0; i < CONFIG_MAX_CPUS; i++)
208                 sp->apic_to_cpu_num[i] = i;
209 }
210
211 #define NUM_FIXED_MTRRS 11
212 static unsigned int fixed_mtrrs[NUM_FIXED_MTRRS] = {
213         MTRRfix64K_00000_MSR, MTRRfix16K_80000_MSR, MTRRfix16K_A0000_MSR,
214         MTRRfix4K_C0000_MSR, MTRRfix4K_C8000_MSR, MTRRfix4K_D0000_MSR,
215         MTRRfix4K_D8000_MSR, MTRRfix4K_E0000_MSR, MTRRfix4K_E8000_MSR,
216         MTRRfix4K_F0000_MSR, MTRRfix4K_F8000_MSR,
217 };
218
219 static inline struct saved_msr *save_msr(int index, struct saved_msr *entry)
220 {
221         msr_t msr;
222
223         msr = rdmsr(index);
224         entry->index = index;
225         entry->lo = msr.lo;
226         entry->hi = msr.hi;
227
228         /* Return the next entry. */
229         entry++;
230         return entry;
231 }
232
233 static int save_bsp_msrs(char *start, int size)
234 {
235         int msr_count;
236         int num_var_mtrrs;
237         struct saved_msr *msr_entry;
238         int i;
239         msr_t msr;
240
241         /* Determine number of MTRRs need to be saved. */
242         msr = rdmsr(MTRRcap_MSR);
243         num_var_mtrrs = msr.lo & 0xff;
244
245         /* 2 * num_var_mtrrs for base and mask. +1 for IA32_MTRR_DEF_TYPE. */
246         msr_count = 2 * num_var_mtrrs + NUM_FIXED_MTRRS + 1;
247
248         if ((msr_count * sizeof(struct saved_msr)) > size) {
249                 printk(BIOS_CRIT, "Cannot mirror all %d msrs.\n", msr_count);
250                 return -1;
251         }
252
253         msr_entry = (void *)start;
254         for (i = 0; i < NUM_FIXED_MTRRS; i++) {
255                 msr_entry = save_msr(fixed_mtrrs[i], msr_entry);
256         }
257
258         for (i = 0; i < num_var_mtrrs; i++) {
259                 msr_entry = save_msr(MTRRphysBase_MSR(i), msr_entry);
260                 msr_entry = save_msr(MTRRphysMask_MSR(i), msr_entry);
261         }
262
263         msr_entry = save_msr(MTRRdefType_MSR, msr_entry);
264
265         return msr_count;
266 }
267
268 /* The SIPI vector is loaded at the SMM_DEFAULT_BASE. The reason is at the
269  * memory range is already reserved so the OS cannot use it. That region is
270  * free to use for AP bringup before SMM is initialized. */
271 static u32 sipi_vector_location = SMM_DEFAULT_BASE;
272 static int sipi_vector_location_size = SMM_DEFAULT_SIZE;
273
274 static int load_sipi_vector(const void *microcode_patch)
275 {
276         struct rmodule sipi_mod;
277         int module_size;
278         int num_msrs;
279         struct sipi_params *sp;
280         char *mod_loc = (void *)sipi_vector_location;
281         const int loc_size = sipi_vector_location_size;
282
283         if (rmodule_parse(&_binary_sipi_vector_start, &sipi_mod)) {
284                 printk(BIOS_CRIT, "Unable to parse sipi module.\n");
285                 return -1;
286         }
287
288         if (rmodule_entry_offset(&sipi_mod) != 0) {
289                 printk(BIOS_CRIT, "SIPI module entry offset is not 0!\n");
290                 return -1;
291         }
292
293         if (rmodule_load_alignment(&sipi_mod) != 4096) {
294                 printk(BIOS_CRIT, "SIPI module load alignment(%d) != 4096.\n",
295                        rmodule_load_alignment(&sipi_mod));
296                 return -1;
297         }
298
299         module_size = rmodule_memory_size(&sipi_mod);
300
301         /* Align to 4 bytes. */
302         module_size += 3;
303         module_size &= ~3;
304
305         if (module_size > loc_size) {
306                 printk(BIOS_CRIT, "SIPI module size (%d) > region size (%d).\n",
307                        module_size, loc_size);
308                 return -1;
309         }
310
311         num_msrs = save_bsp_msrs(&mod_loc[module_size], loc_size - module_size);
312
313         if (num_msrs < 0) {
314                 printk(BIOS_CRIT, "Error mirroring BSP's msrs.\n");
315                 return -1;
316         }
317
318         if (rmodule_load(mod_loc, &sipi_mod)) {
319                 printk(BIOS_CRIT, "Unable to load SIPI module.\n");
320                 return -1;
321         }
322
323         sp = rmodule_parameters(&sipi_mod);
324
325         if (sp == NULL) {
326                 printk(BIOS_CRIT, "SIPI module has no parameters.\n");
327                 return -1;
328         }
329
330         setup_default_sipi_vector_params(sp);
331         /* Setup MSR table. */
332         sp->msr_table_ptr = (u32)&mod_loc[module_size];
333         sp->msr_count = num_msrs;
334         /* Provide pointer to microcode patch. */
335         sp->microcode_ptr = (u32)microcode_patch;
336         /* The microcode pointer is passed on through to the c handler so
337          * that it can be loaded again after SMM relocation. */
338         sp->c_handler_arg = (u32)microcode_patch;
339         sp->c_handler = (u32)&ap_init;
340
341         /* Make sure SIPI vector hits RAM so the APs that come up will see
342          * the startup code even if the caches are disabled.  */
343         wbinvd();
344
345         return 0;
346 }
347
348 static int allocate_cpu_devices(struct bus *cpu_bus, int *total_hw_threads)
349 {
350         int i;
351         int num_threads;
352         int num_cores;
353         int max_cpus;
354         struct cpu_info *info;
355         msr_t msr;
356
357         info = cpu_info();
358         cpu_devs[info->index] = info->cpu;
359         apic_id_table[info->index] = info->cpu->path.apic.apic_id;
360
361         msr = rdmsr(CORE_THREAD_COUNT_MSR);
362         num_threads = (msr.lo >> 0) & 0xffff;
363         num_cores = (msr.lo >> 16) & 0xffff;
364         printk(BIOS_DEBUG, "CPU has %u cores, %u threads enabled.\n",
365                num_cores, num_threads);
366
367         max_cpus = num_threads;
368         *total_hw_threads = num_threads;
369         if (num_threads > CONFIG_MAX_CPUS) {
370                 printk(BIOS_CRIT, "CPU count(%d) exceeds CONFIG_MAX_CPUS(%d)\n",
371                        num_threads, CONFIG_MAX_CPUS);
372                 max_cpus = CONFIG_MAX_CPUS;
373         }
374
375         for (i = 1; i < max_cpus; i++) {
376                 struct device_path cpu_path;
377                 device_t new;
378
379                 /* Build the cpu device path */
380                 cpu_path.type = DEVICE_PATH_APIC;
381                 cpu_path.apic.apic_id = info->cpu->path.apic.apic_id + i;
382
383                 /* Allocate the new cpu device structure */
384                 new = alloc_find_dev(cpu_bus, &cpu_path);
385                 if (new == NULL) {
386                         printk(BIOS_CRIT, "Could not allocte cpu device\n");
387                         max_cpus--;
388                 }
389                 cpu_devs[i] = new;
390         }
391
392         return max_cpus;
393 }
394
395 int setup_ap_init(struct bus *cpu_bus, int *max_cpus,
396                   const void *microcode_patch)
397 {
398         int num_cpus;
399         int hw_threads;
400
401         /* Default to currently running CPU. */
402         num_cpus = allocate_cpu_devices(cpu_bus, &hw_threads);
403
404         /* Load the SIPI vector. */
405         if (load_sipi_vector(microcode_patch))
406                 return -1;
407
408         *max_cpus = num_cpus;
409
410         if (num_cpus < hw_threads) {
411                 printk(BIOS_CRIT,
412                        "ERROR: More HW threads (%d) than support (%d).\n",
413                        hw_threads, num_cpus);
414                 return -1;
415         }
416
417         return 0;
418 }
419
420 /* Returns 1 for timeout. 0 on success. */
421 static int apic_wait_timeout(int total_delay, int delay_step)
422 {
423         int total = 0;
424         int timeout = 0;
425
426         while (lapic_read(LAPIC_ICR) & LAPIC_ICR_BUSY) {
427                 udelay(delay_step);
428                 total += delay_step;
429                 if (total >= total_delay) {
430                         timeout = 1;
431                         break;
432                 }
433         }
434
435         return timeout;
436 }
437
438 int start_aps(struct bus *cpu_bus, int ap_count)
439 {
440         int sipi_vector;
441
442         if (ap_count == 0)
443                 return 0;
444
445         /* The vector is sent as a 4k aligned address in one byte. */
446         sipi_vector = sipi_vector_location >> 12;
447
448         if (sipi_vector > 256) {
449                 printk(BIOS_CRIT, "SIPI vector too large! 0x%08x\n",
450                        sipi_vector);
451                 return -1;
452         }
453
454         printk(BIOS_DEBUG, "Attempting to start %d APs\n", ap_count);
455
456         if ((lapic_read(LAPIC_ICR) & LAPIC_ICR_BUSY)) {
457                 printk(BIOS_DEBUG, "Waiting for ICR not to be busy...");
458                 if (apic_wait_timeout(1000 /* 1 ms */, 50)) {
459                         printk(BIOS_DEBUG, "timed out. Aborting.\n");
460                         return -1;
461                 } else
462                         printk(BIOS_DEBUG, "done.\n");
463         }
464
465         /* Send INIT IPI to all but self. */
466         lapic_write_around(LAPIC_ICR2, SET_LAPIC_DEST_FIELD(0));
467         lapic_write_around(LAPIC_ICR, LAPIC_DEST_ALLBUT | LAPIC_INT_ASSERT |
468                            LAPIC_DM_INIT);
469         printk(BIOS_DEBUG, "Waiting for 10ms after sending INIT.\n");
470         mdelay(10);
471
472         /* Send 1st SIPI */
473         if ((lapic_read(LAPIC_ICR) & LAPIC_ICR_BUSY)) {
474                 printk(BIOS_DEBUG, "Waiting for ICR not to be busy...");
475                 if (apic_wait_timeout(1000 /* 1 ms */, 50)) {
476                         printk(BIOS_DEBUG, "timed out. Aborting.\n");
477                         return -1;
478                 } else
479                         printk(BIOS_DEBUG, "done.\n");
480         }
481
482         lapic_write_around(LAPIC_ICR2, SET_LAPIC_DEST_FIELD(0));
483         lapic_write_around(LAPIC_ICR, LAPIC_DEST_ALLBUT | LAPIC_INT_ASSERT |
484                            LAPIC_DM_STARTUP | sipi_vector);
485         printk(BIOS_DEBUG, "Waiting for 1st SIPI to complete...");
486         if (apic_wait_timeout(10000 /* 10 ms */, 50 /* us */)) {
487                 printk(BIOS_DEBUG, "timed out.\n");
488                 return -1;
489         } else {
490                 printk(BIOS_DEBUG, "done.\n");
491         }
492         /* Wait for CPUs to check in up to 200 us. */
493         wait_for_aps(&num_aps, ap_count, 200 /* us */, 15 /* us */);
494
495         /* Send 2nd SIPI */
496         if ((lapic_read(LAPIC_ICR) & LAPIC_ICR_BUSY)) {
497                 printk(BIOS_DEBUG, "Waiting for ICR not to be busy...");
498                 if (apic_wait_timeout(1000 /* 1 ms */, 50)) {
499                         printk(BIOS_DEBUG, "timed out. Aborting.\n");
500                         return -1;
501                 } else
502                         printk(BIOS_DEBUG, "done.\n");
503         }
504
505         lapic_write_around(LAPIC_ICR2, SET_LAPIC_DEST_FIELD(0));
506         lapic_write_around(LAPIC_ICR, LAPIC_DEST_ALLBUT | LAPIC_INT_ASSERT |
507                            LAPIC_DM_STARTUP | sipi_vector);
508         printk(BIOS_DEBUG, "Waiting for 2nd SIPI to complete...");
509         if (apic_wait_timeout(10000 /* 10 ms */, 50 /* us */)) {
510                 printk(BIOS_DEBUG, "timed out.\n");
511                 return -1;
512         } else {
513                 printk(BIOS_DEBUG, "done.\n");
514         }
515
516         /* Wait for CPUs to check in. */
517         if (wait_for_aps(&num_aps, ap_count, 10000 /* 10 ms */, 50 /* us */)) {
518                 printk(BIOS_DEBUG, "Not all APs checked in: %d/%d.\n",
519                        atomic_read(&num_aps), ap_count);
520                 return -1;
521         }
522
523         return 0;
524 }
525
526 void smm_initiate_relocation_parallel(void)
527 {
528         if ((lapic_read(LAPIC_ICR) & LAPIC_ICR_BUSY)) {
529                 printk(BIOS_DEBUG, "Waiting for ICR not to be busy...");
530                 if (apic_wait_timeout(1000 /* 1 ms */, 50)) {
531                         printk(BIOS_DEBUG, "timed out. Aborting.\n");
532                         return;
533                 } else
534                         printk(BIOS_DEBUG, "done.\n");
535         }
536
537         lapic_write_around(LAPIC_ICR2, SET_LAPIC_DEST_FIELD(lapicid()));
538         lapic_write_around(LAPIC_ICR, LAPIC_INT_ASSERT | LAPIC_DM_SMI);
539         if (apic_wait_timeout(1000 /* 1 ms */, 100 /* us */)) {
540                 printk(BIOS_DEBUG, "SMI Relocation timed out.\n");
541         } else
542                 printk(BIOS_DEBUG, "Relocation complete.\n");
543
544 }
545
546 DECLARE_SPIN_LOCK(smm_relocation_lock);
547
548 void smm_initiate_relocation(void)
549 {
550         spin_lock(&smm_relocation_lock);
551         smm_initiate_relocation_parallel();
552         spin_unlock(&smm_relocation_lock);
553 }
554