2 * $NetBSD: ugen.c,v 1.27 1999/10/28 12:08:38 augustss Exp $
3 * $NetBSD: ugen.c,v 1.59 2002/07/11 21:14:28 augustss Exp $
4 * $FreeBSD: src/sys/dev/usb/ugen.c,v 1.81 2003/11/09 09:17:22 tanimura Exp $
5 * $DragonFly: src/sys/dev/usbmisc/ugen/ugen.c,v 1.34 2008/05/13 08:35:12 hasso Exp $
9 * Also already merged from NetBSD:
10 * $NetBSD: ugen.c,v 1.61 2002/09/23 05:51:20 simonb Exp $
11 * $NetBSD: ugen.c,v 1.64 2003/06/28 14:21:46 darrenr Exp $
12 * $NetBSD: ugen.c,v 1.65 2003/06/29 22:30:56 fvdl Exp $
16 * Copyright (c) 1998 The NetBSD Foundation, Inc.
17 * All rights reserved.
19 * This code is derived from software contributed to The NetBSD Foundation
20 * by Lennart Augustsson (lennart@augustsson.net) at
21 * Carlstedt Research & Technology.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the above copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * This product includes software developed by the NetBSD
34 * Foundation, Inc. and its contributors.
35 * 4. Neither the name of The NetBSD Foundation nor the names of its
36 * contributors may be used to endorse or promote products derived
37 * from this software without specific prior written permission.
39 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
40 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
43 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
44 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
45 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
46 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 * POSSIBILITY OF SUCH DAMAGE.
53 #include <sys/param.h>
54 #include <sys/systm.h>
55 #include <sys/kernel.h>
56 #include <sys/malloc.h>
57 #include <sys/module.h>
60 #include <sys/fcntl.h>
61 #include <sys/filio.h>
64 #include <sys/select.h>
65 #include <sys/vnode.h>
67 #include <sys/sysctl.h>
68 #include <sys/thread2.h>
70 #include <bus/usb/usb.h>
71 #include <bus/usb/usbdi.h>
72 #include <bus/usb/usbdi_util.h>
76 SYSCTL_NODE(_hw_usb, OID_AUTO, ugen, CTLFLAG_RW, 0, "USB ugen");
79 #define DPRINTF(x) if (ugendebug) kprintf x
80 #define DPRINTFN(n,x) if (ugendebug>(n)) kprintf x
82 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, debug, CTLFLAG_RW,
83 &ugendebug, 0, "ugen debug level");
89 static int ugen_bufsize = 16384;
90 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, bufsize, CTLFLAG_RW,
91 &ugen_bufsize, 0, "ugen temporary buffer size");
93 #define UGEN_CHUNK 128 /* chunk size for read */
94 #define UGEN_IBSIZE 1020 /* buffer size */
96 #define UGEN_NISOFRAMES 500 /* 0.5 seconds worth */
97 #define UGEN_NISOREQS 6 /* number of outstanding xfer requests */
98 #define UGEN_NISORFRMS 4 /* number of frames (miliseconds) per req */
100 struct ugen_endpoint {
101 struct ugen_softc *sc;
103 usb_endpoint_descriptor_t *edesc;
104 usbd_interface_handle iface;
106 #define UGEN_ASLP 0x02 /* waiting for data */
107 #define UGEN_SHORT_OK 0x04 /* short xfers are OK */
108 usbd_pipe_handle pipeh;
111 u_char *ibuf; /* start of buffer (circular for isoc) */
112 u_char *fill; /* location for input (isoc) */
113 u_char *limit; /* end of circular buffer (isoc) */
114 u_char *cur; /* current read location (isoc) */
117 struct ugen_endpoint *sce;
118 usbd_xfer_handle xfer;
120 u_int16_t sizes[UGEN_NISORFRMS];
121 } isoreqs[UGEN_NISOREQS];
125 device_t sc_dev; /* base device */
126 usbd_device_handle sc_udev;
128 char sc_is_open[USB_MAX_ENDPOINTS];
129 struct ugen_endpoint sc_endpoints[USB_MAX_ENDPOINTS][2];
144 #define UGEN_CDEV_MAJOR 114
146 static struct dev_ops ugen_ops = {
147 { "ugen", UGEN_CDEV_MAJOR, 0 },
149 .d_close = ugenclose,
151 .d_write = ugenwrite,
152 .d_ioctl = ugenioctl,
156 static void ugenintr(usbd_xfer_handle xfer, usbd_private_handle addr,
158 static void ugen_isoc_rintr(usbd_xfer_handle xfer, usbd_private_handle addr,
160 static int ugen_do_read(struct ugen_softc *, int, struct uio *, int);
161 static int ugen_do_write(struct ugen_softc *, int, struct uio *, int);
162 static int ugen_do_ioctl(struct ugen_softc *, int, u_long,
164 static void ugen_make_devnodes(struct ugen_softc *sc);
165 static void ugen_destroy_devnodes(struct ugen_softc *sc);
166 static int ugen_set_config(struct ugen_softc *sc, int configno);
167 static usb_config_descriptor_t *ugen_get_cdesc(struct ugen_softc *sc,
168 int index, int *lenp);
169 static usbd_status ugen_set_interface(struct ugen_softc *, int, int);
170 static int ugen_get_alt_index(struct ugen_softc *sc, int ifaceidx);
172 #define UGENUNIT(n) ((lminor(n) >> 4) & 0xff)
173 #define UGENENDPOINT(n) (minor(n) & 0xf)
174 #define UGENMINOR(u, e) (((u & 0xf) << 4) | ((u & 0xf0) << 12) | (e))
175 #define UGENUNITMASK 0xffff00f0
177 static device_probe_t ugen_match;
178 static device_attach_t ugen_attach;
179 static device_detach_t ugen_detach;
181 static devclass_t ugen_devclass;
183 static kobj_method_t ugen_methods[] = {
184 DEVMETHOD(device_probe, ugen_match),
185 DEVMETHOD(device_attach, ugen_attach),
186 DEVMETHOD(device_detach, ugen_detach),
190 static driver_t ugen_driver = {
193 sizeof(struct ugen_softc)
196 MODULE_DEPEND(ugen, usb, 1, 1, 1);
199 ugen_match(device_t self)
201 struct usb_attach_arg *uaa = device_get_ivars(self);
205 return (uaa->matchlvl);
208 return (UMATCH_GENERIC);
210 return (UMATCH_NONE);
214 ugen_attach(device_t self)
216 struct ugen_softc *sc = device_get_softc(self);
217 struct usb_attach_arg *uaa = device_get_ivars(self);
218 usbd_device_handle udev;
223 sc->sc_udev = udev = uaa->device;
225 memset(sc->sc_endpoints, 0, sizeof sc->sc_endpoints);
227 /* First set configuration index 0, the default one for ugen. */
228 err = usbd_set_config_index(udev, 0, 0);
230 kprintf("%s: setting configuration index 0 failed\n",
231 device_get_nameunit(sc->sc_dev));
235 conf = usbd_get_config_descriptor(udev)->bConfigurationValue;
237 /* Set up all the local state for this configuration. */
238 err = ugen_set_config(sc, conf);
240 kprintf("%s: setting configuration %d failed\n",
241 device_get_nameunit(sc->sc_dev), conf);
246 /* the main device, ctrl endpoint */
247 make_dev(&ugen_ops, UGENMINOR(device_get_unit(sc->sc_dev), 0),
248 UID_ROOT, GID_OPERATOR, 0644,
249 "%s", device_get_nameunit(sc->sc_dev));
251 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);
256 ugen_make_devnodes(struct ugen_softc *sc)
261 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
262 if (sc->sc_endpoints[endptno][IN].sc != NULL ||
263 sc->sc_endpoints[endptno][OUT].sc != NULL ) {
264 /* endpt can be 0x81 and 0x01, representing
265 * endpoint address 0x01 and IN/OUT directions.
266 * We map both endpts to the same device,
267 * IN is reading from it, OUT is writing to it.
269 * In the if clause above we check whether one
270 * of the structs is populated.
272 dev = make_dev(&ugen_ops,
273 UGENMINOR(device_get_unit(sc->sc_dev), endptno),
274 UID_ROOT, GID_OPERATOR, 0644,
276 device_get_nameunit(sc->sc_dev), endptno);
277 if (sc->sc_endpoints[endptno][IN].sc != NULL) {
279 if (sc->sc_endpoints[endptno][IN].dev)
280 release_dev(sc->sc_endpoints[endptno][IN].dev);
281 sc->sc_endpoints[endptno][IN].dev = dev;
283 if (sc->sc_endpoints[endptno][OUT].sc != NULL) {
285 if (sc->sc_endpoints[endptno][OUT].dev)
286 release_dev(sc->sc_endpoints[endptno][OUT].dev);
287 sc->sc_endpoints[endptno][OUT].dev = dev;
294 ugen_destroy_devnodes(struct ugen_softc *sc)
296 int endptno, prev_sc_dying;
299 prev_sc_dying = sc->sc_dying;
302 /* destroy all devices for the other (existing) endpoints as well */
303 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
304 if (sc->sc_endpoints[endptno][IN].sc != NULL ||
305 sc->sc_endpoints[endptno][OUT].sc != NULL ) {
306 /* endpt can be 0x81 and 0x01, representing
307 * endpoint address 0x01 and IN/OUT directions.
308 * We map both endpoint addresses to the same device,
309 * IN is reading from it, OUT is writing to it.
311 * In the if clause above we check whether one
312 * of the structs is populated.
314 dev = sc->sc_endpoints[endptno][IN].dev;
317 sc->sc_endpoints[endptno][IN].dev = NULL;
319 dev = sc->sc_endpoints[endptno][OUT].dev;
322 sc->sc_endpoints[endptno][OUT].dev = NULL;
326 sc->sc_dying = prev_sc_dying;
330 ugen_set_config(struct ugen_softc *sc, int configno)
332 usbd_device_handle dev = sc->sc_udev;
333 usbd_interface_handle iface;
334 usb_endpoint_descriptor_t *ed;
335 struct ugen_endpoint *sce;
336 u_int8_t niface, nendpt;
337 int ifaceno, endptno, endpt;
341 DPRINTFN(1,("ugen_set_config: %s to configno %d, sc=%p\n",
342 device_get_nameunit(sc->sc_dev), configno, sc));
344 ugen_destroy_devnodes(sc);
346 /* We start at 1, not 0, because we don't care whether the
347 * control endpoint is open or not. It is always present.
349 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
350 if (sc->sc_is_open[endptno]) {
352 ("ugen_set_config: %s - endpoint %d is open\n",
353 device_get_nameunit(sc->sc_dev), endptno));
354 return (USBD_IN_USE);
358 /* Avoid setting the current value. */
359 if (usbd_get_config_descriptor(dev)->bConfigurationValue != configno) {
360 err = usbd_set_config_no(dev, configno, 1);
365 err = usbd_interface_count(dev, &niface);
368 memset(sc->sc_endpoints, 0, sizeof sc->sc_endpoints);
369 for (ifaceno = 0; ifaceno < niface; ifaceno++) {
370 DPRINTFN(1,("ugen_set_config: ifaceno %d\n", ifaceno));
371 err = usbd_device2interface_handle(dev, ifaceno, &iface);
374 err = usbd_endpoint_count(iface, &nendpt);
377 for (endptno = 0; endptno < nendpt; endptno++) {
378 ed = usbd_interface2endpoint_descriptor(iface,endptno);
379 endpt = ed->bEndpointAddress;
380 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
381 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
382 DPRINTFN(1,("ugen_set_config: endptno %d, endpt=0x%02x"
384 endptno, endpt, UE_GET_ADDR(endpt),
385 UE_GET_DIR(endpt), sce));
392 ugen_make_devnodes(sc);
394 return (USBD_NORMAL_COMPLETION);
398 ugenopen(struct dev_open_args *ap)
400 cdev_t dev = ap->a_head.a_dev;
401 struct ugen_softc *sc;
402 int unit = UGENUNIT(dev);
403 int endpt = UGENENDPOINT(dev);
404 usb_endpoint_descriptor_t *edesc;
405 struct ugen_endpoint *sce;
408 usbd_xfer_handle xfer;
412 sc = devclass_get_softc(ugen_devclass, unit);
416 DPRINTFN(5, ("ugenopen: flag=%d, mode=%d, unit=%d endpt=%d\n",
417 ap->a_oflags, ap->a_devtype, unit, endpt));
422 if (sc->sc_is_open[endpt])
425 if (endpt == USB_CONTROL_ENDPOINT) {
426 sc->sc_is_open[USB_CONTROL_ENDPOINT] = 1;
430 /* Make sure there are pipes for all directions. */
431 for (dir = OUT; dir <= IN; dir++) {
432 if (ap->a_oflags & (dir == OUT ? FWRITE : FREAD)) {
433 sce = &sc->sc_endpoints[endpt][dir];
434 if (sce == 0 || sce->edesc == 0)
439 /* Actually open the pipes. */
440 /* XXX Should back out properly if it fails. */
441 for (dir = OUT; dir <= IN; dir++) {
442 if (!(ap->a_oflags & (dir == OUT ? FWRITE : FREAD)))
444 sce = &sc->sc_endpoints[endpt][dir];
446 sce->timeout = USBD_NO_TIMEOUT;
447 DPRINTFN(5, ("ugenopen: sc=%p, endpt=%d, dir=%d, sce=%p\n",
448 sc, endpt, dir, sce));
450 switch (edesc->bmAttributes & UE_XFERTYPE) {
453 err = usbd_open_pipe(sce->iface,
454 edesc->bEndpointAddress, 0, &sce->pipeh);
459 isize = UGETW(edesc->wMaxPacketSize);
460 if (isize == 0) /* shouldn't happen */
462 sce->ibuf = kmalloc(isize, M_USBDEV, M_WAITOK);
463 DPRINTFN(5, ("ugenopen: intr endpt=%d,isize=%d\n",
465 if ((clist_alloc_cblocks(&sce->q, UGEN_IBSIZE,
466 UGEN_IBSIZE), 0) == -1)
468 err = usbd_open_pipe_intr(sce->iface,
469 edesc->bEndpointAddress,
470 USBD_SHORT_XFER_OK, &sce->pipeh, sce,
471 sce->ibuf, isize, ugenintr,
472 USBD_DEFAULT_INTERVAL);
474 kfree(sce->ibuf, M_USBDEV);
475 clist_free_cblocks(&sce->q);
478 DPRINTFN(5, ("ugenopen: interrupt open done\n"));
481 err = usbd_open_pipe(sce->iface,
482 edesc->bEndpointAddress, 0, &sce->pipeh);
489 isize = UGETW(edesc->wMaxPacketSize);
490 if (isize == 0) /* shouldn't happen */
492 sce->ibuf = kmalloc(isize * UGEN_NISOFRAMES,
494 sce->cur = sce->fill = sce->ibuf;
495 sce->limit = sce->ibuf + isize * UGEN_NISOFRAMES;
496 DPRINTFN(5, ("ugenopen: isoc endpt=%d, isize=%d\n",
498 err = usbd_open_pipe(sce->iface,
499 edesc->bEndpointAddress, 0, &sce->pipeh);
501 kfree(sce->ibuf, M_USBDEV);
504 for(i = 0; i < UGEN_NISOREQS; ++i) {
505 sce->isoreqs[i].sce = sce;
506 xfer = usbd_alloc_xfer(sc->sc_udev);
509 sce->isoreqs[i].xfer = xfer;
510 buf = usbd_alloc_buffer
511 (xfer, isize * UGEN_NISORFRMS);
516 sce->isoreqs[i].dmabuf = buf;
517 for(j = 0; j < UGEN_NISORFRMS; ++j)
518 sce->isoreqs[i].sizes[j] = isize;
520 (xfer, sce->pipeh, &sce->isoreqs[i],
521 sce->isoreqs[i].sizes,
522 UGEN_NISORFRMS, USBD_NO_COPY,
524 (void)usbd_transfer(xfer);
526 DPRINTFN(5, ("ugenopen: isoc open done\n"));
529 while (--i >= 0) /* implicit buffer free */
530 usbd_free_xfer(sce->isoreqs[i].xfer);
533 sce->timeout = USBD_DEFAULT_TIMEOUT;
537 sc->sc_is_open[endpt] = 1;
542 ugenclose(struct dev_close_args *ap)
544 cdev_t dev = ap->a_head.a_dev;
545 int endpt = UGENENDPOINT(dev);
546 struct ugen_softc *sc;
547 struct ugen_endpoint *sce;
551 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
553 DPRINTFN(5, ("ugenclose: flag=%d, mode=%d, unit=%d, endpt=%d\n",
554 ap->a_fflag, ap->a_devtype, UGENUNIT(dev), endpt));
557 if (!sc->sc_is_open[endpt]) {
558 kprintf("ugenclose: not open\n");
563 if (endpt == USB_CONTROL_ENDPOINT) {
564 DPRINTFN(5, ("ugenclose: close control\n"));
565 sc->sc_is_open[endpt] = 0;
569 for (dir = OUT; dir <= IN; dir++) {
570 if (!(ap->a_fflag & (dir == OUT ? FWRITE : FREAD)))
572 sce = &sc->sc_endpoints[endpt][dir];
573 if (sce->pipeh == NULL)
575 DPRINTFN(5, ("ugenclose: endpt=%d dir=%d sce=%p\n",
578 usbd_abort_pipe(sce->pipeh);
579 usbd_close_pipe(sce->pipeh);
582 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
584 ndflush(&sce->q, sce->q.c_cc);
585 clist_free_cblocks(&sce->q);
588 for (i = 0; i < UGEN_NISOREQS; ++i)
589 usbd_free_xfer(sce->isoreqs[i].xfer);
594 if (sce->ibuf != NULL) {
595 kfree(sce->ibuf, M_USBDEV);
597 clist_free_cblocks(&sce->q);
600 sc->sc_is_open[endpt] = 0;
606 ugen_do_read(struct ugen_softc *sc, int endpt, struct uio *uio, int flag)
608 struct ugen_endpoint *sce = &sc->sc_endpoints[endpt][IN];
611 usbd_xfer_handle xfer;
615 u_char buffer[UGEN_CHUNK];
617 DPRINTFN(5, ("%s: ugenread: %d\n", device_get_nameunit(sc->sc_dev), endpt));
622 if (endpt == USB_CONTROL_ENDPOINT)
626 if (sce->edesc == NULL) {
627 kprintf("ugenread: no edesc\n");
630 if (sce->pipeh == NULL) {
631 kprintf("ugenread: no pipe\n");
636 buf = getugenbuf(ugen_bufsize, &ugen_bbsize);
638 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
640 /* Block until activity occurred. */
642 while (sce->q.c_cc == 0) {
643 if (flag & IO_NDELAY) {
648 sce->state |= UGEN_ASLP;
649 DPRINTFN(5, ("ugenread: sleep on %p\n", sce));
650 error = tsleep(sce, PCATCH, "ugenri",
651 (sce->timeout * hz + 999) / 1000);
652 sce->state &= ~UGEN_ASLP;
653 DPRINTFN(5, ("ugenread: woke, error=%d\n", error));
656 if (error == EAGAIN) {
657 error = 0; /* timeout, return 0 bytes */
665 /* Transfer as many chunks as possible. */
666 while (sce->q.c_cc > 0 && uio->uio_resid > 0 && !error) {
667 n = szmin(sce->q.c_cc, uio->uio_resid);
668 if (n > sizeof(buffer))
671 /* Remove a small chunk from the input queue. */
672 q_to_b(&sce->q, buffer, n);
673 DPRINTFN(5, ("ugenread: got %d chars\n", n));
675 /* Copy the data to the user process. */
676 error = uiomove(buffer, n, uio);
682 xfer = usbd_alloc_xfer(sc->sc_udev);
687 while ((n = szmin(ugen_bbsize, uio->uio_resid)) != 0) {
688 DPRINTFN(1, ("ugenread: start transfer %d bytes\n",n));
690 err = usbd_bulk_transfer(
692 sce->state & UGEN_SHORT_OK ?
693 USBD_SHORT_XFER_OK : 0,
694 sce->timeout, buf, &tn, "ugenrb");
696 if (err == USBD_INTERRUPTED)
698 else if (err == USBD_TIMEOUT)
704 DPRINTFN(1, ("ugenread: got %d bytes\n", tn));
705 error = uiomove(buf, tn, uio);
709 usbd_free_xfer(xfer);
713 while (sce->cur == sce->fill) {
714 if (flag & IO_NDELAY) {
719 sce->state |= UGEN_ASLP;
720 DPRINTFN(5, ("ugenread: sleep on %p\n", sce));
721 error = tsleep(sce, PCATCH, "ugenri",
722 (sce->timeout * hz + 999) / 1000);
723 sce->state &= ~UGEN_ASLP;
724 DPRINTFN(5, ("ugenread: woke, error=%d\n", error));
727 if (error == EAGAIN) {
728 error = 0; /* timeout, return 0 bytes */
735 while (sce->cur != sce->fill && uio->uio_resid > 0 && !error) {
736 if (sce->fill > sce->cur)
737 n = szmin(sce->fill - sce->cur, uio->uio_resid);
739 n = szmin(sce->limit- sce->cur, uio->uio_resid);
741 DPRINTFN(5, ("ugenread: isoc got %d chars\n", n));
743 /* Copy the data to the user process. */
744 error = uiomove(sce->cur, n, uio);
748 if(sce->cur >= sce->limit)
749 sce->cur = sce->ibuf;
760 relugenbuf(buf, ugen_bbsize);
765 ugenread(struct dev_read_args *ap)
767 cdev_t dev = ap->a_head.a_dev;
768 int endpt = UGENENDPOINT(dev);
769 struct ugen_softc *sc;
772 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
778 error = ugen_do_read(sc, endpt, ap->a_uio, ap->a_ioflag);
779 if (--sc->sc_refcnt < 0)
780 usb_detach_wakeup(sc->sc_dev);
785 ugen_do_write(struct ugen_softc *sc, int endpt, struct uio *uio, int flag)
787 struct ugen_endpoint *sce = &sc->sc_endpoints[endpt][OUT];
792 usbd_xfer_handle xfer;
795 DPRINTFN(5, ("%s: ugenwrite: %d\n", device_get_nameunit(sc->sc_dev), endpt));
800 if (endpt == USB_CONTROL_ENDPOINT)
804 if (sce->edesc == NULL) {
805 kprintf("ugenwrite: no edesc\n");
808 if (sce->pipeh == NULL) {
809 kprintf("ugenwrite: no pipe\n");
814 buf = getugenbuf(ugen_bufsize, &ugen_bbsize);
816 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
818 xfer = usbd_alloc_xfer(sc->sc_udev);
823 while ((n = szmin(ugen_bbsize, uio->uio_resid)) != 0) {
824 error = uiomove(buf, n, uio);
827 DPRINTFN(1, ("ugenwrite: transfer %d bytes\n", n));
828 err = usbd_bulk_transfer(xfer, sce->pipeh, 0,
829 sce->timeout, buf, &n,"ugenwb");
831 if (err == USBD_INTERRUPTED)
833 else if (err == USBD_TIMEOUT)
840 usbd_free_xfer(xfer);
843 xfer = usbd_alloc_xfer(sc->sc_udev);
848 while ((n = szmin(UGETW(sce->edesc->wMaxPacketSize),
849 uio->uio_resid)) != 0) {
850 error = uiomove(buf, n, uio);
853 DPRINTFN(1, ("ugenwrite: transfer %d bytes\n", n));
854 err = usbd_intr_transfer(xfer, sce->pipeh, 0,
855 sce->timeout, buf, &n,"ugenwi");
857 if (err == USBD_INTERRUPTED)
859 else if (err == USBD_TIMEOUT)
866 usbd_free_xfer(xfer);
873 relugenbuf(buf, ugen_bbsize);
878 ugenwrite(struct dev_write_args *ap)
880 cdev_t dev = ap->a_head.a_dev;
881 int endpt = UGENENDPOINT(dev);
882 struct ugen_softc *sc;
885 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
891 error = ugen_do_write(sc, endpt, ap->a_uio, ap->a_ioflag);
892 if (--sc->sc_refcnt < 0)
893 usb_detach_wakeup(sc->sc_dev);
898 ugen_detach(device_t self)
900 struct ugen_softc *sc = device_get_softc(self);
901 struct ugen_endpoint *sce;
904 DPRINTF(("ugen_detach: sc=%p\n", sc));
907 /* Abort all pipes. Causes processes waiting for transfer to wake. */
908 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
909 for (dir = OUT; dir <= IN; dir++) {
910 sce = &sc->sc_endpoints[i][dir];
911 if (sce && sce->pipeh)
912 usbd_abort_pipe(sce->pipeh);
913 selwakeup(&sce->rsel);
917 if (--sc->sc_refcnt >= 0) {
919 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
920 wakeup(&sc->sc_endpoints[i][IN]);
921 /* Wait for processes to go away. */
922 usb_detach_wait(sc->sc_dev);
926 /* destroy the device for the control endpoint */
927 ugen_destroy_devnodes(sc);
928 kprintf("devfs: Please check that only the right ugen devices were removed !!!\n");
929 dev_ops_remove_minor(&ugen_ops,
930 /*UGENUNITMASK,*/ UGENMINOR(device_get_unit(sc->sc_dev), 0));
931 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
936 ugenintr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
938 struct ugen_endpoint *sce = addr;
939 /*struct ugen_softc *sc = sce->sc;*/
943 if (status == USBD_CANCELLED)
946 if (status != USBD_NORMAL_COMPLETION) {
947 DPRINTF(("ugenintr: status=%d\n", status));
948 if (status == USBD_STALLED)
949 usbd_clear_endpoint_stall_async(sce->pipeh);
953 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
956 DPRINTFN(5, ("ugenintr: xfer=%p status=%d count=%d\n",
957 xfer, status, count));
958 DPRINTFN(5, (" data = %02x %02x %02x\n",
959 ibuf[0], ibuf[1], ibuf[2]));
961 (void)b_to_q(ibuf, count, &sce->q);
963 if (sce->state & UGEN_ASLP) {
964 sce->state &= ~UGEN_ASLP;
965 DPRINTFN(5, ("ugen_intr: waking %p\n", sce));
968 selwakeup(&sce->rsel);
972 ugen_isoc_rintr(usbd_xfer_handle xfer, usbd_private_handle addr,
975 struct isoreq *req = addr;
976 struct ugen_endpoint *sce = req->sce;
980 /* Return if we are aborting. */
981 if (status == USBD_CANCELLED)
984 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
985 DPRINTFN(5,("ugen_isoc_rintr: xfer %d, count=%d\n",
986 (int)(req - sce->isoreqs),
989 /* throw away oldest input if the buffer is full */
990 if(sce->fill < sce->cur && sce->cur <= sce->fill + count) {
992 if(sce->cur >= sce->limit)
993 sce->cur = sce->ibuf + (sce->limit - sce->cur);
994 DPRINTFN(5, ("ugen_isoc_rintr: throwing away %d bytes\n",
998 isize = UGETW(sce->edesc->wMaxPacketSize);
999 for (i = 0; i < UGEN_NISORFRMS; i++) {
1000 u_int32_t actlen = req->sizes[i];
1001 char const *buf = (char const *)req->dmabuf + isize * i;
1003 /* copy data to buffer */
1004 while (actlen > 0) {
1005 n = min(actlen, sce->limit - sce->fill);
1006 memcpy(sce->fill, buf, n);
1011 if(sce->fill == sce->limit)
1012 sce->fill = sce->ibuf;
1015 /* setup size for next transfer */
1016 req->sizes[i] = isize;
1019 usbd_setup_isoc_xfer(xfer, sce->pipeh, req, req->sizes, UGEN_NISORFRMS,
1020 USBD_NO_COPY, ugen_isoc_rintr);
1021 (void)usbd_transfer(xfer);
1023 if (sce->state & UGEN_ASLP) {
1024 sce->state &= ~UGEN_ASLP;
1025 DPRINTFN(5, ("ugen_isoc_rintr: waking %p\n", sce));
1028 selwakeup(&sce->rsel);
1032 ugen_set_interface(struct ugen_softc *sc, int ifaceidx, int altno)
1034 usbd_interface_handle iface;
1035 usb_endpoint_descriptor_t *ed;
1037 struct ugen_endpoint *sce;
1038 u_int8_t niface, nendpt, endptno, endpt;
1041 DPRINTFN(15, ("ugen_set_interface %d %d\n", ifaceidx, altno));
1043 err = usbd_interface_count(sc->sc_udev, &niface);
1046 if (ifaceidx < 0 || ifaceidx >= niface)
1047 return (USBD_INVAL);
1049 err = usbd_device2interface_handle(sc->sc_udev, ifaceidx, &iface);
1052 err = usbd_endpoint_count(iface, &nendpt);
1056 /* destroy the existing devices, we remake the new ones in a moment */
1057 ugen_destroy_devnodes(sc);
1059 /* XXX should only do this after setting new altno has succeeded */
1060 for (endptno = 0; endptno < nendpt; endptno++) {
1061 ed = usbd_interface2endpoint_descriptor(iface,endptno);
1062 endpt = ed->bEndpointAddress;
1063 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
1064 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
1070 /* change setting */
1071 err = usbd_set_interface(iface, altno);
1075 err = usbd_endpoint_count(iface, &nendpt);
1078 for (endptno = 0; endptno < nendpt; endptno++) {
1079 ed = usbd_interface2endpoint_descriptor(iface,endptno);
1080 endpt = ed->bEndpointAddress;
1081 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
1082 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
1088 /* make the new devices */
1089 ugen_make_devnodes(sc);
1094 /* Retrieve a complete descriptor for a certain device and index. */
1095 static usb_config_descriptor_t *
1096 ugen_get_cdesc(struct ugen_softc *sc, int index, int *lenp)
1098 usb_config_descriptor_t *cdesc, *tdesc, cdescr;
1102 if (index == USB_CURRENT_CONFIG_INDEX) {
1103 tdesc = usbd_get_config_descriptor(sc->sc_udev);
1104 len = UGETW(tdesc->wTotalLength);
1107 cdesc = kmalloc(len, M_TEMP, M_INTWAIT);
1108 memcpy(cdesc, tdesc, len);
1109 DPRINTFN(5,("ugen_get_cdesc: current, len=%d\n", len));
1111 err = usbd_get_config_desc(sc->sc_udev, index, &cdescr);
1114 len = UGETW(cdescr.wTotalLength);
1115 DPRINTFN(5,("ugen_get_cdesc: index=%d, len=%d\n", index, len));
1118 cdesc = kmalloc(len, M_TEMP, M_INTWAIT);
1119 err = usbd_get_config_desc_full(sc->sc_udev, index, cdesc, len);
1121 kfree(cdesc, M_TEMP);
1129 ugen_get_alt_index(struct ugen_softc *sc, int ifaceidx)
1131 usbd_interface_handle iface;
1134 err = usbd_device2interface_handle(sc->sc_udev, ifaceidx, &iface);
1137 return (usbd_get_interface_altindex(iface));
1141 ugen_do_ioctl(struct ugen_softc *sc, int endpt, u_long cmd,
1142 caddr_t addr, int flag)
1144 struct ugen_endpoint *sce;
1146 usbd_interface_handle iface;
1147 struct usb_config_desc *cd;
1148 usb_config_descriptor_t *cdesc;
1149 struct usb_interface_desc *id;
1150 usb_interface_descriptor_t *idesc;
1151 struct usb_endpoint_desc *ed;
1152 usb_endpoint_descriptor_t *edesc;
1153 struct usb_alt_interface *ai;
1154 struct usb_string_desc *si;
1157 DPRINTFN(5, ("ugenioctl: cmd=%08lx\n", cmd));
1162 case USB_SET_SHORT_XFER:
1163 /* This flag only affects read */
1164 if (endpt == USB_CONTROL_ENDPOINT)
1166 sce = &sc->sc_endpoints[endpt][IN];
1168 if (sce->pipeh == NULL) {
1169 kprintf("ugenioctl: USB_SET_SHORT_XFER, no pipe\n");
1174 sce->state |= UGEN_SHORT_OK;
1176 sce->state &= ~UGEN_SHORT_OK;
1178 case USB_SET_TIMEOUT:
1179 sce = &sc->sc_endpoints[endpt][IN];
1180 sce->timeout = *(int *)addr;
1181 sce = &sc->sc_endpoints[endpt][OUT];
1182 sce->timeout = *(int *)addr;
1188 if (endpt != USB_CONTROL_ENDPOINT)
1194 ugendebug = *(int *)addr;
1197 case USB_GET_CONFIG:
1198 err = usbd_get_config(sc->sc_udev, &conf);
1201 *(int *)addr = conf;
1203 case USB_SET_CONFIG:
1204 if (!(flag & FWRITE))
1206 err = ugen_set_config(sc, *(int *)addr);
1208 case USBD_NORMAL_COMPLETION:
1216 case USB_GET_ALTINTERFACE:
1217 ai = (struct usb_alt_interface *)addr;
1218 err = usbd_device2interface_handle(sc->sc_udev,
1219 ai->uai_interface_index, &iface);
1222 idesc = usbd_get_interface_descriptor(iface);
1225 ai->uai_alt_no = idesc->bAlternateSetting;
1227 case USB_SET_ALTINTERFACE:
1228 if (!(flag & FWRITE))
1230 ai = (struct usb_alt_interface *)addr;
1231 err = usbd_device2interface_handle(sc->sc_udev,
1232 ai->uai_interface_index, &iface);
1235 err = ugen_set_interface(sc, ai->uai_interface_index, ai->uai_alt_no);
1239 case USB_GET_NO_ALT:
1240 ai = (struct usb_alt_interface *)addr;
1241 cdesc = ugen_get_cdesc(sc, ai->uai_config_index, 0);
1244 idesc = usbd_find_idesc(cdesc, ai->uai_interface_index, 0);
1245 if (idesc == NULL) {
1246 kfree(cdesc, M_TEMP);
1249 ai->uai_alt_no = usbd_get_no_alts(cdesc, idesc->bInterfaceNumber);
1250 kfree(cdesc, M_TEMP);
1252 case USB_GET_DEVICE_DESC:
1253 *(usb_device_descriptor_t *)addr =
1254 *usbd_get_device_descriptor(sc->sc_udev);
1256 case USB_GET_CONFIG_DESC:
1257 cd = (struct usb_config_desc *)addr;
1258 cdesc = ugen_get_cdesc(sc, cd->ucd_config_index, 0);
1261 cd->ucd_desc = *cdesc;
1262 kfree(cdesc, M_TEMP);
1264 case USB_GET_INTERFACE_DESC:
1265 id = (struct usb_interface_desc *)addr;
1266 cdesc = ugen_get_cdesc(sc, id->uid_config_index, 0);
1269 if (id->uid_config_index == USB_CURRENT_CONFIG_INDEX &&
1270 id->uid_alt_index == USB_CURRENT_ALT_INDEX)
1271 alt = ugen_get_alt_index(sc, id->uid_interface_index);
1273 alt = id->uid_alt_index;
1274 idesc = usbd_find_idesc(cdesc, id->uid_interface_index, alt);
1275 if (idesc == NULL) {
1276 kfree(cdesc, M_TEMP);
1279 id->uid_desc = *idesc;
1280 kfree(cdesc, M_TEMP);
1282 case USB_GET_ENDPOINT_DESC:
1283 ed = (struct usb_endpoint_desc *)addr;
1284 cdesc = ugen_get_cdesc(sc, ed->ued_config_index, 0);
1287 if (ed->ued_config_index == USB_CURRENT_CONFIG_INDEX &&
1288 ed->ued_alt_index == USB_CURRENT_ALT_INDEX)
1289 alt = ugen_get_alt_index(sc, ed->ued_interface_index);
1291 alt = ed->ued_alt_index;
1292 edesc = usbd_find_edesc(cdesc, ed->ued_interface_index,
1293 alt, ed->ued_endpoint_index);
1294 if (edesc == NULL) {
1295 kfree(cdesc, M_TEMP);
1298 ed->ued_desc = *edesc;
1299 kfree(cdesc, M_TEMP);
1301 case USB_GET_FULL_DESC:
1306 struct usb_full_desc *fd = (struct usb_full_desc *)addr;
1309 cdesc = ugen_get_cdesc(sc, fd->ufd_config_index, &len);
1310 if (len > fd->ufd_size)
1312 iov.iov_base = (caddr_t)fd->ufd_data;
1316 uio.uio_resid = len;
1318 uio.uio_segflg = UIO_USERSPACE;
1319 uio.uio_rw = UIO_READ;
1320 uio.uio_td = curthread;
1321 error = uiomove((void *)cdesc, len, &uio);
1322 kfree(cdesc, M_TEMP);
1325 case USB_GET_STRING_DESC:
1329 si = (struct usb_string_desc *)addr;
1330 err = usbd_get_string_desc(sc->sc_udev, si->usd_string_index,
1331 si->usd_language_id, &si->usd_desc, &size);
1336 case USB_DO_REQUEST:
1338 struct usb_ctl_request *ur = (void *)addr;
1339 int len = UGETW(ur->ucr_request.wLength);
1346 if (!(flag & FWRITE))
1348 /* Avoid requests that would damage the bus integrity. */
1349 if ((ur->ucr_request.bmRequestType == UT_WRITE_DEVICE &&
1350 ur->ucr_request.bRequest == UR_SET_ADDRESS) ||
1351 (ur->ucr_request.bmRequestType == UT_WRITE_DEVICE &&
1352 ur->ucr_request.bRequest == UR_SET_CONFIG) ||
1353 (ur->ucr_request.bmRequestType == UT_WRITE_INTERFACE &&
1354 ur->ucr_request.bRequest == UR_SET_INTERFACE))
1357 if (len < 0 || len > 32767)
1360 iov.iov_base = (caddr_t)ur->ucr_data;
1364 uio.uio_resid = len;
1366 uio.uio_segflg = UIO_USERSPACE;
1368 ur->ucr_request.bmRequestType & UT_READ ?
1369 UIO_READ : UIO_WRITE;
1370 uio.uio_td = curthread;
1371 ptr = kmalloc(len, M_TEMP, M_WAITOK);
1372 if (uio.uio_rw == UIO_WRITE) {
1373 error = uiomove(ptr, len, &uio);
1378 sce = &sc->sc_endpoints[endpt][IN];
1379 err = usbd_do_request_flags(sc->sc_udev, &ur->ucr_request,
1380 ptr, ur->ucr_flags, &ur->ucr_actlen, sce->timeout);
1386 if (uio.uio_rw == UIO_READ) {
1387 error = uiomove(ptr, len, &uio);
1397 case USB_GET_DEVICEINFO:
1398 usbd_fill_deviceinfo(sc->sc_udev,
1399 (struct usb_device_info *)addr, 1);
1408 ugenioctl(struct dev_ioctl_args *ap)
1410 cdev_t dev = ap->a_head.a_dev;
1411 int endpt = UGENENDPOINT(dev);
1412 struct ugen_softc *sc;
1415 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
1420 error = ugen_do_ioctl(sc, endpt, ap->a_cmd, ap->a_data, ap->a_fflag);
1421 if (--sc->sc_refcnt < 0)
1422 usb_detach_wakeup(sc->sc_dev);
1427 ugenpoll(struct dev_poll_args *ap)
1429 cdev_t dev = ap->a_head.a_dev;
1430 struct ugen_softc *sc;
1431 struct ugen_endpoint *sce_in, *sce_out;
1432 usb_endpoint_descriptor_t *edesc;
1435 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
1438 return ((ap->a_events & (POLLIN | POLLOUT | POLLRDNORM |
1439 POLLWRNORM)) | POLLHUP);
1442 /* Do not allow to poll a control endpoint */
1443 if (UGENENDPOINT(dev) == USB_CONTROL_ENDPOINT) {
1444 return (ap->a_events & (POLLIN | POLLOUT | POLLRDNORM |
1448 sce_in = &sc->sc_endpoints[UGENENDPOINT(dev)][IN];
1449 sce_out = &sc->sc_endpoints[UGENENDPOINT(dev)][OUT];
1450 edesc = (sce_in->edesc != NULL) ? sce_in->edesc : sce_out->edesc;
1451 KASSERT(edesc != NULL, ("ugenpoll: NULL edesc"));
1453 if (sce_in->edesc == NULL || sce_in->pipeh == NULL)
1455 if (sce_out->edesc == NULL || sce_out->pipeh == NULL)
1459 switch (edesc->bmAttributes & UE_XFERTYPE) {
1461 if (sce_in != NULL && (ap->a_events & (POLLIN | POLLRDNORM))) {
1462 if (sce_in->q.c_cc > 0)
1463 revents |= ap->a_events & (POLLIN | POLLRDNORM);
1465 selrecord(curthread, &sce_in->rsel);
1467 if (sce_out != NULL && (ap->a_events & (POLLOUT | POLLWRNORM))) {
1468 if (sce_out->q.c_cc > 0)
1469 revents |= ap->a_events & (POLLOUT | POLLWRNORM);
1471 selrecord(curthread, &sce_out->rsel);
1474 case UE_ISOCHRONOUS:
1475 if (sce_in != NULL && (ap->a_events & (POLLIN | POLLRDNORM))) {
1476 if (sce_in->cur != sce_in->fill)
1477 revents |= ap->a_events & (POLLIN | POLLRDNORM);
1479 selrecord(curthread, &sce_in->rsel);
1481 if (sce_out != NULL && (ap->a_events & (POLLOUT | POLLWRNORM))) {
1482 if (sce_out->cur != sce_out->fill)
1483 revents |= ap->a_events & (POLLOUT | POLLWRNORM);
1485 selrecord(curthread, &sce_out->rsel);
1490 * We have no easy way of determining if a read will
1491 * yield any data or a write will happen.
1492 * Pretend they will.
1494 revents |= ap->a_events &
1495 (POLLIN | POLLRDNORM | POLLOUT | POLLWRNORM);
1501 ap->a_events = revents;
1505 DRIVER_MODULE(ugen, uhub, ugen_driver, ugen_devclass, usbd_driver_load, 0);