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>
44 #include <sys/kernel.h>
45 #include <sys/malloc.h>
50 #include <sys/ctype.h>
51 #include <machine/bus.h>
53 #include <sys/ioccom.h>
55 #include <dev/firewire/firewire.h>
56 #include <dev/firewire/firewirereg.h>
57 #include <dev/firewire/fwdma.h>
58 #include <dev/firewire/fwmem.h>
59 #include <dev/firewire/iec68113.h>
61 #define FWNODE_INVAL 0xffff
63 static d_open_t fw_open;
64 static d_close_t fw_close;
65 static d_ioctl_t fw_ioctl;
66 static d_poll_t fw_poll;
67 static d_read_t fw_read; /* for Isochronous packet */
68 static d_write_t fw_write;
69 static d_mmap_t fw_mmap;
70 static d_strategy_t fw_strategy;
72 struct cdevsw firewire_cdevsw = {
73 .d_version = D_VERSION,
81 .d_strategy = fw_strategy,
86 struct firewire_comm *fc;
89 struct fw_isobufreq bufreq;
90 STAILQ_HEAD(, fw_bind) binds;
91 STAILQ_HEAD(, fw_xfer) rq;
95 fwdev_allocbuf(struct firewire_comm *fc, struct fw_xferq *q,
100 if (q->flag & (FWXFERQ_RUNNING | FWXFERQ_EXTBUF))
103 q->bulkxfer = malloc(sizeof(struct fw_bulkxfer) * b->nchunk,
106 b->psize = roundup2(b->psize, sizeof(uint32_t));
107 q->buf = fwdma_malloc_multiseg(fc, sizeof(uint32_t),
108 b->psize, b->nchunk * b->npacket, BUS_DMA_WAITOK);
110 if (q->buf == NULL) {
111 free(q->bulkxfer, M_FW);
115 q->bnchunk = b->nchunk;
116 q->bnpacket = b->npacket;
117 q->psize = (b->psize + 3) & ~3;
120 STAILQ_INIT(&q->stvalid);
121 STAILQ_INIT(&q->stfree);
122 STAILQ_INIT(&q->stdma);
125 for (i = 0; i < q->bnchunk; i++) {
126 q->bulkxfer[i].poffset = i * q->bnpacket;
127 q->bulkxfer[i].mbuf = NULL;
128 STAILQ_INSERT_TAIL(&q->stfree, &q->bulkxfer[i], link);
131 q->flag &= ~FWXFERQ_MODEMASK;
132 q->flag |= FWXFERQ_STREAM;
133 q->flag |= FWXFERQ_EXTBUF;
139 fwdev_freebuf(struct fw_xferq *q)
141 if (q->flag & FWXFERQ_EXTBUF) {
143 fwdma_free_multiseg(q->buf);
145 free(q->bulkxfer, M_FW);
147 q->flag &= ~FWXFERQ_EXTBUF;
149 q->maxq = FWMAXQUEUE;
156 fw_open(struct cdev *dev, int flags, int fmt, fw_proc *td)
159 int unit = DEV2UNIT(dev);
161 struct firewire_softc *sc;
164 return fwmem_open(dev, flags, fmt, td);
166 sc = devclass_get_softc(firewire_devclass, unit);
171 if (dev->si_drv1 != NULL) {
175 /* set dummy value for allocation */
176 dev->si_drv1 = (void *)-1;
179 dev->si_drv1 = malloc(sizeof(struct fw_drv1), M_FW, M_WAITOK | M_ZERO);
181 if ((dev->si_flags & SI_NAMED) == 0) {
182 int unit = DEV2UNIT(dev);
183 int sub = DEV2SUB(dev);
185 make_dev(&firewire_cdevsw, dev2unit(dev),
186 UID_ROOT, GID_OPERATOR, 0660, "fw%d.%d", unit, sub);
191 STAILQ_INIT(&d->binds);
198 fw_close(struct cdev *dev, int flags, int fmt, fw_proc *td)
200 struct firewire_comm *fc;
202 struct fw_xfer *xfer;
207 return fwmem_close(dev, flags, fmt, td);
213 for (fwb = STAILQ_FIRST(&d->binds); fwb != NULL;
214 fwb = STAILQ_FIRST(&d->binds)) {
215 fw_bindremove(fc, fwb);
216 STAILQ_REMOVE_HEAD(&d->binds, chlist);
217 fw_xferlist_remove(&fwb->xferlist);
221 struct fw_xferq *ir = d->ir;
223 if ((ir->flag & FWXFERQ_OPEN) == 0)
225 if (ir->flag & FWXFERQ_RUNNING) {
226 ir->flag &= ~FWXFERQ_RUNNING;
227 fc->irx_disable(fc, ir->dmach);
231 /* drain receiving buffer */
232 for (xfer = STAILQ_FIRST(&ir->q);
233 xfer != NULL; xfer = STAILQ_FIRST(&ir->q)) {
235 STAILQ_REMOVE_HEAD(&ir->q, link);
240 ir->flag &= ~(FWXFERQ_OPEN | FWXFERQ_MODEMASK |
246 struct fw_xferq *it = d->it;
248 if ((it->flag & FWXFERQ_OPEN) == 0)
250 if (it->flag & FWXFERQ_RUNNING) {
251 it->flag &= ~FWXFERQ_RUNNING;
252 fc->itx_disable(fc, it->dmach);
256 it->flag &= ~(FWXFERQ_OPEN |
257 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
260 free(dev->si_drv1, M_FW);
267 fw_read_async(struct fw_drv1 *d, struct uio *uio, int ioflag)
270 struct fw_xfer *xfer;
273 struct tcode_info *tinfo;
276 while ((xfer = STAILQ_FIRST(&d->rq)) == NULL && err == 0)
277 err = msleep(&d->rq, FW_GMTX(d->fc), FWPRI, "fwra", 0);
285 STAILQ_REMOVE_HEAD(&d->rq, link);
286 FW_GUNLOCK(xfer->fc);
288 fp = &xfer->recv.hdr;
289 #if 0 /* for GASP ?? */
290 if (fc->irx_post != NULL)
291 fc->irx_post(fc, fp->mode.ld);
293 tinfo = &xfer->fc->tcode[fp->mode.hdr.tcode];
294 err = uiomove(fp, tinfo->hdr_len, uio);
297 err = uiomove(xfer->recv.payload, xfer->recv.pay_len, uio);
300 /* recycle this xfer */
301 fwb = (struct fw_bind *)xfer->sc;
302 fw_xfer_unload(xfer);
303 xfer->recv.pay_len = PAGE_SIZE;
305 STAILQ_INSERT_TAIL(&fwb->xferlist, xfer, link);
306 FW_GUNLOCK(xfer->fc);
314 fw_read(struct cdev *dev, struct uio *uio, int ioflag)
318 struct firewire_comm *fc;
319 int err = 0, s, slept = 0;
323 return (physio(dev, uio, ioflag));
330 return (fw_read_async(d, uio, ioflag));
337 if (ir->stproc == NULL) {
339 ir->stproc = STAILQ_FIRST(&ir->stvalid);
340 if (ir->stproc != NULL) {
342 STAILQ_REMOVE_HEAD(&ir->stvalid, link);
347 if (ir->stproc == NULL) {
348 /* no data available */
351 ir->flag |= FWXFERQ_WAKEUP;
352 err = msleep(ir, FW_GMTX(fc), FWPRI, "fw_read", hz);
353 ir->flag &= ~FWXFERQ_WAKEUP;
356 } else if (slept == 1)
360 } else if (ir->stproc != NULL) {
363 fp = (struct fw_pkt *)fwdma_v_addr(ir->buf,
364 ir->stproc->poffset + ir->queued);
365 if (fc->irx_post != NULL)
366 fc->irx_post(fc, fp->mode.ld);
367 if (fp->mode.stream.len == 0) {
371 err = uiomove((caddr_t)fp,
372 fp->mode.stream.len + sizeof(uint32_t), uio);
374 if (ir->queued >= ir->bnpacket) {
376 STAILQ_INSERT_TAIL(&ir->stfree, ir->stproc, link);
378 fc->irx_enable(fc, ir->dmach);
381 if (uio->uio_resid >= ir->psize) {
391 fw_write_async(struct fw_drv1 *d, struct uio *uio, int ioflag)
393 struct fw_xfer *xfer;
395 struct tcode_info *tinfo;
398 bzero(&pkt, sizeof(struct fw_pkt));
399 if ((err = uiomove((caddr_t)&pkt, sizeof(uint32_t), uio)))
401 tinfo = &d->fc->tcode[pkt.mode.hdr.tcode];
402 if ((err = uiomove((caddr_t)&pkt + sizeof(uint32_t),
403 tinfo->hdr_len - sizeof(uint32_t), uio)))
406 if ((xfer = fw_xfer_alloc_buf(M_FWXFER, uio->uio_resid,
407 PAGE_SIZE/*XXX*/)) == NULL)
410 bcopy(&pkt, &xfer->send.hdr, sizeof(struct fw_pkt));
411 xfer->send.pay_len = uio->uio_resid;
412 if (uio->uio_resid > 0) {
413 if ((err = uiomove((caddr_t)&xfer->send.payload[0],
414 uio->uio_resid, uio)))
420 xfer->hand = fw_xferwake;
421 xfer->send.spd = 2 /* XXX */;
423 if ((err = fw_asyreq(xfer->fc, -1, xfer)))
426 if ((err = fw_xferwait(xfer)))
429 if (xfer->resp != 0) {
434 if (xfer->flag & FWXF_RCVD) {
436 STAILQ_INSERT_TAIL(&d->rq, xfer, link);
437 FW_GUNLOCK(xfer->fc);
447 fw_write(struct cdev *dev, struct uio *uio, int ioflag)
453 struct firewire_comm *fc;
457 return (physio(dev, uio, ioflag));
464 return (fw_write_async(d, uio, ioflag));
471 if (it->stproc == NULL) {
472 it->stproc = STAILQ_FIRST(&it->stfree);
473 if (it->stproc != NULL) {
475 STAILQ_REMOVE_HEAD(&it->stfree, link);
478 } else if (slept == 0) {
480 #if 0 /* XXX to avoid lock recursion */
481 err = fc->itx_enable(fc, it->dmach);
485 err = msleep(it, FW_GMTX(fc), FWPRI, "fw_write", hz);
495 fp = (struct fw_pkt *)fwdma_v_addr(it->buf,
496 it->stproc->poffset + it->queued);
497 err = uiomove((caddr_t)fp, sizeof(struct fw_isohdr), uio);
498 err = uiomove((caddr_t)fp->mode.stream.payload,
499 fp->mode.stream.len, uio);
501 if (it->queued >= it->bnpacket) {
503 STAILQ_INSERT_TAIL(&it->stvalid, it->stproc, link);
506 err = fc->itx_enable(fc, it->dmach);
508 if (uio->uio_resid >= sizeof(struct fw_isohdr)) {
521 fw_hand(struct fw_xfer *xfer)
526 fwb = (struct fw_bind *)xfer->sc;
529 STAILQ_INSERT_TAIL(&d->rq, xfer, link);
530 FW_GUNLOCK(xfer->fc);
538 fw_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, fw_proc *td)
540 struct firewire_comm *fc;
543 struct fw_device *fwdev;
545 struct fw_xferq *ir, *it;
546 struct fw_xfer *xfer;
548 struct fw_devinfo *devinfo;
551 struct fw_devlstreq *fwdevlst = (struct fw_devlstreq *)data;
552 struct fw_asyreq *asyreq = (struct fw_asyreq *)data;
553 struct fw_isochreq *ichreq = (struct fw_isochreq *)data;
554 struct fw_isobufreq *ibufreq = (struct fw_isobufreq *)data;
555 struct fw_asybindreq *bindreq = (struct fw_asybindreq *)data;
556 struct fw_crom_buf *crom_buf = (struct fw_crom_buf *)data;
559 return fwmem_ioctl(dev, cmd, data, flag, td);
572 i = fw_open_isodma(fc, /* tx */1);
578 err = fwdev_allocbuf(fc, it, &d->bufreq.tx);
580 it->flag &= ~FWXFERQ_OPEN;
585 it->flag |= (0x3f & ichreq->ch);
586 it->flag |= ((0x3 & ichreq->tag) << 6);
591 ichreq->ch = it->flag & 0x3f;
592 ichreq->tag = it->flag >> 2 & 0x3;
598 i = fw_open_isodma(fc, /* tx */0);
604 err = fwdev_allocbuf(fc, ir, &d->bufreq.rx);
606 ir->flag &= ~FWXFERQ_OPEN;
611 ir->flag |= (0x3f & ichreq->ch);
612 ir->flag |= ((0x3 & ichreq->tag) << 6);
614 err = fc->irx_enable(fc, ir->dmach);
618 ichreq->ch = ir->flag & 0x3f;
619 ichreq->tag = ir->flag >> 2 & 0x3;
624 bcopy(ibufreq, &d->bufreq, sizeof(d->bufreq));
627 bzero(&ibufreq->rx, sizeof(ibufreq->rx));
629 ibufreq->rx.nchunk = ir->bnchunk;
630 ibufreq->rx.npacket = ir->bnpacket;
631 ibufreq->rx.psize = ir->psize;
633 bzero(&ibufreq->tx, sizeof(ibufreq->tx));
635 ibufreq->tx.nchunk = it->bnchunk;
636 ibufreq->tx.npacket = it->bnpacket;
637 ibufreq->tx.psize = it->psize;
642 struct tcode_info *tinfo;
646 tinfo = &fc->tcode[fp->mode.hdr.tcode];
648 if ((tinfo->flag & FWTI_BLOCK_ASY) != 0)
649 pay_len = MAX(0, asyreq->req.len - tinfo->hdr_len);
651 xfer = fw_xfer_alloc_buf(M_FWXFER, pay_len, PAGE_SIZE/*XXX*/);
655 switch (asyreq->req.type) {
659 fwdev = fw_noderesolve_eui64(fc,
660 &asyreq->req.dst.eui);
662 device_printf(fc->bdev,
663 "cannot find node\n");
667 fp->mode.hdr.dst = FWLOCALBUS | fwdev->dst;
670 /* XXX what's this? */
677 bcopy(fp, (void *)&xfer->send.hdr, tinfo->hdr_len);
679 bcopy((char *)fp + tinfo->hdr_len,
680 xfer->send.payload, pay_len);
681 xfer->send.spd = asyreq->req.sped;
682 xfer->hand = fw_xferwake;
684 if ((err = fw_asyreq(fc, -1, xfer)) != 0)
686 if ((err = fw_xferwait(xfer)) != 0)
688 if (xfer->resp != 0) {
692 if ((tinfo->flag & FWTI_TLABEL) == 0)
696 tinfo = &fc->tcode[xfer->recv.hdr.mode.hdr.tcode];
697 if (xfer->recv.hdr.mode.hdr.tcode == FWTCODE_RRESB ||
698 xfer->recv.hdr.mode.hdr.tcode == FWTCODE_LRES) {
699 pay_len = xfer->recv.pay_len;
700 if (asyreq->req.len >= xfer->recv.pay_len + tinfo->hdr_len) {
701 asyreq->req.len = xfer->recv.pay_len +
710 bcopy(&xfer->recv.hdr, fp, tinfo->hdr_len);
711 bcopy(xfer->recv.payload, (char *)fp + tinfo->hdr_len, pay_len);
713 fw_xfer_free_buf(xfer);
720 fwb = fw_bindlookup(fc,
721 bindreq->start.hi, bindreq->start.lo);
726 fw_bindremove(fc, fwb);
727 STAILQ_REMOVE(&d->binds, fwb, fw_bind, chlist);
728 fw_xferlist_remove(&fwb->xferlist);
732 if (bindreq->len <= 0) {
736 if (bindreq->start.hi > 0xffff) {
740 fwb = malloc(sizeof(struct fw_bind), M_FW, M_WAITOK);
741 fwb->start = ((u_int64_t)bindreq->start.hi << 32) |
743 fwb->end = fwb->start + bindreq->len;
745 STAILQ_INIT(&fwb->xferlist);
746 err = fw_bindadd(fc, fwb);
748 fw_xferlist_add(&fwb->xferlist, M_FWXFER,
750 PAGE_SIZE, PAGE_SIZE, 5,
752 STAILQ_INSERT_TAIL(&d->binds, fwb, chlist);
758 devinfo = &fwdevlst->dev[0];
759 devinfo->dst = fc->nodeid;
760 devinfo->status = 0; /* XXX */
761 devinfo->eui.hi = fc->eui.hi;
762 devinfo->eui.lo = fc->eui.lo;
763 STAILQ_FOREACH(fwdev, &fc->devices, link) {
764 if (len < FW_MAX_DEVLST) {
765 devinfo = &fwdevlst->dev[len++];
766 devinfo->dst = fwdev->dst;
768 (fwdev->status == FWDEVINVAL) ? 0 : 1;
769 devinfo->eui.hi = fwdev->eui.hi;
770 devinfo->eui.lo = fwdev->eui.lo;
775 fwdevlst->info_len = len;
778 bcopy(fc->topology_map, data,
779 (fc->topology_map->crc_len + 1) * 4);
782 STAILQ_FOREACH(fwdev, &fc->devices, link)
783 if (FW_EUI64_EQUAL(fwdev->eui, crom_buf->eui))
786 if (!FW_EUI64_EQUAL(fc->eui, crom_buf->eui)) {
791 ptr = malloc(CROMSIZE, M_FW, M_WAITOK);
793 for (i = 0; i < CROMSIZE/4; i++)
795 = ntohl(fc->config_rom[i]);
798 ptr = (void *)&fwdev->csrrom[0];
799 if (fwdev->rommax < CSRROMOFF)
802 len = fwdev->rommax - CSRROMOFF + 4;
804 if (crom_buf->len < len)
808 err = copyout(ptr, crom_buf->ptr, len);
814 fc->ioctl(dev, cmd, data, flag, td);
820 fw_poll(struct cdev *dev, int events, fw_proc *td)
827 return fwmem_poll(dev, events, td);
829 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
831 tmp = POLLIN | POLLRDNORM;
833 if (STAILQ_FIRST(&ir->q) != NULL)
836 selrecord(td, &ir->rsel);
838 tmp = POLLOUT | POLLWRNORM;
840 /* XXX should be fixed */
848 fw_mmap (struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
849 int nproto, vm_memattr_t *memattr)
853 return fwmem_mmap(dev, offset, paddr, nproto, memattr);
859 fw_strategy(struct bio *bp)
864 if (DEV_FWMEM(dev)) {
869 bp->bio_error = EOPNOTSUPP;
870 bp->bio_flags |= BIO_ERROR;
871 bp->bio_resid = bp->bio_bcount;
876 fwdev_makedev(struct firewire_softc *sc)
883 unit = device_get_unit(sc->fc->bdev);
884 sc->dev = make_dev(&firewire_cdevsw, MAKEMINOR(0, unit, 0),
885 UID_ROOT, GID_OPERATOR, 0660, "fw%d.%d", unit, 0);
886 d = make_dev(&firewire_cdevsw, MAKEMINOR(FWMEM_FLAG, unit, 0),
887 UID_ROOT, GID_OPERATOR, 0660, "fwmem%d.%d", unit, 0);
888 dev_depends(sc->dev, d);
889 make_dev_alias(sc->dev, "fw%d", unit);
890 make_dev_alias(d, "fwmem%d", unit);
896 fwdev_destroydev(struct firewire_softc *sc)
900 destroy_dev(sc->dev);
906 fwdev_clone(void *arg, struct ucred *cred, char *name, int namelen,
909 struct firewire_softc *sc;
910 char *devnames[NDEVTYPE] = {"fw", "fwmem"};
912 int devflag[NDEVTYPE] = {0, FWMEM_FLAG};
913 int i, unit = 0, sub = 0;
918 for (i = 0; i < NDEVTYPE; i++)
919 if (dev_stdclone(name, &subp, devnames[i], &unit) == 2)
925 if (subp == NULL || *subp++ != '.')
929 while (isdigit(*subp)) {
931 sub += *subp++ - '0';
936 sc = devclass_get_softc(firewire_devclass, unit);
939 *dev = make_dev_credf(MAKEDEV_REF, &firewire_cdevsw,
940 MAKEMINOR(devflag[i], unit, sub), cred, UID_ROOT, GID_OPERATOR,
941 0660, "%s%d.%d", devnames[i], unit, sub);
942 dev_depends(sc->dev, *dev);