acpica5 update part 1/3: Implement support for acpica-unix-20040527.
[dragonfly.git] / sys / dev / acpica5 / acpi_pcib_acpi.c
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  * $FreeBSD: src/sys/dev/acpica/acpi_pcib_acpi.c,v 1.34 2004/05/30 20:08:23 phk Exp $
28  * $DragonFly: src/sys/dev/acpica5/acpi_pcib_acpi.c,v 1.3 2004/07/05 00:07:35 dillon Exp $
29  */
30 #include "opt_acpi.h"
31 #include <sys/param.h>
32 #include <sys/bus.h>
33 #include <sys/kernel.h>
34 #include <sys/malloc.h>
35 #include <sys/module.h>
36
37 #include "acpi.h"
38
39 #include "acpivar.h"
40
41 #include <machine/pci_cfgreg.h>
42 #include <bus/pci/pcivar.h>
43 #include <bus/pci/pcib_private.h>
44 #include "pcib_if.h"
45
46 #include "acpi_pcibvar.h"
47
48 /* Hooks for the ACPI CA debugging infrastructure. */
49 #define _COMPONENT      ACPI_BUS
50 ACPI_MODULE_NAME("PCI_ACPI")
51
52 struct acpi_hpcib_softc {
53     device_t            ap_dev;
54     ACPI_HANDLE         ap_handle;
55
56     int                 ap_segment;     /* analagous to Alpha 'hose' */
57     int                 ap_bus;         /* bios-assigned bus number */
58
59     ACPI_BUFFER         ap_prt;         /* interrupt routing table */
60 };
61
62 static int              acpi_pcib_acpi_probe(device_t bus);
63 static int              acpi_pcib_acpi_attach(device_t bus);
64 static int              acpi_pcib_acpi_resume(device_t bus);
65 static int              acpi_pcib_read_ivar(device_t dev, device_t child,
66                             int which, uintptr_t *result);
67 static int              acpi_pcib_write_ivar(device_t dev, device_t child,
68                             int which, uintptr_t value);
69 static uint32_t         acpi_pcib_read_config(device_t dev, int bus, int slot,
70                             int func, int reg, int bytes);
71 static void             acpi_pcib_write_config(device_t dev, int bus, int slot,
72                             int func, int reg, uint32_t data, int bytes);
73 static int              acpi_pcib_acpi_route_interrupt(device_t pcib,
74                             device_t dev, int pin);
75 static struct resource *acpi_pcib_acpi_alloc_resource(device_t dev,
76                             device_t child, int type, int *rid,
77                             u_long start, u_long end, u_long count,
78                             u_int flags);
79
80 static device_method_t acpi_pcib_acpi_methods[] = {
81     /* Device interface */
82     DEVMETHOD(device_probe,             acpi_pcib_acpi_probe),
83     DEVMETHOD(device_attach,            acpi_pcib_acpi_attach),
84     DEVMETHOD(device_shutdown,          bus_generic_shutdown),
85     DEVMETHOD(device_suspend,           bus_generic_suspend),
86     DEVMETHOD(device_resume,            acpi_pcib_acpi_resume),
87
88     /* Bus interface */
89     DEVMETHOD(bus_print_child,          bus_generic_print_child),
90     DEVMETHOD(bus_read_ivar,            acpi_pcib_read_ivar),
91     DEVMETHOD(bus_write_ivar,           acpi_pcib_write_ivar),
92     DEVMETHOD(bus_alloc_resource,       acpi_pcib_acpi_alloc_resource),
93     DEVMETHOD(bus_release_resource,     bus_generic_release_resource),
94     DEVMETHOD(bus_activate_resource,    bus_generic_activate_resource),
95     DEVMETHOD(bus_deactivate_resource,  bus_generic_deactivate_resource),
96     DEVMETHOD(bus_setup_intr,           bus_generic_setup_intr),
97     DEVMETHOD(bus_teardown_intr,        bus_generic_teardown_intr),
98
99     /* pcib interface */
100     DEVMETHOD(pcib_maxslots,            pcib_maxslots),
101     DEVMETHOD(pcib_read_config,         acpi_pcib_read_config),
102     DEVMETHOD(pcib_write_config,        acpi_pcib_write_config),
103     DEVMETHOD(pcib_route_interrupt,     acpi_pcib_acpi_route_interrupt),
104
105     {0, 0}
106 };
107
108 static driver_t acpi_pcib_acpi_driver = {
109     "pcib",
110     acpi_pcib_acpi_methods,
111     sizeof(struct acpi_hpcib_softc),
112 };
113
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
121     if (acpi_get_type(dev) == ACPI_TYPE_DEVICE && !acpi_disabled("pci") &&
122         acpi_MatchHid(dev, "PNP0A03")) {
123
124         if (pci_cfgregopen() == 0)
125                 return (ENXIO);
126         device_set_desc(dev, "ACPI Host-PCI bridge");
127         return (0);
128     }
129     return (ENXIO);
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 = addr >> 16;
193             func = addr & 0xffff;
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     struct acpi_hpcib_softc     *sc = device_get_softc(dev);
239
240     return (acpi_pcib_resume(dev, &sc->ap_prt, sc->ap_bus));
241 }
242
243 /*
244  * Support for standard PCI bridge ivars.
245  */
246 static int
247 acpi_pcib_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
248 {
249     struct acpi_hpcib_softc     *sc = device_get_softc(dev);
250
251     switch (which) {
252     case PCIB_IVAR_BUS:
253         *result = sc->ap_bus;
254         return (0);
255     case ACPI_IVAR_HANDLE:
256         *result = (uintptr_t)sc->ap_handle;
257         return (0);
258     }
259     return (ENOENT);
260 }
261
262 static int
263 acpi_pcib_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
264 {
265     struct acpi_hpcib_softc     *sc = device_get_softc(dev);
266
267     switch (which) {
268     case PCIB_IVAR_BUS:
269         sc->ap_bus = value;
270         return (0);
271     }
272     return (ENOENT);
273 }
274
275 static uint32_t
276 acpi_pcib_read_config(device_t dev, int bus, int slot, int func, int reg,
277     int bytes)
278 {
279     return (pci_cfgregread(bus, slot, func, reg, bytes));
280 }
281
282 static void
283 acpi_pcib_write_config(device_t dev, int bus, int slot, int func, int reg,
284     uint32_t data, int bytes)
285 {
286     pci_cfgregwrite(bus, slot, func, reg, data, bytes);
287 }
288
289 static int
290 acpi_pcib_acpi_route_interrupt(device_t pcib, device_t dev, int pin)
291 {
292     struct acpi_hpcib_softc *sc;
293
294     /* Find the bridge softc. */
295     sc = device_get_softc(pcib);
296     return (acpi_pcib_route_interrupt(pcib, dev, pin, &sc->ap_prt));
297 }
298
299 struct resource *
300 acpi_pcib_acpi_alloc_resource(device_t dev, device_t child, int type, int *rid,
301     u_long start, u_long end, u_long count, u_int flags)
302 {
303     /*
304      * If no memory preference is given, use upper 256MB slot most
305      * bioses use for their memory window.  Typically other bridges
306      * before us get in the way to assert their preferences on memory.
307      * Hardcoding like this sucks, so a more MD/MI way needs to be
308      * found to do it.
309      */
310     if (type == SYS_RES_MEMORY && start == 0UL && end == ~0UL)
311         start = 0xf0000000;
312     return (bus_generic_alloc_resource(dev, child, type, rid, start, end,
313         count, flags));
314 }