sys/dev/cardbus/cardbus.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2000,2001 Jonathan Chen.  All rights reserved.
   5  *
   6  * Copyright (c) 2003-2008 M. Warner Losh.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/eventhandler.h>
  35 #include <sys/systm.h>
  36 #include <sys/malloc.h>
  37 #include <sys/module.h>
  38 #include <sys/kernel.h>
  39 #include <sys/sysctl.h>
  40
  41 #include <sys/bus.h>
  42 #include <machine/bus.h>
  43 #include <sys/rman.h>
  44 #include <machine/resource.h>
  45
  46 #include <sys/pciio.h>
  47 #include <dev/pci/pcivar.h>
  48 #include <dev/pci/pcireg.h>
  49 #include <dev/pci/pci_private.h>
  50
  51 #include <dev/cardbus/cardbusreg.h>
  52 #include <dev/cardbus/cardbusvar.h>
  53 #include <dev/cardbus/cardbus_cis.h>
  54 #include <dev/pccard/pccard_cis.h>
  55 #include <dev/pccard/pccardvar.h>
  56
  57 #include "power_if.h"
  58 #include "pcib_if.h"
  59
  60 /* sysctl vars */
  61 static SYSCTL_NODE(_hw, OID_AUTO, cardbus, CTLFLAG_RD, 0, "CardBus parameters");
  62
  63 int    cardbus_debug = 0;
  64 SYSCTL_INT(_hw_cardbus, OID_AUTO, debug, CTLFLAG_RWTUN,
  65     &cardbus_debug, 0, "CardBus debug");
  66
  67 int    cardbus_cis_debug = 0;
  68 SYSCTL_INT(_hw_cardbus, OID_AUTO, cis_debug, CTLFLAG_RWTUN,
  69     &cardbus_cis_debug, 0, "CardBus CIS debug");
  70
  71 #define DPRINTF(a) if (cardbus_debug) printf a
  72 #define DEVPRINTF(x) if (cardbus_debug) device_printf x
  73
  74 static int      cardbus_attach(device_t cbdev);
  75 static int      cardbus_attach_card(device_t cbdev);
  76 static int      cardbus_detach(device_t cbdev);
  77 static int      cardbus_detach_card(device_t cbdev);
  78 static void     cardbus_device_setup_regs(pcicfgregs *cfg);
  79 static void     cardbus_driver_added(device_t cbdev, driver_t *driver);
  80 static int      cardbus_probe(device_t cbdev);
  81 static int      cardbus_read_ivar(device_t cbdev, device_t child, int which,
  82                     uintptr_t *result);
  83
  84 /************************************************************************/
  85 /* Probe/Attach                                                         */
  86 /************************************************************************/
  87
  88 static int
  89 cardbus_probe(device_t cbdev)
  90 {
  91         device_set_desc(cbdev, "CardBus bus");
  92         return (0);
  93 }
  94
  95 static int
  96 cardbus_attach(device_t cbdev)
  97 {
  98         struct cardbus_softc *sc;
  99 #ifdef PCI_RES_BUS
 100         int rid;
 101 #endif
 102
 103         sc = device_get_softc(cbdev);
 104         sc->sc_dev = cbdev;
 105 #ifdef PCI_RES_BUS
 106         rid = 0;
 107         sc->sc_bus = bus_alloc_resource(cbdev, PCI_RES_BUS, &rid,
 108             pcib_get_bus(cbdev), pcib_get_bus(cbdev), 1, 0);
 109         if (sc->sc_bus == NULL) {
 110                 device_printf(cbdev, "failed to allocate bus number\n");
 111                 return (ENXIO);
 112         }
 113 #else
 114         device_printf(cbdev, "Your bus numbers may be AFU\n");
 115 #endif
 116         return (0);
 117 }
 118
 119 static int
 120 cardbus_detach(device_t cbdev)
 121 {
 122 #ifdef PCI_RES_BUS
 123         struct cardbus_softc *sc;
 124 #endif
 125
 126         cardbus_detach_card(cbdev);
 127 #ifdef PCI_RES_BUS
 128         sc = device_get_softc(cbdev);
 129         device_printf(cbdev, "Freeing up the allocatd bus\n");
 130         (void)bus_release_resource(cbdev, PCI_RES_BUS, 0, sc->sc_bus);
 131 #endif
 132         return (0);
 133 }
 134
 135 static int
 136 cardbus_suspend(device_t self)
 137 {
 138
 139         cardbus_detach_card(self);
 140         return (0);
 141 }
 142
 143 static int
 144 cardbus_resume(device_t self)
 145 {
 146
 147         return (0);
 148 }
 149
 150 /************************************************************************/
 151 /* Attach/Detach card                                                   */
 152 /************************************************************************/
 153
 154 static void
 155 cardbus_device_setup_regs(pcicfgregs *cfg)
 156 {
 157         device_t dev = cfg->dev;
 158         int i;
 159
 160         /*
 161          * Some cards power up with garbage in their BARs.  This
 162          * code clears all that junk out.
 163          */
 164         for (i = 0; i < PCIR_MAX_BAR_0; i++)
 165                 pci_write_config(dev, PCIR_BAR(i), 0, 4);
 166
 167         cfg->intline =
 168             pci_get_irq(device_get_parent(device_get_parent(dev)));
 169         pci_write_config(dev, PCIR_INTLINE, cfg->intline, 1);
 170         pci_write_config(dev, PCIR_CACHELNSZ, 0x08, 1);
 171         pci_write_config(dev, PCIR_LATTIMER, 0xa8, 1);
 172         pci_write_config(dev, PCIR_MINGNT, 0x14, 1);
 173         pci_write_config(dev, PCIR_MAXLAT, 0x14, 1);
 174 }
 175
 176 static struct pci_devinfo *
 177 cardbus_alloc_devinfo(device_t dev)
 178 {
 179         struct cardbus_devinfo *dinfo;
 180
 181         dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
 182         return (&dinfo->pci);
 183 }
 184
 185 static int
 186 cardbus_attach_card(device_t cbdev)
 187 {
 188         device_t brdev = device_get_parent(cbdev);
 189         device_t child;
 190         int bus, domain, slot, func;
 191         int cardattached = 0;
 192         int cardbusfunchigh = 0;
 193         struct cardbus_softc *sc;
 194
 195         sc = device_get_softc(cbdev);
 196         cardbus_detach_card(cbdev); /* detach existing cards */
 197         POWER_DISABLE_SOCKET(brdev, cbdev); /* Turn the socket off first */
 198         POWER_ENABLE_SOCKET(brdev, cbdev);
 199         domain = pcib_get_domain(cbdev);
 200         bus = pcib_get_bus(cbdev);
 201         slot = 0;
 202         mtx_lock(&Giant);
 203         /* For each function, set it up and try to attach a driver to it */
 204         for (func = 0; func <= cardbusfunchigh; func++) {
 205                 struct cardbus_devinfo *dinfo;
 206
 207                 dinfo = (struct cardbus_devinfo *)
 208                     pci_read_device(brdev, cbdev, domain, bus, slot, func);
 209                 if (dinfo == NULL)
 210                         continue;
 211                 if (dinfo->pci.cfg.mfdev)
 212                         cardbusfunchigh = PCI_FUNCMAX;
 213
 214                 child = device_add_child(cbdev, NULL, -1);
 215                 if (child == NULL) {
 216                         DEVPRINTF((cbdev, "Cannot add child!\n"));
 217                         pci_freecfg((struct pci_devinfo *)dinfo);
 218                         continue;
 219                 }
 220                 dinfo->pci.cfg.dev = child;
 221                 resource_list_init(&dinfo->pci.resources);
 222                 device_set_ivars(child, dinfo);
 223                 cardbus_device_create(sc, dinfo, cbdev, child);
 224                 if (cardbus_do_cis(cbdev, child) != 0)
 225                         DEVPRINTF((cbdev, "Warning: Bogus CIS ignored\n"));
 226                 pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 0);
 227                 pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci);
 228                 cardbus_device_setup_regs(&dinfo->pci.cfg);
 229                 pci_add_resources(cbdev, child, 1, dinfo->mprefetchable);
 230                 pci_print_verbose(&dinfo->pci);
 231                 if (device_probe_and_attach(child) == 0)
 232                         cardattached++;
 233                 else
 234                         pci_cfg_save(dinfo->pci.cfg.dev, &dinfo->pci, 1);
 235         }
 236         mtx_unlock(&Giant);
 237         if (cardattached > 0)
 238                 return (0);
 239 /*      POWER_DISABLE_SOCKET(brdev, cbdev); */
 240         return (ENOENT);
 241 }
 242
 243 static void
 244 cardbus_child_deleted(device_t cbdev, device_t child)
 245 {
 246         struct cardbus_devinfo *dinfo = device_get_ivars(child);
 247
 248         if (dinfo->pci.cfg.dev != child)
 249                 device_printf(cbdev, "devinfo dev mismatch\n");
 250         cardbus_device_destroy(dinfo);
 251         pci_child_deleted(cbdev, child);
 252 }
 253
 254 static int
 255 cardbus_detach_card(device_t cbdev)
 256 {
 257         int err = 0;
 258
 259         err = bus_generic_detach(cbdev);
 260         if (err)
 261                 return (err);
 262         err = device_delete_children(cbdev);
 263         if (err)
 264                 return (err);
 265
 266         POWER_DISABLE_SOCKET(device_get_parent(cbdev), cbdev);
 267         return (err);
 268 }
 269
 270 static void
 271 cardbus_driver_added(device_t cbdev, driver_t *driver)
 272 {
 273         int numdevs;
 274         device_t *devlist;
 275         device_t dev;
 276         int i;
 277         struct cardbus_devinfo *dinfo;
 278
 279         DEVICE_IDENTIFY(driver, cbdev);
 280         if (device_get_children(cbdev, &devlist, &numdevs) != 0)
 281                 return;
 282
 283         /*
 284          * If there are no drivers attached, but there are children,
 285          * then power the card up.
 286          */
 287         for (i = 0; i < numdevs; i++) {
 288                 dev = devlist[i];
 289                 if (device_get_state(dev) != DS_NOTPRESENT)
 290                     break;
 291         }
 292         if (i > 0 && i == numdevs)
 293                 POWER_ENABLE_SOCKET(device_get_parent(cbdev), cbdev);
 294         for (i = 0; i < numdevs; i++) {
 295                 dev = devlist[i];
 296                 if (device_get_state(dev) != DS_NOTPRESENT)
 297                         continue;
 298                 dinfo = device_get_ivars(dev);
 299                 pci_print_verbose(&dinfo->pci);
 300                 if (bootverbose)
 301                         printf("pci%d:%d:%d:%d: reprobing on driver added\n",
 302                             dinfo->pci.cfg.domain, dinfo->pci.cfg.bus,
 303                             dinfo->pci.cfg.slot, dinfo->pci.cfg.func);
 304                 pci_cfg_restore(dinfo->pci.cfg.dev, &dinfo->pci);
 305                 if (device_probe_and_attach(dev) != 0)
 306                         pci_cfg_save(dev, &dinfo->pci, 1);
 307         }
 308         free(devlist, M_TEMP);
 309 }
 310
 311 /************************************************************************/
 312 /* Other Bus Methods                                                    */
 313 /************************************************************************/
 314
 315 static int
 316 cardbus_read_ivar(device_t cbdev, device_t child, int which, uintptr_t *result)
 317 {
 318         struct cardbus_devinfo *dinfo;
 319         pcicfgregs *cfg;
 320
 321         dinfo = device_get_ivars(child);
 322         cfg = &dinfo->pci.cfg;
 323
 324         switch (which) {
 325         case PCI_IVAR_ETHADDR:
 326                 /*
 327                  * The generic accessor doesn't deal with failure, so
 328                  * we set the return value, then return an error.
 329                  */
 330                 if (dinfo->fepresent & (1 << PCCARD_TPLFE_TYPE_LAN_NID)) {
 331                         *((uint8_t **) result) = dinfo->funce.lan.nid;
 332                         break;
 333                 }
 334                 *((uint8_t **) result) = NULL;
 335                 return (EINVAL);
 336         default:
 337                 return (pci_read_ivar(cbdev, child, which, result));
 338         }
 339         return 0;
 340 }
 341
 342 static device_method_t cardbus_methods[] = {
 343         /* Device interface */
 344         DEVMETHOD(device_probe,         cardbus_probe),
 345         DEVMETHOD(device_attach,        cardbus_attach),
 346         DEVMETHOD(device_detach,        cardbus_detach),
 347         DEVMETHOD(device_suspend,       cardbus_suspend),
 348         DEVMETHOD(device_resume,        cardbus_resume),
 349
 350         /* Bus interface */
 351         DEVMETHOD(bus_child_deleted,    cardbus_child_deleted),
 352         DEVMETHOD(bus_get_dma_tag,      bus_generic_get_dma_tag),
 353         DEVMETHOD(bus_read_ivar,        cardbus_read_ivar),
 354         DEVMETHOD(bus_driver_added,     cardbus_driver_added),
 355         DEVMETHOD(bus_rescan,           bus_null_rescan),
 356
 357         /* Card Interface */
 358         DEVMETHOD(card_attach_card,     cardbus_attach_card),
 359         DEVMETHOD(card_detach_card,     cardbus_detach_card),
 360
 361         /* PCI interface */
 362         DEVMETHOD(pci_alloc_devinfo,    cardbus_alloc_devinfo),
 363
 364         {0,0}
 365 };
 366
 367 DEFINE_CLASS_1(cardbus, cardbus_driver, cardbus_methods,
 368     sizeof(struct cardbus_softc), pci_driver);
 369
 370 static devclass_t cardbus_devclass;
 371
 372 DRIVER_MODULE(cardbus, cbb, cardbus_driver, cardbus_devclass, 0, 0);
 373 MODULE_VERSION(cardbus, 1);