drivers/usb/gadget/composite.c

   1 /*
   2  * composite.c - infrastructure for Composite USB Gadgets
   3  *
   4  * Copyright (C) 2006-2008 David Brownell
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  */
  11
  12 /* #define VERBOSE_DEBUG */
  13
  14 #include <linux/kallsyms.h>
  15 #include <linux/kernel.h>
  16 #include <linux/slab.h>
  17 #include <linux/module.h>
  18 #include <linux/device.h>
  19 #include <linux/utsname.h>
  20
  21 #include <linux/usb/composite.h>
  22 #include <linux/usb/otg.h>
  23 #include <asm/unaligned.h>
  24
  25 #include "u_os_desc.h"
  26
  27 /**
  28  * struct usb_os_string - represents OS String to be reported by a gadget
  29  * @bLength: total length of the entire descritor, always 0x12
  30  * @bDescriptorType: USB_DT_STRING
  31  * @qwSignature: the OS String proper
  32  * @bMS_VendorCode: code used by the host for subsequent requests
  33  * @bPad: not used, must be zero
  34  */
  35 struct usb_os_string {
  36         __u8    bLength;
  37         __u8    bDescriptorType;
  38         __u8    qwSignature[OS_STRING_QW_SIGN_LEN];
  39         __u8    bMS_VendorCode;
  40         __u8    bPad;
  41 } __packed;
  42
  43 /*
  44  * The code in this file is utility code, used to build a gadget driver
  45  * from one or more "function" drivers, one or more "configuration"
  46  * objects, and a "usb_composite_driver" by gluing them together along
  47  * with the relevant device-wide data.
  48  */
  49
  50 static struct usb_gadget_strings **get_containers_gs(
  51                 struct usb_gadget_string_container *uc)
  52 {
  53         return (struct usb_gadget_strings **)uc->stash;
  54 }
  55
  56 /**
  57  * function_descriptors() - get function descriptors for speed
  58  * @f: the function
  59  * @speed: the speed
  60  *
  61  * Returns the descriptors or NULL if not set.
  62  */
  63 static struct usb_descriptor_header **
  64 function_descriptors(struct usb_function *f,
  65                      enum usb_device_speed speed)
  66 {
  67         struct usb_descriptor_header **descriptors;
  68
  69         switch (speed) {
  70         case USB_SPEED_SUPER_PLUS:
  71                 descriptors = f->ssp_descriptors;
  72                 break;
  73         case USB_SPEED_SUPER:
  74                 descriptors = f->ss_descriptors;
  75                 break;
  76         case USB_SPEED_HIGH:
  77                 descriptors = f->hs_descriptors;
  78                 break;
  79         default:
  80                 descriptors = f->fs_descriptors;
  81         }
  82
  83         return descriptors;
  84 }
  85
  86 /**
  87  * next_ep_desc() - advance to the next EP descriptor
  88  * @t: currect pointer within descriptor array
  89  *
  90  * Return: next EP descriptor or NULL
  91  *
  92  * Iterate over @t until either EP descriptor found or
  93  * NULL (that indicates end of list) encountered
  94  */
  95 static struct usb_descriptor_header**
  96 next_ep_desc(struct usb_descriptor_header **t)
  97 {
  98         for (; *t; t++) {
  99                 if ((*t)->bDescriptorType == USB_DT_ENDPOINT)
 100                         return t;
 101         }
 102         return NULL;
 103 }
 104
 105 /*
 106  * for_each_ep_desc()- iterate over endpoint descriptors in the
 107  *              descriptors list
 108  * @start:      pointer within descriptor array.
 109  * @ep_desc:    endpoint descriptor to use as the loop cursor
 110  */
 111 #define for_each_ep_desc(start, ep_desc) \
 112         for (ep_desc = next_ep_desc(start); \
 113               ep_desc; ep_desc = next_ep_desc(ep_desc+1))
 114
 115 /**
 116  * config_ep_by_speed() - configures the given endpoint
 117  * according to gadget speed.
 118  * @g: pointer to the gadget
 119  * @f: usb function
 120  * @_ep: the endpoint to configure
 121  *
 122  * Return: error code, 0 on success
 123  *
 124  * This function chooses the right descriptors for a given
 125  * endpoint according to gadget speed and saves it in the
 126  * endpoint desc field. If the endpoint already has a descriptor
 127  * assigned to it - overwrites it with currently corresponding
 128  * descriptor. The endpoint maxpacket field is updated according
 129  * to the chosen descriptor.
 130  * Note: the supplied function should hold all the descriptors
 131  * for supported speeds
 132  */
 133 int config_ep_by_speed(struct usb_gadget *g,
 134                         struct usb_function *f,
 135                         struct usb_ep *_ep)
 136 {
 137         struct usb_composite_dev        *cdev = get_gadget_data(g);
 138         struct usb_endpoint_descriptor *chosen_desc = NULL;
 139         struct usb_descriptor_header **speed_desc = NULL;
 140
 141         struct usb_ss_ep_comp_descriptor *comp_desc = NULL;
 142         int want_comp_desc = 0;
 143
 144         struct usb_descriptor_header **d_spd; /* cursor for speed desc */
 145
 146         if (!g || !f || !_ep)
 147                 return -EIO;
 148
 149         /* select desired speed */
 150         switch (g->speed) {
 151         case USB_SPEED_SUPER_PLUS:
 152                 if (gadget_is_superspeed_plus(g)) {
 153                         speed_desc = f->ssp_descriptors;
 154                         want_comp_desc = 1;
 155                         break;
 156                 }
 157                 /* else: Fall trough */
 158         case USB_SPEED_SUPER:
 159                 if (gadget_is_superspeed(g)) {
 160                         speed_desc = f->ss_descriptors;
 161                         want_comp_desc = 1;
 162                         break;
 163                 }
 164                 /* else: Fall trough */
 165         case USB_SPEED_HIGH:
 166                 if (gadget_is_dualspeed(g)) {
 167                         speed_desc = f->hs_descriptors;
 168                         break;
 169                 }
 170                 /* else: fall through */
 171         default:
 172                 speed_desc = f->fs_descriptors;
 173         }
 174         /* find descriptors */
 175         for_each_ep_desc(speed_desc, d_spd) {
 176                 chosen_desc = (struct usb_endpoint_descriptor *)*d_spd;
 177                 if (chosen_desc->bEndpointAddress == _ep->address)
 178                         goto ep_found;
 179         }
 180         return -EIO;
 181
 182 ep_found:
 183         /* commit results */
 184         _ep->maxpacket = usb_endpoint_maxp(chosen_desc);
 185         _ep->desc = chosen_desc;
 186         _ep->comp_desc = NULL;
 187         _ep->maxburst = 0;
 188         _ep->mult = 0;
 189         if (!want_comp_desc)
 190                 return 0;
 191
 192         /*
 193          * Companion descriptor should follow EP descriptor
 194          * USB 3.0 spec, #9.6.7
 195          */
 196         comp_desc = (struct usb_ss_ep_comp_descriptor *)*(++d_spd);
 197         if (!comp_desc ||
 198             (comp_desc->bDescriptorType != USB_DT_SS_ENDPOINT_COMP))
 199                 return -EIO;
 200         _ep->comp_desc = comp_desc;
 201         if (g->speed >= USB_SPEED_SUPER) {
 202                 switch (usb_endpoint_type(_ep->desc)) {
 203                 case USB_ENDPOINT_XFER_ISOC:
 204                         /* mult: bits 1:0 of bmAttributes */
 205                         _ep->mult = comp_desc->bmAttributes & 0x3;
 206                 case USB_ENDPOINT_XFER_BULK:
 207                 case USB_ENDPOINT_XFER_INT:
 208                         _ep->maxburst = comp_desc->bMaxBurst + 1;
 209                         break;
 210                 default:
 211                         if (comp_desc->bMaxBurst != 0)
 212                                 ERROR(cdev, "ep0 bMaxBurst must be 0\n");
 213                         _ep->maxburst = 1;
 214                         break;
 215                 }
 216         }
 217         return 0;
 218 }
 219 EXPORT_SYMBOL_GPL(config_ep_by_speed);
 220
 221 /**
 222  * usb_add_function() - add a function to a configuration
 223  * @config: the configuration
 224  * @function: the function being added
 225  * Context: single threaded during gadget setup
 226  *
 227  * After initialization, each configuration must have one or more
 228  * functions added to it.  Adding a function involves calling its @bind()
 229  * method to allocate resources such as interface and string identifiers
 230  * and endpoints.
 231  *
 232  * This function returns the value of the function's bind(), which is
 233  * zero for success else a negative errno value.
 234  */
 235 int usb_add_function(struct usb_configuration *config,
 236                 struct usb_function *function)
 237 {
 238         int     value = -EINVAL;
 239
 240         DBG(config->cdev, "adding '%s'/%p to config '%s'/%p\n",
 241                         function->name, function,
 242                         config->label, config);
 243
 244         if (!function->set_alt || !function->disable)
 245                 goto done;
 246
 247         function->config = config;
 248         list_add_tail(&function->list, &config->functions);
 249
 250         if (function->bind_deactivated) {
 251                 value = usb_function_deactivate(function);
 252                 if (value)
 253                         goto done;
 254         }
 255
 256         /* REVISIT *require* function->bind? */
 257         if (function->bind) {
 258                 value = function->bind(config, function);
 259                 if (value < 0) {
 260                         list_del(&function->list);
 261                         function->config = NULL;
 262                 }
 263         } else
 264                 value = 0;
 265
 266         /* We allow configurations that don't work at both speeds.
 267          * If we run into a lowspeed Linux system, treat it the same
 268          * as full speed ... it's the function drivers that will need
 269          * to avoid bulk and ISO transfers.
 270          */
 271         if (!config->fullspeed && function->fs_descriptors)
 272                 config->fullspeed = true;
 273         if (!config->highspeed && function->hs_descriptors)
 274                 config->highspeed = true;
 275         if (!config->superspeed && function->ss_descriptors)
 276                 config->superspeed = true;
 277         if (!config->superspeed_plus && function->ssp_descriptors)
 278                 config->superspeed_plus = true;
 279
 280 done:
 281         if (value)
 282                 DBG(config->cdev, "adding '%s'/%p --> %d\n",
 283                                 function->name, function, value);
 284         return value;
 285 }
 286 EXPORT_SYMBOL_GPL(usb_add_function);
 287
 288 void usb_remove_function(struct usb_configuration *c, struct usb_function *f)
 289 {
 290         if (f->disable)
 291                 f->disable(f);
 292
 293         bitmap_zero(f->endpoints, 32);
 294         list_del(&f->list);
 295         if (f->unbind)
 296                 f->unbind(c, f);
 297 }
 298 EXPORT_SYMBOL_GPL(usb_remove_function);
 299
 300 /**
 301  * usb_function_deactivate - prevent function and gadget enumeration
 302  * @function: the function that isn't yet ready to respond
 303  *
 304  * Blocks response of the gadget driver to host enumeration by
 305  * preventing the data line pullup from being activated.  This is
 306  * normally called during @bind() processing to change from the
 307  * initial "ready to respond" state, or when a required resource
 308  * becomes available.
 309  *
 310  * For example, drivers that serve as a passthrough to a userspace
 311  * daemon can block enumeration unless that daemon (such as an OBEX,
 312  * MTP, or print server) is ready to handle host requests.
 313  *
 314  * Not all systems support software control of their USB peripheral
 315  * data pullups.
 316  *
 317  * Returns zero on success, else negative errno.
 318  */
 319 int usb_function_deactivate(struct usb_function *function)
 320 {
 321         struct usb_composite_dev        *cdev = function->config->cdev;
 322         unsigned long                   flags;
 323         int                             status = 0;
 324
 325         spin_lock_irqsave(&cdev->lock, flags);
 326
 327         if (cdev->deactivations == 0)
 328                 status = usb_gadget_deactivate(cdev->gadget);
 329         if (status == 0)
 330                 cdev->deactivations++;
 331
 332         spin_unlock_irqrestore(&cdev->lock, flags);
 333         return status;
 334 }
 335 EXPORT_SYMBOL_GPL(usb_function_deactivate);
 336
 337 /**
 338  * usb_function_activate - allow function and gadget enumeration
 339  * @function: function on which usb_function_activate() was called
 340  *
 341  * Reverses effect of usb_function_deactivate().  If no more functions
 342  * are delaying their activation, the gadget driver will respond to
 343  * host enumeration procedures.
 344  *
 345  * Returns zero on success, else negative errno.
 346  */
 347 int usb_function_activate(struct usb_function *function)
 348 {
 349         struct usb_composite_dev        *cdev = function->config->cdev;
 350         unsigned long                   flags;
 351         int                             status = 0;
 352
 353         spin_lock_irqsave(&cdev->lock, flags);
 354
 355         if (WARN_ON(cdev->deactivations == 0))
 356                 status = -EINVAL;
 357         else {
 358                 cdev->deactivations--;
 359                 if (cdev->deactivations == 0)
 360                         status = usb_gadget_activate(cdev->gadget);
 361         }
 362
 363         spin_unlock_irqrestore(&cdev->lock, flags);
 364         return status;
 365 }
 366 EXPORT_SYMBOL_GPL(usb_function_activate);
 367
 368 /**
 369  * usb_interface_id() - allocate an unused interface ID
 370  * @config: configuration associated with the interface
 371  * @function: function handling the interface
 372  * Context: single threaded during gadget setup
 373  *
 374  * usb_interface_id() is called from usb_function.bind() callbacks to
 375  * allocate new interface IDs.  The function driver will then store that
 376  * ID in interface, association, CDC union, and other descriptors.  It
 377  * will also handle any control requests targeted at that interface,
 378  * particularly changing its altsetting via set_alt().  There may
 379  * also be class-specific or vendor-specific requests to handle.
 380  *
 381  * All interface identifier should be allocated using this routine, to
 382  * ensure that for example different functions don't wrongly assign
 383  * different meanings to the same identifier.  Note that since interface
 384  * identifiers are configuration-specific, functions used in more than
 385  * one configuration (or more than once in a given configuration) need
 386  * multiple versions of the relevant descriptors.
 387  *
 388  * Returns the interface ID which was allocated; or -ENODEV if no
 389  * more interface IDs can be allocated.
 390  */
 391 int usb_interface_id(struct usb_configuration *config,
 392                 struct usb_function *function)
 393 {
 394         unsigned id = config->next_interface_id;
 395
 396         if (id < MAX_CONFIG_INTERFACES) {
 397                 config->interface[id] = function;
 398                 config->next_interface_id = id + 1;
 399                 return id;
 400         }
 401         return -ENODEV;
 402 }
 403 EXPORT_SYMBOL_GPL(usb_interface_id);
 404
 405 static u8 encode_bMaxPower(enum usb_device_speed speed,
 406                 struct usb_configuration *c)
 407 {
 408         unsigned val;
 409
 410         if (c->MaxPower)
 411                 val = c->MaxPower;
 412         else
 413                 val = CONFIG_USB_GADGET_VBUS_DRAW;
 414         if (!val)
 415                 return 0;
 416         switch (speed) {
 417         case USB_SPEED_SUPER:
 418                 return DIV_ROUND_UP(val, 8);
 419         default:
 420                 return DIV_ROUND_UP(val, 2);
 421         }
 422 }
 423
 424 static int config_buf(struct usb_configuration *config,
 425                 enum usb_device_speed speed, void *buf, u8 type)
 426 {
 427         struct usb_config_descriptor    *c = buf;
 428         void                            *next = buf + USB_DT_CONFIG_SIZE;
 429         int                             len;
 430         struct usb_function             *f;
 431         int                             status;
 432
 433         len = USB_COMP_EP0_BUFSIZ - USB_DT_CONFIG_SIZE;
 434         /* write the config descriptor */
 435         c = buf;
 436         c->bLength = USB_DT_CONFIG_SIZE;
 437         c->bDescriptorType = type;
 438         /* wTotalLength is written later */
 439         c->bNumInterfaces = config->next_interface_id;
 440         c->bConfigurationValue = config->bConfigurationValue;
 441         c->iConfiguration = config->iConfiguration;
 442         c->bmAttributes = USB_CONFIG_ATT_ONE | config->bmAttributes;
 443         c->bMaxPower = encode_bMaxPower(speed, config);
 444
 445         /* There may be e.g. OTG descriptors */
 446         if (config->descriptors) {
 447                 status = usb_descriptor_fillbuf(next, len,
 448                                 config->descriptors);
 449                 if (status < 0)
 450                         return status;
 451                 len -= status;
 452                 next += status;
 453         }
 454
 455         /* add each function's descriptors */
 456         list_for_each_entry(f, &config->functions, list) {
 457                 struct usb_descriptor_header **descriptors;
 458
 459                 descriptors = function_descriptors(f, speed);
 460                 if (!descriptors)
 461                         continue;
 462                 status = usb_descriptor_fillbuf(next, len,
 463                         (const struct usb_descriptor_header **) descriptors);
 464                 if (status < 0)
 465                         return status;
 466                 len -= status;
 467                 next += status;
 468         }
 469
 470         len = next - buf;
 471         c->wTotalLength = cpu_to_le16(len);
 472         return len;
 473 }
 474
 475 static int config_desc(struct usb_composite_dev *cdev, unsigned w_value)
 476 {
 477         struct usb_gadget               *gadget = cdev->gadget;
 478         struct usb_configuration        *c;
 479         struct list_head                *pos;
 480         u8                              type = w_value >> 8;
 481         enum usb_device_speed           speed = USB_SPEED_UNKNOWN;
 482
 483         if (gadget->speed >= USB_SPEED_SUPER)
 484                 speed = gadget->speed;
 485         else if (gadget_is_dualspeed(gadget)) {
 486                 int     hs = 0;
 487                 if (gadget->speed == USB_SPEED_HIGH)
 488                         hs = 1;
 489                 if (type == USB_DT_OTHER_SPEED_CONFIG)
 490                         hs = !hs;
 491                 if (hs)
 492                         speed = USB_SPEED_HIGH;
 493
 494         }
 495
 496         /* This is a lookup by config *INDEX* */
 497         w_value &= 0xff;
 498
 499         pos = &cdev->configs;
 500         c = cdev->os_desc_config;
 501         if (c)
 502                 goto check_config;
 503
 504         while ((pos = pos->next) !=  &cdev->configs) {
 505                 c = list_entry(pos, typeof(*c), list);
 506
 507                 /* skip OS Descriptors config which is handled separately */
 508                 if (c == cdev->os_desc_config)
 509                         continue;
 510
 511 check_config:
 512                 /* ignore configs that won't work at this speed */
 513                 switch (speed) {
 514                 case USB_SPEED_SUPER_PLUS:
 515                         if (!c->superspeed_plus)
 516                                 continue;
 517                         break;
 518                 case USB_SPEED_SUPER:
 519                         if (!c->superspeed)
 520                                 continue;
 521                         break;
 522                 case USB_SPEED_HIGH:
 523                         if (!c->highspeed)
 524                                 continue;
 525                         break;
 526                 default:
 527                         if (!c->fullspeed)
 528                                 continue;
 529                 }
 530
 531                 if (w_value == 0)
 532                         return config_buf(c, speed, cdev->req->buf, type);
 533                 w_value--;
 534         }
 535         return -EINVAL;
 536 }
 537
 538 static int count_configs(struct usb_composite_dev *cdev, unsigned type)
 539 {
 540         struct usb_gadget               *gadget = cdev->gadget;
 541         struct usb_configuration        *c;
 542         unsigned                        count = 0;
 543         int                             hs = 0;
 544         int                             ss = 0;
 545         int                             ssp = 0;
 546
 547         if (gadget_is_dualspeed(gadget)) {
 548                 if (gadget->speed == USB_SPEED_HIGH)
 549                         hs = 1;
 550                 if (gadget->speed == USB_SPEED_SUPER)
 551                         ss = 1;
 552                 if (gadget->speed == USB_SPEED_SUPER_PLUS)
 553                         ssp = 1;
 554                 if (type == USB_DT_DEVICE_QUALIFIER)
 555                         hs = !hs;
 556         }
 557         list_for_each_entry(c, &cdev->configs, list) {
 558                 /* ignore configs that won't work at this speed */
 559                 if (ssp) {
 560                         if (!c->superspeed_plus)
 561                                 continue;
 562                 } else if (ss) {
 563                         if (!c->superspeed)
 564                                 continue;
 565                 } else if (hs) {
 566                         if (!c->highspeed)
 567                                 continue;
 568                 } else {
 569                         if (!c->fullspeed)
 570                                 continue;
 571                 }
 572                 count++;
 573         }
 574         return count;
 575 }
 576
 577 /**
 578  * bos_desc() - prepares the BOS descriptor.
 579  * @cdev: pointer to usb_composite device to generate the bos
 580  *      descriptor for
 581  *
 582  * This function generates the BOS (Binary Device Object)
 583  * descriptor and its device capabilities descriptors. The BOS
 584  * descriptor should be supported by a SuperSpeed device.
 585  */
 586 static int bos_desc(struct usb_composite_dev *cdev)
 587 {
 588         struct usb_ext_cap_descriptor   *usb_ext;
 589         struct usb_ss_cap_descriptor    *ss_cap;
 590         struct usb_dcd_config_params    dcd_config_params;
 591         struct usb_bos_descriptor       *bos = cdev->req->buf;
 592
 593         bos->bLength = USB_DT_BOS_SIZE;
 594         bos->bDescriptorType = USB_DT_BOS;
 595
 596         bos->wTotalLength = cpu_to_le16(USB_DT_BOS_SIZE);
 597         bos->bNumDeviceCaps = 0;
 598
 599         /*
 600          * A SuperSpeed device shall include the USB2.0 extension descriptor
 601          * and shall support LPM when operating in USB2.0 HS mode.
 602          */
 603         usb_ext = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
 604         bos->bNumDeviceCaps++;
 605         le16_add_cpu(&bos->wTotalLength, USB_DT_USB_EXT_CAP_SIZE);
 606         usb_ext->bLength = USB_DT_USB_EXT_CAP_SIZE;
 607         usb_ext->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
 608         usb_ext->bDevCapabilityType = USB_CAP_TYPE_EXT;
 609         usb_ext->bmAttributes = cpu_to_le32(USB_LPM_SUPPORT | USB_BESL_SUPPORT);
 610
 611         /*
 612          * The Superspeed USB Capability descriptor shall be implemented by all
 613          * SuperSpeed devices.
 614          */
 615         ss_cap = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
 616         bos->bNumDeviceCaps++;
 617         le16_add_cpu(&bos->wTotalLength, USB_DT_USB_SS_CAP_SIZE);
 618         ss_cap->bLength = USB_DT_USB_SS_CAP_SIZE;
 619         ss_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
 620         ss_cap->bDevCapabilityType = USB_SS_CAP_TYPE;
 621         ss_cap->bmAttributes = 0; /* LTM is not supported yet */
 622         ss_cap->wSpeedSupported = cpu_to_le16(USB_LOW_SPEED_OPERATION |
 623                                 USB_FULL_SPEED_OPERATION |
 624                                 USB_HIGH_SPEED_OPERATION |
 625                                 USB_5GBPS_OPERATION);
 626         ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
 627
 628         /* Get Controller configuration */
 629         if (cdev->gadget->ops->get_config_params)
 630                 cdev->gadget->ops->get_config_params(&dcd_config_params);
 631         else {
 632                 dcd_config_params.bU1devExitLat = USB_DEFAULT_U1_DEV_EXIT_LAT;
 633                 dcd_config_params.bU2DevExitLat =
 634                         cpu_to_le16(USB_DEFAULT_U2_DEV_EXIT_LAT);
 635         }
 636         ss_cap->bU1devExitLat = dcd_config_params.bU1devExitLat;
 637         ss_cap->bU2DevExitLat = dcd_config_params.bU2DevExitLat;
 638
 639         /* The SuperSpeedPlus USB Device Capability descriptor */
 640         if (gadget_is_superspeed_plus(cdev->gadget)) {
 641                 struct usb_ssp_cap_descriptor *ssp_cap;
 642
 643                 ssp_cap = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
 644                 bos->bNumDeviceCaps++;
 645
 646                 /*
 647                  * Report typical values.
 648                  */
 649
 650                 le16_add_cpu(&bos->wTotalLength, USB_DT_USB_SSP_CAP_SIZE(1));
 651                 ssp_cap->bLength = USB_DT_USB_SSP_CAP_SIZE(1);
 652                 ssp_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
 653                 ssp_cap->bDevCapabilityType = USB_SSP_CAP_TYPE;
 654
 655                 /* SSAC = 1 (2 attributes) */
 656                 ssp_cap->bmAttributes = cpu_to_le32(1);
 657
 658                 /* Min RX/TX Lane Count = 1 */
 659                 ssp_cap->wFunctionalitySupport = (1 << 8) | (1 << 12);
 660
 661                 /*
 662                  * bmSublinkSpeedAttr[0]:
 663                  *   ST  = Symmetric, RX
 664                  *   LSE =  3 (Gbps)
 665                  *   LP  =  1 (SuperSpeedPlus)
 666                  *   LSM = 10 (10 Gbps)
 667                  */
 668                 ssp_cap->bmSublinkSpeedAttr[0] =
 669                         (3 << 4) | (1 << 14) | (0xa << 16);
 670                 /*
 671                  * bmSublinkSpeedAttr[1] =
 672                  *   ST  = Symmetric, TX
 673                  *   LSE =  3 (Gbps)
 674                  *   LP  =  1 (SuperSpeedPlus)
 675                  *   LSM = 10 (10 Gbps)
 676                  */
 677                 ssp_cap->bmSublinkSpeedAttr[1] =
 678                         (3 << 4) | (1 << 14) | (0xa << 16) | (1 << 7);
 679         }
 680
 681         return le16_to_cpu(bos->wTotalLength);
 682 }
 683
 684 static void device_qual(struct usb_composite_dev *cdev)
 685 {
 686         struct usb_qualifier_descriptor *qual = cdev->req->buf;
 687
 688         qual->bLength = sizeof(*qual);
 689         qual->bDescriptorType = USB_DT_DEVICE_QUALIFIER;
 690         /* POLICY: same bcdUSB and device type info at both speeds */
 691         qual->bcdUSB = cdev->desc.bcdUSB;
 692         qual->bDeviceClass = cdev->desc.bDeviceClass;
 693         qual->bDeviceSubClass = cdev->desc.bDeviceSubClass;
 694         qual->bDeviceProtocol = cdev->desc.bDeviceProtocol;
 695         /* ASSUME same EP0 fifo size at both speeds */
 696         qual->bMaxPacketSize0 = cdev->gadget->ep0->maxpacket;
 697         qual->bNumConfigurations = count_configs(cdev, USB_DT_DEVICE_QUALIFIER);
 698         qual->bRESERVED = 0;
 699 }
 700
 701 /*-------------------------------------------------------------------------*/
 702
 703 static void reset_config(struct usb_composite_dev *cdev)
 704 {
 705         struct usb_function             *f;
 706
 707         DBG(cdev, "reset config\n");
 708
 709         list_for_each_entry(f, &cdev->config->functions, list) {
 710                 if (f->disable)
 711                         f->disable(f);
 712
 713                 bitmap_zero(f->endpoints, 32);
 714         }
 715         cdev->config = NULL;
 716         cdev->delayed_status = 0;
 717 }
 718
 719 static int set_config(struct usb_composite_dev *cdev,
 720                 const struct usb_ctrlrequest *ctrl, unsigned number)
 721 {
 722         struct usb_gadget       *gadget = cdev->gadget;
 723         struct usb_configuration *c = NULL;
 724         int                     result = -EINVAL;
 725         unsigned                power = gadget_is_otg(gadget) ? 8 : 100;
 726         int                     tmp;
 727
 728         if (number) {
 729                 list_for_each_entry(c, &cdev->configs, list) {
 730                         if (c->bConfigurationValue == number) {
 731                                 /*
 732                                  * We disable the FDs of the previous
 733                                  * configuration only if the new configuration
 734                                  * is a valid one
 735                                  */
 736                                 if (cdev->config)
 737                                         reset_config(cdev);
 738                                 result = 0;
 739                                 break;
 740                         }
 741                 }
 742                 if (result < 0)
 743                         goto done;
 744         } else { /* Zero configuration value - need to reset the config */
 745                 if (cdev->config)
 746                         reset_config(cdev);
 747                 result = 0;
 748         }
 749
 750         INFO(cdev, "%s config #%d: %s\n",
 751              usb_speed_string(gadget->speed),
 752              number, c ? c->label : "unconfigured");
 753
 754         if (!c)
 755                 goto done;
 756
 757         usb_gadget_set_state(gadget, USB_STATE_CONFIGURED);
 758         cdev->config = c;
 759
 760         /* Initialize all interfaces by setting them to altsetting zero. */
 761         for (tmp = 0; tmp < MAX_CONFIG_INTERFACES; tmp++) {
 762                 struct usb_function     *f = c->interface[tmp];
 763                 struct usb_descriptor_header **descriptors;
 764
 765                 if (!f)
 766                         break;
 767
 768                 /*
 769                  * Record which endpoints are used by the function. This is used
 770                  * to dispatch control requests targeted at that endpoint to the
 771                  * function's setup callback instead of the current
 772                  * configuration's setup callback.
 773                  */
 774                 descriptors = function_descriptors(f, gadget->speed);
 775
 776                 for (; *descriptors; ++descriptors) {
 777                         struct usb_endpoint_descriptor *ep;
 778                         int addr;
 779
 780                         if ((*descriptors)->bDescriptorType != USB_DT_ENDPOINT)
 781                                 continue;
 782
 783                         ep = (struct usb_endpoint_descriptor *)*descriptors;
 784                         addr = ((ep->bEndpointAddress & 0x80) >> 3)
 785                              |  (ep->bEndpointAddress & 0x0f);
 786                         set_bit(addr, f->endpoints);
 787                 }
 788
 789                 result = f->set_alt(f, tmp, 0);
 790                 if (result < 0) {
 791                         DBG(cdev, "interface %d (%s/%p) alt 0 --> %d\n",
 792                                         tmp, f->name, f, result);
 793
 794                         reset_config(cdev);
 795                         goto done;
 796                 }
 797
 798                 if (result == USB_GADGET_DELAYED_STATUS) {
 799                         DBG(cdev,
 800                          "%s: interface %d (%s) requested delayed status\n",
 801                                         __func__, tmp, f->name);
 802                         cdev->delayed_status++;
 803                         DBG(cdev, "delayed_status count %d\n",
 804                                         cdev->delayed_status);
 805                 }
 806         }
 807
 808         /* when we return, be sure our power usage is valid */
 809         power = c->MaxPower ? c->MaxPower : CONFIG_USB_GADGET_VBUS_DRAW;
 810 done:
 811         usb_gadget_vbus_draw(gadget, power);
 812         if (result >= 0 && cdev->delayed_status)
 813                 result = USB_GADGET_DELAYED_STATUS;
 814         return result;
 815 }
 816
 817 int usb_add_config_only(struct usb_composite_dev *cdev,
 818                 struct usb_configuration *config)
 819 {
 820         struct usb_configuration *c;
 821
 822         if (!config->bConfigurationValue)
 823                 return -EINVAL;
 824
 825         /* Prevent duplicate configuration identifiers */
 826         list_for_each_entry(c, &cdev->configs, list) {
 827                 if (c->bConfigurationValue == config->bConfigurationValue)
 828                         return -EBUSY;
 829         }
 830
 831         config->cdev = cdev;
 832         list_add_tail(&config->list, &cdev->configs);
 833
 834         INIT_LIST_HEAD(&config->functions);
 835         config->next_interface_id = 0;
 836         memset(config->interface, 0, sizeof(config->interface));
 837
 838         return 0;
 839 }
 840 EXPORT_SYMBOL_GPL(usb_add_config_only);
 841
 842 /**
 843  * usb_add_config() - add a configuration to a device.
 844  * @cdev: wraps the USB gadget
 845  * @config: the configuration, with bConfigurationValue assigned
 846  * @bind: the configuration's bind function
 847  * Context: single threaded during gadget setup
 848  *
 849  * One of the main tasks of a composite @bind() routine is to
 850  * add each of the configurations it supports, using this routine.
 851  *
 852  * This function returns the value of the configuration's @bind(), which
 853  * is zero for success else a negative errno value.  Binding configurations
 854  * assigns global resources including string IDs, and per-configuration
 855  * resources such as interface IDs and endpoints.
 856  */
 857 int usb_add_config(struct usb_composite_dev *cdev,
 858                 struct usb_configuration *config,
 859                 int (*bind)(struct usb_configuration *))
 860 {
 861         int                             status = -EINVAL;
 862
 863         if (!bind)
 864                 goto done;
 865
 866         DBG(cdev, "adding config #%u '%s'/%p\n",
 867                         config->bConfigurationValue,
 868                         config->label, config);
 869
 870         status = usb_add_config_only(cdev, config);
 871         if (status)
 872                 goto done;
 873
 874         status = bind(config);
 875         if (status < 0) {
 876                 while (!list_empty(&config->functions)) {
 877                         struct usb_function             *f;
 878
 879                         f = list_first_entry(&config->functions,
 880                                         struct usb_function, list);
 881                         list_del(&f->list);
 882                         if (f->unbind) {
 883                                 DBG(cdev, "unbind function '%s'/%p\n",
 884                                         f->name, f);
 885                                 f->unbind(config, f);
 886                                 /* may free memory for "f" */
 887                         }
 888                 }
 889                 list_del(&config->list);
 890                 config->cdev = NULL;
 891         } else {
 892                 unsigned        i;
 893
 894                 DBG(cdev, "cfg %d/%p speeds:%s%s%s%s\n",
 895                         config->bConfigurationValue, config,
 896                         config->superspeed_plus ? " superplus" : "",
 897                         config->superspeed ? " super" : "",
 898                         config->highspeed ? " high" : "",
 899                         config->fullspeed
 900                                 ? (gadget_is_dualspeed(cdev->gadget)
 901                                         ? " full"
 902                                         : " full/low")
 903                                 : "");
 904
 905                 for (i = 0; i < MAX_CONFIG_INTERFACES; i++) {
 906                         struct usb_function     *f = config->interface[i];
 907
 908                         if (!f)
 909                                 continue;
 910                         DBG(cdev, "  interface %d = %s/%p\n",
 911                                 i, f->name, f);
 912                 }
 913         }
 914
 915         /* set_alt(), or next bind(), sets up ep->claimed as needed */
 916         usb_ep_autoconfig_reset(cdev->gadget);
 917
 918 done:
 919         if (status)
 920                 DBG(cdev, "added config '%s'/%u --> %d\n", config->label,
 921                                 config->bConfigurationValue, status);
 922         return status;
 923 }
 924 EXPORT_SYMBOL_GPL(usb_add_config);
 925
 926 static void remove_config(struct usb_composite_dev *cdev,
 927                               struct usb_configuration *config)
 928 {
 929         while (!list_empty(&config->functions)) {
 930                 struct usb_function             *f;
 931
 932                 f = list_first_entry(&config->functions,
 933                                 struct usb_function, list);
 934                 list_del(&f->list);
 935                 if (f->unbind) {
 936                         DBG(cdev, "unbind function '%s'/%p\n", f->name, f);
 937                         f->unbind(config, f);
 938                         /* may free memory for "f" */
 939                 }
 940         }
 941         list_del(&config->list);
 942         if (config->unbind) {
 943                 DBG(cdev, "unbind config '%s'/%p\n", config->label, config);
 944                 config->unbind(config);
 945                         /* may free memory for "c" */
 946         }
 947 }
 948
 949 /**
 950  * usb_remove_config() - remove a configuration from a device.
 951  * @cdev: wraps the USB gadget
 952  * @config: the configuration
 953  *
 954  * Drivers must call usb_gadget_disconnect before calling this function
 955  * to disconnect the device from the host and make sure the host will not
 956  * try to enumerate the device while we are changing the config list.
 957  */
 958 void usb_remove_config(struct usb_composite_dev *cdev,
 959                       struct usb_configuration *config)
 960 {
 961         unsigned long flags;
 962
 963         spin_lock_irqsave(&cdev->lock, flags);
 964
 965         if (cdev->config == config)
 966                 reset_config(cdev);
 967
 968         spin_unlock_irqrestore(&cdev->lock, flags);
 969
 970         remove_config(cdev, config);
 971 }
 972
 973 /*-------------------------------------------------------------------------*/
 974
 975 /* We support strings in multiple languages ... string descriptor zero
 976  * says which languages are supported.  The typical case will be that
 977  * only one language (probably English) is used, with i18n handled on
 978  * the host side.
 979  */
 980
 981 static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf)
 982 {
 983         const struct usb_gadget_strings *s;
 984         __le16                          language;
 985         __le16                          *tmp;
 986
 987         while (*sp) {
 988                 s = *sp;
 989                 language = cpu_to_le16(s->language);
 990                 for (tmp = buf; *tmp && tmp < &buf[126]; tmp++) {
 991                         if (*tmp == language)
 992                                 goto repeat;
 993                 }
 994                 *tmp++ = language;
 995 repeat:
 996                 sp++;
 997         }
 998 }
 999
