drivers/usb/gadget/multi.c

   1 /*
   2  * multi.c -- Multifunction Composite driver
   3  *
   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)
   8  *
   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.
  13  */
  14
  15
  16 #include <linux/kernel.h>
  17 #include <linux/module.h>
  18
  19 #include "u_serial.h"
  20 #if defined USB_ETH_RNDIS
  21 #  undef USB_ETH_RNDIS
  22 #endif
  23 #ifdef CONFIG_USB_G_MULTI_RNDIS
  24 #  define USB_ETH_RNDIS y
  25 #endif
  26
  27
  28 #define DRIVER_DESC             "Multifunction Composite Gadget"
  29
  30 MODULE_DESCRIPTION(DRIVER_DESC);
  31 MODULE_AUTHOR("Michal Nazarewicz");
  32 MODULE_LICENSE("GPL");
  33
  34
  35 /***************************** All the files... *****************************/
  36
  37 /*
  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.
  43  */
  44 #include "f_mass_storage.c"
  45
  46 #define USBF_ECM_INCLUDED
  47 #include "f_ecm.c"
  48 #ifdef USB_ETH_RNDIS
  49 #  define USB_FRNDIS_INCLUDED
  50 #  include "f_rndis.c"
  51 #  include "rndis.h"
  52 #endif
  53 #include "u_ether.h"
  54
  55 USB_GADGET_COMPOSITE_OPTIONS();
  56
  57 USB_ETHERNET_MODULE_PARAMETERS();
  58
  59 /***************************** Device Descriptor ****************************/
  60
  61 #define MULTI_VENDOR_NUM        0x1d6b  /* Linux Foundation */
  62 #define MULTI_PRODUCT_NUM       0x0104  /* Multifunction Composite Gadget */
  63
  64
  65 enum {
  66         __MULTI_NO_CONFIG,
  67 #ifdef CONFIG_USB_G_MULTI_RNDIS
  68         MULTI_RNDIS_CONFIG_NUM,
  69 #endif
  70 #ifdef CONFIG_USB_G_MULTI_CDC
  71         MULTI_CDC_CONFIG_NUM,
  72 #endif
  73 };
  74
  75
  76 static struct usb_device_descriptor device_desc = {
  77         .bLength =              sizeof device_desc,
  78         .bDescriptorType =      USB_DT_DEVICE,
  79
  80         .bcdUSB =               cpu_to_le16(0x0200),
  81
  82         .bDeviceClass =         USB_CLASS_MISC /* 0xEF */,
  83         .bDeviceSubClass =      2,
  84         .bDeviceProtocol =      1,
  85
  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),
  89 };
  90
  91
  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,
  96
  97                 /*
  98                  * REVISIT SRP-only hardware is possible, although
  99                  * it would not be called "OTG" ...
 100                  */
 101                 .bmAttributes =         USB_OTG_SRP | USB_OTG_HNP,
 102         },
 103         NULL,
 104 };
 105
 106
 107 enum {
 108         MULTI_STRING_RNDIS_CONFIG_IDX = USB_GADGET_FIRST_AVAIL_IDX,
 109         MULTI_STRING_CDC_CONFIG_IDX,
 110 };
 111
 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 */
 119 };
 120
 121 static struct usb_gadget_strings *dev_strings[] = {
 122         &(struct usb_gadget_strings){
 123                 .language       = 0x0409,       /* en-us */
 124                 .strings        = strings_dev,
 125         },
 126         NULL,
 127 };
 128
 129
 130
 131
 132 /****************************** Configurations ******************************/
 133
 134 static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
 135 FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
 136
 137 static struct fsg_common fsg_common;
 138
 139 static u8 host_mac[ETH_ALEN];
 140
 141 static struct usb_function_instance *fi_acm;
 142 static struct eth_dev *the_dev;
 143
 144 /********** RNDIS **********/
 145
 146 #ifdef USB_ETH_RNDIS
 147 static struct usb_function *f_acm_rndis;
 148
 149 static __init int rndis_do_config(struct usb_configuration *c)
 150 {
 151         int ret;
 152
 153         if (gadget_is_otg(c->cdev->gadget)) {
 154                 c->descriptors = otg_desc;
 155                 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
 156         }
 157
 158         ret = rndis_bind_config(c, host_mac, the_dev);
 159         if (ret < 0)
 160                 return ret;
 161
 162         f_acm_rndis = usb_get_function(fi_acm);
 163         if (IS_ERR(f_acm_rndis))
 164                 return PTR_ERR(f_acm_rndis);
 165
 166         ret = usb_add_function(c, f_acm_rndis);
 167         if (ret)
 168                 goto err_conf;
 169
 170         ret = fsg_bind_config(c->cdev, c, &fsg_common);
 171         if (ret < 0)
 172                 goto err_fsg;
 173
 174         return 0;
 175 err_fsg:
 176         usb_remove_function(c, f_acm_rndis);
 177 err_conf:
 178         usb_put_function(f_acm_rndis);
 179         return ret;
 180 }
 181
 182 static __ref int rndis_config_register(struct usb_composite_dev *cdev)
 183 {
 184         static struct usb_configuration config = {
 185                 .bConfigurationValue    = MULTI_RNDIS_CONFIG_NUM,
 186                 .bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
 187         };
 188
 189         config.label          = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].s;
 190         config.iConfiguration = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].id;
 191
 192         return usb_add_config(cdev, &config, rndis_do_config);
 193 }
 194
 195 #else
 196
 197 static __ref int rndis_config_register(struct usb_composite_dev *cdev)
 198 {
 199         return 0;
 200 }
 201
 202 #endif
 203
 204
 205 /********** CDC ECM **********/
 206
 207 #ifdef CONFIG_USB_G_MULTI_CDC
 208 static struct usb_function *f_acm_multi;
 209
 210 static __init int cdc_do_config(struct usb_configuration *c)
 211 {
 212         int ret;
 213
 214         if (gadget_is_otg(c->cdev->gadget)) {
 215                 c->descriptors = otg_desc;
 216                 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
 217         }
 218
 219         ret = ecm_bind_config(c, host_mac, the_dev);
 220         if (ret < 0)
 221                 return ret;
 222
 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);
 227
 228         ret = usb_add_function(c, f_acm_multi);
 229         if (ret)
 230                 goto err_conf;
 231
 232         ret = fsg_bind_config(c->cdev, c, &fsg_common);
 233         if (ret < 0)
 234                 goto err_fsg;
 235
 236         return 0;
 237 err_fsg:
 238         usb_remove_function(c, f_acm_multi);
 239 err_conf:
 240         usb_put_function(f_acm_multi);
 241         return ret;
 242 }
 243
 244 static __ref int cdc_config_register(struct usb_composite_dev *cdev)
 245 {
 246         static struct usb_configuration config = {
 247                 .bConfigurationValue    = MULTI_CDC_CONFIG_NUM,
 248                 .bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
 249         };
 250
 251         config.label          = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
 252         config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
 253
 254         return usb_add_config(cdev, &config, cdc_do_config);
 255 }
 256
 257 #else
 258
 259 static __ref int cdc_config_register(struct usb_composite_dev *cdev)
 260 {
 261         return 0;
 262 }
 263
 264 #endif
 265
 266
 267
 268 /****************************** Gadget Bind ******************************/
 269
 270 static int __ref multi_bind(struct usb_composite_dev *cdev)
 271 {
 272         struct usb_gadget *gadget = cdev->gadget;
 273         int status;
 274
 275         if (!can_support_ecm(cdev->gadget)) {
 276                 dev_err(&gadget->dev, "controller '%s' not usable\n",
 277                         gadget->name);
 278                 return -EINVAL;
 279         }
 280
 281         /* set up network link layer */
 282         the_dev = gether_setup(cdev->gadget, dev_addr, host_addr, host_mac,
 283                                qmult);
 284         if (IS_ERR(the_dev))
 285                 return PTR_ERR(the_dev);
 286
 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);
 291                 goto fail0;
 292         }
 293
 294         /* set up mass storage function */
 295         {
 296                 void *retp;
 297                 retp = fsg_common_from_params(&fsg_common, cdev, &fsg_mod_data);
 298                 if (IS_ERR(retp)) {
 299                         status = PTR_ERR(retp);
 300                         goto fail1;
 301                 }
 302         }
 303
 304         /* allocate string IDs */
 305         status = usb_string_ids_tab(cdev, strings_dev);
 306         if (unlikely(status < 0))
 307                 goto fail2;
 308         device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
 309
 310         /* register configurations */
 311         status = rndis_config_register(cdev);
 312         if (unlikely(status < 0))
 313                 goto fail2;
 314
 315         status = cdc_config_register(cdev);
 316         if (unlikely(status < 0))
 317                 goto fail2;
 318         usb_composite_overwrite_options(cdev, &coverwrite);
 319
 320         /* we're done */
 321         dev_info(&gadget->dev, DRIVER_DESC "\n");
 322         fsg_common_put(&fsg_common);
 323         return 0;
 324
 325
 326         /* error recovery */
 327 fail2:
 328         fsg_common_put(&fsg_common);
 329 fail1:
 330         usb_put_function_instance(fi_acm);
 331 fail0:
 332         gether_cleanup(the_dev);
 333         return status;
 334 }
 335
 336 static int __exit multi_unbind(struct usb_composite_dev *cdev)
 337 {
 338 #ifdef CONFIG_USB_G_MULTI_CDC
 339         usb_put_function(f_acm_multi);
 340 #endif
 341 #ifdef USB_ETH_RNDIS
 342         usb_put_function(f_acm_rndis);
 343 #endif
 344         usb_put_function_instance(fi_acm);
 345         gether_cleanup(the_dev);
 346         return 0;
 347 }
 348
 349
 350 /****************************** Some noise ******************************/
 351
 352
 353 static __refdata struct usb_composite_driver multi_driver = {
 354         .name           = "g_multi",
 355         .dev            = &device_desc,
 356         .strings        = dev_strings,
 357         .max_speed      = USB_SPEED_HIGH,
 358         .bind           = multi_bind,
 359         .unbind         = __exit_p(multi_unbind),
 360         .needs_serial   = 1,
 361 };
 362
 363
 364 static int __init multi_init(void)
 365 {
 366         return usb_composite_probe(&multi_driver);
 367 }
 368 module_init(multi_init);
 369
 370 static void __exit multi_exit(void)
 371 {
 372         usb_composite_unregister(&multi_driver);
 373 }
 374 module_exit(multi_exit);