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 <linux/usb/otg.h>
23 #include <asm/unaligned.h>
25 #include "u_os_desc.h"
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
35 struct usb_os_string {
38 __u8 qwSignature[OS_STRING_QW_SIGN_LEN];
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.
50 static struct usb_gadget_strings **get_containers_gs(
51 struct usb_gadget_string_container *uc)
53 return (struct usb_gadget_strings **)uc->stash;
57 * function_descriptors() - get function descriptors for speed
61 * Returns the descriptors or NULL if not set.
63 static struct usb_descriptor_header **
64 function_descriptors(struct usb_function *f,
65 enum usb_device_speed speed)
67 struct usb_descriptor_header **descriptors;
70 * NOTE: we try to help gadget drivers which might not be setting
71 * max_speed appropriately.
75 case USB_SPEED_SUPER_PLUS:
76 descriptors = f->ssp_descriptors;
81 descriptors = f->ss_descriptors;
86 descriptors = f->hs_descriptors;
91 descriptors = f->fs_descriptors;
95 * if we can't find any descriptors at all, then this gadget deserves to
96 * Oops with a NULL pointer dereference
103 * next_ep_desc() - advance to the next EP descriptor
104 * @t: currect pointer within descriptor array
106 * Return: next EP descriptor or NULL
108 * Iterate over @t until either EP descriptor found or
109 * NULL (that indicates end of list) encountered
111 static struct usb_descriptor_header**
112 next_ep_desc(struct usb_descriptor_header **t)
115 if ((*t)->bDescriptorType == USB_DT_ENDPOINT)
122 * for_each_ep_desc()- iterate over endpoint descriptors in the
124 * @start: pointer within descriptor array.
125 * @ep_desc: endpoint descriptor to use as the loop cursor
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))
132 * config_ep_by_speed() - configures the given endpoint
133 * according to gadget speed.
134 * @g: pointer to the gadget
136 * @_ep: the endpoint to configure
138 * Return: error code, 0 on success
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
149 int config_ep_by_speed(struct usb_gadget *g,
150 struct usb_function *f,
153 struct usb_composite_dev *cdev = get_gadget_data(g);
154 struct usb_endpoint_descriptor *chosen_desc = NULL;
155 struct usb_descriptor_header **speed_desc = NULL;
157 struct usb_ss_ep_comp_descriptor *comp_desc = NULL;
158 int want_comp_desc = 0;
160 struct usb_descriptor_header **d_spd; /* cursor for speed desc */
162 if (!g || !f || !_ep)
165 /* select desired speed */
167 case USB_SPEED_SUPER_PLUS:
168 if (gadget_is_superspeed_plus(g)) {
169 speed_desc = f->ssp_descriptors;
173 /* else: Fall trough */
174 case USB_SPEED_SUPER:
175 if (gadget_is_superspeed(g)) {
176 speed_desc = f->ss_descriptors;
180 /* else: Fall trough */
182 if (gadget_is_dualspeed(g)) {
183 speed_desc = f->hs_descriptors;
186 /* else: fall through */
188 speed_desc = f->fs_descriptors;
190 /* find descriptors */
191 for_each_ep_desc(speed_desc, d_spd) {
192 chosen_desc = (struct usb_endpoint_descriptor *)*d_spd;
193 if (chosen_desc->bEndpointAddress == _ep->address)
200 _ep->maxpacket = usb_endpoint_maxp(chosen_desc);
201 _ep->desc = chosen_desc;
202 _ep->comp_desc = NULL;
209 * Companion descriptor should follow EP descriptor
210 * USB 3.0 spec, #9.6.7
212 comp_desc = (struct usb_ss_ep_comp_descriptor *)*(++d_spd);
214 (comp_desc->bDescriptorType != USB_DT_SS_ENDPOINT_COMP))
216 _ep->comp_desc = comp_desc;
217 if (g->speed >= USB_SPEED_SUPER) {
218 switch (usb_endpoint_type(_ep->desc)) {
219 case USB_ENDPOINT_XFER_ISOC:
220 /* mult: bits 1:0 of bmAttributes */
221 _ep->mult = comp_desc->bmAttributes & 0x3;
222 case USB_ENDPOINT_XFER_BULK:
223 case USB_ENDPOINT_XFER_INT:
224 _ep->maxburst = comp_desc->bMaxBurst + 1;
227 if (comp_desc->bMaxBurst != 0)
228 ERROR(cdev, "ep0 bMaxBurst must be 0\n");
235 EXPORT_SYMBOL_GPL(config_ep_by_speed);
238 * usb_add_function() - add a function to a configuration
239 * @config: the configuration
240 * @function: the function being added
241 * Context: single threaded during gadget setup
243 * After initialization, each configuration must have one or more
244 * functions added to it. Adding a function involves calling its @bind()
245 * method to allocate resources such as interface and string identifiers
248 * This function returns the value of the function's bind(), which is
249 * zero for success else a negative errno value.
251 int usb_add_function(struct usb_configuration *config,
252 struct usb_function *function)
256 DBG(config->cdev, "adding '%s'/%p to config '%s'/%p\n",
257 function->name, function,
258 config->label, config);
260 if (!function->set_alt || !function->disable)
263 function->config = config;
264 list_add_tail(&function->list, &config->functions);
266 if (function->bind_deactivated) {
267 value = usb_function_deactivate(function);
272 /* REVISIT *require* function->bind? */
273 if (function->bind) {
274 value = function->bind(config, function);
276 list_del(&function->list);
277 function->config = NULL;
282 /* We allow configurations that don't work at both speeds.
283 * If we run into a lowspeed Linux system, treat it the same
284 * as full speed ... it's the function drivers that will need
285 * to avoid bulk and ISO transfers.
287 if (!config->fullspeed && function->fs_descriptors)
288 config->fullspeed = true;
289 if (!config->highspeed && function->hs_descriptors)
290 config->highspeed = true;
291 if (!config->superspeed && function->ss_descriptors)
292 config->superspeed = true;
293 if (!config->superspeed_plus && function->ssp_descriptors)
294 config->superspeed_plus = true;
298 DBG(config->cdev, "adding '%s'/%p --> %d\n",
299 function->name, function, value);
302 EXPORT_SYMBOL_GPL(usb_add_function);
304 void usb_remove_function(struct usb_configuration *c, struct usb_function *f)
309 bitmap_zero(f->endpoints, 32);
314 EXPORT_SYMBOL_GPL(usb_remove_function);
317 * usb_function_deactivate - prevent function and gadget enumeration
318 * @function: the function that isn't yet ready to respond
320 * Blocks response of the gadget driver to host enumeration by
321 * preventing the data line pullup from being activated. This is
322 * normally called during @bind() processing to change from the
323 * initial "ready to respond" state, or when a required resource
326 * For example, drivers that serve as a passthrough to a userspace
327 * daemon can block enumeration unless that daemon (such as an OBEX,
328 * MTP, or print server) is ready to handle host requests.
330 * Not all systems support software control of their USB peripheral
333 * Returns zero on success, else negative errno.
335 int usb_function_deactivate(struct usb_function *function)
337 struct usb_composite_dev *cdev = function->config->cdev;
341 spin_lock_irqsave(&cdev->lock, flags);
343 if (cdev->deactivations == 0)
344 status = usb_gadget_deactivate(cdev->gadget);
346 cdev->deactivations++;
348 spin_unlock_irqrestore(&cdev->lock, flags);
351 EXPORT_SYMBOL_GPL(usb_function_deactivate);
354 * usb_function_activate - allow function and gadget enumeration
355 * @function: function on which usb_function_activate() was called
357 * Reverses effect of usb_function_deactivate(). If no more functions
358 * are delaying their activation, the gadget driver will respond to
359 * host enumeration procedures.
361 * Returns zero on success, else negative errno.
363 int usb_function_activate(struct usb_function *function)
365 struct usb_composite_dev *cdev = function->config->cdev;
369 spin_lock_irqsave(&cdev->lock, flags);
371 if (WARN_ON(cdev->deactivations == 0))
374 cdev->deactivations--;
375 if (cdev->deactivations == 0)
376 status = usb_gadget_activate(cdev->gadget);
379 spin_unlock_irqrestore(&cdev->lock, flags);
382 EXPORT_SYMBOL_GPL(usb_function_activate);
385 * usb_interface_id() - allocate an unused interface ID
386 * @config: configuration associated with the interface
387 * @function: function handling the interface
388 * Context: single threaded during gadget setup
390 * usb_interface_id() is called from usb_function.bind() callbacks to
391 * allocate new interface IDs. The function driver will then store that
392 * ID in interface, association, CDC union, and other descriptors. It
393 * will also handle any control requests targeted at that interface,
394 * particularly changing its altsetting via set_alt(). There may
395 * also be class-specific or vendor-specific requests to handle.
397 * All interface identifier should be allocated using this routine, to
398 * ensure that for example different functions don't wrongly assign
399 * different meanings to the same identifier. Note that since interface
400 * identifiers are configuration-specific, functions used in more than
401 * one configuration (or more than once in a given configuration) need
402 * multiple versions of the relevant descriptors.
404 * Returns the interface ID which was allocated; or -ENODEV if no
405 * more interface IDs can be allocated.
407 int usb_interface_id(struct usb_configuration *config,
408 struct usb_function *function)
410 unsigned id = config->next_interface_id;
412 if (id < MAX_CONFIG_INTERFACES) {
413 config->interface[id] = function;
414 config->next_interface_id = id + 1;
419 EXPORT_SYMBOL_GPL(usb_interface_id);
421 static u8 encode_bMaxPower(enum usb_device_speed speed,
422 struct usb_configuration *c)
429 val = CONFIG_USB_GADGET_VBUS_DRAW;
433 case USB_SPEED_SUPER:
434 return DIV_ROUND_UP(val, 8);
436 return DIV_ROUND_UP(val, 2);
440 static int config_buf(struct usb_configuration *config,
441 enum usb_device_speed speed, void *buf, u8 type)
443 struct usb_config_descriptor *c = buf;
444 void *next = buf + USB_DT_CONFIG_SIZE;
446 struct usb_function *f;
449 len = USB_COMP_EP0_BUFSIZ - USB_DT_CONFIG_SIZE;
450 /* write the config descriptor */
452 c->bLength = USB_DT_CONFIG_SIZE;
453 c->bDescriptorType = type;
454 /* wTotalLength is written later */
455 c->bNumInterfaces = config->next_interface_id;
456 c->bConfigurationValue = config->bConfigurationValue;
457 c->iConfiguration = config->iConfiguration;
458 c->bmAttributes = USB_CONFIG_ATT_ONE | config->bmAttributes;
459 c->bMaxPower = encode_bMaxPower(speed, config);
461 /* There may be e.g. OTG descriptors */
462 if (config->descriptors) {
463 status = usb_descriptor_fillbuf(next, len,
464 config->descriptors);
471 /* add each function's descriptors */
472 list_for_each_entry(f, &config->functions, list) {
473 struct usb_descriptor_header **descriptors;
475 descriptors = function_descriptors(f, speed);
478 status = usb_descriptor_fillbuf(next, len,
479 (const struct usb_descriptor_header **) descriptors);
487 c->wTotalLength = cpu_to_le16(len);
491 static int config_desc(struct usb_composite_dev *cdev, unsigned w_value)
493 struct usb_gadget *gadget = cdev->gadget;
494 struct usb_configuration *c;
495 struct list_head *pos;
496 u8 type = w_value >> 8;
497 enum usb_device_speed speed = USB_SPEED_UNKNOWN;
499 if (gadget->speed >= USB_SPEED_SUPER)
500 speed = gadget->speed;
501 else if (gadget_is_dualspeed(gadget)) {
503 if (gadget->speed == USB_SPEED_HIGH)
505 if (type == USB_DT_OTHER_SPEED_CONFIG)
508 speed = USB_SPEED_HIGH;
512 /* This is a lookup by config *INDEX* */
515 pos = &cdev->configs;
516 c = cdev->os_desc_config;
520 while ((pos = pos->next) != &cdev->configs) {
521 c = list_entry(pos, typeof(*c), list);
523 /* skip OS Descriptors config which is handled separately */
524 if (c == cdev->os_desc_config)
528 /* ignore configs that won't work at this speed */
530 case USB_SPEED_SUPER_PLUS:
531 if (!c->superspeed_plus)
534 case USB_SPEED_SUPER:
548 return config_buf(c, speed, cdev->req->buf, type);
554 static int count_configs(struct usb_composite_dev *cdev, unsigned type)
556 struct usb_gadget *gadget = cdev->gadget;
557 struct usb_configuration *c;
563 if (gadget_is_dualspeed(gadget)) {
564 if (gadget->speed == USB_SPEED_HIGH)
566 if (gadget->speed == USB_SPEED_SUPER)
568 if (gadget->speed == USB_SPEED_SUPER_PLUS)
570 if (type == USB_DT_DEVICE_QUALIFIER)
573 list_for_each_entry(c, &cdev->configs, list) {
574 /* ignore configs that won't work at this speed */
576 if (!c->superspeed_plus)
594 * bos_desc() - prepares the BOS descriptor.
595 * @cdev: pointer to usb_composite device to generate the bos
598 * This function generates the BOS (Binary Device Object)
599 * descriptor and its device capabilities descriptors. The BOS
600 * descriptor should be supported by a SuperSpeed device.
602 static int bos_desc(struct usb_composite_dev *cdev)
604 struct usb_ext_cap_descriptor *usb_ext;
605 struct usb_ss_cap_descriptor *ss_cap;
606 struct usb_dcd_config_params dcd_config_params;
607 struct usb_bos_descriptor *bos = cdev->req->buf;
609 bos->bLength = USB_DT_BOS_SIZE;
610 bos->bDescriptorType = USB_DT_BOS;
612 bos->wTotalLength = cpu_to_le16(USB_DT_BOS_SIZE);
613 bos->bNumDeviceCaps = 0;
616 * A SuperSpeed device shall include the USB2.0 extension descriptor
617 * and shall support LPM when operating in USB2.0 HS mode.
619 usb_ext = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
620 bos->bNumDeviceCaps++;
621 le16_add_cpu(&bos->wTotalLength, USB_DT_USB_EXT_CAP_SIZE);
622 usb_ext->bLength = USB_DT_USB_EXT_CAP_SIZE;
623 usb_ext->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
624 usb_ext->bDevCapabilityType = USB_CAP_TYPE_EXT;
625 usb_ext->bmAttributes = cpu_to_le32(USB_LPM_SUPPORT | USB_BESL_SUPPORT);
628 * The Superspeed USB Capability descriptor shall be implemented by all
629 * SuperSpeed devices.
631 ss_cap = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
632 bos->bNumDeviceCaps++;
633 le16_add_cpu(&bos->wTotalLength, USB_DT_USB_SS_CAP_SIZE);
634 ss_cap->bLength = USB_DT_USB_SS_CAP_SIZE;
635 ss_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
636 ss_cap->bDevCapabilityType = USB_SS_CAP_TYPE;
637 ss_cap->bmAttributes = 0; /* LTM is not supported yet */
638 ss_cap->wSpeedSupported = cpu_to_le16(USB_LOW_SPEED_OPERATION |
639 USB_FULL_SPEED_OPERATION |
640 USB_HIGH_SPEED_OPERATION |
641 USB_5GBPS_OPERATION);
642 ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
644 /* Get Controller configuration */
645 if (cdev->gadget->ops->get_config_params)
646 cdev->gadget->ops->get_config_params(&dcd_config_params);
648 dcd_config_params.bU1devExitLat = USB_DEFAULT_U1_DEV_EXIT_LAT;
649 dcd_config_params.bU2DevExitLat =
650 cpu_to_le16(USB_DEFAULT_U2_DEV_EXIT_LAT);
652 ss_cap->bU1devExitLat = dcd_config_params.bU1devExitLat;
653 ss_cap->bU2DevExitLat = dcd_config_params.bU2DevExitLat;
655 /* The SuperSpeedPlus USB Device Capability descriptor */
656 if (gadget_is_superspeed_plus(cdev->gadget)) {
657 struct usb_ssp_cap_descriptor *ssp_cap;
659 ssp_cap = cdev->req->buf + le16_to_cpu(bos->wTotalLength);
660 bos->bNumDeviceCaps++;
663 * Report typical values.
666 le16_add_cpu(&bos->wTotalLength, USB_DT_USB_SSP_CAP_SIZE(1));
667 ssp_cap->bLength = USB_DT_USB_SSP_CAP_SIZE(1);
668 ssp_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
669 ssp_cap->bDevCapabilityType = USB_SSP_CAP_TYPE;
670 ssp_cap->bReserved = 0;
671 ssp_cap->wReserved = 0;
673 /* SSAC = 1 (2 attributes) */
674 ssp_cap->bmAttributes = cpu_to_le32(1);
676 /* Min RX/TX Lane Count = 1 */
677 ssp_cap->wFunctionalitySupport =
678 cpu_to_le16((1 << 8) | (1 << 12));
681 * bmSublinkSpeedAttr[0]:
684 * LP = 1 (SuperSpeedPlus)
687 ssp_cap->bmSublinkSpeedAttr[0] =
688 cpu_to_le32((3 << 4) | (1 << 14) | (0xa << 16));
690 * bmSublinkSpeedAttr[1] =
693 * LP = 1 (SuperSpeedPlus)
696 ssp_cap->bmSublinkSpeedAttr[1] =
697 cpu_to_le32((3 << 4) | (1 << 14) |
698 (0xa << 16) | (1 << 7));
701 return le16_to_cpu(bos->wTotalLength);
704 static void device_qual(struct usb_composite_dev *cdev)
706 struct usb_qualifier_descriptor *qual = cdev->req->buf;
708 qual->bLength = sizeof(*qual);
709 qual->bDescriptorType = USB_DT_DEVICE_QUALIFIER;
710 /* POLICY: same bcdUSB and device type info at both speeds */
711 qual->bcdUSB = cdev->desc.bcdUSB;
712 qual->bDeviceClass = cdev->desc.bDeviceClass;
713 qual->bDeviceSubClass = cdev->desc.bDeviceSubClass;
714 qual->bDeviceProtocol = cdev->desc.bDeviceProtocol;
715 /* ASSUME same EP0 fifo size at both speeds */
716 qual->bMaxPacketSize0 = cdev->gadget->ep0->maxpacket;
717 qual->bNumConfigurations = count_configs(cdev, USB_DT_DEVICE_QUALIFIER);
721 /*-------------------------------------------------------------------------*/
723 static void reset_config(struct usb_composite_dev *cdev)
725 struct usb_function *f;
727 DBG(cdev, "reset config\n");
729 list_for_each_entry(f, &cdev->config->functions, list) {
733 bitmap_zero(f->endpoints, 32);
736 cdev->delayed_status = 0;
739 static int set_config(struct usb_composite_dev *cdev,
740 const struct usb_ctrlrequest *ctrl, unsigned number)
742 struct usb_gadget *gadget = cdev->gadget;
743 struct usb_configuration *c = NULL;
744 int result = -EINVAL;
745 unsigned power = gadget_is_otg(gadget) ? 8 : 100;
749 list_for_each_entry(c, &cdev->configs, list) {
750 if (c->bConfigurationValue == number) {
752 * We disable the FDs of the previous
753 * configuration only if the new configuration
764 } else { /* Zero configuration value - need to reset the config */
770 INFO(cdev, "%s config #%d: %s\n",
771 usb_speed_string(gadget->speed),
772 number, c ? c->label : "unconfigured");
777 usb_gadget_set_state(gadget, USB_STATE_CONFIGURED);
780 /* Initialize all interfaces by setting them to altsetting zero. */
781 for (tmp = 0; tmp < MAX_CONFIG_INTERFACES; tmp++) {
782 struct usb_function *f = c->interface[tmp];
783 struct usb_descriptor_header **descriptors;
789 * Record which endpoints are used by the function. This is used
790 * to dispatch control requests targeted at that endpoint to the
791 * function's setup callback instead of the current
792 * configuration's setup callback.
794 descriptors = function_descriptors(f, gadget->speed);
796 for (; *descriptors; ++descriptors) {
797 struct usb_endpoint_descriptor *ep;
800 if ((*descriptors)->bDescriptorType != USB_DT_ENDPOINT)
803 ep = (struct usb_endpoint_descriptor *)*descriptors;
804 addr = ((ep->bEndpointAddress & 0x80) >> 3)
805 | (ep->bEndpointAddress & 0x0f);
806 set_bit(addr, f->endpoints);
809 result = f->set_alt(f, tmp, 0);
811 DBG(cdev, "interface %d (%s/%p) alt 0 --> %d\n",
812 tmp, f->name, f, result);
818 if (result == USB_GADGET_DELAYED_STATUS) {
820 "%s: interface %d (%s) requested delayed status\n",
821 __func__, tmp, f->name);
822 cdev->delayed_status++;
823 DBG(cdev, "delayed_status count %d\n",
824 cdev->delayed_status);
828 /* when we return, be sure our power usage is valid */
829 power = c->MaxPower ? c->MaxPower : CONFIG_USB_GADGET_VBUS_DRAW;
831 usb_gadget_vbus_draw(gadget, power);
832 if (result >= 0 && cdev->delayed_status)
833 result = USB_GADGET_DELAYED_STATUS;
837 int usb_add_config_only(struct usb_composite_dev *cdev,
838 struct usb_configuration *config)
840 struct usb_configuration *c;
842 if (!config->bConfigurationValue)
845 /* Prevent duplicate configuration identifiers */
846 list_for_each_entry(c, &cdev->configs, list) {
847 if (c->bConfigurationValue == config->bConfigurationValue)
852 list_add_tail(&config->list, &cdev->configs);
854 INIT_LIST_HEAD(&config->functions);
855 config->next_interface_id = 0;
856 memset(config->interface, 0, sizeof(config->interface));
860 EXPORT_SYMBOL_GPL(usb_add_config_only);
863 * usb_add_config() - add a configuration to a device.
864 * @cdev: wraps the USB gadget
865 * @config: the configuration, with bConfigurationValue assigned
866 * @bind: the configuration's bind function
867 * Context: single threaded during gadget setup
869 * One of the main tasks of a composite @bind() routine is to
870 * add each of the configurations it supports, using this routine.
872 * This function returns the value of the configuration's @bind(), which
873 * is zero for success else a negative errno value. Binding configurations
874 * assigns global resources including string IDs, and per-configuration
875 * resources such as interface IDs and endpoints.
877 int usb_add_config(struct usb_composite_dev *cdev,
878 struct usb_configuration *config,
879 int (*bind)(struct usb_configuration *))
881 int status = -EINVAL;
886 DBG(cdev, "adding config #%u '%s'/%p\n",
887 config->bConfigurationValue,
888 config->label, config);
890 status = usb_add_config_only(cdev, config);
894 status = bind(config);
896 while (!list_empty(&config->functions)) {
897 struct usb_function *f;
899 f = list_first_entry(&config->functions,
900 struct usb_function, list);
903 DBG(cdev, "unbind function '%s'/%p\n",
905 f->unbind(config, f);
906 /* may free memory for "f" */
909 list_del(&config->list);
914 DBG(cdev, "cfg %d/%p speeds:%s%s%s%s\n",
915 config->bConfigurationValue, config,
916 config->superspeed_plus ? " superplus" : "",
917 config->superspeed ? " super" : "",
918 config->highspeed ? " high" : "",
920 ? (gadget_is_dualspeed(cdev->gadget)
925 for (i = 0; i < MAX_CONFIG_INTERFACES; i++) {
926 struct usb_function *f = config->interface[i];
930 DBG(cdev, " interface %d = %s/%p\n",
935 /* set_alt(), or next bind(), sets up ep->claimed as needed */
936 usb_ep_autoconfig_reset(cdev->gadget);
940 DBG(cdev, "added config '%s'/%u --> %d\n", config->label,
941 config->bConfigurationValue, status);
944 EXPORT_SYMBOL_GPL(usb_add_config);
946 static void remove_config(struct usb_composite_dev *cdev,
947 struct usb_configuration *config)
949 while (!list_empty(&config->functions)) {
950 struct usb_function *f;
952 f = list_first_entry(&config->functions,
953 struct usb_function, list);
956 DBG(cdev, "unbind function '%s'/%p\n", f->name, f);
957 f->unbind(config, f);
958 /* may free memory for "f" */
961 list_del(&config->list);
962 if (config->unbind) {
963 DBG(cdev, "unbind config '%s'/%p\n", config->label, config);
964 config->unbind(config);
965 /* may free memory for "c" */
970 * usb_remove_config() - remove a configuration from a device.
971 * @cdev: wraps the USB gadget
972 * @config: the configuration
974 * Drivers must call usb_gadget_disconnect before calling this function
975 * to disconnect the device from the host and make sure the host will not
976 * try to enumerate the device while we are changing the config list.
978 void usb_remove_config(struct usb_composite_dev *cdev,
979 struct usb_configuration *config)
983 spin_lock_irqsave(&cdev->lock, flags);
985 if (cdev->config == config)
988 spin_unlock_irqrestore(&cdev->lock, flags);
990 remove_config(cdev, config);
993 /*-------------------------------------------------------------------------*/
995 /* We support strings in multiple languages ... string descriptor zero
996 * says which languages are supported. The typical case will be that
997 * only one language (probably English) is used, with i18n handled on
1001 static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf)
1003 const struct usb_gadget_strings *s;
1009 language = cpu_to_le16(s->language);
1010 for (tmp = buf; *tmp && tmp < &buf[126]; tmp++) {
1011 if (*tmp == language)
1020 static int lookup_string(
1021 struct usb_gadget_strings **sp,
1027 struct usb_gadget_strings *s;
1032 if (s->language != language)
1034 value = usb_gadget_get_string(s, id, buf);
1041 static int get_string(struct usb_composite_dev *cdev,
1042 void *buf, u16 language, int id)
1044 struct usb_composite_driver *composite = cdev->driver;
1045 struct usb_gadget_string_container *uc;
1046 struct usb_configuration *c;
1047 struct usb_function *f;
1050 /* Yes, not only is USB's i18n support probably more than most
1051 * folk will ever care about ... also, it's all supported here.
1052 * (Except for UTF8 support for Unicode's "Astral Planes".)
1055 /* 0 == report all available language codes */
1057 struct usb_string_descriptor *s = buf;
1058 struct usb_gadget_strings **sp;
1061 s->bDescriptorType = USB_DT_STRING;
1063 sp = composite->strings;
1065 collect_langs(sp, s->wData);
1067 list_for_each_entry(c, &cdev->configs, list) {
1070 collect_langs(sp, s->wData);
1072 list_for_each_entry(f, &c->functions, list) {
1075 collect_langs(sp, s->wData);
1078 list_for_each_entry(uc, &cdev->gstrings, list) {
1079 struct usb_gadget_strings **sp;
1081 sp = get_containers_gs(uc);
1082 collect_langs(sp, s->wData);
1085 for (len = 0; len <= 126 && s->wData[len]; len++)
1090 s->bLength = 2 * (len + 1);
1094 if (cdev->use_os_string && language == 0 && id == OS_STRING_IDX) {
1095 struct usb_os_string *b = buf;
1096 b->bLength = sizeof(*b);
1097 b->bDescriptorType = USB_DT_STRING;
1099 sizeof(b->qwSignature) == sizeof(cdev->qw_sign),
1100 "qwSignature size must be equal to qw_sign");
1101 memcpy(&b->qwSignature, cdev->qw_sign, sizeof(b->qwSignature));
1102 b->bMS_VendorCode = cdev->b_vendor_code;
1107 list_for_each_entry(uc, &cdev->gstrings, list) {
1108 struct usb_gadget_strings **sp;
1110 sp = get_containers_gs(uc);
1111 len = lookup_string(sp, buf, language, id);
1116 /* String IDs are device-scoped, so we look up each string
1117 * table we're told about. These lookups are infrequent;
1118 * simpler-is-better here.
1120 if (composite->strings) {
1121 len = lookup_string(composite->strings, buf, language, id);
1125 list_for_each_entry(c, &cdev->configs, list) {
1127 len = lookup_string(c->strings, buf, language, id);
1131 list_for_each_entry(f, &c->functions, list) {
1134 len = lookup_string(f->strings, buf, language, id);
1143 * usb_string_id() - allocate an unused string ID
1144 * @cdev: the device whose string descriptor IDs are being allocated
1145 * Context: single threaded during gadget setup
1147 * @usb_string_id() is called from bind() callbacks to allocate
1148 * string IDs. Drivers for functions, configurations, or gadgets will
1149 * then store that ID in the appropriate descriptors and string table.
1151 * All string identifier should be allocated using this,
1152 * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure
1153 * that for example different functions don't wrongly assign different
1154 * meanings to the same identifier.
1156 int usb_string_id(struct usb_composite_dev *cdev)
1158 if (cdev->next_string_id < 254) {
1159 /* string id 0 is reserved by USB spec for list of
1160 * supported languages */
1161 /* 255 reserved as well? -- mina86 */
1162 cdev->next_string_id++;
1163 return cdev->next_string_id;
1167 EXPORT_SYMBOL_GPL(usb_string_id);
1170 * usb_string_ids() - allocate unused string IDs in batch
1171 * @cdev: the device whose string descriptor IDs are being allocated
1172 * @str: an array of usb_string objects to assign numbers to
1173 * Context: single threaded during gadget setup
1175 * @usb_string_ids() is called from bind() callbacks to allocate
1176 * string IDs. Drivers for functions, configurations, or gadgets will
1177 * then copy IDs from the string table to the appropriate descriptors
1178 * and string table for other languages.
1180 * All string identifier should be allocated using this,
1181 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1182 * example different functions don't wrongly assign different meanings
1183 * to the same identifier.
1185 int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str)
1187 int next = cdev->next_string_id;
1189 for (; str->s; ++str) {
1190 if (unlikely(next >= 254))
1195 cdev->next_string_id = next;
1199 EXPORT_SYMBOL_GPL(usb_string_ids_tab);
1201 static struct usb_gadget_string_container *copy_gadget_strings(
1202 struct usb_gadget_strings **sp, unsigned n_gstrings,
1205 struct usb_gadget_string_container *uc;
1206 struct usb_gadget_strings **gs_array;
1207 struct usb_gadget_strings *gs;
1208 struct usb_string *s;
1215 mem += sizeof(void *) * (n_gstrings + 1);
1216 mem += sizeof(struct usb_gadget_strings) * n_gstrings;
1217 mem += sizeof(struct usb_string) * (n_strings + 1) * (n_gstrings);
1218 uc = kmalloc(mem, GFP_KERNEL);
1220 return ERR_PTR(-ENOMEM);
1221 gs_array = get_containers_gs(uc);
1223 stash += sizeof(void *) * (n_gstrings + 1);
1224 for (n_gs = 0; n_gs < n_gstrings; n_gs++) {
1225 struct usb_string *org_s;
1227 gs_array[n_gs] = stash;
1228 gs = gs_array[n_gs];
1229 stash += sizeof(struct usb_gadget_strings);
1230 gs->language = sp[n_gs]->language;
1231 gs->strings = stash;
1232 org_s = sp[n_gs]->strings;
1234 for (n_s = 0; n_s < n_strings; n_s++) {
1236 stash += sizeof(struct usb_string);
1245 stash += sizeof(struct usb_string);
1248 gs_array[n_gs] = NULL;
1253 * usb_gstrings_attach() - attach gadget strings to a cdev and assign ids
1254 * @cdev: the device whose string descriptor IDs are being allocated
1256 * @sp: an array of usb_gadget_strings to attach.
1257 * @n_strings: number of entries in each usb_strings array (sp[]->strings)
1259 * This function will create a deep copy of usb_gadget_strings and usb_string
1260 * and attach it to the cdev. The actual string (usb_string.s) will not be
1261 * copied but only a referenced will be made. The struct usb_gadget_strings
1262 * array may contain multiple languages and should be NULL terminated.
1263 * The ->language pointer of each struct usb_gadget_strings has to contain the
1264 * same amount of entries.
1265 * For instance: sp[0] is en-US, sp[1] is es-ES. It is expected that the first
1266 * usb_string entry of es-ES contains the translation of the first usb_string
1267 * entry of en-US. Therefore both entries become the same id assign.
1269 struct usb_string *usb_gstrings_attach(struct usb_composite_dev *cdev,
1270 struct usb_gadget_strings **sp, unsigned n_strings)
1272 struct usb_gadget_string_container *uc;
1273 struct usb_gadget_strings **n_gs;
1274 unsigned n_gstrings = 0;
1278 for (i = 0; sp[i]; i++)
1282 return ERR_PTR(-EINVAL);
1284 uc = copy_gadget_strings(sp, n_gstrings, n_strings);
1286 return ERR_CAST(uc);
1288 n_gs = get_containers_gs(uc);
1289 ret = usb_string_ids_tab(cdev, n_gs[0]->strings);
1293 for (i = 1; i < n_gstrings; i++) {
1294 struct usb_string *m_s;
1295 struct usb_string *s;
1298 m_s = n_gs[0]->strings;
1299 s = n_gs[i]->strings;
1300 for (n = 0; n < n_strings; n++) {
1306 list_add_tail(&uc->list, &cdev->gstrings);
1307 return n_gs[0]->strings;
1310 return ERR_PTR(ret);
1312 EXPORT_SYMBOL_GPL(usb_gstrings_attach);
1315 * usb_string_ids_n() - allocate unused string IDs in batch
1316 * @c: the device whose string descriptor IDs are being allocated
1317 * @n: number of string IDs to allocate
1318 * Context: single threaded during gadget setup
1320 * Returns the first requested ID. This ID and next @n-1 IDs are now
1321 * valid IDs. At least provided that @n is non-zero because if it
1322 * is, returns last requested ID which is now very useful information.
1324 * @usb_string_ids_n() is called from bind() callbacks to allocate
1325 * string IDs. Drivers for functions, configurations, or gadgets will
1326 * then store that ID in the appropriate descriptors and string table.
1328 * All string identifier should be allocated using this,
1329 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1330 * example different functions don't wrongly assign different meanings
1331 * to the same identifier.
1333 int usb_string_ids_n(struct usb_composite_dev *c, unsigned n)
1335 unsigned next = c->next_string_id;
1336 if (unlikely(n > 254 || (unsigned)next + n > 254))
1338 c->next_string_id += n;
1341 EXPORT_SYMBOL_GPL(usb_string_ids_n);
1343 /*-------------------------------------------------------------------------*/
1345 static void composite_setup_complete(struct usb_ep *ep, struct usb_request *req)
1347 struct usb_composite_dev *cdev;
1349 if (req->status || req->actual != req->length)
1350 DBG((struct usb_composite_dev *) ep->driver_data,
1351 "setup complete --> %d, %d/%d\n",
1352 req->status, req->actual, req->length);
1355 * REVIST The same ep0 requests are shared with function drivers
1356 * so they don't have to maintain the same ->complete() stubs.
1358 * Because of that, we need to check for the validity of ->context
1359 * here, even though we know we've set it to something useful.
1364 cdev = req->context;
1366 if (cdev->req == req)
1367 cdev->setup_pending = false;
1368 else if (cdev->os_desc_req == req)
1369 cdev->os_desc_pending = false;
1371 WARN(1, "unknown request %p\n", req);
1374 static int composite_ep0_queue(struct usb_composite_dev *cdev,
1375 struct usb_request *req, gfp_t gfp_flags)
1379 ret = usb_ep_queue(cdev->gadget->ep0, req, gfp_flags);
1381 if (cdev->req == req)
1382 cdev->setup_pending = true;
1383 else if (cdev->os_desc_req == req)
1384 cdev->os_desc_pending = true;
1386 WARN(1, "unknown request %p\n", req);
1392 static int count_ext_compat(struct usb_configuration *c)
1397 for (i = 0; i < c->next_interface_id; ++i) {
1398 struct usb_function *f;
1401 f = c->interface[i];
1402 for (j = 0; j < f->os_desc_n; ++j) {
1403 struct usb_os_desc *d;
1405 if (i != f->os_desc_table[j].if_id)
1407 d = f->os_desc_table[j].os_desc;
1408 if (d && d->ext_compat_id)
1416 static void fill_ext_compat(struct usb_configuration *c, u8 *buf)
1421 for (i = 0; i < c->next_interface_id; ++i) {
1422 struct usb_function *f;
1425 f = c->interface[i];
1426 for (j = 0; j < f->os_desc_n; ++j) {
1427 struct usb_os_desc *d;
1429 if (i != f->os_desc_table[j].if_id)
1431 d = f->os_desc_table[j].os_desc;
1432 if (d && d->ext_compat_id) {
1435 memcpy(buf, d->ext_compat_id, 16);
1449 static int count_ext_prop(struct usb_configuration *c, int interface)
1451 struct usb_function *f;
1454 f = c->interface[interface];
1455 for (j = 0; j < f->os_desc_n; ++j) {
1456 struct usb_os_desc *d;
1458 if (interface != f->os_desc_table[j].if_id)
1460 d = f->os_desc_table[j].os_desc;
1461 if (d && d->ext_compat_id)
1462 return d->ext_prop_count;
1467 static int len_ext_prop(struct usb_configuration *c, int interface)
1469 struct usb_function *f;
1470 struct usb_os_desc *d;
1473 res = 10; /* header length */
1474 f = c->interface[interface];
1475 for (j = 0; j < f->os_desc_n; ++j) {
1476 if (interface != f->os_desc_table[j].if_id)
1478 d = f->os_desc_table[j].os_desc;
1480 return min(res + d->ext_prop_len, 4096);
1485 static int fill_ext_prop(struct usb_configuration *c, int interface, u8 *buf)
1487 struct usb_function *f;
1488 struct usb_os_desc *d;
1489 struct usb_os_desc_ext_prop *ext_prop;
1490 int j, count, n, ret;
1493 f = c->interface[interface];
1494 for (j = 0; j < f->os_desc_n; ++j) {
1495 if (interface != f->os_desc_table[j].if_id)
1497 d = f->os_desc_table[j].os_desc;
1499 list_for_each_entry(ext_prop, &d->ext_prop, entry) {
1500 /* 4kB minus header length */
1505 count = ext_prop->data_len +
1506 ext_prop->name_len + 14;
1507 if (count > 4086 - n)
1509 usb_ext_prop_put_size(buf, count);
1510 usb_ext_prop_put_type(buf, ext_prop->type);
1511 ret = usb_ext_prop_put_name(buf, ext_prop->name,
1512 ext_prop->name_len);
1515 switch (ext_prop->type) {
1516 case USB_EXT_PROP_UNICODE:
1517 case USB_EXT_PROP_UNICODE_ENV:
1518 case USB_EXT_PROP_UNICODE_LINK:
1519 usb_ext_prop_put_unicode(buf, ret,
1521 ext_prop->data_len);
1523 case USB_EXT_PROP_BINARY:
1524 usb_ext_prop_put_binary(buf, ret,
1526 ext_prop->data_len);
1528 case USB_EXT_PROP_LE32:
1529 /* not implemented */
1530 case USB_EXT_PROP_BE32:
1531 /* not implemented */
1543 * The setup() callback implements all the ep0 functionality that's
1544 * not handled lower down, in hardware or the hardware driver(like
1545 * device and endpoint feature flags, and their status). It's all
1546 * housekeeping for the gadget function we're implementing. Most of
1547 * the work is in config and function specific setup.
1550 composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
1552 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1553 struct usb_request *req = cdev->req;
1554 int value = -EOPNOTSUPP;
1556 u16 w_index = le16_to_cpu(ctrl->wIndex);
1557 u8 intf = w_index & 0xFF;
1558 u16 w_value = le16_to_cpu(ctrl->wValue);
1559 u16 w_length = le16_to_cpu(ctrl->wLength);
1560 struct usb_function *f = NULL;
1563 /* partial re-init of the response message; the function or the
1564 * gadget might need to intercept e.g. a control-OUT completion
1565 * when we delegate to it.
1568 req->context = cdev;
1569 req->complete = composite_setup_complete;
1571 gadget->ep0->driver_data = cdev;
1574 * Don't let non-standard requests match any of the cases below
1577 if ((ctrl->bRequestType & USB_TYPE_MASK) != USB_TYPE_STANDARD)
1580 switch (ctrl->bRequest) {
1582 /* we handle all standard USB descriptors */
1583 case USB_REQ_GET_DESCRIPTOR:
1584 if (ctrl->bRequestType != USB_DIR_IN)
1586 switch (w_value >> 8) {
1589 cdev->desc.bNumConfigurations =
1590 count_configs(cdev, USB_DT_DEVICE);
1591 cdev->desc.bMaxPacketSize0 =
1592 cdev->gadget->ep0->maxpacket;
1593 if (gadget_is_superspeed(gadget)) {
1594 if (gadget->speed >= USB_SPEED_SUPER) {
1595 cdev->desc.bcdUSB = cpu_to_le16(0x0310);
1596 cdev->desc.bMaxPacketSize0 = 9;
1598 cdev->desc.bcdUSB = cpu_to_le16(0x0210);
1601 cdev->desc.bcdUSB = cpu_to_le16(0x0200);
1604 value = min(w_length, (u16) sizeof cdev->desc);
1605 memcpy(req->buf, &cdev->desc, value);
1607 case USB_DT_DEVICE_QUALIFIER:
1608 if (!gadget_is_dualspeed(gadget) ||
1609 gadget->speed >= USB_SPEED_SUPER)
1612 value = min_t(int, w_length,
1613 sizeof(struct usb_qualifier_descriptor));
1615 case USB_DT_OTHER_SPEED_CONFIG:
1616 if (!gadget_is_dualspeed(gadget) ||
1617 gadget->speed >= USB_SPEED_SUPER)
1621 value = config_desc(cdev, w_value);
1623 value = min(w_length, (u16) value);
1626 value = get_string(cdev, req->buf,
1627 w_index, w_value & 0xff);
1629 value = min(w_length, (u16) value);
1632 if (gadget_is_superspeed(gadget)) {
1633 value = bos_desc(cdev);
1634 value = min(w_length, (u16) value);
1638 if (gadget_is_otg(gadget)) {
1639 struct usb_configuration *config;
1640 int otg_desc_len = 0;
1643 config = cdev->config;
1645 config = list_first_entry(
1647 struct usb_configuration, list);
1651 if (gadget->otg_caps &&
1652 (gadget->otg_caps->otg_rev >= 0x0200))
1653 otg_desc_len += sizeof(
1654 struct usb_otg20_descriptor);
1656 otg_desc_len += sizeof(
1657 struct usb_otg_descriptor);
1659 value = min_t(int, w_length, otg_desc_len);
1660 memcpy(req->buf, config->descriptors[0], value);
1666 /* any number of configs can work */
1667 case USB_REQ_SET_CONFIGURATION:
1668 if (ctrl->bRequestType != 0)
1670 if (gadget_is_otg(gadget)) {
1671 if (gadget->a_hnp_support)
1672 DBG(cdev, "HNP available\n");
1673 else if (gadget->a_alt_hnp_support)
1674 DBG(cdev, "HNP on another port\n");
1676 VDBG(cdev, "HNP inactive\n");
1678 spin_lock(&cdev->lock);
1679 value = set_config(cdev, ctrl, w_value);
1680 spin_unlock(&cdev->lock);
1682 case USB_REQ_GET_CONFIGURATION:
1683 if (ctrl->bRequestType != USB_DIR_IN)
1686 *(u8 *)req->buf = cdev->config->bConfigurationValue;
1688 *(u8 *)req->buf = 0;
1689 value = min(w_length, (u16) 1);
1692 /* function drivers must handle get/set altsetting; if there's
1693 * no get() method, we know only altsetting zero works.
1695 case USB_REQ_SET_INTERFACE:
1696 if (ctrl->bRequestType != USB_RECIP_INTERFACE)
1698 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1700 f = cdev->config->interface[intf];
1703 if (w_value && !f->set_alt)
1705 value = f->set_alt(f, w_index, w_value);
1706 if (value == USB_GADGET_DELAYED_STATUS) {
1708 "%s: interface %d (%s) requested delayed status\n",
1709 __func__, intf, f->name);
1710 cdev->delayed_status++;
1711 DBG(cdev, "delayed_status count %d\n",
1712 cdev->delayed_status);
1715 case USB_REQ_GET_INTERFACE:
1716 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE))
1718 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1720 f = cdev->config->interface[intf];
1723 /* lots of interfaces only need altsetting zero... */
1724 value = f->get_alt ? f->get_alt(f, w_index) : 0;
1727 *((u8 *)req->buf) = value;
1728 value = min(w_length, (u16) 1);
1730 case USB_REQ_GET_STATUS:
1731 if (gadget_is_otg(gadget) && gadget->hnp_polling_support &&
1732 (w_index == OTG_STS_SELECTOR)) {
1733 if (ctrl->bRequestType != (USB_DIR_IN |
1736 *((u8 *)req->buf) = gadget->host_request_flag;
1742 * USB 3.0 additions:
1743 * Function driver should handle get_status request. If such cb
1744 * wasn't supplied we respond with default value = 0
1745 * Note: function driver should supply such cb only for the
1746 * first interface of the function
1748 if (!gadget_is_superspeed(gadget))
1750 if (ctrl->bRequestType != (USB_DIR_IN | USB_RECIP_INTERFACE))
1752 value = 2; /* This is the length of the get_status reply */
1753 put_unaligned_le16(0, req->buf);
1754 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1756 f = cdev->config->interface[intf];
1759 status = f->get_status ? f->get_status(f) : 0;
1762 put_unaligned_le16(status & 0x0000ffff, req->buf);
1765 * Function drivers should handle SetFeature/ClearFeature
1766 * (FUNCTION_SUSPEND) request. function_suspend cb should be supplied
1767 * only for the first interface of the function
1769 case USB_REQ_CLEAR_FEATURE:
1770 case USB_REQ_SET_FEATURE:
1771 if (!gadget_is_superspeed(gadget))
1773 if (ctrl->bRequestType != (USB_DIR_OUT | USB_RECIP_INTERFACE))
1776 case USB_INTRF_FUNC_SUSPEND:
1777 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1779 f = cdev->config->interface[intf];
1783 if (f->func_suspend)
1784 value = f->func_suspend(f, w_index >> 8);
1787 "func_suspend() returned error %d\n",
1797 * OS descriptors handling
1799 if (cdev->use_os_string && cdev->os_desc_config &&
1800 (ctrl->bRequestType & USB_TYPE_VENDOR) &&
1801 ctrl->bRequest == cdev->b_vendor_code) {
1802 struct usb_request *req;
1803 struct usb_configuration *os_desc_cfg;
1808 req = cdev->os_desc_req;
1809 req->context = cdev;
1810 req->complete = composite_setup_complete;
1812 os_desc_cfg = cdev->os_desc_config;
1813 memset(buf, 0, w_length);
1815 switch (ctrl->bRequestType & USB_RECIP_MASK) {
1816 case USB_RECIP_DEVICE:
1817 if (w_index != 0x4 || (w_value >> 8))
1820 if (w_length == 0x10) {
1821 /* Number of ext compat interfaces */
1822 count = count_ext_compat(os_desc_cfg);
1824 count *= 24; /* 24 B/ext compat desc */
1825 count += 16; /* header */
1826 put_unaligned_le32(count, buf);
1829 /* "extended compatibility ID"s */
1830 count = count_ext_compat(os_desc_cfg);
1832 count *= 24; /* 24 B/ext compat desc */
1833 count += 16; /* header */
1834 put_unaligned_le32(count, buf);
1836 fill_ext_compat(os_desc_cfg, buf);
1840 case USB_RECIP_INTERFACE:
1841 if (w_index != 0x5 || (w_value >> 8))
1843 interface = w_value & 0xFF;
1845 if (w_length == 0x0A) {
1846 count = count_ext_prop(os_desc_cfg,
1848 put_unaligned_le16(count, buf + 8);
1849 count = len_ext_prop(os_desc_cfg,
1851 put_unaligned_le32(count, buf);
1855 count = count_ext_prop(os_desc_cfg,
1857 put_unaligned_le16(count, buf + 8);
1858 count = len_ext_prop(os_desc_cfg,
1860 put_unaligned_le32(count, buf);
1862 value = fill_ext_prop(os_desc_cfg,
1873 req->length = value;
1874 req->context = cdev;
1875 req->zero = value < w_length;
1876 value = composite_ep0_queue(cdev, req,
1879 DBG(cdev, "ep_queue --> %d\n", value);
1881 composite_setup_complete(gadget->ep0,
1889 "non-core control req%02x.%02x v%04x i%04x l%d\n",
1890 ctrl->bRequestType, ctrl->bRequest,
1891 w_value, w_index, w_length);
1893 /* functions always handle their interfaces and endpoints...
1894 * punt other recipients (other, WUSB, ...) to the current
1895 * configuration code.
1897 * REVISIT it could make sense to let the composite device
1898 * take such requests too, if that's ever needed: to work
1902 list_for_each_entry(f, &cdev->config->functions, list)
1903 if (f->req_match && f->req_match(f, ctrl))
1908 switch (ctrl->bRequestType & USB_RECIP_MASK) {
1909 case USB_RECIP_INTERFACE:
1910 if (!cdev->config || intf >= MAX_CONFIG_INTERFACES)
1912 f = cdev->config->interface[intf];
1915 case USB_RECIP_ENDPOINT:
1918 endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f);
1919 list_for_each_entry(f, &cdev->config->functions, list) {
1920 if (test_bit(endp, f->endpoints))
1923 if (&f->list == &cdev->config->functions)
1929 value = f->setup(f, ctrl);
1931 struct usb_configuration *c;
1937 /* try current config's setup */
1939 value = c->setup(c, ctrl);
1943 /* try the only function in the current config */
1944 if (!list_is_singular(&c->functions))
1946 f = list_first_entry(&c->functions, struct usb_function,
1949 value = f->setup(f, ctrl);
1955 /* respond with data transfer before status phase? */
1956 if (value >= 0 && value != USB_GADGET_DELAYED_STATUS) {
1957 req->length = value;
1958 req->context = cdev;
1959 req->zero = value < w_length;
1960 value = composite_ep0_queue(cdev, req, GFP_ATOMIC);
1962 DBG(cdev, "ep_queue --> %d\n", value);
1964 composite_setup_complete(gadget->ep0, req);
1966 } else if (value == USB_GADGET_DELAYED_STATUS && w_length != 0) {
1968 "%s: Delayed status not supported for w_length != 0",
1973 /* device either stalls (value < 0) or reports success */
1977 void composite_disconnect(struct usb_gadget *gadget)
1979 struct usb_composite_dev *cdev = get_gadget_data(gadget);
1980 unsigned long flags;
1982 /* REVISIT: should we have config and device level
1983 * disconnect callbacks?
1985 spin_lock_irqsave(&cdev->lock, flags);
1988 if (cdev->driver->disconnect)
1989 cdev->driver->disconnect(cdev);
1990 spin_unlock_irqrestore(&cdev->lock, flags);
1993 /*-------------------------------------------------------------------------*/
1995 static ssize_t suspended_show(struct device *dev, struct device_attribute *attr,
1998 struct usb_gadget *gadget = dev_to_usb_gadget(dev);
1999 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2001 return sprintf(buf, "%d\n", cdev->suspended);
2003 static DEVICE_ATTR_RO(suspended);
2005 static void __composite_unbind(struct usb_gadget *gadget, bool unbind_driver)
2007 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2009 /* composite_disconnect() must already have been called
2010 * by the underlying peripheral controller driver!
2011 * so there's no i/o concurrency that could affect the
2012 * state protected by cdev->lock.
2014 WARN_ON(cdev->config);
2016 while (!list_empty(&cdev->configs)) {
2017 struct usb_configuration *c;
2018 c = list_first_entry(&cdev->configs,
2019 struct usb_configuration, list);
2020 remove_config(cdev, c);
2022 if (cdev->driver->unbind && unbind_driver)
2023 cdev->driver->unbind(cdev);
2025 composite_dev_cleanup(cdev);
2027 kfree(cdev->def_manufacturer);
2029 set_gadget_data(gadget, NULL);
2032 static void composite_unbind(struct usb_gadget *gadget)
2034 __composite_unbind(gadget, true);
2037 static void update_unchanged_dev_desc(struct usb_device_descriptor *new,
2038 const struct usb_device_descriptor *old)
2048 * these variables may have been set in
2049 * usb_composite_overwrite_options()
2051 idVendor = new->idVendor;
2052 idProduct = new->idProduct;
2053 bcdDevice = new->bcdDevice;
2054 iSerialNumber = new->iSerialNumber;
2055 iManufacturer = new->iManufacturer;
2056 iProduct = new->iProduct;
2060 new->idVendor = idVendor;
2062 new->idProduct = idProduct;
2064 new->bcdDevice = bcdDevice;
2066 new->bcdDevice = cpu_to_le16(get_default_bcdDevice());
2068 new->iSerialNumber = iSerialNumber;
2070 new->iManufacturer = iManufacturer;
2072 new->iProduct = iProduct;
2075 int composite_dev_prepare(struct usb_composite_driver *composite,
2076 struct usb_composite_dev *cdev)
2078 struct usb_gadget *gadget = cdev->gadget;
2081 /* preallocate control response and buffer */
2082 cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL);
2086 cdev->req->buf = kmalloc(USB_COMP_EP0_BUFSIZ, GFP_KERNEL);
2087 if (!cdev->req->buf)
2090 ret = device_create_file(&gadget->dev, &dev_attr_suspended);
2094 cdev->req->complete = composite_setup_complete;
2095 cdev->req->context = cdev;
2096 gadget->ep0->driver_data = cdev;
2098 cdev->driver = composite;
2101 * As per USB compliance update, a device that is actively drawing
2102 * more than 100mA from USB must report itself as bus-powered in
2103 * the GetStatus(DEVICE) call.
2105 if (CONFIG_USB_GADGET_VBUS_DRAW <= USB_SELF_POWER_VBUS_MAX_DRAW)
2106 usb_gadget_set_selfpowered(gadget);
2108 /* interface and string IDs start at zero via kzalloc.
2109 * we force endpoints to start unassigned; few controller
2110 * drivers will zero ep->driver_data.
2112 usb_ep_autoconfig_reset(gadget);
2115 kfree(cdev->req->buf);
2117 usb_ep_free_request(gadget->ep0, cdev->req);
2122 int composite_os_desc_req_prepare(struct usb_composite_dev *cdev,
2127 cdev->os_desc_req = usb_ep_alloc_request(ep0, GFP_KERNEL);
2128 if (!cdev->os_desc_req) {
2133 /* OS feature descriptor length <= 4kB */
2134 cdev->os_desc_req->buf = kmalloc(4096, GFP_KERNEL);
2135 if (!cdev->os_desc_req->buf) {
2137 kfree(cdev->os_desc_req);
2140 cdev->os_desc_req->context = cdev;
2141 cdev->os_desc_req->complete = composite_setup_complete;
2146 void composite_dev_cleanup(struct usb_composite_dev *cdev)
2148 struct usb_gadget_string_container *uc, *tmp;
2150 list_for_each_entry_safe(uc, tmp, &cdev->gstrings, list) {
2151 list_del(&uc->list);
2154 if (cdev->os_desc_req) {
2155 if (cdev->os_desc_pending)
2156 usb_ep_dequeue(cdev->gadget->ep0, cdev->os_desc_req);
2158 kfree(cdev->os_desc_req->buf);
2159 usb_ep_free_request(cdev->gadget->ep0, cdev->os_desc_req);
2162 if (cdev->setup_pending)
2163 usb_ep_dequeue(cdev->gadget->ep0, cdev->req);
2165 kfree(cdev->req->buf);
2166 usb_ep_free_request(cdev->gadget->ep0, cdev->req);
2168 cdev->next_string_id = 0;
2169 device_remove_file(&cdev->gadget->dev, &dev_attr_suspended);
2172 static int composite_bind(struct usb_gadget *gadget,
2173 struct usb_gadget_driver *gdriver)
2175 struct usb_composite_dev *cdev;
2176 struct usb_composite_driver *composite = to_cdriver(gdriver);
2177 int status = -ENOMEM;
2179 cdev = kzalloc(sizeof *cdev, GFP_KERNEL);
2183 spin_lock_init(&cdev->lock);
2184 cdev->gadget = gadget;
2185 set_gadget_data(gadget, cdev);
2186 INIT_LIST_HEAD(&cdev->configs);
2187 INIT_LIST_HEAD(&cdev->gstrings);
2189 status = composite_dev_prepare(composite, cdev);
2193 /* composite gadget needs to assign strings for whole device (like
2194 * serial number), register function drivers, potentially update
2195 * power state and consumption, etc
2197 status = composite->bind(cdev);
2201 if (cdev->use_os_string) {
2202 status = composite_os_desc_req_prepare(cdev, gadget->ep0);
2207 update_unchanged_dev_desc(&cdev->desc, composite->dev);
2209 /* has userspace failed to provide a serial number? */
2210 if (composite->needs_serial && !cdev->desc.iSerialNumber)
2211 WARNING(cdev, "userspace failed to provide iSerialNumber\n");
2213 INFO(cdev, "%s ready\n", composite->name);
2217 __composite_unbind(gadget, false);
2221 /*-------------------------------------------------------------------------*/
2223 void composite_suspend(struct usb_gadget *gadget)
2225 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2226 struct usb_function *f;
2228 /* REVISIT: should we have config level
2229 * suspend/resume callbacks?
2231 DBG(cdev, "suspend\n");
2233 list_for_each_entry(f, &cdev->config->functions, list) {
2238 if (cdev->driver->suspend)
2239 cdev->driver->suspend(cdev);
2241 cdev->suspended = 1;
2243 usb_gadget_vbus_draw(gadget, 2);
2246 void composite_resume(struct usb_gadget *gadget)
2248 struct usb_composite_dev *cdev = get_gadget_data(gadget);
2249 struct usb_function *f;
2252 /* REVISIT: should we have config level
2253 * suspend/resume callbacks?
2255 DBG(cdev, "resume\n");
2256 if (cdev->driver->resume)
2257 cdev->driver->resume(cdev);
2259 list_for_each_entry(f, &cdev->config->functions, list) {
2264 maxpower = cdev->config->MaxPower;
2266 usb_gadget_vbus_draw(gadget, maxpower ?
2267 maxpower : CONFIG_USB_GADGET_VBUS_DRAW);
2270 cdev->suspended = 0;
2273 /*-------------------------------------------------------------------------*/
2275 static const struct usb_gadget_driver composite_driver_template = {
2276 .bind = composite_bind,
2277 .unbind = composite_unbind,
2279 .setup = composite_setup,
2280 .reset = composite_disconnect,
2281 .disconnect = composite_disconnect,
2283 .suspend = composite_suspend,
2284 .resume = composite_resume,
2287 .owner = THIS_MODULE,
2292 * usb_composite_probe() - register a composite driver
2293 * @driver: the driver to register
2295 * Context: single threaded during gadget setup
2297 * This function is used to register drivers using the composite driver
2298 * framework. The return value is zero, or a negative errno value.
2299 * Those values normally come from the driver's @bind method, which does
2300 * all the work of setting up the driver to match the hardware.
2302 * On successful return, the gadget is ready to respond to requests from
2303 * the host, unless one of its components invokes usb_gadget_disconnect()
2304 * while it was binding. That would usually be done in order to wait for
2305 * some userspace participation.
2307 int usb_composite_probe(struct usb_composite_driver *driver)
2309 struct usb_gadget_driver *gadget_driver;
2311 if (!driver || !driver->dev || !driver->bind)
2315 driver->name = "composite";
2317 driver->gadget_driver = composite_driver_template;
2318 gadget_driver = &driver->gadget_driver;
2320 gadget_driver->function = (char *) driver->name;
2321 gadget_driver->driver.name = driver->name;
2322 gadget_driver->max_speed = driver->max_speed;
2324 return usb_gadget_probe_driver(gadget_driver);
2326 EXPORT_SYMBOL_GPL(usb_composite_probe);
2329 * usb_composite_unregister() - unregister a composite driver
2330 * @driver: the driver to unregister
2332 * This function is used to unregister drivers using the composite
2335 void usb_composite_unregister(struct usb_composite_driver *driver)
2337 usb_gadget_unregister_driver(&driver->gadget_driver);
2339 EXPORT_SYMBOL_GPL(usb_composite_unregister);
2342 * usb_composite_setup_continue() - Continue with the control transfer
2343 * @cdev: the composite device who's control transfer was kept waiting
2345 * This function must be called by the USB function driver to continue
2346 * with the control transfer's data/status stage in case it had requested to
2347 * delay the data/status stages. A USB function's setup handler (e.g. set_alt())
2348 * can request the composite framework to delay the setup request's data/status
2349 * stages by returning USB_GADGET_DELAYED_STATUS.
2351 void usb_composite_setup_continue(struct usb_composite_dev *cdev)
2354 struct usb_request *req = cdev->req;
2355 unsigned long flags;
2357 DBG(cdev, "%s\n", __func__);
2358 spin_lock_irqsave(&cdev->lock, flags);
2360 if (cdev->delayed_status == 0) {
2361 WARN(cdev, "%s: Unexpected call\n", __func__);
2363 } else if (--cdev->delayed_status == 0) {
2364 DBG(cdev, "%s: Completing delayed status\n", __func__);
2366 req->context = cdev;
2367 value = composite_ep0_queue(cdev, req, GFP_ATOMIC);
2369 DBG(cdev, "ep_queue --> %d\n", value);
2371 composite_setup_complete(cdev->gadget->ep0, req);
2375 spin_unlock_irqrestore(&cdev->lock, flags);
2377 EXPORT_SYMBOL_GPL(usb_composite_setup_continue);
2379 static char *composite_default_mfr(struct usb_gadget *gadget)
2384 len = snprintf(NULL, 0, "%s %s with %s", init_utsname()->sysname,
2385 init_utsname()->release, gadget->name);
2387 mfr = kmalloc(len, GFP_KERNEL);
2390 snprintf(mfr, len, "%s %s with %s", init_utsname()->sysname,
2391 init_utsname()->release, gadget->name);
2395 void usb_composite_overwrite_options(struct usb_composite_dev *cdev,
2396 struct usb_composite_overwrite *covr)
2398 struct usb_device_descriptor *desc = &cdev->desc;
2399 struct usb_gadget_strings *gstr = cdev->driver->strings[0];
2400 struct usb_string *dev_str = gstr->strings;
2403 desc->idVendor = cpu_to_le16(covr->idVendor);
2405 if (covr->idProduct)
2406 desc->idProduct = cpu_to_le16(covr->idProduct);
2408 if (covr->bcdDevice)
2409 desc->bcdDevice = cpu_to_le16(covr->bcdDevice);
2411 if (covr->serial_number) {
2412 desc->iSerialNumber = dev_str[USB_GADGET_SERIAL_IDX].id;
2413 dev_str[USB_GADGET_SERIAL_IDX].s = covr->serial_number;
2415 if (covr->manufacturer) {
2416 desc->iManufacturer = dev_str[USB_GADGET_MANUFACTURER_IDX].id;
2417 dev_str[USB_GADGET_MANUFACTURER_IDX].s = covr->manufacturer;
2419 } else if (!strlen(dev_str[USB_GADGET_MANUFACTURER_IDX].s)) {
2420 desc->iManufacturer = dev_str[USB_GADGET_MANUFACTURER_IDX].id;
2421 cdev->def_manufacturer = composite_default_mfr(cdev->gadget);
2422 dev_str[USB_GADGET_MANUFACTURER_IDX].s = cdev->def_manufacturer;
2425 if (covr->product) {
2426 desc->iProduct = dev_str[USB_GADGET_PRODUCT_IDX].id;
2427 dev_str[USB_GADGET_PRODUCT_IDX].s = covr->product;
2430 EXPORT_SYMBOL_GPL(usb_composite_overwrite_options);
2432 MODULE_LICENSE("GPL");
2433 MODULE_AUTHOR("David Brownell");