1 // SPDX-License-Identifier: GPL-2.0+
3 * composite.c - infrastructure for Composite USB Gadgets
5 * Copyright (C) 2006-2008 David Brownell
8 /* #define VERBOSE_DEBUG */
10 #include <linux/kallsyms.h>
11 #include <linux/kernel.h>
12 #include <linux/slab.h>
13 #include <linux/module.h>
14 #include <linux/device.h>
15 #include <linux/utsname.h>
17 #include <linux/usb/composite.h>
18 #include <linux/usb/otg.h>
19 #include <asm/unaligned.h>
21 #include "u_os_desc.h"
24 * struct usb_os_string - represents OS String to be reported by a gadget
25 * @bLength: total length of the entire descritor, always 0x12
26 * @bDescriptorType: USB_DT_STRING
27 * @qwSignature: the OS String proper
28 * @bMS_VendorCode: code used by the host for subsequent requests
29 * @bPad: not used, must be zero
31 struct usb_os_string
{
34 __u8 qwSignature
[OS_STRING_QW_SIGN_LEN
];
40 * The code in this file is utility code, used to build a gadget driver
41 * from one or more "function" drivers, one or more "configuration"
42 * objects, and a "usb_composite_driver" by gluing them together along
43 * with the relevant device-wide data.
46 static struct usb_gadget_strings
**get_containers_gs(
47 struct usb_gadget_string_container
*uc
)
49 return (struct usb_gadget_strings
**)uc
->stash
;
53 * function_descriptors() - get function descriptors for speed
57 * Returns the descriptors or NULL if not set.
59 static struct usb_descriptor_header
**
60 function_descriptors(struct usb_function
*f
,
61 enum usb_device_speed speed
)
63 struct usb_descriptor_header
**descriptors
;
66 * NOTE: we try to help gadget drivers which might not be setting
67 * max_speed appropriately.
71 case USB_SPEED_SUPER_PLUS
:
72 descriptors
= f
->ssp_descriptors
;
77 descriptors
= f
->ss_descriptors
;
82 descriptors
= f
->hs_descriptors
;
87 descriptors
= f
->fs_descriptors
;
91 * if we can't find any descriptors at all, then this gadget deserves to
92 * Oops with a NULL pointer dereference
99 * next_ep_desc() - advance to the next EP descriptor
100 * @t: currect pointer within descriptor array
102 * Return: next EP descriptor or NULL
104 * Iterate over @t until either EP descriptor found or
105 * NULL (that indicates end of list) encountered
107 static struct usb_descriptor_header
**
108 next_ep_desc(struct usb_descriptor_header
**t
)
111 if ((*t
)->bDescriptorType
== USB_DT_ENDPOINT
)
118 * for_each_ep_desc()- iterate over endpoint descriptors in the
120 * @start: pointer within descriptor array.
121 * @ep_desc: endpoint descriptor to use as the loop cursor
123 #define for_each_ep_desc(start, ep_desc) \
124 for (ep_desc = next_ep_desc(start); \
125 ep_desc; ep_desc = next_ep_desc(ep_desc+1))
128 * config_ep_by_speed() - configures the given endpoint
129 * according to gadget speed.
130 * @g: pointer to the gadget
132 * @_ep: the endpoint to configure
134 * Return: error code, 0 on success
136 * This function chooses the right descriptors for a given
137 * endpoint according to gadget speed and saves it in the
138 * endpoint desc field. If the endpoint already has a descriptor
139 * assigned to it - overwrites it with currently corresponding
140 * descriptor. The endpoint maxpacket field is updated according
141 * to the chosen descriptor.
142 * Note: the supplied function should hold all the descriptors
143 * for supported speeds
145 int config_ep_by_speed(struct usb_gadget
*g
,
146 struct usb_function
*f
,
149 struct usb_endpoint_descriptor
*chosen_desc
= NULL
;
150 struct usb_descriptor_header
**speed_desc
= NULL
;
152 struct usb_ss_ep_comp_descriptor
*comp_desc
= NULL
;
153 int want_comp_desc
= 0;
155 struct usb_descriptor_header
**d_spd
; /* cursor for speed desc */
157 if (!g
|| !f
|| !_ep
)
160 /* select desired speed */
162 case USB_SPEED_SUPER_PLUS
:
163 if (gadget_is_superspeed_plus(g
)) {
164 speed_desc
= f
->ssp_descriptors
;
169 case USB_SPEED_SUPER
:
170 if (gadget_is_superspeed(g
)) {
171 speed_desc
= f
->ss_descriptors
;
177 if (gadget_is_dualspeed(g
)) {
178 speed_desc
= f
->hs_descriptors
;
183 speed_desc
= f
->fs_descriptors
;
185 /* find descriptors */
186 for_each_ep_desc(speed_desc
, d_spd
) {
187 chosen_desc
= (struct usb_endpoint_descriptor
*)*d_spd
;
188 if (chosen_desc
->bEndpointAddress
== _ep
->address
)
195 _ep
->maxpacket
= usb_endpoint_maxp(chosen_desc
);
196 _ep
->desc
= chosen_desc
;
197 _ep
->comp_desc
= NULL
;
201 if (g
->speed
== USB_SPEED_HIGH
&& (usb_endpoint_xfer_isoc(_ep
->desc
) ||
202 usb_endpoint_xfer_int(_ep
->desc
)))
203 _ep
->mult
= usb_endpoint_maxp_mult(_ep
->desc
);
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) + 1;
223 case USB_ENDPOINT_XFER_BULK
:
224 case USB_ENDPOINT_XFER_INT
:
225 _ep
->maxburst
= comp_desc
->bMaxBurst
+ 1;
228 if (comp_desc
->bMaxBurst
!= 0) {
229 struct usb_composite_dev
*cdev
;
231 cdev
= get_gadget_data(g
);
232 ERROR(cdev
, "ep0 bMaxBurst must be 0\n");
240 EXPORT_SYMBOL_GPL(config_ep_by_speed
);
243 * usb_add_function() - add a function to a configuration
244 * @config: the configuration
245 * @function: the function being added
246 * Context: single threaded during gadget setup
248 * After initialization, each configuration must have one or more
249 * functions added to it. Adding a function involves calling its @bind()
250 * method to allocate resources such as interface and string identifiers
253 * This function returns the value of the function's bind(), which is
254 * zero for success else a negative errno value.
256 int usb_add_function(struct usb_configuration
*config
,
257 struct usb_function
*function
)
261 DBG(config
->cdev
, "adding '%s'/%p to config '%s'/%p\n",
262 function
->name
, function
,
263 config
->label
, config
);
265 if (!function
->set_alt
|| !function
->disable
)
268 function
->config
= config
;
269 list_add_tail(&function
->list
, &config
->functions
);
271 if (function
->bind_deactivated
) {
272 value
= usb_function_deactivate(function
);
277 /* REVISIT *require* function->bind? */
278 if (function
->bind
) {
279 value
= function
->bind(config
, function
);
281 list_del(&function
->list
);
282 function
->config
= NULL
;
287 /* We allow configurations that don't work at both speeds.
288 * If we run into a lowspeed Linux system, treat it the same
289 * as full speed ... it's the function drivers that will need
290 * to avoid bulk and ISO transfers.
292 if (!config
->fullspeed
&& function
->fs_descriptors
)
293 config
->fullspeed
= true;
294 if (!config
->highspeed
&& function
->hs_descriptors
)
295 config
->highspeed
= true;
296 if (!config
->superspeed
&& function
->ss_descriptors
)
297 config
->superspeed
= true;
298 if (!config
->superspeed_plus
&& function
->ssp_descriptors
)
299 config
->superspeed_plus
= true;
303 DBG(config
->cdev
, "adding '%s'/%p --> %d\n",
304 function
->name
, function
, value
);
307 EXPORT_SYMBOL_GPL(usb_add_function
);
309 void usb_remove_function(struct usb_configuration
*c
, struct usb_function
*f
)
314 bitmap_zero(f
->endpoints
, 32);
319 if (f
->bind_deactivated
)
320 usb_function_activate(f
);
322 EXPORT_SYMBOL_GPL(usb_remove_function
);
325 * usb_function_deactivate - prevent function and gadget enumeration
326 * @function: the function that isn't yet ready to respond
328 * Blocks response of the gadget driver to host enumeration by
329 * preventing the data line pullup from being activated. This is
330 * normally called during @bind() processing to change from the
331 * initial "ready to respond" state, or when a required resource
334 * For example, drivers that serve as a passthrough to a userspace
335 * daemon can block enumeration unless that daemon (such as an OBEX,
336 * MTP, or print server) is ready to handle host requests.
338 * Not all systems support software control of their USB peripheral
341 * Returns zero on success, else negative errno.
343 int usb_function_deactivate(struct usb_function
*function
)
345 struct usb_composite_dev
*cdev
= function
->config
->cdev
;
349 spin_lock_irqsave(&cdev
->lock
, flags
);
351 if (cdev
->deactivations
== 0)
352 status
= usb_gadget_deactivate(cdev
->gadget
);
354 cdev
->deactivations
++;
356 spin_unlock_irqrestore(&cdev
->lock
, flags
);
359 EXPORT_SYMBOL_GPL(usb_function_deactivate
);
362 * usb_function_activate - allow function and gadget enumeration
363 * @function: function on which usb_function_activate() was called
365 * Reverses effect of usb_function_deactivate(). If no more functions
366 * are delaying their activation, the gadget driver will respond to
367 * host enumeration procedures.
369 * Returns zero on success, else negative errno.
371 int usb_function_activate(struct usb_function
*function
)
373 struct usb_composite_dev
*cdev
= function
->config
->cdev
;
377 spin_lock_irqsave(&cdev
->lock
, flags
);
379 if (WARN_ON(cdev
->deactivations
== 0))
382 cdev
->deactivations
--;
383 if (cdev
->deactivations
== 0)
384 status
= usb_gadget_activate(cdev
->gadget
);
387 spin_unlock_irqrestore(&cdev
->lock
, flags
);
390 EXPORT_SYMBOL_GPL(usb_function_activate
);
393 * usb_interface_id() - allocate an unused interface ID
394 * @config: configuration associated with the interface
395 * @function: function handling the interface
396 * Context: single threaded during gadget setup
398 * usb_interface_id() is called from usb_function.bind() callbacks to
399 * allocate new interface IDs. The function driver will then store that
400 * ID in interface, association, CDC union, and other descriptors. It
401 * will also handle any control requests targeted at that interface,
402 * particularly changing its altsetting via set_alt(). There may
403 * also be class-specific or vendor-specific requests to handle.
405 * All interface identifier should be allocated using this routine, to
406 * ensure that for example different functions don't wrongly assign
407 * different meanings to the same identifier. Note that since interface
408 * identifiers are configuration-specific, functions used in more than
409 * one configuration (or more than once in a given configuration) need
410 * multiple versions of the relevant descriptors.
412 * Returns the interface ID which was allocated; or -ENODEV if no
413 * more interface IDs can be allocated.
415 int usb_interface_id(struct usb_configuration
*config
,
416 struct usb_function
*function
)
418 unsigned id
= config
->next_interface_id
;
420 if (id
< MAX_CONFIG_INTERFACES
) {
421 config
->interface
[id
] = function
;
422 config
->next_interface_id
= id
+ 1;
427 EXPORT_SYMBOL_GPL(usb_interface_id
);
429 static u8
encode_bMaxPower(enum usb_device_speed speed
,
430 struct usb_configuration
*c
)
437 val
= CONFIG_USB_GADGET_VBUS_DRAW
;
441 case USB_SPEED_SUPER
:
442 return DIV_ROUND_UP(val
, 8);
444 return DIV_ROUND_UP(val
, 2);
448 static int config_buf(struct usb_configuration
*config
,
449 enum usb_device_speed speed
, void *buf
, u8 type
)
451 struct usb_config_descriptor
*c
= buf
;
452 void *next
= buf
+ USB_DT_CONFIG_SIZE
;
454 struct usb_function
*f
;
457 len
= USB_COMP_EP0_BUFSIZ
- USB_DT_CONFIG_SIZE
;
458 /* write the config descriptor */
460 c
->bLength
= USB_DT_CONFIG_SIZE
;
461 c
->bDescriptorType
= type
;
462 /* wTotalLength is written later */
463 c
->bNumInterfaces
= config
->next_interface_id
;
464 c
->bConfigurationValue
= config
->bConfigurationValue
;
465 c
->iConfiguration
= config
->iConfiguration
;
466 c
->bmAttributes
= USB_CONFIG_ATT_ONE
| config
->bmAttributes
;
467 c
->bMaxPower
= encode_bMaxPower(speed
, config
);
469 /* There may be e.g. OTG descriptors */
470 if (config
->descriptors
) {
471 status
= usb_descriptor_fillbuf(next
, len
,
472 config
->descriptors
);
479 /* add each function's descriptors */
480 list_for_each_entry(f
, &config
->functions
, list
) {
481 struct usb_descriptor_header
**descriptors
;
483 descriptors
= function_descriptors(f
, speed
);
486 status
= usb_descriptor_fillbuf(next
, len
,
487 (const struct usb_descriptor_header
**) descriptors
);
495 c
->wTotalLength
= cpu_to_le16(len
);
499 static int config_desc(struct usb_composite_dev
*cdev
, unsigned w_value
)
501 struct usb_gadget
*gadget
= cdev
->gadget
;
502 struct usb_configuration
*c
;
503 struct list_head
*pos
;
504 u8 type
= w_value
>> 8;
505 enum usb_device_speed speed
= USB_SPEED_UNKNOWN
;
507 if (gadget
->speed
>= USB_SPEED_SUPER
)
508 speed
= gadget
->speed
;
509 else if (gadget_is_dualspeed(gadget
)) {
511 if (gadget
->speed
== USB_SPEED_HIGH
)
513 if (type
== USB_DT_OTHER_SPEED_CONFIG
)
516 speed
= USB_SPEED_HIGH
;
520 /* This is a lookup by config *INDEX* */
523 pos
= &cdev
->configs
;
524 c
= cdev
->os_desc_config
;
528 while ((pos
= pos
->next
) != &cdev
->configs
) {
529 c
= list_entry(pos
, typeof(*c
), list
);
531 /* skip OS Descriptors config which is handled separately */
532 if (c
== cdev
->os_desc_config
)
536 /* ignore configs that won't work at this speed */
538 case USB_SPEED_SUPER_PLUS
:
539 if (!c
->superspeed_plus
)
542 case USB_SPEED_SUPER
:
556 return config_buf(c
, speed
, cdev
->req
->buf
, type
);
562 static int count_configs(struct usb_composite_dev
*cdev
, unsigned type
)
564 struct usb_gadget
*gadget
= cdev
->gadget
;
565 struct usb_configuration
*c
;
571 if (gadget_is_dualspeed(gadget
)) {
572 if (gadget
->speed
== USB_SPEED_HIGH
)
574 if (gadget
->speed
== USB_SPEED_SUPER
)
576 if (gadget
->speed
== USB_SPEED_SUPER_PLUS
)
578 if (type
== USB_DT_DEVICE_QUALIFIER
)
581 list_for_each_entry(c
, &cdev
->configs
, list
) {
582 /* ignore configs that won't work at this speed */
584 if (!c
->superspeed_plus
)
602 * bos_desc() - prepares the BOS descriptor.
603 * @cdev: pointer to usb_composite device to generate the bos
606 * This function generates the BOS (Binary Device Object)
607 * descriptor and its device capabilities descriptors. The BOS
608 * descriptor should be supported by a SuperSpeed device.
610 static int bos_desc(struct usb_composite_dev
*cdev
)
612 struct usb_ext_cap_descriptor
*usb_ext
;
613 struct usb_dcd_config_params dcd_config_params
;
614 struct usb_bos_descriptor
*bos
= cdev
->req
->buf
;
616 bos
->bLength
= USB_DT_BOS_SIZE
;
617 bos
->bDescriptorType
= USB_DT_BOS
;
619 bos
->wTotalLength
= cpu_to_le16(USB_DT_BOS_SIZE
);
620 bos
->bNumDeviceCaps
= 0;
623 * A SuperSpeed device shall include the USB2.0 extension descriptor
624 * and shall support LPM when operating in USB2.0 HS mode.
626 usb_ext
= cdev
->req
->buf
+ le16_to_cpu(bos
->wTotalLength
);
627 bos
->bNumDeviceCaps
++;
628 le16_add_cpu(&bos
->wTotalLength
, USB_DT_USB_EXT_CAP_SIZE
);
629 usb_ext
->bLength
= USB_DT_USB_EXT_CAP_SIZE
;
630 usb_ext
->bDescriptorType
= USB_DT_DEVICE_CAPABILITY
;
631 usb_ext
->bDevCapabilityType
= USB_CAP_TYPE_EXT
;
632 usb_ext
->bmAttributes
= cpu_to_le32(USB_LPM_SUPPORT
| USB_BESL_SUPPORT
);
635 * The Superspeed USB Capability descriptor shall be implemented by all
636 * SuperSpeed devices.
638 if (gadget_is_superspeed(cdev
->gadget
)) {
639 struct usb_ss_cap_descriptor
*ss_cap
;
641 ss_cap
= cdev
->req
->buf
+ le16_to_cpu(bos
->wTotalLength
);
642 bos
->bNumDeviceCaps
++;
643 le16_add_cpu(&bos
->wTotalLength
, USB_DT_USB_SS_CAP_SIZE
);
644 ss_cap
->bLength
= USB_DT_USB_SS_CAP_SIZE
;
645 ss_cap
->bDescriptorType
= USB_DT_DEVICE_CAPABILITY
;
646 ss_cap
->bDevCapabilityType
= USB_SS_CAP_TYPE
;
647 ss_cap
->bmAttributes
= 0; /* LTM is not supported yet */
648 ss_cap
->wSpeedSupported
= cpu_to_le16(USB_LOW_SPEED_OPERATION
|
649 USB_FULL_SPEED_OPERATION
|
650 USB_HIGH_SPEED_OPERATION
|
651 USB_5GBPS_OPERATION
);
652 ss_cap
->bFunctionalitySupport
= USB_LOW_SPEED_OPERATION
;
654 /* Get Controller configuration */
655 if (cdev
->gadget
->ops
->get_config_params
) {
656 cdev
->gadget
->ops
->get_config_params(
659 dcd_config_params
.bU1devExitLat
=
660 USB_DEFAULT_U1_DEV_EXIT_LAT
;
661 dcd_config_params
.bU2DevExitLat
=
662 cpu_to_le16(USB_DEFAULT_U2_DEV_EXIT_LAT
);
664 ss_cap
->bU1devExitLat
= dcd_config_params
.bU1devExitLat
;
665 ss_cap
->bU2DevExitLat
= dcd_config_params
.bU2DevExitLat
;
668 /* The SuperSpeedPlus USB Device Capability descriptor */
669 if (gadget_is_superspeed_plus(cdev
->gadget
)) {
670 struct usb_ssp_cap_descriptor
*ssp_cap
;
672 ssp_cap
= cdev
->req
->buf
+ le16_to_cpu(bos
->wTotalLength
);
673 bos
->bNumDeviceCaps
++;
676 * Report typical values.
679 le16_add_cpu(&bos
->wTotalLength
, USB_DT_USB_SSP_CAP_SIZE(1));
680 ssp_cap
->bLength
= USB_DT_USB_SSP_CAP_SIZE(1);
681 ssp_cap
->bDescriptorType
= USB_DT_DEVICE_CAPABILITY
;
682 ssp_cap
->bDevCapabilityType
= USB_SSP_CAP_TYPE
;
683 ssp_cap
->bReserved
= 0;
684 ssp_cap
->wReserved
= 0;
686 /* SSAC = 1 (2 attributes) */
687 ssp_cap
->bmAttributes
= cpu_to_le32(1);
689 /* Min RX/TX Lane Count = 1 */
690 ssp_cap
->wFunctionalitySupport
=
691 cpu_to_le16((1 << 8) | (1 << 12));
694 * bmSublinkSpeedAttr[0]:
697 * LP = 1 (SuperSpeedPlus)
700 ssp_cap
->bmSublinkSpeedAttr
[0] =
701 cpu_to_le32((3 << 4) | (1 << 14) | (0xa << 16));
703 * bmSublinkSpeedAttr[1] =
706 * LP = 1 (SuperSpeedPlus)
709 ssp_cap
->bmSublinkSpeedAttr
[1] =
710 cpu_to_le32((3 << 4) | (1 << 14) |
711 (0xa << 16) | (1 << 7));
714 return le16_to_cpu(bos
->wTotalLength
);
717 static void device_qual(struct usb_composite_dev
*cdev
)
719 struct usb_qualifier_descriptor
*qual
= cdev
->req
->buf
;
721 qual
->bLength
= sizeof(*qual
);
722 qual
->bDescriptorType
= USB_DT_DEVICE_QUALIFIER
;
723 /* POLICY: same bcdUSB and device type info at both speeds */
724 qual
->bcdUSB
= cdev
->desc
.bcdUSB
;
725 qual
->bDeviceClass
= cdev
->desc
.bDeviceClass
;
726 qual
->bDeviceSubClass
= cdev
->desc
.bDeviceSubClass
;
727 qual
->bDeviceProtocol
= cdev
->desc
.bDeviceProtocol
;
728 /* ASSUME same EP0 fifo size at both speeds */
729 qual
->bMaxPacketSize0
= cdev
->gadget
->ep0
->maxpacket
;
730 qual
->bNumConfigurations
= count_configs(cdev
, USB_DT_DEVICE_QUALIFIER
);
734 /*-------------------------------------------------------------------------*/
736 static void reset_config(struct usb_composite_dev
*cdev
)
738 struct usb_function
*f
;
740 DBG(cdev
, "reset config\n");
742 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
746 bitmap_zero(f
->endpoints
, 32);
749 cdev
->delayed_status
= 0;
752 static int set_config(struct usb_composite_dev
*cdev
,
753 const struct usb_ctrlrequest
*ctrl
, unsigned number
)
755 struct usb_gadget
*gadget
= cdev
->gadget
;
756 struct usb_configuration
*c
= NULL
;
757 int result
= -EINVAL
;
758 unsigned power
= gadget_is_otg(gadget
) ? 8 : 100;
762 list_for_each_entry(c
, &cdev
->configs
, list
) {
763 if (c
->bConfigurationValue
== number
) {
765 * We disable the FDs of the previous
766 * configuration only if the new configuration
777 } else { /* Zero configuration value - need to reset the config */
783 INFO(cdev
, "%s config #%d: %s\n",
784 usb_speed_string(gadget
->speed
),
785 number
, c
? c
->label
: "unconfigured");
790 usb_gadget_set_state(gadget
, USB_STATE_CONFIGURED
);
793 /* Initialize all interfaces by setting them to altsetting zero. */
794 for (tmp
= 0; tmp
< MAX_CONFIG_INTERFACES
; tmp
++) {
795 struct usb_function
*f
= c
->interface
[tmp
];
796 struct usb_descriptor_header
**descriptors
;
802 * Record which endpoints are used by the function. This is used
803 * to dispatch control requests targeted at that endpoint to the
804 * function's setup callback instead of the current
805 * configuration's setup callback.
807 descriptors
= function_descriptors(f
, gadget
->speed
);
809 for (; *descriptors
; ++descriptors
) {
810 struct usb_endpoint_descriptor
*ep
;
813 if ((*descriptors
)->bDescriptorType
!= USB_DT_ENDPOINT
)
816 ep
= (struct usb_endpoint_descriptor
*)*descriptors
;
817 addr
= ((ep
->bEndpointAddress
& 0x80) >> 3)
818 | (ep
->bEndpointAddress
& 0x0f);
819 set_bit(addr
, f
->endpoints
);
822 result
= f
->set_alt(f
, tmp
, 0);
824 DBG(cdev
, "interface %d (%s/%p) alt 0 --> %d\n",
825 tmp
, f
->name
, f
, result
);
831 if (result
== USB_GADGET_DELAYED_STATUS
) {
833 "%s: interface %d (%s) requested delayed status\n",
834 __func__
, tmp
, f
->name
);
835 cdev
->delayed_status
++;
836 DBG(cdev
, "delayed_status count %d\n",
837 cdev
->delayed_status
);
841 /* when we return, be sure our power usage is valid */
842 power
= c
->MaxPower
? c
->MaxPower
: CONFIG_USB_GADGET_VBUS_DRAW
;
844 usb_gadget_vbus_draw(gadget
, power
);
845 if (result
>= 0 && cdev
->delayed_status
)
846 result
= USB_GADGET_DELAYED_STATUS
;
850 int usb_add_config_only(struct usb_composite_dev
*cdev
,
851 struct usb_configuration
*config
)
853 struct usb_configuration
*c
;
855 if (!config
->bConfigurationValue
)
858 /* Prevent duplicate configuration identifiers */
859 list_for_each_entry(c
, &cdev
->configs
, list
) {
860 if (c
->bConfigurationValue
== config
->bConfigurationValue
)
865 list_add_tail(&config
->list
, &cdev
->configs
);
867 INIT_LIST_HEAD(&config
->functions
);
868 config
->next_interface_id
= 0;
869 memset(config
->interface
, 0, sizeof(config
->interface
));
873 EXPORT_SYMBOL_GPL(usb_add_config_only
);
876 * usb_add_config() - add a configuration to a device.
877 * @cdev: wraps the USB gadget
878 * @config: the configuration, with bConfigurationValue assigned
879 * @bind: the configuration's bind function
880 * Context: single threaded during gadget setup
882 * One of the main tasks of a composite @bind() routine is to
883 * add each of the configurations it supports, using this routine.
885 * This function returns the value of the configuration's @bind(), which
886 * is zero for success else a negative errno value. Binding configurations
887 * assigns global resources including string IDs, and per-configuration
888 * resources such as interface IDs and endpoints.
890 int usb_add_config(struct usb_composite_dev
*cdev
,
891 struct usb_configuration
*config
,
892 int (*bind
)(struct usb_configuration
*))
894 int status
= -EINVAL
;
899 DBG(cdev
, "adding config #%u '%s'/%p\n",
900 config
->bConfigurationValue
,
901 config
->label
, config
);
903 status
= usb_add_config_only(cdev
, config
);
907 status
= bind(config
);
909 while (!list_empty(&config
->functions
)) {
910 struct usb_function
*f
;
912 f
= list_first_entry(&config
->functions
,
913 struct usb_function
, list
);
916 DBG(cdev
, "unbind function '%s'/%p\n",
918 f
->unbind(config
, f
);
919 /* may free memory for "f" */
922 list_del(&config
->list
);
927 DBG(cdev
, "cfg %d/%p speeds:%s%s%s%s\n",
928 config
->bConfigurationValue
, config
,
929 config
->superspeed_plus
? " superplus" : "",
930 config
->superspeed
? " super" : "",
931 config
->highspeed
? " high" : "",
933 ? (gadget_is_dualspeed(cdev
->gadget
)
938 for (i
= 0; i
< MAX_CONFIG_INTERFACES
; i
++) {
939 struct usb_function
*f
= config
->interface
[i
];
943 DBG(cdev
, " interface %d = %s/%p\n",
948 /* set_alt(), or next bind(), sets up ep->claimed as needed */
949 usb_ep_autoconfig_reset(cdev
->gadget
);
953 DBG(cdev
, "added config '%s'/%u --> %d\n", config
->label
,
954 config
->bConfigurationValue
, status
);
957 EXPORT_SYMBOL_GPL(usb_add_config
);
959 static void remove_config(struct usb_composite_dev
*cdev
,
960 struct usb_configuration
*config
)
962 while (!list_empty(&config
->functions
)) {
963 struct usb_function
*f
;
965 f
= list_first_entry(&config
->functions
,
966 struct usb_function
, list
);
968 usb_remove_function(config
, f
);
970 list_del(&config
->list
);
971 if (config
->unbind
) {
972 DBG(cdev
, "unbind config '%s'/%p\n", config
->label
, config
);
973 config
->unbind(config
);
974 /* may free memory for "c" */
979 * usb_remove_config() - remove a configuration from a device.
980 * @cdev: wraps the USB gadget
981 * @config: the configuration
983 * Drivers must call usb_gadget_disconnect before calling this function
984 * to disconnect the device from the host and make sure the host will not
985 * try to enumerate the device while we are changing the config list.
987 void usb_remove_config(struct usb_composite_dev
*cdev
,
988 struct usb_configuration
*config
)
992 spin_lock_irqsave(&cdev
->lock
, flags
);
994 if (cdev
->config
== config
)
997 spin_unlock_irqrestore(&cdev
->lock
, flags
);
999 remove_config(cdev
, config
);
1002 /*-------------------------------------------------------------------------*/
1004 /* We support strings in multiple languages ... string descriptor zero
1005 * says which languages are supported. The typical case will be that
1006 * only one language (probably English) is used, with i18n handled on
1010 static void collect_langs(struct usb_gadget_strings
**sp
, __le16
*buf
)
1012 const struct usb_gadget_strings
*s
;
1018 language
= cpu_to_le16(s
->language
);
1019 for (tmp
= buf
; *tmp
&& tmp
< &buf
[126]; tmp
++) {
1020 if (*tmp
== language
)
1029 static int lookup_string(
1030 struct usb_gadget_strings
**sp
,
1036 struct usb_gadget_strings
*s
;
1041 if (s
->language
!= language
)
1043 value
= usb_gadget_get_string(s
, id
, buf
);
1050 static int get_string(struct usb_composite_dev
*cdev
,
1051 void *buf
, u16 language
, int id
)
1053 struct usb_composite_driver
*composite
= cdev
->driver
;
1054 struct usb_gadget_string_container
*uc
;
1055 struct usb_configuration
*c
;
1056 struct usb_function
*f
;
1059 /* Yes, not only is USB's i18n support probably more than most
1060 * folk will ever care about ... also, it's all supported here.
1061 * (Except for UTF8 support for Unicode's "Astral Planes".)
1064 /* 0 == report all available language codes */
1066 struct usb_string_descriptor
*s
= buf
;
1067 struct usb_gadget_strings
**sp
;
1070 s
->bDescriptorType
= USB_DT_STRING
;
1072 sp
= composite
->strings
;
1074 collect_langs(sp
, s
->wData
);
1076 list_for_each_entry(c
, &cdev
->configs
, list
) {
1079 collect_langs(sp
, s
->wData
);
1081 list_for_each_entry(f
, &c
->functions
, list
) {
1084 collect_langs(sp
, s
->wData
);
1087 list_for_each_entry(uc
, &cdev
->gstrings
, list
) {
1088 struct usb_gadget_strings
**sp
;
1090 sp
= get_containers_gs(uc
);
1091 collect_langs(sp
, s
->wData
);
1094 for (len
= 0; len
<= 126 && s
->wData
[len
]; len
++)
1099 s
->bLength
= 2 * (len
+ 1);
1103 if (cdev
->use_os_string
&& language
== 0 && id
== OS_STRING_IDX
) {
1104 struct usb_os_string
*b
= buf
;
1105 b
->bLength
= sizeof(*b
);
1106 b
->bDescriptorType
= USB_DT_STRING
;
1108 sizeof(b
->qwSignature
) == sizeof(cdev
->qw_sign
),
1109 "qwSignature size must be equal to qw_sign");
1110 memcpy(&b
->qwSignature
, cdev
->qw_sign
, sizeof(b
->qwSignature
));
1111 b
->bMS_VendorCode
= cdev
->b_vendor_code
;
1116 list_for_each_entry(uc
, &cdev
->gstrings
, list
) {
1117 struct usb_gadget_strings
**sp
;
1119 sp
= get_containers_gs(uc
);
1120 len
= lookup_string(sp
, buf
, language
, id
);
1125 /* String IDs are device-scoped, so we look up each string
1126 * table we're told about. These lookups are infrequent;
1127 * simpler-is-better here.
1129 if (composite
->strings
) {
1130 len
= lookup_string(composite
->strings
, buf
, language
, id
);
1134 list_for_each_entry(c
, &cdev
->configs
, list
) {
1136 len
= lookup_string(c
->strings
, buf
, language
, id
);
1140 list_for_each_entry(f
, &c
->functions
, list
) {
1143 len
= lookup_string(f
->strings
, buf
, language
, id
);
1152 * usb_string_id() - allocate an unused string ID
1153 * @cdev: the device whose string descriptor IDs are being allocated
1154 * Context: single threaded during gadget setup
1156 * @usb_string_id() is called from bind() callbacks to allocate
1157 * string IDs. Drivers for functions, configurations, or gadgets will
1158 * then store that ID in the appropriate descriptors and string table.
1160 * All string identifier should be allocated using this,
1161 * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure
1162 * that for example different functions don't wrongly assign different
1163 * meanings to the same identifier.
1165 int usb_string_id(struct usb_composite_dev
*cdev
)
1167 if (cdev
->next_string_id
< 254) {
1168 /* string id 0 is reserved by USB spec for list of
1169 * supported languages */
1170 /* 255 reserved as well? -- mina86 */
1171 cdev
->next_string_id
++;
1172 return cdev
->next_string_id
;
1176 EXPORT_SYMBOL_GPL(usb_string_id
);
1179 * usb_string_ids() - allocate unused string IDs in batch
1180 * @cdev: the device whose string descriptor IDs are being allocated
1181 * @str: an array of usb_string objects to assign numbers to
1182 * Context: single threaded during gadget setup
1184 * @usb_string_ids() is called from bind() callbacks to allocate
1185 * string IDs. Drivers for functions, configurations, or gadgets will
1186 * then copy IDs from the string table to the appropriate descriptors
1187 * and string table for other languages.
1189 * All string identifier should be allocated using this,
1190 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1191 * example different functions don't wrongly assign different meanings
1192 * to the same identifier.
1194 int usb_string_ids_tab(struct usb_composite_dev
*cdev
, struct usb_string
*str
)
1196 int next
= cdev
->next_string_id
;
1198 for (; str
->s
; ++str
) {
1199 if (unlikely(next
>= 254))
1204 cdev
->next_string_id
= next
;
1208 EXPORT_SYMBOL_GPL(usb_string_ids_tab
);
1210 static struct usb_gadget_string_container
*copy_gadget_strings(
1211 struct usb_gadget_strings
**sp
, unsigned n_gstrings
,
1214 struct usb_gadget_string_container
*uc
;
1215 struct usb_gadget_strings
**gs_array
;
1216 struct usb_gadget_strings
*gs
;
1217 struct usb_string
*s
;
1224 mem
+= sizeof(void *) * (n_gstrings
+ 1);
1225 mem
+= sizeof(struct usb_gadget_strings
) * n_gstrings
;
1226 mem
+= sizeof(struct usb_string
) * (n_strings
+ 1) * (n_gstrings
);
1227 uc
= kmalloc(mem
, GFP_KERNEL
);
1229 return ERR_PTR(-ENOMEM
);
1230 gs_array
= get_containers_gs(uc
);
1232 stash
+= sizeof(void *) * (n_gstrings
+ 1);
1233 for (n_gs
= 0; n_gs
< n_gstrings
; n_gs
++) {
1234 struct usb_string
*org_s
;
1236 gs_array
[n_gs
] = stash
;
1237 gs
= gs_array
[n_gs
];
1238 stash
+= sizeof(struct usb_gadget_strings
);
1239 gs
->language
= sp
[n_gs
]->language
;
1240 gs
->strings
= stash
;
1241 org_s
= sp
[n_gs
]->strings
;
1243 for (n_s
= 0; n_s
< n_strings
; n_s
++) {
1245 stash
+= sizeof(struct usb_string
);
1254 stash
+= sizeof(struct usb_string
);
1257 gs_array
[n_gs
] = NULL
;
1262 * usb_gstrings_attach() - attach gadget strings to a cdev and assign ids
1263 * @cdev: the device whose string descriptor IDs are being allocated
1265 * @sp: an array of usb_gadget_strings to attach.
1266 * @n_strings: number of entries in each usb_strings array (sp[]->strings)
1268 * This function will create a deep copy of usb_gadget_strings and usb_string
1269 * and attach it to the cdev. The actual string (usb_string.s) will not be
1270 * copied but only a referenced will be made. The struct usb_gadget_strings
1271 * array may contain multiple languages and should be NULL terminated.
1272 * The ->language pointer of each struct usb_gadget_strings has to contain the
1273 * same amount of entries.
1274 * For instance: sp[0] is en-US, sp[1] is es-ES. It is expected that the first
1275 * usb_string entry of es-ES contains the translation of the first usb_string
1276 * entry of en-US. Therefore both entries become the same id assign.
1278 struct usb_string
*usb_gstrings_attach(struct usb_composite_dev
*cdev
,
1279 struct usb_gadget_strings
**sp
, unsigned n_strings
)
1281 struct usb_gadget_string_container
*uc
;
1282 struct usb_gadget_strings
**n_gs
;
1283 unsigned n_gstrings
= 0;
1287 for (i
= 0; sp
[i
]; i
++)
1291 return ERR_PTR(-EINVAL
);
1293 uc
= copy_gadget_strings(sp
, n_gstrings
, n_strings
);
1295 return ERR_CAST(uc
);
1297 n_gs
= get_containers_gs(uc
);
1298 ret
= usb_string_ids_tab(cdev
, n_gs
[0]->strings
);
1302 for (i
= 1; i
< n_gstrings
; i
++) {
1303 struct usb_string
*m_s
;
1304 struct usb_string
*s
;
1307 m_s
= n_gs
[0]->strings
;
1308 s
= n_gs
[i
]->strings
;
1309 for (n
= 0; n
< n_strings
; n
++) {
1315 list_add_tail(&uc
->list
, &cdev
->gstrings
);
1316 return n_gs
[0]->strings
;
1319 return ERR_PTR(ret
);
1321 EXPORT_SYMBOL_GPL(usb_gstrings_attach
);
1324 * usb_string_ids_n() - allocate unused string IDs in batch
1325 * @c: the device whose string descriptor IDs are being allocated
1326 * @n: number of string IDs to allocate
1327 * Context: single threaded during gadget setup
1329 * Returns the first requested ID. This ID and next @n-1 IDs are now
1330 * valid IDs. At least provided that @n is non-zero because if it
1331 * is, returns last requested ID which is now very useful information.
1333 * @usb_string_ids_n() is called from bind() callbacks to allocate
1334 * string IDs. Drivers for functions, configurations, or gadgets will
1335 * then store that ID in the appropriate descriptors and string table.
1337 * All string identifier should be allocated using this,
1338 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1339 * example different functions don't wrongly assign different meanings
1340 * to the same identifier.
1342 int usb_string_ids_n(struct usb_composite_dev
*c
, unsigned n
)
1344 unsigned next
= c
->next_string_id
;
1345 if (unlikely(n
> 254 || (unsigned)next
+ n
> 254))
1347 c
->next_string_id
+= n
;
1350 EXPORT_SYMBOL_GPL(usb_string_ids_n
);
1352 /*-------------------------------------------------------------------------*/
1354 static void composite_setup_complete(struct usb_ep
*ep
, struct usb_request
*req
)
1356 struct usb_composite_dev
*cdev
;
1358 if (req
->status
|| req
->actual
!= req
->length
)
1359 DBG((struct usb_composite_dev
*) ep
->driver_data
,
1360 "setup complete --> %d, %d/%d\n",
1361 req
->status
, req
->actual
, req
->length
);
1364 * REVIST The same ep0 requests are shared with function drivers
1365 * so they don't have to maintain the same ->complete() stubs.
1367 * Because of that, we need to check for the validity of ->context
1368 * here, even though we know we've set it to something useful.
1373 cdev
= req
->context
;
1375 if (cdev
->req
== req
)
1376 cdev
->setup_pending
= false;
1377 else if (cdev
->os_desc_req
== req
)
1378 cdev
->os_desc_pending
= false;
1380 WARN(1, "unknown request %p\n", req
);
1383 static int composite_ep0_queue(struct usb_composite_dev
*cdev
,
1384 struct usb_request
*req
, gfp_t gfp_flags
)
1388 ret
= usb_ep_queue(cdev
->gadget
->ep0
, req
, gfp_flags
);
1390 if (cdev
->req
== req
)
1391 cdev
->setup_pending
= true;
1392 else if (cdev
->os_desc_req
== req
)
1393 cdev
->os_desc_pending
= true;
1395 WARN(1, "unknown request %p\n", req
);
1401 static int count_ext_compat(struct usb_configuration
*c
)
1406 for (i
= 0; i
< c
->next_interface_id
; ++i
) {
1407 struct usb_function
*f
;
1410 f
= c
->interface
[i
];
1411 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1412 struct usb_os_desc
*d
;
1414 if (i
!= f
->os_desc_table
[j
].if_id
)
1416 d
= f
->os_desc_table
[j
].os_desc
;
1417 if (d
&& d
->ext_compat_id
)
1425 static int fill_ext_compat(struct usb_configuration
*c
, u8
*buf
)
1431 for (i
= 0; i
< c
->next_interface_id
; ++i
) {
1432 struct usb_function
*f
;
1435 f
= c
->interface
[i
];
1436 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1437 struct usb_os_desc
*d
;
1439 if (i
!= f
->os_desc_table
[j
].if_id
)
1441 d
= f
->os_desc_table
[j
].os_desc
;
1442 if (d
&& d
->ext_compat_id
) {
1445 memcpy(buf
, d
->ext_compat_id
, 16);
1453 if (count
+ 24 >= USB_COMP_EP0_OS_DESC_BUFSIZ
)
1461 static int count_ext_prop(struct usb_configuration
*c
, int interface
)
1463 struct usb_function
*f
;
1466 f
= c
->interface
[interface
];
1467 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1468 struct usb_os_desc
*d
;
1470 if (interface
!= f
->os_desc_table
[j
].if_id
)
1472 d
= f
->os_desc_table
[j
].os_desc
;
1473 if (d
&& d
->ext_compat_id
)
1474 return d
->ext_prop_count
;
1479 static int len_ext_prop(struct usb_configuration
*c
, int interface
)
1481 struct usb_function
*f
;
1482 struct usb_os_desc
*d
;
1485 res
= 10; /* header length */
1486 f
= c
->interface
[interface
];
1487 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1488 if (interface
!= f
->os_desc_table
[j
].if_id
)
1490 d
= f
->os_desc_table
[j
].os_desc
;
1492 return min(res
+ d
->ext_prop_len
, 4096);
1497 static int fill_ext_prop(struct usb_configuration
*c
, int interface
, u8
*buf
)
1499 struct usb_function
*f
;
1500 struct usb_os_desc
*d
;
1501 struct usb_os_desc_ext_prop
*ext_prop
;
1502 int j
, count
, n
, ret
;
1504 f
= c
->interface
[interface
];
1505 count
= 10; /* header length */
1507 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1508 if (interface
!= f
->os_desc_table
[j
].if_id
)
1510 d
= f
->os_desc_table
[j
].os_desc
;
1512 list_for_each_entry(ext_prop
, &d
->ext_prop
, entry
) {
1513 n
= ext_prop
->data_len
+
1514 ext_prop
->name_len
+ 14;
1515 if (count
+ n
>= USB_COMP_EP0_OS_DESC_BUFSIZ
)
1517 usb_ext_prop_put_size(buf
, n
);
1518 usb_ext_prop_put_type(buf
, ext_prop
->type
);
1519 ret
= usb_ext_prop_put_name(buf
, ext_prop
->name
,
1520 ext_prop
->name_len
);
1523 switch (ext_prop
->type
) {
1524 case USB_EXT_PROP_UNICODE
:
1525 case USB_EXT_PROP_UNICODE_ENV
:
1526 case USB_EXT_PROP_UNICODE_LINK
:
1527 usb_ext_prop_put_unicode(buf
, ret
,
1529 ext_prop
->data_len
);
1531 case USB_EXT_PROP_BINARY
:
1532 usb_ext_prop_put_binary(buf
, ret
,
1534 ext_prop
->data_len
);
1536 case USB_EXT_PROP_LE32
:
1537 /* not implemented */
1538 case USB_EXT_PROP_BE32
:
1539 /* not implemented */
1552 * The setup() callback implements all the ep0 functionality that's
1553 * not handled lower down, in hardware or the hardware driver(like
1554 * device and endpoint feature flags, and their status). It's all
1555 * housekeeping for the gadget function we're implementing. Most of
1556 * the work is in config and function specific setup.
1559 composite_setup(struct usb_gadget
*gadget
, const struct usb_ctrlrequest
*ctrl
)
1561 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
1562 struct usb_request
*req
= cdev
->req
;
1563 int value
= -EOPNOTSUPP
;
1565 u16 w_index
= le16_to_cpu(ctrl
->wIndex
);
1566 u8 intf
= w_index
& 0xFF;
1567 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
1568 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
1569 struct usb_function
*f
= NULL
;
1572 /* partial re-init of the response message; the function or the
1573 * gadget might need to intercept e.g. a control-OUT completion
1574 * when we delegate to it.
1577 req
->context
= cdev
;
1578 req
->complete
= composite_setup_complete
;
1580 gadget
->ep0
->driver_data
= cdev
;
1583 * Don't let non-standard requests match any of the cases below
1586 if ((ctrl
->bRequestType
& USB_TYPE_MASK
) != USB_TYPE_STANDARD
)
1589 switch (ctrl
->bRequest
) {
1591 /* we handle all standard USB descriptors */
1592 case USB_REQ_GET_DESCRIPTOR
:
1593 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1595 switch (w_value
>> 8) {
1598 cdev
->desc
.bNumConfigurations
=
1599 count_configs(cdev
, USB_DT_DEVICE
);
1600 cdev
->desc
.bMaxPacketSize0
=
1601 cdev
->gadget
->ep0
->maxpacket
;
1602 if (gadget_is_superspeed(gadget
)) {
1603 if (gadget
->speed
>= USB_SPEED_SUPER
) {
1604 cdev
->desc
.bcdUSB
= cpu_to_le16(0x0320);
1605 cdev
->desc
.bMaxPacketSize0
= 9;
1607 cdev
->desc
.bcdUSB
= cpu_to_le16(0x0210);
1610 if (gadget
->lpm_capable
)
1611 cdev
->desc
.bcdUSB
= cpu_to_le16(0x0201);
1613 cdev
->desc
.bcdUSB
= cpu_to_le16(0x0200);
1616 value
= min(w_length
, (u16
) sizeof cdev
->desc
);
1617 memcpy(req
->buf
, &cdev
->desc
, value
);
1619 case USB_DT_DEVICE_QUALIFIER
:
1620 if (!gadget_is_dualspeed(gadget
) ||
1621 gadget
->speed
>= USB_SPEED_SUPER
)
1624 value
= min_t(int, w_length
,
1625 sizeof(struct usb_qualifier_descriptor
));
1627 case USB_DT_OTHER_SPEED_CONFIG
:
1628 if (!gadget_is_dualspeed(gadget
) ||
1629 gadget
->speed
>= USB_SPEED_SUPER
)
1633 value
= config_desc(cdev
, w_value
);
1635 value
= min(w_length
, (u16
) value
);
1638 value
= get_string(cdev
, req
->buf
,
1639 w_index
, w_value
& 0xff);
1641 value
= min(w_length
, (u16
) value
);
1644 if (gadget_is_superspeed(gadget
) ||
1645 gadget
->lpm_capable
) {
1646 value
= bos_desc(cdev
);
1647 value
= min(w_length
, (u16
) value
);
1651 if (gadget_is_otg(gadget
)) {
1652 struct usb_configuration
*config
;
1653 int otg_desc_len
= 0;
1656 config
= cdev
->config
;
1658 config
= list_first_entry(
1660 struct usb_configuration
, list
);
1664 if (gadget
->otg_caps
&&
1665 (gadget
->otg_caps
->otg_rev
>= 0x0200))
1666 otg_desc_len
+= sizeof(
1667 struct usb_otg20_descriptor
);
1669 otg_desc_len
+= sizeof(
1670 struct usb_otg_descriptor
);
1672 value
= min_t(int, w_length
, otg_desc_len
);
1673 memcpy(req
->buf
, config
->descriptors
[0], value
);
1679 /* any number of configs can work */
1680 case USB_REQ_SET_CONFIGURATION
:
1681 if (ctrl
->bRequestType
!= 0)
1683 if (gadget_is_otg(gadget
)) {
1684 if (gadget
->a_hnp_support
)
1685 DBG(cdev
, "HNP available\n");
1686 else if (gadget
->a_alt_hnp_support
)
1687 DBG(cdev
, "HNP on another port\n");
1689 VDBG(cdev
, "HNP inactive\n");
1691 spin_lock(&cdev
->lock
);
1692 value
= set_config(cdev
, ctrl
, w_value
);
1693 spin_unlock(&cdev
->lock
);
1695 case USB_REQ_GET_CONFIGURATION
:
1696 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1699 *(u8
*)req
->buf
= cdev
->config
->bConfigurationValue
;
1701 *(u8
*)req
->buf
= 0;
1702 value
= min(w_length
, (u16
) 1);
1705 /* function drivers must handle get/set altsetting */
1706 case USB_REQ_SET_INTERFACE
:
1707 if (ctrl
->bRequestType
!= USB_RECIP_INTERFACE
)
1709 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1711 f
= cdev
->config
->interface
[intf
];
1716 * If there's no get_alt() method, we know only altsetting zero
1717 * works. There is no need to check if set_alt() is not NULL
1718 * as we check this in usb_add_function().
1720 if (w_value
&& !f
->get_alt
)
1723 spin_lock(&cdev
->lock
);
1724 value
= f
->set_alt(f
, w_index
, w_value
);
1725 if (value
== USB_GADGET_DELAYED_STATUS
) {
1727 "%s: interface %d (%s) requested delayed status\n",
1728 __func__
, intf
, f
->name
);
1729 cdev
->delayed_status
++;
1730 DBG(cdev
, "delayed_status count %d\n",
1731 cdev
->delayed_status
);
1733 spin_unlock(&cdev
->lock
);
1735 case USB_REQ_GET_INTERFACE
:
1736 if (ctrl
->bRequestType
!= (USB_DIR_IN
|USB_RECIP_INTERFACE
))
1738 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1740 f
= cdev
->config
->interface
[intf
];
1743 /* lots of interfaces only need altsetting zero... */
1744 value
= f
->get_alt
? f
->get_alt(f
, w_index
) : 0;
1747 *((u8
*)req
->buf
) = value
;
1748 value
= min(w_length
, (u16
) 1);
1750 case USB_REQ_GET_STATUS
:
1751 if (gadget_is_otg(gadget
) && gadget
->hnp_polling_support
&&
1752 (w_index
== OTG_STS_SELECTOR
)) {
1753 if (ctrl
->bRequestType
!= (USB_DIR_IN
|
1756 *((u8
*)req
->buf
) = gadget
->host_request_flag
;
1762 * USB 3.0 additions:
1763 * Function driver should handle get_status request. If such cb
1764 * wasn't supplied we respond with default value = 0
1765 * Note: function driver should supply such cb only for the
1766 * first interface of the function
1768 if (!gadget_is_superspeed(gadget
))
1770 if (ctrl
->bRequestType
!= (USB_DIR_IN
| USB_RECIP_INTERFACE
))
1772 value
= 2; /* This is the length of the get_status reply */
1773 put_unaligned_le16(0, req
->buf
);
1774 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1776 f
= cdev
->config
->interface
[intf
];
1779 status
= f
->get_status
? f
->get_status(f
) : 0;
1782 put_unaligned_le16(status
& 0x0000ffff, req
->buf
);
1785 * Function drivers should handle SetFeature/ClearFeature
1786 * (FUNCTION_SUSPEND) request. function_suspend cb should be supplied
1787 * only for the first interface of the function
1789 case USB_REQ_CLEAR_FEATURE
:
1790 case USB_REQ_SET_FEATURE
:
1791 if (!gadget_is_superspeed(gadget
))
1793 if (ctrl
->bRequestType
!= (USB_DIR_OUT
| USB_RECIP_INTERFACE
))
1796 case USB_INTRF_FUNC_SUSPEND
:
1797 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1799 f
= cdev
->config
->interface
[intf
];
1803 if (f
->func_suspend
)
1804 value
= f
->func_suspend(f
, w_index
>> 8);
1807 "func_suspend() returned error %d\n",
1817 * OS descriptors handling
1819 if (cdev
->use_os_string
&& cdev
->os_desc_config
&&
1820 (ctrl
->bRequestType
& USB_TYPE_VENDOR
) &&
1821 ctrl
->bRequest
== cdev
->b_vendor_code
) {
1822 struct usb_configuration
*os_desc_cfg
;
1827 req
= cdev
->os_desc_req
;
1828 req
->context
= cdev
;
1829 req
->complete
= composite_setup_complete
;
1831 os_desc_cfg
= cdev
->os_desc_config
;
1832 w_length
= min_t(u16
, w_length
, USB_COMP_EP0_OS_DESC_BUFSIZ
);
1833 memset(buf
, 0, w_length
);
1835 switch (ctrl
->bRequestType
& USB_RECIP_MASK
) {
1836 case USB_RECIP_DEVICE
:
1837 if (w_index
!= 0x4 || (w_value
>> 8))
1840 /* Number of ext compat interfaces */
1841 count
= count_ext_compat(os_desc_cfg
);
1843 count
*= 24; /* 24 B/ext compat desc */
1844 count
+= 16; /* header */
1845 put_unaligned_le32(count
, buf
);
1847 if (w_length
> 0x10) {
1848 value
= fill_ext_compat(os_desc_cfg
, buf
);
1849 value
= min_t(u16
, w_length
, value
);
1852 case USB_RECIP_INTERFACE
:
1853 if (w_index
!= 0x5 || (w_value
>> 8))
1855 interface
= w_value
& 0xFF;
1857 count
= count_ext_prop(os_desc_cfg
,
1859 put_unaligned_le16(count
, buf
+ 8);
1860 count
= len_ext_prop(os_desc_cfg
,
1862 put_unaligned_le32(count
, buf
);
1864 if (w_length
> 0x0A) {
1865 value
= fill_ext_prop(os_desc_cfg
,
1868 value
= min_t(u16
, w_length
, value
);
1877 "non-core control req%02x.%02x v%04x i%04x l%d\n",
1878 ctrl
->bRequestType
, ctrl
->bRequest
,
1879 w_value
, w_index
, w_length
);
1881 /* functions always handle their interfaces and endpoints...
1882 * punt other recipients (other, WUSB, ...) to the current
1883 * configuration code.
1886 list_for_each_entry(f
, &cdev
->config
->functions
, list
)
1888 f
->req_match(f
, ctrl
, false))
1891 struct usb_configuration
*c
;
1892 list_for_each_entry(c
, &cdev
->configs
, list
)
1893 list_for_each_entry(f
, &c
->functions
, list
)
1895 f
->req_match(f
, ctrl
, true))
1900 switch (ctrl
->bRequestType
& USB_RECIP_MASK
) {
1901 case USB_RECIP_INTERFACE
:
1902 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1904 f
= cdev
->config
->interface
[intf
];
1907 case USB_RECIP_ENDPOINT
:
1910 endp
= ((w_index
& 0x80) >> 3) | (w_index
& 0x0f);
1911 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
1912 if (test_bit(endp
, f
->endpoints
))
1915 if (&f
->list
== &cdev
->config
->functions
)
1921 value
= f
->setup(f
, ctrl
);
1923 struct usb_configuration
*c
;
1929 /* try current config's setup */
1931 value
= c
->setup(c
, ctrl
);
1935 /* try the only function in the current config */
1936 if (!list_is_singular(&c
->functions
))
1938 f
= list_first_entry(&c
->functions
, struct usb_function
,
1941 value
= f
->setup(f
, ctrl
);
1948 /* respond with data transfer before status phase? */
1949 if (value
>= 0 && value
!= USB_GADGET_DELAYED_STATUS
) {
1950 req
->length
= value
;
1951 req
->context
= cdev
;
1952 req
->zero
= value
< w_length
;
1953 value
= composite_ep0_queue(cdev
, req
, GFP_ATOMIC
);
1955 DBG(cdev
, "ep_queue --> %d\n", value
);
1957 composite_setup_complete(gadget
->ep0
, req
);
1959 } else if (value
== USB_GADGET_DELAYED_STATUS
&& w_length
!= 0) {
1961 "%s: Delayed status not supported for w_length != 0",
1966 /* device either stalls (value < 0) or reports success */
1970 void composite_disconnect(struct usb_gadget
*gadget
)
1972 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
1973 unsigned long flags
;
1975 /* REVISIT: should we have config and device level
1976 * disconnect callbacks?
1978 spin_lock_irqsave(&cdev
->lock
, flags
);
1981 if (cdev
->driver
->disconnect
)
1982 cdev
->driver
->disconnect(cdev
);
1983 spin_unlock_irqrestore(&cdev
->lock
, flags
);
1986 /*-------------------------------------------------------------------------*/
1988 static ssize_t
suspended_show(struct device
*dev
, struct device_attribute
*attr
,
1991 struct usb_gadget
*gadget
= dev_to_usb_gadget(dev
);
1992 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
1994 return sprintf(buf
, "%d\n", cdev
->suspended
);
1996 static DEVICE_ATTR_RO(suspended
);
1998 static void __composite_unbind(struct usb_gadget
*gadget
, bool unbind_driver
)
2000 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
2001 struct usb_gadget_strings
*gstr
= cdev
->driver
->strings
[0];
2002 struct usb_string
*dev_str
= gstr
->strings
;
2004 /* composite_disconnect() must already have been called
2005 * by the underlying peripheral controller driver!
2006 * so there's no i/o concurrency that could affect the
2007 * state protected by cdev->lock.
2009 WARN_ON(cdev
->config
);
2011 while (!list_empty(&cdev
->configs
)) {
2012 struct usb_configuration
*c
;
2013 c
= list_first_entry(&cdev
->configs
,
2014 struct usb_configuration
, list
);
2015 remove_config(cdev
, c
);
2017 if (cdev
->driver
->unbind
&& unbind_driver
)
2018 cdev
->driver
->unbind(cdev
);
2020 composite_dev_cleanup(cdev
);
2022 if (dev_str
[USB_GADGET_MANUFACTURER_IDX
].s
== cdev
->def_manufacturer
)
2023 dev_str
[USB_GADGET_MANUFACTURER_IDX
].s
= "";
2025 kfree(cdev
->def_manufacturer
);
2027 set_gadget_data(gadget
, NULL
);
2030 static void composite_unbind(struct usb_gadget
*gadget
)
2032 __composite_unbind(gadget
, true);
2035 static void update_unchanged_dev_desc(struct usb_device_descriptor
*new,
2036 const struct usb_device_descriptor
*old
)
2046 * these variables may have been set in
2047 * usb_composite_overwrite_options()
2049 idVendor
= new->idVendor
;
2050 idProduct
= new->idProduct
;
2051 bcdDevice
= new->bcdDevice
;
2052 iSerialNumber
= new->iSerialNumber
;
2053 iManufacturer
= new->iManufacturer
;
2054 iProduct
= new->iProduct
;
2058 new->idVendor
= idVendor
;
2060 new->idProduct
= idProduct
;
2062 new->bcdDevice
= bcdDevice
;
2064 new->bcdDevice
= cpu_to_le16(get_default_bcdDevice());
2066 new->iSerialNumber
= iSerialNumber
;
2068 new->iManufacturer
= iManufacturer
;
2070 new->iProduct
= iProduct
;
2073 int composite_dev_prepare(struct usb_composite_driver
*composite
,
2074 struct usb_composite_dev
*cdev
)
2076 struct usb_gadget
*gadget
= cdev
->gadget
;
2079 /* preallocate control response and buffer */
2080 cdev
->req
= usb_ep_alloc_request(gadget
->ep0
, GFP_KERNEL
);
2084 cdev
->req
->buf
= kmalloc(USB_COMP_EP0_BUFSIZ
, GFP_KERNEL
);
2085 if (!cdev
->req
->buf
)
2088 ret
= device_create_file(&gadget
->dev
, &dev_attr_suspended
);
2092 cdev
->req
->complete
= composite_setup_complete
;
2093 cdev
->req
->context
= cdev
;
2094 gadget
->ep0
->driver_data
= cdev
;
2096 cdev
->driver
= composite
;
2099 * As per USB compliance update, a device that is actively drawing
2100 * more than 100mA from USB must report itself as bus-powered in
2101 * the GetStatus(DEVICE) call.
2103 if (CONFIG_USB_GADGET_VBUS_DRAW
<= USB_SELF_POWER_VBUS_MAX_DRAW
)
2104 usb_gadget_set_selfpowered(gadget
);
2106 /* interface and string IDs start at zero via kzalloc.
2107 * we force endpoints to start unassigned; few controller
2108 * drivers will zero ep->driver_data.
2110 usb_ep_autoconfig_reset(gadget
);
2113 kfree(cdev
->req
->buf
);
2115 usb_ep_free_request(gadget
->ep0
, cdev
->req
);
2120 int composite_os_desc_req_prepare(struct usb_composite_dev
*cdev
,
2125 cdev
->os_desc_req
= usb_ep_alloc_request(ep0
, GFP_KERNEL
);
2126 if (!cdev
->os_desc_req
) {
2131 cdev
->os_desc_req
->buf
= kmalloc(USB_COMP_EP0_OS_DESC_BUFSIZ
,
2133 if (!cdev
->os_desc_req
->buf
) {
2135 usb_ep_free_request(ep0
, cdev
->os_desc_req
);
2138 cdev
->os_desc_req
->context
= cdev
;
2139 cdev
->os_desc_req
->complete
= composite_setup_complete
;
2144 void composite_dev_cleanup(struct usb_composite_dev
*cdev
)
2146 struct usb_gadget_string_container
*uc
, *tmp
;
2147 struct usb_ep
*ep
, *tmp_ep
;
2149 list_for_each_entry_safe(uc
, tmp
, &cdev
->gstrings
, list
) {
2150 list_del(&uc
->list
);
2153 if (cdev
->os_desc_req
) {
2154 if (cdev
->os_desc_pending
)
2155 usb_ep_dequeue(cdev
->gadget
->ep0
, cdev
->os_desc_req
);
2157 kfree(cdev
->os_desc_req
->buf
);
2158 usb_ep_free_request(cdev
->gadget
->ep0
, cdev
->os_desc_req
);
2161 if (cdev
->setup_pending
)
2162 usb_ep_dequeue(cdev
->gadget
->ep0
, cdev
->req
);
2164 kfree(cdev
->req
->buf
);
2165 usb_ep_free_request(cdev
->gadget
->ep0
, cdev
->req
);
2167 cdev
->next_string_id
= 0;
2168 device_remove_file(&cdev
->gadget
->dev
, &dev_attr_suspended
);
2171 * Some UDC backends have a dynamic EP allocation scheme.
2173 * In that case, the dispose() callback is used to notify the
2174 * backend that the EPs are no longer in use.
2176 * Note: The UDC backend can remove the EP from the ep_list as
2177 * a result, so we need to use the _safe list iterator.
2179 list_for_each_entry_safe(ep
, tmp_ep
,
2180 &cdev
->gadget
->ep_list
, ep_list
) {
2181 if (ep
->ops
->dispose
)
2182 ep
->ops
->dispose(ep
);
2186 static int composite_bind(struct usb_gadget
*gadget
,
2187 struct usb_gadget_driver
*gdriver
)
2189 struct usb_composite_dev
*cdev
;
2190 struct usb_composite_driver
*composite
= to_cdriver(gdriver
);
2191 int status
= -ENOMEM
;
2193 cdev
= kzalloc(sizeof *cdev
, GFP_KERNEL
);
2197 spin_lock_init(&cdev
->lock
);
2198 cdev
->gadget
= gadget
;
2199 set_gadget_data(gadget
, cdev
);
2200 INIT_LIST_HEAD(&cdev
->configs
);
2201 INIT_LIST_HEAD(&cdev
->gstrings
);
2203 status
= composite_dev_prepare(composite
, cdev
);
2207 /* composite gadget needs to assign strings for whole device (like
2208 * serial number), register function drivers, potentially update
2209 * power state and consumption, etc
2211 status
= composite
->bind(cdev
);
2215 if (cdev
->use_os_string
) {
2216 status
= composite_os_desc_req_prepare(cdev
, gadget
->ep0
);
2221 update_unchanged_dev_desc(&cdev
->desc
, composite
->dev
);
2223 /* has userspace failed to provide a serial number? */
2224 if (composite
->needs_serial
&& !cdev
->desc
.iSerialNumber
)
2225 WARNING(cdev
, "userspace failed to provide iSerialNumber\n");
2227 INFO(cdev
, "%s ready\n", composite
->name
);
2231 __composite_unbind(gadget
, false);
2235 /*-------------------------------------------------------------------------*/
2237 void composite_suspend(struct usb_gadget
*gadget
)
2239 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
2240 struct usb_function
*f
;
2242 /* REVISIT: should we have config level
2243 * suspend/resume callbacks?
2245 DBG(cdev
, "suspend\n");
2247 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
2252 if (cdev
->driver
->suspend
)
2253 cdev
->driver
->suspend(cdev
);
2255 cdev
->suspended
= 1;
2257 usb_gadget_vbus_draw(gadget
, 2);
2260 void composite_resume(struct usb_gadget
*gadget
)
2262 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
2263 struct usb_function
*f
;
2266 /* REVISIT: should we have config level
2267 * suspend/resume callbacks?
2269 DBG(cdev
, "resume\n");
2270 if (cdev
->driver
->resume
)
2271 cdev
->driver
->resume(cdev
);
2273 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
2278 maxpower
= cdev
->config
->MaxPower
;
2280 usb_gadget_vbus_draw(gadget
, maxpower
?
2281 maxpower
: CONFIG_USB_GADGET_VBUS_DRAW
);
2284 cdev
->suspended
= 0;
2287 /*-------------------------------------------------------------------------*/
2289 static const struct usb_gadget_driver composite_driver_template
= {
2290 .bind
= composite_bind
,
2291 .unbind
= composite_unbind
,
2293 .setup
= composite_setup
,
2294 .reset
= composite_disconnect
,
2295 .disconnect
= composite_disconnect
,
2297 .suspend
= composite_suspend
,
2298 .resume
= composite_resume
,
2301 .owner
= THIS_MODULE
,
2306 * usb_composite_probe() - register a composite driver
2307 * @driver: the driver to register
2309 * Context: single threaded during gadget setup
2311 * This function is used to register drivers using the composite driver
2312 * framework. The return value is zero, or a negative errno value.
2313 * Those values normally come from the driver's @bind method, which does
2314 * all the work of setting up the driver to match the hardware.
2316 * On successful return, the gadget is ready to respond to requests from
2317 * the host, unless one of its components invokes usb_gadget_disconnect()
2318 * while it was binding. That would usually be done in order to wait for
2319 * some userspace participation.
2321 int usb_composite_probe(struct usb_composite_driver
*driver
)
2323 struct usb_gadget_driver
*gadget_driver
;
2325 if (!driver
|| !driver
->dev
|| !driver
->bind
)
2329 driver
->name
= "composite";
2331 driver
->gadget_driver
= composite_driver_template
;
2332 gadget_driver
= &driver
->gadget_driver
;
2334 gadget_driver
->function
= (char *) driver
->name
;
2335 gadget_driver
->driver
.name
= driver
->name
;
2336 gadget_driver
->max_speed
= driver
->max_speed
;
2338 return usb_gadget_probe_driver(gadget_driver
);
2340 EXPORT_SYMBOL_GPL(usb_composite_probe
);
2343 * usb_composite_unregister() - unregister a composite driver
2344 * @driver: the driver to unregister
2346 * This function is used to unregister drivers using the composite
2349 void usb_composite_unregister(struct usb_composite_driver
*driver
)
2351 usb_gadget_unregister_driver(&driver
->gadget_driver
);
2353 EXPORT_SYMBOL_GPL(usb_composite_unregister
);
2356 * usb_composite_setup_continue() - Continue with the control transfer
2357 * @cdev: the composite device who's control transfer was kept waiting
2359 * This function must be called by the USB function driver to continue
2360 * with the control transfer's data/status stage in case it had requested to
2361 * delay the data/status stages. A USB function's setup handler (e.g. set_alt())
2362 * can request the composite framework to delay the setup request's data/status
2363 * stages by returning USB_GADGET_DELAYED_STATUS.
2365 void usb_composite_setup_continue(struct usb_composite_dev
*cdev
)
2368 struct usb_request
*req
= cdev
->req
;
2369 unsigned long flags
;
2371 DBG(cdev
, "%s\n", __func__
);
2372 spin_lock_irqsave(&cdev
->lock
, flags
);
2374 if (cdev
->delayed_status
== 0) {
2375 WARN(cdev
, "%s: Unexpected call\n", __func__
);
2377 } else if (--cdev
->delayed_status
== 0) {
2378 DBG(cdev
, "%s: Completing delayed status\n", __func__
);
2380 req
->context
= cdev
;
2381 value
= composite_ep0_queue(cdev
, req
, GFP_ATOMIC
);
2383 DBG(cdev
, "ep_queue --> %d\n", value
);
2385 composite_setup_complete(cdev
->gadget
->ep0
, req
);
2389 spin_unlock_irqrestore(&cdev
->lock
, flags
);
2391 EXPORT_SYMBOL_GPL(usb_composite_setup_continue
);
2393 static char *composite_default_mfr(struct usb_gadget
*gadget
)
2395 return kasprintf(GFP_KERNEL
, "%s %s with %s", init_utsname()->sysname
,
2396 init_utsname()->release
, gadget
->name
);
2399 void usb_composite_overwrite_options(struct usb_composite_dev
*cdev
,
2400 struct usb_composite_overwrite
*covr
)
2402 struct usb_device_descriptor
*desc
= &cdev
->desc
;
2403 struct usb_gadget_strings
*gstr
= cdev
->driver
->strings
[0];
2404 struct usb_string
*dev_str
= gstr
->strings
;
2407 desc
->idVendor
= cpu_to_le16(covr
->idVendor
);
2409 if (covr
->idProduct
)
2410 desc
->idProduct
= cpu_to_le16(covr
->idProduct
);
2412 if (covr
->bcdDevice
)
2413 desc
->bcdDevice
= cpu_to_le16(covr
->bcdDevice
);
2415 if (covr
->serial_number
) {
2416 desc
->iSerialNumber
= dev_str
[USB_GADGET_SERIAL_IDX
].id
;
2417 dev_str
[USB_GADGET_SERIAL_IDX
].s
= covr
->serial_number
;
2419 if (covr
->manufacturer
) {
2420 desc
->iManufacturer
= dev_str
[USB_GADGET_MANUFACTURER_IDX
].id
;
2421 dev_str
[USB_GADGET_MANUFACTURER_IDX
].s
= covr
->manufacturer
;
2423 } else if (!strlen(dev_str
[USB_GADGET_MANUFACTURER_IDX
].s
)) {
2424 desc
->iManufacturer
= dev_str
[USB_GADGET_MANUFACTURER_IDX
].id
;
2425 cdev
->def_manufacturer
= composite_default_mfr(cdev
->gadget
);
2426 dev_str
[USB_GADGET_MANUFACTURER_IDX
].s
= cdev
->def_manufacturer
;
2429 if (covr
->product
) {
2430 desc
->iProduct
= dev_str
[USB_GADGET_PRODUCT_IDX
].id
;
2431 dev_str
[USB_GADGET_PRODUCT_IDX
].s
= covr
->product
;
2434 EXPORT_SYMBOL_GPL(usb_composite_overwrite_options
);
2436 MODULE_LICENSE("GPL");
2437 MODULE_AUTHOR("David Brownell");