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.32 2007/07/03 19:28:16 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 static device_probe_t ugen_match;
179 static device_attach_t ugen_attach;
180 static device_detach_t ugen_detach;
182 static devclass_t ugen_devclass;
184 static kobj_method_t ugen_methods[] = {
185 DEVMETHOD(device_probe, ugen_match),
186 DEVMETHOD(device_attach, ugen_attach),
187 DEVMETHOD(device_detach, ugen_detach),
191 static driver_t ugen_driver = {
194 sizeof(struct ugen_softc)
197 MODULE_DEPEND(ugen, usb, 1, 1, 1);
200 ugen_match(device_t self)
202 struct usb_attach_arg *uaa = device_get_ivars(self);
206 return (uaa->matchlvl);
209 return (UMATCH_GENERIC);
211 return (UMATCH_NONE);
215 ugen_attach(device_t self)
217 struct ugen_softc *sc = device_get_softc(self);
218 struct usb_attach_arg *uaa = device_get_ivars(self);
219 usbd_device_handle udev;
224 usbd_devinfo(uaa->device, 0, devinfo);
226 device_set_desc_copy(self, devinfo);
227 kprintf("%s: %s\n", device_get_nameunit(sc->sc_dev), devinfo);
229 sc->sc_udev = udev = uaa->device;
231 memset(sc->sc_endpoints, 0, sizeof sc->sc_endpoints);
233 /* First set configuration index 0, the default one for ugen. */
234 err = usbd_set_config_index(udev, 0, 0);
236 kprintf("%s: setting configuration index 0 failed\n",
237 device_get_nameunit(sc->sc_dev));
241 conf = usbd_get_config_descriptor(udev)->bConfigurationValue;
243 /* Set up all the local state for this configuration. */
244 err = ugen_set_config(sc, conf);
246 kprintf("%s: setting configuration %d failed\n",
247 device_get_nameunit(sc->sc_dev), conf);
252 /* the main device, ctrl endpoint */
253 dev_ops_add(&ugen_ops,
254 UGENUNITMASK, UGENMINOR(device_get_unit(sc->sc_dev), 0));
255 make_dev(&ugen_ops, UGENMINOR(device_get_unit(sc->sc_dev), 0),
256 UID_ROOT, GID_OPERATOR, 0644, "%s", device_get_nameunit(sc->sc_dev));
262 ugen_make_devnodes(struct ugen_softc *sc)
267 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
268 if (sc->sc_endpoints[endptno][IN].sc != NULL ||
269 sc->sc_endpoints[endptno][OUT].sc != NULL ) {
270 /* endpt can be 0x81 and 0x01, representing
271 * endpoint address 0x01 and IN/OUT directions.
272 * We map both endpts to the same device,
273 * IN is reading from it, OUT is writing to it.
275 * In the if clause above we check whether one
276 * of the structs is populated.
278 dev = make_dev(&ugen_ops,
279 UGENMINOR(device_get_unit(sc->sc_dev), endptno),
280 UID_ROOT, GID_OPERATOR, 0644,
282 device_get_nameunit(sc->sc_dev), endptno);
283 if (sc->sc_endpoints[endptno][IN].sc != NULL) {
285 if (sc->sc_endpoints[endptno][IN].dev)
286 release_dev(sc->sc_endpoints[endptno][IN].dev);
287 sc->sc_endpoints[endptno][IN].dev = dev;
289 if (sc->sc_endpoints[endptno][OUT].sc != NULL) {
291 if (sc->sc_endpoints[endptno][OUT].dev)
292 release_dev(sc->sc_endpoints[endptno][OUT].dev);
293 sc->sc_endpoints[endptno][OUT].dev = dev;
300 ugen_destroy_devnodes(struct ugen_softc *sc)
305 /* destroy all devices for the other (existing) endpoints as well */
306 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
307 if (sc->sc_endpoints[endptno][IN].sc != NULL ||
308 sc->sc_endpoints[endptno][OUT].sc != NULL ) {
309 /* endpt can be 0x81 and 0x01, representing
310 * endpoint address 0x01 and IN/OUT directions.
311 * We map both endpoint addresses to the same device,
312 * IN is reading from it, OUT is writing to it.
314 * In the if clause above we check whether one
315 * of the structs is populated.
317 dev = sc->sc_endpoints[endptno][IN].dev;
320 sc->sc_endpoints[endptno][IN].dev = NULL;
322 dev = sc->sc_endpoints[endptno][OUT].dev;
325 sc->sc_endpoints[endptno][OUT].dev = NULL;
332 ugen_set_config(struct ugen_softc *sc, int configno)
334 usbd_device_handle dev = sc->sc_udev;
335 usbd_interface_handle iface;
336 usb_endpoint_descriptor_t *ed;
337 struct ugen_endpoint *sce;
338 u_int8_t niface, nendpt;
339 int ifaceno, endptno, endpt;
343 DPRINTFN(1,("ugen_set_config: %s to configno %d, sc=%p\n",
344 device_get_nameunit(sc->sc_dev), configno, sc));
346 ugen_destroy_devnodes(sc);
348 /* We start at 1, not 0, because we don't care whether the
349 * control endpoint is open or not. It is always present.
351 for (endptno = 1; endptno < USB_MAX_ENDPOINTS; endptno++) {
352 if (sc->sc_is_open[endptno]) {
354 ("ugen_set_config: %s - endpoint %d is open\n",
355 device_get_nameunit(sc->sc_dev), endptno));
356 return (USBD_IN_USE);
360 /* Avoid setting the current value. */
361 if (usbd_get_config_descriptor(dev)->bConfigurationValue != configno) {
362 err = usbd_set_config_no(dev, configno, 1);
367 err = usbd_interface_count(dev, &niface);
370 memset(sc->sc_endpoints, 0, sizeof sc->sc_endpoints);
371 for (ifaceno = 0; ifaceno < niface; ifaceno++) {
372 DPRINTFN(1,("ugen_set_config: ifaceno %d\n", ifaceno));
373 err = usbd_device2interface_handle(dev, ifaceno, &iface);
376 err = usbd_endpoint_count(iface, &nendpt);
379 for (endptno = 0; endptno < nendpt; endptno++) {
380 ed = usbd_interface2endpoint_descriptor(iface,endptno);
381 endpt = ed->bEndpointAddress;
382 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
383 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
384 DPRINTFN(1,("ugen_set_config: endptno %d, endpt=0x%02x"
386 endptno, endpt, UE_GET_ADDR(endpt),
387 UE_GET_DIR(endpt), sce));
394 ugen_make_devnodes(sc);
396 return (USBD_NORMAL_COMPLETION);
400 ugenopen(struct dev_open_args *ap)
402 cdev_t dev = ap->a_head.a_dev;
403 struct ugen_softc *sc;
404 int unit = UGENUNIT(dev);
405 int endpt = UGENENDPOINT(dev);
406 usb_endpoint_descriptor_t *edesc;
407 struct ugen_endpoint *sce;
410 usbd_xfer_handle xfer;
414 sc = devclass_get_softc(ugen_devclass, unit);
418 DPRINTFN(5, ("ugenopen: flag=%d, mode=%d, unit=%d endpt=%d\n",
419 ap->a_oflags, ap->a_devtype, unit, endpt));
421 if (sc == NULL || sc->sc_dying)
424 if (sc->sc_is_open[endpt])
427 if (endpt == USB_CONTROL_ENDPOINT) {
428 sc->sc_is_open[USB_CONTROL_ENDPOINT] = 1;
432 /* Make sure there are pipes for all directions. */
433 for (dir = OUT; dir <= IN; dir++) {
434 if (ap->a_oflags & (dir == OUT ? FWRITE : FREAD)) {
435 sce = &sc->sc_endpoints[endpt][dir];
436 if (sce == 0 || sce->edesc == 0)
441 /* Actually open the pipes. */
442 /* XXX Should back out properly if it fails. */
443 for (dir = OUT; dir <= IN; dir++) {
444 if (!(ap->a_oflags & (dir == OUT ? FWRITE : FREAD)))
446 sce = &sc->sc_endpoints[endpt][dir];
448 sce->timeout = USBD_NO_TIMEOUT;
449 DPRINTFN(5, ("ugenopen: sc=%p, endpt=%d, dir=%d, sce=%p\n",
450 sc, endpt, dir, sce));
452 switch (edesc->bmAttributes & UE_XFERTYPE) {
455 err = usbd_open_pipe(sce->iface,
456 edesc->bEndpointAddress, 0, &sce->pipeh);
461 isize = UGETW(edesc->wMaxPacketSize);
462 if (isize == 0) /* shouldn't happen */
464 sce->ibuf = kmalloc(isize, M_USBDEV, M_WAITOK);
465 DPRINTFN(5, ("ugenopen: intr endpt=%d,isize=%d\n",
467 if ((clist_alloc_cblocks(&sce->q, UGEN_IBSIZE,
468 UGEN_IBSIZE), 0) == -1)
470 err = usbd_open_pipe_intr(sce->iface,
471 edesc->bEndpointAddress,
472 USBD_SHORT_XFER_OK, &sce->pipeh, sce,
473 sce->ibuf, isize, ugenintr,
474 USBD_DEFAULT_INTERVAL);
476 kfree(sce->ibuf, M_USBDEV);
477 clist_free_cblocks(&sce->q);
480 DPRINTFN(5, ("ugenopen: interrupt open done\n"));
483 err = usbd_open_pipe(sce->iface,
484 edesc->bEndpointAddress, 0, &sce->pipeh);
491 isize = UGETW(edesc->wMaxPacketSize);
492 if (isize == 0) /* shouldn't happen */
494 sce->ibuf = kmalloc(isize * UGEN_NISOFRAMES,
496 sce->cur = sce->fill = sce->ibuf;
497 sce->limit = sce->ibuf + isize * UGEN_NISOFRAMES;
498 DPRINTFN(5, ("ugenopen: isoc endpt=%d, isize=%d\n",
500 err = usbd_open_pipe(sce->iface,
501 edesc->bEndpointAddress, 0, &sce->pipeh);
503 kfree(sce->ibuf, M_USBDEV);
506 for(i = 0; i < UGEN_NISOREQS; ++i) {
507 sce->isoreqs[i].sce = sce;
508 xfer = usbd_alloc_xfer(sc->sc_udev);
511 sce->isoreqs[i].xfer = xfer;
512 buf = usbd_alloc_buffer
513 (xfer, isize * UGEN_NISORFRMS);
518 sce->isoreqs[i].dmabuf = buf;
519 for(j = 0; j < UGEN_NISORFRMS; ++j)
520 sce->isoreqs[i].sizes[j] = isize;
522 (xfer, sce->pipeh, &sce->isoreqs[i],
523 sce->isoreqs[i].sizes,
524 UGEN_NISORFRMS, USBD_NO_COPY,
526 (void)usbd_transfer(xfer);
528 DPRINTFN(5, ("ugenopen: isoc open done\n"));
531 while (--i >= 0) /* implicit buffer free */
532 usbd_free_xfer(sce->isoreqs[i].xfer);
535 sce->timeout = USBD_DEFAULT_TIMEOUT;
539 sc->sc_is_open[endpt] = 1;
544 ugenclose(struct dev_close_args *ap)
546 cdev_t dev = ap->a_head.a_dev;
547 int endpt = UGENENDPOINT(dev);
548 struct ugen_softc *sc;
549 struct ugen_endpoint *sce;
553 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
555 DPRINTFN(5, ("ugenclose: flag=%d, mode=%d, unit=%d, endpt=%d\n",
556 ap->a_fflag, ap->a_devtype, UGENUNIT(dev), endpt));
559 if (!sc->sc_is_open[endpt]) {
560 kprintf("ugenclose: not open\n");
565 if (endpt == USB_CONTROL_ENDPOINT) {
566 DPRINTFN(5, ("ugenclose: close control\n"));
567 sc->sc_is_open[endpt] = 0;
571 for (dir = OUT; dir <= IN; dir++) {
572 if (!(ap->a_fflag & (dir == OUT ? FWRITE : FREAD)))
574 sce = &sc->sc_endpoints[endpt][dir];
575 if (sce == NULL || sce->pipeh == NULL)
577 DPRINTFN(5, ("ugenclose: endpt=%d dir=%d sce=%p\n",
580 usbd_abort_pipe(sce->pipeh);
581 usbd_close_pipe(sce->pipeh);
584 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
586 ndflush(&sce->q, sce->q.c_cc);
587 clist_free_cblocks(&sce->q);
590 for (i = 0; i < UGEN_NISOREQS; ++i)
591 usbd_free_xfer(sce->isoreqs[i].xfer);
596 if (sce->ibuf != NULL) {
597 kfree(sce->ibuf, M_USBDEV);
599 clist_free_cblocks(&sce->q);
602 sc->sc_is_open[endpt] = 0;
608 ugen_do_read(struct ugen_softc *sc, int endpt, struct uio *uio, int flag)
610 struct ugen_endpoint *sce = &sc->sc_endpoints[endpt][IN];
613 usbd_xfer_handle xfer;
617 u_char buffer[UGEN_CHUNK];
619 DPRINTFN(5, ("%s: ugenread: %d\n", device_get_nameunit(sc->sc_dev), endpt));
624 if (endpt == USB_CONTROL_ENDPOINT)
630 if (sce->edesc == NULL) {
631 kprintf("ugenread: no edesc\n");
634 if (sce->pipeh == NULL) {
635 kprintf("ugenread: no pipe\n");
639 buf = getugenbuf(ugen_bufsize, &ugen_bbsize);
641 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
643 /* Block until activity occurred. */
645 while (sce->q.c_cc == 0) {
646 if (flag & IO_NDELAY) {
651 sce->state |= UGEN_ASLP;
652 DPRINTFN(5, ("ugenread: sleep on %p\n", sce));
653 error = tsleep(sce, PCATCH, "ugenri", 0);
654 DPRINTFN(5, ("ugenread: woke, error=%d\n", error));
658 sce->state &= ~UGEN_ASLP;
664 /* Transfer as many chunks as possible. */
665 while (sce->q.c_cc > 0 && uio->uio_resid > 0 && !error) {
666 n = min(sce->q.c_cc, uio->uio_resid);
667 if (n > sizeof(buffer))
670 /* Remove a small chunk from the input queue. */
671 q_to_b(&sce->q, buffer, n);
672 DPRINTFN(5, ("ugenread: got %d chars\n", n));
674 /* Copy the data to the user process. */
675 error = uiomove(buffer, n, uio);
681 xfer = usbd_alloc_xfer(sc->sc_udev);
686 while ((n = min(ugen_bbsize, uio->uio_resid)) != 0) {
687 DPRINTFN(1, ("ugenread: start transfer %d bytes\n",n));
689 err = usbd_bulk_transfer(
691 sce->state & UGEN_SHORT_OK ?
692 USBD_SHORT_XFER_OK : 0,
693 sce->timeout, buf, &tn, "ugenrb");
695 if (err == USBD_INTERRUPTED)
697 else if (err == USBD_TIMEOUT)
703 DPRINTFN(1, ("ugenread: got %d bytes\n", tn));
704 error = uiomove(buf, tn, uio);
708 usbd_free_xfer(xfer);
712 while (sce->cur == sce->fill) {
713 if (flag & IO_NDELAY) {
718 sce->state |= UGEN_ASLP;
719 DPRINTFN(5, ("ugenread: sleep on %p\n", sce));
720 error = tsleep(sce, PCATCH, "ugenri", 0);
721 DPRINTFN(5, ("ugenread: woke, error=%d\n", error));
725 sce->state &= ~UGEN_ASLP;
730 while (sce->cur != sce->fill && uio->uio_resid > 0 && !error) {
731 if(sce->fill > sce->cur)
732 n = min(sce->fill - sce->cur, uio->uio_resid);
734 n = min(sce->limit - sce->cur, uio->uio_resid);
736 DPRINTFN(5, ("ugenread: isoc got %d chars\n", n));
738 /* Copy the data to the user process. */
739 error = uiomove(sce->cur, n, uio);
743 if(sce->cur >= sce->limit)
744 sce->cur = sce->ibuf;
755 relugenbuf(buf, ugen_bbsize);
760 ugenread(struct dev_read_args *ap)
762 cdev_t dev = ap->a_head.a_dev;
763 int endpt = UGENENDPOINT(dev);
764 struct ugen_softc *sc;
767 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
770 error = ugen_do_read(sc, endpt, ap->a_uio, ap->a_ioflag);
771 if (--sc->sc_refcnt < 0)
772 usb_detach_wakeup(sc->sc_dev);
777 ugen_do_write(struct ugen_softc *sc, int endpt, struct uio *uio, int flag)
779 struct ugen_endpoint *sce = &sc->sc_endpoints[endpt][OUT];
784 usbd_xfer_handle xfer;
787 DPRINTFN(5, ("%s: ugenwrite: %d\n", device_get_nameunit(sc->sc_dev), endpt));
792 if (endpt == USB_CONTROL_ENDPOINT)
798 if (sce->edesc == NULL) {
799 kprintf("ugenwrite: no edesc\n");
802 if (sce->pipeh == NULL) {
803 kprintf("ugenwrite: no pipe\n");
807 buf = getugenbuf(ugen_bufsize, &ugen_bbsize);
809 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
811 xfer = usbd_alloc_xfer(sc->sc_udev);
816 while ((n = min(ugen_bbsize, uio->uio_resid)) != 0) {
817 error = uiomove(buf, n, uio);
820 DPRINTFN(1, ("ugenwrite: transfer %d bytes\n", n));
821 err = usbd_bulk_transfer(xfer, sce->pipeh, 0,
822 sce->timeout, buf, &n,"ugenwb");
824 if (err == USBD_INTERRUPTED)
826 else if (err == USBD_TIMEOUT)
833 usbd_free_xfer(xfer);
836 xfer = usbd_alloc_xfer(sc->sc_udev);
841 while ((n = min(UGETW(sce->edesc->wMaxPacketSize),
842 uio->uio_resid)) != 0) {
843 error = uiomove(buf, n, uio);
846 DPRINTFN(1, ("ugenwrite: transfer %d bytes\n", n));
847 err = usbd_intr_transfer(xfer, sce->pipeh, 0,
848 sce->timeout, buf, &n,"ugenwi");
850 if (err == USBD_INTERRUPTED)
852 else if (err == USBD_TIMEOUT)
859 usbd_free_xfer(xfer);
866 relugenbuf(buf, ugen_bbsize);
871 ugenwrite(struct dev_write_args *ap)
873 cdev_t dev = ap->a_head.a_dev;
874 int endpt = UGENENDPOINT(dev);
875 struct ugen_softc *sc;
878 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
881 error = ugen_do_write(sc, endpt, ap->a_uio, ap->a_ioflag);
882 if (--sc->sc_refcnt < 0)
883 usb_detach_wakeup(sc->sc_dev);
888 ugen_detach(device_t self)
890 struct ugen_softc *sc = device_get_softc(self);
891 struct ugen_endpoint *sce;
894 DPRINTF(("ugen_detach: sc=%p\n", sc));
897 /* Abort all pipes. Causes processes waiting for transfer to wake. */
898 for (i = 0; i < USB_MAX_ENDPOINTS; i++) {
899 for (dir = OUT; dir <= IN; dir++) {
900 sce = &sc->sc_endpoints[i][dir];
901 if (sce && sce->pipeh)
902 usbd_abort_pipe(sce->pipeh);
906 if (--sc->sc_refcnt >= 0) {
908 for (i = 0; i < USB_MAX_ENDPOINTS; i++)
909 wakeup(&sc->sc_endpoints[i][IN]);
910 /* Wait for processes to go away. */
911 usb_detach_wait(sc->sc_dev);
915 /* destroy the device for the control endpoint */
916 ugen_destroy_devnodes(sc);
917 dev_ops_remove(&ugen_ops,
918 UGENUNITMASK, UGENMINOR(device_get_unit(sc->sc_dev), 0));
923 ugenintr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
925 struct ugen_endpoint *sce = addr;
926 /*struct ugen_softc *sc = sce->sc;*/
930 if (status == USBD_CANCELLED)
933 if (status != USBD_NORMAL_COMPLETION) {
934 DPRINTF(("ugenintr: status=%d\n", status));
935 if (status == USBD_STALLED)
936 usbd_clear_endpoint_stall_async(sce->pipeh);
940 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
943 DPRINTFN(5, ("ugenintr: xfer=%p status=%d count=%d\n",
944 xfer, status, count));
945 DPRINTFN(5, (" data = %02x %02x %02x\n",
946 ibuf[0], ibuf[1], ibuf[2]));
948 (void)b_to_q(ibuf, count, &sce->q);
950 if (sce->state & UGEN_ASLP) {
951 sce->state &= ~UGEN_ASLP;
952 DPRINTFN(5, ("ugen_intr: waking %p\n", sce));
955 selwakeup(&sce->rsel);
959 ugen_isoc_rintr(usbd_xfer_handle xfer, usbd_private_handle addr,
962 struct isoreq *req = addr;
963 struct ugen_endpoint *sce = req->sce;
967 /* Return if we are aborting. */
968 if (status == USBD_CANCELLED)
971 usbd_get_xfer_status(xfer, NULL, NULL, &count, NULL);
972 DPRINTFN(5,("ugen_isoc_rintr: xfer %d, count=%d\n",
973 (int)(req - sce->isoreqs),
976 /* throw away oldest input if the buffer is full */
977 if(sce->fill < sce->cur && sce->cur <= sce->fill + count) {
979 if(sce->cur >= sce->limit)
980 sce->cur = sce->ibuf + (sce->limit - sce->cur);
981 DPRINTFN(5, ("ugen_isoc_rintr: throwing away %d bytes\n",
985 isize = UGETW(sce->edesc->wMaxPacketSize);
986 for (i = 0; i < UGEN_NISORFRMS; i++) {
987 u_int32_t actlen = req->sizes[i];
988 char const *buf = (char const *)req->dmabuf + isize * i;
990 /* copy data to buffer */
992 n = min(actlen, sce->limit - sce->fill);
993 memcpy(sce->fill, buf, n);
998 if(sce->fill == sce->limit)
999 sce->fill = sce->ibuf;
1002 /* setup size for next transfer */
1003 req->sizes[i] = isize;
1006 usbd_setup_isoc_xfer(xfer, sce->pipeh, req, req->sizes, UGEN_NISORFRMS,
1007 USBD_NO_COPY, ugen_isoc_rintr);
1008 (void)usbd_transfer(xfer);
1010 if (sce->state & UGEN_ASLP) {
1011 sce->state &= ~UGEN_ASLP;
1012 DPRINTFN(5, ("ugen_isoc_rintr: waking %p\n", sce));
1015 selwakeup(&sce->rsel);
1019 ugen_set_interface(struct ugen_softc *sc, int ifaceidx, int altno)
1021 usbd_interface_handle iface;
1022 usb_endpoint_descriptor_t *ed;
1024 struct ugen_endpoint *sce;
1025 u_int8_t niface, nendpt, endptno, endpt;
1028 DPRINTFN(15, ("ugen_set_interface %d %d\n", ifaceidx, altno));
1030 err = usbd_interface_count(sc->sc_udev, &niface);
1033 if (ifaceidx < 0 || ifaceidx >= niface)
1034 return (USBD_INVAL);
1036 err = usbd_device2interface_handle(sc->sc_udev, ifaceidx, &iface);
1039 err = usbd_endpoint_count(iface, &nendpt);
1043 /* destroy the existing devices, we remake the new ones in a moment */
1044 ugen_destroy_devnodes(sc);
1046 /* XXX should only do this after setting new altno has succeeded */
1047 for (endptno = 0; endptno < nendpt; endptno++) {
1048 ed = usbd_interface2endpoint_descriptor(iface,endptno);
1049 endpt = ed->bEndpointAddress;
1050 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
1051 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
1057 /* change setting */
1058 err = usbd_set_interface(iface, altno);
1062 err = usbd_endpoint_count(iface, &nendpt);
1065 for (endptno = 0; endptno < nendpt; endptno++) {
1066 ed = usbd_interface2endpoint_descriptor(iface,endptno);
1067 endpt = ed->bEndpointAddress;
1068 dir = UE_GET_DIR(endpt) == UE_DIR_IN ? IN : OUT;
1069 sce = &sc->sc_endpoints[UE_GET_ADDR(endpt)][dir];
1075 /* make the new devices */
1076 ugen_make_devnodes(sc);
1081 /* Retrieve a complete descriptor for a certain device and index. */
1082 static usb_config_descriptor_t *
1083 ugen_get_cdesc(struct ugen_softc *sc, int index, int *lenp)
1085 usb_config_descriptor_t *cdesc, *tdesc, cdescr;
1089 if (index == USB_CURRENT_CONFIG_INDEX) {
1090 tdesc = usbd_get_config_descriptor(sc->sc_udev);
1091 len = UGETW(tdesc->wTotalLength);
1094 cdesc = kmalloc(len, M_TEMP, M_INTWAIT);
1095 memcpy(cdesc, tdesc, len);
1096 DPRINTFN(5,("ugen_get_cdesc: current, len=%d\n", len));
1098 err = usbd_get_config_desc(sc->sc_udev, index, &cdescr);
1101 len = UGETW(cdescr.wTotalLength);
1102 DPRINTFN(5,("ugen_get_cdesc: index=%d, len=%d\n", index, len));
1105 cdesc = kmalloc(len, M_TEMP, M_INTWAIT);
1106 err = usbd_get_config_desc_full(sc->sc_udev, index, cdesc, len);
1108 kfree(cdesc, M_TEMP);
1116 ugen_get_alt_index(struct ugen_softc *sc, int ifaceidx)
1118 usbd_interface_handle iface;
1121 err = usbd_device2interface_handle(sc->sc_udev, ifaceidx, &iface);
1124 return (usbd_get_interface_altindex(iface));
1128 ugen_do_ioctl(struct ugen_softc *sc, int endpt, u_long cmd,
1129 caddr_t addr, int flag)
1131 struct ugen_endpoint *sce;
1133 usbd_interface_handle iface;
1134 struct usb_config_desc *cd;
1135 usb_config_descriptor_t *cdesc;
1136 struct usb_interface_desc *id;
1137 usb_interface_descriptor_t *idesc;
1138 struct usb_endpoint_desc *ed;
1139 usb_endpoint_descriptor_t *edesc;
1140 struct usb_alt_interface *ai;
1141 struct usb_string_desc *si;
1144 DPRINTFN(5, ("ugenioctl: cmd=%08lx\n", cmd));
1149 case USB_SET_SHORT_XFER:
1150 /* This flag only affects read */
1151 if (endpt == USB_CONTROL_ENDPOINT)
1153 sce = &sc->sc_endpoints[endpt][IN];
1157 if (sce->pipeh == NULL) {
1158 kprintf("ugenioctl: USB_SET_SHORT_XFER, no pipe\n");
1163 sce->state |= UGEN_SHORT_OK;
1165 sce->state &= ~UGEN_SHORT_OK;
1167 case USB_SET_TIMEOUT:
1168 sce = &sc->sc_endpoints[endpt][IN];
1171 sce->timeout = *(int *)addr;
1177 if (endpt != USB_CONTROL_ENDPOINT)
1183 ugendebug = *(int *)addr;
1186 case USB_GET_CONFIG:
1187 err = usbd_get_config(sc->sc_udev, &conf);
1190 *(int *)addr = conf;
1192 case USB_SET_CONFIG:
1193 if (!(flag & FWRITE))
1195 err = ugen_set_config(sc, *(int *)addr);
1197 case USBD_NORMAL_COMPLETION:
1205 case USB_GET_ALTINTERFACE:
1206 ai = (struct usb_alt_interface *)addr;
1207 err = usbd_device2interface_handle(sc->sc_udev,
1208 ai->uai_interface_index, &iface);
1211 idesc = usbd_get_interface_descriptor(iface);
1214 ai->uai_alt_no = idesc->bAlternateSetting;
1216 case USB_SET_ALTINTERFACE:
1217 if (!(flag & FWRITE))
1219 ai = (struct usb_alt_interface *)addr;
1220 err = usbd_device2interface_handle(sc->sc_udev,
1221 ai->uai_interface_index, &iface);
1224 err = ugen_set_interface(sc, ai->uai_interface_index, ai->uai_alt_no);
1228 case USB_GET_NO_ALT:
1229 ai = (struct usb_alt_interface *)addr;
1230 cdesc = ugen_get_cdesc(sc, ai->uai_config_index, 0);
1233 idesc = usbd_find_idesc(cdesc, ai->uai_interface_index, 0);
1234 if (idesc == NULL) {
1235 kfree(cdesc, M_TEMP);
1238 ai->uai_alt_no = usbd_get_no_alts(cdesc, idesc->bInterfaceNumber);
1239 kfree(cdesc, M_TEMP);
1241 case USB_GET_DEVICE_DESC:
1242 *(usb_device_descriptor_t *)addr =
1243 *usbd_get_device_descriptor(sc->sc_udev);
1245 case USB_GET_CONFIG_DESC:
1246 cd = (struct usb_config_desc *)addr;
1247 cdesc = ugen_get_cdesc(sc, cd->ucd_config_index, 0);
1250 cd->ucd_desc = *cdesc;
1251 kfree(cdesc, M_TEMP);
1253 case USB_GET_INTERFACE_DESC:
1254 id = (struct usb_interface_desc *)addr;
1255 cdesc = ugen_get_cdesc(sc, id->uid_config_index, 0);
1258 if (id->uid_config_index == USB_CURRENT_CONFIG_INDEX &&
1259 id->uid_alt_index == USB_CURRENT_ALT_INDEX)
1260 alt = ugen_get_alt_index(sc, id->uid_interface_index);
1262 alt = id->uid_alt_index;
1263 idesc = usbd_find_idesc(cdesc, id->uid_interface_index, alt);
1264 if (idesc == NULL) {
1265 kfree(cdesc, M_TEMP);
1268 id->uid_desc = *idesc;
1269 kfree(cdesc, M_TEMP);
1271 case USB_GET_ENDPOINT_DESC:
1272 ed = (struct usb_endpoint_desc *)addr;
1273 cdesc = ugen_get_cdesc(sc, ed->ued_config_index, 0);
1276 if (ed->ued_config_index == USB_CURRENT_CONFIG_INDEX &&
1277 ed->ued_alt_index == USB_CURRENT_ALT_INDEX)
1278 alt = ugen_get_alt_index(sc, ed->ued_interface_index);
1280 alt = ed->ued_alt_index;
1281 edesc = usbd_find_edesc(cdesc, ed->ued_interface_index,
1282 alt, ed->ued_endpoint_index);
1283 if (edesc == NULL) {
1284 kfree(cdesc, M_TEMP);
1287 ed->ued_desc = *edesc;
1288 kfree(cdesc, M_TEMP);
1290 case USB_GET_FULL_DESC:
1295 struct usb_full_desc *fd = (struct usb_full_desc *)addr;
1298 cdesc = ugen_get_cdesc(sc, fd->ufd_config_index, &len);
1299 if (len > fd->ufd_size)
1301 iov.iov_base = (caddr_t)fd->ufd_data;
1305 uio.uio_resid = len;
1307 uio.uio_segflg = UIO_USERSPACE;
1308 uio.uio_rw = UIO_READ;
1309 uio.uio_td = curthread;
1310 error = uiomove((void *)cdesc, len, &uio);
1311 kfree(cdesc, M_TEMP);
1314 case USB_GET_STRING_DESC:
1318 si = (struct usb_string_desc *)addr;
1319 err = usbd_get_string_desc(sc->sc_udev, si->usd_string_index,
1320 si->usd_language_id, &si->usd_desc, &size);
1325 case USB_DO_REQUEST:
1327 struct usb_ctl_request *ur = (void *)addr;
1328 int len = UGETW(ur->ucr_request.wLength);
1335 if (!(flag & FWRITE))
1337 /* Avoid requests that would damage the bus integrity. */
1338 if ((ur->ucr_request.bmRequestType == UT_WRITE_DEVICE &&
1339 ur->ucr_request.bRequest == UR_SET_ADDRESS) ||
1340 (ur->ucr_request.bmRequestType == UT_WRITE_DEVICE &&
1341 ur->ucr_request.bRequest == UR_SET_CONFIG) ||
1342 (ur->ucr_request.bmRequestType == UT_WRITE_INTERFACE &&
1343 ur->ucr_request.bRequest == UR_SET_INTERFACE))
1346 if (len < 0 || len > 32767)
1349 iov.iov_base = (caddr_t)ur->ucr_data;
1353 uio.uio_resid = len;
1355 uio.uio_segflg = UIO_USERSPACE;
1357 ur->ucr_request.bmRequestType & UT_READ ?
1358 UIO_READ : UIO_WRITE;
1359 uio.uio_td = curthread;
1360 ptr = kmalloc(len, M_TEMP, M_WAITOK);
1361 if (uio.uio_rw == UIO_WRITE) {
1362 error = uiomove(ptr, len, &uio);
1367 sce = &sc->sc_endpoints[endpt][IN];
1368 err = usbd_do_request_flags(sc->sc_udev, &ur->ucr_request,
1369 ptr, ur->ucr_flags, &ur->ucr_actlen, sce->timeout);
1375 if (uio.uio_rw == UIO_READ) {
1376 error = uiomove(ptr, len, &uio);
1386 case USB_GET_DEVICEINFO:
1387 usbd_fill_deviceinfo(sc->sc_udev,
1388 (struct usb_device_info *)addr, 1);
1397 ugenioctl(struct dev_ioctl_args *ap)
1399 cdev_t dev = ap->a_head.a_dev;
1400 int endpt = UGENENDPOINT(dev);
1401 struct ugen_softc *sc;
1404 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
1407 error = ugen_do_ioctl(sc, endpt, ap->a_cmd, ap->a_data, ap->a_fflag);
1408 if (--sc->sc_refcnt < 0)
1409 usb_detach_wakeup(sc->sc_dev);
1414 ugenpoll(struct dev_poll_args *ap)
1416 cdev_t dev = ap->a_head.a_dev;
1417 struct ugen_softc *sc;
1418 struct ugen_endpoint *sce;
1421 sc = devclass_get_softc(ugen_devclass, UGENUNIT(dev));
1427 sce = &sc->sc_endpoints[UGENENDPOINT(dev)][IN];
1432 kprintf("ugenpoll: no edesc\n");
1436 kprintf("ugenpoll: no pipe\n");
1441 switch (sce->edesc->bmAttributes & UE_XFERTYPE) {
1443 if (ap->a_events & (POLLIN | POLLRDNORM)) {
1444 if (sce->q.c_cc > 0)
1445 revents |= ap->a_events & (POLLIN | POLLRDNORM);
1447 selrecord(curthread, &sce->rsel);
1450 case UE_ISOCHRONOUS:
1451 if (ap->a_events & (POLLIN | POLLRDNORM)) {
1452 if (sce->cur != sce->fill)
1453 revents |= ap->a_events & (POLLIN | POLLRDNORM);
1455 selrecord(curthread, &sce->rsel);
1460 * We have no easy way of determining if a read will
1461 * yield any data or a write will happen.
1462 * Pretend they will.
1464 revents |= ap->a_events &
1465 (POLLIN | POLLRDNORM | POLLOUT | POLLWRNORM);
1471 ap->a_events = revents;
1475 DRIVER_MODULE(ugen, uhub, ugen_driver, ugen_devclass, usbd_driver_load, 0);