blob: 1ab4df1de2daddb7db1a6032b1b8e9320dd9b591 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#include <linux/usb.h>
Alan Stern615ae112007-06-08 15:23:27 -04002#include <linux/usb/ch9.h>
Eric Lescouet27729aa2010-04-24 23:21:52 +02003#include <linux/usb/hcd.h>
Hans de Goede317149c2010-03-29 12:03:17 +02004#include <linux/usb/quirks.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/slab.h>
7#include <linux/device.h>
8#include <asm/byteorder.h>
Greg KH6d5e8252005-04-18 17:39:24 -07009#include "usb.h"
Eric Lescouet27729aa2010-04-24 23:21:52 +020010
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
12#define USB_MAXALTSETTING 128 /* Hard limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
14#define USB_MAXCONFIG 8 /* Arbitrary limit */
15
16
17static inline const char *plural(int n)
18{
19 return (n == 1 ? "" : "s");
20}
21
22static int find_next_descriptor(unsigned char *buffer, int size,
23 int dt1, int dt2, int *num_skipped)
24{
25 struct usb_descriptor_header *h;
26 int n = 0;
27 unsigned char *buffer0 = buffer;
28
29 /* Find the next descriptor of type dt1 or dt2 */
30 while (size > 0) {
31 h = (struct usb_descriptor_header *) buffer;
32 if (h->bDescriptorType == dt1 || h->bDescriptorType == dt2)
33 break;
34 buffer += h->bLength;
35 size -= h->bLength;
36 ++n;
37 }
38
39 /* Store the number of descriptors skipped and return the
40 * number of bytes skipped */
41 if (num_skipped)
42 *num_skipped = n;
43 return buffer - buffer0;
44}
45
Alan Stern842f1692010-04-30 12:44:46 -040046static void usb_parse_ss_endpoint_companion(struct device *ddev, int cfgno,
Sarah Sharp663c30d2009-04-27 19:58:14 -070047 int inum, int asnum, struct usb_host_endpoint *ep,
Alan Stern842f1692010-04-30 12:44:46 -040048 unsigned char *buffer, int size)
Sarah Sharp663c30d2009-04-27 19:58:14 -070049{
Alan Stern842f1692010-04-30 12:44:46 -040050 struct usb_ss_ep_comp_descriptor *desc;
Sarah Sharp663c30d2009-04-27 19:58:14 -070051 int max_tx;
Sarah Sharp663c30d2009-04-27 19:58:14 -070052
Alan Stern842f1692010-04-30 12:44:46 -040053 /* The SuperSpeed endpoint companion descriptor is supposed to
54 * be the first thing immediately following the endpoint descriptor.
55 */
Sarah Sharpf0058c62009-04-29 19:06:20 -070056 desc = (struct usb_ss_ep_comp_descriptor *) buffer;
Alan Stern842f1692010-04-30 12:44:46 -040057 if (desc->bDescriptorType != USB_DT_SS_ENDPOINT_COMP ||
58 size < USB_DT_SS_EP_COMP_SIZE) {
Sarah Sharp663c30d2009-04-27 19:58:14 -070059 dev_warn(ddev, "No SuperSpeed endpoint companion for config %d "
60 " interface %d altsetting %d ep %d: "
61 "using minimum values\n",
62 cfgno, inum, asnum, ep->desc.bEndpointAddress);
Sarah Sharp663c30d2009-04-27 19:58:14 -070063
Alan Stern842f1692010-04-30 12:44:46 -040064 /* Fill in some default values.
65 * Leave bmAttributes as zero, which will mean no streams for
66 * bulk, and isoc won't support multiple bursts of packets.
67 * With bursts of only one packet, and a Mult of 1, the max
68 * amount of data moved per endpoint service interval is one
69 * packet.
70 */
71 ep->ss_ep_comp.bLength = USB_DT_SS_EP_COMP_SIZE;
72 ep->ss_ep_comp.bDescriptorType = USB_DT_SS_ENDPOINT_COMP;
73 if (usb_endpoint_xfer_isoc(&ep->desc) ||
74 usb_endpoint_xfer_int(&ep->desc))
75 ep->ss_ep_comp.wBytesPerInterval =
76 ep->desc.wMaxPacketSize;
77 return;
78 }
79
80 memcpy(&ep->ss_ep_comp, desc, USB_DT_SS_EP_COMP_SIZE);
Sarah Sharp663c30d2009-04-27 19:58:14 -070081
82 /* Check the various values */
83 if (usb_endpoint_xfer_control(&ep->desc) && desc->bMaxBurst != 0) {
84 dev_warn(ddev, "Control endpoint with bMaxBurst = %d in "
85 "config %d interface %d altsetting %d ep %d: "
86 "setting to zero\n", desc->bMaxBurst,
87 cfgno, inum, asnum, ep->desc.bEndpointAddress);
Alan Stern842f1692010-04-30 12:44:46 -040088 ep->ss_ep_comp.bMaxBurst = 0;
89 } else if (desc->bMaxBurst > 15) {
Sarah Sharp663c30d2009-04-27 19:58:14 -070090 dev_warn(ddev, "Endpoint with bMaxBurst = %d in "
91 "config %d interface %d altsetting %d ep %d: "
92 "setting to 15\n", desc->bMaxBurst,
93 cfgno, inum, asnum, ep->desc.bEndpointAddress);
Alan Stern842f1692010-04-30 12:44:46 -040094 ep->ss_ep_comp.bMaxBurst = 15;
Sarah Sharp663c30d2009-04-27 19:58:14 -070095 }
Alan Stern842f1692010-04-30 12:44:46 -040096
97 if ((usb_endpoint_xfer_control(&ep->desc) ||
98 usb_endpoint_xfer_int(&ep->desc)) &&
99 desc->bmAttributes != 0) {
Sarah Sharp663c30d2009-04-27 19:58:14 -0700100 dev_warn(ddev, "%s endpoint with bmAttributes = %d in "
101 "config %d interface %d altsetting %d ep %d: "
102 "setting to zero\n",
103 usb_endpoint_xfer_control(&ep->desc) ? "Control" : "Bulk",
104 desc->bmAttributes,
105 cfgno, inum, asnum, ep->desc.bEndpointAddress);
Alan Stern842f1692010-04-30 12:44:46 -0400106 ep->ss_ep_comp.bmAttributes = 0;
107 } else if (usb_endpoint_xfer_bulk(&ep->desc) &&
108 desc->bmAttributes > 16) {
Sarah Sharp663c30d2009-04-27 19:58:14 -0700109 dev_warn(ddev, "Bulk endpoint with more than 65536 streams in "
110 "config %d interface %d altsetting %d ep %d: "
111 "setting to max\n",
112 cfgno, inum, asnum, ep->desc.bEndpointAddress);
Alan Stern842f1692010-04-30 12:44:46 -0400113 ep->ss_ep_comp.bmAttributes = 16;
114 } else if (usb_endpoint_xfer_isoc(&ep->desc) &&
115 desc->bmAttributes > 2) {
Sarah Sharp663c30d2009-04-27 19:58:14 -0700116 dev_warn(ddev, "Isoc endpoint has Mult of %d in "
117 "config %d interface %d altsetting %d ep %d: "
118 "setting to 3\n", desc->bmAttributes + 1,
119 cfgno, inum, asnum, ep->desc.bEndpointAddress);
Alan Stern842f1692010-04-30 12:44:46 -0400120 ep->ss_ep_comp.bmAttributes = 2;
Sarah Sharp663c30d2009-04-27 19:58:14 -0700121 }
Alan Stern842f1692010-04-30 12:44:46 -0400122
123 if (usb_endpoint_xfer_isoc(&ep->desc))
Sebastian Andrzej Siewior7de7c7d2011-07-29 11:05:45 +0200124 max_tx = (desc->bMaxBurst + 1) * (desc->bmAttributes + 1) *
Kuninori Morimoto29cc8892011-08-23 03:12:03 -0700125 usb_endpoint_maxp(&ep->desc);
Alan Stern842f1692010-04-30 12:44:46 -0400126 else if (usb_endpoint_xfer_int(&ep->desc))
Kuninori Morimoto29cc8892011-08-23 03:12:03 -0700127 max_tx = usb_endpoint_maxp(&ep->desc) *
Sebastian Andrzej Siewior7de7c7d2011-07-29 11:05:45 +0200128 (desc->bMaxBurst + 1);
Alan Stern842f1692010-04-30 12:44:46 -0400129 else
130 max_tx = 999999;
Sebastian Andrzej Siewior64b3c302011-04-11 20:19:12 +0200131 if (le16_to_cpu(desc->wBytesPerInterval) > max_tx) {
Sarah Sharp663c30d2009-04-27 19:58:14 -0700132 dev_warn(ddev, "%s endpoint with wBytesPerInterval of %d in "
133 "config %d interface %d altsetting %d ep %d: "
134 "setting to %d\n",
135 usb_endpoint_xfer_isoc(&ep->desc) ? "Isoc" : "Int",
Sebastian Andrzej Siewior7de7c7d2011-07-29 11:05:45 +0200136 le16_to_cpu(desc->wBytesPerInterval),
Sarah Sharp663c30d2009-04-27 19:58:14 -0700137 cfgno, inum, asnum, ep->desc.bEndpointAddress,
138 max_tx);
Sebastian Andrzej Siewior7de7c7d2011-07-29 11:05:45 +0200139 ep->ss_ep_comp.wBytesPerInterval = cpu_to_le16(max_tx);
Sarah Sharp663c30d2009-04-27 19:58:14 -0700140 }
Sarah Sharp663c30d2009-04-27 19:58:14 -0700141}
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143static int usb_parse_endpoint(struct device *ddev, int cfgno, int inum,
144 int asnum, struct usb_host_interface *ifp, int num_ep,
145 unsigned char *buffer, int size)
146{
147 unsigned char *buffer0 = buffer;
148 struct usb_endpoint_descriptor *d;
149 struct usb_host_endpoint *endpoint;
Sarah Sharp663c30d2009-04-27 19:58:14 -0700150 int n, i, j, retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
152 d = (struct usb_endpoint_descriptor *) buffer;
153 buffer += d->bLength;
154 size -= d->bLength;
155
156 if (d->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE)
157 n = USB_DT_ENDPOINT_AUDIO_SIZE;
158 else if (d->bLength >= USB_DT_ENDPOINT_SIZE)
159 n = USB_DT_ENDPOINT_SIZE;
160 else {
161 dev_warn(ddev, "config %d interface %d altsetting %d has an "
162 "invalid endpoint descriptor of length %d, skipping\n",
163 cfgno, inum, asnum, d->bLength);
164 goto skip_to_next_endpoint_or_interface_descriptor;
165 }
166
167 i = d->bEndpointAddress & ~USB_ENDPOINT_DIR_MASK;
168 if (i >= 16 || i == 0) {
169 dev_warn(ddev, "config %d interface %d altsetting %d has an "
170 "invalid endpoint with address 0x%X, skipping\n",
171 cfgno, inum, asnum, d->bEndpointAddress);
172 goto skip_to_next_endpoint_or_interface_descriptor;
173 }
174
175 /* Only store as many endpoints as we have room for */
176 if (ifp->desc.bNumEndpoints >= num_ep)
177 goto skip_to_next_endpoint_or_interface_descriptor;
178
179 endpoint = &ifp->endpoint[ifp->desc.bNumEndpoints];
180 ++ifp->desc.bNumEndpoints;
181
182 memcpy(&endpoint->desc, d, n);
183 INIT_LIST_HEAD(&endpoint->urb_list);
184
Laurent Pinchart300871c2007-06-12 21:47:17 +0200185 /* Fix up bInterval values outside the legal range. Use 32 ms if no
186 * proper value can be guessed. */
Alan Stern615ae112007-06-08 15:23:27 -0400187 i = 0; /* i = min, j = max, n = default */
188 j = 255;
189 if (usb_endpoint_xfer_int(d)) {
190 i = 1;
191 switch (to_usb_device(ddev)->speed) {
Sarah Sharp6b403b02009-04-27 19:54:10 -0700192 case USB_SPEED_SUPER:
Alan Stern615ae112007-06-08 15:23:27 -0400193 case USB_SPEED_HIGH:
Laurent Pinchart300871c2007-06-12 21:47:17 +0200194 /* Many device manufacturers are using full-speed
195 * bInterval values in high-speed interrupt endpoint
196 * descriptors. Try to fix those and fall back to a
197 * 32 ms default value otherwise. */
198 n = fls(d->bInterval*8);
199 if (n == 0)
200 n = 9; /* 32 ms = 2^(9-1) uframes */
Alan Stern615ae112007-06-08 15:23:27 -0400201 j = 16;
202 break;
203 default: /* USB_SPEED_FULL or _LOW */
204 /* For low-speed, 10 ms is the official minimum.
205 * But some "overclocked" devices might want faster
206 * polling so we'll allow it. */
207 n = 32;
208 break;
209 }
210 } else if (usb_endpoint_xfer_isoc(d)) {
211 i = 1;
212 j = 16;
213 switch (to_usb_device(ddev)->speed) {
214 case USB_SPEED_HIGH:
215 n = 9; /* 32 ms = 2^(9-1) uframes */
216 break;
217 default: /* USB_SPEED_FULL */
218 n = 6; /* 32 ms = 2^(6-1) frames */
219 break;
220 }
221 }
222 if (d->bInterval < i || d->bInterval > j) {
223 dev_warn(ddev, "config %d interface %d altsetting %d "
224 "endpoint 0x%X has an invalid bInterval %d, "
225 "changing to %d\n",
226 cfgno, inum, asnum,
227 d->bEndpointAddress, d->bInterval, n);
228 endpoint->desc.bInterval = n;
229 }
230
Alan Stern60aac1e2007-06-08 15:25:02 -0400231 /* Some buggy low-speed devices have Bulk endpoints, which is
232 * explicitly forbidden by the USB spec. In an attempt to make
233 * them usable, we will try treating them as Interrupt endpoints.
234 */
235 if (to_usb_device(ddev)->speed == USB_SPEED_LOW &&
236 usb_endpoint_xfer_bulk(d)) {
237 dev_warn(ddev, "config %d interface %d altsetting %d "
238 "endpoint 0x%X is Bulk; changing to Interrupt\n",
239 cfgno, inum, asnum, d->bEndpointAddress);
240 endpoint->desc.bmAttributes = USB_ENDPOINT_XFER_INT;
241 endpoint->desc.bInterval = 1;
Kuninori Morimoto29cc8892011-08-23 03:12:03 -0700242 if (usb_endpoint_maxp(&endpoint->desc) > 8)
Alan Stern60aac1e2007-06-08 15:25:02 -0400243 endpoint->desc.wMaxPacketSize = cpu_to_le16(8);
244 }
245
David Brownellcaa9ef62008-02-08 15:08:44 -0800246 /*
247 * Some buggy high speed devices have bulk endpoints using
248 * maxpacket sizes other than 512. High speed HCDs may not
249 * be able to handle that particular bug, so let's warn...
250 */
251 if (to_usb_device(ddev)->speed == USB_SPEED_HIGH
252 && usb_endpoint_xfer_bulk(d)) {
253 unsigned maxp;
254
Kuninori Morimoto29cc8892011-08-23 03:12:03 -0700255 maxp = usb_endpoint_maxp(&endpoint->desc) & 0x07ff;
David Brownellcaa9ef62008-02-08 15:08:44 -0800256 if (maxp != 512)
257 dev_warn(ddev, "config %d interface %d altsetting %d "
258 "bulk endpoint 0x%X has invalid maxpacket %d\n",
259 cfgno, inum, asnum, d->bEndpointAddress,
260 maxp);
261 }
262
Alan Stern842f1692010-04-30 12:44:46 -0400263 /* Parse a possible SuperSpeed endpoint companion descriptor */
264 if (to_usb_device(ddev)->speed == USB_SPEED_SUPER)
265 usb_parse_ss_endpoint_companion(ddev, cfgno,
266 inum, asnum, endpoint, buffer, size);
Sarah Sharp9f8e4432009-07-27 12:04:52 -0700267
Alan Stern842f1692010-04-30 12:44:46 -0400268 /* Skip over any Class Specific or Vendor Specific descriptors;
269 * find the next endpoint or interface descriptor */
270 endpoint->extra = buffer;
271 i = find_next_descriptor(buffer, size, USB_DT_ENDPOINT,
272 USB_DT_INTERFACE, &n);
273 endpoint->extralen = i;
274 retval = buffer - buffer0 + i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 if (n > 0)
276 dev_dbg(ddev, "skipped %d descriptor%s after %s\n",
277 n, plural(n), "endpoint");
Sarah Sharp663c30d2009-04-27 19:58:14 -0700278 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280skip_to_next_endpoint_or_interface_descriptor:
281 i = find_next_descriptor(buffer, size, USB_DT_ENDPOINT,
282 USB_DT_INTERFACE, NULL);
283 return buffer - buffer0 + i;
284}
285
286void usb_release_interface_cache(struct kref *ref)
287{
288 struct usb_interface_cache *intfc = ref_to_usb_interface_cache(ref);
289 int j;
290
Alan Stern4f62efe2005-10-24 16:24:14 -0400291 for (j = 0; j < intfc->num_altsetting; j++) {
292 struct usb_host_interface *alt = &intfc->altsetting[j];
293
294 kfree(alt->endpoint);
295 kfree(alt->string);
296 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 kfree(intfc);
298}
299
300static int usb_parse_interface(struct device *ddev, int cfgno,
301 struct usb_host_config *config, unsigned char *buffer, int size,
302 u8 inums[], u8 nalts[])
303{
304 unsigned char *buffer0 = buffer;
305 struct usb_interface_descriptor *d;
306 int inum, asnum;
307 struct usb_interface_cache *intfc;
308 struct usb_host_interface *alt;
309 int i, n;
310 int len, retval;
311 int num_ep, num_ep_orig;
312
313 d = (struct usb_interface_descriptor *) buffer;
314 buffer += d->bLength;
315 size -= d->bLength;
316
317 if (d->bLength < USB_DT_INTERFACE_SIZE)
318 goto skip_to_next_interface_descriptor;
319
320 /* Which interface entry is this? */
321 intfc = NULL;
322 inum = d->bInterfaceNumber;
323 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
324 if (inums[i] == inum) {
325 intfc = config->intf_cache[i];
326 break;
327 }
328 }
329 if (!intfc || intfc->num_altsetting >= nalts[i])
330 goto skip_to_next_interface_descriptor;
331
332 /* Check for duplicate altsetting entries */
333 asnum = d->bAlternateSetting;
334 for ((i = 0, alt = &intfc->altsetting[0]);
335 i < intfc->num_altsetting;
336 (++i, ++alt)) {
337 if (alt->desc.bAlternateSetting == asnum) {
338 dev_warn(ddev, "Duplicate descriptor for config %d "
339 "interface %d altsetting %d, skipping\n",
340 cfgno, inum, asnum);
341 goto skip_to_next_interface_descriptor;
342 }
343 }
344
345 ++intfc->num_altsetting;
346 memcpy(&alt->desc, d, USB_DT_INTERFACE_SIZE);
347
348 /* Skip over any Class Specific or Vendor Specific descriptors;
349 * find the first endpoint or interface descriptor */
350 alt->extra = buffer;
351 i = find_next_descriptor(buffer, size, USB_DT_ENDPOINT,
352 USB_DT_INTERFACE, &n);
353 alt->extralen = i;
354 if (n > 0)
355 dev_dbg(ddev, "skipped %d descriptor%s after %s\n",
356 n, plural(n), "interface");
357 buffer += i;
358 size -= i;
359
360 /* Allocate space for the right(?) number of endpoints */
361 num_ep = num_ep_orig = alt->desc.bNumEndpoints;
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800362 alt->desc.bNumEndpoints = 0; /* Use as a counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 if (num_ep > USB_MAXENDPOINTS) {
364 dev_warn(ddev, "too many endpoints for config %d interface %d "
365 "altsetting %d: %d, using maximum allowed: %d\n",
366 cfgno, inum, asnum, num_ep, USB_MAXENDPOINTS);
367 num_ep = USB_MAXENDPOINTS;
368 }
369
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800370 if (num_ep > 0) {
371 /* Can't allocate 0 bytes */
Alan Stern57a21c12007-05-15 17:40:37 -0400372 len = sizeof(struct usb_host_endpoint) * num_ep;
373 alt->endpoint = kzalloc(len, GFP_KERNEL);
374 if (!alt->endpoint)
375 return -ENOMEM;
376 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378 /* Parse all the endpoint descriptors */
379 n = 0;
380 while (size > 0) {
381 if (((struct usb_descriptor_header *) buffer)->bDescriptorType
382 == USB_DT_INTERFACE)
383 break;
384 retval = usb_parse_endpoint(ddev, cfgno, inum, asnum, alt,
385 num_ep, buffer, size);
386 if (retval < 0)
387 return retval;
388 ++n;
389
390 buffer += retval;
391 size -= retval;
392 }
393
394 if (n != num_ep_orig)
395 dev_warn(ddev, "config %d interface %d altsetting %d has %d "
396 "endpoint descriptor%s, different from the interface "
397 "descriptor's value: %d\n",
398 cfgno, inum, asnum, n, plural(n), num_ep_orig);
399 return buffer - buffer0;
400
401skip_to_next_interface_descriptor:
402 i = find_next_descriptor(buffer, size, USB_DT_INTERFACE,
403 USB_DT_INTERFACE, NULL);
404 return buffer - buffer0 + i;
405}
406
Hans de Goede317149c2010-03-29 12:03:17 +0200407static int usb_parse_configuration(struct usb_device *dev, int cfgidx,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 struct usb_host_config *config, unsigned char *buffer, int size)
409{
Hans de Goede317149c2010-03-29 12:03:17 +0200410 struct device *ddev = &dev->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 unsigned char *buffer0 = buffer;
412 int cfgno;
413 int nintf, nintf_orig;
414 int i, j, n;
415 struct usb_interface_cache *intfc;
416 unsigned char *buffer2;
417 int size2;
418 struct usb_descriptor_header *header;
419 int len, retval;
420 u8 inums[USB_MAXINTERFACES], nalts[USB_MAXINTERFACES];
Craig W. Nadler165fe972007-06-15 23:14:35 -0400421 unsigned iad_num = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423 memcpy(&config->desc, buffer, USB_DT_CONFIG_SIZE);
424 if (config->desc.bDescriptorType != USB_DT_CONFIG ||
Hans de Goedeb4f17a482013-08-03 16:37:48 +0200425 config->desc.bLength < USB_DT_CONFIG_SIZE ||
426 config->desc.bLength > size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 dev_err(ddev, "invalid descriptor for config index %d: "
428 "type = 0x%X, length = %d\n", cfgidx,
429 config->desc.bDescriptorType, config->desc.bLength);
430 return -EINVAL;
431 }
432 cfgno = config->desc.bConfigurationValue;
433
434 buffer += config->desc.bLength;
435 size -= config->desc.bLength;
436
437 nintf = nintf_orig = config->desc.bNumInterfaces;
438 if (nintf > USB_MAXINTERFACES) {
439 dev_warn(ddev, "config %d has too many interfaces: %d, "
440 "using maximum allowed: %d\n",
441 cfgno, nintf, USB_MAXINTERFACES);
442 nintf = USB_MAXINTERFACES;
443 }
444
445 /* Go through the descriptors, checking their length and counting the
446 * number of altsettings for each interface */
447 n = 0;
448 for ((buffer2 = buffer, size2 = size);
449 size2 > 0;
450 (buffer2 += header->bLength, size2 -= header->bLength)) {
451
452 if (size2 < sizeof(struct usb_descriptor_header)) {
453 dev_warn(ddev, "config %d descriptor has %d excess "
454 "byte%s, ignoring\n",
455 cfgno, size2, plural(size2));
456 break;
457 }
458
459 header = (struct usb_descriptor_header *) buffer2;
460 if ((header->bLength > size2) || (header->bLength < 2)) {
461 dev_warn(ddev, "config %d has an invalid descriptor "
462 "of length %d, skipping remainder of the config\n",
463 cfgno, header->bLength);
464 break;
465 }
466
467 if (header->bDescriptorType == USB_DT_INTERFACE) {
468 struct usb_interface_descriptor *d;
469 int inum;
470
471 d = (struct usb_interface_descriptor *) header;
472 if (d->bLength < USB_DT_INTERFACE_SIZE) {
473 dev_warn(ddev, "config %d has an invalid "
474 "interface descriptor of length %d, "
475 "skipping\n", cfgno, d->bLength);
476 continue;
477 }
478
479 inum = d->bInterfaceNumber;
Hans de Goede317149c2010-03-29 12:03:17 +0200480
481 if ((dev->quirks & USB_QUIRK_HONOR_BNUMINTERFACES) &&
482 n >= nintf_orig) {
483 dev_warn(ddev, "config %d has more interface "
484 "descriptors, than it declares in "
485 "bNumInterfaces, ignoring interface "
486 "number: %d\n", cfgno, inum);
487 continue;
488 }
489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 if (inum >= nintf_orig)
491 dev_warn(ddev, "config %d has an invalid "
492 "interface number: %d but max is %d\n",
493 cfgno, inum, nintf_orig - 1);
494
495 /* Have we already encountered this interface?
496 * Count its altsettings */
497 for (i = 0; i < n; ++i) {
498 if (inums[i] == inum)
499 break;
500 }
501 if (i < n) {
502 if (nalts[i] < 255)
503 ++nalts[i];
504 } else if (n < USB_MAXINTERFACES) {
505 inums[n] = inum;
506 nalts[n] = 1;
507 ++n;
508 }
509
Craig W. Nadler165fe972007-06-15 23:14:35 -0400510 } else if (header->bDescriptorType ==
511 USB_DT_INTERFACE_ASSOCIATION) {
512 if (iad_num == USB_MAXIADS) {
513 dev_warn(ddev, "found more Interface "
514 "Association Descriptors "
515 "than allocated for in "
516 "configuration %d\n", cfgno);
517 } else {
518 config->intf_assoc[iad_num] =
519 (struct usb_interface_assoc_descriptor
520 *)header;
521 iad_num++;
522 }
523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 } else if (header->bDescriptorType == USB_DT_DEVICE ||
525 header->bDescriptorType == USB_DT_CONFIG)
526 dev_warn(ddev, "config %d contains an unexpected "
527 "descriptor of type 0x%X, skipping\n",
528 cfgno, header->bDescriptorType);
529
530 } /* for ((buffer2 = buffer, size2 = size); ...) */
531 size = buffer2 - buffer;
532 config->desc.wTotalLength = cpu_to_le16(buffer2 - buffer0);
533
534 if (n != nintf)
535 dev_warn(ddev, "config %d has %d interface%s, different from "
536 "the descriptor's value: %d\n",
537 cfgno, n, plural(n), nintf_orig);
538 else if (n == 0)
539 dev_warn(ddev, "config %d has no interfaces?\n", cfgno);
540 config->desc.bNumInterfaces = nintf = n;
541
542 /* Check for missing interface numbers */
543 for (i = 0; i < nintf; ++i) {
544 for (j = 0; j < nintf; ++j) {
545 if (inums[j] == i)
546 break;
547 }
548 if (j >= nintf)
549 dev_warn(ddev, "config %d has no interface number "
550 "%d\n", cfgno, i);
551 }
552
553 /* Allocate the usb_interface_caches and altsetting arrays */
554 for (i = 0; i < nintf; ++i) {
555 j = nalts[i];
556 if (j > USB_MAXALTSETTING) {
557 dev_warn(ddev, "too many alternate settings for "
558 "config %d interface %d: %d, "
559 "using maximum allowed: %d\n",
560 cfgno, inums[i], j, USB_MAXALTSETTING);
561 nalts[i] = j = USB_MAXALTSETTING;
562 }
563
564 len = sizeof(*intfc) + sizeof(struct usb_host_interface) * j;
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400565 config->intf_cache[i] = intfc = kzalloc(len, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 if (!intfc)
567 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 kref_init(&intfc->ref);
569 }
570
Sarah Sharp663c30d2009-04-27 19:58:14 -0700571 /* FIXME: parse the BOS descriptor */
572
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 /* Skip over any Class Specific or Vendor Specific descriptors;
574 * find the first interface descriptor */
575 config->extra = buffer;
576 i = find_next_descriptor(buffer, size, USB_DT_INTERFACE,
577 USB_DT_INTERFACE, &n);
578 config->extralen = i;
579 if (n > 0)
580 dev_dbg(ddev, "skipped %d descriptor%s after %s\n",
581 n, plural(n), "configuration");
582 buffer += i;
583 size -= i;
584
585 /* Parse all the interface/altsetting descriptors */
586 while (size > 0) {
587 retval = usb_parse_interface(ddev, cfgno, config,
588 buffer, size, inums, nalts);
589 if (retval < 0)
590 return retval;
591
592 buffer += retval;
593 size -= retval;
594 }
595
596 /* Check for missing altsettings */
597 for (i = 0; i < nintf; ++i) {
598 intfc = config->intf_cache[i];
599 for (j = 0; j < intfc->num_altsetting; ++j) {
600 for (n = 0; n < intfc->num_altsetting; ++n) {
601 if (intfc->altsetting[n].desc.
602 bAlternateSetting == j)
603 break;
604 }
605 if (n >= intfc->num_altsetting)
606 dev_warn(ddev, "config %d interface %d has no "
607 "altsetting %d\n", cfgno, inums[i], j);
608 }
609 }
610
611 return 0;
612}
613
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800614/* hub-only!! ... and only exported for reset/reinit path.
615 * otherwise used internally on disconnect/destroy path
616 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617void usb_destroy_configuration(struct usb_device *dev)
618{
619 int c, i;
620
621 if (!dev->config)
622 return;
623
624 if (dev->rawdescriptors) {
625 for (i = 0; i < dev->descriptor.bNumConfigurations; i++)
626 kfree(dev->rawdescriptors[i]);
627
628 kfree(dev->rawdescriptors);
629 dev->rawdescriptors = NULL;
630 }
631
632 for (c = 0; c < dev->descriptor.bNumConfigurations; c++) {
633 struct usb_host_config *cf = &dev->config[c];
634
635 kfree(cf->string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 for (i = 0; i < cf->desc.bNumInterfaces; i++) {
637 if (cf->intf_cache[i])
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800638 kref_put(&cf->intf_cache[i]->ref,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 usb_release_interface_cache);
640 }
641 }
642 kfree(dev->config);
643 dev->config = NULL;
644}
645
646
Inaky Perez-Gonzalez11450652007-07-31 20:34:02 -0700647/*
648 * Get the USB config descriptors, cache and parse'em
649 *
650 * hub-only!! ... and only in reset path, or usb_new_device()
651 * (used by real hubs and virtual root hubs)
Inaky Perez-Gonzalez11450652007-07-31 20:34:02 -0700652 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653int usb_get_configuration(struct usb_device *dev)
654{
655 struct device *ddev = &dev->dev;
656 int ncfg = dev->descriptor.bNumConfigurations;
Inaky Perez-Gonzalez11450652007-07-31 20:34:02 -0700657 int result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 unsigned int cfgno, length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 unsigned char *bigbuffer;
Greg Kroah-Hartman2c044a42008-01-30 15:21:33 -0800660 struct usb_config_descriptor *desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Inaky Perez-Gonzalez11450652007-07-31 20:34:02 -0700662 cfgno = 0;
Inaky Perez-Gonzalez11450652007-07-31 20:34:02 -0700663 result = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 if (ncfg > USB_MAXCONFIG) {
665 dev_warn(ddev, "too many configurations: %d, "
666 "using maximum allowed: %d\n", ncfg, USB_MAXCONFIG);
667 dev->descriptor.bNumConfigurations = ncfg = USB_MAXCONFIG;
668 }
669
670 if (ncfg < 1) {
671 dev_err(ddev, "no configurations\n");
672 return -EINVAL;
673 }
674
675 length = ncfg * sizeof(struct usb_host_config);
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400676 dev->config = kzalloc(length, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 if (!dev->config)
678 goto err2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
680 length = ncfg * sizeof(char *);
Alan Stern0a1ef3b2005-10-24 15:38:24 -0400681 dev->rawdescriptors = kzalloc(length, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 if (!dev->rawdescriptors)
683 goto err2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
Michal Nazarewicze8f4af32010-04-17 17:12:58 +0200685 desc = kmalloc(USB_DT_CONFIG_SIZE, GFP_KERNEL);
686 if (!desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 goto err2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Inaky Perez-Gonzalez11450652007-07-31 20:34:02 -0700689 result = 0;
690 for (; cfgno < ncfg; cfgno++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 /* We grab just the first descriptor so we know how long
692 * the whole configuration is */
693 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno,
Michal Nazarewicze8f4af32010-04-17 17:12:58 +0200694 desc, USB_DT_CONFIG_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 if (result < 0) {
696 dev_err(ddev, "unable to read config index %d "
Inaky Perez-Gonzalez11450652007-07-31 20:34:02 -0700697 "descriptor/%s: %d\n", cfgno, "start", result);
Lan Tianyu3a22b872012-09-05 13:44:37 +0800698 if (result != -EPIPE)
699 goto err;
Inaky Perez-Gonzalezcb4c8fe2006-08-25 19:35:28 -0700700 dev_err(ddev, "chopping to %d config(s)\n", cfgno);
701 dev->descriptor.bNumConfigurations = cfgno;
702 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 } else if (result < 4) {
704 dev_err(ddev, "config index %d descriptor too short "
705 "(expected %i, got %i)\n", cfgno,
706 USB_DT_CONFIG_SIZE, result);
707 result = -EINVAL;
708 goto err;
709 }
710 length = max((int) le16_to_cpu(desc->wTotalLength),
711 USB_DT_CONFIG_SIZE);
712
713 /* Now that we know the length, get the whole thing */
714 bigbuffer = kmalloc(length, GFP_KERNEL);
715 if (!bigbuffer) {
716 result = -ENOMEM;
717 goto err;
718 }
Julius Wernerd86db252014-03-04 11:27:38 -0800719
720 if (dev->quirks & USB_QUIRK_DELAY_INIT)
721 msleep(100);
722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno,
724 bigbuffer, length);
725 if (result < 0) {
726 dev_err(ddev, "unable to read config index %d "
727 "descriptor/%s\n", cfgno, "all");
728 kfree(bigbuffer);
729 goto err;
730 }
731 if (result < length) {
732 dev_warn(ddev, "config index %d descriptor too short "
733 "(expected %i, got %i)\n", cfgno, length, result);
734 length = result;
735 }
736
737 dev->rawdescriptors[cfgno] = bigbuffer;
738
Hans de Goede317149c2010-03-29 12:03:17 +0200739 result = usb_parse_configuration(dev, cfgno,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 &dev->config[cfgno], bigbuffer, length);
741 if (result < 0) {
742 ++cfgno;
743 goto err;
744 }
745 }
746 result = 0;
747
748err:
Michal Nazarewicze8f4af32010-04-17 17:12:58 +0200749 kfree(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 dev->descriptor.bNumConfigurations = cfgno;
751err2:
752 if (result == -ENOMEM)
753 dev_err(ddev, "out of memory\n");
754 return result;
755}
Andiry Xu3148bf02011-09-23 14:19:47 -0700756
757void usb_release_bos_descriptor(struct usb_device *dev)
758{
759 if (dev->bos) {
760 kfree(dev->bos->desc);
761 kfree(dev->bos);
762 dev->bos = NULL;
763 }
764}
765
766/* Get BOS descriptor set */
767int usb_get_bos_descriptor(struct usb_device *dev)
768{
769 struct device *ddev = &dev->dev;
770 struct usb_bos_descriptor *bos;
771 struct usb_dev_cap_header *cap;
772 unsigned char *buffer;
773 int length, total_len, num, i;
774 int ret;
775
776 bos = kzalloc(sizeof(struct usb_bos_descriptor), GFP_KERNEL);
777 if (!bos)
778 return -ENOMEM;
779
780 /* Get BOS descriptor */
781 ret = usb_get_descriptor(dev, USB_DT_BOS, 0, bos, USB_DT_BOS_SIZE);
782 if (ret < USB_DT_BOS_SIZE) {
783 dev_err(ddev, "unable to get BOS descriptor\n");
784 if (ret >= 0)
785 ret = -ENOMSG;
786 kfree(bos);
787 return ret;
788 }
789
790 length = bos->bLength;
791 total_len = le16_to_cpu(bos->wTotalLength);
792 num = bos->bNumDeviceCaps;
793 kfree(bos);
794 if (total_len < length)
795 return -EINVAL;
796
797 dev->bos = kzalloc(sizeof(struct usb_host_bos), GFP_KERNEL);
798 if (!dev->bos)
799 return -ENOMEM;
800
801 /* Now let's get the whole BOS descriptor set */
802 buffer = kzalloc(total_len, GFP_KERNEL);
803 if (!buffer) {
804 ret = -ENOMEM;
805 goto err;
806 }
807 dev->bos->desc = (struct usb_bos_descriptor *)buffer;
808
809 ret = usb_get_descriptor(dev, USB_DT_BOS, 0, buffer, total_len);
810 if (ret < total_len) {
811 dev_err(ddev, "unable to get BOS descriptor set\n");
812 if (ret >= 0)
813 ret = -ENOMSG;
814 goto err;
815 }
816 total_len -= length;
817
818 for (i = 0; i < num; i++) {
819 buffer += length;
820 cap = (struct usb_dev_cap_header *)buffer;
821 length = cap->bLength;
822
823 if (total_len < length)
824 break;
825 total_len -= length;
826
827 if (cap->bDescriptorType != USB_DT_DEVICE_CAPABILITY) {
828 dev_warn(ddev, "descriptor type invalid, skip\n");
829 continue;
830 }
831
832 switch (cap->bDevCapabilityType) {
833 case USB_CAP_TYPE_WIRELESS_USB:
834 /* Wireless USB cap descriptor is handled by wusb */
835 break;
836 case USB_CAP_TYPE_EXT:
837 dev->bos->ext_cap =
838 (struct usb_ext_cap_descriptor *)buffer;
839 break;
840 case USB_SS_CAP_TYPE:
841 dev->bos->ss_cap =
842 (struct usb_ss_cap_descriptor *)buffer;
843 break;
844 case CONTAINER_ID_TYPE:
845 dev->bos->ss_id =
846 (struct usb_ss_container_id_descriptor *)buffer;
847 break;
848 default:
849 break;
850 }
851 }
852
853 return 0;
854
855err:
856 usb_release_bos_descriptor(dev);
857 return ret;
858}