Pileus Git - ~andy/linux/blob - 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 #include "f_ecm.c"
  47 #include "f_subset.c"
  48 #ifdef USB_ETH_RNDIS
  49 #  include "f_rndis.c"
  50 #  include "rndis.c"
  51 #endif
  52 #include "u_ether.c"
  53
  54 USB_GADGET_COMPOSITE_OPTIONS();
  55
  56 /***************************** Device Descriptor ****************************/
  57
  58 #define MULTI_VENDOR_NUM        0x1d6b  /* Linux Foundation */
  59 #define MULTI_PRODUCT_NUM       0x0104  /* Multifunction Composite Gadget */
  60
  61
  62 enum {
  63         __MULTI_NO_CONFIG,
  64 #ifdef CONFIG_USB_G_MULTI_RNDIS
  65         MULTI_RNDIS_CONFIG_NUM,
  66 #endif
  67 #ifdef CONFIG_USB_G_MULTI_CDC
  68         MULTI_CDC_CONFIG_NUM,
  69 #endif
  70 };
  71
  72
  73 static struct usb_device_descriptor device_desc = {
  74         .bLength =              sizeof device_desc,
  75         .bDescriptorType =      USB_DT_DEVICE,
  76
  77         .bcdUSB =               cpu_to_le16(0x0200),
  78
  79         .bDeviceClass =         USB_CLASS_MISC /* 0xEF */,
  80         .bDeviceSubClass =      2,
  81         .bDeviceProtocol =      1,
  82
  83         /* Vendor and product id can be overridden by module parameters.  */
  84         .idVendor =             cpu_to_le16(MULTI_VENDOR_NUM),
  85         .idProduct =            cpu_to_le16(MULTI_PRODUCT_NUM),
  86 };
  87
  88
  89 static const struct usb_descriptor_header *otg_desc[] = {
  90         (struct usb_descriptor_header *) &(struct usb_otg_descriptor){
  91                 .bLength =              sizeof(struct usb_otg_descriptor),
  92                 .bDescriptorType =      USB_DT_OTG,
  93
  94                 /*
  95                  * REVISIT SRP-only hardware is possible, although
  96                  * it would not be called "OTG" ...
  97                  */
  98                 .bmAttributes =         USB_OTG_SRP | USB_OTG_HNP,
  99         },
 100         NULL,
 101 };
 102
 103
 104 enum {
 105         MULTI_STRING_RNDIS_CONFIG_IDX = USB_GADGET_FIRST_AVAIL_IDX,
 106         MULTI_STRING_CDC_CONFIG_IDX,
 107 };
 108
 109 static struct usb_string strings_dev[] = {
 110         [USB_GADGET_MANUFACTURER_IDX].s = "",
 111         [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
 112         [USB_GADGET_SERIAL_IDX].s = "",
 113         [MULTI_STRING_RNDIS_CONFIG_IDX].s = "Multifunction with RNDIS",
 114         [MULTI_STRING_CDC_CONFIG_IDX].s   = "Multifunction with CDC ECM",
 115         {  } /* end of list */
 116 };
 117
 118 static struct usb_gadget_strings *dev_strings[] = {
 119         &(struct usb_gadget_strings){
 120                 .language       = 0x0409,       /* en-us */
 121                 .strings        = strings_dev,
 122         },
 123         NULL,
 124 };
 125
 126
 127
 128
 129 /****************************** Configurations ******************************/
 130
 131 static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
 132 FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
 133
 134 static struct fsg_common fsg_common;
 135
 136 static u8 hostaddr[ETH_ALEN];
 137
 138 static struct usb_function_instance *fi_acm;
 139 static struct eth_dev *the_dev;
 140
 141 /********** RNDIS **********/
 142
 143 #ifdef USB_ETH_RNDIS
 144 static struct usb_function *f_acm_rndis;
 145
 146 static __init int rndis_do_config(struct usb_configuration *c)
 147 {
 148         int ret;
 149
 150         if (gadget_is_otg(c->cdev->gadget)) {
 151                 c->descriptors = otg_desc;
 152                 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
 153         }
 154
 155         ret = rndis_bind_config(c, hostaddr, the_dev);
 156         if (ret < 0)
 157                 return ret;
 158
 159         f_acm_rndis = usb_get_function(fi_acm);
 160         if (IS_ERR(f_acm_rndis)) {
 161                 ret = PTR_ERR(f_acm_rndis);
 162                 goto err_func_acm;
 163         }
 164
 165         ret = usb_add_function(c, f_acm_rndis);
 166         if (ret)
 167                 goto err_conf;
 168
 169         ret = fsg_bind_config(c->cdev, c, &fsg_common);
 170         if (ret < 0)
 171                 goto err_fsg;
 172
 173         return 0;
 174 err_fsg:
 175         usb_remove_function(c, f_acm_rndis);
 176 err_conf:
 177         usb_put_function(f_acm_rndis);
 178 err_func_acm:
 179         return ret;
 180 }
 181
 182 static 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 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, hostaddr, 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                 goto err_func_acm;
 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 err_func_acm:
 242         return ret;
 243 }
 244
 245 static int cdc_config_register(struct usb_composite_dev *cdev)
 246 {
 247         static struct usb_configuration config = {
 248                 .bConfigurationValue    = MULTI_CDC_CONFIG_NUM,
 249                 .bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
 250         };
 251
 252         config.label          = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
 253         config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
 254
 255         return usb_add_config(cdev, &config, cdc_do_config);
 256 }
 257
 258 #else
 259
 260 static int cdc_config_register(struct usb_composite_dev *cdev)
 261 {
 262         return 0;
 263 }
 264
 265 #endif
 266
 267
 268
 269 /****************************** Gadget Bind ******************************/
 270
 271 static int __ref multi_bind(struct usb_composite_dev *cdev)
 272 {
 273         struct usb_gadget *gadget = cdev->gadget;
 274         int status;
 275
 276         if (!can_support_ecm(cdev->gadget)) {
 277                 dev_err(&gadget->dev, "controller '%s' not usable\n",
 278                         gadget->name);
 279                 return -EINVAL;
 280         }
 281
 282         /* set up network link layer */
 283         the_dev = gether_setup(cdev->gadget, hostaddr);
 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);