2 * This file is part of the coreboot project.
4 * coreboot ACPI Table support
5 * written by Stefan Reinauer <stepan@openbios.org>
7 * Copyright (C) 2004 SUSE LINUX AG
8 * Copyright (C) 2005-2009 coresystems GmbH
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
14 * Copyright (C) 2005 ADVANCED MICRO DEVICES, INC. All Rights Reserved.
15 * 2005.9 yhlu add SRAT table generation
19 * Each system port implementing ACPI has to provide two functions:
24 * See Kontron 986LCD-M port for a good example of an ACPI implementation
28 #include <console/console.h>
30 #include <arch/acpi.h>
31 #include <arch/acpigen.h>
32 #include <device/pci.h>
35 u8 acpi_checksum(u8 *table, u32 length)
46 * Add an ACPI table to the RSDT (and XSDT) structure, recalculate length
49 void acpi_add_table(acpi_rsdp_t *rsdp, void *table)
53 acpi_xsdt_t *xsdt = NULL;
55 /* The RSDT is mandatory... */
56 rsdt = (acpi_rsdt_t *)rsdp->rsdt_address;
58 /* ...while the XSDT is not. */
59 if (rsdp->xsdt_address)
60 xsdt = (acpi_xsdt_t *)((u32)rsdp->xsdt_address);
62 /* This should always be MAX_ACPI_TABLES. */
63 entries_num = ARRAY_SIZE(rsdt->entry);
65 for (i = 0; i < entries_num; i++) {
66 if (rsdt->entry[i] == 0)
70 if (i >= entries_num) {
71 printk(BIOS_ERR, "ACPI: Error: Could not add ACPI table, "
72 "too many tables.\n");
76 /* Add table to the RSDT. */
77 rsdt->entry[i] = (u32)table;
79 /* Fix RSDT length or the kernel will assume invalid entries. */
80 rsdt->header.length = sizeof(acpi_header_t) + (sizeof(u32) * (i + 1));
82 /* Re-calculate checksum. */
83 rsdt->header.checksum = 0; /* Hope this won't get optimized away */
84 rsdt->header.checksum = acpi_checksum((u8 *)rsdt, rsdt->header.length);
87 * And now the same thing for the XSDT. We use the same index as for
88 * now we want the XSDT and RSDT to always be in sync in coreboot.
91 /* Add table to the XSDT. */
92 xsdt->entry[i] = (u64)(u32)table;
94 /* Fix XSDT length. */
95 xsdt->header.length = sizeof(acpi_header_t) +
96 (sizeof(u64) * (i + 1));
98 /* Re-calculate checksum. */
99 xsdt->header.checksum = 0;
100 xsdt->header.checksum = acpi_checksum((u8 *)xsdt,
101 xsdt->header.length);
104 printk(BIOS_DEBUG, "ACPI: added table %d/%d, length now %d\n",
105 i + 1, entries_num, rsdt->header.length);
108 int acpi_create_mcfg_mmconfig(acpi_mcfg_mmconfig_t *mmconfig, u32 base,
109 u16 seg_nr, u8 start, u8 end)
111 mmconfig->base_address = base;
112 mmconfig->base_reserved = 0;
113 mmconfig->pci_segment_group_number = seg_nr;
114 mmconfig->start_bus_number = start;
115 mmconfig->end_bus_number = end;
117 return sizeof(acpi_mcfg_mmconfig_t);
120 int acpi_create_madt_lapic(acpi_madt_lapic_t *lapic, u8 cpu, u8 apic)
122 lapic->type = 0; /* Local APIC structure */
123 lapic->length = sizeof(acpi_madt_lapic_t);
124 lapic->flags = (1 << 0); /* Processor/LAPIC enabled */
125 lapic->processor_id = cpu;
126 lapic->apic_id = apic;
128 return lapic->length;
131 unsigned long acpi_create_madt_lapics(unsigned long current)
136 for (cpu = all_devices; cpu; cpu = cpu->next) {
137 if ((cpu->path.type != DEVICE_PATH_APIC) ||
138 (cpu->bus->dev->path.type != DEVICE_PATH_APIC_CLUSTER)) {
143 current += acpi_create_madt_lapic((acpi_madt_lapic_t *)current,
144 cpu_index, cpu->path.apic.apic_id);
151 int acpi_create_madt_ioapic(acpi_madt_ioapic_t *ioapic, u8 id, u32 addr,
154 ioapic->type = 1; /* I/O APIC structure */
155 ioapic->length = sizeof(acpi_madt_ioapic_t);
156 ioapic->reserved = 0x00;
157 ioapic->gsi_base = gsi_base;
158 ioapic->ioapic_id = id;
159 ioapic->ioapic_addr = addr;
161 return ioapic->length;
164 int acpi_create_madt_irqoverride(acpi_madt_irqoverride_t *irqoverride,
165 u8 bus, u8 source, u32 gsirq, u16 flags)
167 irqoverride->type = 2; /* Interrupt source override */
168 irqoverride->length = sizeof(acpi_madt_irqoverride_t);
169 irqoverride->bus = bus;
170 irqoverride->source = source;
171 irqoverride->gsirq = gsirq;
172 irqoverride->flags = flags;
174 return irqoverride->length;
177 int acpi_create_madt_lapic_nmi(acpi_madt_lapic_nmi_t *lapic_nmi, u8 cpu,
180 lapic_nmi->type = 4; /* Local APIC NMI structure */
181 lapic_nmi->length = sizeof(acpi_madt_lapic_nmi_t);
182 lapic_nmi->flags = flags;
183 lapic_nmi->processor_id = cpu;
184 lapic_nmi->lint = lint;
186 return lapic_nmi->length;
189 void acpi_create_madt(acpi_madt_t *madt)
191 #define LOCAL_APIC_ADDR 0xfee00000ULL
193 acpi_header_t *header = &(madt->header);
194 unsigned long current = (unsigned long)madt + sizeof(acpi_madt_t);
196 memset((void *)madt, 0, sizeof(acpi_madt_t));
198 /* Fill out header fields. */
199 memcpy(header->signature, "APIC", 4);
200 memcpy(header->oem_id, OEM_ID, 6);
201 memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
202 memcpy(header->asl_compiler_id, ASLC, 4);
204 header->length = sizeof(acpi_madt_t);
205 header->revision = 1; /* ACPI 1.0/2.0: 1, ACPI 3.0: 2, ACPI 4.0: 3 */
207 madt->lapic_addr = LOCAL_APIC_ADDR;
208 madt->flags = 0x1; /* PCAT_COMPAT */
210 current = acpi_fill_madt(current);
212 /* (Re)calculate length and checksum. */
213 header->length = current - (unsigned long)madt;
215 header->checksum = acpi_checksum((void *)madt, header->length);
218 /* MCFG is defined in the PCI Firmware Specification 3.0. */
219 void acpi_create_mcfg(acpi_mcfg_t *mcfg)
221 acpi_header_t *header = &(mcfg->header);
222 unsigned long current = (unsigned long)mcfg + sizeof(acpi_mcfg_t);
224 memset((void *)mcfg, 0, sizeof(acpi_mcfg_t));
226 /* Fill out header fields. */
227 memcpy(header->signature, "MCFG", 4);
228 memcpy(header->oem_id, OEM_ID, 6);
229 memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
230 memcpy(header->asl_compiler_id, ASLC, 4);
232 header->length = sizeof(acpi_mcfg_t);
233 header->revision = 1;
235 current = acpi_fill_mcfg(current);
237 /* (Re)calculate length and checksum. */
238 header->length = current - (unsigned long)mcfg;
239 header->checksum = acpi_checksum((void *)mcfg, header->length);
243 * This can be overriden by platform ACPI setup code, if it calls
244 * acpi_create_ssdt_generator().
246 unsigned long __attribute__((weak)) acpi_fill_ssdt_generator(
247 unsigned long current, const char *oem_table_id)
252 void acpi_create_ssdt_generator(acpi_header_t *ssdt, const char *oem_table_id)
254 unsigned long current = (unsigned long)ssdt + sizeof(acpi_header_t);
256 memset((void *)ssdt, 0, sizeof(acpi_header_t));
258 memcpy(&ssdt->signature, "SSDT", 4);
259 ssdt->revision = 2; /* ACPI 1.0/2.0: ?, ACPI 3.0/4.0: 2 */
260 memcpy(&ssdt->oem_id, OEM_ID, 6);
261 memcpy(&ssdt->oem_table_id, oem_table_id, 8);
262 ssdt->oem_revision = 42;
263 memcpy(&ssdt->asl_compiler_id, ASLC, 4);
264 ssdt->asl_compiler_revision = 42;
265 ssdt->length = sizeof(acpi_header_t);
267 acpigen_set_current((char *) current);
268 current = acpi_fill_ssdt_generator(current, oem_table_id);
270 /* (Re)calculate length and checksum. */
271 ssdt->length = current - (unsigned long)ssdt;
272 ssdt->checksum = acpi_checksum((void *)ssdt, ssdt->length);
275 int acpi_create_srat_lapic(acpi_srat_lapic_t *lapic, u8 node, u8 apic)
277 memset((void *)lapic, 0, sizeof(acpi_srat_lapic_t));
279 lapic->type = 0; /* Processor local APIC/SAPIC affinity structure */
280 lapic->length = sizeof(acpi_srat_lapic_t);
281 lapic->flags = (1 << 0); /* Enabled (the use of this structure). */
282 lapic->proximity_domain_7_0 = node;
283 /* TODO: proximity_domain_31_8, local SAPIC EID, clock domain. */
284 lapic->apic_id = apic;
286 return lapic->length;
289 int acpi_create_srat_mem(acpi_srat_mem_t *mem, u8 node, u32 basek, u32 sizek,
292 mem->type = 1; /* Memory affinity structure */
293 mem->length = sizeof(acpi_srat_mem_t);
294 mem->base_address_low = (basek << 10);
295 mem->base_address_high = (basek >> (32 - 10));
296 mem->length_low = (sizek << 10);
297 mem->length_high = (sizek >> (32 - 10));
298 mem->proximity_domain = node;
304 /* http://www.microsoft.com/whdc/system/sysinternals/sratdwn.mspx */
305 void acpi_create_srat(acpi_srat_t *srat)
307 acpi_header_t *header = &(srat->header);
308 unsigned long current = (unsigned long)srat + sizeof(acpi_srat_t);
310 memset((void *)srat, 0, sizeof(acpi_srat_t));
312 /* Fill out header fields. */
313 memcpy(header->signature, "SRAT", 4);
314 memcpy(header->oem_id, OEM_ID, 6);
315 memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
316 memcpy(header->asl_compiler_id, ASLC, 4);
318 header->length = sizeof(acpi_srat_t);
319 header->revision = 1; /* ACPI 1.0: N/A, 2.0: 1, 3.0: 2, 4.0: 3 */
321 srat->resv = 1; /* Spec: Reserved to 1 for backwards compatibility. */
323 current = acpi_fill_srat(current);
325 /* (Re)calculate length and checksum. */
326 header->length = current - (unsigned long)srat;
327 header->checksum = acpi_checksum((void *)srat, header->length);
330 /* http://h21007.www2.hp.com/portal/download/files/unprot/Itanium/slit.pdf */
331 void acpi_create_slit(acpi_slit_t *slit)
333 acpi_header_t *header = &(slit->header);
334 unsigned long current = (unsigned long)slit + sizeof(acpi_slit_t);
336 memset((void *)slit, 0, sizeof(acpi_slit_t));
338 /* Fill out header fields. */
339 memcpy(header->signature, "SLIT", 4);
340 memcpy(header->oem_id, OEM_ID, 6);
341 memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
342 memcpy(header->asl_compiler_id, ASLC, 4);
344 header->length = sizeof(acpi_slit_t);
345 header->revision = 1; /* ACPI 1.0: N/A, ACPI 2.0/3.0/4.0: 1 */
347 current = acpi_fill_slit(current);
349 /* (Re)calculate length and checksum. */
350 header->length = current - (unsigned long)slit;
351 header->checksum = acpi_checksum((void *)slit, header->length);
354 /* http://www.intel.com/hardwaredesign/hpetspec_1.pdf */
355 void acpi_create_hpet(acpi_hpet_t *hpet)
357 #define HPET_ADDR 0xfed00000ULL
358 acpi_header_t *header = &(hpet->header);
359 acpi_addr_t *addr = &(hpet->addr);
361 memset((void *)hpet, 0, sizeof(acpi_hpet_t));
363 /* Fill out header fields. */
364 memcpy(header->signature, "HPET", 4);
365 memcpy(header->oem_id, OEM_ID, 6);
366 memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
367 memcpy(header->asl_compiler_id, ASLC, 4);
369 header->length = sizeof(acpi_hpet_t);
370 header->revision = 1; /* Currently 1. Table added in ACPI 2.0. */
372 /* Fill out HPET address. */
373 addr->space_id = 0; /* Memory */
374 addr->bit_width = 64;
375 addr->bit_offset = 0;
376 addr->addrl = HPET_ADDR & 0xffffffff;
377 addr->addrh = HPET_ADDR >> 32;
379 hpet->id = 0x102282a0; /* AMD! FIXME */
381 hpet->min_tick = 4096;
383 header->checksum = acpi_checksum((void *)hpet, sizeof(acpi_hpet_t));
386 void acpi_create_facs(acpi_facs_t *facs)
388 memset((void *)facs, 0, sizeof(acpi_facs_t));
390 memcpy(facs->signature, "FACS", 4);
391 facs->length = sizeof(acpi_facs_t);
392 facs->hardware_signature = 0;
393 facs->firmware_waking_vector = 0;
394 facs->global_lock = 0;
396 facs->x_firmware_waking_vector_l = 0;
397 facs->x_firmware_waking_vector_h = 0;
398 facs->version = 1; /* ACPI 1.0: 0, ACPI 2.0/3.0: 1, ACPI 4.0: 2 */
401 void acpi_write_rsdt(acpi_rsdt_t *rsdt)
403 acpi_header_t *header = &(rsdt->header);
405 /* Fill out header fields. */
406 memcpy(header->signature, "RSDT", 4);
407 memcpy(header->oem_id, OEM_ID, 6);
408 memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
409 memcpy(header->asl_compiler_id, ASLC, 4);
411 header->length = sizeof(acpi_rsdt_t);
412 header->revision = 1; /* ACPI 1.0/2.0/3.0/4.0: 1 */
414 /* Entries are filled in later, we come with an empty set. */
417 header->checksum = acpi_checksum((void *)rsdt, sizeof(acpi_rsdt_t));
420 void acpi_write_xsdt(acpi_xsdt_t *xsdt)
422 acpi_header_t *header = &(xsdt->header);
424 /* Fill out header fields. */
425 memcpy(header->signature, "XSDT", 4);
426 memcpy(header->oem_id, OEM_ID, 6);
427 memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
428 memcpy(header->asl_compiler_id, ASLC, 4);
430 header->length = sizeof(acpi_xsdt_t);
431 header->revision = 1; /* ACPI 1.0: N/A, 2.0/3.0/4.0: 1 */
433 /* Entries are filled in later, we come with an empty set. */
436 header->checksum = acpi_checksum((void *)xsdt, sizeof(acpi_xsdt_t));
439 void acpi_write_rsdp(acpi_rsdp_t *rsdp, acpi_rsdt_t *rsdt, acpi_xsdt_t *xsdt)
441 memset(rsdp, 0, sizeof(acpi_rsdp_t));
443 memcpy(rsdp->signature, RSDP_SIG, 8);
444 memcpy(rsdp->oem_id, OEM_ID, 6);
446 rsdp->length = sizeof(acpi_rsdp_t);
447 rsdp->rsdt_address = (u32)rsdt;
450 * Revision: ACPI 1.0: 0, ACPI 2.0/3.0/4.0: 2.
452 * Some OSes expect an XSDT to be present for RSD PTR revisions >= 2.
453 * If we don't have an ACPI XSDT, force ACPI 1.0 (and thus RSD PTR
459 rsdp->xsdt_address = (u64)(u32)xsdt;
463 /* Calculate checksums. */
464 rsdp->checksum = acpi_checksum((void *)rsdp, 20);
465 rsdp->ext_checksum = acpi_checksum((void *)rsdp, sizeof(acpi_rsdp_t));
468 #if CONFIG_HAVE_ACPI_RESUME == 1
469 void suspend_resume(void)
473 /* If we happen to be resuming find wakeup vector and jump to OS. */
474 wake_vec = acpi_find_wakeup_vector();
476 acpi_jump_to_wakeup(wake_vec);
479 /* This is to be filled by SB code - startup value what was found. */
480 u8 acpi_slp_type = 0;
482 static int acpi_is_wakeup(void)
484 return (acpi_slp_type == 3);
487 static acpi_rsdp_t *valid_rsdp(acpi_rsdp_t *rsdp)
489 if (strncmp((char *)rsdp, RSDP_SIG, sizeof(RSDP_SIG) - 1) != 0)
492 printk(BIOS_DEBUG, "Looking on %p for valid checksum\n", rsdp);
494 if (acpi_checksum((void *)rsdp, 20) != 0)
496 printk(BIOS_DEBUG, "Checksum 1 passed\n");
498 if ((rsdp->revision > 1) && (acpi_checksum((void *)rsdp,
501 printk(BIOS_DEBUG, "Checksum 2 passed all OK\n");
506 static acpi_rsdp_t *rsdp;
508 void *acpi_get_wakeup_rsdp(void)
513 void *acpi_find_wakeup_vector(void)
524 if (!acpi_is_wakeup())
527 printk(BIOS_DEBUG, "Trying to find the wakeup vector...\n");
530 for (p = (char *)0xe0000; p < (char *)0xfffff; p += 16) {
531 if ((rsdp = valid_rsdp((acpi_rsdp_t *)p)))
538 printk(BIOS_DEBUG, "RSDP found at %p\n", rsdp);
539 rsdt = (acpi_rsdt_t *) rsdp->rsdt_address;
541 end = (char *)rsdt + rsdt->header.length;
542 printk(BIOS_DEBUG, "RSDT found at %p ends at %p\n", rsdt, end);
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)
554 printk(BIOS_DEBUG, "FADT found at %p\n", fadt);
555 facs = (acpi_facs_t *)fadt->firmware_ctrl;
558 printk(BIOS_DEBUG, "No FACS found, wake up from S3 not "
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);
570 extern char *lowmem_backup;
571 extern char *lowmem_backup_ptr;
572 extern int lowmem_backup_size;
574 #define WAKEUP_BASE 0x600
576 void (*acpi_do_wakeup)(u32 vector, u32 backup_source, u32 backup_target,
577 u32 backup_size) __attribute__((regparm(0))) = (void *)WAKEUP_BASE;
579 extern unsigned char __wakeup, __wakeup_size;
581 void acpi_jump_to_wakeup(void *vector)
583 u32 acpi_backup_memory = (u32)cbmem_find(CBMEM_ID_RESUME);
585 if (!acpi_backup_memory) {
586 printk(BIOS_WARNING, "ACPI: Backup memory missing. "
591 // FIXME: This should go into the ACPI backup memory, too. No pork saussages.
593 * Just restore the SMP trampoline and continue with wakeup on
596 memcpy(lowmem_backup_ptr, lowmem_backup, lowmem_backup_size);
598 /* Copy wakeup trampoline in place. */
599 memcpy((void *)WAKEUP_BASE, &__wakeup, (size_t)&__wakeup_size);
601 acpi_do_wakeup((u32)vector, acpi_backup_memory, CONFIG_RAMBASE,