blob: a8b4ca04cc50949f5d4384a74fd5e28a7029ff93 [file] [log] [blame]
David Brownell40982be2008-06-19 17:52:58 -07001/*
2 * composite.c - infrastructure for Composite USB Gadgets
3 *
4 * Copyright (C) 2006-2008 David Brownell
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
David Brownell40982be2008-06-19 17:52:58 -070010 */
11
12/* #define VERBOSE_DEBUG */
13
14#include <linux/kallsyms.h>
15#include <linux/kernel.h>
16#include <linux/slab.h>
Paul Gortmaker6eb0de82011-07-03 16:09:31 -040017#include <linux/module.h>
David Brownell40982be2008-06-19 17:52:58 -070018#include <linux/device.h>
Michal Nazarewiczad1a8102010-08-12 17:43:46 +020019#include <linux/utsname.h>
David Brownell40982be2008-06-19 17:52:58 -070020
21#include <linux/usb/composite.h>
Macpaul Lin53e62422015-07-09 15:18:42 +080022#include <linux/usb/otg.h>
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +030023#include <asm/unaligned.h>
David Brownell40982be2008-06-19 17:52:58 -070024
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +020025#include "u_os_desc.h"
26
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +020027/**
28 * struct usb_os_string - represents OS String to be reported by a gadget
29 * @bLength: total length of the entire descritor, always 0x12
30 * @bDescriptorType: USB_DT_STRING
31 * @qwSignature: the OS String proper
32 * @bMS_VendorCode: code used by the host for subsequent requests
33 * @bPad: not used, must be zero
34 */
35struct usb_os_string {
36 __u8 bLength;
37 __u8 bDescriptorType;
38 __u8 qwSignature[OS_STRING_QW_SIGN_LEN];
39 __u8 bMS_VendorCode;
40 __u8 bPad;
41} __packed;
42
David Brownell40982be2008-06-19 17:52:58 -070043/*
44 * The code in this file is utility code, used to build a gadget driver
45 * from one or more "function" drivers, one or more "configuration"
46 * objects, and a "usb_composite_driver" by gluing them together along
47 * with the relevant device-wide data.
48 */
49
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +010050static struct usb_gadget_strings **get_containers_gs(
51 struct usb_gadget_string_container *uc)
52{
53 return (struct usb_gadget_strings **)uc->stash;
54}
55
Tatyana Brokhman48767a42011-06-28 16:33:49 +030056/**
John Younf3bdbe32016-02-05 17:07:03 -080057 * function_descriptors() - get function descriptors for speed
58 * @f: the function
59 * @speed: the speed
60 *
61 * Returns the descriptors or NULL if not set.
62 */
63static struct usb_descriptor_header **
64function_descriptors(struct usb_function *f,
65 enum usb_device_speed speed)
66{
67 struct usb_descriptor_header **descriptors;
68
Felipe Balbi08782632016-04-22 14:53:47 +030069 /*
70 * NOTE: we try to help gadget drivers which might not be setting
71 * max_speed appropriately.
72 */
73
John Younf3bdbe32016-02-05 17:07:03 -080074 switch (speed) {
75 case USB_SPEED_SUPER_PLUS:
76 descriptors = f->ssp_descriptors;
Felipe Balbi08782632016-04-22 14:53:47 +030077 if (descriptors)
78 break;
79 /* FALLTHROUGH */
John Younf3bdbe32016-02-05 17:07:03 -080080 case USB_SPEED_SUPER:
81 descriptors = f->ss_descriptors;
Felipe Balbi08782632016-04-22 14:53:47 +030082 if (descriptors)
83 break;
84 /* FALLTHROUGH */
John Younf3bdbe32016-02-05 17:07:03 -080085 case USB_SPEED_HIGH:
86 descriptors = f->hs_descriptors;
Felipe Balbi08782632016-04-22 14:53:47 +030087 if (descriptors)
88 break;
89 /* FALLTHROUGH */
John Younf3bdbe32016-02-05 17:07:03 -080090 default:
91 descriptors = f->fs_descriptors;
92 }
93
Felipe Balbi08782632016-04-22 14:53:47 +030094 /*
95 * if we can't find any descriptors at all, then this gadget deserves to
96 * Oops with a NULL pointer dereference
97 */
98
John Younf3bdbe32016-02-05 17:07:03 -080099 return descriptors;
100}
101
102/**
Tatyana Brokhman48767a42011-06-28 16:33:49 +0300103 * next_ep_desc() - advance to the next EP descriptor
104 * @t: currect pointer within descriptor array
105 *
106 * Return: next EP descriptor or NULL
107 *
108 * Iterate over @t until either EP descriptor found or
109 * NULL (that indicates end of list) encountered
110 */
111static struct usb_descriptor_header**
112next_ep_desc(struct usb_descriptor_header **t)
113{
114 for (; *t; t++) {
115 if ((*t)->bDescriptorType == USB_DT_ENDPOINT)
116 return t;
117 }
118 return NULL;
119}
120
121/*
122 * for_each_ep_desc()- iterate over endpoint descriptors in the
123 * descriptors list
124 * @start: pointer within descriptor array.
125 * @ep_desc: endpoint descriptor to use as the loop cursor
126 */
127#define for_each_ep_desc(start, ep_desc) \
128 for (ep_desc = next_ep_desc(start); \
129 ep_desc; ep_desc = next_ep_desc(ep_desc+1))
130
131/**
132 * config_ep_by_speed() - configures the given endpoint
133 * according to gadget speed.
134 * @g: pointer to the gadget
135 * @f: usb function
136 * @_ep: the endpoint to configure
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(struct usb_gadget *g,
150 struct usb_function *f,
151 struct usb_ep *_ep)
152{
153 struct usb_endpoint_descriptor *chosen_desc = NULL;
154 struct usb_descriptor_header **speed_desc = NULL;
155
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300156 struct usb_ss_ep_comp_descriptor *comp_desc = NULL;
157 int want_comp_desc = 0;
158
Tatyana Brokhman48767a42011-06-28 16:33:49 +0300159 struct usb_descriptor_header **d_spd; /* cursor for speed desc */
160
161 if (!g || !f || !_ep)
162 return -EIO;
163
164 /* select desired speed */
165 switch (g->speed) {
John Youn4eb8e322016-02-05 17:07:30 -0800166 case USB_SPEED_SUPER_PLUS:
167 if (gadget_is_superspeed_plus(g)) {
168 speed_desc = f->ssp_descriptors;
169 want_comp_desc = 1;
170 break;
171 }
172 /* else: Fall trough */
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300173 case USB_SPEED_SUPER:
174 if (gadget_is_superspeed(g)) {
175 speed_desc = f->ss_descriptors;
176 want_comp_desc = 1;
177 break;
178 }
179 /* else: Fall trough */
Tatyana Brokhman48767a42011-06-28 16:33:49 +0300180 case USB_SPEED_HIGH:
181 if (gadget_is_dualspeed(g)) {
182 speed_desc = f->hs_descriptors;
183 break;
184 }
185 /* else: fall through */
186 default:
Sebastian Andrzej Siewior10287ba2012-10-22 22:15:06 +0200187 speed_desc = f->fs_descriptors;
Tatyana Brokhman48767a42011-06-28 16:33:49 +0300188 }
189 /* find descriptors */
190 for_each_ep_desc(speed_desc, d_spd) {
191 chosen_desc = (struct usb_endpoint_descriptor *)*d_spd;
192 if (chosen_desc->bEndpointAddress == _ep->address)
193 goto ep_found;
194 }
195 return -EIO;
196
197ep_found:
198 /* commit results */
Felipe Balbie0aa5ec2016-09-28 10:38:11 +0300199 _ep->maxpacket = usb_endpoint_maxp(chosen_desc) & 0x7ff;
Tatyana Brokhman48767a42011-06-28 16:33:49 +0300200 _ep->desc = chosen_desc;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300201 _ep->comp_desc = NULL;
202 _ep->maxburst = 0;
Felipe Balbi3999c532016-09-28 12:33:31 +0300203 _ep->mult = 1;
204
205 if (g->speed == USB_SPEED_HIGH && (usb_endpoint_xfer_isoc(_ep->desc) ||
206 usb_endpoint_xfer_int(_ep->desc)))
207 _ep->mult = ((usb_endpoint_maxp(_ep->desc) & 0x1800) >> 11) + 1;
208
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300209 if (!want_comp_desc)
210 return 0;
Tatyana Brokhman48767a42011-06-28 16:33:49 +0300211
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300212 /*
213 * Companion descriptor should follow EP descriptor
214 * USB 3.0 spec, #9.6.7
215 */
216 comp_desc = (struct usb_ss_ep_comp_descriptor *)*(++d_spd);
217 if (!comp_desc ||
218 (comp_desc->bDescriptorType != USB_DT_SS_ENDPOINT_COMP))
219 return -EIO;
220 _ep->comp_desc = comp_desc;
John Youn4eb8e322016-02-05 17:07:30 -0800221 if (g->speed >= USB_SPEED_SUPER) {
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300222 switch (usb_endpoint_type(_ep->desc)) {
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300223 case USB_ENDPOINT_XFER_ISOC:
224 /* mult: bits 1:0 of bmAttributes */
Felipe Balbi3999c532016-09-28 12:33:31 +0300225 _ep->mult = (comp_desc->bmAttributes & 0x3) + 1;
Paul Zimmerman9e878a62012-01-16 13:24:38 -0800226 case USB_ENDPOINT_XFER_BULK:
227 case USB_ENDPOINT_XFER_INT:
Felipe Balbib785ea72012-06-06 10:20:23 +0300228 _ep->maxburst = comp_desc->bMaxBurst + 1;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300229 break;
230 default:
Colin Ian King0e216b02017-11-14 16:18:28 +0000231 if (comp_desc->bMaxBurst != 0) {
232 struct usb_composite_dev *cdev;
233
234 cdev = get_gadget_data(g);
Felipe Balbib785ea72012-06-06 10:20:23 +0300235 ERROR(cdev, "ep0 bMaxBurst must be 0\n");
Colin Ian King0e216b02017-11-14 16:18:28 +0000236 }
Felipe Balbib785ea72012-06-06 10:20:23 +0300237 _ep->maxburst = 1;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300238 break;
239 }
240 }
Tatyana Brokhman48767a42011-06-28 16:33:49 +0300241 return 0;
242}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +0200243EXPORT_SYMBOL_GPL(config_ep_by_speed);
David Brownell40982be2008-06-19 17:52:58 -0700244
245/**
246 * usb_add_function() - add a function to a configuration
247 * @config: the configuration
248 * @function: the function being added
249 * Context: single threaded during gadget setup
250 *
251 * After initialization, each configuration must have one or more
252 * functions added to it. Adding a function involves calling its @bind()
253 * method to allocate resources such as interface and string identifiers
254 * and endpoints.
255 *
256 * This function returns the value of the function's bind(), which is
257 * zero for success else a negative errno value.
258 */
Michal Nazarewicz28824b12010-05-05 12:53:13 +0200259int usb_add_function(struct usb_configuration *config,
David Brownell40982be2008-06-19 17:52:58 -0700260 struct usb_function *function)
261{
262 int value = -EINVAL;
263
264 DBG(config->cdev, "adding '%s'/%p to config '%s'/%p\n",
265 function->name, function,
266 config->label, config);
267
268 if (!function->set_alt || !function->disable)
269 goto done;
270
271 function->config = config;
272 list_add_tail(&function->list, &config->functions);
273
Robert Baldygad5bb9b82015-05-04 14:55:13 +0200274 if (function->bind_deactivated) {
275 value = usb_function_deactivate(function);
276 if (value)
277 goto done;
278 }
279
David Brownell40982be2008-06-19 17:52:58 -0700280 /* REVISIT *require* function->bind? */
281 if (function->bind) {
282 value = function->bind(config, function);
283 if (value < 0) {
284 list_del(&function->list);
285 function->config = NULL;
286 }
287 } else
288 value = 0;
289
290 /* We allow configurations that don't work at both speeds.
291 * If we run into a lowspeed Linux system, treat it the same
292 * as full speed ... it's the function drivers that will need
293 * to avoid bulk and ISO transfers.
294 */
Sebastian Andrzej Siewior10287ba2012-10-22 22:15:06 +0200295 if (!config->fullspeed && function->fs_descriptors)
David Brownell40982be2008-06-19 17:52:58 -0700296 config->fullspeed = true;
297 if (!config->highspeed && function->hs_descriptors)
298 config->highspeed = true;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300299 if (!config->superspeed && function->ss_descriptors)
300 config->superspeed = true;
John Youn554eead2016-02-05 17:06:35 -0800301 if (!config->superspeed_plus && function->ssp_descriptors)
302 config->superspeed_plus = true;
David Brownell40982be2008-06-19 17:52:58 -0700303
304done:
305 if (value)
306 DBG(config->cdev, "adding '%s'/%p --> %d\n",
307 function->name, function, value);
308 return value;
309}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +0200310EXPORT_SYMBOL_GPL(usb_add_function);
David Brownell40982be2008-06-19 17:52:58 -0700311
Sebastian Andrzej Siewiorb47357782012-12-23 21:10:05 +0100312void usb_remove_function(struct usb_configuration *c, struct usb_function *f)
313{
314 if (f->disable)
315 f->disable(f);
316
317 bitmap_zero(f->endpoints, 32);
318 list_del(&f->list);
319 if (f->unbind)
320 f->unbind(c, f);
321}
322EXPORT_SYMBOL_GPL(usb_remove_function);
323
David Brownell40982be2008-06-19 17:52:58 -0700324/**
David Brownell60beed92008-08-18 17:38:22 -0700325 * usb_function_deactivate - prevent function and gadget enumeration
326 * @function: the function that isn't yet ready to respond
327 *
328 * Blocks response of the gadget driver to host enumeration by
329 * preventing the data line pullup from being activated. This is
330 * normally called during @bind() processing to change from the
331 * initial "ready to respond" state, or when a required resource
332 * becomes available.
333 *
334 * For example, drivers that serve as a passthrough to a userspace
335 * daemon can block enumeration unless that daemon (such as an OBEX,
336 * MTP, or print server) is ready to handle host requests.
337 *
338 * Not all systems support software control of their USB peripheral
339 * data pullups.
340 *
341 * Returns zero on success, else negative errno.
342 */
343int usb_function_deactivate(struct usb_function *function)
344{
345 struct usb_composite_dev *cdev = function->config->cdev;
Felipe Balbib2bdf3a2009-02-12 15:09:47 +0200346 unsigned long flags;
David Brownell60beed92008-08-18 17:38:22 -0700347 int status = 0;
348
Felipe Balbib2bdf3a2009-02-12 15:09:47 +0200349 spin_lock_irqsave(&cdev->lock, flags);
David Brownell60beed92008-08-18 17:38:22 -0700350
351 if (cdev->deactivations == 0)
Robert Baldyga56012502015-05-04 14:55:12 +0200352 status = usb_gadget_deactivate(cdev->gadget);
David Brownell60beed92008-08-18 17:38:22 -0700353 if (status == 0)
354 cdev->deactivations++;
355
Felipe Balbib2bdf3a2009-02-12 15:09:47 +0200356 spin_unlock_irqrestore(&cdev->lock, flags);
David Brownell60beed92008-08-18 17:38:22 -0700357 return status;
358}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +0200359EXPORT_SYMBOL_GPL(usb_function_deactivate);
David Brownell60beed92008-08-18 17:38:22 -0700360
361/**
362 * usb_function_activate - allow function and gadget enumeration
363 * @function: function on which usb_function_activate() was called
364 *
365 * Reverses effect of usb_function_deactivate(). If no more functions
366 * are delaying their activation, the gadget driver will respond to
367 * host enumeration procedures.
368 *
369 * Returns zero on success, else negative errno.
370 */
371int usb_function_activate(struct usb_function *function)
372{
373 struct usb_composite_dev *cdev = function->config->cdev;
Michael Grzeschik4fefe9f2012-07-19 00:20:11 +0200374 unsigned long flags;
David Brownell60beed92008-08-18 17:38:22 -0700375 int status = 0;
376
Michael Grzeschik4fefe9f2012-07-19 00:20:11 +0200377 spin_lock_irqsave(&cdev->lock, flags);
David Brownell60beed92008-08-18 17:38:22 -0700378
379 if (WARN_ON(cdev->deactivations == 0))
380 status = -EINVAL;
381 else {
382 cdev->deactivations--;
383 if (cdev->deactivations == 0)
Robert Baldyga56012502015-05-04 14:55:12 +0200384 status = usb_gadget_activate(cdev->gadget);
David Brownell60beed92008-08-18 17:38:22 -0700385 }
386
Michael Grzeschik4fefe9f2012-07-19 00:20:11 +0200387 spin_unlock_irqrestore(&cdev->lock, flags);
David Brownell60beed92008-08-18 17:38:22 -0700388 return status;
389}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +0200390EXPORT_SYMBOL_GPL(usb_function_activate);
David Brownell60beed92008-08-18 17:38:22 -0700391
392/**
David Brownell40982be2008-06-19 17:52:58 -0700393 * usb_interface_id() - allocate an unused interface ID
394 * @config: configuration associated with the interface
395 * @function: function handling the interface
396 * Context: single threaded during gadget setup
397 *
398 * usb_interface_id() is called from usb_function.bind() callbacks to
399 * allocate new interface IDs. The function driver will then store that
400 * ID in interface, association, CDC union, and other descriptors. It
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300401 * will also handle any control requests targeted at that interface,
David Brownell40982be2008-06-19 17:52:58 -0700402 * particularly changing its altsetting via set_alt(). There may
403 * also be class-specific or vendor-specific requests to handle.
404 *
405 * All interface identifier should be allocated using this routine, to
406 * ensure that for example different functions don't wrongly assign
407 * different meanings to the same identifier. Note that since interface
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300408 * identifiers are configuration-specific, functions used in more than
David Brownell40982be2008-06-19 17:52:58 -0700409 * one configuration (or more than once in a given configuration) need
410 * multiple versions of the relevant descriptors.
411 *
412 * Returns the interface ID which was allocated; or -ENODEV if no
413 * more interface IDs can be allocated.
414 */
Michal Nazarewicz28824b12010-05-05 12:53:13 +0200415int usb_interface_id(struct usb_configuration *config,
David Brownell40982be2008-06-19 17:52:58 -0700416 struct usb_function *function)
417{
418 unsigned id = config->next_interface_id;
419
420 if (id < MAX_CONFIG_INTERFACES) {
421 config->interface[id] = function;
422 config->next_interface_id = id + 1;
423 return id;
424 }
425 return -ENODEV;
426}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +0200427EXPORT_SYMBOL_GPL(usb_interface_id);
David Brownell40982be2008-06-19 17:52:58 -0700428
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +0100429static u8 encode_bMaxPower(enum usb_device_speed speed,
430 struct usb_configuration *c)
431{
432 unsigned val;
433
434 if (c->MaxPower)
435 val = c->MaxPower;
436 else
437 val = CONFIG_USB_GADGET_VBUS_DRAW;
438 if (!val)
439 return 0;
440 switch (speed) {
441 case USB_SPEED_SUPER:
442 return DIV_ROUND_UP(val, 8);
443 default:
444 return DIV_ROUND_UP(val, 2);
Joe Perches2b84f922013-10-08 16:01:37 -0700445 }
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +0100446}
447
David Brownell40982be2008-06-19 17:52:58 -0700448static int config_buf(struct usb_configuration *config,
449 enum usb_device_speed speed, void *buf, u8 type)
450{
451 struct usb_config_descriptor *c = buf;
452 void *next = buf + USB_DT_CONFIG_SIZE;
Sebastian Andrzej Siewiore13f17f2012-09-10 15:01:51 +0200453 int len;
David Brownell40982be2008-06-19 17:52:58 -0700454 struct usb_function *f;
455 int status;
456
Sebastian Andrzej Siewiore13f17f2012-09-10 15:01:51 +0200457 len = USB_COMP_EP0_BUFSIZ - USB_DT_CONFIG_SIZE;
David Brownell40982be2008-06-19 17:52:58 -0700458 /* write the config descriptor */
459 c = buf;
460 c->bLength = USB_DT_CONFIG_SIZE;
461 c->bDescriptorType = type;
462 /* wTotalLength is written later */
463 c->bNumInterfaces = config->next_interface_id;
464 c->bConfigurationValue = config->bConfigurationValue;
465 c->iConfiguration = config->iConfiguration;
466 c->bmAttributes = USB_CONFIG_ATT_ONE | config->bmAttributes;
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +0100467 c->bMaxPower = encode_bMaxPower(speed, config);
David Brownell40982be2008-06-19 17:52:58 -0700468
469 /* There may be e.g. OTG descriptors */
470 if (config->descriptors) {
471 status = usb_descriptor_fillbuf(next, len,
472 config->descriptors);
473 if (status < 0)
474 return status;
475 len -= status;
476 next += status;
477 }
478
479 /* add each function's descriptors */
480 list_for_each_entry(f, &config->functions, list) {
481 struct usb_descriptor_header **descriptors;
482
John Younf3bdbe32016-02-05 17:07:03 -0800483 descriptors = function_descriptors(f, speed);
David Brownell40982be2008-06-19 17:52:58 -0700484 if (!descriptors)
485 continue;
486 status = usb_descriptor_fillbuf(next, len,
487 (const struct usb_descriptor_header **) descriptors);
488 if (status < 0)
489 return status;
490 len -= status;
491 next += status;
492 }
493
494 len = next - buf;
495 c->wTotalLength = cpu_to_le16(len);
496 return len;
497}
498
499static int config_desc(struct usb_composite_dev *cdev, unsigned w_value)
500{
501 struct usb_gadget *gadget = cdev->gadget;
502 struct usb_configuration *c;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200503 struct list_head *pos;
David Brownell40982be2008-06-19 17:52:58 -0700504 u8 type = w_value >> 8;
505 enum usb_device_speed speed = USB_SPEED_UNKNOWN;
506
John Youneae58202016-02-05 17:07:17 -0800507 if (gadget->speed >= USB_SPEED_SUPER)
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300508 speed = gadget->speed;
509 else if (gadget_is_dualspeed(gadget)) {
510 int hs = 0;
David Brownell40982be2008-06-19 17:52:58 -0700511 if (gadget->speed == USB_SPEED_HIGH)
512 hs = 1;
513 if (type == USB_DT_OTHER_SPEED_CONFIG)
514 hs = !hs;
515 if (hs)
516 speed = USB_SPEED_HIGH;
517
518 }
519
520 /* This is a lookup by config *INDEX* */
521 w_value &= 0xff;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +0200522
523 pos = &cdev->configs;
524 c = cdev->os_desc_config;
525 if (c)
526 goto check_config;
527
528 while ((pos = pos->next) != &cdev->configs) {
529 c = list_entry(pos, typeof(*c), list);
530
531 /* skip OS Descriptors config which is handled separately */
532 if (c == cdev->os_desc_config)
533 continue;
534
535check_config:
David Brownell40982be2008-06-19 17:52:58 -0700536 /* ignore configs that won't work at this speed */
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300537 switch (speed) {
John Youneae58202016-02-05 17:07:17 -0800538 case USB_SPEED_SUPER_PLUS:
539 if (!c->superspeed_plus)
540 continue;
541 break;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300542 case USB_SPEED_SUPER:
543 if (!c->superspeed)
544 continue;
545 break;
546 case USB_SPEED_HIGH:
David Brownell40982be2008-06-19 17:52:58 -0700547 if (!c->highspeed)
548 continue;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300549 break;
550 default:
David Brownell40982be2008-06-19 17:52:58 -0700551 if (!c->fullspeed)
552 continue;
553 }
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300554
David Brownell40982be2008-06-19 17:52:58 -0700555 if (w_value == 0)
556 return config_buf(c, speed, cdev->req->buf, type);
557 w_value--;
558 }
559 return -EINVAL;
560}
561
562static int count_configs(struct usb_composite_dev *cdev, unsigned type)
563{
564 struct usb_gadget *gadget = cdev->gadget;
565 struct usb_configuration *c;
566 unsigned count = 0;
567 int hs = 0;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300568 int ss = 0;
John Youna4afd012016-02-05 17:06:49 -0800569 int ssp = 0;
David Brownell40982be2008-06-19 17:52:58 -0700570
571 if (gadget_is_dualspeed(gadget)) {
572 if (gadget->speed == USB_SPEED_HIGH)
573 hs = 1;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300574 if (gadget->speed == USB_SPEED_SUPER)
575 ss = 1;
John Youna4afd012016-02-05 17:06:49 -0800576 if (gadget->speed == USB_SPEED_SUPER_PLUS)
577 ssp = 1;
David Brownell40982be2008-06-19 17:52:58 -0700578 if (type == USB_DT_DEVICE_QUALIFIER)
579 hs = !hs;
580 }
581 list_for_each_entry(c, &cdev->configs, list) {
582 /* ignore configs that won't work at this speed */
John Youna4afd012016-02-05 17:06:49 -0800583 if (ssp) {
584 if (!c->superspeed_plus)
585 continue;
586 } else if (ss) {
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300587 if (!c->superspeed)
588 continue;
589 } else if (hs) {
David Brownell40982be2008-06-19 17:52:58 -0700590 if (!c->highspeed)
591 continue;
592 } else {
593 if (!c->fullspeed)
594 continue;
595 }
596 count++;
597 }
598 return count;
599}
600
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300601/**
602 * bos_desc() - prepares the BOS descriptor.
603 * @cdev: pointer to usb_composite device to generate the bos
604 * descriptor for
605 *
606 * This function generates the BOS (Binary Device Object)
607 * descriptor and its device capabilities descriptors. The BOS
608 * descriptor should be supported by a SuperSpeed device.
609 */
610static int bos_desc(struct usb_composite_dev *cdev)
611{
612 struct usb_ext_cap_descriptor *usb_ext;
613 struct usb_ss_cap_descriptor *ss_cap;
614 struct usb_dcd_config_params dcd_config_params;
615 struct usb_bos_descriptor *bos = cdev->req->buf;
616
617 bos->bLength = USB_DT_BOS_SIZE;
618 bos->bDescriptorType = USB_DT_BOS;
619
620 bos->wTotalLength = cpu_to_le16(USB_DT_BOS_SIZE);
621 bos->bNumDeviceCaps = 0;
622
623 /*
624 * A SuperSpeed device shall include the USB2.0 extension descriptor
625 * and shall support LPM when operating in USB2.0 HS mode.
626 */
627 usb_ext = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
628 bos->bNumDeviceCaps++;
629 le16_add_cpu(&bos->wTotalLength, USB_DT_USB_EXT_CAP_SIZE);
630 usb_ext->bLength = USB_DT_USB_EXT_CAP_SIZE;
631 usb_ext->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
632 usb_ext->bDevCapabilityType = USB_CAP_TYPE_EXT;
Felipe Balbia6615932014-09-30 16:08:03 -0500633 usb_ext->bmAttributes = cpu_to_le32(USB_LPM_SUPPORT | USB_BESL_SUPPORT);
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300634
635 /*
636 * The Superspeed USB Capability descriptor shall be implemented by all
637 * SuperSpeed devices.
638 */
639 ss_cap = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
640 bos->bNumDeviceCaps++;
641 le16_add_cpu(&bos->wTotalLength, USB_DT_USB_SS_CAP_SIZE);
642 ss_cap->bLength = USB_DT_USB_SS_CAP_SIZE;
643 ss_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
644 ss_cap->bDevCapabilityType = USB_SS_CAP_TYPE;
645 ss_cap->bmAttributes = 0; /* LTM is not supported yet */
646 ss_cap->wSpeedSupported = cpu_to_le16(USB_LOW_SPEED_OPERATION |
647 USB_FULL_SPEED_OPERATION |
648 USB_HIGH_SPEED_OPERATION |
649 USB_5GBPS_OPERATION);
650 ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
651
652 /* Get Controller configuration */
653 if (cdev->gadget->ops->get_config_params)
654 cdev->gadget->ops->get_config_params(&dcd_config_params);
655 else {
Felipe Balbi089b8372011-10-10 09:43:44 +0300656 dcd_config_params.bU1devExitLat = USB_DEFAULT_U1_DEV_EXIT_LAT;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300657 dcd_config_params.bU2DevExitLat =
Felipe Balbi089b8372011-10-10 09:43:44 +0300658 cpu_to_le16(USB_DEFAULT_U2_DEV_EXIT_LAT);
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300659 }
660 ss_cap->bU1devExitLat = dcd_config_params.bU1devExitLat;
661 ss_cap->bU2DevExitLat = dcd_config_params.bU2DevExitLat;
662
John Younf228a8d2016-02-05 17:05:53 -0800663 /* The SuperSpeedPlus USB Device Capability descriptor */
664 if (gadget_is_superspeed_plus(cdev->gadget)) {
665 struct usb_ssp_cap_descriptor *ssp_cap;
666
667 ssp_cap = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
668 bos->bNumDeviceCaps++;
669
670 /*
671 * Report typical values.
672 */
673
674 le16_add_cpu(&bos->wTotalLength, USB_DT_USB_SSP_CAP_SIZE(1));
675 ssp_cap->bLength = USB_DT_USB_SSP_CAP_SIZE(1);
676 ssp_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
677 ssp_cap->bDevCapabilityType = USB_SSP_CAP_TYPE;
John Youn138b8632016-04-08 14:46:31 -0700678 ssp_cap->bReserved = 0;
679 ssp_cap->wReserved = 0;
John Younf228a8d2016-02-05 17:05:53 -0800680
681 /* SSAC = 1 (2 attributes) */
682 ssp_cap->bmAttributes = cpu_to_le32(1);
683
684 /* Min RX/TX Lane Count = 1 */
John Youn08f8cab2016-03-28 16:12:24 -0700685 ssp_cap->wFunctionalitySupport =
686 cpu_to_le16((1 << 8) | (1 << 12));
John Younf228a8d2016-02-05 17:05:53 -0800687
688 /*
689 * bmSublinkSpeedAttr[0]:
690 * ST = Symmetric, RX
691 * LSE = 3 (Gbps)
692 * LP = 1 (SuperSpeedPlus)
693 * LSM = 10 (10 Gbps)
694 */
695 ssp_cap->bmSublinkSpeedAttr[0] =
John Youn08f8cab2016-03-28 16:12:24 -0700696 cpu_to_le32((3 << 4) | (1 << 14) | (0xa << 16));
John Younf228a8d2016-02-05 17:05:53 -0800697 /*
698 * bmSublinkSpeedAttr[1] =
699 * ST = Symmetric, TX
700 * LSE = 3 (Gbps)
701 * LP = 1 (SuperSpeedPlus)
702 * LSM = 10 (10 Gbps)
703 */
704 ssp_cap->bmSublinkSpeedAttr[1] =
John Youn08f8cab2016-03-28 16:12:24 -0700705 cpu_to_le32((3 << 4) | (1 << 14) |
706 (0xa << 16) | (1 << 7));
John Younf228a8d2016-02-05 17:05:53 -0800707 }
708
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300709 return le16_to_cpu(bos->wTotalLength);
710}
711
David Brownell40982be2008-06-19 17:52:58 -0700712static void device_qual(struct usb_composite_dev *cdev)
713{
714 struct usb_qualifier_descriptor *qual = cdev->req->buf;
715
716 qual->bLength = sizeof(*qual);
717 qual->bDescriptorType = USB_DT_DEVICE_QUALIFIER;
718 /* POLICY: same bcdUSB and device type info at both speeds */
719 qual->bcdUSB = cdev->desc.bcdUSB;
720 qual->bDeviceClass = cdev->desc.bDeviceClass;
721 qual->bDeviceSubClass = cdev->desc.bDeviceSubClass;
722 qual->bDeviceProtocol = cdev->desc.bDeviceProtocol;
723 /* ASSUME same EP0 fifo size at both speeds */
Sebastian Andrzej Siewior765f5b82011-06-23 14:26:11 +0200724 qual->bMaxPacketSize0 = cdev->gadget->ep0->maxpacket;
David Brownell40982be2008-06-19 17:52:58 -0700725 qual->bNumConfigurations = count_configs(cdev, USB_DT_DEVICE_QUALIFIER);
David Lopoc24f4222008-07-01 13:14:17 -0700726 qual->bRESERVED = 0;
David Brownell40982be2008-06-19 17:52:58 -0700727}
728
729/*-------------------------------------------------------------------------*/
730
731static void reset_config(struct usb_composite_dev *cdev)
732{
733 struct usb_function *f;
734
735 DBG(cdev, "reset config\n");
736
737 list_for_each_entry(f, &cdev->config->functions, list) {
738 if (f->disable)
739 f->disable(f);
Laurent Pinchart52426582009-10-21 00:03:38 +0200740
741 bitmap_zero(f->endpoints, 32);
David Brownell40982be2008-06-19 17:52:58 -0700742 }
743 cdev->config = NULL;
Michael Grzeschik2bac51a2013-11-11 23:43:32 +0100744 cdev->delayed_status = 0;
David Brownell40982be2008-06-19 17:52:58 -0700745}
746
747static int set_config(struct usb_composite_dev *cdev,
748 const struct usb_ctrlrequest *ctrl, unsigned number)
749{
750 struct usb_gadget *gadget = cdev->gadget;
751 struct usb_configuration *c = NULL;
752 int result = -EINVAL;
753 unsigned power = gadget_is_otg(gadget) ? 8 : 100;
754 int tmp;
755
David Brownell40982be2008-06-19 17:52:58 -0700756 if (number) {
757 list_for_each_entry(c, &cdev->configs, list) {
758 if (c->bConfigurationValue == number) {
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300759 /*
760 * We disable the FDs of the previous
761 * configuration only if the new configuration
762 * is a valid one
763 */
764 if (cdev->config)
765 reset_config(cdev);
David Brownell40982be2008-06-19 17:52:58 -0700766 result = 0;
767 break;
768 }
769 }
770 if (result < 0)
771 goto done;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300772 } else { /* Zero configuration value - need to reset the config */
773 if (cdev->config)
774 reset_config(cdev);
David Brownell40982be2008-06-19 17:52:58 -0700775 result = 0;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300776 }
David Brownell40982be2008-06-19 17:52:58 -0700777
Michal Nazarewicze538dfd2011-08-30 17:11:19 +0200778 INFO(cdev, "%s config #%d: %s\n",
779 usb_speed_string(gadget->speed),
780 number, c ? c->label : "unconfigured");
David Brownell40982be2008-06-19 17:52:58 -0700781
782 if (!c)
783 goto done;
784
Peter Chen6027f312014-04-29 13:26:28 +0800785 usb_gadget_set_state(gadget, USB_STATE_CONFIGURED);
David Brownell40982be2008-06-19 17:52:58 -0700786 cdev->config = c;
787
788 /* Initialize all interfaces by setting them to altsetting zero. */
789 for (tmp = 0; tmp < MAX_CONFIG_INTERFACES; tmp++) {
790 struct usb_function *f = c->interface[tmp];
Laurent Pinchart52426582009-10-21 00:03:38 +0200791 struct usb_descriptor_header **descriptors;
David Brownell40982be2008-06-19 17:52:58 -0700792
793 if (!f)
794 break;
795
Laurent Pinchart52426582009-10-21 00:03:38 +0200796 /*
797 * Record which endpoints are used by the function. This is used
798 * to dispatch control requests targeted at that endpoint to the
799 * function's setup callback instead of the current
800 * configuration's setup callback.
801 */
John Younf3bdbe32016-02-05 17:07:03 -0800802 descriptors = function_descriptors(f, gadget->speed);
Laurent Pinchart52426582009-10-21 00:03:38 +0200803
804 for (; *descriptors; ++descriptors) {
805 struct usb_endpoint_descriptor *ep;
806 int addr;
807
808 if ((*descriptors)->bDescriptorType != USB_DT_ENDPOINT)
809 continue;
810
811 ep = (struct usb_endpoint_descriptor *)*descriptors;
812 addr = ((ep->bEndpointAddress & 0x80) >> 3)
813 | (ep->bEndpointAddress & 0x0f);
814 set_bit(addr, f->endpoints);
815 }
816
David Brownell40982be2008-06-19 17:52:58 -0700817 result = f->set_alt(f, tmp, 0);
818 if (result < 0) {
819 DBG(cdev, "interface %d (%s/%p) alt 0 --> %d\n",
820 tmp, f->name, f, result);
821
822 reset_config(cdev);
823 goto done;
824 }
Roger Quadros1b9ba002011-05-09 13:08:06 +0300825
826 if (result == USB_GADGET_DELAYED_STATUS) {
827 DBG(cdev,
828 "%s: interface %d (%s) requested delayed status\n",
829 __func__, tmp, f->name);
830 cdev->delayed_status++;
831 DBG(cdev, "delayed_status count %d\n",
832 cdev->delayed_status);
833 }
David Brownell40982be2008-06-19 17:52:58 -0700834 }
835
836 /* when we return, be sure our power usage is valid */
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +0100837 power = c->MaxPower ? c->MaxPower : CONFIG_USB_GADGET_VBUS_DRAW;
David Brownell40982be2008-06-19 17:52:58 -0700838done:
839 usb_gadget_vbus_draw(gadget, power);
Roger Quadros1b9ba002011-05-09 13:08:06 +0300840 if (result >= 0 && cdev->delayed_status)
841 result = USB_GADGET_DELAYED_STATUS;
David Brownell40982be2008-06-19 17:52:58 -0700842 return result;
843}
844
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100845int usb_add_config_only(struct usb_composite_dev *cdev,
846 struct usb_configuration *config)
847{
848 struct usb_configuration *c;
849
850 if (!config->bConfigurationValue)
851 return -EINVAL;
852
853 /* Prevent duplicate configuration identifiers */
854 list_for_each_entry(c, &cdev->configs, list) {
855 if (c->bConfigurationValue == config->bConfigurationValue)
856 return -EBUSY;
857 }
858
859 config->cdev = cdev;
860 list_add_tail(&config->list, &cdev->configs);
861
862 INIT_LIST_HEAD(&config->functions);
863 config->next_interface_id = 0;
864 memset(config->interface, 0, sizeof(config->interface));
865
866 return 0;
867}
868EXPORT_SYMBOL_GPL(usb_add_config_only);
869
David Brownell40982be2008-06-19 17:52:58 -0700870/**
871 * usb_add_config() - add a configuration to a device.
872 * @cdev: wraps the USB gadget
873 * @config: the configuration, with bConfigurationValue assigned
Uwe Kleine-Königc9bfff92010-08-12 17:43:55 +0200874 * @bind: the configuration's bind function
David Brownell40982be2008-06-19 17:52:58 -0700875 * Context: single threaded during gadget setup
876 *
Uwe Kleine-Königc9bfff92010-08-12 17:43:55 +0200877 * One of the main tasks of a composite @bind() routine is to
David Brownell40982be2008-06-19 17:52:58 -0700878 * add each of the configurations it supports, using this routine.
879 *
Uwe Kleine-Königc9bfff92010-08-12 17:43:55 +0200880 * This function returns the value of the configuration's @bind(), which
David Brownell40982be2008-06-19 17:52:58 -0700881 * is zero for success else a negative errno value. Binding configurations
882 * assigns global resources including string IDs, and per-configuration
883 * resources such as interface IDs and endpoints.
884 */
Michal Nazarewicz28824b12010-05-05 12:53:13 +0200885int usb_add_config(struct usb_composite_dev *cdev,
Uwe Kleine-Königc9bfff92010-08-12 17:43:55 +0200886 struct usb_configuration *config,
887 int (*bind)(struct usb_configuration *))
David Brownell40982be2008-06-19 17:52:58 -0700888{
889 int status = -EINVAL;
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100890
891 if (!bind)
892 goto done;
David Brownell40982be2008-06-19 17:52:58 -0700893
894 DBG(cdev, "adding config #%u '%s'/%p\n",
895 config->bConfigurationValue,
896 config->label, config);
897
Sebastian Andrzej Siewiorde53c252012-12-23 21:10:00 +0100898 status = usb_add_config_only(cdev, config);
899 if (status)
David Brownell40982be2008-06-19 17:52:58 -0700900 goto done;
901
Uwe Kleine-Königc9bfff92010-08-12 17:43:55 +0200902 status = bind(config);
David Brownell40982be2008-06-19 17:52:58 -0700903 if (status < 0) {
Yongsul Oh124ef382012-03-20 10:38:38 +0900904 while (!list_empty(&config->functions)) {
905 struct usb_function *f;
906
907 f = list_first_entry(&config->functions,
908 struct usb_function, list);
909 list_del(&f->list);
910 if (f->unbind) {
911 DBG(cdev, "unbind function '%s'/%p\n",
912 f->name, f);
913 f->unbind(config, f);
914 /* may free memory for "f" */
915 }
916 }
David Brownell40982be2008-06-19 17:52:58 -0700917 list_del(&config->list);
918 config->cdev = NULL;
919 } else {
920 unsigned i;
921
John Youncd69cbe2016-02-05 17:07:44 -0800922 DBG(cdev, "cfg %d/%p speeds:%s%s%s%s\n",
David Brownell40982be2008-06-19 17:52:58 -0700923 config->bConfigurationValue, config,
John Youncd69cbe2016-02-05 17:07:44 -0800924 config->superspeed_plus ? " superplus" : "",
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +0300925 config->superspeed ? " super" : "",
David Brownell40982be2008-06-19 17:52:58 -0700926 config->highspeed ? " high" : "",
927 config->fullspeed
928 ? (gadget_is_dualspeed(cdev->gadget)
929 ? " full"
930 : " full/low")
931 : "");
932
933 for (i = 0; i < MAX_CONFIG_INTERFACES; i++) {
934 struct usb_function *f = config->interface[i];
935
936 if (!f)
937 continue;
938 DBG(cdev, " interface %d = %s/%p\n",
939 i, f->name, f);
940 }
941 }
942
Robert Baldygaf871cb92015-09-16 12:10:39 +0200943 /* set_alt(), or next bind(), sets up ep->claimed as needed */
David Brownell40982be2008-06-19 17:52:58 -0700944 usb_ep_autoconfig_reset(cdev->gadget);
945
946done:
947 if (status)
948 DBG(cdev, "added config '%s'/%u --> %d\n", config->label,
949 config->bConfigurationValue, status);
950 return status;
951}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +0200952EXPORT_SYMBOL_GPL(usb_add_config);
David Brownell40982be2008-06-19 17:52:58 -0700953
Benoit Goby51cce6f2012-05-10 10:07:57 +0200954static void remove_config(struct usb_composite_dev *cdev,
955 struct usb_configuration *config)
956{
957 while (!list_empty(&config->functions)) {
958 struct usb_function *f;
959
960 f = list_first_entry(&config->functions,
961 struct usb_function, list);
962 list_del(&f->list);
963 if (f->unbind) {
964 DBG(cdev, "unbind function '%s'/%p\n", f->name, f);
965 f->unbind(config, f);
966 /* may free memory for "f" */
967 }
968 }
969 list_del(&config->list);
970 if (config->unbind) {
971 DBG(cdev, "unbind config '%s'/%p\n", config->label, config);
972 config->unbind(config);
973 /* may free memory for "c" */
974 }
975}
976
977/**
978 * usb_remove_config() - remove a configuration from a device.
979 * @cdev: wraps the USB gadget
980 * @config: the configuration
981 *
982 * Drivers must call usb_gadget_disconnect before calling this function
983 * to disconnect the device from the host and make sure the host will not
984 * try to enumerate the device while we are changing the config list.
985 */
986void usb_remove_config(struct usb_composite_dev *cdev,
987 struct usb_configuration *config)
988{
989 unsigned long flags;
990
991 spin_lock_irqsave(&cdev->lock, flags);
992
993 if (cdev->config == config)
994 reset_config(cdev);
995
996 spin_unlock_irqrestore(&cdev->lock, flags);
997
998 remove_config(cdev, config);
999}
1000
David Brownell40982be2008-06-19 17:52:58 -07001001/*-------------------------------------------------------------------------*/
1002
1003/* We support strings in multiple languages ... string descriptor zero
1004 * says which languages are supported. The typical case will be that
Diego Violaad4676a2015-05-31 15:52:41 -03001005 * only one language (probably English) is used, with i18n handled on
David Brownell40982be2008-06-19 17:52:58 -07001006 * the host side.
1007 */
1008
1009static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf)
1010{
1011 const struct usb_gadget_strings *s;
Dan Carpenter20c5e742012-04-17 09:30:22 +03001012 __le16 language;
David Brownell40982be2008-06-19 17:52:58 -07001013 __le16 *tmp;
1014
1015 while (*sp) {
1016 s = *sp;
1017 language = cpu_to_le16(s->language);
1018 for (tmp = buf; *tmp && tmp < &buf[126]; tmp++) {
1019 if (*tmp == language)
1020 goto repeat;
1021 }
1022 *tmp++ = language;
1023repeat:
1024 sp++;
1025 }
1026}
1027
1028static int lookup_string(
1029 struct usb_gadget_strings **sp,
1030 void *buf,
1031 u16 language,
1032 int id
1033)
1034{
1035 struct usb_gadget_strings *s;
1036 int value;
1037
1038 while (*sp) {
1039 s = *sp++;
1040 if (s->language != language)
1041 continue;
1042 value = usb_gadget_get_string(s, id, buf);
1043 if (value > 0)
1044 return value;
1045 }
1046 return -EINVAL;
1047}
1048
1049static int get_string(struct usb_composite_dev *cdev,
1050 void *buf, u16 language, int id)
1051{
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02001052 struct usb_composite_driver *composite = cdev->driver;
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +01001053 struct usb_gadget_string_container *uc;
David Brownell40982be2008-06-19 17:52:58 -07001054 struct usb_configuration *c;
1055 struct usb_function *f;
1056 int len;
1057
Diego Violaad4676a2015-05-31 15:52:41 -03001058 /* Yes, not only is USB's i18n support probably more than most
David Brownell40982be2008-06-19 17:52:58 -07001059 * folk will ever care about ... also, it's all supported here.
1060 * (Except for UTF8 support for Unicode's "Astral Planes".)
1061 */
1062
1063 /* 0 == report all available language codes */
1064 if (id == 0) {
1065 struct usb_string_descriptor *s = buf;
1066 struct usb_gadget_strings **sp;
1067
1068 memset(s, 0, 256);
1069 s->bDescriptorType = USB_DT_STRING;
1070
1071 sp = composite->strings;
1072 if (sp)
1073 collect_langs(sp, s->wData);
1074
1075 list_for_each_entry(c, &cdev->configs, list) {
1076 sp = c->strings;
1077 if (sp)
1078 collect_langs(sp, s->wData);
1079
1080 list_for_each_entry(f, &c->functions, list) {
1081 sp = f->strings;
1082 if (sp)
1083 collect_langs(sp, s->wData);
1084 }
1085 }
Sebastian Andrzej Siewior27a466332012-12-23 21:10:23 +01001086 list_for_each_entry(uc, &cdev->gstrings, list) {
1087 struct usb_gadget_strings **sp;
1088
1089 sp = get_containers_gs(uc);
1090 collect_langs(sp, s->wData);
1091 }
David Brownell40982be2008-06-19 17:52:58 -07001092
Roel Kluin417b57b2009-08-06 16:09:51 -07001093 for (len = 0; len <= 126 && s->wData[len]; len++)
David Brownell40982be2008-06-19 17:52:58 -07001094 continue;
1095 if (!len)
1096 return -EINVAL;
1097
1098 s->bLength = 2 * (len + 1);
1099 return s->bLength;
1100 }
1101
Andrzej Pietrasiewicz19824d52014-05-08 14:06:22 +02001102 if (cdev->use_os_string && language == 0 && id == OS_STRING_IDX) {
1103 struct usb_os_string *b = buf;
1104 b->bLength = sizeof(*b);
1105 b->bDescriptorType = USB_DT_STRING;
1106 compiletime_assert(
1107 sizeof(b->qwSignature) == sizeof(cdev->qw_sign),
1108 "qwSignature size must be equal to qw_sign");
1109 memcpy(&b->qwSignature, cdev->qw_sign, sizeof(b->qwSignature));
1110 b->bMS_VendorCode = cdev->b_vendor_code;
1111 b->bPad = 0;
1112 return sizeof(*b);
1113 }
1114
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +01001115 list_for_each_entry(uc, &cdev->gstrings, list) {
1116 struct usb_gadget_strings **sp;
1117
1118 sp = get_containers_gs(uc);
1119 len = lookup_string(sp, buf, language, id);
1120 if (len > 0)
1121 return len;
1122 }
1123
Michal Nazarewiczad1a8102010-08-12 17:43:46 +02001124 /* String IDs are device-scoped, so we look up each string
1125 * table we're told about. These lookups are infrequent;
1126 * simpler-is-better here.
David Brownell40982be2008-06-19 17:52:58 -07001127 */
1128 if (composite->strings) {
1129 len = lookup_string(composite->strings, buf, language, id);
1130 if (len > 0)
1131 return len;
1132 }
1133 list_for_each_entry(c, &cdev->configs, list) {
1134 if (c->strings) {
1135 len = lookup_string(c->strings, buf, language, id);
1136 if (len > 0)
1137 return len;
1138 }
1139 list_for_each_entry(f, &c->functions, list) {
1140 if (!f->strings)
1141 continue;
1142 len = lookup_string(f->strings, buf, language, id);
1143 if (len > 0)
1144 return len;
1145 }
1146 }
1147 return -EINVAL;
1148}
1149
1150/**
1151 * usb_string_id() - allocate an unused string ID
1152 * @cdev: the device whose string descriptor IDs are being allocated
1153 * Context: single threaded during gadget setup
1154 *
1155 * @usb_string_id() is called from bind() callbacks to allocate
1156 * string IDs. Drivers for functions, configurations, or gadgets will
1157 * then store that ID in the appropriate descriptors and string table.
1158 *
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +02001159 * All string identifier should be allocated using this,
1160 * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure
1161 * that for example different functions don't wrongly assign different
1162 * meanings to the same identifier.
David Brownell40982be2008-06-19 17:52:58 -07001163 */
Michal Nazarewicz28824b12010-05-05 12:53:13 +02001164int usb_string_id(struct usb_composite_dev *cdev)
David Brownell40982be2008-06-19 17:52:58 -07001165{
1166 if (cdev->next_string_id < 254) {
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +02001167 /* string id 0 is reserved by USB spec for list of
1168 * supported languages */
1169 /* 255 reserved as well? -- mina86 */
David Brownell40982be2008-06-19 17:52:58 -07001170 cdev->next_string_id++;
1171 return cdev->next_string_id;
1172 }
1173 return -ENODEV;
1174}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +02001175EXPORT_SYMBOL_GPL(usb_string_id);
David Brownell40982be2008-06-19 17:52:58 -07001176
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +02001177/**
1178 * usb_string_ids() - allocate unused string IDs in batch
1179 * @cdev: the device whose string descriptor IDs are being allocated
1180 * @str: an array of usb_string objects to assign numbers to
1181 * Context: single threaded during gadget setup
1182 *
1183 * @usb_string_ids() is called from bind() callbacks to allocate
1184 * string IDs. Drivers for functions, configurations, or gadgets will
1185 * then copy IDs from the string table to the appropriate descriptors
1186 * and string table for other languages.
1187 *
1188 * All string identifier should be allocated using this,
1189 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1190 * example different functions don't wrongly assign different meanings
1191 * to the same identifier.
1192 */
1193int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str)
1194{
1195 int next = cdev->next_string_id;
1196
1197 for (; str->s; ++str) {
1198 if (unlikely(next >= 254))
1199 return -ENODEV;
1200 str->id = ++next;
1201 }
1202
1203 cdev->next_string_id = next;
1204
1205 return 0;
1206}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +02001207EXPORT_SYMBOL_GPL(usb_string_ids_tab);
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +02001208
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +01001209static struct usb_gadget_string_container *copy_gadget_strings(
1210 struct usb_gadget_strings **sp, unsigned n_gstrings,
1211 unsigned n_strings)
1212{
1213 struct usb_gadget_string_container *uc;
1214 struct usb_gadget_strings **gs_array;
1215 struct usb_gadget_strings *gs;
1216 struct usb_string *s;
1217 unsigned mem;
1218 unsigned n_gs;
1219 unsigned n_s;
1220 void *stash;
1221
1222 mem = sizeof(*uc);
1223 mem += sizeof(void *) * (n_gstrings + 1);
1224 mem += sizeof(struct usb_gadget_strings) * n_gstrings;
1225 mem += sizeof(struct usb_string) * (n_strings + 1) * (n_gstrings);
1226 uc = kmalloc(mem, GFP_KERNEL);
1227 if (!uc)
1228 return ERR_PTR(-ENOMEM);
1229 gs_array = get_containers_gs(uc);
1230 stash = uc->stash;
1231 stash += sizeof(void *) * (n_gstrings + 1);
1232 for (n_gs = 0; n_gs < n_gstrings; n_gs++) {
1233 struct usb_string *org_s;
1234
1235 gs_array[n_gs] = stash;
1236 gs = gs_array[n_gs];
1237 stash += sizeof(struct usb_gadget_strings);
1238 gs->language = sp[n_gs]->language;
1239 gs->strings = stash;
1240 org_s = sp[n_gs]->strings;
1241
1242 for (n_s = 0; n_s < n_strings; n_s++) {
1243 s = stash;
1244 stash += sizeof(struct usb_string);
1245 if (org_s->s)
1246 s->s = org_s->s;
1247 else
1248 s->s = "";
1249 org_s++;
1250 }
1251 s = stash;
1252 s->s = NULL;
1253 stash += sizeof(struct usb_string);
1254
1255 }
1256 gs_array[n_gs] = NULL;
1257 return uc;
1258}
1259
1260/**
1261 * usb_gstrings_attach() - attach gadget strings to a cdev and assign ids
1262 * @cdev: the device whose string descriptor IDs are being allocated
1263 * and attached.
1264 * @sp: an array of usb_gadget_strings to attach.
1265 * @n_strings: number of entries in each usb_strings array (sp[]->strings)
1266 *
1267 * This function will create a deep copy of usb_gadget_strings and usb_string
1268 * and attach it to the cdev. The actual string (usb_string.s) will not be
1269 * copied but only a referenced will be made. The struct usb_gadget_strings
Masanari Iida06ed0de2015-03-10 22:37:46 +09001270 * array may contain multiple languages and should be NULL terminated.
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +01001271 * The ->language pointer of each struct usb_gadget_strings has to contain the
1272 * same amount of entries.
1273 * For instance: sp[0] is en-US, sp[1] is es-ES. It is expected that the first
Masanari Iida06ed0de2015-03-10 22:37:46 +09001274 * usb_string entry of es-ES contains the translation of the first usb_string
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +01001275 * entry of en-US. Therefore both entries become the same id assign.
1276 */
1277struct usb_string *usb_gstrings_attach(struct usb_composite_dev *cdev,
1278 struct usb_gadget_strings **sp, unsigned n_strings)
1279{
1280 struct usb_gadget_string_container *uc;
1281 struct usb_gadget_strings **n_gs;
1282 unsigned n_gstrings = 0;
1283 unsigned i;
1284 int ret;
1285
1286 for (i = 0; sp[i]; i++)
1287 n_gstrings++;
1288
1289 if (!n_gstrings)
1290 return ERR_PTR(-EINVAL);
1291
1292 uc = copy_gadget_strings(sp, n_gstrings, n_strings);
1293 if (IS_ERR(uc))
Felipe Balbidad4bab2014-03-10 13:30:56 -05001294 return ERR_CAST(uc);
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +01001295
1296 n_gs = get_containers_gs(uc);
1297 ret = usb_string_ids_tab(cdev, n_gs[0]->strings);
1298 if (ret)
1299 goto err;
1300
1301 for (i = 1; i < n_gstrings; i++) {
1302 struct usb_string *m_s;
1303 struct usb_string *s;
1304 unsigned n;
1305
1306 m_s = n_gs[0]->strings;
1307 s = n_gs[i]->strings;
1308 for (n = 0; n < n_strings; n++) {
1309 s->id = m_s->id;
1310 s++;
1311 m_s++;
1312 }
1313 }
1314 list_add_tail(&uc->list, &cdev->gstrings);
1315 return n_gs[0]->strings;
1316err:
1317 kfree(uc);
1318 return ERR_PTR(ret);
1319}
1320EXPORT_SYMBOL_GPL(usb_gstrings_attach);
1321
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +02001322/**
1323 * usb_string_ids_n() - allocate unused string IDs in batch
Randy Dunlapd187abb2010-08-11 12:07:13 -07001324 * @c: the device whose string descriptor IDs are being allocated
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +02001325 * @n: number of string IDs to allocate
1326 * Context: single threaded during gadget setup
1327 *
1328 * Returns the first requested ID. This ID and next @n-1 IDs are now
Randy Dunlapd187abb2010-08-11 12:07:13 -07001329 * valid IDs. At least provided that @n is non-zero because if it
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +02001330 * is, returns last requested ID which is now very useful information.
1331 *
1332 * @usb_string_ids_n() is called from bind() callbacks to allocate
1333 * string IDs. Drivers for functions, configurations, or gadgets will
1334 * then store that ID in the appropriate descriptors and string table.
1335 *
1336 * All string identifier should be allocated using this,
1337 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1338 * example different functions don't wrongly assign different meanings
1339 * to the same identifier.
1340 */
1341int usb_string_ids_n(struct usb_composite_dev *c, unsigned n)
1342{
1343 unsigned next = c->next_string_id;
1344 if (unlikely(n > 254 || (unsigned)next + n > 254))
1345 return -ENODEV;
1346 c->next_string_id += n;
1347 return next + 1;
1348}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +02001349EXPORT_SYMBOL_GPL(usb_string_ids_n);
Michal Nazarewiczf2adc4f2010-06-16 12:07:59 +02001350
David Brownell40982be2008-06-19 17:52:58 -07001351/*-------------------------------------------------------------------------*/
1352
1353static void composite_setup_complete(struct usb_ep *ep, struct usb_request *req)
1354{
Felipe Balbia7c12ea2014-09-18 10:01:55 -05001355 struct usb_composite_dev *cdev;
1356
David Brownell40982be2008-06-19 17:52:58 -07001357 if (req->status || req->actual != req->length)
1358 DBG((struct usb_composite_dev *) ep->driver_data,
1359 "setup complete --> %d, %d/%d\n",
1360 req->status, req->actual, req->length);
Felipe Balbia7c12ea2014-09-18 10:01:55 -05001361
1362 /*
1363 * REVIST The same ep0 requests are shared with function drivers
1364 * so they don't have to maintain the same ->complete() stubs.
1365 *
1366 * Because of that, we need to check for the validity of ->context
1367 * here, even though we know we've set it to something useful.
1368 */
1369 if (!req->context)
1370 return;
1371
1372 cdev = req->context;
1373
1374 if (cdev->req == req)
1375 cdev->setup_pending = false;
1376 else if (cdev->os_desc_req == req)
1377 cdev->os_desc_pending = false;
1378 else
1379 WARN(1, "unknown request %p\n", req);
1380}
1381
1382static int composite_ep0_queue(struct usb_composite_dev *cdev,
1383 struct usb_request *req, gfp_t gfp_flags)
1384{
1385 int ret;
1386
1387 ret = usb_ep_queue(cdev->gadget->ep0, req, gfp_flags);
1388 if (ret == 0) {
1389 if (cdev->req == req)
1390 cdev->setup_pending = true;
1391 else if (cdev->os_desc_req == req)
1392 cdev->os_desc_pending = true;
1393 else
1394 WARN(1, "unknown request %p\n", req);
1395 }
1396
1397 return ret;
David Brownell40982be2008-06-19 17:52:58 -07001398}
1399
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001400static int count_ext_compat(struct usb_configuration *c)
1401{
1402 int i, res;
1403
1404 res = 0;
1405 for (i = 0; i < c->next_interface_id; ++i) {
1406 struct usb_function *f;
1407 int j;
1408
1409 f = c->interface[i];
1410 for (j = 0; j < f->os_desc_n; ++j) {
1411 struct usb_os_desc *d;
1412
1413 if (i != f->os_desc_table[j].if_id)
1414 continue;
1415 d = f->os_desc_table[j].os_desc;
1416 if (d && d->ext_compat_id)
1417 ++res;
1418 }
1419 }
1420 BUG_ON(res > 255);
1421 return res;
1422}
1423
Chris Dickensbf54f312017-12-31 18:59:42 -08001424static int fill_ext_compat(struct usb_configuration *c, u8 *buf)
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001425{
1426 int i, count;
1427
1428 count = 16;
1429 for (i = 0; i < c->next_interface_id; ++i) {
1430 struct usb_function *f;
1431 int j;
1432
1433 f = c->interface[i];
1434 for (j = 0; j < f->os_desc_n; ++j) {
1435 struct usb_os_desc *d;
1436
1437 if (i != f->os_desc_table[j].if_id)
1438 continue;
1439 d = f->os_desc_table[j].os_desc;
1440 if (d && d->ext_compat_id) {
1441 *buf++ = i;
1442 *buf++ = 0x01;
1443 memcpy(buf, d->ext_compat_id, 16);
1444 buf += 22;
1445 } else {
1446 ++buf;
1447 *buf = 0x01;
1448 buf += 23;
1449 }
1450 count += 24;
Chris Dickensbf54f312017-12-31 18:59:42 -08001451 if (count + 24 >= USB_COMP_EP0_OS_DESC_BUFSIZ)
1452 return count;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001453 }
1454 }
Chris Dickensbf54f312017-12-31 18:59:42 -08001455
1456 return count;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001457}
1458
1459static int count_ext_prop(struct usb_configuration *c, int interface)
1460{
1461 struct usb_function *f;
Julia Lawall849b1332014-05-19 06:31:07 +02001462 int j;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001463
1464 f = c->interface[interface];
1465 for (j = 0; j < f->os_desc_n; ++j) {
1466 struct usb_os_desc *d;
1467
1468 if (interface != f->os_desc_table[j].if_id)
1469 continue;
1470 d = f->os_desc_table[j].os_desc;
1471 if (d && d->ext_compat_id)
1472 return d->ext_prop_count;
1473 }
Julia Lawall849b1332014-05-19 06:31:07 +02001474 return 0;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001475}
1476
1477static int len_ext_prop(struct usb_configuration *c, int interface)
1478{
1479 struct usb_function *f;
1480 struct usb_os_desc *d;
1481 int j, res;
1482
1483 res = 10; /* header length */
1484 f = c->interface[interface];
1485 for (j = 0; j < f->os_desc_n; ++j) {
1486 if (interface != f->os_desc_table[j].if_id)
1487 continue;
1488 d = f->os_desc_table[j].os_desc;
1489 if (d)
1490 return min(res + d->ext_prop_len, 4096);
1491 }
1492 return res;
1493}
1494
1495static int fill_ext_prop(struct usb_configuration *c, int interface, u8 *buf)
1496{
1497 struct usb_function *f;
1498 struct usb_os_desc *d;
1499 struct usb_os_desc_ext_prop *ext_prop;
1500 int j, count, n, ret;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001501
1502 f = c->interface[interface];
Chris Dickensbf54f312017-12-31 18:59:42 -08001503 count = 10; /* header length */
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001504 for (j = 0; j < f->os_desc_n; ++j) {
1505 if (interface != f->os_desc_table[j].if_id)
1506 continue;
1507 d = f->os_desc_table[j].os_desc;
1508 if (d)
1509 list_for_each_entry(ext_prop, &d->ext_prop, entry) {
Chris Dickensbf54f312017-12-31 18:59:42 -08001510 n = ext_prop->data_len +
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001511 ext_prop->name_len + 14;
Chris Dickensbf54f312017-12-31 18:59:42 -08001512 if (count + n >= USB_COMP_EP0_OS_DESC_BUFSIZ)
1513 return count;
1514 usb_ext_prop_put_size(buf, n);
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001515 usb_ext_prop_put_type(buf, ext_prop->type);
1516 ret = usb_ext_prop_put_name(buf, ext_prop->name,
1517 ext_prop->name_len);
1518 if (ret < 0)
1519 return ret;
1520 switch (ext_prop->type) {
1521 case USB_EXT_PROP_UNICODE:
1522 case USB_EXT_PROP_UNICODE_ENV:
1523 case USB_EXT_PROP_UNICODE_LINK:
1524 usb_ext_prop_put_unicode(buf, ret,
1525 ext_prop->data,
1526 ext_prop->data_len);
1527 break;
1528 case USB_EXT_PROP_BINARY:
1529 usb_ext_prop_put_binary(buf, ret,
1530 ext_prop->data,
1531 ext_prop->data_len);
1532 break;
1533 case USB_EXT_PROP_LE32:
1534 /* not implemented */
1535 case USB_EXT_PROP_BE32:
1536 /* not implemented */
1537 default:
1538 return -EINVAL;
1539 }
Chris Dickensbf54f312017-12-31 18:59:42 -08001540 buf += n;
1541 count += n;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001542 }
1543 }
1544
Chris Dickensbf54f312017-12-31 18:59:42 -08001545 return count;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001546}
1547
David Brownell40982be2008-06-19 17:52:58 -07001548/*
1549 * The setup() callback implements all the ep0 functionality that's
1550 * not handled lower down, in hardware or the hardware driver(like
1551 * device and endpoint feature flags, and their status). It's all
1552 * housekeeping for the gadget function we're implementing. Most of
1553 * the work is in config and function specific setup.
1554 */
Sebastian Andrzej Siewior2d5a8892012-12-23 21:10:21 +01001555int
David Brownell40982be2008-06-19 17:52:58 -07001556composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1557{
1558 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1559 struct usb_request *req = cdev->req;
1560 int value = -EOPNOTSUPP;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +03001561 int status = 0;
David Brownell40982be2008-06-19 17:52:58 -07001562 u16 w_index = le16_to_cpu(ctrl->wIndex);
Bryan Wu08889512009-01-08 00:21:19 +08001563 u8 intf = w_index & 0xFF;
David Brownell40982be2008-06-19 17:52:58 -07001564 u16 w_value = le16_to_cpu(ctrl->wValue);
1565 u16 w_length = le16_to_cpu(ctrl->wLength);
1566 struct usb_function *f = NULL;
Laurent Pinchart52426582009-10-21 00:03:38 +02001567 u8 endp;
David Brownell40982be2008-06-19 17:52:58 -07001568
1569 /* partial re-init of the response message; the function or the
1570 * gadget might need to intercept e.g. a control-OUT completion
1571 * when we delegate to it.
1572 */
1573 req->zero = 0;
Felipe Balbi57943712014-09-18 09:54:54 -05001574 req->context = cdev;
David Brownell40982be2008-06-19 17:52:58 -07001575 req->complete = composite_setup_complete;
Maulik Mankad2edb11c2011-02-22 19:08:42 +05301576 req->length = 0;
David Brownell40982be2008-06-19 17:52:58 -07001577 gadget->ep0->driver_data = cdev;
1578
Andrzej Pietrasiewicz232c0102015-03-03 10:52:04 +01001579 /*
1580 * Don't let non-standard requests match any of the cases below
1581 * by accident.
1582 */
1583 if ((ctrl->bRequestType & USB_TYPE_MASK) != USB_TYPE_STANDARD)
1584 goto unknown;
1585
David Brownell40982be2008-06-19 17:52:58 -07001586 switch (ctrl->bRequest) {
1587
1588 /* we handle all standard USB descriptors */
1589 case USB_REQ_GET_DESCRIPTOR:
1590 if (ctrl->bRequestType != USB_DIR_IN)
1591 goto unknown;
1592 switch (w_value >> 8) {
1593
1594 case USB_DT_DEVICE:
1595 cdev->desc.bNumConfigurations =
1596 count_configs(cdev, USB_DT_DEVICE);
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +03001597 cdev->desc.bMaxPacketSize0 =
1598 cdev->gadget->ep0->maxpacket;
1599 if (gadget_is_superspeed(gadget)) {
Sebastian Andrzej Siewiora8f21152011-07-19 20:21:52 +02001600 if (gadget->speed >= USB_SPEED_SUPER) {
John Youn1a853292016-02-05 17:05:40 -08001601 cdev->desc.bcdUSB = cpu_to_le16(0x0310);
Sebastian Andrzej Siewiora8f21152011-07-19 20:21:52 +02001602 cdev->desc.bMaxPacketSize0 = 9;
1603 } else {
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +03001604 cdev->desc.bcdUSB = cpu_to_le16(0x0210);
Sebastian Andrzej Siewiora8f21152011-07-19 20:21:52 +02001605 }
Igor Kotrasinski5527e732015-08-20 10:00:01 +02001606 } else {
1607 cdev->desc.bcdUSB = cpu_to_le16(0x0200);
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +03001608 }
1609
David Brownell40982be2008-06-19 17:52:58 -07001610 value = min(w_length, (u16) sizeof cdev->desc);
1611 memcpy(req->buf, &cdev->desc, value);
1612 break;
1613 case USB_DT_DEVICE_QUALIFIER:
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +03001614 if (!gadget_is_dualspeed(gadget) ||
1615 gadget->speed >= USB_SPEED_SUPER)
David Brownell40982be2008-06-19 17:52:58 -07001616 break;
1617 device_qual(cdev);
1618 value = min_t(int, w_length,
1619 sizeof(struct usb_qualifier_descriptor));
1620 break;
1621 case USB_DT_OTHER_SPEED_CONFIG:
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +03001622 if (!gadget_is_dualspeed(gadget) ||
1623 gadget->speed >= USB_SPEED_SUPER)
David Brownell40982be2008-06-19 17:52:58 -07001624 break;
1625 /* FALLTHROUGH */
1626 case USB_DT_CONFIG:
1627 value = config_desc(cdev, w_value);
1628 if (value >= 0)
1629 value = min(w_length, (u16) value);
1630 break;
1631 case USB_DT_STRING:
1632 value = get_string(cdev, req->buf,
1633 w_index, w_value & 0xff);
1634 if (value >= 0)
1635 value = min(w_length, (u16) value);
1636 break;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +03001637 case USB_DT_BOS:
1638 if (gadget_is_superspeed(gadget)) {
1639 value = bos_desc(cdev);
1640 value = min(w_length, (u16) value);
1641 }
1642 break;
Macpaul Lin53e62422015-07-09 15:18:42 +08001643 case USB_DT_OTG:
1644 if (gadget_is_otg(gadget)) {
1645 struct usb_configuration *config;
1646 int otg_desc_len = 0;
1647
1648 if (cdev->config)
1649 config = cdev->config;
1650 else
1651 config = list_first_entry(
1652 &cdev->configs,
1653 struct usb_configuration, list);
1654 if (!config)
1655 goto done;
1656
1657 if (gadget->otg_caps &&
1658 (gadget->otg_caps->otg_rev >= 0x0200))
1659 otg_desc_len += sizeof(
1660 struct usb_otg20_descriptor);
1661 else
1662 otg_desc_len += sizeof(
1663 struct usb_otg_descriptor);
1664
1665 value = min_t(int, w_length, otg_desc_len);
1666 memcpy(req->buf, config->descriptors[0], value);
1667 }
1668 break;
David Brownell40982be2008-06-19 17:52:58 -07001669 }
1670 break;
1671
1672 /* any number of configs can work */
1673 case USB_REQ_SET_CONFIGURATION:
1674 if (ctrl->bRequestType != 0)
1675 goto unknown;
1676 if (gadget_is_otg(gadget)) {
1677 if (gadget->a_hnp_support)
1678 DBG(cdev, "HNP available\n");
1679 else if (gadget->a_alt_hnp_support)
1680 DBG(cdev, "HNP on another port\n");
1681 else
1682 VDBG(cdev, "HNP inactive\n");
1683 }
1684 spin_lock(&cdev->lock);
1685 value = set_config(cdev, ctrl, w_value);
1686 spin_unlock(&cdev->lock);
1687 break;
1688 case USB_REQ_GET_CONFIGURATION:
1689 if (ctrl->bRequestType != USB_DIR_IN)
1690 goto unknown;
1691 if (cdev->config)
1692 *(u8 *)req->buf = cdev->config->bConfigurationValue;
1693 else
1694 *(u8 *)req->buf = 0;
1695 value = min(w_length, (u16) 1);
1696 break;
1697
Krzysztof Opasiak2b95c932016-12-20 19:52:16 +01001698 /* function drivers must handle get/set altsetting */
David Brownell40982be2008-06-19 17:52:58 -07001699 case USB_REQ_SET_INTERFACE:
1700 if (ctrl->bRequestType != USB_RECIP_INTERFACE)
1701 goto unknown;
Jassi Brarff085de2011-02-06 17:39:17 +09001702 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
David Brownell40982be2008-06-19 17:52:58 -07001703 break;
Bryan Wu08889512009-01-08 00:21:19 +08001704 f = cdev->config->interface[intf];
David Brownell40982be2008-06-19 17:52:58 -07001705 if (!f)
1706 break;
Krzysztof Opasiak2b95c932016-12-20 19:52:16 +01001707
1708 /*
1709 * If there's no get_alt() method, we know only altsetting zero
1710 * works. There is no need to check if set_alt() is not NULL
1711 * as we check this in usb_add_function().
1712 */
1713 if (w_value && !f->get_alt)
David Brownell40982be2008-06-19 17:52:58 -07001714 break;
Chunfeng Yun121621e2018-05-25 17:24:57 +08001715
1716 spin_lock(&cdev->lock);
David Brownell40982be2008-06-19 17:52:58 -07001717 value = f->set_alt(f, w_index, w_value);
Roger Quadros1b9ba002011-05-09 13:08:06 +03001718 if (value == USB_GADGET_DELAYED_STATUS) {
1719 DBG(cdev,
1720 "%s: interface %d (%s) requested delayed status\n",
1721 __func__, intf, f->name);
1722 cdev->delayed_status++;
1723 DBG(cdev, "delayed_status count %d\n",
1724 cdev->delayed_status);
1725 }
Chunfeng Yun121621e2018-05-25 17:24:57 +08001726 spin_unlock(&cdev->lock);
David Brownell40982be2008-06-19 17:52:58 -07001727 break;
1728 case USB_REQ_GET_INTERFACE:
1729 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE))
1730 goto unknown;
Jassi Brarff085de2011-02-06 17:39:17 +09001731 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
David Brownell40982be2008-06-19 17:52:58 -07001732 break;
Bryan Wu08889512009-01-08 00:21:19 +08001733 f = cdev->config->interface[intf];
David Brownell40982be2008-06-19 17:52:58 -07001734 if (!f)
1735 break;
1736 /* lots of interfaces only need altsetting zero... */
1737 value = f->get_alt ? f->get_alt(f, w_index) : 0;
1738 if (value < 0)
1739 break;
1740 *((u8 *)req->buf) = value;
1741 value = min(w_length, (u16) 1);
1742 break;
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +03001743 case USB_REQ_GET_STATUS:
Li Junc5348b62016-02-19 10:04:44 +08001744 if (gadget_is_otg(gadget) && gadget->hnp_polling_support &&
1745 (w_index == OTG_STS_SELECTOR)) {
1746 if (ctrl->bRequestType != (USB_DIR_IN |
1747 USB_RECIP_DEVICE))
1748 goto unknown;
1749 *((u8 *)req->buf) = gadget->host_request_flag;
1750 value = 1;
1751 break;
1752 }
1753
1754 /*
1755 * USB 3.0 additions:
1756 * Function driver should handle get_status request. If such cb
1757 * wasn't supplied we respond with default value = 0
1758 * Note: function driver should supply such cb only for the
1759 * first interface of the function
1760 */
Tatyana Brokhmanbdb64d72011-06-29 16:41:50 +03001761 if (!gadget_is_superspeed(gadget))
1762 goto unknown;
1763 if (ctrl->bRequestType != (USB_DIR_IN | USB_RECIP_INTERFACE))
1764 goto unknown;
1765 value = 2; /* This is the length of the get_status reply */
1766 put_unaligned_le16(0, req->buf);
1767 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1768 break;
1769 f = cdev->config->interface[intf];
1770 if (!f)
1771 break;
1772 status = f->get_status ? f->get_status(f) : 0;
1773 if (status < 0)
1774 break;
1775 put_unaligned_le16(status & 0x0000ffff, req->buf);
1776 break;
1777 /*
1778 * Function drivers should handle SetFeature/ClearFeature
1779 * (FUNCTION_SUSPEND) request. function_suspend cb should be supplied
1780 * only for the first interface of the function
1781 */
1782 case USB_REQ_CLEAR_FEATURE:
1783 case USB_REQ_SET_FEATURE:
1784 if (!gadget_is_superspeed(gadget))
1785 goto unknown;
1786 if (ctrl->bRequestType != (USB_DIR_OUT | USB_RECIP_INTERFACE))
1787 goto unknown;
1788 switch (w_value) {
1789 case USB_INTRF_FUNC_SUSPEND:
1790 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1791 break;
1792 f = cdev->config->interface[intf];
1793 if (!f)
1794 break;
1795 value = 0;
1796 if (f->func_suspend)
1797 value = f->func_suspend(f, w_index >> 8);
1798 if (value < 0) {
1799 ERROR(cdev,
1800 "func_suspend() returned error %d\n",
1801 value);
1802 value = 0;
1803 }
1804 break;
1805 }
1806 break;
David Brownell40982be2008-06-19 17:52:58 -07001807 default:
1808unknown:
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001809 /*
1810 * OS descriptors handling
1811 */
1812 if (cdev->use_os_string && cdev->os_desc_config &&
Mario Schuknechtdf6738d2015-01-26 20:30:27 +01001813 (ctrl->bRequestType & USB_TYPE_VENDOR) &&
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001814 ctrl->bRequest == cdev->b_vendor_code) {
1815 struct usb_request *req;
1816 struct usb_configuration *os_desc_cfg;
1817 u8 *buf;
1818 int interface;
1819 int count = 0;
1820
1821 req = cdev->os_desc_req;
Felipe Balbi57943712014-09-18 09:54:54 -05001822 req->context = cdev;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001823 req->complete = composite_setup_complete;
1824 buf = req->buf;
1825 os_desc_cfg = cdev->os_desc_config;
Chris Dickensbf54f312017-12-31 18:59:42 -08001826 w_length = min_t(u16, w_length, USB_COMP_EP0_OS_DESC_BUFSIZ);
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001827 memset(buf, 0, w_length);
1828 buf[5] = 0x01;
1829 switch (ctrl->bRequestType & USB_RECIP_MASK) {
1830 case USB_RECIP_DEVICE:
1831 if (w_index != 0x4 || (w_value >> 8))
1832 break;
1833 buf[6] = w_index;
1834 if (w_length == 0x10) {
1835 /* Number of ext compat interfaces */
1836 count = count_ext_compat(os_desc_cfg);
1837 buf[8] = count;
1838 count *= 24; /* 24 B/ext compat desc */
1839 count += 16; /* header */
1840 put_unaligned_le32(count, buf);
1841 value = w_length;
1842 } else {
1843 /* "extended compatibility ID"s */
1844 count = count_ext_compat(os_desc_cfg);
1845 buf[8] = count;
1846 count *= 24; /* 24 B/ext compat desc */
1847 count += 16; /* header */
1848 put_unaligned_le32(count, buf);
1849 buf += 16;
Chris Dickensbf54f312017-12-31 18:59:42 -08001850 value = fill_ext_compat(os_desc_cfg, buf);
1851 value = min_t(u16, w_length, value);
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001852 }
1853 break;
1854 case USB_RECIP_INTERFACE:
1855 if (w_index != 0x5 || (w_value >> 8))
1856 break;
1857 interface = w_value & 0xFF;
1858 buf[6] = w_index;
1859 if (w_length == 0x0A) {
1860 count = count_ext_prop(os_desc_cfg,
1861 interface);
1862 put_unaligned_le16(count, buf + 8);
1863 count = len_ext_prop(os_desc_cfg,
1864 interface);
1865 put_unaligned_le32(count, buf);
1866
1867 value = w_length;
1868 } else {
1869 count = count_ext_prop(os_desc_cfg,
1870 interface);
1871 put_unaligned_le16(count, buf + 8);
1872 count = len_ext_prop(os_desc_cfg,
1873 interface);
1874 put_unaligned_le32(count, buf);
1875 buf += 10;
1876 value = fill_ext_prop(os_desc_cfg,
1877 interface, buf);
1878 if (value < 0)
1879 return value;
Chris Dickensbf54f312017-12-31 18:59:42 -08001880 value = min_t(u16, w_length, value);
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001881 }
1882 break;
1883 }
William Wu7e14f47a2016-05-13 18:30:42 +08001884
1885 if (value >= 0) {
1886 req->length = value;
1887 req->context = cdev;
1888 req->zero = value < w_length;
1889 value = composite_ep0_queue(cdev, req,
1890 GFP_ATOMIC);
1891 if (value < 0) {
1892 DBG(cdev, "ep_queue --> %d\n", value);
1893 req->status = 0;
1894 composite_setup_complete(gadget->ep0,
1895 req);
1896 }
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02001897 }
1898 return value;
1899 }
1900
David Brownell40982be2008-06-19 17:52:58 -07001901 VDBG(cdev,
1902 "non-core control req%02x.%02x v%04x i%04x l%d\n",
1903 ctrl->bRequestType, ctrl->bRequest,
1904 w_value, w_index, w_length);
1905
Laurent Pinchart52426582009-10-21 00:03:38 +02001906 /* functions always handle their interfaces and endpoints...
1907 * punt other recipients (other, WUSB, ...) to the current
David Brownell40982be2008-06-19 17:52:58 -07001908 * configuration code.
David Brownell40982be2008-06-19 17:52:58 -07001909 */
Kishon Vijay Abraham Ib4c21f02015-06-11 22:12:11 +05301910 if (cdev->config) {
1911 list_for_each_entry(f, &cdev->config->functions, list)
Felix Hädicke1a00b452016-06-22 01:12:08 +02001912 if (f->req_match &&
1913 f->req_match(f, ctrl, false))
Kishon Vijay Abraham Ib4c21f02015-06-11 22:12:11 +05301914 goto try_fun_setup;
Felix Hädicke1a00b452016-06-22 01:12:08 +02001915 } else {
1916 struct usb_configuration *c;
1917 list_for_each_entry(c, &cdev->configs, list)
1918 list_for_each_entry(f, &c->functions, list)
1919 if (f->req_match &&
1920 f->req_match(f, ctrl, true))
1921 goto try_fun_setup;
Kishon Vijay Abraham Ib4c21f02015-06-11 22:12:11 +05301922 }
Felix Hädicke1a00b452016-06-22 01:12:08 +02001923 f = NULL;
Kishon Vijay Abraham Ib4c21f02015-06-11 22:12:11 +05301924
Laurent Pinchart52426582009-10-21 00:03:38 +02001925 switch (ctrl->bRequestType & USB_RECIP_MASK) {
1926 case USB_RECIP_INTERFACE:
Jassi Brarff085de2011-02-06 17:39:17 +09001927 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
Maulik Mankad3c47eb02011-01-13 18:19:56 +05301928 break;
1929 f = cdev->config->interface[intf];
Laurent Pinchart52426582009-10-21 00:03:38 +02001930 break;
1931
1932 case USB_RECIP_ENDPOINT:
Peter Chenc526c622016-07-01 15:33:28 +08001933 if (!cdev->config)
1934 break;
Laurent Pinchart52426582009-10-21 00:03:38 +02001935 endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f);
1936 list_for_each_entry(f, &cdev->config->functions, list) {
1937 if (test_bit(endp, f->endpoints))
1938 break;
1939 }
1940 if (&f->list == &cdev->config->functions)
David Brownell40982be2008-06-19 17:52:58 -07001941 f = NULL;
Laurent Pinchart52426582009-10-21 00:03:38 +02001942 break;
David Brownell40982be2008-06-19 17:52:58 -07001943 }
Andrzej Pietrasiewiczf563d232015-03-03 10:52:23 +01001944try_fun_setup:
Laurent Pinchart52426582009-10-21 00:03:38 +02001945 if (f && f->setup)
1946 value = f->setup(f, ctrl);
1947 else {
David Brownell40982be2008-06-19 17:52:58 -07001948 struct usb_configuration *c;
1949
1950 c = cdev->config;
Andrzej Pietrasiewicza01091e2013-11-07 08:41:25 +01001951 if (!c)
1952 goto done;
1953
1954 /* try current config's setup */
1955 if (c->setup) {
David Brownell40982be2008-06-19 17:52:58 -07001956 value = c->setup(c, ctrl);
Andrzej Pietrasiewicza01091e2013-11-07 08:41:25 +01001957 goto done;
1958 }
1959
1960 /* try the only function in the current config */
1961 if (!list_is_singular(&c->functions))
1962 goto done;
1963 f = list_first_entry(&c->functions, struct usb_function,
1964 list);
1965 if (f->setup)
1966 value = f->setup(f, ctrl);
David Brownell40982be2008-06-19 17:52:58 -07001967 }
1968
1969 goto done;
1970 }
1971
1972 /* respond with data transfer before status phase? */
Roger Quadros1b9ba002011-05-09 13:08:06 +03001973 if (value >= 0 && value != USB_GADGET_DELAYED_STATUS) {
David Brownell40982be2008-06-19 17:52:58 -07001974 req->length = value;
Felipe Balbi57943712014-09-18 09:54:54 -05001975 req->context = cdev;
David Brownell40982be2008-06-19 17:52:58 -07001976 req->zero = value < w_length;
Felipe Balbia7c12ea2014-09-18 10:01:55 -05001977 value = composite_ep0_queue(cdev, req, GFP_ATOMIC);
David Brownell40982be2008-06-19 17:52:58 -07001978 if (value < 0) {
1979 DBG(cdev, "ep_queue --> %d\n", value);
1980 req->status = 0;
1981 composite_setup_complete(gadget->ep0, req);
1982 }
Roger Quadros1b9ba002011-05-09 13:08:06 +03001983 } else if (value == USB_GADGET_DELAYED_STATUS && w_length != 0) {
1984 WARN(cdev,
1985 "%s: Delayed status not supported for w_length != 0",
1986 __func__);
David Brownell40982be2008-06-19 17:52:58 -07001987 }
1988
1989done:
1990 /* device either stalls (value < 0) or reports success */
1991 return value;
1992}
1993
Sebastian Andrzej Siewior2d5a8892012-12-23 21:10:21 +01001994void composite_disconnect(struct usb_gadget *gadget)
David Brownell40982be2008-06-19 17:52:58 -07001995{
1996 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1997 unsigned long flags;
1998
Badhri Jagan Sridharan9061f252015-05-06 13:40:15 -07001999 if (cdev == NULL) {
2000 WARN(1, "%s: Calling disconnect on a Gadget that is \
2001 not connected\n", __func__);
2002 return;
2003 }
2004
David Brownell40982be2008-06-19 17:52:58 -07002005 /* REVISIT: should we have config and device level
2006 * disconnect callbacks?
2007 */
2008 spin_lock_irqsave(&cdev->lock, flags);
2009 if (cdev->config)
2010 reset_config(cdev);
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002011 if (cdev->driver->disconnect)
2012 cdev->driver->disconnect(cdev);
David Brownell40982be2008-06-19 17:52:58 -07002013 spin_unlock_irqrestore(&cdev->lock, flags);
2014}
2015
2016/*-------------------------------------------------------------------------*/
2017
Greg Kroah-Hartmance26bd22013-08-23 16:34:43 -07002018static ssize_t suspended_show(struct device *dev, struct device_attribute *attr,
2019 char *buf)
Fabien Chouteauf48cf802010-04-23 14:21:26 +02002020{
2021 struct usb_gadget *gadget = dev_to_usb_gadget(dev);
2022 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2023
2024 return sprintf(buf, "%d\n", cdev->suspended);
2025}
Greg Kroah-Hartmance26bd22013-08-23 16:34:43 -07002026static DEVICE_ATTR_RO(suspended);
Fabien Chouteauf48cf802010-04-23 14:21:26 +02002027
Sebastian Andrzej Siewior779d5162012-12-23 21:09:55 +01002028static void __composite_unbind(struct usb_gadget *gadget, bool unbind_driver)
David Brownell40982be2008-06-19 17:52:58 -07002029{
2030 struct usb_composite_dev *cdev = get_gadget_data(gadget);
Andrew Gabbasov3941ee22017-09-30 08:55:55 -07002031 struct usb_gadget_strings *gstr = cdev->driver->strings[0];
2032 struct usb_string *dev_str = gstr->strings;
David Brownell40982be2008-06-19 17:52:58 -07002033
2034 /* composite_disconnect() must already have been called
2035 * by the underlying peripheral controller driver!
2036 * so there's no i/o concurrency that could affect the
2037 * state protected by cdev->lock.
2038 */
2039 WARN_ON(cdev->config);
2040
2041 while (!list_empty(&cdev->configs)) {
2042 struct usb_configuration *c;
David Brownell40982be2008-06-19 17:52:58 -07002043 c = list_first_entry(&cdev->configs,
2044 struct usb_configuration, list);
Benoit Goby51cce6f2012-05-10 10:07:57 +02002045 remove_config(cdev, c);
David Brownell40982be2008-06-19 17:52:58 -07002046 }
Sebastian Andrzej Siewior779d5162012-12-23 21:09:55 +01002047 if (cdev->driver->unbind && unbind_driver)
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002048 cdev->driver->unbind(cdev);
David Brownell40982be2008-06-19 17:52:58 -07002049
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +01002050 composite_dev_cleanup(cdev);
2051
Andrew Gabbasov3941ee22017-09-30 08:55:55 -07002052 if (dev_str[USB_GADGET_MANUFACTURER_IDX].s == cdev->def_manufacturer)
2053 dev_str[USB_GADGET_MANUFACTURER_IDX].s = "";
2054
Sebastian Andrzej Siewiorcc2683c2012-09-10 15:01:58 +02002055 kfree(cdev->def_manufacturer);
David Brownell40982be2008-06-19 17:52:58 -07002056 kfree(cdev);
2057 set_gadget_data(gadget, NULL);
David Brownell40982be2008-06-19 17:52:58 -07002058}
2059
Sebastian Andrzej Siewior779d5162012-12-23 21:09:55 +01002060static void composite_unbind(struct usb_gadget *gadget)
2061{
2062 __composite_unbind(gadget, true);
2063}
2064
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +02002065static void update_unchanged_dev_desc(struct usb_device_descriptor *new,
2066 const struct usb_device_descriptor *old)
2067{
2068 __le16 idVendor;
2069 __le16 idProduct;
2070 __le16 bcdDevice;
Sebastian Andrzej Siewior1cf0d262012-09-10 15:01:54 +02002071 u8 iSerialNumber;
Sebastian Andrzej Siewior03de9bf2012-09-10 15:01:55 +02002072 u8 iManufacturer;
Sebastian Andrzej Siewior2d35ee42012-09-10 15:01:56 +02002073 u8 iProduct;
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +02002074
2075 /*
2076 * these variables may have been set in
2077 * usb_composite_overwrite_options()
2078 */
2079 idVendor = new->idVendor;
2080 idProduct = new->idProduct;
2081 bcdDevice = new->bcdDevice;
Sebastian Andrzej Siewior1cf0d262012-09-10 15:01:54 +02002082 iSerialNumber = new->iSerialNumber;
Sebastian Andrzej Siewior03de9bf2012-09-10 15:01:55 +02002083 iManufacturer = new->iManufacturer;
Sebastian Andrzej Siewior2d35ee42012-09-10 15:01:56 +02002084 iProduct = new->iProduct;
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +02002085
2086 *new = *old;
2087 if (idVendor)
2088 new->idVendor = idVendor;
2089 if (idProduct)
2090 new->idProduct = idProduct;
2091 if (bcdDevice)
2092 new->bcdDevice = bcdDevice;
Sebastian Andrzej Siewiored9cbda2012-09-10 09:16:07 +02002093 else
2094 new->bcdDevice = cpu_to_le16(get_default_bcdDevice());
Sebastian Andrzej Siewior1cf0d262012-09-10 15:01:54 +02002095 if (iSerialNumber)
2096 new->iSerialNumber = iSerialNumber;
Sebastian Andrzej Siewior03de9bf2012-09-10 15:01:55 +02002097 if (iManufacturer)
2098 new->iManufacturer = iManufacturer;
Sebastian Andrzej Siewior2d35ee42012-09-10 15:01:56 +02002099 if (iProduct)
2100 new->iProduct = iProduct;
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +02002101}
2102
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +01002103int composite_dev_prepare(struct usb_composite_driver *composite,
2104 struct usb_composite_dev *cdev)
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002105{
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +01002106 struct usb_gadget *gadget = cdev->gadget;
2107 int ret = -ENOMEM;
2108
2109 /* preallocate control response and buffer */
2110 cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
2111 if (!cdev->req)
2112 return -ENOMEM;
2113
2114 cdev->req->buf = kmalloc(USB_COMP_EP0_BUFSIZ, GFP_KERNEL);
2115 if (!cdev->req->buf)
2116 goto fail;
2117
2118 ret = device_create_file(&gadget->dev, &dev_attr_suspended);
2119 if (ret)
2120 goto fail_dev;
2121
2122 cdev->req->complete = composite_setup_complete;
Felipe Balbi57943712014-09-18 09:54:54 -05002123 cdev->req->context = cdev;
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +01002124 gadget->ep0->driver_data = cdev;
2125
2126 cdev->driver = composite;
2127
2128 /*
2129 * As per USB compliance update, a device that is actively drawing
2130 * more than 100mA from USB must report itself as bus-powered in
2131 * the GetStatus(DEVICE) call.
2132 */
2133 if (CONFIG_USB_GADGET_VBUS_DRAW <= USB_SELF_POWER_VBUS_MAX_DRAW)
2134 usb_gadget_set_selfpowered(gadget);
2135
2136 /* interface and string IDs start at zero via kzalloc.
2137 * we force endpoints to start unassigned; few controller
2138 * drivers will zero ep->driver_data.
2139 */
2140 usb_ep_autoconfig_reset(gadget);
2141 return 0;
2142fail_dev:
2143 kfree(cdev->req->buf);
2144fail:
2145 usb_ep_free_request(gadget->ep0, cdev->req);
2146 cdev->req = NULL;
2147 return ret;
2148}
2149
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02002150int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
2151 struct usb_ep *ep0)
2152{
2153 int ret = 0;
2154
2155 cdev->os_desc_req = usb_ep_alloc_request(ep0, GFP_KERNEL);
2156 if (!cdev->os_desc_req) {
Christophe JAILLET3887db52016-07-16 08:34:33 +02002157 ret = -ENOMEM;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02002158 goto end;
2159 }
2160
Chris Dickensbf54f312017-12-31 18:59:42 -08002161 cdev->os_desc_req->buf = kmalloc(USB_COMP_EP0_OS_DESC_BUFSIZ,
2162 GFP_KERNEL);
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02002163 if (!cdev->os_desc_req->buf) {
Christophe JAILLET3887db52016-07-16 08:34:33 +02002164 ret = -ENOMEM;
Christophe JAILLETf0ee2032017-01-04 06:30:16 +01002165 usb_ep_free_request(ep0, cdev->os_desc_req);
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02002166 goto end;
2167 }
Felipe Balbi57943712014-09-18 09:54:54 -05002168 cdev->os_desc_req->context = cdev;
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02002169 cdev->os_desc_req->complete = composite_setup_complete;
2170end:
2171 return ret;
2172}
2173
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +01002174void composite_dev_cleanup(struct usb_composite_dev *cdev)
2175{
Sebastian Andrzej Siewior27a466332012-12-23 21:10:23 +01002176 struct usb_gadget_string_container *uc, *tmp;
2177
2178 list_for_each_entry_safe(uc, tmp, &cdev->gstrings, list) {
2179 list_del(&uc->list);
2180 kfree(uc);
2181 }
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02002182 if (cdev->os_desc_req) {
Felipe Balbia7c12ea2014-09-18 10:01:55 -05002183 if (cdev->os_desc_pending)
2184 usb_ep_dequeue(cdev->gadget->ep0, cdev->os_desc_req);
2185
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02002186 kfree(cdev->os_desc_req->buf);
2187 usb_ep_free_request(cdev->gadget->ep0, cdev->os_desc_req);
2188 }
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +01002189 if (cdev->req) {
Felipe Balbia7c12ea2014-09-18 10:01:55 -05002190 if (cdev->setup_pending)
2191 usb_ep_dequeue(cdev->gadget->ep0, cdev->req);
2192
Li Junbe0a8882014-08-28 21:44:11 +08002193 kfree(cdev->req->buf);
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +01002194 usb_ep_free_request(cdev->gadget->ep0, cdev->req);
2195 }
Sebastian Andrzej Siewior88af8bb2012-12-23 21:10:24 +01002196 cdev->next_string_id = 0;
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +01002197 device_remove_file(&cdev->gadget->dev, &dev_attr_suspended);
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002198}
2199
2200static int composite_bind(struct usb_gadget *gadget,
2201 struct usb_gadget_driver *gdriver)
David Brownell40982be2008-06-19 17:52:58 -07002202{
2203 struct usb_composite_dev *cdev;
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002204 struct usb_composite_driver *composite = to_cdriver(gdriver);
David Brownell40982be2008-06-19 17:52:58 -07002205 int status = -ENOMEM;
2206
2207 cdev = kzalloc(sizeof *cdev, GFP_KERNEL);
2208 if (!cdev)
2209 return status;
2210
2211 spin_lock_init(&cdev->lock);
2212 cdev->gadget = gadget;
2213 set_gadget_data(gadget, cdev);
2214 INIT_LIST_HEAD(&cdev->configs);
Sebastian Andrzej Siewior9bb28592012-12-23 21:10:22 +01002215 INIT_LIST_HEAD(&cdev->gstrings);
David Brownell40982be2008-06-19 17:52:58 -07002216
Sebastian Andrzej Siewiora5923342012-12-23 21:10:20 +01002217 status = composite_dev_prepare(composite, cdev);
2218 if (status)
David Brownell40982be2008-06-19 17:52:58 -07002219 goto fail;
David Brownell40982be2008-06-19 17:52:58 -07002220
2221 /* composite gadget needs to assign strings for whole device (like
2222 * serial number), register function drivers, potentially update
2223 * power state and consumption, etc
2224 */
Sebastian Andrzej Siewiorfac3a432012-09-06 20:11:01 +02002225 status = composite->bind(cdev);
David Brownell40982be2008-06-19 17:52:58 -07002226 if (status < 0)
2227 goto fail;
2228
Andrzej Pietrasiewicz37a3a532014-05-08 14:06:23 +02002229 if (cdev->use_os_string) {
2230 status = composite_os_desc_req_prepare(cdev, gadget->ep0);
2231 if (status)
2232 goto fail;
2233 }
2234
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +02002235 update_unchanged_dev_desc(&cdev->desc, composite->dev);
Greg Kroah-Hartmandbb442b2010-12-16 15:52:30 -08002236
Michal Nazarewiczad1a8102010-08-12 17:43:46 +02002237 /* has userspace failed to provide a serial number? */
2238 if (composite->needs_serial && !cdev->desc.iSerialNumber)
2239 WARNING(cdev, "userspace failed to provide iSerialNumber\n");
2240
David Brownell40982be2008-06-19 17:52:58 -07002241 INFO(cdev, "%s ready\n", composite->name);
2242 return 0;
2243
2244fail:
Sebastian Andrzej Siewior779d5162012-12-23 21:09:55 +01002245 __composite_unbind(gadget, false);
David Brownell40982be2008-06-19 17:52:58 -07002246 return status;
2247}
2248
2249/*-------------------------------------------------------------------------*/
2250
Andrzej Pietrasiewicz3a571872014-10-08 12:03:36 +02002251void composite_suspend(struct usb_gadget *gadget)
David Brownell40982be2008-06-19 17:52:58 -07002252{
2253 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2254 struct usb_function *f;
2255
David Brownell89429392009-03-19 14:14:17 -07002256 /* REVISIT: should we have config level
David Brownell40982be2008-06-19 17:52:58 -07002257 * suspend/resume callbacks?
2258 */
2259 DBG(cdev, "suspend\n");
2260 if (cdev->config) {
2261 list_for_each_entry(f, &cdev->config->functions, list) {
2262 if (f->suspend)
2263 f->suspend(f);
2264 }
2265 }
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002266 if (cdev->driver->suspend)
2267 cdev->driver->suspend(cdev);
Fabien Chouteauf48cf802010-04-23 14:21:26 +02002268
2269 cdev->suspended = 1;
Hao Wub23f2f92010-11-29 15:17:03 +08002270
2271 usb_gadget_vbus_draw(gadget, 2);
David Brownell40982be2008-06-19 17:52:58 -07002272}
2273
Andrzej Pietrasiewicz3a571872014-10-08 12:03:36 +02002274void composite_resume(struct usb_gadget *gadget)
David Brownell40982be2008-06-19 17:52:58 -07002275{
2276 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2277 struct usb_function *f;
Du, ChangbinX56b1b902013-12-17 11:47:42 +00002278 u16 maxpower;
David Brownell40982be2008-06-19 17:52:58 -07002279
David Brownell89429392009-03-19 14:14:17 -07002280 /* REVISIT: should we have config level
David Brownell40982be2008-06-19 17:52:58 -07002281 * suspend/resume callbacks?
2282 */
2283 DBG(cdev, "resume\n");
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002284 if (cdev->driver->resume)
2285 cdev->driver->resume(cdev);
David Brownell40982be2008-06-19 17:52:58 -07002286 if (cdev->config) {
2287 list_for_each_entry(f, &cdev->config->functions, list) {
2288 if (f->resume)
2289 f->resume(f);
2290 }
Hao Wub23f2f92010-11-29 15:17:03 +08002291
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +01002292 maxpower = cdev->config->MaxPower;
Hao Wub23f2f92010-11-29 15:17:03 +08002293
2294 usb_gadget_vbus_draw(gadget, maxpower ?
Sebastian Andrzej Siewior8f900a92012-12-03 20:07:05 +01002295 maxpower : CONFIG_USB_GADGET_VBUS_DRAW);
David Brownell40982be2008-06-19 17:52:58 -07002296 }
Fabien Chouteauf48cf802010-04-23 14:21:26 +02002297
2298 cdev->suspended = 0;
David Brownell40982be2008-06-19 17:52:58 -07002299}
2300
2301/*-------------------------------------------------------------------------*/
2302
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002303static const struct usb_gadget_driver composite_driver_template = {
Sebastian Andrzej Siewior93952952012-09-06 20:11:05 +02002304 .bind = composite_bind,
Michal Nazarewicz915c8be2009-11-09 14:15:25 +01002305 .unbind = composite_unbind,
David Brownell40982be2008-06-19 17:52:58 -07002306
2307 .setup = composite_setup,
Peter Chend8a816f2014-09-09 08:56:49 +08002308 .reset = composite_disconnect,
David Brownell40982be2008-06-19 17:52:58 -07002309 .disconnect = composite_disconnect,
2310
2311 .suspend = composite_suspend,
2312 .resume = composite_resume,
2313
2314 .driver = {
2315 .owner = THIS_MODULE,
2316 },
2317};
2318
2319/**
Michal Nazarewicz07a18bd2010-08-12 17:43:54 +02002320 * usb_composite_probe() - register a composite driver
David Brownell40982be2008-06-19 17:52:58 -07002321 * @driver: the driver to register
Nishanth Menon43febb22013-03-04 16:52:38 -06002322 *
David Brownell40982be2008-06-19 17:52:58 -07002323 * Context: single threaded during gadget setup
2324 *
2325 * This function is used to register drivers using the composite driver
2326 * framework. The return value is zero, or a negative errno value.
2327 * Those values normally come from the driver's @bind method, which does
2328 * all the work of setting up the driver to match the hardware.
2329 *
2330 * On successful return, the gadget is ready to respond to requests from
2331 * the host, unless one of its components invokes usb_gadget_disconnect()
2332 * while it was binding. That would usually be done in order to wait for
2333 * some userspace participation.
2334 */
Sebastian Andrzej Siewior03e42bd2012-09-06 20:11:04 +02002335int usb_composite_probe(struct usb_composite_driver *driver)
David Brownell40982be2008-06-19 17:52:58 -07002336{
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002337 struct usb_gadget_driver *gadget_driver;
2338
2339 if (!driver || !driver->dev || !driver->bind)
David Brownell40982be2008-06-19 17:52:58 -07002340 return -EINVAL;
2341
2342 if (!driver->name)
2343 driver->name = "composite";
David Brownell40982be2008-06-19 17:52:58 -07002344
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002345 driver->gadget_driver = composite_driver_template;
2346 gadget_driver = &driver->gadget_driver;
2347
2348 gadget_driver->function = (char *) driver->name;
2349 gadget_driver->driver.name = driver->name;
2350 gadget_driver->max_speed = driver->max_speed;
2351
2352 return usb_gadget_probe_driver(gadget_driver);
David Brownell40982be2008-06-19 17:52:58 -07002353}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +02002354EXPORT_SYMBOL_GPL(usb_composite_probe);
David Brownell40982be2008-06-19 17:52:58 -07002355
2356/**
2357 * usb_composite_unregister() - unregister a composite driver
2358 * @driver: the driver to unregister
2359 *
2360 * This function is used to unregister drivers using the composite
2361 * driver framework.
2362 */
Michal Nazarewicz28824b12010-05-05 12:53:13 +02002363void usb_composite_unregister(struct usb_composite_driver *driver)
David Brownell40982be2008-06-19 17:52:58 -07002364{
Sebastian Andrzej Siewiorffe0b332012-09-07 09:53:17 +02002365 usb_gadget_unregister_driver(&driver->gadget_driver);
David Brownell40982be2008-06-19 17:52:58 -07002366}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +02002367EXPORT_SYMBOL_GPL(usb_composite_unregister);
Roger Quadros1b9ba002011-05-09 13:08:06 +03002368
2369/**
2370 * usb_composite_setup_continue() - Continue with the control transfer
2371 * @cdev: the composite device who's control transfer was kept waiting
2372 *
2373 * This function must be called by the USB function driver to continue
2374 * with the control transfer's data/status stage in case it had requested to
2375 * delay the data/status stages. A USB function's setup handler (e.g. set_alt())
2376 * can request the composite framework to delay the setup request's data/status
2377 * stages by returning USB_GADGET_DELAYED_STATUS.
2378 */
2379void usb_composite_setup_continue(struct usb_composite_dev *cdev)
2380{
2381 int value;
2382 struct usb_request *req = cdev->req;
2383 unsigned long flags;
2384
2385 DBG(cdev, "%s\n", __func__);
2386 spin_lock_irqsave(&cdev->lock, flags);
2387
2388 if (cdev->delayed_status == 0) {
2389 WARN(cdev, "%s: Unexpected call\n", __func__);
2390
2391 } else if (--cdev->delayed_status == 0) {
2392 DBG(cdev, "%s: Completing delayed status\n", __func__);
2393 req->length = 0;
Felipe Balbi57943712014-09-18 09:54:54 -05002394 req->context = cdev;
Felipe Balbia7c12ea2014-09-18 10:01:55 -05002395 value = composite_ep0_queue(cdev, req, GFP_ATOMIC);
Roger Quadros1b9ba002011-05-09 13:08:06 +03002396 if (value < 0) {
2397 DBG(cdev, "ep_queue --> %d\n", value);
2398 req->status = 0;
2399 composite_setup_complete(cdev->gadget->ep0, req);
2400 }
2401 }
2402
2403 spin_unlock_irqrestore(&cdev->lock, flags);
2404}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +02002405EXPORT_SYMBOL_GPL(usb_composite_setup_continue);
Roger Quadros1b9ba002011-05-09 13:08:06 +03002406
Sebastian Andrzej Siewiorcc2683c2012-09-10 15:01:58 +02002407static char *composite_default_mfr(struct usb_gadget *gadget)
2408{
2409 char *mfr;
2410 int len;
2411
2412 len = snprintf(NULL, 0, "%s %s with %s", init_utsname()->sysname,
2413 init_utsname()->release, gadget->name);
2414 len++;
2415 mfr = kmalloc(len, GFP_KERNEL);
2416 if (!mfr)
2417 return NULL;
2418 snprintf(mfr, len, "%s %s with %s", init_utsname()->sysname,
2419 init_utsname()->release, gadget->name);
2420 return mfr;
2421}
2422
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +02002423void usb_composite_overwrite_options(struct usb_composite_dev *cdev,
2424 struct usb_composite_overwrite *covr)
2425{
2426 struct usb_device_descriptor *desc = &cdev->desc;
Sebastian Andrzej Siewior1cf0d262012-09-10 15:01:54 +02002427 struct usb_gadget_strings *gstr = cdev->driver->strings[0];
2428 struct usb_string *dev_str = gstr->strings;
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +02002429
2430 if (covr->idVendor)
2431 desc->idVendor = cpu_to_le16(covr->idVendor);
2432
2433 if (covr->idProduct)
2434 desc->idProduct = cpu_to_le16(covr->idProduct);
2435
2436 if (covr->bcdDevice)
2437 desc->bcdDevice = cpu_to_le16(covr->bcdDevice);
Sebastian Andrzej Siewior1cf0d262012-09-10 15:01:54 +02002438
2439 if (covr->serial_number) {
2440 desc->iSerialNumber = dev_str[USB_GADGET_SERIAL_IDX].id;
2441 dev_str[USB_GADGET_SERIAL_IDX].s = covr->serial_number;
2442 }
Sebastian Andrzej Siewior03de9bf2012-09-10 15:01:55 +02002443 if (covr->manufacturer) {
2444 desc->iManufacturer = dev_str[USB_GADGET_MANUFACTURER_IDX].id;
2445 dev_str[USB_GADGET_MANUFACTURER_IDX].s = covr->manufacturer;
Sebastian Andrzej Siewiorcc2683c2012-09-10 15:01:58 +02002446
2447 } else if (!strlen(dev_str[USB_GADGET_MANUFACTURER_IDX].s)) {
2448 desc->iManufacturer = dev_str[USB_GADGET_MANUFACTURER_IDX].id;
2449 cdev->def_manufacturer = composite_default_mfr(cdev->gadget);
2450 dev_str[USB_GADGET_MANUFACTURER_IDX].s = cdev->def_manufacturer;
Sebastian Andrzej Siewior03de9bf2012-09-10 15:01:55 +02002451 }
Sebastian Andrzej Siewior2d35ee42012-09-10 15:01:56 +02002452
2453 if (covr->product) {
2454 desc->iProduct = dev_str[USB_GADGET_PRODUCT_IDX].id;
2455 dev_str[USB_GADGET_PRODUCT_IDX].s = covr->product;
2456 }
Sebastian Andrzej Siewior7d16e8d2012-09-10 15:01:53 +02002457}
Sebastian Andrzej Siewior721e2e92012-09-06 20:11:27 +02002458EXPORT_SYMBOL_GPL(usb_composite_overwrite_options);
Sebastian Andrzej Siewiord80c3042012-09-06 20:11:28 +02002459
2460MODULE_LICENSE("GPL");
2461MODULE_AUTHOR("David Brownell");