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