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