xref: /freebsd/sys/dev/acpica/acpi_pcib.c (revision 2e3f49888ec8851bafb22011533217487764fdb0)
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 #include "opt_acpi.h"
30 #include <sys/param.h>
31 #include <sys/bus.h>
32 #include <sys/malloc.h>
33 #include <sys/kernel.h>
34 
35 #include <contrib/dev/acpica/include/acpi.h>
36 #include <contrib/dev/acpica/include/accommon.h>
37 
38 #include <dev/acpica/acpivar.h>
39 #include <dev/acpica/acpi_pcibvar.h>
40 
41 #include <dev/pci/pcivar.h>
42 #include "pcib_if.h"
43 
44 /* Hooks for the ACPI CA debugging infrastructure. */
45 #define _COMPONENT	ACPI_BUS
46 ACPI_MODULE_NAME("PCI")
47 
48 ACPI_SERIAL_DECL(pcib, "ACPI PCI bus methods");
49 
50 /*
51  * For locking, we assume the caller is not concurrent since this is
52  * triggered by newbus methods.
53  */
54 
55 struct prt_lookup_request {
56     ACPI_PCI_ROUTING_TABLE *pr_entry;
57     u_int	pr_pin;
58     u_int	pr_slot;
59 };
60 
61 typedef	void prt_entry_handler(ACPI_PCI_ROUTING_TABLE *entry, void *arg);
62 
63 static void	prt_attach_devices(ACPI_PCI_ROUTING_TABLE *entry, void *arg);
64 static void	prt_lookup_device(ACPI_PCI_ROUTING_TABLE *entry, void *arg);
65 static void	prt_walk_table(ACPI_BUFFER *prt, prt_entry_handler *handler,
66 		    void *arg);
67 
68 static void
69 prt_walk_table(ACPI_BUFFER *prt, prt_entry_handler *handler, void *arg)
70 {
71     ACPI_PCI_ROUTING_TABLE *entry;
72     char *prtptr;
73 
74     /* First check to see if there is a table to walk. */
75     if (prt == NULL || prt->Pointer == NULL)
76 	return;
77 
78     /* Walk the table executing the handler function for each entry. */
79     prtptr = prt->Pointer;
80     entry = (ACPI_PCI_ROUTING_TABLE *)prtptr;
81     while (entry->Length != 0) {
82 	handler(entry, arg);
83 	prtptr += entry->Length;
84 	entry = (ACPI_PCI_ROUTING_TABLE *)prtptr;
85     }
86 }
87 
88 static void
89 prt_attach_devices(ACPI_PCI_ROUTING_TABLE *entry, void *arg)
90 {
91     ACPI_HANDLE handle;
92     device_t child, pcib;
93     int error;
94 
95     /* We only care about entries that reference a link device. */
96     if (entry->Source[0] == '\0')
97 	return;
98 
99     /*
100      * In practice, we only see SourceIndex's of 0 out in the wild.
101      * When indices != 0 have been found, they've been bugs in the ASL.
102      */
103     if (entry->SourceIndex != 0)
104 	return;
105 
106     /* Lookup the associated handle and device. */
107     pcib = (device_t)arg;
108     if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, entry->Source, &handle)))
109 	return;
110     child = acpi_get_device(handle);
111     if (child == NULL)
112 	return;
113 
114     /* If the device hasn't been probed yet, force it to do so. */
115     error = device_probe_and_attach(child);
116     if (error != 0) {
117 	device_printf(pcib, "failed to force attach of %s\n",
118 	    acpi_name(handle));
119 	return;
120     }
121 
122     /* Add a reference for a specific bus/device/pin tuple. */
123     acpi_pci_link_add_reference(child, entry->SourceIndex, pcib,
124 	ACPI_ADR_PCI_SLOT(entry->Address), entry->Pin);
125 }
126 
127 void
128 acpi_pcib_fetch_prt(device_t dev, ACPI_BUFFER *prt)
129 {
130     ACPI_STATUS status;
131 
132     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
133 
134     /*
135      * Get the PCI interrupt routing table for this bus.  If we can't
136      * get it, this is not an error but may reduce functionality.  There
137      * are several valid bridges in the field that do not have a _PRT, so
138      * only warn about missing tables if bootverbose is set.
139      */
140     prt->Length = ACPI_ALLOCATE_BUFFER;
141     status = AcpiGetIrqRoutingTable(acpi_get_handle(dev), prt);
142     if (ACPI_FAILURE(status) && (bootverbose || status != AE_NOT_FOUND))
143 	device_printf(dev,
144 	    "could not get PCI interrupt routing table for %s - %s\n",
145 	    acpi_name(acpi_get_handle(dev)), AcpiFormatException(status));
146 
147     /*
148      * Ensure all the link devices are attached.
149      */
150     prt_walk_table(prt, prt_attach_devices, dev);
151 }
152 
153 static void
154 prt_lookup_device(ACPI_PCI_ROUTING_TABLE *entry, void *arg)
155 {
156     struct prt_lookup_request *pr;
157 
158     pr = (struct prt_lookup_request *)arg;
159     if (pr->pr_entry != NULL)
160 	return;
161 
162     /*
163      * Compare the slot number (high word of Address) and pin number
164      * (note that ACPI uses 0 for INTA) to check for a match.
165      *
166      * Note that the low word of the Address field (function number)
167      * is required by the specification to be 0xffff.  We don't risk
168      * checking it here.
169      */
170     if (ACPI_ADR_PCI_SLOT(entry->Address) == pr->pr_slot &&
171 	entry->Pin == pr->pr_pin)
172 	    pr->pr_entry = entry;
173 }
174 
175 /*
176  * Route an interrupt for a child of the bridge.
177  */
178 int
179 acpi_pcib_route_interrupt(device_t pcib, device_t dev, int pin,
180     ACPI_BUFFER *prtbuf)
181 {
182     ACPI_PCI_ROUTING_TABLE *prt;
183     struct prt_lookup_request pr;
184     ACPI_HANDLE lnkdev;
185     int interrupt;
186 
187     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
188 
189     lnkdev = NULL;
190     interrupt = PCI_INVALID_IRQ;
191 
192     /* ACPI numbers pins 0-3, not 1-4 like the BIOS. */
193     pin--;
194 
195     ACPI_SERIAL_BEGIN(pcib);
196 
197     /* Search for a matching entry in the routing table. */
198     pr.pr_entry = NULL;
199     pr.pr_pin = pin;
200     pr.pr_slot = pci_get_slot(dev);
201     prt_walk_table(prtbuf, prt_lookup_device, &pr);
202     if (pr.pr_entry == NULL) {
203 	device_printf(pcib, "no PRT entry for %d.%d.INT%c\n", pci_get_bus(dev),
204 	    pci_get_slot(dev), 'A' + pin);
205 	goto out;
206     }
207     prt = pr.pr_entry;
208 
209     if (bootverbose) {
210 	device_printf(pcib, "matched entry for %d.%d.INT%c",
211 	    pci_get_bus(dev), pci_get_slot(dev), 'A' + pin);
212 	if (prt->Source[0] != '\0')
213 		printf(" (src %s:%u)", prt->Source, prt->SourceIndex);
214 	printf("\n");
215     }
216 
217     /*
218      * If source is empty/NULL, the source index is a global IRQ number
219      * and it's hard-wired so we're done.
220      *
221      * XXX: If the source index is non-zero, ignore the source device and
222      * assume that this is a hard-wired entry.
223      */
224     if (prt->Source[0] == '\0' || prt->SourceIndex != 0) {
225 	if (bootverbose)
226 	    device_printf(pcib, "slot %d INT%c hardwired to IRQ %d\n",
227 		pci_get_slot(dev), 'A' + pin, prt->SourceIndex);
228 	if (prt->SourceIndex) {
229 	    interrupt = prt->SourceIndex;
230 	    BUS_CONFIG_INTR(dev, interrupt, INTR_TRIGGER_LEVEL,
231 		INTR_POLARITY_LOW);
232 	} else
233 	    device_printf(pcib, "error: invalid hard-wired IRQ of 0\n");
234 	goto out;
235     }
236 
237     /*
238      * We have to find the source device (PCI interrupt link device).
239      */
240     if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, prt->Source, &lnkdev))) {
241 	device_printf(pcib, "couldn't find PCI interrupt link device %s\n",
242 	    prt->Source);
243 	goto out;
244     }
245     interrupt = acpi_pci_link_route_interrupt(acpi_get_device(lnkdev),
246 	prt->SourceIndex);
247 
248     if (bootverbose && PCI_INTERRUPT_VALID(interrupt))
249 	device_printf(pcib, "slot %d INT%c routed to irq %d via %s\n",
250 	    pci_get_slot(dev), 'A' + pin, interrupt, acpi_name(lnkdev));
251 
252 out:
253     ACPI_SERIAL_END(pcib);
254 #ifdef INTRNG
255     if (PCI_INTERRUPT_VALID(interrupt)) {
256 	interrupt  = acpi_map_intr(dev, interrupt, lnkdev);
257 	KASSERT(PCI_INTERRUPT_VALID(interrupt), ("mapping fail"));
258     }
259 #endif
260     return_VALUE(interrupt);
261 }
262 
263 int
264 acpi_pcib_power_for_sleep(device_t pcib, device_t dev, int *pstate)
265 {
266     device_t acpi_dev;
267 
268     acpi_dev = devclass_get_device(devclass_find("acpi"), 0);
269     acpi_device_pwr_for_sleep(acpi_dev, dev, pstate);
270     return (0);
271 }
272 
273 int
274 acpi_pcib_get_cpus(device_t pcib, device_t dev, enum cpu_sets op,
275     size_t setsize, cpuset_t *cpuset)
276 {
277 
278 	return (bus_get_cpus(pcib, op, setsize, cpuset));
279 }
280