xref: /freebsd/sys/dev/firewire/firewire.c (revision c6db8143eda5c775467145ac73e8ebec47afdd8f)
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 
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/types.h>
41 
42 #include <sys/jail.h>
43 #include <sys/kernel.h>
44 #include <sys/module.h>
45 #include <sys/malloc.h>
46 #include <sys/conf.h>
47 #include <sys/sysctl.h>
48 #include <sys/kthread.h>
49 
50 #include <sys/kdb.h>
51 #include <sys/bus.h>		/* used by smbus and newbus */
52 #include <machine/bus.h>
53 
54 #include <dev/firewire/firewire.h>
55 #include <dev/firewire/firewirereg.h>
56 #include <dev/firewire/fwmem.h>
57 #include <dev/firewire/iec13213.h>
58 #include <dev/firewire/iec68113.h>
59 
60 struct crom_src_buf {
61 	struct crom_src	src;
62 	struct crom_chunk root;
63 	struct crom_chunk vendor;
64 	struct crom_chunk hw;
65 };
66 
67 int firewire_debug = 0, try_bmr = 1, hold_count = 0;
68 SYSCTL_INT(_debug, OID_AUTO, firewire_debug, CTLFLAG_RW, &firewire_debug, 0,
69 	"FireWire driver debug flag");
70 SYSCTL_NODE(_hw, OID_AUTO, firewire, CTLFLAG_RD, 0, "FireWire Subsystem");
71 SYSCTL_INT(_hw_firewire, OID_AUTO, try_bmr, CTLFLAG_RW, &try_bmr, 0,
72 	"Try to be a bus manager");
73 SYSCTL_INT(_hw_firewire, OID_AUTO, hold_count, CTLFLAG_RW, &hold_count, 0,
74 	"Number of count of bus resets for removing lost device information");
75 
76 MALLOC_DEFINE(M_FW, "firewire", "FireWire");
77 MALLOC_DEFINE(M_FWXFER, "fw_xfer", "XFER/FireWire");
78 
79 #define FW_MAXASYRTY 4
80 
81 devclass_t firewire_devclass;
82 
83 static void firewire_identify(driver_t *, device_t);
84 static int firewire_probe(device_t);
85 static int firewire_attach(device_t);
86 static int firewire_detach(device_t);
87 static int firewire_resume(device_t);
88 static void firewire_xfer_timeout(void *, int);
89 static device_t firewire_add_child(device_t, u_int, const char *, int);
90 static void fw_try_bmr(void *);
91 static void fw_try_bmr_callback(struct fw_xfer *);
92 static void fw_asystart(struct fw_xfer *);
93 static int fw_get_tlabel(struct firewire_comm *, struct fw_xfer *);
94 static void fw_bus_probe(void *);
95 static void fw_attach_dev(struct firewire_comm *);
96 static void fw_bus_probe_thread(void *);
97 #ifdef FW_VMACCESS
98 static void fw_vmaccess (struct fw_xfer *);
99 #endif
100 static int fw_bmr (struct firewire_comm *);
101 static void fw_dump_hdr(struct fw_pkt *, char *);
102 
103 static device_method_t firewire_methods[] = {
104 	/* Device interface */
105 	DEVMETHOD(device_identify,	firewire_identify),
106 	DEVMETHOD(device_probe,		firewire_probe),
107 	DEVMETHOD(device_attach,	firewire_attach),
108 	DEVMETHOD(device_detach,	firewire_detach),
109 	DEVMETHOD(device_suspend,	bus_generic_suspend),
110 	DEVMETHOD(device_resume,	firewire_resume),
111 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
112 
113 	/* Bus interface */
114 	DEVMETHOD(bus_add_child,	firewire_add_child),
115 
116 	DEVMETHOD_END
117 };
118 
119 char *linkspeed[] = {
120 	"S100", "S200", "S400", "S800",
121 	"S1600", "S3200", "undef", "undef"
122 };
123 
124 static char *tcode_str[] = {
125 	"WREQQ", "WREQB", "WRES",   "undef",
126 	"RREQQ", "RREQB", "RRESQ",  "RRESB",
127 	"CYCS",  "LREQ",  "STREAM", "LRES",
128 	"undef", "undef", "PHY",    "undef"
129 };
130 
131 /* IEEE-1394a Table C-2 Gap count as a function of hops*/
132 #define MAX_GAPHOP 15
133 u_int gap_cnt[] = { 5,  5,  7,  8, 10, 13, 16, 18,
134 		   21, 24, 26, 29, 32, 35, 37, 40};
135 
136 static driver_t firewire_driver = {
137 	"firewire",
138 	firewire_methods,
139 	sizeof(struct firewire_softc),
140 };
141 
142 /*
143  * Lookup fwdev by node id.
144  */
145 struct fw_device *
146 fw_noderesolve_nodeid(struct firewire_comm *fc, int dst)
147 {
148 	struct fw_device *fwdev;
149 	int s;
150 
151 	s = splfw();
152 	STAILQ_FOREACH(fwdev, &fc->devices, link)
153 		if (fwdev->dst == dst && fwdev->status != FWDEVINVAL)
154 			break;
155 	splx(s);
156 
157 	return fwdev;
158 }
159 
160 /*
161  * Lookup fwdev by EUI64.
162  */
163 struct fw_device *
164 fw_noderesolve_eui64(struct firewire_comm *fc, struct fw_eui64 *eui)
165 {
166 	struct fw_device *fwdev;
167 	int s;
168 
169 	s = splfw();
170 	FW_GLOCK(fc);
171 	STAILQ_FOREACH(fwdev, &fc->devices, link)
172 		if (FW_EUI64_EQUAL(fwdev->eui, *eui))
173 			break;
174 	FW_GUNLOCK(fc);
175 	splx(s);
176 
177 	if (fwdev == NULL)
178 		return NULL;
179 	if (fwdev->status == FWDEVINVAL)
180 		return NULL;
181 	return fwdev;
182 }
183 
184 /*
185  * Async. request procedure for userland application.
186  */
187 int
188 fw_asyreq(struct firewire_comm *fc, int sub, struct fw_xfer *xfer)
189 {
190 	int err = 0;
191 	struct fw_xferq *xferq;
192 	int len;
193 	struct fw_pkt *fp;
194 	int tcode;
195 	struct tcode_info *info;
196 
197 	if (xfer == NULL)
198 		return EINVAL;
199 	if (xfer->hand == NULL) {
200 		printf("hand == NULL\n");
201 		return EINVAL;
202 	}
203 	fp = &xfer->send.hdr;
204 
205 	tcode = fp->mode.common.tcode & 0xf;
206 	info = &fc->tcode[tcode];
207 	if (info->flag == 0) {
208 		printf("invalid tcode=%x\n", tcode);
209 		return EINVAL;
210 	}
211 
212 	/* XXX allow bus explore packets only after bus rest */
213 	if ((fc->status < FWBUSEXPLORE) &&
214 	    ((tcode != FWTCODE_RREQQ) || (fp->mode.rreqq.dest_hi != 0xffff) ||
215 	    (fp->mode.rreqq.dest_lo  < 0xf0000000) ||
216 	    (fp->mode.rreqq.dest_lo >= 0xf0001000))) {
217 		xfer->resp = EAGAIN;
218 		xfer->flag = FWXF_BUSY;
219 		return (EAGAIN);
220 	}
221 
222 	if (info->flag & FWTI_REQ)
223 		xferq = fc->atq;
224 	else
225 		xferq = fc->ats;
226 	len = info->hdr_len;
227 	if (xfer->send.pay_len > MAXREC(fc->maxrec)) {
228 		printf("send.pay_len > maxrec\n");
229 		return EINVAL;
230 	}
231 	if (info->flag & FWTI_BLOCK_STR)
232 		len = fp->mode.stream.len;
233 	else if (info->flag & FWTI_BLOCK_ASY)
234 		len = fp->mode.rresb.len;
235 	else
236 		len = 0;
237 	if (len != xfer->send.pay_len) {
238 		printf("len(%d) != send.pay_len(%d) %s(%x)\n",
239 		    len, xfer->send.pay_len, tcode_str[tcode], tcode);
240 		return EINVAL;
241 	}
242 
243 	if (xferq->start == NULL) {
244 		printf("xferq->start == NULL\n");
245 		return EINVAL;
246 	}
247 	if (!(xferq->queued < xferq->maxq)) {
248 		device_printf(fc->bdev, "Discard a packet (queued=%d)\n",
249 			xferq->queued);
250 		return EAGAIN;
251 	}
252 
253 	xfer->tl = -1;
254 	if (info->flag & FWTI_TLABEL) {
255 		if (fw_get_tlabel(fc, xfer) < 0)
256 			return EAGAIN;
257 	}
258 
259 	xfer->resp = 0;
260 	xfer->fc = fc;
261 	xfer->q = xferq;
262 
263 	fw_asystart(xfer);
264 	return err;
265 }
266 
267 /*
268  * Wakeup blocked process.
269  */
270 void
271 fw_xferwake(struct fw_xfer *xfer)
272 {
273 	struct mtx *lock = &xfer->fc->wait_lock;
274 
275 	mtx_lock(lock);
276 	xfer->flag |= FWXF_WAKE;
277 	mtx_unlock(lock);
278 
279 	wakeup(xfer);
280 	return;
281 }
282 
283 int
284 fw_xferwait(struct fw_xfer *xfer)
285 {
286 	struct mtx *lock = &xfer->fc->wait_lock;
287 	int err = 0;
288 
289 	mtx_lock(lock);
290 	while ((xfer->flag & FWXF_WAKE) == 0)
291 		err = msleep(xfer, lock, PWAIT|PCATCH, "fw_xferwait", 0);
292 	mtx_unlock(lock);
293 
294 	return (err);
295 }
296 
297 /*
298  * Async. request with given xfer structure.
299  */
300 static void
301 fw_asystart(struct fw_xfer *xfer)
302 {
303 	struct firewire_comm *fc = xfer->fc;
304 	int s;
305 
306 	s = splfw();
307 	/* Protect from interrupt/timeout */
308 	FW_GLOCK(fc);
309 	xfer->flag = FWXF_INQ;
310 	STAILQ_INSERT_TAIL(&xfer->q->q, xfer, link);
311 #if 0
312 	xfer->q->queued++;
313 #endif
314 	FW_GUNLOCK(fc);
315 	splx(s);
316 	/* XXX just queue for mbuf */
317 	if (xfer->mbuf == NULL)
318 		xfer->q->start(fc);
319 	return;
320 }
321 
322 static void
323 firewire_identify(driver_t *driver, device_t parent)
324 {
325 	BUS_ADD_CHILD(parent, 0, "firewire", -1);
326 }
327 
328 static int
329 firewire_probe(device_t dev)
330 {
331 	device_set_desc(dev, "IEEE1394(FireWire) bus");
332 	return (0);
333 }
334 
335 static void
336 firewire_xfer_timeout(void *arg, int pending)
337 {
338 	struct firewire_comm *fc = (struct firewire_comm *)arg;
339 	struct fw_xfer *xfer, *txfer;
340 	struct timeval tv;
341 	struct timeval split_timeout;
342 	STAILQ_HEAD(, fw_xfer) xfer_timeout;
343 	int i, s;
344 
345 	split_timeout.tv_sec = 0;
346 	split_timeout.tv_usec = 200 * 1000;	 /* 200 msec */
347 
348 	microtime(&tv);
349 	timevalsub(&tv, &split_timeout);
350 	STAILQ_INIT(&xfer_timeout);
351 
352 	s = splfw();
353 	mtx_lock(&fc->tlabel_lock);
354 	for (i = 0; i < 0x40; i++) {
355 		while ((xfer = STAILQ_FIRST(&fc->tlabels[i])) != NULL) {
356 			if ((xfer->flag & FWXF_SENT) == 0)
357 				/* not sent yet */
358 				break;
359 			if (timevalcmp(&xfer->tv, &tv, >))
360 				/* the rests are newer than this */
361 				break;
362 			device_printf(fc->bdev,
363 			    "split transaction timeout: tl=0x%x flag=0x%02x\n",
364 			    i, xfer->flag);
365 			fw_dump_hdr(&xfer->send.hdr, "send");
366 			xfer->resp = ETIMEDOUT;
367 			xfer->tl = -1;
368 			STAILQ_REMOVE_HEAD(&fc->tlabels[i], tlabel);
369 			STAILQ_INSERT_TAIL(&xfer_timeout, xfer, tlabel);
370 		}
371 	}
372 	mtx_unlock(&fc->tlabel_lock);
373 	splx(s);
374 	fc->timeout(fc);
375 
376 	STAILQ_FOREACH_SAFE(xfer, &xfer_timeout, tlabel, txfer)
377 		xfer->hand(xfer);
378 }
379 
380 #define WATCHDOG_HZ 10
381 static void
382 firewire_watchdog(void *arg)
383 {
384 	struct firewire_comm *fc;
385 	static int watchdog_clock = 0;
386 
387 	fc = arg;
388 
389 	/*
390 	 * At boot stage, the device interrupt is disabled and
391 	 * We encounter a timeout easily. To avoid this,
392 	 * ignore clock interrupt for a while.
393 	 */
394 	if (watchdog_clock > WATCHDOG_HZ * 15)
395 		taskqueue_enqueue(fc->taskqueue, &fc->task_timeout);
396 	else
397 		watchdog_clock++;
398 
399 	callout_reset(&fc->timeout_callout, hz / WATCHDOG_HZ,
400 	    firewire_watchdog, fc);
401 }
402 
403 /*
404  * The attach routine.
405  */
406 static int
407 firewire_attach(device_t dev)
408 {
409 	int unit;
410 	struct firewire_softc *sc = device_get_softc(dev);
411 	device_t pa = device_get_parent(dev);
412 	struct firewire_comm *fc;
413 
414 	fc = device_get_softc(pa);
415 	sc->fc = fc;
416 	fc->status = FWBUSNOTREADY;
417 
418 	unit = device_get_unit(dev);
419 	if (fc->nisodma > FWMAXNDMA)
420 		fc->nisodma = FWMAXNDMA;
421 
422 	fwdev_makedev(sc);
423 
424 	fc->crom_src_buf = malloc(sizeof(struct crom_src_buf),
425 	    M_FW, M_NOWAIT | M_ZERO);
426 	if (fc->crom_src_buf == NULL) {
427 		device_printf(fc->dev,
428 		    "%s: unable to allocate crom src buffer\n", __func__);
429 		return ENOMEM;
430 	}
431 	fc->topology_map = malloc(sizeof(struct fw_topology_map),
432 	    M_FW, M_NOWAIT | M_ZERO);
433 	if (fc->topology_map == NULL) {
434 		device_printf(fc->dev, "%s: unable to allocate topology map\n",
435 		    __func__);
436 		free(fc->crom_src_buf, M_FW);
437 		return ENOMEM;
438 	}
439 	fc->speed_map = malloc(sizeof(struct fw_speed_map),
440 	    M_FW, M_NOWAIT | M_ZERO);
441 	if (fc->speed_map == NULL) {
442 		device_printf(fc->dev, "%s: unable to allocate speed map\n",
443 		    __func__);
444 		free(fc->crom_src_buf, M_FW);
445 		free(fc->topology_map, M_FW);
446 		return ENOMEM;
447 	}
448 
449 	mtx_init(&fc->wait_lock, "fwwait", NULL, MTX_DEF);
450 	mtx_init(&fc->tlabel_lock, "fwtlabel", NULL, MTX_DEF);
451 	CALLOUT_INIT(&fc->timeout_callout);
452 	CALLOUT_INIT(&fc->bmr_callout);
453 	CALLOUT_INIT(&fc->busprobe_callout);
454 	TASK_INIT(&fc->task_timeout, 0, firewire_xfer_timeout, fc);
455 
456 	callout_reset(&sc->fc->timeout_callout, hz,
457 	    firewire_watchdog, sc->fc);
458 
459 	/* create thread */
460 	kproc_create(fw_bus_probe_thread, fc, &fc->probe_thread,
461 	    0, 0, "fw%d_probe", unit);
462 
463 	/* Locate our children */
464 	bus_generic_probe(dev);
465 
466 	/* launch attachement of the added children */
467 	bus_generic_attach(dev);
468 
469 	/* bus_reset */
470 	FW_GLOCK(fc);
471 	fw_busreset(fc, FWBUSNOTREADY);
472 	FW_GUNLOCK(fc);
473 	fc->ibr(fc);
474 
475 	return 0;
476 }
477 
478 /*
479  * Attach it as child.
480  */
481 static device_t
482 firewire_add_child(device_t dev, u_int order, const char *name, int unit)
483 {
484 	device_t child;
485 	struct firewire_softc *sc;
486 
487 	sc = device_get_softc(dev);
488 	child = device_add_child(dev, name, unit);
489 	if (child) {
490 		device_set_ivars(child, sc->fc);
491 		device_probe_and_attach(child);
492 	}
493 
494 	return child;
495 }
496 
497 static int
498 firewire_resume(device_t dev)
499 {
500 	struct firewire_softc *sc;
501 
502 	sc = device_get_softc(dev);
503 	sc->fc->status = FWBUSNOTREADY;
504 
505 	bus_generic_resume(dev);
506 
507 	return (0);
508 }
509 
510 /*
511  * Detach it.
512  */
513 static int
514 firewire_detach(device_t dev)
515 {
516 	struct firewire_softc *sc;
517 	struct firewire_comm *fc;
518 	struct fw_device *fwdev, *fwdev_next;
519 	int err;
520 
521 	sc = device_get_softc(dev);
522 	fc = sc->fc;
523 	mtx_lock(&fc->wait_lock);
524 	fc->status = FWBUSDETACH;
525 	wakeup(fc);
526 	if (msleep(fc->probe_thread, &fc->wait_lock, PWAIT, "fwthr", hz * 60))
527 		printf("firewire probe thread didn't die\n");
528 	mtx_unlock(&fc->wait_lock);
529 
530 	if (fc->arq != 0 && fc->arq->maxq > 0)
531 		fw_drain_txq(fc);
532 
533 	if ((err = fwdev_destroydev(sc)) != 0)
534 		return err;
535 
536 	if ((err = bus_generic_detach(dev)) != 0)
537 		return err;
538 
539 	callout_stop(&fc->timeout_callout);
540 	callout_stop(&fc->bmr_callout);
541 	callout_stop(&fc->busprobe_callout);
542 
543 	/* XXX xfer_free and untimeout on all xfers */
544 	for (fwdev = STAILQ_FIRST(&fc->devices); fwdev != NULL;
545 	     fwdev = fwdev_next) {
546 		fwdev_next = STAILQ_NEXT(fwdev, link);
547 		free(fwdev, M_FW);
548 	}
549 	free(fc->topology_map, M_FW);
550 	free(fc->speed_map, M_FW);
551 	free(fc->crom_src_buf, M_FW);
552 
553 	mtx_destroy(&fc->tlabel_lock);
554 	mtx_destroy(&fc->wait_lock);
555 	return (0);
556 }
557 
558 static void
559 fw_xferq_drain(struct fw_xferq *xferq)
560 {
561 	struct fw_xfer *xfer;
562 
563 	while ((xfer = STAILQ_FIRST(&xferq->q)) != NULL) {
564 		STAILQ_REMOVE_HEAD(&xferq->q, link);
565 #if 0
566 		xferq->queued--;
567 #endif
568 		xfer->resp = EAGAIN;
569 		xfer->flag = FWXF_SENTERR;
570 		fw_xfer_done(xfer);
571 	}
572 }
573 
574 void
575 fw_drain_txq(struct firewire_comm *fc)
576 {
577 	struct fw_xfer *xfer, *txfer;
578 	STAILQ_HEAD(, fw_xfer) xfer_drain;
579 	int i;
580 
581 	STAILQ_INIT(&xfer_drain);
582 
583 	FW_GLOCK(fc);
584 	fw_xferq_drain(fc->atq);
585 	fw_xferq_drain(fc->ats);
586 	for (i = 0; i < fc->nisodma; i++)
587 		fw_xferq_drain(fc->it[i]);
588 	FW_GUNLOCK(fc);
589 
590 	mtx_lock(&fc->tlabel_lock);
591 	for (i = 0; i < 0x40; i++)
592 		while ((xfer = STAILQ_FIRST(&fc->tlabels[i])) != NULL) {
593 			if (firewire_debug)
594 				printf("tl=%d flag=%d\n", i, xfer->flag);
595 			xfer->tl = -1;
596 			xfer->resp = EAGAIN;
597 			STAILQ_REMOVE_HEAD(&fc->tlabels[i], tlabel);
598 			STAILQ_INSERT_TAIL(&xfer_drain, xfer, tlabel);
599 		}
600 	mtx_unlock(&fc->tlabel_lock);
601 
602 	STAILQ_FOREACH_SAFE(xfer, &xfer_drain, tlabel, txfer)
603 		xfer->hand(xfer);
604 }
605 
606 static void
607 fw_reset_csr(struct firewire_comm *fc)
608 {
609 	int i;
610 
611 	CSRARC(fc, STATE_CLEAR)
612 			= 1 << 23 | 0 << 17 | 1 << 16 | 1 << 15 | 1 << 14;
613 	CSRARC(fc, STATE_SET) = CSRARC(fc, STATE_CLEAR);
614 	CSRARC(fc, NODE_IDS) = 0x3f;
615 
616 	CSRARC(fc, TOPO_MAP + 8) = 0;
617 	fc->irm = -1;
618 
619 	fc->max_node = -1;
620 
621 	for (i = 2; i < 0x100 / 4 - 2; i++) {
622 		CSRARC(fc, SPED_MAP + i * 4) = 0;
623 	}
624 	CSRARC(fc, STATE_CLEAR) = 1 << 23 | 0 << 17 | 1 << 16 | 1 << 15 | 1 << 14;
625 	CSRARC(fc, STATE_SET) = CSRARC(fc, STATE_CLEAR);
626 	CSRARC(fc, RESET_START) = 0;
627 	CSRARC(fc, SPLIT_TIMEOUT_HI) = 0;
628 	CSRARC(fc, SPLIT_TIMEOUT_LO) = 800 << 19;
629 	CSRARC(fc, CYCLE_TIME) = 0x0;
630 	CSRARC(fc, BUS_TIME) = 0x0;
631 	CSRARC(fc, BUS_MGR_ID) = 0x3f;
632 	CSRARC(fc, BANDWIDTH_AV) = 4915;
633 	CSRARC(fc, CHANNELS_AV_HI) = 0xffffffff;
634 	CSRARC(fc, CHANNELS_AV_LO) = 0xffffffff;
635 	CSRARC(fc, IP_CHANNELS) = (1U << 31);
636 
637 	CSRARC(fc, CONF_ROM) = 0x04 << 24;
638 	CSRARC(fc, CONF_ROM + 4) = 0x31333934; /* means strings 1394 */
639 	CSRARC(fc, CONF_ROM + 8) = 1 << 31 | 1 << 30 | 1 << 29 |
640 	    1 << 28 | 0xff << 16 | 0x09 << 8;
641 	CSRARC(fc, CONF_ROM + 0xc) = 0;
642 
643 	/* DV depend CSRs see blue book */
644 	CSRARC(fc, oPCR) &= ~DV_BROADCAST_ON;
645 	CSRARC(fc, iPCR) &= ~DV_BROADCAST_ON;
646 
647 	CSRARC(fc, STATE_CLEAR) &= ~(1 << 23 | 1 << 15 | 1 << 14);
648 	CSRARC(fc, STATE_SET) = CSRARC(fc, STATE_CLEAR);
649 }
650 
651 static void
652 fw_init_crom(struct firewire_comm *fc)
653 {
654 	struct crom_src *src;
655 
656 	src = &fc->crom_src_buf->src;
657 	bzero(src, sizeof(struct crom_src));
658 
659 	/* BUS info sample */
660 	src->hdr.info_len = 4;
661 
662 	src->businfo.bus_name = CSR_BUS_NAME_IEEE1394;
663 
664 	src->businfo.irmc = 1;
665 	src->businfo.cmc = 1;
666 	src->businfo.isc = 1;
667 	src->businfo.bmc = 1;
668 	src->businfo.pmc = 0;
669 	src->businfo.cyc_clk_acc = 100;
670 	src->businfo.max_rec = fc->maxrec;
671 	src->businfo.max_rom = MAXROM_4;
672 #define FW_GENERATION_CHANGEABLE 2
673 	src->businfo.generation = FW_GENERATION_CHANGEABLE;
674 	src->businfo.link_spd = fc->speed;
675 
676 	src->businfo.eui64.hi = fc->eui.hi;
677 	src->businfo.eui64.lo = fc->eui.lo;
678 
679 	STAILQ_INIT(&src->chunk_list);
680 
681 	fc->crom_src = src;
682 	fc->crom_root = &fc->crom_src_buf->root;
683 }
684 
685 static void
686 fw_reset_crom(struct firewire_comm *fc)
687 {
688 	struct crom_src_buf *buf;
689 	struct crom_src *src;
690 	struct crom_chunk *root;
691 
692 	buf =  fc->crom_src_buf;
693 	src = fc->crom_src;
694 	root = fc->crom_root;
695 
696 	STAILQ_INIT(&src->chunk_list);
697 
698 	bzero(root, sizeof(struct crom_chunk));
699 	crom_add_chunk(src, NULL, root, 0);
700 	crom_add_entry(root, CSRKEY_NCAP, 0x0083c0); /* XXX */
701 	/* private company_id */
702 	crom_add_entry(root, CSRKEY_VENDOR, CSRVAL_VENDOR_PRIVATE);
703 	crom_add_simple_text(src, root, &buf->vendor, "FreeBSD Project");
704 	crom_add_entry(root, CSRKEY_HW, __FreeBSD_version);
705 	mtx_lock(&prison0.pr_mtx);
706 	crom_add_simple_text(src, root, &buf->hw, prison0.pr_hostname);
707 	mtx_unlock(&prison0.pr_mtx);
708 }
709 
710 /*
711  * Called after bus reset.
712  */
713 void
714 fw_busreset(struct firewire_comm *fc, uint32_t new_status)
715 {
716 	struct firewire_dev_comm *fdc;
717 	struct crom_src *src;
718 	device_t *devlistp;
719 	uint32_t *newrom;
720 	int i, devcnt;
721 
722 	FW_GLOCK_ASSERT(fc);
723 	if (fc->status == FWBUSMGRELECT)
724 		callout_stop(&fc->bmr_callout);
725 
726 	fc->status = new_status;
727 	fw_reset_csr(fc);
728 
729 	if (fc->status == FWBUSNOTREADY)
730 		fw_init_crom(fc);
731 
732 	fw_reset_crom(fc);
733 
734 	if (device_get_children(fc->bdev, &devlistp, &devcnt) == 0) {
735 		for (i = 0; i < devcnt; i++)
736 			if (device_get_state(devlistp[i]) >= DS_ATTACHED) {
737 				fdc = device_get_softc(devlistp[i]);
738 				if (fdc->post_busreset != NULL)
739 					fdc->post_busreset(fdc);
740 			}
741 		free(devlistp, M_TEMP);
742 	}
743 
744 	src = &fc->crom_src_buf->src;
745 	/*
746 	 * If the old config rom needs to be overwritten,
747 	 * bump the businfo.generation indicator to
748 	 * indicate that we need to be reprobed
749 	 * See 1394a-2000 8.3.2.5.4 for more details.
750 	 * generation starts at 2 and rolls over at 0xF
751 	 * back to 2.
752 	 *
753 	 * A generation of 0 indicates a device
754 	 * that is not 1394a-2000 compliant.
755 	 * A generation of 1 indicates a device that
756 	 * does not change it's Bus Info Block or
757 	 * Configuration ROM.
758 	 */
759 #define FW_MAX_GENERATION 0xF
760 	newrom = malloc(CROMSIZE, M_FW, M_NOWAIT | M_ZERO);
761 	src = &fc->crom_src_buf->src;
762 	crom_load(src, newrom, CROMSIZE);
763 	if (bcmp(newrom, fc->config_rom, CROMSIZE) != 0) {
764 		if (src->businfo.generation++ > FW_MAX_GENERATION)
765 			src->businfo.generation = FW_GENERATION_CHANGEABLE;
766 		bcopy(newrom, fc->config_rom, CROMSIZE);
767 	}
768 	free(newrom, M_FW);
769 }
770 
771 /* Call once after reboot */
772 void fw_init(struct firewire_comm *fc)
773 {
774 	int i;
775 #ifdef FW_VMACCESS
776 	struct fw_xfer *xfer;
777 	struct fw_bind *fwb;
778 #endif
779 
780 	fc->arq->queued = 0;
781 	fc->ars->queued = 0;
782 	fc->atq->queued = 0;
783 	fc->ats->queued = 0;
784 
785 	fc->arq->buf = NULL;
786 	fc->ars->buf = NULL;
787 	fc->atq->buf = NULL;
788 	fc->ats->buf = NULL;
789 
790 	fc->arq->flag = 0;
791 	fc->ars->flag = 0;
792 	fc->atq->flag = 0;
793 	fc->ats->flag = 0;
794 
795 	STAILQ_INIT(&fc->atq->q);
796 	STAILQ_INIT(&fc->ats->q);
797 
798 	for (i = 0; i < fc->nisodma; i++) {
799 		fc->it[i]->queued = 0;
800 		fc->ir[i]->queued = 0;
801 
802 		fc->it[i]->start = NULL;
803 		fc->ir[i]->start = NULL;
804 
805 		fc->it[i]->buf = NULL;
806 		fc->ir[i]->buf = NULL;
807 
808 		fc->it[i]->flag = FWXFERQ_STREAM;
809 		fc->ir[i]->flag = FWXFERQ_STREAM;
810 
811 		STAILQ_INIT(&fc->it[i]->q);
812 		STAILQ_INIT(&fc->ir[i]->q);
813 	}
814 
815 	fc->arq->maxq = FWMAXQUEUE;
816 	fc->ars->maxq = FWMAXQUEUE;
817 	fc->atq->maxq = FWMAXQUEUE;
818 	fc->ats->maxq = FWMAXQUEUE;
819 
820 	for (i = 0; i < fc->nisodma; i++) {
821 		fc->ir[i]->maxq = FWMAXQUEUE;
822 		fc->it[i]->maxq = FWMAXQUEUE;
823 	}
824 
825 	CSRARC(fc, TOPO_MAP) = 0x3f1 << 16;
826 	CSRARC(fc, TOPO_MAP + 4) = 1;
827 	CSRARC(fc, SPED_MAP) = 0x3f1 << 16;
828 	CSRARC(fc, SPED_MAP + 4) = 1;
829 
830 	STAILQ_INIT(&fc->devices);
831 
832 	/* Initialize Async handlers */
833 	STAILQ_INIT(&fc->binds);
834 	for (i = 0; i < 0x40; i++) {
835 		STAILQ_INIT(&fc->tlabels[i]);
836 	}
837 
838 /* DV depend CSRs see blue book */
839 #if 0
840 	CSRARC(fc, oMPR) = 0x3fff0001; /* # output channel = 1 */
841 	CSRARC(fc, oPCR) = 0x8000007a;
842 	for (i = 4; i < 0x7c/4; i += 4) {
843 		CSRARC(fc, i + oPCR) = 0x8000007a;
844 	}
845 
846 	CSRARC(fc, iMPR) = 0x00ff0001; /* # input channel = 1 */
847 	CSRARC(fc, iPCR) = 0x803f0000;
848 	for (i = 4; i < 0x7c/4; i += 4) {
849 		CSRARC(fc, i + iPCR) = 0x0;
850 	}
851 #endif
852 
853 	fc->crom_src_buf = NULL;
854 
855 #ifdef FW_VMACCESS
856 	xfer = fw_xfer_alloc();
857 	if (xfer == NULL)
858 		return;
859 
860 	fwb = malloc(sizeof(struct fw_bind), M_FW, M_NOWAIT);
861 	if (fwb == NULL) {
862 		fw_xfer_free(xfer);
863 		return;
864 	}
865 	xfer->hand = fw_vmaccess;
866 	xfer->fc = fc;
867 	xfer->sc = NULL;
868 
869 	fwb->start_hi = 0x2;
870 	fwb->start_lo = 0;
871 	fwb->addrlen = 0xffffffff;
872 	fwb->xfer = xfer;
873 	fw_bindadd(fc, fwb);
874 #endif
875 }
876 
877 #define BIND_CMP(addr, fwb) (((addr) < (fwb)->start)? -1 : \
878     ((fwb)->end < (addr)) ? 1 : 0)
879 
880 /*
881  * To lookup bound process from IEEE1394 address.
882  */
883 struct fw_bind *
884 fw_bindlookup(struct firewire_comm *fc, uint16_t dest_hi, uint32_t dest_lo)
885 {
886 	u_int64_t addr;
887 	struct fw_bind *tfw, *r = NULL;
888 
889 	addr = ((u_int64_t)dest_hi << 32) | dest_lo;
890 	FW_GLOCK(fc);
891 	STAILQ_FOREACH(tfw, &fc->binds, fclist)
892 		if (BIND_CMP(addr, tfw) == 0) {
893 			r = tfw;
894 			break;
895 		}
896 	FW_GUNLOCK(fc);
897 	return (r);
898 }
899 
900 /*
901  * To bind IEEE1394 address block to process.
902  */
903 int
904 fw_bindadd(struct firewire_comm *fc, struct fw_bind *fwb)
905 {
906 	struct fw_bind *tfw, *prev = NULL;
907 	int r = 0;
908 
909 	if (fwb->start > fwb->end) {
910 		printf("%s: invalid range\n", __func__);
911 		return EINVAL;
912 	}
913 
914 	FW_GLOCK(fc);
915 	STAILQ_FOREACH(tfw, &fc->binds, fclist) {
916 		if (fwb->end < tfw->start)
917 			break;
918 		prev = tfw;
919 	}
920 	if (prev == NULL)
921 		STAILQ_INSERT_HEAD(&fc->binds, fwb, fclist);
922 	else if (prev->end < fwb->start)
923 		STAILQ_INSERT_AFTER(&fc->binds, prev, fwb, fclist);
924 	else {
925 		printf("%s: bind failed\n", __func__);
926 		r = EBUSY;
927 	}
928 	FW_GUNLOCK(fc);
929 	return (r);
930 }
931 
932 /*
933  * To free IEEE1394 address block.
934  */
935 int
936 fw_bindremove(struct firewire_comm *fc, struct fw_bind *fwb)
937 {
938 #if 0
939 	struct fw_xfer *xfer, *next;
940 #endif
941 	struct fw_bind *tfw;
942 	int s;
943 
944 	s = splfw();
945 	FW_GLOCK(fc);
946 	STAILQ_FOREACH(tfw, &fc->binds, fclist)
947 		if (tfw == fwb) {
948 			STAILQ_REMOVE(&fc->binds, fwb, fw_bind, fclist);
949 			goto found;
950 		}
951 
952 	printf("%s: no such binding\n", __func__);
953 	FW_GUNLOCK(fc);
954 	splx(s);
955 	return (1);
956 found:
957 #if 0
958 	/* shall we do this? */
959 	for (xfer = STAILQ_FIRST(&fwb->xferlist); xfer != NULL; xfer = next) {
960 		next = STAILQ_NEXT(xfer, link);
961 		fw_xfer_free(xfer);
962 	}
963 	STAILQ_INIT(&fwb->xferlist);
964 #endif
965 	FW_GUNLOCK(fc);
966 
967 	splx(s);
968 	return 0;
969 }
970 
971 int
972 fw_xferlist_add(struct fw_xferlist *q, struct malloc_type *type,
973     int slen, int rlen, int n,
974     struct firewire_comm *fc, void *sc, void (*hand)(struct fw_xfer *))
975 {
976 	int i, s;
977 	struct fw_xfer *xfer;
978 
979 	for (i = 0; i < n; i++) {
980 		xfer = fw_xfer_alloc_buf(type, slen, rlen);
981 		if (xfer == NULL)
982 			return (i);
983 		xfer->fc = fc;
984 		xfer->sc = sc;
985 		xfer->hand = hand;
986 		s = splfw();
987 		STAILQ_INSERT_TAIL(q, xfer, link);
988 		splx(s);
989 	}
990 	return (n);
991 }
992 
993 void
994 fw_xferlist_remove(struct fw_xferlist *q)
995 {
996 	struct fw_xfer *xfer, *next;
997 
998 	for (xfer = STAILQ_FIRST(q); xfer != NULL; xfer = next) {
999 		next = STAILQ_NEXT(xfer, link);
1000 		fw_xfer_free_buf(xfer);
1001 	}
1002 	STAILQ_INIT(q);
1003 }
1004 /*
1005  * dump packet header
1006  */
1007 static void
1008 fw_dump_hdr(struct fw_pkt *fp, char *prefix)
1009 {
1010 	printf("%s: dst=0x%02x tl=0x%02x rt=%d tcode=0x%x pri=0x%x "
1011 	    "src=0x%03x\n", prefix,
1012 	    fp->mode.hdr.dst & 0x3f,
1013 	    fp->mode.hdr.tlrt >> 2, fp->mode.hdr.tlrt & 3,
1014 	    fp->mode.hdr.tcode, fp->mode.hdr.pri,
1015 	    fp->mode.hdr.src);
1016 }
1017 
1018 /*
1019  * To free transaction label.
1020  */
1021 static void
1022 fw_tl_free(struct firewire_comm *fc, struct fw_xfer *xfer)
1023 {
1024 	struct fw_xfer *txfer;
1025 	int s;
1026 
1027 	s = splfw();
1028 	mtx_lock(&fc->tlabel_lock);
1029 	if (xfer->tl < 0) {
1030 		mtx_unlock(&fc->tlabel_lock);
1031 		return;
1032 	}
1033 	/* make sure the label is allocated */
1034 	STAILQ_FOREACH(txfer, &fc->tlabels[xfer->tl], tlabel)
1035 		if (txfer == xfer)
1036 			break;
1037 	if (txfer == NULL) {
1038 		printf("%s: the xfer is not in the queue "
1039 		    "(tlabel=%d, flag=0x%x)\n",
1040 		    __FUNCTION__, xfer->tl, xfer->flag);
1041 		fw_dump_hdr(&xfer->send.hdr, "send");
1042 		fw_dump_hdr(&xfer->recv.hdr, "recv");
1043 		kdb_backtrace();
1044 		mtx_unlock(&fc->tlabel_lock);
1045 		splx(s);
1046 		return;
1047 	}
1048 
1049 	STAILQ_REMOVE(&fc->tlabels[xfer->tl], xfer, fw_xfer, tlabel);
1050 	xfer->tl = -1;
1051 	mtx_unlock(&fc->tlabel_lock);
1052 	splx(s);
1053 	return;
1054 }
1055 
1056 /*
1057  * To obtain XFER structure by transaction label.
1058  */
1059 static struct fw_xfer *
1060 fw_tl2xfer(struct firewire_comm *fc, int node, int tlabel, int tcode)
1061 {
1062 	struct fw_xfer *xfer;
1063 	int s = splfw();
1064 	int req;
1065 
1066 	mtx_lock(&fc->tlabel_lock);
1067 	STAILQ_FOREACH(xfer, &fc->tlabels[tlabel], tlabel)
1068 		if (xfer->send.hdr.mode.hdr.dst == node) {
1069 			mtx_unlock(&fc->tlabel_lock);
1070 			splx(s);
1071 			KASSERT(xfer->tl == tlabel,
1072 				("xfer->tl 0x%x != 0x%x", xfer->tl, tlabel));
1073 			/* extra sanity check */
1074 			req = xfer->send.hdr.mode.hdr.tcode;
1075 			if (xfer->fc->tcode[req].valid_res != tcode) {
1076 				printf("%s: invalid response tcode "
1077 				    "(0x%x for 0x%x)\n", __FUNCTION__,
1078 				    tcode, req);
1079 				return (NULL);
1080 			}
1081 
1082 			if (firewire_debug > 2)
1083 				printf("fw_tl2xfer: found tl=%d\n", tlabel);
1084 			return (xfer);
1085 		}
1086 	mtx_unlock(&fc->tlabel_lock);
1087 	if (firewire_debug > 1)
1088 		printf("fw_tl2xfer: not found tl=%d\n", tlabel);
1089 	splx(s);
1090 	return (NULL);
1091 }
1092 
1093 /*
1094  * To allocate IEEE1394 XFER structure.
1095  */
1096 struct fw_xfer *
1097 fw_xfer_alloc(struct malloc_type *type)
1098 {
1099 	struct fw_xfer *xfer;
1100 
1101 	xfer = malloc(sizeof(struct fw_xfer), type, M_NOWAIT | M_ZERO);
1102 	if (xfer == NULL)
1103 		return xfer;
1104 
1105 	xfer->malloc = type;
1106 
1107 	return xfer;
1108 }
1109 
1110 struct fw_xfer *
1111 fw_xfer_alloc_buf(struct malloc_type *type, int send_len, int recv_len)
1112 {
1113 	struct fw_xfer *xfer;
1114 
1115 	xfer = fw_xfer_alloc(type);
1116 	if (xfer == NULL)
1117 		return (NULL);
1118 	xfer->send.pay_len = send_len;
1119 	xfer->recv.pay_len = recv_len;
1120 	if (send_len > 0) {
1121 		xfer->send.payload = malloc(send_len, type, M_NOWAIT | M_ZERO);
1122 		if (xfer->send.payload == NULL) {
1123 			fw_xfer_free(xfer);
1124 			return (NULL);
1125 		}
1126 	}
1127 	if (recv_len > 0) {
1128 		xfer->recv.payload = malloc(recv_len, type, M_NOWAIT);
1129 		if (xfer->recv.payload == NULL) {
1130 			if (xfer->send.payload != NULL)
1131 				free(xfer->send.payload, type);
1132 			fw_xfer_free(xfer);
1133 			return (NULL);
1134 		}
1135 	}
1136 	return (xfer);
1137 }
1138 
1139 /*
1140  * IEEE1394 XFER post process.
1141  */
1142 void
1143 fw_xfer_done(struct fw_xfer *xfer)
1144 {
1145 	if (xfer->hand == NULL) {
1146 		printf("hand == NULL\n");
1147 		return;
1148 	}
1149 
1150 	if (xfer->fc == NULL)
1151 		panic("fw_xfer_done: why xfer->fc is NULL?");
1152 
1153 	fw_tl_free(xfer->fc, xfer);
1154 	xfer->hand(xfer);
1155 }
1156 
1157 void
1158 fw_xfer_unload(struct fw_xfer *xfer)
1159 {
1160 	int s;
1161 
1162 	if (xfer == NULL)
1163 		return;
1164 	if (xfer->flag & FWXF_INQ) {
1165 		printf("fw_xfer_free FWXF_INQ\n");
1166 		s = splfw();
1167 		FW_GLOCK(xfer->fc);
1168 		STAILQ_REMOVE(&xfer->q->q, xfer, fw_xfer, link);
1169 #if 0
1170 		xfer->q->queued--;
1171 #endif
1172 		FW_GUNLOCK(xfer->fc);
1173 		splx(s);
1174 	}
1175 	if (xfer->fc != NULL) {
1176 		/*
1177 		 * Ensure that any tlabel owner can't access this
1178 		 * xfer after it's freed.
1179 		 */
1180 		fw_tl_free(xfer->fc, xfer);
1181 #if 1
1182 		if (xfer->flag & FWXF_START)
1183 			/*
1184 			 * This could happen if:
1185 			 *  1. We call fwohci_arcv() before fwohci_txd().
1186 			 *  2. firewire_watch() is called.
1187 			 */
1188 			printf("fw_xfer_free FWXF_START\n");
1189 #endif
1190 	}
1191 	xfer->flag = FWXF_INIT;
1192 	xfer->resp = 0;
1193 }
1194 
1195 /*
1196  * To free IEEE1394 XFER structure.
1197  */
1198 void
1199 fw_xfer_free_buf(struct fw_xfer *xfer)
1200 {
1201 	if (xfer == NULL) {
1202 		printf("%s: xfer == NULL\n", __func__);
1203 		return;
1204 	}
1205 	fw_xfer_unload(xfer);
1206 	if (xfer->send.payload != NULL)
1207 		free(xfer->send.payload, xfer->malloc);
1208 	if (xfer->recv.payload != NULL)
1209 		free(xfer->recv.payload, xfer->malloc);
1210 	free(xfer, xfer->malloc);
1211 }
1212 
1213 void
1214 fw_xfer_free(struct fw_xfer *xfer)
1215 {
1216 	if (xfer == NULL) {
1217 		printf("%s: xfer == NULL\n", __func__);
1218 		return;
1219 	}
1220 	fw_xfer_unload(xfer);
1221 	free(xfer, xfer->malloc);
1222 }
1223 
1224 void
1225 fw_asy_callback_free(struct fw_xfer *xfer)
1226 {
1227 #if 0
1228 	printf("asyreq done flag=0x%02x resp=%d\n",
1229 				xfer->flag, xfer->resp);
1230 #endif
1231 	fw_xfer_free(xfer);
1232 }
1233 
1234 /*
1235  * To configure PHY.
1236  */
1237 static void
1238 fw_phy_config(struct firewire_comm *fc, int root_node, int gap_count)
1239 {
1240 	struct fw_xfer *xfer;
1241 	struct fw_pkt *fp;
1242 
1243 	fc->status = FWBUSPHYCONF;
1244 
1245 	xfer = fw_xfer_alloc(M_FWXFER);
1246 	if (xfer == NULL)
1247 		return;
1248 	xfer->fc = fc;
1249 	xfer->hand = fw_asy_callback_free;
1250 
1251 	fp = &xfer->send.hdr;
1252 	fp->mode.ld[1] = 0;
1253 	if (root_node >= 0)
1254 		fp->mode.ld[1] |= (1 << 23) | (root_node & 0x3f) << 24;
1255 	if (gap_count >= 0)
1256 		fp->mode.ld[1] |= (1 << 22) | (gap_count & 0x3f) << 16;
1257 	fp->mode.ld[2] = ~fp->mode.ld[1];
1258 /* XXX Dangerous, how to pass PHY packet to device driver */
1259 	fp->mode.common.tcode |= FWTCODE_PHY;
1260 
1261 	if (firewire_debug)
1262 		device_printf(fc->bdev, "%s: root_node=%d gap_count=%d\n",
1263 					__func__, root_node, gap_count);
1264 	fw_asyreq(fc, -1, xfer);
1265 }
1266 
1267 /*
1268  * Dump self ID.
1269  */
1270 static void
1271 fw_print_sid(uint32_t sid)
1272 {
1273 	union fw_self_id *s;
1274 	s = (union fw_self_id *) &sid;
1275 	if (s->p0.sequel) {
1276 		if (s->p1.sequence_num == FW_SELF_ID_PAGE0) {
1277 			printf("node:%d p3:%d p4:%d p5:%d p6:%d p7:%d"
1278 			    "p8:%d p9:%d p10:%d\n",
1279 			    s->p1.phy_id, s->p1.port3, s->p1.port4,
1280 			    s->p1.port5, s->p1.port6, s->p1.port7,
1281 			    s->p1.port8, s->p1.port9, s->p1.port10);
1282 		} else if (s->p2.sequence_num == FW_SELF_ID_PAGE1) {
1283 			printf("node:%d p11:%d p12:%d p13:%d p14:%d p15:%d\n",
1284 			    s->p2.phy_id, s->p2.port11, s->p2.port12,
1285 			    s->p2.port13, s->p2.port14, s->p2.port15);
1286 		} else {
1287 			printf("node:%d Unknown Self ID Page number %d\n",
1288 			    s->p1.phy_id, s->p1.sequence_num);
1289 		}
1290 	} else {
1291 		printf("node:%d link:%d gap:%d spd:%d con:%d pwr:%d"
1292 		    " p0:%d p1:%d p2:%d i:%d m:%d\n",
1293 		    s->p0.phy_id, s->p0.link_active, s->p0.gap_count,
1294 		    s->p0.phy_speed, s->p0.contender,
1295 		    s->p0.power_class, s->p0.port0, s->p0.port1,
1296 		    s->p0.port2, s->p0.initiated_reset, s->p0.more_packets);
1297 	}
1298 }
1299 
1300 /*
1301  * To receive self ID.
1302  */
1303 void fw_sidrcv(struct firewire_comm *fc, uint32_t *sid, u_int len)
1304 {
1305 	uint32_t *p;
1306 	union fw_self_id *self_id;
1307 	u_int i, j, node, c_port = 0, i_branch = 0;
1308 
1309 	fc->sid_cnt = len / (sizeof(uint32_t) * 2);
1310 	fc->max_node = fc->nodeid & 0x3f;
1311 	CSRARC(fc, NODE_IDS) = ((uint32_t)fc->nodeid) << 16;
1312 	fc->status = FWBUSCYMELECT;
1313 	fc->topology_map->crc_len = 2;
1314 	fc->topology_map->generation++;
1315 	fc->topology_map->self_id_count = 0;
1316 	fc->topology_map->node_count= 0;
1317 	fc->speed_map->generation++;
1318 	fc->speed_map->crc_len = 1 + (64 * 64 + 3) / 4;
1319 	self_id = &fc->topology_map->self_id[0];
1320 	for (i = 0; i < fc->sid_cnt; i++) {
1321 		if (sid[1] != ~sid[0]) {
1322 			device_printf(fc->bdev,
1323 			    "%s: ERROR invalid self-id packet\n", __func__);
1324 			sid += 2;
1325 			continue;
1326 		}
1327 		*self_id = *((union fw_self_id *)sid);
1328 		fc->topology_map->crc_len++;
1329 		if (self_id->p0.sequel == 0) {
1330 			fc->topology_map->node_count++;
1331 			c_port = 0;
1332 			if (firewire_debug)
1333 				fw_print_sid(sid[0]);
1334 			node = self_id->p0.phy_id;
1335 			if (fc->max_node < node)
1336 				fc->max_node = self_id->p0.phy_id;
1337 			/* XXX I'm not sure this is the right speed_map */
1338 			fc->speed_map->speed[node][node] =
1339 			    self_id->p0.phy_speed;
1340 			for (j = 0; j < node; j++) {
1341 				fc->speed_map->speed[j][node] =
1342 				    fc->speed_map->speed[node][j] =
1343 				    min(fc->speed_map->speed[j][j],
1344 					self_id->p0.phy_speed);
1345 			}
1346 			if ((fc->irm == -1 || self_id->p0.phy_id > fc->irm) &&
1347 			  (self_id->p0.link_active && self_id->p0.contender))
1348 				fc->irm = self_id->p0.phy_id;
1349 			if (self_id->p0.port0 >= 0x2)
1350 				c_port++;
1351 			if (self_id->p0.port1 >= 0x2)
1352 				c_port++;
1353 			if (self_id->p0.port2 >= 0x2)
1354 				c_port++;
1355 		}
1356 		if (c_port > 2)
1357 			i_branch += (c_port - 2);
1358 		sid += 2;
1359 		self_id++;
1360 		fc->topology_map->self_id_count++;
1361 	}
1362 	/* CRC */
1363 	fc->topology_map->crc = fw_crc16(
1364 	    (uint32_t *)&fc->topology_map->generation,
1365 	    fc->topology_map->crc_len * 4);
1366 	fc->speed_map->crc = fw_crc16(
1367 	    (uint32_t *)&fc->speed_map->generation,
1368 	    fc->speed_map->crc_len * 4);
1369 	/* byteswap and copy to CSR */
1370 	p = (uint32_t *)fc->topology_map;
1371 	for (i = 0; i <= fc->topology_map->crc_len; i++)
1372 		CSRARC(fc, TOPO_MAP + i * 4) = htonl(*p++);
1373 	p = (uint32_t *)fc->speed_map;
1374 	CSRARC(fc, SPED_MAP) = htonl(*p++);
1375 	CSRARC(fc, SPED_MAP + 4) = htonl(*p++);
1376 	/* don't byte-swap uint8_t array */
1377 	bcopy(p, &CSRARC(fc, SPED_MAP + 8), (fc->speed_map->crc_len - 1) * 4);
1378 
1379 	fc->max_hop = fc->max_node - i_branch;
1380 	device_printf(fc->bdev, "%d nodes, maxhop <= %d %s irm(%d) %s\n",
1381 	    fc->max_node + 1, fc->max_hop,
1382 	    (fc->irm == -1) ? "Not IRM capable" : "cable IRM",
1383 	    fc->irm, (fc->irm == fc->nodeid) ? " (me) " : "");
1384 
1385 	if (try_bmr && (fc->irm != -1) && (CSRARC(fc, BUS_MGR_ID) == 0x3f)) {
1386 		if (fc->irm == fc->nodeid) {
1387 			fc->status = FWBUSMGRDONE;
1388 			CSRARC(fc, BUS_MGR_ID) = fc->set_bmr(fc, fc->irm);
1389 			fw_bmr(fc);
1390 		} else {
1391 			fc->status = FWBUSMGRELECT;
1392 			callout_reset(&fc->bmr_callout, hz / 8,
1393 			    fw_try_bmr, fc);
1394 		}
1395 	} else
1396 		fc->status = FWBUSMGRDONE;
1397 
1398 	callout_reset(&fc->busprobe_callout, hz / 4, fw_bus_probe, fc);
1399 }
1400 
1401 /*
1402  * To probe devices on the IEEE1394 bus.
1403  */
1404 static void
1405 fw_bus_probe(void *arg)
1406 {
1407 	struct firewire_comm *fc;
1408 	struct fw_device *fwdev;
1409 	int s;
1410 
1411 	s = splfw();
1412 	fc = arg;
1413 	fc->status = FWBUSEXPLORE;
1414 
1415 	/* Invalidate all devices, just after bus reset. */
1416 	if (firewire_debug)
1417 		device_printf(fc->bdev, "%s:"
1418 			"iterate and invalidate all nodes\n",
1419 			__func__);
1420 	STAILQ_FOREACH(fwdev, &fc->devices, link)
1421 		if (fwdev->status != FWDEVINVAL) {
1422 			fwdev->status = FWDEVINVAL;
1423 			fwdev->rcnt = 0;
1424 			if (firewire_debug)
1425 				device_printf(fc->bdev, "%s:"
1426 					"Invalidate Dev ID: %08x%08x\n",
1427 					__func__, fwdev->eui.hi, fwdev->eui.lo);
1428 		} else {
1429 			if (firewire_debug)
1430 				device_printf(fc->bdev, "%s:"
1431 					"Dev ID: %08x%08x already invalid\n",
1432 					__func__, fwdev->eui.hi, fwdev->eui.lo);
1433 		}
1434 	splx(s);
1435 
1436 	wakeup(fc);
1437 }
1438 
1439 static int
1440 fw_explore_read_quads(struct fw_device *fwdev, int offset,
1441     uint32_t *quad, int length)
1442 {
1443 	struct fw_xfer *xfer;
1444 	uint32_t tmp;
1445 	int i, error;
1446 
1447 	for (i = 0; i < length; i++, offset += sizeof(uint32_t)) {
1448 		xfer = fwmem_read_quad(fwdev, NULL, -1, 0xffff,
1449 		    0xf0000000 | offset, &tmp, fw_xferwake);
1450 		if (xfer == NULL)
1451 			return (-1);
1452 		fw_xferwait(xfer);
1453 
1454 		if (xfer->resp == 0)
1455 			quad[i] = ntohl(tmp);
1456 
1457 		error = xfer->resp;
1458 		fw_xfer_free(xfer);
1459 		if (error)
1460 			return (error);
1461 	}
1462 	return (0);
1463 }
1464 
1465 
1466 static int
1467 fw_explore_csrblock(struct fw_device *fwdev, int offset, int recur)
1468 {
1469 	int err, i, off;
1470 	struct csrdirectory *dir;
1471 	struct csrreg *reg;
1472 
1473 	dir = (struct csrdirectory *)&fwdev->csrrom[offset / sizeof(uint32_t)];
1474 	err = fw_explore_read_quads(fwdev, CSRROMOFF + offset,
1475 	    (uint32_t *)dir, 1);
1476 	if (err)
1477 		return (-1);
1478 
1479 	offset += sizeof(uint32_t);
1480 	reg = (struct csrreg *)&fwdev->csrrom[offset / sizeof(uint32_t)];
1481 	err = fw_explore_read_quads(fwdev, CSRROMOFF + offset,
1482 	    (uint32_t *)reg, dir->crc_len);
1483 	if (err)
1484 		return (-1);
1485 
1486 	/* XXX check CRC */
1487 
1488 	off = CSRROMOFF + offset + sizeof(uint32_t) * (dir->crc_len - 1);
1489 	if (fwdev->rommax < off)
1490 		fwdev->rommax = off;
1491 
1492 	if (recur == 0)
1493 		return (0);
1494 
1495 	for (i = 0; i < dir->crc_len; i++, offset += sizeof(uint32_t)) {
1496 		if ((reg[i].key & CSRTYPE_MASK) == CSRTYPE_D)
1497 			recur = 1;
1498 		else if ((reg[i].key & CSRTYPE_MASK) == CSRTYPE_L)
1499 			recur = 0;
1500 		else
1501 			continue;
1502 
1503 		off = offset + reg[i].val * sizeof(uint32_t);
1504 		if (off > CROMSIZE) {
1505 			printf("%s: invalid offset %d\n", __FUNCTION__, off);
1506 			return (-1);
1507 		}
1508 		err = fw_explore_csrblock(fwdev, off, recur);
1509 		if (err)
1510 			return (-1);
1511 	}
1512 	return (0);
1513 }
1514 
1515 static int
1516 fw_explore_node(struct fw_device *dfwdev)
1517 {
1518 	struct firewire_comm *fc;
1519 	struct fw_device *fwdev, *pfwdev, *tfwdev;
1520 	uint32_t *csr;
1521 	struct csrhdr *hdr;
1522 	struct bus_info *binfo;
1523 	int err, node;
1524 	uint32_t speed_test = 0;
1525 
1526 	fc = dfwdev->fc;
1527 	csr = dfwdev->csrrom;
1528 	node = dfwdev->dst;
1529 
1530 	/* First quad */
1531 	err = fw_explore_read_quads(dfwdev, CSRROMOFF, &csr[0], 1);
1532 	if (err) {
1533 		dfwdev->status = FWDEVINVAL;
1534 		return (-1);
1535 	}
1536 	hdr = (struct csrhdr *)&csr[0];
1537 	if (hdr->info_len != 4) {
1538 		if (firewire_debug)
1539 			device_printf(fc->bdev,
1540 			    "%s: node%d: wrong bus info len(%d)\n",
1541 			    __func__, node, hdr->info_len);
1542 		dfwdev->status = FWDEVINVAL;
1543 		return (-1);
1544 	}
1545 
1546 	/* bus info */
1547 	err = fw_explore_read_quads(dfwdev, CSRROMOFF + 0x04, &csr[1], 4);
1548 	if (err) {
1549 		dfwdev->status = FWDEVINVAL;
1550 		return (-1);
1551 	}
1552 	binfo = (struct bus_info *)&csr[1];
1553 	if (binfo->bus_name != CSR_BUS_NAME_IEEE1394) {
1554 		dfwdev->status = FWDEVINVAL;
1555 		return (-1);
1556 	}
1557 
1558 	if (firewire_debug)
1559 		device_printf(fc->bdev, "%s: node(%d) BUS INFO BLOCK:\n"
1560 		    "irmc(%d) cmc(%d) isc(%d) bmc(%d) pmc(%d) "
1561 		    "cyc_clk_acc(%d) max_rec(%d) max_rom(%d) "
1562 		    "generation(%d) link_spd(%d)\n",
1563 		    __func__, node,
1564 		    binfo->irmc, binfo->cmc, binfo->isc,
1565 		    binfo->bmc, binfo->pmc, binfo->cyc_clk_acc,
1566 		    binfo->max_rec, binfo->max_rom,
1567 		    binfo->generation, binfo->link_spd);
1568 
1569 	STAILQ_FOREACH(fwdev, &fc->devices, link)
1570 		if (FW_EUI64_EQUAL(fwdev->eui, binfo->eui64))
1571 			break;
1572 	if (fwdev == NULL) {
1573 		/* new device */
1574 		fwdev = malloc(sizeof(struct fw_device), M_FW,
1575 		    M_NOWAIT | M_ZERO);
1576 		if (fwdev == NULL) {
1577 			device_printf(fc->bdev, "%s: node%d: no memory\n",
1578 					__func__, node);
1579 			return (-1);
1580 		}
1581 		fwdev->fc = fc;
1582 		fwdev->eui = binfo->eui64;
1583 		fwdev->dst = dfwdev->dst;
1584 		fwdev->maxrec = dfwdev->maxrec;
1585 		fwdev->status = dfwdev->status;
1586 
1587 		/*
1588 		 * Pre-1394a-2000 didn't have link_spd in
1589 		 * the Bus Info block, so try and use the
1590 		 * speed map value.
1591 		 * 1394a-2000 compliant devices only use
1592 		 * the Bus Info Block link spd value, so
1593 		 * ignore the speed map alltogether. SWB
1594 		 */
1595 		if (binfo->link_spd == FWSPD_S100 /* 0 */) {
1596 			device_printf(fc->bdev, "%s: "
1597 			    "Pre 1394a-2000 detected\n", __func__);
1598 			fwdev->speed = fc->speed_map->speed[fc->nodeid][node];
1599 		} else
1600 			fwdev->speed = binfo->link_spd;
1601 		/*
1602 		 * Test this speed with a read to the CSRROM.
1603 		 * If it fails, slow down the speed and retry.
1604 		 */
1605 		while (fwdev->speed > FWSPD_S100 /* 0 */) {
1606 			err = fw_explore_read_quads(fwdev, CSRROMOFF,
1607 			    &speed_test, 1);
1608 			if (err) {
1609 				device_printf(fc->bdev,
1610 				    "%s: fwdev->speed(%s) decremented due to negotiation\n",
1611 				    __func__, linkspeed[fwdev->speed]);
1612 				fwdev->speed--;
1613 			} else
1614 				break;
1615 
1616 		}
1617 
1618 		/*
1619 		 * If the fwdev is not found in the
1620 		 * fc->devices TAILQ, then we will add it.
1621 		 */
1622 		pfwdev = NULL;
1623 		STAILQ_FOREACH(tfwdev, &fc->devices, link) {
1624 			if (tfwdev->eui.hi > fwdev->eui.hi ||
1625 				(tfwdev->eui.hi == fwdev->eui.hi &&
1626 				tfwdev->eui.lo > fwdev->eui.lo))
1627 				break;
1628 			pfwdev = tfwdev;
1629 		}
1630 		if (pfwdev == NULL)
1631 			STAILQ_INSERT_HEAD(&fc->devices, fwdev, link);
1632 		else
1633 			STAILQ_INSERT_AFTER(&fc->devices, pfwdev, fwdev, link);
1634 	} else {
1635 		fwdev->dst = node;
1636 		fwdev->status = FWDEVINIT;
1637 		/* unchanged ? */
1638 		if (bcmp(&csr[0], &fwdev->csrrom[0], sizeof(uint32_t) * 5) == 0) {
1639 			if (firewire_debug)
1640 				device_printf(fc->dev,
1641 				    "node%d: crom unchanged\n", node);
1642 			return (0);
1643 		}
1644 	}
1645 
1646 	bzero(&fwdev->csrrom[0], CROMSIZE);
1647 
1648 	/* copy first quad and bus info block */
1649 	bcopy(&csr[0], &fwdev->csrrom[0], sizeof(uint32_t) * 5);
1650 	fwdev->rommax = CSRROMOFF + sizeof(uint32_t) * 4;
1651 
1652 	err = fw_explore_csrblock(fwdev, 0x14, 1); /* root directory */
1653 
1654 	if (err) {
1655 		if (firewire_debug)
1656 			device_printf(fc->dev, "%s: explore csrblock failed err(%d)\n",
1657 					__func__, err);
1658 		fwdev->status = FWDEVINVAL;
1659 		fwdev->csrrom[0] = 0;
1660 	}
1661 	return (err);
1662 
1663 }
1664 
1665 /*
1666  * Find the self_id packet for a node, ignoring sequels.
1667  */
1668 static union fw_self_id *
1669 fw_find_self_id(struct firewire_comm *fc, int node)
1670 {
1671 	uint32_t i;
1672 	union fw_self_id *s;
1673 
1674 	for (i = 0; i < fc->topology_map->self_id_count; i++) {
1675 		s = &fc->topology_map->self_id[i];
1676 		if (s->p0.sequel)
1677 			continue;
1678 		if (s->p0.phy_id == node)
1679 			return s;
1680 	}
1681 	return 0;
1682 }
1683 
1684 static void
1685 fw_explore(struct firewire_comm *fc)
1686 {
1687 	int node, err, s, i, todo, todo2, trys;
1688 	char nodes[63];
1689 	struct fw_device dfwdev;
1690 	union fw_self_id *fwsid;
1691 
1692 	todo = 0;
1693 	/* setup dummy fwdev */
1694 	dfwdev.fc = fc;
1695 	dfwdev.speed = 0;
1696 	dfwdev.maxrec = 8; /* 512 */
1697 	dfwdev.status = FWDEVINIT;
1698 
1699 	for (node = 0; node <= fc->max_node; node++) {
1700 		/* We don't probe myself and linkdown nodes */
1701 		if (node == fc->nodeid) {
1702 			if (firewire_debug)
1703 				device_printf(fc->bdev, "%s:"
1704 				    "found myself node(%d) fc->nodeid(%d) fc->max_node(%d)\n",
1705 				    __func__, node, fc->nodeid, fc->max_node);
1706 			continue;
1707 		} else if (firewire_debug) {
1708 			device_printf(fc->bdev, "%s:"
1709 			    "node(%d) fc->max_node(%d) found\n",
1710 			    __func__, node, fc->max_node);
1711 		}
1712 		fwsid = fw_find_self_id(fc, node);
1713 		if (!fwsid || !fwsid->p0.link_active) {
1714 			if (firewire_debug)
1715 				device_printf(fc->bdev,
1716 				    "%s: node%d: link down\n",
1717 				    __func__, node);
1718 			continue;
1719 		}
1720 		nodes[todo++] = node;
1721 	}
1722 
1723 	s = splfw();
1724 	for (trys = 0; todo > 0 && trys < 3; trys++) {
1725 		todo2 = 0;
1726 		for (i = 0; i < todo; i++) {
1727 			dfwdev.dst = nodes[i];
1728 			err = fw_explore_node(&dfwdev);
1729 			if (err)
1730 				nodes[todo2++] = nodes[i];
1731 			if (firewire_debug)
1732 				device_printf(fc->bdev,
1733 				    "%s: node %d, err = %d\n",
1734 				    __func__, node, err);
1735 		}
1736 		todo = todo2;
1737 	}
1738 	splx(s);
1739 }
1740 
1741 static void
1742 fw_bus_probe_thread(void *arg)
1743 {
1744 	struct firewire_comm *fc;
1745 
1746 	fc = arg;
1747 
1748 	mtx_lock(&fc->wait_lock);
1749 	while (fc->status != FWBUSDETACH) {
1750 		if (fc->status == FWBUSEXPLORE) {
1751 			mtx_unlock(&fc->wait_lock);
1752 			fw_explore(fc);
1753 			fc->status = FWBUSEXPDONE;
1754 			if (firewire_debug)
1755 				printf("bus_explore done\n");
1756 			fw_attach_dev(fc);
1757 			mtx_lock(&fc->wait_lock);
1758 		}
1759 		msleep((void *)fc, &fc->wait_lock, PWAIT|PCATCH, "-", 0);
1760 	}
1761 	mtx_unlock(&fc->wait_lock);
1762 	kproc_exit(0);
1763 }
1764 
1765 /*
1766  * To attach sub-devices layer onto IEEE1394 bus.
1767  */
1768 static void
1769 fw_attach_dev(struct firewire_comm *fc)
1770 {
1771 	struct fw_device *fwdev, *next;
1772 	int i, err;
1773 	device_t *devlistp;
1774 	int devcnt;
1775 	struct firewire_dev_comm *fdc;
1776 
1777 	for (fwdev = STAILQ_FIRST(&fc->devices); fwdev != NULL; fwdev = next) {
1778 		next = STAILQ_NEXT(fwdev, link);
1779 		if (fwdev->status == FWDEVINIT) {
1780 			fwdev->status = FWDEVATTACHED;
1781 		} else if (fwdev->status == FWDEVINVAL) {
1782 			fwdev->rcnt++;
1783 			if (firewire_debug)
1784 				device_printf(fc->bdev, "%s:"
1785 				    "fwdev->rcnt(%d), hold_count(%d)\n",
1786 				    __func__, fwdev->rcnt, hold_count);
1787 			if (fwdev->rcnt > hold_count) {
1788 				/*
1789 				 * Remove devices which have not been seen
1790 				 * for a while.
1791 				 */
1792 				STAILQ_REMOVE(&fc->devices, fwdev, fw_device,
1793 				    link);
1794 				free(fwdev, M_FW);
1795 			}
1796 		}
1797 	}
1798 
1799 	err = device_get_children(fc->bdev, &devlistp, &devcnt);
1800 	if (err == 0) {
1801 		for (i = 0; i < devcnt; i++) {
1802 			if (device_get_state(devlistp[i]) >= DS_ATTACHED) {
1803 				fdc = device_get_softc(devlistp[i]);
1804 				if (fdc->post_explore != NULL)
1805 					fdc->post_explore(fdc);
1806 			}
1807 		}
1808 		free(devlistp, M_TEMP);
1809 	}
1810 
1811 	return;
1812 }
1813 
1814 /*
1815  * To allocate unique transaction label.
1816  */
1817 static int
1818 fw_get_tlabel(struct firewire_comm *fc, struct fw_xfer *xfer)
1819 {
1820 	u_int dst, new_tlabel;
1821 	struct fw_xfer *txfer;
1822 	int s;
1823 
1824 	dst = xfer->send.hdr.mode.hdr.dst & 0x3f;
1825 	s = splfw();
1826 	mtx_lock(&fc->tlabel_lock);
1827 	new_tlabel = (fc->last_tlabel[dst] + 1) & 0x3f;
1828 	STAILQ_FOREACH(txfer, &fc->tlabels[new_tlabel], tlabel)
1829 		if ((txfer->send.hdr.mode.hdr.dst & 0x3f) == dst)
1830 			break;
1831 	if (txfer == NULL) {
1832 		fc->last_tlabel[dst] = new_tlabel;
1833 		STAILQ_INSERT_TAIL(&fc->tlabels[new_tlabel], xfer, tlabel);
1834 		mtx_unlock(&fc->tlabel_lock);
1835 		splx(s);
1836 		xfer->tl = new_tlabel;
1837 		xfer->send.hdr.mode.hdr.tlrt = new_tlabel << 2;
1838 		if (firewire_debug > 1)
1839 			printf("fw_get_tlabel: dst=%d tl=%d\n", dst, new_tlabel);
1840 		return (new_tlabel);
1841 	}
1842 	mtx_unlock(&fc->tlabel_lock);
1843 	splx(s);
1844 
1845 	if (firewire_debug > 1)
1846 		printf("fw_get_tlabel: no free tlabel\n");
1847 	return (-1);
1848 }
1849 
1850 static void
1851 fw_rcv_copy(struct fw_rcv_buf *rb)
1852 {
1853 	struct fw_pkt *pkt;
1854 	u_char *p;
1855 	struct tcode_info *tinfo;
1856 	u_int res, i, len, plen;
1857 
1858 	rb->xfer->recv.spd = rb->spd;
1859 
1860 	pkt = (struct fw_pkt *)rb->vec->iov_base;
1861 	tinfo = &rb->fc->tcode[pkt->mode.hdr.tcode];
1862 
1863 	/* Copy header */
1864 	p = (u_char *)&rb->xfer->recv.hdr;
1865 	bcopy(rb->vec->iov_base, p, tinfo->hdr_len);
1866 	rb->vec->iov_base = (u_char *)rb->vec->iov_base + tinfo->hdr_len;
1867 	rb->vec->iov_len -= tinfo->hdr_len;
1868 
1869 	/* Copy payload */
1870 	p = (u_char *)rb->xfer->recv.payload;
1871 	res = rb->xfer->recv.pay_len;
1872 
1873 	/* special handling for RRESQ */
1874 	if (pkt->mode.hdr.tcode == FWTCODE_RRESQ &&
1875 	    p != NULL && res >= sizeof(uint32_t)) {
1876 		*(uint32_t *)p = pkt->mode.rresq.data;
1877 		rb->xfer->recv.pay_len = sizeof(uint32_t);
1878 		return;
1879 	}
1880 
1881 	if ((tinfo->flag & FWTI_BLOCK_ASY) == 0)
1882 		return;
1883 
1884 	plen = pkt->mode.rresb.len;
1885 
1886 	for (i = 0; i < rb->nvec; i++, rb->vec++) {
1887 		len = MIN(rb->vec->iov_len, plen);
1888 		if (res < len) {
1889 			device_printf(rb->fc->bdev, "%s:"
1890 				" rcv buffer(%d) is %d bytes short.\n",
1891 				__func__, rb->xfer->recv.pay_len, len - res);
1892 			len = res;
1893 		}
1894 		bcopy(rb->vec->iov_base, p, len);
1895 		p += len;
1896 		res -= len;
1897 		plen -= len;
1898 		if (res == 0 || plen == 0)
1899 			break;
1900 	}
1901 	rb->xfer->recv.pay_len -= res;
1902 }
1903 
1904 /*
1905  * Generic packet receiving process.
1906  */
1907 void
1908 fw_rcv(struct fw_rcv_buf *rb)
1909 {
1910 	struct fw_pkt *fp, *resfp;
1911 	struct fw_bind *bind;
1912 	int tcode;
1913 	int i, len, oldstate;
1914 #if 0
1915 	{
1916 		uint32_t *qld;
1917 		int i;
1918 		qld = (uint32_t *)buf;
1919 		printf("spd %d len:%d\n", spd, len);
1920 		for (i = 0; i <= len && i < 32; i+= 4) {
1921 			printf("0x%08x ", ntohl(qld[i/4]));
1922 			if ((i % 16) == 15) printf("\n");
1923 		}
1924 		if ((i % 16) != 15) printf("\n");
1925 	}
1926 #endif
1927 	fp = (struct fw_pkt *)rb->vec[0].iov_base;
1928 	tcode = fp->mode.common.tcode;
1929 	switch (tcode) {
1930 	case FWTCODE_WRES:
1931 	case FWTCODE_RRESQ:
1932 	case FWTCODE_RRESB:
1933 	case FWTCODE_LRES:
1934 		rb->xfer = fw_tl2xfer(rb->fc, fp->mode.hdr.src,
1935 				fp->mode.hdr.tlrt >> 2, fp->mode.hdr.tcode);
1936 		if (rb->xfer == NULL) {
1937 			device_printf(rb->fc->bdev, "%s: unknown response "
1938 			    "%s(%x) src=0x%x tl=0x%x rt=%d data=0x%x\n",
1939 			    __func__,
1940 			    tcode_str[tcode], tcode,
1941 			    fp->mode.hdr.src,
1942 			    fp->mode.hdr.tlrt >> 2,
1943 			    fp->mode.hdr.tlrt & 3,
1944 			    fp->mode.rresq.data);
1945 #if 0
1946 			printf("try ad-hoc work around!!\n");
1947 			rb->xfer = fw_tl2xfer(rb->fc, fp->mode.hdr.src,
1948 			    (fp->mode.hdr.tlrt >> 2)^3);
1949 			if (rb->xfer == NULL) {
1950 				printf("no use...\n");
1951 				return;
1952 			}
1953 #else
1954 			return;
1955 #endif
1956 		}
1957 		fw_rcv_copy(rb);
1958 		if (rb->xfer->recv.hdr.mode.wres.rtcode != RESP_CMP)
1959 			rb->xfer->resp = EIO;
1960 		else
1961 			rb->xfer->resp = 0;
1962 		/* make sure the packet is drained in AT queue */
1963 		oldstate = rb->xfer->flag;
1964 		rb->xfer->flag = FWXF_RCVD;
1965 		switch (oldstate) {
1966 		case FWXF_SENT:
1967 			fw_xfer_done(rb->xfer);
1968 			break;
1969 		case FWXF_START:
1970 #if 0
1971 			if (firewire_debug)
1972 				printf("not sent yet tl=%x\n", rb->xfer->tl);
1973 #endif
1974 			break;
1975 		default:
1976 			device_printf(rb->fc->bdev, "%s: "
1977 			    "unexpected flag 0x%02x\n", __func__,
1978 			    rb->xfer->flag);
1979 		}
1980 		return;
1981 	case FWTCODE_WREQQ:
1982 	case FWTCODE_WREQB:
1983 	case FWTCODE_RREQQ:
1984 	case FWTCODE_RREQB:
1985 	case FWTCODE_LREQ:
1986 		bind = fw_bindlookup(rb->fc, fp->mode.rreqq.dest_hi,
1987 		    fp->mode.rreqq.dest_lo);
1988 		if (bind == NULL) {
1989 			device_printf(rb->fc->bdev, "%s: "
1990 			    "Unknown service addr 0x%04x:0x%08x %s(%x)"
1991 			    " src=0x%x data=%x\n",
1992 			    __func__,
1993 			    fp->mode.wreqq.dest_hi,
1994 			    fp->mode.wreqq.dest_lo,
1995 			    tcode_str[tcode], tcode,
1996 			    fp->mode.hdr.src,
1997 			    ntohl(fp->mode.wreqq.data));
1998 
1999 			if (rb->fc->status == FWBUSINIT) {
2000 				device_printf(rb->fc->bdev,
2001 				    "%s: cannot respond(bus reset)!\n",
2002 				    __func__);
2003 				return;
2004 			}
2005 			rb->xfer = fw_xfer_alloc(M_FWXFER);
2006 			if (rb->xfer == NULL) {
2007 				return;
2008 			}
2009 			rb->xfer->send.spd = rb->spd;
2010 			rb->xfer->send.pay_len = 0;
2011 			resfp = &rb->xfer->send.hdr;
2012 			switch (tcode) {
2013 			case FWTCODE_WREQQ:
2014 			case FWTCODE_WREQB:
2015 				resfp->mode.hdr.tcode = FWTCODE_WRES;
2016 				break;
2017 			case FWTCODE_RREQQ:
2018 				resfp->mode.hdr.tcode = FWTCODE_RRESQ;
2019 				break;
2020 			case FWTCODE_RREQB:
2021 				resfp->mode.hdr.tcode = FWTCODE_RRESB;
2022 				break;
2023 			case FWTCODE_LREQ:
2024 				resfp->mode.hdr.tcode = FWTCODE_LRES;
2025 				break;
2026 			}
2027 			resfp->mode.hdr.dst = fp->mode.hdr.src;
2028 			resfp->mode.hdr.tlrt = fp->mode.hdr.tlrt;
2029 			resfp->mode.hdr.pri = fp->mode.hdr.pri;
2030 			resfp->mode.rresb.rtcode = RESP_ADDRESS_ERROR;
2031 			resfp->mode.rresb.extcode = 0;
2032 			resfp->mode.rresb.len = 0;
2033 /*
2034 			rb->xfer->hand = fw_xferwake;
2035 */
2036 			rb->xfer->hand = fw_xfer_free;
2037 			if (fw_asyreq(rb->fc, -1, rb->xfer))
2038 				fw_xfer_free(rb->xfer);
2039 		}
2040 		len = 0;
2041 		for (i = 0; i < rb->nvec; i++)
2042 			len += rb->vec[i].iov_len;
2043 		rb->xfer = STAILQ_FIRST(&bind->xferlist);
2044 		if (rb->xfer == NULL) {
2045 			device_printf(rb->fc->bdev, "%s: "
2046 			    "Discard a packet for this bind.\n", __func__);
2047 			return;
2048 		}
2049 		STAILQ_REMOVE_HEAD(&bind->xferlist, link);
2050 		fw_rcv_copy(rb);
2051 		rb->xfer->hand(rb->xfer);
2052 		return;
2053 #if 0 /* shouldn't happen ?? or for GASP */
2054 	case FWTCODE_STREAM:
2055 	{
2056 		struct fw_xferq *xferq;
2057 
2058 		xferq = rb->fc->ir[sub];
2059 #if 0
2060 		printf("stream rcv dma %d len %d off %d spd %d\n",
2061 			sub, len, off, spd);
2062 #endif
2063 		if (xferq->queued >= xferq->maxq) {
2064 			printf("receive queue is full\n");
2065 			return;
2066 		}
2067 		/* XXX get xfer from xfer queue, we don't need copy for
2068 			per packet mode */
2069 		rb->xfer = fw_xfer_alloc_buf(M_FWXFER, 0, /* XXX */
2070 						vec[0].iov_len);
2071 		if (rb->xfer == NULL)
2072 			return;
2073 		fw_rcv_copy(rb)
2074 		s = splfw();
2075 		xferq->queued++;
2076 		STAILQ_INSERT_TAIL(&xferq->q, rb->xfer, link);
2077 		splx(s);
2078 		sc = device_get_softc(rb->fc->bdev);
2079 		if (SEL_WAITING(&xferq->rsel))
2080 			selwakeuppri(&xferq->rsel, FWPRI);
2081 		if (xferq->flag & FWXFERQ_WAKEUP) {
2082 			xferq->flag &= ~FWXFERQ_WAKEUP;
2083 			wakeup((caddr_t)xferq);
2084 		}
2085 		if (xferq->flag & FWXFERQ_HANDLER) {
2086 			xferq->hand(xferq);
2087 		}
2088 		return;
2089 		break;
2090 	}
2091 #endif
2092 	default:
2093 		device_printf(rb->fc->bdev,"%s: unknown tcode %d\n",
2094 		    __func__, tcode);
2095 		break;
2096 	}
2097 }
2098 
2099 /*
2100  * Post process for Bus Manager election process.
2101  */
2102 static void
2103 fw_try_bmr_callback(struct fw_xfer *xfer)
2104 {
2105 	struct firewire_comm *fc;
2106 	int bmr;
2107 
2108 	if (xfer == NULL)
2109 		return;
2110 	fc = xfer->fc;
2111 	if (xfer->resp != 0)
2112 		goto error;
2113 	if (xfer->recv.payload == NULL)
2114 		goto error;
2115 	if (xfer->recv.hdr.mode.lres.rtcode != FWRCODE_COMPLETE)
2116 		goto error;
2117 
2118 	bmr = ntohl(xfer->recv.payload[0]);
2119 	if (bmr == 0x3f)
2120 		bmr = fc->nodeid;
2121 
2122 	CSRARC(fc, BUS_MGR_ID) = fc->set_bmr(fc, bmr & 0x3f);
2123 	fw_xfer_free_buf(xfer);
2124 	fw_bmr(fc);
2125 	return;
2126 
2127 error:
2128 	device_printf(fc->bdev, "bus manager election failed\n");
2129 	fw_xfer_free_buf(xfer);
2130 }
2131 
2132 
2133 /*
2134  * To candidate Bus Manager election process.
2135  */
2136 static void
2137 fw_try_bmr(void *arg)
2138 {
2139 	struct fw_xfer *xfer;
2140 	struct firewire_comm *fc = arg;
2141 	struct fw_pkt *fp;
2142 	int err = 0;
2143 
2144 	xfer = fw_xfer_alloc_buf(M_FWXFER, 8, 4);
2145 	if (xfer == NULL)
2146 		return;
2147 	xfer->send.spd = 0;
2148 	fc->status = FWBUSMGRELECT;
2149 
2150 	fp = &xfer->send.hdr;
2151 	fp->mode.lreq.dest_hi = 0xffff;
2152 	fp->mode.lreq.tlrt = 0;
2153 	fp->mode.lreq.tcode = FWTCODE_LREQ;
2154 	fp->mode.lreq.pri = 0;
2155 	fp->mode.lreq.src = 0;
2156 	fp->mode.lreq.len = 8;
2157 	fp->mode.lreq.extcode = EXTCODE_CMP_SWAP;
2158 	fp->mode.lreq.dst = FWLOCALBUS | fc->irm;
2159 	fp->mode.lreq.dest_lo = 0xf0000000 | BUS_MGR_ID;
2160 	xfer->send.payload[0] = htonl(0x3f);
2161 	xfer->send.payload[1] = htonl(fc->nodeid);
2162 	xfer->hand = fw_try_bmr_callback;
2163 
2164 	err = fw_asyreq(fc, -1, xfer);
2165 	if (err) {
2166 		fw_xfer_free_buf(xfer);
2167 		return;
2168 	}
2169 	return;
2170 }
2171 
2172 #ifdef FW_VMACCESS
2173 /*
2174  * Software implementation for physical memory block access.
2175  * XXX:Too slow, useful for debug purpose only.
2176  */
2177 static void
2178 fw_vmaccess(struct fw_xfer *xfer)
2179 {
2180 	struct fw_pkt *rfp, *sfp = NULL;
2181 	uint32_t *ld = (uint32_t *)xfer->recv.buf;
2182 
2183 	printf("vmaccess spd:%2x len:%03x data:%08x %08x %08x %08x\n",
2184 	    xfer->spd, xfer->recv.len, ntohl(ld[0]), ntohl(ld[1]), ntohl(ld[2]),
2185 	    ntohl(ld[3]));
2186 	printf("vmaccess          data:%08x %08x %08x %08x\n", ntohl(ld[4]),
2187 	    ntohl(ld[5]), ntohl(ld[6]), ntohl(ld[7]));
2188 	if (xfer->resp != 0) {
2189 		fw_xfer_free(xfer);
2190 		return;
2191 	}
2192 	if (xfer->recv.buf == NULL) {
2193 		fw_xfer_free(xfer);
2194 		return;
2195 	}
2196 	rfp = (struct fw_pkt *)xfer->recv.buf;
2197 	switch (rfp->mode.hdr.tcode) {
2198 		/* XXX need fix for 64bit arch */
2199 		case FWTCODE_WREQB:
2200 			xfer->send.buf = malloc(12, M_FW, M_NOWAIT);
2201 			xfer->send.len = 12;
2202 			sfp = (struct fw_pkt *)xfer->send.buf;
2203 			bcopy(rfp->mode.wreqb.payload,
2204 			    (caddr_t)ntohl(rfp->mode.wreqb.dest_lo),s
2205 			    ntohs(rfp->mode.wreqb.len));
2206 			sfp->mode.wres.tcode = FWTCODE_WRES;
2207 			sfp->mode.wres.rtcode = 0;
2208 			break;
2209 		case FWTCODE_WREQQ:
2210 			xfer->send.buf = malloc(12, M_FW, M_NOWAIT);
2211 			xfer->send.len = 12;
2212 			sfp->mode.wres.tcode = FWTCODE_WRES;
2213 			*((uint32_t *)(ntohl(rfp->mode.wreqb.dest_lo))) =
2214 			    rfp->mode.wreqq.data;
2215 			sfp->mode.wres.rtcode = 0;
2216 			break;
2217 		case FWTCODE_RREQB:
2218 			xfer->send.buf = malloc(16 + rfp->mode.rreqb.len,
2219 			    M_FW, M_NOWAIT);
2220 			xfer->send.len = 16 + ntohs(rfp->mode.rreqb.len);
2221 			sfp = (struct fw_pkt *)xfer->send.buf;
2222 			bcopy((caddr_t)ntohl(rfp->mode.rreqb.dest_lo),
2223 			    sfp->mode.rresb.payload,
2224 			    ntohs(rfp->mode.rreqb.len));
2225 			sfp->mode.rresb.tcode = FWTCODE_RRESB;
2226 			sfp->mode.rresb.len = rfp->mode.rreqb.len;
2227 			sfp->mode.rresb.rtcode = 0;
2228 			sfp->mode.rresb.extcode = 0;
2229 			break;
2230 		case FWTCODE_RREQQ:
2231 			xfer->send.buf = malloc(16, M_FW, M_NOWAIT);
2232 			xfer->send.len = 16;
2233 			sfp = (struct fw_pkt *)xfer->send.buf;
2234 			sfp->mode.rresq.data =
2235 			    *(uint32_t *)(ntohl(rfp->mode.rreqq.dest_lo));
2236 			sfp->mode.wres.tcode = FWTCODE_RRESQ;
2237 			sfp->mode.rresb.rtcode = 0;
2238 			break;
2239 		default:
2240 			fw_xfer_free(xfer);
2241 			return;
2242 	}
2243 	sfp->mode.hdr.dst = rfp->mode.hdr.src;
2244 	xfer->dst = ntohs(rfp->mode.hdr.src);
2245 	xfer->hand = fw_xfer_free;
2246 
2247 	sfp->mode.hdr.tlrt = rfp->mode.hdr.tlrt;
2248 	sfp->mode.hdr.pri = 0;
2249 
2250 	fw_asyreq(xfer->fc, -1, xfer);
2251 /**/
2252 	return;
2253 }
2254 #endif
2255 
2256 /*
2257  * CRC16 check-sum for IEEE1394 register blocks.
2258  */
2259 uint16_t
2260 fw_crc16(uint32_t *ptr, uint32_t len)
2261 {
2262 	uint32_t i, sum, crc = 0;
2263 	int shift;
2264 	len = (len + 3) & ~3;
2265 	for (i = 0; i < len; i += 4) {
2266 		for (shift = 28; shift >= 0; shift -= 4) {
2267 			sum = ((crc >> 12) ^ (ptr[i/4] >> shift)) & 0xf;
2268 			crc = (crc << 4) ^ (sum << 12) ^ (sum << 5) ^ sum;
2269 		}
2270 		crc &= 0xffff;
2271 	}
2272 	return ((uint16_t) crc);
2273 }
2274 
2275 /*
2276  * Find the root node, if it is not
2277  * Cycle Master Capable, then we should
2278  * override this and become the Cycle
2279  * Master
2280  */
2281 static int
2282 fw_bmr(struct firewire_comm *fc)
2283 {
2284 	struct fw_device fwdev;
2285 	union fw_self_id *self_id;
2286 	int cmstr;
2287 	uint32_t quad;
2288 
2289 	/* Check to see if the current root node is cycle master capable */
2290 	self_id = fw_find_self_id(fc, fc->max_node);
2291 	if (fc->max_node > 0) {
2292 		/* XXX check cmc bit of businfo block rather than contender */
2293 		if (self_id->p0.link_active && self_id->p0.contender)
2294 			cmstr = fc->max_node;
2295 		else {
2296 			device_printf(fc->bdev,
2297 			    "root node is not cycle master capable\n");
2298 			/* XXX shall we be the cycle master? */
2299 			cmstr = fc->nodeid;
2300 			/* XXX need bus reset */
2301 		}
2302 	} else
2303 		cmstr = -1;
2304 
2305 	device_printf(fc->bdev, "bus manager %d %s\n",
2306 		CSRARC(fc, BUS_MGR_ID),
2307 		(CSRARC(fc, BUS_MGR_ID) != fc->nodeid) ? "(me)" : "");
2308 	if (CSRARC(fc, BUS_MGR_ID) != fc->nodeid) {
2309 		/* We are not the bus manager */
2310 		return (0);
2311 	}
2312 
2313 	/* Optimize gapcount */
2314 	if (fc->max_hop <= MAX_GAPHOP)
2315 		fw_phy_config(fc, cmstr, gap_cnt[fc->max_hop]);
2316 	/* If we are the cycle master, nothing to do */
2317 	if (cmstr == fc->nodeid || cmstr == -1)
2318 		return 0;
2319 	/* Bus probe has not finished, make dummy fwdev for cmstr */
2320 	bzero(&fwdev, sizeof(fwdev));
2321 	fwdev.fc = fc;
2322 	fwdev.dst = cmstr;
2323 	fwdev.speed = 0;
2324 	fwdev.maxrec = 8; /* 512 */
2325 	fwdev.status = FWDEVINIT;
2326 	/* Set cmstr bit on the cycle master */
2327 	quad = htonl(1 << 8);
2328 	fwmem_write_quad(&fwdev, NULL, 0/*spd*/,
2329 	    0xffff, 0xf0000000 | STATE_SET, &quad, fw_asy_callback_free);
2330 
2331 	return 0;
2332 }
2333 
2334 int
2335 fw_open_isodma(struct firewire_comm *fc, int tx)
2336 {
2337 	struct fw_xferq **xferqa;
2338 	struct fw_xferq *xferq;
2339 	int i;
2340 
2341 	if (tx)
2342 		xferqa = &fc->it[0];
2343 	else
2344 		xferqa = &fc->ir[0];
2345 
2346 	FW_GLOCK(fc);
2347 	for (i = 0; i < fc->nisodma; i++) {
2348 		xferq = xferqa[i];
2349 		if ((xferq->flag & FWXFERQ_OPEN) == 0) {
2350 			xferq->flag |= FWXFERQ_OPEN;
2351 			break;
2352 		}
2353 	}
2354 	if (i == fc->nisodma) {
2355 		printf("no free dma channel (tx=%d)\n", tx);
2356 		i = -1;
2357 	}
2358 	FW_GUNLOCK(fc);
2359 	return (i);
2360 }
2361 
2362 static int
2363 fw_modevent(module_t mode, int type, void *data)
2364 {
2365 	int err = 0;
2366 	static eventhandler_tag fwdev_ehtag = NULL;
2367 
2368 	switch (type) {
2369 	case MOD_LOAD:
2370 		fwdev_ehtag = EVENTHANDLER_REGISTER(dev_clone,
2371 		    fwdev_clone, 0, 1000);
2372 		break;
2373 	case MOD_UNLOAD:
2374 		if (fwdev_ehtag != NULL)
2375 			EVENTHANDLER_DEREGISTER(dev_clone, fwdev_ehtag);
2376 		break;
2377 	case MOD_SHUTDOWN:
2378 		break;
2379 	default:
2380 		return (EOPNOTSUPP);
2381 	}
2382 	return (err);
2383 }
2384 
2385 
2386 DRIVER_MODULE(firewire, fwohci, firewire_driver, firewire_devclass,
2387     fw_modevent,0);
2388 MODULE_VERSION(firewire, 1);
2389