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>
18 #include <linux/netdevice.h>
21 #if defined USB_ETH_RNDIS
24 #ifdef CONFIG_USB_G_MULTI_RNDIS
25 # define USB_ETH_RNDIS y
29 #define DRIVER_DESC "Multifunction Composite Gadget"
31 MODULE_DESCRIPTION(DRIVER_DESC);
32 MODULE_AUTHOR("Michal Nazarewicz");
33 MODULE_LICENSE("GPL");
36 #include "f_mass_storage.h"
45 USB_GADGET_COMPOSITE_OPTIONS();
47 USB_ETHERNET_MODULE_PARAMETERS();
49 /***************************** Device Descriptor ****************************/
51 #define MULTI_VENDOR_NUM 0x1d6b /* Linux Foundation */
52 #define MULTI_PRODUCT_NUM 0x0104 /* Multifunction Composite Gadget */
57 #ifdef CONFIG_USB_G_MULTI_RNDIS
58 MULTI_RNDIS_CONFIG_NUM,
60 #ifdef CONFIG_USB_G_MULTI_CDC
66 static struct usb_device_descriptor device_desc = {
67 .bLength = sizeof device_desc,
68 .bDescriptorType = USB_DT_DEVICE,
70 .bcdUSB = cpu_to_le16(0x0200),
72 .bDeviceClass = USB_CLASS_MISC /* 0xEF */,
76 /* Vendor and product id can be overridden by module parameters. */
77 .idVendor = cpu_to_le16(MULTI_VENDOR_NUM),
78 .idProduct = cpu_to_le16(MULTI_PRODUCT_NUM),
82 static const struct usb_descriptor_header *otg_desc[] = {
83 (struct usb_descriptor_header *) &(struct usb_otg_descriptor){
84 .bLength = sizeof(struct usb_otg_descriptor),
85 .bDescriptorType = USB_DT_OTG,
88 * REVISIT SRP-only hardware is possible, although
89 * it would not be called "OTG" ...
91 .bmAttributes = USB_OTG_SRP | USB_OTG_HNP,
98 MULTI_STRING_RNDIS_CONFIG_IDX = USB_GADGET_FIRST_AVAIL_IDX,
99 MULTI_STRING_CDC_CONFIG_IDX,
102 static struct usb_string strings_dev[] = {
103 [USB_GADGET_MANUFACTURER_IDX].s = "",
104 [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
105 [USB_GADGET_SERIAL_IDX].s = "",
106 [MULTI_STRING_RNDIS_CONFIG_IDX].s = "Multifunction with RNDIS",
107 [MULTI_STRING_CDC_CONFIG_IDX].s = "Multifunction with CDC ECM",
108 { } /* end of list */
111 static struct usb_gadget_strings *dev_strings[] = {
112 &(struct usb_gadget_strings){
113 .language = 0x0409, /* en-us */
114 .strings = strings_dev,
122 /****************************** Configurations ******************************/
124 static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
125 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
127 static unsigned int fsg_num_buffers = CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS;
132 * Number of buffers we will use.
133 * 2 is usually enough for good buffering pipeline
135 #define fsg_num_buffers CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS
137 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */
139 FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
141 static struct usb_function_instance *fi_acm;
142 static struct usb_function_instance *fi_msg;
144 /********** RNDIS **********/
147 static struct usb_function_instance *fi_rndis;
148 static struct usb_function *f_acm_rndis;
149 static struct usb_function *f_rndis;
150 static struct usb_function *f_msg_rndis;
152 static __init int rndis_do_config(struct usb_configuration *c)
154 struct fsg_opts *fsg_opts;
157 if (gadget_is_otg(c->cdev->gadget)) {
158 c->descriptors = otg_desc;
159 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
162 f_rndis = usb_get_function(fi_rndis);
164 return PTR_ERR(f_rndis);
166 ret = usb_add_function(c, f_rndis);
170 f_acm_rndis = usb_get_function(fi_acm);
171 if (IS_ERR(f_acm_rndis)) {
172 ret = PTR_ERR(f_acm_rndis);
176 ret = usb_add_function(c, f_acm_rndis);
180 f_msg_rndis = usb_get_function(fi_msg);
181 if (IS_ERR(f_msg_rndis)) {
182 ret = PTR_ERR(f_msg_rndis);
186 fsg_opts = fsg_opts_from_func_inst(fi_msg);
187 ret = fsg_common_run_thread(fsg_opts->common);
191 ret = usb_add_function(c, f_msg_rndis);
197 usb_put_function(f_msg_rndis);
199 usb_remove_function(c, f_acm_rndis);
201 usb_put_function(f_acm_rndis);
203 usb_remove_function(c, f_rndis);
205 usb_put_function(f_rndis);
209 static __ref int rndis_config_register(struct usb_composite_dev *cdev)
211 static struct usb_configuration config = {
212 .bConfigurationValue = MULTI_RNDIS_CONFIG_NUM,
213 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
216 config.label = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].s;
217 config.iConfiguration = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].id;
219 return usb_add_config(cdev, &config, rndis_do_config);
224 static __ref int rndis_config_register(struct usb_composite_dev *cdev)
232 /********** CDC ECM **********/
234 #ifdef CONFIG_USB_G_MULTI_CDC
235 static struct usb_function_instance *fi_ecm;
236 static struct usb_function *f_acm_multi;
237 static struct usb_function *f_ecm;
238 static struct usb_function *f_msg_multi;
240 static __init int cdc_do_config(struct usb_configuration *c)
242 struct fsg_opts *fsg_opts;
245 if (gadget_is_otg(c->cdev->gadget)) {
246 c->descriptors = otg_desc;
247 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
250 f_ecm = usb_get_function(fi_ecm);
252 return PTR_ERR(f_ecm);
254 ret = usb_add_function(c, f_ecm);
258 /* implicit port_num is zero */
259 f_acm_multi = usb_get_function(fi_acm);
260 if (IS_ERR(f_acm_multi)) {
261 ret = PTR_ERR(f_acm_multi);
265 ret = usb_add_function(c, f_acm_multi);
269 f_msg_multi = usb_get_function(fi_msg);
270 if (IS_ERR(f_msg_multi)) {
271 ret = PTR_ERR(f_msg_multi);
275 fsg_opts = fsg_opts_from_func_inst(fi_msg);
276 ret = fsg_common_run_thread(fsg_opts->common);
280 ret = usb_add_function(c, f_msg_multi);
286 usb_put_function(f_msg_multi);
288 usb_remove_function(c, f_acm_multi);
290 usb_put_function(f_acm_multi);
292 usb_remove_function(c, f_ecm);
294 usb_put_function(f_ecm);
298 static __ref int cdc_config_register(struct usb_composite_dev *cdev)
300 static struct usb_configuration config = {
301 .bConfigurationValue = MULTI_CDC_CONFIG_NUM,
302 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
305 config.label = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
306 config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
308 return usb_add_config(cdev, &config, cdc_do_config);
313 static __ref int cdc_config_register(struct usb_composite_dev *cdev)
322 /****************************** Gadget Bind ******************************/
324 static int __ref multi_bind(struct usb_composite_dev *cdev)
326 struct usb_gadget *gadget = cdev->gadget;
327 #ifdef CONFIG_USB_G_MULTI_CDC
328 struct f_ecm_opts *ecm_opts;
331 struct f_rndis_opts *rndis_opts;
333 struct fsg_opts *fsg_opts;
334 struct fsg_config config;
337 if (!can_support_ecm(cdev->gadget)) {
338 dev_err(&gadget->dev, "controller '%s' not usable\n",
343 #ifdef CONFIG_USB_G_MULTI_CDC
344 fi_ecm = usb_get_function_instance("ecm");
346 return PTR_ERR(fi_ecm);
348 ecm_opts = container_of(fi_ecm, struct f_ecm_opts, func_inst);
350 gether_set_qmult(ecm_opts->net, qmult);
351 if (!gether_set_host_addr(ecm_opts->net, host_addr))
352 pr_info("using host ethernet address: %s", host_addr);
353 if (!gether_set_dev_addr(ecm_opts->net, dev_addr))
354 pr_info("using self ethernet address: %s", dev_addr);
358 fi_rndis = usb_get_function_instance("rndis");
359 if (IS_ERR(fi_rndis)) {
360 status = PTR_ERR(fi_rndis);
364 rndis_opts = container_of(fi_rndis, struct f_rndis_opts, func_inst);
366 gether_set_qmult(rndis_opts->net, qmult);
367 if (!gether_set_host_addr(rndis_opts->net, host_addr))
368 pr_info("using host ethernet address: %s", host_addr);
369 if (!gether_set_dev_addr(rndis_opts->net, dev_addr))
370 pr_info("using self ethernet address: %s", dev_addr);
373 #if (defined CONFIG_USB_G_MULTI_CDC && defined USB_ETH_RNDIS)
375 * If both ecm and rndis are selected then:
376 * 1) rndis borrows the net interface from ecm
377 * 2) since the interface is shared it must not be bound
378 * twice - in ecm's _and_ rndis' binds, so do it here.
380 gether_set_gadget(ecm_opts->net, cdev->gadget);
381 status = gether_register_netdev(ecm_opts->net);
385 rndis_borrow_net(fi_rndis, ecm_opts->net);
386 ecm_opts->bound = true;
389 /* set up serial link layer */
390 fi_acm = usb_get_function_instance("acm");
391 if (IS_ERR(fi_acm)) {
392 status = PTR_ERR(fi_acm);
396 /* set up mass storage function */
397 fi_msg = usb_get_function_instance("mass_storage");
398 if (IS_ERR(fi_msg)) {
399 status = PTR_ERR(fi_msg);
402 fsg_config_from_params(&config, &fsg_mod_data, fsg_num_buffers);
403 fsg_opts = fsg_opts_from_func_inst(fi_msg);
405 fsg_opts->no_configfs = true;
406 status = fsg_common_set_num_buffers(fsg_opts->common, fsg_num_buffers);
410 status = fsg_common_set_nluns(fsg_opts->common, config.nluns);
414 status = fsg_common_set_cdev(fsg_opts->common, cdev, config.can_stall);
418 fsg_common_set_sysfs(fsg_opts->common, true);
419 status = fsg_common_create_luns(fsg_opts->common, &config);
423 fsg_common_set_inquiry_string(fsg_opts->common, config.vendor_name,
424 config.product_name);
426 /* allocate string IDs */
427 status = usb_string_ids_tab(cdev, strings_dev);
428 if (unlikely(status < 0))
429 goto fail_string_ids;
430 device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
432 /* register configurations */
433 status = rndis_config_register(cdev);
434 if (unlikely(status < 0))
435 goto fail_string_ids;
437 status = cdc_config_register(cdev);
438 if (unlikely(status < 0))
439 goto fail_string_ids;
440 usb_composite_overwrite_options(cdev, &coverwrite);
443 dev_info(&gadget->dev, DRIVER_DESC "\n");
449 fsg_common_remove_luns(fsg_opts->common);
451 fsg_common_free_luns(fsg_opts->common);
453 fsg_common_free_buffers(fsg_opts->common);
455 usb_put_function_instance(fi_msg);
457 usb_put_function_instance(fi_acm);
460 usb_put_function_instance(fi_rndis);
463 #ifdef CONFIG_USB_G_MULTI_CDC
464 usb_put_function_instance(fi_ecm);
469 static int __exit multi_unbind(struct usb_composite_dev *cdev)
471 #ifdef CONFIG_USB_G_MULTI_CDC
472 usb_put_function(f_msg_multi);
475 usb_put_function(f_msg_rndis);
477 usb_put_function_instance(fi_msg);
478 #ifdef CONFIG_USB_G_MULTI_CDC
479 usb_put_function(f_acm_multi);
482 usb_put_function(f_acm_rndis);
484 usb_put_function_instance(fi_acm);
486 usb_put_function(f_rndis);
487 usb_put_function_instance(fi_rndis);
489 #ifdef CONFIG_USB_G_MULTI_CDC
490 usb_put_function(f_ecm);
491 usb_put_function_instance(fi_ecm);
497 /****************************** Some noise ******************************/
500 static __refdata struct usb_composite_driver multi_driver = {
503 .strings = dev_strings,
504 .max_speed = USB_SPEED_HIGH,
506 .unbind = __exit_p(multi_unbind),
511 static int __init multi_init(void)
513 return usb_composite_probe(&multi_driver);
515 module_init(multi_init);
517 static void __exit multi_exit(void)
519 usb_composite_unregister(&multi_driver);
521 module_exit(multi_exit);