2 * multi.c -- Multifunction Composite driver
4 * Copyright (C) 2008 David Brownell
5 * Copyright (C) 2008 Nokia Corporation
6 * Copyright (C) 2009 Samsung Electronics
7 * Author: Michal Nazarewicz (mina86@mina86.com)
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
16 #include <linux/kernel.h>
17 #include <linux/module.h>
20 #if defined USB_ETH_RNDIS
23 #ifdef CONFIG_USB_G_MULTI_RNDIS
24 # define USB_ETH_RNDIS y
28 #define DRIVER_DESC "Multifunction Composite Gadget"
30 MODULE_DESCRIPTION(DRIVER_DESC);
31 MODULE_AUTHOR("Michal Nazarewicz");
32 MODULE_LICENSE("GPL");
35 /***************************** All the files... *****************************/
38 * kbuild is not very cooperative with respect to linking separately
39 * compiled library objects into one module. So for now we won't use
40 * separate compilation ... ensuring init/exit sections work to shrink
41 * the runtime footprint, and giving us at least some parts of what
42 * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
44 #include "f_mass_storage.c"
46 #define USBF_ECM_INCLUDED
49 # define USB_FRNDIS_INCLUDED
55 USB_GADGET_COMPOSITE_OPTIONS();
57 USB_ETHERNET_MODULE_PARAMETERS();
59 /***************************** Device Descriptor ****************************/
61 #define MULTI_VENDOR_NUM 0x1d6b /* Linux Foundation */
62 #define MULTI_PRODUCT_NUM 0x0104 /* Multifunction Composite Gadget */
67 #ifdef CONFIG_USB_G_MULTI_RNDIS
68 MULTI_RNDIS_CONFIG_NUM,
70 #ifdef CONFIG_USB_G_MULTI_CDC
76 static struct usb_device_descriptor device_desc = {
77 .bLength = sizeof device_desc,
78 .bDescriptorType = USB_DT_DEVICE,
80 .bcdUSB = cpu_to_le16(0x0200),
82 .bDeviceClass = USB_CLASS_MISC /* 0xEF */,
86 /* Vendor and product id can be overridden by module parameters. */
87 .idVendor = cpu_to_le16(MULTI_VENDOR_NUM),
88 .idProduct = cpu_to_le16(MULTI_PRODUCT_NUM),
92 static const struct usb_descriptor_header *otg_desc[] = {
93 (struct usb_descriptor_header *) &(struct usb_otg_descriptor){
94 .bLength = sizeof(struct usb_otg_descriptor),
95 .bDescriptorType = USB_DT_OTG,
98 * REVISIT SRP-only hardware is possible, although
99 * it would not be called "OTG" ...
101 .bmAttributes = USB_OTG_SRP | USB_OTG_HNP,
108 MULTI_STRING_RNDIS_CONFIG_IDX = USB_GADGET_FIRST_AVAIL_IDX,
109 MULTI_STRING_CDC_CONFIG_IDX,
112 static struct usb_string strings_dev[] = {
113 [USB_GADGET_MANUFACTURER_IDX].s = "",
114 [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
115 [USB_GADGET_SERIAL_IDX].s = "",
116 [MULTI_STRING_RNDIS_CONFIG_IDX].s = "Multifunction with RNDIS",
117 [MULTI_STRING_CDC_CONFIG_IDX].s = "Multifunction with CDC ECM",
118 { } /* end of list */
121 static struct usb_gadget_strings *dev_strings[] = {
122 &(struct usb_gadget_strings){
123 .language = 0x0409, /* en-us */
124 .strings = strings_dev,
132 /****************************** Configurations ******************************/
134 static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
135 FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
137 static struct fsg_common fsg_common;
139 static u8 host_mac[ETH_ALEN];
141 static struct usb_function_instance *fi_acm;
142 static struct eth_dev *the_dev;
144 /********** RNDIS **********/
147 static struct usb_function *f_acm_rndis;
149 static __init int rndis_do_config(struct usb_configuration *c)
153 if (gadget_is_otg(c->cdev->gadget)) {
154 c->descriptors = otg_desc;
155 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
158 ret = rndis_bind_config(c, host_mac, the_dev);
162 f_acm_rndis = usb_get_function(fi_acm);
163 if (IS_ERR(f_acm_rndis))
164 return PTR_ERR(f_acm_rndis);
166 ret = usb_add_function(c, f_acm_rndis);
170 ret = fsg_bind_config(c->cdev, c, &fsg_common);
176 usb_remove_function(c, f_acm_rndis);
178 usb_put_function(f_acm_rndis);
182 static int rndis_config_register(struct usb_composite_dev *cdev)
184 static struct usb_configuration config = {
185 .bConfigurationValue = MULTI_RNDIS_CONFIG_NUM,
186 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
189 config.label = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].s;
190 config.iConfiguration = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].id;
192 return usb_add_config(cdev, &config, rndis_do_config);
197 static int rndis_config_register(struct usb_composite_dev *cdev)
205 /********** CDC ECM **********/
207 #ifdef CONFIG_USB_G_MULTI_CDC
208 static struct usb_function *f_acm_multi;
210 static __init int cdc_do_config(struct usb_configuration *c)
214 if (gadget_is_otg(c->cdev->gadget)) {
215 c->descriptors = otg_desc;
216 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
219 ret = ecm_bind_config(c, host_mac, the_dev);
223 /* implicit port_num is zero */
224 f_acm_multi = usb_get_function(fi_acm);
225 if (IS_ERR(f_acm_multi))
226 return PTR_ERR(f_acm_multi);
228 ret = usb_add_function(c, f_acm_multi);
232 ret = fsg_bind_config(c->cdev, c, &fsg_common);
238 usb_remove_function(c, f_acm_multi);
240 usb_put_function(f_acm_multi);
244 static int cdc_config_register(struct usb_composite_dev *cdev)
246 static struct usb_configuration config = {
247 .bConfigurationValue = MULTI_CDC_CONFIG_NUM,
248 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
251 config.label = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
252 config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
254 return usb_add_config(cdev, &config, cdc_do_config);
259 static int cdc_config_register(struct usb_composite_dev *cdev)
268 /****************************** Gadget Bind ******************************/
270 static int __ref multi_bind(struct usb_composite_dev *cdev)
272 struct usb_gadget *gadget = cdev->gadget;
275 if (!can_support_ecm(cdev->gadget)) {
276 dev_err(&gadget->dev, "controller '%s' not usable\n",
281 /* set up network link layer */
282 the_dev = gether_setup(cdev->gadget, dev_addr, host_addr, host_mac,
285 return PTR_ERR(the_dev);
287 /* set up serial link layer */
288 fi_acm = usb_get_function_instance("acm");
289 if (IS_ERR(fi_acm)) {
290 status = PTR_ERR(fi_acm);
294 /* set up mass storage function */
297 retp = fsg_common_from_params(&fsg_common, cdev, &fsg_mod_data);
299 status = PTR_ERR(retp);
304 /* allocate string IDs */
305 status = usb_string_ids_tab(cdev, strings_dev);
306 if (unlikely(status < 0))
308 device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
310 /* register configurations */
311 status = rndis_config_register(cdev);
312 if (unlikely(status < 0))
315 status = cdc_config_register(cdev);
316 if (unlikely(status < 0))
318 usb_composite_overwrite_options(cdev, &coverwrite);
321 dev_info(&gadget->dev, DRIVER_DESC "\n");
322 fsg_common_put(&fsg_common);
328 fsg_common_put(&fsg_common);
330 usb_put_function_instance(fi_acm);
332 gether_cleanup(the_dev);
336 static int __exit multi_unbind(struct usb_composite_dev *cdev)
338 #ifdef CONFIG_USB_G_MULTI_CDC
339 usb_put_function(f_acm_multi);
342 usb_put_function(f_acm_rndis);
344 usb_put_function_instance(fi_acm);
345 gether_cleanup(the_dev);
350 /****************************** Some noise ******************************/
353 static __refdata struct usb_composite_driver multi_driver = {
356 .strings = dev_strings,
357 .max_speed = USB_SPEED_HIGH,
359 .unbind = __exit_p(multi_unbind),
364 static int __init multi_init(void)
366 return usb_composite_probe(&multi_driver);
368 module_init(multi_init);
370 static void __exit multi_exit(void)
372 usb_composite_unregister(&multi_driver);
374 module_exit(multi_exit);