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)
142 if (gadget_is_otg(c->cdev->gadget)) {
143 c->descriptors = otg_desc;
144 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
147 f_rndis = usb_get_function(fi_rndis);
149 return PTR_ERR(f_rndis);
151 ret = usb_add_function(c, f_rndis);
155 f_acm_rndis = usb_get_function(fi_acm);
156 if (IS_ERR(f_acm_rndis)) {
157 ret = PTR_ERR(f_acm_rndis);
161 ret = usb_add_function(c, f_acm_rndis);
165 f_msg_rndis = usb_get_function(fi_msg);
166 if (IS_ERR(f_msg_rndis)) {
167 ret = PTR_ERR(f_msg_rndis);
171 ret = usb_add_function(c, f_msg_rndis);
177 usb_put_function(f_msg_rndis);
179 usb_remove_function(c, f_acm_rndis);
181 usb_put_function(f_acm_rndis);
183 usb_remove_function(c, f_rndis);
185 usb_put_function(f_rndis);
189 static __ref int rndis_config_register(struct usb_composite_dev *cdev)
191 static struct usb_configuration config = {
192 .bConfigurationValue = MULTI_RNDIS_CONFIG_NUM,
193 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
196 config.label = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].s;
197 config.iConfiguration = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].id;
199 return usb_add_config(cdev, &config, rndis_do_config);
204 static __ref int rndis_config_register(struct usb_composite_dev *cdev)
212 /********** CDC ECM **********/
214 #ifdef CONFIG_USB_G_MULTI_CDC
215 static struct usb_function_instance *fi_ecm;
216 static struct usb_function *f_acm_multi;
217 static struct usb_function *f_ecm;
218 static struct usb_function *f_msg_multi;
220 static int cdc_do_config(struct usb_configuration *c)
224 if (gadget_is_otg(c->cdev->gadget)) {
225 c->descriptors = otg_desc;
226 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
229 f_ecm = usb_get_function(fi_ecm);
231 return PTR_ERR(f_ecm);
233 ret = usb_add_function(c, f_ecm);
237 /* implicit port_num is zero */
238 f_acm_multi = usb_get_function(fi_acm);
239 if (IS_ERR(f_acm_multi)) {
240 ret = PTR_ERR(f_acm_multi);
244 ret = usb_add_function(c, f_acm_multi);
248 f_msg_multi = usb_get_function(fi_msg);
249 if (IS_ERR(f_msg_multi)) {
250 ret = PTR_ERR(f_msg_multi);
254 ret = usb_add_function(c, f_msg_multi);
260 usb_put_function(f_msg_multi);
262 usb_remove_function(c, f_acm_multi);
264 usb_put_function(f_acm_multi);
266 usb_remove_function(c, f_ecm);
268 usb_put_function(f_ecm);
272 static __ref int cdc_config_register(struct usb_composite_dev *cdev)
274 static struct usb_configuration config = {
275 .bConfigurationValue = MULTI_CDC_CONFIG_NUM,
276 .bmAttributes = USB_CONFIG_ATT_SELFPOWER,
279 config.label = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
280 config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
282 return usb_add_config(cdev, &config, cdc_do_config);
287 static __ref int cdc_config_register(struct usb_composite_dev *cdev)
296 /****************************** Gadget Bind ******************************/
298 static int __ref multi_bind(struct usb_composite_dev *cdev)
300 struct usb_gadget *gadget = cdev->gadget;
301 #ifdef CONFIG_USB_G_MULTI_CDC
302 struct f_ecm_opts *ecm_opts;
305 struct f_rndis_opts *rndis_opts;
307 struct fsg_opts *fsg_opts;
308 struct fsg_config config;
311 if (!can_support_ecm(cdev->gadget)) {
312 dev_err(&gadget->dev, "controller '%s' not usable\n",
317 #ifdef CONFIG_USB_G_MULTI_CDC
318 fi_ecm = usb_get_function_instance("ecm");
320 return PTR_ERR(fi_ecm);
322 ecm_opts = container_of(fi_ecm, struct f_ecm_opts, func_inst);
324 gether_set_qmult(ecm_opts->net, qmult);
325 if (!gether_set_host_addr(ecm_opts->net, host_addr))
326 pr_info("using host ethernet address: %s", host_addr);
327 if (!gether_set_dev_addr(ecm_opts->net, dev_addr))
328 pr_info("using self ethernet address: %s", dev_addr);
332 fi_rndis = usb_get_function_instance("rndis");
333 if (IS_ERR(fi_rndis)) {
334 status = PTR_ERR(fi_rndis);
338 rndis_opts = container_of(fi_rndis, struct f_rndis_opts, func_inst);
340 gether_set_qmult(rndis_opts->net, qmult);
341 if (!gether_set_host_addr(rndis_opts->net, host_addr))
342 pr_info("using host ethernet address: %s", host_addr);
343 if (!gether_set_dev_addr(rndis_opts->net, dev_addr))
344 pr_info("using self ethernet address: %s", dev_addr);
347 #if (defined CONFIG_USB_G_MULTI_CDC && defined USB_ETH_RNDIS)
349 * If both ecm and rndis are selected then:
350 * 1) rndis borrows the net interface from ecm
351 * 2) since the interface is shared it must not be bound
352 * twice - in ecm's _and_ rndis' binds, so do it here.
354 gether_set_gadget(ecm_opts->net, cdev->gadget);
355 status = gether_register_netdev(ecm_opts->net);
359 rndis_borrow_net(fi_rndis, ecm_opts->net);
360 ecm_opts->bound = true;
363 /* set up serial link layer */
364 fi_acm = usb_get_function_instance("acm");
365 if (IS_ERR(fi_acm)) {
366 status = PTR_ERR(fi_acm);
370 /* set up mass storage function */
371 fi_msg = usb_get_function_instance("mass_storage");
372 if (IS_ERR(fi_msg)) {
373 status = PTR_ERR(fi_msg);
376 fsg_config_from_params(&config, &fsg_mod_data, fsg_num_buffers);
377 fsg_opts = fsg_opts_from_func_inst(fi_msg);
379 fsg_opts->no_configfs = true;
380 status = fsg_common_set_num_buffers(fsg_opts->common, fsg_num_buffers);
384 status = fsg_common_set_cdev(fsg_opts->common, cdev, config.can_stall);
388 fsg_common_set_sysfs(fsg_opts->common, true);
389 status = fsg_common_create_luns(fsg_opts->common, &config);
393 fsg_common_set_inquiry_string(fsg_opts->common, config.vendor_name,
394 config.product_name);
396 /* allocate string IDs */
397 status = usb_string_ids_tab(cdev, strings_dev);
398 if (unlikely(status < 0))
399 goto fail_string_ids;
400 device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
402 if (gadget_is_otg(gadget) && !otg_desc[0]) {
403 struct usb_descriptor_header *usb_desc;
405 usb_desc = usb_otg_descriptor_alloc(gadget);
407 goto fail_string_ids;
408 usb_otg_descriptor_init(gadget, usb_desc);
409 otg_desc[0] = usb_desc;
413 /* register configurations */
414 status = rndis_config_register(cdev);
415 if (unlikely(status < 0))
418 status = cdc_config_register(cdev);
419 if (unlikely(status < 0))
421 usb_composite_overwrite_options(cdev, &coverwrite);
424 dev_info(&gadget->dev, DRIVER_DESC "\n");
433 fsg_common_remove_luns(fsg_opts->common);
435 fsg_common_free_buffers(fsg_opts->common);
437 usb_put_function_instance(fi_msg);
439 usb_put_function_instance(fi_acm);
442 usb_put_function_instance(fi_rndis);
445 #ifdef CONFIG_USB_G_MULTI_CDC
446 usb_put_function_instance(fi_ecm);
451 static int multi_unbind(struct usb_composite_dev *cdev)
453 #ifdef CONFIG_USB_G_MULTI_CDC
454 usb_put_function(f_msg_multi);
457 usb_put_function(f_msg_rndis);
459 usb_put_function_instance(fi_msg);
460 #ifdef CONFIG_USB_G_MULTI_CDC
461 usb_put_function(f_acm_multi);
464 usb_put_function(f_acm_rndis);
466 usb_put_function_instance(fi_acm);
468 usb_put_function(f_rndis);
469 usb_put_function_instance(fi_rndis);
471 #ifdef CONFIG_USB_G_MULTI_CDC
472 usb_put_function(f_ecm);
473 usb_put_function_instance(fi_ecm);
482 /****************************** Some noise ******************************/
485 static struct usb_composite_driver multi_driver = {
488 .strings = dev_strings,
489 .max_speed = USB_SPEED_HIGH,
491 .unbind = multi_unbind,
495 module_usb_composite_driver(multi_driver);