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