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,
87 struct firewire_comm *fc;
90 struct fw_isobufreq bufreq;
91 STAILQ_HEAD(, fw_bind) binds;
92 STAILQ_HEAD(, fw_xfer) rq;
96 fwdev_allocbuf(struct firewire_comm *fc, struct fw_xferq *q,
101 if (q->flag & (FWXFERQ_RUNNING | FWXFERQ_EXTBUF))
104 q->bulkxfer = malloc(sizeof(struct fw_bulkxfer) * b->nchunk,
106 if (q->bulkxfer == NULL)
109 b->psize = roundup2(b->psize, sizeof(uint32_t));
110 q->buf = fwdma_malloc_multiseg(fc, sizeof(uint32_t),
111 b->psize, b->nchunk * b->npacket, BUS_DMA_WAITOK);
113 if (q->buf == NULL) {
114 free(q->bulkxfer, M_FW);
118 q->bnchunk = b->nchunk;
119 q->bnpacket = b->npacket;
120 q->psize = (b->psize + 3) & ~3;
123 STAILQ_INIT(&q->stvalid);
124 STAILQ_INIT(&q->stfree);
125 STAILQ_INIT(&q->stdma);
128 for (i = 0; i < q->bnchunk; i++) {
129 q->bulkxfer[i].poffset = i * q->bnpacket;
130 q->bulkxfer[i].mbuf = NULL;
131 STAILQ_INSERT_TAIL(&q->stfree, &q->bulkxfer[i], link);
134 q->flag &= ~FWXFERQ_MODEMASK;
135 q->flag |= FWXFERQ_STREAM;
136 q->flag |= FWXFERQ_EXTBUF;
142 fwdev_freebuf(struct fw_xferq *q)
144 if (q->flag & FWXFERQ_EXTBUF) {
146 fwdma_free_multiseg(q->buf);
148 free(q->bulkxfer, M_FW);
150 q->flag &= ~FWXFERQ_EXTBUF;
152 q->maxq = FWMAXQUEUE;
159 fw_open(struct cdev *dev, int flags, int fmt, fw_proc *td)
162 int unit = DEV2UNIT(dev);
164 struct firewire_softc *sc;
167 return fwmem_open(dev, flags, fmt, td);
169 sc = devclass_get_softc(firewire_devclass, unit);
174 if (dev->si_drv1 != NULL) {
178 /* set dummy value for allocation */
179 dev->si_drv1 = (void *)-1;
182 dev->si_drv1 = malloc(sizeof(struct fw_drv1), M_FW, M_WAITOK | M_ZERO);
183 if (dev->si_drv1 == NULL)
186 if ((dev->si_flags & SI_NAMED) == 0) {
187 int unit = DEV2UNIT(dev);
188 int sub = DEV2SUB(dev);
190 make_dev(&firewire_cdevsw, dev2unit(dev),
191 UID_ROOT, GID_OPERATOR, 0660, "fw%d.%d", unit, sub);
196 STAILQ_INIT(&d->binds);
203 fw_close(struct cdev *dev, int flags, int fmt, fw_proc *td)
205 struct firewire_comm *fc;
207 struct fw_xfer *xfer;
212 return fwmem_close(dev, flags, fmt, td);
218 for (fwb = STAILQ_FIRST(&d->binds); fwb != NULL;
219 fwb = STAILQ_FIRST(&d->binds)) {
220 fw_bindremove(fc, fwb);
221 STAILQ_REMOVE_HEAD(&d->binds, chlist);
222 fw_xferlist_remove(&fwb->xferlist);
226 struct fw_xferq *ir = d->ir;
228 if ((ir->flag & FWXFERQ_OPEN) == 0)
230 if (ir->flag & FWXFERQ_RUNNING) {
231 ir->flag &= ~FWXFERQ_RUNNING;
232 fc->irx_disable(fc, ir->dmach);
236 /* drain receiving buffer */
237 for (xfer = STAILQ_FIRST(&ir->q);
238 xfer != NULL; xfer = STAILQ_FIRST(&ir->q)) {
240 STAILQ_REMOVE_HEAD(&ir->q, link);
245 ir->flag &= ~(FWXFERQ_OPEN | FWXFERQ_MODEMASK |
251 struct fw_xferq *it = d->it;
253 if ((it->flag & FWXFERQ_OPEN) == 0)
255 if (it->flag & FWXFERQ_RUNNING) {
256 it->flag &= ~FWXFERQ_RUNNING;
257 fc->itx_disable(fc, it->dmach);
261 it->flag &= ~(FWXFERQ_OPEN |
262 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
265 free(dev->si_drv1, M_FW);
272 fw_read_async(struct fw_drv1 *d, struct uio *uio, int ioflag)
275 struct fw_xfer *xfer;
278 struct tcode_info *tinfo;
281 while ((xfer = STAILQ_FIRST(&d->rq)) == NULL && err == 0)
282 err = msleep(&d->rq, FW_GMTX(d->fc), FWPRI, "fwra", 0);
290 STAILQ_REMOVE_HEAD(&d->rq, link);
291 FW_GUNLOCK(xfer->fc);
293 fp = &xfer->recv.hdr;
294 #if 0 /* for GASP ?? */
295 if (fc->irx_post != NULL)
296 fc->irx_post(fc, fp->mode.ld);
298 tinfo = &xfer->fc->tcode[fp->mode.hdr.tcode];
299 err = uiomove(fp, tinfo->hdr_len, uio);
302 err = uiomove(xfer->recv.payload, xfer->recv.pay_len, uio);
305 /* recycle this xfer */
306 fwb = (struct fw_bind *)xfer->sc;
307 fw_xfer_unload(xfer);
308 xfer->recv.pay_len = PAGE_SIZE;
310 STAILQ_INSERT_TAIL(&fwb->xferlist, xfer, link);
311 FW_GUNLOCK(xfer->fc);
319 fw_read(struct cdev *dev, struct uio *uio, int ioflag)
323 struct firewire_comm *fc;
324 int err = 0, s, slept = 0;
328 return (physio(dev, uio, ioflag));
335 return (fw_read_async(d, uio, ioflag));
342 if (ir->stproc == NULL) {
344 ir->stproc = STAILQ_FIRST(&ir->stvalid);
345 if (ir->stproc != NULL) {
347 STAILQ_REMOVE_HEAD(&ir->stvalid, link);
352 if (ir->stproc == NULL) {
353 /* no data avaliable */
356 ir->flag |= FWXFERQ_WAKEUP;
357 err = msleep(ir, FW_GMTX(fc), FWPRI, "fw_read", hz);
358 ir->flag &= ~FWXFERQ_WAKEUP;
361 } else if (slept == 1)
365 } else if (ir->stproc != NULL) {
368 fp = (struct fw_pkt *)fwdma_v_addr(ir->buf,
369 ir->stproc->poffset + ir->queued);
370 if (fc->irx_post != NULL)
371 fc->irx_post(fc, fp->mode.ld);
372 if (fp->mode.stream.len == 0) {
376 err = uiomove((caddr_t)fp,
377 fp->mode.stream.len + sizeof(uint32_t), uio);
379 if (ir->queued >= ir->bnpacket) {
381 STAILQ_INSERT_TAIL(&ir->stfree, ir->stproc, link);
383 fc->irx_enable(fc, ir->dmach);
386 if (uio->uio_resid >= ir->psize) {
396 fw_write_async(struct fw_drv1 *d, struct uio *uio, int ioflag)
398 struct fw_xfer *xfer;
400 struct tcode_info *tinfo;
403 bzero(&pkt, sizeof(struct fw_pkt));
404 if ((err = uiomove((caddr_t)&pkt, sizeof(uint32_t), uio)))
406 tinfo = &d->fc->tcode[pkt.mode.hdr.tcode];
407 if ((err = uiomove((caddr_t)&pkt + sizeof(uint32_t),
408 tinfo->hdr_len - sizeof(uint32_t), uio)))
411 if ((xfer = fw_xfer_alloc_buf(M_FWXFER, uio->uio_resid,
412 PAGE_SIZE/*XXX*/)) == NULL)
415 bcopy(&pkt, &xfer->send.hdr, sizeof(struct fw_pkt));
416 xfer->send.pay_len = uio->uio_resid;
417 if (uio->uio_resid > 0) {
418 if ((err = uiomove((caddr_t)&xfer->send.payload[0],
419 uio->uio_resid, uio)))
425 xfer->hand = fw_xferwake;
426 xfer->send.spd = 2 /* XXX */;
428 if ((err = fw_asyreq(xfer->fc, -1, xfer)))
431 if ((err = fw_xferwait(xfer)))
434 if (xfer->resp != 0) {
439 if (xfer->flag & FWXF_RCVD) {
441 STAILQ_INSERT_TAIL(&d->rq, xfer, link);
442 FW_GUNLOCK(xfer->fc);
452 fw_write(struct cdev *dev, struct uio *uio, int ioflag)
458 struct firewire_comm *fc;
462 return (physio(dev, uio, ioflag));
469 return (fw_write_async(d, uio, ioflag));
476 if (it->stproc == NULL) {
477 it->stproc = STAILQ_FIRST(&it->stfree);
478 if (it->stproc != NULL) {
480 STAILQ_REMOVE_HEAD(&it->stfree, link);
483 } else if (slept == 0) {
485 #if 0 /* XXX to avoid lock recursion */
486 err = fc->itx_enable(fc, it->dmach);
490 err = msleep(it, FW_GMTX(fc), FWPRI, "fw_write", hz);
500 fp = (struct fw_pkt *)fwdma_v_addr(it->buf,
501 it->stproc->poffset + it->queued);
502 err = uiomove((caddr_t)fp, sizeof(struct fw_isohdr), uio);
503 err = uiomove((caddr_t)fp->mode.stream.payload,
504 fp->mode.stream.len, uio);
506 if (it->queued >= it->bnpacket) {
508 STAILQ_INSERT_TAIL(&it->stvalid, it->stproc, link);
511 err = fc->itx_enable(fc, it->dmach);
513 if (uio->uio_resid >= sizeof(struct fw_isohdr)) {
526 fw_hand(struct fw_xfer *xfer)
531 fwb = (struct fw_bind *)xfer->sc;
534 STAILQ_INSERT_TAIL(&d->rq, xfer, link);
535 FW_GUNLOCK(xfer->fc);
543 fw_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, fw_proc *td)
545 struct firewire_comm *fc;
548 struct fw_device *fwdev;
550 struct fw_xferq *ir, *it;
551 struct fw_xfer *xfer;
553 struct fw_devinfo *devinfo;
556 struct fw_devlstreq *fwdevlst = (struct fw_devlstreq *)data;
557 struct fw_asyreq *asyreq = (struct fw_asyreq *)data;
558 struct fw_isochreq *ichreq = (struct fw_isochreq *)data;
559 struct fw_isobufreq *ibufreq = (struct fw_isobufreq *)data;
560 struct fw_asybindreq *bindreq = (struct fw_asybindreq *)data;
561 struct fw_crom_buf *crom_buf = (struct fw_crom_buf *)data;
564 return fwmem_ioctl(dev, cmd, data, flag, td);
577 i = fw_open_isodma(fc, /* tx */1);
583 err = fwdev_allocbuf(fc, it, &d->bufreq.tx);
585 it->flag &= ~FWXFERQ_OPEN;
590 it->flag |= (0x3f & ichreq->ch);
591 it->flag |= ((0x3 & ichreq->tag) << 6);
596 ichreq->ch = it->flag & 0x3f;
597 ichreq->tag = it->flag >> 2 & 0x3;
603 i = fw_open_isodma(fc, /* tx */0);
609 err = fwdev_allocbuf(fc, ir, &d->bufreq.rx);
611 ir->flag &= ~FWXFERQ_OPEN;
616 ir->flag |= (0x3f & ichreq->ch);
617 ir->flag |= ((0x3 & ichreq->tag) << 6);
619 err = fc->irx_enable(fc, ir->dmach);
623 ichreq->ch = ir->flag & 0x3f;
624 ichreq->tag = ir->flag >> 2 & 0x3;
629 bcopy(ibufreq, &d->bufreq, sizeof(d->bufreq));
632 bzero(&ibufreq->rx, sizeof(ibufreq->rx));
634 ibufreq->rx.nchunk = ir->bnchunk;
635 ibufreq->rx.npacket = ir->bnpacket;
636 ibufreq->rx.psize = ir->psize;
638 bzero(&ibufreq->tx, sizeof(ibufreq->tx));
640 ibufreq->tx.nchunk = it->bnchunk;
641 ibufreq->tx.npacket = it->bnpacket;
642 ibufreq->tx.psize = it->psize;
647 struct tcode_info *tinfo;
651 tinfo = &fc->tcode[fp->mode.hdr.tcode];
653 if ((tinfo->flag & FWTI_BLOCK_ASY) != 0)
654 pay_len = MAX(0, asyreq->req.len - tinfo->hdr_len);
656 xfer = fw_xfer_alloc_buf(M_FWXFER, pay_len, PAGE_SIZE/*XXX*/);
660 switch (asyreq->req.type) {
664 fwdev = fw_noderesolve_eui64(fc,
665 &asyreq->req.dst.eui);
667 device_printf(fc->bdev,
668 "cannot find node\n");
672 fp->mode.hdr.dst = FWLOCALBUS | fwdev->dst;
675 /* XXX what's this? */
682 bcopy(fp, (void *)&xfer->send.hdr, tinfo->hdr_len);
684 bcopy((char *)fp + tinfo->hdr_len,
685 xfer->send.payload, pay_len);
686 xfer->send.spd = asyreq->req.sped;
687 xfer->hand = fw_xferwake;
689 if ((err = fw_asyreq(fc, -1, xfer)) != 0)
691 if ((err = fw_xferwait(xfer)) != 0)
693 if (xfer->resp != 0) {
697 if ((tinfo->flag & FWTI_TLABEL) == 0)
701 tinfo = &fc->tcode[xfer->recv.hdr.mode.hdr.tcode];
702 if (xfer->recv.hdr.mode.hdr.tcode == FWTCODE_RRESB ||
703 xfer->recv.hdr.mode.hdr.tcode == FWTCODE_LRES) {
704 pay_len = xfer->recv.pay_len;
705 if (asyreq->req.len >= xfer->recv.pay_len + tinfo->hdr_len) {
706 asyreq->req.len = xfer->recv.pay_len +
715 bcopy(&xfer->recv.hdr, fp, tinfo->hdr_len);
716 bcopy(xfer->recv.payload, (char *)fp + tinfo->hdr_len, pay_len);
718 fw_xfer_free_buf(xfer);
725 fwb = fw_bindlookup(fc,
726 bindreq->start.hi, bindreq->start.lo);
731 fw_bindremove(fc, fwb);
732 STAILQ_REMOVE(&d->binds, fwb, fw_bind, chlist);
733 fw_xferlist_remove(&fwb->xferlist);
737 if (bindreq->len <= 0) {
741 if (bindreq->start.hi > 0xffff) {
745 fwb = malloc(sizeof(struct fw_bind), M_FW, M_WAITOK);
750 fwb->start = ((u_int64_t)bindreq->start.hi << 32) |
752 fwb->end = fwb->start + bindreq->len;
754 STAILQ_INIT(&fwb->xferlist);
755 err = fw_bindadd(fc, fwb);
757 fw_xferlist_add(&fwb->xferlist, M_FWXFER,
759 PAGE_SIZE, PAGE_SIZE, 5,
761 STAILQ_INSERT_TAIL(&d->binds, fwb, chlist);
767 devinfo = &fwdevlst->dev[0];
768 devinfo->dst = fc->nodeid;
769 devinfo->status = 0; /* XXX */
770 devinfo->eui.hi = fc->eui.hi;
771 devinfo->eui.lo = fc->eui.lo;
772 STAILQ_FOREACH(fwdev, &fc->devices, link) {
773 if (len < FW_MAX_DEVLST) {
774 devinfo = &fwdevlst->dev[len++];
775 devinfo->dst = fwdev->dst;
777 (fwdev->status == FWDEVINVAL) ? 0 : 1;
778 devinfo->eui.hi = fwdev->eui.hi;
779 devinfo->eui.lo = fwdev->eui.lo;
784 fwdevlst->info_len = len;
787 bcopy(fc->topology_map, data,
788 (fc->topology_map->crc_len + 1) * 4);
791 STAILQ_FOREACH(fwdev, &fc->devices, link)
792 if (FW_EUI64_EQUAL(fwdev->eui, crom_buf->eui))
795 if (!FW_EUI64_EQUAL(fc->eui, crom_buf->eui)) {
800 ptr = malloc(CROMSIZE, M_FW, M_WAITOK);
802 for (i = 0; i < CROMSIZE/4; i++)
804 = ntohl(fc->config_rom[i]);
807 ptr = (void *)&fwdev->csrrom[0];
808 if (fwdev->rommax < CSRROMOFF)
811 len = fwdev->rommax - CSRROMOFF + 4;
813 if (crom_buf->len < len)
817 err = copyout(ptr, crom_buf->ptr, len);
823 fc->ioctl(dev, cmd, data, flag, td);
829 fw_poll(struct cdev *dev, int events, fw_proc *td)
836 return fwmem_poll(dev, events, td);
838 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
840 tmp = POLLIN | POLLRDNORM;
842 if (STAILQ_FIRST(&ir->q) != NULL)
845 selrecord(td, &ir->rsel);
847 tmp = POLLOUT | POLLWRNORM;
849 /* XXX should be fixed */
857 fw_mmap (struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
858 int nproto, vm_memattr_t *memattr)
862 return fwmem_mmap(dev, offset, paddr, nproto, memattr);
868 fw_strategy(struct bio *bp)
873 if (DEV_FWMEM(dev)) {
878 bp->bio_error = EOPNOTSUPP;
879 bp->bio_flags |= BIO_ERROR;
880 bp->bio_resid = bp->bio_bcount;
885 fwdev_makedev(struct firewire_softc *sc)
892 unit = device_get_unit(sc->fc->bdev);
893 sc->dev = make_dev(&firewire_cdevsw, MAKEMINOR(0, unit, 0),
894 UID_ROOT, GID_OPERATOR, 0660, "fw%d.%d", unit, 0);
895 d = make_dev(&firewire_cdevsw, MAKEMINOR(FWMEM_FLAG, unit, 0),
896 UID_ROOT, GID_OPERATOR, 0660, "fwmem%d.%d", unit, 0);
897 dev_depends(sc->dev, d);
898 make_dev_alias(sc->dev, "fw%d", unit);
899 make_dev_alias(d, "fwmem%d", unit);
905 fwdev_destroydev(struct firewire_softc *sc)
909 destroy_dev(sc->dev);
915 fwdev_clone(void *arg, struct ucred *cred, char *name, int namelen,
918 struct firewire_softc *sc;
919 char *devnames[NDEVTYPE] = {"fw", "fwmem"};
921 int devflag[NDEVTYPE] = {0, FWMEM_FLAG};
922 int i, unit = 0, sub = 0;
927 for (i = 0; i < NDEVTYPE; i++)
928 if (dev_stdclone(name, &subp, devnames[i], &unit) == 2)
934 if (subp == NULL || *subp++ != '.')
938 while (isdigit(*subp)) {
940 sub += *subp++ - '0';
945 sc = devclass_get_softc(firewire_devclass, unit);
948 *dev = make_dev_credf(MAKEDEV_REF, &firewire_cdevsw,
949 MAKEMINOR(devflag[i], unit, sub), cred, UID_ROOT, GID_OPERATOR,
950 0660, "%s%d.%d", devnames[i], unit, sub);
951 dev_depends(sc->dev, *dev);