drivers/usb/core/config.c

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