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
;
206 if (g
->speed
== USB_SPEED_HIGH
&& (usb_endpoint_xfer_isoc(_ep
->desc
) ||
207 usb_endpoint_xfer_int(_ep
->desc
)))
208 _ep
->mult
= usb_endpoint_maxp_mult(_ep
->desc
);
214 * Companion descriptor should follow EP descriptor
215 * USB 3.0 spec, #9.6.7
217 comp_desc
= (struct usb_ss_ep_comp_descriptor
*)*(++d_spd
);
219 (comp_desc
->bDescriptorType
!= USB_DT_SS_ENDPOINT_COMP
))
221 _ep
->comp_desc
= comp_desc
;
222 if (g
->speed
>= USB_SPEED_SUPER
) {
223 switch (usb_endpoint_type(_ep
->desc
)) {
224 case USB_ENDPOINT_XFER_ISOC
:
225 /* mult: bits 1:0 of bmAttributes */
226 _ep
->mult
= (comp_desc
->bmAttributes
& 0x3) + 1;
227 case USB_ENDPOINT_XFER_BULK
:
228 case USB_ENDPOINT_XFER_INT
:
229 _ep
->maxburst
= comp_desc
->bMaxBurst
+ 1;
232 if (comp_desc
->bMaxBurst
!= 0)
233 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 EXPORT_SYMBOL_GPL(usb_remove_function
);
322 * usb_function_deactivate - prevent function and gadget enumeration
323 * @function: the function that isn't yet ready to respond
325 * Blocks response of the gadget driver to host enumeration by
326 * preventing the data line pullup from being activated. This is
327 * normally called during @bind() processing to change from the
328 * initial "ready to respond" state, or when a required resource
331 * For example, drivers that serve as a passthrough to a userspace
332 * daemon can block enumeration unless that daemon (such as an OBEX,
333 * MTP, or print server) is ready to handle host requests.
335 * Not all systems support software control of their USB peripheral
338 * Returns zero on success, else negative errno.
340 int usb_function_deactivate(struct usb_function
*function
)
342 struct usb_composite_dev
*cdev
= function
->config
->cdev
;
346 spin_lock_irqsave(&cdev
->lock
, flags
);
348 if (cdev
->deactivations
== 0)
349 status
= usb_gadget_deactivate(cdev
->gadget
);
351 cdev
->deactivations
++;
353 spin_unlock_irqrestore(&cdev
->lock
, flags
);
356 EXPORT_SYMBOL_GPL(usb_function_deactivate
);
359 * usb_function_activate - allow function and gadget enumeration
360 * @function: function on which usb_function_activate() was called
362 * Reverses effect of usb_function_deactivate(). If no more functions
363 * are delaying their activation, the gadget driver will respond to
364 * host enumeration procedures.
366 * Returns zero on success, else negative errno.
368 int usb_function_activate(struct usb_function
*function
)
370 struct usb_composite_dev
*cdev
= function
->config
->cdev
;
374 spin_lock_irqsave(&cdev
->lock
, flags
);
376 if (WARN_ON(cdev
->deactivations
== 0))
379 cdev
->deactivations
--;
380 if (cdev
->deactivations
== 0)
381 status
= usb_gadget_activate(cdev
->gadget
);
384 spin_unlock_irqrestore(&cdev
->lock
, flags
);
387 EXPORT_SYMBOL_GPL(usb_function_activate
);
390 * usb_interface_id() - allocate an unused interface ID
391 * @config: configuration associated with the interface
392 * @function: function handling the interface
393 * Context: single threaded during gadget setup
395 * usb_interface_id() is called from usb_function.bind() callbacks to
396 * allocate new interface IDs. The function driver will then store that
397 * ID in interface, association, CDC union, and other descriptors. It
398 * will also handle any control requests targeted at that interface,
399 * particularly changing its altsetting via set_alt(). There may
400 * also be class-specific or vendor-specific requests to handle.
402 * All interface identifier should be allocated using this routine, to
403 * ensure that for example different functions don't wrongly assign
404 * different meanings to the same identifier. Note that since interface
405 * identifiers are configuration-specific, functions used in more than
406 * one configuration (or more than once in a given configuration) need
407 * multiple versions of the relevant descriptors.
409 * Returns the interface ID which was allocated; or -ENODEV if no
410 * more interface IDs can be allocated.
412 int usb_interface_id(struct usb_configuration
*config
,
413 struct usb_function
*function
)
415 unsigned id
= config
->next_interface_id
;
417 if (id
< MAX_CONFIG_INTERFACES
) {
418 config
->interface
[id
] = function
;
419 config
->next_interface_id
= id
+ 1;
424 EXPORT_SYMBOL_GPL(usb_interface_id
);
426 static u8
encode_bMaxPower(enum usb_device_speed speed
,
427 struct usb_configuration
*c
)
434 val
= CONFIG_USB_GADGET_VBUS_DRAW
;
438 case USB_SPEED_SUPER
:
439 return DIV_ROUND_UP(val
, 8);
441 return DIV_ROUND_UP(val
, 2);
445 static int config_buf(struct usb_configuration
*config
,
446 enum usb_device_speed speed
, void *buf
, u8 type
)
448 struct usb_config_descriptor
*c
= buf
;
449 void *next
= buf
+ USB_DT_CONFIG_SIZE
;
451 struct usb_function
*f
;
454 len
= USB_COMP_EP0_BUFSIZ
- USB_DT_CONFIG_SIZE
;
455 /* write the config descriptor */
457 c
->bLength
= USB_DT_CONFIG_SIZE
;
458 c
->bDescriptorType
= type
;
459 /* wTotalLength is written later */
460 c
->bNumInterfaces
= config
->next_interface_id
;
461 c
->bConfigurationValue
= config
->bConfigurationValue
;
462 c
->iConfiguration
= config
->iConfiguration
;
463 c
->bmAttributes
= USB_CONFIG_ATT_ONE
| config
->bmAttributes
;
464 c
->bMaxPower
= encode_bMaxPower(speed
, config
);
466 /* There may be e.g. OTG descriptors */
467 if (config
->descriptors
) {
468 status
= usb_descriptor_fillbuf(next
, len
,
469 config
->descriptors
);
476 /* add each function's descriptors */
477 list_for_each_entry(f
, &config
->functions
, list
) {
478 struct usb_descriptor_header
**descriptors
;
480 descriptors
= function_descriptors(f
, speed
);
483 status
= usb_descriptor_fillbuf(next
, len
,
484 (const struct usb_descriptor_header
**) descriptors
);
492 c
->wTotalLength
= cpu_to_le16(len
);
496 static int config_desc(struct usb_composite_dev
*cdev
, unsigned w_value
)
498 struct usb_gadget
*gadget
= cdev
->gadget
;
499 struct usb_configuration
*c
;
500 struct list_head
*pos
;
501 u8 type
= w_value
>> 8;
502 enum usb_device_speed speed
= USB_SPEED_UNKNOWN
;
504 if (gadget
->speed
>= USB_SPEED_SUPER
)
505 speed
= gadget
->speed
;
506 else if (gadget_is_dualspeed(gadget
)) {
508 if (gadget
->speed
== USB_SPEED_HIGH
)
510 if (type
== USB_DT_OTHER_SPEED_CONFIG
)
513 speed
= USB_SPEED_HIGH
;
517 /* This is a lookup by config *INDEX* */
520 pos
= &cdev
->configs
;
521 c
= cdev
->os_desc_config
;
525 while ((pos
= pos
->next
) != &cdev
->configs
) {
526 c
= list_entry(pos
, typeof(*c
), list
);
528 /* skip OS Descriptors config which is handled separately */
529 if (c
== cdev
->os_desc_config
)
533 /* ignore configs that won't work at this speed */
535 case USB_SPEED_SUPER_PLUS
:
536 if (!c
->superspeed_plus
)
539 case USB_SPEED_SUPER
:
553 return config_buf(c
, speed
, cdev
->req
->buf
, type
);
559 static int count_configs(struct usb_composite_dev
*cdev
, unsigned type
)
561 struct usb_gadget
*gadget
= cdev
->gadget
;
562 struct usb_configuration
*c
;
568 if (gadget_is_dualspeed(gadget
)) {
569 if (gadget
->speed
== USB_SPEED_HIGH
)
571 if (gadget
->speed
== USB_SPEED_SUPER
)
573 if (gadget
->speed
== USB_SPEED_SUPER_PLUS
)
575 if (type
== USB_DT_DEVICE_QUALIFIER
)
578 list_for_each_entry(c
, &cdev
->configs
, list
) {
579 /* ignore configs that won't work at this speed */
581 if (!c
->superspeed_plus
)
599 * bos_desc() - prepares the BOS descriptor.
600 * @cdev: pointer to usb_composite device to generate the bos
603 * This function generates the BOS (Binary Device Object)
604 * descriptor and its device capabilities descriptors. The BOS
605 * descriptor should be supported by a SuperSpeed device.
607 static int bos_desc(struct usb_composite_dev
*cdev
)
609 struct usb_ext_cap_descriptor
*usb_ext
;
610 struct usb_ss_cap_descriptor
*ss_cap
;
611 struct usb_dcd_config_params dcd_config_params
;
612 struct usb_bos_descriptor
*bos
= cdev
->req
->buf
;
614 bos
->bLength
= USB_DT_BOS_SIZE
;
615 bos
->bDescriptorType
= USB_DT_BOS
;
617 bos
->wTotalLength
= cpu_to_le16(USB_DT_BOS_SIZE
);
618 bos
->bNumDeviceCaps
= 0;
621 * A SuperSpeed device shall include the USB2.0 extension descriptor
622 * and shall support LPM when operating in USB2.0 HS mode.
624 usb_ext
= cdev
->req
->buf
+ le16_to_cpu(bos
->wTotalLength
);
625 bos
->bNumDeviceCaps
++;
626 le16_add_cpu(&bos
->wTotalLength
, USB_DT_USB_EXT_CAP_SIZE
);
627 usb_ext
->bLength
= USB_DT_USB_EXT_CAP_SIZE
;
628 usb_ext
->bDescriptorType
= USB_DT_DEVICE_CAPABILITY
;
629 usb_ext
->bDevCapabilityType
= USB_CAP_TYPE_EXT
;
630 usb_ext
->bmAttributes
= cpu_to_le32(USB_LPM_SUPPORT
| USB_BESL_SUPPORT
);
633 * The Superspeed USB Capability descriptor shall be implemented by all
634 * SuperSpeed devices.
636 ss_cap
= cdev
->req
->buf
+ le16_to_cpu(bos
->wTotalLength
);
637 bos
->bNumDeviceCaps
++;
638 le16_add_cpu(&bos
->wTotalLength
, USB_DT_USB_SS_CAP_SIZE
);
639 ss_cap
->bLength
= USB_DT_USB_SS_CAP_SIZE
;
640 ss_cap
->bDescriptorType
= USB_DT_DEVICE_CAPABILITY
;
641 ss_cap
->bDevCapabilityType
= USB_SS_CAP_TYPE
;
642 ss_cap
->bmAttributes
= 0; /* LTM is not supported yet */
643 ss_cap
->wSpeedSupported
= cpu_to_le16(USB_LOW_SPEED_OPERATION
|
644 USB_FULL_SPEED_OPERATION
|
645 USB_HIGH_SPEED_OPERATION
|
646 USB_5GBPS_OPERATION
);
647 ss_cap
->bFunctionalitySupport
= USB_LOW_SPEED_OPERATION
;
649 /* Get Controller configuration */
650 if (cdev
->gadget
->ops
->get_config_params
)
651 cdev
->gadget
->ops
->get_config_params(&dcd_config_params
);
653 dcd_config_params
.bU1devExitLat
= USB_DEFAULT_U1_DEV_EXIT_LAT
;
654 dcd_config_params
.bU2DevExitLat
=
655 cpu_to_le16(USB_DEFAULT_U2_DEV_EXIT_LAT
);
657 ss_cap
->bU1devExitLat
= dcd_config_params
.bU1devExitLat
;
658 ss_cap
->bU2DevExitLat
= dcd_config_params
.bU2DevExitLat
;
660 /* The SuperSpeedPlus USB Device Capability descriptor */
661 if (gadget_is_superspeed_plus(cdev
->gadget
)) {
662 struct usb_ssp_cap_descriptor
*ssp_cap
;
664 ssp_cap
= cdev
->req
->buf
+ le16_to_cpu(bos
->wTotalLength
);
665 bos
->bNumDeviceCaps
++;
668 * Report typical values.
671 le16_add_cpu(&bos
->wTotalLength
, USB_DT_USB_SSP_CAP_SIZE(1));
672 ssp_cap
->bLength
= USB_DT_USB_SSP_CAP_SIZE(1);
673 ssp_cap
->bDescriptorType
= USB_DT_DEVICE_CAPABILITY
;
674 ssp_cap
->bDevCapabilityType
= USB_SSP_CAP_TYPE
;
675 ssp_cap
->bReserved
= 0;
676 ssp_cap
->wReserved
= 0;
678 /* SSAC = 1 (2 attributes) */
679 ssp_cap
->bmAttributes
= cpu_to_le32(1);
681 /* Min RX/TX Lane Count = 1 */
682 ssp_cap
->wFunctionalitySupport
=
683 cpu_to_le16((1 << 8) | (1 << 12));
686 * bmSublinkSpeedAttr[0]:
689 * LP = 1 (SuperSpeedPlus)
692 ssp_cap
->bmSublinkSpeedAttr
[0] =
693 cpu_to_le32((3 << 4) | (1 << 14) | (0xa << 16));
695 * bmSublinkSpeedAttr[1] =
698 * LP = 1 (SuperSpeedPlus)
701 ssp_cap
->bmSublinkSpeedAttr
[1] =
702 cpu_to_le32((3 << 4) | (1 << 14) |
703 (0xa << 16) | (1 << 7));
706 return le16_to_cpu(bos
->wTotalLength
);
709 static void device_qual(struct usb_composite_dev
*cdev
)
711 struct usb_qualifier_descriptor
*qual
= cdev
->req
->buf
;
713 qual
->bLength
= sizeof(*qual
);
714 qual
->bDescriptorType
= USB_DT_DEVICE_QUALIFIER
;
715 /* POLICY: same bcdUSB and device type info at both speeds */
716 qual
->bcdUSB
= cdev
->desc
.bcdUSB
;
717 qual
->bDeviceClass
= cdev
->desc
.bDeviceClass
;
718 qual
->bDeviceSubClass
= cdev
->desc
.bDeviceSubClass
;
719 qual
->bDeviceProtocol
= cdev
->desc
.bDeviceProtocol
;
720 /* ASSUME same EP0 fifo size at both speeds */
721 qual
->bMaxPacketSize0
= cdev
->gadget
->ep0
->maxpacket
;
722 qual
->bNumConfigurations
= count_configs(cdev
, USB_DT_DEVICE_QUALIFIER
);
726 /*-------------------------------------------------------------------------*/
728 static void reset_config(struct usb_composite_dev
*cdev
)
730 struct usb_function
*f
;
732 DBG(cdev
, "reset config\n");
734 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
738 bitmap_zero(f
->endpoints
, 32);
741 cdev
->delayed_status
= 0;
744 static int set_config(struct usb_composite_dev
*cdev
,
745 const struct usb_ctrlrequest
*ctrl
, unsigned number
)
747 struct usb_gadget
*gadget
= cdev
->gadget
;
748 struct usb_configuration
*c
= NULL
;
749 int result
= -EINVAL
;
750 unsigned power
= gadget_is_otg(gadget
) ? 8 : 100;
754 list_for_each_entry(c
, &cdev
->configs
, list
) {
755 if (c
->bConfigurationValue
== number
) {
757 * We disable the FDs of the previous
758 * configuration only if the new configuration
769 } else { /* Zero configuration value - need to reset the config */
775 INFO(cdev
, "%s config #%d: %s\n",
776 usb_speed_string(gadget
->speed
),
777 number
, c
? c
->label
: "unconfigured");
782 usb_gadget_set_state(gadget
, USB_STATE_CONFIGURED
);
785 /* Initialize all interfaces by setting them to altsetting zero. */
786 for (tmp
= 0; tmp
< MAX_CONFIG_INTERFACES
; tmp
++) {
787 struct usb_function
*f
= c
->interface
[tmp
];
788 struct usb_descriptor_header
**descriptors
;
794 * Record which endpoints are used by the function. This is used
795 * to dispatch control requests targeted at that endpoint to the
796 * function's setup callback instead of the current
797 * configuration's setup callback.
799 descriptors
= function_descriptors(f
, gadget
->speed
);
801 for (; *descriptors
; ++descriptors
) {
802 struct usb_endpoint_descriptor
*ep
;
805 if ((*descriptors
)->bDescriptorType
!= USB_DT_ENDPOINT
)
808 ep
= (struct usb_endpoint_descriptor
*)*descriptors
;
809 addr
= ((ep
->bEndpointAddress
& 0x80) >> 3)
810 | (ep
->bEndpointAddress
& 0x0f);
811 set_bit(addr
, f
->endpoints
);
814 result
= f
->set_alt(f
, tmp
, 0);
816 DBG(cdev
, "interface %d (%s/%p) alt 0 --> %d\n",
817 tmp
, f
->name
, f
, result
);
823 if (result
== USB_GADGET_DELAYED_STATUS
) {
825 "%s: interface %d (%s) requested delayed status\n",
826 __func__
, tmp
, f
->name
);
827 cdev
->delayed_status
++;
828 DBG(cdev
, "delayed_status count %d\n",
829 cdev
->delayed_status
);
833 /* when we return, be sure our power usage is valid */
834 power
= c
->MaxPower
? c
->MaxPower
: CONFIG_USB_GADGET_VBUS_DRAW
;
836 usb_gadget_vbus_draw(gadget
, power
);
837 if (result
>= 0 && cdev
->delayed_status
)
838 result
= USB_GADGET_DELAYED_STATUS
;
842 int usb_add_config_only(struct usb_composite_dev
*cdev
,
843 struct usb_configuration
*config
)
845 struct usb_configuration
*c
;
847 if (!config
->bConfigurationValue
)
850 /* Prevent duplicate configuration identifiers */
851 list_for_each_entry(c
, &cdev
->configs
, list
) {
852 if (c
->bConfigurationValue
== config
->bConfigurationValue
)
857 list_add_tail(&config
->list
, &cdev
->configs
);
859 INIT_LIST_HEAD(&config
->functions
);
860 config
->next_interface_id
= 0;
861 memset(config
->interface
, 0, sizeof(config
->interface
));
865 EXPORT_SYMBOL_GPL(usb_add_config_only
);
868 * usb_add_config() - add a configuration to a device.
869 * @cdev: wraps the USB gadget
870 * @config: the configuration, with bConfigurationValue assigned
871 * @bind: the configuration's bind function
872 * Context: single threaded during gadget setup
874 * One of the main tasks of a composite @bind() routine is to
875 * add each of the configurations it supports, using this routine.
877 * This function returns the value of the configuration's @bind(), which
878 * is zero for success else a negative errno value. Binding configurations
879 * assigns global resources including string IDs, and per-configuration
880 * resources such as interface IDs and endpoints.
882 int usb_add_config(struct usb_composite_dev
*cdev
,
883 struct usb_configuration
*config
,
884 int (*bind
)(struct usb_configuration
*))
886 int status
= -EINVAL
;
891 DBG(cdev
, "adding config #%u '%s'/%p\n",
892 config
->bConfigurationValue
,
893 config
->label
, config
);
895 status
= usb_add_config_only(cdev
, config
);
899 status
= bind(config
);
901 while (!list_empty(&config
->functions
)) {
902 struct usb_function
*f
;
904 f
= list_first_entry(&config
->functions
,
905 struct usb_function
, list
);
908 DBG(cdev
, "unbind function '%s'/%p\n",
910 f
->unbind(config
, f
);
911 /* may free memory for "f" */
914 list_del(&config
->list
);
919 DBG(cdev
, "cfg %d/%p speeds:%s%s%s%s\n",
920 config
->bConfigurationValue
, config
,
921 config
->superspeed_plus
? " superplus" : "",
922 config
->superspeed
? " super" : "",
923 config
->highspeed
? " high" : "",
925 ? (gadget_is_dualspeed(cdev
->gadget
)
930 for (i
= 0; i
< MAX_CONFIG_INTERFACES
; i
++) {
931 struct usb_function
*f
= config
->interface
[i
];
935 DBG(cdev
, " interface %d = %s/%p\n",
940 /* set_alt(), or next bind(), sets up ep->claimed as needed */
941 usb_ep_autoconfig_reset(cdev
->gadget
);
945 DBG(cdev
, "added config '%s'/%u --> %d\n", config
->label
,
946 config
->bConfigurationValue
, status
);
949 EXPORT_SYMBOL_GPL(usb_add_config
);
951 static void remove_config(struct usb_composite_dev
*cdev
,
952 struct usb_configuration
*config
)
954 while (!list_empty(&config
->functions
)) {
955 struct usb_function
*f
;
957 f
= list_first_entry(&config
->functions
,
958 struct usb_function
, list
);
961 DBG(cdev
, "unbind function '%s'/%p\n", f
->name
, f
);
962 f
->unbind(config
, f
);
963 /* may free memory for "f" */
966 list_del(&config
->list
);
967 if (config
->unbind
) {
968 DBG(cdev
, "unbind config '%s'/%p\n", config
->label
, config
);
969 config
->unbind(config
);
970 /* may free memory for "c" */
975 * usb_remove_config() - remove a configuration from a device.
976 * @cdev: wraps the USB gadget
977 * @config: the configuration
979 * Drivers must call usb_gadget_disconnect before calling this function
980 * to disconnect the device from the host and make sure the host will not
981 * try to enumerate the device while we are changing the config list.
983 void usb_remove_config(struct usb_composite_dev
*cdev
,
984 struct usb_configuration
*config
)
988 spin_lock_irqsave(&cdev
->lock
, flags
);
990 if (cdev
->config
== config
)
993 spin_unlock_irqrestore(&cdev
->lock
, flags
);
995 remove_config(cdev
, config
);
998 /*-------------------------------------------------------------------------*/
1000 /* We support strings in multiple languages ... string descriptor zero
1001 * says which languages are supported. The typical case will be that
1002 * only one language (probably English) is used, with i18n handled on
1006 static void collect_langs(struct usb_gadget_strings
**sp
, __le16
*buf
)
1008 const struct usb_gadget_strings
*s
;
1014 language
= cpu_to_le16(s
->language
);
1015 for (tmp
= buf
; *tmp
&& tmp
< &buf
[126]; tmp
++) {
1016 if (*tmp
== language
)
1025 static int lookup_string(
1026 struct usb_gadget_strings
**sp
,
1032 struct usb_gadget_strings
*s
;
1037 if (s
->language
!= language
)
1039 value
= usb_gadget_get_string(s
, id
, buf
);
1046 static int get_string(struct usb_composite_dev
*cdev
,
1047 void *buf
, u16 language
, int id
)
1049 struct usb_composite_driver
*composite
= cdev
->driver
;
1050 struct usb_gadget_string_container
*uc
;
1051 struct usb_configuration
*c
;
1052 struct usb_function
*f
;
1055 /* Yes, not only is USB's i18n support probably more than most
1056 * folk will ever care about ... also, it's all supported here.
1057 * (Except for UTF8 support for Unicode's "Astral Planes".)
1060 /* 0 == report all available language codes */
1062 struct usb_string_descriptor
*s
= buf
;
1063 struct usb_gadget_strings
**sp
;
1066 s
->bDescriptorType
= USB_DT_STRING
;
1068 sp
= composite
->strings
;
1070 collect_langs(sp
, s
->wData
);
1072 list_for_each_entry(c
, &cdev
->configs
, list
) {
1075 collect_langs(sp
, s
->wData
);
1077 list_for_each_entry(f
, &c
->functions
, list
) {
1080 collect_langs(sp
, s
->wData
);
1083 list_for_each_entry(uc
, &cdev
->gstrings
, list
) {
1084 struct usb_gadget_strings
**sp
;
1086 sp
= get_containers_gs(uc
);
1087 collect_langs(sp
, s
->wData
);
1090 for (len
= 0; len
<= 126 && s
->wData
[len
]; len
++)
1095 s
->bLength
= 2 * (len
+ 1);
1099 if (cdev
->use_os_string
&& language
== 0 && id
== OS_STRING_IDX
) {
1100 struct usb_os_string
*b
= buf
;
1101 b
->bLength
= sizeof(*b
);
1102 b
->bDescriptorType
= USB_DT_STRING
;
1104 sizeof(b
->qwSignature
) == sizeof(cdev
->qw_sign
),
1105 "qwSignature size must be equal to qw_sign");
1106 memcpy(&b
->qwSignature
, cdev
->qw_sign
, sizeof(b
->qwSignature
));
1107 b
->bMS_VendorCode
= cdev
->b_vendor_code
;
1112 list_for_each_entry(uc
, &cdev
->gstrings
, list
) {
1113 struct usb_gadget_strings
**sp
;
1115 sp
= get_containers_gs(uc
);
1116 len
= lookup_string(sp
, buf
, language
, id
);
1121 /* String IDs are device-scoped, so we look up each string
1122 * table we're told about. These lookups are infrequent;
1123 * simpler-is-better here.
1125 if (composite
->strings
) {
1126 len
= lookup_string(composite
->strings
, buf
, language
, id
);
1130 list_for_each_entry(c
, &cdev
->configs
, list
) {
1132 len
= lookup_string(c
->strings
, buf
, language
, id
);
1136 list_for_each_entry(f
, &c
->functions
, list
) {
1139 len
= lookup_string(f
->strings
, buf
, language
, id
);
1148 * usb_string_id() - allocate an unused string ID
1149 * @cdev: the device whose string descriptor IDs are being allocated
1150 * Context: single threaded during gadget setup
1152 * @usb_string_id() is called from bind() callbacks to allocate
1153 * string IDs. Drivers for functions, configurations, or gadgets will
1154 * then store that ID in the appropriate descriptors and string table.
1156 * All string identifier should be allocated using this,
1157 * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure
1158 * that for example different functions don't wrongly assign different
1159 * meanings to the same identifier.
1161 int usb_string_id(struct usb_composite_dev
*cdev
)
1163 if (cdev
->next_string_id
< 254) {
1164 /* string id 0 is reserved by USB spec for list of
1165 * supported languages */
1166 /* 255 reserved as well? -- mina86 */
1167 cdev
->next_string_id
++;
1168 return cdev
->next_string_id
;
1172 EXPORT_SYMBOL_GPL(usb_string_id
);
1175 * usb_string_ids() - allocate unused string IDs in batch
1176 * @cdev: the device whose string descriptor IDs are being allocated
1177 * @str: an array of usb_string objects to assign numbers to
1178 * Context: single threaded during gadget setup
1180 * @usb_string_ids() is called from bind() callbacks to allocate
1181 * string IDs. Drivers for functions, configurations, or gadgets will
1182 * then copy IDs from the string table to the appropriate descriptors
1183 * and string table for other languages.
1185 * All string identifier should be allocated using this,
1186 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1187 * example different functions don't wrongly assign different meanings
1188 * to the same identifier.
1190 int usb_string_ids_tab(struct usb_composite_dev
*cdev
, struct usb_string
*str
)
1192 int next
= cdev
->next_string_id
;
1194 for (; str
->s
; ++str
) {
1195 if (unlikely(next
>= 254))
1200 cdev
->next_string_id
= next
;
1204 EXPORT_SYMBOL_GPL(usb_string_ids_tab
);
1206 static struct usb_gadget_string_container
*copy_gadget_strings(
1207 struct usb_gadget_strings
**sp
, unsigned n_gstrings
,
1210 struct usb_gadget_string_container
*uc
;
1211 struct usb_gadget_strings
**gs_array
;
1212 struct usb_gadget_strings
*gs
;
1213 struct usb_string
*s
;
1220 mem
+= sizeof(void *) * (n_gstrings
+ 1);
1221 mem
+= sizeof(struct usb_gadget_strings
) * n_gstrings
;
1222 mem
+= sizeof(struct usb_string
) * (n_strings
+ 1) * (n_gstrings
);
1223 uc
= kmalloc(mem
, GFP_KERNEL
);
1225 return ERR_PTR(-ENOMEM
);
1226 gs_array
= get_containers_gs(uc
);
1228 stash
+= sizeof(void *) * (n_gstrings
+ 1);
1229 for (n_gs
= 0; n_gs
< n_gstrings
; n_gs
++) {
1230 struct usb_string
*org_s
;
1232 gs_array
[n_gs
] = stash
;
1233 gs
= gs_array
[n_gs
];
1234 stash
+= sizeof(struct usb_gadget_strings
);
1235 gs
->language
= sp
[n_gs
]->language
;
1236 gs
->strings
= stash
;
1237 org_s
= sp
[n_gs
]->strings
;
1239 for (n_s
= 0; n_s
< n_strings
; n_s
++) {
1241 stash
+= sizeof(struct usb_string
);
1250 stash
+= sizeof(struct usb_string
);
1253 gs_array
[n_gs
] = NULL
;
1258 * usb_gstrings_attach() - attach gadget strings to a cdev and assign ids
1259 * @cdev: the device whose string descriptor IDs are being allocated
1261 * @sp: an array of usb_gadget_strings to attach.
1262 * @n_strings: number of entries in each usb_strings array (sp[]->strings)
1264 * This function will create a deep copy of usb_gadget_strings and usb_string
1265 * and attach it to the cdev. The actual string (usb_string.s) will not be
1266 * copied but only a referenced will be made. The struct usb_gadget_strings
1267 * array may contain multiple languages and should be NULL terminated.
1268 * The ->language pointer of each struct usb_gadget_strings has to contain the
1269 * same amount of entries.
1270 * For instance: sp[0] is en-US, sp[1] is es-ES. It is expected that the first
1271 * usb_string entry of es-ES contains the translation of the first usb_string
1272 * entry of en-US. Therefore both entries become the same id assign.
1274 struct usb_string
*usb_gstrings_attach(struct usb_composite_dev
*cdev
,
1275 struct usb_gadget_strings
**sp
, unsigned n_strings
)
1277 struct usb_gadget_string_container
*uc
;
1278 struct usb_gadget_strings
**n_gs
;
1279 unsigned n_gstrings
= 0;
1283 for (i
= 0; sp
[i
]; i
++)
1287 return ERR_PTR(-EINVAL
);
1289 uc
= copy_gadget_strings(sp
, n_gstrings
, n_strings
);
1291 return ERR_CAST(uc
);
1293 n_gs
= get_containers_gs(uc
);
1294 ret
= usb_string_ids_tab(cdev
, n_gs
[0]->strings
);
1298 for (i
= 1; i
< n_gstrings
; i
++) {
1299 struct usb_string
*m_s
;
1300 struct usb_string
*s
;
1303 m_s
= n_gs
[0]->strings
;
1304 s
= n_gs
[i
]->strings
;
1305 for (n
= 0; n
< n_strings
; n
++) {
1311 list_add_tail(&uc
->list
, &cdev
->gstrings
);
1312 return n_gs
[0]->strings
;
1315 return ERR_PTR(ret
);
1317 EXPORT_SYMBOL_GPL(usb_gstrings_attach
);
1320 * usb_string_ids_n() - allocate unused string IDs in batch
1321 * @c: the device whose string descriptor IDs are being allocated
1322 * @n: number of string IDs to allocate
1323 * Context: single threaded during gadget setup
1325 * Returns the first requested ID. This ID and next @n-1 IDs are now
1326 * valid IDs. At least provided that @n is non-zero because if it
1327 * is, returns last requested ID which is now very useful information.
1329 * @usb_string_ids_n() is called from bind() callbacks to allocate
1330 * string IDs. Drivers for functions, configurations, or gadgets will
1331 * then store that ID in the appropriate descriptors and string table.
1333 * All string identifier should be allocated using this,
1334 * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for
1335 * example different functions don't wrongly assign different meanings
1336 * to the same identifier.
1338 int usb_string_ids_n(struct usb_composite_dev
*c
, unsigned n
)
1340 unsigned next
= c
->next_string_id
;
1341 if (unlikely(n
> 254 || (unsigned)next
+ n
> 254))
1343 c
->next_string_id
+= n
;
1346 EXPORT_SYMBOL_GPL(usb_string_ids_n
);
1348 /*-------------------------------------------------------------------------*/
1350 static void composite_setup_complete(struct usb_ep
*ep
, struct usb_request
*req
)
1352 struct usb_composite_dev
*cdev
;
1354 if (req
->status
|| req
->actual
!= req
->length
)
1355 DBG((struct usb_composite_dev
*) ep
->driver_data
,
1356 "setup complete --> %d, %d/%d\n",
1357 req
->status
, req
->actual
, req
->length
);
1360 * REVIST The same ep0 requests are shared with function drivers
1361 * so they don't have to maintain the same ->complete() stubs.
1363 * Because of that, we need to check for the validity of ->context
1364 * here, even though we know we've set it to something useful.
1369 cdev
= req
->context
;
1371 if (cdev
->req
== req
)
1372 cdev
->setup_pending
= false;
1373 else if (cdev
->os_desc_req
== req
)
1374 cdev
->os_desc_pending
= false;
1376 WARN(1, "unknown request %p\n", req
);
1379 static int composite_ep0_queue(struct usb_composite_dev
*cdev
,
1380 struct usb_request
*req
, gfp_t gfp_flags
)
1384 ret
= usb_ep_queue(cdev
->gadget
->ep0
, req
, gfp_flags
);
1386 if (cdev
->req
== req
)
1387 cdev
->setup_pending
= true;
1388 else if (cdev
->os_desc_req
== req
)
1389 cdev
->os_desc_pending
= true;
1391 WARN(1, "unknown request %p\n", req
);
1397 static int count_ext_compat(struct usb_configuration
*c
)
1402 for (i
= 0; i
< c
->next_interface_id
; ++i
) {
1403 struct usb_function
*f
;
1406 f
= c
->interface
[i
];
1407 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1408 struct usb_os_desc
*d
;
1410 if (i
!= f
->os_desc_table
[j
].if_id
)
1412 d
= f
->os_desc_table
[j
].os_desc
;
1413 if (d
&& d
->ext_compat_id
)
1421 static void fill_ext_compat(struct usb_configuration
*c
, u8
*buf
)
1426 for (i
= 0; i
< c
->next_interface_id
; ++i
) {
1427 struct usb_function
*f
;
1430 f
= c
->interface
[i
];
1431 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1432 struct usb_os_desc
*d
;
1434 if (i
!= f
->os_desc_table
[j
].if_id
)
1436 d
= f
->os_desc_table
[j
].os_desc
;
1437 if (d
&& d
->ext_compat_id
) {
1440 memcpy(buf
, d
->ext_compat_id
, 16);
1454 static int count_ext_prop(struct usb_configuration
*c
, int interface
)
1456 struct usb_function
*f
;
1459 f
= c
->interface
[interface
];
1460 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1461 struct usb_os_desc
*d
;
1463 if (interface
!= f
->os_desc_table
[j
].if_id
)
1465 d
= f
->os_desc_table
[j
].os_desc
;
1466 if (d
&& d
->ext_compat_id
)
1467 return d
->ext_prop_count
;
1472 static int len_ext_prop(struct usb_configuration
*c
, int interface
)
1474 struct usb_function
*f
;
1475 struct usb_os_desc
*d
;
1478 res
= 10; /* header length */
1479 f
= c
->interface
[interface
];
1480 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1481 if (interface
!= f
->os_desc_table
[j
].if_id
)
1483 d
= f
->os_desc_table
[j
].os_desc
;
1485 return min(res
+ d
->ext_prop_len
, 4096);
1490 static int fill_ext_prop(struct usb_configuration
*c
, int interface
, u8
*buf
)
1492 struct usb_function
*f
;
1493 struct usb_os_desc
*d
;
1494 struct usb_os_desc_ext_prop
*ext_prop
;
1495 int j
, count
, n
, ret
;
1498 f
= c
->interface
[interface
];
1499 for (j
= 0; j
< f
->os_desc_n
; ++j
) {
1500 if (interface
!= f
->os_desc_table
[j
].if_id
)
1502 d
= f
->os_desc_table
[j
].os_desc
;
1504 list_for_each_entry(ext_prop
, &d
->ext_prop
, entry
) {
1505 /* 4kB minus header length */
1510 count
= ext_prop
->data_len
+
1511 ext_prop
->name_len
+ 14;
1512 if (count
> 4086 - n
)
1514 usb_ext_prop_put_size(buf
, count
);
1515 usb_ext_prop_put_type(buf
, ext_prop
->type
);
1516 ret
= usb_ext_prop_put_name(buf
, ext_prop
->name
,
1517 ext_prop
->name_len
);
1520 switch (ext_prop
->type
) {
1521 case USB_EXT_PROP_UNICODE
:
1522 case USB_EXT_PROP_UNICODE_ENV
:
1523 case USB_EXT_PROP_UNICODE_LINK
:
1524 usb_ext_prop_put_unicode(buf
, ret
,
1526 ext_prop
->data_len
);
1528 case USB_EXT_PROP_BINARY
:
1529 usb_ext_prop_put_binary(buf
, ret
,
1531 ext_prop
->data_len
);
1533 case USB_EXT_PROP_LE32
:
1534 /* not implemented */
1535 case USB_EXT_PROP_BE32
:
1536 /* not implemented */
1548 * The setup() callback implements all the ep0 functionality that's
1549 * not handled lower down, in hardware or the hardware driver(like
1550 * device and endpoint feature flags, and their status). It's all
1551 * housekeeping for the gadget function we're implementing. Most of
1552 * the work is in config and function specific setup.
1555 composite_setup(struct usb_gadget
*gadget
, const struct usb_ctrlrequest
*ctrl
)
1557 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
1558 struct usb_request
*req
= cdev
->req
;
1559 int value
= -EOPNOTSUPP
;
1561 u16 w_index
= le16_to_cpu(ctrl
->wIndex
);
1562 u8 intf
= w_index
& 0xFF;
1563 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
1564 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
1565 struct usb_function
*f
= NULL
;
1568 /* partial re-init of the response message; the function or the
1569 * gadget might need to intercept e.g. a control-OUT completion
1570 * when we delegate to it.
1573 req
->context
= cdev
;
1574 req
->complete
= composite_setup_complete
;
1576 gadget
->ep0
->driver_data
= cdev
;
1579 * Don't let non-standard requests match any of the cases below
1582 if ((ctrl
->bRequestType
& USB_TYPE_MASK
) != USB_TYPE_STANDARD
)
1585 switch (ctrl
->bRequest
) {
1587 /* we handle all standard USB descriptors */
1588 case USB_REQ_GET_DESCRIPTOR
:
1589 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1591 switch (w_value
>> 8) {
1594 cdev
->desc
.bNumConfigurations
=
1595 count_configs(cdev
, USB_DT_DEVICE
);
1596 cdev
->desc
.bMaxPacketSize0
=
1597 cdev
->gadget
->ep0
->maxpacket
;
1598 if (gadget_is_superspeed(gadget
)) {
1599 if (gadget
->speed
>= USB_SPEED_SUPER
) {
1600 cdev
->desc
.bcdUSB
= cpu_to_le16(0x0310);
1601 cdev
->desc
.bMaxPacketSize0
= 9;
1603 cdev
->desc
.bcdUSB
= cpu_to_le16(0x0210);
1606 cdev
->desc
.bcdUSB
= cpu_to_le16(0x0200);
1609 value
= min(w_length
, (u16
) sizeof cdev
->desc
);
1610 memcpy(req
->buf
, &cdev
->desc
, value
);
1612 case USB_DT_DEVICE_QUALIFIER
:
1613 if (!gadget_is_dualspeed(gadget
) ||
1614 gadget
->speed
>= USB_SPEED_SUPER
)
1617 value
= min_t(int, w_length
,
1618 sizeof(struct usb_qualifier_descriptor
));
1620 case USB_DT_OTHER_SPEED_CONFIG
:
1621 if (!gadget_is_dualspeed(gadget
) ||
1622 gadget
->speed
>= USB_SPEED_SUPER
)
1626 value
= config_desc(cdev
, w_value
);
1628 value
= min(w_length
, (u16
) value
);
1631 value
= get_string(cdev
, req
->buf
,
1632 w_index
, w_value
& 0xff);
1634 value
= min(w_length
, (u16
) value
);
1637 if (gadget_is_superspeed(gadget
)) {
1638 value
= bos_desc(cdev
);
1639 value
= min(w_length
, (u16
) value
);
1643 if (gadget_is_otg(gadget
)) {
1644 struct usb_configuration
*config
;
1645 int otg_desc_len
= 0;
1648 config
= cdev
->config
;
1650 config
= list_first_entry(
1652 struct usb_configuration
, list
);
1656 if (gadget
->otg_caps
&&
1657 (gadget
->otg_caps
->otg_rev
>= 0x0200))
1658 otg_desc_len
+= sizeof(
1659 struct usb_otg20_descriptor
);
1661 otg_desc_len
+= sizeof(
1662 struct usb_otg_descriptor
);
1664 value
= min_t(int, w_length
, otg_desc_len
);
1665 memcpy(req
->buf
, config
->descriptors
[0], value
);
1671 /* any number of configs can work */
1672 case USB_REQ_SET_CONFIGURATION
:
1673 if (ctrl
->bRequestType
!= 0)
1675 if (gadget_is_otg(gadget
)) {
1676 if (gadget
->a_hnp_support
)
1677 DBG(cdev
, "HNP available\n");
1678 else if (gadget
->a_alt_hnp_support
)
1679 DBG(cdev
, "HNP on another port\n");
1681 VDBG(cdev
, "HNP inactive\n");
1683 spin_lock(&cdev
->lock
);
1684 value
= set_config(cdev
, ctrl
, w_value
);
1685 spin_unlock(&cdev
->lock
);
1687 case USB_REQ_GET_CONFIGURATION
:
1688 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1691 *(u8
*)req
->buf
= cdev
->config
->bConfigurationValue
;
1693 *(u8
*)req
->buf
= 0;
1694 value
= min(w_length
, (u16
) 1);
1697 /* function drivers must handle get/set altsetting */
1698 case USB_REQ_SET_INTERFACE
:
1699 if (ctrl
->bRequestType
!= USB_RECIP_INTERFACE
)
1701 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1703 f
= cdev
->config
->interface
[intf
];
1708 * If there's no get_alt() method, we know only altsetting zero
1709 * works. There is no need to check if set_alt() is not NULL
1710 * as we check this in usb_add_function().
1712 if (w_value
&& !f
->get_alt
)
1714 value
= f
->set_alt(f
, w_index
, w_value
);
1715 if (value
== USB_GADGET_DELAYED_STATUS
) {
1717 "%s: interface %d (%s) requested delayed status\n",
1718 __func__
, intf
, f
->name
);
1719 cdev
->delayed_status
++;
1720 DBG(cdev
, "delayed_status count %d\n",
1721 cdev
->delayed_status
);
1724 case USB_REQ_GET_INTERFACE
:
1725 if (ctrl
->bRequestType
!= (USB_DIR_IN
|USB_RECIP_INTERFACE
))
1727 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1729 f
= cdev
->config
->interface
[intf
];
1732 /* lots of interfaces only need altsetting zero... */
1733 value
= f
->get_alt
? f
->get_alt(f
, w_index
) : 0;
1736 *((u8
*)req
->buf
) = value
;
1737 value
= min(w_length
, (u16
) 1);
1739 case USB_REQ_GET_STATUS
:
1740 if (gadget_is_otg(gadget
) && gadget
->hnp_polling_support
&&
1741 (w_index
== OTG_STS_SELECTOR
)) {
1742 if (ctrl
->bRequestType
!= (USB_DIR_IN
|
1745 *((u8
*)req
->buf
) = gadget
->host_request_flag
;
1751 * USB 3.0 additions:
1752 * Function driver should handle get_status request. If such cb
1753 * wasn't supplied we respond with default value = 0
1754 * Note: function driver should supply such cb only for the
1755 * first interface of the function
1757 if (!gadget_is_superspeed(gadget
))
1759 if (ctrl
->bRequestType
!= (USB_DIR_IN
| USB_RECIP_INTERFACE
))
1761 value
= 2; /* This is the length of the get_status reply */
1762 put_unaligned_le16(0, req
->buf
);
1763 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1765 f
= cdev
->config
->interface
[intf
];
1768 status
= f
->get_status
? f
->get_status(f
) : 0;
1771 put_unaligned_le16(status
& 0x0000ffff, req
->buf
);
1774 * Function drivers should handle SetFeature/ClearFeature
1775 * (FUNCTION_SUSPEND) request. function_suspend cb should be supplied
1776 * only for the first interface of the function
1778 case USB_REQ_CLEAR_FEATURE
:
1779 case USB_REQ_SET_FEATURE
:
1780 if (!gadget_is_superspeed(gadget
))
1782 if (ctrl
->bRequestType
!= (USB_DIR_OUT
| USB_RECIP_INTERFACE
))
1785 case USB_INTRF_FUNC_SUSPEND
:
1786 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1788 f
= cdev
->config
->interface
[intf
];
1792 if (f
->func_suspend
)
1793 value
= f
->func_suspend(f
, w_index
>> 8);
1796 "func_suspend() returned error %d\n",
1806 * OS descriptors handling
1808 if (cdev
->use_os_string
&& cdev
->os_desc_config
&&
1809 (ctrl
->bRequestType
& USB_TYPE_VENDOR
) &&
1810 ctrl
->bRequest
== cdev
->b_vendor_code
) {
1811 struct usb_request
*req
;
1812 struct usb_configuration
*os_desc_cfg
;
1817 req
= cdev
->os_desc_req
;
1818 req
->context
= cdev
;
1819 req
->complete
= composite_setup_complete
;
1821 os_desc_cfg
= cdev
->os_desc_config
;
1822 memset(buf
, 0, w_length
);
1824 switch (ctrl
->bRequestType
& USB_RECIP_MASK
) {
1825 case USB_RECIP_DEVICE
:
1826 if (w_index
!= 0x4 || (w_value
>> 8))
1829 if (w_length
== 0x10) {
1830 /* Number of ext compat interfaces */
1831 count
= count_ext_compat(os_desc_cfg
);
1833 count
*= 24; /* 24 B/ext compat desc */
1834 count
+= 16; /* header */
1835 put_unaligned_le32(count
, buf
);
1838 /* "extended compatibility ID"s */
1839 count
= count_ext_compat(os_desc_cfg
);
1841 count
*= 24; /* 24 B/ext compat desc */
1842 count
+= 16; /* header */
1843 put_unaligned_le32(count
, buf
);
1845 fill_ext_compat(os_desc_cfg
, buf
);
1849 case USB_RECIP_INTERFACE
:
1850 if (w_index
!= 0x5 || (w_value
>> 8))
1852 interface
= w_value
& 0xFF;
1854 if (w_length
== 0x0A) {
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
);
1864 count
= count_ext_prop(os_desc_cfg
,
1866 put_unaligned_le16(count
, buf
+ 8);
1867 count
= len_ext_prop(os_desc_cfg
,
1869 put_unaligned_le32(count
, buf
);
1871 value
= fill_ext_prop(os_desc_cfg
,
1882 req
->length
= value
;
1883 req
->context
= cdev
;
1884 req
->zero
= value
< w_length
;
1885 value
= composite_ep0_queue(cdev
, req
,
1888 DBG(cdev
, "ep_queue --> %d\n", value
);
1890 composite_setup_complete(gadget
->ep0
,
1898 "non-core control req%02x.%02x v%04x i%04x l%d\n",
1899 ctrl
->bRequestType
, ctrl
->bRequest
,
1900 w_value
, w_index
, w_length
);
1902 /* functions always handle their interfaces and endpoints...
1903 * punt other recipients (other, WUSB, ...) to the current
1904 * configuration code.
1907 list_for_each_entry(f
, &cdev
->config
->functions
, list
)
1909 f
->req_match(f
, ctrl
, false))
1912 struct usb_configuration
*c
;
1913 list_for_each_entry(c
, &cdev
->configs
, list
)
1914 list_for_each_entry(f
, &c
->functions
, list
)
1916 f
->req_match(f
, ctrl
, true))
1921 switch (ctrl
->bRequestType
& USB_RECIP_MASK
) {
1922 case USB_RECIP_INTERFACE
:
1923 if (!cdev
->config
|| intf
>= MAX_CONFIG_INTERFACES
)
1925 f
= cdev
->config
->interface
[intf
];
1928 case USB_RECIP_ENDPOINT
:
1931 endp
= ((w_index
& 0x80) >> 3) | (w_index
& 0x0f);
1932 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
1933 if (test_bit(endp
, f
->endpoints
))
1936 if (&f
->list
== &cdev
->config
->functions
)
1942 value
= f
->setup(f
, ctrl
);
1944 struct usb_configuration
*c
;
1950 /* try current config's setup */
1952 value
= c
->setup(c
, ctrl
);
1956 /* try the only function in the current config */
1957 if (!list_is_singular(&c
->functions
))
1959 f
= list_first_entry(&c
->functions
, struct usb_function
,
1962 value
= f
->setup(f
, ctrl
);
1968 /* respond with data transfer before status phase? */
1969 if (value
>= 0 && value
!= USB_GADGET_DELAYED_STATUS
) {
1970 req
->length
= value
;
1971 req
->context
= cdev
;
1972 req
->zero
= value
< w_length
;
1973 value
= composite_ep0_queue(cdev
, req
, GFP_ATOMIC
);
1975 DBG(cdev
, "ep_queue --> %d\n", value
);
1977 composite_setup_complete(gadget
->ep0
, req
);
1979 } else if (value
== USB_GADGET_DELAYED_STATUS
&& w_length
!= 0) {
1981 "%s: Delayed status not supported for w_length != 0",
1986 /* device either stalls (value < 0) or reports success */
1990 void composite_disconnect(struct usb_gadget
*gadget
)
1992 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
1993 unsigned long flags
;
1995 /* REVISIT: should we have config and device level
1996 * disconnect callbacks?
1998 spin_lock_irqsave(&cdev
->lock
, flags
);
2001 if (cdev
->driver
->disconnect
)
2002 cdev
->driver
->disconnect(cdev
);
2003 spin_unlock_irqrestore(&cdev
->lock
, flags
);
2006 /*-------------------------------------------------------------------------*/
2008 static ssize_t
suspended_show(struct device
*dev
, struct device_attribute
*attr
,
2011 struct usb_gadget
*gadget
= dev_to_usb_gadget(dev
);
2012 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
2014 return sprintf(buf
, "%d\n", cdev
->suspended
);
2016 static DEVICE_ATTR_RO(suspended
);
2018 static void __composite_unbind(struct usb_gadget
*gadget
, bool unbind_driver
)
2020 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
2022 /* composite_disconnect() must already have been called
2023 * by the underlying peripheral controller driver!
2024 * so there's no i/o concurrency that could affect the
2025 * state protected by cdev->lock.
2027 WARN_ON(cdev
->config
);
2029 while (!list_empty(&cdev
->configs
)) {
2030 struct usb_configuration
*c
;
2031 c
= list_first_entry(&cdev
->configs
,
2032 struct usb_configuration
, list
);
2033 remove_config(cdev
, c
);
2035 if (cdev
->driver
->unbind
&& unbind_driver
)
2036 cdev
->driver
->unbind(cdev
);
2038 composite_dev_cleanup(cdev
);
2040 kfree(cdev
->def_manufacturer
);
2042 set_gadget_data(gadget
, NULL
);
2045 static void composite_unbind(struct usb_gadget
*gadget
)
2047 __composite_unbind(gadget
, true);
2050 static void update_unchanged_dev_desc(struct usb_device_descriptor
*new,
2051 const struct usb_device_descriptor
*old
)
2061 * these variables may have been set in
2062 * usb_composite_overwrite_options()
2064 idVendor
= new->idVendor
;
2065 idProduct
= new->idProduct
;
2066 bcdDevice
= new->bcdDevice
;
2067 iSerialNumber
= new->iSerialNumber
;
2068 iManufacturer
= new->iManufacturer
;
2069 iProduct
= new->iProduct
;
2073 new->idVendor
= idVendor
;
2075 new->idProduct
= idProduct
;
2077 new->bcdDevice
= bcdDevice
;
2079 new->bcdDevice
= cpu_to_le16(get_default_bcdDevice());
2081 new->iSerialNumber
= iSerialNumber
;
2083 new->iManufacturer
= iManufacturer
;
2085 new->iProduct
= iProduct
;
2088 int composite_dev_prepare(struct usb_composite_driver
*composite
,
2089 struct usb_composite_dev
*cdev
)
2091 struct usb_gadget
*gadget
= cdev
->gadget
;
2094 /* preallocate control response and buffer */
2095 cdev
->req
= usb_ep_alloc_request(gadget
->ep0
, GFP_KERNEL
);
2099 cdev
->req
->buf
= kmalloc(USB_COMP_EP0_BUFSIZ
, GFP_KERNEL
);
2100 if (!cdev
->req
->buf
)
2103 ret
= device_create_file(&gadget
->dev
, &dev_attr_suspended
);
2107 cdev
->req
->complete
= composite_setup_complete
;
2108 cdev
->req
->context
= cdev
;
2109 gadget
->ep0
->driver_data
= cdev
;
2111 cdev
->driver
= composite
;
2114 * As per USB compliance update, a device that is actively drawing
2115 * more than 100mA from USB must report itself as bus-powered in
2116 * the GetStatus(DEVICE) call.
2118 if (CONFIG_USB_GADGET_VBUS_DRAW
<= USB_SELF_POWER_VBUS_MAX_DRAW
)
2119 usb_gadget_set_selfpowered(gadget
);
2121 /* interface and string IDs start at zero via kzalloc.
2122 * we force endpoints to start unassigned; few controller
2123 * drivers will zero ep->driver_data.
2125 usb_ep_autoconfig_reset(gadget
);
2128 kfree(cdev
->req
->buf
);
2130 usb_ep_free_request(gadget
->ep0
, cdev
->req
);
2135 int composite_os_desc_req_prepare(struct usb_composite_dev
*cdev
,
2140 cdev
->os_desc_req
= usb_ep_alloc_request(ep0
, GFP_KERNEL
);
2141 if (!cdev
->os_desc_req
) {
2146 /* OS feature descriptor length <= 4kB */
2147 cdev
->os_desc_req
->buf
= kmalloc(4096, GFP_KERNEL
);
2148 if (!cdev
->os_desc_req
->buf
) {
2150 usb_ep_free_request(ep0
, cdev
->os_desc_req
);
2153 cdev
->os_desc_req
->context
= cdev
;
2154 cdev
->os_desc_req
->complete
= composite_setup_complete
;
2159 void composite_dev_cleanup(struct usb_composite_dev
*cdev
)
2161 struct usb_gadget_string_container
*uc
, *tmp
;
2163 list_for_each_entry_safe(uc
, tmp
, &cdev
->gstrings
, list
) {
2164 list_del(&uc
->list
);
2167 if (cdev
->os_desc_req
) {
2168 if (cdev
->os_desc_pending
)
2169 usb_ep_dequeue(cdev
->gadget
->ep0
, cdev
->os_desc_req
);
2171 kfree(cdev
->os_desc_req
->buf
);
2172 usb_ep_free_request(cdev
->gadget
->ep0
, cdev
->os_desc_req
);
2175 if (cdev
->setup_pending
)
2176 usb_ep_dequeue(cdev
->gadget
->ep0
, cdev
->req
);
2178 kfree(cdev
->req
->buf
);
2179 usb_ep_free_request(cdev
->gadget
->ep0
, cdev
->req
);
2181 cdev
->next_string_id
= 0;
2182 device_remove_file(&cdev
->gadget
->dev
, &dev_attr_suspended
);
2185 static int composite_bind(struct usb_gadget
*gadget
,
2186 struct usb_gadget_driver
*gdriver
)
2188 struct usb_composite_dev
*cdev
;
2189 struct usb_composite_driver
*composite
= to_cdriver(gdriver
);
2190 int status
= -ENOMEM
;
2192 cdev
= kzalloc(sizeof *cdev
, GFP_KERNEL
);
2196 spin_lock_init(&cdev
->lock
);
2197 cdev
->gadget
= gadget
;
2198 set_gadget_data(gadget
, cdev
);
2199 INIT_LIST_HEAD(&cdev
->configs
);
2200 INIT_LIST_HEAD(&cdev
->gstrings
);
2202 status
= composite_dev_prepare(composite
, cdev
);
2206 /* composite gadget needs to assign strings for whole device (like
2207 * serial number), register function drivers, potentially update
2208 * power state and consumption, etc
2210 status
= composite
->bind(cdev
);
2214 if (cdev
->use_os_string
) {
2215 status
= composite_os_desc_req_prepare(cdev
, gadget
->ep0
);
2220 update_unchanged_dev_desc(&cdev
->desc
, composite
->dev
);
2222 /* has userspace failed to provide a serial number? */
2223 if (composite
->needs_serial
&& !cdev
->desc
.iSerialNumber
)
2224 WARNING(cdev
, "userspace failed to provide iSerialNumber\n");
2226 INFO(cdev
, "%s ready\n", composite
->name
);
2230 __composite_unbind(gadget
, false);
2234 /*-------------------------------------------------------------------------*/
2236 void composite_suspend(struct usb_gadget
*gadget
)
2238 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
2239 struct usb_function
*f
;
2241 /* REVISIT: should we have config level
2242 * suspend/resume callbacks?
2244 DBG(cdev
, "suspend\n");
2246 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
2251 if (cdev
->driver
->suspend
)
2252 cdev
->driver
->suspend(cdev
);
2254 cdev
->suspended
= 1;
2256 usb_gadget_vbus_draw(gadget
, 2);
2259 void composite_resume(struct usb_gadget
*gadget
)
2261 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
2262 struct usb_function
*f
;
2265 /* REVISIT: should we have config level
2266 * suspend/resume callbacks?
2268 DBG(cdev
, "resume\n");
2269 if (cdev
->driver
->resume
)
2270 cdev
->driver
->resume(cdev
);
2272 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
2277 maxpower
= cdev
->config
->MaxPower
;
2279 usb_gadget_vbus_draw(gadget
, maxpower
?
2280 maxpower
: CONFIG_USB_GADGET_VBUS_DRAW
);
2283 cdev
->suspended
= 0;
2286 /*-------------------------------------------------------------------------*/
2288 static const struct usb_gadget_driver composite_driver_template
= {
2289 .bind
= composite_bind
,
2290 .unbind
= composite_unbind
,
2292 .setup
= composite_setup
,
2293 .reset
= composite_disconnect
,
2294 .disconnect
= composite_disconnect
,
2296 .suspend
= composite_suspend
,
2297 .resume
= composite_resume
,
2300 .owner
= THIS_MODULE
,
2305 * usb_composite_probe() - register a composite driver
2306 * @driver: the driver to register
2308 * Context: single threaded during gadget setup
2310 * This function is used to register drivers using the composite driver
2311 * framework. The return value is zero, or a negative errno value.
2312 * Those values normally come from the driver's @bind method, which does
2313 * all the work of setting up the driver to match the hardware.
2315 * On successful return, the gadget is ready to respond to requests from
2316 * the host, unless one of its components invokes usb_gadget_disconnect()
2317 * while it was binding. That would usually be done in order to wait for
2318 * some userspace participation.
2320 int usb_composite_probe(struct usb_composite_driver
*driver
)
2322 struct usb_gadget_driver
*gadget_driver
;
2324 if (!driver
|| !driver
->dev
|| !driver
->bind
)
2328 driver
->name
= "composite";
2330 driver
->gadget_driver
= composite_driver_template
;
2331 gadget_driver
= &driver
->gadget_driver
;
2333 gadget_driver
->function
= (char *) driver
->name
;
2334 gadget_driver
->driver
.name
= driver
->name
;
2335 gadget_driver
->max_speed
= driver
->max_speed
;
2337 return usb_gadget_probe_driver(gadget_driver
);
2339 EXPORT_SYMBOL_GPL(usb_composite_probe
);
2342 * usb_composite_unregister() - unregister a composite driver
2343 * @driver: the driver to unregister
2345 * This function is used to unregister drivers using the composite
2348 void usb_composite_unregister(struct usb_composite_driver
*driver
)
2350 usb_gadget_unregister_driver(&driver
->gadget_driver
);
2352 EXPORT_SYMBOL_GPL(usb_composite_unregister
);
2355 * usb_composite_setup_continue() - Continue with the control transfer
2356 * @cdev: the composite device who's control transfer was kept waiting
2358 * This function must be called by the USB function driver to continue
2359 * with the control transfer's data/status stage in case it had requested to
2360 * delay the data/status stages. A USB function's setup handler (e.g. set_alt())
2361 * can request the composite framework to delay the setup request's data/status
2362 * stages by returning USB_GADGET_DELAYED_STATUS.
2364 void usb_composite_setup_continue(struct usb_composite_dev
*cdev
)
2367 struct usb_request
*req
= cdev
->req
;
2368 unsigned long flags
;
2370 DBG(cdev
, "%s\n", __func__
);
2371 spin_lock_irqsave(&cdev
->lock
, flags
);
2373 if (cdev
->delayed_status
== 0) {
2374 WARN(cdev
, "%s: Unexpected call\n", __func__
);
2376 } else if (--cdev
->delayed_status
== 0) {
2377 DBG(cdev
, "%s: Completing delayed status\n", __func__
);
2379 req
->context
= cdev
;
2380 value
= composite_ep0_queue(cdev
, req
, GFP_ATOMIC
);
2382 DBG(cdev
, "ep_queue --> %d\n", value
);
2384 composite_setup_complete(cdev
->gadget
->ep0
, req
);
2388 spin_unlock_irqrestore(&cdev
->lock
, flags
);
2390 EXPORT_SYMBOL_GPL(usb_composite_setup_continue
);
2392 static char *composite_default_mfr(struct usb_gadget
*gadget
)
2394 return kasprintf(GFP_KERNEL
, "%s %s with %s", init_utsname()->sysname
,
2395 init_utsname()->release
, gadget
->name
);
2398 void usb_composite_overwrite_options(struct usb_composite_dev
*cdev
,
2399 struct usb_composite_overwrite
*covr
)
2401 struct usb_device_descriptor
*desc
= &cdev
->desc
;
2402 struct usb_gadget_strings
*gstr
= cdev
->driver
->strings
[0];
2403 struct usb_string
*dev_str
= gstr
->strings
;
2406 desc
->idVendor
= cpu_to_le16(covr
->idVendor
);
2408 if (covr
->idProduct
)
2409 desc
->idProduct
= cpu_to_le16(covr
->idProduct
);
2411 if (covr
->bcdDevice
)
2412 desc
->bcdDevice
= cpu_to_le16(covr
->bcdDevice
);
2414 if (covr
->serial_number
) {
2415 desc
->iSerialNumber
= dev_str
[USB_GADGET_SERIAL_IDX
].id
;
2416 dev_str
[USB_GADGET_SERIAL_IDX
].s
= covr
->serial_number
;
2418 if (covr
->manufacturer
) {
2419 desc
->iManufacturer
= dev_str
[USB_GADGET_MANUFACTURER_IDX
].id
;
2420 dev_str
[USB_GADGET_MANUFACTURER_IDX
].s
= covr
->manufacturer
;
2422 } else if (!strlen(dev_str
[USB_GADGET_MANUFACTURER_IDX
].s
)) {
2423 desc
->iManufacturer
= dev_str
[USB_GADGET_MANUFACTURER_IDX
].id
;
2424 cdev
->def_manufacturer
= composite_default_mfr(cdev
->gadget
);
2425 dev_str
[USB_GADGET_MANUFACTURER_IDX
].s
= cdev
->def_manufacturer
;
2428 if (covr
->product
) {
2429 desc
->iProduct
= dev_str
[USB_GADGET_PRODUCT_IDX
].id
;
2430 dev_str
[USB_GADGET_PRODUCT_IDX
].s
= covr
->product
;
2433 EXPORT_SYMBOL_GPL(usb_composite_overwrite_options
);
2435 MODULE_LICENSE("GPL");
2436 MODULE_AUTHOR("David Brownell");