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