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.17 2006/10/25 20:55:51 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>
57 #include <sys/ioccom.h>
58 #include <sys/thread2.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 dev_ops firewire_ops =
88 { "fw", CDEV_MAJOR, D_MEM },
96 .d_strategy = fw_strategy,
102 struct fw_isobufreq bufreq;
106 fwdev_allocbuf(struct firewire_comm *fc, struct fw_xferq *q,
107 struct fw_bufspec *b)
111 if (q->flag & (FWXFERQ_RUNNING | FWXFERQ_EXTBUF))
114 q->bulkxfer = (struct fw_bulkxfer *) kmalloc(
115 sizeof(struct fw_bulkxfer) * b->nchunk,
117 if (q->bulkxfer == NULL)
120 b->psize = roundup2(b->psize, sizeof(u_int32_t));
121 q->buf = fwdma_malloc_multiseg(fc, sizeof(u_int32_t),
122 b->psize, b->nchunk * b->npacket, BUS_DMA_WAITOK);
124 if (q->buf == NULL) {
125 kfree(q->bulkxfer, M_FW);
129 q->bnchunk = b->nchunk;
130 q->bnpacket = b->npacket;
131 q->psize = (b->psize + 3) & ~3;
134 STAILQ_INIT(&q->stvalid);
135 STAILQ_INIT(&q->stfree);
136 STAILQ_INIT(&q->stdma);
139 for(i = 0 ; i < q->bnchunk; i++){
140 q->bulkxfer[i].poffset = i * q->bnpacket;
141 q->bulkxfer[i].mbuf = NULL;
142 STAILQ_INSERT_TAIL(&q->stfree, &q->bulkxfer[i], link);
145 q->flag &= ~FWXFERQ_MODEMASK;
146 q->flag |= FWXFERQ_STREAM;
147 q->flag |= FWXFERQ_EXTBUF;
153 fwdev_freebuf(struct fw_xferq *q)
155 if (q->flag & FWXFERQ_EXTBUF) {
157 fwdma_free_multiseg(q->buf);
159 kfree(q->bulkxfer, M_FW);
161 q->flag &= ~FWXFERQ_EXTBUF;
163 q->maxq = FWMAXQUEUE;
170 fw_open (struct dev_open_args *ap)
172 cdev_t dev = ap->a_head.a_dev;
176 return fwmem_open(ap);
178 if (dev->si_drv1 != NULL)
181 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
182 if ((dev->si_flags & SI_NAMED) == 0) {
183 int unit = DEV2UNIT(dev);
184 int sub = DEV2SUB(dev);
186 make_dev(&firewire_ops, minor(dev),
187 UID_ROOT, GID_OPERATOR, 0660,
188 "fw%d.%d", unit, sub);
192 dev->si_drv1 = kmalloc(sizeof(struct fw_drv1), M_FW, M_WAITOK | M_ZERO);
198 fw_close (struct dev_close_args *ap)
200 cdev_t dev = ap->a_head.a_dev;
201 struct firewire_softc *sc;
202 struct firewire_comm *fc;
204 int unit = DEV2UNIT(dev);
205 struct fw_xfer *xfer;
210 return fwmem_close(ap);
212 sc = devclass_get_softc(firewire_devclass, unit);
214 d = (struct fw_drv1 *)dev->si_drv1;
217 struct fw_xferq *ir = d->ir;
219 if ((ir->flag & FWXFERQ_OPEN) == 0)
221 if (ir->flag & FWXFERQ_RUNNING) {
222 ir->flag &= ~FWXFERQ_RUNNING;
223 fc->irx_disable(fc, ir->dmach);
227 /* drain receiving buffer */
228 for (xfer = STAILQ_FIRST(&ir->q);
229 xfer != NULL; xfer = STAILQ_FIRST(&ir->q)) {
231 STAILQ_REMOVE_HEAD(&ir->q, link);
237 for (fwb = STAILQ_FIRST(&ir->binds); fwb != NULL;
238 fwb = STAILQ_FIRST(&ir->binds)) {
239 STAILQ_REMOVE(&fc->binds, fwb, fw_bind, fclist);
240 STAILQ_REMOVE_HEAD(&ir->binds, chlist);
243 ir->flag &= ~(FWXFERQ_OPEN |
244 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
249 struct fw_xferq *it = d->it;
251 if ((it->flag & FWXFERQ_OPEN) == 0)
253 if (it->flag & FWXFERQ_RUNNING) {
254 it->flag &= ~FWXFERQ_RUNNING;
255 fc->itx_disable(fc, it->dmach);
259 it->flag &= ~(FWXFERQ_OPEN |
260 FWXFERQ_MODEMASK | FWXFERQ_CHTAGMASK);
263 kfree(dev->si_drv1, M_FW);
273 fw_read (struct dev_read_args *ap)
275 cdev_t dev = ap->a_head.a_dev;
276 struct uio *uio = ap->a_uio;
277 struct firewire_softc *sc;
279 struct fw_xfer *xfer;
280 int err = 0, slept = 0;
281 int unit = DEV2UNIT(dev);
287 sc = devclass_get_softc(firewire_devclass, unit);
289 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
290 if (ir == NULL || ir->buf == NULL)
294 xfer = STAILQ_FIRST(&ir->q);
295 if (ir->stproc == NULL) {
297 ir->stproc = STAILQ_FIRST(&ir->stvalid);
298 if (ir->stproc != NULL) {
300 STAILQ_REMOVE_HEAD(&ir->stvalid, link);
305 if (xfer == NULL && ir->stproc == NULL) {
306 /* no data avaliable */
309 ir->flag |= FWXFERQ_WAKEUP;
310 err = tsleep(ir, FWPRI, "fw_read", hz);
311 ir->flag &= ~FWXFERQ_WAKEUP;
314 } else if (slept == 1)
317 } else if(xfer != NULL) {
318 #if 0 /* XXX broken */
319 /* per packet mode or FWACT_CH bind?*/
322 STAILQ_REMOVE_HEAD(&ir->q, link);
324 fp = &xfer->recv.hdr;
325 if (sc->fc->irx_post != NULL)
326 sc->fc->irx_post(sc->fc, fp->mode.ld);
327 err = uiomove((void *)fp, 1 /* XXX header size */, uio);
328 /* XXX copy payload too */
329 /* XXX we should recycle this xfer */
332 } else if(ir->stproc != NULL) {
334 fp = (struct fw_pkt *)fwdma_v_addr(ir->buf,
335 ir->stproc->poffset + ir->queued);
336 if(sc->fc->irx_post != NULL)
337 sc->fc->irx_post(sc->fc, fp->mode.ld);
338 if(fp->mode.stream.len == 0){
342 err = uiomove((caddr_t)fp,
343 fp->mode.stream.len + sizeof(u_int32_t), uio);
345 if(ir->queued >= ir->bnpacket){
347 STAILQ_INSERT_TAIL(&ir->stfree, ir->stproc, link);
349 sc->fc->irx_enable(sc->fc, ir->dmach);
352 if (uio->uio_resid >= ir->psize) {
361 fw_write (struct dev_write_args *ap)
363 cdev_t dev = ap->a_head.a_dev;
364 struct uio *uio = ap->a_uio;
366 struct firewire_softc *sc;
367 int unit = DEV2UNIT(dev);
370 struct firewire_comm *fc;
374 return physwrite(ap);
376 sc = devclass_get_softc(firewire_devclass, unit);
378 it = ((struct fw_drv1 *)dev->si_drv1)->it;
379 if (it == NULL || it->buf == NULL)
382 if (it->stproc == NULL) {
383 it->stproc = STAILQ_FIRST(&it->stfree);
384 if (it->stproc != NULL) {
386 STAILQ_REMOVE_HEAD(&it->stfree, link);
389 } else if (slept == 0) {
391 err = sc->fc->itx_enable(sc->fc, it->dmach);
394 err = tsleep(it, FWPRI, "fw_write", hz);
403 fp = (struct fw_pkt *)fwdma_v_addr(it->buf,
404 it->stproc->poffset + it->queued);
405 err = uiomove((caddr_t)fp, sizeof(struct fw_isohdr), uio);
406 err = uiomove((caddr_t)fp->mode.stream.payload,
407 fp->mode.stream.len, uio);
409 if (it->queued >= it->bnpacket) {
411 STAILQ_INSERT_TAIL(&it->stvalid, it->stproc, link);
414 err = sc->fc->itx_enable(sc->fc, it->dmach);
416 if (uio->uio_resid >= sizeof(struct fw_isohdr)) {
426 fw_ioctl (struct dev_ioctl_args *ap)
428 cdev_t dev = ap->a_head.a_dev;
429 struct firewire_softc *sc;
430 struct firewire_comm *fc;
432 int unit = DEV2UNIT(dev);
434 struct fw_device *fwdev;
436 struct fw_xferq *ir, *it;
437 struct fw_xfer *xfer;
439 struct fw_devinfo *devinfo;
442 struct fw_devlstreq *fwdevlst = (struct fw_devlstreq *)ap->a_data;
443 struct fw_asyreq *asyreq = (struct fw_asyreq *)ap->a_data;
444 struct fw_isochreq *ichreq = (struct fw_isochreq *)ap->a_data;
445 struct fw_isobufreq *ibufreq = (struct fw_isobufreq *)ap->a_data;
446 struct fw_asybindreq *bindreq = (struct fw_asybindreq *)ap->a_data;
447 struct fw_crom_buf *crom_buf = (struct fw_crom_buf *)ap->a_data;
450 return fwmem_ioctl(ap);
455 sc = devclass_get_softc(firewire_devclass, unit);
457 d = (struct fw_drv1 *)dev->si_drv1;
464 for (i = 0; i < fc->nisodma; i ++) {
466 if ((it->flag & FWXFERQ_OPEN) == 0)
469 if (i >= fc->nisodma) {
473 err = fwdev_allocbuf(fc, it, &d->bufreq.tx);
476 it->flag |= FWXFERQ_OPEN;
479 it->flag |= (0x3f & ichreq->ch);
480 it->flag |= ((0x3 & ichreq->tag) << 6);
485 ichreq->ch = it->flag & 0x3f;
486 ichreq->tag = it->flag >> 2 & 0x3;
492 for (i = 0; i < fc->nisodma; i ++) {
494 if ((ir->flag & FWXFERQ_OPEN) == 0)
497 if (i >= fc->nisodma) {
501 err = fwdev_allocbuf(fc, ir, &d->bufreq.rx);
504 ir->flag |= FWXFERQ_OPEN;
507 ir->flag |= (0x3f & ichreq->ch);
508 ir->flag |= ((0x3 & ichreq->tag) << 6);
510 err = fc->irx_enable(fc, ir->dmach);
514 ichreq->ch = ir->flag & 0x3f;
515 ichreq->tag = ir->flag >> 2 & 0x3;
520 bcopy(ibufreq, &d->bufreq, sizeof(d->bufreq));
523 bzero(&ibufreq->rx, sizeof(ibufreq->rx));
525 ibufreq->rx.nchunk = ir->bnchunk;
526 ibufreq->rx.npacket = ir->bnpacket;
527 ibufreq->rx.psize = ir->psize;
529 bzero(&ibufreq->tx, sizeof(ibufreq->tx));
531 ibufreq->tx.nchunk = it->bnchunk;
532 ibufreq->tx.npacket = it->bnpacket;
533 ibufreq->tx.psize = it->psize;
538 struct tcode_info *tinfo;
542 tinfo = &sc->fc->tcode[fp->mode.hdr.tcode];
544 if ((tinfo->flag & FWTI_BLOCK_ASY) != 0)
545 pay_len = MAX(0, asyreq->req.len - tinfo->hdr_len);
547 xfer = fw_xfer_alloc_buf(M_FWXFER, pay_len, PAGE_SIZE/*XXX*/);
551 switch (asyreq->req.type) {
555 fwdev = fw_noderesolve_eui64(sc->fc,
556 &asyreq->req.dst.eui);
558 device_printf(sc->fc->bdev,
559 "cannot find node\n");
563 fp->mode.hdr.dst = FWLOCALBUS | fwdev->dst;
566 /* XXX what's this? */
573 bcopy(fp, (void *)&xfer->send.hdr, tinfo->hdr_len);
575 bcopy((char *)fp + tinfo->hdr_len,
576 (void *)&xfer->send.payload, pay_len);
577 xfer->send.spd = asyreq->req.sped;
578 xfer->act.hand = fw_asy_callback;
580 if ((err = fw_asyreq(sc->fc, -1, xfer)) != 0)
582 if ((err = tsleep(xfer, FWPRI, "asyreq", hz)) != 0)
584 if (xfer->resp != 0) {
588 if ((tinfo->flag & FWTI_TLABEL) == 0)
592 tinfo = &sc->fc->tcode[xfer->recv.hdr.mode.hdr.tcode];
593 if (asyreq->req.len >= xfer->recv.pay_len + tinfo->hdr_len)
594 asyreq->req.len = xfer->recv.pay_len;
597 bcopy(&xfer->recv.hdr, fp, tinfo->hdr_len);
598 bcopy(xfer->recv.payload, (char *)fp + tinfo->hdr_len,
599 MAX(0, asyreq->req.len - tinfo->hdr_len));
601 fw_xfer_free_buf(xfer);
608 fwb = fw_bindlookup(sc->fc,
609 bindreq->start.hi, bindreq->start.lo);
614 STAILQ_REMOVE(&sc->fc->binds, fwb, fw_bind, fclist);
615 STAILQ_REMOVE(&ir->binds, fwb, fw_bind, chlist);
619 if(bindreq->len <= 0 ){
623 if(bindreq->start.hi > 0xffff ){
627 fwb = kmalloc(sizeof (struct fw_bind), M_FW, M_WAITOK);
628 fwb->start = ((u_int64_t)bindreq->start.hi << 32) |
630 fwb->end = fwb->start + bindreq->len;
632 fwb->sub = ir->dmach;
633 fwb->act_type = FWACT_CH;
636 xfer = fw_xfer_alloc(M_FWXFER);
644 /* XXX broken. need multiple xfer */
645 STAILQ_INIT(&fwb->xferlist);
646 STAILQ_INSERT_TAIL(&fwb->xferlist, xfer, link);
648 err = fw_bindadd(sc->fc, fwb);
653 devinfo = &fwdevlst->dev[0];
654 devinfo->dst = sc->fc->nodeid;
655 devinfo->status = 0; /* XXX */
656 devinfo->eui.hi = sc->fc->eui.hi;
657 devinfo->eui.lo = sc->fc->eui.lo;
658 STAILQ_FOREACH(fwdev, &sc->fc->devices, link) {
659 if(len < FW_MAX_DEVLST){
660 devinfo = &fwdevlst->dev[len++];
661 devinfo->dst = fwdev->dst;
663 (fwdev->status == FWDEVINVAL)?0:1;
664 devinfo->eui.hi = fwdev->eui.hi;
665 devinfo->eui.lo = fwdev->eui.lo;
670 fwdevlst->info_len = len;
673 bcopy(sc->fc->topology_map, ap->a_data,
674 (sc->fc->topology_map->crc_len + 1) * 4);
677 STAILQ_FOREACH(fwdev, &sc->fc->devices, link)
678 if (FW_EUI64_EQUAL(fwdev->eui, crom_buf->eui))
681 if (!FW_EUI64_EQUAL(sc->fc->eui, crom_buf->eui)) {
686 ptr = kmalloc(CROMSIZE, M_FW, M_WAITOK);
688 for (i = 0; i < CROMSIZE/4; i++)
689 ((u_int32_t *)ptr)[i]
690 = ntohl(sc->fc->config_rom[i]);
693 ptr = (void *)&fwdev->csrrom[0];
694 if (fwdev->rommax < CSRROMOFF)
697 len = fwdev->rommax - CSRROMOFF + 4;
699 if (crom_buf->len < len)
703 err = copyout(ptr, crom_buf->ptr, len);
715 fw_poll(struct dev_poll_args *ap)
717 cdev_t dev = ap->a_head.a_dev;
718 struct firewire_softc *sc;
722 int unit = DEV2UNIT(dev);
725 return fwmem_poll(ap);
727 sc = devclass_get_softc(firewire_devclass, unit);
728 ir = ((struct fw_drv1 *)dev->si_drv1)->ir;
730 tmp = POLLIN | POLLRDNORM;
731 if (ap->a_events & tmp) {
732 if (STAILQ_FIRST(&ir->q) != NULL)
735 selrecord(curthread, &ir->rsel);
737 tmp = POLLOUT | POLLWRNORM;
738 if (ap->a_events & tmp) {
739 /* XXX should be fixed */
742 ap->a_events = revents;
747 fw_mmap (struct dev_mmap_args *ap)
749 cdev_t dev = ap->a_head.a_dev;
750 struct firewire_softc *sc;
751 int unit = DEV2UNIT(dev);
754 return fwmem_mmap(ap);
755 sc = devclass_get_softc(firewire_devclass, unit);
761 fw_strategy(struct dev_strategy_args *ap)
763 cdev_t dev = ap->a_head.a_dev;
764 struct bio *bio = ap->a_bio;
765 struct buf *bp = bio->bio_buf;
767 if (DEV_FWMEM(dev)) {
771 bp->b_error = EOPNOTSUPP;
772 bp->b_flags |= B_ERROR;
773 bp->b_resid = bp->b_bcount;
779 fwdev_makedev(struct firewire_softc *sc)
783 unit = device_get_unit(sc->fc->bdev);
784 dev_ops_add(&firewire_ops, FW_UNITMASK, FW_UNIT(unit));
789 fwdev_destroydev(struct firewire_softc *sc)
793 unit = device_get_unit(sc->fc->bdev);
794 dev_ops_remove(&firewire_ops, FW_UNITMASK, FW_UNIT(unit));
798 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
801 fwdev_clone(void *arg, char *name, int namelen, cdev_t *dev)
803 struct firewire_softc *sc;
804 char *devnames[NDEVTYPE] = {"fw", "fwmem"};
806 int devflag[NDEVTYPE] = {0, FWMEM_FLAG};
807 int i, unit = 0, sub = 0;
812 for (i = 0; i < NDEVTYPE; i++)
813 if (dev_stdclone(name, &subp, devnames[i], &unit) == 2)
819 if (subp == NULL || *subp++ != '.')
823 while (isdigit(*subp)) {
825 sub += *subp++ - '0';
830 sc = devclass_get_softc(firewire_devclass, unit);
833 *dev = make_dev(&firewire_ops, MAKEMINOR(devflag[i], unit, sub),
834 UID_ROOT, GID_OPERATOR, 0660,
835 "%s%d.%d", devnames[i], unit, sub);
836 (*dev)->si_flags |= SI_CHEAPCLONE;
837 dev_depends(sc->dev, *dev);