sys/dev/acpica5/acpi_pcib.c

   1 /*-
   2  * Copyright (c) 2000 Michael Smith
   3  * Copyright (c) 2000 BSDi
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  * __FBSDID("$FreeBSD: src/sys/dev/acpica/acpi_pcib.c,v 1.60.8.1 2009/04/15 03:14:26 kensmith Exp $");
  27  */
  28
  29 #include <sys/cdefs.h>
  30
  31 #include "opt_acpi.h"
  32 #include <sys/param.h>
  33 #include <sys/bus.h>
  34 #include <sys/malloc.h>
  35 #include <sys/kernel.h>
  36 #include <machine/smp.h>
  37
  38 #include "acpi.h"
  39 #include <dev/acpica5/acpivar.h>
  40 #include <dev/acpica5/acpi_pcibvar.h>
  41
  42 #include <bus/pci/pcivar.h>
  43 #include <bus/pci/pcireg.h>
  44 #include "pcib_if.h"
  45
  46 /* Hooks for the ACPI CA debugging infrastructure. */
  47 #define _COMPONENT      ACPI_BUS
  48 ACPI_MODULE_NAME("PCI")
  49
  50 ACPI_SERIAL_DECL(pcib, "ACPI PCI bus methods");
  51
  52 /*
  53  * For locking, we assume the caller is not concurrent since this is
  54  * triggered by newbus methods.
  55  */
  56
  57 struct prt_lookup_request {
  58     ACPI_PCI_ROUTING_TABLE *pr_entry;
  59     u_int       pr_pin;
  60     u_int       pr_slot;
  61 };
  62
  63 typedef void prt_entry_handler(ACPI_PCI_ROUTING_TABLE *entry, void *arg);
  64
  65 static void     prt_attach_devices(ACPI_PCI_ROUTING_TABLE *entry, void *arg);
  66 static void     prt_lookup_device(ACPI_PCI_ROUTING_TABLE *entry, void *arg);
  67 static void     prt_walk_table(ACPI_BUFFER *prt, prt_entry_handler *handler,
  68                     void *arg);
  69
  70 #define PCI_INVALID_IRQ 255
  71
  72 static void
  73 prt_walk_table(ACPI_BUFFER *prt, prt_entry_handler *handler, void *arg)
  74 {
  75     ACPI_PCI_ROUTING_TABLE *entry;
  76     char *prtptr;
  77
  78     /* First check to see if there is a table to walk. */
  79     if (prt == NULL || prt->Pointer == NULL)
  80         return;
  81
  82     /* Walk the table executing the handler function for each entry. */
  83     prtptr = prt->Pointer;
  84     entry = (ACPI_PCI_ROUTING_TABLE *)prtptr;
  85     while (entry->Length != 0) {
  86         handler(entry, arg);
  87         prtptr += entry->Length;
  88         entry = (ACPI_PCI_ROUTING_TABLE *)prtptr;
  89     }
  90 }
  91
  92 static void
  93 prt_attach_devices(ACPI_PCI_ROUTING_TABLE *entry, void *arg)
  94 {
  95     ACPI_HANDLE handle;
  96     device_t child, pcib;
  97     int error;
  98
  99     /* We only care about entries that reference a link device. */
 100     if (entry->Source == NULL || entry->Source[0] == '\0')
 101         return;
 102
 103     /*
 104      * In practice, we only see SourceIndex's of 0 out in the wild.
 105      * When indices != 0 have been found, they've been bugs in the ASL.
 106      */
 107     if (entry->SourceIndex != 0)
 108         return;
 109
 110     /* Lookup the associated handle and device. */
 111     pcib = (device_t)arg;
 112     if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, entry->Source, &handle)))
 113         return;
 114     child = acpi_get_device(handle);
 115     if (child == NULL)
 116         return;
 117
 118     /* If the device hasn't been probed yet, force it to do so. */
 119     error = device_probe_and_attach(child);
 120     if (error != 0) {
 121         device_printf(pcib, "failed to force attach of %s\n",
 122             acpi_name(handle));
 123         return;
 124     }
 125
 126     /* Add a reference for a specific bus/device/pin tuple. */
 127     acpi_pci_link_add_reference(child, entry->SourceIndex, pcib,
 128         ACPI_ADR_PCI_SLOT(entry->Address), entry->Pin);
 129 }
 130
 131 int
 132 acpi_pcib_attach(device_t dev, ACPI_BUFFER *prt, int busno)
 133 {
 134     device_t                    child;
 135     ACPI_STATUS                 status;
 136
 137     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 138
 139     /*
 140      * Don't attach if we're not really there.
 141      *
 142      * XXX: This isn't entirely correct since we may be a PCI bus
 143      * on a hot-plug docking station, etc.
 144      */
 145
 146     if (!acpi_DeviceIsPresent(dev))
 147         return_VALUE(ENXIO);
 148
 149     /*
 150      * Get the PCI interrupt routing table for this bus.  If we can't
 151      * get it, this is not an error but may reduce functionality.  There
 152      * are several valid bridges in the field that do not have a _PRT, so
 153      * only warn about missing tables if bootverbose is set.
 154      */
 155     prt->Length = ACPI_ALLOCATE_BUFFER;
 156     status = AcpiGetIrqRoutingTable(acpi_get_handle(dev), prt);
 157     if (ACPI_FAILURE(status) && (bootverbose || status != AE_NOT_FOUND))
 158         device_printf(dev,
 159             "could not get PCI interrupt routing table for %s - %s\n",
 160             acpi_name(acpi_get_handle(dev)), AcpiFormatException(status));
 161
 162     /*
 163      * Attach the PCI bus proper.
 164      */
 165     if ((child = device_add_child(dev, "pci", busno)) == NULL) {
 166         device_printf(device_get_parent(dev), "couldn't attach pci bus\n");
 167         return_VALUE(ENXIO);
 168     }
 169
 170     /*
 171      * Now go scan the bus.
 172      */
 173     prt_walk_table(prt, prt_attach_devices, dev);
 174
 175     return_VALUE (bus_generic_attach(dev));
 176 }
 177
 178 int
 179 acpi_pcib_resume(device_t dev)
 180 {
 181
 182     return (bus_generic_resume(dev));
 183 }
 184
 185 static void
 186 prt_lookup_device(ACPI_PCI_ROUTING_TABLE *entry, void *arg)
 187 {
 188     struct prt_lookup_request *pr;
 189
 190     pr = (struct prt_lookup_request *)arg;
 191     if (pr->pr_entry != NULL)
 192         return;
 193
 194     /*
 195      * Compare the slot number (high word of Address) and pin number
 196      * (note that ACPI uses 0 for INTA) to check for a match.
 197      *
 198      * Note that the low word of the Address field (function number)
 199      * is required by the specification to be 0xffff.  We don't risk
 200      * checking it here.
 201      */
 202     if (ACPI_ADR_PCI_SLOT(entry->Address) == pr->pr_slot &&
 203         entry->Pin == pr->pr_pin)
 204             pr->pr_entry = entry;
 205 }
 206
 207 /*
 208  * Route an interrupt for a child of the bridge.
 209  */
 210 int
 211 acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin,
 212     ACPI_BUFFER *prtbuf)
 213 {
 214     ACPI_PCI_ROUTING_TABLE *prt;
 215     struct prt_lookup_request pr;
 216     ACPI_HANDLE lnkdev;
 217     int interrupt;
 218
 219     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 220
 221     interrupt = PCI_INVALID_IRQ;
 222
 223     /* ACPI numbers pins 0-3, not 1-4 like the BIOS. */
 224     pin--;
 225
 226     ACPI_SERIAL_BEGIN(pcib);
 227
 228     /* Search for a matching entry in the routing table. */
 229     pr.pr_entry = NULL;
 230     pr.pr_pin = pin;
 231     pr.pr_slot = pci_get_slot(dev);
 232     prt_walk_table(prtbuf, prt_lookup_device, &pr);
 233     if (pr.pr_entry == NULL) {
 234         device_printf(pcib, "no PRT entry for %d.%d.INT%c\n", pci_get_bus(dev),
 235             pci_get_slot(dev), 'A' + pin);
 236         goto out;
 237     }
 238     prt = pr.pr_entry;
 239
 240     if (bootverbose) {
 241         device_printf(pcib, "matched entry for %d.%d.INT%c",
 242             pci_get_bus(dev), pci_get_slot(dev), 'A' + pin);
 243         if (prt->Source != NULL && prt->Source[0] != '\0')
 244                 kprintf(" (src %s:%u)", prt->Source, prt->SourceIndex);
 245         kprintf("\n");
 246     }
 247
 248     /*
 249      * If source is empty/NULL, the source index is a global IRQ number
 250      * and it's hard-wired so we're done.
 251      *
 252      * XXX: If the source index is non-zero, ignore the source device and
 253      * assume that this is a hard-wired entry.
 254      */
 255     if (prt->Source == NULL || prt->Source[0] == '\0' ||
 256         prt->SourceIndex != 0) {
 257         if (bootverbose)
 258             device_printf(pcib, "slot %d INT%c hardwired to IRQ %d\n",
 259                 pci_get_slot(dev), 'A' + pin, prt->SourceIndex);
 260         if (prt->SourceIndex) {
 261             interrupt = prt->SourceIndex;
 262         pci_write_config(dev, PCIR_INTLINE, interrupt, 1);
 263         BUS_CONFIG_INTR(device_get_parent(dev), dev, interrupt, INTR_TRIGGER_LEVEL,
 264                 INTR_POLARITY_LOW);
 265         } else
 266             device_printf(pcib, "error: invalid hard-wired IRQ of 0\n");
 267         goto out;
 268     }
 269
 270     /*
 271      * We have to find the source device (PCI interrupt link device).
 272      */
 273     if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, prt->Source, &lnkdev))) {
 274         device_printf(pcib, "couldn't find PCI interrupt link device %s\n",
 275             prt->Source);
 276         goto out;
 277     }
 278     interrupt = acpi_pci_link_route_interrupt(acpi_get_device(lnkdev),
 279         prt->SourceIndex);
 280
 281     if (bootverbose && PCI_INTERRUPT_VALID(interrupt)) {
 282         if (PCI_INTERRUPT_VALID(interrupt))
 283             device_printf(pcib, "slot %d INT%c routed to irq %d via %s\n",
 284                  pci_get_slot(dev), 'A' + pin, interrupt, acpi_name(lnkdev));
 285     }
 286
 287 out:
 288     ACPI_SERIAL_END(pcib);
 289
 290     return_VALUE (interrupt);
 291 }