drivers/usb/gadget/serial.c

   1 /*
   2  * serial.c -- USB gadget serial driver
   3  *
   4  * Copyright (C) 2003 Al Borchers (alborchers@steinerpoint.com)
   5  * Copyright (C) 2008 by David Brownell
   6  * Copyright (C) 2008 by Nokia Corporation
   7  *
   8  * This software is distributed under the terms of the GNU General
   9  * Public License ("GPL") as published by the Free Software Foundation,
  10  * either version 2 of that License or (at your option) any later version.
  11  */
  12
  13 #include <linux/kernel.h>
  14 #include <linux/utsname.h>
  15 #include <linux/device.h>
  16 #include <linux/tty.h>
  17 #include <linux/tty_flip.h>
  18
  19 #include "u_serial.h"
  20 #include "gadget_chips.h"
  21
  22
  23 /* Defines */
  24
  25 #define GS_VERSION_STR                  "v2.4"
  26 #define GS_VERSION_NUM                  0x2400
  27
  28 #define GS_LONG_NAME                    "Gadget Serial"
  29 #define GS_VERSION_NAME                 GS_LONG_NAME " " GS_VERSION_STR
  30
  31 /*-------------------------------------------------------------------------*/
  32
  33 /*
  34  * Kbuild is not very cooperative with respect to linking separately
  35  * compiled library objects into one module.  So for now we won't use
  36  * separate compilation ... ensuring init/exit sections work to shrink
  37  * the runtime footprint, and giving us at least some parts of what
  38  * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
  39  */
  40 #include "composite.c"
  41 #include "usbstring.c"
  42 #include "config.c"
  43 #include "epautoconf.c"
  44
  45 #include "f_acm.c"
  46 #include "f_serial.c"
  47 #include "u_serial.c"
  48
  49 /*-------------------------------------------------------------------------*/
  50
  51 /* Thanks to NetChip Technologies for donating this product ID.
  52 *
  53 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!!  Ever!!
  54 * Instead:  allocate your own, using normal USB-IF procedures.
  55 */
  56 #define GS_VENDOR_ID                    0x0525  /* NetChip */
  57 #define GS_PRODUCT_ID                   0xa4a6  /* Linux-USB Serial Gadget */
  58 #define GS_CDC_PRODUCT_ID               0xa4a7  /* ... as CDC-ACM */
  59
  60 /* string IDs are assigned dynamically */
  61
  62 #define STRING_MANUFACTURER_IDX         0
  63 #define STRING_PRODUCT_IDX              1
  64 #define STRING_DESCRIPTION_IDX          2
  65
  66 static char manufacturer[50];
  67
  68 static struct usb_string strings_dev[] = {
  69         [STRING_MANUFACTURER_IDX].s = manufacturer,
  70         [STRING_PRODUCT_IDX].s = GS_VERSION_NAME,
  71         [STRING_DESCRIPTION_IDX].s = NULL /* updated; f(use_acm) */,
  72         {  } /* end of list */
  73 };
  74
  75 static struct usb_gadget_strings stringtab_dev = {
  76         .language       = 0x0409,       /* en-us */
  77         .strings        = strings_dev,
  78 };
  79
  80 static struct usb_gadget_strings *dev_strings[] = {
  81         &stringtab_dev,
  82         NULL,
  83 };
  84
  85 static struct usb_device_descriptor device_desc = {
  86         .bLength =              USB_DT_DEVICE_SIZE,
  87         .bDescriptorType =      USB_DT_DEVICE,
  88         .bcdUSB =               __constant_cpu_to_le16(0x0200),
  89         /* .bDeviceClass = f(use_acm) */
  90         .bDeviceSubClass =      0,
  91         .bDeviceProtocol =      0,
  92         /* .bMaxPacketSize0 = f(hardware) */
  93         .idVendor =             __constant_cpu_to_le16(GS_VENDOR_ID),
  94         /* .idProduct = f(use_acm) */
  95         /* .bcdDevice = f(hardware) */
  96         /* .iManufacturer = DYNAMIC */
  97         /* .iProduct = DYNAMIC */
  98         .bNumConfigurations =   1,
  99 };
 100
 101 static struct usb_otg_descriptor otg_descriptor = {
 102         .bLength =              sizeof otg_descriptor,
 103         .bDescriptorType =      USB_DT_OTG,
 104
 105         /* REVISIT SRP-only hardware is possible, although
 106          * it would not be called "OTG" ...
 107          */
 108         .bmAttributes =         USB_OTG_SRP | USB_OTG_HNP,
 109 };
 110
 111 static const struct usb_descriptor_header *otg_desc[] = {
 112         (struct usb_descriptor_header *) &otg_descriptor,
 113         NULL,
 114 };
 115
 116 /*-------------------------------------------------------------------------*/
 117
 118 /* Module */
 119 MODULE_DESCRIPTION(GS_VERSION_NAME);
 120 MODULE_AUTHOR("Al Borchers");
 121 MODULE_AUTHOR("David Brownell");
 122 MODULE_LICENSE("GPL");
 123
 124 static int use_acm = true;
 125 module_param(use_acm, bool, 0);
 126 MODULE_PARM_DESC(use_acm, "Use CDC ACM, default=yes");
 127
 128 static unsigned n_ports = 1;
 129 module_param(n_ports, uint, 0);
 130 MODULE_PARM_DESC(n_ports, "number of ports to create, default=1");
 131
 132 /*-------------------------------------------------------------------------*/
 133
 134 static int __init serial_bind_config(struct usb_configuration *c)
 135 {
 136         unsigned i;
 137         int status = 0;
 138
 139         for (i = 0; i < n_ports && status == 0; i++) {
 140                 if (use_acm)
 141                         status = acm_bind_config(c, i);
 142                 else
 143                         status = gser_bind_config(c, i);
 144         }
 145         return status;
 146 }
 147
 148 static struct usb_configuration serial_config_driver = {
 149         /* .label = f(use_acm) */
 150         .bind           = serial_bind_config,
 151         /* .bConfigurationValue = f(use_acm) */
 152         /* .iConfiguration = DYNAMIC */
 153         .bmAttributes   = USB_CONFIG_ATT_SELFPOWER,
 154         .bMaxPower      = 1,    /* 2 mA, minimal */
 155 };
 156
 157 static int __init gs_bind(struct usb_composite_dev *cdev)
 158 {
 159         int                     gcnum;
 160         struct usb_gadget       *gadget = cdev->gadget;
 161         int                     status;
 162
 163         status = gserial_setup(cdev->gadget, n_ports);
 164         if (status < 0)
 165                 return status;
 166
 167         /* Allocate string descriptor numbers ... note that string
 168          * contents can be overridden by the composite_dev glue.
 169          */
 170
 171         /* device description: manufacturer, product */
 172         snprintf(manufacturer, sizeof manufacturer, "%s %s with %s",
 173                 init_utsname()->sysname, init_utsname()->release,
 174                 gadget->name);
 175         status = usb_string_id(cdev);
 176         if (status < 0)
 177                 goto fail;
 178         strings_dev[STRING_MANUFACTURER_IDX].id = status;
 179
 180         device_desc.iManufacturer = status;
 181
 182         status = usb_string_id(cdev);
 183         if (status < 0)
 184                 goto fail;
 185         strings_dev[STRING_PRODUCT_IDX].id = status;
 186
 187         device_desc.iProduct = status;
 188
 189         /* config description */
 190         status = usb_string_id(cdev);
 191         if (status < 0)
 192                 goto fail;
 193         strings_dev[STRING_DESCRIPTION_IDX].id = status;
 194
 195         serial_config_driver.iConfiguration = status;
 196
 197         /* set up other descriptors */
 198         gcnum = usb_gadget_controller_number(gadget);
 199         if (gcnum >= 0)
 200                 device_desc.bcdDevice = cpu_to_le16(GS_VERSION_NUM | gcnum);
 201         else {
 202                 /* this is so simple (for now, no altsettings) that it
 203                  * SHOULD NOT have problems with bulk-capable hardware.
 204                  * so warn about unrcognized controllers -- don't panic.
 205                  *
 206                  * things like configuration and altsetting numbering
 207                  * can need hardware-specific attention though.
 208                  */
 209                 pr_warning("gs_bind: controller '%s' not recognized\n",
 210                         gadget->name);
 211                 device_desc.bcdDevice =
 212                         __constant_cpu_to_le16(GS_VERSION_NUM | 0x0099);
 213         }
 214
 215         if (gadget_is_otg(cdev->gadget)) {
 216                 serial_config_driver.descriptors = otg_desc;
 217                 serial_config_driver.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
 218         }
 219
 220         /* register our configuration */
 221         status = usb_add_config(cdev, &serial_config_driver);
 222         if (status < 0)
 223                 goto fail;
 224
 225         INFO(cdev, "%s\n", GS_VERSION_NAME);
 226
 227         return 0;
 228
 229 fail:
 230         gserial_cleanup();
 231         return status;
 232 }
 233
 234 static struct usb_composite_driver gserial_driver = {
 235         .name           = "g_serial",
 236         .dev            = &device_desc,
 237         .strings        = dev_strings,
 238         .bind           = gs_bind,
 239 };
 240
 241 static int __init init(void)
 242 {
 243         /* We *could* export two configs; that'd be much cleaner...
 244          * but neither of these product IDs was defined that way.
 245          */
 246         if (use_acm) {
 247                 serial_config_driver.label = "CDC ACM config";
 248                 serial_config_driver.bConfigurationValue = 2;
 249                 device_desc.bDeviceClass = USB_CLASS_COMM;
 250                 device_desc.idProduct =
 251                                 __constant_cpu_to_le16(GS_CDC_PRODUCT_ID);
 252         } else {
 253                 serial_config_driver.label = "Generic Serial config";
 254                 serial_config_driver.bConfigurationValue = 1;
 255                 device_desc.bDeviceClass = USB_CLASS_VENDOR_SPEC;
 256                 device_desc.idProduct =
 257                                 __constant_cpu_to_le16(GS_PRODUCT_ID);
 258         }
 259         strings_dev[STRING_DESCRIPTION_IDX].s = serial_config_driver.label;
 260
 261         return usb_composite_register(&gserial_driver);
 262 }
 263 module_init(init);
 264
 265 static void __exit cleanup(void)
 266 {
 267         usb_composite_unregister(&gserial_driver);
 268         gserial_cleanup();
 269 }
 270 module_exit(cleanup);