sys/bus/firewire/fwohci_pci.c

   1 /*
   2  * Copyright (c) 2003 Hidetoshi Shimokawa
   3  * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
   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  * 3. All advertising materials mentioning features or use of this software
  15  *    must display the acknowledgement as bellow:
  16  *
  17  *    This product includes software developed by K. Kobayashi and H. SHimokawa
  18  *
  19  * 4. The name of the author may not be used to endorse or promote products
  20  *    derived from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  24  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  26  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  27  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  30  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  * $FreeBSD: src/sys/dev/firewire/fwohci_pci.c,v 1.38 2004/01/23 17:37:09 simokawa Exp $
  35  * $DragonFly: src/sys/bus/firewire/fwohci_pci.c,v 1.16 2004/11/08 16:50:33 dillon Exp $
  36  */
  37
  38 #define BOUNCE_BUFFER_TEST      0
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/kernel.h>
  43 #include <sys/module.h>
  44 #include <sys/conf.h>
  45 #include <sys/bus.h>
  46 #include <sys/queue.h>
  47 #include <machine/bus.h>
  48 #include <sys/rman.h>
  49 #include <sys/malloc.h>
  50 #if defined(__FreeBSD__) && __FreeBSD_version >= 501102
  51 #include <sys/lock.h>
  52 #include <sys/mutex.h>
  53 #endif
  54 #include <machine/resource.h>
  55
  56 #if defined(__DragonFly__) || __FreeBSD_version < 500000
  57 #include <machine/clock.h>              /* for DELAY() */
  58 #endif
  59
  60 #ifdef __DragonFly__
  61 #include <bus/pci/pcivar.h>
  62 #include <bus/pci/pcireg.h>
  63
  64 #include "firewire.h"
  65 #include "firewirereg.h"
  66
  67 #include "fwdma.h"
  68 #include "fwohcireg.h"
  69 #include "fwohcivar.h"
  70 #else
  71 #if __FreeBSD_version < 500000
  72 #include <pci/pcivar.h>
  73 #include <pci/pcireg.h>
  74 #else
  75 #include <dev/pci/pcivar.h>
  76 #include <dev/pci/pcireg.h>
  77 #endif
  78
  79 #include <dev/firewire/firewire.h>
  80 #include <dev/firewire/firewirereg.h>
  81
  82 #include <dev/firewire/fwdma.h>
  83 #include <dev/firewire/fwohcireg.h>
  84 #include <dev/firewire/fwohcivar.h>
  85 #endif
  86
  87 static int fwohci_pci_attach(device_t self);
  88 static int fwohci_pci_detach(device_t self);
  89
  90 /*
  91  * The probe routine.
  92  */
  93 static int
  94 fwohci_pci_probe( device_t dev )
  95 {
  96 #if 1
  97         u_int32_t id;
  98
  99         id = pci_get_devid(dev);
 100         if (id == (FW_VENDORID_NATSEMI | FW_DEVICE_CS4210)) {
 101                 device_set_desc(dev, "National Semiconductor CS4210");
 102                 return 0;
 103         }
 104         if (id == (FW_VENDORID_NEC | FW_DEVICE_UPD861)) {
 105                 device_set_desc(dev, "NEC uPD72861");
 106                 return 0;
 107         }
 108         if (id == (FW_VENDORID_NEC | FW_DEVICE_UPD871)) {
 109                 device_set_desc(dev, "NEC uPD72871/2");
 110                 return 0;
 111         }
 112         if (id == (FW_VENDORID_NEC | FW_DEVICE_UPD72870)) {
 113                 device_set_desc(dev, "NEC uPD72870");
 114                 return 0;
 115         }
 116         if (id == (FW_VENDORID_NEC | FW_DEVICE_UPD72874)) {
 117                 device_set_desc(dev, "NEC uPD72874");
 118                 return 0;
 119         }
 120         if (id == (FW_VENDORID_SIS | FW_DEVICE_7007)) {
 121                 /* It has no real identifier, using device id. */
 122                 device_set_desc(dev, "SiS 7007");
 123                 return 0;
 124         }
 125         if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB22)) {
 126                 device_set_desc(dev, "Texas Instruments TSB12LV22");
 127                 return 0;
 128         }
 129         if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB23)) {
 130                 device_set_desc(dev, "Texas Instruments TSB12LV23");
 131                 return 0;
 132         }
 133         if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB26)) {
 134                 device_set_desc(dev, "Texas Instruments TSB12LV26");
 135                 return 0;
 136         }
 137         if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43)) {
 138                 device_set_desc(dev, "Texas Instruments TSB43AA22");
 139                 return 0;
 140         }
 141         if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43A)) {
 142                 device_set_desc(dev, "Texas Instruments TSB43AB22/A");
 143                 return 0;
 144         }
 145         if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43AB21)) {
 146                 device_set_desc(dev, "Texas Instruments TSB43AB21/A/AI/A-EP");
 147                 return 0;
 148         }
 149         if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43AB23)) {
 150                 device_set_desc(dev, "Texas Instruments TSB43AB23");
 151                 return 0;
 152         }
 153         if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB82AA2)) {
 154                 device_set_desc(dev, "Texas Instruments TSB82AA2");
 155                 return 0;
 156         }
 157         if (id == (FW_VENDORID_TI | FW_DEVICE_TIPCI4450)) {
 158                 device_set_desc(dev, "Texas Instruments PCI4450");
 159                 return 0;
 160         }
 161         if (id == (FW_VENDORID_TI | FW_DEVICE_TIPCI4410A)) {
 162                 device_set_desc(dev, "Texas Instruments PCI4410A");
 163                 return 0;
 164         }
 165         if (id == (FW_VENDORID_TI | FW_DEVICE_TIPCI4451)) {
 166                 device_set_desc(dev, "Texas Instruments PCI4451");
 167                 return 0;
 168         }
 169         if (id == (FW_VENDORID_SONY | FW_DEVICE_CXD1947)) {
 170                 device_set_desc(dev, "Sony i.LINK (CXD1947)");
 171                 return 0;
 172         }
 173         if (id == (FW_VENDORID_SONY | FW_DEVICE_CXD3222)) {
 174                 device_set_desc(dev, "Sony i.LINK (CXD3222)");
 175                 return 0;
 176         }
 177         if (id == (FW_VENDORID_VIA | FW_DEVICE_VT6306)) {
 178                 device_set_desc(dev, "VIA Fire II (VT6306)");
 179                 return 0;
 180         }
 181         if (id == (FW_VENDORID_RICOH | FW_DEVICE_R5C551)) {
 182                 device_set_desc(dev, "Ricoh R5C551");
 183                 return 0;
 184         }
 185         if (id == (FW_VENDORID_RICOH | FW_DEVICE_R5C552)) {
 186                 device_set_desc(dev, "Ricoh R5C552");
 187                 return 0;
 188         }
 189         if (id == (FW_VENDORID_APPLE | FW_DEVICE_PANGEA)) {
 190                 device_set_desc(dev, "Apple Pangea");
 191                 return 0;
 192         }
 193         if (id == (FW_VENDORID_APPLE | FW_DEVICE_UNINORTH)) {
 194                 device_set_desc(dev, "Apple UniNorth");
 195                 return 0;
 196         }
 197         if (id == (FW_VENDORID_LUCENT | FW_DEVICE_FW322)) {
 198                 device_set_desc(dev, "Lucent FW322/323");
 199                 return 0;
 200         }
 201         if (id == (FW_VENDORID_INTEL | FW_DEVICE_82372FB)) {
 202                 device_set_desc(dev, "Intel 82372FB");
 203                 return 0;
 204         }
 205         if (id == (FW_VENDORID_ADAPTEC | FW_DEVICE_AIC5800)) {
 206                 device_set_desc(dev, "Adaptec AHA-894x/AIC-5800");
 207                 return 0;
 208         }
 209 #endif
 210         if (pci_get_class(dev) == PCIC_SERIALBUS
 211                         && pci_get_subclass(dev) == PCIS_SERIALBUS_FW
 212                         && pci_get_progif(dev) == PCI_INTERFACE_OHCI) {
 213                 device_printf(dev, "vendor=%x, dev=%x\n", pci_get_vendor(dev),
 214                         pci_get_device(dev));
 215                 device_set_desc(dev, "1394 Open Host Controller Interface");
 216                 return 0;
 217         }
 218
 219         return ENXIO;
 220 }
 221
 222 #if defined(__DragonFly__) || __FreeBSD_version < 500000
 223 static void
 224 fwohci_dummy_intr(void *arg)
 225 {
 226         /* XXX do nothing */
 227 }
 228 #endif
 229
 230 static int
 231 fwohci_pci_init(device_t self)
 232 {
 233         int olatency, latency, ocache_line, cache_line;
 234         u_int16_t cmd;
 235
 236         /*
 237          * Clear PCIM_CMD_MWRICEN as per FreeBSD/1.20, but note that the
 238          * problem may have been related to SERR and PERR being
 239          * unconditionally enabled in that rev.
 240          *
 241          * Do not change the SERRESPEN or PERRESPEN bits.  Use the BIOS
 242          * values (probably off).  This crashes some machines in fwohci_init().
 243          *
 244          * The theory here is that the device may not be properly initializing
 245          * its on-chip memory, leaving some of it in a parity errored state,
 246          * and enabling parity check may result in the device blowing up.
 247          * It's also possible that some hardware is just plain broken.  OpenBSD
 248          * does not turn on SERRESPEN or PERRESPEN so we won't either.
 249          */
 250         cmd = pci_read_config(self, PCIR_COMMAND, 2);
 251         cmd |= PCIM_CMD_MEMEN | PCIM_CMD_BUSMASTEREN;
 252         cmd &= ~PCIM_CMD_MWRICEN;
 253         pci_write_config(self, PCIR_COMMAND, cmd, 2);
 254
 255         latency = olatency = pci_read_config(self, PCIR_LATTIMER, 1);
 256 #define DEF_LATENCY 0x20
 257         if (olatency < DEF_LATENCY) {
 258                 latency = DEF_LATENCY;
 259                 pci_write_config(self, PCIR_LATTIMER, latency, 1);
 260         }
 261
 262         cache_line = ocache_line = pci_read_config(self, PCIR_CACHELNSZ, 1);
 263 #define DEF_CACHE_LINE 8
 264         if (ocache_line < DEF_CACHE_LINE) {
 265                 cache_line = DEF_CACHE_LINE;
 266                 pci_write_config(self, PCIR_CACHELNSZ, cache_line, 1);
 267         }
 268
 269         if (firewire_debug) {
 270                 device_printf(self, "latency timer %d -> %d.\n",
 271                         olatency, latency);
 272                 device_printf(self, "cache size %d -> %d.\n",
 273                         ocache_line, cache_line);
 274         }
 275
 276         return 0;
 277 }
 278
 279 static int
 280 fwohci_pci_attach(device_t self)
 281 {
 282         fwohci_softc_t *sc = device_get_softc(self);
 283         int err;
 284         int rid;
 285 #if defined(__DragonFly__) || __FreeBSD_version < 500000
 286         int intr;
 287         /* For the moment, put in a message stating what is wrong */
 288         intr = pci_read_config(self, PCIR_INTLINE, 1);
 289         if (intr == 0 || intr == 255) {
 290                 device_printf(self, "Invalid irq %d\n", intr);
 291 #ifdef __i386__
 292                 device_printf(self, "Please switch PNP-OS to 'No' in BIOS\n");
 293 #endif
 294         }
 295 #endif
 296
 297         if (bootverbose)
 298                 firewire_debug = bootverbose;
 299
 300         fwohci_pci_init(self);
 301
 302         rid = PCI_CBMEM;
 303         sc->bsr = bus_alloc_resource(self, SYS_RES_MEMORY, &rid,
 304                                         0, ~0, 1, RF_ACTIVE);
 305         if (!sc->bsr) {
 306                 device_printf(self, "Could not map memory\n");
 307                 return ENXIO;
 308         }
 309
 310         sc->bst = rman_get_bustag(sc->bsr);
 311         sc->bsh = rman_get_bushandle(sc->bsr);
 312
 313         rid = 0;
 314         sc->irq_res = bus_alloc_resource(self, SYS_RES_IRQ, &rid, 0, ~0, 1,
 315                                      RF_SHAREABLE | RF_ACTIVE);
 316         if (sc->irq_res == NULL) {
 317                 device_printf(self, "Could not allocate irq\n");
 318                 fwohci_pci_detach(self);
 319                 return ENXIO;
 320         }
 321
 322
 323         err = bus_setup_intr(self, sc->irq_res,
 324 #if FWOHCI_TASKQUEUE
 325                         INTR_TYPE_NET | INTR_MPSAFE,
 326 #else
 327                         INTR_TYPE_NET,
 328 #endif
 329                      (driver_intr_t *) fwohci_intr, sc, &sc->ih);
 330 #if defined(__DragonFly__) || __FreeBSD_version < 500000
 331         /* XXX splcam() should mask this irq for sbp.c*/
 332         err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_CAM,
 333                      (driver_intr_t *) fwohci_dummy_intr, sc, &sc->ih_cam);
 334         /* XXX splbio() should mask this irq for physio()/fwmem_strategy() */
 335         err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO,
 336                      (driver_intr_t *) fwohci_dummy_intr, sc, &sc->ih_bio);
 337 #endif
 338         if (err) {
 339                 device_printf(self, "Could not setup irq, %d\n", err);
 340                 fwohci_pci_detach(self);
 341                 return ENXIO;
 342         }
 343
 344         err = bus_dma_tag_create(/*parent*/NULL, /*alignment*/1,
 345                                 /*boundary*/0,
 346 #if BOUNCE_BUFFER_TEST
 347                                 /*lowaddr*/BUS_SPACE_MAXADDR_24BIT,
 348 #else
 349                                 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
 350 #endif
 351                                 /*highaddr*/BUS_SPACE_MAXADDR,
 352                                 /*filter*/NULL, /*filterarg*/NULL,
 353                                 /*maxsize*/0x100000,
 354                                 /*nsegments*/0x20,
 355                                 /*maxsegsz*/0x8000,
 356                                 /*flags*/BUS_DMA_ALLOCNOW,
 357 #if defined(__FreeBSD__) && __FreeBSD_version >= 501102
 358                                 /*lockfunc*/busdma_lock_mutex,
 359                                 /*lockarg*/&Giant,
 360 #endif
 361                                 &sc->fc.dmat);
 362         if (err != 0) {
 363                 printf("fwohci_pci_attach: Could not allocate DMA tag "
 364                         "- error %d\n", err);
 365                         return (ENOMEM);
 366         }
 367
 368         err = fwohci_init(sc, self);
 369
 370         if (err) {
 371                 device_printf(self, "fwohci_init failed with err=%d\n", err);
 372                 fwohci_pci_detach(self);
 373                 return EIO;
 374         }
 375
 376         /* probe and attach a child device(firewire) */
 377         bus_generic_probe(self);
 378         bus_generic_attach(self);
 379
 380         return 0;
 381 }
 382
 383 static int
 384 fwohci_pci_detach(device_t self)
 385 {
 386         fwohci_softc_t *sc = device_get_softc(self);
 387         int s;
 388
 389
 390         s = splfw();
 391
 392         if (sc->bsr)
 393                 fwohci_stop(sc, self);
 394
 395         bus_generic_detach(self);
 396         if (sc->fc.bdev) {
 397                 device_delete_child(self, sc->fc.bdev);
 398                 sc->fc.bdev = NULL;
 399         }
 400
 401         /* disable interrupts that might have been switched on */
 402         if (sc->bst && sc->bsh)
 403                 bus_space_write_4(sc->bst, sc->bsh,
 404                                   FWOHCI_INTMASKCLR, OHCI_INT_EN);
 405
 406         if (sc->irq_res) {
 407                 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
 408                 if (err)
 409                         /* XXX or should we panic? */
 410                         device_printf(self, "Could not tear down irq, %d\n",
 411                                       err);
 412 #if defined(__DragonFly__) || __FreeBSD_version < 500000
 413                 bus_teardown_intr(self, sc->irq_res, sc->ih_cam);
 414                 bus_teardown_intr(self, sc->irq_res, sc->ih_bio);
 415 #endif
 416                 sc->ih = NULL;
 417         }
 418
 419         if (sc->irq_res) {
 420                 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
 421                 sc->irq_res = NULL;
 422         }
 423
 424         if (sc->bsr) {
 425                 bus_release_resource(self, SYS_RES_MEMORY,PCI_CBMEM,sc->bsr);
 426                 sc->bsr = NULL;
 427                 sc->bst = 0;
 428                 sc->bsh = 0;
 429         }
 430
 431         fwohci_detach(sc, self);
 432         splx(s);
 433
 434         return 0;
 435 }
 436
 437 static int
 438 fwohci_pci_suspend(device_t dev)
 439 {
 440         fwohci_softc_t *sc = device_get_softc(dev);
 441         int err;
 442
 443         device_printf(dev, "fwohci_pci_suspend\n");
 444         err = bus_generic_suspend(dev);
 445         if (err)
 446                 return err;
 447         fwohci_stop(sc, dev);
 448         return 0;
 449 }
 450
 451 static int
 452 fwohci_pci_resume(device_t dev)
 453 {
 454         fwohci_softc_t *sc = device_get_softc(dev);
 455
 456 #ifndef BURN_BRIDGES
 457         device_printf(dev, "fwohci_pci_resume: power_state = 0x%08x\n",
 458                                         pci_get_powerstate(dev));
 459         pci_set_powerstate(dev, PCI_POWERSTATE_D0);
 460 #endif
 461         fwohci_pci_init(dev);
 462         fwohci_resume(sc, dev);
 463         return 0;
 464 }
 465
 466 static int
 467 fwohci_pci_shutdown(device_t dev)
 468 {
 469         fwohci_softc_t *sc = device_get_softc(dev);
 470
 471         bus_generic_shutdown(dev);
 472         fwohci_stop(sc, dev);
 473         return 0;
 474 }
 475
 476 static device_t
 477 fwohci_pci_add_child(device_t dev, int order, const char *name, int unit)
 478 {
 479         struct fwohci_softc *sc;
 480         device_t child;
 481         int s, err = 0;
 482
 483         sc = (struct fwohci_softc *)device_get_softc(dev);
 484         child = device_add_child(dev, name, unit);
 485         if (child == NULL)
 486                 return (child);
 487
 488         sc->fc.bdev = child;
 489         device_set_ivars(child, (void *)&sc->fc);
 490
 491         err = device_probe_and_attach(child);
 492         if (err) {
 493                 device_printf(dev, "probe_and_attach failed with err=%d\n",
 494                     err);
 495                 fwohci_pci_detach(dev);
 496                 device_delete_child(dev, child);
 497                 return NULL;
 498         }
 499
 500         /* XXX
 501          * Clear the bus reset event flag to start transactions even when
 502          * interrupt is disabled during the boot process.
 503          */
 504         DELAY(250); /* 2 cycles */
 505         s = splfw();
 506         fwohci_poll((void *)sc, 0, -1);
 507         splx(s);
 508
 509         return (child);
 510 }
 511
 512 static device_method_t fwohci_methods[] = {
 513         /* Device interface */
 514         DEVMETHOD(device_probe,         fwohci_pci_probe),
 515         DEVMETHOD(device_attach,        fwohci_pci_attach),
 516         DEVMETHOD(device_detach,        fwohci_pci_detach),
 517         DEVMETHOD(device_suspend,       fwohci_pci_suspend),
 518         DEVMETHOD(device_resume,        fwohci_pci_resume),
 519         DEVMETHOD(device_shutdown,      fwohci_pci_shutdown),
 520
 521         /* Bus interface */
 522         DEVMETHOD(bus_add_child,        fwohci_pci_add_child),
 523         DEVMETHOD(bus_print_child,      bus_generic_print_child),
 524
 525         { 0, 0 }
 526 };
 527
 528 static driver_t fwohci_driver = {
 529         "fwohci",
 530         fwohci_methods,
 531         sizeof(fwohci_softc_t),
 532 };
 533
 534 static devclass_t fwohci_devclass;
 535
 536 #ifdef FWOHCI_MODULE
 537 MODULE_DEPEND(fwohci, firewire, 1, 1, 1);
 538 #endif
 539 DRIVER_MODULE(fwohci, pci, fwohci_driver, fwohci_devclass, 0, 0);
 540 DRIVER_MODULE(fwohci, cardbus, fwohci_driver, fwohci_devclass, 0, 0);