Bring in YONETANI Tomokazu's acpi-update-2.patch (27-May-2004), a major
[dragonfly.git] / sys / dev / acpica5 / acpi_pcib.c
index 586b052..5847a93 100644 (file)
@@ -24,8 +24,8 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $FreeBSD: src/sys/dev/acpica/acpi_pcib.c,v 1.36 2003/12/18 17:04:11 kan Exp $
- * $DragonFly: src/sys/dev/acpica5/acpi_pcib.c,v 1.1 2004/02/21 06:48:08 dillon Exp $
+ * $FreeBSD: src/sys/dev/acpica/acpi_pcib.c,v 1.43 2004/05/06 02:18:58 njl Exp $
+ * $DragonFly: src/sys/dev/acpica5/acpi_pcib.c,v 1.2 2004/06/27 08:52:39 dillon Exp $
  */
 
 #include "opt_acpi.h"
 #include <sys/kernel.h>
 
 #include "acpi.h"
-
 #include "acpivar.h"
 #include "acpi_pcibvar.h"
 
-#include <machine/pci_cfgreg.h>
 #include <bus/pci/pcivar.h>
-#include <bus/pci/pcib_private.h>
 #include "pcib_if.h"
 
-/*
- * Hooks for the ACPI CA debugging infrastructure
- */
+/* Hooks for the ACPI CA debugging infrastructure. */
 #define _COMPONENT     ACPI_BUS
 ACPI_MODULE_NAME("PCI")
 
@@ -68,12 +63,12 @@ acpi_pcib_attach(device_t dev, ACPI_BUFFER *prt, int busno)
        return_VALUE(ENXIO);
 
     /*
-     * Get the PCI interrupt routing table for this bus.
+     * Get the PCI interrupt routing table for this bus.  If we can't
+     * get it, this is not an error but may reduce functionality.
      */
     prt->Length = ACPI_ALLOCATE_BUFFER;
     status = AcpiGetIrqRoutingTable(acpi_get_handle(dev), prt);
     if (ACPI_FAILURE(status))
-       /* This is not an error, but it may reduce functionality. */
        device_printf(dev,
            "could not get PCI interrupt routing table for %s - %s\n",
            acpi_name(acpi_get_handle(dev)), AcpiFormatException(status));
@@ -90,7 +85,8 @@ acpi_pcib_attach(device_t dev, ACPI_BUFFER *prt, int busno)
      * Now go scan the bus.
      */
     acpi_pci_link_config(dev, prt, busno);
-    return_VALUE(bus_generic_attach(dev));
+
+    return_VALUE (bus_generic_attach(dev));
 }
 
 int
@@ -130,18 +126,20 @@ acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin,
     prsbuf.Pointer = NULL;
     interrupt = 255;
 
-    /* ACPI numbers pins 0-3, not 1-4 like the BIOS */
+    /* ACPI numbers pins 0-3, not 1-4 like the BIOS. */
     pin--;
 
+    /* We failed to retrieve the routing table. */
     prtp = prtbuf->Pointer;
-    if (prtp == NULL)                  /* didn't get routing table */
+    if (prtp == NULL)
        goto out;
 
