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 */
32 struct 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
get_containers_gs(struct usb_gadget_string_container * uc)47 static 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 */
60 static struct usb_descriptor_header **
function_descriptors(struct usb_function * f,enum usb_device_speed speed)61 function_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 */
109 static struct usb_descriptor_header**
next_desc(struct usb_descriptor_header ** t,u8 desc_type)110 next_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 */
config_ep_by_speed_and_alt(struct usb_gadget * g,struct usb_function * f,struct usb_ep * _ep,u8 alt)149 int 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
220 intf_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
229 ep_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 }
272 EXPORT_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 */
config_ep_by_speed(struct usb_gadget * g,struct usb_function * f,struct usb_ep * _ep)292 int 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 }
298 EXPORT_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 */
usb_add_function(struct usb_configuration * config,struct usb_function * function)314 int 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
359 done:
360 if (value)
361 DBG(config->cdev, "adding '%s'/%p --> %d\n",
362 function->name, function, value);
363 return value;
364 }
365 EXPORT_SYMBOL_GPL(usb_add_function);
366
usb_remove_function(struct usb_configuration * c,struct usb_function * f)367 void 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 }
380 EXPORT_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 */
usb_function_deactivate(struct usb_function * function)401 int 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 }
420 EXPORT_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 */
usb_function_activate(struct usb_function * function)432 int 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 }
454 EXPORT_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 */
usb_interface_id(struct usb_configuration * config,struct usb_function * function)479 int 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 }
491 EXPORT_SYMBOL_GPL(usb_interface_id);
492
encode_bMaxPower(enum usb_device_speed speed,struct usb_configuration * c)493 static 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
config_buf(struct usb_configuration * config,enum usb_device_speed speed,void * buf,u8 type)514 static 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
config_desc(struct usb_composite_dev * cdev,unsigned w_value)565 static 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
601 check_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
count_configs(struct usb_composite_dev * cdev,unsigned type)628 static 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 */
bos_desc(struct usb_composite_dev * cdev)676 static 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
device_qual(struct usb_composite_dev * cdev)827 static 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
reset_config(struct usb_composite_dev * cdev)846 static 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
set_config(struct usb_composite_dev * cdev,const struct usb_ctrlrequest * ctrl,unsigned number)862 static 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);
962 done:
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
usb_add_config_only(struct usb_composite_dev * cdev,struct usb_configuration * config)974 int 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 }
997 EXPORT_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 */
usb_add_config(struct usb_composite_dev * cdev,struct usb_configuration * config,int (* bind)(struct usb_configuration *))1014 int 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
1033 if (status == 0)
1034 status = usb_gadget_check_config(cdev->gadget);
1035
1036 if (status < 0) {
1037 while (!list_empty(&config->functions)) {
1038 struct usb_function *f;
1039
1040 f = list_first_entry(&config->functions,
1041 struct usb_function, list);
1042 list_del(&f->list);
1043 if (f->unbind) {
1044 DBG(cdev, "unbind function '%s'/%p\n",
1045 f->name, f);
1046 f->unbind(config, f);
1047 /* may free memory for "f" */
1048 }
1049 }
1050 list_del(&config->list);
1051 config->cdev = NULL;
1052 } else {
1053 unsigned i;
1054
1055 DBG(cdev, "cfg %d/%p speeds:%s%s%s%s\n",
1056 config->bConfigurationValue, config,
1057 config->superspeed_plus ? " superplus" : "",
1058 config->superspeed ? " super" : "",
1059 config->highspeed ? " high" : "",
1060 config->fullspeed
1061 ? (gadget_is_dualspeed(cdev->gadget)
1062 ? " full"
1063 : " full/low")
1064 : "");
1065
1066 for (i = 0; i < MAX_CONFIG_INTERFACES; i++) {
1067 struct usb_function *f = config->interface[i];
1068
1069 if (!f)
1070 continue;
1071 DBG(cdev, " interface %d = %s/%p\n",
1072 i, f->name, f);
1073 }
1074 }
1075
1076 /* set_alt(), or next bind(), sets up ep->claimed as needed */
1077 usb_ep_autoconfig_reset(cdev->gadget);
1078
1079 done:
1080 if (status)
1081 DBG(cdev, "added config '%s'/%u --> %d\n", config->label,
1082 config->bConfigurationValue, status);
1083 return status;
1084 }
1085 EXPORT_SYMBOL_GPL(usb_add_config);
1086
remove_config(struct usb_composite_dev * cdev,struct usb_configuration * config)1087 static void remove_config(struct usb_composite_dev *cdev,
1088 struct usb_configuration *config)
1089 {
1090 while (!list_empty(&config->functions)) {
1091 struct usb_function *f;
1092
1093 f = list_first_entry(&config->functions,
1094 struct usb_function, list);
1095
1096 usb_remove_function(config, f);
1097 }
1098 list_del(&config->list);
1099 if (config->unbind) {
1100 DBG(cdev, "unbind config '%s'/%p\n", config->label, config);
1101 config->unbind(config);
1102 /* may free memory for "c" */
1103 }
1104 }
1105
1106 /**
1107 * usb_remove_config() - remove a configuration from a device.
1108 * @cdev: wraps the USB gadget
1109 * @config: the configuration
1110 *
1111 * Drivers must call usb_gadget_disconnect before calling this function
1112 * to disconnect the device from the host and make sure the host will not
1113 * try to enumerate the device while we are changing the config list.
1114 */
usb_remove_config(struct usb_composite_dev * cdev,struct usb_configuration * config)1115 void usb_remove_config(struct usb_composite_dev *cdev,
1116 struct usb_configuration *config)
1117 {
1118 unsigned long flags;
1119
1120 spin_lock_irqsave(&cdev->lock, flags);
1121
1122 if (cdev->config == config)
1123 reset_config(cdev);
1124
1125 spin_unlock_irqrestore(&cdev->lock, flags);
1126
1127 remove_config(cdev, config);
1128 }
1129
1130 /*-------------------------------------------------------------------------*/
1131
1132 /* We support strings in multiple languages ... string descriptor zero
1133 * says which languages are supported. The typical case will be that
1134 * only one language (probably English) is used, with i18n handled on
1135 * the host side.
1136 */
1137
collect_langs(struct usb_gadget_strings ** sp,__le16 * buf)1138 static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf)
1139 {
1140 const struct usb_gadget_strings *s;
1141 __le16 language;
1142 __le16 *tmp;
1143
1144 while (*sp) {
1145 s = *sp;
1146 language = cpu_to_le16(s->language);
1147 for (tmp = buf; *tmp && tmp < &buf[USB_MAX_STRING_LEN]; tmp++) {
1148 if (*tmp == language)
1149 goto repeat;
1150 }
1151 *tmp++ = language;
1152 repeat:
1153 sp++;
1154 }
1155 }
1156
lookup_string(struct usb_gadget_strings ** sp,void * buf,u16 language,int id)1157 static int lookup_string(
1158 struct usb_gadget_strings **sp,
1159 void *buf,
1160 u16 language,
1161 int id
1162 )
1163 {
1164 struct usb_gadget_strings *s;
1165 int value;
1166
1167 while (*sp) {
1168 s = *sp++;
1169 if (s->language != language)
1170 continue;
1171 value = usb_gadget_get_string(s, id, buf);
1172 if (value > 0)
1173 return value;
1174 }
1175 return -EINVAL;
1176 }
1177
get_string(struct usb_composite_dev * cdev,void * buf,u16 language,int id)1178 static int get_string(struct usb_composite_dev *cdev,
1179 void *buf, u16 language, int id)
1180 {
1181 struct usb_composite_driver *composite = cdev->driver;
1182 struct usb_gadget_string_container *uc;
1183 struct usb_configuration *c;
1184 struct usb_function *f;
1185 int len;
1186
1187 /* Yes, not only is USB's i18n support probably more than most
1188 * folk will ever care about ... also, it's all supported here.
1189 * (Except for UTF8 support for Unicode's "Astral Planes".)
1190 */
1191
1192 /* 0 == report all available language codes */
1193 if (id == 0) {
1194 struct usb_string_descriptor *s = buf;
1195 struct usb_gadget_strings **sp;
1196
1197 memset(s, 0, 256);
1198 s->bDescriptorType = USB_DT_STRING;
1199
1200 sp = composite->strings;
1201 if (sp)
1202 collect_langs(sp, s->wData);
1203
1204 list_for_each_entry(c, &cdev->configs, list) {
1205 sp = c->strings;
1206 if (sp)
1207 collect_langs(sp, s->wData);
1208
1209 list_for_each_entry(f, &c->functions, list) {
1210 sp = f->strings;
1211 if (sp)
1212 collect_langs(sp, s->wData);
1213 }
1214 }
1215 list_for_each_entry(uc, &cdev->gstrings, list) {
1216 struct usb_gadget_strings **sp;
1217
1218 sp = get_containers_gs(uc);
1219 collect_langs(sp, s->wData);
1220 }
1221
1222 for (len = 0; len <= USB_MAX_STRING_LEN && s->wData[len]; len++)
1223 continue;
1224 if (!len)
1225 return -EINVAL;
1226
1227 s->bLength = 2 * (len + 1);
1228 return s->bLength;
1229 }
1230
1231 if (cdev->use_os_string && language == 0 && id == OS_STRING_IDX) {
1232 struct usb_os_string *b = buf;
1233 b->bLength = sizeof(*b);
1234 b->bDescriptorType = USB_DT_STRING;
1235 compiletime_assert(
1236 sizeof(b->qwSignature) == sizeof(cdev->qw_sign),
1237 "qwSignature size must be equal to qw_sign");
1238 memcpy(&b->qwSignature, cdev->qw_sign, sizeof(b->qwSignature));
1239 b->bMS_VendorCode = cdev->b_vendor_code;
1240 b->bPad = 0;
1241 return sizeof(*b);
1242 }
1243
1244 list_for_each_entry(uc, &cdev->gstrings, list) {
1245 struct usb_gadget_strings **sp;
1246
1247 sp = get_containers_gs(uc);
1248 len = lookup_string(sp, buf, language, id);
1249 if (len > 0)
1250 return len;
1251 }
1252
1253 /* String IDs are device-scoped, so we look up each string
1254 * table we're told about. These lookups are infrequent;
1255 * simpler-is-better here.
1256 */
1257 if (composite->strings) {
1258 len = lookup_string(composite->strings, buf, language, id);
1259 if (len > 0)
1260 return len;
1261 }
1262 list_for_each_entry(c, &cdev->configs, list) {
1263 if (c->strings) {
1264 len = lookup_string(c->strings, buf, language, id);
1265 if (len > 0)
1266 return len;
1267 }
1268 list_for_each_entry(f, &c->functions, list) {
1269 if (!f->strings)
1270 continue;
1271 len = lookup_string(f->strings, buf, language, id);
1272 if (len > 0)
1273 return len;
1274 }
1275 }
1276 return -EINVAL;
1277 }
1278
1279 /**
1280 * usb_string_id() - allocate an unused string ID
1281 * @cdev: the device whose string descriptor IDs are being allocated
1282 * Context: single threaded during gadget setup
1283 *
1284 * @usb_string_id() is called from bind() callbacks to allocate
1285 * string IDs. Drivers for functions, configurations, or gadgets will
1286 * then store that ID in the appropriate descriptors and string table.
1287 *
1288 * All string identifier should be allocated using this,
1289 * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure
1290 * that for example different functions don't wrongly assign different
1291 * meanings to the same identifier.
1292 */
usb_string_id(struct usb_composite_dev * cdev)1293 int usb_string_id(struct usb_composite_dev *cdev)
1294 {
1295 if (cdev->next_string_id < 254) {
1296 /* string id 0 is reserved by USB spec for list of
1297 * supported languages */
1298 /* 255 reserved as well? -- mina86 */
1299 cdev->next_string_id++;
1300 return cdev->next_string_id;
1301 }
1302 return -ENODEV;
1303 }
1304 EXPORT_SYMBOL_GPL(usb_string_id);
1305
1306 /**
1307 * usb_string_ids_tab() - allocate unused string IDs in batch
1308 * @cdev: the device whose string descriptor IDs are being allocated
1309 * @str: an array of usb_string objects to assign numbers to
1310 * Context: single threaded during gadget setup
1311 *
1312 * @usb_string_ids() is called from bind() callbacks to allocate
1313 * string IDs. Drivers for functions, configurations, or gadgets will
1314 * then copy IDs from the string table to the appropriate descriptors
1315 * and string table for other languages.
1316 *
1317 * All string identifier should be allocated using this,
1318 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1319 * example different functions don't wrongly assign different meanings
1320 * to the same identifier.
1321 */
usb_string_ids_tab(struct usb_composite_dev * cdev,struct usb_string * str)1322 int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str)
1323 {
1324 int next = cdev->next_string_id;
1325
1326 for (; str->s; ++str) {
1327 if (unlikely(next >= 254))
1328 return -ENODEV;
1329 str->id = ++next;
1330 }
1331
1332 cdev->next_string_id = next;
1333
1334 return 0;
1335 }
1336 EXPORT_SYMBOL_GPL(usb_string_ids_tab);
1337
copy_gadget_strings(struct usb_gadget_strings ** sp,unsigned n_gstrings,unsigned n_strings)1338 static struct usb_gadget_string_container *copy_gadget_strings(
1339 struct usb_gadget_strings **sp, unsigned n_gstrings,
1340 unsigned n_strings)
1341 {
1342 struct usb_gadget_string_container *uc;
1343 struct usb_gadget_strings **gs_array;
1344 struct usb_gadget_strings *gs;
1345 struct usb_string *s;
1346 unsigned mem;
1347 unsigned n_gs;
1348 unsigned n_s;
1349 void *stash;
1350
1351 mem = sizeof(*uc);
1352 mem += sizeof(void *) * (n_gstrings + 1);
1353 mem += sizeof(struct usb_gadget_strings) * n_gstrings;
1354 mem += sizeof(struct usb_string) * (n_strings + 1) * (n_gstrings);
1355 uc = kmalloc(mem, GFP_KERNEL);
1356 if (!uc)
1357 return ERR_PTR(-ENOMEM);
1358 gs_array = get_containers_gs(uc);
1359 stash = uc->stash;
1360 stash += sizeof(void *) * (n_gstrings + 1);
1361 for (n_gs = 0; n_gs < n_gstrings; n_gs++) {
1362 struct usb_string *org_s;
1363
1364 gs_array[n_gs] = stash;
1365 gs = gs_array[n_gs];
1366 stash += sizeof(struct usb_gadget_strings);
1367 gs->language = sp[n_gs]->language;
1368 gs->strings = stash;
1369 org_s = sp[n_gs]->strings;
1370
1371 for (n_s = 0; n_s < n_strings; n_s++) {
1372 s = stash;
1373 stash += sizeof(struct usb_string);
1374 if (org_s->s)
1375 s->s = org_s->s;
1376 else
1377 s->s = "";
1378 org_s++;
1379 }
1380 s = stash;
1381 s->s = NULL;
1382 stash += sizeof(struct usb_string);
1383
1384 }
1385 gs_array[n_gs] = NULL;
1386 return uc;
1387 }
1388
1389 /**
1390 * usb_gstrings_attach() - attach gadget strings to a cdev and assign ids
1391 * @cdev: the device whose string descriptor IDs are being allocated
1392 * and attached.
1393 * @sp: an array of usb_gadget_strings to attach.
1394 * @n_strings: number of entries in each usb_strings array (sp[]->strings)
1395 *
1396 * This function will create a deep copy of usb_gadget_strings and usb_string
1397 * and attach it to the cdev. The actual string (usb_string.s) will not be
1398 * copied but only a referenced will be made. The struct usb_gadget_strings
1399 * array may contain multiple languages and should be NULL terminated.
1400 * The ->language pointer of each struct usb_gadget_strings has to contain the
1401 * same amount of entries.
1402 * For instance: sp[0] is en-US, sp[1] is es-ES. It is expected that the first
1403 * usb_string entry of es-ES contains the translation of the first usb_string
1404 * entry of en-US. Therefore both entries become the same id assign.
1405 */
usb_gstrings_attach(struct usb_composite_dev * cdev,struct usb_gadget_strings ** sp,unsigned n_strings)1406 struct usb_string *usb_gstrings_attach(struct usb_composite_dev *cdev,
1407 struct usb_gadget_strings **sp, unsigned n_strings)
1408 {
1409 struct usb_gadget_string_container *uc;
1410 struct usb_gadget_strings **n_gs;
1411 unsigned n_gstrings = 0;
1412 unsigned i;
1413 int ret;
1414
1415 for (i = 0; sp[i]; i++)
1416 n_gstrings++;
1417
1418 if (!n_gstrings)
1419 return ERR_PTR(-EINVAL);
1420
1421 uc = copy_gadget_strings(sp, n_gstrings, n_strings);
1422 if (IS_ERR(uc))
1423 return ERR_CAST(uc);
1424
1425 n_gs = get_containers_gs(uc);
1426 ret = usb_string_ids_tab(cdev, n_gs[0]->strings);
1427 if (ret)
1428 goto err;
1429
1430 for (i = 1; i < n_gstrings; i++) {
1431 struct usb_string *m_s;
1432 struct usb_string *s;
1433 unsigned n;
1434
1435 m_s = n_gs[0]->strings;
1436 s = n_gs[i]->strings;
1437 for (n = 0; n < n_strings; n++) {
1438 s->id = m_s->id;
1439 s++;
1440 m_s++;
1441 }
1442 }
1443 list_add_tail(&uc->list, &cdev->gstrings);
1444 return n_gs[0]->strings;
1445 err:
1446 kfree(uc);
1447 return ERR_PTR(ret);
1448 }
1449 EXPORT_SYMBOL_GPL(usb_gstrings_attach);
1450
1451 /**
1452 * usb_string_ids_n() - allocate unused string IDs in batch
1453 * @c: the device whose string descriptor IDs are being allocated
1454 * @n: number of string IDs to allocate
1455 * Context: single threaded during gadget setup
1456 *
1457 * Returns the first requested ID. This ID and next @n-1 IDs are now
1458 * valid IDs. At least provided that @n is non-zero because if it
1459 * is, returns last requested ID which is now very useful information.
1460 *
1461 * @usb_string_ids_n() is called from bind() callbacks to allocate
1462 * string IDs. Drivers for functions, configurations, or gadgets will
1463 * then store that ID in the appropriate descriptors and string table.
1464 *
1465 * All string identifier should be allocated using this,
1466 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1467 * example different functions don't wrongly assign different meanings
1468 * to the same identifier.
1469 */
usb_string_ids_n(struct usb_composite_dev * c,unsigned n)1470 int usb_string_ids_n(struct usb_composite_dev *c, unsigned n)
1471 {
1472 unsigned next = c->next_string_id;
1473 if (unlikely(n > 254 || (unsigned)next + n > 254))
1474 return -ENODEV;
1475 c->next_string_id += n;
1476 return next + 1;
1477 }
1478 EXPORT_SYMBOL_GPL(usb_string_ids_n);
1479
1480 /*-------------------------------------------------------------------------*/
1481
composite_setup_complete(struct usb_ep * ep,struct usb_request * req)1482 static void composite_setup_complete(struct usb_ep *ep, struct usb_request *req)
1483 {
1484 struct usb_composite_dev *cdev;
1485
1486 if (req->status || req->actual != req->length)
1487 DBG((struct usb_composite_dev *) ep->driver_data,
1488 "setup complete --> %d, %d/%d\n",
1489 req->status, req->actual, req->length);
1490
1491 /*
1492 * REVIST The same ep0 requests are shared with function drivers
1493 * so they don't have to maintain the same ->complete() stubs.
1494 *
1495 * Because of that, we need to check for the validity of ->context
1496 * here, even though we know we've set it to something useful.
1497 */
1498 if (!req->context)
1499 return;
1500
1501 cdev = req->context;
1502
1503 if (cdev->req == req)
1504 cdev->setup_pending = false;
1505 else if (cdev->os_desc_req == req)
1506 cdev->os_desc_pending = false;
1507 else
1508 WARN(1, "unknown request %p\n", req);
1509 }
1510
composite_ep0_queue(struct usb_composite_dev * cdev,struct usb_request * req,gfp_t gfp_flags)1511 static int composite_ep0_queue(struct usb_composite_dev *cdev,
1512 struct usb_request *req, gfp_t gfp_flags)
1513 {
1514 int ret;
1515
1516 ret = usb_ep_queue(cdev->gadget->ep0, req, gfp_flags);
1517 if (ret == 0) {
1518 if (cdev->req == req)
1519 cdev->setup_pending = true;
1520 else if (cdev->os_desc_req == req)
1521 cdev->os_desc_pending = true;
1522 else
1523 WARN(1, "unknown request %p\n", req);
1524 }
1525
1526 return ret;
1527 }
1528
count_ext_compat(struct usb_configuration * c)1529 static int count_ext_compat(struct usb_configuration *c)
1530 {
1531 int i, res;
1532
1533 res = 0;
1534 for (i = 0; i < c->next_interface_id; ++i) {
1535 struct usb_function *f;
1536 int j;
1537
1538 f = c->interface[i];
1539 for (j = 0; j < f->os_desc_n; ++j) {
1540 struct usb_os_desc *d;
1541
1542 if (i != f->os_desc_table[j].if_id)
1543 continue;
1544 d = f->os_desc_table[j].os_desc;
1545 if (d && d->ext_compat_id)
1546 ++res;
1547 }
1548 }
1549 BUG_ON(res > 255);
1550 return res;
1551 }
1552
fill_ext_compat(struct usb_configuration * c,u8 * buf)1553 static int fill_ext_compat(struct usb_configuration *c, u8 *buf)
1554 {
1555 int i, count;
1556
1557 count = 16;
1558 buf += 16;
1559 for (i = 0; i < c->next_interface_id; ++i) {
1560 struct usb_function *f;
1561 int j;
1562
1563 f = c->interface[i];
1564 for (j = 0; j < f->os_desc_n; ++j) {
1565 struct usb_os_desc *d;
1566
1567 if (i != f->os_desc_table[j].if_id)
1568 continue;
1569 d = f->os_desc_table[j].os_desc;
1570 if (d && d->ext_compat_id) {
1571 *buf++ = i;
1572 *buf++ = 0x01;
1573 memcpy(buf, d->ext_compat_id, 16);
1574 buf += 22;
1575 } else {
1576 ++buf;
1577 *buf = 0x01;
1578 buf += 23;
1579 }
1580 count += 24;
1581 if (count + 24 >= USB_COMP_EP0_OS_DESC_BUFSIZ)
1582 return count;
1583 }
1584 }
1585
1586 return count;
1587 }
1588
count_ext_prop(struct usb_configuration * c,int interface)1589 static int count_ext_prop(struct usb_configuration *c, int interface)
1590 {
1591 struct usb_function *f;
1592 int j;
1593
1594 f = c->interface[interface];
1595 for (j = 0; j < f->os_desc_n; ++j) {
1596 struct usb_os_desc *d;
1597
1598 if (interface != f->os_desc_table[j].if_id)
1599 continue;
1600 d = f->os_desc_table[j].os_desc;
1601 if (d && d->ext_compat_id)
1602 return d->ext_prop_count;
1603 }
1604 return 0;
1605 }
1606
len_ext_prop(struct usb_configuration * c,int interface)1607 static int len_ext_prop(struct usb_configuration *c, int interface)
1608 {
1609 struct usb_function *f;
1610 struct usb_os_desc *d;
1611 int j, res;
1612
1613 res = 10; /* header length */
1614 f = c->interface[interface];
1615 for (j = 0; j < f->os_desc_n; ++j) {
1616 if (interface != f->os_desc_table[j].if_id)
1617 continue;
1618 d = f->os_desc_table[j].os_desc;
1619 if (d)
1620 return min(res + d->ext_prop_len, 4096);
1621 }
1622 return res;
1623 }
1624
fill_ext_prop(struct usb_configuration * c,int interface,u8 * buf)1625 static int fill_ext_prop(struct usb_configuration *c, int interface, u8 *buf)
1626 {
1627 struct usb_function *f;
1628 struct usb_os_desc *d;
1629 struct usb_os_desc_ext_prop *ext_prop;
1630 int j, count, n, ret;
1631
1632 f = c->interface[interface];
1633 count = 10; /* header length */
1634 buf += 10;
1635 for (j = 0; j < f->os_desc_n; ++j) {
1636 if (interface != f->os_desc_table[j].if_id)
1637 continue;
1638 d = f->os_desc_table[j].os_desc;
1639 if (d)
1640 list_for_each_entry(ext_prop, &d->ext_prop, entry) {
1641 n = ext_prop->data_len +
1642 ext_prop->name_len + 14;
1643 if (count + n >= USB_COMP_EP0_OS_DESC_BUFSIZ)
1644 return count;
1645 usb_ext_prop_put_size(buf, n);
1646 usb_ext_prop_put_type(buf, ext_prop->type);
1647 ret = usb_ext_prop_put_name(buf, ext_prop->name,
1648 ext_prop->name_len);
1649 if (ret < 0)
1650 return ret;
1651 switch (ext_prop->type) {
1652 case USB_EXT_PROP_UNICODE:
1653 case USB_EXT_PROP_UNICODE_ENV:
1654 case USB_EXT_PROP_UNICODE_LINK:
1655 usb_ext_prop_put_unicode(buf, ret,
1656 ext_prop->data,
1657 ext_prop->data_len);
1658 break;
1659 case USB_EXT_PROP_BINARY:
1660 usb_ext_prop_put_binary(buf, ret,
1661 ext_prop->data,
1662 ext_prop->data_len);
1663 break;
1664 case USB_EXT_PROP_LE32:
1665 /* not implemented */
1666 case USB_EXT_PROP_BE32:
1667 /* not implemented */
1668 default:
1669 return -EINVAL;
1670 }
1671 buf += n;
1672 count += n;
1673 }
1674 }
1675
1676 return count;
1677 }
1678
1679 /*
1680 * The setup() callback implements all the ep0 functionality that's
1681 * not handled lower down, in hardware or the hardware driver(like
1682 * device and endpoint feature flags, and their status). It's all
1683 * housekeeping for the gadget function we're implementing. Most of
1684 * the work is in config and function specific setup.
1685 */
1686 int
composite_setup(struct usb_gadget * gadget,const struct usb_ctrlrequest * ctrl)1687 composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1688 {
1689 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1690 struct usb_request *req = cdev->req;
1691 int value = -EOPNOTSUPP;
1692 int status = 0;
1693 u16 w_index = le16_to_cpu(ctrl->wIndex);
1694 u8 intf = w_index & 0xFF;
1695 u16 w_value = le16_to_cpu(ctrl->wValue);
1696 u16 w_length = le16_to_cpu(ctrl->wLength);
1697 struct usb_function *f = NULL;
1698 struct usb_function *iter;
1699 u8 endp;
1700
1701 if (w_length > USB_COMP_EP0_BUFSIZ) {
1702 if (ctrl->bRequestType & USB_DIR_IN) {
1703 /* Cast away the const, we are going to overwrite on purpose. */
1704 __le16 *temp = (__le16 *)&ctrl->wLength;
1705
1706 *temp = cpu_to_le16(USB_COMP_EP0_BUFSIZ);
1707 w_length = USB_COMP_EP0_BUFSIZ;
1708 } else {
1709 goto done;
1710 }
1711 }
1712
1713 /* partial re-init of the response message; the function or the
1714 * gadget might need to intercept e.g. a control-OUT completion
1715 * when we delegate to it.
1716 */
1717 req->zero = 0;
1718 req->context = cdev;
1719 req->complete = composite_setup_complete;
1720 req->length = 0;
1721 gadget->ep0->driver_data = cdev;
1722
1723 /*
1724 * Don't let non-standard requests match any of the cases below
1725 * by accident.
1726 */
1727 if ((ctrl->bRequestType & USB_TYPE_MASK) != USB_TYPE_STANDARD)
1728 goto unknown;
1729
1730 switch (ctrl->bRequest) {
1731
1732 /* we handle all standard USB descriptors */
1733 case USB_REQ_GET_DESCRIPTOR:
1734 if (ctrl->bRequestType != USB_DIR_IN)
1735 goto unknown;
1736 switch (w_value >> 8) {
1737
1738 case USB_DT_DEVICE:
1739 cdev->desc.bNumConfigurations =
1740 count_configs(cdev, USB_DT_DEVICE);
1741 cdev->desc.bMaxPacketSize0 =
1742 cdev->gadget->ep0->maxpacket;
1743 if (gadget_is_superspeed(gadget)) {
1744 if (gadget->speed >= USB_SPEED_SUPER) {
1745 cdev->desc.bcdUSB = cpu_to_le16(0x0320);
1746 cdev->desc.bMaxPacketSize0 = 9;
1747 } else {
1748 cdev->desc.bcdUSB = cpu_to_le16(0x0210);
1749 }
1750 } else {
1751 if (gadget->lpm_capable)
1752 cdev->desc.bcdUSB = cpu_to_le16(0x0201);
1753 else
1754 cdev->desc.bcdUSB = cpu_to_le16(0x0200);
1755 }
1756
1757 value = min(w_length, (u16) sizeof cdev->desc);
1758 memcpy(req->buf, &cdev->desc, value);
1759 break;
1760 case USB_DT_DEVICE_QUALIFIER:
1761 if (!gadget_is_dualspeed(gadget) ||
1762 gadget->speed >= USB_SPEED_SUPER)
1763 break;
1764 device_qual(cdev);
1765 value = min_t(int, w_length,
1766 sizeof(struct usb_qualifier_descriptor));
1767 break;
1768 case USB_DT_OTHER_SPEED_CONFIG:
1769 if (!gadget_is_dualspeed(gadget) ||
1770 gadget->speed >= USB_SPEED_SUPER)
1771 break;
1772 fallthrough;
1773 case USB_DT_CONFIG:
1774 value = config_desc(cdev, w_value);
1775 if (value >= 0)
1776 value = min(w_length, (u16) value);
1777 break;
1778 case USB_DT_STRING:
1779 value = get_string(cdev, req->buf,
1780 w_index, w_value & 0xff);
1781 if (value >= 0)
1782 value = min(w_length, (u16) value);
1783 break;
1784 case USB_DT_BOS:
1785 if (gadget_is_superspeed(gadget) ||
1786 gadget->lpm_capable) {
1787 value = bos_desc(cdev);
1788 value = min(w_length, (u16) value);
1789 }
1790 break;
1791 case USB_DT_OTG:
1792 if (gadget_is_otg(gadget)) {
1793 struct usb_configuration *config;
1794 int otg_desc_len = 0;
1795
1796 if (cdev->config)
1797 config = cdev->config;
1798 else
1799 config = list_first_entry(
1800 &cdev->configs,
1801 struct usb_configuration, list);
1802 if (!config)
1803 goto done;
1804
1805 if (gadget->otg_caps &&
1806 (gadget->otg_caps->otg_rev >= 0x0200))
1807 otg_desc_len += sizeof(
1808 struct usb_otg20_descriptor);
1809 else
1810 otg_desc_len += sizeof(
1811 struct usb_otg_descriptor);
1812
1813 value = min_t(int, w_length, otg_desc_len);
1814 memcpy(req->buf, config->descriptors[0], value);
1815 }
1816 break;
1817 }
1818 break;
1819
1820 /* any number of configs can work */
1821 case USB_REQ_SET_CONFIGURATION:
1822 if (ctrl->bRequestType != 0)
1823 goto unknown;
1824 if (gadget_is_otg(gadget)) {
1825 if (gadget->a_hnp_support)
1826 DBG(cdev, "HNP available\n");
1827 else if (gadget->a_alt_hnp_support)
1828 DBG(cdev, "HNP on another port\n");
1829 else
1830 VDBG(cdev, "HNP inactive\n");
1831 }
1832 spin_lock(&cdev->lock);
1833 value = set_config(cdev, ctrl, w_value);
1834 spin_unlock(&cdev->lock);
1835 break;
1836 case USB_REQ_GET_CONFIGURATION:
1837 if (ctrl->bRequestType != USB_DIR_IN)
1838 goto unknown;
1839 if (cdev->config)
1840 *(u8 *)req->buf = cdev->config->bConfigurationValue;
1841 else
1842 *(u8 *)req->buf = 0;
1843 value = min(w_length, (u16) 1);
1844 break;
1845
1846 /* function drivers must handle get/set altsetting */
1847 case USB_REQ_SET_INTERFACE:
1848 if (ctrl->bRequestType != USB_RECIP_INTERFACE)
1849 goto unknown;
1850 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1851 break;
1852 f = cdev->config->interface[intf];
1853 if (!f)
1854 break;
1855
1856 /*
1857 * If there's no get_alt() method, we know only altsetting zero
1858 * works. There is no need to check if set_alt() is not NULL
1859 * as we check this in usb_add_function().
1860 */
1861 if (w_value && !f->get_alt)
1862 break;
1863
1864 spin_lock(&cdev->lock);
1865 value = f->set_alt(f, w_index, w_value);
1866 if (value == USB_GADGET_DELAYED_STATUS) {
1867 DBG(cdev,
1868 "%s: interface %d (%s) requested delayed status\n",
1869 __func__, intf, f->name);
1870 cdev->delayed_status++;
1871 DBG(cdev, "delayed_status count %d\n",
1872 cdev->delayed_status);
1873 }
1874 spin_unlock(&cdev->lock);
1875 break;
1876 case USB_REQ_GET_INTERFACE:
1877 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE))
1878 goto unknown;
1879 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1880 break;
1881 f = cdev->config->interface[intf];
1882 if (!f)
1883 break;
1884 /* lots of interfaces only need altsetting zero... */
1885 value = f->get_alt ? f->get_alt(f, w_index) : 0;
1886 if (value < 0)
1887 break;
1888 *((u8 *)req->buf) = value;
1889 value = min(w_length, (u16) 1);
1890 break;
1891 case USB_REQ_GET_STATUS:
1892 if (gadget_is_otg(gadget) && gadget->hnp_polling_support &&
1893 (w_index == OTG_STS_SELECTOR)) {
1894 if (ctrl->bRequestType != (USB_DIR_IN |
1895 USB_RECIP_DEVICE))
1896 goto unknown;
1897 *((u8 *)req->buf) = gadget->host_request_flag;
1898 value = 1;
1899 break;
1900 }
1901
1902 /*
1903 * USB 3.0 additions:
1904 * Function driver should handle get_status request. If such cb
1905 * wasn't supplied we respond with default value = 0
1906 * Note: function driver should supply such cb only for the
1907 * first interface of the function
1908 */
1909 if (!gadget_is_superspeed(gadget))
1910 goto unknown;
1911 if (ctrl->bRequestType != (USB_DIR_IN | USB_RECIP_INTERFACE))
1912 goto unknown;
1913 value = 2; /* This is the length of the get_status reply */
1914 put_unaligned_le16(0, req->buf);
1915 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1916 break;
1917 f = cdev->config->interface[intf];
1918 if (!f)
1919 break;
1920 status = f->get_status ? f->get_status(f) : 0;
1921 if (status < 0)
1922 break;
1923 put_unaligned_le16(status & 0x0000ffff, req->buf);
1924 break;
1925 /*
1926 * Function drivers should handle SetFeature/ClearFeature
1927 * (FUNCTION_SUSPEND) request. function_suspend cb should be supplied
1928 * only for the first interface of the function
1929 */
1930 case USB_REQ_CLEAR_FEATURE:
1931 case USB_REQ_SET_FEATURE:
1932 if (!gadget_is_superspeed(gadget))
1933 goto unknown;
1934 if (ctrl->bRequestType != (USB_DIR_OUT | USB_RECIP_INTERFACE))
1935 goto unknown;
1936 switch (w_value) {
1937 case USB_INTRF_FUNC_SUSPEND:
1938 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1939 break;
1940 f = cdev->config->interface[intf];
1941 if (!f)
1942 break;
1943 value = 0;
1944 if (f->func_suspend)
1945 value = f->func_suspend(f, w_index >> 8);
1946 if (value < 0) {
1947 ERROR(cdev,
1948 "func_suspend() returned error %d\n",
1949 value);
1950 value = 0;
1951 }
1952 break;
1953 }
1954 break;
1955 default:
1956 unknown:
1957 /*
1958 * OS descriptors handling
1959 */
1960 if (cdev->use_os_string && cdev->os_desc_config &&
1961 (ctrl->bRequestType & USB_TYPE_VENDOR) &&
1962 ctrl->bRequest == cdev->b_vendor_code) {
1963 struct usb_configuration *os_desc_cfg;
1964 u8 *buf;
1965 int interface;
1966 int count = 0;
1967
1968 req = cdev->os_desc_req;
1969 req->context = cdev;
1970 req->complete = composite_setup_complete;
1971 buf = req->buf;
1972 os_desc_cfg = cdev->os_desc_config;
1973 w_length = min_t(u16, w_length, USB_COMP_EP0_OS_DESC_BUFSIZ);
1974 memset(buf, 0, w_length);
1975 buf[5] = 0x01;
1976 switch (ctrl->bRequestType & USB_RECIP_MASK) {
1977 case USB_RECIP_DEVICE:
1978 if (w_index != 0x4 || (w_value >> 8))
1979 break;
1980 buf[6] = w_index;
1981 /* Number of ext compat interfaces */
1982 count = count_ext_compat(os_desc_cfg);
1983 buf[8] = count;
1984 count *= 24; /* 24 B/ext compat desc */
1985 count += 16; /* header */
1986 put_unaligned_le32(count, buf);
1987 value = w_length;
1988 if (w_length > 0x10) {
1989 value = fill_ext_compat(os_desc_cfg, buf);
1990 value = min_t(u16, w_length, value);
1991 }
1992 break;
1993 case USB_RECIP_INTERFACE:
1994 if (w_index != 0x5 || (w_value >> 8))
1995 break;
1996 interface = w_value & 0xFF;
1997 if (interface >= MAX_CONFIG_INTERFACES ||
1998 !os_desc_cfg->interface[interface])
1999 break;
2000 buf[6] = w_index;
2001 count = count_ext_prop(os_desc_cfg,
2002 interface);
2003 put_unaligned_le16(count, buf + 8);
2004 count = len_ext_prop(os_desc_cfg,
2005 interface);
2006 put_unaligned_le32(count, buf);
2007 value = w_length;
2008 if (w_length > 0x0A) {
2009 value = fill_ext_prop(os_desc_cfg,
2010 interface, buf);
2011 if (value >= 0)
2012 value = min_t(u16, w_length, value);
2013 }
2014 break;
2015 }
2016
2017 goto check_value;
2018 }
2019
2020 VDBG(cdev,
2021 "non-core control req%02x.%02x v%04x i%04x l%d\n",
2022 ctrl->bRequestType, ctrl->bRequest,
2023 w_value, w_index, w_length);
2024
2025 /* functions always handle their interfaces and endpoints...
2026 * punt other recipients (other, WUSB, ...) to the current
2027 * configuration code.
2028 */
2029 if (cdev->config) {
2030 list_for_each_entry(f, &cdev->config->functions, list)
2031 if (f->req_match &&
2032 f->req_match(f, ctrl, false))
2033 goto try_fun_setup;
2034 } else {
2035 struct usb_configuration *c;
2036 list_for_each_entry(c, &cdev->configs, list)
2037 list_for_each_entry(f, &c->functions, list)
2038 if (f->req_match &&
2039 f->req_match(f, ctrl, true))
2040 goto try_fun_setup;
2041 }
2042 f = NULL;
2043
2044 switch (ctrl->bRequestType & USB_RECIP_MASK) {
2045 case USB_RECIP_INTERFACE:
2046 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
2047 break;
2048 f = cdev->config->interface[intf];
2049 break;
2050
2051 case USB_RECIP_ENDPOINT:
2052 if (!cdev->config)
2053 break;
2054 endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f);
2055 list_for_each_entry(iter, &cdev->config->functions, list) {
2056 if (test_bit(endp, iter->endpoints)) {
2057 f = iter;
2058 break;
2059 }
2060 }
2061 break;
2062 }
2063 try_fun_setup:
2064 if (f && f->setup)
2065 value = f->setup(f, ctrl);
2066 else {
2067 struct usb_configuration *c;
2068
2069 c = cdev->config;
2070 if (!c)
2071 goto done;
2072
2073 /* try current config's setup */
2074 if (c->setup) {
2075 value = c->setup(c, ctrl);
2076 goto done;
2077 }
2078
2079 /* try the only function in the current config */
2080 if (!list_is_singular(&c->functions))
2081 goto done;
2082 f = list_first_entry(&c->functions, struct usb_function,
2083 list);
2084 if (f->setup)
2085 value = f->setup(f, ctrl);
2086 }
2087
2088 goto done;
2089 }
2090
2091 check_value:
2092 /* respond with data transfer before status phase? */
2093 if (value >= 0 && value != USB_GADGET_DELAYED_STATUS) {
2094 req->length = value;
2095 req->context = cdev;
2096 req->zero = value < w_length;
2097 value = composite_ep0_queue(cdev, req, GFP_ATOMIC);
2098 if (value < 0) {
2099 DBG(cdev, "ep_queue --> %d\n", value);
2100 req->status = 0;
2101 composite_setup_complete(gadget->ep0, req);
2102 }
2103 } else if (value == USB_GADGET_DELAYED_STATUS && w_length != 0) {
2104 WARN(cdev,
2105 "%s: Delayed status not supported for w_length != 0",
2106 __func__);
2107 }
2108
2109 done:
2110 /* device either stalls (value < 0) or reports success */
2111 return value;
2112 }
2113
__composite_disconnect(struct usb_gadget * gadget)2114 static void __composite_disconnect(struct usb_gadget *gadget)
2115 {
2116 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2117 unsigned long flags;
2118
2119 /* REVISIT: should we have config and device level
2120 * disconnect callbacks?
2121 */
2122 spin_lock_irqsave(&cdev->lock, flags);
2123 cdev->suspended = 0;
2124 if (cdev->config)
2125 reset_config(cdev);
2126 if (cdev->driver->disconnect)
2127 cdev->driver->disconnect(cdev);
2128 spin_unlock_irqrestore(&cdev->lock, flags);
2129 }
2130
composite_disconnect(struct usb_gadget * gadget)2131 void composite_disconnect(struct usb_gadget *gadget)
2132 {
2133 usb_gadget_vbus_draw(gadget, 0);
2134 __composite_disconnect(gadget);
2135 }
2136
composite_reset(struct usb_gadget * gadget)2137 void composite_reset(struct usb_gadget *gadget)
2138 {
2139 /*
2140 * Section 1.4.13 Standard Downstream Port of the USB battery charging
2141 * specification v1.2 states that a device connected on a SDP shall only
2142 * draw at max 100mA while in a connected, but unconfigured state.
2143 */
2144 usb_gadget_vbus_draw(gadget, 100);
2145 __composite_disconnect(gadget);
2146 }
2147
2148 /*-------------------------------------------------------------------------*/
2149
suspended_show(struct device * dev,struct device_attribute * attr,char * buf)2150 static ssize_t suspended_show(struct device *dev, struct device_attribute *attr,
2151 char *buf)
2152 {
2153 struct usb_gadget *gadget = dev_to_usb_gadget(dev);
2154 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2155
2156 return sprintf(buf, "%d\n", cdev->suspended);
2157 }
2158 static DEVICE_ATTR_RO(suspended);
2159
__composite_unbind(struct usb_gadget * gadget,bool unbind_driver)2160 static void __composite_unbind(struct usb_gadget *gadget, bool unbind_driver)
2161 {
2162 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2163 struct usb_gadget_strings *gstr = cdev->driver->strings[0];
2164 struct usb_string *dev_str = gstr->strings;
2165
2166 /* composite_disconnect() must already have been called
2167 * by the underlying peripheral controller driver!
2168 * so there's no i/o concurrency that could affect the
2169 * state protected by cdev->lock.
2170 */
2171 WARN_ON(cdev->config);
2172
2173 while (!list_empty(&cdev->configs)) {
2174 struct usb_configuration *c;
2175 c = list_first_entry(&cdev->configs,
2176 struct usb_configuration, list);
2177 remove_config(cdev, c);
2178 }
2179 if (cdev->driver->unbind && unbind_driver)
2180 cdev->driver->unbind(cdev);
2181
2182 composite_dev_cleanup(cdev);
2183
2184 if (dev_str[USB_GADGET_MANUFACTURER_IDX].s == cdev->def_manufacturer)
2185 dev_str[USB_GADGET_MANUFACTURER_IDX].s = "";
2186
2187 kfree(cdev->def_manufacturer);
2188 kfree(cdev);
2189 set_gadget_data(gadget, NULL);
2190 }
2191
composite_unbind(struct usb_gadget * gadget)2192 static void composite_unbind(struct usb_gadget *gadget)
2193 {
2194 __composite_unbind(gadget, true);
2195 }
2196
update_unchanged_dev_desc(struct usb_device_descriptor * new,const struct usb_device_descriptor * old)2197 static void update_unchanged_dev_desc(struct usb_device_descriptor *new,
2198 const struct usb_device_descriptor *old)
2199 {
2200 __le16 idVendor;
2201 __le16 idProduct;
2202 __le16 bcdDevice;
2203 u8 iSerialNumber;
2204 u8 iManufacturer;
2205 u8 iProduct;
2206
2207 /*
2208 * these variables may have been set in
2209 * usb_composite_overwrite_options()
2210 */
2211 idVendor = new->idVendor;
2212 idProduct = new->idProduct;
2213 bcdDevice = new->bcdDevice;
2214 iSerialNumber = new->iSerialNumber;
2215 iManufacturer = new->iManufacturer;
2216 iProduct = new->iProduct;
2217
2218 *new = *old;
2219 if (idVendor)
2220 new->idVendor = idVendor;
2221 if (idProduct)
2222 new->idProduct = idProduct;
2223 if (bcdDevice)
2224 new->bcdDevice = bcdDevice;
2225 else
2226 new->bcdDevice = cpu_to_le16(get_default_bcdDevice());
2227 if (iSerialNumber)
2228 new->iSerialNumber = iSerialNumber;
2229 if (iManufacturer)
2230 new->iManufacturer = iManufacturer;
2231 if (iProduct)
2232 new->iProduct = iProduct;
2233 }
2234
composite_dev_prepare(struct usb_composite_driver * composite,struct usb_composite_dev * cdev)2235 int composite_dev_prepare(struct usb_composite_driver *composite,
2236 struct usb_composite_dev *cdev)
2237 {
2238 struct usb_gadget *gadget = cdev->gadget;
2239 int ret = -ENOMEM;
2240
2241 /* preallocate control response and buffer */
2242 cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
2243 if (!cdev->req)
2244 return -ENOMEM;
2245
2246 cdev->req->buf = kzalloc(USB_COMP_EP0_BUFSIZ, GFP_KERNEL);
2247 if (!cdev->req->buf)
2248 goto fail;
2249
2250 ret = device_create_file(&gadget->dev, &dev_attr_suspended);
2251 if (ret)
2252 goto fail_dev;
2253
2254 cdev->req->complete = composite_setup_complete;
2255 cdev->req->context = cdev;
2256 gadget->ep0->driver_data = cdev;
2257
2258 cdev->driver = composite;
2259
2260 /*
2261 * As per USB compliance update, a device that is actively drawing
2262 * more than 100mA from USB must report itself as bus-powered in
2263 * the GetStatus(DEVICE) call.
2264 */
2265 if (CONFIG_USB_GADGET_VBUS_DRAW <= USB_SELF_POWER_VBUS_MAX_DRAW)
2266 usb_gadget_set_selfpowered(gadget);
2267
2268 /* interface and string IDs start at zero via kzalloc.
2269 * we force endpoints to start unassigned; few controller
2270 * drivers will zero ep->driver_data.
2271 */
2272 usb_ep_autoconfig_reset(gadget);
2273 return 0;
2274 fail_dev:
2275 kfree(cdev->req->buf);
2276 fail:
2277 usb_ep_free_request(gadget->ep0, cdev->req);
2278 cdev->req = NULL;
2279 return ret;
2280 }
2281
composite_os_desc_req_prepare(struct usb_composite_dev * cdev,struct usb_ep * ep0)2282 int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
2283 struct usb_ep *ep0)
2284 {
2285 int ret = 0;
2286
2287 cdev->os_desc_req = usb_ep_alloc_request(ep0, GFP_KERNEL);
2288 if (!cdev->os_desc_req) {
2289 ret = -ENOMEM;
2290 goto end;
2291 }
2292
2293 cdev->os_desc_req->buf = kmalloc(USB_COMP_EP0_OS_DESC_BUFSIZ,
2294 GFP_KERNEL);
2295 if (!cdev->os_desc_req->buf) {
2296 ret = -ENOMEM;
2297 usb_ep_free_request(ep0, cdev->os_desc_req);
2298 goto end;
2299 }
2300 cdev->os_desc_req->context = cdev;
2301 cdev->os_desc_req->complete = composite_setup_complete;
2302 end:
2303 return ret;
2304 }
2305
composite_dev_cleanup(struct usb_composite_dev * cdev)2306 void composite_dev_cleanup(struct usb_composite_dev *cdev)
2307 {
2308 struct usb_gadget_string_container *uc, *tmp;
2309 struct usb_ep *ep, *tmp_ep;
2310
2311 list_for_each_entry_safe(uc, tmp, &cdev->gstrings, list) {
2312 list_del(&uc->list);
2313 kfree(uc);
2314 }
2315 if (cdev->os_desc_req) {
2316 if (cdev->os_desc_pending)
2317 usb_ep_dequeue(cdev->gadget->ep0, cdev->os_desc_req);
2318
2319 kfree(cdev->os_desc_req->buf);
2320 cdev->os_desc_req->buf = NULL;
2321 usb_ep_free_request(cdev->gadget->ep0, cdev->os_desc_req);
2322 cdev->os_desc_req = NULL;
2323 }
2324 if (cdev->req) {
2325 if (cdev->setup_pending)
2326 usb_ep_dequeue(cdev->gadget->ep0, cdev->req);
2327
2328 kfree(cdev->req->buf);
2329 cdev->req->buf = NULL;
2330 usb_ep_free_request(cdev->gadget->ep0, cdev->req);
2331 cdev->req = NULL;
2332 }
2333 cdev->next_string_id = 0;
2334 device_remove_file(&cdev->gadget->dev, &dev_attr_suspended);
2335
2336 /*
2337 * Some UDC backends have a dynamic EP allocation scheme.
2338 *
2339 * In that case, the dispose() callback is used to notify the
2340 * backend that the EPs are no longer in use.
2341 *
2342 * Note: The UDC backend can remove the EP from the ep_list as
2343 * a result, so we need to use the _safe list iterator.
2344 */
2345 list_for_each_entry_safe(ep, tmp_ep,
2346 &cdev->gadget->ep_list, ep_list) {
2347 if (ep->ops->dispose)
2348 ep->ops->dispose(ep);
2349 }
2350 }
2351
composite_bind(struct usb_gadget * gadget,struct usb_gadget_driver * gdriver)2352 static int composite_bind(struct usb_gadget *gadget,
2353 struct usb_gadget_driver *gdriver)
2354 {
2355 struct usb_composite_dev *cdev;
2356 struct usb_composite_driver *composite = to_cdriver(gdriver);
2357 int status = -ENOMEM;
2358
2359 cdev = kzalloc(sizeof *cdev, GFP_KERNEL);
2360 if (!cdev)
2361 return status;
2362
2363 spin_lock_init(&cdev->lock);
2364 cdev->gadget = gadget;
2365 set_gadget_data(gadget, cdev);
2366 INIT_LIST_HEAD(&cdev->configs);
2367 INIT_LIST_HEAD(&cdev->gstrings);
2368
2369 status = composite_dev_prepare(composite, cdev);
2370 if (status)
2371 goto fail;
2372
2373 /* composite gadget needs to assign strings for whole device (like
2374 * serial number), register function drivers, potentially update
2375 * power state and consumption, etc
2376 */
2377 status = composite->bind(cdev);
2378 if (status < 0)
2379 goto fail;
2380
2381 if (cdev->use_os_string) {
2382 status = composite_os_desc_req_prepare(cdev, gadget->ep0);
2383 if (status)
2384 goto fail;
2385 }
2386
2387 update_unchanged_dev_desc(&cdev->desc, composite->dev);
2388
2389 /* has userspace failed to provide a serial number? */
2390 if (composite->needs_serial && !cdev->desc.iSerialNumber)
2391 WARNING(cdev, "userspace failed to provide iSerialNumber\n");
2392
2393 INFO(cdev, "%s ready\n", composite->name);
2394 return 0;
2395
2396 fail:
2397 __composite_unbind(gadget, false);
2398 return status;
2399 }
2400
2401 /*-------------------------------------------------------------------------*/
2402
composite_suspend(struct usb_gadget * gadget)2403 void composite_suspend(struct usb_gadget *gadget)
2404 {
2405 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2406 struct usb_function *f;
2407
2408 /* REVISIT: should we have config level
2409 * suspend/resume callbacks?
2410 */
2411 DBG(cdev, "suspend\n");
2412 if (cdev->config) {
2413 list_for_each_entry(f, &cdev->config->functions, list) {
2414 if (f->suspend)
2415 f->suspend(f);
2416 }
2417 }
2418 if (cdev->driver->suspend)
2419 cdev->driver->suspend(cdev);
2420
2421 cdev->suspended = 1;
2422
2423 usb_gadget_set_selfpowered(gadget);
2424 usb_gadget_vbus_draw(gadget, 2);
2425 }
2426
composite_resume(struct usb_gadget * gadget)2427 void composite_resume(struct usb_gadget *gadget)
2428 {
2429 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2430 struct usb_function *f;
2431 unsigned maxpower;
2432
2433 /* REVISIT: should we have config level
2434 * suspend/resume callbacks?
2435 */
2436 DBG(cdev, "resume\n");
2437 if (cdev->driver->resume)
2438 cdev->driver->resume(cdev);
2439 if (cdev->config) {
2440 list_for_each_entry(f, &cdev->config->functions, list) {
2441 if (f->resume)
2442 f->resume(f);
2443 }
2444
2445 maxpower = cdev->config->MaxPower ?
2446 cdev->config->MaxPower : CONFIG_USB_GADGET_VBUS_DRAW;
2447 if (gadget->speed < USB_SPEED_SUPER)
2448 maxpower = min(maxpower, 500U);
2449 else
2450 maxpower = min(maxpower, 900U);
2451
2452 if (maxpower > USB_SELF_POWER_VBUS_MAX_DRAW)
2453 usb_gadget_clear_selfpowered(gadget);
2454
2455 usb_gadget_vbus_draw(gadget, maxpower);
2456 }
2457
2458 cdev->suspended = 0;
2459 }
2460
2461 /*-------------------------------------------------------------------------*/
2462
2463 static const struct usb_gadget_driver composite_driver_template = {
2464 .bind = composite_bind,
2465 .unbind = composite_unbind,
2466
2467 .setup = composite_setup,
2468 .reset = composite_reset,
2469 .disconnect = composite_disconnect,
2470
2471 .suspend = composite_suspend,
2472 .resume = composite_resume,
2473
2474 .driver = {
2475 .owner = THIS_MODULE,
2476 },
2477 };
2478
2479 /**
2480 * usb_composite_probe() - register a composite driver
2481 * @driver: the driver to register
2482 *
2483 * Context: single threaded during gadget setup
2484 *
2485 * This function is used to register drivers using the composite driver
2486 * framework. The return value is zero, or a negative errno value.
2487 * Those values normally come from the driver's @bind method, which does
2488 * all the work of setting up the driver to match the hardware.
2489 *
2490 * On successful return, the gadget is ready to respond to requests from
2491 * the host, unless one of its components invokes usb_gadget_disconnect()
2492 * while it was binding. That would usually be done in order to wait for
2493 * some userspace participation.
2494 */
usb_composite_probe(struct usb_composite_driver * driver)2495 int usb_composite_probe(struct usb_composite_driver *driver)
2496 {
2497 struct usb_gadget_driver *gadget_driver;
2498
2499 if (!driver || !driver->dev || !driver->bind)
2500 return -EINVAL;
2501
2502 if (!driver->name)
2503 driver->name = "composite";
2504
2505 driver->gadget_driver = composite_driver_template;
2506 gadget_driver = &driver->gadget_driver;
2507
2508 gadget_driver->function = (char *) driver->name;
2509 gadget_driver->driver.name = driver->name;
2510 gadget_driver->max_speed = driver->max_speed;
2511
2512 return usb_gadget_register_driver(gadget_driver);
2513 }
2514 EXPORT_SYMBOL_GPL(usb_composite_probe);
2515
2516 /**
2517 * usb_composite_unregister() - unregister a composite driver
2518 * @driver: the driver to unregister
2519 *
2520 * This function is used to unregister drivers using the composite
2521 * driver framework.
2522 */
usb_composite_unregister(struct usb_composite_driver * driver)2523 void usb_composite_unregister(struct usb_composite_driver *driver)
2524 {
2525 usb_gadget_unregister_driver(&driver->gadget_driver);
2526 }
2527 EXPORT_SYMBOL_GPL(usb_composite_unregister);
2528
2529 /**
2530 * usb_composite_setup_continue() - Continue with the control transfer
2531 * @cdev: the composite device who's control transfer was kept waiting
2532 *
2533 * This function must be called by the USB function driver to continue
2534 * with the control transfer's data/status stage in case it had requested to
2535 * delay the data/status stages. A USB function's setup handler (e.g. set_alt())
2536 * can request the composite framework to delay the setup request's data/status
2537 * stages by returning USB_GADGET_DELAYED_STATUS.
2538 */
usb_composite_setup_continue(struct usb_composite_dev * cdev)2539 void usb_composite_setup_continue(struct usb_composite_dev *cdev)
2540 {
2541 int value;
2542 struct usb_request *req = cdev->req;
2543 unsigned long flags;
2544
2545 DBG(cdev, "%s\n", __func__);
2546 spin_lock_irqsave(&cdev->lock, flags);
2547
2548 if (cdev->delayed_status == 0) {
2549 WARN(cdev, "%s: Unexpected call\n", __func__);
2550
2551 } else if (--cdev->delayed_status == 0) {
2552 DBG(cdev, "%s: Completing delayed status\n", __func__);
2553 req->length = 0;
2554 req->context = cdev;
2555 value = composite_ep0_queue(cdev, req, GFP_ATOMIC);
2556 if (value < 0) {
2557 DBG(cdev, "ep_queue --> %d\n", value);
2558 req->status = 0;
2559 composite_setup_complete(cdev->gadget->ep0, req);
2560 }
2561 }
2562
2563 spin_unlock_irqrestore(&cdev->lock, flags);
2564 }
2565 EXPORT_SYMBOL_GPL(usb_composite_setup_continue);
2566
composite_default_mfr(struct usb_gadget * gadget)2567 static char *composite_default_mfr(struct usb_gadget *gadget)
2568 {
2569 return kasprintf(GFP_KERNEL, "%s %s with %s", init_utsname()->sysname,
2570 init_utsname()->release, gadget->name);
2571 }
2572
usb_composite_overwrite_options(struct usb_composite_dev * cdev,struct usb_composite_overwrite * covr)2573 void usb_composite_overwrite_options(struct usb_composite_dev *cdev,
2574 struct usb_composite_overwrite *covr)
2575 {
2576 struct usb_device_descriptor *desc = &cdev->desc;
2577 struct usb_gadget_strings *gstr = cdev->driver->strings[0];
2578 struct usb_string *dev_str = gstr->strings;
2579
2580 if (covr->idVendor)
2581 desc->idVendor = cpu_to_le16(covr->idVendor);
2582
2583 if (covr->idProduct)
2584 desc->idProduct = cpu_to_le16(covr->idProduct);
2585
2586 if (covr->bcdDevice)
2587 desc->bcdDevice = cpu_to_le16(covr->bcdDevice);
2588
2589 if (covr->serial_number) {
2590 desc->iSerialNumber = dev_str[USB_GADGET_SERIAL_IDX].id;
2591 dev_str[USB_GADGET_SERIAL_IDX].s = covr->serial_number;
2592 }
2593 if (covr->manufacturer) {
2594 desc->iManufacturer = dev_str[USB_GADGET_MANUFACTURER_IDX].id;
2595 dev_str[USB_GADGET_MANUFACTURER_IDX].s = covr->manufacturer;
2596
2597 } else if (!strlen(dev_str[USB_GADGET_MANUFACTURER_IDX].s)) {
2598 desc->iManufacturer = dev_str[USB_GADGET_MANUFACTURER_IDX].id;
2599 cdev->def_manufacturer = composite_default_mfr(cdev->gadget);
2600 dev_str[USB_GADGET_MANUFACTURER_IDX].s = cdev->def_manufacturer;
2601 }
2602
2603 if (covr->product) {
2604 desc->iProduct = dev_str[USB_GADGET_PRODUCT_IDX].id;
2605 dev_str[USB_GADGET_PRODUCT_IDX].s = covr->product;
2606 }
2607 }
2608 EXPORT_SYMBOL_GPL(usb_composite_overwrite_options);
2609
2610 MODULE_LICENSE("GPL");
2611 MODULE_AUTHOR("David Brownell");
2612