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