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.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 /* #define VERBOSE_DEBUG */
23 #include <linux/kallsyms.h>
24 #include <linux/kernel.h>
25 #include <linux/slab.h>
26 #include <linux/device.h>
28 #include <linux/usb/composite.h>
32 * The code in this file is utility code, used to build a gadget driver
33 * from one or more "function" drivers, one or more "configuration"
34 * objects, and a "usb_composite_driver" by gluing them together along
35 * with the relevant device-wide data.
38 /* big enough to hold our biggest descriptor */
39 #define USB_BUFSIZ 512
41 static struct usb_composite_driver
*composite
;
43 /* Some systems will need runtime overrides for the product identifers
44 * published in the device descriptor, either numbers or strings or both.
45 * String parameters are in UTF-8 (superset of ASCII's 7 bit characters).
48 static ushort idVendor
;
49 module_param(idVendor
, ushort
, 0);
50 MODULE_PARM_DESC(idVendor
, "USB Vendor ID");
52 static ushort idProduct
;
53 module_param(idProduct
, ushort
, 0);
54 MODULE_PARM_DESC(idProduct
, "USB Product ID");
56 static ushort bcdDevice
;
57 module_param(bcdDevice
, ushort
, 0);
58 MODULE_PARM_DESC(bcdDevice
, "USB Device version (BCD)");
60 static char *iManufacturer
;
61 module_param(iManufacturer
, charp
, 0);
62 MODULE_PARM_DESC(iManufacturer
, "USB Manufacturer string");
64 static char *iProduct
;
65 module_param(iProduct
, charp
, 0);
66 MODULE_PARM_DESC(iProduct
, "USB Product string");
68 static char *iSerialNumber
;
69 module_param(iSerialNumber
, charp
, 0);
70 MODULE_PARM_DESC(iSerialNumber
, "SerialNumber string");
72 /*-------------------------------------------------------------------------*/
75 * usb_add_function() - add a function to a configuration
76 * @config: the configuration
77 * @function: the function being added
78 * Context: single threaded during gadget setup
80 * After initialization, each configuration must have one or more
81 * functions added to it. Adding a function involves calling its @bind()
82 * method to allocate resources such as interface and string identifiers
85 * This function returns the value of the function's bind(), which is
86 * zero for success else a negative errno value.
88 int __init
usb_add_function(struct usb_configuration
*config
,
89 struct usb_function
*function
)
93 DBG(config
->cdev
, "adding '%s'/%p to config '%s'/%p\n",
94 function
->name
, function
,
95 config
->label
, config
);
97 if (!function
->set_alt
|| !function
->disable
)
100 function
->config
= config
;
101 list_add_tail(&function
->list
, &config
->functions
);
103 /* REVISIT *require* function->bind? */
104 if (function
->bind
) {
105 value
= function
->bind(config
, function
);
107 list_del(&function
->list
);
108 function
->config
= NULL
;
113 /* We allow configurations that don't work at both speeds.
114 * If we run into a lowspeed Linux system, treat it the same
115 * as full speed ... it's the function drivers that will need
116 * to avoid bulk and ISO transfers.
118 if (!config
->fullspeed
&& function
->descriptors
)
119 config
->fullspeed
= true;
120 if (!config
->highspeed
&& function
->hs_descriptors
)
121 config
->highspeed
= true;
125 DBG(config
->cdev
, "adding '%s'/%p --> %d\n",
126 function
->name
, function
, value
);
131 * usb_function_deactivate - prevent function and gadget enumeration
132 * @function: the function that isn't yet ready to respond
134 * Blocks response of the gadget driver to host enumeration by
135 * preventing the data line pullup from being activated. This is
136 * normally called during @bind() processing to change from the
137 * initial "ready to respond" state, or when a required resource
140 * For example, drivers that serve as a passthrough to a userspace
141 * daemon can block enumeration unless that daemon (such as an OBEX,
142 * MTP, or print server) is ready to handle host requests.
144 * Not all systems support software control of their USB peripheral
147 * Returns zero on success, else negative errno.
149 int usb_function_deactivate(struct usb_function
*function
)
151 struct usb_composite_dev
*cdev
= function
->config
->cdev
;
154 spin_lock(&cdev
->lock
);
156 if (cdev
->deactivations
== 0)
157 status
= usb_gadget_disconnect(cdev
->gadget
);
159 cdev
->deactivations
++;
161 spin_unlock(&cdev
->lock
);
166 * usb_function_activate - allow function and gadget enumeration
167 * @function: function on which usb_function_activate() was called
169 * Reverses effect of usb_function_deactivate(). If no more functions
170 * are delaying their activation, the gadget driver will respond to
171 * host enumeration procedures.
173 * Returns zero on success, else negative errno.
175 int usb_function_activate(struct usb_function
*function
)
177 struct usb_composite_dev
*cdev
= function
->config
->cdev
;
180 spin_lock(&cdev
->lock
);
182 if (WARN_ON(cdev
->deactivations
== 0))
185 cdev
->deactivations
--;
186 if (cdev
->deactivations
== 0)
187 status
= usb_gadget_connect(cdev
->gadget
);
190 spin_unlock(&cdev
->lock
);
195 * usb_interface_id() - allocate an unused interface ID
196 * @config: configuration associated with the interface
197 * @function: function handling the interface
198 * Context: single threaded during gadget setup
200 * usb_interface_id() is called from usb_function.bind() callbacks to
201 * allocate new interface IDs. The function driver will then store that
202 * ID in interface, association, CDC union, and other descriptors. It
203 * will also handle any control requests targetted at that interface,
204 * particularly changing its altsetting via set_alt(). There may
205 * also be class-specific or vendor-specific requests to handle.
207 * All interface identifier should be allocated using this routine, to
208 * ensure that for example different functions don't wrongly assign
209 * different meanings to the same identifier. Note that since interface
210 * identifers are configuration-specific, functions used in more than
211 * one configuration (or more than once in a given configuration) need
212 * multiple versions of the relevant descriptors.
214 * Returns the interface ID which was allocated; or -ENODEV if no
215 * more interface IDs can be allocated.
217 int __init
usb_interface_id(struct usb_configuration
*config
,
218 struct usb_function
*function
)
220 unsigned id
= config
->next_interface_id
;
222 if (id
< MAX_CONFIG_INTERFACES
) {
223 config
->interface
[id
] = function
;
224 config
->next_interface_id
= id
+ 1;
230 static int config_buf(struct usb_configuration
*config
,
231 enum usb_device_speed speed
, void *buf
, u8 type
)
233 struct usb_config_descriptor
*c
= buf
;
234 void *next
= buf
+ USB_DT_CONFIG_SIZE
;
235 int len
= USB_BUFSIZ
- USB_DT_CONFIG_SIZE
;
236 struct usb_function
*f
;
239 /* write the config descriptor */
241 c
->bLength
= USB_DT_CONFIG_SIZE
;
242 c
->bDescriptorType
= type
;
243 /* wTotalLength is written later */
244 c
->bNumInterfaces
= config
->next_interface_id
;
245 c
->bConfigurationValue
= config
->bConfigurationValue
;
246 c
->iConfiguration
= config
->iConfiguration
;
247 c
->bmAttributes
= USB_CONFIG_ATT_ONE
| config
->bmAttributes
;
248 c
->bMaxPower
= config
->bMaxPower
? : (CONFIG_USB_GADGET_VBUS_DRAW
/ 2);
250 /* There may be e.g. OTG descriptors */
251 if (config
->descriptors
) {
252 status
= usb_descriptor_fillbuf(next
, len
,
253 config
->descriptors
);
260 /* add each function's descriptors */
261 list_for_each_entry(f
, &config
->functions
, list
) {
262 struct usb_descriptor_header
**descriptors
;
264 if (speed
== USB_SPEED_HIGH
)
265 descriptors
= f
->hs_descriptors
;
267 descriptors
= f
->descriptors
;
270 status
= usb_descriptor_fillbuf(next
, len
,
271 (const struct usb_descriptor_header
**) descriptors
);
279 c
->wTotalLength
= cpu_to_le16(len
);
283 static int config_desc(struct usb_composite_dev
*cdev
, unsigned w_value
)
285 struct usb_gadget
*gadget
= cdev
->gadget
;
286 struct usb_configuration
*c
;
287 u8 type
= w_value
>> 8;
288 enum usb_device_speed speed
= USB_SPEED_UNKNOWN
;
290 if (gadget_is_dualspeed(gadget
)) {
293 if (gadget
->speed
== USB_SPEED_HIGH
)
295 if (type
== USB_DT_OTHER_SPEED_CONFIG
)
298 speed
= USB_SPEED_HIGH
;
302 /* This is a lookup by config *INDEX* */
304 list_for_each_entry(c
, &cdev
->configs
, list
) {
305 /* ignore configs that won't work at this speed */
306 if (speed
== USB_SPEED_HIGH
) {
314 return config_buf(c
, speed
, cdev
->req
->buf
, type
);
320 static int count_configs(struct usb_composite_dev
*cdev
, unsigned type
)
322 struct usb_gadget
*gadget
= cdev
->gadget
;
323 struct usb_configuration
*c
;
327 if (gadget_is_dualspeed(gadget
)) {
328 if (gadget
->speed
== USB_SPEED_HIGH
)
330 if (type
== USB_DT_DEVICE_QUALIFIER
)
333 list_for_each_entry(c
, &cdev
->configs
, list
) {
334 /* ignore configs that won't work at this speed */
347 static void device_qual(struct usb_composite_dev
*cdev
)
349 struct usb_qualifier_descriptor
*qual
= cdev
->req
->buf
;
351 qual
->bLength
= sizeof(*qual
);
352 qual
->bDescriptorType
= USB_DT_DEVICE_QUALIFIER
;
353 /* POLICY: same bcdUSB and device type info at both speeds */
354 qual
->bcdUSB
= cdev
->desc
.bcdUSB
;
355 qual
->bDeviceClass
= cdev
->desc
.bDeviceClass
;
356 qual
->bDeviceSubClass
= cdev
->desc
.bDeviceSubClass
;
357 qual
->bDeviceProtocol
= cdev
->desc
.bDeviceProtocol
;
358 /* ASSUME same EP0 fifo size at both speeds */
359 qual
->bMaxPacketSize0
= cdev
->desc
.bMaxPacketSize0
;
360 qual
->bNumConfigurations
= count_configs(cdev
, USB_DT_DEVICE_QUALIFIER
);
364 /*-------------------------------------------------------------------------*/
366 static void reset_config(struct usb_composite_dev
*cdev
)
368 struct usb_function
*f
;
370 DBG(cdev
, "reset config\n");
372 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
379 static int set_config(struct usb_composite_dev
*cdev
,
380 const struct usb_ctrlrequest
*ctrl
, unsigned number
)
382 struct usb_gadget
*gadget
= cdev
->gadget
;
383 struct usb_configuration
*c
= NULL
;
384 int result
= -EINVAL
;
385 unsigned power
= gadget_is_otg(gadget
) ? 8 : 100;
392 list_for_each_entry(c
, &cdev
->configs
, list
) {
393 if (c
->bConfigurationValue
== number
) {
403 INFO(cdev
, "%s speed config #%d: %s\n",
405 switch (gadget
->speed
) {
406 case USB_SPEED_LOW
: speed
= "low"; break;
407 case USB_SPEED_FULL
: speed
= "full"; break;
408 case USB_SPEED_HIGH
: speed
= "high"; break;
409 default: speed
= "?"; break;
410 } ; speed
; }), number
, c
? c
->label
: "unconfigured");
417 /* Initialize all interfaces by setting them to altsetting zero. */
418 for (tmp
= 0; tmp
< MAX_CONFIG_INTERFACES
; tmp
++) {
419 struct usb_function
*f
= c
->interface
[tmp
];
424 result
= f
->set_alt(f
, tmp
, 0);
426 DBG(cdev
, "interface %d (%s/%p) alt 0 --> %d\n",
427 tmp
, f
->name
, f
, result
);
434 /* when we return, be sure our power usage is valid */
435 power
= c
->bMaxPower
? (2 * c
->bMaxPower
) : CONFIG_USB_GADGET_VBUS_DRAW
;
437 usb_gadget_vbus_draw(gadget
, power
);
442 * usb_add_config() - add a configuration to a device.
443 * @cdev: wraps the USB gadget
444 * @config: the configuration, with bConfigurationValue assigned
445 * Context: single threaded during gadget setup
447 * One of the main tasks of a composite driver's bind() routine is to
448 * add each of the configurations it supports, using this routine.
450 * This function returns the value of the configuration's bind(), which
451 * is zero for success else a negative errno value. Binding configurations
452 * assigns global resources including string IDs, and per-configuration
453 * resources such as interface IDs and endpoints.
455 int __init
usb_add_config(struct usb_composite_dev
*cdev
,
456 struct usb_configuration
*config
)
458 int status
= -EINVAL
;
459 struct usb_configuration
*c
;
461 DBG(cdev
, "adding config #%u '%s'/%p\n",
462 config
->bConfigurationValue
,
463 config
->label
, config
);
465 if (!config
->bConfigurationValue
|| !config
->bind
)
468 /* Prevent duplicate configuration identifiers */
469 list_for_each_entry(c
, &cdev
->configs
, list
) {
470 if (c
->bConfigurationValue
== config
->bConfigurationValue
) {
477 list_add_tail(&config
->list
, &cdev
->configs
);
479 INIT_LIST_HEAD(&config
->functions
);
480 config
->next_interface_id
= 0;
482 status
= config
->bind(config
);
484 list_del(&config
->list
);
489 DBG(cdev
, "cfg %d/%p speeds:%s%s\n",
490 config
->bConfigurationValue
, config
,
491 config
->highspeed
? " high" : "",
493 ? (gadget_is_dualspeed(cdev
->gadget
)
498 for (i
= 0; i
< MAX_CONFIG_INTERFACES
; i
++) {
499 struct usb_function
*f
= config
->interface
[i
];
503 DBG(cdev
, " interface %d = %s/%p\n",
508 /* set_alt(), or next config->bind(), sets up
509 * ep->driver_data as needed.
511 usb_ep_autoconfig_reset(cdev
->gadget
);
515 DBG(cdev
, "added config '%s'/%u --> %d\n", config
->label
,
516 config
->bConfigurationValue
, status
);
520 /*-------------------------------------------------------------------------*/
522 /* We support strings in multiple languages ... string descriptor zero
523 * says which languages are supported. The typical case will be that
524 * only one language (probably English) is used, with I18N handled on
528 static void collect_langs(struct usb_gadget_strings
**sp
, __le16
*buf
)
530 const struct usb_gadget_strings
*s
;
536 language
= cpu_to_le16(s
->language
);
537 for (tmp
= buf
; *tmp
&& tmp
< &buf
[126]; tmp
++) {
538 if (*tmp
== language
)
547 static int lookup_string(
548 struct usb_gadget_strings
**sp
,
554 struct usb_gadget_strings
*s
;
559 if (s
->language
!= language
)
561 value
= usb_gadget_get_string(s
, id
, buf
);
568 static int get_string(struct usb_composite_dev
*cdev
,
569 void *buf
, u16 language
, int id
)
571 struct usb_configuration
*c
;
572 struct usb_function
*f
;
575 /* Yes, not only is USB's I18N support probably more than most
576 * folk will ever care about ... also, it's all supported here.
577 * (Except for UTF8 support for Unicode's "Astral Planes".)
580 /* 0 == report all available language codes */
582 struct usb_string_descriptor
*s
= buf
;
583 struct usb_gadget_strings
**sp
;
586 s
->bDescriptorType
= USB_DT_STRING
;
588 sp
= composite
->strings
;
590 collect_langs(sp
, s
->wData
);
592 list_for_each_entry(c
, &cdev
->configs
, list
) {
595 collect_langs(sp
, s
->wData
);
597 list_for_each_entry(f
, &c
->functions
, list
) {
600 collect_langs(sp
, s
->wData
);
604 for (len
= 0; s
->wData
[len
] && len
<= 126; len
++)
609 s
->bLength
= 2 * (len
+ 1);
613 /* Otherwise, look up and return a specified string. String IDs
614 * are device-scoped, so we look up each string table we're told
615 * about. These lookups are infrequent; simpler-is-better here.
617 if (composite
->strings
) {
618 len
= lookup_string(composite
->strings
, buf
, language
, id
);
622 list_for_each_entry(c
, &cdev
->configs
, list
) {
624 len
= lookup_string(c
->strings
, buf
, language
, id
);
628 list_for_each_entry(f
, &c
->functions
, list
) {
631 len
= lookup_string(f
->strings
, buf
, language
, id
);
640 * usb_string_id() - allocate an unused string ID
641 * @cdev: the device whose string descriptor IDs are being allocated
642 * Context: single threaded during gadget setup
644 * @usb_string_id() is called from bind() callbacks to allocate
645 * string IDs. Drivers for functions, configurations, or gadgets will
646 * then store that ID in the appropriate descriptors and string table.
648 * All string identifier should be allocated using this routine, to
649 * ensure that for example different functions don't wrongly assign
650 * different meanings to the same identifier.
652 int __init
usb_string_id(struct usb_composite_dev
*cdev
)
654 if (cdev
->next_string_id
< 254) {
655 /* string id 0 is reserved */
656 cdev
->next_string_id
++;
657 return cdev
->next_string_id
;
662 /*-------------------------------------------------------------------------*/
664 static void composite_setup_complete(struct usb_ep
*ep
, struct usb_request
*req
)
666 if (req
->status
|| req
->actual
!= req
->length
)
667 DBG((struct usb_composite_dev
*) ep
->driver_data
,
668 "setup complete --> %d, %d/%d\n",
669 req
->status
, req
->actual
, req
->length
);
673 * The setup() callback implements all the ep0 functionality that's
674 * not handled lower down, in hardware or the hardware driver(like
675 * device and endpoint feature flags, and their status). It's all
676 * housekeeping for the gadget function we're implementing. Most of
677 * the work is in config and function specific setup.
680 composite_setup(struct usb_gadget
*gadget
, const struct usb_ctrlrequest
*ctrl
)
682 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
683 struct usb_request
*req
= cdev
->req
;
684 int value
= -EOPNOTSUPP
;
685 u16 w_index
= le16_to_cpu(ctrl
->wIndex
);
686 u16 w_value
= le16_to_cpu(ctrl
->wValue
);
687 u16 w_length
= le16_to_cpu(ctrl
->wLength
);
688 struct usb_function
*f
= NULL
;
690 /* partial re-init of the response message; the function or the
691 * gadget might need to intercept e.g. a control-OUT completion
692 * when we delegate to it.
695 req
->complete
= composite_setup_complete
;
696 req
->length
= USB_BUFSIZ
;
697 gadget
->ep0
->driver_data
= cdev
;
699 switch (ctrl
->bRequest
) {
701 /* we handle all standard USB descriptors */
702 case USB_REQ_GET_DESCRIPTOR
:
703 if (ctrl
->bRequestType
!= USB_DIR_IN
)
705 switch (w_value
>> 8) {
708 cdev
->desc
.bNumConfigurations
=
709 count_configs(cdev
, USB_DT_DEVICE
);
710 value
= min(w_length
, (u16
) sizeof cdev
->desc
);
711 memcpy(req
->buf
, &cdev
->desc
, value
);
713 case USB_DT_DEVICE_QUALIFIER
:
714 if (!gadget_is_dualspeed(gadget
))
717 value
= min_t(int, w_length
,
718 sizeof(struct usb_qualifier_descriptor
));
720 case USB_DT_OTHER_SPEED_CONFIG
:
721 if (!gadget_is_dualspeed(gadget
))
725 value
= config_desc(cdev
, w_value
);
727 value
= min(w_length
, (u16
) value
);
730 value
= get_string(cdev
, req
->buf
,
731 w_index
, w_value
& 0xff);
733 value
= min(w_length
, (u16
) value
);
738 /* any number of configs can work */
739 case USB_REQ_SET_CONFIGURATION
:
740 if (ctrl
->bRequestType
!= 0)
742 if (gadget_is_otg(gadget
)) {
743 if (gadget
->a_hnp_support
)
744 DBG(cdev
, "HNP available\n");
745 else if (gadget
->a_alt_hnp_support
)
746 DBG(cdev
, "HNP on another port\n");
748 VDBG(cdev
, "HNP inactive\n");
750 spin_lock(&cdev
->lock
);
751 value
= set_config(cdev
, ctrl
, w_value
);
752 spin_unlock(&cdev
->lock
);
754 case USB_REQ_GET_CONFIGURATION
:
755 if (ctrl
->bRequestType
!= USB_DIR_IN
)
758 *(u8
*)req
->buf
= cdev
->config
->bConfigurationValue
;
761 value
= min(w_length
, (u16
) 1);
764 /* function drivers must handle get/set altsetting; if there's
765 * no get() method, we know only altsetting zero works.
767 case USB_REQ_SET_INTERFACE
:
768 if (ctrl
->bRequestType
!= USB_RECIP_INTERFACE
)
770 if (!cdev
->config
|| w_index
>= MAX_CONFIG_INTERFACES
)
772 f
= cdev
->config
->interface
[w_index
];
775 if (w_value
&& !f
->get_alt
)
777 value
= f
->set_alt(f
, w_index
, w_value
);
779 case USB_REQ_GET_INTERFACE
:
780 if (ctrl
->bRequestType
!= (USB_DIR_IN
|USB_RECIP_INTERFACE
))
782 if (!cdev
->config
|| w_index
>= MAX_CONFIG_INTERFACES
)
784 f
= cdev
->config
->interface
[w_index
];
787 /* lots of interfaces only need altsetting zero... */
788 value
= f
->get_alt
? f
->get_alt(f
, w_index
) : 0;
791 *((u8
*)req
->buf
) = value
;
792 value
= min(w_length
, (u16
) 1);
797 "non-core control req%02x.%02x v%04x i%04x l%d\n",
798 ctrl
->bRequestType
, ctrl
->bRequest
,
799 w_value
, w_index
, w_length
);
801 /* functions always handle their interfaces ... punt other
802 * recipients (endpoint, other, WUSB, ...) to the current
803 * configuration code.
805 * REVISIT it could make sense to let the composite device
806 * take such requests too, if that's ever needed: to work
809 if ((ctrl
->bRequestType
& USB_RECIP_MASK
)
810 == USB_RECIP_INTERFACE
) {
811 f
= cdev
->config
->interface
[w_index
];
813 value
= f
->setup(f
, ctrl
);
817 if (value
< 0 && !f
) {
818 struct usb_configuration
*c
;
822 value
= c
->setup(c
, ctrl
);
828 /* respond with data transfer before status phase? */
831 req
->zero
= value
< w_length
;
832 value
= usb_ep_queue(gadget
->ep0
, req
, GFP_ATOMIC
);
834 DBG(cdev
, "ep_queue --> %d\n", value
);
836 composite_setup_complete(gadget
->ep0
, req
);
841 /* device either stalls (value < 0) or reports success */
845 static void composite_disconnect(struct usb_gadget
*gadget
)
847 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
850 /* REVISIT: should we have config and device level
851 * disconnect callbacks?
853 spin_lock_irqsave(&cdev
->lock
, flags
);
856 spin_unlock_irqrestore(&cdev
->lock
, flags
);
859 /*-------------------------------------------------------------------------*/
861 static void /* __init_or_exit */
862 composite_unbind(struct usb_gadget
*gadget
)
864 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
866 /* composite_disconnect() must already have been called
867 * by the underlying peripheral controller driver!
868 * so there's no i/o concurrency that could affect the
869 * state protected by cdev->lock.
871 WARN_ON(cdev
->config
);
873 while (!list_empty(&cdev
->configs
)) {
874 struct usb_configuration
*c
;
876 c
= list_first_entry(&cdev
->configs
,
877 struct usb_configuration
, list
);
878 while (!list_empty(&c
->functions
)) {
879 struct usb_function
*f
;
881 f
= list_first_entry(&c
->functions
,
882 struct usb_function
, list
);
885 DBG(cdev
, "unbind function '%s'/%p\n",
888 /* may free memory for "f" */
893 DBG(cdev
, "unbind config '%s'/%p\n", c
->label
, c
);
895 /* may free memory for "c" */
898 if (composite
->unbind
)
899 composite
->unbind(cdev
);
902 kfree(cdev
->req
->buf
);
903 usb_ep_free_request(gadget
->ep0
, cdev
->req
);
906 set_gadget_data(gadget
, NULL
);
911 string_override_one(struct usb_gadget_strings
*tab
, u8 id
, const char *s
)
913 struct usb_string
*str
= tab
->strings
;
915 for (str
= tab
->strings
; str
->s
; str
++) {
924 string_override(struct usb_gadget_strings
**tab
, u8 id
, const char *s
)
927 string_override_one(*tab
, id
, s
);
932 static int __init
composite_bind(struct usb_gadget
*gadget
)
934 struct usb_composite_dev
*cdev
;
935 int status
= -ENOMEM
;
937 cdev
= kzalloc(sizeof *cdev
, GFP_KERNEL
);
941 spin_lock_init(&cdev
->lock
);
942 cdev
->gadget
= gadget
;
943 set_gadget_data(gadget
, cdev
);
944 INIT_LIST_HEAD(&cdev
->configs
);
946 /* preallocate control response and buffer */
947 cdev
->req
= usb_ep_alloc_request(gadget
->ep0
, GFP_KERNEL
);
950 cdev
->req
->buf
= kmalloc(USB_BUFSIZ
, GFP_KERNEL
);
953 cdev
->req
->complete
= composite_setup_complete
;
954 gadget
->ep0
->driver_data
= cdev
;
956 cdev
->bufsiz
= USB_BUFSIZ
;
957 cdev
->driver
= composite
;
959 usb_gadget_set_selfpowered(gadget
);
961 /* interface and string IDs start at zero via kzalloc.
962 * we force endpoints to start unassigned; few controller
963 * drivers will zero ep->driver_data.
965 usb_ep_autoconfig_reset(cdev
->gadget
);
967 /* composite gadget needs to assign strings for whole device (like
968 * serial number), register function drivers, potentially update
969 * power state and consumption, etc
971 status
= composite
->bind(cdev
);
975 cdev
->desc
= *composite
->dev
;
976 cdev
->desc
.bMaxPacketSize0
= gadget
->ep0
->maxpacket
;
978 /* standardized runtime overrides for device ID data */
980 cdev
->desc
.idVendor
= cpu_to_le16(idVendor
);
982 cdev
->desc
.idProduct
= cpu_to_le16(idProduct
);
984 cdev
->desc
.bcdDevice
= cpu_to_le16(bcdDevice
);
986 /* strings can't be assigned before bind() allocates the
987 * releavnt identifiers
989 if (cdev
->desc
.iManufacturer
&& iManufacturer
)
990 string_override(composite
->strings
,
991 cdev
->desc
.iManufacturer
, iManufacturer
);
992 if (cdev
->desc
.iProduct
&& iProduct
)
993 string_override(composite
->strings
,
994 cdev
->desc
.iProduct
, iProduct
);
995 if (cdev
->desc
.iSerialNumber
&& iSerialNumber
)
996 string_override(composite
->strings
,
997 cdev
->desc
.iSerialNumber
, iSerialNumber
);
999 INFO(cdev
, "%s ready\n", composite
->name
);
1003 composite_unbind(gadget
);
1007 /*-------------------------------------------------------------------------*/
1010 composite_suspend(struct usb_gadget
*gadget
)
1012 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
1013 struct usb_function
*f
;
1015 /* REVISIT: should we have config and device level
1016 * suspend/resume callbacks?
1018 DBG(cdev
, "suspend\n");
1020 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
1028 composite_resume(struct usb_gadget
*gadget
)
1030 struct usb_composite_dev
*cdev
= get_gadget_data(gadget
);
1031 struct usb_function
*f
;
1033 /* REVISIT: should we have config and device level
1034 * suspend/resume callbacks?
1036 DBG(cdev
, "resume\n");
1038 list_for_each_entry(f
, &cdev
->config
->functions
, list
) {
1045 /*-------------------------------------------------------------------------*/
1047 static struct usb_gadget_driver composite_driver
= {
1048 .speed
= USB_SPEED_HIGH
,
1050 .bind
= composite_bind
,
1051 .unbind
= __exit_p(composite_unbind
),
1053 .setup
= composite_setup
,
1054 .disconnect
= composite_disconnect
,
1056 .suspend
= composite_suspend
,
1057 .resume
= composite_resume
,
1060 .owner
= THIS_MODULE
,
1065 * usb_composite_register() - register a composite driver
1066 * @driver: the driver to register
1067 * Context: single threaded during gadget setup
1069 * This function is used to register drivers using the composite driver
1070 * framework. The return value is zero, or a negative errno value.
1071 * Those values normally come from the driver's @bind method, which does
1072 * all the work of setting up the driver to match the hardware.
1074 * On successful return, the gadget is ready to respond to requests from
1075 * the host, unless one of its components invokes usb_gadget_disconnect()
1076 * while it was binding. That would usually be done in order to wait for
1077 * some userspace participation.
1079 int __init
usb_composite_register(struct usb_composite_driver
*driver
)
1081 if (!driver
|| !driver
->dev
|| !driver
->bind
|| composite
)
1085 driver
->name
= "composite";
1086 composite_driver
.function
= (char *) driver
->name
;
1087 composite_driver
.driver
.name
= driver
->name
;
1090 return usb_gadget_register_driver(&composite_driver
);
1094 * usb_composite_unregister() - unregister a composite driver
1095 * @driver: the driver to unregister
1097 * This function is used to unregister drivers using the composite
1100 void __exit
usb_composite_unregister(struct usb_composite_driver
*driver
)
1102 if (composite
!= driver
)
1104 usb_gadget_unregister_driver(&composite_driver
);