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