-    /* scan the table looking for this device */
+    /* Scan the table to look for this device. */
     for (;;) {
        prt = (ACPI_PCI_ROUTING_TABLE *)prtp;
 
-       if (prt->Length == 0)           /* end of table */
+       /* We hit the end of the table. */
+       if (prt->Length == 0)
            goto out;
 
        /*
@@ -152,58 +150,57 @@ acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin,
         * is required by the specification to be 0xffff.  We don't risk
         * checking it here.
         */
-       if ((((prt->Address & 0xffff0000) >> 16) == pci_get_slot(dev)) &&
-           (prt->Pin == pin)) {
+       if (((prt->Address & 0xffff0000) >> 16) == pci_get_slot(dev) &&
+           prt->Pin == pin) {
            if (bootverbose)
-               device_printf(pcib, "matched entry for %d.%d.INT%c (source %s)\n",
-                             pci_get_bus(dev), pci_get_slot(dev), 'A' + pin, prt->Source);
+               device_printf(pcib, "matched entry for %d.%d.INT%c (src %s)\n",
+                             pci_get_bus(dev), pci_get_slot(dev), 'A' + pin,
+                             prt->Source);
            break;
        }
        
-       /* skip to next entry */
+       /* Skip to the next entry. */
        prtp += prt->Length;
     }
 
     /*
      * If source is empty/NULL, the source index is the global IRQ number.
      */
-    if ((prt->Source == NULL) || (prt->Source[0] == '\0')) {
+    if (prt->Source == NULL || prt->Source[0] == '\0') {
        if (bootverbose)
            device_printf(pcib, "device is hardwired to IRQ %d\n",
-               prt->SourceIndex);
+                         prt->SourceIndex);
        interrupt = prt->SourceIndex;
        goto out;
     }
     
     /*
-     * We have to find the source device (PCI interrupt link device)
+     * We have to find the source device (PCI interrupt link device).
      */
     if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, prt->Source, &lnkdev))) {
        device_printf(pcib, "couldn't find PCI interrupt link device %s\n",
-           prt->Source);
+                     prt->Source);
        goto out;
     }
 
     /*
-     * Verify that this is a PCI link device, and that it's present.
+     * Verify that this is a PCI link device and that it's present.
      */
     buf.Length = ACPI_ALLOCATE_BUFFER;
     if (ACPI_FAILURE(AcpiGetObjectInfo(lnkdev, &buf))) {
        device_printf(pcib, "couldn't validate PCI interrupt link device %s\n",
-           prt->Source);
+                     prt->Source);
        goto out;
     }
     devinfo = (ACPI_DEVICE_INFO *)buf.Pointer;
     if ((devinfo->Valid & ACPI_VALID_HID) == 0 ||
        strcmp("PNP0C0F", devinfo->HardwareId.Value) != 0) {
-
-       device_printf(pcib, "PCI interrupt link device %s has wrong _HID (%s)\n",
+       device_printf(pcib, "PCI interrupt link %s has invalid _HID (%s)\n",
                      prt->Source, devinfo->HardwareId.Value);
        goto out;
     }
     if ((devinfo->Valid & ACPI_VALID_STA) != 0 &&
        (devinfo->CurrentStatus & 0x9) != 0x9) {
-
        device_printf(pcib, "PCI interrupt link device %s not present\n",
                      prt->Source);
        goto out;
@@ -211,44 +208,47 @@ acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin,
 
     /*
      * Get the current and possible resources for the interrupt link device.
+     * If we fail to get the current resources, this is a fatal error.
      */
     crsbuf.Length = ACPI_ALLOCATE_BUFFER;
     if (ACPI_FAILURE(status = AcpiGetCurrentResources(lnkdev, &crsbuf))) {
-       device_printf(pcib, "couldn't get PCI interrupt link device _CRS data - %s\n",
+       device_printf(pcib, "PCI interrupt link device _CRS failed - %s\n",
                      AcpiFormatException(status));
-       goto out;       /* this is fatal */
+       goto out;
     }
     prsbuf.Length = ACPI_ALLOCATE_BUFFER;
     if (ACPI_FAILURE(status = AcpiGetPossibleResources(lnkdev, &prsbuf))) {
-       device_printf(pcib, "couldn't get PCI interrupt link device _PRS data - %s\n",
+       device_printf(pcib, "PCI interrupt link device _PRS failed - %s\n",
                      AcpiFormatException(status));
-       /* this is not fatal, since it may be hardwired */
     }
     ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "got %ld bytes for %s._CRS\n",
-       (long)crsbuf.Length, acpi_name(lnkdev)));
+                    (long)crsbuf.Length, acpi_name(lnkdev)));
     ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "got %ld bytes for %s._PRS\n",
-       (long)prsbuf.Length, acpi_name(lnkdev)));
+                    (long)prsbuf.Length, acpi_name(lnkdev)));
 
     /*
-     * The interrupt may already be routed, so check _CRS first.  We don't check the
-     * 'decoding' bit in the _STA result, since there's nothing in the spec that 
-     * mandates it be set, however some BIOS' will set it if the decode is active.
+     * The interrupt may already be routed, so check _CRS first.  We don't
+     * check the 'decoding' bit in the _STA result, since there's nothing in
+     * the spec that mandates it be set, however some BIOS' will set it if
+     * the decode is active.
      *
-     * The Source Index points to the particular resource entry we're interested in.
+     * The Source Index points to the particular resource entry we're
+     * interested in.
      */
-    if (ACPI_FAILURE(acpi_FindIndexedResource(&crsbuf, prt->SourceIndex, &crsres))) {
+    if (ACPI_FAILURE(acpi_FindIndexedResource(&crsbuf, prt->SourceIndex,
+       &crsres))) {
        device_printf(pcib, "_CRS buffer corrupt, cannot route interrupt\n");
        goto out;
     }
 
-    /* type-check the resource we've got */
+    /* Type-check the resource we've found. */
     if (crsres->Id != ACPI_RSTYPE_IRQ && crsres->Id != ACPI_RSTYPE_EXT_IRQ) {
        device_printf(pcib, "_CRS resource entry has unsupported type %d\n",
-           crsres->Id);
+                     crsres->Id);
        goto out;
     }
 
-    /* set variables based on resource type */
+    /* Set variables based on resource type. */
     if (crsres->Id == ACPI_RSTYPE_IRQ) {
        NumberOfInterrupts = crsres->Data.Irq.NumberOfInterrupts;
        Interrupts = crsres->Data.Irq.Interrupts;
@@ -257,112 +257,135 @@ acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin,
        Interrupts = crsres->Data.ExtendedIrq.Interrupts;
     }
 
