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 unsigned char tty_line;
 139 static struct usb_function_instance *fi_acm;
 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);
 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                 goto err_func_acm;
 162
 163         ret = usb_add_function(c, f_acm_rndis);
 164         if (ret)
 165                 goto err_conf;
 166
 167         ret = fsg_bind_config(c->cdev, c, &fsg_common);
 168         if (ret < 0)
 169                 goto err_fsg;
 170
 171         return 0;
 172 err_fsg:
 173         usb_remove_function(c, f_acm_rndis);
 174 err_conf:
 175         usb_put_function(f_acm_rndis);
 176 err_func_acm:
 177         return ret;
 178 }
 179
 180 static int rndis_config_register(struct usb_composite_dev *cdev)
 181 {
 182         static struct usb_configuration config = {
 183                 .bConfigurationValue    = MULTI_RNDIS_CONFIG_NUM,
 184                 .bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
 185         };
 186
 187         config.label          = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].s;
 188         config.iConfiguration = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].id;
 189
 190         return usb_add_config(cdev, &config, rndis_do_config);
 191 }
 192
 193 #else
 194
 195 static int rndis_config_register(struct usb_composite_dev *cdev)
 196 {
 197         return 0;
 198 }
 199
 200 #endif
 201
 202
 203 /********** CDC ECM **********/
 204
 205 #ifdef CONFIG_USB_G_MULTI_CDC
 206 static struct usb_function *f_acm_multi;
 207
 208 static __init int cdc_do_config(struct usb_configuration *c)
 209 {
 210         int ret;
 211
 212         if (gadget_is_otg(c->cdev->gadget)) {
 213                 c->descriptors = otg_desc;
 214                 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
 215         }
 216
 217         ret = ecm_bind_config(c, hostaddr);
 218         if (ret < 0)
 219                 return ret;
 220
 221         /* implicit port_num is zero */
 222         f_acm_multi = usb_get_function(fi_acm);
 223         if (IS_ERR(f_acm_multi))
 224                 goto err_func_acm;
 225
 226         ret = usb_add_function(c, f_acm_multi);
 227         if (ret)
 228                 goto err_conf;
 229
 230         ret = fsg_bind_config(c->cdev, c, &fsg_common);
 231         if (ret < 0)
 232                 goto err_fsg;
 233
 234         return 0;
 235 err_fsg:
 236         usb_remove_function(c, f_acm_multi);
 237 err_conf:
 238         usb_put_function(f_acm_multi);
 239 err_func_acm:
 240         return ret;
 241 }
 242
 243 static int cdc_config_register(struct usb_composite_dev *cdev)
 244 {
 245         static struct usb_configuration config = {
 246                 .bConfigurationValue    = MULTI_CDC_CONFIG_NUM,
 247                 .bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
 248         };
 249
 250         config.label          = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
 251         config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
 252
 253         return usb_add_config(cdev, &config, cdc_do_config);
 254 }
 255
 256 #else
 257
 258 static int cdc_config_register(struct usb_composite_dev *cdev)
 259 {
 260         return 0;
 261 }
 262
 263 #endif
 264
 265
 266
 267 /****************************** Gadget Bind ******************************/
 268
 269 static int __ref multi_bind(struct usb_composite_dev *cdev)
 270 {
 271         struct usb_gadget *gadget = cdev->gadget;
 272         struct f_serial_opts *opts;
 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         status = gether_setup(cdev->gadget, hostaddr);
 283         if (status < 0)
 284                 return status;
 285
 286         /* set up serial link layer */
 287         status = gserial_alloc_line(&tty_line);
 288         if (status < 0)
 289                 goto fail0;
 290
 291         fi_acm = usb_get_function_instance("acm");
 292         if (IS_ERR(fi_acm)) {
 293                 status = PTR_ERR(fi_acm);
 294                 goto fail0dot5;
 295         }
 296
 297         opts = container_of(fi_acm, struct f_serial_opts, func_inst);
 298         opts->port_num = tty_line;
 299
 300         /* set up mass storage function */
 301         {
 302                 void *retp;
 303                 retp = fsg_common_from_params(&fsg_common, cdev, &fsg_mod_data);
 304                 if (IS_ERR(retp)) {
 305                         status = PTR_ERR(retp);
 306                         goto fail1;
 307                 }
 308         }
 309
 310         /* allocate string IDs */
 311         status = usb_string_ids_tab(cdev, strings_dev);
 312         if (unlikely(status < 0))
 313                 goto fail2;
 314         device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
 315
 316         /* register configurations */
 317         status = rndis_config_register(cdev);
 318         if (unlikely(status < 0))
 319                 goto fail2;
 320
 321         status = cdc_config_register(cdev);
 322         if (unlikely(status < 0))
 323                 goto fail2;
 324         usb_composite_overwrite_options(cdev, &coverwrite);
 325
 326         /* we're done */
 327         dev_info(&gadget->dev, DRIVER_DESC "\n");
 328         fsg_common_put(&fsg_common);
 329         return 0;
 330
 331
 332         /* error recovery */
 333 fail2:
 334         fsg_common_put(&fsg_common);
 335 fail1:
 336         usb_put_function_instance(fi_acm);
 337 fail0dot5:
 338         gserial_free_line(tty_line);
 339 fail0:
 340         gether_cleanup();
 341         return status;
 342 }
 343
 344 static int __exit multi_unbind(struct usb_composite_dev *cdev)
 345 {
 346 #ifdef CONFIG_USB_G_MULTI_CDC
 347         usb_put_function(f_acm_multi);
 348 #endif
 349 #ifdef USB_ETH_RNDIS
 350         usb_put_function(f_acm_rndis);
 351 #endif
 352         usb_put_function_instance(fi_acm);
 353         gserial_free_line(tty_line);
 354         gether_cleanup();
 355         return 0;
 356 }
 357
 358
 359 /****************************** Some noise ******************************/
 360
 361
 362 static __refdata struct usb_composite_driver multi_driver = {
 363         .name           = "g_multi",
 364         .dev            = &device_desc,
 365         .strings        = dev_strings,
 366         .max_speed      = USB_SPEED_HIGH,
 367         .bind           = multi_bind,
 368         .unbind         = __exit_p(multi_unbind),
 369         .needs_serial   = 1,
 370 };
 371
 372
 373 static int __init multi_init(void)
 374 {
 375         return usb_composite_probe(&multi_driver);
 376 }
 377 module_init(multi_init);
 378
 379 static void __exit multi_exit(void)
 380 {
 381         usb_composite_unregister(&multi_driver);
 382 }
 383 module_exit(multi_exit);