2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (c) 2003 Hidetoshi Shimokawa
5 * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the acknowledgement as bellow:
19 * This product includes software developed by K. Kobayashi and H. Shimokawa
21 * 4. The name of the author may not be used to endorse or promote products
22 * derived from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
28 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
32 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/types.h>
46 #include <sys/kernel.h>
47 #include <sys/malloc.h>
52 #include <sys/ctype.h>
53 #include <machine/bus.h>
55 #include <sys/ioccom.h>
57 #include <dev/firewire/firewire.h>
58 #include <dev/firewire/firewirereg.h>
59 #include <dev/firewire/fwdma.h>
60 #include <dev/firewire/fwmem.h>
61 #include <dev/firewire/iec68113.h>
63 #define FWNODE_INVAL 0xffff
65 static d_open_t fw_open;
66 static d_close_t fw_close;
67 static d_ioctl_t fw_ioctl;
68 static d_poll_t fw_poll;
69 static d_read_t fw_read; /* for Isochronous packet */
70 static d_write_t fw_write;
71 static d_mmap_t fw_mmap;
72 static d_strategy_t fw_strategy;
74 struct cdevsw firewire_cdevsw = {
75 .d_version = D_VERSION,
83 .d_strategy = fw_strategy,
88 struct firewire_comm *fc;
91 struct fw_isobufreq bufreq;
92 STAILQ_HEAD(, fw_bind) binds;
93 STAILQ_HEAD(, fw_xfer) rq;
97 fwdev_allocbuf(struct firewire_comm *fc, struct fw_xferq *q,
102 if (q->flag & (FWXFERQ_RUNNING | FWXFERQ_EXTBUF))
105 q->bulkxfer = malloc(sizeof(struct fw_bulkxfer) * b->nchunk,
108 b->psize = roundup2(b->psize, sizeof(uint32_t));
109 q->buf = fwdma_malloc_multiseg(fc, sizeof(uint32_t),
110 b->psize, b->nchunk * b->npacket, BUS_DMA_WAITOK);
112 if (q->buf == NULL) {
113 free(q->bulkxfer, M_FW);
117 q->bnchunk = b->nchunk;
118 q->bnpacket = b->npacket;
119 q->psize = (b->psize + 3) & ~3;
122 STAILQ_INIT(&q->stvalid);
123 STAILQ_INIT(&q->stfree);
124 STAILQ_INIT(&q->stdma);
127 for (i = 0; i < q->bnchunk; i++) {
128 q->bulkxfer[i].poffset = i * q->bnpacket;
129 q->bulkxfer[i].mbuf = NULL;
130 STAILQ_INSERT_TAIL(&q->stfree, &q->bulkxfer[i], link);
133 q->flag &= ~FWXFERQ_MODEMASK;
134 q->flag |= FWXFERQ_STREAM;
135 q->flag |= FWXFERQ_EXTBUF;
141 fwdev_freebuf(struct fw_xferq *q)
143 if (q->flag & FWXFERQ_EXTBUF) {
145 fwdma_free_multiseg(q->buf);
147 free(q->bulkxfer, M_FW);
149 q->flag &= ~FWXFERQ_EXTBUF;
151 q->maxq = FWMAXQUEUE;
158 fw_open(struct cdev *dev, int flags, int fmt, fw_proc *td)
161 int unit = DEV2UNIT(dev);
163 struct firewire_softc *sc;
166 return fwmem_open(dev, flags, fmt, td);
168 sc = devclass_get_softc(firewire_devclass, unit);
173 if (dev->si_drv1 != NULL) {
177 /* set dummy value for allocation */
178 dev->si_drv1 = (void *)-1;
181 dev->si_drv1 = malloc(sizeof(struct fw_drv1), M_FW, M_WAITOK | M_ZERO);
183 if ((dev->si_flags & SI_NAMED) == 0) {
184 int unit = DEV2UNIT(dev);
185 int sub = DEV2SUB(dev);
187 make_dev(&firewire_cdevsw, dev2unit(dev),
188 UID_ROOT, GID_OPERATOR, 0660, "fw%d.%d", unit, sub);
193 STAILQ_INIT(&d->binds);
200 fw_close(struct cdev *dev, int flags, int fmt, fw_proc *td)
202 struct firewire_comm *fc;
204 struct fw_xfer *xfer;
209 return fwmem_close(dev, flags, fmt, td);
215 for (fwb = STAILQ_FIRST(&d->binds); fwb != NULL;
216 fwb = STAILQ_FIRST(&d->binds)) {
217 fw_bindremove(fc, fwb);
218 STAILQ_REMOVE_HEAD(&d->binds, chlist);
219 fw_xferlist_remove(&fwb->xferlist);
223 struct fw_xferq *ir = d->ir;
225 if ((ir->flag & FWXFERQ_OPEN) == 0)
227 if (ir->flag & FWXFERQ_RUNNING) {
228 ir->flag &= ~FWXFERQ_RUNNING;
229 fc->irx_disable(fc, ir->dmach);
233 /* drain receiving buffer */
234 for (xfer = STAILQ_FIRST(&ir->q);
235 xfer != NULL; xfer = STAILQ_FIRST(&ir->q)) {
237 STAILQ_REMOVE_HEAD(&ir->q, link);
242 ir->flag &= ~(FWXFERQ_OPEN | FWXFERQ_MODEMASK |
248 struct fw_xferq *it = d->it;
250 if ((it->flag & FWXFERQ_OPEN) == 0)
252 if (it->flag & FWXFERQ_RUNNING) {
253 it->flag &= ~FWXFERQ_RUNNING;
254 fc->itx_disable(fc, it->dmach);
258 it->flag &= ~(FWXFERQ_OPEN |
259 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
262 free(dev->si_drv1, M_FW);
269 fw_read_async(struct fw_drv1 *d, struct uio *uio, int ioflag)
272 struct fw_xfer *xfer;
275 struct tcode_info *tinfo;
278 while ((xfer = STAILQ_FIRST(&d->rq)) == NULL && err == 0)
279 err = msleep(&d->rq, FW_GMTX(d->fc), FWPRI, "fwra", 0);
287 STAILQ_REMOVE_HEAD(&d->rq, link);
288 FW_GUNLOCK(xfer->fc);
290 fp = &xfer->recv.hdr;
291 #if 0 /* for GASP ?? */
292 if (fc->irx_post != NULL)
293 fc->irx_post(fc, fp->mode.ld);
295 tinfo = &xfer->fc->tcode[fp->mode.hdr.tcode];
296 err = uiomove(fp, tinfo->hdr_len, uio);
299 err = uiomove(xfer->recv.payload, xfer->recv.pay_len, uio);
302 /* recycle this xfer */
303 fwb = (struct fw_bind *)xfer->sc;
304 fw_xfer_unload(xfer);
305 xfer->recv.pay_len = PAGE_SIZE;
307 STAILQ_INSERT_TAIL(&fwb->xferlist, xfer, link);
308 FW_GUNLOCK(xfer->fc);
316 fw_read(struct cdev *dev, struct uio *uio, int ioflag)
320 struct firewire_comm *fc;
321 int err = 0, s, slept = 0;
325 return (physio(dev, uio, ioflag));
332 return (fw_read_async(d, uio, ioflag));
339 if (ir->stproc == NULL) {
341 ir->stproc = STAILQ_FIRST(&ir->stvalid);
342 if (ir->stproc != NULL) {
344 STAILQ_REMOVE_HEAD(&ir->stvalid, link);
349 if (ir->stproc == NULL) {
350 /* no data available */
353 ir->flag |= FWXFERQ_WAKEUP;
354 err = msleep(ir, FW_GMTX(fc), FWPRI, "fw_read", hz);
355 ir->flag &= ~FWXFERQ_WAKEUP;
358 } else if (slept == 1)
362 } else if (ir->stproc != NULL) {
365 fp = (struct fw_pkt *)fwdma_v_addr(ir->buf,
366 ir->stproc->poffset + ir->queued);
367 if (fc->irx_post != NULL)
368 fc->irx_post(fc, fp->mode.ld);
369 if (fp->mode.stream.len == 0) {
373 err = uiomove((caddr_t)fp,
374 fp->mode.stream.len + sizeof(uint32_t), uio);
376 if (ir->queued >= ir->bnpacket) {
378 STAILQ_INSERT_TAIL(&ir->stfree, ir->stproc, link);
380 fc->irx_enable(fc, ir->dmach);
383 if (uio->uio_resid >= ir->psize) {
393 fw_write_async(struct fw_drv1 *d, struct uio *uio, int ioflag)
395 struct fw_xfer *xfer;
397 struct tcode_info *tinfo;
400 bzero(&pkt, sizeof(struct fw_pkt));
401 if ((err = uiomove((caddr_t)&pkt, sizeof(uint32_t), uio)))
403 tinfo = &d->fc->tcode[pkt.mode.hdr.tcode];
404 if ((err = uiomove((caddr_t)&pkt + sizeof(uint32_t),
405 tinfo->hdr_len - sizeof(uint32_t), uio)))
408 if ((xfer = fw_xfer_alloc_buf(M_FWXFER, uio->uio_resid,
409 PAGE_SIZE/*XXX*/)) == NULL)
412 bcopy(&pkt, &xfer->send.hdr, sizeof(struct fw_pkt));
413 xfer->send.pay_len = uio->uio_resid;
414 if (uio->uio_resid > 0) {
415 if ((err = uiomove((caddr_t)&xfer->send.payload[0],
416 uio->uio_resid, uio)))
422 xfer->hand = fw_xferwake;
423 xfer->send.spd = 2 /* XXX */;
425 if ((err = fw_asyreq(xfer->fc, -1, xfer)))
428 if ((err = fw_xferwait(xfer)))
431 if (xfer->resp != 0) {
436 if (xfer->flag & FWXF_RCVD) {
438 STAILQ_INSERT_TAIL(&d->rq, xfer, link);
439 FW_GUNLOCK(xfer->fc);
449 fw_write(struct cdev *dev, struct uio *uio, int ioflag)
455 struct firewire_comm *fc;
459 return (physio(dev, uio, ioflag));
466 return (fw_write_async(d, uio, ioflag));
473 if (it->stproc == NULL) {
474 it->stproc = STAILQ_FIRST(&it->stfree);
475 if (it->stproc != NULL) {
477 STAILQ_REMOVE_HEAD(&it->stfree, link);
480 } else if (slept == 0) {
482 #if 0 /* XXX to avoid lock recursion */
483 err = fc->itx_enable(fc, it->dmach);
487 err = msleep(it, FW_GMTX(fc), FWPRI, "fw_write", hz);
497 fp = (struct fw_pkt *)fwdma_v_addr(it->buf,
498 it->stproc->poffset + it->queued);
499 err = uiomove((caddr_t)fp, sizeof(struct fw_isohdr), uio);
500 err = uiomove((caddr_t)fp->mode.stream.payload,
501 fp->mode.stream.len, uio);
503 if (it->queued >= it->bnpacket) {
505 STAILQ_INSERT_TAIL(&it->stvalid, it->stproc, link);
508 err = fc->itx_enable(fc, it->dmach);
510 if (uio->uio_resid >= sizeof(struct fw_isohdr)) {
523 fw_hand(struct fw_xfer *xfer)
528 fwb = (struct fw_bind *)xfer->sc;
531 STAILQ_INSERT_TAIL(&d->rq, xfer, link);
532 FW_GUNLOCK(xfer->fc);
540 fw_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, fw_proc *td)
542 struct firewire_comm *fc;
545 struct fw_device *fwdev;
547 struct fw_xferq *ir, *it;
548 struct fw_xfer *xfer;
550 struct fw_devinfo *devinfo;
553 struct fw_devlstreq *fwdevlst = (struct fw_devlstreq *)data;
554 struct fw_asyreq *asyreq = (struct fw_asyreq *)data;
555 struct fw_isochreq *ichreq = (struct fw_isochreq *)data;
556 struct fw_isobufreq *ibufreq = (struct fw_isobufreq *)data;
557 struct fw_asybindreq *bindreq = (struct fw_asybindreq *)data;
558 struct fw_crom_buf *crom_buf = (struct fw_crom_buf *)data;
561 return fwmem_ioctl(dev, cmd, data, flag, td);
574 i = fw_open_isodma(fc, /* tx */1);
580 err = fwdev_allocbuf(fc, it, &d->bufreq.tx);
582 it->flag &= ~FWXFERQ_OPEN;
587 it->flag |= (0x3f & ichreq->ch);
588 it->flag |= ((0x3 & ichreq->tag) << 6);
593 ichreq->ch = it->flag & 0x3f;
594 ichreq->tag = it->flag >> 2 & 0x3;
600 i = fw_open_isodma(fc, /* tx */0);
606 err = fwdev_allocbuf(fc, ir, &d->bufreq.rx);
608 ir->flag &= ~FWXFERQ_OPEN;
613 ir->flag |= (0x3f & ichreq->ch);
614 ir->flag |= ((0x3 & ichreq->tag) << 6);
616 err = fc->irx_enable(fc, ir->dmach);
620 ichreq->ch = ir->flag & 0x3f;
621 ichreq->tag = ir->flag >> 2 & 0x3;
626 bcopy(ibufreq, &d->bufreq, sizeof(d->bufreq));
629 bzero(&ibufreq->rx, sizeof(ibufreq->rx));
631 ibufreq->rx.nchunk = ir->bnchunk;
632 ibufreq->rx.npacket = ir->bnpacket;
633 ibufreq->rx.psize = ir->psize;
635 bzero(&ibufreq->tx, sizeof(ibufreq->tx));
637 ibufreq->tx.nchunk = it->bnchunk;
638 ibufreq->tx.npacket = it->bnpacket;
639 ibufreq->tx.psize = it->psize;
644 struct tcode_info *tinfo;
648 tinfo = &fc->tcode[fp->mode.hdr.tcode];
650 if ((tinfo->flag & FWTI_BLOCK_ASY) != 0)
651 pay_len = MAX(0, asyreq->req.len - tinfo->hdr_len);
653 xfer = fw_xfer_alloc_buf(M_FWXFER, pay_len, PAGE_SIZE/*XXX*/);
657 switch (asyreq->req.type) {
661 fwdev = fw_noderesolve_eui64(fc,
662 &asyreq->req.dst.eui);
664 device_printf(fc->bdev,
665 "cannot find node\n");
669 fp->mode.hdr.dst = FWLOCALBUS | fwdev->dst;
672 /* XXX what's this? */
679 bcopy(fp, (void *)&xfer->send.hdr, tinfo->hdr_len);
681 bcopy((char *)fp + tinfo->hdr_len,
682 xfer->send.payload, pay_len);
683 xfer->send.spd = asyreq->req.sped;
684 xfer->hand = fw_xferwake;
686 if ((err = fw_asyreq(fc, -1, xfer)) != 0)
688 if ((err = fw_xferwait(xfer)) != 0)
690 if (xfer->resp != 0) {
694 if ((tinfo->flag & FWTI_TLABEL) == 0)
698 tinfo = &fc->tcode[xfer->recv.hdr.mode.hdr.tcode];
699 if (xfer->recv.hdr.mode.hdr.tcode == FWTCODE_RRESB ||
700 xfer->recv.hdr.mode.hdr.tcode == FWTCODE_LRES) {
701 pay_len = xfer->recv.pay_len;
702 if (asyreq->req.len >= xfer->recv.pay_len + tinfo->hdr_len) {
703 asyreq->req.len = xfer->recv.pay_len +
712 bcopy(&xfer->recv.hdr, fp, tinfo->hdr_len);
713 bcopy(xfer->recv.payload, (char *)fp + tinfo->hdr_len, pay_len);
715 fw_xfer_free_buf(xfer);
722 fwb = fw_bindlookup(fc,
723 bindreq->start.hi, bindreq->start.lo);
728 fw_bindremove(fc, fwb);
729 STAILQ_REMOVE(&d->binds, fwb, fw_bind, chlist);
730 fw_xferlist_remove(&fwb->xferlist);
734 if (bindreq->len <= 0) {
738 if (bindreq->start.hi > 0xffff) {
742 fwb = malloc(sizeof(struct fw_bind), M_FW, M_WAITOK);
743 fwb->start = ((u_int64_t)bindreq->start.hi << 32) |
745 fwb->end = fwb->start + bindreq->len;
747 STAILQ_INIT(&fwb->xferlist);
748 err = fw_bindadd(fc, fwb);
750 fw_xferlist_add(&fwb->xferlist, M_FWXFER,
752 PAGE_SIZE, PAGE_SIZE, 5,
754 STAILQ_INSERT_TAIL(&d->binds, fwb, chlist);
760 devinfo = &fwdevlst->dev[0];
761 devinfo->dst = fc->nodeid;
762 devinfo->status = 0; /* XXX */
763 devinfo->eui.hi = fc->eui.hi;
764 devinfo->eui.lo = fc->eui.lo;
765 STAILQ_FOREACH(fwdev, &fc->devices, link) {
766 if (len < FW_MAX_DEVLST) {
767 devinfo = &fwdevlst->dev[len++];
768 devinfo->dst = fwdev->dst;
770 (fwdev->status == FWDEVINVAL) ? 0 : 1;
771 devinfo->eui.hi = fwdev->eui.hi;
772 devinfo->eui.lo = fwdev->eui.lo;
777 fwdevlst->info_len = len;
780 bcopy(fc->topology_map, data,
781 (fc->topology_map->crc_len + 1) * 4);
784 STAILQ_FOREACH(fwdev, &fc->devices, link)
785 if (FW_EUI64_EQUAL(fwdev->eui, crom_buf->eui))
788 if (!FW_EUI64_EQUAL(fc->eui, crom_buf->eui)) {
793 ptr = malloc(CROMSIZE, M_FW, M_WAITOK);
795 for (i = 0; i < CROMSIZE/4; i++)
797 = ntohl(fc->config_rom[i]);
800 ptr = (void *)&fwdev->csrrom[0];
801 if (fwdev->rommax < CSRROMOFF)
804 len = fwdev->rommax - CSRROMOFF + 4;
806 if (crom_buf->len < len)
810 err = copyout(ptr, crom_buf->ptr, len);
816 fc->ioctl(dev, cmd, data, flag, td);
822 fw_poll(struct cdev *dev, int events, fw_proc *td)
829 return fwmem_poll(dev, events, td);
831 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
833 tmp = POLLIN | POLLRDNORM;
835 if (STAILQ_FIRST(&ir->q) != NULL)
838 selrecord(td, &ir->rsel);
840 tmp = POLLOUT | POLLWRNORM;
842 /* XXX should be fixed */
850 fw_mmap (struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
851 int nproto, vm_memattr_t *memattr)
855 return fwmem_mmap(dev, offset, paddr, nproto, memattr);
861 fw_strategy(struct bio *bp)
866 if (DEV_FWMEM(dev)) {
871 bp->bio_error = EOPNOTSUPP;
872 bp->bio_flags |= BIO_ERROR;
873 bp->bio_resid = bp->bio_bcount;
878 fwdev_makedev(struct firewire_softc *sc)
885 unit = device_get_unit(sc->fc->bdev);
886 sc->dev = make_dev(&firewire_cdevsw, MAKEMINOR(0, unit, 0),
887 UID_ROOT, GID_OPERATOR, 0660, "fw%d.%d", unit, 0);
888 d = make_dev(&firewire_cdevsw, MAKEMINOR(FWMEM_FLAG, unit, 0),
889 UID_ROOT, GID_OPERATOR, 0660, "fwmem%d.%d", unit, 0);
890 dev_depends(sc->dev, d);
891 make_dev_alias(sc->dev, "fw%d", unit);
892 make_dev_alias(d, "fwmem%d", unit);
898 fwdev_destroydev(struct firewire_softc *sc)
902 destroy_dev(sc->dev);
908 fwdev_clone(void *arg, struct ucred *cred, char *name, int namelen,
911 struct firewire_softc *sc;
912 char *devnames[NDEVTYPE] = {"fw", "fwmem"};
914 int devflag[NDEVTYPE] = {0, FWMEM_FLAG};
915 int i, unit = 0, sub = 0;
920 for (i = 0; i < NDEVTYPE; i++)
921 if (dev_stdclone(name, &subp, devnames[i], &unit) == 2)
927 if (subp == NULL || *subp++ != '.')
931 while (isdigit(*subp)) {
933 sub += *subp++ - '0';
938 sc = devclass_get_softc(firewire_devclass, unit);
941 *dev = make_dev_credf(MAKEDEV_REF, &firewire_cdevsw,
942 MAKEMINOR(devflag[i], unit, sub), cred, UID_ROOT, GID_OPERATOR,
943 0660, "%s%d.%d", devnames[i], unit, sub);
944 dev_depends(sc->dev, *dev);