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