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>
42 #if defined(__DragonFly__) || __FreeBSD_version < 500000
48 #include <sys/kernel.h>
49 #include <sys/malloc.h>
54 #include <sys/ctype.h>
55 #include <machine/bus.h>
57 #include <sys/ioccom.h>
61 #include "firewirereg.h"
66 #include <dev/firewire/firewire.h>
67 #include <dev/firewire/firewirereg.h>
68 #include <dev/firewire/fwdma.h>
69 #include <dev/firewire/fwmem.h>
70 #include <dev/firewire/iec68113.h>
73 #define FWNODE_INVAL 0xffff
75 static d_open_t fw_open;
76 static d_close_t fw_close;
77 static d_ioctl_t fw_ioctl;
78 static d_poll_t fw_poll;
79 static d_read_t fw_read; /* for Isochronous packet */
80 static d_write_t fw_write;
81 static d_mmap_t fw_mmap;
82 static d_strategy_t fw_strategy;
84 struct cdevsw firewire_cdevsw = {
86 #define CDEV_MAJOR 127
87 "fw", CDEV_MAJOR, D_MEM, NULL, 0,
88 fw_open, fw_close, fw_read, fw_write, fw_ioctl,
89 fw_poll, fw_mmap, fw_strategy, nodump, nopsize,
90 #elif __FreeBSD_version >= 500104
91 .d_version = D_VERSION,
99 .d_strategy = fw_strategy,
101 .d_flags = D_MEM | D_NEEDGIANT
103 #define CDEV_MAJOR 127
104 fw_open, fw_close, fw_read, fw_write, fw_ioctl,
105 fw_poll, fw_mmap, fw_strategy, "fw", CDEV_MAJOR,
106 nodump, nopsize, D_MEM, -1
113 struct fw_isobufreq bufreq;
117 fwdev_allocbuf(struct firewire_comm *fc, struct fw_xferq *q,
118 struct fw_bufspec *b)
122 if (q->flag & (FWXFERQ_RUNNING | FWXFERQ_EXTBUF))
125 q->bulkxfer = (struct fw_bulkxfer *) malloc(
126 sizeof(struct fw_bulkxfer) * b->nchunk,
128 if (q->bulkxfer == NULL)
131 b->psize = roundup2(b->psize, sizeof(uint32_t));
132 q->buf = fwdma_malloc_multiseg(fc, sizeof(uint32_t),
133 b->psize, b->nchunk * b->npacket, BUS_DMA_WAITOK);
135 if (q->buf == NULL) {
136 free(q->bulkxfer, M_FW);
140 q->bnchunk = b->nchunk;
141 q->bnpacket = b->npacket;
142 q->psize = (b->psize + 3) & ~3;
145 STAILQ_INIT(&q->stvalid);
146 STAILQ_INIT(&q->stfree);
147 STAILQ_INIT(&q->stdma);
150 for(i = 0 ; i < q->bnchunk; i++){
151 q->bulkxfer[i].poffset = i * q->bnpacket;
152 q->bulkxfer[i].mbuf = NULL;
153 STAILQ_INSERT_TAIL(&q->stfree, &q->bulkxfer[i], link);
156 q->flag &= ~FWXFERQ_MODEMASK;
157 q->flag |= FWXFERQ_STREAM;
158 q->flag |= FWXFERQ_EXTBUF;
164 fwdev_freebuf(struct fw_xferq *q)
166 if (q->flag & FWXFERQ_EXTBUF) {
168 fwdma_free_multiseg(q->buf);
170 free(q->bulkxfer, M_FW);
172 q->flag &= ~FWXFERQ_EXTBUF;
174 q->maxq = FWMAXQUEUE;
181 fw_open (struct cdev *dev, int flags, int fmt, fw_proc *td)
186 return fwmem_open(dev, flags, fmt, td);
188 if (dev->si_drv1 != NULL)
191 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
192 if ((dev->si_flags & SI_NAMED) == 0) {
193 int unit = DEV2UNIT(dev);
194 int sub = DEV2SUB(dev);
196 make_dev(&firewire_cdevsw, minor(dev),
197 UID_ROOT, GID_OPERATOR, 0660,
198 "fw%d.%d", unit, sub);
202 dev->si_drv1 = malloc(sizeof(struct fw_drv1), M_FW, M_WAITOK | M_ZERO);
208 fw_close (struct cdev *dev, int flags, int fmt, fw_proc *td)
210 struct firewire_softc *sc;
211 struct firewire_comm *fc;
213 int unit = DEV2UNIT(dev);
214 struct fw_xfer *xfer;
219 return fwmem_close(dev, flags, fmt, td);
221 sc = devclass_get_softc(firewire_devclass, unit);
223 d = (struct fw_drv1 *)dev->si_drv1;
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);
246 for (fwb = STAILQ_FIRST(&ir->binds); fwb != NULL;
247 fwb = STAILQ_FIRST(&ir->binds)) {
248 STAILQ_REMOVE(&fc->binds, fwb, fw_bind, fclist);
249 STAILQ_REMOVE_HEAD(&ir->binds, chlist);
252 ir->flag &= ~(FWXFERQ_OPEN |
253 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
258 struct fw_xferq *it = d->it;
260 if ((it->flag & FWXFERQ_OPEN) == 0)
262 if (it->flag & FWXFERQ_RUNNING) {
263 it->flag &= ~FWXFERQ_RUNNING;
264 fc->itx_disable(fc, it->dmach);
268 it->flag &= ~(FWXFERQ_OPEN |
269 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
272 free(dev->si_drv1, M_FW);
282 fw_read (struct cdev *dev, struct uio *uio, int ioflag)
284 struct firewire_softc *sc;
286 struct fw_xfer *xfer;
287 int err = 0, s, slept = 0;
288 int unit = DEV2UNIT(dev);
292 return physio(dev, uio, ioflag);
294 sc = devclass_get_softc(firewire_devclass, unit);
296 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
297 if (ir == NULL || ir->buf == NULL)
301 xfer = STAILQ_FIRST(&ir->q);
302 if (ir->stproc == NULL) {
304 ir->stproc = STAILQ_FIRST(&ir->stvalid);
305 if (ir->stproc != NULL) {
307 STAILQ_REMOVE_HEAD(&ir->stvalid, link);
312 if (xfer == NULL && ir->stproc == NULL) {
313 /* no data avaliable */
316 ir->flag |= FWXFERQ_WAKEUP;
317 err = tsleep(ir, FWPRI, "fw_read", hz);
318 ir->flag &= ~FWXFERQ_WAKEUP;
321 } else if (slept == 1)
324 } else if(xfer != NULL) {
325 #if 0 /* XXX broken */
326 /* per packet mode or FWACT_CH bind?*/
329 STAILQ_REMOVE_HEAD(&ir->q, link);
331 fp = &xfer->recv.hdr;
332 if (sc->fc->irx_post != NULL)
333 sc->fc->irx_post(sc->fc, fp->mode.ld);
334 err = uiomove((void *)fp, 1 /* XXX header size */, uio);
335 /* XXX copy payload too */
336 /* XXX we should recycle this xfer */
339 } else if(ir->stproc != NULL) {
341 fp = (struct fw_pkt *)fwdma_v_addr(ir->buf,
342 ir->stproc->poffset + ir->queued);
343 if(sc->fc->irx_post != NULL)
344 sc->fc->irx_post(sc->fc, fp->mode.ld);
345 if(fp->mode.stream.len == 0){
349 err = uiomove((caddr_t)fp,
350 fp->mode.stream.len + sizeof(uint32_t), uio);
352 if(ir->queued >= ir->bnpacket){
354 STAILQ_INSERT_TAIL(&ir->stfree, ir->stproc, link);
356 sc->fc->irx_enable(sc->fc, ir->dmach);
359 if (uio->uio_resid >= ir->psize) {
368 fw_write (struct cdev *dev, struct uio *uio, int ioflag)
371 struct firewire_softc *sc;
372 int unit = DEV2UNIT(dev);
375 struct firewire_comm *fc;
379 return physio(dev, uio, ioflag);
381 sc = devclass_get_softc(firewire_devclass, unit);
383 it = ((struct fw_drv1 *)dev->si_drv1)->it;
384 if (it == NULL || it->buf == NULL)
387 if (it->stproc == NULL) {
388 it->stproc = STAILQ_FIRST(&it->stfree);
389 if (it->stproc != NULL) {
391 STAILQ_REMOVE_HEAD(&it->stfree, link);
394 } else if (slept == 0) {
396 err = sc->fc->itx_enable(sc->fc, it->dmach);
399 err = tsleep(it, FWPRI, "fw_write", hz);
408 fp = (struct fw_pkt *)fwdma_v_addr(it->buf,
409 it->stproc->poffset + it->queued);
410 err = uiomove((caddr_t)fp, sizeof(struct fw_isohdr), uio);
411 err = uiomove((caddr_t)fp->mode.stream.payload,
412 fp->mode.stream.len, uio);
414 if (it->queued >= it->bnpacket) {
416 STAILQ_INSERT_TAIL(&it->stvalid, it->stproc, link);
419 err = sc->fc->itx_enable(sc->fc, it->dmach);
421 if (uio->uio_resid >= sizeof(struct fw_isohdr)) {
431 fw_ioctl (struct cdev *dev, u_long cmd, caddr_t data, int flag, fw_proc *td)
433 struct firewire_softc *sc;
434 struct firewire_comm *fc;
436 int unit = DEV2UNIT(dev);
437 int s, i, len, err = 0;
438 struct fw_device *fwdev;
440 struct fw_xferq *ir, *it;
441 struct fw_xfer *xfer;
443 struct fw_devinfo *devinfo;
446 struct fw_devlstreq *fwdevlst = (struct fw_devlstreq *)data;
447 struct fw_asyreq *asyreq = (struct fw_asyreq *)data;
448 struct fw_isochreq *ichreq = (struct fw_isochreq *)data;
449 struct fw_isobufreq *ibufreq = (struct fw_isobufreq *)data;
450 struct fw_asybindreq *bindreq = (struct fw_asybindreq *)data;
451 struct fw_crom_buf *crom_buf = (struct fw_crom_buf *)data;
454 return fwmem_ioctl(dev, cmd, data, flag, td);
459 sc = devclass_get_softc(firewire_devclass, unit);
461 d = (struct fw_drv1 *)dev->si_drv1;
468 for (i = 0; i < fc->nisodma; i ++) {
470 if ((it->flag & FWXFERQ_OPEN) == 0)
473 if (i >= fc->nisodma) {
477 err = fwdev_allocbuf(fc, it, &d->bufreq.tx);
480 it->flag |= FWXFERQ_OPEN;
483 it->flag |= (0x3f & ichreq->ch);
484 it->flag |= ((0x3 & ichreq->tag) << 6);
489 ichreq->ch = it->flag & 0x3f;
490 ichreq->tag = it->flag >> 2 & 0x3;
496 for (i = 0; i < fc->nisodma; i ++) {
498 if ((ir->flag & FWXFERQ_OPEN) == 0)
501 if (i >= fc->nisodma) {
505 err = fwdev_allocbuf(fc, ir, &d->bufreq.rx);
508 ir->flag |= FWXFERQ_OPEN;
511 ir->flag |= (0x3f & ichreq->ch);
512 ir->flag |= ((0x3 & ichreq->tag) << 6);
514 err = fc->irx_enable(fc, ir->dmach);
518 ichreq->ch = ir->flag & 0x3f;
519 ichreq->tag = ir->flag >> 2 & 0x3;
524 bcopy(ibufreq, &d->bufreq, sizeof(d->bufreq));
527 bzero(&ibufreq->rx, sizeof(ibufreq->rx));
529 ibufreq->rx.nchunk = ir->bnchunk;
530 ibufreq->rx.npacket = ir->bnpacket;
531 ibufreq->rx.psize = ir->psize;
533 bzero(&ibufreq->tx, sizeof(ibufreq->tx));
535 ibufreq->tx.nchunk = it->bnchunk;
536 ibufreq->tx.npacket = it->bnpacket;
537 ibufreq->tx.psize = it->psize;
542 struct tcode_info *tinfo;
546 tinfo = &sc->fc->tcode[fp->mode.hdr.tcode];
548 if ((tinfo->flag & FWTI_BLOCK_ASY) != 0)
549 pay_len = MAX(0, asyreq->req.len - tinfo->hdr_len);
551 xfer = fw_xfer_alloc_buf(M_FWXFER, pay_len, PAGE_SIZE/*XXX*/);
555 switch (asyreq->req.type) {
559 fwdev = fw_noderesolve_eui64(sc->fc,
560 &asyreq->req.dst.eui);
562 device_printf(sc->fc->bdev,
563 "cannot find node\n");
567 fp->mode.hdr.dst = FWLOCALBUS | fwdev->dst;
570 /* XXX what's this? */
577 bcopy(fp, (void *)&xfer->send.hdr, tinfo->hdr_len);
579 bcopy((char *)fp + tinfo->hdr_len,
580 (void *)xfer->send.payload, pay_len);
581 xfer->send.spd = asyreq->req.sped;
582 xfer->act.hand = fw_asy_callback;
584 if ((err = fw_asyreq(sc->fc, -1, xfer)) != 0)
586 if ((err = tsleep(xfer, FWPRI, "asyreq", hz)) != 0)
588 if (xfer->resp != 0) {
592 if ((tinfo->flag & FWTI_TLABEL) == 0)
596 tinfo = &sc->fc->tcode[xfer->recv.hdr.mode.hdr.tcode];
597 if (xfer->recv.hdr.mode.hdr.tcode == FWTCODE_RRESB ||
598 xfer->recv.hdr.mode.hdr.tcode == FWTCODE_LRES) {
599 pay_len = xfer->recv.pay_len;
600 if (asyreq->req.len >= xfer->recv.pay_len + tinfo->hdr_len) {
601 asyreq->req.len = xfer->recv.pay_len +
610 bcopy(&xfer->recv.hdr, fp, tinfo->hdr_len);
611 bcopy(xfer->recv.payload, (char *)fp + tinfo->hdr_len, pay_len);
613 fw_xfer_free_buf(xfer);
620 fwb = fw_bindlookup(sc->fc,
621 bindreq->start.hi, bindreq->start.lo);
626 STAILQ_REMOVE(&sc->fc->binds, fwb, fw_bind, fclist);
627 STAILQ_REMOVE(&ir->binds, fwb, fw_bind, chlist);
631 if(bindreq->len <= 0 ){
635 if(bindreq->start.hi > 0xffff ){
639 fwb = (struct fw_bind *)malloc(sizeof (struct fw_bind), M_FW, M_NOWAIT);
644 fwb->start = ((u_int64_t)bindreq->start.hi << 32) |
646 fwb->end = fwb->start + bindreq->len;
648 fwb->sub = ir->dmach;
649 fwb->act_type = FWACT_CH;
652 xfer = fw_xfer_alloc(M_FWXFER);
660 /* XXX broken. need multiple xfer */
661 STAILQ_INIT(&fwb->xferlist);
662 STAILQ_INSERT_TAIL(&fwb->xferlist, xfer, link);
664 err = fw_bindadd(sc->fc, fwb);
669 devinfo = &fwdevlst->dev[0];
670 devinfo->dst = sc->fc->nodeid;
671 devinfo->status = 0; /* XXX */
672 devinfo->eui.hi = sc->fc->eui.hi;
673 devinfo->eui.lo = sc->fc->eui.lo;
674 STAILQ_FOREACH(fwdev, &sc->fc->devices, link) {
675 if(len < FW_MAX_DEVLST){
676 devinfo = &fwdevlst->dev[len++];
677 devinfo->dst = fwdev->dst;
679 (fwdev->status == FWDEVINVAL)?0:1;
680 devinfo->eui.hi = fwdev->eui.hi;
681 devinfo->eui.lo = fwdev->eui.lo;
686 fwdevlst->info_len = len;
689 bcopy(sc->fc->topology_map, data,
690 (sc->fc->topology_map->crc_len + 1) * 4);
693 STAILQ_FOREACH(fwdev, &sc->fc->devices, link)
694 if (FW_EUI64_EQUAL(fwdev->eui, crom_buf->eui))
697 if (!FW_EUI64_EQUAL(sc->fc->eui, crom_buf->eui)) {
702 ptr = malloc(CROMSIZE, M_FW, M_WAITOK);
704 for (i = 0; i < CROMSIZE/4; i++)
706 = ntohl(sc->fc->config_rom[i]);
709 ptr = (void *)&fwdev->csrrom[0];
710 if (fwdev->rommax < CSRROMOFF)
713 len = fwdev->rommax - CSRROMOFF + 4;
715 if (crom_buf->len < len)
719 err = copyout(ptr, crom_buf->ptr, len);
725 sc->fc->ioctl (dev, cmd, data, flag, td);
731 fw_poll(struct cdev *dev, int events, fw_proc *td)
733 struct firewire_softc *sc;
737 int unit = DEV2UNIT(dev);
740 return fwmem_poll(dev, events, td);
742 sc = devclass_get_softc(firewire_devclass, unit);
743 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
745 tmp = POLLIN | POLLRDNORM;
747 if (STAILQ_FIRST(&ir->q) != NULL)
750 selrecord(td, &ir->rsel);
752 tmp = POLLOUT | POLLWRNORM;
754 /* XXX should be fixed */
762 #if defined(__DragonFly__) || __FreeBSD_version < 500102
763 fw_mmap (struct cdev *dev, vm_offset_t offset, int nproto)
765 fw_mmap (struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, int nproto)
768 struct firewire_softc *sc;
769 int unit = DEV2UNIT(dev);
772 #if defined(__DragonFly__) || __FreeBSD_version < 500102
773 return fwmem_mmap(dev, offset, nproto);
775 return fwmem_mmap(dev, offset, paddr, nproto);
778 sc = devclass_get_softc(firewire_devclass, unit);
784 fw_strategy(struct bio *bp)
789 if (DEV_FWMEM(dev)) {
794 bp->bio_error = EOPNOTSUPP;
795 bp->bio_flags |= BIO_ERROR;
796 bp->bio_resid = bp->bio_bcount;
801 fwdev_makedev(struct firewire_softc *sc)
805 #if defined(__DragonFly__) || __FreeBSD_version < 500000
806 cdevsw_add(&firewire_cdevsw);
811 unit = device_get_unit(sc->fc->bdev);
812 sc->dev = make_dev(&firewire_cdevsw, MAKEMINOR(0, unit, 0),
813 UID_ROOT, GID_OPERATOR, 0660,
815 d = make_dev(&firewire_cdevsw,
816 MAKEMINOR(FWMEM_FLAG, unit, 0),
817 UID_ROOT, GID_OPERATOR, 0660,
818 "fwmem%d.%d", unit, 0);
819 dev_depends(sc->dev, d);
820 make_dev_alias(sc->dev, "fw%d", unit);
821 make_dev_alias(d, "fwmem%d", unit);
828 fwdev_destroydev(struct firewire_softc *sc)
832 #if defined(__DragonFly__) || __FreeBSD_version < 500000
833 cdevsw_remove(&firewire_cdevsw);
835 destroy_dev(sc->dev);
840 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
843 fwdev_clone(void *arg, struct ucred *cred, char *name, int namelen,
846 struct firewire_softc *sc;
847 char *devnames[NDEVTYPE] = {"fw", "fwmem"};
849 int devflag[NDEVTYPE] = {0, FWMEM_FLAG};
850 int i, unit = 0, sub = 0;
855 for (i = 0; i < NDEVTYPE; i++)
856 if (dev_stdclone(name, &subp, devnames[i], &unit) == 2)
862 if (subp == NULL || *subp++ != '.')
866 while (isdigit(*subp)) {
868 sub += *subp++ - '0';
873 sc = devclass_get_softc(firewire_devclass, unit);
876 *dev = make_dev(&firewire_cdevsw, MAKEMINOR(devflag[i], unit, sub),
877 UID_ROOT, GID_OPERATOR, 0660,
878 "%s%d.%d", devnames[i], unit, sub);
880 (*dev)->si_flags |= SI_CHEAPCLONE;
881 dev_depends(sc->dev, *dev);