2 * Copyright (c) 2003 Hidetoshi Shimokawa
3 * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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:
17 * This product includes software developed by K. Kobayashi and H. SHimokawa
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.
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.
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 $
38 #define BOUNCE_BUFFER_TEST 0
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/module.h>
46 #include <sys/queue.h>
47 #include <machine/bus.h>
49 #include <sys/malloc.h>
50 #if defined(__FreeBSD__) && __FreeBSD_version >= 501102
52 #include <sys/mutex.h>
54 #include <machine/resource.h>
56 #if defined(__DragonFly__) || __FreeBSD_version < 500000
57 #include <machine/clock.h> /* for DELAY() */
61 #include <bus/pci/pcivar.h>
62 #include <bus/pci/pcireg.h>
65 #include "firewirereg.h"
68 #include "fwohcireg.h"
69 #include "fwohcivar.h"
71 #if __FreeBSD_version < 500000
72 #include <pci/pcivar.h>
73 #include <pci/pcireg.h>
75 #include <dev/pci/pcivar.h>
76 #include <dev/pci/pcireg.h>
79 #include <dev/firewire/firewire.h>
80 #include <dev/firewire/firewirereg.h>
82 #include <dev/firewire/fwdma.h>
83 #include <dev/firewire/fwohcireg.h>
84 #include <dev/firewire/fwohcivar.h>
87 static int fwohci_pci_attach(device_t self);
88 static int fwohci_pci_detach(device_t self);
94 fwohci_pci_probe( device_t dev )
99 id = pci_get_devid(dev);
100 if (id == (FW_VENDORID_NATSEMI | FW_DEVICE_CS4210)) {
101 device_set_desc(dev, "National Semiconductor CS4210");
104 if (id == (FW_VENDORID_NEC | FW_DEVICE_UPD861)) {
105 device_set_desc(dev, "NEC uPD72861");
108 if (id == (FW_VENDORID_NEC | FW_DEVICE_UPD871)) {
109 device_set_desc(dev, "NEC uPD72871/2");
112 if (id == (FW_VENDORID_NEC | FW_DEVICE_UPD72870)) {
113 device_set_desc(dev, "NEC uPD72870");
116 if (id == (FW_VENDORID_NEC | FW_DEVICE_UPD72874)) {
117 device_set_desc(dev, "NEC uPD72874");
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");
125 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB22)) {
126 device_set_desc(dev, "Texas Instruments TSB12LV22");
129 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB23)) {
130 device_set_desc(dev, "Texas Instruments TSB12LV23");
133 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB26)) {
134 device_set_desc(dev, "Texas Instruments TSB12LV26");
137 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43)) {
138 device_set_desc(dev, "Texas Instruments TSB43AA22");
141 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43A)) {
142 device_set_desc(dev, "Texas Instruments TSB43AB22/A");
145 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43AB21)) {
146 device_set_desc(dev, "Texas Instruments TSB43AB21/A/AI/A-EP");
149 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB43AB23)) {
150 device_set_desc(dev, "Texas Instruments TSB43AB23");
153 if (id == (FW_VENDORID_TI | FW_DEVICE_TITSB82AA2)) {
154 device_set_desc(dev, "Texas Instruments TSB82AA2");
157 if (id == (FW_VENDORID_TI | FW_DEVICE_TIPCI4450)) {
158 device_set_desc(dev, "Texas Instruments PCI4450");
161 if (id == (FW_VENDORID_TI | FW_DEVICE_TIPCI4410A)) {
162 device_set_desc(dev, "Texas Instruments PCI4410A");
165 if (id == (FW_VENDORID_TI | FW_DEVICE_TIPCI4451)) {
166 device_set_desc(dev, "Texas Instruments PCI4451");
169 if (id == (FW_VENDORID_SONY | FW_DEVICE_CXD1947)) {
170 device_set_desc(dev, "Sony i.LINK (CXD1947)");
173 if (id == (FW_VENDORID_SONY | FW_DEVICE_CXD3222)) {
174 device_set_desc(dev, "Sony i.LINK (CXD3222)");
177 if (id == (FW_VENDORID_VIA | FW_DEVICE_VT6306)) {
178 device_set_desc(dev, "VIA Fire II (VT6306)");
181 if (id == (FW_VENDORID_RICOH | FW_DEVICE_R5C551)) {
182 device_set_desc(dev, "Ricoh R5C551");
185 if (id == (FW_VENDORID_RICOH | FW_DEVICE_R5C552)) {
186 device_set_desc(dev, "Ricoh R5C552");
189 if (id == (FW_VENDORID_APPLE | FW_DEVICE_PANGEA)) {
190 device_set_desc(dev, "Apple Pangea");
193 if (id == (FW_VENDORID_APPLE | FW_DEVICE_UNINORTH)) {
194 device_set_desc(dev, "Apple UniNorth");
197 if (id == (FW_VENDORID_LUCENT | FW_DEVICE_FW322)) {
198 device_set_desc(dev, "Lucent FW322/323");
201 if (id == (FW_VENDORID_INTEL | FW_DEVICE_82372FB)) {
202 device_set_desc(dev, "Intel 82372FB");
205 if (id == (FW_VENDORID_ADAPTEC | FW_DEVICE_AIC5800)) {
206 device_set_desc(dev, "Adaptec AHA-894x/AIC-5800");
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");
222 #if defined(__DragonFly__) || __FreeBSD_version < 500000
224 fwohci_dummy_intr(void *arg)
231 fwohci_pci_init(device_t self)
233 int olatency, latency, ocache_line, cache_line;
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.
241 * Do not change the SERRESPEN or PERRESPEN bits. Use the BIOS
242 * values (probably off). This crashes some machines in fwohci_init().
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.
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);
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);
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);
269 if (firewire_debug) {
270 device_printf(self, "latency timer %d -> %d.\n",
272 device_printf(self, "cache size %d -> %d.\n",
273 ocache_line, cache_line);
280 fwohci_pci_attach(device_t self)
282 fwohci_softc_t *sc = device_get_softc(self);
285 #if defined(__DragonFly__) || __FreeBSD_version < 500000
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);
292 device_printf(self, "Please switch PNP-OS to 'No' in BIOS\n");
298 firewire_debug = bootverbose;
300 fwohci_pci_init(self);
303 sc->bsr = bus_alloc_resource(self, SYS_RES_MEMORY, &rid,
304 0, ~0, 1, RF_ACTIVE);
306 device_printf(self, "Could not map memory\n");
310 sc->bst = rman_get_bustag(sc->bsr);
311 sc->bsh = rman_get_bushandle(sc->bsr);
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);
323 err = bus_setup_intr(self, sc->irq_res,
325 INTR_TYPE_NET | INTR_MPSAFE,
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);
339 device_printf(self, "Could not setup irq, %d\n", err);
340 fwohci_pci_detach(self);
344 err = bus_dma_tag_create(/*parent*/NULL, /*alignment*/1,
346 #if BOUNCE_BUFFER_TEST
347 /*lowaddr*/BUS_SPACE_MAXADDR_24BIT,
349 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
351 /*highaddr*/BUS_SPACE_MAXADDR,
352 /*filter*/NULL, /*filterarg*/NULL,
356 /*flags*/BUS_DMA_ALLOCNOW,
357 #if defined(__FreeBSD__) && __FreeBSD_version >= 501102
358 /*lockfunc*/busdma_lock_mutex,
363 printf("fwohci_pci_attach: Could not allocate DMA tag "
364 "- error %d\n", err);
368 err = fwohci_init(sc, self);
371 device_printf(self, "fwohci_init failed with err=%d\n", err);
372 fwohci_pci_detach(self);
376 /* probe and attach a child device(firewire) */
377 bus_generic_probe(self);
378 bus_generic_attach(self);
384 fwohci_pci_detach(device_t self)
386 fwohci_softc_t *sc = device_get_softc(self);
393 fwohci_stop(sc, self);
395 bus_generic_detach(self);
397 device_delete_child(self, sc->fc.bdev);
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);
407 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
409 /* XXX or should we panic? */
410 device_printf(self, "Could not tear down irq, %d\n",
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);
420 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
425 bus_release_resource(self, SYS_RES_MEMORY,PCI_CBMEM,sc->bsr);
431 fwohci_detach(sc, self);
438 fwohci_pci_suspend(device_t dev)
440 fwohci_softc_t *sc = device_get_softc(dev);
443 device_printf(dev, "fwohci_pci_suspend\n");
444 err = bus_generic_suspend(dev);
447 fwohci_stop(sc, dev);
452 fwohci_pci_resume(device_t dev)
454 fwohci_softc_t *sc = device_get_softc(dev);
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);
461 fwohci_pci_init(dev);
462 fwohci_resume(sc, dev);
467 fwohci_pci_shutdown(device_t dev)
469 fwohci_softc_t *sc = device_get_softc(dev);
471 bus_generic_shutdown(dev);
472 fwohci_stop(sc, dev);
477 fwohci_pci_add_child(device_t dev, int order, const char *name, int unit)
479 struct fwohci_softc *sc;
483 sc = (struct fwohci_softc *)device_get_softc(dev);
484 child = device_add_child(dev, name, unit);
489 device_set_ivars(child, (void *)&sc->fc);
491 err = device_probe_and_attach(child);
493 device_printf(dev, "probe_and_attach failed with err=%d\n",
495 fwohci_pci_detach(dev);
496 device_delete_child(dev, child);
501 * Clear the bus reset event flag to start transactions even when
502 * interrupt is disabled during the boot process.
504 DELAY(250); /* 2 cycles */
506 fwohci_poll((void *)sc, 0, -1);
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),
522 DEVMETHOD(bus_add_child, fwohci_pci_add_child),
523 DEVMETHOD(bus_print_child, bus_generic_print_child),
528 static driver_t fwohci_driver = {
531 sizeof(fwohci_softc_t),
534 static devclass_t fwohci_devclass;
537 MODULE_DEPEND(fwohci, firewire, 1, 1, 1);
539 DRIVER_MODULE(fwohci, pci, fwohci_driver, fwohci_devclass, 0, 0);
540 DRIVER_MODULE(fwohci, cardbus, fwohci_driver, fwohci_devclass, 0, 0);