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_RWTUN,
90 &usb_fifo_debug, 0, "Debug Level");
93 #if ((__FreeBSD_version >= 700001) || (__FreeBSD_version == 0) || \
94 ((__FreeBSD_version >= 600034) && (__FreeBSD_version < 700000)))
95 #define USB_UCRED struct ucred *ucred,
102 static int usb_fifo_open(struct usb_cdev_privdata *,
103 struct usb_fifo *, int);
104 static void usb_fifo_close(struct usb_fifo *, int);
105 static void usb_dev_init(void *);
106 static void usb_dev_init_post(void *);
107 static void usb_dev_uninit(void *);
108 static int usb_fifo_uiomove(struct usb_fifo *, void *, int,
110 static void usb_fifo_check_methods(struct usb_fifo_methods *);
111 static struct usb_fifo *usb_fifo_alloc(struct mtx *);
112 static struct usb_endpoint *usb_dev_get_ep(struct usb_device *, uint8_t,
114 static void usb_loc_fill(struct usb_fs_privdata *,
115 struct usb_cdev_privdata *);
116 static void usb_close(void *);
117 static usb_error_t usb_ref_device(struct usb_cdev_privdata *, struct usb_cdev_refdata *, int);
118 static usb_error_t usb_usb_ref_device(struct usb_cdev_privdata *, struct usb_cdev_refdata *);
119 static void usb_unref_device(struct usb_cdev_privdata *, struct usb_cdev_refdata *);
121 static d_open_t usb_open;
122 static d_ioctl_t usb_ioctl;
123 static d_read_t usb_read;
124 static d_write_t usb_write;
125 static d_poll_t usb_poll;
126 static d_kqfilter_t usb_kqfilter;
128 static d_ioctl_t usb_static_ioctl;
130 static usb_fifo_open_t usb_fifo_dummy_open;
131 static usb_fifo_close_t usb_fifo_dummy_close;
132 static usb_fifo_ioctl_t usb_fifo_dummy_ioctl;
133 static usb_fifo_cmd_t usb_fifo_dummy_cmd;
135 /* character device structure used for devices (/dev/ugenX.Y and /dev/uXXX) */
136 struct cdevsw usb_devsw = {
137 .d_version = D_VERSION,
139 .d_ioctl = usb_ioctl,
141 .d_flags = D_TRACKCLOSE,
143 .d_write = usb_write,
145 .d_kqfilter = usb_kqfilter,
148 static struct cdev* usb_dev = NULL;
150 /* character device structure used for /dev/usb */
151 static struct cdevsw usb_static_devsw = {
152 .d_version = D_VERSION,
153 .d_ioctl = usb_static_ioctl,
157 static TAILQ_HEAD(, usb_symlink) usb_sym_head;
158 static struct sx usb_sym_lock;
160 struct mtx usb_ref_lock;
162 /*------------------------------------------------------------------------*
165 * This is used to fill out a usb_cdev_privdata structure based on the
166 * device's address as contained in usb_fs_privdata.
167 *------------------------------------------------------------------------*/
169 usb_loc_fill(struct usb_fs_privdata* pd, struct usb_cdev_privdata *cpd)
171 cpd->bus_index = pd->bus_index;
172 cpd->dev_index = pd->dev_index;
173 cpd->ep_addr = pd->ep_addr;
174 cpd->fifo_index = pd->fifo_index;
177 /*------------------------------------------------------------------------*
180 * This function is used to atomically refer an USB device by its
181 * device location. If this function returns success the USB device
182 * will not dissappear until the USB device is unreferenced.
185 * 0: Success, refcount incremented on the given USB device.
187 *------------------------------------------------------------------------*/
189 usb_ref_device(struct usb_cdev_privdata *cpd,
190 struct usb_cdev_refdata *crd, int need_uref)
192 struct usb_fifo **ppf;
195 DPRINTFN(2, "cpd=%p need uref=%d\n", cpd, need_uref);
198 memset(crd, 0, sizeof(*crd));
200 mtx_lock(&usb_ref_lock);
201 cpd->bus = devclass_get_softc(usb_devclass_ptr, cpd->bus_index);
202 if (cpd->bus == NULL) {
203 DPRINTFN(2, "no bus at %u\n", cpd->bus_index);
206 cpd->udev = cpd->bus->devices[cpd->dev_index];
207 if (cpd->udev == NULL) {
208 DPRINTFN(2, "no device at %u\n", cpd->dev_index);
211 if (cpd->udev->state == USB_STATE_DETACHED &&
213 DPRINTFN(2, "device is detached\n");
217 DPRINTFN(2, "ref udev - needed\n");
219 if (cpd->udev->refcount == USB_DEV_REF_MAX) {
220 DPRINTFN(2, "no dev ref\n");
223 cpd->udev->refcount++;
225 mtx_unlock(&usb_ref_lock);
228 * We need to grab the enumeration SX-lock before
229 * grabbing the FIFO refs to avoid deadlock at detach!
231 crd->do_unlock = usbd_enum_lock(cpd->udev);
233 mtx_lock(&usb_ref_lock);
236 * Set "is_uref" after grabbing the default SX lock
241 /* check if we are doing an open */
242 if (cpd->fflags == 0) {
243 /* use zero defaults */
245 /* check for write */
246 if (cpd->fflags & FWRITE) {
247 ppf = cpd->udev->fifo;
248 f = ppf[cpd->fifo_index + USB_FIFO_TX];
250 crd->is_write = 1; /* ref */
251 if (f == NULL || f->refcount == USB_FIFO_REF_MAX)
253 if (f->curr_cpd != cpd)
255 /* check if USB-FS is active */
256 if (f->fs_ep_max != 0) {
262 if (cpd->fflags & FREAD) {
263 ppf = cpd->udev->fifo;
264 f = ppf[cpd->fifo_index + USB_FIFO_RX];
266 crd->is_read = 1; /* ref */
267 if (f == NULL || f->refcount == USB_FIFO_REF_MAX)
269 if (f->curr_cpd != cpd)
271 /* check if USB-FS is active */
272 if (f->fs_ep_max != 0) {
278 /* when everything is OK we increment the refcounts */
280 DPRINTFN(2, "ref write\n");
281 crd->txfifo->refcount++;
284 DPRINTFN(2, "ref read\n");
285 crd->rxfifo->refcount++;
287 mtx_unlock(&usb_ref_lock);
293 usbd_enum_unlock(cpd->udev);
296 cpd->udev->refcount--;
297 cv_broadcast(&cpd->udev->ref_cv);
299 mtx_unlock(&usb_ref_lock);
300 DPRINTFN(2, "fail\n");
303 memset(crd, 0, sizeof(*crd));
305 return (USB_ERR_INVAL);
308 /*------------------------------------------------------------------------*
311 * This function is used to upgrade an USB reference to include the
312 * USB device reference on a USB location.
315 * 0: Success, refcount incremented on the given USB device.
317 *------------------------------------------------------------------------*/
319 usb_usb_ref_device(struct usb_cdev_privdata *cpd,
320 struct usb_cdev_refdata *crd)
323 * Check if we already got an USB reference on this location:
326 return (0); /* success */
329 * To avoid deadlock at detach we need to drop the FIFO ref
330 * and re-acquire a new ref!
332 usb_unref_device(cpd, crd);
334 return (usb_ref_device(cpd, crd, 1 /* need uref */));
337 /*------------------------------------------------------------------------*
340 * This function will release the reference count by one unit for the
342 *------------------------------------------------------------------------*/
344 usb_unref_device(struct usb_cdev_privdata *cpd,
345 struct usb_cdev_refdata *crd)
348 DPRINTFN(2, "cpd=%p is_uref=%d\n", cpd, crd->is_uref);
351 usbd_enum_unlock(cpd->udev);
353 mtx_lock(&usb_ref_lock);
355 if (--(crd->rxfifo->refcount) == 0) {
356 cv_signal(&crd->rxfifo->cv_drain);
361 if (--(crd->txfifo->refcount) == 0) {
362 cv_signal(&crd->txfifo->cv_drain);
368 cpd->udev->refcount--;
369 cv_broadcast(&cpd->udev->ref_cv);
371 mtx_unlock(&usb_ref_lock);
374 static struct usb_fifo *
375 usb_fifo_alloc(struct mtx *mtx)
379 f = malloc(sizeof(*f), M_USBDEV, M_WAITOK | M_ZERO);
381 cv_init(&f->cv_io, "FIFO-IO");
382 cv_init(&f->cv_drain, "FIFO-DRAIN");
385 knlist_init_mtx(&f->selinfo.si_note, mtx);
390 /*------------------------------------------------------------------------*
392 *------------------------------------------------------------------------*/
394 usb_fifo_create(struct usb_cdev_privdata *cpd,
395 struct usb_cdev_refdata *crd)
397 struct usb_device *udev = cpd->udev;
399 struct usb_endpoint *ep;
405 int e = cpd->ep_addr;
407 is_tx = (cpd->fflags & FWRITE) ? 1 : 0;
408 is_rx = (cpd->fflags & FREAD) ? 1 : 0;
412 /* Preallocated FIFO */
414 DPRINTFN(5, "Preallocated FIFO\n");
416 f = udev->fifo[cpd->fifo_index + USB_FIFO_TX];
422 f = udev->fifo[cpd->fifo_index + USB_FIFO_RX];
430 KASSERT(e >= 0 && e <= 15, ("endpoint %d out of range", e));
432 /* search for a free FIFO slot */
433 DPRINTFN(5, "Endpoint device, searching for 0x%02x\n", e);
434 for (n = 0;; n += 2) {
436 if (n == USB_FIFO_MAX) {
441 /* end of FIFOs reached */
442 DPRINTFN(5, "out of FIFOs\n");
446 /* Check for TX FIFO */
448 f = udev->fifo[n + USB_FIFO_TX];
450 if (f->dev_ep_index != e) {
451 /* wrong endpoint index */
454 if (f->curr_cpd != NULL) {
459 } else if (no_null) {
463 /* Check for RX FIFO */
465 f = udev->fifo[n + USB_FIFO_RX];
467 if (f->dev_ep_index != e) {
468 /* wrong endpoint index */
471 if (f->curr_cpd != NULL) {
476 } else if (no_null) {
484 if (e >= (USB_EP_MAX / 2)) {
485 /* we don't create any endpoints in this range */
486 DPRINTFN(5, "ep out of range\n");
487 return (is_busy ? EBUSY : EINVAL);
491 if ((e != 0) && is_busy) {
493 * Only the default control endpoint is allowed to be
494 * opened multiple times!
496 DPRINTFN(5, "busy\n");
502 (udev->fifo[n + USB_FIFO_TX] == NULL)) {
503 ep = usb_dev_get_ep(udev, e, USB_FIFO_TX);
504 DPRINTFN(5, "dev_get_endpoint(%d, 0x%x)\n", e, USB_FIFO_TX);
506 DPRINTFN(5, "dev_get_endpoint returned NULL\n");
509 f = usb_fifo_alloc(&udev->device_mtx);
511 DPRINTFN(5, "could not alloc tx fifo\n");
514 /* update some fields */
515 f->fifo_index = n + USB_FIFO_TX;
518 f->methods = &usb_ugen_methods;
519 f->iface_index = ep->iface_index;
521 mtx_lock(&usb_ref_lock);
522 udev->fifo[n + USB_FIFO_TX] = f;
523 mtx_unlock(&usb_ref_lock);
527 (udev->fifo[n + USB_FIFO_RX] == NULL)) {
529 ep = usb_dev_get_ep(udev, e, USB_FIFO_RX);
530 DPRINTFN(5, "dev_get_endpoint(%d, 0x%x)\n", e, USB_FIFO_RX);
532 DPRINTFN(5, "dev_get_endpoint returned NULL\n");
535 f = usb_fifo_alloc(&udev->device_mtx);
537 DPRINTFN(5, "could not alloc rx fifo\n");
540 /* update some fields */
541 f->fifo_index = n + USB_FIFO_RX;
544 f->methods = &usb_ugen_methods;
545 f->iface_index = ep->iface_index;
547 mtx_lock(&usb_ref_lock);
548 udev->fifo[n + USB_FIFO_RX] = f;
549 mtx_unlock(&usb_ref_lock);
552 crd->txfifo = udev->fifo[n + USB_FIFO_TX];
555 crd->rxfifo = udev->fifo[n + USB_FIFO_RX];
557 /* fill out fifo index */
558 DPRINTFN(5, "fifo index = %d\n", n);
567 usb_fifo_free(struct usb_fifo *f)
575 /* destroy symlink devices, if any */
576 for (n = 0; n != 2; n++) {
578 usb_free_symlink(f->symlink[n]);
579 f->symlink[n] = NULL;
582 mtx_lock(&usb_ref_lock);
584 /* delink ourselves to stop calls from userland */
585 if ((f->fifo_index < USB_FIFO_MAX) &&
587 (f->udev->fifo[f->fifo_index] == f)) {
588 f->udev->fifo[f->fifo_index] = NULL;
590 DPRINTFN(0, "USB FIFO %p has not been linked\n", f);
593 /* decrease refcount */
595 /* prevent any write flush */
597 /* need to wait until all callers have exited */
598 while (f->refcount != 0) {
599 mtx_unlock(&usb_ref_lock); /* avoid LOR */
600 mtx_lock(f->priv_mtx);
601 /* get I/O thread out of any sleep state */
602 if (f->flag_sleeping) {
603 f->flag_sleeping = 0;
604 cv_broadcast(&f->cv_io);
606 mtx_unlock(f->priv_mtx);
607 mtx_lock(&usb_ref_lock);
610 * Check if the "f->refcount" variable reached zero
611 * during the unlocked time before entering wait:
613 if (f->refcount == 0)
617 cv_wait(&f->cv_drain, &usb_ref_lock);
619 mtx_unlock(&usb_ref_lock);
621 /* take care of closing the device here, if any */
622 usb_fifo_close(f, 0);
624 cv_destroy(&f->cv_io);
625 cv_destroy(&f->cv_drain);
627 knlist_clear(&f->selinfo.si_note, 0);
628 seldrain(&f->selinfo);
629 knlist_destroy(&f->selinfo.si_note);
634 static struct usb_endpoint *
635 usb_dev_get_ep(struct usb_device *udev, uint8_t ep_index, uint8_t dir)
637 struct usb_endpoint *ep;
643 if (dir == USB_FIFO_RX) {
644 if (udev->flags.usb_mode == USB_MODE_HOST) {
650 if (udev->flags.usb_mode == USB_MODE_HOST) {
656 ep = usbd_get_ep_by_addr(udev, ep_index | ep_dir);
660 /* if the endpoint does not exist then return */
663 if (ep->edesc == NULL) {
664 /* invalid endpoint */
667 return (ep); /* success */
670 /*------------------------------------------------------------------------*
676 *------------------------------------------------------------------------*/
678 usb_fifo_open(struct usb_cdev_privdata *cpd,
679 struct usb_fifo *f, int fflags)
685 DPRINTFN(2, "no FIFO\n");
688 /* remove FWRITE and FREAD flags */
689 fflags &= ~(FWRITE | FREAD);
691 /* set correct file flags */
692 if ((f->fifo_index & 1) == USB_FIFO_TX) {
698 /* check if we are already opened */
699 /* we don't need any locks when checking this variable */
700 if (f->curr_cpd != NULL) {
705 /* reset short flag before open */
708 /* call open method */
709 err = (f->methods->f_open) (f, fflags);
713 mtx_lock(f->priv_mtx);
715 /* reset sleep flag */
716 f->flag_sleeping = 0;
718 /* reset error flag */
721 /* reset complete flag */
722 f->flag_iscomplete = 0;
724 /* reset select flag */
725 f->flag_isselect = 0;
727 /* reset flushing flag */
728 f->flag_flushing = 0;
730 /* reset ASYNC proc flag */
733 mtx_lock(&usb_ref_lock);
734 /* flag the fifo as opened to prevent others */
736 mtx_unlock(&usb_ref_lock);
741 mtx_unlock(f->priv_mtx);
746 /*------------------------------------------------------------------------*
748 *------------------------------------------------------------------------*/
750 usb_fifo_reset(struct usb_fifo *f)
758 USB_IF_DEQUEUE(&f->used_q, m);
760 USB_IF_ENQUEUE(&f->free_q, m);
765 /* reset have fragment flag */
766 f->flag_have_fragment = 0;
769 /*------------------------------------------------------------------------*
771 *------------------------------------------------------------------------*/
773 usb_fifo_close(struct usb_fifo *f, int fflags)
777 /* check if we are not opened */
778 if (f->curr_cpd == NULL) {
779 /* nothing to do - already closed */
782 mtx_lock(f->priv_mtx);
784 /* clear current cdev private data pointer */
785 mtx_lock(&usb_ref_lock);
787 mtx_unlock(&usb_ref_lock);
789 /* check if we are watched by kevent */
790 KNOTE_LOCKED(&f->selinfo.si_note, 0);
792 /* check if we are selected */
793 if (f->flag_isselect) {
794 selwakeup(&f->selinfo);
795 f->flag_isselect = 0;
797 /* check if a thread wants SIGIO */
798 if (f->async_p != NULL) {
799 PROC_LOCK(f->async_p);
800 kern_psignal(f->async_p, SIGIO);
801 PROC_UNLOCK(f->async_p);
804 /* remove FWRITE and FREAD flags */
805 fflags &= ~(FWRITE | FREAD);
807 /* flush written data, if any */
808 if ((f->fifo_index & 1) == USB_FIFO_TX) {
810 if (!f->flag_iserror) {
812 /* set flushing flag */
813 f->flag_flushing = 1;
815 /* get the last packet in */
816 if (f->flag_have_fragment) {
818 f->flag_have_fragment = 0;
819 USB_IF_DEQUEUE(&f->free_q, m);
821 USB_IF_ENQUEUE(&f->used_q, m);
825 /* start write transfer, if not already started */
826 (f->methods->f_start_write) (f);
828 /* check if flushed already */
829 while (f->flag_flushing &&
830 (!f->flag_iserror)) {
831 /* wait until all data has been written */
832 f->flag_sleeping = 1;
833 err = cv_wait_sig(&f->cv_io, f->priv_mtx);
835 DPRINTF("signal received\n");
842 /* stop write transfer, if not already stopped */
843 (f->methods->f_stop_write) (f);
847 /* stop write transfer, if not already stopped */
848 (f->methods->f_stop_read) (f);
851 /* check if we are sleeping */
852 if (f->flag_sleeping) {
853 DPRINTFN(2, "Sleeping at close!\n");
855 mtx_unlock(f->priv_mtx);
857 /* call close method */
858 (f->methods->f_close) (f, fflags);
863 /*------------------------------------------------------------------------*
864 * usb_open - cdev callback
865 *------------------------------------------------------------------------*/
867 usb_open(struct cdev *dev, int fflags, int devtype, struct thread *td)
869 struct usb_fs_privdata* pd = (struct usb_fs_privdata*)dev->si_drv1;
870 struct usb_cdev_refdata refs;
871 struct usb_cdev_privdata *cpd;
874 DPRINTFN(2, "%s fflags=0x%08x\n", devtoname(dev), fflags);
876 KASSERT(fflags & (FREAD|FWRITE), ("invalid open flags"));
877 if (((fflags & FREAD) && !(pd->mode & FREAD)) ||
878 ((fflags & FWRITE) && !(pd->mode & FWRITE))) {
879 DPRINTFN(2, "access mode not supported\n");
883 cpd = malloc(sizeof(*cpd), M_USBDEV, M_WAITOK | M_ZERO);
884 ep = cpd->ep_addr = pd->ep_addr;
886 usb_loc_fill(pd, cpd);
887 err = usb_ref_device(cpd, &refs, 1);
889 DPRINTFN(2, "cannot ref device\n");
893 cpd->fflags = fflags; /* access mode for open lifetime */
895 /* create FIFOs, if any */
896 err = usb_fifo_create(cpd, &refs);
897 /* check for error */
899 DPRINTFN(2, "cannot create fifo\n");
900 usb_unref_device(cpd, &refs);
904 if (fflags & FREAD) {
905 err = usb_fifo_open(cpd, refs.rxfifo, fflags);
907 DPRINTFN(2, "read open failed\n");
908 usb_unref_device(cpd, &refs);
913 if (fflags & FWRITE) {
914 err = usb_fifo_open(cpd, refs.txfifo, fflags);
916 DPRINTFN(2, "write open failed\n");
917 if (fflags & FREAD) {
918 usb_fifo_close(refs.rxfifo, fflags);
920 usb_unref_device(cpd, &refs);
925 usb_unref_device(cpd, &refs);
926 devfs_set_cdevpriv(cpd, usb_close);
931 /*------------------------------------------------------------------------*
932 * usb_close - cdev callback
933 *------------------------------------------------------------------------*/
937 struct usb_cdev_refdata refs;
938 struct usb_cdev_privdata *cpd = arg;
941 DPRINTFN(2, "cpd=%p\n", cpd);
943 err = usb_ref_device(cpd, &refs,
944 2 /* uref and allow detached state */);
946 DPRINTFN(2, "Cannot grab USB reference when "
947 "closing USB file handle\n");
950 if (cpd->fflags & FREAD) {
951 usb_fifo_close(refs.rxfifo, cpd->fflags);
953 if (cpd->fflags & FWRITE) {
954 usb_fifo_close(refs.txfifo, cpd->fflags);
956 usb_unref_device(cpd, &refs);
962 usb_dev_init(void *arg)
964 mtx_init(&usb_ref_lock, "USB ref mutex", NULL, MTX_DEF);
965 sx_init(&usb_sym_lock, "USB sym mutex");
966 TAILQ_INIT(&usb_sym_head);
968 /* check the UGEN methods */
969 usb_fifo_check_methods(&usb_ugen_methods);
972 SYSINIT(usb_dev_init, SI_SUB_KLD, SI_ORDER_FIRST, usb_dev_init, NULL);
975 usb_dev_init_post(void *arg)
978 * Create /dev/usb - this is needed for usbconfig(8), which
979 * needs a well-known device name to access.
981 usb_dev = make_dev(&usb_static_devsw, 0, UID_ROOT, GID_OPERATOR,
982 0644, USB_DEVICE_NAME);
983 if (usb_dev == NULL) {
984 DPRINTFN(0, "Could not create usb bus device\n");
988 SYSINIT(usb_dev_init_post, SI_SUB_KICK_SCHEDULER, SI_ORDER_FIRST, usb_dev_init_post, NULL);
991 usb_dev_uninit(void *arg)
993 if (usb_dev != NULL) {
994 destroy_dev(usb_dev);
997 mtx_destroy(&usb_ref_lock);
998 sx_destroy(&usb_sym_lock);
1001 SYSUNINIT(usb_dev_uninit, SI_SUB_KICK_SCHEDULER, SI_ORDER_ANY, usb_dev_uninit, NULL);
1004 usb_ioctl_f_sub(struct usb_fifo *f, u_long cmd, void *addr,
1011 *(int *)addr = 0; /* character device */
1015 /* handled by upper FS layer */
1020 if (f->async_p != NULL) {
1024 f->async_p = USB_TD_GET_PROC(td);
1030 /* XXX this is not the most general solution */
1032 if (f->async_p == NULL) {
1036 if (*(int *)addr != USB_PROC_GET_GID(f->async_p)) {
1044 DPRINTFN(3, "cmd 0x%lx = %d\n", cmd, error);
1048 /*------------------------------------------------------------------------*
1049 * usb_ioctl - cdev callback
1050 *------------------------------------------------------------------------*/
1052 usb_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int fflag, struct thread* td)
1054 struct usb_cdev_refdata refs;
1055 struct usb_cdev_privdata* cpd;
1060 DPRINTFN(2, "cmd=0x%lx\n", cmd);
1062 err = devfs_get_cdevpriv((void **)&cpd);
1067 * Performance optimisation: We try to check for IOCTL's that
1068 * don't need the USB reference first. Then we grab the USB
1069 * reference if we need it!
1071 err = usb_ref_device(cpd, &refs, 0 /* no uref */ );
1075 fflags = cpd->fflags;
1077 f = NULL; /* set default value */
1078 err = ENOIOCTL; /* set default value */
1080 if (fflags & FWRITE) {
1082 err = usb_ioctl_f_sub(f, cmd, addr, td);
1084 if (fflags & FREAD) {
1086 err = usb_ioctl_f_sub(f, cmd, addr, td);
1088 KASSERT(f != NULL, ("fifo not found"));
1089 if (err != ENOIOCTL)
1092 err = (f->methods->f_ioctl) (f, cmd, addr, fflags);
1094 DPRINTFN(2, "f_ioctl cmd 0x%lx = %d\n", cmd, err);
1096 if (err != ENOIOCTL)
1099 if (usb_usb_ref_device(cpd, &refs)) {
1100 /* we lost the reference */
1104 err = (f->methods->f_ioctl_post) (f, cmd, addr, fflags);
1106 DPRINTFN(2, "f_ioctl_post cmd 0x%lx = %d\n", cmd, err);
1108 if (err == ENOIOCTL)
1114 /* Wait for re-enumeration, if any */
1116 while (f->udev->re_enumerate_wait != USB_RE_ENUM_DONE) {
1118 usb_unref_device(cpd, &refs);
1120 usb_pause_mtx(NULL, hz / 128);
1122 while (usb_ref_device(cpd, &refs, 1 /* need uref */)) {
1123 if (usb_ref_device(cpd, &refs, 0)) {
1124 /* device no longer exists */
1127 usb_unref_device(cpd, &refs);
1128 usb_pause_mtx(NULL, hz / 128);
1133 usb_unref_device(cpd, &refs);
1138 usb_filter_detach(struct knote *kn)
1140 struct usb_fifo *f = kn->kn_hook;
1141 knlist_remove(&f->selinfo.si_note, kn, 0);
1145 usb_filter_write(struct knote *kn, long hint)
1147 struct usb_cdev_privdata* cpd;
1155 mtx_assert(f->priv_mtx, MA_OWNED);
1160 } else if (f->fs_ep_max == 0) {
1161 if (f->flag_iserror) {
1162 /* we got an error */
1165 if (f->queue_data == NULL) {
1167 * start write transfer, if not
1170 (f->methods->f_start_write) (f);
1172 /* check if any packets are available */
1173 USB_IF_POLL(&f->free_q, m);
1176 if (f->flag_iscomplete) {
1186 usb_filter_read(struct knote *kn, long hint)
1188 struct usb_cdev_privdata* cpd;
1196 mtx_assert(f->priv_mtx, MA_OWNED);
1201 } else if (f->fs_ep_max == 0) {
1202 if (f->flag_iserror) {
1203 /* we have an error */
1206 if (f->queue_data == NULL) {
1208 * start read transfer, if not
1211 (f->methods->f_start_read) (f);
1213 /* check if any packets are available */
1214 USB_IF_POLL(&f->used_q, m);
1216 /* start reading data, if any */
1218 (f->methods->f_start_read) (f);
1221 if (f->flag_iscomplete) {
1230 static struct filterops usb_filtops_write = {
1232 .f_detach = usb_filter_detach,
1233 .f_event = usb_filter_write,
1236 static struct filterops usb_filtops_read = {
1238 .f_detach = usb_filter_detach,
1239 .f_event = usb_filter_read,
1245 usb_kqfilter(struct cdev* dev, struct knote *kn)
1247 struct usb_cdev_refdata refs;
1248 struct usb_cdev_privdata* cpd;
1255 if (devfs_get_cdevpriv((void **)&cpd) != 0 ||
1256 usb_ref_device(cpd, &refs, 0) != 0)
1259 fflags = cpd->fflags;
1261 /* Figure out who needs service */
1262 switch (kn->kn_filter) {
1264 if (fflags & FWRITE) {
1266 kn->kn_fop = &usb_filtops_write;
1271 if (fflags & FREAD) {
1273 kn->kn_fop = &usb_filtops_read;
1284 mtx_lock(f->priv_mtx);
1285 knlist_add(&f->selinfo.si_note, kn, 1);
1286 mtx_unlock(f->priv_mtx);
1289 usb_unref_device(cpd, &refs);
1295 usb_poll(struct cdev* dev, int events, struct thread* td)
1297 struct usb_cdev_refdata refs;
1298 struct usb_cdev_privdata* cpd;
1301 int fflags, revents;
1303 if (devfs_get_cdevpriv((void **)&cpd) != 0 ||
1304 usb_ref_device(cpd, &refs, 0) != 0)
1306 (POLLHUP|POLLIN|POLLRDNORM|POLLOUT|POLLWRNORM));
1308 fflags = cpd->fflags;
1310 /* Figure out who needs service */
1312 if ((events & (POLLOUT | POLLWRNORM)) &&
1313 (fflags & FWRITE)) {
1317 mtx_lock(f->priv_mtx);
1319 if (!refs.is_usbfs) {
1320 if (f->flag_iserror) {
1321 /* we got an error */
1324 if (f->queue_data == NULL) {
1326 * start write transfer, if not
1329 (f->methods->f_start_write) (f);
1331 /* check if any packets are available */
1332 USB_IF_POLL(&f->free_q, m);
1335 if (f->flag_iscomplete) {
1343 revents |= events & (POLLOUT | POLLWRNORM);
1345 f->flag_isselect = 1;
1346 selrecord(td, &f->selinfo);
1349 mtx_unlock(f->priv_mtx);
1351 if ((events & (POLLIN | POLLRDNORM)) &&
1356 mtx_lock(f->priv_mtx);
1358 if (!refs.is_usbfs) {
1359 if (f->flag_iserror) {
1360 /* we have an error */
1363 if (f->queue_data == NULL) {
1365 * start read transfer, if not
1368 (f->methods->f_start_read) (f);
1370 /* check if any packets are available */
1371 USB_IF_POLL(&f->used_q, m);
1374 if (f->flag_iscomplete) {
1382 revents |= events & (POLLIN | POLLRDNORM);
1384 f->flag_isselect = 1;
1385 selrecord(td, &f->selinfo);
1387 if (!refs.is_usbfs) {
1388 /* start reading data */
1389 (f->methods->f_start_read) (f);
1393 mtx_unlock(f->priv_mtx);
1395 usb_unref_device(cpd, &refs);
1400 usb_read(struct cdev *dev, struct uio *uio, int ioflag)
1402 struct usb_cdev_refdata refs;
1403 struct usb_cdev_privdata* cpd;
1410 uint8_t tr_data = 0;
1412 err = devfs_get_cdevpriv((void **)&cpd);
1416 err = usb_ref_device(cpd, &refs, 0 /* no uref */ );
1420 fflags = cpd->fflags;
1424 /* should not happen */
1425 usb_unref_device(cpd, &refs);
1429 resid = uio->uio_resid;
1431 mtx_lock(f->priv_mtx);
1433 /* check for permanent read error */
1434 if (f->flag_iserror) {
1438 /* check if USB-FS interface is active */
1439 if (refs.is_usbfs) {
1441 * The queue is used for events that should be
1442 * retrieved using the "USB_FS_COMPLETE" ioctl.
1447 while (uio->uio_resid > 0) {
1449 USB_IF_DEQUEUE(&f->used_q, m);
1453 /* start read transfer, if not already started */
1455 (f->methods->f_start_read) (f);
1457 if (ioflag & IO_NDELAY) {
1459 /* return length before error */
1465 DPRINTF("sleeping\n");
1467 err = usb_fifo_wait(f);
1473 if (f->methods->f_filter_read) {
1475 * Sometimes it is convenient to process data at the
1476 * expense of a userland process instead of a kernel
1479 (f->methods->f_filter_read) (f, m);
1483 io_len = MIN(m->cur_data_len, uio->uio_resid);
1485 DPRINTFN(2, "transfer %d bytes from %p\n",
1486 io_len, m->cur_data_ptr);
1488 err = usb_fifo_uiomove(f,
1489 m->cur_data_ptr, io_len, uio);
1491 m->cur_data_len -= io_len;
1492 m->cur_data_ptr += io_len;
1494 if (m->cur_data_len == 0) {
1496 uint8_t last_packet;
1498 last_packet = m->last_packet;
1500 USB_IF_ENQUEUE(&f->free_q, m);
1507 USB_IF_PREPEND(&f->used_q, m);
1515 mtx_unlock(f->priv_mtx);
1517 usb_unref_device(cpd, &refs);
1523 usb_write(struct cdev *dev, struct uio *uio, int ioflag)
1525 struct usb_cdev_refdata refs;
1526 struct usb_cdev_privdata* cpd;
1534 uint8_t tr_data = 0;
1538 err = devfs_get_cdevpriv((void **)&cpd);
1542 err = usb_ref_device(cpd, &refs, 0 /* no uref */ );
1546 fflags = cpd->fflags;
1550 /* should not happen */
1551 usb_unref_device(cpd, &refs);
1554 resid = uio->uio_resid;
1556 mtx_lock(f->priv_mtx);
1558 /* check for permanent write error */
1559 if (f->flag_iserror) {
1563 /* check if USB-FS interface is active */
1564 if (refs.is_usbfs) {
1566 * The queue is used for events that should be
1567 * retrieved using the "USB_FS_COMPLETE" ioctl.
1572 if (f->queue_data == NULL) {
1573 /* start write transfer, if not already started */
1574 (f->methods->f_start_write) (f);
1576 /* we allow writing zero length data */
1578 USB_IF_DEQUEUE(&f->free_q, m);
1582 if (ioflag & IO_NDELAY) {
1584 /* return length before error */
1590 DPRINTF("sleeping\n");
1592 err = usb_fifo_wait(f);
1600 if (f->flag_have_fragment == 0) {
1602 io_len = m->cur_data_len;
1603 pdata = m->cur_data_ptr;
1604 if (io_len > uio->uio_resid)
1605 io_len = uio->uio_resid;
1606 m->cur_data_len = io_len;
1608 io_len = m->max_data_len - m->cur_data_len;
1609 pdata = m->cur_data_ptr + m->cur_data_len;
1610 if (io_len > uio->uio_resid)
1611 io_len = uio->uio_resid;
1612 m->cur_data_len += io_len;
1615 DPRINTFN(2, "transfer %d bytes to %p\n",
1618 err = usb_fifo_uiomove(f, pdata, io_len, uio);
1621 f->flag_have_fragment = 0;
1622 USB_IF_ENQUEUE(&f->free_q, m);
1626 /* check if the buffer is ready to be transmitted */
1628 if ((f->flag_write_defrag == 0) ||
1629 (m->cur_data_len == m->max_data_len)) {
1630 f->flag_have_fragment = 0;
1633 * Check for write filter:
1635 * Sometimes it is convenient to process data
1636 * at the expense of a userland process
1637 * instead of a kernel process.
1639 if (f->methods->f_filter_write) {
1640 (f->methods->f_filter_write) (f, m);
1643 /* Put USB mbuf in the used queue */
1644 USB_IF_ENQUEUE(&f->used_q, m);
1646 /* Start writing data, if not already started */
1647 (f->methods->f_start_write) (f);
1649 /* Wait for more data or close */
1650 f->flag_have_fragment = 1;
1651 USB_IF_PREPEND(&f->free_q, m);
1654 } while (uio->uio_resid > 0);
1656 mtx_unlock(f->priv_mtx);
1658 usb_unref_device(cpd, &refs);
1664 usb_static_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
1668 struct usb_read_dir *urd;
1676 err = usb_read_symlink(u.urd->urd_data,
1677 u.urd->urd_startentry, u.urd->urd_maxlen);
1679 case USB_DEV_QUIRK_GET:
1680 case USB_QUIRK_NAME_GET:
1681 case USB_DEV_QUIRK_ADD:
1682 case USB_DEV_QUIRK_REMOVE:
1683 err = usb_quirk_ioctl_p(cmd, data, fflag, td);
1685 case USB_GET_TEMPLATE:
1686 *(int *)data = usb_template;
1689 case USB_SET_TEMPLATE:
1690 err = priv_check(curthread, PRIV_DRIVER);
1693 usb_template = *(int *)data;
1703 usb_fifo_uiomove(struct usb_fifo *f, void *cp,
1704 int n, struct uio *uio)
1708 mtx_unlock(f->priv_mtx);
1711 * "uiomove()" can sleep so one needs to make a wrapper,
1712 * exiting the mutex and checking things:
1714 error = uiomove(cp, n, uio);
1716 mtx_lock(f->priv_mtx);
1722 usb_fifo_wait(struct usb_fifo *f)
1726 mtx_assert(f->priv_mtx, MA_OWNED);
1728 if (f->flag_iserror) {
1732 f->flag_sleeping = 1;
1734 err = cv_wait_sig(&f->cv_io, f->priv_mtx);
1736 if (f->flag_iserror) {
1744 usb_fifo_signal(struct usb_fifo *f)
1746 if (f->flag_sleeping) {
1747 f->flag_sleeping = 0;
1748 cv_broadcast(&f->cv_io);
1753 usb_fifo_wakeup(struct usb_fifo *f)
1757 KNOTE_LOCKED(&f->selinfo.si_note, 0);
1759 if (f->flag_isselect) {
1760 selwakeup(&f->selinfo);
1761 f->flag_isselect = 0;
1763 if (f->async_p != NULL) {
1764 PROC_LOCK(f->async_p);
1765 kern_psignal(f->async_p, SIGIO);
1766 PROC_UNLOCK(f->async_p);
1771 usb_fifo_dummy_open(struct usb_fifo *fifo, int fflags)
1777 usb_fifo_dummy_close(struct usb_fifo *fifo, int fflags)
1783 usb_fifo_dummy_ioctl(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags)
1789 usb_fifo_dummy_cmd(struct usb_fifo *fifo)
1791 fifo->flag_flushing = 0; /* not flushing */
1795 usb_fifo_check_methods(struct usb_fifo_methods *pm)
1797 /* check that all callback functions are OK */
1799 if (pm->f_open == NULL)
1800 pm->f_open = &usb_fifo_dummy_open;
1802 if (pm->f_close == NULL)
1803 pm->f_close = &usb_fifo_dummy_close;
1805 if (pm->f_ioctl == NULL)
1806 pm->f_ioctl = &usb_fifo_dummy_ioctl;
1808 if (pm->f_ioctl_post == NULL)
1809 pm->f_ioctl_post = &usb_fifo_dummy_ioctl;
1811 if (pm->f_start_read == NULL)
1812 pm->f_start_read = &usb_fifo_dummy_cmd;
1814 if (pm->f_stop_read == NULL)
1815 pm->f_stop_read = &usb_fifo_dummy_cmd;
1817 if (pm->f_start_write == NULL)
1818 pm->f_start_write = &usb_fifo_dummy_cmd;
1820 if (pm->f_stop_write == NULL)
1821 pm->f_stop_write = &usb_fifo_dummy_cmd;
1824 /*------------------------------------------------------------------------*
1827 * The following function will create a duplex FIFO.
1832 *------------------------------------------------------------------------*/
1834 usb_fifo_attach(struct usb_device *udev, void *priv_sc,
1835 struct mtx *priv_mtx, struct usb_fifo_methods *pm,
1836 struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit,
1837 uint8_t iface_index, uid_t uid, gid_t gid, int mode)
1839 struct usb_fifo *f_tx;
1840 struct usb_fifo *f_rx;
1844 f_sc->fp[USB_FIFO_TX] = NULL;
1845 f_sc->fp[USB_FIFO_RX] = NULL;
1850 /* check the methods */
1851 usb_fifo_check_methods(pm);
1853 if (priv_mtx == NULL)
1856 /* search for a free FIFO slot */
1857 for (n = 0;; n += 2) {
1859 if (n == USB_FIFO_MAX) {
1860 /* end of FIFOs reached */
1863 /* Check for TX FIFO */
1864 if (udev->fifo[n + USB_FIFO_TX] != NULL) {
1867 /* Check for RX FIFO */
1868 if (udev->fifo[n + USB_FIFO_RX] != NULL) {
1874 f_tx = usb_fifo_alloc(priv_mtx);
1875 f_rx = usb_fifo_alloc(priv_mtx);
1877 if ((f_tx == NULL) || (f_rx == NULL)) {
1878 usb_fifo_free(f_tx);
1879 usb_fifo_free(f_rx);
1882 /* initialise FIFO structures */
1884 f_tx->fifo_index = n + USB_FIFO_TX;
1885 f_tx->dev_ep_index = -1;
1886 f_tx->priv_sc0 = priv_sc;
1888 f_tx->iface_index = iface_index;
1891 f_rx->fifo_index = n + USB_FIFO_RX;
1892 f_rx->dev_ep_index = -1;
1893 f_rx->priv_sc0 = priv_sc;
1895 f_rx->iface_index = iface_index;
1898 f_sc->fp[USB_FIFO_TX] = f_tx;
1899 f_sc->fp[USB_FIFO_RX] = f_rx;
1901 mtx_lock(&usb_ref_lock);
1902 udev->fifo[f_tx->fifo_index] = f_tx;
1903 udev->fifo[f_rx->fifo_index] = f_rx;
1904 mtx_unlock(&usb_ref_lock);
1906 for (n = 0; n != 4; n++) {
1908 if (pm->basename[n] == NULL) {
1912 if (snprintf(devname, sizeof(devname),
1913 "%s%u%s", pm->basename[n],
1914 unit, pm->postfix[n] ?
1915 pm->postfix[n] : "")) {
1919 if (snprintf(devname, sizeof(devname),
1920 "%s%u.%d%s", pm->basename[n],
1921 unit, subunit, pm->postfix[n] ?
1922 pm->postfix[n] : "")) {
1928 * Distribute the symbolic links into two FIFO structures:
1931 f_rx->symlink[n / 2] =
1932 usb_alloc_symlink(devname);
1934 f_tx->symlink[n / 2] =
1935 usb_alloc_symlink(devname);
1938 /* Create the device */
1939 f_sc->dev = usb_make_dev(udev, devname, -1,
1940 f_tx->fifo_index & f_rx->fifo_index,
1941 FREAD|FWRITE, uid, gid, mode);
1944 DPRINTFN(2, "attached %p/%p\n", f_tx, f_rx);
1948 /*------------------------------------------------------------------------*
1949 * usb_fifo_alloc_buffer
1954 *------------------------------------------------------------------------*/
1956 usb_fifo_alloc_buffer(struct usb_fifo *f, usb_size_t bufsize,
1959 usb_fifo_free_buffer(f);
1961 /* allocate an endpoint */
1962 f->free_q.ifq_maxlen = nbuf;
1963 f->used_q.ifq_maxlen = nbuf;
1965 f->queue_data = usb_alloc_mbufs(
1966 M_USBDEV, &f->free_q, bufsize, nbuf);
1968 if ((f->queue_data == NULL) && bufsize && nbuf) {
1971 return (0); /* success */
1974 /*------------------------------------------------------------------------*
1975 * usb_fifo_free_buffer
1977 * This function will free the buffers associated with a FIFO. This
1978 * function can be called multiple times in a row.
1979 *------------------------------------------------------------------------*/
1981 usb_fifo_free_buffer(struct usb_fifo *f)
1983 if (f->queue_data) {
1984 /* free old buffer */
1985 free(f->queue_data, M_USBDEV);
1986 f->queue_data = NULL;
1990 memset(&f->free_q, 0, sizeof(f->free_q));
1991 memset(&f->used_q, 0, sizeof(f->used_q));
1995 usb_fifo_detach(struct usb_fifo_sc *f_sc)
2000 usb_fifo_free(f_sc->fp[USB_FIFO_TX]);
2001 usb_fifo_free(f_sc->fp[USB_FIFO_RX]);
2003 f_sc->fp[USB_FIFO_TX] = NULL;
2004 f_sc->fp[USB_FIFO_RX] = NULL;
2006 usb_destroy_dev(f_sc->dev);
2010 DPRINTFN(2, "detached %p\n", f_sc);
2014 usb_fifo_put_bytes_max(struct usb_fifo *f)
2019 USB_IF_POLL(&f->free_q, m);
2022 len = m->max_data_len;
2029 /*------------------------------------------------------------------------*
2033 * 0 - normal operation
2034 * 1 - set last packet flag to enforce framing
2035 *------------------------------------------------------------------------*/
2037 usb_fifo_put_data(struct usb_fifo *f, struct usb_page_cache *pc,
2038 usb_frlength_t offset, usb_frlength_t len, uint8_t what)
2041 usb_frlength_t io_len;
2043 while (len || (what == 1)) {
2045 USB_IF_DEQUEUE(&f->free_q, m);
2050 io_len = MIN(len, m->cur_data_len);
2052 usbd_copy_out(pc, offset, m->cur_data_ptr, io_len);
2054 m->cur_data_len = io_len;
2058 if ((len == 0) && (what == 1)) {
2061 USB_IF_ENQUEUE(&f->used_q, m);
2065 if ((len == 0) || (what == 1)) {
2075 usb_fifo_put_data_linear(struct usb_fifo *f, void *ptr,
2076 usb_size_t len, uint8_t what)
2081 while (len || (what == 1)) {
2083 USB_IF_DEQUEUE(&f->free_q, m);
2088 io_len = MIN(len, m->cur_data_len);
2090 memcpy(m->cur_data_ptr, ptr, io_len);
2092 m->cur_data_len = io_len;
2093 ptr = USB_ADD_BYTES(ptr, io_len);
2096 if ((len == 0) && (what == 1)) {
2099 USB_IF_ENQUEUE(&f->used_q, m);
2103 if ((len == 0) || (what == 1)) {
2113 usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len)
2117 USB_IF_DEQUEUE(&f->free_q, m);
2120 m->cur_data_len = len;
2121 m->cur_data_ptr = ptr;
2122 USB_IF_ENQUEUE(&f->used_q, m);
2130 usb_fifo_put_data_error(struct usb_fifo *f)
2132 f->flag_iserror = 1;
2136 /*------------------------------------------------------------------------*
2140 * 0 - normal operation
2141 * 1 - only get one "usb_mbuf"
2145 * 1 - data in buffer
2146 *------------------------------------------------------------------------*/
2148 usb_fifo_get_data(struct usb_fifo *f, struct usb_page_cache *pc,
2149 usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
2153 usb_frlength_t io_len;
2154 uint8_t tr_data = 0;
2160 USB_IF_DEQUEUE(&f->used_q, m);
2166 io_len = MIN(len, m->cur_data_len);
2168 usbd_copy_in(pc, offset, m->cur_data_ptr, io_len);
2172 actlen[0] += io_len;
2173 m->cur_data_ptr += io_len;
2174 m->cur_data_len -= io_len;
2176 if ((m->cur_data_len == 0) || (what == 1)) {
2177 USB_IF_ENQUEUE(&f->free_q, m);
2185 USB_IF_PREPEND(&f->used_q, m);
2190 /* wait for data to be written out */
2193 if (f->flag_flushing) {
2194 /* check if we should send a short packet */
2195 if (f->flag_short != 0) {
2200 /* flushing complete */
2201 f->flag_flushing = 0;
2214 usb_fifo_get_data_linear(struct usb_fifo *f, void *ptr,
2215 usb_size_t len, usb_size_t *actlen, uint8_t what)
2219 uint8_t tr_data = 0;
2225 USB_IF_DEQUEUE(&f->used_q, m);
2231 io_len = MIN(len, m->cur_data_len);
2233 memcpy(ptr, m->cur_data_ptr, io_len);
2236 ptr = USB_ADD_BYTES(ptr, io_len);
2237 actlen[0] += io_len;
2238 m->cur_data_ptr += io_len;
2239 m->cur_data_len -= io_len;
2241 if ((m->cur_data_len == 0) || (what == 1)) {
2242 USB_IF_ENQUEUE(&f->free_q, m);
2250 USB_IF_PREPEND(&f->used_q, m);
2255 /* wait for data to be written out */
2258 if (f->flag_flushing) {
2259 /* check if we should send a short packet */
2260 if (f->flag_short != 0) {
2265 /* flushing complete */
2266 f->flag_flushing = 0;
2279 usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr, usb_size_t *plen)
2283 USB_IF_POLL(&f->used_q, m);
2286 *plen = m->cur_data_len;
2287 *pptr = m->cur_data_ptr;
2295 usb_fifo_get_data_error(struct usb_fifo *f)
2297 f->flag_iserror = 1;
2301 /*------------------------------------------------------------------------*
2306 * Else: Pointer to symlink entry
2307 *------------------------------------------------------------------------*/
2308 struct usb_symlink *
2309 usb_alloc_symlink(const char *target)
2311 struct usb_symlink *ps;
2313 ps = malloc(sizeof(*ps), M_USBDEV, M_WAITOK);
2317 /* XXX no longer needed */
2318 strlcpy(ps->src_path, target, sizeof(ps->src_path));
2319 ps->src_len = strlen(ps->src_path);
2320 strlcpy(ps->dst_path, target, sizeof(ps->dst_path));
2321 ps->dst_len = strlen(ps->dst_path);
2323 sx_xlock(&usb_sym_lock);
2324 TAILQ_INSERT_TAIL(&usb_sym_head, ps, sym_entry);
2325 sx_unlock(&usb_sym_lock);
2329 /*------------------------------------------------------------------------*
2331 *------------------------------------------------------------------------*/
2333 usb_free_symlink(struct usb_symlink *ps)
2338 sx_xlock(&usb_sym_lock);
2339 TAILQ_REMOVE(&usb_sym_head, ps, sym_entry);
2340 sx_unlock(&usb_sym_lock);
2345 /*------------------------------------------------------------------------*
2351 *------------------------------------------------------------------------*/
2353 usb_read_symlink(uint8_t *user_ptr, uint32_t startentry, uint32_t user_len)
2355 struct usb_symlink *ps;
2361 sx_xlock(&usb_sym_lock);
2363 TAILQ_FOREACH(ps, &usb_sym_head, sym_entry) {
2366 * Compute total length of source and destination symlink
2367 * strings pluss one length byte and two NUL bytes:
2369 temp = ps->src_len + ps->dst_len + 3;
2373 * Skip entry because this length cannot fit
2378 if (startentry != 0) {
2379 /* decrement read offset */
2383 if (temp > user_len) {
2384 /* out of buffer space */
2389 /* copy out total length */
2391 error = copyout(&len,
2392 USB_ADD_BYTES(user_ptr, delta), 1);
2398 /* copy out source string */
2400 error = copyout(ps->src_path,
2401 USB_ADD_BYTES(user_ptr, delta), ps->src_len);
2406 delta += ps->src_len;
2407 error = copyout(&len,
2408 USB_ADD_BYTES(user_ptr, delta), 1);
2414 /* copy out destination string */
2416 error = copyout(ps->dst_path,
2417 USB_ADD_BYTES(user_ptr, delta), ps->dst_len);
2422 delta += ps->dst_len;
2423 error = copyout(&len,
2424 USB_ADD_BYTES(user_ptr, delta), 1);
2433 /* a zero length entry indicates the end */
2435 if ((user_len != 0) && (error == 0)) {
2439 error = copyout(&len,
2440 USB_ADD_BYTES(user_ptr, delta), 1);
2442 sx_unlock(&usb_sym_lock);
2447 usb_fifo_set_close_zlp(struct usb_fifo *f, uint8_t onoff)
2452 /* send a Zero Length Packet, ZLP, before close */
2453 f->flag_short = onoff;
2457 usb_fifo_set_write_defrag(struct usb_fifo *f, uint8_t onoff)
2462 /* defrag written data */
2463 f->flag_write_defrag = onoff;
2464 /* reset defrag state */
2465 f->flag_have_fragment = 0;
2469 usb_fifo_softc(struct usb_fifo *f)
2471 return (f->priv_sc0);
2473 #endif /* USB_HAVE_UGEN */