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