1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/* $FreeBSD$ */
/*-
* Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <dev/usb/usb.h>
#include <dev/usb/usb_mfunc.h>
#include <dev/usb/usb_core.h>
#include <dev/usb/usb_parse.h>
/*------------------------------------------------------------------------*
* usb2_desc_foreach
*
* This function is the safe way to iterate across the USB config
* descriptor. It contains several checks against invalid
* descriptors. If the "desc" argument passed to this function is
* "NULL" the first descriptor, if any, will be returned.
*
* Return values:
* NULL: End of descriptors
* Else: Next descriptor after "desc"
*------------------------------------------------------------------------*/
struct usb2_descriptor *
usb2_desc_foreach(struct usb2_config_descriptor *cd,
struct usb2_descriptor *_desc)
{
uint8_t *desc_next;
uint8_t *start;
uint8_t *end;
uint8_t *desc;
/* be NULL safe */
if (cd == NULL)
return (NULL);
/* We assume that the "wTotalLength" has been checked. */
start = (uint8_t *)cd;
end = start + UGETW(cd->wTotalLength);
desc = (uint8_t *)_desc;
/* Get start of next USB descriptor. */
if (desc == NULL)
desc = start;
else
desc = desc + desc[0];
/* Check that the next USB descriptor is within the range. */
if ((desc < start) || (desc >= end))
return (NULL); /* out of range, or EOD */
/* Check that the second next USB descriptor is within range. */
desc_next = desc + desc[0];
if ((desc_next < start) || (desc_next > end))
return (NULL); /* out of range */
/* Check minimum descriptor length. */
if (desc[0] < 3)
return (NULL); /* too short descriptor */
/* Return start of next descriptor. */
return ((struct usb2_descriptor *)desc);
}
/*------------------------------------------------------------------------*
* usb2_find_idesc
*
* This function will return the interface descriptor, if any, that
* has index "iface_index" and alternate index "alt_index".
*
* Return values:
* NULL: End of descriptors
* Else: A valid interface descriptor
*------------------------------------------------------------------------*/
struct usb2_interface_descriptor *
usb2_find_idesc(struct usb2_config_descriptor *cd,
uint8_t iface_index, uint8_t alt_index)
{
struct usb2_descriptor *desc = NULL;
struct usb2_interface_descriptor *id;
uint8_t curidx = 0;
uint8_t lastidx = 0;
uint8_t curaidx = 0;
uint8_t first = 1;
while ((desc = usb2_desc_foreach(cd, desc))) {
if ((desc->bDescriptorType == UDESC_INTERFACE) &&
(desc->bLength >= sizeof(*id))) {
id = (void *)desc;
if (first) {
first = 0;
lastidx = id->bInterfaceNumber;
} else if (id->bInterfaceNumber != lastidx) {
lastidx = id->bInterfaceNumber;
curidx++;
curaidx = 0;
} else {
curaidx++;
}
if ((iface_index == curidx) && (alt_index == curaidx)) {
return (id);
}
}
}
return (NULL);
}
/*------------------------------------------------------------------------*
* usb2_find_edesc
*
* This function will return the endpoint descriptor for the passed
* interface index, alternate index and endpoint index.
*
* Return values:
* NULL: End of descriptors
* Else: A valid endpoint descriptor
*------------------------------------------------------------------------*/
struct usb2_endpoint_descriptor *
usb2_find_edesc(struct usb2_config_descriptor *cd,
uint8_t iface_index, uint8_t alt_index, uint8_t ep_index)
{
struct usb2_descriptor *desc = NULL;
struct usb2_interface_descriptor *d;
uint8_t curidx = 0;
d = usb2_find_idesc(cd, iface_index, alt_index);
if (d == NULL)
return (NULL);
if (ep_index >= d->bNumEndpoints) /* quick exit */
return (NULL);
desc = ((void *)d);
while ((desc = usb2_desc_foreach(cd, desc))) {
if (desc->bDescriptorType == UDESC_INTERFACE) {
break;
}
if (desc->bDescriptorType == UDESC_ENDPOINT) {
if (curidx == ep_index) {
if (desc->bLength <
sizeof(struct usb2_endpoint_descriptor)) {
/* endpoint index is invalid */
break;
}
return ((void *)desc);
}
curidx++;
}
}
return (NULL);
}
/*------------------------------------------------------------------------*
* usb2_get_no_endpoints
*
* This function will count the total number of endpoints available.
*------------------------------------------------------------------------*/
uint16_t
usb2_get_no_endpoints(struct usb2_config_descriptor *cd)
{
struct usb2_descriptor *desc = NULL;
uint16_t count = 0;
while ((desc = usb2_desc_foreach(cd, desc))) {
if (desc->bDescriptorType == UDESC_ENDPOINT) {
count++;
}
}
return (count);
}
/*------------------------------------------------------------------------*
* usb2_get_no_alts
*
* Return value:
* Number of alternate settings for the given "ifaceno".
*
* NOTE: The returned can be larger than the actual number of
* alternate settings.
*------------------------------------------------------------------------*/
uint16_t
usb2_get_no_alts(struct usb2_config_descriptor *cd, uint8_t ifaceno)
{
struct usb2_descriptor *desc = NULL;
struct usb2_interface_descriptor *id;
uint16_t n = 0;
while ((desc = usb2_desc_foreach(cd, desc))) {
if ((desc->bDescriptorType == UDESC_INTERFACE) &&
(desc->bLength >= sizeof(*id))) {
id = (void *)desc;
if (id->bInterfaceNumber == ifaceno) {
n++;
}
}
}
return (n);
}
|
