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.29 2007/07/01 21:24:03 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>
59 #include <sys/ioccom.h>
61 #include <sys/fcntl.h>
62 #include <sys/filio.h>
65 #include <sys/select.h>
66 #include <sys/vnode.h>
68 #include <sys/sysctl.h>
69 #include <sys/thread2.h>
71 #include <bus/usb/usb.h>
72 #include <bus/usb/usbdi.h>
73 #include <bus/usb/usbdi_util.h>
77 SYSCTL_NODE(_hw_usb, OID_AUTO, ugen, CTLFLAG_RW, 0, "USB ugen");
80 #define DPRINTF(x) if (ugendebug) kprintf x
81 #define DPRINTFN(n,x) if (ugendebug>(n)) kprintf x
83 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, debug, CTLFLAG_RW,
84 &ugendebug, 0, "ugen debug level");
90 static int ugen_bufsize = 16384;
91 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, bufsize, CTLFLAG_RW,
92 &ugen_bufsize, 0, "ugen temporary buffer size");
94 #define UGEN_CHUNK 128 /* chunk size for read */
95 #define UGEN_IBSIZE 1020 /* buffer size */
97 #define UGEN_NISOFRAMES 500 /* 0.5 seconds worth */
98 #define UGEN_NISOREQS 6 /* number of outstanding xfer requests */
99 #define UGEN_NISORFRMS 4 /* number of frames (miliseconds) per req */
101 struct ugen_endpoint {
102 struct ugen_softc *sc;
104 usb_endpoint_descriptor_t *edesc;
105 usbd_interface_handle iface;
107 #define UGEN_ASLP 0x02 /* waiting for data */
108 #define UGEN_SHORT_OK 0x04 /* short xfers are OK */
109 usbd_pipe_handle pipeh;
112 u_char *ibuf; /* start of buffer (circular for isoc) */
113 u_char *fill; /* location for input (isoc) */
114 u_char *limit; /* end of circular buffer (isoc) */
115 u_char *cur; /* current read location (isoc) */
118 struct ugen_endpoint *sce;
119 usbd_xfer_handle xfer;
121 u_int16_t sizes[UGEN_NISORFRMS];
122 } isoreqs[UGEN_NISOREQS];
126 device_t sc_dev; /* base device */
127 usbd_device_handle sc_udev;
129 char sc_is_open[USB_MAX_ENDPOINTS];
130 struct ugen_endpoint sc_endpoints[USB_MAX_ENDPOINTS][2];
145 #define UGEN_CDEV_MAJOR 114
147 static struct dev_ops ugen_ops = {
148 { "ugen", UGEN_CDEV_MAJOR, 0 },
150 .d_close = ugenclose,
152 .d_write = ugenwrite,
153 .d_ioctl = ugenioctl,
157 static void ugenintr(usbd_xfer_handle xfer, usbd_private_handle addr,
159 static void ugen_isoc_rintr(usbd_xfer_handle xfer, usbd_private_handle addr,
161 static int ugen_do_read(struct ugen_softc *, int, struct uio *, int);
162 static int ugen_do_write(struct ugen_softc *, int, struct uio *, int);
163 static int ugen_do_ioctl(struct ugen_softc *, int, u_long,
165 static void ugen_make_devnodes(struct ugen_softc *sc);
166 static void ugen_destroy_devnodes(struct ugen_softc *sc);
167 static int ugen_set_config(struct ugen_softc *sc, int configno);
168 static usb_config_descriptor_t *ugen_get_cdesc(struct ugen_softc *sc,
169 int index, int *lenp);
170 static usbd_status ugen_set_interface(struct ugen_softc *, int, int);
171 static int ugen_get_alt_index(struct ugen_softc *sc, int ifaceidx);
173 #define UGENUNIT(n) ((lminor(n) >> 4) & 0xff)
174 #define UGENENDPOINT(n) (minor(n) & 0xf)
175 #define UGENMINOR(u, e) (((u & 0xf) << 4) | ((u & 0xf0) << 12) | (e))
176 #define UGENUNITMASK 0xffff00f0
178 USB_DECLARE_DRIVER(ugen);
181 ugen_match(device_t self)
183 struct usb_attach_arg *uaa = device_get_ivars(self);
187 return (uaa->matchlvl);
190 return (UMATCH_GENERIC);
192 return (UMATCH_NONE);
196 ugen_attach(device_t self)
198 struct ugen_softc *sc = device_get_softc(self);
199 struct usb_attach_arg *uaa = device_get_ivars(self);
200 usbd_device_handle udev;
205 usbd_devinfo(uaa->device, 0, devinfo);
207 device_set_desc_copy(self, devinfo);
208 kprintf("%s: %s\n", device_get_nameunit(sc->sc_dev), devinfo);
210 sc->sc_udev = udev = uaa->device;
212 memset(sc->sc_endpoints, 0, sizeof sc->sc_endpoints);
214 /* First set configuration index 0, the default one for ugen. */
215 err = usbd_set_config_index(udev, 0, 0);
217 kprintf("%s: setting configuration index 0 failed\n",
218 device_get_nameunit(sc->sc_dev));
222 conf = usbd_get_config_descriptor(udev)->bConfigurationValue;
224 /* Set up all the local state for this configuration. */
225 err = ugen_set_config(sc, conf);
227 kprintf("%s: setting configuration %d failed\n",
228 device_get_nameunit(sc->sc_dev), conf);
233 /* the main device, ctrl endpoint */
234 dev_ops_add(&ugen_ops,
235 UGENUNITMASK, UGENMINOR(device_get_unit(sc->sc_dev), 0));
236 make_dev(&ugen_ops, UGENMINOR(device_get_unit(sc->sc_dev), 0),
237 UID_ROOT, GID_OPERATOR, 0644, "%s", device_get_nameunit(sc->sc_dev));
243 ugen_make_devnodes(struct ugen_softc *sc)
248 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
249 if (sc->sc_endpoints[endptno][IN].sc != NULL ||
250 sc->sc_endpoints[endptno][OUT].sc != NULL ) {
251 /* endpt can be 0x81 and 0x01, representing
252 * endpoint address 0x01 and IN/OUT directions.
253 * We map both endpts to the same device,
254 * IN is reading from it, OUT is writing to it.
256 * In the if clause above we check whether one
257 * of the structs is populated.
259 dev = make_dev(&ugen_ops,
260 UGENMINOR(device_get_unit(sc->sc_dev), endptno),
261 UID_ROOT, GID_OPERATOR, 0644,
263 device_get_nameunit(sc->sc_dev), endptno);
264 if (sc->sc_endpoints[endptno][IN].sc != NULL) {
266 if (sc->sc_endpoints[endptno][IN].dev)
267 release_dev(sc->sc_endpoints[endptno][IN].dev);
268 sc->sc_endpoints[endptno][IN].dev = dev;
270 if (sc->sc_endpoints[endptno][OUT].sc != NULL) {
272 if (sc->sc_endpoints[endptno][OUT].dev)
273 release_dev(sc->sc_endpoints[endptno][OUT].dev);
274 sc->sc_endpoints[endptno][OUT].dev = dev;
281 ugen_destroy_devnodes(struct ugen_softc *sc)
286 /* destroy all devices for the other (existing) endpoints as well */
287 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
288 if (sc->sc_endpoints[endptno][IN].sc != NULL ||
289 sc->sc_endpoints[endptno][OUT].sc != NULL ) {
290 /* endpt can be 0x81 and 0x01, representing
291 * endpoint address 0x01 and IN/OUT directions.
292 * We map both endpoint addresses to the same device,
293 * IN is reading from it, OUT is writing to it.
295 * In the if clause above we check whether one
296 * of the structs is populated.
298 dev = sc->sc_endpoints[endptno][IN].dev;
301 sc->sc_endpoints[endptno][IN].dev = NULL;
303 dev = sc->sc_endpoints[endptno][OUT].dev;
306 sc->sc_endpoints[endptno][OUT].dev = NULL;
313 ugen_set_config(struct ugen_softc *sc, int configno)
315 usbd_device_handle dev = sc->sc_udev;
316 usbd_interface_handle iface;
317 usb_endpoint_descriptor_t *ed;
318 struct ugen_endpoint *sce;
319 u_int8_t niface, nendpt;
320 int ifaceno, endptno, endpt;
324 DPRINTFN(1,("ugen_set_config: %s to configno %d, sc=%p\n",
325 device_get_nameunit(sc->sc_dev), configno, sc));
327 ugen_destroy_devnodes(sc);
329 /* We start at 1, not 0, because we don't care whether the
330 * control endpoint is open or not. It is always present.
332 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
333 if (sc->sc_is_open[endptno]) {
335 ("ugen_set_config: %s - endpoint %d is open\n",
336 device_get_nameunit(sc->sc_dev), endptno));
337 return (USBD_IN_USE);
341 /* Avoid setting the current value. */
342 if (usbd_get_config_descriptor(dev)->bConfigurationValue != configno) {
343 err = usbd_set_config_no(dev, configno, 1);
348 err = usbd_interface_count(dev, &niface);
351 memset(sc->sc_endpoints, 0, sizeof sc->sc_endpoints);
352 for (ifaceno = 0; ifaceno < niface; ifaceno++) {
353 DPRINTFN(1,("ugen_set_config: ifaceno %d\n", ifaceno));
354 err = usbd_device2interface_handle(dev, ifaceno, &iface);
357 err = usbd_endpoint_count(iface, &nendpt);
360 for (endptno = 0; endptno < nendpt; endptno++) {
361 ed = usbd_interface2endpoint_descriptor(iface,endptno);
362 endpt = ed->bEndpointAddress;
363 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
364 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
365 DPRINTFN(1,("ugen_set_config: endptno %d, endpt=0x%02x"
367 endptno, endpt, UE_GET_ADDR(endpt),
368 UE_GET_DIR(endpt), sce));
375 ugen_make_devnodes(sc);
377 return (USBD_NORMAL_COMPLETION);
381 ugenopen(struct dev_open_args *ap)
383 cdev_t dev = ap->a_head.a_dev;
384 struct ugen_softc *sc;
385 int unit = UGENUNIT(dev);
386 int endpt = UGENENDPOINT(dev);
387 usb_endpoint_descriptor_t *edesc;
388 struct ugen_endpoint *sce;
391 usbd_xfer_handle xfer;
395 USB_GET_SC_OPEN(ugen, unit, sc);
397 DPRINTFN(5, ("ugenopen: flag=%d, mode=%d, unit=%d endpt=%d\n",
398 ap->a_oflags, ap->a_devtype, unit, endpt));
400 if (sc == NULL || sc->sc_dying)
403 if (sc->sc_is_open[endpt])
406 if (endpt == USB_CONTROL_ENDPOINT) {
407 sc->sc_is_open[USB_CONTROL_ENDPOINT] = 1;
411 /* Make sure there are pipes for all directions. */
412 for (dir = OUT; dir <= IN; dir++) {
413 if (ap->a_oflags & (dir == OUT ? FWRITE : FREAD)) {
414 sce = &sc->sc_endpoints[endpt][dir];
415 if (sce == 0 || sce->edesc == 0)
420 /* Actually open the pipes. */
421 /* XXX Should back out properly if it fails. */
422 for (dir = OUT; dir <= IN; dir++) {
423 if (!(ap->a_oflags & (dir == OUT ? FWRITE : FREAD)))
425 sce = &sc->sc_endpoints[endpt][dir];
427 sce->timeout = USBD_NO_TIMEOUT;
428 DPRINTFN(5, ("ugenopen: sc=%p, endpt=%d, dir=%d, sce=%p\n",
429 sc, endpt, dir, sce));
431 switch (edesc->bmAttributes & UE_XFERTYPE) {
434 err = usbd_open_pipe(sce->iface,
435 edesc->bEndpointAddress, 0, &sce->pipeh);
440 isize = UGETW(edesc->wMaxPacketSize);
441 if (isize == 0) /* shouldn't happen */
443 sce->ibuf = kmalloc(isize, M_USBDEV, M_WAITOK);
444 DPRINTFN(5, ("ugenopen: intr endpt=%d,isize=%d\n",
446 if (clalloc(&sce->q, UGEN_IBSIZE, 0) == -1)
448 err = usbd_open_pipe_intr(sce->iface,
449 edesc->bEndpointAddress,
450 USBD_SHORT_XFER_OK, &sce->pipeh, sce,
451 sce->ibuf, isize, ugenintr,
452 USBD_DEFAULT_INTERVAL);
454 kfree(sce->ibuf, M_USBDEV);
458 DPRINTFN(5, ("ugenopen: interrupt open done\n"));
461 err = usbd_open_pipe(sce->iface,
462 edesc->bEndpointAddress, 0, &sce->pipeh);
469 isize = UGETW(edesc->wMaxPacketSize);
470 if (isize == 0) /* shouldn't happen */
472 sce->ibuf = kmalloc(isize * UGEN_NISOFRAMES,
474 sce->cur = sce->fill = sce->ibuf;
475 sce->limit = sce->ibuf + isize * UGEN_NISOFRAMES;
476 DPRINTFN(5, ("ugenopen: isoc endpt=%d, isize=%d\n",
478 err = usbd_open_pipe(sce->iface,
479 edesc->bEndpointAddress, 0, &sce->pipeh);
481 kfree(sce->ibuf, M_USBDEV);
484 for(i = 0; i < UGEN_NISOREQS; ++i) {
485 sce->isoreqs[i].sce = sce;
486 xfer = usbd_alloc_xfer(sc->sc_udev);
489 sce->isoreqs[i].xfer = xfer;
490 buf = usbd_alloc_buffer
491 (xfer, isize * UGEN_NISORFRMS);
496 sce->isoreqs[i].dmabuf = buf;
497 for(j = 0; j < UGEN_NISORFRMS; ++j)
498 sce->isoreqs[i].sizes[j] = isize;
500 (xfer, sce->pipeh, &sce->isoreqs[i],
501 sce->isoreqs[i].sizes,
502 UGEN_NISORFRMS, USBD_NO_COPY,
504 (void)usbd_transfer(xfer);
506 DPRINTFN(5, ("ugenopen: isoc open done\n"));
509 while (--i >= 0) /* implicit buffer free */
510 usbd_free_xfer(sce->isoreqs[i].xfer);
513 sce->timeout = USBD_DEFAULT_TIMEOUT;
517 sc->sc_is_open[endpt] = 1;
522 ugenclose(struct dev_close_args *ap)
524 cdev_t dev = ap->a_head.a_dev;
525 int endpt = UGENENDPOINT(dev);
526 struct ugen_softc *sc;
527 struct ugen_endpoint *sce;
531 USB_GET_SC(ugen, UGENUNIT(dev), sc);
533 DPRINTFN(5, ("ugenclose: flag=%d, mode=%d, unit=%d, endpt=%d\n",
534 ap->a_fflag, ap->a_devtype, UGENUNIT(dev), endpt));
537 if (!sc->sc_is_open[endpt]) {
538 kprintf("ugenclose: not open\n");
543 if (endpt == USB_CONTROL_ENDPOINT) {
544 DPRINTFN(5, ("ugenclose: close control\n"));
545 sc->sc_is_open[endpt] = 0;
549 for (dir = OUT; dir <= IN; dir++) {
550 if (!(ap->a_fflag & (dir == OUT ? FWRITE : FREAD)))
552 sce = &sc->sc_endpoints[endpt][dir];
553 if (sce == NULL || sce->pipeh == NULL)
555 DPRINTFN(5, ("ugenclose: endpt=%d dir=%d sce=%p\n",
558 usbd_abort_pipe(sce->pipeh);
559 usbd_close_pipe(sce->pipeh);
562 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
564 ndflush(&sce->q, sce->q.c_cc);
568 for (i = 0; i < UGEN_NISOREQS; ++i)
569 usbd_free_xfer(sce->isoreqs[i].xfer);
574 if (sce->ibuf != NULL) {
575 kfree(sce->ibuf, M_USBDEV);
580 sc->sc_is_open[endpt] = 0;
586 ugen_do_read(struct ugen_softc *sc, int endpt, struct uio *uio, int flag)
588 struct ugen_endpoint *sce = &sc->sc_endpoints[endpt][IN];
591 usbd_xfer_handle xfer;
595 u_char buffer[UGEN_CHUNK];
597 DPRINTFN(5, ("%s: ugenread: %d\n", device_get_nameunit(sc->sc_dev), endpt));
602 if (endpt == USB_CONTROL_ENDPOINT)
608 if (sce->edesc == NULL) {
609 kprintf("ugenread: no edesc\n");
612 if (sce->pipeh == NULL) {
613 kprintf("ugenread: no pipe\n");
617 buf = getugenbuf(ugen_bufsize, &ugen_bbsize);
619 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
621 /* Block until activity occurred. */
623 while (sce->q.c_cc == 0) {
624 if (flag & IO_NDELAY) {
629 sce->state |= UGEN_ASLP;
630 DPRINTFN(5, ("ugenread: sleep on %p\n", sce));
631 error = tsleep(sce, PCATCH, "ugenri", 0);
632 DPRINTFN(5, ("ugenread: woke, error=%d\n", error));
636 sce->state &= ~UGEN_ASLP;
642 /* Transfer as many chunks as possible. */
643 while (sce->q.c_cc > 0 && uio->uio_resid > 0 && !error) {
644 n = min(sce->q.c_cc, uio->uio_resid);
645 if (n > sizeof(buffer))
648 /* Remove a small chunk from the input queue. */
649 q_to_b(&sce->q, buffer, n);
650 DPRINTFN(5, ("ugenread: got %d chars\n", n));
652 /* Copy the data to the user process. */
653 error = uiomove(buffer, n, uio);
659 xfer = usbd_alloc_xfer(sc->sc_udev);
664 while ((n = min(ugen_bbsize, uio->uio_resid)) != 0) {
665 DPRINTFN(1, ("ugenread: start transfer %d bytes\n",n));
667 err = usbd_bulk_transfer(
669 sce->state & UGEN_SHORT_OK ?
670 USBD_SHORT_XFER_OK : 0,
671 sce->timeout, buf, &tn, "ugenrb");
673 if (err == USBD_INTERRUPTED)
675 else if (err == USBD_TIMEOUT)
681 DPRINTFN(1, ("ugenread: got %d bytes\n", tn));
682 error = uiomove(buf, tn, uio);
686 usbd_free_xfer(xfer);
690 while (sce->cur == sce->fill) {
691 if (flag & IO_NDELAY) {
696 sce->state |= UGEN_ASLP;
697 DPRINTFN(5, ("ugenread: sleep on %p\n", sce));
698 error = tsleep(sce, PCATCH, "ugenri", 0);
699 DPRINTFN(5, ("ugenread: woke, error=%d\n", error));
703 sce->state &= ~UGEN_ASLP;
708 while (sce->cur != sce->fill && uio->uio_resid > 0 && !error) {
709 if(sce->fill > sce->cur)
710 n = min(sce->fill - sce->cur, uio->uio_resid);
712 n = min(sce->limit - sce->cur, uio->uio_resid);
714 DPRINTFN(5, ("ugenread: isoc got %d chars\n", n));
716 /* Copy the data to the user process. */
717 error = uiomove(sce->cur, n, uio);
721 if(sce->cur >= sce->limit)
722 sce->cur = sce->ibuf;
733 relugenbuf(buf, ugen_bbsize);
738 ugenread(struct dev_read_args *ap)
740 cdev_t dev = ap->a_head.a_dev;
741 int endpt = UGENENDPOINT(dev);
742 struct ugen_softc *sc;
745 USB_GET_SC(ugen, UGENUNIT(dev), sc);
748 error = ugen_do_read(sc, endpt, ap->a_uio, ap->a_ioflag);
749 if (--sc->sc_refcnt < 0)
750 usb_detach_wakeup(sc->sc_dev);
755 ugen_do_write(struct ugen_softc *sc, int endpt, struct uio *uio, int flag)
757 struct ugen_endpoint *sce = &sc->sc_endpoints[endpt][OUT];
762 usbd_xfer_handle xfer;
765 DPRINTFN(5, ("%s: ugenwrite: %d\n", device_get_nameunit(sc->sc_dev), endpt));
770 if (endpt == USB_CONTROL_ENDPOINT)
776 if (sce->edesc == NULL) {
777 kprintf("ugenwrite: no edesc\n");
780 if (sce->pipeh == NULL) {
781 kprintf("ugenwrite: no pipe\n");
785 buf = getugenbuf(ugen_bufsize, &ugen_bbsize);
787 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
789 xfer = usbd_alloc_xfer(sc->sc_udev);
794 while ((n = min(ugen_bbsize, uio->uio_resid)) != 0) {
795 error = uiomove(buf, n, uio);
798 DPRINTFN(1, ("ugenwrite: transfer %d bytes\n", n));
799 err = usbd_bulk_transfer(xfer, sce->pipeh, 0,
800 sce->timeout, buf, &n,"ugenwb");
802 if (err == USBD_INTERRUPTED)
804 else if (err == USBD_TIMEOUT)
811 usbd_free_xfer(xfer);
814 xfer = usbd_alloc_xfer(sc->sc_udev);
819 while ((n = min(UGETW(sce->edesc->wMaxPacketSize),
820 uio->uio_resid)) != 0) {
821 error = uiomove(buf, n, uio);
824 DPRINTFN(1, ("ugenwrite: transfer %d bytes\n", n));
825 err = usbd_intr_transfer(xfer, sce->pipeh, 0,
826 sce->timeout, buf, &n,"ugenwi");
828 if (err == USBD_INTERRUPTED)
830 else if (err == USBD_TIMEOUT)
837 usbd_free_xfer(xfer);
844 relugenbuf(buf, ugen_bbsize);
849 ugenwrite(struct dev_write_args *ap)
851 cdev_t dev = ap->a_head.a_dev;
852 int endpt = UGENENDPOINT(dev);
853 struct ugen_softc *sc;
856 USB_GET_SC(ugen, UGENUNIT(dev), sc);
859 error = ugen_do_write(sc, endpt, ap->a_uio, ap->a_ioflag);
860 if (--sc->sc_refcnt < 0)
861 usb_detach_wakeup(sc->sc_dev);
866 ugen_detach(device_t self)
868 struct ugen_softc *sc = device_get_softc(self);
869 struct ugen_endpoint *sce;
872 DPRINTF(("ugen_detach: sc=%p\n", sc));
875 /* Abort all pipes. Causes processes waiting for transfer to wake. */
876 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
877 for (dir = OUT; dir <= IN; dir++) {
878 sce = &sc->sc_endpoints[i][dir];
879 if (sce && sce->pipeh)
880 usbd_abort_pipe(sce->pipeh);
884 if (--sc->sc_refcnt >= 0) {
886 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
887 wakeup(&sc->sc_endpoints[i][IN]);
888 /* Wait for processes to go away. */
889 usb_detach_wait(sc->sc_dev);
893 /* destroy the device for the control endpoint */
894 ugen_destroy_devnodes(sc);
895 dev_ops_remove(&ugen_ops,
896 UGENUNITMASK, UGENMINOR(device_get_unit(sc->sc_dev), 0));
901 ugenintr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
903 struct ugen_endpoint *sce = addr;
904 /*struct ugen_softc *sc = sce->sc;*/
908 if (status == USBD_CANCELLED)
911 if (status != USBD_NORMAL_COMPLETION) {
912 DPRINTF(("ugenintr: status=%d\n", status));
913 if (status == USBD_STALLED)
914 usbd_clear_endpoint_stall_async(sce->pipeh);
918 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
921 DPRINTFN(5, ("ugenintr: xfer=%p status=%d count=%d\n",
922 xfer, status, count));
923 DPRINTFN(5, (" data = %02x %02x %02x\n",
924 ibuf[0], ibuf[1], ibuf[2]));
926 (void)b_to_q(ibuf, count, &sce->q);
928 if (sce->state & UGEN_ASLP) {
929 sce->state &= ~UGEN_ASLP;
930 DPRINTFN(5, ("ugen_intr: waking %p\n", sce));
933 selwakeuppri(&sce->rsel, 0);
937 ugen_isoc_rintr(usbd_xfer_handle xfer, usbd_private_handle addr,
940 struct isoreq *req = addr;
941 struct ugen_endpoint *sce = req->sce;
945 /* Return if we are aborting. */
946 if (status == USBD_CANCELLED)
949 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
950 DPRINTFN(5,("ugen_isoc_rintr: xfer %d, count=%d\n",
951 (int)(req - sce->isoreqs),
954 /* throw away oldest input if the buffer is full */
955 if(sce->fill < sce->cur && sce->cur <= sce->fill + count) {
957 if(sce->cur >= sce->limit)
958 sce->cur = sce->ibuf + (sce->limit - sce->cur);
959 DPRINTFN(5, ("ugen_isoc_rintr: throwing away %d bytes\n",
963 isize = UGETW(sce->edesc->wMaxPacketSize);
964 for (i = 0; i < UGEN_NISORFRMS; i++) {
965 u_int32_t actlen = req->sizes[i];
966 char const *buf = (char const *)req->dmabuf + isize * i;
968 /* copy data to buffer */
970 n = min(actlen, sce->limit - sce->fill);
971 memcpy(sce->fill, buf, n);
976 if(sce->fill == sce->limit)
977 sce->fill = sce->ibuf;
980 /* setup size for next transfer */
981 req->sizes[i] = isize;
984 usbd_setup_isoc_xfer(xfer, sce->pipeh, req, req->sizes, UGEN_NISORFRMS,
985 USBD_NO_COPY, ugen_isoc_rintr);
986 (void)usbd_transfer(xfer);
988 if (sce->state & UGEN_ASLP) {
989 sce->state &= ~UGEN_ASLP;
990 DPRINTFN(5, ("ugen_isoc_rintr: waking %p\n", sce));
993 selwakeuppri(&sce->rsel, 0);
997 ugen_set_interface(struct ugen_softc *sc, int ifaceidx, int altno)
999 usbd_interface_handle iface;
1000 usb_endpoint_descriptor_t *ed;
1002 struct ugen_endpoint *sce;
1003 u_int8_t niface, nendpt, endptno, endpt;
1006 DPRINTFN(15, ("ugen_set_interface %d %d\n", ifaceidx, altno));
1008 err = usbd_interface_count(sc->sc_udev, &niface);
1011 if (ifaceidx < 0 || ifaceidx >= niface)
1012 return (USBD_INVAL);
1014 err = usbd_device2interface_handle(sc->sc_udev, ifaceidx, &iface);
1017 err = usbd_endpoint_count(iface, &nendpt);
1021 /* destroy the existing devices, we remake the new ones in a moment */
1022 ugen_destroy_devnodes(sc);
1024 /* XXX should only do this after setting new altno has succeeded */
1025 for (endptno = 0; endptno < nendpt; endptno++) {
1026 ed = usbd_interface2endpoint_descriptor(iface,endptno);
1027 endpt = ed->bEndpointAddress;
1028 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
1029 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
1035 /* change setting */
1036 err = usbd_set_interface(iface, altno);
1040 err = usbd_endpoint_count(iface, &nendpt);
1043 for (endptno = 0; endptno < nendpt; endptno++) {
1044 ed = usbd_interface2endpoint_descriptor(iface,endptno);
1045 endpt = ed->bEndpointAddress;
1046 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
1047 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
1053 /* make the new devices */
1054 ugen_make_devnodes(sc);
1059 /* Retrieve a complete descriptor for a certain device and index. */
1060 static usb_config_descriptor_t *
1061 ugen_get_cdesc(struct ugen_softc *sc, int index, int *lenp)
1063 usb_config_descriptor_t *cdesc, *tdesc, cdescr;
1067 if (index == USB_CURRENT_CONFIG_INDEX) {
1068 tdesc = usbd_get_config_descriptor(sc->sc_udev);
1069 len = UGETW(tdesc->wTotalLength);
1072 cdesc = kmalloc(len, M_TEMP, M_INTWAIT);
1073 memcpy(cdesc, tdesc, len);
1074 DPRINTFN(5,("ugen_get_cdesc: current, len=%d\n", len));
1076 err = usbd_get_config_desc(sc->sc_udev, index, &cdescr);
1079 len = UGETW(cdescr.wTotalLength);
1080 DPRINTFN(5,("ugen_get_cdesc: index=%d, len=%d\n", index, len));
1083 cdesc = kmalloc(len, M_TEMP, M_INTWAIT);
1084 err = usbd_get_config_desc_full(sc->sc_udev, index, cdesc, len);
1086 kfree(cdesc, M_TEMP);
1094 ugen_get_alt_index(struct ugen_softc *sc, int ifaceidx)
1096 usbd_interface_handle iface;
1099 err = usbd_device2interface_handle(sc->sc_udev, ifaceidx, &iface);
1102 return (usbd_get_interface_altindex(iface));
1106 ugen_do_ioctl(struct ugen_softc *sc, int endpt, u_long cmd,
1107 caddr_t addr, int flag)
1109 struct ugen_endpoint *sce;
1111 usbd_interface_handle iface;
1112 struct usb_config_desc *cd;
1113 usb_config_descriptor_t *cdesc;
1114 struct usb_interface_desc *id;
1115 usb_interface_descriptor_t *idesc;
1116 struct usb_endpoint_desc *ed;
1117 usb_endpoint_descriptor_t *edesc;
1118 struct usb_alt_interface *ai;
1119 struct usb_string_desc *si;
1122 DPRINTFN(5, ("ugenioctl: cmd=%08lx\n", cmd));
1127 case USB_SET_SHORT_XFER:
1128 /* This flag only affects read */
1129 if (endpt == USB_CONTROL_ENDPOINT)
1131 sce = &sc->sc_endpoints[endpt][IN];
1135 if (sce->pipeh == NULL) {
1136 kprintf("ugenioctl: USB_SET_SHORT_XFER, no pipe\n");
1141 sce->state |= UGEN_SHORT_OK;
1143 sce->state &= ~UGEN_SHORT_OK;
1145 case USB_SET_TIMEOUT:
1146 sce = &sc->sc_endpoints[endpt][IN];
1149 sce->timeout = *(int *)addr;
1155 if (endpt != USB_CONTROL_ENDPOINT)
1161 ugendebug = *(int *)addr;
1164 case USB_GET_CONFIG:
1165 err = usbd_get_config(sc->sc_udev, &conf);
1168 *(int *)addr = conf;
1170 case USB_SET_CONFIG:
1171 if (!(flag & FWRITE))
1173 err = ugen_set_config(sc, *(int *)addr);
1175 case USBD_NORMAL_COMPLETION:
1183 case USB_GET_ALTINTERFACE:
1184 ai = (struct usb_alt_interface *)addr;
1185 err = usbd_device2interface_handle(sc->sc_udev,
1186 ai->uai_interface_index, &iface);
1189 idesc = usbd_get_interface_descriptor(iface);
1192 ai->uai_alt_no = idesc->bAlternateSetting;
1194 case USB_SET_ALTINTERFACE:
1195 if (!(flag & FWRITE))
1197 ai = (struct usb_alt_interface *)addr;
1198 err = usbd_device2interface_handle(sc->sc_udev,
1199 ai->uai_interface_index, &iface);
1202 err = ugen_set_interface(sc, ai->uai_interface_index, ai->uai_alt_no);
1206 case USB_GET_NO_ALT:
1207 ai = (struct usb_alt_interface *)addr;
1208 cdesc = ugen_get_cdesc(sc, ai->uai_config_index, 0);
1211 idesc = usbd_find_idesc(cdesc, ai->uai_interface_index, 0);
1212 if (idesc == NULL) {
1213 kfree(cdesc, M_TEMP);
1216 ai->uai_alt_no = usbd_get_no_alts(cdesc, idesc->bInterfaceNumber);
1217 kfree(cdesc, M_TEMP);
1219 case USB_GET_DEVICE_DESC:
1220 *(usb_device_descriptor_t *)addr =
1221 *usbd_get_device_descriptor(sc->sc_udev);
1223 case USB_GET_CONFIG_DESC:
1224 cd = (struct usb_config_desc *)addr;
1225 cdesc = ugen_get_cdesc(sc, cd->ucd_config_index, 0);
1228 cd->ucd_desc = *cdesc;
1229 kfree(cdesc, M_TEMP);
1231 case USB_GET_INTERFACE_DESC:
1232 id = (struct usb_interface_desc *)addr;
1233 cdesc = ugen_get_cdesc(sc, id->uid_config_index, 0);
1236 if (id->uid_config_index == USB_CURRENT_CONFIG_INDEX &&
1237 id->uid_alt_index == USB_CURRENT_ALT_INDEX)
1238 alt = ugen_get_alt_index(sc, id->uid_interface_index);
1240 alt = id->uid_alt_index;
1241 idesc = usbd_find_idesc(cdesc, id->uid_interface_index, alt);
1242 if (idesc == NULL) {
1243 kfree(cdesc, M_TEMP);
1246 id->uid_desc = *idesc;
1247 kfree(cdesc, M_TEMP);
1249 case USB_GET_ENDPOINT_DESC:
1250 ed = (struct usb_endpoint_desc *)addr;
1251 cdesc = ugen_get_cdesc(sc, ed->ued_config_index, 0);
1254 if (ed->ued_config_index == USB_CURRENT_CONFIG_INDEX &&
1255 ed->ued_alt_index == USB_CURRENT_ALT_INDEX)
1256 alt = ugen_get_alt_index(sc, ed->ued_interface_index);
1258 alt = ed->ued_alt_index;
1259 edesc = usbd_find_edesc(cdesc, ed->ued_interface_index,
1260 alt, ed->ued_endpoint_index);
1261 if (edesc == NULL) {
1262 kfree(cdesc, M_TEMP);
1265 ed->ued_desc = *edesc;
1266 kfree(cdesc, M_TEMP);
1268 case USB_GET_FULL_DESC:
1273 struct usb_full_desc *fd = (struct usb_full_desc *)addr;
1276 cdesc = ugen_get_cdesc(sc, fd->ufd_config_index, &len);
1277 if (len > fd->ufd_size)
1279 iov.iov_base = (caddr_t)fd->ufd_data;
1283 uio.uio_resid = len;
1285 uio.uio_segflg = UIO_USERSPACE;
1286 uio.uio_rw = UIO_READ;
1287 uio.uio_td = curthread;
1288 error = uiomove((void *)cdesc, len, &uio);
1289 kfree(cdesc, M_TEMP);
1292 case USB_GET_STRING_DESC:
1296 si = (struct usb_string_desc *)addr;
1297 err = usbd_get_string_desc(sc->sc_udev, si->usd_string_index,
1298 si->usd_language_id, &si->usd_desc, &size);
1303 case USB_DO_REQUEST:
1305 struct usb_ctl_request *ur = (void *)addr;
1306 int len = UGETW(ur->ucr_request.wLength);
1313 if (!(flag & FWRITE))
1315 /* Avoid requests that would damage the bus integrity. */
1316 if ((ur->ucr_request.bmRequestType == UT_WRITE_DEVICE &&
1317 ur->ucr_request.bRequest == UR_SET_ADDRESS) ||
1318 (ur->ucr_request.bmRequestType == UT_WRITE_DEVICE &&
1319 ur->ucr_request.bRequest == UR_SET_CONFIG) ||
1320 (ur->ucr_request.bmRequestType == UT_WRITE_INTERFACE &&
1321 ur->ucr_request.bRequest == UR_SET_INTERFACE))
1324 if (len < 0 || len > 32767)
1327 iov.iov_base = (caddr_t)ur->ucr_data;
1331 uio.uio_resid = len;
1333 uio.uio_segflg = UIO_USERSPACE;
1335 ur->ucr_request.bmRequestType & UT_READ ?
1336 UIO_READ : UIO_WRITE;
1337 uio.uio_td = curthread;
1338 ptr = kmalloc(len, M_TEMP, M_WAITOK);
1339 if (uio.uio_rw == UIO_WRITE) {
1340 error = uiomove(ptr, len, &uio);
1345 sce = &sc->sc_endpoints[endpt][IN];
1346 err = usbd_do_request_flags(sc->sc_udev, &ur->ucr_request,
1347 ptr, ur->ucr_flags, &ur->ucr_actlen, sce->timeout);
1353 if (uio.uio_rw == UIO_READ) {
1354 error = uiomove(ptr, len, &uio);
1364 case USB_GET_DEVICEINFO:
1365 usbd_fill_deviceinfo(sc->sc_udev,
1366 (struct usb_device_info *)addr, 1);
1375 ugenioctl(struct dev_ioctl_args *ap)
1377 cdev_t dev = ap->a_head.a_dev;
1378 int endpt = UGENENDPOINT(dev);
1379 struct ugen_softc *sc;
1382 USB_GET_SC(ugen, UGENUNIT(dev), sc);
1385 error = ugen_do_ioctl(sc, endpt, ap->a_cmd, ap->a_data, ap->a_fflag);
1386 if (--sc->sc_refcnt < 0)
1387 usb_detach_wakeup(sc->sc_dev);
1392 ugenpoll(struct dev_poll_args *ap)
1394 cdev_t dev = ap->a_head.a_dev;
1395 struct ugen_softc *sc;
1396 struct ugen_endpoint *sce;
1399 USB_GET_SC(ugen, UGENUNIT(dev), sc);
1405 sce = &sc->sc_endpoints[UGENENDPOINT(dev)][IN];
1410 kprintf("ugenpoll: no edesc\n");
1414 kprintf("ugenpoll: no pipe\n");
1419 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
1421 if (ap->a_events & (POLLIN | POLLRDNORM)) {
1422 if (sce->q.c_cc > 0)
1423 revents |= ap->a_events & (POLLIN | POLLRDNORM);
1425 selrecord(curthread, &sce->rsel);
1428 case UE_ISOCHRONOUS:
1429 if (ap->a_events & (POLLIN | POLLRDNORM)) {
1430 if (sce->cur != sce->fill)
1431 revents |= ap->a_events & (POLLIN | POLLRDNORM);
1433 selrecord(curthread, &sce->rsel);
1438 * We have no easy way of determining if a read will
1439 * yield any data or a write will happen.
1440 * Pretend they will.
1442 revents |= ap->a_events &
1443 (POLLIN | POLLRDNORM | POLLOUT | POLLWRNORM);
1449 ap->a_events = revents;
1453 DRIVER_MODULE(ugen, uhub, ugen_driver, ugen_devclass, usbd_driver_load, 0);