2 * composite.c - infrastructure for Composite USB Gadgets
4 * Copyright (C) 2006-2008 David Brownell
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.
12 /* #define VERBOSE_DEBUG */
14 #include <linux/kallsyms.h>
15 #include <linux/kernel.h>
16 #include <linux/slab.h>
17 #include <linux/module.h>
18 #include <linux/device.h>
19 #include <linux/utsname.h>
21 #include <linux/usb/composite.h>
22 #include <asm/unaligned.h>
25 * The code in this file is utility code, used to build a gadget driver
26 * from one or more "function" drivers, one or more "configuration"
27 * objects, and a "usb_composite_driver" by gluing them together along
28 * with the relevant device-wide data.
31 /* big enough to hold our biggest descriptor */
32 #define USB_BUFSIZ 1024
34 static struct usb_composite_driver *composite;
36 /* Some systems will need runtime overrides for the product identifiers
37 * published in the device descriptor, either numbers or strings or both.
38 * String parameters are in UTF-8 (superset of ASCII's 7 bit characters).
41 static ushort idVendor;
42 module_param(idVendor, ushort, 0644);
43 MODULE_PARM_DESC(idVendor, "USB Vendor ID");
45 static ushort idProduct;
46 module_param(idProduct, ushort, 0644);
47 MODULE_PARM_DESC(idProduct, "USB Product ID");
49 static ushort bcdDevice;
50 module_param(bcdDevice, ushort, 0644);
51 MODULE_PARM_DESC(bcdDevice, "USB Device version (BCD)");
53 static char *iManufacturer;
54 module_param(iManufacturer, charp, 0644);
55 MODULE_PARM_DESC(iManufacturer, "USB Manufacturer string");
57 static char *iProduct;
58 module_param(iProduct, charp, 0644);
59 MODULE_PARM_DESC(iProduct, "USB Product string");
61 static char *iSerialNumber;
62 module_param(iSerialNumber, charp, 0644);
63 MODULE_PARM_DESC(iSerialNumber, "SerialNumber string");
65 static char composite_manufacturer[50];
67 /*-------------------------------------------------------------------------*/
69 * next_ep_desc() - advance to the next EP descriptor
70 * @t: currect pointer within descriptor array
72 * Return: next EP descriptor or NULL
74 * Iterate over @t until either EP descriptor found or
75 * NULL (that indicates end of list) encountered
77 static struct usb_descriptor_header**
78 next_ep_desc(struct usb_descriptor_header **t)
81 if ((*t)->bDescriptorType == USB_DT_ENDPOINT)
88 * for_each_ep_desc()- iterate over endpoint descriptors in the
90 * @start: pointer within descriptor array.
91 * @ep_desc: endpoint descriptor to use as the loop cursor
93 #define for_each_ep_desc(start, ep_desc) \
94 for (ep_desc = next_ep_desc(start); \
95 ep_desc; ep_desc = next_ep_desc(ep_desc+1))
98 * config_ep_by_speed() - configures the given endpoint
99 * according to gadget speed.
100 * @g: pointer to the gadget
102 * @_ep: the endpoint to configure
104 * Return: error code, 0 on success
106 * This function chooses the right descriptors for a given
107 * endpoint according to gadget speed and saves it in the
108 * endpoint desc field. If the endpoint already has a descriptor
109 * assigned to it - overwrites it with currently corresponding
110 * descriptor. The endpoint maxpacket field is updated according
111 * to the chosen descriptor.
112 * Note: the supplied function should hold all the descriptors
113 * for supported speeds
115 int config_ep_by_speed(struct usb_gadget *g,
116 struct usb_function *f,
119 struct usb_composite_dev *cdev = get_gadget_data(g);
120 struct usb_endpoint_descriptor *chosen_desc = NULL;
121 struct usb_descriptor_header **speed_desc = NULL;
123 struct usb_ss_ep_comp_descriptor *comp_desc = NULL;
124 int want_comp_desc = 0;
126 struct usb_descriptor_header **d_spd; /* cursor for speed desc */
128 if (!g || !f || !_ep)
131 /* select desired speed */
133 case USB_SPEED_SUPER:
134 if (gadget_is_superspeed(g)) {
135 speed_desc = f->ss_descriptors;
139 /* else: Fall trough */
141 if (gadget_is_dualspeed(g)) {
142 speed_desc = f->hs_descriptors;
145 /* else: fall through */
147 speed_desc = f->descriptors;
149 /* find descriptors */
150 for_each_ep_desc(speed_desc, d_spd) {
151 chosen_desc = (struct usb_endpoint_descriptor *)*d_spd;
152 if (chosen_desc->bEndpointAddress == _ep->address)
159 _ep->maxpacket = usb_endpoint_maxp(chosen_desc);
160 _ep->desc = chosen_desc;
161 _ep->comp_desc = NULL;
168 * Companion descriptor should follow EP descriptor
169 * USB 3.0 spec, #9.6.7
171 comp_desc = (struct usb_ss_ep_comp_descriptor *)*(++d_spd);
173 (comp_desc->bDescriptorType != USB_DT_SS_ENDPOINT_COMP))
175 _ep->comp_desc = comp_desc;
176 if (g->speed == USB_SPEED_SUPER) {
177 switch (usb_endpoint_type(_ep->desc)) {
178 case USB_ENDPOINT_XFER_ISOC:
179 /* mult: bits 1:0 of bmAttributes */
180 _ep->mult = comp_desc->bmAttributes & 0x3;
181 case USB_ENDPOINT_XFER_BULK:
182 case USB_ENDPOINT_XFER_INT:
183 _ep->maxburst = comp_desc->bMaxBurst + 1;
186 if (comp_desc->bMaxBurst != 0)
187 ERROR(cdev, "ep0 bMaxBurst must be 0\n");
196 * usb_add_function() - add a function to a configuration
197 * @config: the configuration
198 * @function: the function being added
199 * Context: single threaded during gadget setup
201 * After initialization, each configuration must have one or more
202 * functions added to it. Adding a function involves calling its @bind()
203 * method to allocate resources such as interface and string identifiers
206 * This function returns the value of the function's bind(), which is
207 * zero for success else a negative errno value.
209 int usb_add_function(struct usb_configuration *config,
210 struct usb_function *function)
214 DBG(config->cdev, "adding '%s'/%p to config '%s'/%p\n",
215 function->name, function,
216 config->label, config);
218 if (!function->set_alt || !function->disable)
221 function->config = config;
222 list_add_tail(&function->list, &config->functions);
224 /* REVISIT *require* function->bind? */
225 if (function->bind) {
226 value = function->bind(config, function);
228 list_del(&function->list);
229 function->config = NULL;
234 /* We allow configurations that don't work at both speeds.
235 * If we run into a lowspeed Linux system, treat it the same
236 * as full speed ... it's the function drivers that will need
237 * to avoid bulk and ISO transfers.
239 if (!config->fullspeed && function->descriptors)
240 config->fullspeed = true;
241 if (!config->highspeed && function->hs_descriptors)
242 config->highspeed = true;
243 if (!config->superspeed && function->ss_descriptors)
244 config->superspeed = true;
248 DBG(config->cdev, "adding '%s'/%p --> %d\n",
249 function->name, function, value);
254 * usb_function_deactivate - prevent function and gadget enumeration
255 * @function: the function that isn't yet ready to respond
257 * Blocks response of the gadget driver to host enumeration by
258 * preventing the data line pullup from being activated. This is
259 * normally called during @bind() processing to change from the
260 * initial "ready to respond" state, or when a required resource
263 * For example, drivers that serve as a passthrough to a userspace
264 * daemon can block enumeration unless that daemon (such as an OBEX,
265 * MTP, or print server) is ready to handle host requests.
267 * Not all systems support software control of their USB peripheral
270 * Returns zero on success, else negative errno.
272 int usb_function_deactivate(struct usb_function *function)
274 struct usb_composite_dev *cdev = function->config->cdev;
278 spin_lock_irqsave(&cdev->lock, flags);
280 if (cdev->deactivations == 0)
281 status = usb_gadget_disconnect(cdev->gadget);
283 cdev->deactivations++;
285 spin_unlock_irqrestore(&cdev->lock, flags);
290 * usb_function_activate - allow function and gadget enumeration
291 * @function: function on which usb_function_activate() was called
293 * Reverses effect of usb_function_deactivate(). If no more functions
294 * are delaying their activation, the gadget driver will respond to
295 * host enumeration procedures.
297 * Returns zero on success, else negative errno.
299 int usb_function_activate(struct usb_function *function)
301 struct usb_composite_dev *cdev = function->config->cdev;
305 spin_lock_irqsave(&cdev->lock, flags);
307 if (WARN_ON(cdev->deactivations == 0))
310 cdev->deactivations--;
311 if (cdev->deactivations == 0)
312 status = usb_gadget_connect(cdev->gadget);
315 spin_unlock_irqrestore(&cdev->lock, flags);
320 * usb_interface_id() - allocate an unused interface ID
321 * @config: configuration associated with the interface
322 * @function: function handling the interface
323 * Context: single threaded during gadget setup
325 * usb_interface_id() is called from usb_function.bind() callbacks to
326 * allocate new interface IDs. The function driver will then store that
327 * ID in interface, association, CDC union, and other descriptors. It
328 * will also handle any control requests targeted at that interface,
329 * particularly changing its altsetting via set_alt(). There may
330 * also be class-specific or vendor-specific requests to handle.
332 * All interface identifier should be allocated using this routine, to
333 * ensure that for example different functions don't wrongly assign
334 * different meanings to the same identifier. Note that since interface
335 * identifiers are configuration-specific, functions used in more than
336 * one configuration (or more than once in a given configuration) need
337 * multiple versions of the relevant descriptors.
339 * Returns the interface ID which was allocated; or -ENODEV if no
340 * more interface IDs can be allocated.
342 int usb_interface_id(struct usb_configuration *config,
343 struct usb_function *function)
345 unsigned id = config->next_interface_id;
347 if (id < MAX_CONFIG_INTERFACES) {
348 config->interface[id] = function;
349 config->next_interface_id = id + 1;
355 static int config_buf(struct usb_configuration *config,
356 enum usb_device_speed speed, void *buf, u8 type)
358 struct usb_config_descriptor *c = buf;
359 void *next = buf + USB_DT_CONFIG_SIZE;
360 int len = USB_BUFSIZ - USB_DT_CONFIG_SIZE;
361 struct usb_function *f;
364 /* write the config descriptor */
366 c->bLength = USB_DT_CONFIG_SIZE;
367 c->bDescriptorType = type;
368 /* wTotalLength is written later */
369 c->bNumInterfaces = config->next_interface_id;
370 c->bConfigurationValue = config->bConfigurationValue;
371 c->iConfiguration = config->iConfiguration;
372 c->bmAttributes = USB_CONFIG_ATT_ONE | config->bmAttributes;
373 c->bMaxPower = config->bMaxPower ? : (CONFIG_USB_GADGET_VBUS_DRAW / 2);
375 /* There may be e.g. OTG descriptors */
376 if (config->descriptors) {
377 status = usb_descriptor_fillbuf(next, len,
378 config->descriptors);
385 /* add each function's descriptors */
386 list_for_each_entry(f, &config->functions, list) {
387 struct usb_descriptor_header **descriptors;
390 case USB_SPEED_SUPER:
391 descriptors = f->ss_descriptors;
394 descriptors = f->hs_descriptors;
397 descriptors = f->descriptors;
402 status = usb_descriptor_fillbuf(next, len,
403 (const struct usb_descriptor_header **) descriptors);
411 c->wTotalLength = cpu_to_le16(len);
415 static int config_desc(struct usb_composite_dev *cdev, unsigned w_value)
417 struct usb_gadget *gadget = cdev->gadget;
418 struct usb_configuration *c;
419 u8 type = w_value >> 8;
420 enum usb_device_speed speed = USB_SPEED_UNKNOWN;
422 if (gadget->speed == USB_SPEED_SUPER)
423 speed = gadget->speed;
424 else if (gadget_is_dualspeed(gadget)) {
426 if (gadget->speed == USB_SPEED_HIGH)
428 if (type == USB_DT_OTHER_SPEED_CONFIG)
431 speed = USB_SPEED_HIGH;
435 /* This is a lookup by config *INDEX* */
437 list_for_each_entry(c, &cdev->configs, list) {
438 /* ignore configs that won't work at this speed */
440 case USB_SPEED_SUPER:
454 return config_buf(c, speed, cdev->req->buf, type);
460 static int count_configs(struct usb_composite_dev *cdev, unsigned type)
462 struct usb_gadget *gadget = cdev->gadget;
463 struct usb_configuration *c;
468 if (gadget_is_dualspeed(gadget)) {
469 if (gadget->speed == USB_SPEED_HIGH)
471 if (gadget->speed == USB_SPEED_SUPER)
473 if (type == USB_DT_DEVICE_QUALIFIER)
476 list_for_each_entry(c, &cdev->configs, list) {
477 /* ignore configs that won't work at this speed */
494 * bos_desc() - prepares the BOS descriptor.
495 * @cdev: pointer to usb_composite device to generate the bos
498 * This function generates the BOS (Binary Device Object)
499 * descriptor and its device capabilities descriptors. The BOS
500 * descriptor should be supported by a SuperSpeed device.
502 static int bos_desc(struct usb_composite_dev *cdev)
504 struct usb_ext_cap_descriptor *usb_ext;
505 struct usb_ss_cap_descriptor *ss_cap;
506 struct usb_dcd_config_params dcd_config_params;
507 struct usb_bos_descriptor *bos = cdev->req->buf;
509 bos->bLength = USB_DT_BOS_SIZE;
510 bos->bDescriptorType = USB_DT_BOS;
512 bos->wTotalLength = cpu_to_le16(USB_DT_BOS_SIZE);
513 bos->bNumDeviceCaps = 0;
516 * A SuperSpeed device shall include the USB2.0 extension descriptor
517 * and shall support LPM when operating in USB2.0 HS mode.
519 usb_ext = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
520 bos->bNumDeviceCaps++;
521 le16_add_cpu(&bos->wTotalLength, USB_DT_USB_EXT_CAP_SIZE);
522 usb_ext->bLength = USB_DT_USB_EXT_CAP_SIZE;
523 usb_ext->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
524 usb_ext->bDevCapabilityType = USB_CAP_TYPE_EXT;
525 usb_ext->bmAttributes = cpu_to_le32(USB_LPM_SUPPORT);
528 * The Superspeed USB Capability descriptor shall be implemented by all
529 * SuperSpeed devices.
531 ss_cap = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
532 bos->bNumDeviceCaps++;
533 le16_add_cpu(&bos->wTotalLength, USB_DT_USB_SS_CAP_SIZE);
534 ss_cap->bLength = USB_DT_USB_SS_CAP_SIZE;
535 ss_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
536 ss_cap->bDevCapabilityType = USB_SS_CAP_TYPE;
537 ss_cap->bmAttributes = 0; /* LTM is not supported yet */
538 ss_cap->wSpeedSupported = cpu_to_le16(USB_LOW_SPEED_OPERATION |
539 USB_FULL_SPEED_OPERATION |
540 USB_HIGH_SPEED_OPERATION |
541 USB_5GBPS_OPERATION);
542 ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
544 /* Get Controller configuration */
545 if (cdev->gadget->ops->get_config_params)
546 cdev->gadget->ops->get_config_params(&dcd_config_params);
548 dcd_config_params.bU1devExitLat = USB_DEFAULT_U1_DEV_EXIT_LAT;
549 dcd_config_params.bU2DevExitLat =
550 cpu_to_le16(USB_DEFAULT_U2_DEV_EXIT_LAT);
552 ss_cap->bU1devExitLat = dcd_config_params.bU1devExitLat;
553 ss_cap->bU2DevExitLat = dcd_config_params.bU2DevExitLat;
555 return le16_to_cpu(bos->wTotalLength);
558 static void device_qual(struct usb_composite_dev *cdev)
560 struct usb_qualifier_descriptor *qual = cdev->req->buf;
562 qual->bLength = sizeof(*qual);
563 qual->bDescriptorType = USB_DT_DEVICE_QUALIFIER;
564 /* POLICY: same bcdUSB and device type info at both speeds */
565 qual->bcdUSB = cdev->desc.bcdUSB;
566 qual->bDeviceClass = cdev->desc.bDeviceClass;
567 qual->bDeviceSubClass = cdev->desc.bDeviceSubClass;
568 qual->bDeviceProtocol = cdev->desc.bDeviceProtocol;
569 /* ASSUME same EP0 fifo size at both speeds */
570 qual->bMaxPacketSize0 = cdev->gadget->ep0->maxpacket;
571 qual->bNumConfigurations = count_configs(cdev, USB_DT_DEVICE_QUALIFIER);
575 /*-------------------------------------------------------------------------*/
577 static void reset_config(struct usb_composite_dev *cdev)
579 struct usb_function *f;
581 DBG(cdev, "reset config\n");
583 list_for_each_entry(f, &cdev->config->functions, list) {
587 bitmap_zero(f->endpoints, 32);
592 static int set_config(struct usb_composite_dev *cdev,
593 const struct usb_ctrlrequest *ctrl, unsigned number)
595 struct usb_gadget *gadget = cdev->gadget;
596 struct usb_configuration *c = NULL;
597 int result = -EINVAL;
598 unsigned power = gadget_is_otg(gadget) ? 8 : 100;
602 list_for_each_entry(c, &cdev->configs, list) {
603 if (c->bConfigurationValue == number) {
605 * We disable the FDs of the previous
606 * configuration only if the new configuration
617 } else { /* Zero configuration value - need to reset the config */
623 INFO(cdev, "%s config #%d: %s\n",
624 usb_speed_string(gadget->speed),
625 number, c ? c->label : "unconfigured");
632 /* Initialize all interfaces by setting them to altsetting zero. */
633 for (tmp = 0; tmp < MAX_CONFIG_INTERFACES; tmp++) {
634 struct usb_function *f = c->interface[tmp];
635 struct usb_descriptor_header **descriptors;
641 * Record which endpoints are used by the function. This is used
642 * to dispatch control requests targeted at that endpoint to the
643 * function's setup callback instead of the current
644 * configuration's setup callback.
646 switch (gadget->speed) {
647 case USB_SPEED_SUPER:
648 descriptors = f->ss_descriptors;
651 descriptors = f->hs_descriptors;
654 descriptors = f->descriptors;
657 for (; *descriptors; ++descriptors) {
658 struct usb_endpoint_descriptor *ep;
661 if ((*descriptors)->bDescriptorType != USB_DT_ENDPOINT)
664 ep = (struct usb_endpoint_descriptor *)*descriptors;
665 addr = ((ep->bEndpointAddress & 0x80) >> 3)
666 | (ep->bEndpointAddress & 0x0f);
667 set_bit(addr, f->endpoints);
670 result = f->set_alt(f, tmp, 0);
672 DBG(cdev, "interface %d (%s/%p) alt 0 --> %d\n",
673 tmp, f->name, f, result);
679 if (result == USB_GADGET_DELAYED_STATUS) {
681 "%s: interface %d (%s) requested delayed status\n",
682 __func__, tmp, f->name);
683 cdev->delayed_status++;
684 DBG(cdev, "delayed_status count %d\n",
685 cdev->delayed_status);
689 /* when we return, be sure our power usage is valid */
690 power = c->bMaxPower ? (2 * c->bMaxPower) : CONFIG_USB_GADGET_VBUS_DRAW;
692 usb_gadget_vbus_draw(gadget, power);
693 if (result >= 0 && cdev->delayed_status)
694 result = USB_GADGET_DELAYED_STATUS;
699 * usb_add_config() - add a configuration to a device.
700 * @cdev: wraps the USB gadget
701 * @config: the configuration, with bConfigurationValue assigned
702 * @bind: the configuration's bind function
703 * Context: single threaded during gadget setup
705 * One of the main tasks of a composite @bind() routine is to
706 * add each of the configurations it supports, using this routine.
708 * This function returns the value of the configuration's @bind(), which
709 * is zero for success else a negative errno value. Binding configurations
710 * assigns global resources including string IDs, and per-configuration
711 * resources such as interface IDs and endpoints.
713 int usb_add_config(struct usb_composite_dev *cdev,
714 struct usb_configuration *config,
715 int (*bind)(struct usb_configuration *))
717 int status = -EINVAL;
718 struct usb_configuration *c;
720 DBG(cdev, "adding config #%u '%s'/%p\n",
721 config->bConfigurationValue,
722 config->label, config);
724 if (!config->bConfigurationValue || !bind)
727 /* Prevent duplicate configuration identifiers */
728 list_for_each_entry(c, &cdev->configs, list) {
729 if (c->bConfigurationValue == config->bConfigurationValue) {
736 list_add_tail(&config->list, &cdev->configs);
738 INIT_LIST_HEAD(&config->functions);
739 config->next_interface_id = 0;
740 memset(config->interface, 0, sizeof(config->interface));
742 status = bind(config);
744 while (!list_empty(&config->functions)) {
745 struct usb_function *f;
747 f = list_first_entry(&config->functions,
748 struct usb_function, list);
751 DBG(cdev, "unbind function '%s'/%p\n",
753 f->unbind(config, f);
754 /* may free memory for "f" */
757 list_del(&config->list);
762 DBG(cdev, "cfg %d/%p speeds:%s%s%s\n",
763 config->bConfigurationValue, config,
764 config->superspeed ? " super" : "",
765 config->highspeed ? " high" : "",
767 ? (gadget_is_dualspeed(cdev->gadget)
772 for (i = 0; i < MAX_CONFIG_INTERFACES; i++) {
773 struct usb_function *f = config->interface[i];
777 DBG(cdev, " interface %d = %s/%p\n",
782 /* set_alt(), or next bind(), sets up
783 * ep->driver_data as needed.
785 usb_ep_autoconfig_reset(cdev->gadget);
789 DBG(cdev, "added config '%s'/%u --> %d\n", config->label,
790 config->bConfigurationValue, status);
794 static void remove_config(struct usb_composite_dev *cdev,
795 struct usb_configuration *config)
797 while (!list_empty(&config->functions)) {
798 struct usb_function *f;
800 f = list_first_entry(&config->functions,
801 struct usb_function, list);
804 DBG(cdev, "unbind function '%s'/%p\n", f->name, f);
805 f->unbind(config, f);
806 /* may free memory for "f" */
809 list_del(&config->list);
810 if (config->unbind) {
811 DBG(cdev, "unbind config '%s'/%p\n", config->label, config);
812 config->unbind(config);
813 /* may free memory for "c" */
818 * usb_remove_config() - remove a configuration from a device.
819 * @cdev: wraps the USB gadget
820 * @config: the configuration
822 * Drivers must call usb_gadget_disconnect before calling this function
823 * to disconnect the device from the host and make sure the host will not
824 * try to enumerate the device while we are changing the config list.
826 void usb_remove_config(struct usb_composite_dev *cdev,
827 struct usb_configuration *config)
831 spin_lock_irqsave(&cdev->lock, flags);
833 if (cdev->config == config)
836 spin_unlock_irqrestore(&cdev->lock, flags);
838 remove_config(cdev, config);
841 /*-------------------------------------------------------------------------*/
843 /* We support strings in multiple languages ... string descriptor zero
844 * says which languages are supported. The typical case will be that
845 * only one language (probably English) is used, with I18N handled on
849 static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf)
851 const struct usb_gadget_strings *s;
857 language = cpu_to_le16(s->language);
858 for (tmp = buf; *tmp && tmp < &buf[126]; tmp++) {
859 if (*tmp == language)
868 static int lookup_string(
869 struct usb_gadget_strings **sp,
875 struct usb_gadget_strings *s;
880 if (s->language != language)
882 value = usb_gadget_get_string(s, id, buf);
889 static int get_string(struct usb_composite_dev *cdev,
890 void *buf, u16 language, int id)
892 struct usb_configuration *c;
893 struct usb_function *f;
897 /* Yes, not only is USB's I18N support probably more than most
898 * folk will ever care about ... also, it's all supported here.
899 * (Except for UTF8 support for Unicode's "Astral Planes".)
902 /* 0 == report all available language codes */
904 struct usb_string_descriptor *s = buf;
905 struct usb_gadget_strings **sp;
908 s->bDescriptorType = USB_DT_STRING;
910 sp = composite->strings;
912 collect_langs(sp, s->wData);
914 list_for_each_entry(c, &cdev->configs, list) {
917 collect_langs(sp, s->wData);
919 list_for_each_entry(f, &c->functions, list) {
922 collect_langs(sp, s->wData);
926 for (len = 0; len <= 126 && s->wData[len]; len++)
931 s->bLength = 2 * (len + 1);
935 /* Otherwise, look up and return a specified string. First
936 * check if the string has not been overridden.
938 if (cdev->manufacturer_override == id)
939 str = iManufacturer ?: composite->iManufacturer ?:
940 composite_manufacturer;
941 else if (cdev->product_override == id)
942 str = iProduct ?: composite->iProduct;
943 else if (cdev->serial_override == id)
944 str = iSerialNumber ?: composite->iSerialNumber;
948 struct usb_gadget_strings strings = {
949 .language = language,
950 .strings = &(struct usb_string) { 0xff, str }
952 return usb_gadget_get_string(&strings, 0xff, buf);
955 /* String IDs are device-scoped, so we look up each string
956 * table we're told about. These lookups are infrequent;
957 * simpler-is-better here.
959 if (composite->strings) {
960 len = lookup_string(composite->strings, buf, language, id);
964 list_for_each_entry(c, &cdev->configs, list) {
966 len = lookup_string(c->strings, buf, language, id);
970 list_for_each_entry(f, &c->functions, list) {
973 len = lookup_string(f->strings, buf, language, id);
982 * usb_string_id() - allocate an unused string ID
983 * @cdev: the device whose string descriptor IDs are being allocated
984 * Context: single threaded during gadget setup
986 * @usb_string_id() is called from bind() callbacks to allocate
987 * string IDs. Drivers for functions, configurations, or gadgets will
988 * then store that ID in the appropriate descriptors and string table.
990 * All string identifier should be allocated using this,
991 * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure
992 * that for example different functions don't wrongly assign different
993 * meanings to the same identifier.
995 int usb_string_id(struct usb_composite_dev *cdev)
997 if (cdev->next_string_id < 254) {
998 /* string id 0 is reserved by USB spec for list of
999 * supported languages */
1000 /* 255 reserved as well? -- mina86 */
1001 cdev->next_string_id++;
1002 return cdev->next_string_id;
1008 * usb_string_ids() - allocate unused string IDs in batch
1009 * @cdev: the device whose string descriptor IDs are being allocated
1010 * @str: an array of usb_string objects to assign numbers to
1011 * Context: single threaded during gadget setup
1013 * @usb_string_ids() is called from bind() callbacks to allocate
1014 * string IDs. Drivers for functions, configurations, or gadgets will
1015 * then copy IDs from the string table to the appropriate descriptors
1016 * and string table for other languages.
1018 * All string identifier should be allocated using this,
1019 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1020 * example different functions don't wrongly assign different meanings
1021 * to the same identifier.
1023 int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str)
1025 int next = cdev->next_string_id;
1027 for (; str->s; ++str) {
1028 if (unlikely(next >= 254))
1033 cdev->next_string_id = next;
1039 * usb_string_ids_n() - allocate unused string IDs in batch
1040 * @c: the device whose string descriptor IDs are being allocated
1041 * @n: number of string IDs to allocate
1042 * Context: single threaded during gadget setup
1044 * Returns the first requested ID. This ID and next @n-1 IDs are now
1045 * valid IDs. At least provided that @n is non-zero because if it
1046 * is, returns last requested ID which is now very useful information.
1048 * @usb_string_ids_n() is called from bind() callbacks to allocate
1049 * string IDs. Drivers for functions, configurations, or gadgets will
1050 * then store that ID in the appropriate descriptors and string table.
1052 * All string identifier should be allocated using this,
1053 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1054 * example different functions don't wrongly assign different meanings
1055 * to the same identifier.
1057 int usb_string_ids_n(struct usb_composite_dev *c, unsigned n)
1059 unsigned next = c->next_string_id;
1060 if (unlikely(n > 254 || (unsigned)next + n > 254))
1062 c->next_string_id += n;
1067 /*-------------------------------------------------------------------------*/
1069 static void composite_setup_complete(struct usb_ep *ep, struct usb_request *req)
1071 if (req->status || req->actual != req->length)
1072 DBG((struct usb_composite_dev *) ep->driver_data,
1073 "setup complete --> %d, %d/%d\n",
1074 req->status, req->actual, req->length);
1078 * The setup() callback implements all the ep0 functionality that's
1079 * not handled lower down, in hardware or the hardware driver(like
1080 * device and endpoint feature flags, and their status). It's all
1081 * housekeeping for the gadget function we're implementing. Most of
1082 * the work is in config and function specific setup.
1085 composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1087 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1088 struct usb_request *req = cdev->req;
1089 int value = -EOPNOTSUPP;
1091 u16 w_index = le16_to_cpu(ctrl->wIndex);
1092 u8 intf = w_index & 0xFF;
1093 u16 w_value = le16_to_cpu(ctrl->wValue);
1094 u16 w_length = le16_to_cpu(ctrl->wLength);
1095 struct usb_function *f = NULL;
1098 /* partial re-init of the response message; the function or the
1099 * gadget might need to intercept e.g. a control-OUT completion
1100 * when we delegate to it.
1103 req->complete = composite_setup_complete;
1105 gadget->ep0->driver_data = cdev;
1107 switch (ctrl->bRequest) {
1109 /* we handle all standard USB descriptors */
1110 case USB_REQ_GET_DESCRIPTOR:
1111 if (ctrl->bRequestType != USB_DIR_IN)
1113 switch (w_value >> 8) {
1116 cdev->desc.bNumConfigurations =
1117 count_configs(cdev, USB_DT_DEVICE);
1118 cdev->desc.bMaxPacketSize0 =
1119 cdev->gadget->ep0->maxpacket;
1120 if (gadget_is_superspeed(gadget)) {
1121 if (gadget->speed >= USB_SPEED_SUPER) {
1122 cdev->desc.bcdUSB = cpu_to_le16(0x0300);
1123 cdev->desc.bMaxPacketSize0 = 9;
1125 cdev->desc.bcdUSB = cpu_to_le16(0x0210);
1129 value = min(w_length, (u16) sizeof cdev->desc);
1130 memcpy(req->buf, &cdev->desc, value);
1132 case USB_DT_DEVICE_QUALIFIER:
1133 if (!gadget_is_dualspeed(gadget) ||
1134 gadget->speed >= USB_SPEED_SUPER)
1137 value = min_t(int, w_length,
1138 sizeof(struct usb_qualifier_descriptor));
1140 case USB_DT_OTHER_SPEED_CONFIG:
1141 if (!gadget_is_dualspeed(gadget) ||
1142 gadget->speed >= USB_SPEED_SUPER)
1146 value = config_desc(cdev, w_value);
1148 value = min(w_length, (u16) value);
1151 value = get_string(cdev, req->buf,
1152 w_index, w_value & 0xff);
1154 value = min(w_length, (u16) value);
1157 if (gadget_is_superspeed(gadget)) {
1158 value = bos_desc(cdev);
1159 value = min(w_length, (u16) value);
1165 /* any number of configs can work */
1166 case USB_REQ_SET_CONFIGURATION:
1167 if (ctrl->bRequestType != 0)
1169 if (gadget_is_otg(gadget)) {
1170 if (gadget->a_hnp_support)
1171 DBG(cdev, "HNP available\n");
1172 else if (gadget->a_alt_hnp_support)
1173 DBG(cdev, "HNP on another port\n");
1175 VDBG(cdev, "HNP inactive\n");
1177 spin_lock(&cdev->lock);
1178 value = set_config(cdev, ctrl, w_value);
1179 spin_unlock(&cdev->lock);
1181 case USB_REQ_GET_CONFIGURATION:
1182 if (ctrl->bRequestType != USB_DIR_IN)
1185 *(u8 *)req->buf = cdev->config->bConfigurationValue;
1187 *(u8 *)req->buf = 0;
1188 value = min(w_length, (u16) 1);
1191 /* function drivers must handle get/set altsetting; if there's
1192 * no get() method, we know only altsetting zero works.
1194 case USB_REQ_SET_INTERFACE:
1195 if (ctrl->bRequestType != USB_RECIP_INTERFACE)
1197 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1199 f = cdev->config->interface[intf];
1202 if (w_value && !f->set_alt)
1204 value = f->set_alt(f, w_index, w_value);
1205 if (value == USB_GADGET_DELAYED_STATUS) {
1207 "%s: interface %d (%s) requested delayed status\n",
1208 __func__, intf, f->name);
1209 cdev->delayed_status++;
1210 DBG(cdev, "delayed_status count %d\n",
1211 cdev->delayed_status);
1214 case USB_REQ_GET_INTERFACE:
1215 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE))
1217 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1219 f = cdev->config->interface[intf];
1222 /* lots of interfaces only need altsetting zero... */
1223 value = f->get_alt ? f->get_alt(f, w_index) : 0;
1226 *((u8 *)req->buf) = value;
1227 value = min(w_length, (u16) 1);
1231 * USB 3.0 additions:
1232 * Function driver should handle get_status request. If such cb
1233 * wasn't supplied we respond with default value = 0
1234 * Note: function driver should supply such cb only for the first
1235 * interface of the function
1237 case USB_REQ_GET_STATUS:
1238 if (!gadget_is_superspeed(gadget))
1240 if (ctrl->bRequestType != (USB_DIR_IN | USB_RECIP_INTERFACE))
1242 value = 2; /* This is the length of the get_status reply */
1243 put_unaligned_le16(0, req->buf);
1244 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1246 f = cdev->config->interface[intf];
1249 status = f->get_status ? f->get_status(f) : 0;
1252 put_unaligned_le16(status & 0x0000ffff, req->buf);
1255 * Function drivers should handle SetFeature/ClearFeature
1256 * (FUNCTION_SUSPEND) request. function_suspend cb should be supplied
1257 * only for the first interface of the function
1259 case USB_REQ_CLEAR_FEATURE:
1260 case USB_REQ_SET_FEATURE:
1261 if (!gadget_is_superspeed(gadget))
1263 if (ctrl->bRequestType != (USB_DIR_OUT | USB_RECIP_INTERFACE))
1266 case USB_INTRF_FUNC_SUSPEND:
1267 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1269 f = cdev->config->interface[intf];
1273 if (f->func_suspend)
1274 value = f->func_suspend(f, w_index >> 8);
1277 "func_suspend() returned error %d\n",
1287 "non-core control req%02x.%02x v%04x i%04x l%d\n",
1288 ctrl->bRequestType, ctrl->bRequest,
1289 w_value, w_index, w_length);
1291 /* functions always handle their interfaces and endpoints...
1292 * punt other recipients (other, WUSB, ...) to the current
1293 * configuration code.
1295 * REVISIT it could make sense to let the composite device
1296 * take such requests too, if that's ever needed: to work
1299 switch (ctrl->bRequestType & USB_RECIP_MASK) {
1300 case USB_RECIP_INTERFACE:
1301 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1303 f = cdev->config->interface[intf];
1306 case USB_RECIP_ENDPOINT:
1307 endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f);
1308 list_for_each_entry(f, &cdev->config->functions, list) {
1309 if (test_bit(endp, f->endpoints))
1312 if (&f->list == &cdev->config->functions)
1318 value = f->setup(f, ctrl);
1320 struct usb_configuration *c;
1324 value = c->setup(c, ctrl);
1330 /* respond with data transfer before status phase? */
1331 if (value >= 0 && value != USB_GADGET_DELAYED_STATUS) {
1332 req->length = value;
1333 req->zero = value < w_length;
1334 value = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
1336 DBG(cdev, "ep_queue --> %d\n", value);
1338 composite_setup_complete(gadget->ep0, req);
1340 } else if (value == USB_GADGET_DELAYED_STATUS && w_length != 0) {
1342 "%s: Delayed status not supported for w_length != 0",
1347 /* device either stalls (value < 0) or reports success */
1351 static void composite_disconnect(struct usb_gadget *gadget)
1353 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1354 unsigned long flags;
1356 /* REVISIT: should we have config and device level
1357 * disconnect callbacks?
1359 spin_lock_irqsave(&cdev->lock, flags);
1362 if (composite->disconnect)
1363 composite->disconnect(cdev);
1364 spin_unlock_irqrestore(&cdev->lock, flags);
1367 /*-------------------------------------------------------------------------*/
1369 static ssize_t composite_show_suspended(struct device *dev,
1370 struct device_attribute *attr,
1373 struct usb_gadget *gadget = dev_to_usb_gadget(dev);
1374 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1376 return sprintf(buf, "%d\n", cdev->suspended);
1379 static DEVICE_ATTR(suspended, 0444, composite_show_suspended, NULL);
1382 composite_unbind(struct usb_gadget *gadget)
1384 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1386 /* composite_disconnect() must already have been called
1387 * by the underlying peripheral controller driver!
1388 * so there's no i/o concurrency that could affect the
1389 * state protected by cdev->lock.
1391 WARN_ON(cdev->config);
1393 while (!list_empty(&cdev->configs)) {
1394 struct usb_configuration *c;
1395 c = list_first_entry(&cdev->configs,
1396 struct usb_configuration, list);
1397 remove_config(cdev, c);
1399 if (composite->unbind)
1400 composite->unbind(cdev);
1403 kfree(cdev->req->buf);
1404 usb_ep_free_request(gadget->ep0, cdev->req);
1406 device_remove_file(&gadget->dev, &dev_attr_suspended);
1408 set_gadget_data(gadget, NULL);
1412 static u8 override_id(struct usb_composite_dev *cdev, u8 *desc)
1415 int ret = usb_string_id(cdev);
1416 if (unlikely(ret < 0))
1417 WARNING(cdev, "failed to override string ID\n");
1425 static int composite_bind(struct usb_gadget *gadget,
1426 struct usb_gadget_driver *driver)
1428 struct usb_composite_dev *cdev;
1429 int status = -ENOMEM;
1431 cdev = kzalloc(sizeof *cdev, GFP_KERNEL);
1435 spin_lock_init(&cdev->lock);
1436 cdev->gadget = gadget;
1437 set_gadget_data(gadget, cdev);
1438 INIT_LIST_HEAD(&cdev->configs);
1440 /* preallocate control response and buffer */
1441 cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
1444 cdev->req->buf = kmalloc(USB_BUFSIZ, GFP_KERNEL);
1445 if (!cdev->req->buf)
1447 cdev->req->complete = composite_setup_complete;
1448 gadget->ep0->driver_data = cdev;
1450 cdev->bufsiz = USB_BUFSIZ;
1451 cdev->driver = composite;
1454 * As per USB compliance update, a device that is actively drawing
1455 * more than 100mA from USB must report itself as bus-powered in
1456 * the GetStatus(DEVICE) call.
1458 if (CONFIG_USB_GADGET_VBUS_DRAW <= USB_SELF_POWER_VBUS_MAX_DRAW)
1459 usb_gadget_set_selfpowered(gadget);
1461 /* interface and string IDs start at zero via kzalloc.
1462 * we force endpoints to start unassigned; few controller
1463 * drivers will zero ep->driver_data.
1465 usb_ep_autoconfig_reset(cdev->gadget);
1467 /* composite gadget needs to assign strings for whole device (like
1468 * serial number), register function drivers, potentially update
1469 * power state and consumption, etc
1471 status = composite->bind(cdev);
1475 cdev->desc = *composite->dev;
1477 /* standardized runtime overrides for device ID data */
1479 cdev->desc.idVendor = cpu_to_le16(idVendor);
1481 idVendor = le16_to_cpu(cdev->desc.idVendor);
1483 cdev->desc.idProduct = cpu_to_le16(idProduct);
1485 idProduct = le16_to_cpu(cdev->desc.idProduct);
1487 cdev->desc.bcdDevice = cpu_to_le16(bcdDevice);
1489 bcdDevice = le16_to_cpu(cdev->desc.bcdDevice);
1491 /* string overrides */
1492 if (iManufacturer || !cdev->desc.iManufacturer) {
1493 if (!iManufacturer && !composite->iManufacturer &&
1494 !*composite_manufacturer)
1495 snprintf(composite_manufacturer,
1496 sizeof composite_manufacturer,
1498 init_utsname()->sysname,
1499 init_utsname()->release,
1502 cdev->manufacturer_override =
1503 override_id(cdev, &cdev->desc.iManufacturer);
1506 if (iProduct || (!cdev->desc.iProduct && composite->iProduct))
1507 cdev->product_override =
1508 override_id(cdev, &cdev->desc.iProduct);
1510 if (iSerialNumber ||
1511 (!cdev->desc.iSerialNumber && composite->iSerialNumber))
1512 cdev->serial_override =
1513 override_id(cdev, &cdev->desc.iSerialNumber);
1515 /* has userspace failed to provide a serial number? */
1516 if (composite->needs_serial && !cdev->desc.iSerialNumber)
1517 WARNING(cdev, "userspace failed to provide iSerialNumber\n");
1520 status = device_create_file(&gadget->dev, &dev_attr_suspended);
1524 INFO(cdev, "%s ready\n", composite->name);
1528 composite_unbind(gadget);
1532 /*-------------------------------------------------------------------------*/
1535 composite_suspend(struct usb_gadget *gadget)
1537 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1538 struct usb_function *f;
1540 /* REVISIT: should we have config level
1541 * suspend/resume callbacks?
1543 DBG(cdev, "suspend\n");
1545 list_for_each_entry(f, &cdev->config->functions, list) {
1550 if (composite->suspend)
1551 composite->suspend(cdev);
1553 cdev->suspended = 1;
1555 usb_gadget_vbus_draw(gadget, 2);
1559 composite_resume(struct usb_gadget *gadget)
1561 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1562 struct usb_function *f;
1565 /* REVISIT: should we have config level
1566 * suspend/resume callbacks?
1568 DBG(cdev, "resume\n");
1569 if (composite->resume)
1570 composite->resume(cdev);
1572 list_for_each_entry(f, &cdev->config->functions, list) {
1577 maxpower = cdev->config->bMaxPower;
1579 usb_gadget_vbus_draw(gadget, maxpower ?
1580 (2 * maxpower) : CONFIG_USB_GADGET_VBUS_DRAW);
1583 cdev->suspended = 0;
1586 /*-------------------------------------------------------------------------*/
1588 static struct usb_gadget_driver composite_driver = {
1589 .bind = composite_bind,
1590 .unbind = composite_unbind,
1592 .setup = composite_setup,
1593 .disconnect = composite_disconnect,
1595 .suspend = composite_suspend,
1596 .resume = composite_resume,
1599 .owner = THIS_MODULE,
1604 * usb_composite_probe() - register a composite driver
1605 * @driver: the driver to register
1606 * @bind: the callback used to allocate resources that are shared across the
1607 * whole device, such as string IDs, and add its configurations using
1608 * @usb_add_config(). This may fail by returning a negative errno
1609 * value; it should return zero on successful initialization.
1610 * Context: single threaded during gadget setup
1612 * This function is used to register drivers using the composite driver
1613 * framework. The return value is zero, or a negative errno value.
1614 * Those values normally come from the driver's @bind method, which does
1615 * all the work of setting up the driver to match the hardware.
1617 * On successful return, the gadget is ready to respond to requests from
1618 * the host, unless one of its components invokes usb_gadget_disconnect()
1619 * while it was binding. That would usually be done in order to wait for
1620 * some userspace participation.
1622 int usb_composite_probe(struct usb_composite_driver *driver)
1624 if (!driver || !driver->dev || composite || !driver->bind)
1628 driver->name = "composite";
1629 if (!driver->iProduct)
1630 driver->iProduct = driver->name;
1631 composite_driver.function = (char *) driver->name;
1632 composite_driver.driver.name = driver->name;
1633 composite_driver.max_speed = driver->max_speed;
1636 return usb_gadget_probe_driver(&composite_driver);
1640 * usb_composite_unregister() - unregister a composite driver
1641 * @driver: the driver to unregister
1643 * This function is used to unregister drivers using the composite
1646 void usb_composite_unregister(struct usb_composite_driver *driver)
1648 if (composite != driver)
1650 usb_gadget_unregister_driver(&composite_driver);
1654 * usb_composite_setup_continue() - Continue with the control transfer
1655 * @cdev: the composite device who's control transfer was kept waiting
1657 * This function must be called by the USB function driver to continue
1658 * with the control transfer's data/status stage in case it had requested to
1659 * delay the data/status stages. A USB function's setup handler (e.g. set_alt())
1660 * can request the composite framework to delay the setup request's data/status
1661 * stages by returning USB_GADGET_DELAYED_STATUS.
1663 void usb_composite_setup_continue(struct usb_composite_dev *cdev)
1666 struct usb_request *req = cdev->req;
1667 unsigned long flags;
1669 DBG(cdev, "%s\n", __func__);
1670 spin_lock_irqsave(&cdev->lock, flags);
1672 if (cdev->delayed_status == 0) {
1673 WARN(cdev, "%s: Unexpected call\n", __func__);
1675 } else if (--cdev->delayed_status == 0) {
1676 DBG(cdev, "%s: Completing delayed status\n", __func__);
1678 value = usb_ep_queue(cdev->gadget->ep0, req, GFP_ATOMIC);
1680 DBG(cdev, "ep_queue --> %d\n", value);
1682 composite_setup_complete(cdev->gadget->ep0, req);
1686 spin_unlock_irqrestore(&cdev->lock, flags);