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 int error; 134 135 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 136 137 /* 138 * Don't attach if we're not really there. 139 * 140 * XXX: This isn't entirely correct since we may be a PCI bus 141 * on a hot-plug docking station, etc. 142 */ 143 if (!acpi_DeviceIsPresent(dev)) 144 return_VALUE(ENXIO); 145 146 /* 147 * Get the PCI interrupt routing table for this bus. If we can't 148 * get it, this is not an error but may reduce functionality. There 149 * are several valid bridges in the field that do not have a _PRT, so 150 * only warn about missing tables if bootverbose is set. 151 */ 152 prt->Length = ACPI_ALLOCATE_BUFFER; 153 status = AcpiGetIrqRoutingTable(acpi_get_handle(dev), prt); 154 if (ACPI_FAILURE(status) && (bootverbose || status != AE_NOT_FOUND)) 155 device_printf(dev, 156 "could not get PCI interrupt routing table for %s - %s\n", 157 acpi_name(acpi_get_handle(dev)), AcpiFormatException(status)); 158 159 /* 160 * Attach the PCI bus proper. 161 */ 162 if (device_add_child(dev, "pci", busno) == NULL) { 163 device_printf(device_get_parent(dev), "couldn't attach pci bus\n"); 164 return_VALUE(ENXIO); 165 } 166 167 /* 168 * Now go scan the bus. 169 */ 170 prt_walk_table(prt, prt_attach_devices, dev); 171 172 error = bus_generic_attach(dev); 173 return_VALUE(error); 174 } 175 176 static void 177 prt_lookup_device(ACPI_PCI_ROUTING_TABLE *entry, void *arg) 178 { 179 struct prt_lookup_request *pr; 180 181 pr = (struct prt_lookup_request *)arg; 182 if (pr->pr_entry != NULL) 183 return; 184 185 /* 186 * Compare the slot number (high word of Address) and pin number 187 * (note that ACPI uses 0 for INTA) to check for a match. 188 * 189 * Note that the low word of the Address field (function number) 190 * is required by the specification to be 0xffff. We don't risk 191 * checking it here. 192 */ 193 if (ACPI_ADR_PCI_SLOT(entry->Address) == pr->pr_slot && 194 entry->Pin == pr->pr_pin) 195 pr->pr_entry = entry; 196 } 197 198 /* 199 * Route an interrupt for a child of the bridge. 200 */ 201 int 202 acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin, 203 ACPI_BUFFER *prtbuf) 204 { 205 ACPI_PCI_ROUTING_TABLE *prt; 206 struct prt_lookup_request pr; 207 ACPI_HANDLE lnkdev; 208 int interrupt; 209 210 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 211 212 interrupt = PCI_INVALID_IRQ; 213 214 /* ACPI numbers pins 0-3, not 1-4 like the BIOS. */ 215 pin--; 216 217 ACPI_SERIAL_BEGIN(pcib); 218 219 /* Search for a matching entry in the routing table. */ 220 pr.pr_entry = NULL; 221 pr.pr_pin = pin; 222 pr.pr_slot = pci_get_slot(dev); 223 prt_walk_table(prtbuf, prt_lookup_device, &pr); 224 if (pr.pr_entry == NULL) { 225 device_printf(pcib, "no PRT entry for %d.%d.INT%c\n", pci_get_bus(dev), 226 pci_get_slot(dev), 'A' + pin); 227 goto out; 228 } 229 prt = pr.pr_entry; 230 231 if (bootverbose) { 232 device_printf(pcib, "matched entry for %d.%d.INT%c", 233 pci_get_bus(dev), pci_get_slot(dev), 'A' + pin); 234 if (prt->Source != NULL && prt->Source[0] != '\0') 235 printf(" (src %s:%u)", prt->Source, prt->SourceIndex); 236 printf("\n"); 237 } 238 239 /* 240 * If source is empty/NULL, the source index is a global IRQ number 241 * and it's hard-wired so we're done. 242 * 243 * XXX: If the source index is non-zero, ignore the source device and 244 * assume that this is a hard-wired entry. 245 */ 246 if (prt->Source == NULL || prt->Source[0] == '\0' || 247 prt->SourceIndex != 0) { 248 if (bootverbose) 249 device_printf(pcib, "slot %d INT%c hardwired to IRQ %d\n", 250 pci_get_slot(dev), 'A' + pin, prt->SourceIndex); 251 if (prt->SourceIndex) { 252 interrupt = prt->SourceIndex; 253 BUS_CONFIG_INTR(dev, interrupt, INTR_TRIGGER_LEVEL, 254 INTR_POLARITY_LOW); 255 } else 256 device_printf(pcib, "error: invalid hard-wired IRQ of 0\n"); 257 goto out; 258 } 259 260 /* 261 * We have to find the source device (PCI interrupt link device). 262 */ 263 if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, prt->Source, &lnkdev))) { 264 device_printf(pcib, "couldn't find PCI interrupt link device %s\n", 265 prt->Source); 266 goto out; 267 } 268 interrupt = acpi_pci_link_route_interrupt(acpi_get_device(lnkdev), 269 prt->SourceIndex); 270 271 if (bootverbose && PCI_INTERRUPT_VALID(interrupt)) 272 device_printf(pcib, "slot %d INT%c routed to irq %d via %s\n", 273 pci_get_slot(dev), 'A' + pin, interrupt, acpi_name(lnkdev)); 274 275 out: 276 ACPI_SERIAL_END(pcib); 277 278 return_VALUE(interrupt); 279 } 280 281 int 282 acpi_pcib_power_for_sleep(device_t pcib, device_t dev, int *pstate) 283 { 284 device_t acpi_dev; 285 286 acpi_dev = devclass_get_device(devclass_find("acpi"), 0); 287 acpi_device_pwr_for_sleep(acpi_dev, dev, pstate); 288 return (0); 289 } 290