sys/x86/acpica/madt.c

   1 /*-
   2  * Copyright (c) 2003 John Baldwin <jhb@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <sys/param.h>
  31 #include <sys/systm.h>
  32 #include <sys/bus.h>
  33 #include <sys/kernel.h>
  34 #include <sys/malloc.h>
  35 #include <sys/smp.h>
  36 #include <vm/vm.h>
  37 #include <vm/pmap.h>
  38
  39 #include <x86/apicreg.h>
  40 #include <machine/intr_machdep.h>
  41 #include <machine/apicvar.h>
  42
  43 #include <contrib/dev/acpica/include/acpi.h>
  44 #include <contrib/dev/acpica/include/actables.h>
  45
  46 #include <dev/acpica/acpivar.h>
  47 #include <dev/pci/pcivar.h>
  48
  49 /* These two arrays are indexed by APIC IDs. */
  50 static struct {
  51         void *io_apic;
  52         UINT32 io_vector;
  53 } *ioapics;
  54
  55 static struct lapic_info {
  56         u_int la_enabled:1;
  57         u_int la_acpi_id:8;
  58 } lapics[MAX_APIC_ID + 1];
  59
  60 static int madt_found_sci_override;
  61 static ACPI_TABLE_MADT *madt;
  62 static vm_paddr_t madt_physaddr;
  63 static vm_offset_t madt_length;
  64
  65 static MALLOC_DEFINE(M_MADT, "madt_table", "ACPI MADT Table Items");
  66
  67 static enum intr_polarity interrupt_polarity(UINT16 IntiFlags, UINT8 Source);
  68 static enum intr_trigger interrupt_trigger(UINT16 IntiFlags, UINT8 Source);
  69 static int      madt_find_cpu(u_int acpi_id, u_int *apic_id);
  70 static int      madt_find_interrupt(int intr, void **apic, u_int *pin);
  71 static void     madt_parse_apics(ACPI_SUBTABLE_HEADER *entry, void *arg);
  72 static void     madt_parse_interrupt_override(
  73                     ACPI_MADT_INTERRUPT_OVERRIDE *intr);
  74 static void     madt_parse_ints(ACPI_SUBTABLE_HEADER *entry,
  75                     void *arg __unused);
  76 static void     madt_parse_local_nmi(ACPI_MADT_LOCAL_APIC_NMI *nmi);
  77 static void     madt_parse_nmi(ACPI_MADT_NMI_SOURCE *nmi);
  78 static int      madt_probe(void);
  79 static int      madt_probe_cpus(void);
  80 static void     madt_probe_cpus_handler(ACPI_SUBTABLE_HEADER *entry,
  81                     void *arg __unused);
  82 static void     madt_register(void *dummy);
  83 static int      madt_setup_local(void);
  84 static int      madt_setup_io(void);
  85 static void     madt_walk_table(acpi_subtable_handler *handler, void *arg);
  86
  87 static struct apic_enumerator madt_enumerator = {
  88         "MADT",
  89         madt_probe,
  90         madt_probe_cpus,
  91         madt_setup_local,
  92         madt_setup_io
  93 };
  94
  95 /*
  96  * Look for an ACPI Multiple APIC Description Table ("APIC")
  97  */
  98 static int
  99 madt_probe(void)
 100 {
 101
 102         madt_physaddr = acpi_find_table(ACPI_SIG_MADT);
 103         if (madt_physaddr == 0)
 104                 return (ENXIO);
 105         return (0);
 106 }
 107
 108 /*
 109  * Run through the MP table enumerating CPUs.
 110  */
 111 static int
 112 madt_probe_cpus(void)
 113 {
 114
 115         madt = acpi_map_table(madt_physaddr, ACPI_SIG_MADT);
 116         madt_length = madt->Header.Length;
 117         KASSERT(madt != NULL, ("Unable to re-map MADT"));
 118         madt_walk_table(madt_probe_cpus_handler, NULL);
 119         acpi_unmap_table(madt);
 120         madt = NULL;
 121         return (0);
 122 }
 123
 124 /*
 125  * Initialize the local APIC on the BSP.
 126  */
 127 static int
 128 madt_setup_local(void)
 129 {
 130
 131         madt = pmap_mapbios(madt_physaddr, madt_length);
 132         lapic_init(madt->Address);
 133         printf("ACPI APIC Table: <%.*s %.*s>\n",
 134             (int)sizeof(madt->Header.OemId), madt->Header.OemId,
 135             (int)sizeof(madt->Header.OemTableId), madt->Header.OemTableId);
 136
 137         /*
 138          * We ignore 64-bit local APIC override entries.  Should we
 139          * perhaps emit a warning here if we find one?
 140          */
 141         return (0);
 142 }
 143
 144 /*
 145  * Enumerate I/O APICs and setup interrupt sources.
 146  */
 147 static int
 148 madt_setup_io(void)
 149 {
 150         void *ioapic;
 151         u_int pin;
 152         int i;
 153
 154         /* Try to initialize ACPI so that we can access the FADT. */
 155         i = acpi_Startup();
 156         if (ACPI_FAILURE(i)) {
 157                 printf("MADT: ACPI Startup failed with %s\n",
 158                     AcpiFormatException(i));
 159                 printf("Try disabling either ACPI or apic support.\n");
 160                 panic("Using MADT but ACPI doesn't work");
 161         }
 162
 163         ioapics = malloc(sizeof(*ioapics) * (MAX_APIC_ID + 1), M_MADT,
 164             M_WAITOK | M_ZERO);
 165
 166         /* First, we run through adding I/O APIC's. */
 167         madt_walk_table(madt_parse_apics, NULL);
 168
 169         /* Second, we run through the table tweaking interrupt sources. */
 170         madt_walk_table(madt_parse_ints, NULL);
 171
 172         /*
 173          * If there was not an explicit override entry for the SCI,
 174          * force it to use level trigger and active-low polarity.
 175          */
 176         if (!madt_found_sci_override) {
 177                 if (madt_find_interrupt(AcpiGbl_FADT.SciInterrupt, &ioapic,
 178                     &pin) != 0)
 179                         printf("MADT: Could not find APIC for SCI IRQ %u\n",
 180                             AcpiGbl_FADT.SciInterrupt);
 181                 else {
 182                         printf(
 183         "MADT: Forcing active-low polarity and level trigger for SCI\n");
 184                         ioapic_set_polarity(ioapic, pin, INTR_POLARITY_LOW);
 185                         ioapic_set_triggermode(ioapic, pin, INTR_TRIGGER_LEVEL);
 186                 }
 187         }
 188
 189         /* Third, we register all the I/O APIC's. */
 190         for (i = 0; i <= MAX_APIC_ID; i++)
 191                 if (ioapics[i].io_apic != NULL)
 192                         ioapic_register(ioapics[i].io_apic);
 193
 194         /* Finally, we throw the switch to enable the I/O APIC's. */
 195         acpi_SetDefaultIntrModel(ACPI_INTR_APIC);
 196
 197         free(ioapics, M_MADT);
 198         ioapics = NULL;
 199
 200         return (0);
 201 }
 202
 203 static void
 204 madt_register(void *dummy __unused)
 205 {
 206
 207         apic_register_enumerator(&madt_enumerator);
 208 }
 209 SYSINIT(madt_register, SI_SUB_TUNABLES - 1, SI_ORDER_FIRST, madt_register, NULL);
 210
 211 /*
 212  * Call the handler routine for each entry in the MADT table.
 213  */
 214 static void
 215 madt_walk_table(acpi_subtable_handler *handler, void *arg)
 216 {
 217
 218         acpi_walk_subtables(madt + 1, (char *)madt + madt->Header.Length,
 219             handler, arg);
 220 }
 221
 222 static void
 223 madt_probe_cpus_handler(ACPI_SUBTABLE_HEADER *entry, void *arg)
 224 {
 225         ACPI_MADT_LOCAL_APIC *proc;
 226         struct lapic_info *la;
 227
 228         switch (entry->Type) {
 229         case ACPI_MADT_TYPE_LOCAL_APIC:
 230                 /*
 231                  * The MADT does not include a BSP flag, so we have to
 232                  * let the MP code figure out which CPU is the BSP on
 233                  * its own.
 234                  */
 235                 proc = (ACPI_MADT_LOCAL_APIC *)entry;
 236                 if (bootverbose)
 237                         printf("MADT: Found CPU APIC ID %u ACPI ID %u: %s\n",
 238                             proc->Id, proc->ProcessorId,
 239                             (proc->LapicFlags & ACPI_MADT_ENABLED) ?
 240                             "enabled" : "disabled");
 241                 if (!(proc->LapicFlags & ACPI_MADT_ENABLED))
 242                         break;
 243                 if (proc->Id > MAX_APIC_ID)
 244                         panic("%s: CPU ID %u too high", __func__, proc->Id);
 245                 la = &lapics[proc->Id];
 246                 KASSERT(la->la_enabled == 0,
 247                     ("Duplicate local APIC ID %u", proc->Id));
 248                 la->la_enabled = 1;
 249                 la->la_acpi_id = proc->ProcessorId;
 250                 lapic_create(proc->Id, 0);
 251                 break;
 252         }
 253 }
 254
 255
 256 /*
 257  * Add an I/O APIC from an entry in the table.
 258  */
 259 static void
 260 madt_parse_apics(ACPI_SUBTABLE_HEADER *entry, void *arg __unused)
 261 {
 262         ACPI_MADT_IO_APIC *apic;
 263
 264         switch (entry->Type) {
 265         case ACPI_MADT_TYPE_IO_APIC:
 266                 apic = (ACPI_MADT_IO_APIC *)entry;
 267                 if (bootverbose)
 268                         printf(
 269                             "MADT: Found IO APIC ID %u, Interrupt %u at %p\n",
 270                             apic->Id, apic->GlobalIrqBase,
 271                             (void *)(uintptr_t)apic->Address);
 272                 if (apic->Id > MAX_APIC_ID)
 273                         panic("%s: I/O APIC ID %u too high", __func__,
 274                             apic->Id);
 275                 if (ioapics[apic->Id].io_apic != NULL)
 276                         panic("%s: Double APIC ID %u", __func__, apic->Id);
 277                 if (apic->GlobalIrqBase >= FIRST_MSI_INT) {
 278                         printf("MADT: Ignoring bogus I/O APIC ID %u", apic->Id);
 279                         break;
 280                 }
 281                 ioapics[apic->Id].io_apic = ioapic_create(apic->Address,
 282                     apic->Id, apic->GlobalIrqBase);
 283                 ioapics[apic->Id].io_vector = apic->GlobalIrqBase;
 284                 break;
 285         default:
 286                 break;
 287         }
 288 }
 289
 290 /*
 291  * Determine properties of an interrupt source.  Note that for ACPI these
 292  * functions are only used for ISA interrupts, so we assume ISA bus values
 293  * (Active Hi, Edge Triggered) for conforming values except for the ACPI
 294  * SCI for which we use Active Lo, Level Triggered.
 295  */
 296 static enum intr_polarity
 297 interrupt_polarity(UINT16 IntiFlags, UINT8 Source)
 298 {
 299
 300         switch (IntiFlags & ACPI_MADT_POLARITY_MASK) {
 301         case ACPI_MADT_POLARITY_CONFORMS:
 302                 if (Source == AcpiGbl_FADT.SciInterrupt)
 303                         return (INTR_POLARITY_LOW);
 304                 else
 305                         return (INTR_POLARITY_HIGH);
 306         case ACPI_MADT_POLARITY_ACTIVE_HIGH:
 307                 return (INTR_POLARITY_HIGH);
 308         case ACPI_MADT_POLARITY_ACTIVE_LOW:
 309                 return (INTR_POLARITY_LOW);
 310         default:
 311                 panic("Bogus Interrupt Polarity");
 312         }
 313 }
 314
 315 static enum intr_trigger
 316 interrupt_trigger(UINT16 IntiFlags, UINT8 Source)
 317 {
 318
 319         switch (IntiFlags & ACPI_MADT_TRIGGER_MASK) {
 320         case ACPI_MADT_TRIGGER_CONFORMS:
 321                 if (Source == AcpiGbl_FADT.SciInterrupt)
 322                         return (INTR_TRIGGER_LEVEL);
 323                 else
 324                         return (INTR_TRIGGER_EDGE);
 325         case ACPI_MADT_TRIGGER_EDGE:
 326                 return (INTR_TRIGGER_EDGE);
 327         case ACPI_MADT_TRIGGER_LEVEL:
 328                 return (INTR_TRIGGER_LEVEL);
 329         default:
 330                 panic("Bogus Interrupt Trigger Mode");
 331         }
 332 }
 333
 334 /*
 335  * Find the local APIC ID associated with a given ACPI Processor ID.
 336  */
 337 static int
 338 madt_find_cpu(u_int acpi_id, u_int *apic_id)
 339 {
 340         int i;
 341
 342         for (i = 0; i <= MAX_APIC_ID; i++) {
 343                 if (!lapics[i].la_enabled)
 344                         continue;
 345                 if (lapics[i].la_acpi_id != acpi_id)
 346                         continue;
 347                 *apic_id = i;
 348                 return (0);
 349         }
 350         return (ENOENT);
 351 }
 352
 353 /*
 354  * Find the IO APIC and pin on that APIC associated with a given global
 355  * interrupt.
 356  */
 357 static int
 358 madt_find_interrupt(int intr, void **apic, u_int *pin)
 359 {
 360         int i, best;
 361
 362         best = -1;
 363         for (i = 0; i <= MAX_APIC_ID; i++) {
 364                 if (ioapics[i].io_apic == NULL ||
 365                     ioapics[i].io_vector > intr)
 366                         continue;
 367                 if (best == -1 ||
 368                     ioapics[best].io_vector < ioapics[i].io_vector)
 369                         best = i;
 370         }
 371         if (best == -1)
 372                 return (ENOENT);
 373         *apic = ioapics[best].io_apic;
 374         *pin = intr - ioapics[best].io_vector;
 375         if (*pin > 32)
 376                 printf("WARNING: Found intpin of %u for vector %d\n", *pin,
 377                     intr);
 378         return (0);
 379 }
 380
 381 /*
 382  * Parse an interrupt source override for an ISA interrupt.
 383  */
 384 static void
 385 madt_parse_interrupt_override(ACPI_MADT_INTERRUPT_OVERRIDE *intr)
 386 {
 387         void *new_ioapic, *old_ioapic;
 388         u_int new_pin, old_pin;
 389         enum intr_trigger trig;
 390         enum intr_polarity pol;
 391         char buf[64];
 392
 393         if (acpi_quirks & ACPI_Q_MADT_IRQ0 && intr->SourceIrq == 0 &&
 394             intr->GlobalIrq == 2) {
 395                 if (bootverbose)
 396                         printf("MADT: Skipping timer override\n");
 397                 return;
 398         }
 399         if (bootverbose)
 400                 printf("MADT: Interrupt override: source %u, irq %u\n",
 401                     intr->SourceIrq, intr->GlobalIrq);
 402         KASSERT(intr->Bus == 0, ("bus for interrupt overrides must be zero"));
 403         if (madt_find_interrupt(intr->GlobalIrq, &new_ioapic, &new_pin) != 0) {
 404                 printf("MADT: Could not find APIC for vector %u (IRQ %u)\n",
 405                     intr->GlobalIrq, intr->SourceIrq);
 406                 return;
 407         }
 408
 409         /*
 410          * Lookup the appropriate trigger and polarity modes for this
 411          * entry.
 412          */
 413         trig = interrupt_trigger(intr->IntiFlags, intr->SourceIrq);
 414         pol = interrupt_polarity(intr->IntiFlags, intr->SourceIrq);
 415
 416         /*
 417          * If the SCI is identity mapped but has edge trigger and
 418          * active-hi polarity or the force_sci_lo tunable is set,
 419          * force it to use level/lo.
 420          */
 421         if (intr->SourceIrq == AcpiGbl_FADT.SciInterrupt) {
 422                 madt_found_sci_override = 1;
 423                 if (getenv_string("hw.acpi.sci.trigger", buf, sizeof(buf))) {
 424                         if (tolower(buf[0]) == 'e')
 425                                 trig = INTR_TRIGGER_EDGE;
 426                         else if (tolower(buf[0]) == 'l')
 427                                 trig = INTR_TRIGGER_LEVEL;
 428                         else
 429                                 panic(
 430                                 "Invalid trigger %s: must be 'edge' or 'level'",
 431                                     buf);
 432                         printf("MADT: Forcing SCI to %s trigger\n",
 433                             trig == INTR_TRIGGER_EDGE ? "edge" : "level");
 434                 }
 435                 if (getenv_string("hw.acpi.sci.polarity", buf, sizeof(buf))) {
 436                         if (tolower(buf[0]) == 'h')
 437                                 pol = INTR_POLARITY_HIGH;
 438                         else if (tolower(buf[0]) == 'l')
 439                                 pol = INTR_POLARITY_LOW;
 440                         else
 441                                 panic(
 442                                 "Invalid polarity %s: must be 'high' or 'low'",
 443                                     buf);
 444                         printf("MADT: Forcing SCI to active %s polarity\n",
 445                             pol == INTR_POLARITY_HIGH ? "high" : "low");
 446                 }
 447         }
 448
 449         /* Remap the IRQ if it is mapped to a different interrupt vector. */
 450         if (intr->SourceIrq != intr->GlobalIrq) {
 451                 /*
 452                  * If the SCI is remapped to a non-ISA global interrupt,
 453                  * then override the vector we use to setup and allocate
 454                  * the interrupt.
 455                  */
 456                 if (intr->GlobalIrq > 15 &&
 457                     intr->SourceIrq == AcpiGbl_FADT.SciInterrupt)
 458                         acpi_OverrideInterruptLevel(intr->GlobalIrq);
 459                 else
 460                         ioapic_remap_vector(new_ioapic, new_pin,
 461                             intr->SourceIrq);
 462                 if (madt_find_interrupt(intr->SourceIrq, &old_ioapic,
 463                     &old_pin) != 0)
 464                         printf("MADT: Could not find APIC for source IRQ %u\n",
 465                             intr->SourceIrq);
 466                 else if (ioapic_get_vector(old_ioapic, old_pin) ==
 467                     intr->SourceIrq)
 468                         ioapic_disable_pin(old_ioapic, old_pin);
 469         }
 470
 471         /* Program the polarity and trigger mode. */
 472         ioapic_set_triggermode(new_ioapic, new_pin, trig);
 473         ioapic_set_polarity(new_ioapic, new_pin, pol);
 474 }
 475
 476 /*
 477  * Parse an entry for an NMI routed to an IO APIC.
 478  */
 479 static void
 480 madt_parse_nmi(ACPI_MADT_NMI_SOURCE *nmi)
 481 {
 482         void *ioapic;
 483         u_int pin;
 484
 485         if (madt_find_interrupt(nmi->GlobalIrq, &ioapic, &pin) != 0) {
 486                 printf("MADT: Could not find APIC for vector %u\n",
 487                     nmi->GlobalIrq);
 488                 return;
 489         }
 490
 491         ioapic_set_nmi(ioapic, pin);
 492         if (!(nmi->IntiFlags & ACPI_MADT_TRIGGER_CONFORMS))
 493                 ioapic_set_triggermode(ioapic, pin,
 494                     interrupt_trigger(nmi->IntiFlags, 0));
 495         if (!(nmi->IntiFlags & ACPI_MADT_TRIGGER_CONFORMS))
 496                 ioapic_set_polarity(ioapic, pin,
 497                     interrupt_polarity(nmi->IntiFlags, 0));
 498 }
 499
 500 /*
 501  * Parse an entry for an NMI routed to a local APIC LVT pin.
 502  */
 503 static void
 504 madt_parse_local_nmi(ACPI_MADT_LOCAL_APIC_NMI *nmi)
 505 {
 506         u_int apic_id, pin;
 507
 508         if (nmi->ProcessorId == 0xff)
 509                 apic_id = APIC_ID_ALL;
 510         else if (madt_find_cpu(nmi->ProcessorId, &apic_id) != 0) {
 511                 if (bootverbose)
 512                         printf("MADT: Ignoring local NMI routed to "
 513                             "ACPI CPU %u\n", nmi->ProcessorId);
 514                 return;
 515         }
 516         if (nmi->Lint == 0)
 517                 pin = APIC_LVT_LINT0;
 518         else
 519                 pin = APIC_LVT_LINT1;
 520         lapic_set_lvt_mode(apic_id, pin, APIC_LVT_DM_NMI);
 521         if (!(nmi->IntiFlags & ACPI_MADT_TRIGGER_CONFORMS))
 522                 lapic_set_lvt_triggermode(apic_id, pin,
 523                     interrupt_trigger(nmi->IntiFlags, 0));
 524         if (!(nmi->IntiFlags & ACPI_MADT_POLARITY_CONFORMS))
 525                 lapic_set_lvt_polarity(apic_id, pin,
 526                     interrupt_polarity(nmi->IntiFlags, 0));
 527 }
 528
 529 /*
 530  * Parse interrupt entries.
 531  */
 532 static void
 533 madt_parse_ints(ACPI_SUBTABLE_HEADER *entry, void *arg __unused)
 534 {
 535
 536         switch (entry->Type) {
 537         case ACPI_MADT_TYPE_INTERRUPT_OVERRIDE:
 538                 madt_parse_interrupt_override(
 539                         (ACPI_MADT_INTERRUPT_OVERRIDE *)entry);
 540                 break;
 541         case ACPI_MADT_TYPE_NMI_SOURCE:
 542                 madt_parse_nmi((ACPI_MADT_NMI_SOURCE *)entry);
 543                 break;
 544         case ACPI_MADT_TYPE_LOCAL_APIC_NMI:
 545                 madt_parse_local_nmi((ACPI_MADT_LOCAL_APIC_NMI *)entry);
 546                 break;
 547         }
 548 }
 549
 550 /*
 551  * Setup per-CPU ACPI IDs.
 552  */
 553 static void
 554 madt_set_ids(void *dummy)
 555 {
 556         struct lapic_info *la;
 557         struct pcpu *pc;
 558         u_int i;
 559
 560         if (madt == NULL)
 561                 return;
 562         CPU_FOREACH(i) {
 563                 pc = pcpu_find(i);
 564                 KASSERT(pc != NULL, ("no pcpu data for CPU %u", i));
 565                 la = &lapics[pc->pc_apic_id];
 566                 if (!la->la_enabled)
 567                         panic("APIC: CPU with APIC ID %u is not enabled",
 568                             pc->pc_apic_id);
 569                 pc->pc_acpi_id = la->la_acpi_id;
 570                 if (bootverbose)
 571                         printf("APIC: CPU %u has ACPI ID %u\n", i,
 572                             la->la_acpi_id);
 573         }
 574 }
 575 SYSINIT(madt_set_ids, SI_SUB_CPU, SI_ORDER_MIDDLE, madt_set_ids, NULL);