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