1000 static int lookup_string(
1001         struct usb_gadget_strings       **sp,
1002         void                            *buf,
1003         u16                             language,
1004         int                             id
1005 )
1006 {
1007         struct usb_gadget_strings       *s;
1008         int                             value;
1009
1010         while (*sp) {
1011                 s = *sp++;
1012                 if (s->language != language)
1013                         continue;
1014                 value = usb_gadget_get_string(s, id, buf);
1015                 if (value > 0)
1016                         return value;
1017         }
1018         return -EINVAL;
1019 }
1020
1021 static int get_string(struct usb_composite_dev *cdev,
1022                 void *buf, u16 language, int id)
1023 {
1024         struct usb_composite_driver     *composite = cdev->driver;
1025         struct usb_gadget_string_container *uc;
1026         struct usb_configuration        *c;
1027         struct usb_function             *f;
1028         int                             len;
1029
1030         /* Yes, not only is USB's i18n support probably more than most
1031          * folk will ever care about ... also, it's all supported here.
1032          * (Except for UTF8 support for Unicode's "Astral Planes".)
1033          */
1034
1035         /* 0 == report all available language codes */
1036         if (id == 0) {
1037                 struct usb_string_descriptor    *s = buf;
1038                 struct usb_gadget_strings       **sp;
1039
1040                 memset(s, 0, 256);
1041                 s->bDescriptorType = USB_DT_STRING;
1042
1043                 sp = composite->strings;
1044                 if (sp)
1045                         collect_langs(sp, s->wData);
1046
1047                 list_for_each_entry(c, &cdev->configs, list) {
1048                         sp = c->strings;
1049                         if (sp)
1050                                 collect_langs(sp, s->wData);
1051
1052                         list_for_each_entry(f, &c->functions, list) {
1053                                 sp = f->strings;
1054                                 if (sp)
1055                                         collect_langs(sp, s->wData);
1056                         }
1057                 }
1058                 list_for_each_entry(uc, &cdev->gstrings, list) {
1059                         struct usb_gadget_strings **sp;
1060
1061                         sp = get_containers_gs(uc);
1062                         collect_langs(sp, s->wData);
1063                 }
1064
1065                 for (len = 0; len <= 126 && s->wData[len]; len++)
1066                         continue;
1067                 if (!len)
1068                         return -EINVAL;
1069
1070                 s->bLength = 2 * (len + 1);
1071                 return s->bLength;
1072         }
1073
1074         if (cdev->use_os_string && language == 0 && id == OS_STRING_IDX) {
1075                 struct usb_os_string *b = buf;
1076                 b->bLength = sizeof(*b);
1077                 b->bDescriptorType = USB_DT_STRING;
1078                 compiletime_assert(
1079                         sizeof(b->qwSignature) == sizeof(cdev->qw_sign),
1080                         "qwSignature size must be equal to qw_sign");
1081                 memcpy(&b->qwSignature, cdev->qw_sign, sizeof(b->qwSignature));
1082                 b->bMS_VendorCode = cdev->b_vendor_code;
1083                 b->bPad = 0;
1084                 return sizeof(*b);
1085         }
1086
1087         list_for_each_entry(uc, &cdev->gstrings, list) {
1088                 struct usb_gadget_strings **sp;
1089
1090                 sp = get_containers_gs(uc);
1091                 len = lookup_string(sp, buf, language, id);
1092                 if (len > 0)
1093                         return len;
1094         }
1095
1096         /* String IDs are device-scoped, so we look up each string
1097          * table we're told about.  These lookups are infrequent;
1098          * simpler-is-better here.
1099          */
1100         if (composite->strings) {
1101                 len = lookup_string(composite->strings, buf, language, id);
1102                 if (len > 0)
1103                         return len;
1104         }
1105         list_for_each_entry(c, &cdev->configs, list) {
1106                 if (c->strings) {
1107                         len = lookup_string(c->strings, buf, language, id);
1108                         if (len > 0)
1109                                 return len;
1110                 }
1111                 list_for_each_entry(f, &c->functions, list) {
1112                         if (!f->strings)
1113                                 continue;
1114                         len = lookup_string(f->strings, buf, language, id);
1115                         if (len > 0)
1116                                 return len;
1117                 }
1118         }
1119         return -EINVAL;
1120 }
1121
1122 /**
1123  * usb_string_id() - allocate an unused string ID
1124  * @cdev: the device whose string descriptor IDs are being allocated
1125  * Context: single threaded during gadget setup
1126  *
1127  * @usb_string_id() is called from bind() callbacks to allocate
1128  * string IDs.  Drivers for functions, configurations, or gadgets will
1129  * then store that ID in the appropriate descriptors and string table.
1130  *
1131  * All string identifier should be allocated using this,
1132  * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure
1133  * that for example different functions don't wrongly assign different
1134  * meanings to the same identifier.
1135  */
1136 int usb_string_id(struct usb_composite_dev *cdev)
1137 {
1138         if (cdev->next_string_id < 254) {
1139                 /* string id 0 is reserved by USB spec for list of
1140                  * supported languages */
1141                 /* 255 reserved as well? -- mina86 */
1142                 cdev->next_string_id++;
1143                 return cdev->next_string_id;
1144         }
1145         return -ENODEV;
1146 }
1147 EXPORT_SYMBOL_GPL(usb_string_id);
1148
1149 /**
1150  * usb_string_ids() - allocate unused string IDs in batch
1151  * @cdev: the device whose string descriptor IDs are being allocated
1152  * @str: an array of usb_string objects to assign numbers to
1153  * Context: single threaded during gadget setup
1154  *
1155  * @usb_string_ids() is called from bind() callbacks to allocate
1156  * string IDs.  Drivers for functions, configurations, or gadgets will
1157  * then copy IDs from the string table to the appropriate descriptors
1158  * and string table for other languages.
1159  *
1160  * All string identifier should be allocated using this,
1161  * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1162  * example different functions don't wrongly assign different meanings
1163  * to the same identifier.
1164  */
1165 int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str)
1166 {
1167         int next = cdev->next_string_id;
1168
1169         for (; str->s; ++str) {
1170                 if (unlikely(next >= 254))
1171                         return -ENODEV;
1172                 str->id = ++next;
1173         }
1174
1175         cdev->next_string_id = next;
1176
1177         return 0;
1178 }
1179 EXPORT_SYMBOL_GPL(usb_string_ids_tab);
1180
1181 static struct usb_gadget_string_container *copy_gadget_strings(
1182                 struct usb_gadget_strings **sp, unsigned n_gstrings,
1183                 unsigned n_strings)
1184 {
1185         struct usb_gadget_string_container *uc;
1186         struct usb_gadget_strings **gs_array;
1187         struct usb_gadget_strings *gs;
1188         struct usb_string *s;
1189         unsigned mem;
1190         unsigned n_gs;
1191         unsigned n_s;
1192         void *stash;
1193
1194         mem = sizeof(*uc);
1195         mem += sizeof(void *) * (n_gstrings + 1);
1196         mem += sizeof(struct usb_gadget_strings) * n_gstrings;
1197         mem += sizeof(struct usb_string) * (n_strings + 1) * (n_gstrings);
1198         uc = kmalloc(mem, GFP_KERNEL);
1199         if (!uc)
1200                 return ERR_PTR(-ENOMEM);
1201         gs_array = get_containers_gs(uc);
1202         stash = uc->stash;
1203         stash += sizeof(void *) * (n_gstrings + 1);
1204         for (n_gs = 0; n_gs < n_gstrings; n_gs++) {
1205                 struct usb_string *org_s;
1206
1207                 gs_array[n_gs] = stash;
1208                 gs = gs_array[n_gs];
1209                 stash += sizeof(struct usb_gadget_strings);
1210                 gs->language = sp[n_gs]->language;
1211                 gs->strings = stash;
1212                 org_s = sp[n_gs]->strings;
1213
1214                 for (n_s = 0; n_s < n_strings; n_s++) {
1215                         s = stash;
1216                         stash += sizeof(struct usb_string);
1217                         if (org_s->s)
1218                                 s->s = org_s->s;
1219                         else
1220                                 s->s = "";
1221                         org_s++;
1222                 }
1223                 s = stash;
1224                 s->s = NULL;
1225                 stash += sizeof(struct usb_string);
1226
1227         }
1228         gs_array[n_gs] = NULL;
1229         return uc;
1230 }
1231
1232 /**
1233  * usb_gstrings_attach() - attach gadget strings to a cdev and assign ids
1234  * @cdev: the device whose string descriptor IDs are being allocated
1235  * and attached.
1236  * @sp: an array of usb_gadget_strings to attach.
1237  * @n_strings: number of entries in each usb_strings array (sp[]->strings)
1238  *
1239  * This function will create a deep copy of usb_gadget_strings and usb_string
1240  * and attach it to the cdev. The actual string (usb_string.s) will not be
1241  * copied but only a referenced will be made. The struct usb_gadget_strings
1242  * array may contain multiple languages and should be NULL terminated.
1243  * The ->language pointer of each struct usb_gadget_strings has to contain the
1244  * same amount of entries.
1245  * For instance: sp[0] is en-US, sp[1] is es-ES. It is expected that the first
1246  * usb_string entry of es-ES contains the translation of the first usb_string
1247  * entry of en-US. Therefore both entries become the same id assign.
1248  */
1249 struct usb_string *usb_gstrings_attach(struct usb_composite_dev *cdev,
1250                 struct usb_gadget_strings **sp, unsigned n_strings)
1251 {
1252         struct usb_gadget_string_container *uc;
1253         struct usb_gadget_strings **n_gs;
1254         unsigned n_gstrings = 0;
1255         unsigned i;
1256         int ret;
1257
1258         for (i = 0; sp[i]; i++)
1259                 n_gstrings++;
1260
1261         if (!n_gstrings)
1262                 return ERR_PTR(-EINVAL);
1263
1264         uc = copy_gadget_strings(sp, n_gstrings, n_strings);
1265         if (IS_ERR(uc))
1266                 return ERR_CAST(uc);
1267
1268         n_gs = get_containers_gs(uc);
1269         ret = usb_string_ids_tab(cdev, n_gs[0]->strings);
1270         if (ret)
1271                 goto err;
1272
1273         for (i = 1; i < n_gstrings; i++) {
1274                 struct usb_string *m_s;
1275                 struct usb_string *s;
1276                 unsigned n;
1277
1278                 m_s = n_gs[0]->strings;
1279                 s = n_gs[i]->strings;
1280                 for (n = 0; n < n_strings; n++) {
1281                         s->id = m_s->id;
1282                         s++;
1283                         m_s++;
1284                 }
1285         }
1286         list_add_tail(&uc->list, &cdev->gstrings);
1287         return n_gs[0]->strings;
1288 err:
1289         kfree(uc);
1290         return ERR_PTR(ret);
1291 }
1292 EXPORT_SYMBOL_GPL(usb_gstrings_attach);
1293
1294 /**
1295  * usb_string_ids_n() - allocate unused string IDs in batch
1296  * @c: the device whose string descriptor IDs are being allocated
1297  * @n: number of string IDs to allocate
1298  * Context: single threaded during gadget setup
1299  *
1300  * Returns the first requested ID.  This ID and next @n-1 IDs are now
1301  * valid IDs.  At least provided that @n is non-zero because if it
1302  * is, returns last requested ID which is now very useful information.
1303  *
1304  * @usb_string_ids_n() is called from bind() callbacks to allocate
1305  * string IDs.  Drivers for functions, configurations, or gadgets will
1306  * then store that ID in the appropriate descriptors and string table.
1307  *
1308  * All string identifier should be allocated using this,
1309  * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1310  * example different functions don't wrongly assign different meanings
1311  * to the same identifier.
1312  */
1313 int usb_string_ids_n(struct usb_composite_dev *c, unsigned n)
1314 {
1315         unsigned next = c->next_string_id;
1316         if (unlikely(n > 254 || (unsigned)next + n > 254))
1317                 return -ENODEV;
1318         c->next_string_id += n;
1319         return next + 1;
1320 }
1321 EXPORT_SYMBOL_GPL(usb_string_ids_n);
1322
1323 /*-------------------------------------------------------------------------*/
1324
1325 static void composite_setup_complete(struct usb_ep *ep, struct usb_request *req)
1326 {
1327         struct usb_composite_dev *cdev;
1328
1329         if (req->status || req->actual != req->length)
1330                 DBG((struct usb_composite_dev *) ep->driver_data,
1331                                 "setup complete --> %d, %d/%d\n",
1332                                 req->status, req->actual, req->length);
1333
1334         /*
1335          * REVIST The same ep0 requests are shared with function drivers
1336          * so they don't have to maintain the same ->complete() stubs.
1337          *
1338          * Because of that, we need to check for the validity of ->context
1339          * here, even though we know we've set it to something useful.
1340          */
1341         if (!req->context)
1342                 return;
1343
1344         cdev = req->context;
1345
1346         if (cdev->req == req)
1347                 cdev->setup_pending = false;
1348         else if (cdev->os_desc_req == req)
1349                 cdev->os_desc_pending = false;
1350         else
1351                 WARN(1, "unknown request %p\n", req);
1352 }
1353
1354 static int composite_ep0_queue(struct usb_composite_dev *cdev,
1355                 struct usb_request *req, gfp_t gfp_flags)
1356 {
1357         int ret;
1358
1359         ret = usb_ep_queue(cdev->gadget->ep0, req, gfp_flags);
1360         if (ret == 0) {
1361                 if (cdev->req == req)
1362                         cdev->setup_pending = true;
1363                 else if (cdev->os_desc_req == req)
1364                         cdev->os_desc_pending = true;
1365                 else
1366                         WARN(1, "unknown request %p\n", req);
1367         }
1368
1369         return ret;
1370 }
1371
1372 static int count_ext_compat(struct usb_configuration *c)
1373 {
1374         int i, res;
1375
1376         res = 0;
1377         for (i = 0; i < c->next_interface_id; ++i) {
1378                 struct usb_function *f;
1379                 int j;
1380
1381                 f = c->interface[i];
1382                 for (j = 0; j < f->os_desc_n; ++j) {
1383                         struct usb_os_desc *d;
1384
1385                         if (i != f->os_desc_table[j].if_id)
1386                                 continue;
1387                         d = f->os_desc_table[j].os_desc;
1388                         if (d && d->ext_compat_id)
1389                                 ++res;
1390                 }
1391         }
1392         BUG_ON(res > 255);
1393         return res;
1394 }
1395
1396 static void fill_ext_compat(struct usb_configuration *c, u8 *buf)
1397 {
1398         int i, count;
1399
1400         count = 16;
1401         for (i = 0; i < c->next_interface_id; ++i) {
1402                 struct usb_function *f;
1403                 int j;
1404
1405                 f = c->interface[i];
1406                 for (j = 0; j < f->os_desc_n; ++j) {
1407                         struct usb_os_desc *d;
1408
1409                         if (i != f->os_desc_table[j].if_id)
1410                                 continue;
1411                         d = f->os_desc_table[j].os_desc;
1412                         if (d && d->ext_compat_id) {
1413                                 *buf++ = i;
1414                                 *buf++ = 0x01;
1415                                 memcpy(buf, d->ext_compat_id, 16);
1416                                 buf += 22;
1417                         } else {
1418                                 ++buf;
1419                                 *buf = 0x01;
1420                                 buf += 23;
1421                         }
1422                         count += 24;
1423                         if (count >= 4096)
1424                                 return;
1425                 }
1426         }
1427 }
1428
1429 static int count_ext_prop(struct usb_configuration *c, int interface)
1430 {
1431         struct usb_function *f;
1432         int j;
1433
1434         f = c->interface[interface];
1435         for (j = 0; j < f->os_desc_n; ++j) {
1436                 struct usb_os_desc *d;
1437
1438                 if (interface != f->os_desc_table[j].if_id)
1439                         continue;
1440                 d = f->os_desc_table[j].os_desc;
1441                 if (d && d->ext_compat_id)
1442                         return d->ext_prop_count;
1443         }
1444         return 0;
1445 }
1446
1447 static int len_ext_prop(struct usb_configuration *c, int interface)
1448 {
1449         struct usb_function *f;
1450         struct usb_os_desc *d;
1451         int j, res;
1452
1453         res = 10; /* header length */
1454         f = c->interface[interface];
1455         for (j = 0; j < f->os_desc_n; ++j) {
1456                 if (interface != f->os_desc_table[j].if_id)
1457                         continue;
1458                 d = f->os_desc_table[j].os_desc;
1459                 if (d)
1460                         return min(res + d->ext_prop_len, 4096);
1461         }
1462         return res;
1463 }
1464
1465 static int fill_ext_prop(struct usb_configuration *c, int interface, u8 *buf)
1466 {
1467         struct usb_function *f;
1468         struct usb_os_desc *d;
1469         struct usb_os_desc_ext_prop *ext_prop;
1470         int j, count, n, ret;
1471         u8 *start = buf;
1472
1473         f = c->interface[interface];
1474         for (j = 0; j < f->os_desc_n; ++j) {
1475                 if (interface != f->os_desc_table[j].if_id)
1476                         continue;
1477                 d = f->os_desc_table[j].os_desc;
1478                 if (d)
1479                         list_for_each_entry(ext_prop, &d->ext_prop, entry) {
1480                                 /* 4kB minus header length */
1481                                 n = buf - start;
1482                                 if (n >= 4086)
1483                                         return 0;
1484
1485                                 count = ext_prop->data_len +
1486                                         ext_prop->name_len + 14;
1487                                 if (count > 4086 - n)
1488                                         return -EINVAL;
1489                                 usb_ext_prop_put_size(buf, count);
1490                                 usb_ext_prop_put_type(buf, ext_prop->type);
1491                                 ret = usb_ext_prop_put_name(buf, ext_prop->name,
1492                                                             ext_prop->name_len);
1493                                 if (ret < 0)
1494                                         return ret;
1495                                 switch (ext_prop->type) {
1496                                 case USB_EXT_PROP_UNICODE:
1497                                 case USB_EXT_PROP_UNICODE_ENV:
1498                                 case USB_EXT_PROP_UNICODE_LINK:
1499                                         usb_ext_prop_put_unicode(buf, ret,
1500                                                          ext_prop->data,
1501                                                          ext_prop->data_len);
1502                                         break;
1503                                 case USB_EXT_PROP_BINARY:
1504                                         usb_ext_prop_put_binary(buf, ret,
1505                                                         ext_prop->data,
1506                                                         ext_prop->data_len);
1507                                         break;
1508                                 case USB_EXT_PROP_LE32:
1509                                         /* not implemented */
1510                                 case USB_EXT_PROP_BE32:
1511                                         /* not implemented */
1512                                 default:
1513                                         return -EINVAL;
1514                                 }
1515                                 buf += count;
1516                         }
1517         }
1518
1519         return 0;
1520 }
1521
1522 /*
1523  * The setup() callback implements all the ep0 functionality that's
1524  * not handled lower down, in hardware or the hardware driver(like
1525  * device and endpoint feature flags, and their status).  It's all
1526  * housekeeping for the gadget function we're implementing.  Most of
1527  * the work is in config and function specific setup.
1528  */
1529 int
1530 composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1531 {
1532         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
1533         struct usb_request              *req = cdev->req;
1534         int                             value = -EOPNOTSUPP;
1535         int                             status = 0;
1536         u16                             w_index = le16_to_cpu(ctrl->wIndex);
1537         u8                              intf = w_index & 0xFF;
1538         u16                             w_value = le16_to_cpu(ctrl->wValue);
1539         u16                             w_length = le16_to_cpu(ctrl->wLength);
1540         struct usb_function             *f = NULL;
1541         u8                              endp;
1542
1543         /* partial re-init of the response message; the function or the
1544          * gadget might need to intercept e.g. a control-OUT completion
1545          * when we delegate to it.
1546          */
1547         req->zero = 0;
1548         req->context = cdev;
1549         req->complete = composite_setup_complete;
1550         req->length = 0;
1551         gadget->ep0->driver_data = cdev;
1552
1553         /*
1554          * Don't let non-standard requests match any of the cases below
1555          * by accident.
1556          */
1557         if ((ctrl->bRequestType & USB_TYPE_MASK) != USB_TYPE_STANDARD)
1558                 goto unknown;
1559
1560         switch (ctrl->bRequest) {
1561
1562         /* we handle all standard USB descriptors */
1563         case USB_REQ_GET_DESCRIPTOR:
1564                 if (ctrl->bRequestType != USB_DIR_IN)
1565                         goto unknown;
1566                 switch (w_value >> 8) {
1567
1568                 case USB_DT_DEVICE:
1569                         cdev->desc.bNumConfigurations =
1570                                 count_configs(cdev, USB_DT_DEVICE);
1571                         cdev->desc.bMaxPacketSize0 =
1572                                 cdev->gadget->ep0->maxpacket;
1573                         if (gadget_is_superspeed(gadget)) {
1574                                 if (gadget->speed >= USB_SPEED_SUPER) {
1575                                         cdev->desc.bcdUSB = cpu_to_le16(0x0310);
1576                                         cdev->desc.bMaxPacketSize0 = 9;
1577                                 } else {
1578                                         cdev->desc.bcdUSB = cpu_to_le16(0x0210);
1579                                 }
1580                         } else {
1581                                 cdev->desc.bcdUSB = cpu_to_le16(0x0200);
1582                         }
1583
1584                         value = min(w_length, (u16) sizeof cdev->desc);
1585                         memcpy(req->buf, &cdev->desc, value);
1586                         break;
1587                 case USB_DT_DEVICE_QUALIFIER:
1588                         if (!gadget_is_dualspeed(gadget) ||
1589                             gadget->speed >= USB_SPEED_SUPER)
1590                                 break;
1591                         device_qual(cdev);
1592                         value = min_t(int, w_length,
1593                                 sizeof(struct usb_qualifier_descriptor));
1594                         break;
1595                 case USB_DT_OTHER_SPEED_CONFIG:
1596                         if (!gadget_is_dualspeed(gadget) ||
1597                             gadget->speed >= USB_SPEED_SUPER)
1598                                 break;
1599                         /* FALLTHROUGH */
1600                 case USB_DT_CONFIG:
1601                         value = config_desc(cdev, w_value);
1602                         if (value >= 0)
1603                                 value = min(w_length, (u16) value);
1604                         break;
1605                 case USB_DT_STRING:
1606                         value = get_string(cdev, req->buf,
1607                                         w_index, w_value & 0xff);
1608                         if (value >= 0)
1609                                 value = min(w_length, (u16) value);
1610                         break;
1611                 case USB_DT_BOS:
1612                         if (gadget_is_superspeed(gadget)) {
1613                                 value = bos_desc(cdev);
1614                                 value = min(w_length, (u16) value);
1615                         }
1616                         break;
1617                 case USB_DT_OTG:
1618                         if (gadget_is_otg(gadget)) {
1619                                 struct usb_configuration *config;
1620                                 int otg_desc_len = 0;
1621
1622                                 if (cdev->config)
1623                                         config = cdev->config;
1624                                 else
1625                                         config = list_first_entry(
1626                                                         &cdev->configs,
1627                                                 struct usb_configuration, list);
1628                                 if (!config)
1629                                         goto done;
1630
1631                                 if (gadget->otg_caps &&
1632                                         (gadget->otg_caps->otg_rev >= 0x0200))
1633                                         otg_desc_len += sizeof(
1634                                                 struct usb_otg20_descriptor);
1635                                 else
1636                                         otg_desc_len += sizeof(
1637                                                 struct usb_otg_descriptor);
1638
1639                                 value = min_t(int, w_length, otg_desc_len);
1640                                 memcpy(req->buf, config->descriptors[0], value);
1641                         }
1642                         break;
1643                 }
1644                 break;
1645
1646         /* any number of configs can work */
1647         case USB_REQ_SET_CONFIGURATION:
1648                 if (ctrl->bRequestType != 0)
1649                         goto unknown;
1650                 if (gadget_is_otg(gadget)) {
1651                         if (gadget->a_hnp_support)
1652                                 DBG(cdev, "HNP available\n");
1653                         else if (gadget->a_alt_hnp_support)
1654                                 DBG(cdev, "HNP on another port\n");
1655                         else
1656                                 VDBG(cdev, "HNP inactive\n");
1657                 }
1658                 spin_lock(&cdev->lock);
1659                 value = set_config(cdev, ctrl, w_value);
1660                 spin_unlock(&cdev->lock);
1661                 break;
1662         case USB_REQ_GET_CONFIGURATION:
1663                 if (ctrl->bRequestType != USB_DIR_IN)
1664                         goto unknown;
1665                 if (cdev->config)
1666                         *(u8 *)req->buf = cdev->config->bConfigurationValue;
1667                 else
1668                         *(u8 *)req->buf = 0;
1669                 value = min(w_length, (u16) 1);
1670                 break;
1671
1672         /* function drivers must handle get/set altsetting; if there's
1673          * no get() method, we know only altsetting zero works.
1674          */
1675         case USB_REQ_SET_INTERFACE:
1676                 if (ctrl->bRequestType != USB_RECIP_INTERFACE)
1677                         goto unknown;
1678                 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1679                         break;
1680                 f = cdev->config->interface[intf];
1681                 if (!f)
1682                         break;
1683                 if (w_value && !f->set_alt)
1684                         break;
1685                 value = f->set_alt(f, w_index, w_value);
1686                 if (value == USB_GADGET_DELAYED_STATUS) {
1687                         DBG(cdev,
1688                          "%s: interface %d (%s) requested delayed status\n",
1689                                         __func__, intf, f->name);
1690                         cdev->delayed_status++;
1691                         DBG(cdev, "delayed_status count %d\n",
1692                                         cdev->delayed_status);
1693                 }
1694                 break;
1695         case USB_REQ_GET_INTERFACE:
1696                 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE))
1697                         goto unknown;
1698                 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1699                         break;
1700                 f = cdev->config->interface[intf];
1701                 if (!f)
1702                         break;
1703                 /* lots of interfaces only need altsetting zero... */
1704                 value = f->get_alt ? f->get_alt(f, w_index) : 0;
1705                 if (value < 0)
1706                         break;
1707                 *((u8 *)req->buf) = value;
1708                 value = min(w_length, (u16) 1);
1709                 break;
1710         case USB_REQ_GET_STATUS:
1711                 if (gadget_is_otg(gadget) && gadget->hnp_polling_support &&
1712                                                 (w_index == OTG_STS_SELECTOR)) {
1713                         if (ctrl->bRequestType != (USB_DIR_IN |
1714                                                         USB_RECIP_DEVICE))
1715                                 goto unknown;
1716                         *((u8 *)req->buf) = gadget->host_request_flag;
1717                         value = 1;
1718                         break;
1719                 }
1720
1721                 /*
1722                  * USB 3.0 additions:
1723                  * Function driver should handle get_status request. If such cb
1724                  * wasn't supplied we respond with default value = 0
1725                  * Note: function driver should supply such cb only for the
1726                  * first interface of the function
1727                  */
1728                 if (!gadget_is_superspeed(gadget))
1729                         goto unknown;
1730                 if (ctrl->bRequestType != (USB_DIR_IN | USB_RECIP_INTERFACE))
1731                         goto unknown;
1732                 value = 2;      /* This is the length of the get_status reply */
1733                 put_unaligned_le16(0, req->buf);
1734                 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1735                         break;
1736                 f = cdev->config->interface[intf];
1737                 if (!f)
1738                         break;
1739                 status = f->get_status ? f->get_status(f) : 0;
1740                 if (status < 0)
1741                         break;
1742                 put_unaligned_le16(status & 0x0000ffff, req->buf);
1743                 break;
1744         /*
1745          * Function drivers should handle SetFeature/ClearFeature
1746          * (FUNCTION_SUSPEND) request. function_suspend cb should be supplied
1747          * only for the first interface of the function
1748          */
1749         case USB_REQ_CLEAR_FEATURE:
1750         case USB_REQ_SET_FEATURE:
1751                 if (!gadget_is_superspeed(gadget))
1752                         goto unknown;
1753                 if (ctrl->bRequestType != (USB_DIR_OUT | USB_RECIP_INTERFACE))
1754                         goto unknown;
1755                 switch (w_value) {
1756                 case USB_INTRF_FUNC_SUSPEND:
1757                         if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1758                                 break;
1759                         f = cdev->config->interface[intf];
1760                         if (!f)
1761                                 break;
1762                         value = 0;
1763                         if (f->func_suspend)
1764                                 value = f->func_suspend(f, w_index >> 8);
1765                         if (value < 0) {
1766                                 ERROR(cdev,
1767                                       "func_suspend() returned error %d\n",
1768                                       value);
1769                                 value = 0;
1770                         }
1771                         break;
1772                 }
1773                 break;
1774         default:
1775 unknown:
1776                 /*
1777                  * OS descriptors handling
1778                  */
1779                 if (cdev->use_os_string && cdev->os_desc_config &&
1780                     (ctrl->bRequestType & USB_TYPE_VENDOR) &&
1781                     ctrl->bRequest == cdev->b_vendor_code) {
1782                         struct usb_request              *req;
1783                         struct usb_configuration        *os_desc_cfg;
1784                         u8                              *buf;
1785                         int                             interface;
1786                         int                             count = 0;
1787
1788                         req = cdev->os_desc_req;
1789                         req->context = cdev;
1790                         req->complete = composite_setup_complete;
1791                         buf = req->buf;
1792                         os_desc_cfg = cdev->os_desc_config;
1793                         memset(buf, 0, w_length);
1794                         buf[5] = 0x01;
1795                         switch (ctrl->bRequestType & USB_RECIP_MASK) {
1796                         case USB_RECIP_DEVICE:
1797                                 if (w_index != 0x4 || (w_value >> 8))
1798                                         break;
1799                                 buf[6] = w_index;
1800                                 if (w_length == 0x10) {
1801                                         /* Number of ext compat interfaces */
1802                                         count = count_ext_compat(os_desc_cfg);
1803                                         buf[8] = count;
1804                                         count *= 24; /* 24 B/ext compat desc */
1805                                         count += 16; /* header */
1806                                         put_unaligned_le32(count, buf);
1807                                         value = w_length;
1808                                 } else {
1809                                         /* "extended compatibility ID"s */
1810                                         count = count_ext_compat(os_desc_cfg);
1811                                         buf[8] = count;
1812                                         count *= 24; /* 24 B/ext compat desc */
1813                                         count += 16; /* header */
1814                                         put_unaligned_le32(count, buf);
1815                                         buf += 16;
1816                                         fill_ext_compat(os_desc_cfg, buf);
1817                                         value = w_length;
1818                                 }
1819                                 break;
1820                         case USB_RECIP_INTERFACE:
1821                                 if (w_index != 0x5 || (w_value >> 8))
1822                                         break;
1823                                 interface = w_value & 0xFF;
1824                                 buf[6] = w_index;
1825                                 if (w_length == 0x0A) {
1826                                         count = count_ext_prop(os_desc_cfg,
1827                                                 interface);
1828                                         put_unaligned_le16(count, buf + 8);
1829                                         count = len_ext_prop(os_desc_cfg,
1830                                                 interface);
1831                                         put_unaligned_le32(count, buf);
1832
1833                                         value = w_length;
1834                                 } else {
1835                                         count = count_ext_prop(os_desc_cfg,
1836                                                 interface);
1837                                         put_unaligned_le16(count, buf + 8);
1838                                         count = len_ext_prop(os_desc_cfg,
1839                                                 interface);
1840                                         put_unaligned_le32(count, buf);
1841                                         buf += 10;
1842                                         value = fill_ext_prop(os_desc_cfg,
1843                                                               interface, buf);
1844                                         if (value < 0)
1845                                                 return value;
1846
1847                                         value = w_length;
1848                                 }
1849                                 break;
1850                         }
1851                         req->length = value;
1852                         req->context = cdev;
1853                         req->zero = value < w_length;
1854                         value = composite_ep0_queue(cdev, req, GFP_ATOMIC);
1855                         if (value < 0) {
1856                                 DBG(cdev, "ep_queue --> %d\n", value);
1857                                 req->status = 0;
1858                                 composite_setup_complete(gadget->ep0, req);
1859                         }
1860                         return value;
1861                 }
1862
1863                 VDBG(cdev,
1864                         "non-core control req%02x.%02x v%04x i%04x l%d\n",
1865                         ctrl->bRequestType, ctrl->bRequest,
1866                         w_value, w_index, w_length);
1867
1868                 /* functions always handle their interfaces and endpoints...
1869                  * punt other recipients (other, WUSB, ...) to the current
1870                  * configuration code.
1871                  *
1872                  * REVISIT it could make sense to let the composite device
1873                  * take such requests too, if that's ever needed:  to work
1874                  * in config 0, etc.
1875                  */
1876                 if (cdev->config) {
1877                         list_for_each_entry(f, &cdev->config->functions, list)
1878                                 if (f->req_match && f->req_match(f, ctrl))
1879                                         goto try_fun_setup;
1880                         f = NULL;
1881                 }
1882
1883                 switch (ctrl->bRequestType & USB_RECIP_MASK) {
1884                 case USB_RECIP_INTERFACE:
1885                         if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1886                                 break;
1887                         f = cdev->config->interface[intf];
1888                         break;
1889
1890                 case USB_RECIP_ENDPOINT:
1891                         endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f);
1892                         list_for_each_entry(f, &cdev->config->functions, list) {
1893                                 if (test_bit(endp, f->endpoints))
1894                                         break;
1895                         }
1896                         if (&f->list == &cdev->config->functions)
1897                                 f = NULL;
1898                         break;
1899                 }
1900 try_fun_setup:
1901                 if (f && f->setup)
1902                         value = f->setup(f, ctrl);
1903                 else {
1904                         struct usb_configuration        *c;
1905
1906                         c = cdev->config;
1907                         if (!c)
1908                                 goto done;
1909
1910                         /* try current config's setup */
1911                         if (c->setup) {
1912                                 value = c->setup(c, ctrl);
1913                                 goto done;
1914                         }
1915
1916                         /* try the only function in the current config */
1917                         if (!list_is_singular(&c->functions))
1918                                 goto done;
1919                         f = list_first_entry(&c->functions, struct usb_function,
1920                                              list);
1921                         if (f->setup)
1922                                 value = f->setup(f, ctrl);
1923                 }
1924
1925                 goto done;
1926         }
1927
1928         /* respond with data transfer before status phase? */
1929         if (value >= 0 && value != USB_GADGET_DELAYED_STATUS) {
1930                 req->length = value;
1931                 req->context = cdev;
1932                 req->zero = value < w_length;
1933                 value = composite_ep0_queue(cdev, req, GFP_ATOMIC);
1934                 if (value < 0) {
1935                         DBG(cdev, "ep_queue --> %d\n", value);
1936                         req->status = 0;
1937                         composite_setup_complete(gadget->ep0, req);
1938                 }
1939         } else if (value == USB_GADGET_DELAYED_STATUS && w_length != 0) {
1940                 WARN(cdev,
1941                         "%s: Delayed status not supported for w_length != 0",
1942                         __func__);
1943         }
1944
1945 done:
1946         /* device either stalls (value < 0) or reports success */
1947         return value;
1948 }
1949
1950 void composite_disconnect(struct usb_gadget *gadget)
1951 {
1952         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
1953         unsigned long                   flags;
1954
1955         /* REVISIT:  should we have config and device level
1956          * disconnect callbacks?
1957          */
1958         spin_lock_irqsave(&cdev->lock, flags);
1959         if (cdev->config)
1960                 reset_config(cdev);
1961         if (cdev->driver->disconnect)
1962                 cdev->driver->disconnect(cdev);
1963         spin_unlock_irqrestore(&cdev->lock, flags);
1964 }
1965
1966 /*-------------------------------------------------------------------------*/
1967
1968 static ssize_t suspended_show(struct device *dev, struct device_attribute *attr,
1969                               char *buf)
1970 {
1971         struct usb_gadget *gadget = dev_to_usb_gadget(dev);
1972         struct usb_composite_dev *cdev = get_gadget_data(gadget);
1973
1974         return sprintf(buf, "%d\n", cdev->suspended);
1975 }
1976 static DEVICE_ATTR_RO(suspended);
1977
1978 static void __composite_unbind(struct usb_gadget *gadget, bool unbind_driver)
1979 {
1980         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
1981
1982         /* composite_disconnect() must already have been called
1983          * by the underlying peripheral controller driver!
1984          * so there's no i/o concurrency that could affect the
1985          * state protected by cdev->lock.
1986          */
1987         WARN_ON(cdev->config);
1988
1989         while (!list_empty(&cdev->configs)) {
1990                 struct usb_configuration        *c;
1991                 c = list_first_entry(&cdev->configs,
1992                                 struct usb_configuration, list);
1993                 remove_config(cdev, c);
1994         }
1995         if (cdev->driver->unbind && unbind_driver)
1996                 cdev->driver->unbind(cdev);
1997
1998         composite_dev_cleanup(cdev);
1999
2000         kfree(cdev->def_manufacturer);
2001         kfree(cdev);
2002         set_gadget_data(gadget, NULL);
2003 }
2004
2005 static void composite_unbind(struct usb_gadget *gadget)
2006 {
2007         __composite_unbind(gadget, true);
2008 }
2009
2010 static void update_unchanged_dev_desc(struct usb_device_descriptor *new,
2011                 const struct usb_device_descriptor *old)
2012 {
2013         __le16 idVendor;
2014         __le16 idProduct;
2015         __le16 bcdDevice;
2016         u8 iSerialNumber;
2017         u8 iManufacturer;
2018         u8 iProduct;
2019
2020         /*
2021          * these variables may have been set in
2022          * usb_composite_overwrite_options()
2023          */
2024         idVendor = new->idVendor;
2025         idProduct = new->idProduct;
2026         bcdDevice = new->bcdDevice;
2027         iSerialNumber = new->iSerialNumber;
2028         iManufacturer = new->iManufacturer;
2029         iProduct = new->iProduct;
2030
2031         *new = *old;
2032         if (idVendor)
2033                 new->idVendor = idVendor;
2034         if (idProduct)
2035                 new->idProduct = idProduct;
2036         if (bcdDevice)
2037                 new->bcdDevice = bcdDevice;
2038         else
2039                 new->bcdDevice = cpu_to_le16(get_default_bcdDevice());
2040         if (iSerialNumber)
2041                 new->iSerialNumber = iSerialNumber;
2042         if (iManufacturer)
2043                 new->iManufacturer = iManufacturer;
2044         if (iProduct)
2045                 new->iProduct = iProduct;
2046 }
2047
2048 int composite_dev_prepare(struct usb_composite_driver *composite,
2049                 struct usb_composite_dev *cdev)
2050 {
2051         struct usb_gadget *gadget = cdev->gadget;
2052         int ret = -ENOMEM;
2053
2054         /* preallocate control response and buffer */
2055         cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
2056         if (!cdev->req)
2057                 return -ENOMEM;
2058
2059         cdev->req->buf = kmalloc(USB_COMP_EP0_BUFSIZ, GFP_KERNEL);
2060         if (!cdev->req->buf)
2061                 goto fail;
2062
2063         ret = device_create_file(&gadget->dev, &dev_attr_suspended);
2064         if (ret)
2065                 goto fail_dev;
2066
2067         cdev->req->complete = composite_setup_complete;
2068         cdev->req->context = cdev;
2069         gadget->ep0->driver_data = cdev;
2070
2071         cdev->driver = composite;
2072
2073         /*
2074          * As per USB compliance update, a device that is actively drawing
2075          * more than 100mA from USB must report itself as bus-powered in
2076          * the GetStatus(DEVICE) call.
2077          */
2078         if (CONFIG_USB_GADGET_VBUS_DRAW <= USB_SELF_POWER_VBUS_MAX_DRAW)
2079                 usb_gadget_set_selfpowered(gadget);
2080
2081         /* interface and string IDs start at zero via kzalloc.
2082          * we force endpoints to start unassigned; few controller
2083          * drivers will zero ep->driver_data.
2084          */
2085         usb_ep_autoconfig_reset(gadget);
2086         return 0;
2087 fail_dev:
2088         kfree(cdev->req->buf);
2089 fail:
2090         usb_ep_free_request(gadget->ep0, cdev->req);
2091         cdev->req = NULL;
2092         return ret;
2093 }
2094
2095 int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
2096                                   struct usb_ep *ep0)
2097 {
2098         int ret = 0;
2099
2100         cdev->os_desc_req = usb_ep_alloc_request(ep0, GFP_KERNEL);
2101         if (!cdev->os_desc_req) {
2102                 ret = PTR_ERR(cdev->os_desc_req);
2103                 goto end;
2104         }
2105
2106         /* OS feature descriptor length <= 4kB */
2107         cdev->os_desc_req->buf = kmalloc(4096, GFP_KERNEL);
2108         if (!cdev->os_desc_req->buf) {
2109                 ret = PTR_ERR(cdev->os_desc_req->buf);
2110                 kfree(cdev->os_desc_req);
2111                 goto end;
2112         }
2113         cdev->os_desc_req->context = cdev;
2114         cdev->os_desc_req->complete = composite_setup_complete;
2115 end:
2116         return ret;
2117 }
2118
2119 void composite_dev_cleanup(struct usb_composite_dev *cdev)
2120 {
2121         struct usb_gadget_string_container *uc, *tmp;
2122
2123         list_for_each_entry_safe(uc, tmp, &cdev->gstrings, list) {
2124                 list_del(&uc->list);
2125                 kfree(uc);
2126         }
2127         if (cdev->os_desc_req) {
2128                 if (cdev->os_desc_pending)
2129                         usb_ep_dequeue(cdev->gadget->ep0, cdev->os_desc_req);
2130
2131                 kfree(cdev->os_desc_req->buf);
2132                 usb_ep_free_request(cdev->gadget->ep0, cdev->os_desc_req);
2133         }
2134         if (cdev->req) {
2135                 if (cdev->setup_pending)
2136                         usb_ep_dequeue(cdev->gadget->ep0, cdev->req);
2137
2138                 kfree(cdev->req->buf);
2139                 usb_ep_free_request(cdev->gadget->ep0, cdev->req);
2140         }
2141         cdev->next_string_id = 0;
2142         device_remove_file(&cdev->gadget->dev, &dev_attr_suspended);
2143 }
2144
2145 static int composite_bind(struct usb_gadget *gadget,
2146                 struct usb_gadget_driver *gdriver)
2147 {
2148         struct usb_composite_dev        *cdev;
2149         struct usb_composite_driver     *composite = to_cdriver(gdriver);
2150         int                             status = -ENOMEM;
2151
2152         cdev = kzalloc(sizeof *cdev, GFP_KERNEL);
2153         if (!cdev)
2154                 return status;
2155
2156         spin_lock_init(&cdev->lock);
2157         cdev->gadget = gadget;
2158         set_gadget_data(gadget, cdev);
2159         INIT_LIST_HEAD(&cdev->configs);
2160         INIT_LIST_HEAD(&cdev->gstrings);
2161
2162         status = composite_dev_prepare(composite, cdev);
2163         if (status)
2164                 goto fail;
2165
2166         /* composite gadget needs to assign strings for whole device (like
2167          * serial number), register function drivers, potentially update
2168          * power state and consumption, etc
2169          */
2170         status = composite->bind(cdev);
2171         if (status < 0)
2172                 goto fail;
2173
2174         if (cdev->use_os_string) {
2175                 status = composite_os_desc_req_prepare(cdev, gadget->ep0);
2176                 if (status)
2177                         goto fail;
2178         }
2179
2180         update_unchanged_dev_desc(&cdev->desc, composite->dev);
2181
2182         /* has userspace failed to provide a serial number? */
2183         if (composite->needs_serial && !cdev->desc.iSerialNumber)
2184                 WARNING(cdev, "userspace failed to provide iSerialNumber\n");
2185
2186         INFO(cdev, "%s ready\n", composite->name);
2187         return 0;
2188
2189 fail:
2190         __composite_unbind(gadget, false);
2191         return status;
2192 }
2193
2194 /*-------------------------------------------------------------------------*/
2195
2196 void composite_suspend(struct usb_gadget *gadget)
2197 {
2198         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
2199         struct usb_function             *f;
2200
2201         /* REVISIT:  should we have config level
2202          * suspend/resume callbacks?
2203          */
2204         DBG(cdev, "suspend\n");
2205         if (cdev->config) {
2206                 list_for_each_entry(f, &cdev->config->functions, list) {
2207                         if (f->suspend)
2208                                 f->suspend(f);
2209                 }
2210         }
2211         if (cdev->driver->suspend)
2212                 cdev->driver->suspend(cdev);
2213
2214         cdev->suspended = 1;
2215
2216         usb_gadget_vbus_draw(gadget, 2);
2217 }
2218
2219 void composite_resume(struct usb_gadget *gadget)
2220 {
2221         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
2222         struct usb_function             *f;
2223         u16                             maxpower;
2224
2225         /* REVISIT:  should we have config level
2226          * suspend/resume callbacks?
2227          */
2228         DBG(cdev, "resume\n");
2229         if (cdev->driver->resume)
2230                 cdev->driver->resume(cdev);
2231         if (cdev->config) {
2232                 list_for_each_entry(f, &cdev->config->functions, list) {
2233                         if (f->resume)
2234                                 f->resume(f);
2235                 }
2236
2237                 maxpower = cdev->config->MaxPower;
2238
2239                 usb_gadget_vbus_draw(gadget, maxpower ?
2240                         maxpower : CONFIG_USB_GADGET_VBUS_DRAW);
2241         }
2242
2243         cdev->suspended = 0;
2244 }
2245
2246 /*-------------------------------------------------------------------------*/
2247
2248 static const struct usb_gadget_driver composite_driver_template = {
2249         .bind           = composite_bind,
2250         .unbind         = composite_unbind,
2251
2252         .setup          = composite_setup,
2253         .reset          = composite_disconnect,
2254         .disconnect     = composite_disconnect,
2255
2256         .suspend        = composite_suspend,
2257         .resume         = composite_resume,
2258
2259         .driver = {
2260                 .owner          = THIS_MODULE,
2261         },
2262 };
2263
2264 /**
2265  * usb_composite_probe() - register a composite driver
2266  * @driver: the driver to register
2267  *
2268  * Context: single threaded during gadget setup
2269  *
2270  * This function is used to register drivers using the composite driver
2271  * framework.  The return value is zero, or a negative errno value.
2272  * Those values normally come from the driver's @bind method, which does
2273  * all the work of setting up the driver to match the hardware.
2274  *
2275  * On successful return, the gadget is ready to respond to requests from
2276  * the host, unless one of its components invokes usb_gadget_disconnect()
2277  * while it was binding.  That would usually be done in order to wait for
2278  * some userspace participation.
2279  */
2280 int usb_composite_probe(struct usb_composite_driver *driver)
2281 {
2282         struct usb_gadget_driver *gadget_driver;
2283
2284         if (!driver || !driver->dev || !driver->bind)
2285                 return -EINVAL;
2286
2287         if (!driver->name)
2288                 driver->name = "composite";
2289
2290         driver->gadget_driver = composite_driver_template;
2291         gadget_driver = &driver->gadget_driver;
2292
2293         gadget_driver->function =  (char *) driver->name;
2294         gadget_driver->driver.name = driver->name;
2295         gadget_driver->max_speed = driver->max_speed;
2296
2297         return usb_gadget_probe_driver(gadget_driver);
2298 }
2299 EXPORT_SYMBOL_GPL(usb_composite_probe);
2300
2301 /**
2302  * usb_composite_unregister() - unregister a composite driver
2303  * @driver: the driver to unregister
2304  *
2305  * This function is used to unregister drivers using the composite
2306  * driver framework.
2307  */
2308 void usb_composite_unregister(struct usb_composite_driver *driver)
2309 {
2310         usb_gadget_unregister_driver(&driver->gadget_driver);
2311 }
2312 EXPORT_SYMBOL_GPL(usb_composite_unregister);
2313
2314 /**
2315  * usb_composite_setup_continue() - Continue with the control transfer
2316  * @cdev: the composite device who's control transfer was kept waiting
2317  *
2318  * This function must be called by the USB function driver to continue
2319  * with the control transfer's data/status stage in case it had requested to
2320  * delay the data/status stages. A USB function's setup handler (e.g. set_alt())
2321  * can request the composite framework to delay the setup request's data/status
2322  * stages by returning USB_GADGET_DELAYED_STATUS.
2323  */
2324 void usb_composite_setup_continue(struct usb_composite_dev *cdev)
2325 {
2326         int                     value;
2327         struct usb_request      *req = cdev->req;
2328         unsigned long           flags;
2329
2330         DBG(cdev, "%s\n", __func__);
2331         spin_lock_irqsave(&cdev->lock, flags);
2332
2333         if (cdev->delayed_status == 0) {
2334                 WARN(cdev, "%s: Unexpected call\n", __func__);
2335
2336         } else if (--cdev->delayed_status == 0) {
2337                 DBG(cdev, "%s: Completing delayed status\n", __func__);
2338                 req->length = 0;
2339                 req->context = cdev;
2340                 value = composite_ep0_queue(cdev, req, GFP_ATOMIC);
2341                 if (value < 0) {
2342                         DBG(cdev, "ep_queue --> %d\n", value);
2343                         req->status = 0;
2344                         composite_setup_complete(cdev->gadget->ep0, req);
2345                 }
2346         }
2347
2348         spin_unlock_irqrestore(&cdev->lock, flags);
2349 }
2350 EXPORT_SYMBOL_GPL(usb_composite_setup_continue);
2351
2352 static char *composite_default_mfr(struct usb_gadget *gadget)
2353 {
2354         char *mfr;
2355         int len;
2356
2357         len = snprintf(NULL, 0, "%s %s with %s", init_utsname()->sysname,
2358                         init_utsname()->release, gadget->name);
2359         len++;
2360         mfr = kmalloc(len, GFP_KERNEL);
2361         if (!mfr)
2362                 return NULL;
2363         snprintf(mfr, len, "%s %s with %s", init_utsname()->sysname,
2364                         init_utsname()->release, gadget->name);
2365         return mfr;
2366 }
2367
2368 void usb_composite_overwrite_options(struct usb_composite_dev *cdev,
2369                 struct usb_composite_overwrite *covr)
2370 {
2371         struct usb_device_descriptor    *desc = &cdev->desc;
2372         struct usb_gadget_strings       *gstr = cdev->driver->strings[0];
2373         struct usb_string               *dev_str = gstr->strings;
2374
2375         if (covr->idVendor)
2376                 desc->idVendor = cpu_to_le16(covr->idVendor);
2377
2378         if (covr->idProduct)
2379                 desc->idProduct = cpu_to_le16(covr->idProduct);
2380
2381         if (covr->bcdDevice)
2382                 desc->bcdDevice = cpu_to_le16(covr->bcdDevice);
2383
2384         if (covr->serial_number) {
2385                 desc->iSerialNumber = dev_str[USB_GADGET_SERIAL_IDX].id;
2386                 dev_str[USB_GADGET_SERIAL_IDX].s = covr->serial_number;
2387         }
2388         if (covr->manufacturer) {
2389                 desc->iManufacturer = dev_str[USB_GADGET_MANUFACTURER_IDX].id;
2390                 dev_str[USB_GADGET_MANUFACTURER_IDX].s = covr->manufacturer;
2391
2392         } else if (!strlen(dev_str[USB_GADGET_MANUFACTURER_IDX].s)) {
2393                 desc->iManufacturer = dev_str[USB_GADGET_MANUFACTURER_IDX].id;
2394                 cdev->def_manufacturer = composite_default_mfr(cdev->gadget);
2395                 dev_str[USB_GADGET_MANUFACTURER_IDX].s = cdev->def_manufacturer;
2396         }
2397
2398         if (covr->product) {
2399                 desc->iProduct = dev_str[USB_GADGET_PRODUCT_IDX].id;
2400                 dev_str[USB_GADGET_PRODUCT_IDX].s = covr->product;
2401         }
2402 }
2403 EXPORT_SYMBOL_GPL(usb_composite_overwrite_options);
2404
2405 MODULE_LICENSE("GPL");
2406 MODULE_AUTHOR("David Brownell");