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 "acpi.h" 38 39 #include <dev/acpica/acpivar.h> 40 #include <dev/acpica/acpi_pcibvar.h> 41 42 #include <machine/pci_cfgreg.h> 43 #include <dev/pci/pcivar.h> 44 #include <dev/pci/pcib_private.h> 45 #include "pcib_if.h" 46 47 /* 48 * Hooks for the ACPI CA debugging infrastructure 49 */ 50 #define _COMPONENT ACPI_BUS 51 ACPI_MODULE_NAME("PCI") 52 53 int 54 acpi_pcib_attach(device_t dev, ACPI_BUFFER *prt, int busno) 55 { 56 device_t child; 57 ACPI_STATUS status; 58 59 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 60 61 /* 62 * Don't attach if we're not really there. 63 * 64 * XXX: This isn't entirely correct since we may be a PCI bus 65 * on a hot-plug docking station, etc. 66 */ 67 if (!acpi_DeviceIsPresent(dev)) 68 return_VALUE(ENXIO); 69 70 /* 71 * Get the PCI interrupt routing table for this bus. 72 */ 73 prt->Length = ACPI_ALLOCATE_BUFFER; 74 status = AcpiGetIrqRoutingTable(acpi_get_handle(dev), prt); 75 if (ACPI_FAILURE(status)) 76 /* This is not an error, but it may reduce functionality. */ 77 device_printf(dev, 78 "could not get PCI interrupt routing table for %s - %s\n", 79 acpi_name(acpi_get_handle(dev)), AcpiFormatException(status)); 80 81 /* 82 * Attach the PCI bus proper. 83 */ 84 if ((child = device_add_child(dev, "pci", busno)) == NULL) { 85 device_printf(device_get_parent(dev), "couldn't attach pci bus\n"); 86 return_VALUE(ENXIO); 87 } 88 89 /* 90 * Now go scan the bus. 91 */ 92 acpi_pci_link_config(dev, prt, busno); 93 return_VALUE(bus_generic_attach(dev)); 94 } 95 96 int 97 acpi_pcib_resume(device_t dev, ACPI_BUFFER *prt, int busno) 98 { 99 acpi_pci_link_resume(dev, prt, busno); 100 return (bus_generic_resume(dev)); 101 } 102 103 /* 104 * Route an interrupt for a child of the bridge. 105 * 106 * XXX clean up error messages 107 * 108 * XXX this function is somewhat bulky 109 */ 110 int 111 acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin, 112 ACPI_BUFFER *prtbuf) 113 { 114 ACPI_PCI_ROUTING_TABLE *prt; 115 ACPI_HANDLE lnkdev; 116 ACPI_BUFFER crsbuf, prsbuf; 117 ACPI_RESOURCE *crsres, *prsres, resbuf; 118 ACPI_DEVICE_INFO devinfo; 119 ACPI_BUFFER buf = {sizeof(devinfo), &devinfo}; 120 ACPI_STATUS status; 121 u_int8_t *prtp; 122 int interrupt; 123 int i; 124 125 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 126 127 crsbuf.Pointer = NULL; 128 prsbuf.Pointer = NULL; 129 interrupt = 255; 130 131 /* ACPI numbers pins 0-3, not 1-4 like the BIOS */ 132 pin--; 133 134 prtp = prtbuf->Pointer; 135 if (prtp == NULL) /* didn't get routing table */ 136 goto out; 137 138 /* scan the table looking for this device */ 139 for (;;) { 140 prt = (ACPI_PCI_ROUTING_TABLE *)prtp; 141 142 if (prt->Length == 0) /* end of table */ 143 goto out; 144 145 /* 146 * Compare the slot number (high word of Address) and pin number 147 * (note that ACPI uses 0 for INTA) to check for a match. 148 * 149 * Note that the low word of the Address field (function number) 150 * is required by the specification to be 0xffff. We don't risk 151 * checking it here. 152 */ 153 if ((((prt->Address & 0xffff0000) >> 16) == pci_get_slot(dev)) && 154 (prt->Pin == pin)) { 155 if (bootverbose) 156 device_printf(pcib, "matched entry for %d.%d.INT%c (source %s)\n", 157 pci_get_bus(dev), pci_get_slot(dev), 'A' + pin, prt->Source); 158 break; 159 } 160 161 /* skip to next entry */ 162 prtp += prt->Length; 163 } 164 165 /* 166 * If source is empty/NULL, the source index is the global IRQ number. 167 */ 168 if ((prt->Source == NULL) || (prt->Source[0] == '\0')) { 169 if (bootverbose) 170 device_printf(pcib, "device is hardwired to IRQ %d\n", 171 prt->SourceIndex); 172 interrupt = prt->SourceIndex; 173 goto out; 174 } 175 176 /* 177 * We have to find the source device (PCI interrupt link device) 178 */ 179 if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, prt->Source, &lnkdev))) { 180 device_printf(pcib, "couldn't find PCI interrupt link device %s\n", 181 prt->Source); 182 goto out; 183 } 184 185 /* 186 * Verify that this is a PCI link device, and that it's present. 187 */ 188 if (ACPI_FAILURE(AcpiGetObjectInfo(lnkdev, &buf))) { 189 device_printf(pcib, "couldn't validate PCI interrupt link device %s\n", 190 prt->Source); 191 goto out; 192 } 193 if (!(devinfo.Valid & ACPI_VALID_HID) || strcmp("PNP0C0F", devinfo.HardwareId.Value)) { 194 device_printf(pcib, "PCI interrupt link device %s has wrong _HID (%s)\n", 195 prt->Source, devinfo.HardwareId.Value); 196 goto out; 197 } 198 if (devinfo.Valid & ACPI_VALID_STA && (devinfo.CurrentStatus & 0x9) != 0x9) { 199 device_printf(pcib, "PCI interrupt link device %s not present\n", 200 prt->Source); 201 goto out; 202 } 203 204 /* 205 * Get the current and possible resources for the interrupt link device. 206 */ 207 crsbuf.Length = ACPI_ALLOCATE_BUFFER; 208 if (ACPI_FAILURE(status = AcpiGetCurrentResources(lnkdev, &crsbuf))) { 209 device_printf(pcib, "couldn't get PCI interrupt link device _CRS data - %s\n", 210 AcpiFormatException(status)); 211 goto out; /* this is fatal */ 212 } 213 prsbuf.Length = ACPI_ALLOCATE_BUFFER; 214 if (ACPI_FAILURE(status = AcpiGetPossibleResources(lnkdev, &prsbuf))) { 215 device_printf(pcib, "couldn't get PCI interrupt link device _PRS data - %s\n", 216 AcpiFormatException(status)); 217 /* this is not fatal, since it may be hardwired */ 218 } 219 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "got %ld bytes for %s._CRS\n", 220 (long)crsbuf.Length, acpi_name(lnkdev))); 221 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "got %ld bytes for %s._PRS\n", 222 (long)prsbuf.Length, acpi_name(lnkdev))); 223 224 /* 225 * The interrupt may already be routed, so check _CRS first. We don't check the 226 * 'decoding' bit in the _STA result, since there's nothing in the spec that 227 * mandates it be set, however some BIOS' will set it if the decode is active. 228 * 229 * The Source Index points to the particular resource entry we're interested in. 230 */ 231 if (ACPI_FAILURE(acpi_FindIndexedResource(&crsbuf, prt->SourceIndex, &crsres))) { 232 device_printf(pcib, "_CRS buffer corrupt, cannot route interrupt\n"); 233 goto out; 234 } 235 236 /* type-check the resource we've got */ 237 if (crsres->Id != ACPI_RSTYPE_IRQ) { /* XXX ACPI_RSTYPE_EXT_IRQ */ 238 device_printf(pcib, "_CRS resource entry has unsupported type %d\n", 239 crsres->Id); 240 goto out; 241 } 242 243 /* if there's more than one interrupt, we are confused */ 244 if (crsres->Data.Irq.NumberOfInterrupts > 1) { 245 device_printf(pcib, "device has too many interrupts (%d)\n", 246 crsres->Data.Irq.NumberOfInterrupts); 247 goto out; 248 } 249 250 /* 251 * If there's only one interrupt, and it's not zero, then we're already routed. 252 * 253 * Note that we could also check the 'decoding' bit in _STA, but can't depend on 254 * it since it's not part of the spec. 255 * 256 * XXX check ASL examples to see if this is an acceptable set of tests 257 */ 258 if ((crsres->Data.Irq.NumberOfInterrupts == 1) && (crsres->Data.Irq.Interrupts[0] != 0)) { 259 device_printf(pcib, "slot %d INT%c is routed to irq %d\n", 260 pci_get_slot(dev), 'A' + pin, crsres->Data.Irq.Interrupts[0]); 261 interrupt = crsres->Data.Irq.Interrupts[0]; 262 goto out; 263 } 264 265 /* 266 * There isn't an interrupt, so we have to look at _PRS to get one. 267 * Get the set of allowed interrupts from the _PRS resource indexed by SourceIndex. 268 */ 269 if (prsbuf.Pointer == NULL) { 270 device_printf(pcib, "device has no routed interrupt and no _PRS on PCI interrupt link device\n"); 271 goto out; 272 } 273 if (ACPI_FAILURE(acpi_FindIndexedResource(&prsbuf, prt->SourceIndex, &prsres))) { 274 device_printf(pcib, "_PRS buffer corrupt, cannot route interrupt\n"); 275 goto out; 276 } 277 278 /* type-check the resource we've got */ 279 if (prsres->Id != ACPI_RSTYPE_IRQ) { /* XXX ACPI_RSTYPE_EXT_IRQ */ 280 device_printf(pcib, "_PRS resource entry has unsupported type %d\n", 281 prsres->Id); 282 goto out; 283 } 284 285 /* there has to be at least one interrupt available */ 286 if (prsres->Data.Irq.NumberOfInterrupts < 1) { 287 device_printf(pcib, "device has no interrupts\n"); 288 goto out; 289 } 290 291 /* 292 * Pick an interrupt to use. Note that a more scientific approach than just 293 * taking the first one available would be desirable. 294 * 295 * The PCI BIOS $PIR table offers "preferred PCI interrupts", but ACPI doesn't 296 * seem to offer a similar mechanism, so picking a "good" interrupt here is a 297 * difficult task. 298 * 299 * Build a resource buffer and pass it to AcpiSetCurrentResources to route the 300 * new interrupt. 301 */ 302 device_printf(pcib, "possible interrupts:"); 303 for (i = 0; i < prsres->Data.Irq.NumberOfInterrupts; i++) 304 printf(" %d", prsres->Data.Irq.Interrupts[i]); 305 printf("\n"); 306 307 if (crsbuf.Pointer != NULL) /* should never happen */ 308 AcpiOsFree(crsbuf.Pointer); 309 crsbuf.Pointer = NULL; 310 resbuf.Id = ACPI_RSTYPE_IRQ; 311 resbuf.Length = ACPI_SIZEOF_RESOURCE(ACPI_RESOURCE_IRQ); 312 resbuf.Data.Irq = prsres->Data.Irq; /* structure copy other fields */ 313 resbuf.Data.Irq.NumberOfInterrupts = 1; 314 resbuf.Data.Irq.Interrupts[0] = prsres->Data.Irq.Interrupts[0]; /* just take first... */ 315 if (ACPI_FAILURE(status = acpi_AppendBufferResource(&crsbuf, &resbuf))) { 316 device_printf(pcib, "couldn't route interrupt %d via %s, interrupt resource build failed - %s\n", 317 prsres->Data.Irq.Interrupts[0], acpi_name(lnkdev), AcpiFormatException(status)); 318 goto out; 319 } 320 if (ACPI_FAILURE(status = AcpiSetCurrentResources(lnkdev, &crsbuf))) { 321 device_printf(pcib, "couldn't route interrupt %d via %s - %s\n", 322 prsres->Data.Irq.Interrupts[0], acpi_name(lnkdev), AcpiFormatException(status)); 323 goto out; 324 } 325 326 /* successful, return the interrupt we just routed */ 327 device_printf(pcib, "slot %d INT%c routed to irq %d via %s\n", 328 pci_get_slot(dev), 'A' + pin, prsres->Data.Irq.Interrupts[0], 329 acpi_name(lnkdev)); 330 interrupt = prsres->Data.Irq.Interrupts[0]; 331 332 out: 333 if (crsbuf.Pointer != NULL) 334 AcpiOsFree(crsbuf.Pointer); 335 if (prsbuf.Pointer != NULL) 336 AcpiOsFree(prsbuf.Pointer); 337 338 /* XXX APIC_IO interrupt mapping? */ 339 return_VALUE(interrupt); 340 } 341 342