168933a7263140870b531b099a77cb5ff7d5c2c4
[coreboot.git] / src / arch / x86 / boot / acpi.c
1 /*
2  * This file is part of the coreboot project.
3  *
4  * coreboot ACPI Table support
5  * written by Stefan Reinauer <stepan@openbios.org>
6  *
7  * Copyright (C) 2004 SUSE LINUX AG
8  * Copyright (C) 2005-2009 coresystems GmbH
9  *
10  * ACPI FADT, FACS, and DSDT table support added by
11  * Nick Barker <nick.barker9@btinternet.com>, and those portions
12  * Copyright (C) 2004 Nick Barker
13  *
14  * Copyright (C) 2005 ADVANCED MICRO DEVICES, INC. All Rights Reserved.
15  * 2005.9 yhlu add SRAT table generation
16  */
17
18 /*
19  * Each system port implementing ACPI has to provide two functions:
20  *
21  *   write_acpi_tables()
22  *   acpi_dump_apics()
23  *
24  * See Kontron 986LCD-M port for a good example of an ACPI implementation
25  * in coreboot.
26  */
27
28 #include <console/console.h>
29 #include <string.h>
30 #include <arch/acpi.h>
31 #include <arch/acpigen.h>
32 #include <device/pci.h>
33 #include <cbmem.h>
34 #include <cpu/x86/lapic_def.h>
35
36 u8 acpi_checksum(u8 *table, u32 length)
37 {
38         u8 ret = 0;
39         while (length--) {
40                 ret += *table;
41                 table++;
42         }
43         return -ret;
44 }
45
46 /**
47  * Add an ACPI table to the RSDT (and XSDT) structure, recalculate length
48  * and checksum.
49  */
50 void acpi_add_table(acpi_rsdp_t *rsdp, void *table)
51 {
52         int i, entries_num;
53         acpi_rsdt_t *rsdt;
54         acpi_xsdt_t *xsdt = NULL;
55
56         /* The RSDT is mandatory... */
57         rsdt = (acpi_rsdt_t *)rsdp->rsdt_address;
58
59         /* ...while the XSDT is not. */
60         if (rsdp->xsdt_address)
61                 xsdt = (acpi_xsdt_t *)((u32)rsdp->xsdt_address);
62
63         /* This should always be MAX_ACPI_TABLES. */
64         entries_num = ARRAY_SIZE(rsdt->entry);
65
66         for (i = 0; i < entries_num; i++) {
67                 if (rsdt->entry[i] == 0)
68                         break;
69         }
70
71         if (i >= entries_num) {
72                 printk(BIOS_ERR, "ACPI: Error: Could not add ACPI table, "
73                         "too many tables.\n");
74                 return;
75         }
76
77         /* Add table to the RSDT. */
78         rsdt->entry[i] = (u32)table;
79
80         /* Fix RSDT length or the kernel will assume invalid entries. */
81         rsdt->header.length = sizeof(acpi_header_t) + (sizeof(u32) * (i + 1));
82
83         /* Re-calculate checksum. */
84         rsdt->header.checksum = 0; /* Hope this won't get optimized away */
85         rsdt->header.checksum = acpi_checksum((u8 *)rsdt, rsdt->header.length);
86
87         /*
88          * And now the same thing for the XSDT. We use the same index as for
89          * now we want the XSDT and RSDT to always be in sync in coreboot.
90          */
91         if (xsdt) {
92                 /* Add table to the XSDT. */
93                 xsdt->entry[i] = (u64)(u32)table;
94
95                 /* Fix XSDT length. */
96                 xsdt->header.length = sizeof(acpi_header_t) +
97                                         (sizeof(u64) * (i + 1));
98
99                 /* Re-calculate checksum. */
100                 xsdt->header.checksum = 0;
101                 xsdt->header.checksum = acpi_checksum((u8 *)xsdt,
102                                                         xsdt->header.length);
103         }
104
105         printk(BIOS_DEBUG, "ACPI: added table %d/%d, length now %d\n",
106                 i + 1, entries_num, rsdt->header.length);
107 }
108
109 int acpi_create_mcfg_mmconfig(acpi_mcfg_mmconfig_t *mmconfig, u32 base,
110                                 u16 seg_nr, u8 start, u8 end)
111 {
112         mmconfig->base_address = base;
113         mmconfig->base_reserved = 0;
114         mmconfig->pci_segment_group_number = seg_nr;
115         mmconfig->start_bus_number = start;
116         mmconfig->end_bus_number = end;
117
118         return sizeof(acpi_mcfg_mmconfig_t);
119 }
120
121 int acpi_create_madt_lapic(acpi_madt_lapic_t *lapic, u8 cpu, u8 apic)
122 {
123         lapic->type = 0; /* Local APIC structure */
124         lapic->length = sizeof(acpi_madt_lapic_t);
125         lapic->flags = (1 << 0); /* Processor/LAPIC enabled */
126         lapic->processor_id = cpu;
127         lapic->apic_id = apic;
128
129         return lapic->length;
130 }
131
132 unsigned long acpi_create_madt_lapics(unsigned long current)
133 {
134         device_t cpu;
135         int cpu_index = 0;
136
137         for (cpu = all_devices; cpu; cpu = cpu->next) {
138                 if ((cpu->path.type != DEVICE_PATH_APIC) ||
139                         (cpu->bus->dev->path.type != DEVICE_PATH_APIC_CLUSTER)) {
140                         continue;
141                 }
142                 if (!cpu->enabled)
143                         continue;
144                 current += acpi_create_madt_lapic((acpi_madt_lapic_t *)current,
145                                 cpu_index, cpu->path.apic.apic_id);
146                 cpu_index++;
147         }
148
149         return current;
150 }
151
152 int acpi_create_madt_ioapic(acpi_madt_ioapic_t *ioapic, u8 id, u32 addr,
153                                 u32 gsi_base)
154 {
155         ioapic->type = 1; /* I/O APIC structure */
156         ioapic->length = sizeof(acpi_madt_ioapic_t);
157         ioapic->reserved = 0x00;
158         ioapic->gsi_base = gsi_base;
159         ioapic->ioapic_id = id;
160         ioapic->ioapic_addr = addr;
161
162         return ioapic->length;
163 }
164
165 int acpi_create_madt_irqoverride(acpi_madt_irqoverride_t *irqoverride,
166                 u8 bus, u8 source, u32 gsirq, u16 flags)
167 {
168         irqoverride->type = 2; /* Interrupt source override */
169         irqoverride->length = sizeof(acpi_madt_irqoverride_t);
170         irqoverride->bus = bus;
171         irqoverride->source = source;
172         irqoverride->gsirq = gsirq;
173         irqoverride->flags = flags;
174
175         return irqoverride->length;
176 }
177
178 int acpi_create_madt_lapic_nmi(acpi_madt_lapic_nmi_t *lapic_nmi, u8 cpu,
179                                 u16 flags, u8 lint)
180 {
181         lapic_nmi->type = 4; /* Local APIC NMI structure */
182         lapic_nmi->length = sizeof(acpi_madt_lapic_nmi_t);
183         lapic_nmi->flags = flags;
184         lapic_nmi->processor_id = cpu;
185         lapic_nmi->lint = lint;
186
187         return lapic_nmi->length;
188 }
189
190 void acpi_create_madt(acpi_madt_t *madt)
191 {
192         acpi_header_t *header = &(madt->header);
193         unsigned long current = (unsigned long)madt + sizeof(acpi_madt_t);
194
195         memset((void *)madt, 0, sizeof(acpi_madt_t));
196
197         /* Fill out header fields. */
198         memcpy(header->signature, "APIC", 4);
199         memcpy(header->oem_id, OEM_ID, 6);
200         memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
201         memcpy(header->asl_compiler_id, ASLC, 4);
202
203         header->length = sizeof(acpi_madt_t);
204         header->revision = 1; /* ACPI 1.0/2.0: 1, ACPI 3.0: 2, ACPI 4.0: 3 */
205
206         madt->lapic_addr = LOCAL_APIC_ADDR;
207         madt->flags = 0x1; /* PCAT_COMPAT */
208
209         current = acpi_fill_madt(current);
210
211         /* (Re)calculate length and checksum. */
212         header->length = current - (unsigned long)madt;
213
214         header->checksum = acpi_checksum((void *)madt, header->length);
215 }
216
217 /* MCFG is defined in the PCI Firmware Specification 3.0. */
218 void acpi_create_mcfg(acpi_mcfg_t *mcfg)
219 {
220         acpi_header_t *header = &(mcfg->header);
221         unsigned long current = (unsigned long)mcfg + sizeof(acpi_mcfg_t);
222
223         memset((void *)mcfg, 0, sizeof(acpi_mcfg_t));
224
225         /* Fill out header fields. */
226         memcpy(header->signature, "MCFG", 4);
227         memcpy(header->oem_id, OEM_ID, 6);
228         memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
229         memcpy(header->asl_compiler_id, ASLC, 4);
230
231         header->length = sizeof(acpi_mcfg_t);
232         header->revision = 1;
233
234         current = acpi_fill_mcfg(current);
235
236         /* (Re)calculate length and checksum. */
237         header->length = current - (unsigned long)mcfg;
238         header->checksum = acpi_checksum((void *)mcfg, header->length);
239 }
240
241 /*
242  * This can be overriden by platform ACPI setup code, if it calls
243  * acpi_create_ssdt_generator().
244  */
245 unsigned long __attribute__((weak)) acpi_fill_ssdt_generator(
246                         unsigned long current, const char *oem_table_id)
247 {
248         return current;
249 }
250
251 void acpi_create_ssdt_generator(acpi_header_t *ssdt, const char *oem_table_id)
252 {
253         unsigned long current = (unsigned long)ssdt + sizeof(acpi_header_t);
254
255         memset((void *)ssdt, 0, sizeof(acpi_header_t));
256
257         memcpy(&ssdt->signature, "SSDT", 4);
258         ssdt->revision = 2; /* ACPI 1.0/2.0: ?, ACPI 3.0/4.0: 2 */
259         memcpy(&ssdt->oem_id, OEM_ID, 6);
260         memcpy(&ssdt->oem_table_id, oem_table_id, 8);
261         ssdt->oem_revision = 42;
262         memcpy(&ssdt->asl_compiler_id, ASLC, 4);
263         ssdt->asl_compiler_revision = 42;
264         ssdt->length = sizeof(acpi_header_t);
265
266         acpigen_set_current((char *) current);
267         current = acpi_fill_ssdt_generator(current, oem_table_id);
268
269         /* (Re)calculate length and checksum. */
270         ssdt->length = current - (unsigned long)ssdt;
271         ssdt->checksum = acpi_checksum((void *)ssdt, ssdt->length);
272 }
273
274 int acpi_create_srat_lapic(acpi_srat_lapic_t *lapic, u8 node, u8 apic)
275 {
276         memset((void *)lapic, 0, sizeof(acpi_srat_lapic_t));
277
278         lapic->type = 0; /* Processor local APIC/SAPIC affinity structure */
279         lapic->length = sizeof(acpi_srat_lapic_t);
280         lapic->flags = (1 << 0); /* Enabled (the use of this structure). */
281         lapic->proximity_domain_7_0 = node;
282         /* TODO: proximity_domain_31_8, local SAPIC EID, clock domain. */
283         lapic->apic_id = apic;
284
285         return lapic->length;
286 }
287
288 int acpi_create_srat_mem(acpi_srat_mem_t *mem, u8 node, u32 basek, u32 sizek,
289                                 u32 flags)
290 {
291         mem->type = 1; /* Memory affinity structure */
292         mem->length = sizeof(acpi_srat_mem_t);
293         mem->base_address_low = (basek << 10);
294         mem->base_address_high = (basek >> (32 - 10));
295         mem->length_low = (sizek << 10);
296         mem->length_high = (sizek >> (32 - 10));
297         mem->proximity_domain = node;
298         mem->flags = flags;
299
300         return mem->length;
301 }
302
303 /* http://www.microsoft.com/whdc/system/sysinternals/sratdwn.mspx */
304 void acpi_create_srat(acpi_srat_t *srat)
305 {
306         acpi_header_t *header = &(srat->header);
307         unsigned long current = (unsigned long)srat + sizeof(acpi_srat_t);
308
309         memset((void *)srat, 0, sizeof(acpi_srat_t));
310
311         /* Fill out header fields. */
312         memcpy(header->signature, "SRAT", 4);
313         memcpy(header->oem_id, OEM_ID, 6);
314         memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
315         memcpy(header->asl_compiler_id, ASLC, 4);
316
317         header->length = sizeof(acpi_srat_t);
318         header->revision = 1; /* ACPI 1.0: N/A, 2.0: 1, 3.0: 2, 4.0: 3 */
319
320         srat->resv = 1; /* Spec: Reserved to 1 for backwards compatibility. */
321
322         current = acpi_fill_srat(current);
323
324         /* (Re)calculate length and checksum. */
325         header->length = current - (unsigned long)srat;
326         header->checksum = acpi_checksum((void *)srat, header->length);
327 }
328
329 /* http://h21007.www2.hp.com/portal/download/files/unprot/Itanium/slit.pdf */
330 void acpi_create_slit(acpi_slit_t *slit)
331 {
332         acpi_header_t *header = &(slit->header);
333         unsigned long current = (unsigned long)slit + sizeof(acpi_slit_t);
334
335         memset((void *)slit, 0, sizeof(acpi_slit_t));
336
337         /* Fill out header fields. */
338         memcpy(header->signature, "SLIT", 4);
339         memcpy(header->oem_id, OEM_ID, 6);
340         memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
341         memcpy(header->asl_compiler_id, ASLC, 4);
342
343         header->length = sizeof(acpi_slit_t);
344         header->revision = 1; /* ACPI 1.0: N/A, ACPI 2.0/3.0/4.0: 1 */
345
346         current = acpi_fill_slit(current);
347
348         /* (Re)calculate length and checksum. */
349         header->length = current - (unsigned long)slit;
350         header->checksum = acpi_checksum((void *)slit, header->length);
351 }
352
353 /* http://www.intel.com/hardwaredesign/hpetspec_1.pdf */
354 void acpi_create_hpet(acpi_hpet_t *hpet)
355 {
356 #define HPET_ADDR 0xfed00000ULL
357         acpi_header_t *header = &(hpet->header);
358         acpi_addr_t *addr = &(hpet->addr);
359
360         memset((void *)hpet, 0, sizeof(acpi_hpet_t));
361
362         /* Fill out header fields. */
363         memcpy(header->signature, "HPET", 4);
364         memcpy(header->oem_id, OEM_ID, 6);
365         memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
366         memcpy(header->asl_compiler_id, ASLC, 4);
367
368         header->length = sizeof(acpi_hpet_t);
369         header->revision = 1; /* Currently 1. Table added in ACPI 2.0. */
370
371         /* Fill out HPET address. */
372         addr->space_id = 0; /* Memory */
373         addr->bit_width = 64;
374         addr->bit_offset = 0;
375         addr->addrl = HPET_ADDR & 0xffffffff;
376         addr->addrh = HPET_ADDR >> 32;
377
378         hpet->id = 0x102282a0; /* AMD! FIXME */
379         hpet->number = 0;
380         hpet->min_tick = 4096;
381
382         header->checksum = acpi_checksum((void *)hpet, sizeof(acpi_hpet_t));
383 }
384
385 void acpi_create_facs(acpi_facs_t *facs)
386 {
387         memset((void *)facs, 0, sizeof(acpi_facs_t));
388
389         memcpy(facs->signature, "FACS", 4);
390         facs->length = sizeof(acpi_facs_t);
391         facs->hardware_signature = 0;
392         facs->firmware_waking_vector = 0;
393         facs->global_lock = 0;
394         facs->flags = 0;
395         facs->x_firmware_waking_vector_l = 0;
396         facs->x_firmware_waking_vector_h = 0;
397         facs->version = 1; /* ACPI 1.0: 0, ACPI 2.0/3.0: 1, ACPI 4.0: 2 */
398 }
399
400 void acpi_write_rsdt(acpi_rsdt_t *rsdt)
401 {
402         acpi_header_t *header = &(rsdt->header);
403
404         /* Fill out header fields. */
405         memcpy(header->signature, "RSDT", 4);
406         memcpy(header->oem_id, OEM_ID, 6);
407         memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
408         memcpy(header->asl_compiler_id, ASLC, 4);
409
410         header->length = sizeof(acpi_rsdt_t);
411         header->revision = 1; /* ACPI 1.0/2.0/3.0/4.0: 1 */
412
413         /* Entries are filled in later, we come with an empty set. */
414
415         /* Fix checksum. */
416         header->checksum = acpi_checksum((void *)rsdt, sizeof(acpi_rsdt_t));
417 }
418
419 void acpi_write_xsdt(acpi_xsdt_t *xsdt)
420 {
421         acpi_header_t *header = &(xsdt->header);
422
423         /* Fill out header fields. */
424         memcpy(header->signature, "XSDT", 4);
425         memcpy(header->oem_id, OEM_ID, 6);
426         memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
427         memcpy(header->asl_compiler_id, ASLC, 4);
428
429         header->length = sizeof(acpi_xsdt_t);
430         header->revision = 1; /* ACPI 1.0: N/A, 2.0/3.0/4.0: 1 */
431
432         /* Entries are filled in later, we come with an empty set. */
433
434         /* Fix checksum. */
435         header->checksum = acpi_checksum((void *)xsdt, sizeof(acpi_xsdt_t));
436 }
437
438 void acpi_write_rsdp(acpi_rsdp_t *rsdp, acpi_rsdt_t *rsdt, acpi_xsdt_t *xsdt)
439 {
440         memset(rsdp, 0, sizeof(acpi_rsdp_t));
441
442         memcpy(rsdp->signature, RSDP_SIG, 8);
443         memcpy(rsdp->oem_id, OEM_ID, 6);
444
445         rsdp->length = sizeof(acpi_rsdp_t);
446         rsdp->rsdt_address = (u32)rsdt;
447
448         /*
449          * Revision: ACPI 1.0: 0, ACPI 2.0/3.0/4.0: 2.
450          *
451          * Some OSes expect an XSDT to be present for RSD PTR revisions >= 2.
452          * If we don't have an ACPI XSDT, force ACPI 1.0 (and thus RSD PTR
453          * revision 0).
454          */
455         if (xsdt == NULL) {
456                 rsdp->revision = 0;
457         } else {
458                 rsdp->xsdt_address = (u64)(u32)xsdt;
459                 rsdp->revision = 2;
460         }
461
462         /* Calculate checksums. */
463         rsdp->checksum = acpi_checksum((void *)rsdp, 20);
464         rsdp->ext_checksum = acpi_checksum((void *)rsdp, sizeof(acpi_rsdp_t));
465 }
466
467 #if CONFIG_HAVE_ACPI_RESUME == 1
468 void suspend_resume(void)
469 {
470         void *wake_vec;
471
472         /* If we happen to be resuming find wakeup vector and jump to OS. */
473         wake_vec = acpi_find_wakeup_vector();
474         if (wake_vec)
475                 acpi_jump_to_wakeup(wake_vec);
476 }
477
478 /* This is to be filled by SB code - startup value what was found. */
479 u8 acpi_slp_type = 0;
480
481 static int acpi_is_wakeup(void)
482 {
483         /* Both resume from S2 and resume from S3 restart at CPU reset */
484         return (acpi_slp_type == 3 || acpi_slp_type == 2);
485 }
486
487 static acpi_rsdp_t *valid_rsdp(acpi_rsdp_t *rsdp)
488 {
489         if (strncmp((char *)rsdp, RSDP_SIG, sizeof(RSDP_SIG) - 1) != 0)
490                 return NULL;
491
492         printk(BIOS_DEBUG, "Looking on %p for valid checksum\n", rsdp);
493
494         if (acpi_checksum((void *)rsdp, 20) != 0)
495                 return NULL;
496         printk(BIOS_DEBUG, "Checksum 1 passed\n");
497
498         if ((rsdp->revision > 1) && (acpi_checksum((void *)rsdp,
499                                                 rsdp->length) != 0))
500                 return NULL;
501         printk(BIOS_DEBUG, "Checksum 2 passed all OK\n");
502
503         return rsdp;
504 }
505
506 static acpi_rsdp_t *rsdp;
507
508 void *acpi_get_wakeup_rsdp(void)
509 {
510         return rsdp;
511 }
512
513 void *acpi_find_wakeup_vector(void)
514 {
515         char *p, *end;
516         acpi_rsdt_t *rsdt;
517         acpi_facs_t *facs;
518         acpi_fadt_t *fadt;
519         void *wake_vec;
520         int i;
521
522         rsdp = NULL;
523
524         if (!acpi_is_wakeup())
525                 return NULL;
526
527         printk(BIOS_DEBUG, "Trying to find the wakeup vector...\n");
528
529         /* Find RSDP. */
530         for (p = (char *)0xe0000; p < (char *)0xfffff; p += 16) {
531                 if ((rsdp = valid_rsdp((acpi_rsdp_t *)p)))
532                         break;
533         }
534
535         if (rsdp == NULL)
536                 return NULL;
537
538         printk(BIOS_DEBUG, "RSDP found at %p\n", rsdp);
539         rsdt = (acpi_rsdt_t *) rsdp->rsdt_address;
540
541         end = (char *)rsdt + rsdt->header.length;
542         printk(BIOS_DEBUG, "RSDT found at %p ends at %p\n", rsdt, end);
543
544         for (i = 0; ((char *)&rsdt->entry[i]) < end; i++) {
545                 fadt = (acpi_fadt_t *)rsdt->entry[i];
546                 if (strncmp((char *)fadt, "FACP", 4) == 0)
547                         break;
548                 fadt = NULL;
549         }
550
551         if (fadt == NULL)
552                 return NULL;
553
554         printk(BIOS_DEBUG, "FADT found at %p\n", fadt);
555         facs = (acpi_facs_t *)fadt->firmware_ctrl;
556
557         if (facs == NULL) {
558                 printk(BIOS_DEBUG, "No FACS found, wake up from S3 not "
559                        "possible.\n");
560                 return NULL;
561         }
562
563         printk(BIOS_DEBUG, "FACS found at %p\n", facs);
564         wake_vec = (void *)facs->firmware_waking_vector;
565         printk(BIOS_DEBUG, "OS waking vector is %p\n", wake_vec);
566
567         return wake_vec;
568 }
569
570 #if CONFIG_SMP
571 extern char *lowmem_backup;
572 extern char *lowmem_backup_ptr;
573 extern int lowmem_backup_size;
574 #endif
575
576 #define WAKEUP_BASE 0x600
577
578 void (*acpi_do_wakeup)(u32 vector, u32 backup_source, u32 backup_target,
579        u32 backup_size) __attribute__((regparm(0))) = (void *)WAKEUP_BASE;
580
581 extern unsigned char __wakeup, __wakeup_size;
582
583 void acpi_jump_to_wakeup(void *vector)
584 {
585         u32 acpi_backup_memory = (u32)cbmem_find(CBMEM_ID_RESUME);
586
587         if (!acpi_backup_memory) {
588                 printk(BIOS_WARNING, "ACPI: Backup memory missing. "
589                        "No S3 resume.\n");
590                 return;
591         }
592
593 #if CONFIG_SMP
594         // FIXME: This should go into the ACPI backup memory, too. No pork saussages.
595         /*
596          * Just restore the SMP trampoline and continue with wakeup on
597          * assembly level.
598          */
599         memcpy(lowmem_backup_ptr, lowmem_backup, lowmem_backup_size);
600 #endif
601
602         /* Copy wakeup trampoline in place. */
603         memcpy((void *)WAKEUP_BASE, &__wakeup, (size_t)&__wakeup_size);
604
605         acpi_do_wakeup((u32)vector, acpi_backup_memory, CONFIG_RAMBASE,
606                        HIGH_MEMORY_SAVE);
607 }
608 #endif