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.
34 * $FreeBSD: src/sys/dev/firewire/fwdev.c,v 1.36 2004/01/22 14:41:17 simokawa Exp $
35 * $DragonFly: src/sys/bus/firewire/fwdev.c,v 1.12 2006/07/28 02:17:33 dillon Exp $
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/types.h>
43 #if defined(__DragonFly__) || __FreeBSD_version < 500000
49 #include <sys/kernel.h>
50 #include <sys/malloc.h>
55 #include <sys/ctype.h>
56 #include <machine/bus.h>
58 #include <sys/ioccom.h>
59 #include <sys/thread2.h>
63 #include "firewirereg.h"
68 #include <dev/firewire/firewire.h>
69 #include <dev/firewire/firewirereg.h>
70 #include <dev/firewire/fwdma.h>
71 #include <dev/firewire/fwmem.h>
72 #include <dev/firewire/iec68113.h>
75 #define CDEV_MAJOR 127
76 #define FWNODE_INVAL 0xffff
78 static d_open_t fw_open;
79 static d_close_t fw_close;
80 static d_ioctl_t fw_ioctl;
81 static d_poll_t fw_poll;
82 static d_read_t fw_read; /* for Isochronous packet */
83 static d_write_t fw_write;
84 static d_mmap_t fw_mmap;
85 static d_strategy_t fw_strategy;
87 struct dev_ops firewire_ops =
89 { "fw", CDEV_MAJOR, D_MEM },
97 .d_strategy = fw_strategy,
103 struct fw_isobufreq bufreq;
107 fwdev_allocbuf(struct firewire_comm *fc, struct fw_xferq *q,
108 struct fw_bufspec *b)
112 if (q->flag & (FWXFERQ_RUNNING | FWXFERQ_EXTBUF))
115 q->bulkxfer = (struct fw_bulkxfer *) malloc(
116 sizeof(struct fw_bulkxfer) * b->nchunk,
118 if (q->bulkxfer == NULL)
121 b->psize = roundup2(b->psize, sizeof(u_int32_t));
122 q->buf = fwdma_malloc_multiseg(fc, sizeof(u_int32_t),
123 b->psize, b->nchunk * b->npacket, BUS_DMA_WAITOK);
125 if (q->buf == NULL) {
126 free(q->bulkxfer, M_FW);
130 q->bnchunk = b->nchunk;
131 q->bnpacket = b->npacket;
132 q->psize = (b->psize + 3) & ~3;
135 STAILQ_INIT(&q->stvalid);
136 STAILQ_INIT(&q->stfree);
137 STAILQ_INIT(&q->stdma);
140 for(i = 0 ; i < q->bnchunk; i++){
141 q->bulkxfer[i].poffset = i * q->bnpacket;
142 q->bulkxfer[i].mbuf = NULL;
143 STAILQ_INSERT_TAIL(&q->stfree, &q->bulkxfer[i], link);
146 q->flag &= ~FWXFERQ_MODEMASK;
147 q->flag |= FWXFERQ_STREAM;
148 q->flag |= FWXFERQ_EXTBUF;
154 fwdev_freebuf(struct fw_xferq *q)
156 if (q->flag & FWXFERQ_EXTBUF) {
158 fwdma_free_multiseg(q->buf);
160 free(q->bulkxfer, M_FW);
162 q->flag &= ~FWXFERQ_EXTBUF;
164 q->maxq = FWMAXQUEUE;
171 fw_open (struct dev_open_args *ap)
173 dev_t dev = ap->a_head.a_dev;
177 return fwmem_open(ap);
179 if (dev->si_drv1 != NULL)
182 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
183 if ((dev->si_flags & SI_NAMED) == 0) {
184 int unit = DEV2UNIT(dev);
185 int sub = DEV2SUB(dev);
187 make_dev(&firewire_ops, minor(dev),
188 UID_ROOT, GID_OPERATOR, 0660,
189 "fw%d.%d", unit, sub);
193 dev->si_drv1 = malloc(sizeof(struct fw_drv1), M_FW, M_WAITOK | M_ZERO);
199 fw_close (struct dev_close_args *ap)
201 dev_t dev = ap->a_head.a_dev;
202 struct firewire_softc *sc;
203 struct firewire_comm *fc;
205 int unit = DEV2UNIT(dev);
206 struct fw_xfer *xfer;
211 return fwmem_close(ap);
213 sc = devclass_get_softc(firewire_devclass, unit);
215 d = (struct fw_drv1 *)dev->si_drv1;
218 struct fw_xferq *ir = d->ir;
220 if ((ir->flag & FWXFERQ_OPEN) == 0)
222 if (ir->flag & FWXFERQ_RUNNING) {
223 ir->flag &= ~FWXFERQ_RUNNING;
224 fc->irx_disable(fc, ir->dmach);
228 /* drain receiving buffer */
229 for (xfer = STAILQ_FIRST(&ir->q);
230 xfer != NULL; xfer = STAILQ_FIRST(&ir->q)) {
232 STAILQ_REMOVE_HEAD(&ir->q, link);
238 for (fwb = STAILQ_FIRST(&ir->binds); fwb != NULL;
239 fwb = STAILQ_FIRST(&ir->binds)) {
240 STAILQ_REMOVE(&fc->binds, fwb, fw_bind, fclist);
241 STAILQ_REMOVE_HEAD(&ir->binds, chlist);
244 ir->flag &= ~(FWXFERQ_OPEN |
245 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
250 struct fw_xferq *it = d->it;
252 if ((it->flag & FWXFERQ_OPEN) == 0)
254 if (it->flag & FWXFERQ_RUNNING) {
255 it->flag &= ~FWXFERQ_RUNNING;
256 fc->itx_disable(fc, it->dmach);
260 it->flag &= ~(FWXFERQ_OPEN |
261 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
264 free(dev->si_drv1, M_FW);
274 fw_read (struct dev_read_args *ap)
276 dev_t dev = ap->a_head.a_dev;
277 struct uio *uio = ap->a_uio;
278 struct firewire_softc *sc;
280 struct fw_xfer *xfer;
281 int err = 0, slept = 0;
282 int unit = DEV2UNIT(dev);
288 sc = devclass_get_softc(firewire_devclass, unit);
290 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
291 if (ir == NULL || ir->buf == NULL)
295 xfer = STAILQ_FIRST(&ir->q);
296 if (ir->stproc == NULL) {
298 ir->stproc = STAILQ_FIRST(&ir->stvalid);
299 if (ir->stproc != NULL) {
301 STAILQ_REMOVE_HEAD(&ir->stvalid, link);
306 if (xfer == NULL && ir->stproc == NULL) {
307 /* no data avaliable */
310 ir->flag |= FWXFERQ_WAKEUP;
311 err = tsleep(ir, FWPRI, "fw_read", hz);
312 ir->flag &= ~FWXFERQ_WAKEUP;
315 } else if (slept == 1)
318 } else if(xfer != NULL) {
319 #if 0 /* XXX broken */
320 /* per packet mode or FWACT_CH bind?*/
323 STAILQ_REMOVE_HEAD(&ir->q, link);
325 fp = &xfer->recv.hdr;
326 if (sc->fc->irx_post != NULL)
327 sc->fc->irx_post(sc->fc, fp->mode.ld);
328 err = uiomove((void *)fp, 1 /* XXX header size */, uio);
329 /* XXX copy payload too */
330 /* XXX we should recycle this xfer */
333 } else if(ir->stproc != NULL) {
335 fp = (struct fw_pkt *)fwdma_v_addr(ir->buf,
336 ir->stproc->poffset + ir->queued);
337 if(sc->fc->irx_post != NULL)
338 sc->fc->irx_post(sc->fc, fp->mode.ld);
339 if(fp->mode.stream.len == 0){
343 err = uiomove((caddr_t)fp,
344 fp->mode.stream.len + sizeof(u_int32_t), uio);
346 if(ir->queued >= ir->bnpacket){
348 STAILQ_INSERT_TAIL(&ir->stfree, ir->stproc, link);
350 sc->fc->irx_enable(sc->fc, ir->dmach);
353 if (uio->uio_resid >= ir->psize) {
362 fw_write (struct dev_write_args *ap)
364 dev_t dev = ap->a_head.a_dev;
365 struct uio *uio = ap->a_uio;
367 struct firewire_softc *sc;
368 int unit = DEV2UNIT(dev);
371 struct firewire_comm *fc;
375 return physwrite(ap);
377 sc = devclass_get_softc(firewire_devclass, unit);
379 it = ((struct fw_drv1 *)dev->si_drv1)->it;
380 if (it == NULL || it->buf == NULL)
383 if (it->stproc == NULL) {
384 it->stproc = STAILQ_FIRST(&it->stfree);
385 if (it->stproc != NULL) {
387 STAILQ_REMOVE_HEAD(&it->stfree, link);
390 } else if (slept == 0) {
392 err = sc->fc->itx_enable(sc->fc, it->dmach);
395 err = tsleep(it, FWPRI, "fw_write", hz);
404 fp = (struct fw_pkt *)fwdma_v_addr(it->buf,
405 it->stproc->poffset + it->queued);
406 err = uiomove((caddr_t)fp, sizeof(struct fw_isohdr), uio);
407 err = uiomove((caddr_t)fp->mode.stream.payload,
408 fp->mode.stream.len, uio);
410 if (it->queued >= it->bnpacket) {
412 STAILQ_INSERT_TAIL(&it->stvalid, it->stproc, link);
415 err = sc->fc->itx_enable(sc->fc, it->dmach);
417 if (uio->uio_resid >= sizeof(struct fw_isohdr)) {
427 fw_ioctl (struct dev_ioctl_args *ap)
429 dev_t dev = ap->a_head.a_dev;
430 struct firewire_softc *sc;
431 struct firewire_comm *fc;
433 int unit = DEV2UNIT(dev);
435 struct fw_device *fwdev;
437 struct fw_xferq *ir, *it;
438 struct fw_xfer *xfer;
440 struct fw_devinfo *devinfo;
443 struct fw_devlstreq *fwdevlst = (struct fw_devlstreq *)ap->a_data;
444 struct fw_asyreq *asyreq = (struct fw_asyreq *)ap->a_data;
445 struct fw_isochreq *ichreq = (struct fw_isochreq *)ap->a_data;
446 struct fw_isobufreq *ibufreq = (struct fw_isobufreq *)ap->a_data;
447 struct fw_asybindreq *bindreq = (struct fw_asybindreq *)ap->a_data;
448 struct fw_crom_buf *crom_buf = (struct fw_crom_buf *)ap->a_data;
451 return fwmem_ioctl(ap);
456 sc = devclass_get_softc(firewire_devclass, unit);
458 d = (struct fw_drv1 *)dev->si_drv1;
465 for (i = 0; i < fc->nisodma; i ++) {
467 if ((it->flag & FWXFERQ_OPEN) == 0)
470 if (i >= fc->nisodma) {
474 err = fwdev_allocbuf(fc, it, &d->bufreq.tx);
477 it->flag |= FWXFERQ_OPEN;
480 it->flag |= (0x3f & ichreq->ch);
481 it->flag |= ((0x3 & ichreq->tag) << 6);
486 ichreq->ch = it->flag & 0x3f;
487 ichreq->tag = it->flag >> 2 & 0x3;
493 for (i = 0; i < fc->nisodma; i ++) {
495 if ((ir->flag & FWXFERQ_OPEN) == 0)
498 if (i >= fc->nisodma) {
502 err = fwdev_allocbuf(fc, ir, &d->bufreq.rx);
505 ir->flag |= FWXFERQ_OPEN;
508 ir->flag |= (0x3f & ichreq->ch);
509 ir->flag |= ((0x3 & ichreq->tag) << 6);
511 err = fc->irx_enable(fc, ir->dmach);
515 ichreq->ch = ir->flag & 0x3f;
516 ichreq->tag = ir->flag >> 2 & 0x3;
521 bcopy(ibufreq, &d->bufreq, sizeof(d->bufreq));
524 bzero(&ibufreq->rx, sizeof(ibufreq->rx));
526 ibufreq->rx.nchunk = ir->bnchunk;
527 ibufreq->rx.npacket = ir->bnpacket;
528 ibufreq->rx.psize = ir->psize;
530 bzero(&ibufreq->tx, sizeof(ibufreq->tx));
532 ibufreq->tx.nchunk = it->bnchunk;
533 ibufreq->tx.npacket = it->bnpacket;
534 ibufreq->tx.psize = it->psize;
539 struct tcode_info *tinfo;
543 tinfo = &sc->fc->tcode[fp->mode.hdr.tcode];
545 if ((tinfo->flag & FWTI_BLOCK_ASY) != 0)
546 pay_len = MAX(0, asyreq->req.len - tinfo->hdr_len);
548 xfer = fw_xfer_alloc_buf(M_FWXFER, pay_len, PAGE_SIZE/*XXX*/);
552 switch (asyreq->req.type) {
556 fwdev = fw_noderesolve_eui64(sc->fc,
557 &asyreq->req.dst.eui);
559 device_printf(sc->fc->bdev,
560 "cannot find node\n");
564 fp->mode.hdr.dst = FWLOCALBUS | fwdev->dst;
567 /* XXX what's this? */
574 bcopy(fp, (void *)&xfer->send.hdr, tinfo->hdr_len);
576 bcopy((char *)fp + tinfo->hdr_len,
577 (void *)&xfer->send.payload, pay_len);
578 xfer->send.spd = asyreq->req.sped;
579 xfer->act.hand = fw_asy_callback;
581 if ((err = fw_asyreq(sc->fc, -1, xfer)) != 0)
583 if ((err = tsleep(xfer, FWPRI, "asyreq", hz)) != 0)
585 if (xfer->resp != 0) {
589 if ((tinfo->flag & FWTI_TLABEL) == 0)
593 tinfo = &sc->fc->tcode[xfer->recv.hdr.mode.hdr.tcode];
594 if (asyreq->req.len >= xfer->recv.pay_len + tinfo->hdr_len)
595 asyreq->req.len = xfer->recv.pay_len;
598 bcopy(&xfer->recv.hdr, fp, tinfo->hdr_len);
599 bcopy(xfer->recv.payload, (char *)fp + tinfo->hdr_len,
600 MAX(0, asyreq->req.len - tinfo->hdr_len));
602 fw_xfer_free_buf(xfer);
609 fwb = fw_bindlookup(sc->fc,
610 bindreq->start.hi, bindreq->start.lo);
615 STAILQ_REMOVE(&sc->fc->binds, fwb, fw_bind, fclist);
616 STAILQ_REMOVE(&ir->binds, fwb, fw_bind, chlist);
620 if(bindreq->len <= 0 ){
624 if(bindreq->start.hi > 0xffff ){
628 fwb = malloc(sizeof (struct fw_bind), M_FW, M_WAITOK);
629 fwb->start = ((u_int64_t)bindreq->start.hi << 32) |
631 fwb->end = fwb->start + bindreq->len;
633 fwb->sub = ir->dmach;
634 fwb->act_type = FWACT_CH;
637 xfer = fw_xfer_alloc(M_FWXFER);
645 /* XXX broken. need multiple xfer */
646 STAILQ_INIT(&fwb->xferlist);
647 STAILQ_INSERT_TAIL(&fwb->xferlist, xfer, link);
649 err = fw_bindadd(sc->fc, fwb);
654 devinfo = &fwdevlst->dev[0];
655 devinfo->dst = sc->fc->nodeid;
656 devinfo->status = 0; /* XXX */
657 devinfo->eui.hi = sc->fc->eui.hi;
658 devinfo->eui.lo = sc->fc->eui.lo;
659 STAILQ_FOREACH(fwdev, &sc->fc->devices, link) {
660 if(len < FW_MAX_DEVLST){
661 devinfo = &fwdevlst->dev[len++];
662 devinfo->dst = fwdev->dst;
664 (fwdev->status == FWDEVINVAL)?0:1;
665 devinfo->eui.hi = fwdev->eui.hi;
666 devinfo->eui.lo = fwdev->eui.lo;
671 fwdevlst->info_len = len;
674 bcopy(sc->fc->topology_map, ap->a_data,
675 (sc->fc->topology_map->crc_len + 1) * 4);
678 STAILQ_FOREACH(fwdev, &sc->fc->devices, link)
679 if (FW_EUI64_EQUAL(fwdev->eui, crom_buf->eui))
682 if (!FW_EUI64_EQUAL(sc->fc->eui, crom_buf->eui)) {
687 ptr = malloc(CROMSIZE, M_FW, M_WAITOK);
689 for (i = 0; i < CROMSIZE/4; i++)
690 ((u_int32_t *)ptr)[i]
691 = ntohl(sc->fc->config_rom[i]);
694 ptr = (void *)&fwdev->csrrom[0];
695 if (fwdev->rommax < CSRROMOFF)
698 len = fwdev->rommax - CSRROMOFF + 4;
700 if (crom_buf->len < len)
704 err = copyout(ptr, crom_buf->ptr, len);
716 fw_poll(struct dev_poll_args *ap)
718 dev_t dev = ap->a_head.a_dev;
719 struct firewire_softc *sc;
723 int unit = DEV2UNIT(dev);
726 return fwmem_poll(ap);
728 sc = devclass_get_softc(firewire_devclass, unit);
729 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
731 tmp = POLLIN | POLLRDNORM;
732 if (ap->a_events & tmp) {
733 if (STAILQ_FIRST(&ir->q) != NULL)
736 selrecord(curthread, &ir->rsel);
738 tmp = POLLOUT | POLLWRNORM;
739 if (ap->a_events & tmp) {
740 /* XXX should be fixed */
743 ap->a_events = revents;
748 fw_mmap (struct dev_mmap_args *ap)
750 dev_t dev = ap->a_head.a_dev;
751 struct firewire_softc *sc;
752 int unit = DEV2UNIT(dev);
755 return fwmem_mmap(ap);
756 sc = devclass_get_softc(firewire_devclass, unit);
762 fw_strategy(struct dev_strategy_args *ap)
764 dev_t dev = ap->a_head.a_dev;
765 struct bio *bio = ap->a_bio;
766 struct buf *bp = bio->bio_buf;
768 if (DEV_FWMEM(dev)) {
772 bp->b_error = EOPNOTSUPP;
773 bp->b_flags |= B_ERROR;
774 bp->b_resid = bp->b_bcount;
780 fwdev_makedev(struct firewire_softc *sc)
784 unit = device_get_unit(sc->fc->bdev);
785 dev_ops_add(&firewire_ops, FW_UNITMASK, FW_UNIT(unit));
790 fwdev_destroydev(struct firewire_softc *sc)
794 unit = device_get_unit(sc->fc->bdev);
795 dev_ops_remove(&firewire_ops, FW_UNITMASK, FW_UNIT(unit));
799 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
802 fwdev_clone(void *arg, char *name, int namelen, dev_t *dev)
804 struct firewire_softc *sc;
805 char *devnames[NDEVTYPE] = {"fw", "fwmem"};
807 int devflag[NDEVTYPE] = {0, FWMEM_FLAG};
808 int i, unit = 0, sub = 0;
813 for (i = 0; i < NDEVTYPE; i++)
814 if (dev_stdclone(name, &subp, devnames[i], &unit) == 2)
820 if (subp == NULL || *subp++ != '.')
824 while (isdigit(*subp)) {
826 sub += *subp++ - '0';
831 sc = devclass_get_softc(firewire_devclass, unit);
834 *dev = make_dev(&firewire_ops, MAKEMINOR(devflag[i], unit, sub),
835 UID_ROOT, GID_OPERATOR, 0660,
836 "%s%d.%d", devnames[i], unit, sub);
837 (*dev)->si_flags |= SI_CHEAPCLONE;
838 dev_depends(sc->dev, *dev);