drivers/usb/core/config.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Released under the GPLv2 only.
   4  */
   5
   6 #include <linux/usb.h>
   7 #include <linux/usb/ch9.h>
   8 #include <linux/usb/hcd.h>
   9 #include <linux/usb/quirks.h>
  10 #include <linux/module.h>
  11 #include <linux/slab.h>
  12 #include <linux/device.h>
  13 #include <asm/byteorder.h>
  14 #include "usb.h"
  15
  16
  17 #define USB_MAXALTSETTING               128     /* Hard limit */
  18
  19 #define USB_MAXCONFIG                   8       /* Arbitrary limit */
  20
  21
  22 static inline const char *plural(int n)
  23 {
  24         return (n == 1 ? "" : "s");
  25 }
  26
  27 static int find_next_descriptor(unsigned char *buffer, int size,
  28     int dt1, int dt2, int *num_skipped)
  29 {
  30         struct usb_descriptor_header *h;
  31         int n = 0;
  32         unsigned char *buffer0 = buffer;
  33
  34         /* Find the next descriptor of type dt1 or dt2 */
  35         while (size > 0) {
  36                 h = (struct usb_descriptor_header *) buffer;
  37                 if (h->bDescriptorType == dt1 || h->bDescriptorType == dt2)
  38                         break;
  39                 buffer += h->bLength;
  40                 size -= h->bLength;
  41                 ++n;
  42         }
  43
  44         /* Store the number of descriptors skipped and return the
  45          * number of bytes skipped */
  46         if (num_skipped)
  47                 *num_skipped = n;
  48         return buffer - buffer0;
  49 }
  50
  51 static void usb_parse_ssp_isoc_endpoint_companion(struct device *ddev,
  52                 int cfgno, int inum, int asnum, struct usb_host_endpoint *ep,
  53                 unsigned char *buffer, int size)
  54 {
  55         struct usb_ssp_isoc_ep_comp_descriptor *desc;
  56
  57         /*
  58          * The SuperSpeedPlus Isoc endpoint companion descriptor immediately
  59          * follows the SuperSpeed Endpoint Companion descriptor
  60          */
  61         desc = (struct usb_ssp_isoc_ep_comp_descriptor *) buffer;
  62         if (desc->bDescriptorType != USB_DT_SSP_ISOC_ENDPOINT_COMP ||
  63             size < USB_DT_SSP_ISOC_EP_COMP_SIZE) {
  64                 dev_warn(ddev, "Invalid SuperSpeedPlus isoc endpoint companion"
  65                          "for config %d interface %d altsetting %d ep %d.\n",
  66                          cfgno, inum, asnum, ep->desc.bEndpointAddress);
  67                 return;
  68         }
  69         memcpy(&ep->ssp_isoc_ep_comp, desc, USB_DT_SSP_ISOC_EP_COMP_SIZE);
  70 }
  71
  72 static void usb_parse_ss_endpoint_companion(struct device *ddev, int cfgno,
  73                 int inum, int asnum, struct usb_host_endpoint *ep,
  74                 unsigned char *buffer, int size)
  75 {
  76         struct usb_ss_ep_comp_descriptor *desc;
  77         int max_tx;
  78
  79         /* The SuperSpeed endpoint companion descriptor is supposed to
  80          * be the first thing immediately following the endpoint descriptor.
  81          */
  82         desc = (struct usb_ss_ep_comp_descriptor *) buffer;
  83
  84         if (desc->bDescriptorType != USB_DT_SS_ENDPOINT_COMP ||
  85                         size < USB_DT_SS_EP_COMP_SIZE) {
  86                 dev_warn(ddev, "No SuperSpeed endpoint companion for config %d "
  87                                 " interface %d altsetting %d ep %d: "
  88                                 "using minimum values\n",
  89                                 cfgno, inum, asnum, ep->desc.bEndpointAddress);
  90
  91                 /* Fill in some default values.
  92                  * Leave bmAttributes as zero, which will mean no streams for
  93                  * bulk, and isoc won't support multiple bursts of packets.
  94                  * With bursts of only one packet, and a Mult of 1, the max
  95                  * amount of data moved per endpoint service interval is one
  96                  * packet.
  97                  */
  98                 ep->ss_ep_comp.bLength = USB_DT_SS_EP_COMP_SIZE;
  99                 ep->ss_ep_comp.bDescriptorType = USB_DT_SS_ENDPOINT_COMP;
 100                 if (usb_endpoint_xfer_isoc(&ep->desc) ||
 101                                 usb_endpoint_xfer_int(&ep->desc))
 102                         ep->ss_ep_comp.wBytesPerInterval =
 103                                         ep->desc.wMaxPacketSize;
 104                 return;
 105         }
 106         buffer += desc->bLength;
 107         size -= desc->bLength;
 108         memcpy(&ep->ss_ep_comp, desc, USB_DT_SS_EP_COMP_SIZE);
 109
 110         /* Check the various values */
 111         if (usb_endpoint_xfer_control(&ep->desc) && desc->bMaxBurst != 0) {
 112                 dev_warn(ddev, "Control endpoint with bMaxBurst = %d in "
 113                                 "config %d interface %d altsetting %d ep %d: "
 114                                 "setting to zero\n", desc->bMaxBurst,
 115                                 cfgno, inum, asnum, ep->desc.bEndpointAddress);
 116                 ep->ss_ep_comp.bMaxBurst = 0;
 117         } else if (desc->bMaxBurst > 15) {
 118                 dev_warn(ddev, "Endpoint with bMaxBurst = %d in "
 119                                 "config %d interface %d altsetting %d ep %d: "
 120                                 "setting to 15\n", desc->bMaxBurst,
 121                                 cfgno, inum, asnum, ep->desc.bEndpointAddress);
 122                 ep->ss_ep_comp.bMaxBurst = 15;
 123         }
 124
 125         if ((usb_endpoint_xfer_control(&ep->desc) ||
 126                         usb_endpoint_xfer_int(&ep->desc)) &&
 127                                 desc->bmAttributes != 0) {
 128                 dev_warn(ddev, "%s endpoint with bmAttributes = %d in "
 129                                 "config %d interface %d altsetting %d ep %d: "
 130                                 "setting to zero\n",
 131                                 usb_endpoint_xfer_control(&ep->desc) ? "Control" : "Bulk",
 132                                 desc->bmAttributes,
 133                                 cfgno, inum, asnum, ep->desc.bEndpointAddress);
 134                 ep->ss_ep_comp.bmAttributes = 0;
 135         } else if (usb_endpoint_xfer_bulk(&ep->desc) &&
 136                         desc->bmAttributes > 16) {
 137                 dev_warn(ddev, "Bulk endpoint with more than 65536 streams in "
 138                                 "config %d interface %d altsetting %d ep %d: "
 139                                 "setting to max\n",
 140                                 cfgno, inum, asnum, ep->desc.bEndpointAddress);
 141                 ep->ss_ep_comp.bmAttributes = 16;
 142         } else if (usb_endpoint_xfer_isoc(&ep->desc) &&
 143                    !USB_SS_SSP_ISOC_COMP(desc->bmAttributes) &&
 144                    USB_SS_MULT(desc->bmAttributes) > 3) {
 145                 dev_warn(ddev, "Isoc endpoint has Mult of %d in "
 146                                 "config %d interface %d altsetting %d ep %d: "
 147                                 "setting to 3\n",
 148                                 USB_SS_MULT(desc->bmAttributes),
 149                                 cfgno, inum, asnum, ep->desc.bEndpointAddress);
 150                 ep->ss_ep_comp.bmAttributes = 2;
 151         }
 152
 153         if (usb_endpoint_xfer_isoc(&ep->desc))
 154                 max_tx = (desc->bMaxBurst + 1) *
 155                         (USB_SS_MULT(desc->bmAttributes)) *
 156                         usb_endpoint_maxp(&ep->desc);
 157         else if (usb_endpoint_xfer_int(&ep->desc))
 158                 max_tx = usb_endpoint_maxp(&ep->desc) *
 159                         (desc->bMaxBurst + 1);
 160         else
 161                 max_tx = 999999;
 162         if (le16_to_cpu(desc->wBytesPerInterval) > max_tx) {
 163                 dev_warn(ddev, "%s endpoint with wBytesPerInterval of %d in "
 164                                 "config %d interface %d altsetting %d ep %d: "
 165                                 "setting to %d\n",
 166                                 usb_endpoint_xfer_isoc(&ep->desc) ? "Isoc" : "Int",
 167                                 le16_to_cpu(desc->wBytesPerInterval),
 168                                 cfgno, inum, asnum, ep->desc.bEndpointAddress,
 169                                 max_tx);
 170                 ep->ss_ep_comp.wBytesPerInterval = cpu_to_le16(max_tx);
 171         }
 172         /* Parse a possible SuperSpeedPlus isoc ep companion descriptor */
 173         if (usb_endpoint_xfer_isoc(&ep->desc) &&
 174             USB_SS_SSP_ISOC_COMP(desc->bmAttributes))
 175                 usb_parse_ssp_isoc_endpoint_companion(ddev, cfgno, inum, asnum,
 176                                                         ep, buffer, size);
 177 }
 178
 179 static const unsigned short low_speed_maxpacket_maxes[4] = {
 180         [USB_ENDPOINT_XFER_CONTROL] = 8,
 181         [USB_ENDPOINT_XFER_ISOC] = 0,
 182         [USB_ENDPOINT_XFER_BULK] = 0,
 183         [USB_ENDPOINT_XFER_INT] = 8,
 184 };
 185 static const unsigned short full_speed_maxpacket_maxes[4] = {
 186         [USB_ENDPOINT_XFER_CONTROL] = 64,
 187         [USB_ENDPOINT_XFER_ISOC] = 1023,
 188         [USB_ENDPOINT_XFER_BULK] = 64,
 189         [USB_ENDPOINT_XFER_INT] = 64,
 190 };
 191 static const unsigned short high_speed_maxpacket_maxes[4] = {
 192         [USB_ENDPOINT_XFER_CONTROL] = 64,
 193         [USB_ENDPOINT_XFER_ISOC] = 1024,
 194
 195         /* Bulk should be 512, but some devices use 1024: we will warn below */
 196         [USB_ENDPOINT_XFER_BULK] = 1024,
 197         [USB_ENDPOINT_XFER_INT] = 1024,
 198 };
 199 static const unsigned short super_speed_maxpacket_maxes[4] = {
 200         [USB_ENDPOINT_XFER_CONTROL] = 512,
 201         [USB_ENDPOINT_XFER_ISOC] = 1024,
 202         [USB_ENDPOINT_XFER_BULK] = 1024,
 203         [USB_ENDPOINT_XFER_INT] = 1024,
 204 };
 205
 206 static int usb_parse_endpoint(struct device *ddev, int cfgno, int inum,
 207     int asnum, struct usb_host_interface *ifp, int num_ep,
 208     unsigned char *buffer, int size)
 209 {
 210         unsigned char *buffer0 = buffer;
 211         struct usb_endpoint_descriptor *d;
 212         struct usb_host_endpoint *endpoint;
 213         int n, i, j, retval;
 214         unsigned int maxp;
 215         const unsigned short *maxpacket_maxes;
 216
 217         d = (struct usb_endpoint_descriptor *) buffer;
 218         buffer += d->bLength;
 219         size -= d->bLength;
 220
 221         if (d->bLength >= USB_DT_ENDPOINT_AUDIO_SIZE)
 222                 n = USB_DT_ENDPOINT_AUDIO_SIZE;
 223         else if (d->bLength >= USB_DT_ENDPOINT_SIZE)
 224                 n = USB_DT_ENDPOINT_SIZE;
 225         else {
 226                 dev_warn(ddev, "config %d interface %d altsetting %d has an "
 227                     "invalid endpoint descriptor of length %d, skipping\n",
 228                     cfgno, inum, asnum, d->bLength);
 229                 goto skip_to_next_endpoint_or_interface_descriptor;
 230         }
 231
 232         i = d->bEndpointAddress & ~USB_ENDPOINT_DIR_MASK;
 233         if (i >= 16 || i == 0) {
 234                 dev_warn(ddev, "config %d interface %d altsetting %d has an "
 235                     "invalid endpoint with address 0x%X, skipping\n",
 236                     cfgno, inum, asnum, d->bEndpointAddress);
 237                 goto skip_to_next_endpoint_or_interface_descriptor;
 238         }
 239
 240         /* Only store as many endpoints as we have room for */
 241         if (ifp->desc.bNumEndpoints >= num_ep)
 242                 goto skip_to_next_endpoint_or_interface_descriptor;
 243
 244         /* Check for duplicate endpoint addresses */
 245         for (i = 0; i < ifp->desc.bNumEndpoints; ++i) {
 246                 if (ifp->endpoint[i].desc.bEndpointAddress ==
 247                     d->bEndpointAddress) {
 248                         dev_warn(ddev, "config %d interface %d altsetting %d has a duplicate endpoint with address 0x%X, skipping\n",
 249                             cfgno, inum, asnum, d->bEndpointAddress);
 250                         goto skip_to_next_endpoint_or_interface_descriptor;
 251                 }
 252         }
 253
 254         endpoint = &ifp->endpoint[ifp->desc.bNumEndpoints];
 255         ++ifp->desc.bNumEndpoints;
 256
 257         memcpy(&endpoint->desc, d, n);
 258         INIT_LIST_HEAD(&endpoint->urb_list);
 259
 260         /*
 261          * Fix up bInterval values outside the legal range.
 262          * Use 10 or 8 ms if no proper value can be guessed.
 263          */
 264         i = 0;          /* i = min, j = max, n = default */
 265         j = 255;
 266         if (usb_endpoint_xfer_int(d)) {
 267                 i = 1;
 268                 switch (to_usb_device(ddev)->speed) {
 269                 case USB_SPEED_SUPER_PLUS:
 270                 case USB_SPEED_SUPER:
 271                 case USB_SPEED_HIGH:
 272                         /*
 273                          * Many device manufacturers are using full-speed
 274                          * bInterval values in high-speed interrupt endpoint
 275                          * descriptors. Try to fix those and fall back to an
 276                          * 8-ms default value otherwise.
 277                          */
 278                         n = fls(d->bInterval*8);
 279                         if (n == 0)
 280                                 n = 7;  /* 8 ms = 2^(7-1) uframes */
 281                         j = 16;
 282
 283                         /*
 284                          * Adjust bInterval for quirked devices.
 285                          */
 286                         /*
 287                          * This quirk fixes bIntervals reported in ms.
 288                          */
 289                         if (to_usb_device(ddev)->quirks &
 290                                 USB_QUIRK_LINEAR_FRAME_INTR_BINTERVAL) {
 291                                 n = clamp(fls(d->bInterval) + 3, i, j);
 292                                 i = j = n;
 293                         }
 294                         /*
 295                          * This quirk fixes bIntervals reported in
 296                          * linear microframes.
 297                          */
 298                         if (to_usb_device(ddev)->quirks &
 299                                 USB_QUIRK_LINEAR_UFRAME_INTR_BINTERVAL) {
 300                                 n = clamp(fls(d->bInterval), i, j);
 301                                 i = j = n;
 302                         }
 303                         break;
 304                 default:                /* USB_SPEED_FULL or _LOW */
 305                         /*
 306                          * For low-speed, 10 ms is the official minimum.
 307                          * But some "overclocked" devices might want faster
 308                          * polling so we'll allow it.
 309                          */
 310                         n = 10;
 311                         break;
 312                 }
 313         } else if (usb_endpoint_xfer_isoc(d)) {
 314                 i = 1;
 315                 j = 16;
 316                 switch (to_usb_device(ddev)->speed) {
 317                 case USB_SPEED_HIGH:
 318                         n = 7;          /* 8 ms = 2^(7-1) uframes */
 319                         break;
 320                 default:                /* USB_SPEED_FULL */
 321                         n = 4;          /* 8 ms = 2^(4-1) frames */
 322                         break;
 323                 }
 324         }
 325         if (d->bInterval < i || d->bInterval > j) {
 326                 dev_warn(ddev, "config %d interface %d altsetting %d "
 327                     "endpoint 0x%X has an invalid bInterval %d, "
 328                     "changing to %d\n",
 329                     cfgno, inum, asnum,
 330                     d->bEndpointAddress, d->bInterval, n);
 331                 endpoint->desc.bInterval = n;
 332         }
 333
 334         /* Some buggy low-speed devices have Bulk endpoints, which is
 335          * explicitly forbidden by the USB spec.  In an attempt to make
 336          * them usable, we will try treating them as Interrupt endpoints.
 337          */
 338         if (to_usb_device(ddev)->speed == USB_SPEED_LOW &&
 339                         usb_endpoint_xfer_bulk(d)) {
 340                 dev_warn(ddev, "config %d interface %d altsetting %d "
 341                     "endpoint 0x%X is Bulk; changing to Interrupt\n",
 342                     cfgno, inum, asnum, d->bEndpointAddress);
 343                 endpoint->desc.bmAttributes = USB_ENDPOINT_XFER_INT;
 344                 endpoint->desc.bInterval = 1;
 345                 if (usb_endpoint_maxp(&endpoint->desc) > 8)
 346                         endpoint->desc.wMaxPacketSize = cpu_to_le16(8);
 347         }
 348
 349         /* Validate the wMaxPacketSize field */
 350         maxp = usb_endpoint_maxp(&endpoint->desc);
 351         if (maxp == 0) {
 352                 dev_warn(ddev, "config %d interface %d altsetting %d endpoint 0x%X has wMaxPacketSize 0, skipping\n",
 353                     cfgno, inum, asnum, d->bEndpointAddress);
 354                 goto skip_to_next_endpoint_or_interface_descriptor;
 355         }
 356
 357         /* Find the highest legal maxpacket size for this endpoint */
 358         i = 0;          /* additional transactions per microframe */
 359         switch (to_usb_device(ddev)->speed) {
 360         case USB_SPEED_LOW:
 361                 maxpacket_maxes = low_speed_maxpacket_maxes;
 362                 break;
 363         case USB_SPEED_FULL:
 364                 maxpacket_maxes = full_speed_maxpacket_maxes;
 365                 break;
 366         case USB_SPEED_HIGH:
 367                 /* Bits 12..11 are allowed only for HS periodic endpoints */
 368                 if (usb_endpoint_xfer_int(d) || usb_endpoint_xfer_isoc(d)) {
 369                         i = maxp & (BIT(12) | BIT(11));
 370                         maxp &= ~i;
 371                 }
 372                 /* fallthrough */
 373         default:
 374                 maxpacket_maxes = high_speed_maxpacket_maxes;
 375                 break;
 376         case USB_SPEED_SUPER:
 377         case USB_SPEED_SUPER_PLUS:
 378                 maxpacket_maxes = super_speed_maxpacket_maxes;
 379                 break;
 380         }
 381         j = maxpacket_maxes[usb_endpoint_type(&endpoint->desc)];
 382
 383         if (maxp > j) {
 384                 dev_warn(ddev, "config %d interface %d altsetting %d endpoint 0x%X has invalid maxpacket %d, setting to %d\n",
 385                     cfgno, inum, asnum, d->bEndpointAddress, maxp, j);
 386                 maxp = j;
 387                 endpoint->desc.wMaxPacketSize = cpu_to_le16(i | maxp);
 388         }
 389
 390         /*
 391          * Some buggy high speed devices have bulk endpoints using
 392          * maxpacket sizes other than 512.  High speed HCDs may not
 393          * be able to handle that particular bug, so let's warn...
 394          */
 395         if (to_usb_device(ddev)->speed == USB_SPEED_HIGH
 396                         && usb_endpoint_xfer_bulk(d)) {
 397                 if (maxp != 512)
 398                         dev_warn(ddev, "config %d interface %d altsetting %d "
 399                                 "bulk endpoint 0x%X has invalid maxpacket %d\n",
 400                                 cfgno, inum, asnum, d->bEndpointAddress,
 401                                 maxp);
 402         }
 403
 404         /* Parse a possible SuperSpeed endpoint companion descriptor */
 405         if (to_usb_device(ddev)->speed >= USB_SPEED_SUPER)
 406                 usb_parse_ss_endpoint_companion(ddev, cfgno,
 407                                 inum, asnum, endpoint, buffer, size);
 408
 409         /* Skip over any Class Specific or Vendor Specific descriptors;
 410          * find the next endpoint or interface descriptor */
 411         endpoint->extra = buffer;
 412         i = find_next_descriptor(buffer, size, USB_DT_ENDPOINT,
 413                         USB_DT_INTERFACE, &n);
 414         endpoint->extralen = i;
 415         retval = buffer - buffer0 + i;
 416         if (n > 0)
 417                 dev_dbg(ddev, "skipped %d descriptor%s after %s\n",
 418                     n, plural(n), "endpoint");
 419         return retval;
 420
 421 skip_to_next_endpoint_or_interface_descriptor:
 422         i = find_next_descriptor(buffer, size, USB_DT_ENDPOINT,
 423             USB_DT_INTERFACE, NULL);
 424         return buffer - buffer0 + i;
 425 }
 426
 427 void usb_release_interface_cache(struct kref *ref)
 428 {
 429         struct usb_interface_cache *intfc = ref_to_usb_interface_cache(ref);
 430         int j;
 431
 432         for (j = 0; j < intfc->num_altsetting; j++) {
 433                 struct usb_host_interface *alt = &intfc->altsetting[j];
 434
 435                 kfree(alt->endpoint);
 436                 kfree(alt->string);
 437         }
 438         kfree(intfc);
 439 }
 440
 441 static int usb_parse_interface(struct device *ddev, int cfgno,
 442     struct usb_host_config *config, unsigned char *buffer, int size,
 443     u8 inums[], u8 nalts[])
 444 {
 445         unsigned char *buffer0 = buffer;
 446         struct usb_interface_descriptor *d;
 447         int inum, asnum;
 448         struct usb_interface_cache *intfc;
 449         struct usb_host_interface *alt;
 450         int i, n;
 451         int len, retval;
 452         int num_ep, num_ep_orig;
 453
 454         d = (struct usb_interface_descriptor *) buffer;
 455         buffer += d->bLength;
 456         size -= d->bLength;
 457
 458         if (d->bLength < USB_DT_INTERFACE_SIZE)
 459                 goto skip_to_next_interface_descriptor;
 460
 461         /* Which interface entry is this? */
 462         intfc = NULL;
 463         inum = d->bInterfaceNumber;
 464         for (i = 0; i < config->desc.bNumInterfaces; ++i) {
 465                 if (inums[i] == inum) {
 466                         intfc = config->intf_cache[i];
 467                         break;
 468                 }
 469         }
 470         if (!intfc || intfc->num_altsetting >= nalts[i])
 471                 goto skip_to_next_interface_descriptor;
 472
 473         /* Check for duplicate altsetting entries */
 474         asnum = d->bAlternateSetting;
 475         for ((i = 0, alt = &intfc->altsetting[0]);
 476               i < intfc->num_altsetting;
 477              (++i, ++alt)) {
 478                 if (alt->desc.bAlternateSetting == asnum) {
 479                         dev_warn(ddev, "Duplicate descriptor for config %d "
 480                             "interface %d altsetting %d, skipping\n",
 481                             cfgno, inum, asnum);
 482                         goto skip_to_next_interface_descriptor;
 483                 }
 484         }
 485
 486         ++intfc->num_altsetting;
 487         memcpy(&alt->desc, d, USB_DT_INTERFACE_SIZE);
 488
 489         /* Skip over any Class Specific or Vendor Specific descriptors;
 490          * find the first endpoint or interface descriptor */
 491         alt->extra = buffer;
 492         i = find_next_descriptor(buffer, size, USB_DT_ENDPOINT,
 493             USB_DT_INTERFACE, &n);
 494         alt->extralen = i;
 495         if (n > 0)
 496                 dev_dbg(ddev, "skipped %d descriptor%s after %s\n",
 497                     n, plural(n), "interface");
 498         buffer += i;
 499         size -= i;
 500
 501         /* Allocate space for the right(?) number of endpoints */
 502         num_ep = num_ep_orig = alt->desc.bNumEndpoints;
 503         alt->desc.bNumEndpoints = 0;            /* Use as a counter */
 504         if (num_ep > USB_MAXENDPOINTS) {
 505                 dev_warn(ddev, "too many endpoints for config %d interface %d "
 506                     "altsetting %d: %d, using maximum allowed: %d\n",
 507                     cfgno, inum, asnum, num_ep, USB_MAXENDPOINTS);
 508                 num_ep = USB_MAXENDPOINTS;
 509         }
 510
 511         if (num_ep > 0) {
 512                 /* Can't allocate 0 bytes */
 513                 len = sizeof(struct usb_host_endpoint) * num_ep;
 514                 alt->endpoint = kzalloc(len, GFP_KERNEL);
 515                 if (!alt->endpoint)
 516                         return -ENOMEM;
 517         }
 518
 519         /* Parse all the endpoint descriptors */
 520         n = 0;
 521         while (size > 0) {
 522                 if (((struct usb_descriptor_header *) buffer)->bDescriptorType
 523                      == USB_DT_INTERFACE)
 524                         break;
 525                 retval = usb_parse_endpoint(ddev, cfgno, inum, asnum, alt,
 526                     num_ep, buffer, size);
 527                 if (retval < 0)
 528                         return retval;
 529                 ++n;
 530
 531                 buffer += retval;
 532                 size -= retval;
 533         }
 534
 535         if (n != num_ep_orig)
 536                 dev_warn(ddev, "config %d interface %d altsetting %d has %d "
 537                     "endpoint descriptor%s, different from the interface "
 538                     "descriptor's value: %d\n",
 539                     cfgno, inum, asnum, n, plural(n), num_ep_orig);
 540         return buffer - buffer0;
 541
 542 skip_to_next_interface_descriptor:
 543         i = find_next_descriptor(buffer, size, USB_DT_INTERFACE,
 544             USB_DT_INTERFACE, NULL);
 545         return buffer - buffer0 + i;
 546 }
 547
 548 static int usb_parse_configuration(struct usb_device *dev, int cfgidx,
 549     struct usb_host_config *config, unsigned char *buffer, int size)
 550 {
 551         struct device *ddev = &dev->dev;
 552         unsigned char *buffer0 = buffer;
 553         int cfgno;
 554         int nintf, nintf_orig;
 555         int i, j, n;
 556         struct usb_interface_cache *intfc;
 557         unsigned char *buffer2;
 558         int size2;
 559         struct usb_descriptor_header *header;
 560         int retval;
 561         u8 inums[USB_MAXINTERFACES], nalts[USB_MAXINTERFACES];
 562         unsigned iad_num = 0;
 563
 564         memcpy(&config->desc, buffer, USB_DT_CONFIG_SIZE);
 565         nintf = nintf_orig = config->desc.bNumInterfaces;
 566         config->desc.bNumInterfaces = 0;        // Adjusted later
 567
 568         if (config->desc.bDescriptorType != USB_DT_CONFIG ||
 569             config->desc.bLength < USB_DT_CONFIG_SIZE ||
 570             config->desc.bLength > size) {
 571                 dev_err(ddev, "invalid descriptor for config index %d: "
 572                     "type = 0x%X, length = %d\n", cfgidx,
 573                     config->desc.bDescriptorType, config->desc.bLength);
 574                 return -EINVAL;
 575         }
 576         cfgno = config->desc.bConfigurationValue;
 577
 578         buffer += config->desc.bLength;
 579         size -= config->desc.bLength;
 580
 581         if (nintf > USB_MAXINTERFACES) {
 582                 dev_warn(ddev, "config %d has too many interfaces: %d, "
 583                     "using maximum allowed: %d\n",
 584                     cfgno, nintf, USB_MAXINTERFACES);
 585                 nintf = USB_MAXINTERFACES;
 586         }
 587
 588         /* Go through the descriptors, checking their length and counting the
 589          * number of altsettings for each interface */
 590         n = 0;
 591         for ((buffer2 = buffer, size2 = size);
 592               size2 > 0;
 593              (buffer2 += header->bLength, size2 -= header->bLength)) {
 594
 595                 if (size2 < sizeof(struct usb_descriptor_header)) {
 596                         dev_warn(ddev, "config %d descriptor has %d excess "
 597                             "byte%s, ignoring\n",
 598                             cfgno, size2, plural(size2));
 599                         break;
 600                 }
 601
 602                 header = (struct usb_descriptor_header *) buffer2;
 603                 if ((header->bLength > size2) || (header->bLength < 2)) {
 604                         dev_warn(ddev, "config %d has an invalid descriptor "
 605                             "of length %d, skipping remainder of the config\n",
 606                             cfgno, header->bLength);
 607                         break;
 608                 }
 609
 610                 if (header->bDescriptorType == USB_DT_INTERFACE) {
 611                         struct usb_interface_descriptor *d;
 612                         int inum;
 613
 614                         d = (struct usb_interface_descriptor *) header;
 615                         if (d->bLength < USB_DT_INTERFACE_SIZE) {
 616                                 dev_warn(ddev, "config %d has an invalid "
 617                                     "interface descriptor of length %d, "
 618                                     "skipping\n", cfgno, d->bLength);
 619                                 continue;
 620                         }
 621
 622                         inum = d->bInterfaceNumber;
 623
 624                         if ((dev->quirks & USB_QUIRK_HONOR_BNUMINTERFACES) &&
 625                             n >= nintf_orig) {
 626                                 dev_warn(ddev, "config %d has more interface "
 627                                     "descriptors, than it declares in "
 628                                     "bNumInterfaces, ignoring interface "
 629                                     "number: %d\n", cfgno, inum);
 630                                 continue;
 631                         }
 632
 633                         if (inum >= nintf_orig)
 634                                 dev_warn(ddev, "config %d has an invalid "
 635                                     "interface number: %d but max is %d\n",
 636                                     cfgno, inum, nintf_orig - 1);
 637
 638                         /* Have we already encountered this interface?
 639                          * Count its altsettings */
 640                         for (i = 0; i < n; ++i) {
 641                                 if (inums[i] == inum)
 642                                         break;
 643                         }
 644                         if (i < n) {
 645                                 if (nalts[i] < 255)
 646                                         ++nalts[i];
 647                         } else if (n < USB_MAXINTERFACES) {
 648                                 inums[n] = inum;
 649                                 nalts[n] = 1;
 650                                 ++n;
 651                         }
 652
 653                 } else if (header->bDescriptorType ==
 654                                 USB_DT_INTERFACE_ASSOCIATION) {
 655                         struct usb_interface_assoc_descriptor *d;
 656
 657                         d = (struct usb_interface_assoc_descriptor *)header;
 658                         if (d->bLength < USB_DT_INTERFACE_ASSOCIATION_SIZE) {
 659                                 dev_warn(ddev,
 660                                          "config %d has an invalid interface association descriptor of length %d, skipping\n",
 661                                          cfgno, d->bLength);
 662                                 continue;
 663                         }
 664
 665                         if (iad_num == USB_MAXIADS) {
 666                                 dev_warn(ddev, "found more Interface "
 667                                                "Association Descriptors "
 668                                                "than allocated for in "
 669                                                "configuration %d\n", cfgno);
 670                         } else {
 671                                 config->intf_assoc[iad_num] = d;
 672                                 iad_num++;
 673                         }
 674
 675                 } else if (header->bDescriptorType == USB_DT_DEVICE ||
 676                             header->bDescriptorType == USB_DT_CONFIG)
 677                         dev_warn(ddev, "config %d contains an unexpected "
 678                             "descriptor of type 0x%X, skipping\n",
 679                             cfgno, header->bDescriptorType);
 680
 681         }       /* for ((buffer2 = buffer, size2 = size); ...) */
 682         size = buffer2 - buffer;
 683         config->desc.wTotalLength = cpu_to_le16(buffer2 - buffer0);
 684
 685         if (n != nintf)
 686                 dev_warn(ddev, "config %d has %d interface%s, different from "
 687                     "the descriptor's value: %d\n",
 688                     cfgno, n, plural(n), nintf_orig);
 689         else if (n == 0)
 690                 dev_warn(ddev, "config %d has no interfaces?\n", cfgno);
 691         config->desc.bNumInterfaces = nintf = n;
 692
 693         /* Check for missing interface numbers */
 694         for (i = 0; i < nintf; ++i) {
 695                 for (j = 0; j < nintf; ++j) {
 696                         if (inums[j] == i)
 697                                 break;
 698                 }
 699                 if (j >= nintf)
 700                         dev_warn(ddev, "config %d has no interface number "
 701                             "%d\n", cfgno, i);
 702         }
 703
 704         /* Allocate the usb_interface_caches and altsetting arrays */
 705         for (i = 0; i < nintf; ++i) {
 706                 j = nalts[i];
 707                 if (j > USB_MAXALTSETTING) {
 708                         dev_warn(ddev, "too many alternate settings for "
 709                             "config %d interface %d: %d, "
 710                             "using maximum allowed: %d\n",
 711                             cfgno, inums[i], j, USB_MAXALTSETTING);
 712                         nalts[i] = j = USB_MAXALTSETTING;
 713                 }
 714
 715                 intfc = kzalloc(struct_size(intfc, altsetting, j), GFP_KERNEL);
 716                 config->intf_cache[i] = intfc;
 717                 if (!intfc)
 718                         return -ENOMEM;
 719                 kref_init(&intfc->ref);
 720         }
 721
 722         /* FIXME: parse the BOS descriptor */
 723
 724         /* Skip over any Class Specific or Vendor Specific descriptors;
 725          * find the first interface descriptor */
 726         config->extra = buffer;
 727         i = find_next_descriptor(buffer, size, USB_DT_INTERFACE,
 728             USB_DT_INTERFACE, &n);
 729         config->extralen = i;
 730         if (n > 0)
 731                 dev_dbg(ddev, "skipped %d descriptor%s after %s\n",
 732                     n, plural(n), "configuration");
 733         buffer += i;
 734         size -= i;
 735
 736         /* Parse all the interface/altsetting descriptors */
 737         while (size > 0) {
 738                 retval = usb_parse_interface(ddev, cfgno, config,
 739                     buffer, size, inums, nalts);
 740                 if (retval < 0)
 741                         return retval;
 742
 743                 buffer += retval;
 744                 size -= retval;
 745         }
 746
 747         /* Check for missing altsettings */
 748         for (i = 0; i < nintf; ++i) {
 749                 intfc = config->intf_cache[i];
 750                 for (j = 0; j < intfc->num_altsetting; ++j) {
 751                         for (n = 0; n < intfc->num_altsetting; ++n) {
 752                                 if (intfc->altsetting[n].desc.
 753                                     bAlternateSetting == j)
 754                                         break;
 755                         }
 756                         if (n >= intfc->num_altsetting)
 757                                 dev_warn(ddev, "config %d interface %d has no "
 758                                     "altsetting %d\n", cfgno, inums[i], j);
 759                 }
 760         }
 761
 762         return 0;
 763 }
 764
 765 /* hub-only!! ... and only exported for reset/reinit path.
 766  * otherwise used internally on disconnect/destroy path
 767  */
 768 void usb_destroy_configuration(struct usb_device *dev)
 769 {
 770         int c, i;
 771
 772         if (!dev->config)
 773                 return;
 774
 775         if (dev->rawdescriptors) {
 776                 for (i = 0; i < dev->descriptor.bNumConfigurations; i++)
 777                         kfree(dev->rawdescriptors[i]);
 778
 779                 kfree(dev->rawdescriptors);
 780                 dev->rawdescriptors = NULL;
 781         }
 782
 783         for (c = 0; c < dev->descriptor.bNumConfigurations; c++) {
 784                 struct usb_host_config *cf = &dev->config[c];
 785
 786                 kfree(cf->string);
 787                 for (i = 0; i < cf->desc.bNumInterfaces; i++) {
 788                         if (cf->intf_cache[i])
 789                                 kref_put(&cf->intf_cache[i]->ref,
 790                                           usb_release_interface_cache);
 791                 }
 792         }
 793         kfree(dev->config);
 794         dev->config = NULL;
 795 }
 796
 797
 798 /*
 799  * Get the USB config descriptors, cache and parse'em
 800  *
 801  * hub-only!! ... and only in reset path, or usb_new_device()
 802  * (used by real hubs and virtual root hubs)
 803  */
 804 int usb_get_configuration(struct usb_device *dev)
 805 {
 806         struct device *ddev = &dev->dev;
 807         int ncfg = dev->descriptor.bNumConfigurations;
 808         unsigned int cfgno, length;
 809         unsigned char *bigbuffer;
 810         struct usb_config_descriptor *desc;
 811         int result;
 812
 813         if (ncfg > USB_MAXCONFIG) {
 814                 dev_warn(ddev, "too many configurations: %d, "
 815                     "using maximum allowed: %d\n", ncfg, USB_MAXCONFIG);
 816                 dev->descriptor.bNumConfigurations = ncfg = USB_MAXCONFIG;
 817         }
 818
 819         if (ncfg < 1) {
 820                 dev_err(ddev, "no configurations\n");
 821                 return -EINVAL;
 822         }
 823
 824         length = ncfg * sizeof(struct usb_host_config);
 825         dev->config = kzalloc(length, GFP_KERNEL);
 826         if (!dev->config)
 827                 return -ENOMEM;
 828
 829         length = ncfg * sizeof(char *);
 830         dev->rawdescriptors = kzalloc(length, GFP_KERNEL);
 831         if (!dev->rawdescriptors)
 832                 return -ENOMEM;
 833
 834         desc = kmalloc(USB_DT_CONFIG_SIZE, GFP_KERNEL);
 835         if (!desc)
 836                 return -ENOMEM;
 837
 838         for (cfgno = 0; cfgno < ncfg; cfgno++) {
 839                 /* We grab just the first descriptor so we know how long
 840                  * the whole configuration is */
 841                 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno,
 842                     desc, USB_DT_CONFIG_SIZE);
 843                 if (result < 0) {
 844                         dev_err(ddev, "unable to read config index %d "
 845                             "descriptor/%s: %d\n", cfgno, "start", result);
 846                         if (result != -EPIPE)
 847                                 goto err;
 848                         dev_err(ddev, "chopping to %d config(s)\n", cfgno);
 849                         dev->descriptor.bNumConfigurations = cfgno;
 850                         break;
 851                 } else if (result < 4) {
 852                         dev_err(ddev, "config index %d descriptor too short "
 853                             "(expected %i, got %i)\n", cfgno,
 854                             USB_DT_CONFIG_SIZE, result);
 855                         result = -EINVAL;
 856                         goto err;
 857                 }
 858                 length = max((int) le16_to_cpu(desc->wTotalLength),
 859                     USB_DT_CONFIG_SIZE);
 860
 861                 /* Now that we know the length, get the whole thing */
 862                 bigbuffer = kmalloc(length, GFP_KERNEL);
 863                 if (!bigbuffer) {
 864                         result = -ENOMEM;
 865                         goto err;
 866                 }
 867
 868                 if (dev->quirks & USB_QUIRK_DELAY_INIT)
 869                         msleep(200);
 870
 871                 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno,
 872                     bigbuffer, length);
 873                 if (result < 0) {
 874                         dev_err(ddev, "unable to read config index %d "
 875                             "descriptor/%s\n", cfgno, "all");
 876                         kfree(bigbuffer);
 877                         goto err;
 878                 }
 879                 if (result < length) {
 880                         dev_warn(ddev, "config index %d descriptor too short "
 881                             "(expected %i, got %i)\n", cfgno, length, result);
 882                         length = result;
 883                 }
 884
 885                 dev->rawdescriptors[cfgno] = bigbuffer;
 886
 887                 result = usb_parse_configuration(dev, cfgno,
 888                     &dev->config[cfgno], bigbuffer, length);
 889                 if (result < 0) {
 890                         ++cfgno;
 891                         goto err;
 892                 }
 893         }
 894
 895 err:
 896         kfree(desc);
 897         dev->descriptor.bNumConfigurations = cfgno;
 898
 899         return result;
 900 }
 901
 902 void usb_release_bos_descriptor(struct usb_device *dev)
 903 {
 904         if (dev->bos) {
 905                 kfree(dev->bos->desc);
 906                 kfree(dev->bos);
 907                 dev->bos = NULL;
 908         }
 909 }
 910
 911 static const __u8 bos_desc_len[256] = {
 912         [USB_CAP_TYPE_WIRELESS_USB] = USB_DT_USB_WIRELESS_CAP_SIZE,
 913         [USB_CAP_TYPE_EXT]          = USB_DT_USB_EXT_CAP_SIZE,
 914         [USB_SS_CAP_TYPE]           = USB_DT_USB_SS_CAP_SIZE,
 915         [USB_SSP_CAP_TYPE]          = USB_DT_USB_SSP_CAP_SIZE(1),
 916         [CONTAINER_ID_TYPE]         = USB_DT_USB_SS_CONTN_ID_SIZE,
 917         [USB_PTM_CAP_TYPE]          = USB_DT_USB_PTM_ID_SIZE,
 918 };
 919
 920 /* Get BOS descriptor set */
 921 int usb_get_bos_descriptor(struct usb_device *dev)
 922 {
 923         struct device *ddev = &dev->dev;
 924         struct usb_bos_descriptor *bos;
 925         struct usb_dev_cap_header *cap;
 926         struct usb_ssp_cap_descriptor *ssp_cap;
 927         unsigned char *buffer, *buffer0;
 928         int length, total_len, num, i, ssac;
 929         __u8 cap_type;
 930         int ret;
 931
 932         bos = kzalloc(sizeof(struct usb_bos_descriptor), GFP_KERNEL);
 933         if (!bos)
 934                 return -ENOMEM;
 935
 936         /* Get BOS descriptor */
 937         ret = usb_get_descriptor(dev, USB_DT_BOS, 0, bos, USB_DT_BOS_SIZE);
 938         if (ret < USB_DT_BOS_SIZE || bos->bLength < USB_DT_BOS_SIZE) {
 939                 dev_err(ddev, "unable to get BOS descriptor or descriptor too short\n");
 940                 if (ret >= 0)
 941                         ret = -ENOMSG;
 942                 kfree(bos);
 943                 return ret;
 944         }
 945
 946         length = bos->bLength;
 947         total_len = le16_to_cpu(bos->wTotalLength);
 948         num = bos->bNumDeviceCaps;
 949         kfree(bos);
 950         if (total_len < length)
 951                 return -EINVAL;
 952
 953         dev->bos = kzalloc(sizeof(struct usb_host_bos), GFP_KERNEL);
 954         if (!dev->bos)
 955                 return -ENOMEM;
 956
 957         /* Now let's get the whole BOS descriptor set */
 958         buffer = kzalloc(total_len, GFP_KERNEL);
 959         if (!buffer) {
 960                 ret = -ENOMEM;
 961                 goto err;
 962         }
 963         dev->bos->desc = (struct usb_bos_descriptor *)buffer;
 964
 965         ret = usb_get_descriptor(dev, USB_DT_BOS, 0, buffer, total_len);
 966         if (ret < total_len) {
 967                 dev_err(ddev, "unable to get BOS descriptor set\n");
 968                 if (ret >= 0)
 969                         ret = -ENOMSG;
 970                 goto err;
 971         }
 972
 973         buffer0 = buffer;
 974         total_len -= length;
 975         buffer += length;
 976
 977         for (i = 0; i < num; i++) {
 978                 cap = (struct usb_dev_cap_header *)buffer;
 979
 980                 if (total_len < sizeof(*cap) || total_len < cap->bLength) {
 981                         dev->bos->desc->bNumDeviceCaps = i;
 982                         break;
 983                 }
 984                 cap_type = cap->bDevCapabilityType;
 985                 length = cap->bLength;
 986                 if (bos_desc_len[cap_type] && length < bos_desc_len[cap_type]) {
 987                         dev->bos->desc->bNumDeviceCaps = i;
 988                         break;
 989                 }
 990
 991                 if (cap->bDescriptorType != USB_DT_DEVICE_CAPABILITY) {
 992                         dev_warn(ddev, "descriptor type invalid, skip\n");
 993                         continue;
 994                 }
 995
 996                 switch (cap_type) {
 997                 case USB_CAP_TYPE_WIRELESS_USB:
 998                         /* Wireless USB cap descriptor is handled by wusb */
 999                         break;
1000                 case USB_CAP_TYPE_EXT:
1001                         dev->bos->ext_cap =
1002                                 (struct usb_ext_cap_descriptor *)buffer;
1003                         break;
1004                 case USB_SS_CAP_TYPE:
1005                         dev->bos->ss_cap =
1006                                 (struct usb_ss_cap_descriptor *)buffer;
1007                         break;
1008                 case USB_SSP_CAP_TYPE:
1009                         ssp_cap = (struct usb_ssp_cap_descriptor *)buffer;
1010                         ssac = (le32_to_cpu(ssp_cap->bmAttributes) &
1011                                 USB_SSP_SUBLINK_SPEED_ATTRIBS);
1012                         if (length >= USB_DT_USB_SSP_CAP_SIZE(ssac))
1013                                 dev->bos->ssp_cap = ssp_cap;
1014                         break;
1015                 case CONTAINER_ID_TYPE:
1016                         dev->bos->ss_id =
1017                                 (struct usb_ss_container_id_descriptor *)buffer;
1018                         break;
1019                 case USB_PTM_CAP_TYPE:
1020                         dev->bos->ptm_cap =
1021                                 (struct usb_ptm_cap_descriptor *)buffer;
1022                 default:
1023                         break;
1024                 }
1025
1026                 total_len -= length;
1027                 buffer += length;
1028         }
1029         dev->bos->desc->wTotalLength = cpu_to_le16(buffer - buffer0);
1030
1031         return 0;
1032
1033 err:
1034         usb_release_bos_descriptor(dev);
1035         return ret;
1036 }