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/utsname.h>
  18 #include <linux/module.h>
  19
  20
  21 #if defined USB_ETH_RNDIS
  22 #  undef USB_ETH_RNDIS
  23 #endif
  24 #ifdef CONFIG_USB_G_MULTI_RNDIS
  25 #  define USB_ETH_RNDIS y
  26 #endif
  27
  28
  29 #define DRIVER_DESC             "Multifunction Composite Gadget"
  30
  31 MODULE_DESCRIPTION(DRIVER_DESC);
  32 MODULE_AUTHOR("Michal Nazarewicz");
  33 MODULE_LICENSE("GPL");
  34
  35
  36 /***************************** All the files... *****************************/
  37
  38 /*
  39  * kbuild is not very cooperative with respect to linking separately
  40  * compiled library objects into one module.  So for now we won't use
  41  * separate compilation ... ensuring init/exit sections work to shrink
  42  * the runtime footprint, and giving us at least some parts of what
  43  * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
  44  */
  45
  46 #include "composite.c"
  47
  48 #include "f_mass_storage.c"
  49
  50 #include "u_serial.c"
  51 #include "f_acm.c"
  52
  53 #include "f_ecm.c"
  54 #include "f_subset.c"
  55 #ifdef USB_ETH_RNDIS
  56 #  include "f_rndis.c"
  57 #  include "rndis.c"
  58 #endif
  59 #include "u_ether.c"
  60
  61 USB_GADGET_COMPOSITE_OPTIONS();
  62
  63 /***************************** Device Descriptor ****************************/
  64
  65 #define MULTI_VENDOR_NUM        0x1d6b  /* Linux Foundation */
  66 #define MULTI_PRODUCT_NUM       0x0104  /* Multifunction Composite Gadget */
  67
  68
  69 enum {
  70         __MULTI_NO_CONFIG,
  71 #ifdef CONFIG_USB_G_MULTI_RNDIS
  72         MULTI_RNDIS_CONFIG_NUM,
  73 #endif
  74 #ifdef CONFIG_USB_G_MULTI_CDC
  75         MULTI_CDC_CONFIG_NUM,
  76 #endif
  77 };
  78
  79
  80 static struct usb_device_descriptor device_desc = {
  81         .bLength =              sizeof device_desc,
  82         .bDescriptorType =      USB_DT_DEVICE,
  83
  84         .bcdUSB =               cpu_to_le16(0x0200),
  85
  86         .bDeviceClass =         USB_CLASS_MISC /* 0xEF */,
  87         .bDeviceSubClass =      2,
  88         .bDeviceProtocol =      1,
  89
  90         /* Vendor and product id can be overridden by module parameters.  */
  91         .idVendor =             cpu_to_le16(MULTI_VENDOR_NUM),
  92         .idProduct =            cpu_to_le16(MULTI_PRODUCT_NUM),
  93 };
  94
  95
  96 static const struct usb_descriptor_header *otg_desc[] = {
  97         (struct usb_descriptor_header *) &(struct usb_otg_descriptor){
  98                 .bLength =              sizeof(struct usb_otg_descriptor),
  99                 .bDescriptorType =      USB_DT_OTG,
 100
 101                 /*
 102                  * REVISIT SRP-only hardware is possible, although
 103                  * it would not be called "OTG" ...
 104                  */
 105                 .bmAttributes =         USB_OTG_SRP | USB_OTG_HNP,
 106         },
 107         NULL,
 108 };
 109
 110
 111 enum {
 112         MULTI_STRING_RNDIS_CONFIG_IDX = USB_GADGET_FIRST_AVAIL_IDX,
 113         MULTI_STRING_CDC_CONFIG_IDX,
 114 };
 115
 116 static struct usb_string strings_dev[] = {
 117         [USB_GADGET_MANUFACTURER_IDX].s = "",
 118         [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
 119         [USB_GADGET_SERIAL_IDX].s = "",
 120         [MULTI_STRING_RNDIS_CONFIG_IDX].s = "Multifunction with RNDIS",
 121         [MULTI_STRING_CDC_CONFIG_IDX].s   = "Multifunction with CDC ECM",
 122         {  } /* end of list */
 123 };
 124
 125 static struct usb_gadget_strings *dev_strings[] = {
 126         &(struct usb_gadget_strings){
 127                 .language       = 0x0409,       /* en-us */
 128                 .strings        = strings_dev,
 129         },
 130         NULL,
 131 };
 132
 133
 134
 135
 136 /****************************** Configurations ******************************/
 137
 138 static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
 139 FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
 140
 141 static struct fsg_common fsg_common;
 142
 143 static u8 hostaddr[ETH_ALEN];
 144
 145
 146 /********** RNDIS **********/
 147
 148 #ifdef USB_ETH_RNDIS
 149
 150 static __init int rndis_do_config(struct usb_configuration *c)
 151 {
 152         int ret;
 153
 154         if (gadget_is_otg(c->cdev->gadget)) {
 155                 c->descriptors = otg_desc;
 156                 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
 157         }
 158
 159         ret = rndis_bind_config(c, hostaddr);
 160         if (ret < 0)
 161                 return ret;
 162
 163         ret = acm_bind_config(c, 0);
 164         if (ret < 0)
 165                 return ret;
 166
 167         ret = fsg_bind_config(c->cdev, c, &fsg_common);
 168         if (ret < 0)
 169                 return ret;
 170
 171         return 0;
 172 }
 173
 174 static int rndis_config_register(struct usb_composite_dev *cdev)
 175 {
 176         static struct usb_configuration config = {
 177                 .bConfigurationValue    = MULTI_RNDIS_CONFIG_NUM,
 178                 .bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
 179         };
 180
 181         config.label          = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].s;
 182         config.iConfiguration = strings_dev[MULTI_STRING_RNDIS_CONFIG_IDX].id;
 183
 184         return usb_add_config(cdev, &config, rndis_do_config);
 185 }
 186
 187 #else
 188
 189 static int rndis_config_register(struct usb_composite_dev *cdev)
 190 {
 191         return 0;
 192 }
 193
 194 #endif
 195
 196
 197 /********** CDC ECM **********/
 198
 199 #ifdef CONFIG_USB_G_MULTI_CDC
 200
 201 static __init int cdc_do_config(struct usb_configuration *c)
 202 {
 203         int ret;
 204
 205         if (gadget_is_otg(c->cdev->gadget)) {
 206                 c->descriptors = otg_desc;
 207                 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
 208         }
 209
 210         ret = ecm_bind_config(c, hostaddr);
 211         if (ret < 0)
 212                 return ret;
 213
 214         ret = acm_bind_config(c, 0);
 215         if (ret < 0)
 216                 return ret;
 217
 218         ret = fsg_bind_config(c->cdev, c, &fsg_common);
 219         if (ret < 0)
 220                 return ret;
 221
 222         return 0;
 223 }
 224
 225 static int cdc_config_register(struct usb_composite_dev *cdev)
 226 {
 227         static struct usb_configuration config = {
 228                 .bConfigurationValue    = MULTI_CDC_CONFIG_NUM,
 229                 .bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
 230         };
 231
 232         config.label          = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].s;
 233         config.iConfiguration = strings_dev[MULTI_STRING_CDC_CONFIG_IDX].id;
 234
 235         return usb_add_config(cdev, &config, cdc_do_config);
 236 }
 237
 238 #else
 239
 240 static int cdc_config_register(struct usb_composite_dev *cdev)
 241 {
 242         return 0;
 243 }
 244
 245 #endif
 246
 247
 248
 249 /****************************** Gadget Bind ******************************/
 250
 251
 252 static int __ref multi_bind(struct usb_composite_dev *cdev)
 253 {
 254         struct usb_gadget *gadget = cdev->gadget;
 255         int status, gcnum;
 256
 257         if (!can_support_ecm(cdev->gadget)) {
 258                 dev_err(&gadget->dev, "controller '%s' not usable\n",
 259                         gadget->name);
 260                 return -EINVAL;
 261         }
 262
 263         /* set up network link layer */
 264         status = gether_setup(cdev->gadget, hostaddr);
 265         if (status < 0)
 266                 return status;
 267
 268         /* set up serial link layer */
 269         status = gserial_setup(cdev->gadget, 1);
 270         if (status < 0)
 271                 goto fail0;
 272
 273         /* set up mass storage function */
 274         {
 275                 void *retp;
 276                 retp = fsg_common_from_params(&fsg_common, cdev, &fsg_mod_data);
 277                 if (IS_ERR(retp)) {
 278                         status = PTR_ERR(retp);
 279                         goto fail1;
 280                 }
 281         }
 282
 283         /* set bcdDevice */
 284         gcnum = usb_gadget_controller_number(gadget);
 285         if (gcnum >= 0) {
 286                 device_desc.bcdDevice = cpu_to_le16(0x0300 | gcnum);
 287         } else {
 288                 WARNING(cdev, "controller '%s' not recognized\n", gadget->name);
 289                 device_desc.bcdDevice = cpu_to_le16(0x0300 | 0x0099);
 290         }
 291
 292         /* allocate string IDs */
 293         status = usb_string_ids_tab(cdev, strings_dev);
 294         if (unlikely(status < 0))
 295                 goto fail2;
 296         device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
 297
 298         /* register configurations */
 299         status = rndis_config_register(cdev);
 300         if (unlikely(status < 0))
 301                 goto fail2;
 302
 303         status = cdc_config_register(cdev);
 304         if (unlikely(status < 0))
 305                 goto fail2;
 306         usb_composite_overwrite_options(cdev, &coverwrite);
 307
 308         /* we're done */
 309         dev_info(&gadget->dev, DRIVER_DESC "\n");
 310         fsg_common_put(&fsg_common);
 311         return 0;
 312
 313
 314         /* error recovery */
 315 fail2:
 316         fsg_common_put(&fsg_common);
 317 fail1:
 318         gserial_cleanup();
 319 fail0:
 320         gether_cleanup();
 321         return status;
 322 }
 323
 324 static int __exit multi_unbind(struct usb_composite_dev *cdev)
 325 {
 326         gserial_cleanup();
 327         gether_cleanup();
 328         return 0;
 329 }
 330
 331
 332 /****************************** Some noise ******************************/
 333
 334
 335 static __refdata struct usb_composite_driver multi_driver = {
 336         .name           = "g_multi",
 337         .dev            = &device_desc,
 338         .strings        = dev_strings,
 339         .max_speed      = USB_SPEED_HIGH,
 340         .bind           = multi_bind,
 341         .unbind         = __exit_p(multi_unbind),
 342         .needs_serial   = 1,
 343 };
 344
 345
 346 static int __init multi_init(void)
 347 {
 348         return usb_composite_probe(&multi_driver);
 349 }
 350 module_init(multi_init);
 351
 352 static void __exit multi_exit(void)
 353 {
 354         usb_composite_unregister(&multi_driver);
 355 }
 356 module_exit(multi_exit);