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
27 #include <sys/stdint.h>
28 #include <sys/stddef.h>
29 #include <sys/param.h>
30 #include <sys/queue.h>
31 #include <sys/types.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/linker_set.h>
36 #include <sys/module.h>
38 #include <sys/mutex.h>
39 #include <sys/condvar.h>
40 #include <sys/sysctl.h>
42 #include <sys/unistd.h>
43 #include <sys/callout.h>
44 #include <sys/malloc.h>
47 #include <dev/usb/usb.h>
48 #include <dev/usb/usbdi.h>
49 #include <dev/usb/usbdi_util.h>
52 /*------------------------------------------------------------------------*
55 * This function is the safe way to iterate across the USB config
56 * descriptor. It contains several checks against invalid
57 * descriptors. If the "desc" argument passed to this function is
58 * "NULL" the first descriptor, if any, will be returned.
61 * NULL: End of descriptors
62 * Else: Next descriptor after "desc"
63 *------------------------------------------------------------------------*/
64 struct usb_descriptor *
65 usb_desc_foreach(struct usb_config_descriptor *cd,
66 struct usb_descriptor *_desc)
77 /* We assume that the "wTotalLength" has been checked. */
78 start = (uint8_t *)cd;
79 end = start + UGETW(cd->wTotalLength);
80 desc = (uint8_t *)_desc;
82 /* Get start of next USB descriptor. */
86 desc = desc + desc[0];
88 /* Check that the next USB descriptor is within the range. */
89 if ((desc < start) || (desc >= end))
90 return (NULL); /* out of range, or EOD */
92 /* Check that the second next USB descriptor is within range. */
93 desc_next = desc + desc[0];
94 if ((desc_next < start) || (desc_next > end))
95 return (NULL); /* out of range */
97 /* Check minimum descriptor length. */
99 return (NULL); /* too short descriptor */
101 /* Return start of next descriptor. */
102 return ((struct usb_descriptor *)desc);
105 /*------------------------------------------------------------------------*
108 * This function will iterate the interface descriptors in the config
109 * descriptor. The parse state structure should be zeroed before
110 * calling this function the first time.
113 * NULL: End of descriptors
114 * Else: A valid interface descriptor
115 *------------------------------------------------------------------------*/
116 struct usb_interface_descriptor *
117 usb_idesc_foreach(struct usb_config_descriptor *cd,
118 struct usb_idesc_parse_state *ps)
120 struct usb_interface_descriptor *id;
123 /* retrieve current descriptor */
124 id = (struct usb_interface_descriptor *)ps->desc;
125 /* default is to start a new interface */
129 id = (struct usb_interface_descriptor *)
130 usb_desc_foreach(cd, (struct usb_descriptor *)id);
133 if ((id->bDescriptorType == UDESC_INTERFACE) &&
134 (id->bLength >= sizeof(*id))) {
135 if (ps->iface_no_last == id->bInterfaceNumber)
137 ps->iface_no_last = id->bInterfaceNumber;
142 if (ps->desc == NULL) {
144 } else if (new_iface) {
147 ps->iface_index_alt = 0;
149 /* new alternate interface */
150 ps->iface_index_alt ++;
153 /* store and return current descriptor */
154 ps->desc = (struct usb_descriptor *)id;
158 /*------------------------------------------------------------------------*
161 * This function will iterate all the endpoint descriptors within an
162 * interface descriptor. Starting value for the "ped" argument should
163 * be a valid interface descriptor.
166 * NULL: End of descriptors
167 * Else: A valid endpoint descriptor
168 *------------------------------------------------------------------------*/
169 struct usb_endpoint_descriptor *
170 usb_edesc_foreach(struct usb_config_descriptor *cd,
171 struct usb_endpoint_descriptor *ped)
173 struct usb_descriptor *desc;
175 desc = ((struct usb_descriptor *)ped);
177 while ((desc = usb_desc_foreach(cd, desc))) {
178 if (desc->bDescriptorType == UDESC_INTERFACE) {
181 if (desc->bDescriptorType == UDESC_ENDPOINT) {
182 if (desc->bLength < sizeof(*ped)) {
183 /* endpoint descriptor is invalid */
186 return ((struct usb_endpoint_descriptor *)desc);
192 /*------------------------------------------------------------------------*
193 * usb_ed_comp_foreach
195 * This function will iterate all the endpoint companion descriptors
196 * within an endpoint descriptor in an interface descriptor. Starting
197 * value for the "ped" argument should be a valid endpoint companion
201 * NULL: End of descriptors
202 * Else: A valid endpoint companion descriptor
203 *------------------------------------------------------------------------*/
204 struct usb_endpoint_ss_comp_descriptor *
205 usb_ed_comp_foreach(struct usb_config_descriptor *cd,
206 struct usb_endpoint_ss_comp_descriptor *ped)
208 struct usb_descriptor *desc;
210 desc = ((struct usb_descriptor *)ped);
212 while ((desc = usb_desc_foreach(cd, desc))) {
213 if (desc->bDescriptorType == UDESC_INTERFACE)
215 if (desc->bDescriptorType == UDESC_ENDPOINT)
217 if (desc->bDescriptorType == UDESC_ENDPOINT_SS_COMP) {
218 if (desc->bLength < sizeof(*ped)) {
219 /* endpoint companion descriptor is invalid */
222 return ((struct usb_endpoint_ss_comp_descriptor *)desc);
228 /*------------------------------------------------------------------------*
229 * usbd_get_no_descriptors
231 * This function will count the total number of descriptors in the
232 * configuration descriptor of type "type".
233 *------------------------------------------------------------------------*/
235 usbd_get_no_descriptors(struct usb_config_descriptor *cd, uint8_t type)
237 struct usb_descriptor *desc = NULL;
240 while ((desc = usb_desc_foreach(cd, desc))) {
241 if (desc->bDescriptorType == type) {
250 /*------------------------------------------------------------------------*
254 * Number of alternate settings for the given interface descriptor
255 * pointer. If the USB descriptor is corrupt, the returned value can
256 * be greater than the actual number of alternate settings.
257 *------------------------------------------------------------------------*/
259 usbd_get_no_alts(struct usb_config_descriptor *cd,
260 struct usb_interface_descriptor *id)
262 struct usb_descriptor *desc;
266 /* Reset interface count */
270 /* Get the interface number */
272 ifaceno = id->bInterfaceNumber;
274 /* Iterate all the USB descriptors */
277 while ((desc = usb_desc_foreach(cd, desc))) {
278 if ((desc->bDescriptorType == UDESC_INTERFACE) &&
279 (desc->bLength >= sizeof(*id))) {
280 id = (struct usb_interface_descriptor *)desc;
281 if (id->bInterfaceNumber == ifaceno) {