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