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 dev_ops_add(&ugen_ops,
248 UGENUNITMASK, UGENMINOR(device_get_unit(sc->sc_dev), 0));
249 make_dev(&ugen_ops, UGENMINOR(device_get_unit(sc->sc_dev), 0),
250 UID_ROOT, GID_OPERATOR, 0644, "%s", device_get_nameunit(sc->sc_dev));
252 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);
257 ugen_make_devnodes(struct ugen_softc *sc)
262 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
263 if (sc->sc_endpoints[endptno][IN].sc != NULL ||
264 sc->sc_endpoints[endptno][OUT].sc != NULL ) {
265 /* endpt can be 0x81 and 0x01, representing
266 * endpoint address 0x01 and IN/OUT directions.
267 * We map both endpts to the same device,
268 * IN is reading from it, OUT is writing to it.
270 * In the if clause above we check whether one
271 * of the structs is populated.
273 dev = make_dev(&ugen_ops,
274 UGENMINOR(device_get_unit(sc->sc_dev), endptno),
275 UID_ROOT, GID_OPERATOR, 0644,
277 device_get_nameunit(sc->sc_dev), endptno);
278 if (sc->sc_endpoints[endptno][IN].sc != NULL) {
280 if (sc->sc_endpoints[endptno][IN].dev)
281 release_dev(sc->sc_endpoints[endptno][IN].dev);
282 sc->sc_endpoints[endptno][IN].dev = dev;
284 if (sc->sc_endpoints[endptno][OUT].sc != NULL) {
286 if (sc->sc_endpoints[endptno][OUT].dev)
287 release_dev(sc->sc_endpoints[endptno][OUT].dev);
288 sc->sc_endpoints[endptno][OUT].dev = dev;
295 ugen_destroy_devnodes(struct ugen_softc *sc)
297 int endptno, prev_sc_dying;
300 prev_sc_dying = sc->sc_dying;
303 /* destroy all devices for the other (existing) endpoints as well */
304 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
305 if (sc->sc_endpoints[endptno][IN].sc != NULL ||
306 sc->sc_endpoints[endptno][OUT].sc != NULL ) {
307 /* endpt can be 0x81 and 0x01, representing
308 * endpoint address 0x01 and IN/OUT directions.
309 * We map both endpoint addresses to the same device,
310 * IN is reading from it, OUT is writing to it.
312 * In the if clause above we check whether one
313 * of the structs is populated.
315 dev = sc->sc_endpoints[endptno][IN].dev;
318 sc->sc_endpoints[endptno][IN].dev = NULL;
320 dev = sc->sc_endpoints[endptno][OUT].dev;
323 sc->sc_endpoints[endptno][OUT].dev = NULL;
327 sc->sc_dying = prev_sc_dying;
331 ugen_set_config(struct ugen_softc *sc, int configno)
333 usbd_device_handle dev = sc->sc_udev;
334 usbd_interface_handle iface;
335 usb_endpoint_descriptor_t *ed;
336 struct ugen_endpoint *sce;
337 u_int8_t niface, nendpt;
338 int ifaceno, endptno, endpt;
342 DPRINTFN(1,("ugen_set_config: %s to configno %d, sc=%p\n",
343 device_get_nameunit(sc->sc_dev), configno, sc));
345 ugen_destroy_devnodes(sc);
347 /* We start at 1, not 0, because we don't care whether the
348 * control endpoint is open or not. It is always present.
350 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
351 if (sc->sc_is_open[endptno]) {
353 ("ugen_set_config: %s - endpoint %d is open\n",
354 device_get_nameunit(sc->sc_dev), endptno));
355 return (USBD_IN_USE);
359 /* Avoid setting the current value. */
360 if (usbd_get_config_descriptor(dev)->bConfigurationValue != configno) {
361 err = usbd_set_config_no(dev, configno, 1);
366 err = usbd_interface_count(dev, &niface);
369 memset(sc->sc_endpoints, 0, sizeof sc->sc_endpoints);
370 for (ifaceno = 0; ifaceno < niface; ifaceno++) {
371 DPRINTFN(1,("ugen_set_config: ifaceno %d\n", ifaceno));
372 err = usbd_device2interface_handle(dev, ifaceno, &iface);
375 err = usbd_endpoint_count(iface, &nendpt);
378 for (endptno = 0; endptno < nendpt; endptno++) {
379 ed = usbd_interface2endpoint_descriptor(iface,endptno);
380 endpt = ed->bEndpointAddress;
381 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
382 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
383 DPRINTFN(1,("ugen_set_config: endptno %d, endpt=0x%02x"
385 endptno, endpt, UE_GET_ADDR(endpt),
386 UE_GET_DIR(endpt), sce));
393 ugen_make_devnodes(sc);
395 return (USBD_NORMAL_COMPLETION);
399 ugenopen(struct dev_open_args *ap)
401 cdev_t dev = ap->a_head.a_dev;
402 struct ugen_softc *sc;
403 int unit = UGENUNIT(dev);
404 int endpt = UGENENDPOINT(dev);
405 usb_endpoint_descriptor_t *edesc;
406 struct ugen_endpoint *sce;
409 usbd_xfer_handle xfer;
413 sc = devclass_get_softc(ugen_devclass, unit);
417 DPRINTFN(5, ("ugenopen: flag=%d, mode=%d, unit=%d endpt=%d\n",
418 ap->a_oflags, ap->a_devtype, unit, endpt));
423 if (sc->sc_is_open[endpt])
426 if (endpt == USB_CONTROL_ENDPOINT) {
427 sc->sc_is_open[USB_CONTROL_ENDPOINT] = 1;
431 /* Make sure there are pipes for all directions. */
432 for (dir = OUT; dir <= IN; dir++) {
433 if (ap->a_oflags & (dir == OUT ? FWRITE : FREAD)) {
434 sce = &sc->sc_endpoints[endpt][dir];
435 if (sce == 0 || sce->edesc == 0)
440 /* Actually open the pipes. */
441 /* XXX Should back out properly if it fails. */
442 for (dir = OUT; dir <= IN; dir++) {
443 if (!(ap->a_oflags & (dir == OUT ? FWRITE : FREAD)))
445 sce = &sc->sc_endpoints[endpt][dir];
447 sce->timeout = USBD_NO_TIMEOUT;
448 DPRINTFN(5, ("ugenopen: sc=%p, endpt=%d, dir=%d, sce=%p\n",
449 sc, endpt, dir, sce));
451 switch (edesc->bmAttributes & UE_XFERTYPE) {
454 err = usbd_open_pipe(sce->iface,
455 edesc->bEndpointAddress, 0, &sce->pipeh);
460 isize = UGETW(edesc->wMaxPacketSize);
461 if (isize == 0) /* shouldn't happen */
463 sce->ibuf = kmalloc(isize, M_USBDEV, M_WAITOK);
464 DPRINTFN(5, ("ugenopen: intr endpt=%d,isize=%d\n",
466 if ((clist_alloc_cblocks(&sce->q, UGEN_IBSIZE,
467 UGEN_IBSIZE), 0) == -1)
469 err = usbd_open_pipe_intr(sce->iface,
470 edesc->bEndpointAddress,
471 USBD_SHORT_XFER_OK, &sce->pipeh, sce,
472 sce->ibuf, isize, ugenintr,
473 USBD_DEFAULT_INTERVAL);
475 kfree(sce->ibuf, M_USBDEV);
476 clist_free_cblocks(&sce->q);
479 DPRINTFN(5, ("ugenopen: interrupt open done\n"));
482 err = usbd_open_pipe(sce->iface,
483 edesc->bEndpointAddress, 0, &sce->pipeh);
490 isize = UGETW(edesc->wMaxPacketSize);
491 if (isize == 0) /* shouldn't happen */
493 sce->ibuf = kmalloc(isize * UGEN_NISOFRAMES,
495 sce->cur = sce->fill = sce->ibuf;
496 sce->limit = sce->ibuf + isize * UGEN_NISOFRAMES;
497 DPRINTFN(5, ("ugenopen: isoc endpt=%d, isize=%d\n",
499 err = usbd_open_pipe(sce->iface,
500 edesc->bEndpointAddress, 0, &sce->pipeh);
502 kfree(sce->ibuf, M_USBDEV);
505 for(i = 0; i < UGEN_NISOREQS; ++i) {
506 sce->isoreqs[i].sce = sce;
507 xfer = usbd_alloc_xfer(sc->sc_udev);
510 sce->isoreqs[i].xfer = xfer;
511 buf = usbd_alloc_buffer
512 (xfer, isize * UGEN_NISORFRMS);
517 sce->isoreqs[i].dmabuf = buf;
518 for(j = 0; j < UGEN_NISORFRMS; ++j)
519 sce->isoreqs[i].sizes[j] = isize;
521 (xfer, sce->pipeh, &sce->isoreqs[i],
522 sce->isoreqs[i].sizes,
523 UGEN_NISORFRMS, USBD_NO_COPY,
525 (void)usbd_transfer(xfer);
527 DPRINTFN(5, ("ugenopen: isoc open done\n"));
530 while (--i >= 0) /* implicit buffer free */
531 usbd_free_xfer(sce->isoreqs[i].xfer);
534 sce->timeout = USBD_DEFAULT_TIMEOUT;
538 sc->sc_is_open[endpt] = 1;
543 ugenclose(struct dev_close_args *ap)
545 cdev_t dev = ap->a_head.a_dev;
546 int endpt = UGENENDPOINT(dev);
547 struct ugen_softc *sc;
548 struct ugen_endpoint *sce;
552 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
554 DPRINTFN(5, ("ugenclose: flag=%d, mode=%d, unit=%d, endpt=%d\n",
555 ap->a_fflag, ap->a_devtype, UGENUNIT(dev), endpt));
558 if (!sc->sc_is_open[endpt]) {
559 kprintf("ugenclose: not open\n");
564 if (endpt == USB_CONTROL_ENDPOINT) {
565 DPRINTFN(5, ("ugenclose: close control\n"));
566 sc->sc_is_open[endpt] = 0;
570 for (dir = OUT; dir <= IN; dir++) {
571 if (!(ap->a_fflag & (dir == OUT ? FWRITE : FREAD)))
573 sce = &sc->sc_endpoints[endpt][dir];
574 if (sce->pipeh == NULL)
576 DPRINTFN(5, ("ugenclose: endpt=%d dir=%d sce=%p\n",
579 usbd_abort_pipe(sce->pipeh);
580 usbd_close_pipe(sce->pipeh);
583 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
585 ndflush(&sce->q, sce->q.c_cc);
586 clist_free_cblocks(&sce->q);
589 for (i = 0; i < UGEN_NISOREQS; ++i)
590 usbd_free_xfer(sce->isoreqs[i].xfer);
595 if (sce->ibuf != NULL) {
596 kfree(sce->ibuf, M_USBDEV);
598 clist_free_cblocks(&sce->q);
601 sc->sc_is_open[endpt] = 0;
607 ugen_do_read(struct ugen_softc *sc, int endpt, struct uio *uio, int flag)
609 struct ugen_endpoint *sce = &sc->sc_endpoints[endpt][IN];
612 usbd_xfer_handle xfer;
616 u_char buffer[UGEN_CHUNK];
618 DPRINTFN(5, ("%s: ugenread: %d\n", device_get_nameunit(sc->sc_dev), endpt));
623 if (endpt == USB_CONTROL_ENDPOINT)
627 if (sce->edesc == NULL) {
628 kprintf("ugenread: no edesc\n");
631 if (sce->pipeh == NULL) {
632 kprintf("ugenread: no pipe\n");
637 buf = getugenbuf(ugen_bufsize, &ugen_bbsize);
639 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
641 /* Block until activity occurred. */
643 while (sce->q.c_cc == 0) {
644 if (flag & IO_NDELAY) {
649 sce->state |= UGEN_ASLP;
650 DPRINTFN(5, ("ugenread: sleep on %p\n", sce));
651 error = tsleep(sce, PCATCH, "ugenri",
652 (sce->timeout * hz + 999) / 1000);
653 sce->state &= ~UGEN_ASLP;
654 DPRINTFN(5, ("ugenread: woke, error=%d\n", error));
657 if (error == EAGAIN) {
658 error = 0; /* timeout, return 0 bytes */
666 /* Transfer as many chunks as possible. */
667 while (sce->q.c_cc > 0 && uio->uio_resid > 0 && !error) {
668 n = min(sce->q.c_cc, uio->uio_resid);
669 if (n > sizeof(buffer))
672 /* Remove a small chunk from the input queue. */
673 q_to_b(&sce->q, buffer, n);
674 DPRINTFN(5, ("ugenread: got %d chars\n", n));
676 /* Copy the data to the user process. */
677 error = uiomove(buffer, n, uio);
683 xfer = usbd_alloc_xfer(sc->sc_udev);
688 while ((n = min(ugen_bbsize, uio->uio_resid)) != 0) {
689 DPRINTFN(1, ("ugenread: start transfer %d bytes\n",n));
691 err = usbd_bulk_transfer(
693 sce->state & UGEN_SHORT_OK ?
694 USBD_SHORT_XFER_OK : 0,
695 sce->timeout, buf, &tn, "ugenrb");
697 if (err == USBD_INTERRUPTED)
699 else if (err == USBD_TIMEOUT)
705 DPRINTFN(1, ("ugenread: got %d bytes\n", tn));
706 error = uiomove(buf, tn, uio);
710 usbd_free_xfer(xfer);
714 while (sce->cur == sce->fill) {
715 if (flag & IO_NDELAY) {
720 sce->state |= UGEN_ASLP;
721 DPRINTFN(5, ("ugenread: sleep on %p\n", sce));
722 error = tsleep(sce, PCATCH, "ugenri",
723 (sce->timeout * hz + 999) / 1000);
724 sce->state &= ~UGEN_ASLP;
725 DPRINTFN(5, ("ugenread: woke, error=%d\n", error));
728 if (error == EAGAIN) {
729 error = 0; /* timeout, return 0 bytes */
736 while (sce->cur != sce->fill && uio->uio_resid > 0 && !error) {
737 if (sce->fill > sce->cur)
738 n = min(sce->fill - sce->cur, uio->uio_resid);
740 n = min(sce->limit - sce->cur, uio->uio_resid);
742 DPRINTFN(5, ("ugenread: isoc got %d chars\n", n));
744 /* Copy the data to the user process. */
745 error = uiomove(sce->cur, n, uio);
749 if(sce->cur >= sce->limit)
750 sce->cur = sce->ibuf;
761 relugenbuf(buf, ugen_bbsize);
766 ugenread(struct dev_read_args *ap)
768 cdev_t dev = ap->a_head.a_dev;
769 int endpt = UGENENDPOINT(dev);
770 struct ugen_softc *sc;
773 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
779 error = ugen_do_read(sc, endpt, ap->a_uio, ap->a_ioflag);
780 if (--sc->sc_refcnt < 0)
781 usb_detach_wakeup(sc->sc_dev);
786 ugen_do_write(struct ugen_softc *sc, int endpt, struct uio *uio, int flag)
788 struct ugen_endpoint *sce = &sc->sc_endpoints[endpt][OUT];
793 usbd_xfer_handle xfer;
796 DPRINTFN(5, ("%s: ugenwrite: %d\n", device_get_nameunit(sc->sc_dev), endpt));
801 if (endpt == USB_CONTROL_ENDPOINT)
805 if (sce->edesc == NULL) {
806 kprintf("ugenwrite: no edesc\n");
809 if (sce->pipeh == NULL) {
810 kprintf("ugenwrite: no pipe\n");
815 buf = getugenbuf(ugen_bufsize, &ugen_bbsize);
817 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
819 xfer = usbd_alloc_xfer(sc->sc_udev);
824 while ((n = min(ugen_bbsize, uio->uio_resid)) != 0) {
825 error = uiomove(buf, n, uio);
828 DPRINTFN(1, ("ugenwrite: transfer %d bytes\n", n));
829 err = usbd_bulk_transfer(xfer, sce->pipeh, 0,
830 sce->timeout, buf, &n,"ugenwb");
832 if (err == USBD_INTERRUPTED)
834 else if (err == USBD_TIMEOUT)
841 usbd_free_xfer(xfer);
844 xfer = usbd_alloc_xfer(sc->sc_udev);
849 while ((n = min(UGETW(sce->edesc->wMaxPacketSize),
850 uio->uio_resid)) != 0) {
851 error = uiomove(buf, n, uio);
854 DPRINTFN(1, ("ugenwrite: transfer %d bytes\n", n));
855 err = usbd_intr_transfer(xfer, sce->pipeh, 0,
856 sce->timeout, buf, &n,"ugenwi");
858 if (err == USBD_INTERRUPTED)
860 else if (err == USBD_TIMEOUT)
867 usbd_free_xfer(xfer);
874 relugenbuf(buf, ugen_bbsize);
879 ugenwrite(struct dev_write_args *ap)
881 cdev_t dev = ap->a_head.a_dev;
882 int endpt = UGENENDPOINT(dev);
883 struct ugen_softc *sc;
886 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
892 error = ugen_do_write(sc, endpt, ap->a_uio, ap->a_ioflag);
893 if (--sc->sc_refcnt < 0)
894 usb_detach_wakeup(sc->sc_dev);
899 ugen_detach(device_t self)
901 struct ugen_softc *sc = device_get_softc(self);
902 struct ugen_endpoint *sce;
905 DPRINTF(("ugen_detach: sc=%p\n", sc));
908 /* Abort all pipes. Causes processes waiting for transfer to wake. */
909 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
910 for (dir = OUT; dir <= IN; dir++) {
911 sce = &sc->sc_endpoints[i][dir];
912 if (sce && sce->pipeh)
913 usbd_abort_pipe(sce->pipeh);
914 selwakeup(&sce->rsel);
918 if (--sc->sc_refcnt >= 0) {
920 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
921 wakeup(&sc->sc_endpoints[i][IN]);
922 /* Wait for processes to go away. */
923 usb_detach_wait(sc->sc_dev);
927 /* destroy the device for the control endpoint */
928 ugen_destroy_devnodes(sc);
929 kprintf("devfs: Please check that only the right ugen devices were removed !!!\n");
930 dev_ops_remove_minor(&ugen_ops,
931 /*UGENUNITMASK,*/ UGENMINOR(device_get_unit(sc->sc_dev), 0));
932 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
937 ugenintr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
939 struct ugen_endpoint *sce = addr;
940 /*struct ugen_softc *sc = sce->sc;*/
944 if (status == USBD_CANCELLED)
947 if (status != USBD_NORMAL_COMPLETION) {
948 DPRINTF(("ugenintr: status=%d\n", status));
949 if (status == USBD_STALLED)
950 usbd_clear_endpoint_stall_async(sce->pipeh);
954 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
957 DPRINTFN(5, ("ugenintr: xfer=%p status=%d count=%d\n",
958 xfer, status, count));
959 DPRINTFN(5, (" data = %02x %02x %02x\n",
960 ibuf[0], ibuf[1], ibuf[2]));
962 (void)b_to_q(ibuf, count, &sce->q);
964 if (sce->state & UGEN_ASLP) {
965 sce->state &= ~UGEN_ASLP;
966 DPRINTFN(5, ("ugen_intr: waking %p\n", sce));
969 selwakeup(&sce->rsel);
973 ugen_isoc_rintr(usbd_xfer_handle xfer, usbd_private_handle addr,
976 struct isoreq *req = addr;
977 struct ugen_endpoint *sce = req->sce;
981 /* Return if we are aborting. */
982 if (status == USBD_CANCELLED)
985 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
986 DPRINTFN(5,("ugen_isoc_rintr: xfer %d, count=%d\n",
987 (int)(req - sce->isoreqs),
990 /* throw away oldest input if the buffer is full */
991 if(sce->fill < sce->cur && sce->cur <= sce->fill + count) {
993 if(sce->cur >= sce->limit)
994 sce->cur = sce->ibuf + (sce->limit - sce->cur);
995 DPRINTFN(5, ("ugen_isoc_rintr: throwing away %d bytes\n",
999 isize = UGETW(sce->edesc->wMaxPacketSize);
1000 for (i = 0; i < UGEN_NISORFRMS; i++) {
1001 u_int32_t actlen = req->sizes[i];
1002 char const *buf = (char const *)req->dmabuf + isize * i;
1004 /* copy data to buffer */
1005 while (actlen > 0) {
1006 n = min(actlen, sce->limit - sce->fill);
1007 memcpy(sce->fill, buf, n);
1012 if(sce->fill == sce->limit)
1013 sce->fill = sce->ibuf;
1016 /* setup size for next transfer */
1017 req->sizes[i] = isize;
1020 usbd_setup_isoc_xfer(xfer, sce->pipeh, req, req->sizes, UGEN_NISORFRMS,
1021 USBD_NO_COPY, ugen_isoc_rintr);
1022 (void)usbd_transfer(xfer);
1024 if (sce->state & UGEN_ASLP) {
1025 sce->state &= ~UGEN_ASLP;
1026 DPRINTFN(5, ("ugen_isoc_rintr: waking %p\n", sce));
1029 selwakeup(&sce->rsel);
1033 ugen_set_interface(struct ugen_softc *sc, int ifaceidx, int altno)
1035 usbd_interface_handle iface;
1036 usb_endpoint_descriptor_t *ed;
1038 struct ugen_endpoint *sce;
1039 u_int8_t niface, nendpt, endptno, endpt;
1042 DPRINTFN(15, ("ugen_set_interface %d %d\n", ifaceidx, altno));
1044 err = usbd_interface_count(sc->sc_udev, &niface);
1047 if (ifaceidx < 0 || ifaceidx >= niface)
1048 return (USBD_INVAL);
1050 err = usbd_device2interface_handle(sc->sc_udev, ifaceidx, &iface);
1053 err = usbd_endpoint_count(iface, &nendpt);
1057 /* destroy the existing devices, we remake the new ones in a moment */
1058 ugen_destroy_devnodes(sc);
1060 /* XXX should only do this after setting new altno has succeeded */
1061 for (endptno = 0; endptno < nendpt; endptno++) {
1062 ed = usbd_interface2endpoint_descriptor(iface,endptno);
1063 endpt = ed->bEndpointAddress;
1064 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
1065 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
1071 /* change setting */
1072 err = usbd_set_interface(iface, altno);
1076 err = usbd_endpoint_count(iface, &nendpt);
1079 for (endptno = 0; endptno < nendpt; endptno++) {
1080 ed = usbd_interface2endpoint_descriptor(iface,endptno);
1081 endpt = ed->bEndpointAddress;
1082 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
1083 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
1089 /* make the new devices */
1090 ugen_make_devnodes(sc);
1095 /* Retrieve a complete descriptor for a certain device and index. */
1096 static usb_config_descriptor_t *
1097 ugen_get_cdesc(struct ugen_softc *sc, int index, int *lenp)
1099 usb_config_descriptor_t *cdesc, *tdesc, cdescr;
1103 if (index == USB_CURRENT_CONFIG_INDEX) {
1104 tdesc = usbd_get_config_descriptor(sc->sc_udev);
1105 len = UGETW(tdesc->wTotalLength);
1108 cdesc = kmalloc(len, M_TEMP, M_INTWAIT);
1109 memcpy(cdesc, tdesc, len);
1110 DPRINTFN(5,("ugen_get_cdesc: current, len=%d\n", len));
1112 err = usbd_get_config_desc(sc->sc_udev, index, &cdescr);
1115 len = UGETW(cdescr.wTotalLength);
1116 DPRINTFN(5,("ugen_get_cdesc: index=%d, len=%d\n", index, len));
1119 cdesc = kmalloc(len, M_TEMP, M_INTWAIT);
1120 err = usbd_get_config_desc_full(sc->sc_udev, index, cdesc, len);
1122 kfree(cdesc, M_TEMP);
1130 ugen_get_alt_index(struct ugen_softc *sc, int ifaceidx)
1132 usbd_interface_handle iface;
1135 err = usbd_device2interface_handle(sc->sc_udev, ifaceidx, &iface);
1138 return (usbd_get_interface_altindex(iface));
1142 ugen_do_ioctl(struct ugen_softc *sc, int endpt, u_long cmd,
1143 caddr_t addr, int flag)
1145 struct ugen_endpoint *sce;
1147 usbd_interface_handle iface;
1148 struct usb_config_desc *cd;
1149 usb_config_descriptor_t *cdesc;
1150 struct usb_interface_desc *id;
1151 usb_interface_descriptor_t *idesc;
1152 struct usb_endpoint_desc *ed;
1153 usb_endpoint_descriptor_t *edesc;
1154 struct usb_alt_interface *ai;
1155 struct usb_string_desc *si;
1158 DPRINTFN(5, ("ugenioctl: cmd=%08lx\n", cmd));
1163 case USB_SET_SHORT_XFER:
1164 /* This flag only affects read */
1165 if (endpt == USB_CONTROL_ENDPOINT)
1167 sce = &sc->sc_endpoints[endpt][IN];
1169 if (sce->pipeh == NULL) {
1170 kprintf("ugenioctl: USB_SET_SHORT_XFER, no pipe\n");
1175 sce->state |= UGEN_SHORT_OK;
1177 sce->state &= ~UGEN_SHORT_OK;
1179 case USB_SET_TIMEOUT:
1180 sce = &sc->sc_endpoints[endpt][IN];
1181 sce->timeout = *(int *)addr;
1182 sce = &sc->sc_endpoints[endpt][OUT];
1183 sce->timeout = *(int *)addr;
1189 if (endpt != USB_CONTROL_ENDPOINT)
1195 ugendebug = *(int *)addr;
1198 case USB_GET_CONFIG:
1199 err = usbd_get_config(sc->sc_udev, &conf);
1202 *(int *)addr = conf;
1204 case USB_SET_CONFIG:
1205 if (!(flag & FWRITE))
1207 err = ugen_set_config(sc, *(int *)addr);
1209 case USBD_NORMAL_COMPLETION:
1217 case USB_GET_ALTINTERFACE:
1218 ai = (struct usb_alt_interface *)addr;
1219 err = usbd_device2interface_handle(sc->sc_udev,
1220 ai->uai_interface_index, &iface);
1223 idesc = usbd_get_interface_descriptor(iface);
1226 ai->uai_alt_no = idesc->bAlternateSetting;
1228 case USB_SET_ALTINTERFACE:
1229 if (!(flag & FWRITE))
1231 ai = (struct usb_alt_interface *)addr;
1232 err = usbd_device2interface_handle(sc->sc_udev,
1233 ai->uai_interface_index, &iface);
1236 err = ugen_set_interface(sc, ai->uai_interface_index, ai->uai_alt_no);
1240 case USB_GET_NO_ALT:
1241 ai = (struct usb_alt_interface *)addr;
1242 cdesc = ugen_get_cdesc(sc, ai->uai_config_index, 0);
1245 idesc = usbd_find_idesc(cdesc, ai->uai_interface_index, 0);
1246 if (idesc == NULL) {
1247 kfree(cdesc, M_TEMP);
1250 ai->uai_alt_no = usbd_get_no_alts(cdesc, idesc->bInterfaceNumber);
1251 kfree(cdesc, M_TEMP);
1253 case USB_GET_DEVICE_DESC:
1254 *(usb_device_descriptor_t *)addr =
1255 *usbd_get_device_descriptor(sc->sc_udev);
1257 case USB_GET_CONFIG_DESC:
1258 cd = (struct usb_config_desc *)addr;
1259 cdesc = ugen_get_cdesc(sc, cd->ucd_config_index, 0);
1262 cd->ucd_desc = *cdesc;
1263 kfree(cdesc, M_TEMP);
1265 case USB_GET_INTERFACE_DESC:
1266 id = (struct usb_interface_desc *)addr;
1267 cdesc = ugen_get_cdesc(sc, id->uid_config_index, 0);
1270 if (id->uid_config_index == USB_CURRENT_CONFIG_INDEX &&
1271 id->uid_alt_index == USB_CURRENT_ALT_INDEX)
1272 alt = ugen_get_alt_index(sc, id->uid_interface_index);
1274 alt = id->uid_alt_index;
1275 idesc = usbd_find_idesc(cdesc, id->uid_interface_index, alt);
1276 if (idesc == NULL) {
1277 kfree(cdesc, M_TEMP);
1280 id->uid_desc = *idesc;
1281 kfree(cdesc, M_TEMP);
1283 case USB_GET_ENDPOINT_DESC:
1284 ed = (struct usb_endpoint_desc *)addr;
1285 cdesc = ugen_get_cdesc(sc, ed->ued_config_index, 0);
1288 if (ed->ued_config_index == USB_CURRENT_CONFIG_INDEX &&
1289 ed->ued_alt_index == USB_CURRENT_ALT_INDEX)
1290 alt = ugen_get_alt_index(sc, ed->ued_interface_index);
1292 alt = ed->ued_alt_index;
1293 edesc = usbd_find_edesc(cdesc, ed->ued_interface_index,
1294 alt, ed->ued_endpoint_index);
1295 if (edesc == NULL) {
1296 kfree(cdesc, M_TEMP);
1299 ed->ued_desc = *edesc;
1300 kfree(cdesc, M_TEMP);
1302 case USB_GET_FULL_DESC:
1307 struct usb_full_desc *fd = (struct usb_full_desc *)addr;
1310 cdesc = ugen_get_cdesc(sc, fd->ufd_config_index, &len);
1311 if (len > fd->ufd_size)
1313 iov.iov_base = (caddr_t)fd->ufd_data;
1317 uio.uio_resid = len;
1319 uio.uio_segflg = UIO_USERSPACE;
1320 uio.uio_rw = UIO_READ;
1321 uio.uio_td = curthread;
1322 error = uiomove((void *)cdesc, len, &uio);
1323 kfree(cdesc, M_TEMP);
1326 case USB_GET_STRING_DESC:
1330 si = (struct usb_string_desc *)addr;
1331 err = usbd_get_string_desc(sc->sc_udev, si->usd_string_index,
1332 si->usd_language_id, &si->usd_desc, &size);
1337 case USB_DO_REQUEST:
1339 struct usb_ctl_request *ur = (void *)addr;
1340 int len = UGETW(ur->ucr_request.wLength);
1347 if (!(flag & FWRITE))
1349 /* Avoid requests that would damage the bus integrity. */
1350 if ((ur->ucr_request.bmRequestType == UT_WRITE_DEVICE &&
1351 ur->ucr_request.bRequest == UR_SET_ADDRESS) ||
1352 (ur->ucr_request.bmRequestType == UT_WRITE_DEVICE &&
1353 ur->ucr_request.bRequest == UR_SET_CONFIG) ||
1354 (ur->ucr_request.bmRequestType == UT_WRITE_INTERFACE &&
1355 ur->ucr_request.bRequest == UR_SET_INTERFACE))
1358 if (len < 0 || len > 32767)
1361 iov.iov_base = (caddr_t)ur->ucr_data;
1365 uio.uio_resid = len;
1367 uio.uio_segflg = UIO_USERSPACE;
1369 ur->ucr_request.bmRequestType & UT_READ ?
1370 UIO_READ : UIO_WRITE;
1371 uio.uio_td = curthread;
1372 ptr = kmalloc(len, M_TEMP, M_WAITOK);
1373 if (uio.uio_rw == UIO_WRITE) {
1374 error = uiomove(ptr, len, &uio);
1379 sce = &sc->sc_endpoints[endpt][IN];
1380 err = usbd_do_request_flags(sc->sc_udev, &ur->ucr_request,
1381 ptr, ur->ucr_flags, &ur->ucr_actlen, sce->timeout);
1387 if (uio.uio_rw == UIO_READ) {
1388 error = uiomove(ptr, len, &uio);
1398 case USB_GET_DEVICEINFO:
1399 usbd_fill_deviceinfo(sc->sc_udev,
1400 (struct usb_device_info *)addr, 1);
1409 ugenioctl(struct dev_ioctl_args *ap)
1411 cdev_t dev = ap->a_head.a_dev;
1412 int endpt = UGENENDPOINT(dev);
1413 struct ugen_softc *sc;
1416 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
1421 error = ugen_do_ioctl(sc, endpt, ap->a_cmd, ap->a_data, ap->a_fflag);
1422 if (--sc->sc_refcnt < 0)
1423 usb_detach_wakeup(sc->sc_dev);
1428 ugenpoll(struct dev_poll_args *ap)
1430 cdev_t dev = ap->a_head.a_dev;
1431 struct ugen_softc *sc;
1432 struct ugen_endpoint *sce_in, *sce_out;
1433 usb_endpoint_descriptor_t *edesc;
1436 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
1439 return ((ap->a_events & (POLLIN | POLLOUT | POLLRDNORM |
1440 POLLWRNORM)) | POLLHUP);
1443 /* Do not allow to poll a control endpoint */
1444 if (UGENENDPOINT(dev) == USB_CONTROL_ENDPOINT) {
1445 return (ap->a_events & (POLLIN | POLLOUT | POLLRDNORM |
1449 sce_in = &sc->sc_endpoints[UGENENDPOINT(dev)][IN];
1450 sce_out = &sc->sc_endpoints[UGENENDPOINT(dev)][OUT];
1451 edesc = (sce_in->edesc != NULL) ? sce_in->edesc : sce_out->edesc;
1452 KASSERT(edesc != NULL, ("ugenpoll: NULL edesc"));
1454 if (sce_in->edesc == NULL || sce_in->pipeh == NULL)
1456 if (sce_out->edesc == NULL || sce_out->pipeh == NULL)
1460 switch (edesc->bmAttributes & UE_XFERTYPE) {
1462 if (sce_in != NULL && (ap->a_events & (POLLIN | POLLRDNORM))) {
1463 if (sce_in->q.c_cc > 0)
1464 revents |= ap->a_events & (POLLIN | POLLRDNORM);
1466 selrecord(curthread, &sce_in->rsel);
1468 if (sce_out != NULL && (ap->a_events & (POLLOUT | POLLWRNORM))) {
1469 if (sce_out->q.c_cc > 0)
1470 revents |= ap->a_events & (POLLOUT | POLLWRNORM);
1472 selrecord(curthread, &sce_out->rsel);
1475 case UE_ISOCHRONOUS:
1476 if (sce_in != NULL && (ap->a_events & (POLLIN | POLLRDNORM))) {
1477 if (sce_in->cur != sce_in->fill)
1478 revents |= ap->a_events & (POLLIN | POLLRDNORM);
1480 selrecord(curthread, &sce_in->rsel);
1482 if (sce_out != NULL && (ap->a_events & (POLLOUT | POLLWRNORM))) {
1483 if (sce_out->cur != sce_out->fill)
1484 revents |= ap->a_events & (POLLOUT | POLLWRNORM);
1486 selrecord(curthread, &sce_out->rsel);
1491 * We have no easy way of determining if a read will
1492 * yield any data or a write will happen.
1493 * Pretend they will.
1495 revents |= ap->a_events &
1496 (POLLIN | POLLRDNORM | POLLOUT | POLLWRNORM);
1502 ap->a_events = revents;
1506 DRIVER_MODULE(ugen, uhub, ugen_driver, ugen_devclass, usbd_driver_load, 0);