3 * Copyright (c) 2006-2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * usb_dev.c - An abstraction layer for creating devices under /dev/...
30 #ifdef USB_GLOBAL_INCLUDE_FILE
31 #include USB_GLOBAL_INCLUDE_FILE
33 #include <sys/stdint.h>
34 #include <sys/stddef.h>
35 #include <sys/param.h>
36 #include <sys/queue.h>
37 #include <sys/types.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
41 #include <sys/module.h>
43 #include <sys/mutex.h>
44 #include <sys/condvar.h>
45 #include <sys/sysctl.h>
47 #include <sys/unistd.h>
48 #include <sys/callout.h>
49 #include <sys/malloc.h>
51 #include <sys/vnode.h>
53 #include <sys/fcntl.h>
55 #include <dev/usb/usb.h>
56 #include <dev/usb/usb_ioctl.h>
57 #include <dev/usb/usbdi.h>
58 #include <dev/usb/usbdi_util.h>
60 #define USB_DEBUG_VAR usb_fifo_debug
62 #include <dev/usb/usb_core.h>
63 #include <dev/usb/usb_dev.h>
64 #include <dev/usb/usb_mbuf.h>
65 #include <dev/usb/usb_process.h>
66 #include <dev/usb/usb_device.h>
67 #include <dev/usb/usb_debug.h>
68 #include <dev/usb/usb_busdma.h>
69 #include <dev/usb/usb_generic.h>
70 #include <dev/usb/usb_dynamic.h>
71 #include <dev/usb/usb_util.h>
73 #include <dev/usb/usb_controller.h>
74 #include <dev/usb/usb_bus.h>
76 #include <sys/filio.h>
77 #include <sys/ttycom.h>
78 #include <sys/syscallsubr.h>
80 #include <machine/stdarg.h>
81 #endif /* USB_GLOBAL_INCLUDE_FILE */
86 static int usb_fifo_debug = 0;
88 static SYSCTL_NODE(_hw_usb, OID_AUTO, dev, CTLFLAG_RW, 0, "USB device");
89 SYSCTL_INT(_hw_usb_dev, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_TUN,
90 &usb_fifo_debug, 0, "Debug Level");
91 TUNABLE_INT("hw.usb.dev.debug", &usb_fifo_debug);
94 #if ((__FreeBSD_version >= 700001) || (__FreeBSD_version == 0) || \
95 ((__FreeBSD_version >= 600034) && (__FreeBSD_version < 700000)))
96 #define USB_UCRED struct ucred *ucred,
103 static int usb_fifo_open(struct usb_cdev_privdata *,
104 struct usb_fifo *, int);
105 static void usb_fifo_close(struct usb_fifo *, int);
106 static void usb_dev_init(void *);
107 static void usb_dev_init_post(void *);
108 static void usb_dev_uninit(void *);
109 static int usb_fifo_uiomove(struct usb_fifo *, void *, int,
111 static void usb_fifo_check_methods(struct usb_fifo_methods *);
112 static struct usb_fifo *usb_fifo_alloc(struct mtx *);
113 static struct usb_endpoint *usb_dev_get_ep(struct usb_device *, uint8_t,
115 static void usb_loc_fill(struct usb_fs_privdata *,
116 struct usb_cdev_privdata *);
117 static void usb_close(void *);
118 static usb_error_t usb_ref_device(struct usb_cdev_privdata *, struct usb_cdev_refdata *, int);
119 static usb_error_t usb_usb_ref_device(struct usb_cdev_privdata *, struct usb_cdev_refdata *);
120 static void usb_unref_device(struct usb_cdev_privdata *, struct usb_cdev_refdata *);
122 static d_open_t usb_open;
123 static d_ioctl_t usb_ioctl;
124 static d_read_t usb_read;
125 static d_write_t usb_write;
126 static d_poll_t usb_poll;
127 static d_kqfilter_t usb_kqfilter;
129 static d_ioctl_t usb_static_ioctl;
131 static usb_fifo_open_t usb_fifo_dummy_open;
132 static usb_fifo_close_t usb_fifo_dummy_close;
133 static usb_fifo_ioctl_t usb_fifo_dummy_ioctl;
134 static usb_fifo_cmd_t usb_fifo_dummy_cmd;
136 /* character device structure used for devices (/dev/ugenX.Y and /dev/uXXX) */
137 struct cdevsw usb_devsw = {
138 .d_version = D_VERSION,
140 .d_ioctl = usb_ioctl,
142 .d_flags = D_TRACKCLOSE,
144 .d_write = usb_write,
146 .d_kqfilter = usb_kqfilter,
149 static struct cdev* usb_dev = NULL;
151 /* character device structure used for /dev/usb */
152 static struct cdevsw usb_static_devsw = {
153 .d_version = D_VERSION,
154 .d_ioctl = usb_static_ioctl,
158 static TAILQ_HEAD(, usb_symlink) usb_sym_head;
159 static struct sx usb_sym_lock;
161 struct mtx usb_ref_lock;
163 /*------------------------------------------------------------------------*
166 * This is used to fill out a usb_cdev_privdata structure based on the
167 * device's address as contained in usb_fs_privdata.
168 *------------------------------------------------------------------------*/
170 usb_loc_fill(struct usb_fs_privdata* pd, struct usb_cdev_privdata *cpd)
172 cpd->bus_index = pd->bus_index;
173 cpd->dev_index = pd->dev_index;
174 cpd->ep_addr = pd->ep_addr;
175 cpd->fifo_index = pd->fifo_index;
178 /*------------------------------------------------------------------------*
181 * This function is used to atomically refer an USB device by its
182 * device location. If this function returns success the USB device
183 * will not dissappear until the USB device is unreferenced.
186 * 0: Success, refcount incremented on the given USB device.
188 *------------------------------------------------------------------------*/
190 usb_ref_device(struct usb_cdev_privdata *cpd,
191 struct usb_cdev_refdata *crd, int need_uref)
193 struct usb_fifo **ppf;
196 DPRINTFN(2, "cpd=%p need uref=%d\n", cpd, need_uref);
199 memset(crd, 0, sizeof(*crd));
201 mtx_lock(&usb_ref_lock);
202 cpd->bus = devclass_get_softc(usb_devclass_ptr, cpd->bus_index);
203 if (cpd->bus == NULL) {
204 DPRINTFN(2, "no bus at %u\n", cpd->bus_index);
207 cpd->udev = cpd->bus->devices[cpd->dev_index];
208 if (cpd->udev == NULL) {
209 DPRINTFN(2, "no device at %u\n", cpd->dev_index);
212 if (cpd->udev->state == USB_STATE_DETACHED &&
214 DPRINTFN(2, "device is detached\n");
218 DPRINTFN(2, "ref udev - needed\n");
220 if (cpd->udev->refcount == USB_DEV_REF_MAX) {
221 DPRINTFN(2, "no dev ref\n");
224 cpd->udev->refcount++;
226 mtx_unlock(&usb_ref_lock);
229 * We need to grab the enumeration SX-lock before
230 * grabbing the FIFO refs to avoid deadlock at detach!
232 crd->do_unlock = usbd_enum_lock_sig(cpd->udev);
234 mtx_lock(&usb_ref_lock);
237 * Set "is_uref" after grabbing the default SX lock
241 /* check for signal */
242 if (crd->do_unlock > 1) {
248 /* check if we are doing an open */
249 if (cpd->fflags == 0) {
250 /* use zero defaults */
252 /* check for write */
253 if (cpd->fflags & FWRITE) {
254 ppf = cpd->udev->fifo;
255 f = ppf[cpd->fifo_index + USB_FIFO_TX];
257 crd->is_write = 1; /* ref */
258 if (f == NULL || f->refcount == USB_FIFO_REF_MAX)
260 if (f->curr_cpd != cpd)
262 /* check if USB-FS is active */
263 if (f->fs_ep_max != 0) {
269 if (cpd->fflags & FREAD) {
270 ppf = cpd->udev->fifo;
271 f = ppf[cpd->fifo_index + USB_FIFO_RX];
273 crd->is_read = 1; /* ref */
274 if (f == NULL || f->refcount == USB_FIFO_REF_MAX)
276 if (f->curr_cpd != cpd)
278 /* check if USB-FS is active */
279 if (f->fs_ep_max != 0) {
285 /* when everything is OK we increment the refcounts */
287 DPRINTFN(2, "ref write\n");
288 crd->txfifo->refcount++;
291 DPRINTFN(2, "ref read\n");
292 crd->rxfifo->refcount++;
294 mtx_unlock(&usb_ref_lock);
300 usbd_enum_unlock(cpd->udev);
303 if (--(cpd->udev->refcount) == 0)
304 cv_broadcast(&cpd->udev->ref_cv);
306 mtx_unlock(&usb_ref_lock);
307 DPRINTFN(2, "fail\n");
310 memset(crd, 0, sizeof(*crd));
312 return (USB_ERR_INVAL);
315 /*------------------------------------------------------------------------*
318 * This function is used to upgrade an USB reference to include the
319 * USB device reference on a USB location.
322 * 0: Success, refcount incremented on the given USB device.
324 *------------------------------------------------------------------------*/
326 usb_usb_ref_device(struct usb_cdev_privdata *cpd,
327 struct usb_cdev_refdata *crd)
330 * Check if we already got an USB reference on this location:
333 return (0); /* success */
336 * To avoid deadlock at detach we need to drop the FIFO ref
337 * and re-acquire a new ref!
339 usb_unref_device(cpd, crd);
341 return (usb_ref_device(cpd, crd, 1 /* need uref */));
344 /*------------------------------------------------------------------------*
347 * This function will release the reference count by one unit for the
349 *------------------------------------------------------------------------*/
351 usb_unref_device(struct usb_cdev_privdata *cpd,
352 struct usb_cdev_refdata *crd)
355 DPRINTFN(2, "cpd=%p is_uref=%d\n", cpd, crd->is_uref);
358 usbd_enum_unlock(cpd->udev);
360 mtx_lock(&usb_ref_lock);
362 if (--(crd->rxfifo->refcount) == 0) {
363 cv_signal(&crd->rxfifo->cv_drain);
368 if (--(crd->txfifo->refcount) == 0) {
369 cv_signal(&crd->txfifo->cv_drain);
375 if (--(cpd->udev->refcount) == 0)
376 cv_broadcast(&cpd->udev->ref_cv);
378 mtx_unlock(&usb_ref_lock);
381 static struct usb_fifo *
382 usb_fifo_alloc(struct mtx *mtx)
386 f = malloc(sizeof(*f), M_USBDEV, M_WAITOK | M_ZERO);
388 cv_init(&f->cv_io, "FIFO-IO");
389 cv_init(&f->cv_drain, "FIFO-DRAIN");
392 knlist_init_mtx(&f->selinfo.si_note, mtx);
397 /*------------------------------------------------------------------------*
399 *------------------------------------------------------------------------*/
401 usb_fifo_create(struct usb_cdev_privdata *cpd,
402 struct usb_cdev_refdata *crd)
404 struct usb_device *udev = cpd->udev;
406 struct usb_endpoint *ep;
412 int e = cpd->ep_addr;
414 is_tx = (cpd->fflags & FWRITE) ? 1 : 0;
415 is_rx = (cpd->fflags & FREAD) ? 1 : 0;
419 /* Preallocated FIFO */
421 DPRINTFN(5, "Preallocated FIFO\n");
423 f = udev->fifo[cpd->fifo_index + USB_FIFO_TX];
429 f = udev->fifo[cpd->fifo_index + USB_FIFO_RX];
437 KASSERT(e >= 0 && e <= 15, ("endpoint %d out of range", e));
439 /* search for a free FIFO slot */
440 DPRINTFN(5, "Endpoint device, searching for 0x%02x\n", e);
441 for (n = 0;; n += 2) {
443 if (n == USB_FIFO_MAX) {
448 /* end of FIFOs reached */
449 DPRINTFN(5, "out of FIFOs\n");
453 /* Check for TX FIFO */
455 f = udev->fifo[n + USB_FIFO_TX];
457 if (f->dev_ep_index != e) {
458 /* wrong endpoint index */
461 if (f->curr_cpd != NULL) {
466 } else if (no_null) {
470 /* Check for RX FIFO */
472 f = udev->fifo[n + USB_FIFO_RX];
474 if (f->dev_ep_index != e) {
475 /* wrong endpoint index */
478 if (f->curr_cpd != NULL) {
483 } else if (no_null) {
491 if (e >= (USB_EP_MAX / 2)) {
492 /* we don't create any endpoints in this range */
493 DPRINTFN(5, "ep out of range\n");
494 return (is_busy ? EBUSY : EINVAL);
498 if ((e != 0) && is_busy) {
500 * Only the default control endpoint is allowed to be
501 * opened multiple times!
503 DPRINTFN(5, "busy\n");
509 (udev->fifo[n + USB_FIFO_TX] == NULL)) {
510 ep = usb_dev_get_ep(udev, e, USB_FIFO_TX);
511 DPRINTFN(5, "dev_get_endpoint(%d, 0x%x)\n", e, USB_FIFO_TX);
513 DPRINTFN(5, "dev_get_endpoint returned NULL\n");
516 f = usb_fifo_alloc(&udev->device_mtx);
518 DPRINTFN(5, "could not alloc tx fifo\n");
521 /* update some fields */
522 f->fifo_index = n + USB_FIFO_TX;
525 f->methods = &usb_ugen_methods;
526 f->iface_index = ep->iface_index;
528 mtx_lock(&usb_ref_lock);
529 udev->fifo[n + USB_FIFO_TX] = f;
530 mtx_unlock(&usb_ref_lock);
534 (udev->fifo[n + USB_FIFO_RX] == NULL)) {
536 ep = usb_dev_get_ep(udev, e, USB_FIFO_RX);
537 DPRINTFN(5, "dev_get_endpoint(%d, 0x%x)\n", e, USB_FIFO_RX);
539 DPRINTFN(5, "dev_get_endpoint returned NULL\n");
542 f = usb_fifo_alloc(&udev->device_mtx);
544 DPRINTFN(5, "could not alloc rx fifo\n");
547 /* update some fields */
548 f->fifo_index = n + USB_FIFO_RX;
551 f->methods = &usb_ugen_methods;
552 f->iface_index = ep->iface_index;
554 mtx_lock(&usb_ref_lock);
555 udev->fifo[n + USB_FIFO_RX] = f;
556 mtx_unlock(&usb_ref_lock);
559 crd->txfifo = udev->fifo[n + USB_FIFO_TX];
562 crd->rxfifo = udev->fifo[n + USB_FIFO_RX];
564 /* fill out fifo index */
565 DPRINTFN(5, "fifo index = %d\n", n);
574 usb_fifo_free(struct usb_fifo *f)
582 /* destroy symlink devices, if any */
583 for (n = 0; n != 2; n++) {
585 usb_free_symlink(f->symlink[n]);
586 f->symlink[n] = NULL;
589 mtx_lock(&usb_ref_lock);
591 /* delink ourselves to stop calls from userland */
592 if ((f->fifo_index < USB_FIFO_MAX) &&
594 (f->udev->fifo[f->fifo_index] == f)) {
595 f->udev->fifo[f->fifo_index] = NULL;
597 DPRINTFN(0, "USB FIFO %p has not been linked\n", f);
600 /* decrease refcount */
602 /* need to wait until all callers have exited */
603 while (f->refcount != 0) {
604 mtx_unlock(&usb_ref_lock); /* avoid LOR */
605 mtx_lock(f->priv_mtx);
606 /* prevent write flush, if any */
608 /* get I/O thread out of any sleep state */
609 if (f->flag_sleeping) {
610 f->flag_sleeping = 0;
611 cv_broadcast(&f->cv_io);
613 mtx_unlock(f->priv_mtx);
614 mtx_lock(&usb_ref_lock);
617 * Check if the "f->refcount" variable reached zero
618 * during the unlocked time before entering wait:
620 if (f->refcount == 0)
624 cv_wait(&f->cv_drain, &usb_ref_lock);
626 mtx_unlock(&usb_ref_lock);
628 /* take care of closing the device here, if any */
629 usb_fifo_close(f, 0);
631 cv_destroy(&f->cv_io);
632 cv_destroy(&f->cv_drain);
634 knlist_clear(&f->selinfo.si_note, 0);
635 seldrain(&f->selinfo);
636 knlist_destroy(&f->selinfo.si_note);
641 static struct usb_endpoint *
642 usb_dev_get_ep(struct usb_device *udev, uint8_t ep_index, uint8_t dir)
644 struct usb_endpoint *ep;
650 if (dir == USB_FIFO_RX) {
651 if (udev->flags.usb_mode == USB_MODE_HOST) {
657 if (udev->flags.usb_mode == USB_MODE_HOST) {
663 ep = usbd_get_ep_by_addr(udev, ep_index | ep_dir);
667 /* if the endpoint does not exist then return */
670 if (ep->edesc == NULL) {
671 /* invalid endpoint */
674 return (ep); /* success */
677 /*------------------------------------------------------------------------*
683 *------------------------------------------------------------------------*/
685 usb_fifo_open(struct usb_cdev_privdata *cpd,
686 struct usb_fifo *f, int fflags)
692 DPRINTFN(2, "no FIFO\n");
695 /* remove FWRITE and FREAD flags */
696 fflags &= ~(FWRITE | FREAD);
698 /* set correct file flags */
699 if ((f->fifo_index & 1) == USB_FIFO_TX) {
705 /* check if we are already opened */
706 /* we don't need any locks when checking this variable */
707 if (f->curr_cpd != NULL) {
712 /* reset short flag before open */
715 /* call open method */
716 err = (f->methods->f_open) (f, fflags);
720 mtx_lock(f->priv_mtx);
722 /* reset sleep flag */
723 f->flag_sleeping = 0;
725 /* reset error flag */
728 /* reset complete flag */
729 f->flag_iscomplete = 0;
731 /* reset select flag */
732 f->flag_isselect = 0;
734 /* reset flushing flag */
735 f->flag_flushing = 0;
737 /* reset ASYNC proc flag */
740 mtx_lock(&usb_ref_lock);
741 /* flag the fifo as opened to prevent others */
743 mtx_unlock(&usb_ref_lock);
748 mtx_unlock(f->priv_mtx);
753 /*------------------------------------------------------------------------*
755 *------------------------------------------------------------------------*/
757 usb_fifo_reset(struct usb_fifo *f)
765 USB_IF_DEQUEUE(&f->used_q, m);
767 USB_IF_ENQUEUE(&f->free_q, m);
772 /* reset have fragment flag */
773 f->flag_have_fragment = 0;
776 /*------------------------------------------------------------------------*
778 *------------------------------------------------------------------------*/
780 usb_fifo_close(struct usb_fifo *f, int fflags)
784 /* check if we are not opened */
785 if (f->curr_cpd == NULL) {
786 /* nothing to do - already closed */
789 mtx_lock(f->priv_mtx);
791 /* clear current cdev private data pointer */
792 mtx_lock(&usb_ref_lock);
794 mtx_unlock(&usb_ref_lock);
796 /* check if we are watched by kevent */
797 KNOTE_LOCKED(&f->selinfo.si_note, 0);
799 /* check if we are selected */
800 if (f->flag_isselect) {
801 selwakeup(&f->selinfo);
802 f->flag_isselect = 0;
804 /* check if a thread wants SIGIO */
805 if (f->async_p != NULL) {
806 PROC_LOCK(f->async_p);
807 kern_psignal(f->async_p, SIGIO);
808 PROC_UNLOCK(f->async_p);
811 /* remove FWRITE and FREAD flags */
812 fflags &= ~(FWRITE | FREAD);
814 /* flush written data, if any */
815 if ((f->fifo_index & 1) == USB_FIFO_TX) {
817 if (!f->flag_iserror) {
819 /* set flushing flag */
820 f->flag_flushing = 1;
822 /* get the last packet in */
823 if (f->flag_have_fragment) {
825 f->flag_have_fragment = 0;
826 USB_IF_DEQUEUE(&f->free_q, m);
828 USB_IF_ENQUEUE(&f->used_q, m);
832 /* start write transfer, if not already started */
833 (f->methods->f_start_write) (f);
835 /* check if flushed already */
836 while (f->flag_flushing &&
837 (!f->flag_iserror)) {
838 /* wait until all data has been written */
839 f->flag_sleeping = 1;
840 err = cv_timedwait_sig(&f->cv_io, f->priv_mtx,
841 USB_MS_TO_TICKS(USB_DEFAULT_TIMEOUT));
843 DPRINTF("signal received\n");
850 /* stop write transfer, if not already stopped */
851 (f->methods->f_stop_write) (f);
855 /* stop write transfer, if not already stopped */
856 (f->methods->f_stop_read) (f);
859 /* check if we are sleeping */
860 if (f->flag_sleeping) {
861 DPRINTFN(2, "Sleeping at close!\n");
863 mtx_unlock(f->priv_mtx);
865 /* call close method */
866 (f->methods->f_close) (f, fflags);
871 /*------------------------------------------------------------------------*
872 * usb_open - cdev callback
873 *------------------------------------------------------------------------*/
875 usb_open(struct cdev *dev, int fflags, int devtype, struct thread *td)
877 struct usb_fs_privdata* pd = (struct usb_fs_privdata*)dev->si_drv1;
878 struct usb_cdev_refdata refs;
879 struct usb_cdev_privdata *cpd;
882 DPRINTFN(2, "%s fflags=0x%08x\n", devtoname(dev), fflags);
884 KASSERT(fflags & (FREAD|FWRITE), ("invalid open flags"));
885 if (((fflags & FREAD) && !(pd->mode & FREAD)) ||
886 ((fflags & FWRITE) && !(pd->mode & FWRITE))) {
887 DPRINTFN(2, "access mode not supported\n");
891 cpd = malloc(sizeof(*cpd), M_USBDEV, M_WAITOK | M_ZERO);
892 ep = cpd->ep_addr = pd->ep_addr;
894 usb_loc_fill(pd, cpd);
895 err = usb_ref_device(cpd, &refs, 1);
897 DPRINTFN(2, "cannot ref device\n");
901 cpd->fflags = fflags; /* access mode for open lifetime */
903 /* create FIFOs, if any */
904 err = usb_fifo_create(cpd, &refs);
905 /* check for error */
907 DPRINTFN(2, "cannot create fifo\n");
908 usb_unref_device(cpd, &refs);
912 if (fflags & FREAD) {
913 err = usb_fifo_open(cpd, refs.rxfifo, fflags);
915 DPRINTFN(2, "read open failed\n");
916 usb_unref_device(cpd, &refs);
921 if (fflags & FWRITE) {
922 err = usb_fifo_open(cpd, refs.txfifo, fflags);
924 DPRINTFN(2, "write open failed\n");
925 if (fflags & FREAD) {
926 usb_fifo_close(refs.rxfifo, fflags);
928 usb_unref_device(cpd, &refs);
933 usb_unref_device(cpd, &refs);
934 devfs_set_cdevpriv(cpd, usb_close);
939 /*------------------------------------------------------------------------*
940 * usb_close - cdev callback
941 *------------------------------------------------------------------------*/
945 struct usb_cdev_refdata refs;
946 struct usb_cdev_privdata *cpd = arg;
949 DPRINTFN(2, "cpd=%p\n", cpd);
951 err = usb_ref_device(cpd, &refs,
952 2 /* uref and allow detached state */);
954 DPRINTFN(2, "Cannot grab USB reference when "
955 "closing USB file handle\n");
958 if (cpd->fflags & FREAD) {
959 usb_fifo_close(refs.rxfifo, cpd->fflags);
961 if (cpd->fflags & FWRITE) {
962 usb_fifo_close(refs.txfifo, cpd->fflags);
964 usb_unref_device(cpd, &refs);
970 usb_dev_init(void *arg)
972 mtx_init(&usb_ref_lock, "USB ref mutex", NULL, MTX_DEF);
973 sx_init(&usb_sym_lock, "USB sym mutex");
974 TAILQ_INIT(&usb_sym_head);
976 /* check the UGEN methods */
977 usb_fifo_check_methods(&usb_ugen_methods);
980 SYSINIT(usb_dev_init, SI_SUB_KLD, SI_ORDER_FIRST, usb_dev_init, NULL);
983 usb_dev_init_post(void *arg)
986 * Create /dev/usb - this is needed for usbconfig(8), which
987 * needs a well-known device name to access.
989 usb_dev = make_dev(&usb_static_devsw, 0, UID_ROOT, GID_OPERATOR,
990 0644, USB_DEVICE_NAME);
991 if (usb_dev == NULL) {
992 DPRINTFN(0, "Could not create usb bus device\n");
996 SYSINIT(usb_dev_init_post, SI_SUB_KICK_SCHEDULER, SI_ORDER_FIRST, usb_dev_init_post, NULL);
999 usb_dev_uninit(void *arg)
1001 if (usb_dev != NULL) {
1002 destroy_dev(usb_dev);
1005 mtx_destroy(&usb_ref_lock);
1006 sx_destroy(&usb_sym_lock);
1009 SYSUNINIT(usb_dev_uninit, SI_SUB_KICK_SCHEDULER, SI_ORDER_ANY, usb_dev_uninit, NULL);
1012 usb_ioctl_f_sub(struct usb_fifo *f, u_long cmd, void *addr,
1019 *(int *)addr = 0; /* character device */
1023 /* handled by upper FS layer */
1028 if (f->async_p != NULL) {
1032 f->async_p = USB_TD_GET_PROC(td);
1038 /* XXX this is not the most general solution */
1040 if (f->async_p == NULL) {
1044 if (*(int *)addr != USB_PROC_GET_GID(f->async_p)) {
1052 DPRINTFN(3, "cmd 0x%lx = %d\n", cmd, error);
1056 /*------------------------------------------------------------------------*
1057 * usb_ioctl - cdev callback
1058 *------------------------------------------------------------------------*/
1060 usb_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int fflag, struct thread* td)
1062 struct usb_cdev_refdata refs;
1063 struct usb_cdev_privdata* cpd;
1068 DPRINTFN(2, "cmd=0x%lx\n", cmd);
1070 err = devfs_get_cdevpriv((void **)&cpd);
1075 * Performance optimisation: We try to check for IOCTL's that
1076 * don't need the USB reference first. Then we grab the USB
1077 * reference if we need it!
1079 err = usb_ref_device(cpd, &refs, 0 /* no uref */ );
1083 fflags = cpd->fflags;
1085 f = NULL; /* set default value */
1086 err = ENOIOCTL; /* set default value */
1088 if (fflags & FWRITE) {
1090 err = usb_ioctl_f_sub(f, cmd, addr, td);
1092 if (fflags & FREAD) {
1094 err = usb_ioctl_f_sub(f, cmd, addr, td);
1096 KASSERT(f != NULL, ("fifo not found"));
1097 if (err != ENOIOCTL)
1100 err = (f->methods->f_ioctl) (f, cmd, addr, fflags);
1102 DPRINTFN(2, "f_ioctl cmd 0x%lx = %d\n", cmd, err);
1104 if (err != ENOIOCTL)
1107 if (usb_usb_ref_device(cpd, &refs)) {
1108 /* we lost the reference */
1112 err = (f->methods->f_ioctl_post) (f, cmd, addr, fflags);
1114 DPRINTFN(2, "f_ioctl_post cmd 0x%lx = %d\n", cmd, err);
1116 if (err == ENOIOCTL)
1122 /* Wait for re-enumeration, if any */
1124 while (f->udev->re_enumerate_wait != USB_RE_ENUM_DONE) {
1126 usb_unref_device(cpd, &refs);
1128 usb_pause_mtx(NULL, hz / 128);
1130 while (usb_ref_device(cpd, &refs, 1 /* need uref */)) {
1131 if (usb_ref_device(cpd, &refs, 0)) {
1132 /* device no longer exists */
1135 usb_unref_device(cpd, &refs);
1136 usb_pause_mtx(NULL, hz / 128);
1141 usb_unref_device(cpd, &refs);
1146 usb_filter_detach(struct knote *kn)
1148 struct usb_fifo *f = kn->kn_hook;
1149 knlist_remove(&f->selinfo.si_note, kn, 0);
1153 usb_filter_write(struct knote *kn, long hint)
1155 struct usb_cdev_privdata* cpd;
1163 mtx_assert(f->priv_mtx, MA_OWNED);
1168 } else if (f->fs_ep_max == 0) {
1169 if (f->flag_iserror) {
1170 /* we got an error */
1173 if (f->queue_data == NULL) {
1175 * start write transfer, if not
1178 (f->methods->f_start_write) (f);
1180 /* check if any packets are available */
1181 USB_IF_POLL(&f->free_q, m);
1184 if (f->flag_iscomplete) {
1194 usb_filter_read(struct knote *kn, long hint)
1196 struct usb_cdev_privdata* cpd;
1204 mtx_assert(f->priv_mtx, MA_OWNED);
1209 } else if (f->fs_ep_max == 0) {
1210 if (f->flag_iserror) {
1211 /* we have an error */
1214 if (f->queue_data == NULL) {
1216 * start read transfer, if not
1219 (f->methods->f_start_read) (f);
1221 /* check if any packets are available */
1222 USB_IF_POLL(&f->used_q, m);
1224 /* start reading data, if any */
1226 (f->methods->f_start_read) (f);
1229 if (f->flag_iscomplete) {
1238 static struct filterops usb_filtops_write = {
1240 .f_detach = usb_filter_detach,
1241 .f_event = usb_filter_write,
1244 static struct filterops usb_filtops_read = {
1246 .f_detach = usb_filter_detach,
1247 .f_event = usb_filter_read,
1253 usb_kqfilter(struct cdev* dev, struct knote *kn)
1255 struct usb_cdev_refdata refs;
1256 struct usb_cdev_privdata* cpd;
1263 if (devfs_get_cdevpriv((void **)&cpd) != 0 ||
1264 usb_ref_device(cpd, &refs, 0) != 0)
1267 fflags = cpd->fflags;
1269 /* Figure out who needs service */
1270 switch (kn->kn_filter) {
1272 if (fflags & FWRITE) {
1274 kn->kn_fop = &usb_filtops_write;
1279 if (fflags & FREAD) {
1281 kn->kn_fop = &usb_filtops_read;
1292 mtx_lock(f->priv_mtx);
1293 knlist_add(&f->selinfo.si_note, kn, 1);
1294 mtx_unlock(f->priv_mtx);
1297 usb_unref_device(cpd, &refs);
1303 usb_poll(struct cdev* dev, int events, struct thread* td)
1305 struct usb_cdev_refdata refs;
1306 struct usb_cdev_privdata* cpd;
1309 int fflags, revents;
1311 if (devfs_get_cdevpriv((void **)&cpd) != 0 ||
1312 usb_ref_device(cpd, &refs, 0) != 0)
1314 (POLLHUP|POLLIN|POLLRDNORM|POLLOUT|POLLWRNORM));
1316 fflags = cpd->fflags;
1318 /* Figure out who needs service */
1320 if ((events & (POLLOUT | POLLWRNORM)) &&
1321 (fflags & FWRITE)) {
1325 mtx_lock(f->priv_mtx);
1327 if (!refs.is_usbfs) {
1328 if (f->flag_iserror) {
1329 /* we got an error */
1332 if (f->queue_data == NULL) {
1334 * start write transfer, if not
1337 (f->methods->f_start_write) (f);
1339 /* check if any packets are available */
1340 USB_IF_POLL(&f->free_q, m);
1343 if (f->flag_iscomplete) {
1351 revents |= events & (POLLOUT | POLLWRNORM);
1353 f->flag_isselect = 1;
1354 selrecord(td, &f->selinfo);
1357 mtx_unlock(f->priv_mtx);
1359 if ((events & (POLLIN | POLLRDNORM)) &&
1364 mtx_lock(f->priv_mtx);
1366 if (!refs.is_usbfs) {
1367 if (f->flag_iserror) {
1368 /* we have an error */
1371 if (f->queue_data == NULL) {
1373 * start read transfer, if not
1376 (f->methods->f_start_read) (f);
1378 /* check if any packets are available */
1379 USB_IF_POLL(&f->used_q, m);
1382 if (f->flag_iscomplete) {
1390 revents |= events & (POLLIN | POLLRDNORM);
1392 f->flag_isselect = 1;
1393 selrecord(td, &f->selinfo);
1395 if (!refs.is_usbfs) {
1396 /* start reading data */
1397 (f->methods->f_start_read) (f);
1401 mtx_unlock(f->priv_mtx);
1403 usb_unref_device(cpd, &refs);
1408 usb_read(struct cdev *dev, struct uio *uio, int ioflag)
1410 struct usb_cdev_refdata refs;
1411 struct usb_cdev_privdata* cpd;
1418 uint8_t tr_data = 0;
1420 err = devfs_get_cdevpriv((void **)&cpd);
1424 err = usb_ref_device(cpd, &refs, 0 /* no uref */ );
1428 fflags = cpd->fflags;
1432 /* should not happen */
1433 usb_unref_device(cpd, &refs);
1437 resid = uio->uio_resid;
1439 mtx_lock(f->priv_mtx);
1441 /* check for permanent read error */
1442 if (f->flag_iserror) {
1446 /* check if USB-FS interface is active */
1447 if (refs.is_usbfs) {
1449 * The queue is used for events that should be
1450 * retrieved using the "USB_FS_COMPLETE" ioctl.
1455 while (uio->uio_resid > 0) {
1457 USB_IF_DEQUEUE(&f->used_q, m);
1461 /* start read transfer, if not already started */
1463 (f->methods->f_start_read) (f);
1465 if (ioflag & IO_NDELAY) {
1467 /* return length before error */
1473 DPRINTF("sleeping\n");
1475 err = usb_fifo_wait(f);
1481 if (f->methods->f_filter_read) {
1483 * Sometimes it is convenient to process data at the
1484 * expense of a userland process instead of a kernel
1487 (f->methods->f_filter_read) (f, m);
1491 io_len = MIN(m->cur_data_len, uio->uio_resid);
1493 DPRINTFN(2, "transfer %d bytes from %p\n",
1494 io_len, m->cur_data_ptr);
1496 err = usb_fifo_uiomove(f,
1497 m->cur_data_ptr, io_len, uio);
1499 m->cur_data_len -= io_len;
1500 m->cur_data_ptr += io_len;
1502 if (m->cur_data_len == 0) {
1504 uint8_t last_packet;
1506 last_packet = m->last_packet;
1508 USB_IF_ENQUEUE(&f->free_q, m);
1515 USB_IF_PREPEND(&f->used_q, m);
1523 mtx_unlock(f->priv_mtx);
1525 usb_unref_device(cpd, &refs);
1531 usb_write(struct cdev *dev, struct uio *uio, int ioflag)
1533 struct usb_cdev_refdata refs;
1534 struct usb_cdev_privdata* cpd;
1542 uint8_t tr_data = 0;
1546 err = devfs_get_cdevpriv((void **)&cpd);
1550 err = usb_ref_device(cpd, &refs, 0 /* no uref */ );
1554 fflags = cpd->fflags;
1558 /* should not happen */
1559 usb_unref_device(cpd, &refs);
1562 resid = uio->uio_resid;
1564 mtx_lock(f->priv_mtx);
1566 /* check for permanent write error */
1567 if (f->flag_iserror) {
1571 /* check if USB-FS interface is active */
1572 if (refs.is_usbfs) {
1574 * The queue is used for events that should be
1575 * retrieved using the "USB_FS_COMPLETE" ioctl.
1580 if (f->queue_data == NULL) {
1581 /* start write transfer, if not already started */
1582 (f->methods->f_start_write) (f);
1584 /* we allow writing zero length data */
1586 USB_IF_DEQUEUE(&f->free_q, m);
1590 if (ioflag & IO_NDELAY) {
1592 /* return length before error */
1598 DPRINTF("sleeping\n");
1600 err = usb_fifo_wait(f);
1608 if (f->flag_have_fragment == 0) {
1610 io_len = m->cur_data_len;
1611 pdata = m->cur_data_ptr;
1612 if (io_len > uio->uio_resid)
1613 io_len = uio->uio_resid;
1614 m->cur_data_len = io_len;
1616 io_len = m->max_data_len - m->cur_data_len;
1617 pdata = m->cur_data_ptr + m->cur_data_len;
1618 if (io_len > uio->uio_resid)
1619 io_len = uio->uio_resid;
1620 m->cur_data_len += io_len;
1623 DPRINTFN(2, "transfer %d bytes to %p\n",
1626 err = usb_fifo_uiomove(f, pdata, io_len, uio);
1629 f->flag_have_fragment = 0;
1630 USB_IF_ENQUEUE(&f->free_q, m);
1634 /* check if the buffer is ready to be transmitted */
1636 if ((f->flag_write_defrag == 0) ||
1637 (m->cur_data_len == m->max_data_len)) {
1638 f->flag_have_fragment = 0;
1641 * Check for write filter:
1643 * Sometimes it is convenient to process data
1644 * at the expense of a userland process
1645 * instead of a kernel process.
1647 if (f->methods->f_filter_write) {
1648 (f->methods->f_filter_write) (f, m);
1651 /* Put USB mbuf in the used queue */
1652 USB_IF_ENQUEUE(&f->used_q, m);
1654 /* Start writing data, if not already started */
1655 (f->methods->f_start_write) (f);
1657 /* Wait for more data or close */
1658 f->flag_have_fragment = 1;
1659 USB_IF_PREPEND(&f->free_q, m);
1662 } while (uio->uio_resid > 0);
1664 mtx_unlock(f->priv_mtx);
1666 usb_unref_device(cpd, &refs);
1672 usb_static_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
1676 struct usb_read_dir *urd;
1684 err = usb_read_symlink(u.urd->urd_data,
1685 u.urd->urd_startentry, u.urd->urd_maxlen);
1687 case USB_DEV_QUIRK_GET:
1688 case USB_QUIRK_NAME_GET:
1689 case USB_DEV_QUIRK_ADD:
1690 case USB_DEV_QUIRK_REMOVE:
1691 err = usb_quirk_ioctl_p(cmd, data, fflag, td);
1693 case USB_GET_TEMPLATE:
1694 *(int *)data = usb_template;
1697 case USB_SET_TEMPLATE:
1698 err = priv_check(curthread, PRIV_DRIVER);
1701 usb_template = *(int *)data;
1711 usb_fifo_uiomove(struct usb_fifo *f, void *cp,
1712 int n, struct uio *uio)
1716 mtx_unlock(f->priv_mtx);
1719 * "uiomove()" can sleep so one needs to make a wrapper,
1720 * exiting the mutex and checking things:
1722 error = uiomove(cp, n, uio);
1724 mtx_lock(f->priv_mtx);
1730 usb_fifo_wait(struct usb_fifo *f)
1734 mtx_assert(f->priv_mtx, MA_OWNED);
1736 if (f->flag_iserror) {
1740 f->flag_sleeping = 1;
1742 err = cv_wait_sig(&f->cv_io, f->priv_mtx);
1744 if (f->flag_iserror) {
1752 usb_fifo_signal(struct usb_fifo *f)
1754 if (f->flag_sleeping) {
1755 f->flag_sleeping = 0;
1756 cv_broadcast(&f->cv_io);
1761 usb_fifo_wakeup(struct usb_fifo *f)
1765 KNOTE_LOCKED(&f->selinfo.si_note, 0);
1767 if (f->flag_isselect) {
1768 selwakeup(&f->selinfo);
1769 f->flag_isselect = 0;
1771 if (f->async_p != NULL) {
1772 PROC_LOCK(f->async_p);
1773 kern_psignal(f->async_p, SIGIO);
1774 PROC_UNLOCK(f->async_p);
1779 usb_fifo_dummy_open(struct usb_fifo *fifo, int fflags)
1785 usb_fifo_dummy_close(struct usb_fifo *fifo, int fflags)
1791 usb_fifo_dummy_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags)
1797 usb_fifo_dummy_cmd(struct usb_fifo *fifo)
1799 fifo->flag_flushing = 0; /* not flushing */
1803 usb_fifo_check_methods(struct usb_fifo_methods *pm)
1805 /* check that all callback functions are OK */
1807 if (pm->f_open == NULL)
1808 pm->f_open = &usb_fifo_dummy_open;
1810 if (pm->f_close == NULL)
1811 pm->f_close = &usb_fifo_dummy_close;
1813 if (pm->f_ioctl == NULL)
1814 pm->f_ioctl = &usb_fifo_dummy_ioctl;
1816 if (pm->f_ioctl_post == NULL)
1817 pm->f_ioctl_post = &usb_fifo_dummy_ioctl;
1819 if (pm->f_start_read == NULL)
1820 pm->f_start_read = &usb_fifo_dummy_cmd;
1822 if (pm->f_stop_read == NULL)
1823 pm->f_stop_read = &usb_fifo_dummy_cmd;
1825 if (pm->f_start_write == NULL)
1826 pm->f_start_write = &usb_fifo_dummy_cmd;
1828 if (pm->f_stop_write == NULL)
1829 pm->f_stop_write = &usb_fifo_dummy_cmd;
1832 /*------------------------------------------------------------------------*
1835 * The following function will create a duplex FIFO.
1840 *------------------------------------------------------------------------*/
1842 usb_fifo_attach(struct usb_device *udev, void *priv_sc,
1843 struct mtx *priv_mtx, struct usb_fifo_methods *pm,
1844 struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit,
1845 uint8_t iface_index, uid_t uid, gid_t gid, int mode)
1847 struct usb_fifo *f_tx;
1848 struct usb_fifo *f_rx;
1852 f_sc->fp[USB_FIFO_TX] = NULL;
1853 f_sc->fp[USB_FIFO_RX] = NULL;
1858 /* check the methods */
1859 usb_fifo_check_methods(pm);
1861 if (priv_mtx == NULL)
1864 /* search for a free FIFO slot */
1865 for (n = 0;; n += 2) {
1867 if (n == USB_FIFO_MAX) {
1868 /* end of FIFOs reached */
1871 /* Check for TX FIFO */
1872 if (udev->fifo[n + USB_FIFO_TX] != NULL) {
1875 /* Check for RX FIFO */
1876 if (udev->fifo[n + USB_FIFO_RX] != NULL) {
1882 f_tx = usb_fifo_alloc(priv_mtx);
1883 f_rx = usb_fifo_alloc(priv_mtx);
1885 if ((f_tx == NULL) || (f_rx == NULL)) {
1886 usb_fifo_free(f_tx);
1887 usb_fifo_free(f_rx);
1890 /* initialise FIFO structures */
1892 f_tx->fifo_index = n + USB_FIFO_TX;
1893 f_tx->dev_ep_index = -1;
1894 f_tx->priv_sc0 = priv_sc;
1896 f_tx->iface_index = iface_index;
1899 f_rx->fifo_index = n + USB_FIFO_RX;
1900 f_rx->dev_ep_index = -1;
1901 f_rx->priv_sc0 = priv_sc;
1903 f_rx->iface_index = iface_index;
1906 f_sc->fp[USB_FIFO_TX] = f_tx;
1907 f_sc->fp[USB_FIFO_RX] = f_rx;
1909 mtx_lock(&usb_ref_lock);
1910 udev->fifo[f_tx->fifo_index] = f_tx;
1911 udev->fifo[f_rx->fifo_index] = f_rx;
1912 mtx_unlock(&usb_ref_lock);
1914 for (n = 0; n != 4; n++) {
1916 if (pm->basename[n] == NULL) {
1920 if (snprintf(devname, sizeof(devname),
1921 "%s%u%s", pm->basename[n],
1922 unit, pm->postfix[n] ?
1923 pm->postfix[n] : "")) {
1927 if (snprintf(devname, sizeof(devname),
1928 "%s%u.%d%s", pm->basename[n],
1929 unit, subunit, pm->postfix[n] ?
1930 pm->postfix[n] : "")) {
1936 * Distribute the symbolic links into two FIFO structures:
1939 f_rx->symlink[n / 2] =
1940 usb_alloc_symlink(devname);
1942 f_tx->symlink[n / 2] =
1943 usb_alloc_symlink(devname);
1946 /* Create the device */
1947 f_sc->dev = usb_make_dev(udev, devname, -1,
1948 f_tx->fifo_index & f_rx->fifo_index,
1949 FREAD|FWRITE, uid, gid, mode);
1952 DPRINTFN(2, "attached %p/%p\n", f_tx, f_rx);
1956 /*------------------------------------------------------------------------*
1957 * usb_fifo_alloc_buffer
1962 *------------------------------------------------------------------------*/
1964 usb_fifo_alloc_buffer(struct usb_fifo *f, usb_size_t bufsize,
1967 usb_fifo_free_buffer(f);
1969 /* allocate an endpoint */
1970 f->free_q.ifq_maxlen = nbuf;
1971 f->used_q.ifq_maxlen = nbuf;
1973 f->queue_data = usb_alloc_mbufs(
1974 M_USBDEV, &f->free_q, bufsize, nbuf);
1976 if ((f->queue_data == NULL) && bufsize && nbuf) {
1979 return (0); /* success */
1982 /*------------------------------------------------------------------------*
1983 * usb_fifo_free_buffer
1985 * This function will free the buffers associated with a FIFO. This
1986 * function can be called multiple times in a row.
1987 *------------------------------------------------------------------------*/
1989 usb_fifo_free_buffer(struct usb_fifo *f)
1991 if (f->queue_data) {
1992 /* free old buffer */
1993 free(f->queue_data, M_USBDEV);
1994 f->queue_data = NULL;
1998 memset(&f->free_q, 0, sizeof(f->free_q));
1999 memset(&f->used_q, 0, sizeof(f->used_q));
2003 usb_fifo_detach(struct usb_fifo_sc *f_sc)
2008 usb_fifo_free(f_sc->fp[USB_FIFO_TX]);
2009 usb_fifo_free(f_sc->fp[USB_FIFO_RX]);
2011 f_sc->fp[USB_FIFO_TX] = NULL;
2012 f_sc->fp[USB_FIFO_RX] = NULL;
2014 usb_destroy_dev(f_sc->dev);
2018 DPRINTFN(2, "detached %p\n", f_sc);
2022 usb_fifo_put_bytes_max(struct usb_fifo *f)
2027 USB_IF_POLL(&f->free_q, m);
2030 len = m->max_data_len;
2037 /*------------------------------------------------------------------------*
2041 * 0 - normal operation
2042 * 1 - set last packet flag to enforce framing
2043 *------------------------------------------------------------------------*/
2045 usb_fifo_put_data(struct usb_fifo *f, struct usb_page_cache *pc,
2046 usb_frlength_t offset, usb_frlength_t len, uint8_t what)
2049 usb_frlength_t io_len;
2051 while (len || (what == 1)) {
2053 USB_IF_DEQUEUE(&f->free_q, m);
2058 io_len = MIN(len, m->cur_data_len);
2060 usbd_copy_out(pc, offset, m->cur_data_ptr, io_len);
2062 m->cur_data_len = io_len;
2066 if ((len == 0) && (what == 1)) {
2069 USB_IF_ENQUEUE(&f->used_q, m);
2073 if ((len == 0) || (what == 1)) {
2083 usb_fifo_put_data_linear(struct usb_fifo *f, void *ptr,
2084 usb_size_t len, uint8_t what)
2089 while (len || (what == 1)) {
2091 USB_IF_DEQUEUE(&f->free_q, m);
2096 io_len = MIN(len, m->cur_data_len);
2098 memcpy(m->cur_data_ptr, ptr, io_len);
2100 m->cur_data_len = io_len;
2101 ptr = USB_ADD_BYTES(ptr, io_len);
2104 if ((len == 0) && (what == 1)) {
2107 USB_IF_ENQUEUE(&f->used_q, m);
2111 if ((len == 0) || (what == 1)) {
2121 usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len)
2125 USB_IF_DEQUEUE(&f->free_q, m);
2128 m->cur_data_len = len;
2129 m->cur_data_ptr = ptr;
2130 USB_IF_ENQUEUE(&f->used_q, m);
2138 usb_fifo_put_data_error(struct usb_fifo *f)
2140 f->flag_iserror = 1;
2144 /*------------------------------------------------------------------------*
2148 * 0 - normal operation
2149 * 1 - only get one "usb_mbuf"
2153 * 1 - data in buffer
2154 *------------------------------------------------------------------------*/
2156 usb_fifo_get_data(struct usb_fifo *f, struct usb_page_cache *pc,
2157 usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
2161 usb_frlength_t io_len;
2162 uint8_t tr_data = 0;
2168 USB_IF_DEQUEUE(&f->used_q, m);
2174 io_len = MIN(len, m->cur_data_len);
2176 usbd_copy_in(pc, offset, m->cur_data_ptr, io_len);
2180 actlen[0] += io_len;
2181 m->cur_data_ptr += io_len;
2182 m->cur_data_len -= io_len;
2184 if ((m->cur_data_len == 0) || (what == 1)) {
2185 USB_IF_ENQUEUE(&f->free_q, m);
2193 USB_IF_PREPEND(&f->used_q, m);
2198 /* wait for data to be written out */
2201 if (f->flag_flushing) {
2202 /* check if we should send a short packet */
2203 if (f->flag_short != 0) {
2208 /* flushing complete */
2209 f->flag_flushing = 0;
2222 usb_fifo_get_data_linear(struct usb_fifo *f, void *ptr,
2223 usb_size_t len, usb_size_t *actlen, uint8_t what)
2227 uint8_t tr_data = 0;
2233 USB_IF_DEQUEUE(&f->used_q, m);
2239 io_len = MIN(len, m->cur_data_len);
2241 memcpy(ptr, m->cur_data_ptr, io_len);
2244 ptr = USB_ADD_BYTES(ptr, io_len);
2245 actlen[0] += io_len;
2246 m->cur_data_ptr += io_len;
2247 m->cur_data_len -= io_len;
2249 if ((m->cur_data_len == 0) || (what == 1)) {
2250 USB_IF_ENQUEUE(&f->free_q, m);
2258 USB_IF_PREPEND(&f->used_q, m);
2263 /* wait for data to be written out */
2266 if (f->flag_flushing) {
2267 /* check if we should send a short packet */
2268 if (f->flag_short != 0) {
2273 /* flushing complete */
2274 f->flag_flushing = 0;
2287 usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr, usb_size_t *plen)
2291 USB_IF_POLL(&f->used_q, m);
2294 *plen = m->cur_data_len;
2295 *pptr = m->cur_data_ptr;
2303 usb_fifo_get_data_error(struct usb_fifo *f)
2305 f->flag_iserror = 1;
2309 /*------------------------------------------------------------------------*
2314 * Else: Pointer to symlink entry
2315 *------------------------------------------------------------------------*/
2316 struct usb_symlink *
2317 usb_alloc_symlink(const char *target)
2319 struct usb_symlink *ps;
2321 ps = malloc(sizeof(*ps), M_USBDEV, M_WAITOK);
2325 /* XXX no longer needed */
2326 strlcpy(ps->src_path, target, sizeof(ps->src_path));
2327 ps->src_len = strlen(ps->src_path);
2328 strlcpy(ps->dst_path, target, sizeof(ps->dst_path));
2329 ps->dst_len = strlen(ps->dst_path);
2331 sx_xlock(&usb_sym_lock);
2332 TAILQ_INSERT_TAIL(&usb_sym_head, ps, sym_entry);
2333 sx_unlock(&usb_sym_lock);
2337 /*------------------------------------------------------------------------*
2339 *------------------------------------------------------------------------*/
2341 usb_free_symlink(struct usb_symlink *ps)
2346 sx_xlock(&usb_sym_lock);
2347 TAILQ_REMOVE(&usb_sym_head, ps, sym_entry);
2348 sx_unlock(&usb_sym_lock);
2353 /*------------------------------------------------------------------------*
2359 *------------------------------------------------------------------------*/
2361 usb_read_symlink(uint8_t *user_ptr, uint32_t startentry, uint32_t user_len)
2363 struct usb_symlink *ps;
2369 sx_xlock(&usb_sym_lock);
2371 TAILQ_FOREACH(ps, &usb_sym_head, sym_entry) {
2374 * Compute total length of source and destination symlink
2375 * strings pluss one length byte and two NUL bytes:
2377 temp = ps->src_len + ps->dst_len + 3;
2381 * Skip entry because this length cannot fit
2386 if (startentry != 0) {
2387 /* decrement read offset */
2391 if (temp > user_len) {
2392 /* out of buffer space */
2397 /* copy out total length */
2399 error = copyout(&len,
2400 USB_ADD_BYTES(user_ptr, delta), 1);
2406 /* copy out source string */
2408 error = copyout(ps->src_path,
2409 USB_ADD_BYTES(user_ptr, delta), ps->src_len);
2414 delta += ps->src_len;
2415 error = copyout(&len,
2416 USB_ADD_BYTES(user_ptr, delta), 1);
2422 /* copy out destination string */
2424 error = copyout(ps->dst_path,
2425 USB_ADD_BYTES(user_ptr, delta), ps->dst_len);
2430 delta += ps->dst_len;
2431 error = copyout(&len,
2432 USB_ADD_BYTES(user_ptr, delta), 1);
2441 /* a zero length entry indicates the end */
2443 if ((user_len != 0) && (error == 0)) {
2447 error = copyout(&len,
2448 USB_ADD_BYTES(user_ptr, delta), 1);
2450 sx_unlock(&usb_sym_lock);
2455 usb_fifo_set_close_zlp(struct usb_fifo *f, uint8_t onoff)
2460 /* send a Zero Length Packet, ZLP, before close */
2461 f->flag_short = onoff;
2465 usb_fifo_set_write_defrag(struct usb_fifo *f, uint8_t onoff)
2470 /* defrag written data */
2471 f->flag_write_defrag = onoff;
2472 /* reset defrag state */
2473 f->flag_have_fragment = 0;
2477 usb_fifo_softc(struct usb_fifo *f)
2479 return (f->priv_sc0);
2481 #endif /* USB_HAVE_UGEN */