2 * Copyright (c) 2003 John Baldwin <jhb@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the author nor the names of any co-contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
41 #include <vm/vm_param.h>
44 #include <machine/apicreg.h>
45 #include <machine/frame.h>
46 #include <machine/intr_machdep.h>
47 #include <machine/apicvar.h>
48 #include <machine/md_var.h>
49 #include <machine/specialreg.h>
51 #include <contrib/dev/acpica/acpi.h>
52 #include <contrib/dev/acpica/actables.h>
53 #include <dev/acpica/acpivar.h>
54 #include <dev/pci/pcivar.h>
56 typedef void madt_entry_handler(ACPI_SUBTABLE_HEADER *entry, void *arg);
58 /* These two arrays are indexed by APIC IDs. */
62 } ioapics[MAX_APIC_ID + 1];
67 } lapics[MAX_APIC_ID + 1];
69 static int madt_found_sci_override;
70 static ACPI_TABLE_MADT *madt;
71 static vm_paddr_t madt_physaddr;
72 static vm_offset_t madt_length;
74 MALLOC_DEFINE(M_MADT, "madt_table", "ACPI MADT Table Items");
76 static enum intr_polarity interrupt_polarity(UINT16 IntiFlags, UINT8 Source);
77 static enum intr_trigger interrupt_trigger(UINT16 IntiFlags, UINT8 Source);
78 static int madt_find_cpu(u_int acpi_id, u_int *apic_id);
79 static int madt_find_interrupt(int intr, void **apic, u_int *pin);
80 static void *madt_map(vm_paddr_t pa, int offset, vm_offset_t length);
81 static void *madt_map_table(vm_paddr_t pa, int offset, const char *sig);
82 static void madt_parse_apics(ACPI_SUBTABLE_HEADER *entry, void *arg);
83 static void madt_parse_interrupt_override(
84 ACPI_MADT_INTERRUPT_OVERRIDE *intr);
85 static void madt_parse_ints(ACPI_SUBTABLE_HEADER *entry,
87 static void madt_parse_local_nmi(ACPI_MADT_LOCAL_APIC_NMI *nmi);
88 static void madt_parse_nmi(ACPI_MADT_NMI_SOURCE *nmi);
89 static int madt_probe(void);
90 static int madt_probe_cpus(void);
91 static void madt_probe_cpus_handler(ACPI_SUBTABLE_HEADER *entry,
93 static int madt_probe_table(vm_paddr_t address);
94 static void madt_register(void *dummy);
95 static int madt_setup_local(void);
96 static int madt_setup_io(void);
97 static void madt_unmap(void *data, vm_offset_t length);
98 static void madt_unmap_table(void *table);
99 static void madt_walk_table(madt_entry_handler *handler, void *arg);
101 static struct apic_enumerator madt_enumerator = {
110 * Code to abuse the crashdump map to map in the tables for the early
111 * probe. We cheat and make the following assumptions about how we
112 * use this KVA: pages 0 and 1 are used to map in the header of each
113 * table found via the RSDT or XSDT and pages 2 to n are used to map
114 * in the RSDT or XSDT. We have to use 2 pages for the table headers
115 * in case a header spans a page boundary. The offset is in pages;
116 * the length is in bytes.
119 madt_map(vm_paddr_t pa, int offset, vm_offset_t length)
124 off = pa & PAGE_MASK;
125 length = roundup(length + off, PAGE_SIZE);
127 va = (vm_offset_t)pmap_kenter_temporary(pa, offset) +
128 (offset * PAGE_SIZE);
129 data = (void *)(va + off);
142 madt_unmap(void *data, vm_offset_t length)
146 va = (vm_offset_t)data;
147 off = va & PAGE_MASK;
148 length = roundup(length + off, PAGE_SIZE);
159 madt_map_table(vm_paddr_t pa, int offset, const char *sig)
161 ACPI_TABLE_HEADER *header;
165 header = madt_map(pa, offset, sizeof(ACPI_TABLE_HEADER));
166 if (strncmp(header->Signature, sig, ACPI_NAME_SIZE) != 0) {
167 madt_unmap(header, sizeof(ACPI_TABLE_HEADER));
170 length = header->Length;
171 madt_unmap(header, sizeof(ACPI_TABLE_HEADER));
172 table = madt_map(pa, offset, length);
173 if (ACPI_FAILURE(AcpiTbChecksum(table, length))) {
175 printf("MADT: Failed checksum for table %s\n", sig);
176 madt_unmap(table, length);
183 madt_unmap_table(void *table)
185 ACPI_TABLE_HEADER *header;
187 header = (ACPI_TABLE_HEADER *)table;
188 madt_unmap(table, header->Length);
192 * Look for an ACPI Multiple APIC Description Table ("APIC")
197 ACPI_PHYSICAL_ADDRESS rsdp_ptr;
198 ACPI_TABLE_RSDP *rsdp;
199 ACPI_TABLE_RSDT *rsdt;
200 ACPI_TABLE_XSDT *xsdt;
203 if (resource_disabled("acpi", 0))
207 * Map in the RSDP. Since ACPI uses AcpiOsMapMemory() which in turn
208 * calls pmap_mapbios() to find the RSDP, we assume that we can use
209 * pmap_mapbios() to map the RSDP.
211 if ((rsdp_ptr = AcpiOsGetRootPointer()) == 0)
213 rsdp = pmap_mapbios(rsdp_ptr, sizeof(ACPI_TABLE_RSDP));
216 printf("MADT: Failed to map RSDP\n");
221 * For ACPI >= 2.0, use the XSDT if it is available.
222 * Otherwise, use the RSDT. We map the XSDT or RSDT at page 1
223 * in the crashdump area. Page 0 is used to map in the
224 * headers of candidate ACPI tables.
226 if (rsdp->Revision >= 2 && rsdp->XsdtPhysicalAddress != 0) {
228 * AcpiOsGetRootPointer only verifies the checksum for
229 * the version 1.0 portion of the RSDP. Version 2.0 has
230 * an additional checksum that we verify first.
232 if (AcpiTbChecksum((UINT8 *)rsdp, ACPI_RSDP_XCHECKSUM_LENGTH)) {
234 printf("MADT: RSDP failed extended checksum\n");
237 xsdt = madt_map_table(rsdp->XsdtPhysicalAddress, 2,
241 printf("MADT: Failed to map XSDT\n");
244 count = (xsdt->Header.Length - sizeof(ACPI_TABLE_HEADER)) /
246 for (i = 0; i < count; i++)
247 if (madt_probe_table(xsdt->TableOffsetEntry[i]))
249 madt_unmap_table(xsdt);
251 rsdt = madt_map_table(rsdp->RsdtPhysicalAddress, 2,
255 printf("MADT: Failed to map RSDT\n");
258 count = (rsdt->Header.Length - sizeof(ACPI_TABLE_HEADER)) /
260 for (i = 0; i < count; i++)
261 if (madt_probe_table(rsdt->TableOffsetEntry[i]))
263 madt_unmap_table(rsdt);
265 pmap_unmapbios((vm_offset_t)rsdp, sizeof(ACPI_TABLE_RSDP));
266 if (madt_physaddr == 0) {
268 printf("MADT: No MADT table found\n");
272 printf("MADT: Found table at 0x%jx\n",
273 (uintmax_t)madt_physaddr);
276 * Verify that we can map the full table and that its checksum is
279 madt = madt_map_table(madt_physaddr, 0, ACPI_SIG_MADT);
282 madt_unmap_table(madt);
289 * See if a given ACPI table is the MADT.
292 madt_probe_table(vm_paddr_t address)
294 ACPI_TABLE_HEADER *table;
296 table = madt_map(address, 0, sizeof(ACPI_TABLE_HEADER));
299 printf("MADT: Failed to map table at 0x%jx\n",
304 printf("Table '%.4s' at 0x%jx\n", table->Signature,
307 if (strncmp(table->Signature, ACPI_SIG_MADT, ACPI_NAME_SIZE) != 0) {
308 madt_unmap(table, sizeof(ACPI_TABLE_HEADER));
311 madt_physaddr = address;
312 madt_length = table->Length;
313 madt_unmap(table, sizeof(ACPI_TABLE_HEADER));
318 * Run through the MP table enumerating CPUs.
321 madt_probe_cpus(void)
324 madt = madt_map_table(madt_physaddr, 0, ACPI_SIG_MADT);
325 KASSERT(madt != NULL, ("Unable to re-map MADT"));
326 madt_walk_table(madt_probe_cpus_handler, NULL);
327 madt_unmap_table(madt);
333 * Initialize the local APIC on the BSP.
336 madt_setup_local(void)
339 madt = pmap_mapbios(madt_physaddr, madt_length);
340 lapic_init(madt->Address);
341 printf("ACPI APIC Table: <%.*s %.*s>\n",
342 (int)sizeof(madt->Header.OemId), madt->Header.OemId,
343 (int)sizeof(madt->Header.OemTableId), madt->Header.OemTableId);
346 * We ignore 64-bit local APIC override entries. Should we
347 * perhaps emit a warning here if we find one?
353 * Enumerate I/O APICs and setup interrupt sources.
362 /* Try to initialize ACPI so that we can access the FADT. */
364 if (ACPI_FAILURE(i)) {
365 printf("MADT: ACPI Startup failed with %s\n",
366 AcpiFormatException(i));
367 printf("Try disabling either ACPI or apic support.\n");
368 panic("Using MADT but ACPI doesn't work");
371 /* First, we run through adding I/O APIC's. */
372 madt_walk_table(madt_parse_apics, NULL);
374 /* Second, we run through the table tweaking interrupt sources. */
375 madt_walk_table(madt_parse_ints, NULL);
378 * If there was not an explicit override entry for the SCI,
379 * force it to use level trigger and active-low polarity.
381 if (!madt_found_sci_override) {
382 if (madt_find_interrupt(AcpiGbl_FADT.SciInterrupt, &ioapic,
384 printf("MADT: Could not find APIC for SCI IRQ %u\n",
385 AcpiGbl_FADT.SciInterrupt);
388 "MADT: Forcing active-low polarity and level trigger for SCI\n");
389 ioapic_set_polarity(ioapic, pin, INTR_POLARITY_LOW);
390 ioapic_set_triggermode(ioapic, pin, INTR_TRIGGER_LEVEL);
394 /* Third, we register all the I/O APIC's. */
395 for (i = 0; i <= MAX_APIC_ID; i++)
396 if (ioapics[i].io_apic != NULL)
397 ioapic_register(ioapics[i].io_apic);
399 /* Finally, we throw the switch to enable the I/O APIC's. */
400 acpi_SetDefaultIntrModel(ACPI_INTR_APIC);
406 madt_register(void *dummy __unused)
409 apic_register_enumerator(&madt_enumerator);
411 SYSINIT(madt_register, SI_SUB_CPU - 1, SI_ORDER_SECOND, madt_register, NULL);
414 * Call the handler routine for each entry in the MADT table.
417 madt_walk_table(madt_entry_handler *handler, void *arg)
419 ACPI_SUBTABLE_HEADER *entry;
422 end = (u_char *)(madt) + madt->Header.Length;
423 for (p = (u_char *)(madt + 1); p < end; ) {
424 entry = (ACPI_SUBTABLE_HEADER *)p;
431 madt_probe_cpus_handler(ACPI_SUBTABLE_HEADER *entry, void *arg)
433 ACPI_MADT_LOCAL_APIC *proc;
434 struct lapic_info *la;
436 switch (entry->Type) {
437 case ACPI_MADT_TYPE_LOCAL_APIC:
439 * The MADT does not include a BSP flag, so we have to
440 * let the MP code figure out which CPU is the BSP on
443 proc = (ACPI_MADT_LOCAL_APIC *)entry;
445 printf("MADT: Found CPU APIC ID %u ACPI ID %u: %s\n",
446 proc->Id, proc->ProcessorId,
447 (proc->LapicFlags & ACPI_MADT_ENABLED) ?
448 "enabled" : "disabled");
449 if (!(proc->LapicFlags & ACPI_MADT_ENABLED))
451 if (proc->Id > MAX_APIC_ID)
452 panic("%s: CPU ID %u too high", __func__, proc->Id);
453 la = &lapics[proc->Id];
454 KASSERT(la->la_enabled == 0,
455 ("Duplicate local APIC ID %u", proc->Id));
457 la->la_acpi_id = proc->ProcessorId;
458 lapic_create(proc->Id, 0);
465 * Add an I/O APIC from an entry in the table.
468 madt_parse_apics(ACPI_SUBTABLE_HEADER *entry, void *arg __unused)
470 ACPI_MADT_IO_APIC *apic;
472 switch (entry->Type) {
473 case ACPI_MADT_TYPE_IO_APIC:
474 apic = (ACPI_MADT_IO_APIC *)entry;
477 "MADT: Found IO APIC ID %u, Interrupt %u at %p\n",
478 apic->Id, apic->GlobalIrqBase,
479 (void *)(uintptr_t)apic->Address);
480 if (apic->Id > MAX_APIC_ID)
481 panic("%s: I/O APIC ID %u too high", __func__,
483 if (ioapics[apic->Id].io_apic != NULL)
484 panic("%s: Double APIC ID %u", __func__, apic->Id);
485 if (apic->GlobalIrqBase >= FIRST_MSI_INT) {
486 printf("MADT: Ignoring bogus I/O APIC ID %u", apic->Id);
489 ioapics[apic->Id].io_apic = ioapic_create(apic->Address,
490 apic->Id, apic->GlobalIrqBase);
491 ioapics[apic->Id].io_vector = apic->GlobalIrqBase;
499 * Determine properties of an interrupt source. Note that for ACPI these
500 * functions are only used for ISA interrupts, so we assume ISA bus values
501 * (Active Hi, Edge Triggered) for conforming values except for the ACPI
502 * SCI for which we use Active Lo, Level Triggered.
504 static enum intr_polarity
505 interrupt_polarity(UINT16 IntiFlags, UINT8 Source)
508 switch (IntiFlags & ACPI_MADT_POLARITY_MASK) {
509 case ACPI_MADT_POLARITY_CONFORMS:
510 if (Source == AcpiGbl_FADT.SciInterrupt)
511 return (INTR_POLARITY_LOW);
513 return (INTR_POLARITY_HIGH);
514 case ACPI_MADT_POLARITY_ACTIVE_HIGH:
515 return (INTR_POLARITY_HIGH);
516 case ACPI_MADT_POLARITY_ACTIVE_LOW:
517 return (INTR_POLARITY_LOW);
519 panic("Bogus Interrupt Polarity");
523 static enum intr_trigger
524 interrupt_trigger(UINT16 IntiFlags, UINT8 Source)
527 switch (IntiFlags & ACPI_MADT_TRIGGER_MASK) {
528 case ACPI_MADT_TRIGGER_CONFORMS:
529 if (Source == AcpiGbl_FADT.SciInterrupt)
530 return (INTR_TRIGGER_LEVEL);
532 return (INTR_TRIGGER_EDGE);
533 case ACPI_MADT_TRIGGER_EDGE:
534 return (INTR_TRIGGER_EDGE);
535 case ACPI_MADT_TRIGGER_LEVEL:
536 return (INTR_TRIGGER_LEVEL);
538 panic("Bogus Interrupt Trigger Mode");
543 * Find the local APIC ID associated with a given ACPI Processor ID.
546 madt_find_cpu(u_int acpi_id, u_int *apic_id)
550 for (i = 0; i <= MAX_APIC_ID; i++) {
551 if (!lapics[i].la_enabled)
553 if (lapics[i].la_acpi_id != acpi_id)
562 * Find the IO APIC and pin on that APIC associated with a given global
566 madt_find_interrupt(int intr, void **apic, u_int *pin)
571 for (i = 0; i <= MAX_APIC_ID; i++) {
572 if (ioapics[i].io_apic == NULL ||
573 ioapics[i].io_vector > intr)
576 ioapics[best].io_vector < ioapics[i].io_vector)
581 *apic = ioapics[best].io_apic;
582 *pin = intr - ioapics[best].io_vector;
584 printf("WARNING: Found intpin of %u for vector %d\n", *pin,
590 * Parse an interrupt source override for an ISA interrupt.
593 madt_parse_interrupt_override(ACPI_MADT_INTERRUPT_OVERRIDE *intr)
595 void *new_ioapic, *old_ioapic;
596 u_int new_pin, old_pin;
597 enum intr_trigger trig;
598 enum intr_polarity pol;
601 if (acpi_quirks & ACPI_Q_MADT_IRQ0 && intr->SourceIrq == 0 &&
602 intr->GlobalIrq == 2) {
604 printf("MADT: Skipping timer override\n");
608 printf("MADT: Interrupt override: source %u, irq %u\n",
609 intr->SourceIrq, intr->GlobalIrq);
610 KASSERT(intr->Bus == 0, ("bus for interrupt overrides must be zero"));
611 if (madt_find_interrupt(intr->GlobalIrq, &new_ioapic, &new_pin) != 0) {
612 printf("MADT: Could not find APIC for vector %u (IRQ %u)\n",
613 intr->GlobalIrq, intr->SourceIrq);
618 * Lookup the appropriate trigger and polarity modes for this
621 trig = interrupt_trigger(intr->IntiFlags, intr->SourceIrq);
622 pol = interrupt_polarity(intr->IntiFlags, intr->SourceIrq);
625 * If the SCI is identity mapped but has edge trigger and
626 * active-hi polarity or the force_sci_lo tunable is set,
627 * force it to use level/lo.
629 if (intr->SourceIrq == AcpiGbl_FADT.SciInterrupt) {
630 madt_found_sci_override = 1;
631 if (getenv_string("hw.acpi.sci.trigger", buf, sizeof(buf))) {
632 if (tolower(buf[0]) == 'e')
633 trig = INTR_TRIGGER_EDGE;
634 else if (tolower(buf[0]) == 'l')
635 trig = INTR_TRIGGER_LEVEL;
638 "Invalid trigger %s: must be 'edge' or 'level'",
640 printf("MADT: Forcing SCI to %s trigger\n",
641 trig == INTR_TRIGGER_EDGE ? "edge" : "level");
643 if (getenv_string("hw.acpi.sci.polarity", buf, sizeof(buf))) {
644 if (tolower(buf[0]) == 'h')
645 pol = INTR_POLARITY_HIGH;
646 else if (tolower(buf[0]) == 'l')
647 pol = INTR_POLARITY_LOW;
650 "Invalid polarity %s: must be 'high' or 'low'",
652 printf("MADT: Forcing SCI to active %s polarity\n",
653 pol == INTR_POLARITY_HIGH ? "high" : "low");
657 /* Remap the IRQ if it is mapped to a different interrupt vector. */
658 if (intr->SourceIrq != intr->GlobalIrq) {
660 * If the SCI is remapped to a non-ISA global interrupt,
661 * then override the vector we use to setup and allocate
664 if (intr->GlobalIrq > 15 &&
665 intr->SourceIrq == AcpiGbl_FADT.SciInterrupt)
666 acpi_OverrideInterruptLevel(intr->GlobalIrq);
668 ioapic_remap_vector(new_ioapic, new_pin,
670 if (madt_find_interrupt(intr->SourceIrq, &old_ioapic,
672 printf("MADT: Could not find APIC for source IRQ %u\n",
674 else if (ioapic_get_vector(old_ioapic, old_pin) ==
676 ioapic_disable_pin(old_ioapic, old_pin);
679 /* Program the polarity and trigger mode. */
680 ioapic_set_triggermode(new_ioapic, new_pin, trig);
681 ioapic_set_polarity(new_ioapic, new_pin, pol);
685 * Parse an entry for an NMI routed to an IO APIC.
688 madt_parse_nmi(ACPI_MADT_NMI_SOURCE *nmi)
693 if (madt_find_interrupt(nmi->GlobalIrq, &ioapic, &pin) != 0) {
694 printf("MADT: Could not find APIC for vector %u\n",
699 ioapic_set_nmi(ioapic, pin);
700 if (!(nmi->IntiFlags & ACPI_MADT_TRIGGER_CONFORMS))
701 ioapic_set_triggermode(ioapic, pin,
702 interrupt_trigger(nmi->IntiFlags, 0));
703 if (!(nmi->IntiFlags & ACPI_MADT_TRIGGER_CONFORMS))
704 ioapic_set_polarity(ioapic, pin,
705 interrupt_polarity(nmi->IntiFlags, 0));
709 * Parse an entry for an NMI routed to a local APIC LVT pin.
712 madt_parse_local_nmi(ACPI_MADT_LOCAL_APIC_NMI *nmi)
716 if (nmi->ProcessorId == 0xff)
717 apic_id = APIC_ID_ALL;
718 else if (madt_find_cpu(nmi->ProcessorId, &apic_id) != 0) {
720 printf("MADT: Ignoring local NMI routed to "
721 "ACPI CPU %u\n", nmi->ProcessorId);
728 lapic_set_lvt_mode(apic_id, pin, APIC_LVT_DM_NMI);
729 if (!(nmi->IntiFlags & ACPI_MADT_TRIGGER_CONFORMS))
730 lapic_set_lvt_triggermode(apic_id, pin,
731 interrupt_trigger(nmi->IntiFlags, 0));
732 if (!(nmi->IntiFlags & ACPI_MADT_POLARITY_CONFORMS))
733 lapic_set_lvt_polarity(apic_id, pin,
734 interrupt_polarity(nmi->IntiFlags, 0));
738 * Parse interrupt entries.
741 madt_parse_ints(ACPI_SUBTABLE_HEADER *entry, void *arg __unused)
744 switch (entry->Type) {
745 case ACPI_MADT_TYPE_INTERRUPT_OVERRIDE:
746 madt_parse_interrupt_override(
747 (ACPI_MADT_INTERRUPT_OVERRIDE *)entry);
749 case ACPI_MADT_TYPE_NMI_SOURCE:
750 madt_parse_nmi((ACPI_MADT_NMI_SOURCE *)entry);
752 case ACPI_MADT_TYPE_LOCAL_APIC_NMI:
753 madt_parse_local_nmi((ACPI_MADT_LOCAL_APIC_NMI *)entry);
759 * Setup per-CPU ACPI IDs.
762 madt_set_ids(void *dummy)
764 struct lapic_info *la;
770 for (i = 0; i <= mp_maxid; i++) {
774 KASSERT(pc != NULL, ("no pcpu data for CPU %u", i));
775 la = &lapics[pc->pc_apic_id];
777 panic("APIC: CPU with APIC ID %u is not enabled",
779 pc->pc_acpi_id = la->la_acpi_id;
781 printf("APIC: CPU %u has ACPI ID %u\n", i,
785 SYSINIT(madt_set_ids, SI_SUB_CPU, SI_ORDER_ANY, madt_set_ids, NULL);