drivers/usb/gadget/acm_ms.c

   1 /*
   2  * acm_ms.c -- Composite driver, with ACM and mass storage support
   3  *
   4  * Copyright (C) 2008 David Brownell
   5  * Copyright (C) 2008 Nokia Corporation
   6  * Author: David Brownell
   7  * Modified: Klaus Schwarzkopf <schwarzkopf@sensortherm.de>
   8  *
   9  * Heavily based on multi.c and cdc2.c
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  */
  16
  17 #include <linux/kernel.h>
  18 #include <linux/module.h>
  19
  20 #include "u_serial.h"
  21
  22 #define DRIVER_DESC             "Composite Gadget (ACM + MS)"
  23 #define DRIVER_VERSION          "2011/10/10"
  24
  25 /*-------------------------------------------------------------------------*/
  26
  27 /*
  28  * DO NOT REUSE THESE IDs with a protocol-incompatible driver!!  Ever!!
  29  * Instead:  allocate your own, using normal USB-IF procedures.
  30  */
  31 #define ACM_MS_VENDOR_NUM       0x1d6b  /* Linux Foundation */
  32 #define ACM_MS_PRODUCT_NUM      0x0106  /* Composite Gadget: ACM + MS*/
  33
  34 /*-------------------------------------------------------------------------*/
  35
  36 /*
  37  * Kbuild is not very cooperative with respect to linking separately
  38  * compiled library objects into one module.  So for now we won't use
  39  * separate compilation ... ensuring init/exit sections work to shrink
  40  * the runtime footprint, and giving us at least some parts of what
  41  * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
  42  */
  43 #include "f_mass_storage.c"
  44
  45 /*-------------------------------------------------------------------------*/
  46 USB_GADGET_COMPOSITE_OPTIONS();
  47
  48 static struct usb_device_descriptor device_desc = {
  49         .bLength =              sizeof device_desc,
  50         .bDescriptorType =      USB_DT_DEVICE,
  51
  52         .bcdUSB =               cpu_to_le16(0x0200),
  53
  54         .bDeviceClass =         USB_CLASS_MISC /* 0xEF */,
  55         .bDeviceSubClass =      2,
  56         .bDeviceProtocol =      1,
  57
  58         /* .bMaxPacketSize0 = f(hardware) */
  59
  60         /* Vendor and product id can be overridden by module parameters.  */
  61         .idVendor =             cpu_to_le16(ACM_MS_VENDOR_NUM),
  62         .idProduct =            cpu_to_le16(ACM_MS_PRODUCT_NUM),
  63         /* .bcdDevice = f(hardware) */
  64         /* .iManufacturer = DYNAMIC */
  65         /* .iProduct = DYNAMIC */
  66         /* NO SERIAL NUMBER */
  67         /*.bNumConfigurations = DYNAMIC*/
  68 };
  69
  70 static struct usb_otg_descriptor otg_descriptor = {
  71         .bLength =              sizeof otg_descriptor,
  72         .bDescriptorType =      USB_DT_OTG,
  73
  74         /*
  75          * REVISIT SRP-only hardware is possible, although
  76          * it would not be called "OTG" ...
  77          */
  78         .bmAttributes =         USB_OTG_SRP | USB_OTG_HNP,
  79 };
  80
  81 static const struct usb_descriptor_header *otg_desc[] = {
  82         (struct usb_descriptor_header *) &otg_descriptor,
  83         NULL,
  84 };
  85
  86 /* string IDs are assigned dynamically */
  87 static struct usb_string strings_dev[] = {
  88         [USB_GADGET_MANUFACTURER_IDX].s = "",
  89         [USB_GADGET_PRODUCT_IDX].s = DRIVER_DESC,
  90         [USB_GADGET_SERIAL_IDX].s = "",
  91         {  } /* end of list */
  92 };
  93
  94 static struct usb_gadget_strings stringtab_dev = {
  95         .language       = 0x0409,       /* en-us */
  96         .strings        = strings_dev,
  97 };
  98
  99 static struct usb_gadget_strings *dev_strings[] = {
 100         &stringtab_dev,
 101         NULL,
 102 };
 103
 104 /****************************** Configurations ******************************/
 105
 106 static struct fsg_module_parameters fsg_mod_data = { .stall = 1 };
 107 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
 108
 109 static unsigned int fsg_num_buffers = CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS;
 110
 111 #else
 112
 113 /*
 114  * Number of buffers we will use.
 115  * 2 is usually enough for good buffering pipeline
 116  */
 117 #define fsg_num_buffers CONFIG_USB_GADGET_STORAGE_NUM_BUFFERS
 118
 119 #endif /* CONFIG_USB_DEBUG */
 120
 121 FSG_MODULE_PARAMETERS(/* no prefix */, fsg_mod_data);
 122
 123 static struct fsg_common fsg_common;
 124
 125 /*-------------------------------------------------------------------------*/
 126 static struct usb_function *f_acm;
 127 static struct usb_function_instance *f_acm_inst;
 128 /*
 129  * We _always_ have both ACM and mass storage functions.
 130  */
 131 static int __init acm_ms_do_config(struct usb_configuration *c)
 132 {
 133         int     status;
 134
 135         if (gadget_is_otg(c->cdev->gadget)) {
 136                 c->descriptors = otg_desc;
 137                 c->bmAttributes |= USB_CONFIG_ATT_WAKEUP;
 138         }
 139
 140         f_acm_inst = usb_get_function_instance("acm");
 141         if (IS_ERR(f_acm_inst))
 142                 return PTR_ERR(f_acm_inst);
 143
 144         f_acm = usb_get_function(f_acm_inst);
 145         if (IS_ERR(f_acm)) {
 146                 status = PTR_ERR(f_acm);
 147                 goto err_func;
 148         }
 149
 150         status = usb_add_function(c, f_acm);
 151         if (status < 0)
 152                 goto err_conf;
 153
 154         status = fsg_bind_config(c->cdev, c, &fsg_common);
 155         if (status < 0)
 156                 goto err_fsg;
 157
 158         return 0;
 159 err_fsg:
 160         usb_remove_function(c, f_acm);
 161 err_conf:
 162         usb_put_function(f_acm);
 163 err_func:
 164         usb_put_function_instance(f_acm_inst);
 165         return status;
 166 }
 167
 168 static struct usb_configuration acm_ms_config_driver = {
 169         .label                  = DRIVER_DESC,
 170         .bConfigurationValue    = 1,
 171         /* .iConfiguration = DYNAMIC */
 172         .bmAttributes           = USB_CONFIG_ATT_SELFPOWER,
 173 };
 174
 175 /*-------------------------------------------------------------------------*/
 176
 177 static int __init acm_ms_bind(struct usb_composite_dev *cdev)
 178 {
 179         struct usb_gadget       *gadget = cdev->gadget;
 180         int                     status;
 181         void                    *retp;
 182
 183         /* set up mass storage function */
 184         retp = fsg_common_from_params(&fsg_common, cdev, &fsg_mod_data,
 185                                       fsg_num_buffers);
 186         if (IS_ERR(retp)) {
 187                 status = PTR_ERR(retp);
 188                 return PTR_ERR(retp);
 189         }
 190
 191         /*
 192          * Allocate string descriptor numbers ... note that string
 193          * contents can be overridden by the composite_dev glue.
 194          */
 195         status = usb_string_ids_tab(cdev, strings_dev);
 196         if (status < 0)
 197                 goto fail1;
 198         device_desc.iManufacturer = strings_dev[USB_GADGET_MANUFACTURER_IDX].id;
 199         device_desc.iProduct = strings_dev[USB_GADGET_PRODUCT_IDX].id;
 200
 201         /* register our configuration */
 202         status = usb_add_config(cdev, &acm_ms_config_driver, acm_ms_do_config);
 203         if (status < 0)
 204                 goto fail1;
 205
 206         usb_composite_overwrite_options(cdev, &coverwrite);
 207         dev_info(&gadget->dev, "%s, version: " DRIVER_VERSION "\n",
 208                         DRIVER_DESC);
 209         fsg_common_put(&fsg_common);
 210         return 0;
 211
 212         /* error recovery */
 213 fail1:
 214         fsg_common_put(&fsg_common);
 215         return status;
 216 }
 217
 218 static int __exit acm_ms_unbind(struct usb_composite_dev *cdev)
 219 {
 220         usb_put_function(f_acm);
 221         usb_put_function_instance(f_acm_inst);
 222         return 0;
 223 }
 224
 225 static __refdata struct usb_composite_driver acm_ms_driver = {
 226         .name           = "g_acm_ms",
 227         .dev            = &device_desc,
 228         .max_speed      = USB_SPEED_SUPER,
 229         .strings        = dev_strings,
 230         .bind           = acm_ms_bind,
 231         .unbind         = __exit_p(acm_ms_unbind),
 232 };
 233
 234 MODULE_DESCRIPTION(DRIVER_DESC);
 235 MODULE_AUTHOR("Klaus Schwarzkopf <schwarzkopf@sensortherm.de>");
 236 MODULE_LICENSE("GPL v2");
 237
 238 static int __init init(void)
 239 {
 240         return usb_composite_probe(&acm_ms_driver);
 241 }
 242 module_init(init);
 243
 244 static void __exit cleanup(void)
 245 {
 246         usb_composite_unregister(&acm_ms_driver);
 247 }
 248 module_exit(cleanup);