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 <asm/unaligned.h>
  23
  24 /*
  25  * The code in this file is utility code, used to build a gadget driver
  26  * from one or more "function" drivers, one or more "configuration"
  27  * objects, and a "usb_composite_driver" by gluing them together along
  28  * with the relevant device-wide data.
  29  */
  30
  31 /* big enough to hold our biggest descriptor */
  32 #define USB_BUFSIZ      1024
  33
  34 static struct usb_composite_driver *composite;
  35 static int (*composite_gadget_bind)(struct usb_composite_dev *cdev);
  36
  37 /* Some systems will need runtime overrides for the  product identifiers
  38  * published in the device descriptor, either numbers or strings or both.
  39  * String parameters are in UTF-8 (superset of ASCII's 7 bit characters).
  40  */
  41
  42 static ushort idVendor;
  43 module_param(idVendor, ushort, 0);
  44 MODULE_PARM_DESC(idVendor, "USB Vendor ID");
  45
  46 static ushort idProduct;
  47 module_param(idProduct, ushort, 0);
  48 MODULE_PARM_DESC(idProduct, "USB Product ID");
  49
  50 static ushort bcdDevice;
  51 module_param(bcdDevice, ushort, 0);
  52 MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)");
  53
  54 static char *iManufacturer;
  55 module_param(iManufacturer, charp, 0);
  56 MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string");
  57
  58 static char *iProduct;
  59 module_param(iProduct, charp, 0);
  60 MODULE_PARM_DESC(iProduct, "USB Product string");
  61
  62 static char *iSerialNumber;
  63 module_param(iSerialNumber, charp, 0);
  64 MODULE_PARM_DESC(iSerialNumber, "SerialNumber string");
  65
  66 static char composite_manufacturer[50];
  67
  68 /*-------------------------------------------------------------------------*/
  69 /**
  70  * next_ep_desc() - advance to the next EP descriptor
  71  * @t: currect pointer within descriptor array
  72  *
  73  * Return: next EP descriptor or NULL
  74  *
  75  * Iterate over @t until either EP descriptor found or
  76  * NULL (that indicates end of list) encountered
  77  */
  78 static struct usb_descriptor_header**
  79 next_ep_desc(struct usb_descriptor_header **t)
  80 {
  81         for (; *t; t++) {
  82                 if ((*t)->bDescriptorType == USB_DT_ENDPOINT)
  83                         return t;
  84         }
  85         return NULL;
  86 }
  87
  88 /*
  89  * for_each_ep_desc()- iterate over endpoint descriptors in the
  90  *              descriptors list
  91  * @start:      pointer within descriptor array.
  92  * @ep_desc:    endpoint descriptor to use as the loop cursor
  93  */
  94 #define for_each_ep_desc(start, ep_desc) \
  95         for (ep_desc = next_ep_desc(start); \
  96               ep_desc; ep_desc = next_ep_desc(ep_desc+1))
  97
  98 /**
  99  * config_ep_by_speed() - configures the given endpoint
 100  * according to gadget speed.
 101  * @g: pointer to the gadget
 102  * @f: usb function
 103  * @_ep: the endpoint to configure
 104  *
 105  * Return: error code, 0 on success
 106  *
 107  * This function chooses the right descriptors for a given
 108  * endpoint according to gadget speed and saves it in the
 109  * endpoint desc field. If the endpoint already has a descriptor
 110  * assigned to it - overwrites it with currently corresponding
 111  * descriptor. The endpoint maxpacket field is updated according
 112  * to the chosen descriptor.
 113  * Note: the supplied function should hold all the descriptors
 114  * for supported speeds
 115  */
 116 int config_ep_by_speed(struct usb_gadget *g,
 117                         struct usb_function *f,
 118                         struct usb_ep *_ep)
 119 {
 120         struct usb_endpoint_descriptor *chosen_desc = NULL;
 121         struct usb_descriptor_header **speed_desc = NULL;
 122
 123         struct usb_ss_ep_comp_descriptor *comp_desc = NULL;
 124         int want_comp_desc = 0;
 125
 126         struct usb_descriptor_header **d_spd; /* cursor for speed desc */
 127
 128         if (!g || !f || !_ep)
 129                 return -EIO;
 130
 131         /* select desired speed */
 132         switch (g->speed) {
 133         case USB_SPEED_SUPER:
 134                 if (gadget_is_superspeed(g)) {
 135                         speed_desc = f->ss_descriptors;
 136                         want_comp_desc = 1;
 137                         break;
 138                 }
 139                 /* else: Fall trough */
 140         case USB_SPEED_HIGH:
 141                 if (gadget_is_dualspeed(g)) {
 142                         speed_desc = f->hs_descriptors;
 143                         break;
 144                 }
 145                 /* else: fall through */
 146         default:
 147                 speed_desc = f->descriptors;
 148         }
 149         /* find descriptors */
 150         for_each_ep_desc(speed_desc, d_spd) {
 151                 chosen_desc = (struct usb_endpoint_descriptor *)*d_spd;
 152                 if (chosen_desc->bEndpointAddress == _ep->address)
 153                         goto ep_found;
 154         }
 155         return -EIO;
 156
 157 ep_found:
 158         /* commit results */
 159         _ep->maxpacket = usb_endpoint_maxp(chosen_desc);
 160         _ep->desc = chosen_desc;
 161         _ep->comp_desc = NULL;
 162         _ep->maxburst = 0;
 163         _ep->mult = 0;
 164         if (!want_comp_desc)
 165                 return 0;
 166
 167         /*
 168          * Companion descriptor should follow EP descriptor
 169          * USB 3.0 spec, #9.6.7
 170          */
 171         comp_desc = (struct usb_ss_ep_comp_descriptor *)*(++d_spd);
 172         if (!comp_desc ||
 173             (comp_desc->bDescriptorType != USB_DT_SS_ENDPOINT_COMP))
 174                 return -EIO;
 175         _ep->comp_desc = comp_desc;
 176         if (g->speed == USB_SPEED_SUPER) {
 177                 switch (usb_endpoint_type(_ep->desc)) {
 178                 case USB_ENDPOINT_XFER_BULK:
 179                 case USB_ENDPOINT_XFER_INT:
 180                         _ep->maxburst = comp_desc->bMaxBurst;
 181                         break;
 182                 case USB_ENDPOINT_XFER_ISOC:
 183                         /* mult: bits 1:0 of bmAttributes */
 184                         _ep->mult = comp_desc->bmAttributes & 0x3;
 185                         break;
 186                 default:
 187                         /* Do nothing for control endpoints */
 188                         break;
 189                 }
 190         }
 191         return 0;
 192 }
 193
 194 /**
 195  * usb_add_function() - add a function to a configuration
 196  * @config: the configuration
 197  * @function: the function being added
 198  * Context: single threaded during gadget setup
 199  *
 200  * After initialization, each configuration must have one or more
 201  * functions added to it.  Adding a function involves calling its @bind()
 202  * method to allocate resources such as interface and string identifiers
 203  * and endpoints.
 204  *
 205  * This function returns the value of the function's bind(), which is
 206  * zero for success else a negative errno value.
 207  */
 208 int usb_add_function(struct usb_configuration *config,
 209                 struct usb_function *function)
 210 {
 211         int     value = -EINVAL;
 212
 213         DBG(config->cdev, "adding '%s'/%p to config '%s'/%p\n",
 214                         function->name, function,
 215                         config->label, config);
 216
 217         if (!function->set_alt || !function->disable)
 218                 goto done;
 219
 220         function->config = config;
 221         list_add_tail(&function->list, &config->functions);
 222
 223         /* REVISIT *require* function->bind? */
 224         if (function->bind) {
 225                 value = function->bind(config, function);
 226                 if (value < 0) {
 227                         list_del(&function->list);
 228                         function->config = NULL;
 229                 }
 230         } else
 231                 value = 0;
 232
 233         /* We allow configurations that don't work at both speeds.
 234          * If we run into a lowspeed Linux system, treat it the same
 235          * as full speed ... it's the function drivers that will need
 236          * to avoid bulk and ISO transfers.
 237          */
 238         if (!config->fullspeed && function->descriptors)
 239                 config->fullspeed = true;
 240         if (!config->highspeed && function->hs_descriptors)
 241                 config->highspeed = true;
 242         if (!config->superspeed && function->ss_descriptors)
 243                 config->superspeed = true;
 244
 245 done:
 246         if (value)
 247                 DBG(config->cdev, "adding '%s'/%p --> %d\n",
 248                                 function->name, function, value);
 249         return value;
 250 }
 251
 252 /**
 253  * usb_function_deactivate - prevent function and gadget enumeration
 254  * @function: the function that isn't yet ready to respond
 255  *
 256  * Blocks response of the gadget driver to host enumeration by
 257  * preventing the data line pullup from being activated.  This is
 258  * normally called during @bind() processing to change from the
 259  * initial "ready to respond" state, or when a required resource
 260  * becomes available.
 261  *
 262  * For example, drivers that serve as a passthrough to a userspace
 263  * daemon can block enumeration unless that daemon (such as an OBEX,
 264  * MTP, or print server) is ready to handle host requests.
 265  *
 266  * Not all systems support software control of their USB peripheral
 267  * data pullups.
 268  *
 269  * Returns zero on success, else negative errno.
 270  */
 271 int usb_function_deactivate(struct usb_function *function)
 272 {
 273         struct usb_composite_dev        *cdev = function->config->cdev;
 274         unsigned long                   flags;
 275         int                             status = 0;
 276
 277         spin_lock_irqsave(&cdev->lock, flags);
 278
 279         if (cdev->deactivations == 0)
 280                 status = usb_gadget_disconnect(cdev->gadget);
 281         if (status == 0)
 282                 cdev->deactivations++;
 283
 284         spin_unlock_irqrestore(&cdev->lock, flags);
 285         return status;
 286 }
 287
 288 /**
 289  * usb_function_activate - allow function and gadget enumeration
 290  * @function: function on which usb_function_activate() was called
 291  *
 292  * Reverses effect of usb_function_deactivate().  If no more functions
 293  * are delaying their activation, the gadget driver will respond to
 294  * host enumeration procedures.
 295  *
 296  * Returns zero on success, else negative errno.
 297  */
 298 int usb_function_activate(struct usb_function *function)
 299 {
 300         struct usb_composite_dev        *cdev = function->config->cdev;
 301         int                             status = 0;
 302
 303         spin_lock(&cdev->lock);
 304
 305         if (WARN_ON(cdev->deactivations == 0))
 306                 status = -EINVAL;
 307         else {
 308                 cdev->deactivations--;
 309                 if (cdev->deactivations == 0)
 310                         status = usb_gadget_connect(cdev->gadget);
 311         }
 312
 313         spin_unlock(&cdev->lock);
 314         return status;
 315 }
 316
 317 /**
 318  * usb_interface_id() - allocate an unused interface ID
 319  * @config: configuration associated with the interface
 320  * @function: function handling the interface
 321  * Context: single threaded during gadget setup
 322  *
 323  * usb_interface_id() is called from usb_function.bind() callbacks to
 324  * allocate new interface IDs.  The function driver will then store that
 325  * ID in interface, association, CDC union, and other descriptors.  It
 326  * will also handle any control requests targeted at that interface,
 327  * particularly changing its altsetting via set_alt().  There may
 328  * also be class-specific or vendor-specific requests to handle.
 329  *
 330  * All interface identifier should be allocated using this routine, to
 331  * ensure that for example different functions don't wrongly assign
 332  * different meanings to the same identifier.  Note that since interface
 333  * identifiers are configuration-specific, functions used in more than
 334  * one configuration (or more than once in a given configuration) need
 335  * multiple versions of the relevant descriptors.
 336  *
 337  * Returns the interface ID which was allocated; or -ENODEV if no
 338  * more interface IDs can be allocated.
 339  */
 340 int usb_interface_id(struct usb_configuration *config,
 341                 struct usb_function *function)
 342 {
 343         unsigned id = config->next_interface_id;
 344
 345         if (id < MAX_CONFIG_INTERFACES) {
 346                 config->interface[id] = function;
 347                 config->next_interface_id = id + 1;
 348                 return id;
 349         }
 350         return -ENODEV;
 351 }
 352
 353 static int config_buf(struct usb_configuration *config,
 354                 enum usb_device_speed speed, void *buf, u8 type)
 355 {
 356         struct usb_config_descriptor    *c = buf;
 357         void                            *next = buf + USB_DT_CONFIG_SIZE;
 358         int                             len = USB_BUFSIZ - USB_DT_CONFIG_SIZE;
 359         struct usb_function             *f;
 360         int                             status;
 361
 362         /* write the config descriptor */
 363         c = buf;
 364         c->bLength = USB_DT_CONFIG_SIZE;
 365         c->bDescriptorType = type;
 366         /* wTotalLength is written later */
 367         c->bNumInterfaces = config->next_interface_id;
 368         c->bConfigurationValue = config->bConfigurationValue;
 369         c->iConfiguration = config->iConfiguration;
 370         c->bmAttributes = USB_CONFIG_ATT_ONE | config->bmAttributes;
 371         c->bMaxPower = config->bMaxPower ? : (CONFIG_USB_GADGET_VBUS_DRAW / 2);
 372
 373         /* There may be e.g. OTG descriptors */
 374         if (config->descriptors) {
 375                 status = usb_descriptor_fillbuf(next, len,
 376                                 config->descriptors);
 377                 if (status < 0)
 378                         return status;
 379                 len -= status;
 380                 next += status;
 381         }
 382
 383         /* add each function's descriptors */
 384         list_for_each_entry(f, &config->functions, list) {
 385                 struct usb_descriptor_header **descriptors;
 386
 387                 switch (speed) {
 388                 case USB_SPEED_SUPER:
 389                         descriptors = f->ss_descriptors;
 390                         break;
 391                 case USB_SPEED_HIGH:
 392                         descriptors = f->hs_descriptors;
 393                         break;
 394                 default:
 395                         descriptors = f->descriptors;
 396                 }
 397
 398                 if (!descriptors)
 399                         continue;
 400                 status = usb_descriptor_fillbuf(next, len,
 401                         (const struct usb_descriptor_header **) descriptors);
 402                 if (status < 0)
 403                         return status;
 404                 len -= status;
 405                 next += status;
 406         }
 407
 408         len = next - buf;
 409         c->wTotalLength = cpu_to_le16(len);
 410         return len;
 411 }
 412
 413 static int config_desc(struct usb_composite_dev *cdev, unsigned w_value)
 414 {
 415         struct usb_gadget               *gadget = cdev->gadget;
 416         struct usb_configuration        *c;
 417         u8                              type = w_value >> 8;
 418         enum usb_device_speed           speed = USB_SPEED_UNKNOWN;
 419
 420         if (gadget->speed == USB_SPEED_SUPER)
 421                 speed = gadget->speed;
 422         else if (gadget_is_dualspeed(gadget)) {
 423                 int     hs = 0;
 424                 if (gadget->speed == USB_SPEED_HIGH)
 425                         hs = 1;
 426                 if (type == USB_DT_OTHER_SPEED_CONFIG)
 427                         hs = !hs;
 428                 if (hs)
 429                         speed = USB_SPEED_HIGH;
 430
 431         }
 432
 433         /* This is a lookup by config *INDEX* */
 434         w_value &= 0xff;
 435         list_for_each_entry(c, &cdev->configs, list) {
 436                 /* ignore configs that won't work at this speed */
 437                 switch (speed) {
 438                 case USB_SPEED_SUPER:
 439                         if (!c->superspeed)
 440                                 continue;
 441                         break;
 442                 case USB_SPEED_HIGH:
 443                         if (!c->highspeed)
 444                                 continue;
 445                         break;
 446                 default:
 447                         if (!c->fullspeed)
 448                                 continue;
 449                 }
 450
 451                 if (w_value == 0)
 452                         return config_buf(c, speed, cdev->req->buf, type);
 453                 w_value--;
 454         }
 455         return -EINVAL;
 456 }
 457
 458 static int count_configs(struct usb_composite_dev *cdev, unsigned type)
 459 {
 460         struct usb_gadget               *gadget = cdev->gadget;
 461         struct usb_configuration        *c;
 462         unsigned                        count = 0;
 463         int                             hs = 0;
 464         int                             ss = 0;
 465
 466         if (gadget_is_dualspeed(gadget)) {
 467                 if (gadget->speed == USB_SPEED_HIGH)
 468                         hs = 1;
 469                 if (gadget->speed == USB_SPEED_SUPER)
 470                         ss = 1;
 471                 if (type == USB_DT_DEVICE_QUALIFIER)
 472                         hs = !hs;
 473         }
 474         list_for_each_entry(c, &cdev->configs, list) {
 475                 /* ignore configs that won't work at this speed */
 476                 if (ss) {
 477                         if (!c->superspeed)
 478                                 continue;
 479                 } else if (hs) {
 480                         if (!c->highspeed)
 481                                 continue;
 482                 } else {
 483                         if (!c->fullspeed)
 484                                 continue;
 485                 }
 486                 count++;
 487         }
 488         return count;
 489 }
 490
 491 /**
 492  * bos_desc() - prepares the BOS descriptor.
 493  * @cdev: pointer to usb_composite device to generate the bos
 494  *      descriptor for
 495  *
 496  * This function generates the BOS (Binary Device Object)
 497  * descriptor and its device capabilities descriptors. The BOS
 498  * descriptor should be supported by a SuperSpeed device.
 499  */
 500 static int bos_desc(struct usb_composite_dev *cdev)
 501 {
 502         struct usb_ext_cap_descriptor   *usb_ext;
 503         struct usb_ss_cap_descriptor    *ss_cap;
 504         struct usb_dcd_config_params    dcd_config_params;
 505         struct usb_bos_descriptor       *bos = cdev->req->buf;
 506
 507         bos->bLength = USB_DT_BOS_SIZE;
 508         bos->bDescriptorType = USB_DT_BOS;
 509
 510         bos->wTotalLength = cpu_to_le16(USB_DT_BOS_SIZE);
 511         bos->bNumDeviceCaps = 0;
 512
 513         /*
 514          * A SuperSpeed device shall include the USB2.0 extension descriptor
 515          * and shall support LPM when operating in USB2.0 HS mode.
 516          */
 517         usb_ext = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
 518         bos->bNumDeviceCaps++;
 519         le16_add_cpu(&bos->wTotalLength, USB_DT_USB_EXT_CAP_SIZE);
 520         usb_ext->bLength = USB_DT_USB_EXT_CAP_SIZE;
 521         usb_ext->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
 522         usb_ext->bDevCapabilityType = USB_CAP_TYPE_EXT;
 523         usb_ext->bmAttributes = cpu_to_le32(USB_LPM_SUPPORT);
 524
 525         /*
 526          * The Superspeed USB Capability descriptor shall be implemented by all
 527          * SuperSpeed devices.
 528          */
 529         ss_cap = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
 530         bos->bNumDeviceCaps++;
 531         le16_add_cpu(&bos->wTotalLength, USB_DT_USB_SS_CAP_SIZE);
 532         ss_cap->bLength = USB_DT_USB_SS_CAP_SIZE;
 533         ss_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
 534         ss_cap->bDevCapabilityType = USB_SS_CAP_TYPE;
 535         ss_cap->bmAttributes = 0; /* LTM is not supported yet */
 536         ss_cap->wSpeedSupported = cpu_to_le16(USB_LOW_SPEED_OPERATION |
 537                                 USB_FULL_SPEED_OPERATION |
 538                                 USB_HIGH_SPEED_OPERATION |
 539                                 USB_5GBPS_OPERATION);
 540         ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
 541
 542         /* Get Controller configuration */
 543         if (cdev->gadget->ops->get_config_params)
 544                 cdev->gadget->ops->get_config_params(&dcd_config_params);
 545         else {
 546                 dcd_config_params.bU1devExitLat = USB_DEFAULT_U1_DEV_EXIT_LAT;
 547                 dcd_config_params.bU2DevExitLat =
 548                         cpu_to_le16(USB_DEFAULT_U2_DEV_EXIT_LAT);
 549         }
 550         ss_cap->bU1devExitLat = dcd_config_params.bU1devExitLat;
 551         ss_cap->bU2DevExitLat = dcd_config_params.bU2DevExitLat;
 552
 553         return le16_to_cpu(bos->wTotalLength);
 554 }
 555
 556 static void device_qual(struct usb_composite_dev *cdev)
 557 {
 558         struct usb_qualifier_descriptor *qual = cdev->req->buf;
 559
 560         qual->bLength = sizeof(*qual);
 561         qual->bDescriptorType = USB_DT_DEVICE_QUALIFIER;
 562         /* POLICY: same bcdUSB and device type info at both speeds */
 563         qual->bcdUSB = cdev->desc.bcdUSB;
 564         qual->bDeviceClass = cdev->desc.bDeviceClass;
 565         qual->bDeviceSubClass = cdev->desc.bDeviceSubClass;
 566         qual->bDeviceProtocol = cdev->desc.bDeviceProtocol;
 567         /* ASSUME same EP0 fifo size at both speeds */
 568         qual->bMaxPacketSize0 = cdev->gadget->ep0->maxpacket;
 569         qual->bNumConfigurations = count_configs(cdev, USB_DT_DEVICE_QUALIFIER);
 570         qual->bRESERVED = 0;
 571 }
 572
 573 /*-------------------------------------------------------------------------*/
 574
 575 static void reset_config(struct usb_composite_dev *cdev)
 576 {
 577         struct usb_function             *f;
 578
 579         DBG(cdev, "reset config\n");
 580
 581         list_for_each_entry(f, &cdev->config->functions, list) {
 582                 if (f->disable)
 583                         f->disable(f);
 584
 585                 bitmap_zero(f->endpoints, 32);
 586         }
 587         cdev->config = NULL;
 588         cdev->delayed_status = 0;
 589 }
 590
 591 static int set_config(struct usb_composite_dev *cdev,
 592                 const struct usb_ctrlrequest *ctrl, unsigned number)
 593 {
 594         struct usb_gadget       *gadget = cdev->gadget;
 595         struct usb_configuration *c = NULL;
 596         int                     result = -EINVAL;
 597         unsigned                power = gadget_is_otg(gadget) ? 8 : 100;
 598         int                     tmp;
 599
 600         if (number) {
 601                 list_for_each_entry(c, &cdev->configs, list) {
 602                         if (c->bConfigurationValue == number) {
 603                                 /*
 604                                  * We disable the FDs of the previous
 605                                  * configuration only if the new configuration
 606                                  * is a valid one
 607                                  */
 608                                 if (cdev->config)
 609                                         reset_config(cdev);
 610                                 result = 0;
 611                                 break;
 612                         }
 613                 }
 614                 if (result < 0)
 615                         goto done;
 616         } else { /* Zero configuration value - need to reset the config */
 617                 if (cdev->config)
 618                         reset_config(cdev);
 619                 result = 0;
 620         }
 621
 622         INFO(cdev, "%s config #%d: %s\n",
 623              usb_speed_string(gadget->speed),
 624              number, c ? c->label : "unconfigured");
 625
 626         if (!c)
 627                 goto done;
 628
 629         cdev->config = c;
 630
 631         /* Initialize all interfaces by setting them to altsetting zero. */
 632         for (tmp = 0; tmp < MAX_CONFIG_INTERFACES; tmp++) {
 633                 struct usb_function     *f = c->interface[tmp];
 634                 struct usb_descriptor_header **descriptors;
 635
 636                 if (!f)
 637                         break;
 638
 639                 /*
 640                  * Record which endpoints are used by the function. This is used
 641                  * to dispatch control requests targeted at that endpoint to the
 642                  * function's setup callback instead of the current
 643                  * configuration's setup callback.
 644                  */
 645                 switch (gadget->speed) {
 646                 case USB_SPEED_SUPER:
 647                         descriptors = f->ss_descriptors;
 648                         break;
 649                 case USB_SPEED_HIGH:
 650                         descriptors = f->hs_descriptors;
 651                         break;
 652                 default:
 653                         descriptors = f->descriptors;
 654                 }
 655
 656                 for (; *descriptors; ++descriptors) {
 657                         struct usb_endpoint_descriptor *ep;
 658                         int addr;
 659
 660                         if ((*descriptors)->bDescriptorType != USB_DT_ENDPOINT)
 661                                 continue;
 662
 663                         ep = (struct usb_endpoint_descriptor *)*descriptors;
 664                         addr = ((ep->bEndpointAddress & 0x80) >> 3)
 665                              |  (ep->bEndpointAddress & 0x0f);
 666                         set_bit(addr, f->endpoints);
 667                 }
 668
 669                 result = f->set_alt(f, tmp, 0);
 670                 if (result < 0) {
 671                         DBG(cdev, "interface %d (%s/%p) alt 0 --> %d\n",
 672                                         tmp, f->name, f, result);
 673
 674                         reset_config(cdev);
 675                         goto done;
 676                 }
 677
 678                 if (result == USB_GADGET_DELAYED_STATUS) {
 679                         DBG(cdev,
 680                          "%s: interface %d (%s) requested delayed status\n",
 681                                         __func__, tmp, f->name);
 682                         cdev->delayed_status++;
 683                         DBG(cdev, "delayed_status count %d\n",
 684                                         cdev->delayed_status);
 685                 }
 686         }
 687
 688         /* when we return, be sure our power usage is valid */
 689         power = c->bMaxPower ? (2 * c->bMaxPower) : CONFIG_USB_GADGET_VBUS_DRAW;
 690 done:
 691         usb_gadget_vbus_draw(gadget, power);
 692         if (result >= 0 && cdev->delayed_status)
 693                 result = USB_GADGET_DELAYED_STATUS;
 694         return result;
 695 }
 696
 697 /**
 698  * usb_add_config() - add a configuration to a device.
 699  * @cdev: wraps the USB gadget
 700  * @config: the configuration, with bConfigurationValue assigned
 701  * @bind: the configuration's bind function
 702  * Context: single threaded during gadget setup
 703  *
 704  * One of the main tasks of a composite @bind() routine is to
 705  * add each of the configurations it supports, using this routine.
 706  *
 707  * This function returns the value of the configuration's @bind(), which
 708  * is zero for success else a negative errno value.  Binding configurations
 709  * assigns global resources including string IDs, and per-configuration
 710  * resources such as interface IDs and endpoints.
 711  */
 712 int usb_add_config(struct usb_composite_dev *cdev,
 713                 struct usb_configuration *config,
 714                 int (*bind)(struct usb_configuration *))
 715 {
 716         int                             status = -EINVAL;
 717         struct usb_configuration        *c;
 718
 719         DBG(cdev, "adding config #%u '%s'/%p\n",
 720                         config->bConfigurationValue,
 721                         config->label, config);
 722
 723         if (!config->bConfigurationValue || !bind)
 724                 goto done;
 725
 726         /* Prevent duplicate configuration identifiers */
 727         list_for_each_entry(c, &cdev->configs, list) {
 728                 if (c->bConfigurationValue == config->bConfigurationValue) {
 729                         status = -EBUSY;
 730                         goto done;
 731                 }
 732         }
 733
 734         config->cdev = cdev;
 735         list_add_tail(&config->list, &cdev->configs);
 736
 737         INIT_LIST_HEAD(&config->functions);
 738         config->next_interface_id = 0;
 739
 740         status = bind(config);
 741         if (status < 0) {
 742                 list_del(&config->list);
 743                 config->cdev = NULL;
 744         } else {
 745                 unsigned        i;
 746
 747                 DBG(cdev, "cfg %d/%p speeds:%s%s%s\n",
 748                         config->bConfigurationValue, config,
 749                         config->superspeed ? " super" : "",
 750                         config->highspeed ? " high" : "",
 751                         config->fullspeed
 752                                 ? (gadget_is_dualspeed(cdev->gadget)
 753                                         ? " full"
 754                                         : " full/low")
 755                                 : "");
 756
 757                 for (i = 0; i < MAX_CONFIG_INTERFACES; i++) {
 758                         struct usb_function     *f = config->interface[i];
 759
 760                         if (!f)
 761                                 continue;
 762                         DBG(cdev, "  interface %d = %s/%p\n",
 763                                 i, f->name, f);
 764                 }
 765         }
 766
 767         /* set_alt(), or next bind(), sets up
 768          * ep->driver_data as needed.
 769          */
 770         usb_ep_autoconfig_reset(cdev->gadget);
 771
 772 done:
 773         if (status)
 774                 DBG(cdev, "added config '%s'/%u --> %d\n", config->label,
 775                                 config->bConfigurationValue, status);
 776         return status;
 777 }
 778
 779 /*-------------------------------------------------------------------------*/
 780
 781 /* We support strings in multiple languages ... string descriptor zero
 782  * says which languages are supported.  The typical case will be that
 783  * only one language (probably English) is used, with I18N handled on
 784  * the host side.
 785  */
 786
 787 static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf)
 788 {
 789         const struct usb_gadget_strings *s;
 790         u16                             language;
 791         __le16                          *tmp;
 792
 793         while (*sp) {
 794                 s = *sp;
 795                 language = cpu_to_le16(s->language);
 796                 for (tmp = buf; *tmp && tmp < &buf[126]; tmp++) {
 797                         if (*tmp == language)
 798                                 goto repeat;
 799                 }
 800                 *tmp++ = language;
 801 repeat:
 802                 sp++;
 803         }
 804 }
 805
 806 static int lookup_string(
 807         struct usb_gadget_strings       **sp,
 808         void                            *buf,
 809         u16                             language,
 810         int                             id
 811 )
 812 {
 813         struct usb_gadget_strings       *s;
 814         int                             value;
 815
 816         while (*sp) {
 817                 s = *sp++;
 818                 if (s->language != language)
 819                         continue;
 820                 value = usb_gadget_get_string(s, id, buf);
 821                 if (value > 0)
 822                         return value;
 823         }
 824         return -EINVAL;
 825 }
 826
 827 static int get_string(struct usb_composite_dev *cdev,
 828                 void *buf, u16 language, int id)
 829 {
 830         struct usb_configuration        *c;
 831         struct usb_function             *f;
 832         int                             len;
 833         const char                      *str;
 834
 835         /* Yes, not only is USB's I18N support probably more than most
 836          * folk will ever care about ... also, it's all supported here.
 837          * (Except for UTF8 support for Unicode's "Astral Planes".)
 838          */
 839
 840         /* 0 == report all available language codes */
 841         if (id == 0) {
 842                 struct usb_string_descriptor    *s = buf;
 843                 struct usb_gadget_strings       **sp;
 844
 845                 memset(s, 0, 256);
 846                 s->bDescriptorType = USB_DT_STRING;
 847
 848                 sp = composite->strings;
 849                 if (sp)
 850                         collect_langs(sp, s->wData);
 851
 852                 list_for_each_entry(c, &cdev->configs, list) {
 853                         sp = c->strings;
 854                         if (sp)
 855                                 collect_langs(sp, s->wData);
 856
 857                         list_for_each_entry(f, &c->functions, list) {
 858                                 sp = f->strings;
 859                                 if (sp)
 860                                         collect_langs(sp, s->wData);
 861                         }
 862                 }
 863
 864                 for (len = 0; len <= 126 && s->wData[len]; len++)
 865                         continue;
 866                 if (!len)
 867                         return -EINVAL;
 868
 869                 s->bLength = 2 * (len + 1);
 870                 return s->bLength;
 871         }
 872
 873         /* Otherwise, look up and return a specified string.  First
 874          * check if the string has not been overridden.
 875          */
 876         if (cdev->manufacturer_override == id)
 877                 str = iManufacturer ?: composite->iManufacturer ?:
 878                         composite_manufacturer;
 879         else if (cdev->product_override == id)
 880                 str = iProduct ?: composite->iProduct;
 881         else if (cdev->serial_override == id)
 882                 str = iSerialNumber;
 883         else
 884                 str = NULL;
 885         if (str) {
 886                 struct usb_gadget_strings strings = {
 887                         .language = language,
 888                         .strings  = &(struct usb_string) { 0xff, str }
 889                 };
 890                 return usb_gadget_get_string(&strings, 0xff, buf);
 891         }
 892
 893         /* String IDs are device-scoped, so we look up each string
 894          * table we're told about.  These lookups are infrequent;
 895          * simpler-is-better here.
 896          */
 897         if (composite->strings) {
 898                 len = lookup_string(composite->strings, buf, language, id);
 899                 if (len > 0)
 900                         return len;
 901         }
 902         list_for_each_entry(c, &cdev->configs, list) {
 903                 if (c->strings) {
 904                         len = lookup_string(c->strings, buf, language, id);
 905                         if (len > 0)
 906                                 return len;
 907                 }
 908                 list_for_each_entry(f, &c->functions, list) {
 909                         if (!f->strings)
 910                                 continue;
 911                         len = lookup_string(f->strings, buf, language, id);
 912                         if (len > 0)
 913                                 return len;
 914                 }
 915         }
 916         return -EINVAL;
 917 }
 918
 919 /**
 920  * usb_string_id() - allocate an unused string ID
 921  * @cdev: the device whose string descriptor IDs are being allocated
 922  * Context: single threaded during gadget setup
 923  *
 924  * @usb_string_id() is called from bind() callbacks to allocate
 925  * string IDs.  Drivers for functions, configurations, or gadgets will
 926  * then store that ID in the appropriate descriptors and string table.
 927  *
 928  * All string identifier should be allocated using this,
 929  * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure
 930  * that for example different functions don't wrongly assign different
 931  * meanings to the same identifier.
 932  */
 933 int usb_string_id(struct usb_composite_dev *cdev)
 934 {
 935         if (cdev->next_string_id < 254) {
 936                 /* string id 0 is reserved by USB spec for list of
 937                  * supported languages */
 938                 /* 255 reserved as well? -- mina86 */
 939                 cdev->next_string_id++;
 940                 return cdev->next_string_id;
 941         }
 942         return -ENODEV;
 943 }
 944
 945 /**
 946  * usb_string_ids() - allocate unused string IDs in batch
 947  * @cdev: the device whose string descriptor IDs are being allocated
 948  * @str: an array of usb_string objects to assign numbers to
 949  * Context: single threaded during gadget setup
 950  *
 951  * @usb_string_ids() is called from bind() callbacks to allocate
 952  * string IDs.  Drivers for functions, configurations, or gadgets will
 953  * then copy IDs from the string table to the appropriate descriptors
 954  * and string table for other languages.
 955  *
 956  * All string identifier should be allocated using this,
 957  * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
 958  * example different functions don't wrongly assign different meanings
 959  * to the same identifier.
 960  */
 961 int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str)
 962 {
 963         int next = cdev->next_string_id;
 964
 965         for (; str->s; ++str) {
 966                 if (unlikely(next >= 254))
 967                         return -ENODEV;
 968                 str->id = ++next;
 969         }
 970
 971         cdev->next_string_id = next;
 972
 973         return 0;
 974 }
 975
 976 /**
 977  * usb_string_ids_n() - allocate unused string IDs in batch
 978  * @c: the device whose string descriptor IDs are being allocated
 979  * @n: number of string IDs to allocate
 980  * Context: single threaded during gadget setup
 981  *
 982  * Returns the first requested ID.  This ID and next @n-1 IDs are now
 983  * valid IDs.  At least provided that @n is non-zero because if it
 984  * is, returns last requested ID which is now very useful information.
 985  *
 986  * @usb_string_ids_n() is called from bind() callbacks to allocate
 987  * string IDs.  Drivers for functions, configurations, or gadgets will
 988  * then store that ID in the appropriate descriptors and string table.
 989  *
 990  * All string identifier should be allocated using this,
 991  * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
 992  * example different functions don't wrongly assign different meanings
 993  * to the same identifier.
 994  */
 995 int usb_string_ids_n(struct usb_composite_dev *c, unsigned n)
 996 {
 997         unsigned next = c->next_string_id;
 998         if (unlikely(n > 254 || (unsigned)next + n > 254))
 999                 return -ENODEV;
1000         c->next_string_id += n;
1001         return next + 1;
1002 }
1003
1004
1005 /*-------------------------------------------------------------------------*/
1006
1007 static void composite_setup_complete(struct usb_ep *ep, struct usb_request *req)
1008 {
1009         if (req->status || req->actual != req->length)
1010                 DBG((struct usb_composite_dev *) ep->driver_data,
1011                                 "setup complete --> %d, %d/%d\n",
1012                                 req->status, req->actual, req->length);
1013 }
1014
1015 /*
1016  * The setup() callback implements all the ep0 functionality that's
1017  * not handled lower down, in hardware or the hardware driver(like
1018  * device and endpoint feature flags, and their status).  It's all
1019  * housekeeping for the gadget function we're implementing.  Most of
1020  * the work is in config and function specific setup.
1021  */
1022 static int
1023 composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1024 {
1025         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
1026         struct usb_request              *req = cdev->req;
1027         int                             value = -EOPNOTSUPP;
1028         int                             status = 0;
1029         u16                             w_index = le16_to_cpu(ctrl->wIndex);
1030         u8                              intf = w_index & 0xFF;
1031         u16                             w_value = le16_to_cpu(ctrl->wValue);
1032         u16                             w_length = le16_to_cpu(ctrl->wLength);
1033         struct usb_function             *f = NULL;
1034         u8                              endp;
1035
1036         /* partial re-init of the response message; the function or the
1037          * gadget might need to intercept e.g. a control-OUT completion
1038          * when we delegate to it.
1039          */
1040         req->zero = 0;
1041         req->complete = composite_setup_complete;
1042         req->length = 0;
1043         gadget->ep0->driver_data = cdev;
1044
1045         switch (ctrl->bRequest) {
1046
1047         /* we handle all standard USB descriptors */
1048         case USB_REQ_GET_DESCRIPTOR:
1049                 if (ctrl->bRequestType != USB_DIR_IN)
1050                         goto unknown;
1051                 switch (w_value >> 8) {
1052
1053                 case USB_DT_DEVICE:
1054                         cdev->desc.bNumConfigurations =
1055                                 count_configs(cdev, USB_DT_DEVICE);
1056                         cdev->desc.bMaxPacketSize0 =
1057                                 cdev->gadget->ep0->maxpacket;
1058                         if (gadget_is_superspeed(gadget)) {
1059                                 if (gadget->speed >= USB_SPEED_SUPER) {
1060                                         cdev->desc.bcdUSB = cpu_to_le16(0x0300);
1061                                         cdev->desc.bMaxPacketSize0 = 9;
1062                                 } else {
1063                                         cdev->desc.bcdUSB = cpu_to_le16(0x0210);
1064                                 }
1065                         }
1066
1067                         value = min(w_length, (u16) sizeof cdev->desc);
1068                         memcpy(req->buf, &cdev->desc, value);
1069                         break;
1070                 case USB_DT_DEVICE_QUALIFIER:
1071                         if (!gadget_is_dualspeed(gadget) ||
1072                             gadget->speed >= USB_SPEED_SUPER)
1073                                 break;
1074                         device_qual(cdev);
1075                         value = min_t(int, w_length,
1076                                 sizeof(struct usb_qualifier_descriptor));
1077                         break;
1078                 case USB_DT_OTHER_SPEED_CONFIG:
1079                         if (!gadget_is_dualspeed(gadget) ||
1080                             gadget->speed >= USB_SPEED_SUPER)
1081                                 break;
1082                         /* FALLTHROUGH */
1083                 case USB_DT_CONFIG:
1084                         value = config_desc(cdev, w_value);
1085                         if (value >= 0)
1086                                 value = min(w_length, (u16) value);
1087                         break;
1088                 case USB_DT_STRING:
1089                         value = get_string(cdev, req->buf,
1090                                         w_index, w_value & 0xff);
1091                         if (value >= 0)
1092                                 value = min(w_length, (u16) value);
1093                         break;
1094                 case USB_DT_BOS:
1095                         if (gadget_is_superspeed(gadget)) {
1096                                 value = bos_desc(cdev);
1097                                 value = min(w_length, (u16) value);
1098                         }
1099                         break;
1100                 }
1101                 break;
1102
1103         /* any number of configs can work */
1104         case USB_REQ_SET_CONFIGURATION:
1105                 if (ctrl->bRequestType != 0)
1106                         goto unknown;
1107                 if (gadget_is_otg(gadget)) {
1108                         if (gadget->a_hnp_support)
1109                                 DBG(cdev, "HNP available\n");
1110                         else if (gadget->a_alt_hnp_support)
1111                                 DBG(cdev, "HNP on another port\n");
1112                         else
1113                                 VDBG(cdev, "HNP inactive\n");
1114                 }
1115                 spin_lock(&cdev->lock);
1116                 value = set_config(cdev, ctrl, w_value);
1117                 spin_unlock(&cdev->lock);
1118                 break;
1119         case USB_REQ_GET_CONFIGURATION:
1120                 if (ctrl->bRequestType != USB_DIR_IN)
1121                         goto unknown;
1122                 if (cdev->config)
1123                         *(u8 *)req->buf = cdev->config->bConfigurationValue;
1124                 else
1125                         *(u8 *)req->buf = 0;
1126                 value = min(w_length, (u16) 1);
1127                 break;
1128
1129         /* function drivers must handle get/set altsetting; if there's
1130          * no get() method, we know only altsetting zero works.
1131          */
1132         case USB_REQ_SET_INTERFACE:
1133                 if (ctrl->bRequestType != USB_RECIP_INTERFACE)
1134                         goto unknown;
1135                 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1136                         break;
1137                 f = cdev->config->interface[intf];
1138                 if (!f)
1139                         break;
1140                 if (w_value && !f->set_alt)
1141                         break;
1142                 value = f->set_alt(f, w_index, w_value);
1143                 if (value == USB_GADGET_DELAYED_STATUS) {
1144                         DBG(cdev,
1145                          "%s: interface %d (%s) requested delayed status\n",
1146                                         __func__, intf, f->name);
1147                         cdev->delayed_status++;
1148                         DBG(cdev, "delayed_status count %d\n",
1149                                         cdev->delayed_status);
1150                 }
1151                 break;
1152         case USB_REQ_GET_INTERFACE:
1153                 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE))
1154                         goto unknown;
1155                 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1156                         break;
1157                 f = cdev->config->interface[intf];
1158                 if (!f)
1159                         break;
1160                 /* lots of interfaces only need altsetting zero... */
1161                 value = f->get_alt ? f->get_alt(f, w_index) : 0;
1162                 if (value < 0)
1163                         break;
1164                 *((u8 *)req->buf) = value;
1165                 value = min(w_length, (u16) 1);
1166                 break;
1167
1168         /*
1169          * USB 3.0 additions:
1170          * Function driver should handle get_status request. If such cb
1171          * wasn't supplied we respond with default value = 0
1172          * Note: function driver should supply such cb only for the first
1173          * interface of the function
1174          */
1175         case USB_REQ_GET_STATUS:
1176                 if (!gadget_is_superspeed(gadget))
1177                         goto unknown;
1178                 if (ctrl->bRequestType != (USB_DIR_IN | USB_RECIP_INTERFACE))
1179                         goto unknown;
1180                 value = 2;      /* This is the length of the get_status reply */
1181                 put_unaligned_le16(0, req->buf);
1182                 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1183                         break;
1184                 f = cdev->config->interface[intf];
1185                 if (!f)
1186                         break;
1187                 status = f->get_status ? f->get_status(f) : 0;
1188                 if (status < 0)
1189                         break;
1190                 put_unaligned_le16(status & 0x0000ffff, req->buf);
1191                 break;
1192         /*
1193          * Function drivers should handle SetFeature/ClearFeature
1194          * (FUNCTION_SUSPEND) request. function_suspend cb should be supplied
1195          * only for the first interface of the function
1196          */
1197         case USB_REQ_CLEAR_FEATURE:
1198         case USB_REQ_SET_FEATURE:
1199                 if (!gadget_is_superspeed(gadget))
1200                         goto unknown;
1201                 if (ctrl->bRequestType != (USB_DIR_OUT | USB_RECIP_INTERFACE))
1202                         goto unknown;
1203                 switch (w_value) {
1204                 case USB_INTRF_FUNC_SUSPEND:
1205                         if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1206                                 break;
1207                         f = cdev->config->interface[intf];
1208                         if (!f)
1209                                 break;
1210                         value = 0;
1211                         if (f->func_suspend)
1212                                 value = f->func_suspend(f, w_index >> 8);
1213                         if (value < 0) {
1214                                 ERROR(cdev,
1215                                       "func_suspend() returned error %d\n",
1216                                       value);
1217                                 value = 0;
1218                         }
1219                         break;
1220                 }
1221                 break;
1222         default:
1223 unknown:
1224                 VDBG(cdev,
1225                         "non-core control req%02x.%02x v%04x i%04x l%d\n",
1226                         ctrl->bRequestType, ctrl->bRequest,
1227                         w_value, w_index, w_length);
1228
1229                 /* functions always handle their interfaces and endpoints...
1230                  * punt other recipients (other, WUSB, ...) to the current
1231                  * configuration code.
1232                  *
1233                  * REVISIT it could make sense to let the composite device
1234                  * take such requests too, if that's ever needed:  to work
1235                  * in config 0, etc.
1236                  */
1237                 switch (ctrl->bRequestType & USB_RECIP_MASK) {
1238                 case USB_RECIP_INTERFACE:
1239                         if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1240                                 break;
1241                         f = cdev->config->interface[intf];
1242                         break;
1243
1244                 case USB_RECIP_ENDPOINT:
1245                         endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f);
1246                         list_for_each_entry(f, &cdev->config->functions, list) {
1247                                 if (test_bit(endp, f->endpoints))
1248                                         break;
1249                         }
1250                         if (&f->list == &cdev->config->functions)
1251                                 f = NULL;
1252                         break;
1253                 }
1254
1255                 if (f && f->setup)
1256                         value = f->setup(f, ctrl);
1257                 else {
1258                         struct usb_configuration        *c;
1259
1260                         c = cdev->config;
1261                         if (c && c->setup)
1262                                 value = c->setup(c, ctrl);
1263                 }
1264
1265                 goto done;
1266         }
1267
1268         /* respond with data transfer before status phase? */
1269         if (value >= 0 && value != USB_GADGET_DELAYED_STATUS) {
1270                 req->length = value;
1271                 req->zero = value < w_length;
1272                 value = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
1273                 if (value < 0) {
1274                         DBG(cdev, "ep_queue --> %d\n", value);
1275                         req->status = 0;
1276                         composite_setup_complete(gadget->ep0, req);
1277                 }
1278         } else if (value == USB_GADGET_DELAYED_STATUS && w_length != 0) {
1279                 WARN(cdev,
1280                         "%s: Delayed status not supported for w_length != 0",
1281                         __func__);
1282         }
1283
1284 done:
1285         /* device either stalls (value < 0) or reports success */
1286         return value;
1287 }
1288
1289 static void composite_disconnect(struct usb_gadget *gadget)
1290 {
1291         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
1292         unsigned long                   flags;
1293
1294         /* REVISIT:  should we have config and device level
1295          * disconnect callbacks?
1296          */
1297         spin_lock_irqsave(&cdev->lock, flags);
1298         if (cdev->config)
1299                 reset_config(cdev);
1300         if (composite->disconnect)
1301                 composite->disconnect(cdev);
1302         spin_unlock_irqrestore(&cdev->lock, flags);
1303 }
1304
1305 /*-------------------------------------------------------------------------*/
1306
1307 static ssize_t composite_show_suspended(struct device *dev,
1308                                         struct device_attribute *attr,
1309                                         char *buf)
1310 {
1311         struct usb_gadget *gadget = dev_to_usb_gadget(dev);
1312         struct usb_composite_dev *cdev = get_gadget_data(gadget);
1313
1314         return sprintf(buf, "%d\n", cdev->suspended);
1315 }
1316
1317 static DEVICE_ATTR(suspended, 0444, composite_show_suspended, NULL);
1318
1319 static void
1320 composite_unbind(struct usb_gadget *gadget)
1321 {
1322         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
1323
1324         /* composite_disconnect() must already have been called
1325          * by the underlying peripheral controller driver!
1326          * so there's no i/o concurrency that could affect the
1327          * state protected by cdev->lock.
1328          */
1329         WARN_ON(cdev->config);
1330
1331         while (!list_empty(&cdev->configs)) {
1332                 struct usb_configuration        *c;
1333
1334                 c = list_first_entry(&cdev->configs,
1335                                 struct usb_configuration, list);
1336                 while (!list_empty(&c->functions)) {
1337                         struct usb_function             *f;
1338
1339                         f = list_first_entry(&c->functions,
1340                                         struct usb_function, list);
1341                         list_del(&f->list);
1342                         if (f->unbind) {
1343                                 DBG(cdev, "unbind function '%s'/%p\n",
1344                                                 f->name, f);
1345                                 f->unbind(c, f);
1346                                 /* may free memory for "f" */
1347                         }
1348                 }
1349                 list_del(&c->list);
1350                 if (c->unbind) {
1351                         DBG(cdev, "unbind config '%s'/%p\n", c->label, c);
1352                         c->unbind(c);
1353                         /* may free memory for "c" */
1354                 }
1355         }
1356         if (composite->unbind)
1357                 composite->unbind(cdev);
1358
1359         if (cdev->req) {
1360                 kfree(cdev->req->buf);
1361                 usb_ep_free_request(gadget->ep0, cdev->req);
1362         }
1363         device_remove_file(&gadget->dev, &dev_attr_suspended);
1364         kfree(cdev);
1365         set_gadget_data(gadget, NULL);
1366         composite = NULL;
1367 }
1368
1369 static u8 override_id(struct usb_composite_dev *cdev, u8 *desc)
1370 {
1371         if (!*desc) {
1372                 int ret = usb_string_id(cdev);
1373                 if (unlikely(ret < 0))
1374                         WARNING(cdev, "failed to override string ID\n");
1375                 else
1376                         *desc = ret;
1377         }
1378
1379         return *desc;
1380 }
1381
1382 static int composite_bind(struct usb_gadget *gadget)
1383 {
1384         struct usb_composite_dev        *cdev;
1385         int                             status = -ENOMEM;
1386
1387         cdev = kzalloc(sizeof *cdev, GFP_KERNEL);
1388         if (!cdev)
1389                 return status;
1390
1391         spin_lock_init(&cdev->lock);
1392         cdev->gadget = gadget;
1393         set_gadget_data(gadget, cdev);
1394         INIT_LIST_HEAD(&cdev->configs);
1395
1396         /* preallocate control response and buffer */
1397         cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
1398         if (!cdev->req)
1399                 goto fail;
1400         cdev->req->buf = kmalloc(USB_BUFSIZ, GFP_KERNEL);
1401         if (!cdev->req->buf)
1402                 goto fail;
1403         cdev->req->complete = composite_setup_complete;
1404         gadget->ep0->driver_data = cdev;
1405
1406         cdev->bufsiz = USB_BUFSIZ;
1407         cdev->driver = composite;
1408
1409         /*
1410          * As per USB compliance update, a device that is actively drawing
1411          * more than 100mA from USB must report itself as bus-powered in
1412          * the GetStatus(DEVICE) call.
1413          */
1414         if (CONFIG_USB_GADGET_VBUS_DRAW <= USB_SELF_POWER_VBUS_MAX_DRAW)
1415                 usb_gadget_set_selfpowered(gadget);
1416
1417         /* interface and string IDs start at zero via kzalloc.
1418          * we force endpoints to start unassigned; few controller
1419          * drivers will zero ep->driver_data.
1420          */
1421         usb_ep_autoconfig_reset(cdev->gadget);
1422
1423         /* composite gadget needs to assign strings for whole device (like
1424          * serial number), register function drivers, potentially update
1425          * power state and consumption, etc
1426          */
1427         status = composite_gadget_bind(cdev);
1428         if (status < 0)
1429                 goto fail;
1430
1431         cdev->desc = *composite->dev;
1432
1433         /* standardized runtime overrides for device ID data */
1434         if (idVendor)
1435                 cdev->desc.idVendor = cpu_to_le16(idVendor);
1436         if (idProduct)
1437                 cdev->desc.idProduct = cpu_to_le16(idProduct);
1438         if (bcdDevice)
1439                 cdev->desc.bcdDevice = cpu_to_le16(bcdDevice);
1440
1441         /* string overrides */
1442         if (iManufacturer || !cdev->desc.iManufacturer) {
1443                 if (!iManufacturer && !composite->iManufacturer &&
1444                     !*composite_manufacturer)
1445                         snprintf(composite_manufacturer,
1446                                  sizeof composite_manufacturer,
1447                                  "%s %s with %s",
1448                                  init_utsname()->sysname,
1449                                  init_utsname()->release,
1450                                  gadget->name);
1451
1452                 cdev->manufacturer_override =
1453                         override_id(cdev, &cdev->desc.iManufacturer);
1454         }
1455
1456         if (iProduct || (!cdev->desc.iProduct && composite->iProduct))
1457                 cdev->product_override =
1458                         override_id(cdev, &cdev->desc.iProduct);
1459
1460         if (iSerialNumber)
1461                 cdev->serial_override =
1462                         override_id(cdev, &cdev->desc.iSerialNumber);
1463
1464         /* has userspace failed to provide a serial number? */
1465         if (composite->needs_serial && !cdev->desc.iSerialNumber)
1466                 WARNING(cdev, "userspace failed to provide iSerialNumber\n");
1467
1468         /* finish up */
1469         status = device_create_file(&gadget->dev, &dev_attr_suspended);
1470         if (status)
1471                 goto fail;
1472
1473         INFO(cdev, "%s ready\n", composite->name);
1474         return 0;
1475
1476 fail:
1477         composite_unbind(gadget);
1478         return status;
1479 }
1480
1481 /*-------------------------------------------------------------------------*/
1482
1483 static void
1484 composite_suspend(struct usb_gadget *gadget)
1485 {
1486         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
1487         struct usb_function             *f;
1488
1489         /* REVISIT:  should we have config level
1490          * suspend/resume callbacks?
1491          */
1492         DBG(cdev, "suspend\n");
1493         if (cdev->config) {
1494                 list_for_each_entry(f, &cdev->config->functions, list) {
1495                         if (f->suspend)
1496                                 f->suspend(f);
1497                 }
1498         }
1499         if (composite->suspend)
1500                 composite->suspend(cdev);
1501
1502         cdev->suspended = 1;
1503
1504         usb_gadget_vbus_draw(gadget, 2);
1505 }
1506
1507 static void
1508 composite_resume(struct usb_gadget *gadget)
1509 {
1510         struct usb_composite_dev        *cdev = get_gadget_data(gadget);
1511         struct usb_function             *f;
1512         u8                              maxpower;
1513
1514         /* REVISIT:  should we have config level
1515          * suspend/resume callbacks?
1516          */
1517         DBG(cdev, "resume\n");
1518         if (composite->resume)
1519                 composite->resume(cdev);
1520         if (cdev->config) {
1521                 list_for_each_entry(f, &cdev->config->functions, list) {
1522                         if (f->resume)
1523                                 f->resume(f);
1524                 }
1525
1526                 maxpower = cdev->config->bMaxPower;
1527
1528                 usb_gadget_vbus_draw(gadget, maxpower ?
1529                         (2 * maxpower) : CONFIG_USB_GADGET_VBUS_DRAW);
1530         }
1531
1532         cdev->suspended = 0;
1533 }
1534
1535 /*-------------------------------------------------------------------------*/
1536
1537 static struct usb_gadget_driver composite_driver = {
1538 #ifdef CONFIG_USB_GADGET_SUPERSPEED
1539         .speed          = USB_SPEED_SUPER,
1540 #else
1541         .speed          = USB_SPEED_HIGH,
1542 #endif
1543
1544         .unbind         = composite_unbind,
1545
1546         .setup          = composite_setup,
1547         .disconnect     = composite_disconnect,
1548
1549         .suspend        = composite_suspend,
1550         .resume         = composite_resume,
1551
1552         .driver = {
1553                 .owner          = THIS_MODULE,
1554         },
1555 };
1556
1557 /**
1558  * usb_composite_probe() - register a composite driver
1559  * @driver: the driver to register
1560  * @bind: the callback used to allocate resources that are shared across the
1561  *      whole device, such as string IDs, and add its configurations using
1562  *      @usb_add_config().  This may fail by returning a negative errno
1563  *      value; it should return zero on successful initialization.
1564  * Context: single threaded during gadget setup
1565  *
1566  * This function is used to register drivers using the composite driver
1567  * framework.  The return value is zero, or a negative errno value.
1568  * Those values normally come from the driver's @bind method, which does
1569  * all the work of setting up the driver to match the hardware.
1570  *
1571  * On successful return, the gadget is ready to respond to requests from
1572  * the host, unless one of its components invokes usb_gadget_disconnect()
1573  * while it was binding.  That would usually be done in order to wait for
1574  * some userspace participation.
1575  */
1576 int usb_composite_probe(struct usb_composite_driver *driver,
1577                                int (*bind)(struct usb_composite_dev *cdev))
1578 {
1579         if (!driver || !driver->dev || !bind || composite)
1580                 return -EINVAL;
1581
1582         if (!driver->name)
1583                 driver->name = "composite";
1584         if (!driver->iProduct)
1585                 driver->iProduct = driver->name;
1586         composite_driver.function =  (char *) driver->name;
1587         composite_driver.driver.name = driver->name;
1588         composite_driver.speed = min((u8)composite_driver.speed,
1589                                      (u8)driver->max_speed);
1590         composite = driver;
1591         composite_gadget_bind = bind;
1592
1593         return usb_gadget_probe_driver(&composite_driver, composite_bind);
1594 }
1595
1596 /**
1597  * usb_composite_unregister() - unregister a composite driver
1598  * @driver: the driver to unregister
1599  *
1600  * This function is used to unregister drivers using the composite
1601  * driver framework.
1602  */
1603 void usb_composite_unregister(struct usb_composite_driver *driver)
1604 {
1605         if (composite != driver)
1606                 return;
1607         usb_gadget_unregister_driver(&composite_driver);
1608 }
1609
1610 /**
1611  * usb_composite_setup_continue() - Continue with the control transfer
1612  * @cdev: the composite device who's control transfer was kept waiting
1613  *
1614  * This function must be called by the USB function driver to continue
1615  * with the control transfer's data/status stage in case it had requested to
1616  * delay the data/status stages. A USB function's setup handler (e.g. set_alt())
1617  * can request the composite framework to delay the setup request's data/status
1618  * stages by returning USB_GADGET_DELAYED_STATUS.
1619  */
1620 void usb_composite_setup_continue(struct usb_composite_dev *cdev)
1621 {
1622         int                     value;
1623         struct usb_request      *req = cdev->req;
1624         unsigned long           flags;
1625
1626         DBG(cdev, "%s\n", __func__);
1627         spin_lock_irqsave(&cdev->lock, flags);
1628
1629         if (cdev->delayed_status == 0) {
1630                 WARN(cdev, "%s: Unexpected call\n", __func__);
1631
1632         } else if (--cdev->delayed_status == 0) {
1633                 DBG(cdev, "%s: Completing delayed status\n", __func__);
1634                 req->length = 0;
1635                 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
1636                 if (value < 0) {
1637                         DBG(cdev, "ep_queue --> %d\n", value);
1638                         req->status = 0;
1639                         composite_setup_complete(cdev->gadget->ep0, req);
1640                 }
1641         }
1642
1643         spin_unlock_irqrestore(&cdev->lock, flags);
1644 }
1645