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.9 2004/05/19 22:52:38 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>
62 #include "firewirereg.h"
67 #include <dev/firewire/firewire.h>
68 #include <dev/firewire/firewirereg.h>
69 #include <dev/firewire/fwdma.h>
70 #include <dev/firewire/fwmem.h>
71 #include <dev/firewire/iec68113.h>
74 #define CDEV_MAJOR 127
75 #define FWNODE_INVAL 0xffff
77 static d_open_t fw_open;
78 static d_close_t fw_close;
79 static d_ioctl_t fw_ioctl;
80 static d_poll_t fw_poll;
81 static d_read_t fw_read; /* for Isochronous packet */
82 static d_write_t fw_write;
83 static d_mmap_t fw_mmap;
84 static d_strategy_t fw_strategy;
86 struct cdevsw firewire_cdevsw =
89 "fw", CDEV_MAJOR, D_MEM, NULL, 0,
90 fw_open, fw_close, fw_read, fw_write, fw_ioctl,
91 fw_poll, fw_mmap, fw_strategy, nodump, nopsize,
92 #elif __FreeBSD_version >= 500104
100 .d_strategy = fw_strategy,
105 fw_open, fw_close, fw_read, fw_write, fw_ioctl,
106 fw_poll, fw_mmap, fw_strategy, "fw", CDEV_MAJOR,
107 nodump, nopsize, D_MEM, -1
114 struct fw_isobufreq bufreq;
118 fwdev_allocbuf(struct firewire_comm *fc, struct fw_xferq *q,
119 struct fw_bufspec *b)
123 if (q->flag & (FWXFERQ_RUNNING | FWXFERQ_EXTBUF))
126 q->bulkxfer = (struct fw_bulkxfer *) malloc(
127 sizeof(struct fw_bulkxfer) * b->nchunk,
129 if (q->bulkxfer == NULL)
132 b->psize = roundup2(b->psize, sizeof(u_int32_t));
133 q->buf = fwdma_malloc_multiseg(fc, sizeof(u_int32_t),
134 b->psize, b->nchunk * b->npacket, BUS_DMA_WAITOK);
136 if (q->buf == NULL) {
137 free(q->bulkxfer, M_FW);
141 q->bnchunk = b->nchunk;
142 q->bnpacket = b->npacket;
143 q->psize = (b->psize + 3) & ~3;
146 STAILQ_INIT(&q->stvalid);
147 STAILQ_INIT(&q->stfree);
148 STAILQ_INIT(&q->stdma);
151 for(i = 0 ; i < q->bnchunk; i++){
152 q->bulkxfer[i].poffset = i * q->bnpacket;
153 q->bulkxfer[i].mbuf = NULL;
154 STAILQ_INSERT_TAIL(&q->stfree, &q->bulkxfer[i], link);
157 q->flag &= ~FWXFERQ_MODEMASK;
158 q->flag |= FWXFERQ_STREAM;
159 q->flag |= FWXFERQ_EXTBUF;
165 fwdev_freebuf(struct fw_xferq *q)
167 if (q->flag & FWXFERQ_EXTBUF) {
169 fwdma_free_multiseg(q->buf);
171 free(q->bulkxfer, M_FW);
173 q->flag &= ~FWXFERQ_EXTBUF;
175 q->maxq = FWMAXQUEUE;
182 fw_open (dev_t dev, int flags, int fmt, fw_proc *td)
187 return fwmem_open(dev, flags, fmt, td);
189 if (dev->si_drv1 != NULL)
192 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
193 if ((dev->si_flags & SI_NAMED) == 0) {
194 int unit = DEV2UNIT(dev);
195 int sub = DEV2SUB(dev);
197 make_dev(&firewire_cdevsw, minor(dev),
198 UID_ROOT, GID_OPERATOR, 0660,
199 "fw%d.%d", unit, sub);
203 dev->si_drv1 = malloc(sizeof(struct fw_drv1), M_FW, M_WAITOK | M_ZERO);
209 fw_close (dev_t dev, int flags, int fmt, fw_proc *td)
211 struct firewire_softc *sc;
212 struct firewire_comm *fc;
214 int unit = DEV2UNIT(dev);
215 struct fw_xfer *xfer;
220 return fwmem_close(dev, flags, fmt, td);
222 sc = devclass_get_softc(firewire_devclass, unit);
224 d = (struct fw_drv1 *)dev->si_drv1;
227 struct fw_xferq *ir = d->ir;
229 if ((ir->flag & FWXFERQ_OPEN) == 0)
231 if (ir->flag & FWXFERQ_RUNNING) {
232 ir->flag &= ~FWXFERQ_RUNNING;
233 fc->irx_disable(fc, ir->dmach);
237 /* drain receiving buffer */
238 for (xfer = STAILQ_FIRST(&ir->q);
239 xfer != NULL; xfer = STAILQ_FIRST(&ir->q)) {
241 STAILQ_REMOVE_HEAD(&ir->q, link);
247 for (fwb = STAILQ_FIRST(&ir->binds); fwb != NULL;
248 fwb = STAILQ_FIRST(&ir->binds)) {
249 STAILQ_REMOVE(&fc->binds, fwb, fw_bind, fclist);
250 STAILQ_REMOVE_HEAD(&ir->binds, chlist);
253 ir->flag &= ~(FWXFERQ_OPEN |
254 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
259 struct fw_xferq *it = d->it;
261 if ((it->flag & FWXFERQ_OPEN) == 0)
263 if (it->flag & FWXFERQ_RUNNING) {
264 it->flag &= ~FWXFERQ_RUNNING;
265 fc->itx_disable(fc, it->dmach);
269 it->flag &= ~(FWXFERQ_OPEN |
270 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
273 free(dev->si_drv1, M_FW);
283 fw_read (dev_t dev, struct uio *uio, int ioflag)
285 struct firewire_softc *sc;
287 struct fw_xfer *xfer;
288 int err = 0, s, slept = 0;
289 int unit = DEV2UNIT(dev);
293 return physio(dev, uio, ioflag);
295 sc = devclass_get_softc(firewire_devclass, unit);
297 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
298 if (ir == NULL || ir->buf == NULL)
302 xfer = STAILQ_FIRST(&ir->q);
303 if (ir->stproc == NULL) {
305 ir->stproc = STAILQ_FIRST(&ir->stvalid);
306 if (ir->stproc != NULL) {
308 STAILQ_REMOVE_HEAD(&ir->stvalid, link);
313 if (xfer == NULL && ir->stproc == NULL) {
314 /* no data avaliable */
317 ir->flag |= FWXFERQ_WAKEUP;
318 err = tsleep(ir, FWPRI, "fw_read", hz);
319 ir->flag &= ~FWXFERQ_WAKEUP;
322 } else if (slept == 1)
325 } else if(xfer != NULL) {
326 #if 0 /* XXX broken */
327 /* per packet mode or FWACT_CH bind?*/
330 STAILQ_REMOVE_HEAD(&ir->q, link);
332 fp = &xfer->recv.hdr;
333 if (sc->fc->irx_post != NULL)
334 sc->fc->irx_post(sc->fc, fp->mode.ld);
335 err = uiomove((void *)fp, 1 /* XXX header size */, uio);
336 /* XXX copy payload too */
337 /* XXX we should recycle this xfer */
340 } else if(ir->stproc != NULL) {
342 fp = (struct fw_pkt *)fwdma_v_addr(ir->buf,
343 ir->stproc->poffset + ir->queued);
344 if(sc->fc->irx_post != NULL)
345 sc->fc->irx_post(sc->fc, fp->mode.ld);
346 if(fp->mode.stream.len == 0){
350 err = uiomove((caddr_t)fp,
351 fp->mode.stream.len + sizeof(u_int32_t), uio);
353 if(ir->queued >= ir->bnpacket){
355 STAILQ_INSERT_TAIL(&ir->stfree, ir->stproc, link);
357 sc->fc->irx_enable(sc->fc, ir->dmach);
360 if (uio->uio_resid >= ir->psize) {
369 fw_write (dev_t dev, struct uio *uio, int ioflag)
372 struct firewire_softc *sc;
373 int unit = DEV2UNIT(dev);
376 struct firewire_comm *fc;
380 return physio(dev, uio, ioflag);
382 sc = devclass_get_softc(firewire_devclass, unit);
384 it = ((struct fw_drv1 *)dev->si_drv1)->it;
385 if (it == NULL || it->buf == NULL)
388 if (it->stproc == NULL) {
389 it->stproc = STAILQ_FIRST(&it->stfree);
390 if (it->stproc != NULL) {
392 STAILQ_REMOVE_HEAD(&it->stfree, link);
395 } else if (slept == 0) {
397 err = sc->fc->itx_enable(sc->fc, it->dmach);
400 err = tsleep(it, FWPRI, "fw_write", hz);
409 fp = (struct fw_pkt *)fwdma_v_addr(it->buf,
410 it->stproc->poffset + it->queued);
411 err = uiomove((caddr_t)fp, sizeof(struct fw_isohdr), uio);
412 err = uiomove((caddr_t)fp->mode.stream.payload,
413 fp->mode.stream.len, uio);
415 if (it->queued >= it->bnpacket) {
417 STAILQ_INSERT_TAIL(&it->stvalid, it->stproc, link);
420 err = sc->fc->itx_enable(sc->fc, it->dmach);
422 if (uio->uio_resid >= sizeof(struct fw_isohdr)) {
432 fw_ioctl (dev_t dev, u_long cmd, caddr_t data, int flag, fw_proc *td)
434 struct firewire_softc *sc;
435 struct firewire_comm *fc;
437 int unit = DEV2UNIT(dev);
438 int s, i, len, err = 0;
439 struct fw_device *fwdev;
441 struct fw_xferq *ir, *it;
442 struct fw_xfer *xfer;
444 struct fw_devinfo *devinfo;
447 struct fw_devlstreq *fwdevlst = (struct fw_devlstreq *)data;
448 struct fw_asyreq *asyreq = (struct fw_asyreq *)data;
449 struct fw_isochreq *ichreq = (struct fw_isochreq *)data;
450 struct fw_isobufreq *ibufreq = (struct fw_isobufreq *)data;
451 struct fw_asybindreq *bindreq = (struct fw_asybindreq *)data;
452 struct fw_crom_buf *crom_buf = (struct fw_crom_buf *)data;
455 return fwmem_ioctl(dev, cmd, data, flag, td);
460 sc = devclass_get_softc(firewire_devclass, unit);
462 d = (struct fw_drv1 *)dev->si_drv1;
469 for (i = 0; i < fc->nisodma; i ++) {
471 if ((it->flag & FWXFERQ_OPEN) == 0)
474 if (i >= fc->nisodma) {
478 err = fwdev_allocbuf(fc, it, &d->bufreq.tx);
481 it->flag |= FWXFERQ_OPEN;
484 it->flag |= (0x3f & ichreq->ch);
485 it->flag |= ((0x3 & ichreq->tag) << 6);
490 ichreq->ch = it->flag & 0x3f;
491 ichreq->tag = it->flag >> 2 & 0x3;
497 for (i = 0; i < fc->nisodma; i ++) {
499 if ((ir->flag & FWXFERQ_OPEN) == 0)
502 if (i >= fc->nisodma) {
506 err = fwdev_allocbuf(fc, ir, &d->bufreq.rx);
509 ir->flag |= FWXFERQ_OPEN;
512 ir->flag |= (0x3f & ichreq->ch);
513 ir->flag |= ((0x3 & ichreq->tag) << 6);
515 err = fc->irx_enable(fc, ir->dmach);
519 ichreq->ch = ir->flag & 0x3f;
520 ichreq->tag = ir->flag >> 2 & 0x3;
525 bcopy(ibufreq, &d->bufreq, sizeof(d->bufreq));
528 bzero(&ibufreq->rx, sizeof(ibufreq->rx));
530 ibufreq->rx.nchunk = ir->bnchunk;
531 ibufreq->rx.npacket = ir->bnpacket;
532 ibufreq->rx.psize = ir->psize;
534 bzero(&ibufreq->tx, sizeof(ibufreq->tx));
536 ibufreq->tx.nchunk = it->bnchunk;
537 ibufreq->tx.npacket = it->bnpacket;
538 ibufreq->tx.psize = it->psize;
543 struct tcode_info *tinfo;
547 tinfo = &sc->fc->tcode[fp->mode.hdr.tcode];
549 if ((tinfo->flag & FWTI_BLOCK_ASY) != 0)
550 pay_len = MAX(0, asyreq->req.len - tinfo->hdr_len);
552 xfer = fw_xfer_alloc_buf(M_FWXFER, pay_len, PAGE_SIZE/*XXX*/);
556 switch (asyreq->req.type) {
560 fwdev = fw_noderesolve_eui64(sc->fc,
561 &asyreq->req.dst.eui);
563 device_printf(sc->fc->bdev,
564 "cannot find node\n");
568 fp->mode.hdr.dst = FWLOCALBUS | fwdev->dst;
571 /* XXX what's this? */
578 bcopy(fp, (void *)&xfer->send.hdr, tinfo->hdr_len);
580 bcopy((char *)fp + tinfo->hdr_len,
581 (void *)&xfer->send.payload, pay_len);
582 xfer->send.spd = asyreq->req.sped;
583 xfer->act.hand = fw_asy_callback;
585 if ((err = fw_asyreq(sc->fc, -1, xfer)) != 0)
587 if ((err = tsleep(xfer, FWPRI, "asyreq", hz)) != 0)
589 if (xfer->resp != 0) {
593 if ((tinfo->flag & FWTI_TLABEL) == 0)
597 tinfo = &sc->fc->tcode[xfer->recv.hdr.mode.hdr.tcode];
598 if (asyreq->req.len >= xfer->recv.pay_len + tinfo->hdr_len)
599 asyreq->req.len = xfer->recv.pay_len;
602 bcopy(&xfer->recv.hdr, fp, tinfo->hdr_len);
603 bcopy(xfer->recv.payload, (char *)fp + tinfo->hdr_len,
604 MAX(0, asyreq->req.len - tinfo->hdr_len));
606 fw_xfer_free_buf(xfer);
613 fwb = fw_bindlookup(sc->fc,
614 bindreq->start.hi, bindreq->start.lo);
619 STAILQ_REMOVE(&sc->fc->binds, fwb, fw_bind, fclist);
620 STAILQ_REMOVE(&ir->binds, fwb, fw_bind, chlist);
624 if(bindreq->len <= 0 ){
628 if(bindreq->start.hi > 0xffff ){
632 fwb = malloc(sizeof (struct fw_bind), M_FW, M_WAITOK);
633 fwb->start = ((u_int64_t)bindreq->start.hi << 32) |
635 fwb->end = fwb->start + bindreq->len;
637 fwb->sub = ir->dmach;
638 fwb->act_type = FWACT_CH;
641 xfer = fw_xfer_alloc(M_FWXFER);
649 /* XXX broken. need multiple xfer */
650 STAILQ_INIT(&fwb->xferlist);
651 STAILQ_INSERT_TAIL(&fwb->xferlist, xfer, link);
653 err = fw_bindadd(sc->fc, fwb);
658 devinfo = &fwdevlst->dev[0];
659 devinfo->dst = sc->fc->nodeid;
660 devinfo->status = 0; /* XXX */
661 devinfo->eui.hi = sc->fc->eui.hi;
662 devinfo->eui.lo = sc->fc->eui.lo;
663 STAILQ_FOREACH(fwdev, &sc->fc->devices, link) {
664 if(len < FW_MAX_DEVLST){
665 devinfo = &fwdevlst->dev[len++];
666 devinfo->dst = fwdev->dst;
668 (fwdev->status == FWDEVINVAL)?0:1;
669 devinfo->eui.hi = fwdev->eui.hi;
670 devinfo->eui.lo = fwdev->eui.lo;
675 fwdevlst->info_len = len;
678 bcopy(sc->fc->topology_map, data,
679 (sc->fc->topology_map->crc_len + 1) * 4);
682 STAILQ_FOREACH(fwdev, &sc->fc->devices, link)
683 if (FW_EUI64_EQUAL(fwdev->eui, crom_buf->eui))
686 if (!FW_EUI64_EQUAL(sc->fc->eui, crom_buf->eui)) {
691 ptr = malloc(CROMSIZE, M_FW, M_WAITOK);
693 for (i = 0; i < CROMSIZE/4; i++)
694 ((u_int32_t *)ptr)[i]
695 = ntohl(sc->fc->config_rom[i]);
698 ptr = (void *)&fwdev->csrrom[0];
699 if (fwdev->rommax < CSRROMOFF)
702 len = fwdev->rommax - CSRROMOFF + 4;
704 if (crom_buf->len < len)
708 err = copyout(ptr, crom_buf->ptr, len);
714 sc->fc->ioctl (dev, cmd, data, flag, td);
720 fw_poll(dev_t dev, int events, fw_proc *td)
722 struct firewire_softc *sc;
726 int unit = DEV2UNIT(dev);
729 return fwmem_poll(dev, events, td);
731 sc = devclass_get_softc(firewire_devclass, unit);
732 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
734 tmp = POLLIN | POLLRDNORM;
736 if (STAILQ_FIRST(&ir->q) != NULL)
739 selrecord(td, &ir->rsel);
741 tmp = POLLOUT | POLLWRNORM;
743 /* XXX should be fixed */
751 #if defined(__DragonFly__) || __FreeBSD_version < 500102
752 fw_mmap (dev_t dev, vm_offset_t offset, int nproto)
754 fw_mmap (dev_t dev, vm_offset_t offset, vm_paddr_t *paddr, int nproto)
757 struct firewire_softc *sc;
758 int unit = DEV2UNIT(dev);
761 #if defined(__DragonFly__) || __FreeBSD_version < 500102
762 return fwmem_mmap(dev, offset, nproto);
764 return fwmem_mmap(dev, offset, paddr, nproto);
767 sc = devclass_get_softc(firewire_devclass, unit);
773 fw_strategy(struct bio *bp)
778 if (DEV_FWMEM(dev)) {
783 bp->bio_error = EOPNOTSUPP;
784 bp->bio_flags |= BIO_ERROR;
785 bp->bio_resid = bp->bio_bcount;
790 fwdev_makedev(struct firewire_softc *sc)
794 unit = device_get_unit(sc->fc->bdev);
795 cdevsw_add(&firewire_cdevsw, FW_UNITMASK, FW_UNIT(unit));
800 fwdev_destroydev(struct firewire_softc *sc)
804 unit = device_get_unit(sc->fc->bdev);
805 cdevsw_remove(&firewire_cdevsw, FW_UNITMASK, FW_UNIT(unit));
809 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
812 fwdev_clone(void *arg, char *name, int namelen, dev_t *dev)
814 struct firewire_softc *sc;
815 char *devnames[NDEVTYPE] = {"fw", "fwmem"};
817 int devflag[NDEVTYPE] = {0, FWMEM_FLAG};
818 int i, unit = 0, sub = 0;
823 for (i = 0; i < NDEVTYPE; i++)
824 if (dev_stdclone(name, &subp, devnames[i], &unit) == 2)
830 if (subp == NULL || *subp++ != '.')
834 while (isdigit(*subp)) {
836 sub += *subp++ - '0';
841 sc = devclass_get_softc(firewire_devclass, unit);
844 *dev = make_dev(&firewire_cdevsw, MAKEMINOR(devflag[i], unit, sub),
845 UID_ROOT, GID_OPERATOR, 0660,
846 "%s%d.%d", devnames[i], unit, sub);
847 (*dev)->si_flags |= SI_CHEAPCLONE;
848 dev_depends(sc->dev, *dev);