-    /* if there's more than one interrupt, we are confused */
+    /* If there's more than one interrupt, this is an error. */
     if (NumberOfInterrupts > 1) {
        device_printf(pcib, "device has too many interrupts (%d)\n",
-           NumberOfInterrupts);
+                     NumberOfInterrupts);
        goto out;
     }
 
     /* 
-     * If there's only one interrupt, and it's not zero, then we're already routed.
+     * If there's only one interrupt, and it's not zero, then it's already
+     * routed.
      *
-     * Note that we could also check the 'decoding' bit in _STA, but can't depend on
-     * it since it's not part of the spec.
+     * Note that we could also check the 'decoding' bit in _STA, but can't
+     * depend on it since it's not part of the spec.
      *
      * XXX check ASL examples to see if this is an acceptable set of tests
      */
-    if ((NumberOfInterrupts == 1) && (Interrupts[0] != 0)) {
+    if (NumberOfInterrupts == 1 && Interrupts[0] != 0) {
        device_printf(pcib, "slot %d INT%c is routed to irq %d\n",
-           pci_get_slot(dev), 'A' + pin, Interrupts[0]);
+                     pci_get_slot(dev), 'A' + pin, Interrupts[0]);
        interrupt = Interrupts[0];
        goto out;
     }
     
     /* 
      * There isn't an interrupt, so we have to look at _PRS to get one.
-     * Get the set of allowed interrupts from the _PRS resource indexed by SourceIndex.
+     * Get the set of allowed interrupts from the _PRS resource indexed
+     * by SourceIndex.
      */
     if (prsbuf.Pointer == NULL) {
-       device_printf(pcib, "device has no routed interrupt and no _PRS on PCI interrupt link device\n");
-       goto out;
-    }
-    if (ACPI_FAILURE(acpi_FindIndexedResource(&prsbuf, prt->SourceIndex, &prsres))) {
-       device_printf(pcib, "_PRS buffer corrupt, cannot route interrupt\n");
-       goto out;
-    }
-
-    /* type-check the resource we've got */
-    if (prsres->Id != ACPI_RSTYPE_IRQ && prsres->Id != ACPI_RSTYPE_EXT_IRQ) {
-       device_printf(pcib, "_PRS resource entry has unsupported type %d\n",
-           prsres->Id);
+       device_printf(pcib, "no routed irq and no _PRS on irq link device\n");
        goto out;
     }
 
