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