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