xref: /freebsd/sys/dev/acpica/acpi_pcib_acpi.c (revision a3cf0ef5a295c885c895fabfd56470c0d1db322d)
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/kernel.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
37 #include <sys/sysctl.h>
38 
39 #include <contrib/dev/acpica/include/acpi.h>
40 #include <contrib/dev/acpica/include/accommon.h>
41 
42 #include <dev/acpica/acpivar.h>
43 
44 #include <machine/pci_cfgreg.h>
45 #include <dev/pci/pcivar.h>
46 #include <dev/pci/pcib_private.h>
47 #include "pcib_if.h"
48 
49 #include <dev/acpica/acpi_pcibvar.h>
50 
51 /* Hooks for the ACPI CA debugging infrastructure. */
52 #define _COMPONENT	ACPI_BUS
53 ACPI_MODULE_NAME("PCI_ACPI")
54 
55 struct acpi_hpcib_softc {
56     device_t		ap_dev;
57     ACPI_HANDLE		ap_handle;
58     int			ap_flags;
59 
60     int			ap_segment;	/* analagous to Alpha 'hose' */
61     int			ap_bus;		/* bios-assigned bus number */
62 
63     ACPI_BUFFER		ap_prt;		/* interrupt routing table */
64 };
65 
66 static int		acpi_pcib_acpi_probe(device_t bus);
67 static int		acpi_pcib_acpi_attach(device_t bus);
68 static int		acpi_pcib_read_ivar(device_t dev, device_t child,
69 			    int which, uintptr_t *result);
70 static int		acpi_pcib_write_ivar(device_t dev, device_t child,
71 			    int which, uintptr_t value);
72 static uint32_t		acpi_pcib_read_config(device_t dev, u_int bus,
73 			    u_int slot, u_int func, u_int reg, int bytes);
74 static void		acpi_pcib_write_config(device_t dev, u_int bus,
75 			    u_int slot, u_int func, u_int reg, uint32_t data,
76 			    int bytes);
77 static int		acpi_pcib_acpi_route_interrupt(device_t pcib,
78 			    device_t dev, int pin);
79 static int		acpi_pcib_alloc_msi(device_t pcib, device_t dev,
80 			    int count, int maxcount, int *irqs);
81 static int		acpi_pcib_map_msi(device_t pcib, device_t dev,
82 			    int irq, uint64_t *addr, uint32_t *data);
83 static int		acpi_pcib_alloc_msix(device_t pcib, device_t dev,
84 			    int *irq);
85 static struct resource *acpi_pcib_acpi_alloc_resource(device_t dev,
86 			    device_t child, int type, int *rid,
87 			    u_long start, u_long end, u_long count,
88 			    u_int flags);
89 
90 static device_method_t acpi_pcib_acpi_methods[] = {
91     /* Device interface */
92     DEVMETHOD(device_probe,		acpi_pcib_acpi_probe),
93     DEVMETHOD(device_attach,		acpi_pcib_acpi_attach),
94     DEVMETHOD(device_shutdown,		bus_generic_shutdown),
95     DEVMETHOD(device_suspend,		bus_generic_suspend),
96     DEVMETHOD(device_resume,		bus_generic_resume),
97 
98     /* Bus interface */
99     DEVMETHOD(bus_print_child,		bus_generic_print_child),
100     DEVMETHOD(bus_read_ivar,		acpi_pcib_read_ivar),
101     DEVMETHOD(bus_write_ivar,		acpi_pcib_write_ivar),
102     DEVMETHOD(bus_alloc_resource,	acpi_pcib_acpi_alloc_resource),
103     DEVMETHOD(bus_release_resource,	bus_generic_release_resource),
104     DEVMETHOD(bus_activate_resource,	bus_generic_activate_resource),
105     DEVMETHOD(bus_deactivate_resource,	bus_generic_deactivate_resource),
106     DEVMETHOD(bus_setup_intr,		bus_generic_setup_intr),
107     DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
108 
109     /* pcib interface */
110     DEVMETHOD(pcib_maxslots,		pcib_maxslots),
111     DEVMETHOD(pcib_read_config,		acpi_pcib_read_config),
112     DEVMETHOD(pcib_write_config,	acpi_pcib_write_config),
113     DEVMETHOD(pcib_route_interrupt,	acpi_pcib_acpi_route_interrupt),
114     DEVMETHOD(pcib_alloc_msi,		acpi_pcib_alloc_msi),
115     DEVMETHOD(pcib_release_msi,		pcib_release_msi),
116     DEVMETHOD(pcib_alloc_msix,		acpi_pcib_alloc_msix),
117     DEVMETHOD(pcib_release_msix,	pcib_release_msix),
118     DEVMETHOD(pcib_map_msi,		acpi_pcib_map_msi),
119     DEVMETHOD(pcib_power_for_sleep,	acpi_pcib_power_for_sleep),
120 
121     {0, 0}
122 };
123 
124 static devclass_t pcib_devclass;
125 
126 DEFINE_CLASS_0(pcib, acpi_pcib_acpi_driver, acpi_pcib_acpi_methods,
127     sizeof(struct acpi_hpcib_softc));
128 DRIVER_MODULE(acpi_pcib, acpi, acpi_pcib_acpi_driver, pcib_devclass, 0, 0);
129 MODULE_DEPEND(acpi_pcib, acpi, 1, 1, 1);
130 
131 static int
132 acpi_pcib_acpi_probe(device_t dev)
133 {
134     ACPI_DEVICE_INFO	*devinfo;
135     ACPI_HANDLE		h;
136     int			root;
137 
138     if (acpi_disabled("pcib") || (h = acpi_get_handle(dev)) == NULL ||
139 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
140 	return (ENXIO);
141     root = (devinfo->Flags & ACPI_PCI_ROOT_BRIDGE) != 0;
142     AcpiOsFree(devinfo);
143     if (!root || pci_cfgregopen() == 0)
144 	return (ENXIO);
145 
146     device_set_desc(dev, "ACPI Host-PCI bridge");
147     return (0);
148 }
149 
150 static int
151 acpi_pcib_acpi_attach(device_t dev)
152 {
153     struct acpi_hpcib_softc	*sc;
154     ACPI_STATUS			status;
155     static int bus0_seen = 0;
156     u_int addr, slot, func, busok;
157     uint8_t busno;
158 
159     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
160 
161     sc = device_get_softc(dev);
162     sc->ap_dev = dev;
163     sc->ap_handle = acpi_get_handle(dev);
164 
165     /*
166      * Get our segment number by evaluating _SEG
167      * It's OK for this to not exist.
168      */
169     status = acpi_GetInteger(sc->ap_handle, "_SEG", &sc->ap_segment);
170     if (ACPI_FAILURE(status)) {
171 	if (status != AE_NOT_FOUND) {
172 	    device_printf(dev, "could not evaluate _SEG - %s\n",
173 		AcpiFormatException(status));
174 	    return_VALUE (ENXIO);
175 	}
176 	/* If it's not found, assume 0. */
177 	sc->ap_segment = 0;
178     }
179 
180     /*
181      * Get our base bus number by evaluating _BBN.
182      * If this doesn't work, we assume we're bus number 0.
183      *
184      * XXX note that it may also not exist in the case where we are
185      *     meant to use a private configuration space mechanism for this bus,
186      *     so we should dig out our resources and check to see if we have
187      *     anything like that.  How do we do this?
188      * XXX If we have the requisite information, and if we don't think the
189      *     default PCI configuration space handlers can deal with this bus,
190      *     we should attach our own handler.
191      * XXX invoke _REG on this for the PCI config space address space?
192      * XXX It seems many BIOS's with multiple Host-PCI bridges do not set
193      *     _BBN correctly.  They set _BBN to zero for all bridges.  Thus,
194      *     if _BBN is zero and PCI bus 0 already exists, we try to read our
195      *     bus number from the configuration registers at address _ADR.
196      *     We only do this for domain/segment 0 in the hopes that this is
197      *     only needed for old single-domain machines.
198      */
199     status = acpi_GetInteger(sc->ap_handle, "_BBN", &sc->ap_bus);
200     if (ACPI_FAILURE(status)) {
201 	if (status != AE_NOT_FOUND) {
202 	    device_printf(dev, "could not evaluate _BBN - %s\n",
203 		AcpiFormatException(status));
204 	    return_VALUE (ENXIO);
205 	} else {
206 	    /* If it's not found, assume 0. */
207 	    sc->ap_bus = 0;
208 	}
209     }
210 
211     /*
212      * If this is segment 0, the bus is zero, and PCI bus 0 already
213      * exists, read the bus number via PCI config space.
214      */
215     busok = 1;
216     if (sc->ap_segment == 0 && sc->ap_bus == 0 && bus0_seen) {
217 	busok = 0;
218 	status = acpi_GetInteger(sc->ap_handle, "_ADR", &addr);
219 	if (ACPI_FAILURE(status)) {
220 	    if (status != AE_NOT_FOUND) {
221 		device_printf(dev, "could not evaluate _ADR - %s\n",
222 		    AcpiFormatException(status));
223 		return_VALUE (ENXIO);
224 	    } else
225 		device_printf(dev, "couldn't find _ADR\n");
226 	} else {
227 	    /* XXX: We assume bus 0. */
228 	    slot = ACPI_ADR_PCI_SLOT(addr);
229 	    func = ACPI_ADR_PCI_FUNC(addr);
230 	    if (bootverbose)
231 		device_printf(dev, "reading config registers from 0:%d:%d\n",
232 		    slot, func);
233 	    if (host_pcib_get_busno(pci_cfgregread, 0, slot, func, &busno) == 0)
234 		device_printf(dev, "couldn't read bus number from cfg space\n");
235 	    else {
236 		sc->ap_bus = busno;
237 		busok = 1;
238 	    }
239 	}
240     }
241 
242     /*
243      * If nothing else worked, hope that ACPI at least lays out the
244      * host-PCI bridges in order and that as a result our unit number
245      * is actually our bus number.  There are several reasons this
246      * might not be true.
247      */
248     if (busok == 0) {
249 	sc->ap_bus = device_get_unit(dev);
250 	device_printf(dev, "trying bus number %d\n", sc->ap_bus);
251     }
252 
253     /* If this is bus 0 on segment 0, note that it has been seen already. */
254     if (sc->ap_segment == 0 && sc->ap_bus == 0)
255 	    bus0_seen = 1;
256 
257     return (acpi_pcib_attach(dev, &sc->ap_prt, sc->ap_bus));
258 }
259 
260 /*
261  * Support for standard PCI bridge ivars.
262  */
263 static int
264 acpi_pcib_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
265 {
266     struct acpi_hpcib_softc	*sc = device_get_softc(dev);
267 
268     switch (which) {
269     case PCIB_IVAR_DOMAIN:
270 	*result = 0;
271 	return (0);
272     case PCIB_IVAR_BUS:
273 	*result = sc->ap_bus;
274 	return (0);
275     case ACPI_IVAR_HANDLE:
276 	*result = (uintptr_t)sc->ap_handle;
277 	return (0);
278     case ACPI_IVAR_FLAGS:
279 	*result = (uintptr_t)sc->ap_flags;
280 	return (0);
281     }
282     return (ENOENT);
283 }
284 
285 static int
286 acpi_pcib_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
287 {
288     struct acpi_hpcib_softc	*sc = device_get_softc(dev);
289 
290     switch (which) {
291     case PCIB_IVAR_DOMAIN:
292 	return (EINVAL);
293     case PCIB_IVAR_BUS:
294 	sc->ap_bus = value;
295 	return (0);
296     case ACPI_IVAR_HANDLE:
297 	sc->ap_handle = (ACPI_HANDLE)value;
298 	return (0);
299     case ACPI_IVAR_FLAGS:
300 	sc->ap_flags = (int)value;
301 	return (0);
302     }
303     return (ENOENT);
304 }
305 
306 static uint32_t
307 acpi_pcib_read_config(device_t dev, u_int bus, u_int slot, u_int func,
308     u_int reg, int bytes)
309 {
310     return (pci_cfgregread(bus, slot, func, reg, bytes));
311 }
312 
313 static void
314 acpi_pcib_write_config(device_t dev, u_int bus, u_int slot, u_int func,
315     u_int reg, uint32_t data, int bytes)
316 {
317     pci_cfgregwrite(bus, slot, func, reg, data, bytes);
318 }
319 
320 static int
321 acpi_pcib_acpi_route_interrupt(device_t pcib, device_t dev, int pin)
322 {
323     struct acpi_hpcib_softc *sc = device_get_softc(pcib);
324 
325     return (acpi_pcib_route_interrupt(pcib, dev, pin, &sc->ap_prt));
326 }
327 
328 static int
329 acpi_pcib_alloc_msi(device_t pcib, device_t dev, int count, int maxcount,
330     int *irqs)
331 {
332 	device_t bus;
333 
334 	bus = device_get_parent(pcib);
335 	return (PCIB_ALLOC_MSI(device_get_parent(bus), dev, count, maxcount,
336 	    irqs));
337 }
338 
339 static int
340 acpi_pcib_alloc_msix(device_t pcib, device_t dev, int *irq)
341 {
342 	device_t bus;
343 
344 	bus = device_get_parent(pcib);
345 	return (PCIB_ALLOC_MSIX(device_get_parent(bus), dev, irq));
346 }
347 
348 static int
349 acpi_pcib_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr,
350     uint32_t *data)
351 {
352 	device_t bus;
353 
354 	bus = device_get_parent(pcib);
355 	return (PCIB_MAP_MSI(device_get_parent(bus), dev, irq, addr, data));
356 }
357 
358 static u_long acpi_host_mem_start = 0x80000000;
359 TUNABLE_ULONG("hw.acpi.host_mem_start", &acpi_host_mem_start);
360 
361 struct resource *
362 acpi_pcib_acpi_alloc_resource(device_t dev, device_t child, int type, int *rid,
363     u_long start, u_long end, u_long count, u_int flags)
364 {
365     /*
366      * If no memory preference is given, use upper 32MB slot most
367      * bioses use for their memory window.  Typically other bridges
368      * before us get in the way to assert their preferences on memory.
369      * Hardcoding like this sucks, so a more MD/MI way needs to be
370      * found to do it.  This is typically only used on older laptops
371      * that don't have pci busses behind pci bridge, so assuming > 32MB
372      * is liekly OK.
373      */
374     if (type == SYS_RES_MEMORY && start == 0UL && end == ~0UL)
375 	start = acpi_host_mem_start;
376     if (type == SYS_RES_IOPORT && start == 0UL && end == ~0UL)
377 	start = 0x1000;
378     return (bus_generic_alloc_resource(dev, child, type, rid, start, end,
379 	count, flags));
380 }
381