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(cpd->udev);
234 mtx_lock(&usb_ref_lock);
237 * Set "is_uref" after grabbing the default SX lock
242 /* check if we are doing an open */
243 if (cpd->fflags == 0) {
244 /* use zero defaults */
246 /* check for write */
247 if (cpd->fflags & FWRITE) {
248 ppf = cpd->udev->fifo;
249 f = ppf[cpd->fifo_index + USB_FIFO_TX];
251 crd->is_write = 1; /* ref */
252 if (f == NULL || f->refcount == USB_FIFO_REF_MAX)
254 if (f->curr_cpd != cpd)
256 /* check if USB-FS is active */
257 if (f->fs_ep_max != 0) {
263 if (cpd->fflags & FREAD) {
264 ppf = cpd->udev->fifo;
265 f = ppf[cpd->fifo_index + USB_FIFO_RX];
267 crd->is_read = 1; /* ref */
268 if (f == NULL || f->refcount == USB_FIFO_REF_MAX)
270 if (f->curr_cpd != cpd)
272 /* check if USB-FS is active */
273 if (f->fs_ep_max != 0) {
279 /* when everything is OK we increment the refcounts */
281 DPRINTFN(2, "ref write\n");
282 crd->txfifo->refcount++;
285 DPRINTFN(2, "ref read\n");
286 crd->rxfifo->refcount++;
288 mtx_unlock(&usb_ref_lock);
294 usbd_enum_unlock(cpd->udev);
297 cpd->udev->refcount--;
298 cv_broadcast(&cpd->udev->ref_cv);
300 mtx_unlock(&usb_ref_lock);
301 DPRINTFN(2, "fail\n");
302 return (USB_ERR_INVAL);
305 /*------------------------------------------------------------------------*
308 * This function is used to upgrade an USB reference to include the
309 * USB device reference on a USB location.
312 * 0: Success, refcount incremented on the given USB device.
314 *------------------------------------------------------------------------*/
316 usb_usb_ref_device(struct usb_cdev_privdata *cpd,
317 struct usb_cdev_refdata *crd)
320 * Check if we already got an USB reference on this location:
323 return (0); /* success */
326 * To avoid deadlock at detach we need to drop the FIFO ref
327 * and re-acquire a new ref!
329 usb_unref_device(cpd, crd);
331 return (usb_ref_device(cpd, crd, 1 /* need uref */));
334 /*------------------------------------------------------------------------*
337 * This function will release the reference count by one unit for the
339 *------------------------------------------------------------------------*/
341 usb_unref_device(struct usb_cdev_privdata *cpd,
342 struct usb_cdev_refdata *crd)
345 DPRINTFN(2, "cpd=%p is_uref=%d\n", cpd, crd->is_uref);
348 usbd_enum_unlock(cpd->udev);
350 mtx_lock(&usb_ref_lock);
352 if (--(crd->rxfifo->refcount) == 0) {
353 cv_signal(&crd->rxfifo->cv_drain);
358 if (--(crd->txfifo->refcount) == 0) {
359 cv_signal(&crd->txfifo->cv_drain);
365 cpd->udev->refcount--;
366 cv_broadcast(&cpd->udev->ref_cv);
368 mtx_unlock(&usb_ref_lock);
371 static struct usb_fifo *
372 usb_fifo_alloc(struct mtx *mtx)
376 f = malloc(sizeof(*f), M_USBDEV, M_WAITOK | M_ZERO);
378 cv_init(&f->cv_io, "FIFO-IO");
379 cv_init(&f->cv_drain, "FIFO-DRAIN");
382 knlist_init_mtx(&f->selinfo.si_note, mtx);
387 /*------------------------------------------------------------------------*
389 *------------------------------------------------------------------------*/
391 usb_fifo_create(struct usb_cdev_privdata *cpd,
392 struct usb_cdev_refdata *crd)
394 struct usb_device *udev = cpd->udev;
396 struct usb_endpoint *ep;
402 int e = cpd->ep_addr;
404 is_tx = (cpd->fflags & FWRITE) ? 1 : 0;
405 is_rx = (cpd->fflags & FREAD) ? 1 : 0;
409 /* Preallocated FIFO */
411 DPRINTFN(5, "Preallocated FIFO\n");
413 f = udev->fifo[cpd->fifo_index + USB_FIFO_TX];
419 f = udev->fifo[cpd->fifo_index + USB_FIFO_RX];
427 KASSERT(e >= 0 && e <= 15, ("endpoint %d out of range", e));
429 /* search for a free FIFO slot */
430 DPRINTFN(5, "Endpoint device, searching for 0x%02x\n", e);
431 for (n = 0;; n += 2) {
433 if (n == USB_FIFO_MAX) {
438 /* end of FIFOs reached */
439 DPRINTFN(5, "out of FIFOs\n");
443 /* Check for TX FIFO */
445 f = udev->fifo[n + USB_FIFO_TX];
447 if (f->dev_ep_index != e) {
448 /* wrong endpoint index */
451 if (f->curr_cpd != NULL) {
456 } else if (no_null) {
460 /* Check for RX FIFO */
462 f = udev->fifo[n + USB_FIFO_RX];
464 if (f->dev_ep_index != e) {
465 /* wrong endpoint index */
468 if (f->curr_cpd != NULL) {
473 } else if (no_null) {
481 if (e >= (USB_EP_MAX / 2)) {
482 /* we don't create any endpoints in this range */
483 DPRINTFN(5, "ep out of range\n");
484 return (is_busy ? EBUSY : EINVAL);
488 if ((e != 0) && is_busy) {
490 * Only the default control endpoint is allowed to be
491 * opened multiple times!
493 DPRINTFN(5, "busy\n");
499 (udev->fifo[n + USB_FIFO_TX] == NULL)) {
500 ep = usb_dev_get_ep(udev, e, USB_FIFO_TX);
501 DPRINTFN(5, "dev_get_endpoint(%d, 0x%x)\n", e, USB_FIFO_TX);
503 DPRINTFN(5, "dev_get_endpoint returned NULL\n");
506 f = usb_fifo_alloc(&udev->device_mtx);
508 DPRINTFN(5, "could not alloc tx fifo\n");
511 /* update some fields */
512 f->fifo_index = n + USB_FIFO_TX;
515 f->methods = &usb_ugen_methods;
516 f->iface_index = ep->iface_index;
518 mtx_lock(&usb_ref_lock);
519 udev->fifo[n + USB_FIFO_TX] = f;
520 mtx_unlock(&usb_ref_lock);
524 (udev->fifo[n + USB_FIFO_RX] == NULL)) {
526 ep = usb_dev_get_ep(udev, e, USB_FIFO_RX);
527 DPRINTFN(5, "dev_get_endpoint(%d, 0x%x)\n", e, USB_FIFO_RX);
529 DPRINTFN(5, "dev_get_endpoint returned NULL\n");
532 f = usb_fifo_alloc(&udev->device_mtx);
534 DPRINTFN(5, "could not alloc rx fifo\n");
537 /* update some fields */
538 f->fifo_index = n + USB_FIFO_RX;
541 f->methods = &usb_ugen_methods;
542 f->iface_index = ep->iface_index;
544 mtx_lock(&usb_ref_lock);
545 udev->fifo[n + USB_FIFO_RX] = f;
546 mtx_unlock(&usb_ref_lock);
549 crd->txfifo = udev->fifo[n + USB_FIFO_TX];
552 crd->rxfifo = udev->fifo[n + USB_FIFO_RX];
554 /* fill out fifo index */
555 DPRINTFN(5, "fifo index = %d\n", n);
564 usb_fifo_free(struct usb_fifo *f)
572 /* destroy symlink devices, if any */
573 for (n = 0; n != 2; n++) {
575 usb_free_symlink(f->symlink[n]);
576 f->symlink[n] = NULL;
579 mtx_lock(&usb_ref_lock);
581 /* delink ourselves to stop calls from userland */
582 if ((f->fifo_index < USB_FIFO_MAX) &&
584 (f->udev->fifo[f->fifo_index] == f)) {
585 f->udev->fifo[f->fifo_index] = NULL;
587 DPRINTFN(0, "USB FIFO %p has not been linked\n", f);
590 /* decrease refcount */
592 /* prevent any write flush */
594 /* need to wait until all callers have exited */
595 while (f->refcount != 0) {
596 mtx_unlock(&usb_ref_lock); /* avoid LOR */
597 mtx_lock(f->priv_mtx);
598 /* get I/O thread out of any sleep state */
599 if (f->flag_sleeping) {
600 f->flag_sleeping = 0;
601 cv_broadcast(&f->cv_io);
603 mtx_unlock(f->priv_mtx);
604 mtx_lock(&usb_ref_lock);
607 * Check if the "f->refcount" variable reached zero
608 * during the unlocked time before entering wait:
610 if (f->refcount == 0)
614 cv_wait(&f->cv_drain, &usb_ref_lock);
616 mtx_unlock(&usb_ref_lock);
618 /* take care of closing the device here, if any */
619 usb_fifo_close(f, 0);
621 cv_destroy(&f->cv_io);
622 cv_destroy(&f->cv_drain);
624 knlist_clear(&f->selinfo.si_note, 0);
625 seldrain(&f->selinfo);
626 knlist_destroy(&f->selinfo.si_note);
631 static struct usb_endpoint *
632 usb_dev_get_ep(struct usb_device *udev, uint8_t ep_index, uint8_t dir)
634 struct usb_endpoint *ep;
640 if (dir == USB_FIFO_RX) {
641 if (udev->flags.usb_mode == USB_MODE_HOST) {
647 if (udev->flags.usb_mode == USB_MODE_HOST) {
653 ep = usbd_get_ep_by_addr(udev, ep_index | ep_dir);
657 /* if the endpoint does not exist then return */
660 if (ep->edesc == NULL) {
661 /* invalid endpoint */
664 return (ep); /* success */
667 /*------------------------------------------------------------------------*
673 *------------------------------------------------------------------------*/
675 usb_fifo_open(struct usb_cdev_privdata *cpd,
676 struct usb_fifo *f, int fflags)
682 DPRINTFN(2, "no FIFO\n");
685 /* remove FWRITE and FREAD flags */
686 fflags &= ~(FWRITE | FREAD);
688 /* set correct file flags */
689 if ((f->fifo_index & 1) == USB_FIFO_TX) {
695 /* check if we are already opened */
696 /* we don't need any locks when checking this variable */
697 if (f->curr_cpd != NULL) {
702 /* reset short flag before open */
705 /* call open method */
706 err = (f->methods->f_open) (f, fflags);
710 mtx_lock(f->priv_mtx);
712 /* reset sleep flag */
713 f->flag_sleeping = 0;
715 /* reset error flag */
718 /* reset complete flag */
719 f->flag_iscomplete = 0;
721 /* reset select flag */
722 f->flag_isselect = 0;
724 /* reset flushing flag */
725 f->flag_flushing = 0;
727 /* reset ASYNC proc flag */
730 mtx_lock(&usb_ref_lock);
731 /* flag the fifo as opened to prevent others */
733 mtx_unlock(&usb_ref_lock);
738 mtx_unlock(f->priv_mtx);
743 /*------------------------------------------------------------------------*
745 *------------------------------------------------------------------------*/
747 usb_fifo_reset(struct usb_fifo *f)
755 USB_IF_DEQUEUE(&f->used_q, m);
757 USB_IF_ENQUEUE(&f->free_q, m);
762 /* reset have fragment flag */
763 f->flag_have_fragment = 0;
766 /*------------------------------------------------------------------------*
768 *------------------------------------------------------------------------*/
770 usb_fifo_close(struct usb_fifo *f, int fflags)
774 /* check if we are not opened */
775 if (f->curr_cpd == NULL) {
776 /* nothing to do - already closed */
779 mtx_lock(f->priv_mtx);
781 /* clear current cdev private data pointer */
782 mtx_lock(&usb_ref_lock);
784 mtx_unlock(&usb_ref_lock);
786 /* check if we are watched by kevent */
787 KNOTE_LOCKED(&f->selinfo.si_note, 0);
789 /* check if we are selected */
790 if (f->flag_isselect) {
791 selwakeup(&f->selinfo);
792 f->flag_isselect = 0;
794 /* check if a thread wants SIGIO */
795 if (f->async_p != NULL) {
796 PROC_LOCK(f->async_p);
797 kern_psignal(f->async_p, SIGIO);
798 PROC_UNLOCK(f->async_p);
801 /* remove FWRITE and FREAD flags */
802 fflags &= ~(FWRITE | FREAD);
804 /* flush written data, if any */
805 if ((f->fifo_index & 1) == USB_FIFO_TX) {
807 if (!f->flag_iserror) {
809 /* set flushing flag */
810 f->flag_flushing = 1;
812 /* get the last packet in */
813 if (f->flag_have_fragment) {
815 f->flag_have_fragment = 0;
816 USB_IF_DEQUEUE(&f->free_q, m);
818 USB_IF_ENQUEUE(&f->used_q, m);
822 /* start write transfer, if not already started */
823 (f->methods->f_start_write) (f);
825 /* check if flushed already */
826 while (f->flag_flushing &&
827 (!f->flag_iserror)) {
828 /* wait until all data has been written */
829 f->flag_sleeping = 1;
830 err = cv_wait_sig(&f->cv_io, f->priv_mtx);
832 DPRINTF("signal received\n");
839 /* stop write transfer, if not already stopped */
840 (f->methods->f_stop_write) (f);
844 /* stop write transfer, if not already stopped */
845 (f->methods->f_stop_read) (f);
848 /* check if we are sleeping */
849 if (f->flag_sleeping) {
850 DPRINTFN(2, "Sleeping at close!\n");
852 mtx_unlock(f->priv_mtx);
854 /* call close method */
855 (f->methods->f_close) (f, fflags);
860 /*------------------------------------------------------------------------*
861 * usb_open - cdev callback
862 *------------------------------------------------------------------------*/
864 usb_open(struct cdev *dev, int fflags, int devtype, struct thread *td)
866 struct usb_fs_privdata* pd = (struct usb_fs_privdata*)dev->si_drv1;
867 struct usb_cdev_refdata refs;
868 struct usb_cdev_privdata *cpd;
871 DPRINTFN(2, "%s fflags=0x%08x\n", devtoname(dev), fflags);
873 KASSERT(fflags & (FREAD|FWRITE), ("invalid open flags"));
874 if (((fflags & FREAD) && !(pd->mode & FREAD)) ||
875 ((fflags & FWRITE) && !(pd->mode & FWRITE))) {
876 DPRINTFN(2, "access mode not supported\n");
880 cpd = malloc(sizeof(*cpd), M_USBDEV, M_WAITOK | M_ZERO);
881 ep = cpd->ep_addr = pd->ep_addr;
883 usb_loc_fill(pd, cpd);
884 err = usb_ref_device(cpd, &refs, 1);
886 DPRINTFN(2, "cannot ref device\n");
890 cpd->fflags = fflags; /* access mode for open lifetime */
892 /* create FIFOs, if any */
893 err = usb_fifo_create(cpd, &refs);
894 /* check for error */
896 DPRINTFN(2, "cannot create fifo\n");
897 usb_unref_device(cpd, &refs);
901 if (fflags & FREAD) {
902 err = usb_fifo_open(cpd, refs.rxfifo, fflags);
904 DPRINTFN(2, "read open failed\n");
905 usb_unref_device(cpd, &refs);
910 if (fflags & FWRITE) {
911 err = usb_fifo_open(cpd, refs.txfifo, fflags);
913 DPRINTFN(2, "write open failed\n");
914 if (fflags & FREAD) {
915 usb_fifo_close(refs.rxfifo, fflags);
917 usb_unref_device(cpd, &refs);
922 usb_unref_device(cpd, &refs);
923 devfs_set_cdevpriv(cpd, usb_close);
928 /*------------------------------------------------------------------------*
929 * usb_close - cdev callback
930 *------------------------------------------------------------------------*/
934 struct usb_cdev_refdata refs;
935 struct usb_cdev_privdata *cpd = arg;
938 DPRINTFN(2, "cpd=%p\n", cpd);
940 err = usb_ref_device(cpd, &refs,
941 2 /* uref and allow detached state */);
943 DPRINTFN(2, "Cannot grab USB reference when "
944 "closing USB file handle\n");
947 if (cpd->fflags & FREAD) {
948 usb_fifo_close(refs.rxfifo, cpd->fflags);
950 if (cpd->fflags & FWRITE) {
951 usb_fifo_close(refs.txfifo, cpd->fflags);
953 usb_unref_device(cpd, &refs);
959 usb_dev_init(void *arg)
961 mtx_init(&usb_ref_lock, "USB ref mutex", NULL, MTX_DEF);
962 sx_init(&usb_sym_lock, "USB sym mutex");
963 TAILQ_INIT(&usb_sym_head);
965 /* check the UGEN methods */
966 usb_fifo_check_methods(&usb_ugen_methods);
969 SYSINIT(usb_dev_init, SI_SUB_KLD, SI_ORDER_FIRST, usb_dev_init, NULL);
972 usb_dev_init_post(void *arg)
975 * Create /dev/usb - this is needed for usbconfig(8), which
976 * needs a well-known device name to access.
978 usb_dev = make_dev(&usb_static_devsw, 0, UID_ROOT, GID_OPERATOR,
979 0644, USB_DEVICE_NAME);
980 if (usb_dev == NULL) {
981 DPRINTFN(0, "Could not create usb bus device\n");
985 SYSINIT(usb_dev_init_post, SI_SUB_KICK_SCHEDULER, SI_ORDER_FIRST, usb_dev_init_post, NULL);
988 usb_dev_uninit(void *arg)
990 if (usb_dev != NULL) {
991 destroy_dev(usb_dev);
994 mtx_destroy(&usb_ref_lock);
995 sx_destroy(&usb_sym_lock);
998 SYSUNINIT(usb_dev_uninit, SI_SUB_KICK_SCHEDULER, SI_ORDER_ANY, usb_dev_uninit, NULL);
1001 usb_ioctl_f_sub(struct usb_fifo *f, u_long cmd, void *addr,
1008 *(int *)addr = 0; /* character device */
1012 /* handled by upper FS layer */
1017 if (f->async_p != NULL) {
1021 f->async_p = USB_TD_GET_PROC(td);
1027 /* XXX this is not the most general solution */
1029 if (f->async_p == NULL) {
1033 if (*(int *)addr != USB_PROC_GET_GID(f->async_p)) {
1041 DPRINTFN(3, "cmd 0x%lx = %d\n", cmd, error);
1045 /*------------------------------------------------------------------------*
1046 * usb_ioctl - cdev callback
1047 *------------------------------------------------------------------------*/
1049 usb_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int fflag, struct thread* td)
1051 struct usb_cdev_refdata refs;
1052 struct usb_cdev_privdata* cpd;
1057 DPRINTFN(2, "cmd=0x%lx\n", cmd);
1059 err = devfs_get_cdevpriv((void **)&cpd);
1064 * Performance optimisation: We try to check for IOCTL's that
1065 * don't need the USB reference first. Then we grab the USB
1066 * reference if we need it!
1068 err = usb_ref_device(cpd, &refs, 0 /* no uref */ );
1072 fflags = cpd->fflags;
1074 f = NULL; /* set default value */
1075 err = ENOIOCTL; /* set default value */
1077 if (fflags & FWRITE) {
1079 err = usb_ioctl_f_sub(f, cmd, addr, td);
1081 if (fflags & FREAD) {
1083 err = usb_ioctl_f_sub(f, cmd, addr, td);
1085 KASSERT(f != NULL, ("fifo not found"));
1086 if (err != ENOIOCTL)
1089 err = (f->methods->f_ioctl) (f, cmd, addr, fflags);
1091 DPRINTFN(2, "f_ioctl cmd 0x%lx = %d\n", cmd, err);
1093 if (err != ENOIOCTL)
1096 if (usb_usb_ref_device(cpd, &refs)) {
1101 err = (f->methods->f_ioctl_post) (f, cmd, addr, fflags);
1103 DPRINTFN(2, "f_ioctl_post cmd 0x%lx = %d\n", cmd, err);
1105 if (err == ENOIOCTL)
1111 /* Wait for re-enumeration, if any */
1113 while (f->udev->re_enumerate_wait != USB_RE_ENUM_DONE) {
1115 usb_unref_device(cpd, &refs);
1117 usb_pause_mtx(NULL, hz / 128);
1119 if (usb_ref_device(cpd, &refs, 1 /* need uref */)) {
1126 usb_unref_device(cpd, &refs);
1131 usb_filter_detach(struct knote *kn)
1133 struct usb_fifo *f = kn->kn_hook;
1134 knlist_remove(&f->selinfo.si_note, kn, 0);
1138 usb_filter_write(struct knote *kn, long hint)
1140 struct usb_cdev_privdata* cpd;
1148 mtx_assert(f->priv_mtx, MA_OWNED);
1153 } else if (f->fs_ep_max == 0) {
1154 if (f->flag_iserror) {
1155 /* we got an error */
1158 if (f->queue_data == NULL) {
1160 * start write transfer, if not
1163 (f->methods->f_start_write) (f);
1165 /* check if any packets are available */
1166 USB_IF_POLL(&f->free_q, m);
1169 if (f->flag_iscomplete) {
1179 usb_filter_read(struct knote *kn, long hint)
1181 struct usb_cdev_privdata* cpd;
1189 mtx_assert(f->priv_mtx, MA_OWNED);
1194 } else if (f->fs_ep_max == 0) {
1195 if (f->flag_iserror) {
1196 /* we have an error */
1199 if (f->queue_data == NULL) {
1201 * start read transfer, if not
1204 (f->methods->f_start_read) (f);
1206 /* check if any packets are available */
1207 USB_IF_POLL(&f->used_q, m);
1209 /* start reading data, if any */
1211 (f->methods->f_start_read) (f);
1214 if (f->flag_iscomplete) {
1223 static struct filterops usb_filtops_write = {
1225 .f_detach = usb_filter_detach,
1226 .f_event = usb_filter_write,
1229 static struct filterops usb_filtops_read = {
1231 .f_detach = usb_filter_detach,
1232 .f_event = usb_filter_read,
1238 usb_kqfilter(struct cdev* dev, struct knote *kn)
1240 struct usb_cdev_refdata refs;
1241 struct usb_cdev_privdata* cpd;
1248 if (devfs_get_cdevpriv((void **)&cpd) != 0 ||
1249 usb_ref_device(cpd, &refs, 0) != 0)
1252 fflags = cpd->fflags;
1254 /* Figure out who needs service */
1255 switch (kn->kn_filter) {
1257 if (fflags & FWRITE) {
1259 kn->kn_fop = &usb_filtops_write;
1264 if (fflags & FREAD) {
1266 kn->kn_fop = &usb_filtops_read;
1277 mtx_lock(f->priv_mtx);
1278 knlist_add(&f->selinfo.si_note, kn, 1);
1279 mtx_unlock(f->priv_mtx);
1282 usb_unref_device(cpd, &refs);
1288 usb_poll(struct cdev* dev, int events, struct thread* td)
1290 struct usb_cdev_refdata refs;
1291 struct usb_cdev_privdata* cpd;
1294 int fflags, revents;
1296 if (devfs_get_cdevpriv((void **)&cpd) != 0 ||
1297 usb_ref_device(cpd, &refs, 0) != 0)
1299 (POLLHUP|POLLIN|POLLRDNORM|POLLOUT|POLLWRNORM));
1301 fflags = cpd->fflags;
1303 /* Figure out who needs service */
1305 if ((events & (POLLOUT | POLLWRNORM)) &&
1306 (fflags & FWRITE)) {
1310 mtx_lock(f->priv_mtx);
1312 if (!refs.is_usbfs) {
1313 if (f->flag_iserror) {
1314 /* we got an error */
1317 if (f->queue_data == NULL) {
1319 * start write transfer, if not
1322 (f->methods->f_start_write) (f);
1324 /* check if any packets are available */
1325 USB_IF_POLL(&f->free_q, m);
1328 if (f->flag_iscomplete) {
1336 revents |= events & (POLLOUT | POLLWRNORM);
1338 f->flag_isselect = 1;
1339 selrecord(td, &f->selinfo);
1342 mtx_unlock(f->priv_mtx);
1344 if ((events & (POLLIN | POLLRDNORM)) &&
1349 mtx_lock(f->priv_mtx);
1351 if (!refs.is_usbfs) {
1352 if (f->flag_iserror) {
1353 /* we have an error */
1356 if (f->queue_data == NULL) {
1358 * start read transfer, if not
1361 (f->methods->f_start_read) (f);
1363 /* check if any packets are available */
1364 USB_IF_POLL(&f->used_q, m);
1367 if (f->flag_iscomplete) {
1375 revents |= events & (POLLIN | POLLRDNORM);
1377 f->flag_isselect = 1;
1378 selrecord(td, &f->selinfo);
1380 if (!refs.is_usbfs) {
1381 /* start reading data */
1382 (f->methods->f_start_read) (f);
1386 mtx_unlock(f->priv_mtx);
1388 usb_unref_device(cpd, &refs);
1393 usb_read(struct cdev *dev, struct uio *uio, int ioflag)
1395 struct usb_cdev_refdata refs;
1396 struct usb_cdev_privdata* cpd;
1403 uint8_t tr_data = 0;
1405 err = devfs_get_cdevpriv((void **)&cpd);
1409 err = usb_ref_device(cpd, &refs, 0 /* no uref */ );
1413 fflags = cpd->fflags;
1417 /* should not happen */
1418 usb_unref_device(cpd, &refs);
1422 resid = uio->uio_resid;
1424 mtx_lock(f->priv_mtx);
1426 /* check for permanent read error */
1427 if (f->flag_iserror) {
1431 /* check if USB-FS interface is active */
1432 if (refs.is_usbfs) {
1434 * The queue is used for events that should be
1435 * retrieved using the "USB_FS_COMPLETE" ioctl.
1440 while (uio->uio_resid > 0) {
1442 USB_IF_DEQUEUE(&f->used_q, m);
1446 /* start read transfer, if not already started */
1448 (f->methods->f_start_read) (f);
1450 if (ioflag & IO_NDELAY) {
1452 /* return length before error */
1458 DPRINTF("sleeping\n");
1460 err = usb_fifo_wait(f);
1466 if (f->methods->f_filter_read) {
1468 * Sometimes it is convenient to process data at the
1469 * expense of a userland process instead of a kernel
1472 (f->methods->f_filter_read) (f, m);
1476 io_len = MIN(m->cur_data_len, uio->uio_resid);
1478 DPRINTFN(2, "transfer %d bytes from %p\n",
1479 io_len, m->cur_data_ptr);
1481 err = usb_fifo_uiomove(f,
1482 m->cur_data_ptr, io_len, uio);
1484 m->cur_data_len -= io_len;
1485 m->cur_data_ptr += io_len;
1487 if (m->cur_data_len == 0) {
1489 uint8_t last_packet;
1491 last_packet = m->last_packet;
1493 USB_IF_ENQUEUE(&f->free_q, m);
1500 USB_IF_PREPEND(&f->used_q, m);
1508 mtx_unlock(f->priv_mtx);
1510 usb_unref_device(cpd, &refs);
1516 usb_write(struct cdev *dev, struct uio *uio, int ioflag)
1518 struct usb_cdev_refdata refs;
1519 struct usb_cdev_privdata* cpd;
1527 uint8_t tr_data = 0;
1531 err = devfs_get_cdevpriv((void **)&cpd);
1535 err = usb_ref_device(cpd, &refs, 0 /* no uref */ );
1539 fflags = cpd->fflags;
1543 /* should not happen */
1544 usb_unref_device(cpd, &refs);
1547 resid = uio->uio_resid;
1549 mtx_lock(f->priv_mtx);
1551 /* check for permanent write error */
1552 if (f->flag_iserror) {
1556 /* check if USB-FS interface is active */
1557 if (refs.is_usbfs) {
1559 * The queue is used for events that should be
1560 * retrieved using the "USB_FS_COMPLETE" ioctl.
1565 if (f->queue_data == NULL) {
1566 /* start write transfer, if not already started */
1567 (f->methods->f_start_write) (f);
1569 /* we allow writing zero length data */
1571 USB_IF_DEQUEUE(&f->free_q, m);
1575 if (ioflag & IO_NDELAY) {
1577 /* return length before error */
1583 DPRINTF("sleeping\n");
1585 err = usb_fifo_wait(f);
1593 if (f->flag_have_fragment == 0) {
1595 io_len = m->cur_data_len;
1596 pdata = m->cur_data_ptr;
1597 if (io_len > uio->uio_resid)
1598 io_len = uio->uio_resid;
1599 m->cur_data_len = io_len;
1601 io_len = m->max_data_len - m->cur_data_len;
1602 pdata = m->cur_data_ptr + m->cur_data_len;
1603 if (io_len > uio->uio_resid)
1604 io_len = uio->uio_resid;
1605 m->cur_data_len += io_len;
1608 DPRINTFN(2, "transfer %d bytes to %p\n",
1611 err = usb_fifo_uiomove(f, pdata, io_len, uio);
1614 f->flag_have_fragment = 0;
1615 USB_IF_ENQUEUE(&f->free_q, m);
1619 /* check if the buffer is ready to be transmitted */
1621 if ((f->flag_write_defrag == 0) ||
1622 (m->cur_data_len == m->max_data_len)) {
1623 f->flag_have_fragment = 0;
1626 * Check for write filter:
1628 * Sometimes it is convenient to process data
1629 * at the expense of a userland process
1630 * instead of a kernel process.
1632 if (f->methods->f_filter_write) {
1633 (f->methods->f_filter_write) (f, m);
1636 /* Put USB mbuf in the used queue */
1637 USB_IF_ENQUEUE(&f->used_q, m);
1639 /* Start writing data, if not already started */
1640 (f->methods->f_start_write) (f);
1642 /* Wait for more data or close */
1643 f->flag_have_fragment = 1;
1644 USB_IF_PREPEND(&f->free_q, m);
1647 } while (uio->uio_resid > 0);
1649 mtx_unlock(f->priv_mtx);
1651 usb_unref_device(cpd, &refs);
1657 usb_static_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
1661 struct usb_read_dir *urd;
1669 err = usb_read_symlink(u.urd->urd_data,
1670 u.urd->urd_startentry, u.urd->urd_maxlen);
1672 case USB_DEV_QUIRK_GET:
1673 case USB_QUIRK_NAME_GET:
1674 case USB_DEV_QUIRK_ADD:
1675 case USB_DEV_QUIRK_REMOVE:
1676 err = usb_quirk_ioctl_p(cmd, data, fflag, td);
1678 case USB_GET_TEMPLATE:
1679 *(int *)data = usb_template;
1682 case USB_SET_TEMPLATE:
1683 err = priv_check(curthread, PRIV_DRIVER);
1686 usb_template = *(int *)data;
1696 usb_fifo_uiomove(struct usb_fifo *f, void *cp,
1697 int n, struct uio *uio)
1701 mtx_unlock(f->priv_mtx);
1704 * "uiomove()" can sleep so one needs to make a wrapper,
1705 * exiting the mutex and checking things:
1707 error = uiomove(cp, n, uio);
1709 mtx_lock(f->priv_mtx);
1715 usb_fifo_wait(struct usb_fifo *f)
1719 mtx_assert(f->priv_mtx, MA_OWNED);
1721 if (f->flag_iserror) {
1725 f->flag_sleeping = 1;
1727 err = cv_wait_sig(&f->cv_io, f->priv_mtx);
1729 if (f->flag_iserror) {
1737 usb_fifo_signal(struct usb_fifo *f)
1739 if (f->flag_sleeping) {
1740 f->flag_sleeping = 0;
1741 cv_broadcast(&f->cv_io);
1746 usb_fifo_wakeup(struct usb_fifo *f)
1750 KNOTE_LOCKED(&f->selinfo.si_note, 0);
1752 if (f->flag_isselect) {
1753 selwakeup(&f->selinfo);
1754 f->flag_isselect = 0;
1756 if (f->async_p != NULL) {
1757 PROC_LOCK(f->async_p);
1758 kern_psignal(f->async_p, SIGIO);
1759 PROC_UNLOCK(f->async_p);
1764 usb_fifo_dummy_open(struct usb_fifo *fifo, int fflags)
1770 usb_fifo_dummy_close(struct usb_fifo *fifo, int fflags)
1776 usb_fifo_dummy_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags)
1782 usb_fifo_dummy_cmd(struct usb_fifo *fifo)
1784 fifo->flag_flushing = 0; /* not flushing */
1788 usb_fifo_check_methods(struct usb_fifo_methods *pm)
1790 /* check that all callback functions are OK */
1792 if (pm->f_open == NULL)
1793 pm->f_open = &usb_fifo_dummy_open;
1795 if (pm->f_close == NULL)
1796 pm->f_close = &usb_fifo_dummy_close;
1798 if (pm->f_ioctl == NULL)
1799 pm->f_ioctl = &usb_fifo_dummy_ioctl;
1801 if (pm->f_ioctl_post == NULL)
1802 pm->f_ioctl_post = &usb_fifo_dummy_ioctl;
1804 if (pm->f_start_read == NULL)
1805 pm->f_start_read = &usb_fifo_dummy_cmd;
1807 if (pm->f_stop_read == NULL)
1808 pm->f_stop_read = &usb_fifo_dummy_cmd;
1810 if (pm->f_start_write == NULL)
1811 pm->f_start_write = &usb_fifo_dummy_cmd;
1813 if (pm->f_stop_write == NULL)
1814 pm->f_stop_write = &usb_fifo_dummy_cmd;
1817 /*------------------------------------------------------------------------*
1820 * The following function will create a duplex FIFO.
1825 *------------------------------------------------------------------------*/
1827 usb_fifo_attach(struct usb_device *udev, void *priv_sc,
1828 struct mtx *priv_mtx, struct usb_fifo_methods *pm,
1829 struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit,
1830 uint8_t iface_index, uid_t uid, gid_t gid, int mode)
1832 struct usb_fifo *f_tx;
1833 struct usb_fifo *f_rx;
1837 f_sc->fp[USB_FIFO_TX] = NULL;
1838 f_sc->fp[USB_FIFO_RX] = NULL;
1843 /* check the methods */
1844 usb_fifo_check_methods(pm);
1846 if (priv_mtx == NULL)
1849 /* search for a free FIFO slot */
1850 for (n = 0;; n += 2) {
1852 if (n == USB_FIFO_MAX) {
1853 /* end of FIFOs reached */
1856 /* Check for TX FIFO */
1857 if (udev->fifo[n + USB_FIFO_TX] != NULL) {
1860 /* Check for RX FIFO */
1861 if (udev->fifo[n + USB_FIFO_RX] != NULL) {
1867 f_tx = usb_fifo_alloc(priv_mtx);
1868 f_rx = usb_fifo_alloc(priv_mtx);
1870 if ((f_tx == NULL) || (f_rx == NULL)) {
1871 usb_fifo_free(f_tx);
1872 usb_fifo_free(f_rx);
1875 /* initialise FIFO structures */
1877 f_tx->fifo_index = n + USB_FIFO_TX;
1878 f_tx->dev_ep_index = -1;
1879 f_tx->priv_sc0 = priv_sc;
1881 f_tx->iface_index = iface_index;
1884 f_rx->fifo_index = n + USB_FIFO_RX;
1885 f_rx->dev_ep_index = -1;
1886 f_rx->priv_sc0 = priv_sc;
1888 f_rx->iface_index = iface_index;
1891 f_sc->fp[USB_FIFO_TX] = f_tx;
1892 f_sc->fp[USB_FIFO_RX] = f_rx;
1894 mtx_lock(&usb_ref_lock);
1895 udev->fifo[f_tx->fifo_index] = f_tx;
1896 udev->fifo[f_rx->fifo_index] = f_rx;
1897 mtx_unlock(&usb_ref_lock);
1899 for (n = 0; n != 4; n++) {
1901 if (pm->basename[n] == NULL) {
1905 if (snprintf(devname, sizeof(devname),
1906 "%s%u%s", pm->basename[n],
1907 unit, pm->postfix[n] ?
1908 pm->postfix[n] : "")) {
1912 if (snprintf(devname, sizeof(devname),
1913 "%s%u.%d%s", pm->basename[n],
1914 unit, subunit, pm->postfix[n] ?
1915 pm->postfix[n] : "")) {
1921 * Distribute the symbolic links into two FIFO structures:
1924 f_rx->symlink[n / 2] =
1925 usb_alloc_symlink(devname);
1927 f_tx->symlink[n / 2] =
1928 usb_alloc_symlink(devname);
1931 /* Create the device */
1932 f_sc->dev = usb_make_dev(udev, devname, -1,
1933 f_tx->fifo_index & f_rx->fifo_index,
1934 FREAD|FWRITE, uid, gid, mode);
1937 DPRINTFN(2, "attached %p/%p\n", f_tx, f_rx);
1941 /*------------------------------------------------------------------------*
1942 * usb_fifo_alloc_buffer
1947 *------------------------------------------------------------------------*/
1949 usb_fifo_alloc_buffer(struct usb_fifo *f, usb_size_t bufsize,
1952 usb_fifo_free_buffer(f);
1954 /* allocate an endpoint */
1955 f->free_q.ifq_maxlen = nbuf;
1956 f->used_q.ifq_maxlen = nbuf;
1958 f->queue_data = usb_alloc_mbufs(
1959 M_USBDEV, &f->free_q, bufsize, nbuf);
1961 if ((f->queue_data == NULL) && bufsize && nbuf) {
1964 return (0); /* success */
1967 /*------------------------------------------------------------------------*
1968 * usb_fifo_free_buffer
1970 * This function will free the buffers associated with a FIFO. This
1971 * function can be called multiple times in a row.
1972 *------------------------------------------------------------------------*/
1974 usb_fifo_free_buffer(struct usb_fifo *f)
1976 if (f->queue_data) {
1977 /* free old buffer */
1978 free(f->queue_data, M_USBDEV);
1979 f->queue_data = NULL;
1983 memset(&f->free_q, 0, sizeof(f->free_q));
1984 memset(&f->used_q, 0, sizeof(f->used_q));
1988 usb_fifo_detach(struct usb_fifo_sc *f_sc)
1993 usb_fifo_free(f_sc->fp[USB_FIFO_TX]);
1994 usb_fifo_free(f_sc->fp[USB_FIFO_RX]);
1996 f_sc->fp[USB_FIFO_TX] = NULL;
1997 f_sc->fp[USB_FIFO_RX] = NULL;
1999 usb_destroy_dev(f_sc->dev);
2003 DPRINTFN(2, "detached %p\n", f_sc);
2007 usb_fifo_put_bytes_max(struct usb_fifo *f)
2012 USB_IF_POLL(&f->free_q, m);
2015 len = m->max_data_len;
2022 /*------------------------------------------------------------------------*
2026 * 0 - normal operation
2027 * 1 - set last packet flag to enforce framing
2028 *------------------------------------------------------------------------*/
2030 usb_fifo_put_data(struct usb_fifo *f, struct usb_page_cache *pc,
2031 usb_frlength_t offset, usb_frlength_t len, uint8_t what)
2034 usb_frlength_t io_len;
2036 while (len || (what == 1)) {
2038 USB_IF_DEQUEUE(&f->free_q, m);
2043 io_len = MIN(len, m->cur_data_len);
2045 usbd_copy_out(pc, offset, m->cur_data_ptr, io_len);
2047 m->cur_data_len = io_len;
2051 if ((len == 0) && (what == 1)) {
2054 USB_IF_ENQUEUE(&f->used_q, m);
2058 if ((len == 0) || (what == 1)) {
2068 usb_fifo_put_data_linear(struct usb_fifo *f, void *ptr,
2069 usb_size_t len, uint8_t what)
2074 while (len || (what == 1)) {
2076 USB_IF_DEQUEUE(&f->free_q, m);
2081 io_len = MIN(len, m->cur_data_len);
2083 memcpy(m->cur_data_ptr, ptr, io_len);
2085 m->cur_data_len = io_len;
2086 ptr = USB_ADD_BYTES(ptr, io_len);
2089 if ((len == 0) && (what == 1)) {
2092 USB_IF_ENQUEUE(&f->used_q, m);
2096 if ((len == 0) || (what == 1)) {
2106 usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len)
2110 USB_IF_DEQUEUE(&f->free_q, m);
2113 m->cur_data_len = len;
2114 m->cur_data_ptr = ptr;
2115 USB_IF_ENQUEUE(&f->used_q, m);
2123 usb_fifo_put_data_error(struct usb_fifo *f)
2125 f->flag_iserror = 1;
2129 /*------------------------------------------------------------------------*
2133 * 0 - normal operation
2134 * 1 - only get one "usb_mbuf"
2138 * 1 - data in buffer
2139 *------------------------------------------------------------------------*/
2141 usb_fifo_get_data(struct usb_fifo *f, struct usb_page_cache *pc,
2142 usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
2146 usb_frlength_t io_len;
2147 uint8_t tr_data = 0;
2153 USB_IF_DEQUEUE(&f->used_q, m);
2159 io_len = MIN(len, m->cur_data_len);
2161 usbd_copy_in(pc, offset, m->cur_data_ptr, io_len);
2165 actlen[0] += io_len;
2166 m->cur_data_ptr += io_len;
2167 m->cur_data_len -= io_len;
2169 if ((m->cur_data_len == 0) || (what == 1)) {
2170 USB_IF_ENQUEUE(&f->free_q, m);
2178 USB_IF_PREPEND(&f->used_q, m);
2183 /* wait for data to be written out */
2186 if (f->flag_flushing) {
2187 /* check if we should send a short packet */
2188 if (f->flag_short != 0) {
2193 /* flushing complete */
2194 f->flag_flushing = 0;
2207 usb_fifo_get_data_linear(struct usb_fifo *f, void *ptr,
2208 usb_size_t len, usb_size_t *actlen, uint8_t what)
2212 uint8_t tr_data = 0;
2218 USB_IF_DEQUEUE(&f->used_q, m);
2224 io_len = MIN(len, m->cur_data_len);
2226 memcpy(ptr, m->cur_data_ptr, io_len);
2229 ptr = USB_ADD_BYTES(ptr, io_len);
2230 actlen[0] += io_len;
2231 m->cur_data_ptr += io_len;
2232 m->cur_data_len -= io_len;
2234 if ((m->cur_data_len == 0) || (what == 1)) {
2235 USB_IF_ENQUEUE(&f->free_q, m);
2243 USB_IF_PREPEND(&f->used_q, m);
2248 /* wait for data to be written out */
2251 if (f->flag_flushing) {
2252 /* check if we should send a short packet */
2253 if (f->flag_short != 0) {
2258 /* flushing complete */
2259 f->flag_flushing = 0;
2272 usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr, usb_size_t *plen)
2276 USB_IF_POLL(&f->used_q, m);
2279 *plen = m->cur_data_len;
2280 *pptr = m->cur_data_ptr;
2288 usb_fifo_get_data_error(struct usb_fifo *f)
2290 f->flag_iserror = 1;
2294 /*------------------------------------------------------------------------*
2299 * Else: Pointer to symlink entry
2300 *------------------------------------------------------------------------*/
2301 struct usb_symlink *
2302 usb_alloc_symlink(const char *target)
2304 struct usb_symlink *ps;
2306 ps = malloc(sizeof(*ps), M_USBDEV, M_WAITOK);
2310 /* XXX no longer needed */
2311 strlcpy(ps->src_path, target, sizeof(ps->src_path));
2312 ps->src_len = strlen(ps->src_path);
2313 strlcpy(ps->dst_path, target, sizeof(ps->dst_path));
2314 ps->dst_len = strlen(ps->dst_path);
2316 sx_xlock(&usb_sym_lock);
2317 TAILQ_INSERT_TAIL(&usb_sym_head, ps, sym_entry);
2318 sx_unlock(&usb_sym_lock);
2322 /*------------------------------------------------------------------------*
2324 *------------------------------------------------------------------------*/
2326 usb_free_symlink(struct usb_symlink *ps)
2331 sx_xlock(&usb_sym_lock);
2332 TAILQ_REMOVE(&usb_sym_head, ps, sym_entry);
2333 sx_unlock(&usb_sym_lock);
2338 /*------------------------------------------------------------------------*
2344 *------------------------------------------------------------------------*/
2346 usb_read_symlink(uint8_t *user_ptr, uint32_t startentry, uint32_t user_len)
2348 struct usb_symlink *ps;
2354 sx_xlock(&usb_sym_lock);
2356 TAILQ_FOREACH(ps, &usb_sym_head, sym_entry) {
2359 * Compute total length of source and destination symlink
2360 * strings pluss one length byte and two NUL bytes:
2362 temp = ps->src_len + ps->dst_len + 3;
2366 * Skip entry because this length cannot fit
2371 if (startentry != 0) {
2372 /* decrement read offset */
2376 if (temp > user_len) {
2377 /* out of buffer space */
2382 /* copy out total length */
2384 error = copyout(&len,
2385 USB_ADD_BYTES(user_ptr, delta), 1);
2391 /* copy out source string */
2393 error = copyout(ps->src_path,
2394 USB_ADD_BYTES(user_ptr, delta), ps->src_len);
2399 delta += ps->src_len;
2400 error = copyout(&len,
2401 USB_ADD_BYTES(user_ptr, delta), 1);
2407 /* copy out destination string */
2409 error = copyout(ps->dst_path,
2410 USB_ADD_BYTES(user_ptr, delta), ps->dst_len);
2415 delta += ps->dst_len;
2416 error = copyout(&len,
2417 USB_ADD_BYTES(user_ptr, delta), 1);
2426 /* a zero length entry indicates the end */
2428 if ((user_len != 0) && (error == 0)) {
2432 error = copyout(&len,
2433 USB_ADD_BYTES(user_ptr, delta), 1);
2435 sx_unlock(&usb_sym_lock);
2440 usb_fifo_set_close_zlp(struct usb_fifo *f, uint8_t onoff)
2445 /* send a Zero Length Packet, ZLP, before close */
2446 f->flag_short = onoff;
2450 usb_fifo_set_write_defrag(struct usb_fifo *f, uint8_t onoff)
2455 /* defrag written data */
2456 f->flag_write_defrag = onoff;
2457 /* reset defrag state */
2458 f->flag_have_fragment = 0;
2462 usb_fifo_softc(struct usb_fifo *f)
2464 return (f->priv_sc0);
2466 #endif /* USB_HAVE_UGEN */