]> CyberLeo.Net >> Repos - FreeBSD/stable/9.git/blob - sys/dev/acpica/acpi_pcib_acpi.c
MFC r238199:
[FreeBSD/stable/9.git] / sys / dev / acpica / 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
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/limits.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
38 #include <sys/rman.h>
39 #include <sys/sysctl.h>
40
41 #include <contrib/dev/acpica/include/acpi.h>
42 #include <contrib/dev/acpica/include/accommon.h>
43
44 #include <dev/acpica/acpivar.h>
45
46 #include <machine/pci_cfgreg.h>
47 #include <dev/pci/pcivar.h>
48 #include <dev/pci/pcib_private.h>
49 #include "pcib_if.h"
50
51 #include <dev/acpica/acpi_pcibvar.h>
52
53 /* Hooks for the ACPI CA debugging infrastructure. */
54 #define _COMPONENT      ACPI_BUS
55 ACPI_MODULE_NAME("PCI_ACPI")
56
57 struct acpi_hpcib_softc {
58     device_t            ap_dev;
59     ACPI_HANDLE         ap_handle;
60     int                 ap_flags;
61
62     int                 ap_segment;     /* PCI domain */
63     int                 ap_bus;         /* bios-assigned bus number */
64     int                 ap_addr;        /* device/func of PCI-Host bridge */
65
66     ACPI_BUFFER         ap_prt;         /* interrupt routing table */
67 #ifdef NEW_PCIB
68     struct pcib_host_resources ap_host_res;
69 #endif
70 };
71
72 static int              acpi_pcib_acpi_probe(device_t bus);
73 static int              acpi_pcib_acpi_attach(device_t bus);
74 static int              acpi_pcib_read_ivar(device_t dev, device_t child,
75                             int which, uintptr_t *result);
76 static int              acpi_pcib_write_ivar(device_t dev, device_t child,
77                             int which, uintptr_t value);
78 static uint32_t         acpi_pcib_read_config(device_t dev, u_int bus,
79                             u_int slot, u_int func, u_int reg, int bytes);
80 static void             acpi_pcib_write_config(device_t dev, u_int bus,
81                             u_int slot, u_int func, u_int reg, uint32_t data,
82                             int bytes);
83 static int              acpi_pcib_acpi_route_interrupt(device_t pcib,
84                             device_t dev, int pin);
85 static int              acpi_pcib_alloc_msi(device_t pcib, device_t dev,
86                             int count, int maxcount, int *irqs);
87 static int              acpi_pcib_map_msi(device_t pcib, device_t dev,
88                             int irq, uint64_t *addr, uint32_t *data);
89 static int              acpi_pcib_alloc_msix(device_t pcib, device_t dev,
90                             int *irq);
91 static struct resource *acpi_pcib_acpi_alloc_resource(device_t dev,
92                             device_t child, int type, int *rid,
93                             u_long start, u_long end, u_long count,
94                             u_int flags);
95 #ifdef NEW_PCIB
96 static int              acpi_pcib_acpi_adjust_resource(device_t dev,
97                             device_t child, int type, struct resource *r,
98                             u_long start, u_long end);
99 #endif
100
101 static device_method_t acpi_pcib_acpi_methods[] = {
102     /* Device interface */
103     DEVMETHOD(device_probe,             acpi_pcib_acpi_probe),
104     DEVMETHOD(device_attach,            acpi_pcib_acpi_attach),
105     DEVMETHOD(device_shutdown,          bus_generic_shutdown),
106     DEVMETHOD(device_suspend,           bus_generic_suspend),
107     DEVMETHOD(device_resume,            bus_generic_resume),
108
109     /* Bus interface */
110     DEVMETHOD(bus_read_ivar,            acpi_pcib_read_ivar),
111     DEVMETHOD(bus_write_ivar,           acpi_pcib_write_ivar),
112     DEVMETHOD(bus_alloc_resource,       acpi_pcib_acpi_alloc_resource),
113 #ifdef NEW_PCIB
114     DEVMETHOD(bus_adjust_resource,      acpi_pcib_acpi_adjust_resource),
115 #else
116     DEVMETHOD(bus_adjust_resource,      bus_generic_adjust_resource),
117 #endif
118     DEVMETHOD(bus_release_resource,     bus_generic_release_resource),
119     DEVMETHOD(bus_activate_resource,    bus_generic_activate_resource),
120     DEVMETHOD(bus_deactivate_resource,  bus_generic_deactivate_resource),
121     DEVMETHOD(bus_setup_intr,           bus_generic_setup_intr),
122     DEVMETHOD(bus_teardown_intr,        bus_generic_teardown_intr),
123
124     /* pcib interface */
125     DEVMETHOD(pcib_maxslots,            pcib_maxslots),
126     DEVMETHOD(pcib_read_config,         acpi_pcib_read_config),
127     DEVMETHOD(pcib_write_config,        acpi_pcib_write_config),
128     DEVMETHOD(pcib_route_interrupt,     acpi_pcib_acpi_route_interrupt),
129     DEVMETHOD(pcib_alloc_msi,           acpi_pcib_alloc_msi),
130     DEVMETHOD(pcib_release_msi,         pcib_release_msi),
131     DEVMETHOD(pcib_alloc_msix,          acpi_pcib_alloc_msix),
132     DEVMETHOD(pcib_release_msix,        pcib_release_msix),
133     DEVMETHOD(pcib_map_msi,             acpi_pcib_map_msi),
134     DEVMETHOD(pcib_power_for_sleep,     acpi_pcib_power_for_sleep),
135
136     DEVMETHOD_END
137 };
138
139 static devclass_t pcib_devclass;
140
141 DEFINE_CLASS_0(pcib, acpi_pcib_acpi_driver, acpi_pcib_acpi_methods,
142     sizeof(struct acpi_hpcib_softc));
143 DRIVER_MODULE(acpi_pcib, acpi, acpi_pcib_acpi_driver, pcib_devclass, 0, 0);
144 MODULE_DEPEND(acpi_pcib, acpi, 1, 1, 1);
145
146 static int
147 acpi_pcib_acpi_probe(device_t dev)
148 {
149     ACPI_DEVICE_INFO    *devinfo;
150     ACPI_HANDLE         h;
151     int                 root;
152
153     if (acpi_disabled("pcib") || (h = acpi_get_handle(dev)) == NULL ||
154         ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
155         return (ENXIO);
156     root = (devinfo->Flags & ACPI_PCI_ROOT_BRIDGE) != 0;
157     AcpiOsFree(devinfo);
158     if (!root || pci_cfgregopen() == 0)
159         return (ENXIO);
160
161     device_set_desc(dev, "ACPI Host-PCI bridge");
162     return (0);
163 }
164
165 #ifdef NEW_PCIB
166 static ACPI_STATUS
167 acpi_pcib_producer_handler(ACPI_RESOURCE *res, void *context)
168 {
169         struct acpi_hpcib_softc *sc;
170         UINT64 length, min, max;
171         u_int flags;
172         int error, type;
173
174         sc = context;
175         switch (res->Type) {
176         case ACPI_RESOURCE_TYPE_START_DEPENDENT:
177         case ACPI_RESOURCE_TYPE_END_DEPENDENT:
178                 panic("host bridge has depenedent resources");
179         case ACPI_RESOURCE_TYPE_ADDRESS16:
180         case ACPI_RESOURCE_TYPE_ADDRESS32:
181         case ACPI_RESOURCE_TYPE_ADDRESS64:
182         case ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64:
183                 if (res->Data.Address.ProducerConsumer != ACPI_PRODUCER)
184                         break;
185                 switch (res->Type) {
186                 case ACPI_RESOURCE_TYPE_ADDRESS16:
187                         min = res->Data.Address16.Minimum;
188                         max = res->Data.Address16.Maximum;
189                         length = res->Data.Address16.AddressLength;
190                         break;
191                 case ACPI_RESOURCE_TYPE_ADDRESS32:
192                         min = res->Data.Address32.Minimum;
193                         max = res->Data.Address32.Maximum;
194                         length = res->Data.Address32.AddressLength;
195                         break;
196                 case ACPI_RESOURCE_TYPE_ADDRESS64:
197                         min = res->Data.Address64.Minimum;
198                         max = res->Data.Address64.Maximum;
199                         length = res->Data.Address64.AddressLength;
200                         break;
201                 default:
202                         KASSERT(res->Type ==
203                             ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64,
204                             ("should never happen"));
205                         min = res->Data.ExtAddress64.Minimum;
206                         max = res->Data.ExtAddress64.Maximum;
207                         length = res->Data.ExtAddress64.AddressLength;
208                         break;
209                 }
210                 if (length == 0)
211                         break;
212                 if (min + length - 1 != max &&
213                     (res->Data.Address.MinAddressFixed != ACPI_ADDRESS_FIXED ||
214                     res->Data.Address.MaxAddressFixed != ACPI_ADDRESS_FIXED))
215                         break;
216                 flags = 0;
217                 switch (res->Data.Address.ResourceType) {
218                 case ACPI_MEMORY_RANGE:
219                         type = SYS_RES_MEMORY;
220                         if (res->Type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64) {
221                                 if (res->Data.Address.Info.Mem.Caching ==
222                                     ACPI_PREFETCHABLE_MEMORY)
223                                         flags |= RF_PREFETCHABLE;
224                         } else {
225                                 /*
226                                  * XXX: Parse prefetch flag out of
227                                  * TypeSpecific.
228                                  */
229                         }
230                         break;
231                 case ACPI_IO_RANGE:
232                         type = SYS_RES_IOPORT;
233                         break;
234 #ifdef PCI_RES_BUS
235                 case ACPI_BUS_NUMBER_RANGE:
236                         type = PCI_RES_BUS;
237                         break;
238 #endif
239                 default:
240                         return (AE_OK);
241                 }
242
243                 if (min + length - 1 != max)
244                         device_printf(sc->ap_dev,
245                             "Length mismatch for %d range: %jx vs %jx\n", type,
246                             (uintmax_t)max - min + 1, (uintmax_t)length);
247 #ifdef __i386__
248                 if (min > ULONG_MAX) {
249                         device_printf(sc->ap_dev,
250                             "Ignoring %d range above 4GB (%#jx-%#jx)\n",
251                             type, (uintmax_t)min, (uintmax_t)max);
252                         break;
253                 }
254                 if (max > ULONG_MAX) {
255                         device_printf(sc->ap_dev,
256                     "Truncating end of %d range above 4GB (%#jx-%#jx)\n",
257                             type, (uintmax_t)min, (uintmax_t)max);
258                         max = ULONG_MAX;
259                 }
260 #endif
261                 error = pcib_host_res_decodes(&sc->ap_host_res, type, min, max,
262                     flags);
263                 if (error)
264                         panic("Failed to manage %d range (%#jx-%#jx): %d",
265                             type, (uintmax_t)min, (uintmax_t)max, error);
266                 break;
267         default:
268                 break;
269         }
270         return (AE_OK);
271 }
272 #endif
273
274 static int
275 acpi_pcib_acpi_attach(device_t dev)
276 {
277     struct acpi_hpcib_softc     *sc;
278     ACPI_STATUS                 status;
279     static int bus0_seen = 0;
280     u_int slot, func, busok;
281     uint8_t busno;
282
283     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
284
285     sc = device_get_softc(dev);
286     sc->ap_dev = dev;
287     sc->ap_handle = acpi_get_handle(dev);
288
289     /*
290      * Get our segment number by evaluating _SEG.
291      * It's OK for this to not exist.
292      */
293     status = acpi_GetInteger(sc->ap_handle, "_SEG", &sc->ap_segment);
294     if (ACPI_FAILURE(status)) {
295         if (status != AE_NOT_FOUND) {
296             device_printf(dev, "could not evaluate _SEG - %s\n",
297                 AcpiFormatException(status));
298             return_VALUE (ENXIO);
299         }
300         /* If it's not found, assume 0. */
301         sc->ap_segment = 0;
302     }
303
304     /*
305      * Get the address (device and function) of the associated
306      * PCI-Host bridge device from _ADR.  Assume we don't have one if
307      * it doesn't exist.
308      */
309     status = acpi_GetInteger(sc->ap_handle, "_ADR", &sc->ap_addr);
310     if (ACPI_FAILURE(status)) {
311         device_printf(dev, "could not evaluate _ADR - %s\n",
312             AcpiFormatException(status));
313         sc->ap_addr = -1;
314     }
315
316 #ifdef NEW_PCIB
317     /*
318      * Determine which address ranges this bridge decodes and setup
319      * resource managers for those ranges.
320      */
321     if (pcib_host_res_init(sc->ap_dev, &sc->ap_host_res) != 0)
322             panic("failed to init hostb resources");
323     if (!acpi_disabled("hostres")) {
324         status = AcpiWalkResources(sc->ap_handle, "_CRS",
325             acpi_pcib_producer_handler, sc);
326         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND)
327             device_printf(sc->ap_dev, "failed to parse resources: %s\n",
328                 AcpiFormatException(status));
329     }
330 #endif
331
332     /*
333      * Get our base bus number by evaluating _BBN.
334      * If this doesn't work, we assume we're bus number 0.
335      *
336      * XXX note that it may also not exist in the case where we are
337      *     meant to use a private configuration space mechanism for this bus,
338      *     so we should dig out our resources and check to see if we have
339      *     anything like that.  How do we do this?
340      * XXX If we have the requisite information, and if we don't think the
341      *     default PCI configuration space handlers can deal with this bus,
342      *     we should attach our own handler.
343      * XXX invoke _REG on this for the PCI config space address space?
344      * XXX It seems many BIOS's with multiple Host-PCI bridges do not set
345      *     _BBN correctly.  They set _BBN to zero for all bridges.  Thus,
346      *     if _BBN is zero and PCI bus 0 already exists, we try to read our
347      *     bus number from the configuration registers at address _ADR.
348      *     We only do this for domain/segment 0 in the hopes that this is
349      *     only needed for old single-domain machines.
350      */
351     status = acpi_GetInteger(sc->ap_handle, "_BBN", &sc->ap_bus);
352     if (ACPI_FAILURE(status)) {
353         if (status != AE_NOT_FOUND) {
354             device_printf(dev, "could not evaluate _BBN - %s\n",
355                 AcpiFormatException(status));
356             return_VALUE (ENXIO);
357         } else {
358             /* If it's not found, assume 0. */
359             sc->ap_bus = 0;
360         }
361     }
362
363     /*
364      * If this is segment 0, the bus is zero, and PCI bus 0 already
365      * exists, read the bus number via PCI config space.
366      */
367     busok = 1;
368     if (sc->ap_segment == 0 && sc->ap_bus == 0 && bus0_seen) {
369         busok = 0;
370         if (sc->ap_addr != -1) {
371             /* XXX: We assume bus 0. */
372             slot = ACPI_ADR_PCI_SLOT(sc->ap_addr);
373             func = ACPI_ADR_PCI_FUNC(sc->ap_addr);
374             if (bootverbose)
375                 device_printf(dev, "reading config registers from 0:%d:%d\n",
376                     slot, func);
377             if (host_pcib_get_busno(pci_cfgregread, 0, slot, func, &busno) == 0)
378                 device_printf(dev, "couldn't read bus number from cfg space\n");
379             else {
380                 sc->ap_bus = busno;
381                 busok = 1;
382             }
383         }
384     }
385
386     /*
387      * If nothing else worked, hope that ACPI at least lays out the
388      * host-PCI bridges in order and that as a result our unit number
389      * is actually our bus number.  There are several reasons this
390      * might not be true.
391      */
392     if (busok == 0) {
393         sc->ap_bus = device_get_unit(dev);
394         device_printf(dev, "trying bus number %d\n", sc->ap_bus);
395     }
396
397     /* If this is bus 0 on segment 0, note that it has been seen already. */
398     if (sc->ap_segment == 0 && sc->ap_bus == 0)
399             bus0_seen = 1;
400
401     return (acpi_pcib_attach(dev, &sc->ap_prt, sc->ap_bus));
402 }
403
404 /*
405  * Support for standard PCI bridge ivars.
406  */
407 static int
408 acpi_pcib_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
409 {
410     struct acpi_hpcib_softc     *sc = device_get_softc(dev);
411
412     switch (which) {
413     case PCIB_IVAR_DOMAIN:
414         *result = sc->ap_segment;
415         return (0);
416     case PCIB_IVAR_BUS:
417         *result = sc->ap_bus;
418         return (0);
419     case ACPI_IVAR_HANDLE:
420         *result = (uintptr_t)sc->ap_handle;
421         return (0);
422     case ACPI_IVAR_FLAGS:
423         *result = (uintptr_t)sc->ap_flags;
424         return (0);
425     }
426     return (ENOENT);
427 }
428
429 static int
430 acpi_pcib_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
431 {
432     struct acpi_hpcib_softc     *sc = device_get_softc(dev);
433
434     switch (which) {
435     case PCIB_IVAR_DOMAIN:
436         return (EINVAL);
437     case PCIB_IVAR_BUS:
438         sc->ap_bus = value;
439         return (0);
440     case ACPI_IVAR_HANDLE:
441         sc->ap_handle = (ACPI_HANDLE)value;
442         return (0);
443     case ACPI_IVAR_FLAGS:
444         sc->ap_flags = (int)value;
445         return (0);
446     }
447     return (ENOENT);
448 }
449
450 static uint32_t
451 acpi_pcib_read_config(device_t dev, u_int bus, u_int slot, u_int func,
452     u_int reg, int bytes)
453 {
454     return (pci_cfgregread(bus, slot, func, reg, bytes));
455 }
456
457 static void
458 acpi_pcib_write_config(device_t dev, u_int bus, u_int slot, u_int func,
459     u_int reg, uint32_t data, int bytes)
460 {
461     pci_cfgregwrite(bus, slot, func, reg, data, bytes);
462 }
463
464 static int
465 acpi_pcib_acpi_route_interrupt(device_t pcib, device_t dev, int pin)
466 {
467     struct acpi_hpcib_softc *sc = device_get_softc(pcib);
468
469     return (acpi_pcib_route_interrupt(pcib, dev, pin, &sc->ap_prt));
470 }
471
472 static int
473 acpi_pcib_alloc_msi(device_t pcib, device_t dev, int count, int maxcount,
474     int *irqs)
475 {
476         device_t bus;
477
478         bus = device_get_parent(pcib);
479         return (PCIB_ALLOC_MSI(device_get_parent(bus), dev, count, maxcount,
480             irqs));
481 }
482
483 static int
484 acpi_pcib_alloc_msix(device_t pcib, device_t dev, int *irq)
485 {
486         device_t bus;
487
488         bus = device_get_parent(pcib);
489         return (PCIB_ALLOC_MSIX(device_get_parent(bus), dev, irq));
490 }
491
492 static int
493 acpi_pcib_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr,
494     uint32_t *data)
495 {
496         struct acpi_hpcib_softc *sc;
497         device_t bus, hostb;
498         int error;
499
500         bus = device_get_parent(pcib);
501         error = PCIB_MAP_MSI(device_get_parent(bus), dev, irq, addr, data);
502         if (error)
503                 return (error);
504
505         sc = device_get_softc(dev);
506         if (sc->ap_addr == -1)
507                 return (0);
508         /* XXX: Assumes all bridges are on bus 0. */
509         hostb = pci_find_dbsf(sc->ap_segment, 0, ACPI_ADR_PCI_SLOT(sc->ap_addr),
510             ACPI_ADR_PCI_FUNC(sc->ap_addr));
511         if (hostb != NULL)
512                 pci_ht_map_msi(hostb, *addr);
513         return (0);
514 }
515
516 struct resource *
517 acpi_pcib_acpi_alloc_resource(device_t dev, device_t child, int type, int *rid,
518     u_long start, u_long end, u_long count, u_int flags)
519 {
520 #ifdef NEW_PCIB
521     struct acpi_hpcib_softc *sc;
522     struct resource *res;
523 #endif
524
525 #if defined(__i386__) || defined(__amd64__)
526     start = hostb_alloc_start(type, start, end, count);
527 #endif
528
529 #ifdef NEW_PCIB
530     sc = device_get_softc(dev);
531     res = pcib_host_res_alloc(&sc->ap_host_res, child, type, rid, start, end,
532         count, flags);
533
534     /*
535      * XXX: If this is a request for a specific range, assume it is
536      * correct and pass it up to the parent.  What we probably want to
537      * do long-term is explicitly trust any firmware-configured
538      * resources during the initial bus scan on boot and then disable
539      * this after that.
540      */
541     if (res == NULL && start + count - 1 == end)
542         res = bus_generic_alloc_resource(dev, child, type, rid, start, end,
543             count, flags);
544     return (res);
545 #else
546     return (bus_generic_alloc_resource(dev, child, type, rid, start, end,
547         count, flags));
548 #endif
549 }
550
551 #ifdef NEW_PCIB
552 int
553 acpi_pcib_acpi_adjust_resource(device_t dev, device_t child, int type,
554     struct resource *r, u_long start, u_long end)
555 {
556         struct acpi_hpcib_softc *sc;
557
558         sc = device_get_softc(dev);
559         return (pcib_host_res_adjust(&sc->ap_host_res, child, type, r, start,
560             end));
561 }
562 #endif