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),
81 static const struct usb_descriptor_header *otg_desc[2];
84 MULTI_STRING_RNDIS_CONFIG_IDX = USB_GADGET_FIRST_AVAIL_IDX,
85 MULTI_STRING_CDC_CONFIG_IDX,
88 static struct usb_string strings_dev[] = {
89 [USB_GADGET_MANUFACTURER_IDX].s = "",
90 [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
91 [USB_GADGET_SERIAL_IDX].s = "",
92 [MULTI_STRING_RNDIS_CONFIG_IDX].s = "Multifunction with RNDIS",
93 [MULTI_STRING_CDC_CONFIG_IDX].s = "Multifunction with CDC ECM",
97 static struct usb_gadget_strings *dev_strings[] = {
98 &(struct usb_gadget_strings){
99 .language = 0x0409, /* en-us */
100 .strings = strings_dev,
108 /****************************** Configurations ******************************/
110 static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
111 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
113 static unsigned int fsg_num_buffers = CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS;
118 * Number of buffers we will use.
119 * 2 is usually enough for good buffering pipeline
121 #define fsg_num_buffers CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS
123 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */
125 FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
127 static struct usb_function_instance *fi_acm;
128 static struct usb_function_instance *fi_msg;
130 /********** RNDIS **********/
133 static struct usb_function_instance *fi_rndis;
134 static struct usb_function *f_acm_rndis;
135 static struct usb_function *f_rndis;
136 static struct usb_function *f_msg_rndis;
138 static int rndis_do_config(struct usb_configuration *c)
140 struct fsg_opts *fsg_opts;
143 if (gadget_is_otg(c->cdev->gadget)) {
144 c->descriptors = otg_desc;
145 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
148 f_rndis = usb_get_function(fi_rndis);
150 return PTR_ERR(f_rndis);
152 ret = usb_add_function(c, f_rndis);
156 f_acm_rndis = usb_get_function(fi_acm);
157 if (IS_ERR(f_acm_rndis)) {
158 ret = PTR_ERR(f_acm_rndis);
162 ret = usb_add_function(c, f_acm_rndis);
166 f_msg_rndis = usb_get_function(fi_msg);
167 if (IS_ERR(f_msg_rndis)) {
168 ret = PTR_ERR(f_msg_rndis);
172 fsg_opts = fsg_opts_from_func_inst(fi_msg);
173 ret = fsg_common_run_thread(fsg_opts->common);
177 ret = usb_add_function(c, f_msg_rndis);
183 usb_put_function(f_msg_rndis);
185 usb_remove_function(c, f_acm_rndis);
187 usb_put_function(f_acm_rndis);
189 usb_remove_function(c, f_rndis);
191 usb_put_function(f_rndis);
195 static __ref int rndis_config_register(struct usb_composite_dev *cdev)
197 static struct usb_configuration config = {
198 .bConfigurationValue = MULTI_RNDIS_CONFIG_NUM,
199 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
202 config.label = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].s;
203 config.iConfiguration = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].id;
205 return usb_add_config(cdev, &config, rndis_do_config);
210 static __ref int rndis_config_register(struct usb_composite_dev *cdev)
218 /********** CDC ECM **********/
220 #ifdef CONFIG_USB_G_MULTI_CDC
221 static struct usb_function_instance *fi_ecm;
222 static struct usb_function *f_acm_multi;
223 static struct usb_function *f_ecm;
224 static struct usb_function *f_msg_multi;
226 static int cdc_do_config(struct usb_configuration *c)
228 struct fsg_opts *fsg_opts;
231 if (gadget_is_otg(c->cdev->gadget)) {
232 c->descriptors = otg_desc;
233 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
236 f_ecm = usb_get_function(fi_ecm);
238 return PTR_ERR(f_ecm);
240 ret = usb_add_function(c, f_ecm);
244 /* implicit port_num is zero */
245 f_acm_multi = usb_get_function(fi_acm);
246 if (IS_ERR(f_acm_multi)) {
247 ret = PTR_ERR(f_acm_multi);
251 ret = usb_add_function(c, f_acm_multi);
255 f_msg_multi = usb_get_function(fi_msg);
256 if (IS_ERR(f_msg_multi)) {
257 ret = PTR_ERR(f_msg_multi);
261 fsg_opts = fsg_opts_from_func_inst(fi_msg);
262 ret = fsg_common_run_thread(fsg_opts->common);
266 ret = usb_add_function(c, f_msg_multi);
272 usb_put_function(f_msg_multi);
274 usb_remove_function(c, f_acm_multi);
276 usb_put_function(f_acm_multi);
278 usb_remove_function(c, f_ecm);
280 usb_put_function(f_ecm);
284 static __ref int cdc_config_register(struct usb_composite_dev *cdev)
286 static struct usb_configuration config = {
287 .bConfigurationValue = MULTI_CDC_CONFIG_NUM,
288 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
291 config.label = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
292 config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
294 return usb_add_config(cdev, &config, cdc_do_config);
299 static __ref int cdc_config_register(struct usb_composite_dev *cdev)
308 /****************************** Gadget Bind ******************************/
310 static int __ref multi_bind(struct usb_composite_dev *cdev)
312 struct usb_gadget *gadget = cdev->gadget;
313 #ifdef CONFIG_USB_G_MULTI_CDC
314 struct f_ecm_opts *ecm_opts;
317 struct f_rndis_opts *rndis_opts;
319 struct fsg_opts *fsg_opts;
320 struct fsg_config config;
323 if (!can_support_ecm(cdev->gadget)) {
324 dev_err(&gadget->dev, "controller '%s' not usable\n",
329 #ifdef CONFIG_USB_G_MULTI_CDC
330 fi_ecm = usb_get_function_instance("ecm");
332 return PTR_ERR(fi_ecm);
334 ecm_opts = container_of(fi_ecm, struct f_ecm_opts, func_inst);
336 gether_set_qmult(ecm_opts->net, qmult);
337 if (!gether_set_host_addr(ecm_opts->net, host_addr))
338 pr_info("using host ethernet address: %s", host_addr);
339 if (!gether_set_dev_addr(ecm_opts->net, dev_addr))
340 pr_info("using self ethernet address: %s", dev_addr);
344 fi_rndis = usb_get_function_instance("rndis");
345 if (IS_ERR(fi_rndis)) {
346 status = PTR_ERR(fi_rndis);
350 rndis_opts = container_of(fi_rndis, struct f_rndis_opts, func_inst);
352 gether_set_qmult(rndis_opts->net, qmult);
353 if (!gether_set_host_addr(rndis_opts->net, host_addr))
354 pr_info("using host ethernet address: %s", host_addr);
355 if (!gether_set_dev_addr(rndis_opts->net, dev_addr))
356 pr_info("using self ethernet address: %s", dev_addr);
359 #if (defined CONFIG_USB_G_MULTI_CDC && defined USB_ETH_RNDIS)
361 * If both ecm and rndis are selected then:
362 * 1) rndis borrows the net interface from ecm
363 * 2) since the interface is shared it must not be bound
364 * twice - in ecm's _and_ rndis' binds, so do it here.
366 gether_set_gadget(ecm_opts->net, cdev->gadget);
367 status = gether_register_netdev(ecm_opts->net);
371 rndis_borrow_net(fi_rndis, ecm_opts->net);
372 ecm_opts->bound = true;
375 /* set up serial link layer */
376 fi_acm = usb_get_function_instance("acm");
377 if (IS_ERR(fi_acm)) {
378 status = PTR_ERR(fi_acm);
382 /* set up mass storage function */
383 fi_msg = usb_get_function_instance("mass_storage");
384 if (IS_ERR(fi_msg)) {
385 status = PTR_ERR(fi_msg);
388 fsg_config_from_params(&config, &fsg_mod_data, fsg_num_buffers);
389 fsg_opts = fsg_opts_from_func_inst(fi_msg);
391 fsg_opts->no_configfs = true;
392 status = fsg_common_set_num_buffers(fsg_opts->common, fsg_num_buffers);
396 status = fsg_common_set_cdev(fsg_opts->common, cdev, config.can_stall);
400 fsg_common_set_sysfs(fsg_opts->common, true);
401 status = fsg_common_create_luns(fsg_opts->common, &config);
405 fsg_common_set_inquiry_string(fsg_opts->common, config.vendor_name,
406 config.product_name);
408 /* allocate string IDs */
409 status = usb_string_ids_tab(cdev, strings_dev);
410 if (unlikely(status < 0))
411 goto fail_string_ids;
412 device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
414 if (gadget_is_otg(gadget) && !otg_desc[0]) {
415 struct usb_descriptor_header *usb_desc;
417 usb_desc = usb_otg_descriptor_alloc(gadget);
419 goto fail_string_ids;
420 usb_otg_descriptor_init(gadget, usb_desc);
421 otg_desc[0] = usb_desc;
425 /* register configurations */
426 status = rndis_config_register(cdev);
427 if (unlikely(status < 0))
430 status = cdc_config_register(cdev);
431 if (unlikely(status < 0))
433 usb_composite_overwrite_options(cdev, &coverwrite);
436 dev_info(&gadget->dev, DRIVER_DESC "\n");
445 fsg_common_remove_luns(fsg_opts->common);
447 fsg_common_free_buffers(fsg_opts->common);
449 usb_put_function_instance(fi_msg);
451 usb_put_function_instance(fi_acm);
454 usb_put_function_instance(fi_rndis);
457 #ifdef CONFIG_USB_G_MULTI_CDC
458 usb_put_function_instance(fi_ecm);
463 static int multi_unbind(struct usb_composite_dev *cdev)
465 #ifdef CONFIG_USB_G_MULTI_CDC
466 usb_put_function(f_msg_multi);
469 usb_put_function(f_msg_rndis);
471 usb_put_function_instance(fi_msg);
472 #ifdef CONFIG_USB_G_MULTI_CDC
473 usb_put_function(f_acm_multi);
476 usb_put_function(f_acm_rndis);
478 usb_put_function_instance(fi_acm);
480 usb_put_function(f_rndis);
481 usb_put_function_instance(fi_rndis);
483 #ifdef CONFIG_USB_G_MULTI_CDC
484 usb_put_function(f_ecm);
485 usb_put_function_instance(fi_ecm);
494 /****************************** Some noise ******************************/
497 static struct usb_composite_driver multi_driver = {
500 .strings = dev_strings,
501 .max_speed = USB_SPEED_HIGH,
503 .unbind = multi_unbind,
507 module_usb_composite_driver(multi_driver);