2 * Copyright (c) 2003 Hidetoshi Shimokawa
3 * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the acknowledgement as bellow:
17 * This product includes software developed by K. Kobayashi and H. Shimokawa
19 * 4. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
26 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/types.h>
43 #include <sys/kernel.h>
44 #include <sys/module.h>
45 #include <sys/malloc.h>
47 #include <sys/sysctl.h>
48 #include <sys/kthread.h>
52 #if defined(__DragonFly__) || __FreeBSD_version < 500000
53 #include <machine/clock.h> /* for DELAY() */
56 #include <sys/bus.h> /* used by smbus and newbus */
57 #include <machine/bus.h>
61 #include "firewirereg.h"
66 #include <dev/firewire/firewire.h>
67 #include <dev/firewire/firewirereg.h>
68 #include <dev/firewire/fwmem.h>
69 #include <dev/firewire/iec13213.h>
70 #include <dev/firewire/iec68113.h>
75 struct crom_chunk root;
76 struct crom_chunk vendor;
80 int firewire_debug=0, try_bmr=1, hold_count=0;
81 SYSCTL_INT(_debug, OID_AUTO, firewire_debug, CTLFLAG_RW, &firewire_debug, 0,
82 "FireWire driver debug flag");
83 SYSCTL_NODE(_hw, OID_AUTO, firewire, CTLFLAG_RD, 0, "FireWire Subsystem");
84 SYSCTL_INT(_hw_firewire, OID_AUTO, try_bmr, CTLFLAG_RW, &try_bmr, 0,
85 "Try to be a bus manager");
86 SYSCTL_INT(_hw_firewire, OID_AUTO, hold_count, CTLFLAG_RW, &hold_count, 0,
87 "Number of count of bus resets for removing lost device information");
89 MALLOC_DEFINE(M_FW, "firewire", "FireWire");
90 MALLOC_DEFINE(M_FWXFER, "fw_xfer", "XFER/FireWire");
92 #define FW_MAXASYRTY 4
94 devclass_t firewire_devclass;
96 static void firewire_identify (driver_t *, device_t);
97 static int firewire_probe (device_t);
98 static int firewire_attach (device_t);
99 static int firewire_detach (device_t);
100 static int firewire_resume (device_t);
101 static void firewire_xfer_timeout(void *, int);
103 static int firewire_shutdown (device_t);
105 static device_t firewire_add_child(device_t, u_int, const char *, int);
106 static void fw_try_bmr (void *);
107 static void fw_try_bmr_callback (struct fw_xfer *);
108 static void fw_asystart (struct fw_xfer *);
109 static int fw_get_tlabel (struct firewire_comm *, struct fw_xfer *);
110 static void fw_bus_probe (struct firewire_comm *);
111 static void fw_attach_dev (struct firewire_comm *);
112 static void fw_bus_probe_thread(void *);
114 static void fw_vmaccess (struct fw_xfer *);
116 static int fw_bmr (struct firewire_comm *);
117 static void fw_dump_hdr(struct fw_pkt *, char *);
119 static device_method_t firewire_methods[] = {
120 /* Device interface */
121 DEVMETHOD(device_identify, firewire_identify),
122 DEVMETHOD(device_probe, firewire_probe),
123 DEVMETHOD(device_attach, firewire_attach),
124 DEVMETHOD(device_detach, firewire_detach),
125 DEVMETHOD(device_suspend, bus_generic_suspend),
126 DEVMETHOD(device_resume, firewire_resume),
127 DEVMETHOD(device_shutdown, bus_generic_shutdown),
130 DEVMETHOD(bus_add_child, firewire_add_child),
131 DEVMETHOD(bus_print_child, bus_generic_print_child),
135 char *linkspeed[] = {
136 "S100", "S200", "S400", "S800",
137 "S1600", "S3200", "undef", "undef"
140 static char *tcode_str[] = {
141 "WREQQ", "WREQB", "WRES", "undef",
142 "RREQQ", "RREQB", "RRESQ", "RRESB",
143 "CYCS", "LREQ", "STREAM", "LRES",
144 "undef", "undef", "PHY", "undef"
147 /* IEEE-1394a Table C-2 Gap count as a function of hops*/
148 #define MAX_GAPHOP 15
149 u_int gap_cnt[] = { 5, 5, 7, 8, 10, 13, 16, 18,
150 21, 24, 26, 29, 32, 35, 37, 40};
152 static driver_t firewire_driver = {
155 sizeof(struct firewire_softc),
159 * Lookup fwdev by node id.
162 fw_noderesolve_nodeid(struct firewire_comm *fc, int dst)
164 struct fw_device *fwdev;
168 STAILQ_FOREACH(fwdev, &fc->devices, link)
169 if (fwdev->dst == dst && fwdev->status != FWDEVINVAL)
177 * Lookup fwdev by EUI64.
180 fw_noderesolve_eui64(struct firewire_comm *fc, struct fw_eui64 *eui)
182 struct fw_device *fwdev;
187 STAILQ_FOREACH(fwdev, &fc->devices, link)
188 if (FW_EUI64_EQUAL(fwdev->eui, *eui))
193 if(fwdev == NULL) return NULL;
194 if(fwdev->status == FWDEVINVAL) return NULL;
199 * Async. request procedure for userland application.
202 fw_asyreq(struct firewire_comm *fc, int sub, struct fw_xfer *xfer)
205 struct fw_xferq *xferq;
209 struct tcode_info *info;
211 if(xfer == NULL) return EINVAL;
212 if(xfer->hand == NULL){
213 printf("hand == NULL\n");
216 fp = &xfer->send.hdr;
218 tcode = fp->mode.common.tcode & 0xf;
219 info = &fc->tcode[tcode];
220 if (info->flag == 0) {
221 printf("invalid tcode=%x\n", tcode);
225 /* XXX allow bus explore packets only after bus rest */
226 if ((fc->status < FWBUSEXPLORE) &&
227 ((tcode != FWTCODE_RREQQ) || (fp->mode.rreqq.dest_hi != 0xffff) ||
228 (fp->mode.rreqq.dest_lo < 0xf0000000) ||
229 (fp->mode.rreqq.dest_lo >= 0xf0001000))) {
231 xfer->flag = FWXF_BUSY;
235 if (info->flag & FWTI_REQ)
240 if (xfer->send.pay_len > MAXREC(fc->maxrec)) {
241 printf("send.pay_len > maxrec\n");
244 if (info->flag & FWTI_BLOCK_STR)
245 len = fp->mode.stream.len;
246 else if (info->flag & FWTI_BLOCK_ASY)
247 len = fp->mode.rresb.len;
250 if (len != xfer->send.pay_len){
251 printf("len(%d) != send.pay_len(%d) %s(%x)\n",
252 len, xfer->send.pay_len, tcode_str[tcode], tcode);
256 if(xferq->start == NULL){
257 printf("xferq->start == NULL\n");
260 if(!(xferq->queued < xferq->maxq)){
261 device_printf(fc->bdev, "Discard a packet (queued=%d)\n",
267 if (info->flag & FWTI_TLABEL) {
268 if (fw_get_tlabel(fc, xfer) < 0)
280 * Wakeup blocked process.
283 fw_xferwake(struct fw_xfer *xfer)
285 struct mtx *lock = &xfer->fc->wait_lock;
288 xfer->flag |= FWXF_WAKE;
296 fw_xferwait(struct fw_xfer *xfer)
298 struct mtx *lock = &xfer->fc->wait_lock;
302 if ((xfer->flag & FWXF_WAKE) == 0)
303 err = msleep((void *)xfer, lock, PWAIT|PCATCH, "fw_xferwait", 0);
310 * Async. request with given xfer structure.
313 fw_asystart(struct fw_xfer *xfer)
315 struct firewire_comm *fc = xfer->fc;
318 /* Protect from interrupt/timeout */
320 xfer->flag = FWXF_INQ;
321 STAILQ_INSERT_TAIL(&xfer->q->q, xfer, link);
327 /* XXX just queue for mbuf */
328 if (xfer->mbuf == NULL)
334 firewire_identify(driver_t *driver, device_t parent)
336 BUS_ADD_CHILD(parent, 0, "firewire", -1);
340 firewire_probe(device_t dev)
342 device_set_desc(dev, "IEEE1394(FireWire) bus");
347 firewire_xfer_timeout(void *arg, int pending)
349 struct firewire_comm *fc = (struct firewire_comm *)arg;
350 struct fw_xfer *xfer, *txfer;
352 struct timeval split_timeout;
353 STAILQ_HEAD(, fw_xfer) xfer_timeout;
356 split_timeout.tv_sec = 0;
357 split_timeout.tv_usec = 200 * 1000; /* 200 msec */
360 timevalsub(&tv, &split_timeout);
361 STAILQ_INIT(&xfer_timeout);
364 mtx_lock(&fc->tlabel_lock);
365 for (i = 0; i < 0x40; i ++) {
366 while ((xfer = STAILQ_FIRST(&fc->tlabels[i])) != NULL) {
367 if ((xfer->flag & FWXF_SENT) == 0)
370 if (timevalcmp(&xfer->tv, &tv, >))
371 /* the rests are newer than this */
373 device_printf(fc->bdev,
374 "split transaction timeout: "
375 "tl=0x%x flag=0x%02x\n", i, xfer->flag);
376 fw_dump_hdr(&xfer->send.hdr, "send");
377 xfer->resp = ETIMEDOUT;
378 STAILQ_REMOVE_HEAD(&fc->tlabels[i], tlabel);
379 STAILQ_INSERT_TAIL(&xfer_timeout, xfer, tlabel);
382 mtx_unlock(&fc->tlabel_lock);
386 STAILQ_FOREACH_SAFE(xfer, &xfer_timeout, tlabel, txfer)
390 #define WATCHDOG_HZ 10
392 firewire_watchdog(void *arg)
394 struct firewire_comm *fc;
395 static int watchdog_clock = 0;
397 fc = (struct firewire_comm *)arg;
400 * At boot stage, the device interrupt is disabled and
401 * We encounter a timeout easily. To avoid this,
402 * ignore clock interrupt for a while.
404 if (watchdog_clock > WATCHDOG_HZ * 15)
405 taskqueue_enqueue(fc->taskqueue, &fc->task_timeout);
409 callout_reset(&fc->timeout_callout, hz / WATCHDOG_HZ,
410 (void *)firewire_watchdog, (void *)fc);
414 * The attach routine.
417 firewire_attach(device_t dev)
420 struct firewire_softc *sc = device_get_softc(dev);
421 device_t pa = device_get_parent(dev);
422 struct firewire_comm *fc;
424 fc = (struct firewire_comm *)device_get_softc(pa);
426 fc->status = FWBUSNOTREADY;
428 unit = device_get_unit(dev);
429 if( fc->nisodma > FWMAXNDMA) fc->nisodma = FWMAXNDMA;
433 fc->crom_src_buf = (struct crom_src_buf *)malloc(
434 sizeof(struct crom_src_buf),
435 M_FW, M_NOWAIT | M_ZERO);
436 if (fc->crom_src_buf == NULL) {
437 device_printf(fc->dev, "%s: Malloc Failure crom src buff\n", __func__);
440 fc->topology_map = (struct fw_topology_map *)malloc(
441 sizeof(struct fw_topology_map),
442 M_FW, M_NOWAIT | M_ZERO);
443 if (fc->topology_map == NULL) {
444 device_printf(fc->dev, "%s: Malloc Failure topology map\n", __func__);
445 free(fc->crom_src_buf, M_FW);
448 fc->speed_map = (struct fw_speed_map *)malloc(
449 sizeof(struct fw_speed_map),
450 M_FW, M_NOWAIT | M_ZERO);
451 if (fc->speed_map == NULL) {
452 device_printf(fc->dev, "%s: Malloc Failure speed map\n", __func__);
453 free(fc->crom_src_buf, M_FW);
454 free(fc->topology_map, M_FW);
458 mtx_init(&fc->wait_lock, "fwwait", NULL, MTX_DEF);
459 mtx_init(&fc->tlabel_lock, "fwtlabel", NULL, MTX_DEF);
460 CALLOUT_INIT(&fc->timeout_callout);
461 CALLOUT_INIT(&fc->bmr_callout);
462 CALLOUT_INIT(&fc->busprobe_callout);
463 TASK_INIT(&fc->task_timeout, 0, firewire_xfer_timeout, (void *)fc);
465 callout_reset(&sc->fc->timeout_callout, hz,
466 (void *)firewire_watchdog, (void *)sc->fc);
469 kproc_create(fw_bus_probe_thread, (void *)fc, &fc->probe_thread,
470 0, 0, "fw%d_probe", unit);
472 /* Locate our children */
473 bus_generic_probe(dev);
475 /* launch attachement of the added children */
476 bus_generic_attach(dev);
480 fw_busreset(fc, FWBUSNOTREADY);
488 * Attach it as child.
491 firewire_add_child(device_t dev, u_int order, const char *name, int unit)
494 struct firewire_softc *sc;
496 sc = (struct firewire_softc *)device_get_softc(dev);
497 child = device_add_child(dev, name, unit);
499 device_set_ivars(child, sc->fc);
500 device_probe_and_attach(child);
507 firewire_resume(device_t dev)
509 struct firewire_softc *sc;
511 sc = (struct firewire_softc *)device_get_softc(dev);
512 sc->fc->status = FWBUSNOTREADY;
514 bus_generic_resume(dev);
523 firewire_detach(device_t dev)
525 struct firewire_softc *sc;
526 struct firewire_comm *fc;
527 struct fw_device *fwdev, *fwdev_next;
530 sc = (struct firewire_softc *)device_get_softc(dev);
532 mtx_lock(&fc->wait_lock);
533 fc->status = FWBUSDETACH;
535 if (msleep(fc->probe_thread, &fc->wait_lock, PWAIT, "fwthr", hz * 60))
536 printf("firewire probe thread didn't die\n");
537 mtx_unlock(&fc->wait_lock);
539 if (fc->arq !=0 && fc->arq->maxq > 0)
542 if ((err = fwdev_destroydev(sc)) != 0)
545 if ((err = bus_generic_detach(dev)) != 0)
548 callout_stop(&fc->timeout_callout);
549 callout_stop(&fc->bmr_callout);
550 callout_stop(&fc->busprobe_callout);
552 /* XXX xfer_free and untimeout on all xfers */
553 for (fwdev = STAILQ_FIRST(&fc->devices); fwdev != NULL;
554 fwdev = fwdev_next) {
555 fwdev_next = STAILQ_NEXT(fwdev, link);
558 free(fc->topology_map, M_FW);
559 free(fc->speed_map, M_FW);
560 free(fc->crom_src_buf, M_FW);
562 mtx_destroy(&fc->tlabel_lock);
563 mtx_destroy(&fc->wait_lock);
568 firewire_shutdown( device_t dev )
576 fw_xferq_drain(struct fw_xferq *xferq)
578 struct fw_xfer *xfer;
580 while ((xfer = STAILQ_FIRST(&xferq->q)) != NULL) {
581 STAILQ_REMOVE_HEAD(&xferq->q, link);
586 xfer->flag = FWXF_SENTERR;
592 fw_drain_txq(struct firewire_comm *fc)
594 struct fw_xfer *xfer, *txfer;
595 STAILQ_HEAD(, fw_xfer) xfer_drain;
598 STAILQ_INIT(&xfer_drain);
601 fw_xferq_drain(fc->atq);
602 fw_xferq_drain(fc->ats);
603 for(i = 0; i < fc->nisodma; i++)
604 fw_xferq_drain(fc->it[i]);
607 mtx_lock(&fc->tlabel_lock);
608 for (i = 0; i < 0x40; i ++)
609 while ((xfer = STAILQ_FIRST(&fc->tlabels[i])) != NULL) {
611 printf("tl=%d flag=%d\n", i, xfer->flag);
613 STAILQ_REMOVE_HEAD(&fc->tlabels[i], tlabel);
614 STAILQ_INSERT_TAIL(&xfer_drain, xfer, tlabel);
616 mtx_unlock(&fc->tlabel_lock);
618 STAILQ_FOREACH_SAFE(xfer, &xfer_drain, tlabel, txfer)
623 fw_reset_csr(struct firewire_comm *fc)
627 CSRARC(fc, STATE_CLEAR)
628 = 1 << 23 | 0 << 17 | 1 << 16 | 1 << 15 | 1 << 14 ;
629 CSRARC(fc, STATE_SET) = CSRARC(fc, STATE_CLEAR);
630 CSRARC(fc, NODE_IDS) = 0x3f;
632 CSRARC(fc, TOPO_MAP + 8) = 0;
637 for(i = 2; i < 0x100/4 - 2 ; i++){
638 CSRARC(fc, SPED_MAP + i * 4) = 0;
640 CSRARC(fc, STATE_CLEAR) = 1 << 23 | 0 << 17 | 1 << 16 | 1 << 15 | 1 << 14 ;
641 CSRARC(fc, STATE_SET) = CSRARC(fc, STATE_CLEAR);
642 CSRARC(fc, RESET_START) = 0;
643 CSRARC(fc, SPLIT_TIMEOUT_HI) = 0;
644 CSRARC(fc, SPLIT_TIMEOUT_LO) = 800 << 19;
645 CSRARC(fc, CYCLE_TIME) = 0x0;
646 CSRARC(fc, BUS_TIME) = 0x0;
647 CSRARC(fc, BUS_MGR_ID) = 0x3f;
648 CSRARC(fc, BANDWIDTH_AV) = 4915;
649 CSRARC(fc, CHANNELS_AV_HI) = 0xffffffff;
650 CSRARC(fc, CHANNELS_AV_LO) = 0xffffffff;
651 CSRARC(fc, IP_CHANNELS) = (1 << 31);
653 CSRARC(fc, CONF_ROM) = 0x04 << 24;
654 CSRARC(fc, CONF_ROM + 4) = 0x31333934; /* means strings 1394 */
655 CSRARC(fc, CONF_ROM + 8) = 1 << 31 | 1 << 30 | 1 << 29 |
656 1 << 28 | 0xff << 16 | 0x09 << 8;
657 CSRARC(fc, CONF_ROM + 0xc) = 0;
659 /* DV depend CSRs see blue book */
660 CSRARC(fc, oPCR) &= ~DV_BROADCAST_ON;
661 CSRARC(fc, iPCR) &= ~DV_BROADCAST_ON;
663 CSRARC(fc, STATE_CLEAR) &= ~(1 << 23 | 1 << 15 | 1 << 14 );
664 CSRARC(fc, STATE_SET) = CSRARC(fc, STATE_CLEAR);
668 fw_init_crom(struct firewire_comm *fc)
670 struct crom_src *src;
672 src = &fc->crom_src_buf->src;
673 bzero(src, sizeof(struct crom_src));
675 /* BUS info sample */
676 src->hdr.info_len = 4;
678 src->businfo.bus_name = CSR_BUS_NAME_IEEE1394;
680 src->businfo.irmc = 1;
681 src->businfo.cmc = 1;
682 src->businfo.isc = 1;
683 src->businfo.bmc = 1;
684 src->businfo.pmc = 0;
685 src->businfo.cyc_clk_acc = 100;
686 src->businfo.max_rec = fc->maxrec;
687 src->businfo.max_rom = MAXROM_4;
688 #define FW_GENERATION_CHANGEABLE 2
689 src->businfo.generation = FW_GENERATION_CHANGEABLE;
690 src->businfo.link_spd = fc->speed;
692 src->businfo.eui64.hi = fc->eui.hi;
693 src->businfo.eui64.lo = fc->eui.lo;
695 STAILQ_INIT(&src->chunk_list);
698 fc->crom_root = &fc->crom_src_buf->root;
702 fw_reset_crom(struct firewire_comm *fc)
704 struct crom_src_buf *buf;
705 struct crom_src *src;
706 struct crom_chunk *root;
708 buf = fc->crom_src_buf;
710 root = fc->crom_root;
712 STAILQ_INIT(&src->chunk_list);
714 bzero(root, sizeof(struct crom_chunk));
715 crom_add_chunk(src, NULL, root, 0);
716 crom_add_entry(root, CSRKEY_NCAP, 0x0083c0); /* XXX */
717 /* private company_id */
718 crom_add_entry(root, CSRKEY_VENDOR, CSRVAL_VENDOR_PRIVATE);
720 crom_add_simple_text(src, root, &buf->vendor, "DragonFly Project");
721 crom_add_entry(root, CSRKEY_HW, __DragonFly_cc_version);
723 crom_add_simple_text(src, root, &buf->vendor, "FreeBSD Project");
724 crom_add_entry(root, CSRKEY_HW, __FreeBSD_version);
726 mtx_lock(&prison0.pr_mtx);
727 crom_add_simple_text(src, root, &buf->hw, prison0.pr_hostname);
728 mtx_unlock(&prison0.pr_mtx);
732 * Called after bus reset.
735 fw_busreset(struct firewire_comm *fc, uint32_t new_status)
737 struct firewire_dev_comm *fdc;
738 struct crom_src *src;
744 if (fc->status == FWBUSMGRELECT)
745 callout_stop(&fc->bmr_callout);
747 fc->status = new_status;
750 if (fc->status == FWBUSNOTREADY)
755 if (device_get_children(fc->bdev, &devlistp, &devcnt) == 0) {
756 for( i = 0 ; i < devcnt ; i++)
757 if (device_get_state(devlistp[i]) >= DS_ATTACHED) {
758 fdc = device_get_softc(devlistp[i]);
759 if (fdc->post_busreset != NULL)
760 fdc->post_busreset(fdc);
762 free(devlistp, M_TEMP);
765 src = &fc->crom_src_buf->src;
767 * If the old config rom needs to be overwritten,
768 * bump the businfo.generation indicator to
769 * indicate that we need to be reprobed
770 * See 1394a-2000 8.3.2.5.4 for more details.
771 * generation starts at 2 and rolls over at 0xF
774 * A generation of 0 indicates a device
775 * that is not 1394a-2000 compliant.
776 * A generation of 1 indicates a device that
777 * does not change it's Bus Info Block or
780 #define FW_MAX_GENERATION 0xF
781 newrom = malloc(CROMSIZE, M_FW, M_NOWAIT | M_ZERO);
782 src = &fc->crom_src_buf->src;
783 crom_load(src, newrom, CROMSIZE);
784 if (bcmp(newrom, fc->config_rom, CROMSIZE) != 0) {
785 if ( src->businfo.generation++ > FW_MAX_GENERATION )
786 src->businfo.generation = FW_GENERATION_CHANGEABLE;
787 bcopy(newrom, (void *)fc->config_rom, CROMSIZE);
793 /* Call once after reboot */
794 void fw_init(struct firewire_comm *fc)
798 struct fw_xfer *xfer;
817 STAILQ_INIT(&fc->atq->q);
818 STAILQ_INIT(&fc->ats->q);
820 for( i = 0 ; i < fc->nisodma ; i ++ ){
821 fc->it[i]->queued = 0;
822 fc->ir[i]->queued = 0;
824 fc->it[i]->start = NULL;
825 fc->ir[i]->start = NULL;
827 fc->it[i]->buf = NULL;
828 fc->ir[i]->buf = NULL;
830 fc->it[i]->flag = FWXFERQ_STREAM;
831 fc->ir[i]->flag = FWXFERQ_STREAM;
833 STAILQ_INIT(&fc->it[i]->q);
834 STAILQ_INIT(&fc->ir[i]->q);
837 fc->arq->maxq = FWMAXQUEUE;
838 fc->ars->maxq = FWMAXQUEUE;
839 fc->atq->maxq = FWMAXQUEUE;
840 fc->ats->maxq = FWMAXQUEUE;
842 for( i = 0 ; i < fc->nisodma ; i++){
843 fc->ir[i]->maxq = FWMAXQUEUE;
844 fc->it[i]->maxq = FWMAXQUEUE;
847 CSRARC(fc, TOPO_MAP) = 0x3f1 << 16;
848 CSRARC(fc, TOPO_MAP + 4) = 1;
849 CSRARC(fc, SPED_MAP) = 0x3f1 << 16;
850 CSRARC(fc, SPED_MAP + 4) = 1;
852 STAILQ_INIT(&fc->devices);
854 /* Initialize Async handlers */
855 STAILQ_INIT(&fc->binds);
856 for( i = 0 ; i < 0x40 ; i++){
857 STAILQ_INIT(&fc->tlabels[i]);
860 /* DV depend CSRs see blue book */
862 CSRARC(fc, oMPR) = 0x3fff0001; /* # output channel = 1 */
863 CSRARC(fc, oPCR) = 0x8000007a;
864 for(i = 4 ; i < 0x7c/4 ; i+=4){
865 CSRARC(fc, i + oPCR) = 0x8000007a;
868 CSRARC(fc, iMPR) = 0x00ff0001; /* # input channel = 1 */
869 CSRARC(fc, iPCR) = 0x803f0000;
870 for(i = 4 ; i < 0x7c/4 ; i+=4){
871 CSRARC(fc, i + iPCR) = 0x0;
875 fc->crom_src_buf = NULL;
878 xfer = fw_xfer_alloc();
879 if(xfer == NULL) return;
881 fwb = (struct fw_bind *)malloc(sizeof (struct fw_bind), M_FW, M_NOWAIT);
886 xfer->hand = fw_vmaccess;
892 fwb->addrlen = 0xffffffff;
898 #define BIND_CMP(addr, fwb) (((addr) < (fwb)->start)?-1:\
899 ((fwb)->end < (addr))?1:0)
902 * To lookup bound process from IEEE1394 address.
905 fw_bindlookup(struct firewire_comm *fc, uint16_t dest_hi, uint32_t dest_lo)
908 struct fw_bind *tfw, *r = NULL;
910 addr = ((u_int64_t)dest_hi << 32) | dest_lo;
912 STAILQ_FOREACH(tfw, &fc->binds, fclist)
913 if (BIND_CMP(addr, tfw) == 0) {
922 * To bind IEEE1394 address block to process.
925 fw_bindadd(struct firewire_comm *fc, struct fw_bind *fwb)
927 struct fw_bind *tfw, *prev = NULL;
930 if (fwb->start > fwb->end) {
931 printf("%s: invalid range\n", __func__);
936 STAILQ_FOREACH(tfw, &fc->binds, fclist) {
937 if (fwb->end < tfw->start)
942 STAILQ_INSERT_HEAD(&fc->binds, fwb, fclist);
943 else if (prev->end < fwb->start)
944 STAILQ_INSERT_AFTER(&fc->binds, prev, fwb, fclist);
946 printf("%s: bind failed\n", __func__);
954 * To free IEEE1394 address block.
957 fw_bindremove(struct firewire_comm *fc, struct fw_bind *fwb)
960 struct fw_xfer *xfer, *next;
967 STAILQ_FOREACH(tfw, &fc->binds, fclist)
969 STAILQ_REMOVE(&fc->binds, fwb, fw_bind, fclist);
973 printf("%s: no such binding\n", __func__);
979 /* shall we do this? */
980 for (xfer = STAILQ_FIRST(&fwb->xferlist); xfer != NULL; xfer = next) {
981 next = STAILQ_NEXT(xfer, link);
984 STAILQ_INIT(&fwb->xferlist);
993 fw_xferlist_add(struct fw_xferlist *q, struct malloc_type *type,
994 int slen, int rlen, int n,
995 struct firewire_comm *fc, void *sc, void (*hand)(struct fw_xfer *))
998 struct fw_xfer *xfer;
1000 for (i = 0; i < n; i++) {
1001 xfer = fw_xfer_alloc_buf(type, slen, rlen);
1008 STAILQ_INSERT_TAIL(q, xfer, link);
1015 fw_xferlist_remove(struct fw_xferlist *q)
1017 struct fw_xfer *xfer, *next;
1019 for (xfer = STAILQ_FIRST(q); xfer != NULL; xfer = next) {
1020 next = STAILQ_NEXT(xfer, link);
1021 fw_xfer_free_buf(xfer);
1026 * dump packet header
1029 fw_dump_hdr(struct fw_pkt *fp, char *prefix)
1031 printf("%s: dst=0x%02x tl=0x%02x rt=%d tcode=0x%x pri=0x%x "
1032 "src=0x%03x\n", prefix,
1033 fp->mode.hdr.dst & 0x3f,
1034 fp->mode.hdr.tlrt >> 2, fp->mode.hdr.tlrt & 3,
1035 fp->mode.hdr.tcode, fp->mode.hdr.pri,
1040 * To free transaction label.
1043 fw_tl_free(struct firewire_comm *fc, struct fw_xfer *xfer)
1045 struct fw_xfer *txfer;
1052 mtx_lock(&fc->tlabel_lock);
1053 #if 1 /* make sure the label is allocated */
1054 STAILQ_FOREACH(txfer, &fc->tlabels[xfer->tl], tlabel)
1057 if (txfer == NULL) {
1058 printf("%s: the xfer is not in the queue "
1059 "(tlabel=%d, flag=0x%x)\n",
1060 __FUNCTION__, xfer->tl, xfer->flag);
1061 fw_dump_hdr(&xfer->send.hdr, "send");
1062 fw_dump_hdr(&xfer->recv.hdr, "recv");
1064 mtx_unlock(&fc->tlabel_lock);
1070 STAILQ_REMOVE(&fc->tlabels[xfer->tl], xfer, fw_xfer, tlabel);
1071 mtx_unlock(&fc->tlabel_lock);
1077 * To obtain XFER structure by transaction label.
1079 static struct fw_xfer *
1080 fw_tl2xfer(struct firewire_comm *fc, int node, int tlabel, int tcode)
1082 struct fw_xfer *xfer;
1086 mtx_lock(&fc->tlabel_lock);
1087 STAILQ_FOREACH(xfer, &fc->tlabels[tlabel], tlabel)
1088 if(xfer->send.hdr.mode.hdr.dst == node) {
1089 mtx_unlock(&fc->tlabel_lock);
1091 KASSERT(xfer->tl == tlabel,
1092 ("xfer->tl 0x%x != 0x%x", xfer->tl, tlabel));
1093 /* extra sanity check */
1094 req = xfer->send.hdr.mode.hdr.tcode;
1095 if (xfer->fc->tcode[req].valid_res != tcode) {
1096 printf("%s: invalid response tcode "
1097 "(0x%x for 0x%x)\n", __FUNCTION__,
1102 if (firewire_debug > 2)
1103 printf("fw_tl2xfer: found tl=%d\n", tlabel);
1106 mtx_unlock(&fc->tlabel_lock);
1107 if (firewire_debug > 1)
1108 printf("fw_tl2xfer: not found tl=%d\n", tlabel);
1114 * To allocate IEEE1394 XFER structure.
1117 fw_xfer_alloc(struct malloc_type *type)
1119 struct fw_xfer *xfer;
1121 xfer = malloc(sizeof(struct fw_xfer), type, M_NOWAIT | M_ZERO);
1125 xfer->malloc = type;
1131 fw_xfer_alloc_buf(struct malloc_type *type, int send_len, int recv_len)
1133 struct fw_xfer *xfer;
1135 xfer = fw_xfer_alloc(type);
1138 xfer->send.pay_len = send_len;
1139 xfer->recv.pay_len = recv_len;
1141 xfer->send.payload = malloc(send_len, type, M_NOWAIT | M_ZERO);
1142 if (xfer->send.payload == NULL) {
1148 xfer->recv.payload = malloc(recv_len, type, M_NOWAIT);
1149 if (xfer->recv.payload == NULL) {
1150 if (xfer->send.payload != NULL)
1151 free(xfer->send.payload, type);
1160 * IEEE1394 XFER post process.
1163 fw_xfer_done(struct fw_xfer *xfer)
1165 if (xfer->hand == NULL) {
1166 printf("hand == NULL\n");
1170 if (xfer->fc == NULL)
1171 panic("fw_xfer_done: why xfer->fc is NULL?");
1173 fw_tl_free(xfer->fc, xfer);
1178 fw_xfer_unload(struct fw_xfer* xfer)
1182 if(xfer == NULL ) return;
1183 if(xfer->flag & FWXF_INQ){
1184 printf("fw_xfer_free FWXF_INQ\n");
1187 STAILQ_REMOVE(&xfer->q->q, xfer, fw_xfer, link);
1191 FW_GUNLOCK(xfer->fc);
1194 if (xfer->fc != NULL) {
1196 if(xfer->flag & FWXF_START)
1198 * This could happen if:
1199 * 1. We call fwohci_arcv() before fwohci_txd().
1200 * 2. firewire_watch() is called.
1202 printf("fw_xfer_free FWXF_START\n");
1205 xfer->flag = FWXF_INIT;
1209 * To free IEEE1394 XFER structure.
1212 fw_xfer_free_buf( struct fw_xfer* xfer)
1215 printf("%s: xfer == NULL\n", __func__);
1218 fw_xfer_unload(xfer);
1219 if(xfer->send.payload != NULL){
1220 free(xfer->send.payload, xfer->malloc);
1222 if(xfer->recv.payload != NULL){
1223 free(xfer->recv.payload, xfer->malloc);
1225 free(xfer, xfer->malloc);
1229 fw_xfer_free( struct fw_xfer* xfer)
1232 printf("%s: xfer == NULL\n", __func__);
1235 fw_xfer_unload(xfer);
1236 free(xfer, xfer->malloc);
1240 fw_asy_callback_free(struct fw_xfer *xfer)
1243 printf("asyreq done flag=0x%02x resp=%d\n",
1244 xfer->flag, xfer->resp);
1253 fw_phy_config(struct firewire_comm *fc, int root_node, int gap_count)
1255 struct fw_xfer *xfer;
1258 fc->status = FWBUSPHYCONF;
1260 xfer = fw_xfer_alloc(M_FWXFER);
1264 xfer->hand = fw_asy_callback_free;
1266 fp = &xfer->send.hdr;
1269 fp->mode.ld[1] |= (root_node & 0x3f) << 24 | 1 << 23;
1271 fp->mode.ld[1] |= 1 << 22 | (gap_count & 0x3f) << 16;
1272 fp->mode.ld[2] = ~fp->mode.ld[1];
1273 /* XXX Dangerous, how to pass PHY packet to device driver */
1274 fp->mode.common.tcode |= FWTCODE_PHY;
1277 device_printf(fc->bdev, "%s: root_node=%d gap_count=%d\n",
1278 __func__, root_node, gap_count);
1279 fw_asyreq(fc, -1, xfer);
1286 fw_print_sid(uint32_t sid)
1288 union fw_self_id *s;
1289 s = (union fw_self_id *) &sid;
1290 if ( s->p0.sequel ) {
1291 if ( s->p1.sequence_num == FW_SELF_ID_PAGE0 ) {
1292 printf("node:%d p3:%d p4:%d p5:%d p6:%d p7:%d"
1293 "p8:%d p9:%d p10:%d\n",
1294 s->p1.phy_id, s->p1.port3, s->p1.port4,
1295 s->p1.port5, s->p1.port6, s->p1.port7,
1296 s->p1.port8, s->p1.port9, s->p1.port10);
1297 } else if (s->p2.sequence_num == FW_SELF_ID_PAGE1 ){
1298 printf("node:%d p11:%d p12:%d p13:%d p14:%d p15:%d\n",
1299 s->p2.phy_id, s->p2.port11, s->p2.port12,
1300 s->p2.port13, s->p2.port14, s->p2.port15);
1302 printf("node:%d Unknown Self ID Page number %d\n",
1303 s->p1.phy_id, s->p1.sequence_num);
1306 printf("node:%d link:%d gap:%d spd:%d con:%d pwr:%d"
1307 " p0:%d p1:%d p2:%d i:%d m:%d\n",
1308 s->p0.phy_id, s->p0.link_active, s->p0.gap_count,
1309 s->p0.phy_speed, s->p0.contender,
1310 s->p0.power_class, s->p0.port0, s->p0.port1,
1311 s->p0.port2, s->p0.initiated_reset, s->p0.more_packets);
1316 * To receive self ID.
1318 void fw_sidrcv(struct firewire_comm* fc, uint32_t *sid, u_int len)
1321 union fw_self_id *self_id;
1322 u_int i, j, node, c_port = 0, i_branch = 0;
1324 fc->sid_cnt = len /(sizeof(uint32_t) * 2);
1325 fc->max_node = fc->nodeid & 0x3f;
1326 CSRARC(fc, NODE_IDS) = ((uint32_t)fc->nodeid) << 16;
1327 fc->status = FWBUSCYMELECT;
1328 fc->topology_map->crc_len = 2;
1329 fc->topology_map->generation ++;
1330 fc->topology_map->self_id_count = 0;
1331 fc->topology_map->node_count = 0;
1332 fc->speed_map->generation ++;
1333 fc->speed_map->crc_len = 1 + (64*64 + 3) / 4;
1334 self_id = &fc->topology_map->self_id[0];
1335 for(i = 0; i < fc->sid_cnt; i ++){
1336 if (sid[1] != ~sid[0]) {
1337 device_printf(fc->bdev, "%s: ERROR invalid self-id packet\n",
1342 *self_id = *((union fw_self_id *)sid);
1343 fc->topology_map->crc_len++;
1344 if(self_id->p0.sequel == 0){
1345 fc->topology_map->node_count ++;
1348 fw_print_sid(sid[0]);
1349 node = self_id->p0.phy_id;
1350 if(fc->max_node < node){
1351 fc->max_node = self_id->p0.phy_id;
1353 /* XXX I'm not sure this is the right speed_map */
1354 fc->speed_map->speed[node][node]
1355 = self_id->p0.phy_speed;
1356 for (j = 0; j < node; j ++) {
1357 fc->speed_map->speed[j][node]
1358 = fc->speed_map->speed[node][j]
1359 = min(fc->speed_map->speed[j][j],
1360 self_id->p0.phy_speed);
1362 if ((fc->irm == -1 || self_id->p0.phy_id > fc->irm) &&
1363 (self_id->p0.link_active && self_id->p0.contender)) {
1364 fc->irm = self_id->p0.phy_id;
1366 if(self_id->p0.port0 >= 0x2){
1369 if(self_id->p0.port1 >= 0x2){
1372 if(self_id->p0.port2 >= 0x2){
1377 i_branch += (c_port - 2);
1381 fc->topology_map->self_id_count ++;
1384 fc->topology_map->crc = fw_crc16(
1385 (uint32_t *)&fc->topology_map->generation,
1386 fc->topology_map->crc_len * 4);
1387 fc->speed_map->crc = fw_crc16(
1388 (uint32_t *)&fc->speed_map->generation,
1389 fc->speed_map->crc_len * 4);
1390 /* byteswap and copy to CSR */
1391 p = (uint32_t *)fc->topology_map;
1392 for (i = 0; i <= fc->topology_map->crc_len; i++)
1393 CSRARC(fc, TOPO_MAP + i * 4) = htonl(*p++);
1394 p = (uint32_t *)fc->speed_map;
1395 CSRARC(fc, SPED_MAP) = htonl(*p++);
1396 CSRARC(fc, SPED_MAP + 4) = htonl(*p++);
1397 /* don't byte-swap uint8_t array */
1398 bcopy(p, &CSRARC(fc, SPED_MAP + 8), (fc->speed_map->crc_len - 1)*4);
1400 fc->max_hop = fc->max_node - i_branch;
1401 device_printf(fc->bdev, "%d nodes, maxhop <= %d %s irm(%d) %s\n",
1402 fc->max_node + 1, fc->max_hop,
1403 (fc->irm == -1) ? "Not IRM capable" : "cable IRM",
1405 (fc->irm == fc->nodeid) ? " (me) " : "");
1407 if (try_bmr && (fc->irm != -1) && (CSRARC(fc, BUS_MGR_ID) == 0x3f)) {
1408 if (fc->irm == fc->nodeid) {
1409 fc->status = FWBUSMGRDONE;
1410 CSRARC(fc, BUS_MGR_ID) = fc->set_bmr(fc, fc->irm);
1413 fc->status = FWBUSMGRELECT;
1414 callout_reset(&fc->bmr_callout, hz/8,
1415 (void *)fw_try_bmr, (void *)fc);
1418 fc->status = FWBUSMGRDONE;
1420 callout_reset(&fc->busprobe_callout, hz/4,
1421 (void *)fw_bus_probe, (void *)fc);
1425 * To probe devices on the IEEE1394 bus.
1428 fw_bus_probe(struct firewire_comm *fc)
1431 struct fw_device *fwdev;
1434 fc->status = FWBUSEXPLORE;
1436 /* Invalidate all devices, just after bus reset. */
1438 device_printf(fc->bdev, "%s:"
1439 "iterate and invalidate all nodes\n",
1441 STAILQ_FOREACH(fwdev, &fc->devices, link)
1442 if (fwdev->status != FWDEVINVAL) {
1443 fwdev->status = FWDEVINVAL;
1446 device_printf(fc->bdev, "%s:"
1447 "Invalidate Dev ID: %08x%08x\n",
1448 __func__, fwdev->eui.hi, fwdev->eui.lo);
1451 device_printf(fc->bdev, "%s:"
1452 "Dev ID: %08x%08x already invalid\n",
1453 __func__, fwdev->eui.hi, fwdev->eui.lo);
1461 fw_explore_read_quads(struct fw_device *fwdev, int offset,
1462 uint32_t *quad, int length)
1464 struct fw_xfer *xfer;
1468 for (i = 0; i < length; i ++, offset += sizeof(uint32_t)) {
1469 xfer = fwmem_read_quad(fwdev, NULL, -1,
1470 0xffff, 0xf0000000 | offset, (void *)&tmp,
1476 if (xfer->resp == 0)
1477 quad[i] = ntohl(tmp);
1489 fw_explore_csrblock(struct fw_device *fwdev, int offset, int recur)
1492 struct csrdirectory *dir;
1495 dir = (struct csrdirectory *)&fwdev->csrrom[offset/sizeof(uint32_t)];
1496 err = fw_explore_read_quads(fwdev, CSRROMOFF + offset,
1497 (uint32_t *)dir, 1);
1501 offset += sizeof(uint32_t);
1502 reg = (struct csrreg *)&fwdev->csrrom[offset/sizeof(uint32_t)];
1503 err = fw_explore_read_quads(fwdev, CSRROMOFF + offset,
1504 (uint32_t *)reg, dir->crc_len);
1510 off = CSRROMOFF + offset + sizeof(uint32_t) * (dir->crc_len - 1);
1511 if (fwdev->rommax < off)
1512 fwdev->rommax = off;
1517 for (i = 0; i < dir->crc_len; i ++, offset += sizeof(uint32_t)) {
1518 if ((reg[i].key & CSRTYPE_MASK) == CSRTYPE_D)
1520 else if ((reg[i].key & CSRTYPE_MASK) == CSRTYPE_L)
1525 off = offset + reg[i].val * sizeof(uint32_t);
1526 if (off > CROMSIZE) {
1527 printf("%s: invalid offset %d\n", __FUNCTION__, off);
1530 err = fw_explore_csrblock(fwdev, off, recur);
1538 fw_explore_node(struct fw_device *dfwdev)
1540 struct firewire_comm *fc;
1541 struct fw_device *fwdev, *pfwdev, *tfwdev;
1544 struct bus_info *binfo;
1546 uint32_t speed_test = 0;
1549 csr = dfwdev->csrrom;
1553 err = fw_explore_read_quads(dfwdev, CSRROMOFF, &csr[0], 1);
1555 device_printf(fc->bdev, "%s: node%d: explore_read_quads failure\n",
1557 dfwdev->status = FWDEVINVAL;
1560 hdr = (struct csrhdr *)&csr[0];
1561 if (hdr->info_len != 4) {
1563 device_printf(fc->bdev, "%s: node%d: wrong bus info len(%d)\n",
1564 __func__, node, hdr->info_len);
1565 dfwdev->status = FWDEVINVAL;
1570 err = fw_explore_read_quads(dfwdev, CSRROMOFF + 0x04, &csr[1], 4);
1572 device_printf(fc->bdev, "%s: node%d: error reading 0x04\n",
1574 dfwdev->status = FWDEVINVAL;
1577 binfo = (struct bus_info *)&csr[1];
1578 if (binfo->bus_name != CSR_BUS_NAME_IEEE1394) {
1579 device_printf(fc->bdev, "%s: node%d: invalid bus name 0x%08x\n",
1580 __func__, node, binfo->bus_name);
1581 dfwdev->status = FWDEVINVAL;
1586 device_printf(fc->bdev, "%s: node(%d) BUS INFO BLOCK:\n"
1587 "irmc(%d) cmc(%d) isc(%d) bmc(%d) pmc(%d) "
1588 "cyc_clk_acc(%d) max_rec(%d) max_rom(%d) "
1589 "generation(%d) link_spd(%d)\n",
1591 binfo->irmc, binfo->cmc, binfo->isc,
1592 binfo->bmc, binfo->pmc, binfo->cyc_clk_acc,
1593 binfo->max_rec, binfo->max_rom,
1594 binfo->generation, binfo->link_spd);
1596 STAILQ_FOREACH(fwdev, &fc->devices, link)
1597 if (FW_EUI64_EQUAL(fwdev->eui, binfo->eui64))
1599 if (fwdev == NULL) {
1601 fwdev = malloc(sizeof(struct fw_device), M_FW,
1603 if (fwdev == NULL) {
1604 device_printf(fc->bdev, "%s: node%d: no memory\n",
1609 fwdev->eui = binfo->eui64;
1610 fwdev->dst = dfwdev->dst;
1611 fwdev->maxrec = dfwdev->maxrec;
1612 fwdev->status = dfwdev->status;
1615 * Pre-1394a-2000 didn't have link_spd in
1616 * the Bus Info block, so try and use the
1618 * 1394a-2000 compliant devices only use
1619 * the Bus Info Block link spd value, so
1620 * ignore the speed map alltogether. SWB
1622 if ( binfo->link_spd == FWSPD_S100 /* 0 */) {
1623 device_printf(fc->bdev, "%s: "
1624 "Pre 1394a-2000 detected\n",
1626 fwdev->speed = fc->speed_map->speed[fc->nodeid][node];
1628 fwdev->speed = binfo->link_spd;
1630 * Test this speed with a read to the CSRROM.
1631 * If it fails, slow down the speed and retry.
1633 while (fwdev->speed > FWSPD_S100 /* 0 */) {
1634 err = fw_explore_read_quads(fwdev, CSRROMOFF,
1637 device_printf(fc->bdev, "%s: fwdev->speed(%s)"
1638 " decremented due to negotiation\n",
1640 linkspeed[fwdev->speed]);
1648 * If the fwdev is not found in the
1649 * fc->devices TAILQ, then we will add it.
1652 STAILQ_FOREACH(tfwdev, &fc->devices, link) {
1653 if (tfwdev->eui.hi > fwdev->eui.hi ||
1654 (tfwdev->eui.hi == fwdev->eui.hi &&
1655 tfwdev->eui.lo > fwdev->eui.lo))
1660 STAILQ_INSERT_HEAD(&fc->devices, fwdev, link);
1662 STAILQ_INSERT_AFTER(&fc->devices, pfwdev, fwdev, link);
1664 device_printf(fc->bdev, "New %s device ID:%08x%08x\n",
1665 linkspeed[fwdev->speed],
1666 fwdev->eui.hi, fwdev->eui.lo);
1669 fwdev->status = FWDEVINIT;
1671 if (bcmp(&csr[0], &fwdev->csrrom[0], sizeof(uint32_t) * 5) == 0) {
1673 device_printf(fc->dev, "node%d: crom unchanged\n", node);
1678 bzero(&fwdev->csrrom[0], CROMSIZE);
1680 /* copy first quad and bus info block */
1681 bcopy(&csr[0], &fwdev->csrrom[0], sizeof(uint32_t) * 5);
1682 fwdev->rommax = CSRROMOFF + sizeof(uint32_t) * 4;
1684 err = fw_explore_csrblock(fwdev, 0x14, 1); /* root directory */
1688 device_printf(fc->dev, "%s: explore csrblock failed err(%d)\n",
1690 fwdev->status = FWDEVINVAL;
1691 fwdev->csrrom[0] = 0;
1698 * Find the self_id packet for a node, ignoring sequels.
1700 static union fw_self_id *
1701 fw_find_self_id(struct firewire_comm *fc, int node)
1704 union fw_self_id *s;
1706 for (i = 0; i < fc->topology_map->self_id_count; i++) {
1707 s = &fc->topology_map->self_id[i];
1710 if (s->p0.phy_id == node)
1717 fw_explore(struct firewire_comm *fc)
1719 int node, err, s, i, todo, todo2, trys;
1721 struct fw_device dfwdev;
1722 union fw_self_id *fwsid;
1725 /* setup dummy fwdev */
1728 dfwdev.maxrec = 8; /* 512 */
1729 dfwdev.status = FWDEVINIT;
1731 for (node = 0; node <= fc->max_node; node ++) {
1732 /* We don't probe myself and linkdown nodes */
1733 if (node == fc->nodeid) {
1735 device_printf(fc->bdev, "%s:"
1736 "found myself node(%d) fc->nodeid(%d) fc->max_node(%d)\n",
1737 __func__, node, fc->nodeid, fc->max_node);
1739 } else if (firewire_debug) {
1740 device_printf(fc->bdev, "%s:"
1741 "node(%d) fc->max_node(%d) found\n",
1742 __func__, node, fc->max_node);
1744 fwsid = fw_find_self_id(fc, node);
1745 if (!fwsid || !fwsid->p0.link_active) {
1747 device_printf(fc->bdev, "%s: node%d: link down\n",
1751 nodes[todo++] = node;
1755 for (trys = 0; todo > 0 && trys < 3; trys ++) {
1757 for (i = 0; i < todo; i ++) {
1758 dfwdev.dst = nodes[i];
1759 err = fw_explore_node(&dfwdev);
1761 nodes[todo2++] = nodes[i];
1763 device_printf(fc->bdev, "%s: node %d, err = %d\n",
1764 __func__, node, err);
1773 fw_bus_probe_thread(void *arg)
1775 struct firewire_comm *fc;
1777 fc = (struct firewire_comm *)arg;
1779 mtx_lock(&fc->wait_lock);
1780 while (fc->status != FWBUSDETACH) {
1781 if (fc->status == FWBUSEXPLORE) {
1782 mtx_unlock(&fc->wait_lock);
1784 fc->status = FWBUSEXPDONE;
1786 printf("bus_explore done\n");
1788 mtx_lock(&fc->wait_lock);
1790 msleep((void *)fc, &fc->wait_lock, PWAIT|PCATCH, "-", 0);
1792 mtx_unlock(&fc->wait_lock);
1797 * To attach sub-devices layer onto IEEE1394 bus.
1800 fw_attach_dev(struct firewire_comm *fc)
1802 struct fw_device *fwdev, *next;
1806 struct firewire_dev_comm *fdc;
1808 for (fwdev = STAILQ_FIRST(&fc->devices); fwdev != NULL; fwdev = next) {
1809 next = STAILQ_NEXT(fwdev, link);
1810 if (fwdev->status == FWDEVINIT) {
1811 fwdev->status = FWDEVATTACHED;
1812 } else if (fwdev->status == FWDEVINVAL) {
1815 device_printf(fc->bdev, "%s:"
1816 "fwdev->rcnt(%d), hold_count(%d)\n",
1817 __func__, fwdev->rcnt, hold_count);
1818 if (fwdev->rcnt > hold_count) {
1820 * Remove devices which have not been seen
1823 device_printf(fc->bdev, "%s:"
1824 "Removing missing device ID:%08x%08x\n",
1825 __func__, fwdev->eui.hi, fwdev->eui.lo);
1826 STAILQ_REMOVE(&fc->devices, fwdev, fw_device,
1833 err = device_get_children(fc->bdev, &devlistp, &devcnt);
1835 for( i = 0 ; i < devcnt ; i++){
1836 if (device_get_state(devlistp[i]) >= DS_ATTACHED) {
1837 fdc = device_get_softc(devlistp[i]);
1838 if (fdc->post_explore != NULL)
1839 fdc->post_explore(fdc);
1842 free(devlistp, M_TEMP);
1849 * To allocate unique transaction label.
1852 fw_get_tlabel(struct firewire_comm *fc, struct fw_xfer *xfer)
1854 u_int dst, new_tlabel;
1855 struct fw_xfer *txfer;
1858 dst = xfer->send.hdr.mode.hdr.dst & 0x3f;
1860 mtx_lock(&fc->tlabel_lock);
1861 new_tlabel = (fc->last_tlabel[dst] + 1) & 0x3f;
1862 STAILQ_FOREACH(txfer, &fc->tlabels[new_tlabel], tlabel)
1863 if ((txfer->send.hdr.mode.hdr.dst & 0x3f) == dst)
1866 fc->last_tlabel[dst] = new_tlabel;
1867 STAILQ_INSERT_TAIL(&fc->tlabels[new_tlabel], xfer, tlabel);
1868 mtx_unlock(&fc->tlabel_lock);
1870 xfer->tl = new_tlabel;
1871 xfer->send.hdr.mode.hdr.tlrt = new_tlabel << 2;
1872 if (firewire_debug > 1)
1873 printf("fw_get_tlabel: dst=%d tl=%d\n", dst, new_tlabel);
1874 return (new_tlabel);
1876 mtx_unlock(&fc->tlabel_lock);
1879 if (firewire_debug > 1)
1880 printf("fw_get_tlabel: no free tlabel\n");
1885 fw_rcv_copy(struct fw_rcv_buf *rb)
1889 struct tcode_info *tinfo;
1890 u_int res, i, len, plen;
1892 rb->xfer->recv.spd = rb->spd;
1894 pkt = (struct fw_pkt *)rb->vec->iov_base;
1895 tinfo = &rb->fc->tcode[pkt->mode.hdr.tcode];
1898 p = (u_char *)&rb->xfer->recv.hdr;
1899 bcopy(rb->vec->iov_base, p, tinfo->hdr_len);
1900 rb->vec->iov_base = (u_char *)rb->vec->iov_base + tinfo->hdr_len;
1901 rb->vec->iov_len -= tinfo->hdr_len;
1904 p = (u_char *)rb->xfer->recv.payload;
1905 res = rb->xfer->recv.pay_len;
1907 /* special handling for RRESQ */
1908 if (pkt->mode.hdr.tcode == FWTCODE_RRESQ &&
1909 p != NULL && res >= sizeof(uint32_t)) {
1910 *(uint32_t *)p = pkt->mode.rresq.data;
1911 rb->xfer->recv.pay_len = sizeof(uint32_t);
1915 if ((tinfo->flag & FWTI_BLOCK_ASY) == 0)
1918 plen = pkt->mode.rresb.len;
1920 for (i = 0; i < rb->nvec; i++, rb->vec++) {
1921 len = MIN(rb->vec->iov_len, plen);
1923 device_printf(rb->fc->bdev, "%s:"
1924 " rcv buffer(%d) is %d bytes short.\n",
1925 __func__, rb->xfer->recv.pay_len, len - res);
1928 bcopy(rb->vec->iov_base, p, len);
1932 if (res == 0 || plen == 0)
1935 rb->xfer->recv.pay_len -= res;
1940 * Generic packet receiving process.
1943 fw_rcv(struct fw_rcv_buf *rb)
1945 struct fw_pkt *fp, *resfp;
1946 struct fw_bind *bind;
1948 int i, len, oldstate;
1953 qld = (uint32_t *)buf;
1954 printf("spd %d len:%d\n", spd, len);
1955 for( i = 0 ; i <= len && i < 32; i+= 4){
1956 printf("0x%08x ", ntohl(qld[i/4]));
1957 if((i % 16) == 15) printf("\n");
1959 if((i % 16) != 15) printf("\n");
1962 fp = (struct fw_pkt *)rb->vec[0].iov_base;
1963 tcode = fp->mode.common.tcode;
1969 rb->xfer = fw_tl2xfer(rb->fc, fp->mode.hdr.src,
1970 fp->mode.hdr.tlrt >> 2, fp->mode.hdr.tcode);
1971 if(rb->xfer == NULL) {
1972 device_printf(rb->fc->bdev, "%s: "
1974 "%s(%x) src=0x%x tl=0x%x rt=%d data=0x%x\n",
1976 tcode_str[tcode], tcode,
1978 fp->mode.hdr.tlrt >> 2,
1979 fp->mode.hdr.tlrt & 3,
1980 fp->mode.rresq.data);
1982 printf("try ad-hoc work around!!\n");
1983 rb->xfer = fw_tl2xfer(rb->fc, fp->mode.hdr.src,
1984 (fp->mode.hdr.tlrt >> 2)^3);
1985 if (rb->xfer == NULL) {
1986 printf("no use...\n");
1994 if (rb->xfer->recv.hdr.mode.wres.rtcode != RESP_CMP)
1995 rb->xfer->resp = EIO;
1998 /* make sure the packet is drained in AT queue */
1999 oldstate = rb->xfer->flag;
2000 rb->xfer->flag = FWXF_RCVD;
2003 fw_xfer_done(rb->xfer);
2008 printf("not sent yet tl=%x\n", rb->xfer->tl);
2012 device_printf(rb->fc->bdev, "%s: "
2013 "unexpected flag 0x%02x\n", __func__, rb->xfer->flag);
2021 bind = fw_bindlookup(rb->fc, fp->mode.rreqq.dest_hi,
2022 fp->mode.rreqq.dest_lo);
2024 device_printf(rb->fc->bdev, "%s: "
2025 "Unknown service addr 0x%04x:0x%08x %s(%x)"
2026 #if defined(__DragonFly__) || __FreeBSD_version < 500000
2027 " src=0x%x data=%lx\n",
2029 " src=0x%x data=%x\n",
2032 fp->mode.wreqq.dest_hi,
2033 fp->mode.wreqq.dest_lo,
2034 tcode_str[tcode], tcode,
2036 ntohl(fp->mode.wreqq.data));
2038 if (rb->fc->status == FWBUSINIT) {
2039 device_printf(rb->fc->bdev, "%s: cannot respond(bus reset)!\n",
2043 rb->xfer = fw_xfer_alloc(M_FWXFER);
2044 if(rb->xfer == NULL){
2047 rb->xfer->send.spd = rb->spd;
2048 rb->xfer->send.pay_len = 0;
2049 resfp = &rb->xfer->send.hdr;
2053 resfp->mode.hdr.tcode = FWTCODE_WRES;
2056 resfp->mode.hdr.tcode = FWTCODE_RRESQ;
2059 resfp->mode.hdr.tcode = FWTCODE_RRESB;
2062 resfp->mode.hdr.tcode = FWTCODE_LRES;
2065 resfp->mode.hdr.dst = fp->mode.hdr.src;
2066 resfp->mode.hdr.tlrt = fp->mode.hdr.tlrt;
2067 resfp->mode.hdr.pri = fp->mode.hdr.pri;
2068 resfp->mode.rresb.rtcode = RESP_ADDRESS_ERROR;
2069 resfp->mode.rresb.extcode = 0;
2070 resfp->mode.rresb.len = 0;
2072 rb->xfer->hand = fw_xferwake;
2074 rb->xfer->hand = fw_xfer_free;
2075 if(fw_asyreq(rb->fc, -1, rb->xfer)){
2076 fw_xfer_free(rb->xfer);
2082 for (i = 0; i < rb->nvec; i ++)
2083 len += rb->vec[i].iov_len;
2084 rb->xfer = STAILQ_FIRST(&bind->xferlist);
2085 if (rb->xfer == NULL) {
2086 device_printf(rb->fc->bdev, "%s: "
2087 "Discard a packet for this bind.\n",
2091 STAILQ_REMOVE_HEAD(&bind->xferlist, link);
2093 rb->xfer->hand(rb->xfer);
2095 #if 0 /* shouldn't happen ?? or for GASP */
2096 case FWTCODE_STREAM:
2098 struct fw_xferq *xferq;
2100 xferq = rb->fc->ir[sub];
2102 printf("stream rcv dma %d len %d off %d spd %d\n",
2103 sub, len, off, spd);
2105 if(xferq->queued >= xferq->maxq) {
2106 printf("receive queue is full\n");
2109 /* XXX get xfer from xfer queue, we don't need copy for
2111 rb->xfer = fw_xfer_alloc_buf(M_FWXFER, 0, /* XXX */
2113 if (rb->xfer == NULL)
2118 STAILQ_INSERT_TAIL(&xferq->q, rb->xfer, link);
2120 sc = device_get_softc(rb->fc->bdev);
2121 #if defined(__DragonFly__) || __FreeBSD_version < 500000
2122 if (&xferq->rsel.si_pid != 0)
2124 if (SEL_WAITING(&xferq->rsel))
2126 selwakeuppri(&xferq->rsel, FWPRI);
2127 if (xferq->flag & FWXFERQ_WAKEUP) {
2128 xferq->flag &= ~FWXFERQ_WAKEUP;
2129 wakeup((caddr_t)xferq);
2131 if (xferq->flag & FWXFERQ_HANDLER) {
2139 device_printf(rb->fc->bdev,"%s: unknown tcode %d\n",
2146 * Post process for Bus Manager election process.
2149 fw_try_bmr_callback(struct fw_xfer *xfer)
2151 struct firewire_comm *fc;
2157 if (xfer->resp != 0)
2159 if (xfer->recv.payload == NULL)
2161 if (xfer->recv.hdr.mode.lres.rtcode != FWRCODE_COMPLETE)
2164 bmr = ntohl(xfer->recv.payload[0]);
2168 CSRARC(fc, BUS_MGR_ID) = fc->set_bmr(fc, bmr & 0x3f);
2169 fw_xfer_free_buf(xfer);
2174 device_printf(fc->bdev, "bus manager election failed\n");
2175 fw_xfer_free_buf(xfer);
2180 * To candidate Bus Manager election process.
2183 fw_try_bmr(void *arg)
2185 struct fw_xfer *xfer;
2186 struct firewire_comm *fc = (struct firewire_comm *)arg;
2190 xfer = fw_xfer_alloc_buf(M_FWXFER, 8, 4);
2195 fc->status = FWBUSMGRELECT;
2197 fp = &xfer->send.hdr;
2198 fp->mode.lreq.dest_hi = 0xffff;
2199 fp->mode.lreq.tlrt = 0;
2200 fp->mode.lreq.tcode = FWTCODE_LREQ;
2201 fp->mode.lreq.pri = 0;
2202 fp->mode.lreq.src = 0;
2203 fp->mode.lreq.len = 8;
2204 fp->mode.lreq.extcode = EXTCODE_CMP_SWAP;
2205 fp->mode.lreq.dst = FWLOCALBUS | fc->irm;
2206 fp->mode.lreq.dest_lo = 0xf0000000 | BUS_MGR_ID;
2207 xfer->send.payload[0] = htonl(0x3f);
2208 xfer->send.payload[1] = htonl(fc->nodeid);
2209 xfer->hand = fw_try_bmr_callback;
2211 err = fw_asyreq(fc, -1, xfer);
2213 fw_xfer_free_buf(xfer);
2221 * Software implementation for physical memory block access.
2222 * XXX:Too slow, usef for debug purpose only.
2225 fw_vmaccess(struct fw_xfer *xfer){
2226 struct fw_pkt *rfp, *sfp = NULL;
2227 uint32_t *ld = (uint32_t *)xfer->recv.buf;
2229 printf("vmaccess spd:%2x len:%03x data:%08x %08x %08x %08x\n",
2230 xfer->spd, xfer->recv.len, ntohl(ld[0]), ntohl(ld[1]), ntohl(ld[2]), ntohl(ld[3]));
2231 printf("vmaccess data:%08x %08x %08x %08x\n", ntohl(ld[4]), ntohl(ld[5]), ntohl(ld[6]), ntohl(ld[7]));
2232 if(xfer->resp != 0){
2233 fw_xfer_free( xfer);
2236 if(xfer->recv.buf == NULL){
2237 fw_xfer_free( xfer);
2240 rfp = (struct fw_pkt *)xfer->recv.buf;
2241 switch(rfp->mode.hdr.tcode){
2242 /* XXX need fix for 64bit arch */
2244 xfer->send.buf = malloc(12, M_FW, M_NOWAIT);
2245 xfer->send.len = 12;
2246 sfp = (struct fw_pkt *)xfer->send.buf;
2247 bcopy(rfp->mode.wreqb.payload,
2248 (caddr_t)ntohl(rfp->mode.wreqb.dest_lo), ntohs(rfp->mode.wreqb.len));
2249 sfp->mode.wres.tcode = FWTCODE_WRES;
2250 sfp->mode.wres.rtcode = 0;
2253 xfer->send.buf = malloc(12, M_FW, M_NOWAIT);
2254 xfer->send.len = 12;
2255 sfp->mode.wres.tcode = FWTCODE_WRES;
2256 *((uint32_t *)(ntohl(rfp->mode.wreqb.dest_lo))) = rfp->mode.wreqq.data;
2257 sfp->mode.wres.rtcode = 0;
2260 xfer->send.buf = malloc(16 + rfp->mode.rreqb.len, M_FW, M_NOWAIT);
2261 xfer->send.len = 16 + ntohs(rfp->mode.rreqb.len);
2262 sfp = (struct fw_pkt *)xfer->send.buf;
2263 bcopy((caddr_t)ntohl(rfp->mode.rreqb.dest_lo),
2264 sfp->mode.rresb.payload, (uint16_t)ntohs(rfp->mode.rreqb.len));
2265 sfp->mode.rresb.tcode = FWTCODE_RRESB;
2266 sfp->mode.rresb.len = rfp->mode.rreqb.len;
2267 sfp->mode.rresb.rtcode = 0;
2268 sfp->mode.rresb.extcode = 0;
2271 xfer->send.buf = malloc(16, M_FW, M_NOWAIT);
2272 xfer->send.len = 16;
2273 sfp = (struct fw_pkt *)xfer->send.buf;
2274 sfp->mode.rresq.data = *(uint32_t *)(ntohl(rfp->mode.rreqq.dest_lo));
2275 sfp->mode.wres.tcode = FWTCODE_RRESQ;
2276 sfp->mode.rresb.rtcode = 0;
2279 fw_xfer_free( xfer);
2282 sfp->mode.hdr.dst = rfp->mode.hdr.src;
2283 xfer->dst = ntohs(rfp->mode.hdr.src);
2284 xfer->hand = fw_xfer_free;
2286 sfp->mode.hdr.tlrt = rfp->mode.hdr.tlrt;
2287 sfp->mode.hdr.pri = 0;
2289 fw_asyreq(xfer->fc, -1, xfer);
2296 * CRC16 check-sum for IEEE1394 register blocks.
2299 fw_crc16(uint32_t *ptr, uint32_t len){
2300 uint32_t i, sum, crc = 0;
2302 len = (len + 3) & ~3;
2303 for(i = 0 ; i < len ; i+= 4){
2304 for( shift = 28 ; shift >= 0 ; shift -= 4){
2305 sum = ((crc >> 12) ^ (ptr[i/4] >> shift)) & 0xf;
2306 crc = (crc << 4) ^ ( sum << 12 ) ^ ( sum << 5) ^ sum;
2310 return((uint16_t) crc);
2314 * Find the root node, if it is not
2315 * Cycle Master Capable, then we should
2316 * override this and become the Cycle
2320 fw_bmr(struct firewire_comm *fc)
2322 struct fw_device fwdev;
2323 union fw_self_id *self_id;
2327 /* Check to see if the current root node is cycle master capable */
2328 self_id = fw_find_self_id(fc, fc->max_node);
2329 if (fc->max_node > 0) {
2330 /* XXX check cmc bit of businfo block rather than contender */
2331 if (self_id->p0.link_active && self_id->p0.contender)
2332 cmstr = fc->max_node;
2334 device_printf(fc->bdev,
2335 "root node is not cycle master capable\n");
2336 /* XXX shall we be the cycle master? */
2338 /* XXX need bus reset */
2343 device_printf(fc->bdev, "bus manager %d %s\n",
2344 CSRARC(fc, BUS_MGR_ID),
2345 (CSRARC(fc, BUS_MGR_ID) != fc->nodeid) ? "(me)" : "");
2346 if(CSRARC(fc, BUS_MGR_ID) != fc->nodeid) {
2347 /* We are not the bus manager */
2351 /* Optimize gapcount */
2352 if(fc->max_hop <= MAX_GAPHOP )
2353 fw_phy_config(fc, cmstr, gap_cnt[fc->max_hop]);
2354 /* If we are the cycle master, nothing to do */
2355 if (cmstr == fc->nodeid || cmstr == -1)
2357 /* Bus probe has not finished, make dummy fwdev for cmstr */
2358 bzero(&fwdev, sizeof(fwdev));
2362 fwdev.maxrec = 8; /* 512 */
2363 fwdev.status = FWDEVINIT;
2364 /* Set cmstr bit on the cycle master */
2365 quad = htonl(1 << 8);
2366 fwmem_write_quad(&fwdev, NULL, 0/*spd*/,
2367 0xffff, 0xf0000000 | STATE_SET, &quad, fw_asy_callback_free);
2373 fw_open_isodma(struct firewire_comm *fc, int tx)
2375 struct fw_xferq **xferqa;
2376 struct fw_xferq *xferq;
2380 xferqa = &fc->it[0];
2382 xferqa = &fc->ir[0];
2385 for (i = 0; i < fc->nisodma; i ++) {
2387 if ((xferq->flag & FWXFERQ_OPEN) == 0) {
2388 xferq->flag |= FWXFERQ_OPEN;
2392 if (i == fc->nisodma) {
2393 printf("no free dma channel (tx=%d)\n", tx);
2401 fw_modevent(module_t mode, int type, void *data)
2404 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
2405 static eventhandler_tag fwdev_ehtag = NULL;
2410 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
2411 fwdev_ehtag = EVENTHANDLER_REGISTER(dev_clone,
2412 fwdev_clone, 0, 1000);
2416 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
2417 if (fwdev_ehtag != NULL)
2418 EVENTHANDLER_DEREGISTER(dev_clone, fwdev_ehtag);
2424 return (EOPNOTSUPP);
2430 #ifdef __DragonFly__
2431 DECLARE_DUMMY_MODULE(firewire);
2433 DRIVER_MODULE(firewire,fwohci,firewire_driver,firewire_devclass,fw_modevent,0);
2434 MODULE_VERSION(firewire, 1);