-    /* set variables based on resource type */
-    if (prsres->Id == ACPI_RSTYPE_IRQ) {
-       NumberOfInterrupts = prsres->Data.Irq.NumberOfInterrupts;
-       Interrupts = prsres->Data.Irq.Interrupts;
-    } else {
-       NumberOfInterrupts = prsres->Data.ExtendedIrq.NumberOfInterrupts;
-       Interrupts = prsres->Data.ExtendedIrq.Interrupts;
+    /*
+     * Search through the _PRS resources, looking for an IRQ or extended
+     * IRQ resource.  Skip dependent function resources for now.  In the
+     * future, we might use these for priority but this is good enough for
+     * now until BIOS vendors actually mean something by using them.
+     */
+    prsres = NULL;
+    for (i = prt->SourceIndex; prsres == NULL; i++) {
+       if (ACPI_FAILURE(acpi_FindIndexedResource(&prsbuf, i, &prsres))) {
+           device_printf(pcib, "_PRS lacks IRQ resource, routing failed\n");
+           goto out;
+       }
+       switch (prsres->Id) {
+       case ACPI_RSTYPE_IRQ:
+           NumberOfInterrupts = prsres->Data.Irq.NumberOfInterrupts;
+           Interrupts = prsres->Data.Irq.Interrupts;
+           break;
+       case ACPI_RSTYPE_EXT_IRQ:
+           NumberOfInterrupts = prsres->Data.ExtendedIrq.NumberOfInterrupts;
+           Interrupts = prsres->Data.ExtendedIrq.Interrupts;
+           break;
+       case ACPI_RSTYPE_START_DPF:
+           prsres = NULL;
+           continue;
+       default:
+           device_printf(pcib, "_PRS has invalid type %d\n", prsres->Id);
+           goto out;
+       }
     }
 
-    /* there has to be at least one interrupt available */
+    /* There has to be at least one interrupt available. */
     if (NumberOfInterrupts < 1) {
        device_printf(pcib, "device has no interrupts\n");
        goto out;
     }
 
     /*
-     * Pick an interrupt to use.  Note that a more scientific approach than just
-     * taking the first one available would be desirable.
+     * Pick an interrupt to use.  Note that a more scientific approach than
+     * just taking the first one available would be desirable.
      *
-     * The PCI BIOS $PIR table offers "preferred PCI interrupts", but ACPI doesn't
-     * seem to offer a similar mechanism, so picking a "good" interrupt here is a
-     * difficult task.
+     * The PCI BIOS $PIR table offers "preferred PCI interrupts", but ACPI
+     * doesn't seem to offer a similar mechanism, so picking a "good"
+     * interrupt here is a difficult task.
      *
-     * Build a resource buffer and pass it to AcpiSetCurrentResources to route the
-     * new interrupt.
+     * Build a resource buffer and pass it to AcpiSetCurrentResources to
+     * route the new interrupt.
      */
     device_printf(pcib, "possible interrupts:");
     for (i = 0; i < NumberOfInterrupts; i++)
        printf("  %d", Interrupts[i]);
     printf("\n");
 
-    if (crsbuf.Pointer != NULL)                        /* should never happen */
+    /* This should never happen. */
+    if (crsbuf.Pointer != NULL)
        AcpiOsFree(crsbuf.Pointer);
+
+    /* XXX Data.Irq and Data.ExtendedIrq are implicitly structure-copied. */
     crsbuf.Pointer = NULL;
     if (prsres->Id == ACPI_RSTYPE_IRQ) {
        resbuf.Id = ACPI_RSTYPE_IRQ;
        resbuf.Length = ACPI_SIZEOF_RESOURCE(ACPI_RESOURCE_IRQ);
-       resbuf.Data.Irq = prsres->Data.Irq;             /* structure copy other fields */
+       resbuf.Data.Irq = prsres->Data.Irq;
        resbuf.Data.Irq.NumberOfInterrupts = 1;
-       resbuf.Data.Irq.Interrupts[0] = Interrupts[0];  /* just take first... */
+       resbuf.Data.Irq.Interrupts[0] = Interrupts[0];
     } else {
        resbuf.Id = ACPI_RSTYPE_EXT_IRQ;
-       resbuf.Length = ACPI_SIZEOF_RESOURCE(ACPI_RESOURCE_IRQ);
-       resbuf.Data.ExtendedIrq = prsres->Data.ExtendedIrq;     /* structure copy other fields */
+       resbuf.Length = ACPI_SIZEOF_RESOURCE(ACPI_RESOURCE_EXT_IRQ);
+       resbuf.Data.ExtendedIrq = prsres->Data.ExtendedIrq;
        resbuf.Data.ExtendedIrq.NumberOfInterrupts = 1;
-       resbuf.Data.ExtendedIrq.Interrupts[0] = Interrupts[0];  /* just take first... */
+       resbuf.Data.ExtendedIrq.Interrupts[0] = Interrupts[0];
     }
     if (ACPI_FAILURE(status = acpi_AppendBufferResource(&crsbuf, &resbuf))) {
-       device_printf(pcib, "couldn't route interrupt %d via %s, interrupt resource build failed - %s\n",
-                     Interrupts[0], acpi_name(lnkdev), AcpiFormatException(status));
+       device_printf(pcib, "buf append failed for interrupt %d via %s - %s\n",
+                     Interrupts[0], acpi_name(lnkdev),
+                     AcpiFormatException(status));
+       goto out;
+    }
+    /* XXX Figure out how this is happening when the append succeeds. */
+    if (crsbuf.Pointer == NULL) {
+       device_printf(pcib, "_CRS buf NULL after append?\n");
        goto out;
     }
     if (ACPI_FAILURE(status = AcpiSetCurrentResources(lnkdev, &crsbuf))) {
-       device_printf(pcib, "couldn't route interrupt %d via %s - %s\n",
-                     Interrupts[0], acpi_name(lnkdev), AcpiFormatException(status));
+       device_printf(pcib, "_SRS failed for interrupt %d via %s - %s\n",
+                     Interrupts[0], acpi_name(lnkdev),
+                     AcpiFormatException(status));
        goto out;
     }
     
-    /* successful, return the interrupt we just routed */
+    /* Return the interrupt we just routed. */
     device_printf(pcib, "slot %d INT%c routed to irq %d via %s\n", 
-       pci_get_slot(dev), 'A' + pin, Interrupts[0], acpi_name(lnkdev));
+                 pci_get_slot(dev), 'A' + pin, Interrupts[0],
+                 acpi_name(lnkdev));
     interrupt = Interrupts[0];
 
- out:
+out:
     if (crsbuf.Pointer != NULL)
        AcpiOsFree(crsbuf.Pointer);
     if (prsbuf.Pointer != NULL)
@@ -371,6 +394,5 @@ acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin,
        AcpiOsFree(buf.Pointer);
 
     /* XXX APIC_IO interrupt mapping? */
-    return_VALUE(interrupt);
+    return_VALUE (interrupt);
 }
-