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 /* for broken hardware */ 243 cmd &= ~PCIM_CMD_MWRICEN; 244 cmd &= ~(PCIM_CMD_SERRESPEN | PCIM_CMD_PERRESPEN); 245 #endif 246 pci_write_config(self, PCIR_COMMAND, cmd, 2); 247 248 latency = olatency = pci_read_config(self, PCIR_LATTIMER, 1); 249 #define DEF_LATENCY 0x20 250 if (olatency < DEF_LATENCY) { 251 latency = DEF_LATENCY; 252 pci_write_config(self, PCIR_LATTIMER, latency, 1); 253 } 254 255 cache_line = ocache_line = pci_read_config(self, PCIR_CACHELNSZ, 1); 256 #define DEF_CACHE_LINE 8 257 if (ocache_line < DEF_CACHE_LINE) { 258 cache_line = DEF_CACHE_LINE; 259 pci_write_config(self, PCIR_CACHELNSZ, cache_line, 1); 260 } 261 262 if (firewire_debug) { 263 device_printf(self, "latency timer %d -> %d.\n", 264 olatency, latency); 265 device_printf(self, "cache size %d -> %d.\n", 266 ocache_line, cache_line); 267 } 268 269 return 0; 270 } 271 272 static int 273 fwohci_pci_attach(device_t self) 274 { 275 fwohci_softc_t *sc = device_get_softc(self); 276 int err; 277 int rid; 278 #if defined(__DragonFly__) || __FreeBSD_version < 500000 279 int intr; 280 /* For the moment, put in a message stating what is wrong */ 281 intr = pci_read_config(self, PCIR_INTLINE, 1); 282 if (intr == 0 || intr == 255) { 283 device_printf(self, "Invalid irq %d\n", intr); 284 #ifdef __i386__ 285 device_printf(self, "Please switch PNP-OS to 'No' in BIOS\n"); 286 #endif 287 } 288 #endif 289 290 #if 0 291 if (bootverbose) 292 firewire_debug = bootverbose; 293 #endif 294 295 fwohci_pci_init(self); 296 297 rid = PCI_CBMEM; 298 #if __FreeBSD_version >= 502109 299 sc->bsr = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE); 300 #else 301 sc->bsr = bus_alloc_resource(self, SYS_RES_MEMORY, &rid, 302 0, ~0, 1, RF_ACTIVE); 303 #endif 304 if (!sc->bsr) { 305 device_printf(self, "Could not map memory\n"); 306 return ENXIO; 307 } 308 309 sc->bst = rman_get_bustag(sc->bsr); 310 sc->bsh = rman_get_bushandle(sc->bsr); 311 312 rid = 0; 313 #if __FreeBSD_version >= 502109 314 sc->irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 315 RF_SHAREABLE | RF_ACTIVE); 316 #else 317 sc->irq_res = bus_alloc_resource(self, SYS_RES_IRQ, &rid, 0, ~0, 1, 318 RF_SHAREABLE | RF_ACTIVE); 319 #endif 320 if (sc->irq_res == NULL) { 321 device_printf(self, "Could not allocate irq\n"); 322 fwohci_pci_detach(self); 323 return ENXIO; 324 } 325 326 327 err = bus_setup_intr(self, sc->irq_res, 328 #if FWOHCI_TASKQUEUE 329 INTR_TYPE_NET | INTR_MPSAFE, 330 #else 331 INTR_TYPE_NET, 332 #endif 333 (driver_intr_t *) fwohci_intr, sc, &sc->ih); 334 #if defined(__DragonFly__) || __FreeBSD_version < 500000 335 /* XXX splcam() should mask this irq for sbp.c*/ 336 err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_CAM, 337 (driver_intr_t *) fwohci_dummy_intr, sc, &sc->ih_cam); 338 /* XXX splbio() should mask this irq for physio()/fwmem_strategy() */ 339 err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO, 340 (driver_intr_t *) fwohci_dummy_intr, sc, &sc->ih_bio); 341 #endif 342 if (err) { 343 device_printf(self, "Could not setup irq, %d\n", err); 344 fwohci_pci_detach(self); 345 return ENXIO; 346 } 347 348 err = bus_dma_tag_create(/*parent*/NULL, /*alignment*/1, 349 /*boundary*/0, 350 #if BOUNCE_BUFFER_TEST 351 /*lowaddr*/BUS_SPACE_MAXADDR_24BIT, 352 #else 353 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT, 354 #endif 355 /*highaddr*/BUS_SPACE_MAXADDR, 356 /*filter*/NULL, /*filterarg*/NULL, 357 /*maxsize*/0x100000, 358 /*nsegments*/0x20, 359 /*maxsegsz*/0x8000, 360 /*flags*/BUS_DMA_ALLOCNOW, 361 #if defined(__FreeBSD__) && __FreeBSD_version >= 501102 362 /*lockfunc*/busdma_lock_mutex, 363 /*lockarg*/&Giant, 364 #endif 365 &sc->fc.dmat); 366 if (err != 0) { 367 printf("fwohci_pci_attach: Could not allocate DMA tag " 368 "- error %d\n", err); 369 return (ENOMEM); 370 } 371 372 err = fwohci_init(sc, self); 373 374 if (err) { 375 device_printf(self, "fwohci_init failed with err=%d\n", err); 376 fwohci_pci_detach(self); 377 return EIO; 378 } 379 380 /* probe and attach a child device(firewire) */ 381 bus_generic_probe(self); 382 bus_generic_attach(self); 383 384 return 0; 385 } 386 387 static int 388 fwohci_pci_detach(device_t self) 389 { 390 fwohci_softc_t *sc = device_get_softc(self); 391 int s; 392 393 394 s = splfw(); 395 396 if (sc->bsr) 397 fwohci_stop(sc, self); 398 399 bus_generic_detach(self); 400 if (sc->fc.bdev) { 401 device_delete_child(self, sc->fc.bdev); 402 sc->fc.bdev = NULL; 403 } 404 405 /* disable interrupts that might have been switched on */ 406 if (sc->bst && sc->bsh) 407 bus_space_write_4(sc->bst, sc->bsh, 408 FWOHCI_INTMASKCLR, OHCI_INT_EN); 409 410 if (sc->irq_res) { 411 int err = bus_teardown_intr(self, sc->irq_res, sc->ih); 412 if (err) 413 /* XXX or should we panic? */ 414 device_printf(self, "Could not tear down irq, %d\n", 415 err); 416 #if defined(__DragonFly__) || __FreeBSD_version < 500000 417 bus_teardown_intr(self, sc->irq_res, sc->ih_cam); 418 bus_teardown_intr(self, sc->irq_res, sc->ih_bio); 419 #endif 420 sc->ih = NULL; 421 } 422 423 if (sc->irq_res) { 424 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res); 425 sc->irq_res = NULL; 426 } 427 428 if (sc->bsr) { 429 bus_release_resource(self, SYS_RES_MEMORY,PCI_CBMEM,sc->bsr); 430 sc->bsr = NULL; 431 sc->bst = 0; 432 sc->bsh = 0; 433 } 434 435 fwohci_detach(sc, self); 436 splx(s); 437 438 return 0; 439 } 440 441 static int 442 fwohci_pci_suspend(device_t dev) 443 { 444 fwohci_softc_t *sc = device_get_softc(dev); 445 int err; 446 447 device_printf(dev, "fwohci_pci_suspend\n"); 448 err = bus_generic_suspend(dev); 449 if (err) 450 return err; 451 fwohci_stop(sc, dev); 452 return 0; 453 } 454 455 static int 456 fwohci_pci_resume(device_t dev) 457 { 458 fwohci_softc_t *sc = device_get_softc(dev); 459 460 fwohci_pci_init(dev); 461 fwohci_resume(sc, dev); 462 return 0; 463 } 464 465 static int 466 fwohci_pci_shutdown(device_t dev) 467 { 468 fwohci_softc_t *sc = device_get_softc(dev); 469 470 bus_generic_shutdown(dev); 471 fwohci_stop(sc, dev); 472 return 0; 473 } 474 475 static device_t 476 fwohci_pci_add_child(device_t dev, int order, const char *name, int unit) 477 { 478 struct fwohci_softc *sc; 479 device_t child; 480 int s, err = 0; 481 482 sc = (struct fwohci_softc *)device_get_softc(dev); 483 child = device_add_child(dev, name, unit); 484 if (child == NULL) 485 return (child); 486 487 sc->fc.bdev = child; 488 device_set_ivars(child, (void *)&sc->fc); 489 490 err = device_probe_and_attach(child); 491 if (err) { 492 device_printf(dev, "probe_and_attach failed with err=%d\n", 493 err); 494 fwohci_pci_detach(dev); 495 device_delete_child(dev, child); 496 return NULL; 497 } 498 499 /* XXX 500 * Clear the bus reset event flag to start transactions even when 501 * interrupt is disabled during the boot process. 502 */ 503 DELAY(250); /* 2 cycles */ 504 s = splfw(); 505 fwohci_poll((void *)sc, 0, -1); 506 splx(s); 507 508 return (child); 509 } 510 511 static device_method_t fwohci_methods[] = { 512 /* Device interface */ 513 DEVMETHOD(device_probe, fwohci_pci_probe), 514 DEVMETHOD(device_attach, fwohci_pci_attach), 515 DEVMETHOD(device_detach, fwohci_pci_detach), 516 DEVMETHOD(device_suspend, fwohci_pci_suspend), 517 DEVMETHOD(device_resume, fwohci_pci_resume), 518 DEVMETHOD(device_shutdown, fwohci_pci_shutdown), 519 520 /* Bus interface */ 521 DEVMETHOD(bus_add_child, fwohci_pci_add_child), 522 DEVMETHOD(bus_print_child, bus_generic_print_child), 523 524 { 0, 0 } 525 }; 526 527 static driver_t fwohci_driver = { 528 "fwohci", 529 fwohci_methods, 530 sizeof(fwohci_softc_t), 531 }; 532 533 static devclass_t fwohci_devclass; 534 535 #ifdef FWOHCI_MODULE 536 MODULE_DEPEND(fwohci, firewire, 1, 1, 1); 537 #endif 538 DRIVER_MODULE(fwohci, pci, fwohci_driver, fwohci_devclass, 0, 0); 539 DRIVER_MODULE(fwohci, cardbus, fwohci_driver, fwohci_devclass, 0, 0); 540