3 * Copyright (c) 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
30 #ifndef USB_GLOBAL_INCLUDE_FILE
32 #include <sys/selinfo.h>
34 #include <sys/signalvar.h>
42 TAILQ_ENTRY(usb_symlink) sym_entry;
43 char src_path[32]; /* Source path - including terminating
45 char dst_path[32]; /* Destination path - including
47 uint8_t src_len; /* String length */
48 uint8_t dst_len; /* String length */
52 * Private per-device information.
54 struct usb_cdev_privdata {
56 struct usb_device *udev;
57 struct usb_interface *iface;
58 int bus_index; /* bus index */
59 int dev_index; /* device index */
60 int ep_addr; /* endpoint address */
62 uint8_t fifo_index; /* FIFO index */
66 * The following structure defines a minimum re-implementation of the
67 * ifqueue structure in the kernel.
70 struct usb_mbuf *ifq_head;
71 struct usb_mbuf *ifq_tail;
74 usb_size_t ifq_maxlen;
78 * Private per-device and per-thread reference information
80 struct usb_cdev_refdata {
81 struct usb_fifo *rxfifo;
82 struct usb_fifo *txfifo;
83 uint8_t is_read; /* location has read access */
84 uint8_t is_write; /* location has write access */
85 uint8_t is_uref; /* USB refcount decr. needed */
86 uint8_t is_usbfs; /* USB-FS is active */
87 uint8_t do_unlock; /* USB enum unlock needed */
90 struct usb_fs_privdata {
98 LIST_ENTRY(usb_fs_privdata) pd_next;
102 * Most of the fields in the "usb_fifo" structure are used by the
103 * generic USB access layer.
106 struct usb_ifqueue free_q;
107 struct usb_ifqueue used_q;
108 struct selinfo selinfo;
111 struct usb_fifo_methods *methods;
112 struct usb_symlink *symlink[2];/* our symlinks */
113 struct proc *async_p; /* process that wants SIGIO */
114 struct usb_fs_endpoint *fs_ep_ptr;
115 struct usb_device *udev;
116 struct usb_xfer *xfer[2];
117 struct usb_xfer **fs_xfer;
118 struct mtx *priv_mtx; /* client data */
119 /* set if FIFO is opened by a FILE: */
120 struct usb_cdev_privdata *curr_cpd;
121 void *priv_sc0; /* client data */
122 void *priv_sc1; /* client data */
124 usb_timeout_t timeout; /* timeout in milliseconds */
125 usb_frlength_t bufsize; /* BULK and INTERRUPT buffer size */
126 usb_frcount_t nframes; /* for isochronous mode */
127 uint16_t dev_ep_index; /* our device endpoint index */
128 uint8_t flag_sleeping; /* set if FIFO is sleeping */
129 uint8_t flag_iscomplete; /* set if a USB transfer is complete */
130 uint8_t flag_iserror; /* set if FIFO error happened */
131 uint8_t flag_isselect; /* set if FIFO is selected */
132 uint8_t flag_flushing; /* set if FIFO is flushing data */
133 uint8_t flag_short; /* set if short_ok or force_short
134 * transfer flags should be set */
135 uint8_t flag_stall; /* set if clear stall should be run */
136 uint8_t flag_write_defrag; /* set to defrag written data */
137 uint8_t flag_have_fragment; /* set if defragging */
138 uint8_t iface_index; /* set to the interface we belong to */
139 uint8_t fifo_index; /* set to the FIFO index in "struct
142 uint8_t fifo_zlp; /* zero length packet count */
144 #define USB_FIFO_REF_MAX 0xFF
147 extern struct cdevsw usb_devsw;
149 int usb_fifo_wait(struct usb_fifo *fifo);
150 void usb_fifo_signal(struct usb_fifo *fifo);
151 uint8_t usb_fifo_opened(struct usb_fifo *fifo);
152 struct usb_symlink *usb_alloc_symlink(const char *target);
153 void usb_free_symlink(struct usb_symlink *ps);
154 int usb_read_symlink(uint8_t *user_ptr, uint32_t startentry,
157 #endif /* _USB_DEV_H_ */