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