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.11 2006/02/17 19:17:44 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>
59 #include <sys/thread2.h>
63 #include "firewirereg.h"
68 #include <dev/firewire/firewire.h>
69 #include <dev/firewire/firewirereg.h>
70 #include <dev/firewire/fwdma.h>
71 #include <dev/firewire/fwmem.h>
72 #include <dev/firewire/iec68113.h>
75 #define CDEV_MAJOR 127
76 #define FWNODE_INVAL 0xffff
78 static d_open_t fw_open;
79 static d_close_t fw_close;
80 static d_ioctl_t fw_ioctl;
81 static d_poll_t fw_poll;
82 static d_read_t fw_read; /* for Isochronous packet */
83 static d_write_t fw_write;
84 static d_mmap_t fw_mmap;
85 static d_strategy_t fw_strategy;
87 struct cdevsw firewire_cdevsw =
90 "fw", CDEV_MAJOR, D_MEM, NULL, 0,
91 fw_open, fw_close, fw_read, fw_write, fw_ioctl,
92 fw_poll, fw_mmap, fw_strategy, nodump, nopsize,
93 #elif __FreeBSD_version >= 500104
101 .d_strategy = fw_strategy,
106 fw_open, fw_close, fw_read, fw_write, fw_ioctl,
107 fw_poll, fw_mmap, fw_strategy, "fw", CDEV_MAJOR,
108 nodump, nopsize, D_MEM, -1
115 struct fw_isobufreq bufreq;
119 fwdev_allocbuf(struct firewire_comm *fc, struct fw_xferq *q,
120 struct fw_bufspec *b)
124 if (q->flag & (FWXFERQ_RUNNING | FWXFERQ_EXTBUF))
127 q->bulkxfer = (struct fw_bulkxfer *) malloc(
128 sizeof(struct fw_bulkxfer) * b->nchunk,
130 if (q->bulkxfer == NULL)
133 b->psize = roundup2(b->psize, sizeof(u_int32_t));
134 q->buf = fwdma_malloc_multiseg(fc, sizeof(u_int32_t),
135 b->psize, b->nchunk * b->npacket, BUS_DMA_WAITOK);
137 if (q->buf == NULL) {
138 free(q->bulkxfer, M_FW);
142 q->bnchunk = b->nchunk;
143 q->bnpacket = b->npacket;
144 q->psize = (b->psize + 3) & ~3;
147 STAILQ_INIT(&q->stvalid);
148 STAILQ_INIT(&q->stfree);
149 STAILQ_INIT(&q->stdma);
152 for(i = 0 ; i < q->bnchunk; i++){
153 q->bulkxfer[i].poffset = i * q->bnpacket;
154 q->bulkxfer[i].mbuf = NULL;
155 STAILQ_INSERT_TAIL(&q->stfree, &q->bulkxfer[i], link);
158 q->flag &= ~FWXFERQ_MODEMASK;
159 q->flag |= FWXFERQ_STREAM;
160 q->flag |= FWXFERQ_EXTBUF;
166 fwdev_freebuf(struct fw_xferq *q)
168 if (q->flag & FWXFERQ_EXTBUF) {
170 fwdma_free_multiseg(q->buf);
172 free(q->bulkxfer, M_FW);
174 q->flag &= ~FWXFERQ_EXTBUF;
176 q->maxq = FWMAXQUEUE;
183 fw_open (dev_t dev, int flags, int fmt, fw_proc *td)
188 return fwmem_open(dev, flags, fmt, td);
190 if (dev->si_drv1 != NULL)
193 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
194 if ((dev->si_flags & SI_NAMED) == 0) {
195 int unit = DEV2UNIT(dev);
196 int sub = DEV2SUB(dev);
198 make_dev(&firewire_cdevsw, minor(dev),
199 UID_ROOT, GID_OPERATOR, 0660,
200 "fw%d.%d", unit, sub);
204 dev->si_drv1 = malloc(sizeof(struct fw_drv1), M_FW, M_WAITOK | M_ZERO);
210 fw_close (dev_t dev, int flags, int fmt, fw_proc *td)
212 struct firewire_softc *sc;
213 struct firewire_comm *fc;
215 int unit = DEV2UNIT(dev);
216 struct fw_xfer *xfer;
221 return fwmem_close(dev, flags, fmt, td);
223 sc = devclass_get_softc(firewire_devclass, unit);
225 d = (struct fw_drv1 *)dev->si_drv1;
228 struct fw_xferq *ir = d->ir;
230 if ((ir->flag & FWXFERQ_OPEN) == 0)
232 if (ir->flag & FWXFERQ_RUNNING) {
233 ir->flag &= ~FWXFERQ_RUNNING;
234 fc->irx_disable(fc, ir->dmach);
238 /* drain receiving buffer */
239 for (xfer = STAILQ_FIRST(&ir->q);
240 xfer != NULL; xfer = STAILQ_FIRST(&ir->q)) {
242 STAILQ_REMOVE_HEAD(&ir->q, link);
248 for (fwb = STAILQ_FIRST(&ir->binds); fwb != NULL;
249 fwb = STAILQ_FIRST(&ir->binds)) {
250 STAILQ_REMOVE(&fc->binds, fwb, fw_bind, fclist);
251 STAILQ_REMOVE_HEAD(&ir->binds, chlist);
254 ir->flag &= ~(FWXFERQ_OPEN |
255 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
260 struct fw_xferq *it = d->it;
262 if ((it->flag & FWXFERQ_OPEN) == 0)
264 if (it->flag & FWXFERQ_RUNNING) {
265 it->flag &= ~FWXFERQ_RUNNING;
266 fc->itx_disable(fc, it->dmach);
270 it->flag &= ~(FWXFERQ_OPEN |
271 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
274 free(dev->si_drv1, M_FW);
284 fw_read (dev_t dev, struct uio *uio, int ioflag)
286 struct firewire_softc *sc;
288 struct fw_xfer *xfer;
289 int err = 0, slept = 0;
290 int unit = DEV2UNIT(dev);
294 return physio(dev, uio, ioflag);
296 sc = devclass_get_softc(firewire_devclass, unit);
298 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
299 if (ir == NULL || ir->buf == NULL)
303 xfer = STAILQ_FIRST(&ir->q);
304 if (ir->stproc == NULL) {
306 ir->stproc = STAILQ_FIRST(&ir->stvalid);
307 if (ir->stproc != NULL) {
309 STAILQ_REMOVE_HEAD(&ir->stvalid, link);
314 if (xfer == NULL && ir->stproc == NULL) {
315 /* no data avaliable */
318 ir->flag |= FWXFERQ_WAKEUP;
319 err = tsleep(ir, FWPRI, "fw_read", hz);
320 ir->flag &= ~FWXFERQ_WAKEUP;
323 } else if (slept == 1)
326 } else if(xfer != NULL) {
327 #if 0 /* XXX broken */
328 /* per packet mode or FWACT_CH bind?*/
331 STAILQ_REMOVE_HEAD(&ir->q, link);
333 fp = &xfer->recv.hdr;
334 if (sc->fc->irx_post != NULL)
335 sc->fc->irx_post(sc->fc, fp->mode.ld);
336 err = uiomove((void *)fp, 1 /* XXX header size */, uio);
337 /* XXX copy payload too */
338 /* XXX we should recycle this xfer */
341 } else if(ir->stproc != NULL) {
343 fp = (struct fw_pkt *)fwdma_v_addr(ir->buf,
344 ir->stproc->poffset + ir->queued);
345 if(sc->fc->irx_post != NULL)
346 sc->fc->irx_post(sc->fc, fp->mode.ld);
347 if(fp->mode.stream.len == 0){
351 err = uiomove((caddr_t)fp,
352 fp->mode.stream.len + sizeof(u_int32_t), uio);
354 if(ir->queued >= ir->bnpacket){
356 STAILQ_INSERT_TAIL(&ir->stfree, ir->stproc, link);
358 sc->fc->irx_enable(sc->fc, ir->dmach);
361 if (uio->uio_resid >= ir->psize) {
370 fw_write (dev_t dev, struct uio *uio, int ioflag)
373 struct firewire_softc *sc;
374 int unit = DEV2UNIT(dev);
377 struct firewire_comm *fc;
381 return physio(dev, uio, ioflag);
383 sc = devclass_get_softc(firewire_devclass, unit);
385 it = ((struct fw_drv1 *)dev->si_drv1)->it;
386 if (it == NULL || it->buf == NULL)
389 if (it->stproc == NULL) {
390 it->stproc = STAILQ_FIRST(&it->stfree);
391 if (it->stproc != NULL) {
393 STAILQ_REMOVE_HEAD(&it->stfree, link);
396 } else if (slept == 0) {
398 err = sc->fc->itx_enable(sc->fc, it->dmach);
401 err = tsleep(it, FWPRI, "fw_write", hz);
410 fp = (struct fw_pkt *)fwdma_v_addr(it->buf,
411 it->stproc->poffset + it->queued);
412 err = uiomove((caddr_t)fp, sizeof(struct fw_isohdr), uio);
413 err = uiomove((caddr_t)fp->mode.stream.payload,
414 fp->mode.stream.len, uio);
416 if (it->queued >= it->bnpacket) {
418 STAILQ_INSERT_TAIL(&it->stvalid, it->stproc, link);
421 err = sc->fc->itx_enable(sc->fc, it->dmach);
423 if (uio->uio_resid >= sizeof(struct fw_isohdr)) {
433 fw_ioctl (dev_t dev, u_long cmd, caddr_t data, int flag, fw_proc *td)
435 struct firewire_softc *sc;
436 struct firewire_comm *fc;
438 int unit = DEV2UNIT(dev);
440 struct fw_device *fwdev;
442 struct fw_xferq *ir, *it;
443 struct fw_xfer *xfer;
445 struct fw_devinfo *devinfo;
448 struct fw_devlstreq *fwdevlst = (struct fw_devlstreq *)data;
449 struct fw_asyreq *asyreq = (struct fw_asyreq *)data;
450 struct fw_isochreq *ichreq = (struct fw_isochreq *)data;
451 struct fw_isobufreq *ibufreq = (struct fw_isobufreq *)data;
452 struct fw_asybindreq *bindreq = (struct fw_asybindreq *)data;
453 struct fw_crom_buf *crom_buf = (struct fw_crom_buf *)data;
456 return fwmem_ioctl(dev, cmd, data, flag, td);
461 sc = devclass_get_softc(firewire_devclass, unit);
463 d = (struct fw_drv1 *)dev->si_drv1;
470 for (i = 0; i < fc->nisodma; i ++) {
472 if ((it->flag & FWXFERQ_OPEN) == 0)
475 if (i >= fc->nisodma) {
479 err = fwdev_allocbuf(fc, it, &d->bufreq.tx);
482 it->flag |= FWXFERQ_OPEN;
485 it->flag |= (0x3f & ichreq->ch);
486 it->flag |= ((0x3 & ichreq->tag) << 6);
491 ichreq->ch = it->flag & 0x3f;
492 ichreq->tag = it->flag >> 2 & 0x3;
498 for (i = 0; i < fc->nisodma; i ++) {
500 if ((ir->flag & FWXFERQ_OPEN) == 0)
503 if (i >= fc->nisodma) {
507 err = fwdev_allocbuf(fc, ir, &d->bufreq.rx);
510 ir->flag |= FWXFERQ_OPEN;
513 ir->flag |= (0x3f & ichreq->ch);
514 ir->flag |= ((0x3 & ichreq->tag) << 6);
516 err = fc->irx_enable(fc, ir->dmach);
520 ichreq->ch = ir->flag & 0x3f;
521 ichreq->tag = ir->flag >> 2 & 0x3;
526 bcopy(ibufreq, &d->bufreq, sizeof(d->bufreq));
529 bzero(&ibufreq->rx, sizeof(ibufreq->rx));
531 ibufreq->rx.nchunk = ir->bnchunk;
532 ibufreq->rx.npacket = ir->bnpacket;
533 ibufreq->rx.psize = ir->psize;
535 bzero(&ibufreq->tx, sizeof(ibufreq->tx));
537 ibufreq->tx.nchunk = it->bnchunk;
538 ibufreq->tx.npacket = it->bnpacket;
539 ibufreq->tx.psize = it->psize;
544 struct tcode_info *tinfo;
548 tinfo = &sc->fc->tcode[fp->mode.hdr.tcode];
550 if ((tinfo->flag & FWTI_BLOCK_ASY) != 0)
551 pay_len = MAX(0, asyreq->req.len - tinfo->hdr_len);
553 xfer = fw_xfer_alloc_buf(M_FWXFER, pay_len, PAGE_SIZE/*XXX*/);
557 switch (asyreq->req.type) {
561 fwdev = fw_noderesolve_eui64(sc->fc,
562 &asyreq->req.dst.eui);
564 device_printf(sc->fc->bdev,
565 "cannot find node\n");
569 fp->mode.hdr.dst = FWLOCALBUS | fwdev->dst;
572 /* XXX what's this? */
579 bcopy(fp, (void *)&xfer->send.hdr, tinfo->hdr_len);
581 bcopy((char *)fp + tinfo->hdr_len,
582 (void *)&xfer->send.payload, pay_len);
583 xfer->send.spd = asyreq->req.sped;
584 xfer->act.hand = fw_asy_callback;
586 if ((err = fw_asyreq(sc->fc, -1, xfer)) != 0)
588 if ((err = tsleep(xfer, FWPRI, "asyreq", hz)) != 0)
590 if (xfer->resp != 0) {
594 if ((tinfo->flag & FWTI_TLABEL) == 0)
598 tinfo = &sc->fc->tcode[xfer->recv.hdr.mode.hdr.tcode];
599 if (asyreq->req.len >= xfer->recv.pay_len + tinfo->hdr_len)
600 asyreq->req.len = xfer->recv.pay_len;
603 bcopy(&xfer->recv.hdr, fp, tinfo->hdr_len);
604 bcopy(xfer->recv.payload, (char *)fp + tinfo->hdr_len,
605 MAX(0, asyreq->req.len - tinfo->hdr_len));
607 fw_xfer_free_buf(xfer);
614 fwb = fw_bindlookup(sc->fc,
615 bindreq->start.hi, bindreq->start.lo);
620 STAILQ_REMOVE(&sc->fc->binds, fwb, fw_bind, fclist);
621 STAILQ_REMOVE(&ir->binds, fwb, fw_bind, chlist);
625 if(bindreq->len <= 0 ){
629 if(bindreq->start.hi > 0xffff ){
633 fwb = malloc(sizeof (struct fw_bind), M_FW, M_WAITOK);
634 fwb->start = ((u_int64_t)bindreq->start.hi << 32) |
636 fwb->end = fwb->start + bindreq->len;
638 fwb->sub = ir->dmach;
639 fwb->act_type = FWACT_CH;
642 xfer = fw_xfer_alloc(M_FWXFER);
650 /* XXX broken. need multiple xfer */
651 STAILQ_INIT(&fwb->xferlist);
652 STAILQ_INSERT_TAIL(&fwb->xferlist, xfer, link);
654 err = fw_bindadd(sc->fc, fwb);
659 devinfo = &fwdevlst->dev[0];
660 devinfo->dst = sc->fc->nodeid;
661 devinfo->status = 0; /* XXX */
662 devinfo->eui.hi = sc->fc->eui.hi;
663 devinfo->eui.lo = sc->fc->eui.lo;
664 STAILQ_FOREACH(fwdev, &sc->fc->devices, link) {
665 if(len < FW_MAX_DEVLST){
666 devinfo = &fwdevlst->dev[len++];
667 devinfo->dst = fwdev->dst;
669 (fwdev->status == FWDEVINVAL)?0:1;
670 devinfo->eui.hi = fwdev->eui.hi;
671 devinfo->eui.lo = fwdev->eui.lo;
676 fwdevlst->info_len = len;
679 bcopy(sc->fc->topology_map, data,
680 (sc->fc->topology_map->crc_len + 1) * 4);
683 STAILQ_FOREACH(fwdev, &sc->fc->devices, link)
684 if (FW_EUI64_EQUAL(fwdev->eui, crom_buf->eui))
687 if (!FW_EUI64_EQUAL(sc->fc->eui, crom_buf->eui)) {
692 ptr = malloc(CROMSIZE, M_FW, M_WAITOK);
694 for (i = 0; i < CROMSIZE/4; i++)
695 ((u_int32_t *)ptr)[i]
696 = ntohl(sc->fc->config_rom[i]);
699 ptr = (void *)&fwdev->csrrom[0];
700 if (fwdev->rommax < CSRROMOFF)
703 len = fwdev->rommax - CSRROMOFF + 4;
705 if (crom_buf->len < len)
709 err = copyout(ptr, crom_buf->ptr, len);
715 sc->fc->ioctl (dev, cmd, data, flag, td);
721 fw_poll(dev_t dev, int events, fw_proc *td)
723 struct firewire_softc *sc;
727 int unit = DEV2UNIT(dev);
730 return fwmem_poll(dev, events, td);
732 sc = devclass_get_softc(firewire_devclass, unit);
733 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
735 tmp = POLLIN | POLLRDNORM;
737 if (STAILQ_FIRST(&ir->q) != NULL)
740 selrecord(td, &ir->rsel);
742 tmp = POLLOUT | POLLWRNORM;
744 /* XXX should be fixed */
752 #if defined(__DragonFly__) || __FreeBSD_version < 500102
753 fw_mmap (dev_t dev, vm_offset_t offset, int nproto)
755 fw_mmap (dev_t dev, vm_offset_t offset, vm_paddr_t *paddr, int nproto)
758 struct firewire_softc *sc;
759 int unit = DEV2UNIT(dev);
762 #if defined(__DragonFly__) || __FreeBSD_version < 500102
763 return fwmem_mmap(dev, offset, nproto);
765 return fwmem_mmap(dev, offset, paddr, nproto);
768 sc = devclass_get_softc(firewire_devclass, unit);
774 fw_strategy(dev_t dev, struct bio *bio)
776 struct buf *bp = bio->bio_buf;
778 if (DEV_FWMEM(dev)) {
779 fwmem_strategy(dev, bio);
782 bp->b_error = EOPNOTSUPP;
783 bp->b_flags |= B_ERROR;
784 bp->b_resid = bp->b_bcount;
789 fwdev_makedev(struct firewire_softc *sc)
793 unit = device_get_unit(sc->fc->bdev);
794 cdevsw_add(&firewire_cdevsw, FW_UNITMASK, FW_UNIT(unit));
799 fwdev_destroydev(struct firewire_softc *sc)
803 unit = device_get_unit(sc->fc->bdev);
804 cdevsw_remove(&firewire_cdevsw, FW_UNITMASK, FW_UNIT(unit));
808 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
811 fwdev_clone(void *arg, char *name, int namelen, dev_t *dev)
813 struct firewire_softc *sc;
814 char *devnames[NDEVTYPE] = {"fw", "fwmem"};
816 int devflag[NDEVTYPE] = {0, FWMEM_FLAG};
817 int i, unit = 0, sub = 0;
822 for (i = 0; i < NDEVTYPE; i++)
823 if (dev_stdclone(name, &subp, devnames[i], &unit) == 2)
829 if (subp == NULL || *subp++ != '.')
833 while (isdigit(*subp)) {
835 sub += *subp++ - '0';
840 sc = devclass_get_softc(firewire_devclass, unit);
843 *dev = make_dev(&firewire_cdevsw, MAKEMINOR(devflag[i], unit, sub),
844 UID_ROOT, GID_OPERATOR, 0660,
845 "%s%d.%d", devnames[i], unit, sub);
846 (*dev)->si_flags |= SI_CHEAPCLONE;
847 dev_depends(sc->dev, *dev);