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