sys/dev/acpica/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  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  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
  37 #include <contrib/dev/acpica/include/acpi.h>
  38 #include <contrib/dev/acpica/include/accommon.h>
  39
  40 #include <dev/acpica/acpivar.h>
  41 #include <dev/acpica/acpi_pcibvar.h>
  42
  43 #include <dev/pci/pcivar.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 static void
  71 prt_walk_table(ACPI_BUFFER *prt, prt_entry_handler *handler, void *arg)
  72 {
  73     ACPI_PCI_ROUTING_TABLE *entry;
  74     char *prtptr;
  75
  76     /* First check to see if there is a table to walk. */
  77     if (prt == NULL || prt->Pointer == NULL)
  78         return;
  79
  80     /* Walk the table executing the handler function for each entry. */
  81     prtptr = prt->Pointer;
  82     entry = (ACPI_PCI_ROUTING_TABLE *)prtptr;
  83     while (entry->Length != 0) {
  84         handler(entry, arg);
  85         prtptr += entry->Length;
  86         entry = (ACPI_PCI_ROUTING_TABLE *)prtptr;
  87     }
  88 }
  89
  90 static void
  91 prt_attach_devices(ACPI_PCI_ROUTING_TABLE *entry, void *arg)
  92 {
  93     ACPI_HANDLE handle;
  94     device_t child, pcib;
  95     int error;
  96
  97     /* We only care about entries that reference a link device. */
  98     if (entry->Source == NULL || entry->Source[0] == '\0')
  99         return;
 100
 101     /*
 102      * In practice, we only see SourceIndex's of 0 out in the wild.
 103      * When indices != 0 have been found, they've been bugs in the ASL.
 104      */
 105     if (entry->SourceIndex != 0)
 106         return;
 107
 108     /* Lookup the associated handle and device. */
 109     pcib = (device_t)arg;
 110     if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, entry->Source, &handle)))
 111         return;
 112     child = acpi_get_device(handle);
 113     if (child == NULL)
 114         return;
 115
 116     /* If the device hasn't been probed yet, force it to do so. */
 117     error = device_probe_and_attach(child);
 118     if (error != 0) {
 119         device_printf(pcib, "failed to force attach of %s\n",
 120             acpi_name(handle));
 121         return;
 122     }
 123
 124     /* Add a reference for a specific bus/device/pin tuple. */
 125     acpi_pci_link_add_reference(child, entry->SourceIndex, pcib,
 126         ACPI_ADR_PCI_SLOT(entry->Address), entry->Pin);
 127 }
 128
 129 int
 130 acpi_pcib_attach(device_t dev, ACPI_BUFFER *prt, int busno)
 131 {
 132     ACPI_STATUS                 status;
 133
 134     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 135
 136     /*
 137      * Don't attach if we're not really there.
 138      *
 139      * XXX: This isn't entirely correct since we may be a PCI bus
 140      * on a hot-plug docking station, etc.
 141      */
 142     if (!acpi_DeviceIsPresent(dev))
 143         return_VALUE(ENXIO);
 144
 145     /*
 146      * Get the PCI interrupt routing table for this bus.  If we can't
 147      * get it, this is not an error but may reduce functionality.  There
 148      * are several valid bridges in the field that do not have a _PRT, so
 149      * only warn about missing tables if bootverbose is set.
 150      */
 151     prt->Length = ACPI_ALLOCATE_BUFFER;
 152     status = AcpiGetIrqRoutingTable(acpi_get_handle(dev), prt);
 153     if (ACPI_FAILURE(status) && (bootverbose || status != AE_NOT_FOUND))
 154         device_printf(dev,
 155             "could not get PCI interrupt routing table for %s - %s\n",
 156             acpi_name(acpi_get_handle(dev)), AcpiFormatException(status));
 157
 158     /*
 159      * Attach the PCI bus proper.
 160      */
 161     if (device_add_child(dev, "pci", busno) == NULL) {
 162         device_printf(device_get_parent(dev), "couldn't attach pci bus\n");
 163         return_VALUE(ENXIO);
 164     }
 165
 166     /*
 167      * Now go scan the bus.
 168      */
 169     prt_walk_table(prt, prt_attach_devices, dev);
 170
 171     return_VALUE (bus_generic_attach(dev));
 172 }
 173
 174 int
 175 acpi_pcib_resume(device_t dev)
 176 {
 177
 178     return (bus_generic_resume(dev));
 179 }
 180
 181 static void
 182 prt_lookup_device(ACPI_PCI_ROUTING_TABLE *entry, void *arg)
 183 {
 184     struct prt_lookup_request *pr;
 185
 186     pr = (struct prt_lookup_request *)arg;
 187     if (pr->pr_entry != NULL)
 188         return;
 189
 190     /*
 191      * Compare the slot number (high word of Address) and pin number
 192      * (note that ACPI uses 0 for INTA) to check for a match.
 193      *
 194      * Note that the low word of the Address field (function number)
 195      * is required by the specification to be 0xffff.  We don't risk
 196      * checking it here.
 197      */
 198     if (ACPI_ADR_PCI_SLOT(entry->Address) == pr->pr_slot &&
 199         entry->Pin == pr->pr_pin)
 200             pr->pr_entry = entry;
 201 }
 202
 203 /*
 204  * Route an interrupt for a child of the bridge.
 205  */
 206 int
 207 acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin,
 208     ACPI_BUFFER *prtbuf)
 209 {
 210     ACPI_PCI_ROUTING_TABLE *prt;
 211     struct prt_lookup_request pr;
 212     ACPI_HANDLE lnkdev;
 213     int interrupt;
 214
 215     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
 216
 217     interrupt = PCI_INVALID_IRQ;
 218
 219     /* ACPI numbers pins 0-3, not 1-4 like the BIOS. */
 220     pin--;
 221
 222     ACPI_SERIAL_BEGIN(pcib);
 223
 224     /* Search for a matching entry in the routing table. */
 225     pr.pr_entry = NULL;
 226     pr.pr_pin = pin;
 227     pr.pr_slot = pci_get_slot(dev);
 228     prt_walk_table(prtbuf, prt_lookup_device, &pr);
 229     if (pr.pr_entry == NULL) {
 230         device_printf(pcib, "no PRT entry for %d.%d.INT%c\n", pci_get_bus(dev),
 231             pci_get_slot(dev), 'A' + pin);
 232         goto out;
 233     }
 234     prt = pr.pr_entry;
 235
 236     if (bootverbose) {
 237         device_printf(pcib, "matched entry for %d.%d.INT%c",
 238             pci_get_bus(dev), pci_get_slot(dev), 'A' + pin);
 239         if (prt->Source != NULL && prt->Source[0] != '\0')
 240                 printf(" (src %s:%u)", prt->Source, prt->SourceIndex);
 241         printf("\n");
 242     }
 243
 244     /*
 245      * If source is empty/NULL, the source index is a global IRQ number
 246      * and it's hard-wired so we're done.
 247      *
 248      * XXX: If the source index is non-zero, ignore the source device and
 249      * assume that this is a hard-wired entry.
 250      */
 251     if (prt->Source == NULL || prt->Source[0] == '\0' ||
 252         prt->SourceIndex != 0) {
 253         if (bootverbose)
 254             device_printf(pcib, "slot %d INT%c hardwired to IRQ %d\n",
 255                 pci_get_slot(dev), 'A' + pin, prt->SourceIndex);
 256         if (prt->SourceIndex) {
 257             interrupt = prt->SourceIndex;
 258             BUS_CONFIG_INTR(dev, interrupt, INTR_TRIGGER_LEVEL,
 259                 INTR_POLARITY_LOW);
 260         } else
 261             device_printf(pcib, "error: invalid hard-wired IRQ of 0\n");
 262         goto out;
 263     }
 264
 265     /*
 266      * We have to find the source device (PCI interrupt link device).
 267      */
 268     if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, prt->Source, &lnkdev))) {
 269         device_printf(pcib, "couldn't find PCI interrupt link device %s\n",
 270             prt->Source);
 271         goto out;
 272     }
 273     interrupt = acpi_pci_link_route_interrupt(acpi_get_device(lnkdev),
 274         prt->SourceIndex);
 275
 276     if (bootverbose && PCI_INTERRUPT_VALID(interrupt))
 277         device_printf(pcib, "slot %d INT%c routed to irq %d via %s\n",
 278             pci_get_slot(dev), 'A' + pin, interrupt, acpi_name(lnkdev));
 279
 280 out:
 281     ACPI_SERIAL_END(pcib);
 282
 283     return_VALUE (interrupt);
 284 }