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
29 * $FreeBSD: src/sys/i386/acpica/madt.c,v 1.15 2004/05/11 20:06:32 jhb Exp $
30 * $DragonFly: src/sys/i386/acpica5/Attic/madt.c,v 1.2 2004/06/27 08:52:45 dillon Exp $
33 #include <sys/param.h>
34 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/globaldata.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/md_var.h>
48 #include <machine/apicvar.h>
49 #include <machine/specialreg.h>
50 #include <machine/smp.h>
51 #include <machine/globaldata.h>
56 #include <bus/pci/pcivar.h>
58 #define NIOAPICS 32 /* Max number of I/O APICs */
59 #define NLAPICS 32 /* Max number of local APICs */
66 typedef void madt_entry_handler(APIC_HEADER *entry, void *arg);
68 /* These two arrays are indexed by APIC IDs. */
78 } lapics[NLAPICS + 1];
80 static int madt_found_sci_override;
81 static MULTIPLE_APIC_TABLE *madt;
82 static vm_paddr_t madt_physaddr;
83 static vm_offset_t madt_length;
85 MALLOC_DEFINE(M_MADT, "MADT Table", "ACPI MADT Table Items");
87 static enum intr_polarity interrupt_polarity(UINT16 Polarity, UINT8 Source);
88 static enum intr_trigger interrupt_trigger(UINT16 TriggerMode, UINT8 Source);
89 static int madt_find_cpu(u_int acpi_id, u_int *apic_id);
90 static int madt_find_interrupt(int intr, void **apic, u_int *pin);
91 static void *madt_map(vm_paddr_t pa, int offset, vm_offset_t length);
92 static void *madt_map_table(vm_paddr_t pa, int offset, const char *sig);
93 static void madt_parse_apics(APIC_HEADER *entry, void *arg);
94 static void madt_parse_interrupt_override(MADT_INTERRUPT_OVERRIDE *intr);
95 static void madt_parse_ints(APIC_HEADER *entry, void *arg __unused);
96 static void madt_parse_local_nmi(MADT_LOCAL_APIC_NMI *nmi);
97 static void madt_parse_nmi(MADT_NMI_SOURCE *nmi);
98 static int madt_probe(void);
99 static int madt_probe_cpus(void);
100 static void madt_probe_cpus_handler(APIC_HEADER *entry, void *arg __unused);
101 static int madt_probe_table(vm_paddr_t address);
102 static void madt_register(void *dummy);
103 static int madt_setup_local(void);
104 static int madt_setup_io(void);
105 static void madt_unmap(void *data, vm_offset_t length);
106 static void madt_unmap_table(void *table);
107 static void madt_walk_table(madt_entry_handler *handler, void *arg);
109 static struct apic_enumerator madt_enumerator = {
118 * Code to abuse the crashdump map to map in the tables for the early
119 * probe. We cheat and make the following assumptions about how we
120 * use this KVA: page 0 is used to map in the first page of each table
121 * found via the RSDT or XSDT and pages 1 to n are used to map in the
122 * RSDT or XSDT. The offset is in pages; the length is in bytes.
125 madt_map(vm_paddr_t pa, int offset, vm_offset_t length)
130 off = pa & PAGE_MASK;
131 length = roundup(length + off, PAGE_SIZE);
133 va = (vm_offset_t)pmap_kenter_temporary(pa, offset) +
134 (offset * PAGE_SIZE);
135 data = (void *)(va + off);
142 cpu_invlpg((void *)va);
148 madt_unmap(void *data, vm_offset_t length)
152 va = (vm_offset_t)data;
153 off = va & PAGE_MASK;
154 length = roundup(length + off, PAGE_SIZE);
158 cpu_invlpg((void *)va);
165 madt_map_table(vm_paddr_t pa, int offset, const char *sig)
167 ACPI_TABLE_HEADER *header;
171 header = madt_map(pa, offset, sizeof(ACPI_TABLE_HEADER));
172 if (strncmp(header->Signature, sig, 4) != 0) {
173 madt_unmap(header, sizeof(ACPI_TABLE_HEADER));
176 length = header->Length;
177 madt_unmap(header, sizeof(ACPI_TABLE_HEADER));
178 table = madt_map(pa, offset, length);
179 if (ACPI_FAILURE(AcpiTbVerifyTableChecksum(table))) {
181 printf("MADT: Failed checksum for table %s\n", sig);
182 madt_unmap(table, length);
189 madt_unmap_table(void *table)
191 ACPI_TABLE_HEADER *header;
193 header = (ACPI_TABLE_HEADER *)table;
194 madt_unmap(table, header->Length);
198 * Look for an ACPI Multiple APIC Description Table ("APIC")
203 ACPI_POINTER rsdp_ptr;
204 RSDP_DESCRIPTOR *rsdp;
205 RSDT_DESCRIPTOR *rsdt;
206 XSDT_DESCRIPTOR *xsdt;
210 if (resource_disabled("acpi", 0))
215 * Map in the RSDP. Since ACPI uses AcpiOsMapMemory() which in turn
216 * calls pmap_mapdev() to find the RSDP, we assume that we can use
217 * pmap_mapdev() to map the RSDP.
219 if (AcpiOsGetRootPointer(ACPI_LOGICAL_ADDRESSING, &rsdp_ptr) != AE_OK)
222 KASSERT(rsdp_ptr.Pointer.Physical < KERNLOAD, ("RSDP too high"));
224 rsdp = pmap_mapdev(rsdp_ptr.Pointer.Physical, sizeof(RSDP_DESCRIPTOR));
227 printf("MADT: Failed to map RSDP\n");
232 * For ACPI < 2.0, use the RSDT. For ACPI >= 2.0, use the XSDT.
233 * We map the XSDT and RSDT at page 1 in the crashdump area.
234 * Page 0 is used to map in the headers of candidate ACPI tables.
236 if (rsdp->Revision >= 2) {
238 * AcpiOsGetRootPointer only verifies the checksum for
239 * the version 1.0 portion of the RSDP. Version 2.0 has
240 * an additional checksum that we verify first.
242 if (AcpiTbChecksum(rsdp, ACPI_RSDP_XCHECKSUM_LENGTH) != 0) {
244 printf("MADT: RSDP failed extended checksum\n");
247 xsdt = madt_map_table(rsdp->XsdtPhysicalAddress, 1, XSDT_SIG);
250 printf("MADT: Failed to map XSDT\n");
253 count = (xsdt->Length - sizeof(ACPI_TABLE_HEADER)) /
255 for (i = 0; i < count; i++)
256 if (madt_probe_table(xsdt->TableOffsetEntry[i]))
258 madt_unmap_table(xsdt);
260 rsdt = madt_map_table(rsdp->RsdtPhysicalAddress, 1, RSDT_SIG);
263 printf("MADT: Failed to map RSDT\n");
266 count = (rsdt->Length - sizeof(ACPI_TABLE_HEADER)) /
268 for (i = 0; i < count; i++)
269 if (madt_probe_table(rsdt->TableOffsetEntry[i]))
271 madt_unmap_table(rsdt);
273 pmap_unmapdev((vm_offset_t)rsdp, sizeof(RSDP_DESCRIPTOR));
274 if (madt_physaddr == 0) {
276 printf("MADT: No MADT table found\n");
280 printf("MADT: Found table at 0x%jx\n",
281 (uintmax_t)madt_physaddr);
284 * Verify that we can map the full table and that its checksum is
287 madt = madt_map_table(madt_physaddr, 0, APIC_SIG);
290 madt_unmap_table(madt);
297 * See if a given ACPI table is the MADT.
300 madt_probe_table(vm_paddr_t address)
302 ACPI_TABLE_HEADER *table;
304 table = madt_map(address, 0, sizeof(ACPI_TABLE_HEADER));
307 printf("MADT: Failed to map table at 0x%jx\n",
312 printf("Table '%.4s' at 0x%jx\n", table->Signature,
315 if (strncmp(table->Signature, APIC_SIG, 4) != 0) {
316 madt_unmap(table, sizeof(ACPI_TABLE_HEADER));
319 madt_physaddr = address;
320 madt_length = table->Length;
321 madt_unmap(table, sizeof(ACPI_TABLE_HEADER));
326 * Run through the MP table enumerating CPUs.
329 madt_probe_cpus(void)
332 madt = madt_map_table(madt_physaddr, 0, APIC_SIG);
333 KASSERT(madt != NULL, ("Unable to re-map MADT"));
334 madt_walk_table(madt_probe_cpus_handler, NULL);
335 madt_unmap_table(madt);
341 * Initialize the local APIC on the BSP.
344 madt_setup_local(void)
347 madt = pmap_mapdev(madt_physaddr, madt_length);
348 lapic_init((uintptr_t)madt->LocalApicAddress);
349 printf("ACPI APIC Table: <%.*s %.*s>\n",
350 (int)sizeof(madt->OemId), madt->OemId,
351 (int)sizeof(madt->OemTableId), madt->OemTableId);
354 * We ignore 64-bit local APIC override entries. Should we
355 * perhaps emit a warning here if we find one?
361 * Enumerate I/O APICs and setup interrupt sources.
370 /* Try to initialize ACPI so that we can access the FADT. */
372 if (ACPI_FAILURE(i)) {
373 printf("MADT: ACPI Startup failed with %s\n",
374 AcpiFormatException(i));
375 printf("Try disabling either ACPI or apic support.\n");
376 panic("Using MADT but ACPI doesn't work");
379 /* First, we run through adding I/O APIC's. */
380 if (madt->PCATCompat)
381 ioapic_enable_mixed_mode();
382 madt_walk_table(madt_parse_apics, NULL);
384 /* Second, we run through the table tweaking interrupt sources. */
385 madt_walk_table(madt_parse_ints, NULL);
388 * If there was not an explicit override entry for the SCI,
389 * force it to use level trigger and active-low polarity.
391 if (!madt_found_sci_override) {
392 if (madt_find_interrupt(AcpiGbl_FADT->SciInt, &ioapic, &pin)
394 printf("MADT: Could not find APIC for SCI IRQ %d\n",
395 AcpiGbl_FADT->SciInt);
398 "MADT: Forcing active-low polarity and level trigger for SCI\n");
399 ioapic_set_polarity(ioapic, pin, INTR_POLARITY_LOW);
400 ioapic_set_triggermode(ioapic, pin, INTR_TRIGGER_LEVEL);
404 /* Third, we register all the I/O APIC's. */
405 for (i = 0; i < NIOAPICS; i++)
406 if (ioapics[i].io_apic != NULL)
407 ioapic_register(ioapics[i].io_apic);
409 /* Finally, we throw the switch to enable the I/O APIC's. */
410 acpi_SetDefaultIntrModel(ACPI_INTR_APIC);
416 madt_register(void *dummy __unused)
419 apic_register_enumerator(&madt_enumerator);
421 SYSINIT(madt_register, SI_SUB_CPU - 1, SI_ORDER_FIRST, madt_register, NULL)
424 * Call the handler routine for each entry in the MADT table.
427 madt_walk_table(madt_entry_handler *handler, void *arg)
432 end = (u_char *)(madt) + madt->Length;
433 for (p = (u_char *)(madt + 1); p < end; ) {
434 entry = (APIC_HEADER *)p;
441 madt_probe_cpus_handler(APIC_HEADER *entry, void *arg)
443 MADT_PROCESSOR_APIC *proc;
444 struct lapic_info *la;
446 switch (entry->Type) {
449 * The MADT does not include a BSP flag, so we have to
450 * let the MP code figure out which CPU is the BSP on
453 proc = (MADT_PROCESSOR_APIC *)entry;
455 printf("MADT: Found CPU APIC ID %d ACPI ID %d: %s\n",
456 proc->LocalApicId, proc->ProcessorId,
457 proc->ProcessorEnabled ? "enabled" : "disabled");
458 if (proc->ProcessorId > NLAPICS)
459 panic("%s: CPU ID %d too high", __func__,
461 la = &lapics[proc->ProcessorId];
462 KASSERT(la->la_present == 0,
463 ("Duplicate local ACPI ID %d", proc->ProcessorId));
465 la->la_apic_id = proc->LocalApicId;
466 if (proc->ProcessorEnabled) {
468 lapic_create(proc->LocalApicId, 0);
476 * Add an I/O APIC from an entry in the table.
479 madt_parse_apics(APIC_HEADER *entry, void *arg __unused)
483 switch (entry->Type) {
485 apic = (MADT_IO_APIC *)entry;
487 printf("MADT: Found IO APIC ID %d, Interrupt %d at %p\n",
488 apic->IoApicId, apic->Interrupt,
489 (void *)(uintptr_t)apic->Address);
490 if (apic->IoApicId >= NIOAPICS)
491 panic("%s: I/O APIC ID %d too high", __func__,
493 if (ioapics[apic->IoApicId].io_apic != NULL)
494 panic("%s: Double APIC ID %d", __func__,
496 ioapics[apic->IoApicId].io_apic = ioapic_create(
497 (uintptr_t)apic->Address, apic->IoApicId,
499 ioapics[apic->IoApicId].io_vector = apic->Interrupt;
507 * Determine properties of an interrupt source. Note that for ACPI these
508 * functions are only used for ISA interrupts, so we assume ISA bus values
509 * (Active Hi, Edge Triggered) for conforming values except for the ACPI
510 * SCI for which we use Active Lo, Level Triggered.
512 static enum intr_polarity
513 interrupt_polarity(UINT16 Polarity, UINT8 Source)
517 case POLARITY_CONFORMS:
518 if (Source == AcpiGbl_FADT->SciInt)
519 return (INTR_POLARITY_LOW);
521 return (INTR_POLARITY_HIGH);
522 case POLARITY_ACTIVE_HIGH:
523 return (INTR_POLARITY_HIGH);
524 case POLARITY_ACTIVE_LOW:
525 return (INTR_POLARITY_LOW);
527 panic("Bogus Interrupt Polarity");
531 static enum intr_trigger
532 interrupt_trigger(UINT16 TriggerMode, UINT8 Source)
535 switch (TriggerMode) {
536 case TRIGGER_CONFORMS:
537 if (Source == AcpiGbl_FADT->SciInt)
538 return (INTR_TRIGGER_LEVEL);
540 return (INTR_TRIGGER_EDGE);
542 return (INTR_TRIGGER_EDGE);
544 return (INTR_TRIGGER_LEVEL);
546 panic("Bogus Interrupt Trigger Mode");
551 * Find the local APIC ID associated with a given ACPI Processor ID.
554 madt_find_cpu(u_int acpi_id, u_int *apic_id)
557 if (!lapics[acpi_id].la_present)
559 *apic_id = lapics[acpi_id].la_apic_id;
560 if (lapics[acpi_id].la_enabled)
567 * Find the IO APIC and pin on that APIC associated with a given global
571 madt_find_interrupt(int intr, void **apic, u_int *pin)
576 for (i = 0; i < NIOAPICS; i++) {
577 if (ioapics[i].io_apic == NULL ||
578 ioapics[i].io_vector > intr)
581 ioapics[best].io_vector < ioapics[i].io_vector)
586 *apic = ioapics[best].io_apic;
587 *pin = intr - ioapics[best].io_vector;
589 printf("WARNING: Found intpin of %u for vector %d\n", *pin,
595 * Parse an interrupt source override for an ISA interrupt.
598 madt_parse_interrupt_override(MADT_INTERRUPT_OVERRIDE *intr)
600 void *new_ioapic, *old_ioapic;
601 u_int new_pin, old_pin;
602 enum intr_trigger trig;
603 enum intr_polarity pol;
607 printf("MADT: intr override: source %u, irq %u\n",
608 intr->Source, intr->Interrupt);
609 KASSERT(intr->Bus == 0, ("bus for interrupt overrides must be zero"));
610 if (madt_find_interrupt(intr->Interrupt, &new_ioapic,
612 printf("MADT: Could not find APIC for vector %d (IRQ %d)\n",
613 intr->Interrupt, intr->Source);
618 * Lookup the appropriate trigger and polarity modes for this
621 trig = interrupt_trigger(intr->TriggerMode, intr->Source);
622 pol = interrupt_polarity(intr->Polarity, intr->Source);
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->Source == AcpiGbl_FADT->SciInt) {
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->Source != intr->Interrupt) {
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->Interrupt > 15 &&
665 intr->Source == AcpiGbl_FADT->SciInt)
666 acpi_OverrideInterruptLevel(intr->Interrupt);
668 ioapic_remap_vector(new_ioapic, new_pin, intr->Source);
669 if (madt_find_interrupt(intr->Source, &old_ioapic,
671 printf("MADT: Could not find APIC for source IRQ %d\n",
673 else if (ioapic_get_vector(old_ioapic, old_pin) ==
675 ioapic_disable_pin(old_ioapic, old_pin);
678 /* Program the polarity and trigger mode. */
679 ioapic_set_triggermode(new_ioapic, new_pin, trig);
680 ioapic_set_polarity(new_ioapic, new_pin, pol);
684 * Parse an entry for an NMI routed to an IO APIC.
687 madt_parse_nmi(MADT_NMI_SOURCE *nmi)
692 if (madt_find_interrupt(nmi->Interrupt, &ioapic, &pin) != 0) {
693 printf("MADT: Could not find APIC for vector %d\n",
698 ioapic_set_nmi(ioapic, pin);
699 if (nmi->TriggerMode != TRIGGER_CONFORMS)
700 ioapic_set_triggermode(ioapic, pin,
701 interrupt_trigger(nmi->TriggerMode, 0));
702 if (nmi->Polarity != TRIGGER_CONFORMS)
703 ioapic_set_polarity(ioapic, pin,
704 interrupt_polarity(nmi->Polarity, 0));
708 * Parse an entry for an NMI routed to a local APIC LVT pin.
711 madt_parse_local_nmi(MADT_LOCAL_APIC_NMI *nmi)
715 if (nmi->ProcessorId == 0xff)
716 apic_id = APIC_ID_ALL;
717 else if (madt_find_cpu(nmi->ProcessorId, &apic_id) != 0) {
719 printf("MADT: Ignoring local NMI routed to ACPI CPU %u\n",
727 lapic_set_lvt_mode(apic_id, pin, APIC_LVT_DM_NMI);
728 if (nmi->TriggerMode != TRIGGER_CONFORMS)
729 lapic_set_lvt_triggermode(apic_id, pin,
730 interrupt_trigger(nmi->TriggerMode, 0));
731 if (nmi->Polarity != POLARITY_CONFORMS)
732 lapic_set_lvt_polarity(apic_id, pin,
733 interrupt_polarity(nmi->Polarity, 0));
737 * Parse interrupt entries.
740 madt_parse_ints(APIC_HEADER *entry, void *arg __unused)
743 switch (entry->Type) {
744 case APIC_XRUPT_OVERRIDE:
745 madt_parse_interrupt_override(
746 (MADT_INTERRUPT_OVERRIDE *)entry);
749 madt_parse_nmi((MADT_NMI_SOURCE *)entry);
752 madt_parse_local_nmi((MADT_LOCAL_APIC_NMI *)entry);
758 * Setup per-CPU ACPI IDs.
761 madt_set_ids(void *dummy)
763 struct mdglobaldata *md;
768 for (i = 0; i < ncpus; i++) {
769 if ((smp_active_mask & (1 << i)) == 0)
771 md = (struct mdglobaldata *)globaldata_find(i);
772 KKASSERT(md != NULL);
773 for (j = 0; j < NLAPICS + 1; j++) {
774 if (!lapics[j].la_present || !lapics[j].la_enabled)
776 if (lapics[j].la_apic_id == md->gd_apic_id) {
779 printf("APIC: CPU %u has ACPI ID %u\n",
784 if (j == NLAPICS + 1)
785 panic("Unable to find ACPI ID for CPU %d", i);
788 SYSINIT(madt_set_ids, SI_SUB_CPU, SI_ORDER_ANY, madt_set_ids, NULL)