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