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$ 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/bus.h> 44 #include <sys/queue.h> 45 #include <machine/bus.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 <machine/resource.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 uint32_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_UPD72873)) { 115 device_set_desc(dev, "NEC uPD72873"); 116 return 0; 117 } 118 if (id == (FW_VENDORID_NEC | FW_DEVICE_UPD72874)) { 119 device_set_desc(dev, "NEC uPD72874"); 120 return 0; 121 } 122 if (id == (FW_VENDORID_SIS | FW_DEVICE_7007)) { 123 /* It has no real identifier, using device id. */ 124 device_set_desc(dev, "SiS 7007"); 125 return 0; 126 } 127 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB22)) { 128 device_set_desc(dev, "Texas Instruments TSB12LV22"); 129 return 0; 130 } 131 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB23)) { 132 device_set_desc(dev, "Texas Instruments TSB12LV23"); 133 return 0; 134 } 135 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB26)) { 136 device_set_desc(dev, "Texas Instruments TSB12LV26"); 137 return 0; 138 } 139 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43)) { 140 device_set_desc(dev, "Texas Instruments TSB43AA22"); 141 return 0; 142 } 143 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43A)) { 144 device_set_desc(dev, "Texas Instruments TSB43AB22/A"); 145 return 0; 146 } 147 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43AB21)) { 148 device_set_desc(dev, "Texas Instruments TSB43AB21/A/AI/A-EP"); 149 return 0; 150 } 151 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43AB23)) { 152 device_set_desc(dev, "Texas Instruments TSB43AB23"); 153 return 0; 154 } 155 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB82AA2)) { 156 device_set_desc(dev, "Texas Instruments TSB82AA2"); 157 return 0; 158 } 159 if (id == (FW_VENDORID_TI | FW_DEVICE_TIPCI4450)) { 160 device_set_desc(dev, "Texas Instruments PCI4450"); 161 return 0; 162 } 163 if (id == (FW_VENDORID_TI | FW_DEVICE_TIPCI4410A)) { 164 device_set_desc(dev, "Texas Instruments PCI4410A"); 165 return 0; 166 } 167 if (id == (FW_VENDORID_TI | FW_DEVICE_TIPCI4451)) { 168 device_set_desc(dev, "Texas Instruments PCI4451"); 169 return 0; 170 } 171 if (id == (FW_VENDORID_SONY | FW_DEVICE_CXD1947)) { 172 device_set_desc(dev, "Sony i.LINK (CXD1947)"); 173 return 0; 174 } 175 if (id == (FW_VENDORID_SONY | FW_DEVICE_CXD3222)) { 176 device_set_desc(dev, "Sony i.LINK (CXD3222)"); 177 return 0; 178 } 179 if (id == (FW_VENDORID_VIA | FW_DEVICE_VT6306)) { 180 device_set_desc(dev, "VIA Fire II (VT6306)"); 181 return 0; 182 } 183 if (id == (FW_VENDORID_RICOH | FW_DEVICE_R5C551)) { 184 device_set_desc(dev, "Ricoh R5C551"); 185 return 0; 186 } 187 if (id == (FW_VENDORID_RICOH | FW_DEVICE_R5C552)) { 188 device_set_desc(dev, "Ricoh R5C552"); 189 return 0; 190 } 191 if (id == (FW_VENDORID_APPLE | FW_DEVICE_PANGEA)) { 192 device_set_desc(dev, "Apple Pangea"); 193 return 0; 194 } 195 if (id == (FW_VENDORID_APPLE | FW_DEVICE_UNINORTH)) { 196 device_set_desc(dev, "Apple UniNorth"); 197 return 0; 198 } 199 if (id == (FW_VENDORID_LUCENT | FW_DEVICE_FW322)) { 200 device_set_desc(dev, "Lucent FW322/323"); 201 return 0; 202 } 203 if (id == (FW_VENDORID_INTEL | FW_DEVICE_82372FB)) { 204 device_set_desc(dev, "Intel 82372FB"); 205 return 0; 206 } 207 if (id == (FW_VENDORID_ADAPTEC | FW_DEVICE_AIC5800)) { 208 device_set_desc(dev, "Adaptec AHA-894x/AIC-5800"); 209 return 0; 210 } 211 #endif 212 if (pci_get_class(dev) == PCIC_SERIALBUS 213 && pci_get_subclass(dev) == PCIS_SERIALBUS_FW 214 && pci_get_progif(dev) == PCI_INTERFACE_OHCI) { 215 if (bootverbose) 216 device_printf(dev, "vendor=%x, dev=%x\n", 217 pci_get_vendor(dev), pci_get_device(dev)); 218 device_set_desc(dev, "1394 Open Host Controller Interface"); 219 return 0; 220 } 221 222 return ENXIO; 223 } 224 225 #if defined(__DragonFly__) || __FreeBSD_version < 500000 226 static void 227 fwohci_dummy_intr(void *arg) 228 { 229 /* XXX do nothing */ 230 } 231 #endif 232 233 static int 234 fwohci_pci_init(device_t self) 235 { 236 int olatency, latency, ocache_line, cache_line; 237 uint16_t cmd; 238 239 cmd = pci_read_config(self, PCIR_COMMAND, 2); 240 cmd |= PCIM_CMD_MEMEN | PCIM_CMD_BUSMASTEREN | PCIM_CMD_MWRICEN | 241 PCIM_CMD_SERRESPEN | PCIM_CMD_PERRESPEN; 242 #if 1 243 cmd &= ~PCIM_CMD_MWRICEN; 244 #endif 245 pci_write_config(self, PCIR_COMMAND, cmd, 2); 246 247 latency = olatency = pci_read_config(self, PCIR_LATTIMER, 1); 248 #define DEF_LATENCY 0x20 249 if (olatency < DEF_LATENCY) { 250 latency = DEF_LATENCY; 251 pci_write_config(self, PCIR_LATTIMER, latency, 1); 252 } 253 254 cache_line = ocache_line = pci_read_config(self, PCIR_CACHELNSZ, 1); 255 #define DEF_CACHE_LINE 8 256 if (ocache_line < DEF_CACHE_LINE) { 257 cache_line = DEF_CACHE_LINE; 258 pci_write_config(self, PCIR_CACHELNSZ, cache_line, 1); 259 } 260 261 if (firewire_debug) { 262 device_printf(self, "latency timer %d -> %d.\n", 263 olatency, latency); 264 device_printf(self, "cache size %d -> %d.\n", 265 ocache_line, cache_line); 266 } 267 268 return 0; 269 } 270 271 static int 272 fwohci_pci_attach(device_t self) 273 { 274 fwohci_softc_t *sc = device_get_softc(self); 275 int err; 276 int rid; 277 #if defined(__DragonFly__) || __FreeBSD_version < 500000 278 int intr; 279 /* For the moment, put in a message stating what is wrong */ 280 intr = pci_read_config(self, PCIR_INTLINE, 1); 281 if (intr == 0 || intr == 255) { 282 device_printf(self, "Invalid irq %d\n", intr); 283 #ifdef __i386__ 284 device_printf(self, "Please switch PNP-OS to 'No' in BIOS\n"); 285 #endif 286 } 287 #endif 288 289 #if 0 290 if (bootverbose) 291 firewire_debug = bootverbose; 292 #endif 293 294 fwohci_pci_init(self); 295 296 rid = PCI_CBMEM; 297 #if __FreeBSD_version >= 502109 298 sc->bsr = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE); 299 #else 300 sc->bsr = bus_alloc_resource(self, SYS_RES_MEMORY, &rid, 301 0, ~0, 1, RF_ACTIVE); 302 #endif 303 if (!sc->bsr) { 304 device_printf(self, "Could not map memory\n"); 305 return ENXIO; 306 } 307 308 sc->bst = rman_get_bustag(sc->bsr); 309 sc->bsh = rman_get_bushandle(sc->bsr); 310 311 rid = 0; 312 #if __FreeBSD_version >= 502109 313 sc->irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 314 RF_SHAREABLE | RF_ACTIVE); 315 #else 316 sc->irq_res = bus_alloc_resource(self, SYS_RES_IRQ, &rid, 0, ~0, 1, 317 RF_SHAREABLE | RF_ACTIVE); 318 #endif 319 if (sc->irq_res == NULL) { 320 device_printf(self, "Could not allocate irq\n"); 321 fwohci_pci_detach(self); 322 return ENXIO; 323 } 324 325 326 err = bus_setup_intr(self, sc->irq_res, 327 #if FWOHCI_TASKQUEUE 328 INTR_TYPE_NET | INTR_MPSAFE, 329 #else 330 INTR_TYPE_NET, 331 #endif 332 (driver_intr_t *) fwohci_intr, sc, &sc->ih); 333 #if defined(__DragonFly__) || __FreeBSD_version < 500000 334 /* XXX splcam() should mask this irq for sbp.c*/ 335 err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_CAM, 336 (driver_intr_t *) fwohci_dummy_intr, sc, &sc->ih_cam); 337 /* XXX splbio() should mask this irq for physio()/fwmem_strategy() */ 338 err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO, 339 (driver_intr_t *) fwohci_dummy_intr, sc, &sc->ih_bio); 340 #endif 341 if (err) { 342 device_printf(self, "Could not setup irq, %d\n", err); 343 fwohci_pci_detach(self); 344 return ENXIO; 345 } 346 347 err = bus_dma_tag_create(/*parent*/NULL, /*alignment*/1, 348 /*boundary*/0, 349 #if BOUNCE_BUFFER_TEST 350 /*lowaddr*/BUS_SPACE_MAXADDR_24BIT, 351 #else 352 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT, 353 #endif 354 /*highaddr*/BUS_SPACE_MAXADDR, 355 /*filter*/NULL, /*filterarg*/NULL, 356 /*maxsize*/0x100000, 357 /*nsegments*/0x20, 358 /*maxsegsz*/0x8000, 359 /*flags*/BUS_DMA_ALLOCNOW, 360 #if defined(__FreeBSD__) && __FreeBSD_version >= 501102 361 /*lockfunc*/busdma_lock_mutex, 362 /*lockarg*/&Giant, 363 #endif 364 &sc->fc.dmat); 365 if (err != 0) { 366 printf("fwohci_pci_attach: Could not allocate DMA tag " 367 "- error %d\n", err); 368 return (ENOMEM); 369 } 370 371 err = fwohci_init(sc, self); 372 373 if (err) { 374 device_printf(self, "fwohci_init failed with err=%d\n", err); 375 fwohci_pci_detach(self); 376 return EIO; 377 } 378 379 /* probe and attach a child device(firewire) */ 380 bus_generic_probe(self); 381 bus_generic_attach(self); 382 383 return 0; 384 } 385 386 static int 387 fwohci_pci_detach(device_t self) 388 { 389 fwohci_softc_t *sc = device_get_softc(self); 390 int s; 391 392 393 s = splfw(); 394 395 if (sc->bsr) 396 fwohci_stop(sc, self); 397 398 bus_generic_detach(self); 399 if (sc->fc.bdev) { 400 device_delete_child(self, sc->fc.bdev); 401 sc->fc.bdev = NULL; 402 } 403 404 /* disable interrupts that might have been switched on */ 405 if (sc->bst && sc->bsh) 406 bus_space_write_4(sc->bst, sc->bsh, 407 FWOHCI_INTMASKCLR, OHCI_INT_EN); 408 409 if (sc->irq_res) { 410 int err = bus_teardown_intr(self, sc->irq_res, sc->ih); 411 if (err) 412 /* XXX or should we panic? */ 413 device_printf(self, "Could not tear down irq, %d\n", 414 err); 415 #if defined(__DragonFly__) || __FreeBSD_version < 500000 416 bus_teardown_intr(self, sc->irq_res, sc->ih_cam); 417 bus_teardown_intr(self, sc->irq_res, sc->ih_bio); 418 #endif 419 sc->ih = NULL; 420 } 421 422 if (sc->irq_res) { 423 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res); 424 sc->irq_res = NULL; 425 } 426 427 if (sc->bsr) { 428 bus_release_resource(self, SYS_RES_MEMORY,PCI_CBMEM,sc->bsr); 429 sc->bsr = NULL; 430 sc->bst = 0; 431 sc->bsh = 0; 432 } 433 434 fwohci_detach(sc, self); 435 splx(s); 436 437 return 0; 438 } 439 440 static int 441 fwohci_pci_suspend(device_t dev) 442 { 443 fwohci_softc_t *sc = device_get_softc(dev); 444 int err; 445 446 device_printf(dev, "fwohci_pci_suspend\n"); 447 err = bus_generic_suspend(dev); 448 if (err) 449 return err; 450 fwohci_stop(sc, dev); 451 return 0; 452 } 453 454 static int 455 fwohci_pci_resume(device_t dev) 456 { 457 fwohci_softc_t *sc = device_get_softc(dev); 458 459 fwohci_pci_init(dev); 460 fwohci_resume(sc, dev); 461 return 0; 462 } 463 464 static int 465 fwohci_pci_shutdown(device_t dev) 466 { 467 fwohci_softc_t *sc = device_get_softc(dev); 468 469 bus_generic_shutdown(dev); 470 fwohci_stop(sc, dev); 471 return 0; 472 } 473 474 static device_t 475 fwohci_pci_add_child(device_t dev, int order, const char *name, int unit) 476 { 477 struct fwohci_softc *sc; 478 device_t child; 479 int s, err = 0; 480 481 sc = (struct fwohci_softc *)device_get_softc(dev); 482 child = device_add_child(dev, name, unit); 483 if (child == NULL) 484 return (child); 485 486 sc->fc.bdev = child; 487 device_set_ivars(child, (void *)&sc->fc); 488 489 err = device_probe_and_attach(child); 490 if (err) { 491 device_printf(dev, "probe_and_attach failed with err=%d\n", 492 err); 493 fwohci_pci_detach(dev); 494 device_delete_child(dev, child); 495 return NULL; 496 } 497 498 /* XXX 499 * Clear the bus reset event flag to start transactions even when 500 * interrupt is disabled during the boot process. 501 */ 502 DELAY(250); /* 2 cycles */ 503 s = splfw(); 504 fwohci_poll((void *)sc, 0, -1); 505 splx(s); 506 507 return (child); 508 } 509 510 static device_method_t fwohci_methods[] = { 511 /* Device interface */ 512 DEVMETHOD(device_probe, fwohci_pci_probe), 513 DEVMETHOD(device_attach, fwohci_pci_attach), 514 DEVMETHOD(device_detach, fwohci_pci_detach), 515 DEVMETHOD(device_suspend, fwohci_pci_suspend), 516 DEVMETHOD(device_resume, fwohci_pci_resume), 517 DEVMETHOD(device_shutdown, fwohci_pci_shutdown), 518 519 /* Bus interface */ 520 DEVMETHOD(bus_add_child, fwohci_pci_add_child), 521 DEVMETHOD(bus_print_child, bus_generic_print_child), 522 523 { 0, 0 } 524 }; 525 526 static driver_t fwohci_driver = { 527 "fwohci", 528 fwohci_methods, 529 sizeof(fwohci_softc_t), 530 }; 531 532 static devclass_t fwohci_devclass; 533 534 #ifdef FWOHCI_MODULE 535 MODULE_DEPEND(fwohci, firewire, 1, 1, 1); 536 #endif 537 DRIVER_MODULE(fwohci, pci, fwohci_driver, fwohci_devclass, 0, 0); 538 DRIVER_MODULE(fwohci, cardbus, fwohci_driver, fwohci_devclass, 0, 0); 539