err.no Git - linux-2.6/blob - drivers/usb/gadget/serial.c

   1 /*
   2  * g_serial.c -- USB gadget serial driver
   3  *
   4  * Copyright 2003 (C) Al Borchers (alborchers@steinerpoint.com)
   5  *
   6  * This code is based in part on the Gadget Zero driver, which
   7  * is Copyright (C) 2003 by David Brownell, all rights reserved.
   8  *
   9  * This code also borrows from usbserial.c, which is
  10  * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
  11  * Copyright (C) 2000 Peter Berger (pberger@brimson.com)
  12  * Copyright (C) 2000 Al Borchers (alborchers@steinerpoint.com)
  13  *
  14  * This software is distributed under the terms of the GNU General
  15  * Public License ("GPL") as published by the Free Software Foundation,
  16  * either version 2 of that License or (at your option) any later version.
  17  *
  18  */
  19
  20 #include <linux/config.h>
  21 #include <linux/module.h>
  22 #include <linux/kernel.h>
  23 #include <linux/delay.h>
  24 #include <linux/ioport.h>
  25 #include <linux/sched.h>
  26 #include <linux/slab.h>
  27 #include <linux/smp_lock.h>
  28 #include <linux/errno.h>
  29 #include <linux/init.h>
  30 #include <linux/timer.h>
  31 #include <linux/list.h>
  32 #include <linux/interrupt.h>
  33 #include <linux/utsname.h>
  34 #include <linux/wait.h>
  35 #include <linux/proc_fs.h>
  36 #include <linux/device.h>
  37 #include <linux/tty.h>
  38 #include <linux/tty_flip.h>
  39
  40 #include <asm/byteorder.h>
  41 #include <asm/io.h>
  42 #include <asm/irq.h>
  43 #include <asm/system.h>
  44 #include <asm/unaligned.h>
  45 #include <asm/uaccess.h>
  46
  47 #include <linux/usb_ch9.h>
  48 #include <linux/usb_cdc.h>
  49 #include <linux/usb_gadget.h>
  50
  51 #include "gadget_chips.h"
  52
  53
  54 /* Wait Cond */
  55
  56 #define __wait_cond_interruptible(wq, condition, lock, flags, ret)      \
  57 do {                                                                    \
  58         wait_queue_t __wait;                                            \
  59         init_waitqueue_entry(&__wait, current);                         \
  60                                                                         \
  61         add_wait_queue(&wq, &__wait);                                   \
  62         for (;;) {                                                      \
  63                 set_current_state(TASK_INTERRUPTIBLE);                  \
  64                 if (condition)                                          \
  65                         break;                                          \
  66                 if (!signal_pending(current)) {                         \
  67                         spin_unlock_irqrestore(lock, flags);            \
  68                         schedule();                                     \
  69                         spin_lock_irqsave(lock, flags);                 \
  70                         continue;                                       \
  71                 }                                                       \
  72                 ret = -ERESTARTSYS;                                     \
  73                 break;                                                  \
  74         }                                                               \
  75         current->state = TASK_RUNNING;                                  \
  76         remove_wait_queue(&wq, &__wait);                                \
  77 } while (0)
  78
  79 #define wait_cond_interruptible(wq, condition, lock, flags)             \
  80 ({                                                                      \
  81         int __ret = 0;                                                  \
  82         if (!(condition))                                               \
  83                 __wait_cond_interruptible(wq, condition, lock, flags,   \
  84                                                 __ret);                 \
  85         __ret;                                                          \
  86 })
  87
  88 #define __wait_cond_interruptible_timeout(wq, condition, lock, flags,   \
  89                                                 timeout, ret)           \
  90 do {                                                                    \
  91         signed long __timeout = timeout;                                \
  92         wait_queue_t __wait;                                            \
  93         init_waitqueue_entry(&__wait, current);                         \
  94                                                                         \
  95         add_wait_queue(&wq, &__wait);                                   \
  96         for (;;) {                                                      \
  97                 set_current_state(TASK_INTERRUPTIBLE);                  \
  98                 if (__timeout == 0)                                     \
  99                         break;                                          \
 100                 if (condition)                                          \
 101                         break;                                          \
 102                 if (!signal_pending(current)) {                         \
 103                         spin_unlock_irqrestore(lock, flags);            \
 104                         __timeout = schedule_timeout(__timeout);        \
 105                         spin_lock_irqsave(lock, flags);                 \
 106                         continue;                                       \
 107                 }                                                       \
 108                 ret = -ERESTARTSYS;                                     \
 109                 break;                                                  \
 110         }                                                               \
 111         current->state = TASK_RUNNING;                                  \
 112         remove_wait_queue(&wq, &__wait);                                \
 113 } while (0)
 114
 115 #define wait_cond_interruptible_timeout(wq, condition, lock, flags,     \
 116                                                 timeout)                \
 117 ({                                                                      \
 118         int __ret = 0;                                                  \
 119         if (!(condition))                                               \
 120                 __wait_cond_interruptible_timeout(wq, condition, lock,  \
 121                                                 flags, timeout, __ret); \
 122         __ret;                                                          \
 123 })
 124
 125
 126 /* Defines */
 127
 128 #define GS_VERSION_STR                  "v2.0"
 129 #define GS_VERSION_NUM                  0x0200
 130
 131 #define GS_LONG_NAME                    "Gadget Serial"
 132 #define GS_SHORT_NAME                   "g_serial"
 133
 134 #define GS_MAJOR                        127
 135 #define GS_MINOR_START                  0
 136
 137 #define GS_NUM_PORTS                    16
 138
 139 #define GS_NUM_CONFIGS                  1
 140 #define GS_NO_CONFIG_ID                 0
 141 #define GS_BULK_CONFIG_ID               1
 142 #define GS_ACM_CONFIG_ID                2
 143
 144 #define GS_MAX_NUM_INTERFACES           2
 145 #define GS_BULK_INTERFACE_ID            0
 146 #define GS_CONTROL_INTERFACE_ID         0
 147 #define GS_DATA_INTERFACE_ID            1
 148
 149 #define GS_MAX_DESC_LEN                 256
 150
 151 #define GS_DEFAULT_READ_Q_SIZE          32
 152 #define GS_DEFAULT_WRITE_Q_SIZE         32
 153
 154 #define GS_DEFAULT_WRITE_BUF_SIZE       8192
 155 #define GS_TMP_BUF_SIZE                 8192
 156
 157 #define GS_CLOSE_TIMEOUT                15
 158
 159 #define GS_DEFAULT_USE_ACM              0
 160
 161 #define GS_DEFAULT_DTE_RATE             9600
 162 #define GS_DEFAULT_DATA_BITS            8
 163 #define GS_DEFAULT_PARITY               USB_CDC_NO_PARITY
 164 #define GS_DEFAULT_CHAR_FORMAT          USB_CDC_1_STOP_BITS
 165
 166 /* select highspeed/fullspeed, hiding highspeed if not configured */
 167 #ifdef CONFIG_USB_GADGET_DUALSPEED
 168 #define GS_SPEED_SELECT(is_hs,hs,fs) ((is_hs) ? (hs) : (fs))
 169 #else
 170 #define GS_SPEED_SELECT(is_hs,hs,fs) (fs)
 171 #endif /* CONFIG_USB_GADGET_DUALSPEED */
 172
 173 /* debug settings */
 174 #ifdef GS_DEBUG
 175 static int debug = 1;
 176
 177 #define gs_debug(format, arg...) \
 178         do { if (debug) printk(KERN_DEBUG format, ## arg); } while(0)
 179 #define gs_debug_level(level, format, arg...) \
 180         do { if (debug>=level) printk(KERN_DEBUG format, ## arg); } while(0)
 181
 182 #else
 183
 184 #define gs_debug(format, arg...) \
 185         do { } while(0)
 186 #define gs_debug_level(level, format, arg...) \
 187         do { } while(0)
 188
 189 #endif /* GS_DEBUG */
 190
 191 /* Thanks to NetChip Technologies for donating this product ID.
 192  *
 193  * DO NOT REUSE THESE IDs with a protocol-incompatible driver!!  Ever!!
 194  * Instead:  allocate your own, using normal USB-IF procedures.
 195  */
 196 #define GS_VENDOR_ID                    0x0525  /* NetChip */
 197 #define GS_PRODUCT_ID                   0xa4a6  /* Linux-USB Serial Gadget */
 198 #define GS_CDC_PRODUCT_ID               0xa4a7  /* ... as CDC-ACM */
 199
 200 #define GS_LOG2_NOTIFY_INTERVAL         5       /* 1 << 5 == 32 msec */
 201 #define GS_NOTIFY_MAXPACKET             8
 202
 203
 204 /* Structures */
 205
 206 struct gs_dev;
 207
 208 /* circular buffer */
 209 struct gs_buf {
 210         unsigned int            buf_size;
 211         char                    *buf_buf;
 212         char                    *buf_get;
 213         char                    *buf_put;
 214 };
 215
 216 /* list of requests */
 217 struct gs_req_entry {
 218         struct list_head        re_entry;
 219         struct usb_request      *re_req;
 220 };
 221
 222 /* the port structure holds info for each port, one for each minor number */
 223 struct gs_port {
 224         struct gs_dev           *port_dev;      /* pointer to device struct */
 225         struct tty_struct       *port_tty;      /* pointer to tty struct */
 226         spinlock_t              port_lock;
 227         int                     port_num;
 228         int                     port_open_count;
 229         int                     port_in_use;    /* open/close in progress */
 230         wait_queue_head_t       port_write_wait;/* waiting to write */
 231         struct gs_buf           *port_write_buf;
 232         struct usb_cdc_line_coding      port_line_coding;
 233 };
 234
 235 /* the device structure holds info for the USB device */
 236 struct gs_dev {
 237         struct usb_gadget       *dev_gadget;    /* gadget device pointer */
 238         spinlock_t              dev_lock;       /* lock for set/reset config */
 239         int                     dev_config;     /* configuration number */
 240         struct usb_ep           *dev_notify_ep; /* address of notify endpoint */
 241         struct usb_ep           *dev_in_ep;     /* address of in endpoint */
 242         struct usb_ep           *dev_out_ep;    /* address of out endpoint */
 243         struct usb_endpoint_descriptor          /* descriptor of notify ep */
 244                                 *dev_notify_ep_desc;
 245         struct usb_endpoint_descriptor          /* descriptor of in endpoint */
 246                                 *dev_in_ep_desc;
 247         struct usb_endpoint_descriptor          /* descriptor of out endpoint */
 248                                 *dev_out_ep_desc;
 249         struct usb_request      *dev_ctrl_req;  /* control request */
 250         struct list_head        dev_req_list;   /* list of write requests */
 251         int                     dev_sched_port; /* round robin port scheduled */
 252         struct gs_port          *dev_port[GS_NUM_PORTS]; /* the ports */
 253 };
 254
 255
 256 /* Functions */
 257
 258 /* module */
 259 static int __init gs_module_init(void);
 260 static void __exit gs_module_exit(void);
 261
 262 /* tty driver */
 263 static int gs_open(struct tty_struct *tty, struct file *file);
 264 static void gs_close(struct tty_struct *tty, struct file *file);
 265 static int gs_write(struct tty_struct *tty,
 266         const unsigned char *buf, int count);
 267 static void gs_put_char(struct tty_struct *tty, unsigned char ch);
 268 static void gs_flush_chars(struct tty_struct *tty);
 269 static int gs_write_room(struct tty_struct *tty);
 270 static int gs_chars_in_buffer(struct tty_struct *tty);
 271 static void gs_throttle(struct tty_struct * tty);
 272 static void gs_unthrottle(struct tty_struct * tty);
 273 static void gs_break(struct tty_struct *tty, int break_state);
 274 static int  gs_ioctl(struct tty_struct *tty, struct file *file,
 275         unsigned int cmd, unsigned long arg);
 276 static void gs_set_termios(struct tty_struct *tty, struct termios *old);
 277
 278 static int gs_send(struct gs_dev *dev);
 279 static int gs_send_packet(struct gs_dev *dev, char *packet,
 280         unsigned int size);
 281 static int gs_recv_packet(struct gs_dev *dev, char *packet,
 282         unsigned int size);
 283 static void gs_read_complete(struct usb_ep *ep, struct usb_request *req);
 284 static void gs_write_complete(struct usb_ep *ep, struct usb_request *req);
 285
 286 /* gadget driver */
 287 static int gs_bind(struct usb_gadget *gadget);
 288 static void gs_unbind(struct usb_gadget *gadget);
 289 static int gs_setup(struct usb_gadget *gadget,
 290         const struct usb_ctrlrequest *ctrl);
 291 static int gs_setup_standard(struct usb_gadget *gadget,
 292         const struct usb_ctrlrequest *ctrl);
 293 static int gs_setup_class(struct usb_gadget *gadget,
 294         const struct usb_ctrlrequest *ctrl);
 295 static void gs_setup_complete(struct usb_ep *ep, struct usb_request *req);
 296 static void gs_disconnect(struct usb_gadget *gadget);
 297 static int gs_set_config(struct gs_dev *dev, unsigned config);
 298 static void gs_reset_config(struct gs_dev *dev);
 299 static int gs_build_config_buf(u8 *buf, enum usb_device_speed speed,
 300                 u8 type, unsigned int index, int is_otg);
 301
 302 static struct usb_request *gs_alloc_req(struct usb_ep *ep, unsigned int len,
 303         gfp_t kmalloc_flags);
 304 static void gs_free_req(struct usb_ep *ep, struct usb_request *req);
 305
 306 static struct gs_req_entry *gs_alloc_req_entry(struct usb_ep *ep, unsigned len,
 307         gfp_t kmalloc_flags);
 308 static void gs_free_req_entry(struct usb_ep *ep, struct gs_req_entry *req);
 309
 310 static int gs_alloc_ports(struct gs_dev *dev, gfp_t kmalloc_flags);
 311 static void gs_free_ports(struct gs_dev *dev);
 312
 313 /* circular buffer */
 314 static struct gs_buf *gs_buf_alloc(unsigned int size, gfp_t kmalloc_flags);
 315 static void gs_buf_free(struct gs_buf *gb);
 316 static void gs_buf_clear(struct gs_buf *gb);
 317 static unsigned int gs_buf_data_avail(struct gs_buf *gb);
 318 static unsigned int gs_buf_space_avail(struct gs_buf *gb);
 319 static unsigned int gs_buf_put(struct gs_buf *gb, const char *buf,
 320         unsigned int count);
 321 static unsigned int gs_buf_get(struct gs_buf *gb, char *buf,
 322         unsigned int count);
 323
 324 /* external functions */
 325 extern int net2280_set_fifo_mode(struct usb_gadget *gadget, int mode);
 326
 327
 328 /* Globals */
 329
 330 static struct gs_dev *gs_device;
 331
 332 static const char *EP_IN_NAME;
 333 static const char *EP_OUT_NAME;
 334 static const char *EP_NOTIFY_NAME;
 335
 336 static struct semaphore gs_open_close_sem[GS_NUM_PORTS];
 337
 338 static unsigned int read_q_size = GS_DEFAULT_READ_Q_SIZE;
 339 static unsigned int write_q_size = GS_DEFAULT_WRITE_Q_SIZE;
 340
 341 static unsigned int write_buf_size = GS_DEFAULT_WRITE_BUF_SIZE;
 342
 343 static unsigned int use_acm = GS_DEFAULT_USE_ACM;
 344
 345
 346 /* tty driver struct */
 347 static struct tty_operations gs_tty_ops = {
 348         .open =                 gs_open,
 349         .close =                gs_close,
 350         .write =                gs_write,
 351         .put_char =             gs_put_char,
 352         .flush_chars =          gs_flush_chars,
 353         .write_room =           gs_write_room,
 354         .ioctl =                gs_ioctl,
 355         .set_termios =          gs_set_termios,
 356         .throttle =             gs_throttle,
 357         .unthrottle =           gs_unthrottle,
 358         .break_ctl =            gs_break,
 359         .chars_in_buffer =      gs_chars_in_buffer,
 360 };
 361 static struct tty_driver *gs_tty_driver;
 362
 363 /* gadget driver struct */
 364 static struct usb_gadget_driver gs_gadget_driver = {
 365 #ifdef CONFIG_USB_GADGET_DUALSPEED
 366         .speed =                USB_SPEED_HIGH,
 367 #else
 368         .speed =                USB_SPEED_FULL,
 369 #endif /* CONFIG_USB_GADGET_DUALSPEED */
 370         .function =             GS_LONG_NAME,
 371         .bind =                 gs_bind,
 372         .unbind =               gs_unbind,
 373         .setup =                gs_setup,
 374         .disconnect =           gs_disconnect,
 375         .driver = {
 376                 .name =         GS_SHORT_NAME,
 377                 /* .shutdown = ... */
 378                 /* .suspend = ...  */
 379                 /* .resume = ...   */
 380         },
 381 };
 382
 383
 384 /* USB descriptors */
 385
 386 #define GS_MANUFACTURER_STR_ID  1
 387 #define GS_PRODUCT_STR_ID       2
 388 #define GS_SERIAL_STR_ID        3
 389 #define GS_BULK_CONFIG_STR_ID   4
 390 #define GS_ACM_CONFIG_STR_ID    5
 391 #define GS_CONTROL_STR_ID       6
 392 #define GS_DATA_STR_ID          7
 393
 394 /* static strings, in UTF-8 */
 395 static char manufacturer[50];
 396 static struct usb_string gs_strings[] = {
 397         { GS_MANUFACTURER_STR_ID, manufacturer },
 398         { GS_PRODUCT_STR_ID, GS_LONG_NAME },
 399         { GS_SERIAL_STR_ID, "0" },
 400         { GS_BULK_CONFIG_STR_ID, "Gadget Serial Bulk" },
 401         { GS_ACM_CONFIG_STR_ID, "Gadget Serial CDC ACM" },
 402         { GS_CONTROL_STR_ID, "Gadget Serial Control" },
 403         { GS_DATA_STR_ID, "Gadget Serial Data" },
 404         {  } /* end of list */
 405 };
 406
 407 static struct usb_gadget_strings gs_string_table = {
 408         .language =             0x0409, /* en-us */
 409         .strings =              gs_strings,
 410 };
 411
 412 static struct usb_device_descriptor gs_device_desc = {
 413         .bLength =              USB_DT_DEVICE_SIZE,
 414         .bDescriptorType =      USB_DT_DEVICE,
 415         .bcdUSB =               __constant_cpu_to_le16(0x0200),
 416         .bDeviceSubClass =      0,
 417         .bDeviceProtocol =      0,
 418         .idVendor =             __constant_cpu_to_le16(GS_VENDOR_ID),
 419         .idProduct =            __constant_cpu_to_le16(GS_PRODUCT_ID),
 420         .iManufacturer =        GS_MANUFACTURER_STR_ID,
 421         .iProduct =             GS_PRODUCT_STR_ID,
 422         .iSerialNumber =        GS_SERIAL_STR_ID,
 423         .bNumConfigurations =   GS_NUM_CONFIGS,
 424 };
 425
 426 static struct usb_otg_descriptor gs_otg_descriptor = {
 427         .bLength =              sizeof(gs_otg_descriptor),
 428         .bDescriptorType =      USB_DT_OTG,
 429         .bmAttributes =         USB_OTG_SRP,
 430 };
 431
 432 static struct usb_config_descriptor gs_bulk_config_desc = {
 433         .bLength =              USB_DT_CONFIG_SIZE,
 434         .bDescriptorType =      USB_DT_CONFIG,
 435         /* .wTotalLength computed dynamically */
 436         .bNumInterfaces =       1,
 437         .bConfigurationValue =  GS_BULK_CONFIG_ID,
 438         .iConfiguration =       GS_BULK_CONFIG_STR_ID,
 439         .bmAttributes =         USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
 440         .bMaxPower =            1,
 441 };
 442
 443 static struct usb_config_descriptor gs_acm_config_desc = {
 444         .bLength =              USB_DT_CONFIG_SIZE,
 445         .bDescriptorType =      USB_DT_CONFIG,
 446         /* .wTotalLength computed dynamically */
 447         .bNumInterfaces =       2,
 448         .bConfigurationValue =  GS_ACM_CONFIG_ID,
 449         .iConfiguration =       GS_ACM_CONFIG_STR_ID,
 450         .bmAttributes =         USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
 451         .bMaxPower =            1,
 452 };
 453
 454 static const struct usb_interface_descriptor gs_bulk_interface_desc = {
 455         .bLength =              USB_DT_INTERFACE_SIZE,
 456         .bDescriptorType =      USB_DT_INTERFACE,
 457         .bInterfaceNumber =     GS_BULK_INTERFACE_ID,
 458         .bNumEndpoints =        2,
 459         .bInterfaceClass =      USB_CLASS_CDC_DATA,
 460         .bInterfaceSubClass =   0,
 461         .bInterfaceProtocol =   0,
 462         .iInterface =           GS_DATA_STR_ID,
 463 };
 464
 465 static const struct usb_interface_descriptor gs_control_interface_desc = {
 466         .bLength =              USB_DT_INTERFACE_SIZE,
 467         .bDescriptorType =      USB_DT_INTERFACE,
 468         .bInterfaceNumber =     GS_CONTROL_INTERFACE_ID,
 469         .bNumEndpoints =        1,
 470         .bInterfaceClass =      USB_CLASS_COMM,
 471         .bInterfaceSubClass =   USB_CDC_SUBCLASS_ACM,
 472         .bInterfaceProtocol =   USB_CDC_ACM_PROTO_AT_V25TER,
 473         .iInterface =           GS_CONTROL_STR_ID,
 474 };
 475
 476 static const struct usb_interface_descriptor gs_data_interface_desc = {
 477         .bLength =              USB_DT_INTERFACE_SIZE,
 478         .bDescriptorType =      USB_DT_INTERFACE,
 479         .bInterfaceNumber =     GS_DATA_INTERFACE_ID,
 480         .bNumEndpoints =        2,
 481         .bInterfaceClass =      USB_CLASS_CDC_DATA,
 482         .bInterfaceSubClass =   0,
 483         .bInterfaceProtocol =   0,
 484         .iInterface =           GS_DATA_STR_ID,
 485 };
 486
 487 static const struct usb_cdc_header_desc gs_header_desc = {
 488         .bLength =              sizeof(gs_header_desc),
 489         .bDescriptorType =      USB_DT_CS_INTERFACE,
 490         .bDescriptorSubType =   USB_CDC_HEADER_TYPE,
 491         .bcdCDC =               __constant_cpu_to_le16(0x0110),
 492 };
 493
 494 static const struct usb_cdc_call_mgmt_descriptor gs_call_mgmt_descriptor = {
 495         .bLength =              sizeof(gs_call_mgmt_descriptor),
 496         .bDescriptorType =      USB_DT_CS_INTERFACE,
 497         .bDescriptorSubType =   USB_CDC_CALL_MANAGEMENT_TYPE,
 498         .bmCapabilities =       0,
 499         .bDataInterface =       1,      /* index of data interface */
 500 };
 501
 502 static struct usb_cdc_acm_descriptor gs_acm_descriptor = {
 503         .bLength =              sizeof(gs_acm_descriptor),
 504         .bDescriptorType =      USB_DT_CS_INTERFACE,
 505         .bDescriptorSubType =   USB_CDC_ACM_TYPE,
 506         .bmCapabilities =       0,
 507 };
 508
 509 static const struct usb_cdc_union_desc gs_union_desc = {
 510         .bLength =              sizeof(gs_union_desc),
 511         .bDescriptorType =      USB_DT_CS_INTERFACE,
 512         .bDescriptorSubType =   USB_CDC_UNION_TYPE,
 513         .bMasterInterface0 =    0,      /* index of control interface */
 514         .bSlaveInterface0 =     1,      /* index of data interface */
 515 };
 516
 517 static struct usb_endpoint_descriptor gs_fullspeed_notify_desc = {
 518         .bLength =              USB_DT_ENDPOINT_SIZE,
 519         .bDescriptorType =      USB_DT_ENDPOINT,
 520         .bEndpointAddress =     USB_DIR_IN,
 521         .bmAttributes =         USB_ENDPOINT_XFER_INT,
 522         .wMaxPacketSize =       __constant_cpu_to_le16(GS_NOTIFY_MAXPACKET),
 523         .bInterval =            1 << GS_LOG2_NOTIFY_INTERVAL,
 524 };
 525
 526 static struct usb_endpoint_descriptor gs_fullspeed_in_desc = {
 527         .bLength =              USB_DT_ENDPOINT_SIZE,
 528         .bDescriptorType =      USB_DT_ENDPOINT,
 529         .bEndpointAddress =     USB_DIR_IN,
 530         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 531 };
 532
 533 static struct usb_endpoint_descriptor gs_fullspeed_out_desc = {
 534         .bLength =              USB_DT_ENDPOINT_SIZE,
 535         .bDescriptorType =      USB_DT_ENDPOINT,
 536         .bEndpointAddress =     USB_DIR_OUT,
 537         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 538 };
 539
 540 static const struct usb_descriptor_header *gs_bulk_fullspeed_function[] = {
 541         (struct usb_descriptor_header *) &gs_otg_descriptor,
 542         (struct usb_descriptor_header *) &gs_bulk_interface_desc,
 543         (struct usb_descriptor_header *) &gs_fullspeed_in_desc,
 544         (struct usb_descriptor_header *) &gs_fullspeed_out_desc,
 545         NULL,
 546 };
 547
 548 static const struct usb_descriptor_header *gs_acm_fullspeed_function[] = {
 549         (struct usb_descriptor_header *) &gs_otg_descriptor,
 550         (struct usb_descriptor_header *) &gs_control_interface_desc,
 551         (struct usb_descriptor_header *) &gs_header_desc,
 552         (struct usb_descriptor_header *) &gs_call_mgmt_descriptor,
 553         (struct usb_descriptor_header *) &gs_acm_descriptor,
 554         (struct usb_descriptor_header *) &gs_union_desc,
 555         (struct usb_descriptor_header *) &gs_fullspeed_notify_desc,
 556         (struct usb_descriptor_header *) &gs_data_interface_desc,
 557         (struct usb_descriptor_header *) &gs_fullspeed_in_desc,
 558         (struct usb_descriptor_header *) &gs_fullspeed_out_desc,
 559         NULL,
 560 };
 561
 562 #ifdef CONFIG_USB_GADGET_DUALSPEED
 563 static struct usb_endpoint_descriptor gs_highspeed_notify_desc = {
 564         .bLength =              USB_DT_ENDPOINT_SIZE,
 565         .bDescriptorType =      USB_DT_ENDPOINT,
 566         .bEndpointAddress =     USB_DIR_IN,
 567         .bmAttributes =         USB_ENDPOINT_XFER_INT,
 568         .wMaxPacketSize =       __constant_cpu_to_le16(GS_NOTIFY_MAXPACKET),
 569         .bInterval =            GS_LOG2_NOTIFY_INTERVAL+4,
 570 };
 571
 572 static struct usb_endpoint_descriptor gs_highspeed_in_desc = {
 573         .bLength =              USB_DT_ENDPOINT_SIZE,
 574         .bDescriptorType =      USB_DT_ENDPOINT,
 575         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 576         .wMaxPacketSize =       __constant_cpu_to_le16(512),
 577 };
 578
 579 static struct usb_endpoint_descriptor gs_highspeed_out_desc = {
 580         .bLength =              USB_DT_ENDPOINT_SIZE,
 581         .bDescriptorType =      USB_DT_ENDPOINT,
 582         .bmAttributes =         USB_ENDPOINT_XFER_BULK,
 583         .wMaxPacketSize =       __constant_cpu_to_le16(512),
 584 };
 585
 586 static struct usb_qualifier_descriptor gs_qualifier_desc = {
 587         .bLength =              sizeof(struct usb_qualifier_descriptor),
 588         .bDescriptorType =      USB_DT_DEVICE_QUALIFIER,
 589         .bcdUSB =               __constant_cpu_to_le16 (0x0200),
 590         /* assumes ep0 uses the same value for both speeds ... */
 591         .bNumConfigurations =   GS_NUM_CONFIGS,
 592 };
 593
 594 static const struct usb_descriptor_header *gs_bulk_highspeed_function[] = {
 595         (struct usb_descriptor_header *) &gs_otg_descriptor,
 596         (struct usb_descriptor_header *) &gs_bulk_interface_desc,
 597         (struct usb_descriptor_header *) &gs_highspeed_in_desc,
 598         (struct usb_descriptor_header *) &gs_highspeed_out_desc,
 599         NULL,
 600 };
 601
 602 static const struct usb_descriptor_header *gs_acm_highspeed_function[] = {
 603         (struct usb_descriptor_header *) &gs_otg_descriptor,
 604         (struct usb_descriptor_header *) &gs_control_interface_desc,
 605         (struct usb_descriptor_header *) &gs_header_desc,
 606         (struct usb_descriptor_header *) &gs_call_mgmt_descriptor,
 607         (struct usb_descriptor_header *) &gs_acm_descriptor,
 608         (struct usb_descriptor_header *) &gs_union_desc,
 609         (struct usb_descriptor_header *) &gs_highspeed_notify_desc,
 610         (struct usb_descriptor_header *) &gs_data_interface_desc,
 611         (struct usb_descriptor_header *) &gs_highspeed_in_desc,
 612         (struct usb_descriptor_header *) &gs_highspeed_out_desc,
 613         NULL,
 614 };
 615
 616 #endif /* CONFIG_USB_GADGET_DUALSPEED */
 617
 618
 619 /* Module */
 620 MODULE_DESCRIPTION(GS_LONG_NAME);
 621 MODULE_AUTHOR("Al Borchers");
 622 MODULE_LICENSE("GPL");
 623
 624 #ifdef GS_DEBUG
 625 module_param(debug, int, S_IRUGO|S_IWUSR);
 626 MODULE_PARM_DESC(debug, "Enable debugging, 0=off, 1=on");
 627 #endif
 628
 629 module_param(read_q_size, uint, S_IRUGO);
 630 MODULE_PARM_DESC(read_q_size, "Read request queue size, default=32");
 631
 632 module_param(write_q_size, uint, S_IRUGO);
 633 MODULE_PARM_DESC(write_q_size, "Write request queue size, default=32");
 634
 635 module_param(write_buf_size, uint, S_IRUGO);
 636 MODULE_PARM_DESC(write_buf_size, "Write buffer size, default=8192");
 637
 638 module_param(use_acm, uint, S_IRUGO);
 639 MODULE_PARM_DESC(use_acm, "Use CDC ACM, 0=no, 1=yes, default=no");
 640
 641 module_init(gs_module_init);
 642 module_exit(gs_module_exit);
 643
 644 /*
 645 *  gs_module_init
 646 *
 647 *  Register as a USB gadget driver and a tty driver.
 648 */
 649 static int __init gs_module_init(void)
 650 {
 651         int i;
 652         int retval;
 653
 654         retval = usb_gadget_register_driver(&gs_gadget_driver);
 655         if (retval) {
 656                 printk(KERN_ERR "gs_module_init: cannot register gadget driver, ret=%d\n", retval);
 657                 return retval;
 658         }
 659
 660         gs_tty_driver = alloc_tty_driver(GS_NUM_PORTS);
 661         if (!gs_tty_driver)
 662                 return -ENOMEM;
 663         gs_tty_driver->owner = THIS_MODULE;
 664         gs_tty_driver->driver_name = GS_SHORT_NAME;
 665         gs_tty_driver->name = "ttygs";
 666         gs_tty_driver->devfs_name = "usb/ttygs/";
 667         gs_tty_driver->major = GS_MAJOR;
 668         gs_tty_driver->minor_start = GS_MINOR_START;
 669         gs_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
 670         gs_tty_driver->subtype = SERIAL_TYPE_NORMAL;
 671         gs_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_NO_DEVFS;
 672         gs_tty_driver->init_termios = tty_std_termios;
 673         gs_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
 674         tty_set_operations(gs_tty_driver, &gs_tty_ops);
 675
 676         for (i=0; i < GS_NUM_PORTS; i++)
 677                 sema_init(&gs_open_close_sem[i], 1);
 678
 679         retval = tty_register_driver(gs_tty_driver);
 680         if (retval) {
 681                 usb_gadget_unregister_driver(&gs_gadget_driver);
 682                 put_tty_driver(gs_tty_driver);
 683                 printk(KERN_ERR "gs_module_init: cannot register tty driver, ret=%d\n", retval);
 684                 return retval;
 685         }
 686
 687         printk(KERN_INFO "gs_module_init: %s %s loaded\n", GS_LONG_NAME, GS_VERSION_STR);
 688         return 0;
 689 }
 690
 691 /*
 692 * gs_module_exit
 693 *
 694 * Unregister as a tty driver and a USB gadget driver.
 695 */
 696 static void __exit gs_module_exit(void)
 697 {
 698         tty_unregister_driver(gs_tty_driver);
 699         put_tty_driver(gs_tty_driver);
 700         usb_gadget_unregister_driver(&gs_gadget_driver);
 701
 702         printk(KERN_INFO "gs_module_exit: %s %s unloaded\n", GS_LONG_NAME, GS_VERSION_STR);
 703 }
 704
 705 /* TTY Driver */
 706
 707 /*
 708  * gs_open
 709  */
 710 static int gs_open(struct tty_struct *tty, struct file *file)
 711 {
 712         int port_num;
 713         unsigned long flags;
 714         struct gs_port *port;
 715         struct gs_dev *dev;
 716         struct gs_buf *buf;
 717         struct semaphore *sem;
 718         int ret;
 719
 720         port_num = tty->index;
 721
 722         gs_debug("gs_open: (%d,%p,%p)\n", port_num, tty, file);
 723
 724         if (port_num < 0 || port_num >= GS_NUM_PORTS) {
 725                 printk(KERN_ERR "gs_open: (%d,%p,%p) invalid port number\n",
 726                         port_num, tty, file);
 727                 return -ENODEV;
 728         }
 729
 730         dev = gs_device;
 731
 732         if (dev == NULL) {
 733                 printk(KERN_ERR "gs_open: (%d,%p,%p) NULL device pointer\n",
 734                         port_num, tty, file);
 735                 return -ENODEV;
 736         }
 737
 738         sem = &gs_open_close_sem[port_num];
 739         if (down_interruptible(sem)) {
 740                 printk(KERN_ERR
 741                 "gs_open: (%d,%p,%p) interrupted waiting for semaphore\n",
 742                         port_num, tty, file);
 743                 return -ERESTARTSYS;
 744         }
 745
 746         spin_lock_irqsave(&dev->dev_lock, flags);
 747
 748         if (dev->dev_config == GS_NO_CONFIG_ID) {
 749                 printk(KERN_ERR
 750                         "gs_open: (%d,%p,%p) device is not connected\n",
 751                         port_num, tty, file);
 752                 ret = -ENODEV;
 753                 goto exit_unlock_dev;
 754         }
 755
 756         port = dev->dev_port[port_num];
 757
 758         if (port == NULL) {
 759                 printk(KERN_ERR "gs_open: (%d,%p,%p) NULL port pointer\n",
 760                         port_num, tty, file);
 761                 ret = -ENODEV;
 762                 goto exit_unlock_dev;
 763         }
 764
 765         spin_lock(&port->port_lock);
 766         spin_unlock(&dev->dev_lock);
 767
 768         if (port->port_dev == NULL) {
 769                 printk(KERN_ERR "gs_open: (%d,%p,%p) port disconnected (1)\n",
 770                         port_num, tty, file);
 771                 ret = -EIO;
 772                 goto exit_unlock_port;
 773         }
 774
 775         if (port->port_open_count > 0) {
 776                 ++port->port_open_count;
 777                 gs_debug("gs_open: (%d,%p,%p) already open\n",
 778                         port_num, tty, file);
 779                 ret = 0;
 780                 goto exit_unlock_port;
 781         }
 782
 783         tty->driver_data = NULL;
 784
 785         /* mark port as in use, we can drop port lock and sleep if necessary */
 786         port->port_in_use = 1;
 787
 788         /* allocate write buffer on first open */
 789         if (port->port_write_buf == NULL) {
 790                 spin_unlock_irqrestore(&port->port_lock, flags);
 791                 buf = gs_buf_alloc(write_buf_size, GFP_KERNEL);
 792                 spin_lock_irqsave(&port->port_lock, flags);
 793
 794                 /* might have been disconnected while asleep, check */
 795                 if (port->port_dev == NULL) {
 796                         printk(KERN_ERR
 797                                 "gs_open: (%d,%p,%p) port disconnected (2)\n",
 798                                 port_num, tty, file);
 799                         port->port_in_use = 0;
 800                         ret = -EIO;
 801                         goto exit_unlock_port;
 802                 }
 803
 804                 if ((port->port_write_buf=buf) == NULL) {
 805                         printk(KERN_ERR "gs_open: (%d,%p,%p) cannot allocate port write buffer\n",
 806                                 port_num, tty, file);
 807                         port->port_in_use = 0;
 808                         ret = -ENOMEM;
 809                         goto exit_unlock_port;
 810                 }
 811
 812         }
 813
 814         /* wait for carrier detect (not implemented) */
 815
 816         /* might have been disconnected while asleep, check */
 817         if (port->port_dev == NULL) {
 818                 printk(KERN_ERR "gs_open: (%d,%p,%p) port disconnected (3)\n",
 819                         port_num, tty, file);
 820                 port->port_in_use = 0;
 821                 ret = -EIO;
 822                 goto exit_unlock_port;
 823         }
 824
 825         tty->driver_data = port;
 826         port->port_tty = tty;
 827         port->port_open_count = 1;
 828         port->port_in_use = 0;
 829
 830         gs_debug("gs_open: (%d,%p,%p) completed\n", port_num, tty, file);
 831
 832         ret = 0;
 833
 834 exit_unlock_port:
 835         spin_unlock_irqrestore(&port->port_lock, flags);
 836         up(sem);
 837         return ret;
 838
 839 exit_unlock_dev:
 840         spin_unlock_irqrestore(&dev->dev_lock, flags);
 841         up(sem);
 842         return ret;
 843
 844 }
 845
 846 /*
 847  * gs_close
 848  */
 849 static void gs_close(struct tty_struct *tty, struct file *file)
 850 {
 851         unsigned long flags;
 852         struct gs_port *port = tty->driver_data;
 853         struct semaphore *sem;
 854
 855         if (port == NULL) {
 856                 printk(KERN_ERR "gs_close: NULL port pointer\n");
 857                 return;
 858         }
 859
 860         gs_debug("gs_close: (%d,%p,%p)\n", port->port_num, tty, file);
 861
 862         sem = &gs_open_close_sem[port->port_num];
 863         down(sem);
 864
 865         spin_lock_irqsave(&port->port_lock, flags);
 866
 867         if (port->port_open_count == 0) {
 868                 printk(KERN_ERR
 869                         "gs_close: (%d,%p,%p) port is already closed\n",
 870                         port->port_num, tty, file);
 871                 goto exit;
 872         }
 873
 874         if (port->port_open_count > 1) {
 875                 --port->port_open_count;
 876                 goto exit;
 877         }
 878
 879         /* free disconnected port on final close */
 880         if (port->port_dev == NULL) {
 881                 kfree(port);
 882                 goto exit;
 883         }
 884
 885         /* mark port as closed but in use, we can drop port lock */
 886         /* and sleep if necessary */
 887         port->port_in_use = 1;
 888         port->port_open_count = 0;
 889
 890         /* wait for write buffer to drain, or */
 891         /* at most GS_CLOSE_TIMEOUT seconds */
 892         if (gs_buf_data_avail(port->port_write_buf) > 0) {
 893                 spin_unlock_irqrestore(&port->port_lock, flags);
 894                 wait_cond_interruptible_timeout(port->port_write_wait,
 895                 port->port_dev == NULL
 896                 || gs_buf_data_avail(port->port_write_buf) == 0,
 897                 &port->port_lock, flags, GS_CLOSE_TIMEOUT * HZ);
 898                 spin_lock_irqsave(&port->port_lock, flags);
 899         }
 900
 901         /* free disconnected port on final close */
 902         /* (might have happened during the above sleep) */
 903         if (port->port_dev == NULL) {
 904                 kfree(port);
 905                 goto exit;
 906         }
 907
 908         gs_buf_clear(port->port_write_buf);
 909
 910         tty->driver_data = NULL;
 911         port->port_tty = NULL;
 912         port->port_in_use = 0;
 913
 914         gs_debug("gs_close: (%d,%p,%p) completed\n",
 915                 port->port_num, tty, file);
 916
 917 exit:
 918         spin_unlock_irqrestore(&port->port_lock, flags);
 919         up(sem);
 920 }
 921
 922 /*
 923  * gs_write
 924  */
 925 static int gs_write(struct tty_struct *tty, const unsigned char *buf, int count)
 926 {
 927         unsigned long flags;
 928         struct gs_port *port = tty->driver_data;
 929         int ret;
 930
 931         if (port == NULL) {
 932                 printk(KERN_ERR "gs_write: NULL port pointer\n");
 933                 return -EIO;
 934         }
 935
 936         gs_debug("gs_write: (%d,%p) writing %d bytes\n", port->port_num, tty,
 937                 count);
 938
 939         if (count == 0)
 940                 return 0;
 941
 942         spin_lock_irqsave(&port->port_lock, flags);
 943
 944         if (port->port_dev == NULL) {
 945                 printk(KERN_ERR "gs_write: (%d,%p) port is not connected\n",
 946                         port->port_num, tty);
 947                 ret = -EIO;
 948                 goto exit;
 949         }
 950
 951         if (port->port_open_count == 0) {
 952                 printk(KERN_ERR "gs_write: (%d,%p) port is closed\n",
 953                         port->port_num, tty);
 954                 ret = -EBADF;
 955                 goto exit;
 956         }
 957
 958         count = gs_buf_put(port->port_write_buf, buf, count);
 959
 960         spin_unlock_irqrestore(&port->port_lock, flags);
 961
 962         gs_send(gs_device);
 963
 964         gs_debug("gs_write: (%d,%p) wrote %d bytes\n", port->port_num, tty,
 965                 count);
 966
 967         return count;
 968
 969 exit:
 970         spin_unlock_irqrestore(&port->port_lock, flags);
 971         return ret;
 972 }
 973
 974 /*
 975  * gs_put_char
 976  */
 977 static void gs_put_char(struct tty_struct *tty, unsigned char ch)
 978 {
 979         unsigned long flags;
 980         struct gs_port *port = tty->driver_data;
 981
 982         if (port == NULL) {
 983                 printk(KERN_ERR "gs_put_char: NULL port pointer\n");
 984                 return;
 985         }
 986
 987         gs_debug("gs_put_char: (%d,%p) char=0x%x, called from %p, %p, %p\n", port->port_num, tty, ch, __builtin_return_address(0), __builtin_return_address(1), __builtin_return_address(2));
 988
 989         spin_lock_irqsave(&port->port_lock, flags);
 990
 991         if (port->port_dev == NULL) {
 992                 printk(KERN_ERR "gs_put_char: (%d,%p) port is not connected\n",
 993                         port->port_num, tty);
 994                 goto exit;
 995         }
 996
 997         if (port->port_open_count == 0) {
 998                 printk(KERN_ERR "gs_put_char: (%d,%p) port is closed\n",
 999                         port->port_num, tty);
1000                 goto exit;
1001         }
1002
1003         gs_buf_put(port->port_write_buf, &ch, 1);
1004
1005 exit:
1006         spin_unlock_irqrestore(&port->port_lock, flags);
1007 }
1008
1009 /*
1010  * gs_flush_chars
1011  */
1012 static void gs_flush_chars(struct tty_struct *tty)
1013 {
1014         unsigned long flags;
1015         struct gs_port *port = tty->driver_data;
1016
1017         if (port == NULL) {
1018                 printk(KERN_ERR "gs_flush_chars: NULL port pointer\n");
1019                 return;
1020         }
1021
1022         gs_debug("gs_flush_chars: (%d,%p)\n", port->port_num, tty);
1023
1024         spin_lock_irqsave(&port->port_lock, flags);
1025
1026         if (port->port_dev == NULL) {
1027                 printk(KERN_ERR
1028                         "gs_flush_chars: (%d,%p) port is not connected\n",
1029                         port->port_num, tty);
1030                 goto exit;
1031         }
1032
1033         if (port->port_open_count == 0) {
1034                 printk(KERN_ERR "gs_flush_chars: (%d,%p) port is closed\n",
1035                         port->port_num, tty);
1036                 goto exit;
1037         }
1038
1039         spin_unlock_irqrestore(&port->port_lock, flags);
1040
1041         gs_send(gs_device);
1042
1043         return;
1044
1045 exit:
1046         spin_unlock_irqrestore(&port->port_lock, flags);
1047 }
1048
1049 /*
1050  * gs_write_room
1051  */
1052 static int gs_write_room(struct tty_struct *tty)
1053 {
1054
1055         int room = 0;
1056         unsigned long flags;
1057         struct gs_port *port = tty->driver_data;
1058
1059
1060         if (port == NULL)
1061                 return 0;
1062
1063         spin_lock_irqsave(&port->port_lock, flags);
1064
1065         if (port->port_dev != NULL && port->port_open_count > 0
1066         && port->port_write_buf != NULL)
1067                 room = gs_buf_space_avail(port->port_write_buf);
1068
1069         spin_unlock_irqrestore(&port->port_lock, flags);
1070
1071         gs_debug("gs_write_room: (%d,%p) room=%d\n",
1072                 port->port_num, tty, room);
1073
1074         return room;
1075 }
1076
1077 /*
1078  * gs_chars_in_buffer
1079  */
1080 static int gs_chars_in_buffer(struct tty_struct *tty)
1081 {
1082         int chars = 0;
1083         unsigned long flags;
1084         struct gs_port *port = tty->driver_data;
1085
1086         if (port == NULL)
1087                 return 0;
1088
1089         spin_lock_irqsave(&port->port_lock, flags);
1090
1091         if (port->port_dev != NULL && port->port_open_count > 0
1092         && port->port_write_buf != NULL)
1093                 chars = gs_buf_data_avail(port->port_write_buf);
1094
1095         spin_unlock_irqrestore(&port->port_lock, flags);
1096
1097         gs_debug("gs_chars_in_buffer: (%d,%p) chars=%d\n",
1098                 port->port_num, tty, chars);
1099
1100         return chars;
1101 }
1102
1103 /*
1104  * gs_throttle
1105  */
1106 static void gs_throttle(struct tty_struct *tty)
1107 {
1108 }
1109
1110 /*
1111  * gs_unthrottle
1112  */
1113 static void gs_unthrottle(struct tty_struct *tty)
1114 {
1115 }
1116
1117 /*
1118  * gs_break
1119  */
1120 static void gs_break(struct tty_struct *tty, int break_state)
1121 {
1122 }
1123
1124 /*
1125  * gs_ioctl
1126  */
1127 static int gs_ioctl(struct tty_struct *tty, struct file *file, unsigned int cmd, unsigned long arg)
1128 {
1129         struct gs_port *port = tty->driver_data;
1130
1131         if (port == NULL) {
1132                 printk(KERN_ERR "gs_ioctl: NULL port pointer\n");
1133                 return -EIO;
1134         }
1135
1136         gs_debug("gs_ioctl: (%d,%p,%p) cmd=0x%4.4x, arg=%lu\n",
1137                 port->port_num, tty, file, cmd, arg);
1138
1139         /* handle ioctls */
1140
1141         /* could not handle ioctl */
1142         return -ENOIOCTLCMD;
1143 }
1144
1145 /*
1146  * gs_set_termios
1147  */
1148 static void gs_set_termios(struct tty_struct *tty, struct termios *old)
1149 {
1150 }
1151
1152 /*
1153 * gs_send
1154 *
1155 * This function finds available write requests, calls
1156 * gs_send_packet to fill these packets with data, and
1157 * continues until either there are no more write requests
1158 * available or no more data to send.  This function is
1159 * run whenever data arrives or write requests are available.
1160 */
1161 static int gs_send(struct gs_dev *dev)
1162 {
1163         int ret,len;
1164         unsigned long flags;
1165         struct usb_ep *ep;
1166         struct usb_request *req;
1167         struct gs_req_entry *req_entry;
1168
1169         if (dev == NULL) {
1170                 printk(KERN_ERR "gs_send: NULL device pointer\n");
1171                 return -ENODEV;
1172         }
1173
1174         spin_lock_irqsave(&dev->dev_lock, flags);
1175
1176         ep = dev->dev_in_ep;
1177
1178         while(!list_empty(&dev->dev_req_list)) {
1179
1180                 req_entry = list_entry(dev->dev_req_list.next,
1181                         struct gs_req_entry, re_entry);
1182
1183                 req = req_entry->re_req;
1184
1185                 len = gs_send_packet(dev, req->buf, ep->maxpacket);
1186
1187                 if (len > 0) {
1188 gs_debug_level(3, "gs_send: len=%d, 0x%2.2x 0x%2.2x 0x%2.2x ...\n", len, *((unsigned char *)req->buf), *((unsigned char *)req->buf+1), *((unsigned char *)req->buf+2));
1189                         list_del(&req_entry->re_entry);
1190                         req->length = len;
1191                         if ((ret=usb_ep_queue(ep, req, GFP_ATOMIC))) {
1192                                 printk(KERN_ERR
1193                                 "gs_send: cannot queue read request, ret=%d\n",
1194                                         ret);
1195                                 break;
1196                         }
1197                 } else {
1198                         break;
1199                 }
1200
1201         }
1202
1203         spin_unlock_irqrestore(&dev->dev_lock, flags);
1204
1205         return 0;
1206 }
1207
1208 /*
1209  * gs_send_packet
1210  *
1211  * If there is data to send, a packet is built in the given
1212  * buffer and the size is returned.  If there is no data to
1213  * send, 0 is returned.  If there is any error a negative
1214  * error number is returned.
1215  *
1216  * Called during USB completion routine, on interrupt time.
1217  *
1218  * We assume that disconnect will not happen until all completion
1219  * routines have completed, so we can assume that the dev_port
1220  * array does not change during the lifetime of this function.
1221  */
1222 static int gs_send_packet(struct gs_dev *dev, char *packet, unsigned int size)
1223 {
1224         unsigned int len;
1225         struct gs_port *port;
1226
1227         /* TEMPORARY -- only port 0 is supported right now */
1228         port = dev->dev_port[0];
1229
1230         if (port == NULL) {
1231                 printk(KERN_ERR
1232                         "gs_send_packet: port=%d, NULL port pointer\n",
1233                         0);
1234                 return -EIO;
1235         }
1236
1237         spin_lock(&port->port_lock);
1238
1239         len = gs_buf_data_avail(port->port_write_buf);
1240         if (len < size)
1241                 size = len;
1242
1243         if (size == 0)
1244                 goto exit;
1245
1246         size = gs_buf_get(port->port_write_buf, packet, size);
1247
1248         if (port->port_tty)
1249                 wake_up_interruptible(&port->port_tty->write_wait);
1250
1251 exit:
1252         spin_unlock(&port->port_lock);
1253         return size;
1254 }
1255
1256 /*
1257  * gs_recv_packet
1258  *
1259  * Called for each USB packet received.  Reads the packet
1260  * header and stuffs the data in the appropriate tty buffer.
1261  * Returns 0 if successful, or a negative error number.
1262  *
1263  * Called during USB completion routine, on interrupt time.
1264  *
1265  * We assume that disconnect will not happen until all completion
1266  * routines have completed, so we can assume that the dev_port
1267  * array does not change during the lifetime of this function.
1268  */
1269 static int gs_recv_packet(struct gs_dev *dev, char *packet, unsigned int size)
1270 {
1271         unsigned int len;
1272         struct gs_port *port;
1273         int ret;
1274         struct tty_struct *tty;
1275
1276         /* TEMPORARY -- only port 0 is supported right now */
1277         port = dev->dev_port[0];
1278
1279         if (port == NULL) {
1280                 printk(KERN_ERR "gs_recv_packet: port=%d, NULL port pointer\n",
1281                         port->port_num);
1282                 return -EIO;
1283         }
1284
1285         spin_lock(&port->port_lock);
1286
1287         if (port->port_open_count == 0) {
1288                 printk(KERN_ERR "gs_recv_packet: port=%d, port is closed\n",
1289                         port->port_num);
1290                 ret = -EIO;
1291                 goto exit;
1292         }
1293
1294
1295         tty = port->port_tty;
1296
1297         if (tty == NULL) {
1298                 printk(KERN_ERR "gs_recv_packet: port=%d, NULL tty pointer\n",
1299                         port->port_num);
1300                 ret = -EIO;
1301                 goto exit;
1302         }
1303
1304         if (port->port_tty->magic != TTY_MAGIC) {
1305                 printk(KERN_ERR "gs_recv_packet: port=%d, bad tty magic\n",
1306                         port->port_num);
1307                 ret = -EIO;
1308                 goto exit;
1309         }
1310
1311         len = tty_buffer_request_room(tty, size);
1312         if (len > 0) {
1313                 tty_insert_flip_string(tty, packet, len);
1314                 tty_flip_buffer_push(port->port_tty);
1315                 wake_up_interruptible(&port->port_tty->read_wait);
1316         }
1317         ret = 0;
1318 exit:
1319         spin_unlock(&port->port_lock);
1320         return ret;
1321 }
1322
1323 /*
1324 * gs_read_complete
1325 */
1326 static void gs_read_complete(struct usb_ep *ep, struct usb_request *req)
1327 {
1328         int ret;
1329         struct gs_dev *dev = ep->driver_data;
1330
1331         if (dev == NULL) {
1332                 printk(KERN_ERR "gs_read_complete: NULL device pointer\n");
1333                 return;
1334         }
1335
1336         switch(req->status) {
1337         case 0:
1338                 /* normal completion */
1339                 gs_recv_packet(dev, req->buf, req->actual);
1340 requeue:
1341                 req->length = ep->maxpacket;
1342                 if ((ret=usb_ep_queue(ep, req, GFP_ATOMIC))) {
1343                         printk(KERN_ERR
1344                         "gs_read_complete: cannot queue read request, ret=%d\n",
1345                                 ret);
1346                 }
1347                 break;
1348
1349         case -ESHUTDOWN:
1350                 /* disconnect */
1351                 gs_debug("gs_read_complete: shutdown\n");
1352                 gs_free_req(ep, req);
1353                 break;
1354
1355         default:
1356                 /* unexpected */
1357                 printk(KERN_ERR
1358                 "gs_read_complete: unexpected status error, status=%d\n",
1359                         req->status);
1360                 goto requeue;
1361                 break;
1362         }
1363 }
1364
1365 /*
1366 * gs_write_complete
1367 */
1368 static void gs_write_complete(struct usb_ep *ep, struct usb_request *req)
1369 {
1370         struct gs_dev *dev = ep->driver_data;
1371         struct gs_req_entry *gs_req = req->context;
1372
1373         if (dev == NULL) {
1374                 printk(KERN_ERR "gs_write_complete: NULL device pointer\n");
1375                 return;
1376         }
1377
1378         switch(req->status) {
1379         case 0:
1380                 /* normal completion */
1381 requeue:
1382                 if (gs_req == NULL) {
1383                         printk(KERN_ERR
1384                                 "gs_write_complete: NULL request pointer\n");
1385                         return;
1386                 }
1387
1388                 spin_lock(&dev->dev_lock);
1389                 list_add(&gs_req->re_entry, &dev->dev_req_list);
1390                 spin_unlock(&dev->dev_lock);
1391
1392                 gs_send(dev);
1393
1394                 break;
1395
1396         case -ESHUTDOWN:
1397                 /* disconnect */
1398                 gs_debug("gs_write_complete: shutdown\n");
1399                 gs_free_req(ep, req);
1400                 break;
1401
1402         default:
1403                 printk(KERN_ERR
1404                 "gs_write_complete: unexpected status error, status=%d\n",
1405                         req->status);
1406                 goto requeue;
1407                 break;
1408         }
1409 }
1410
1411 /* Gadget Driver */
1412
1413 /*
1414  * gs_bind
1415  *
1416  * Called on module load.  Allocates and initializes the device
1417  * structure and a control request.
1418  */
1419 static int gs_bind(struct usb_gadget *gadget)
1420 {
1421         int ret;
1422         struct usb_ep *ep;
1423         struct gs_dev *dev;
1424         int gcnum;
1425
1426         /* Some controllers can't support CDC ACM:
1427          * - sh doesn't support multiple interfaces or configs;
1428          * - sa1100 doesn't have a third interrupt endpoint
1429          */
1430         if (gadget_is_sh(gadget) || gadget_is_sa1100(gadget))
1431                 use_acm = 0;
1432
1433         gcnum = usb_gadget_controller_number(gadget);
1434         if (gcnum >= 0)
1435                 gs_device_desc.bcdDevice =
1436                                 cpu_to_le16(GS_VERSION_NUM | gcnum);
1437         else {
1438                 printk(KERN_WARNING "gs_bind: controller '%s' not recognized\n",
1439                         gadget->name);
1440                 /* unrecognized, but safe unless bulk is REALLY quirky */
1441                 gs_device_desc.bcdDevice =
1442                         __constant_cpu_to_le16(GS_VERSION_NUM|0x0099);
1443         }
1444
1445         usb_ep_autoconfig_reset(gadget);
1446
1447         ep = usb_ep_autoconfig(gadget, &gs_fullspeed_in_desc);
1448         if (!ep)
1449                 goto autoconf_fail;
1450         EP_IN_NAME = ep->name;
1451         ep->driver_data = ep;   /* claim the endpoint */
1452
1453         ep = usb_ep_autoconfig(gadget, &gs_fullspeed_out_desc);
1454         if (!ep)
1455                 goto autoconf_fail;
1456         EP_OUT_NAME = ep->name;
1457         ep->driver_data = ep;   /* claim the endpoint */
1458
1459         if (use_acm) {
1460                 ep = usb_ep_autoconfig(gadget, &gs_fullspeed_notify_desc);
1461                 if (!ep) {
1462                         printk(KERN_ERR "gs_bind: cannot run ACM on %s\n", gadget->name);
1463                         goto autoconf_fail;
1464                 }
1465                 gs_device_desc.idProduct = __constant_cpu_to_le16(
1466                                                 GS_CDC_PRODUCT_ID),
1467                 EP_NOTIFY_NAME = ep->name;
1468                 ep->driver_data = ep;   /* claim the endpoint */
1469         }
1470
1471         gs_device_desc.bDeviceClass = use_acm
1472                 ? USB_CLASS_COMM : USB_CLASS_VENDOR_SPEC;
1473         gs_device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
1474
1475 #ifdef CONFIG_USB_GADGET_DUALSPEED
1476         gs_qualifier_desc.bDeviceClass = use_acm
1477                 ? USB_CLASS_COMM : USB_CLASS_VENDOR_SPEC;
1478         /* assume ep0 uses the same packet size for both speeds */
1479         gs_qualifier_desc.bMaxPacketSize0 = gs_device_desc.bMaxPacketSize0;
1480         /* assume endpoints are dual-speed */
1481         gs_highspeed_notify_desc.bEndpointAddress =
1482                 gs_fullspeed_notify_desc.bEndpointAddress;
1483         gs_highspeed_in_desc.bEndpointAddress =
1484                 gs_fullspeed_in_desc.bEndpointAddress;
1485         gs_highspeed_out_desc.bEndpointAddress =
1486                 gs_fullspeed_out_desc.bEndpointAddress;
1487 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1488
1489         usb_gadget_set_selfpowered(gadget);
1490
1491         if (gadget->is_otg) {
1492                 gs_otg_descriptor.bmAttributes |= USB_OTG_HNP,
1493                 gs_bulk_config_desc.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1494                 gs_acm_config_desc.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1495         }
1496
1497         gs_device = dev = kmalloc(sizeof(struct gs_dev), GFP_KERNEL);
1498         if (dev == NULL)
1499                 return -ENOMEM;
1500
1501         snprintf(manufacturer, sizeof(manufacturer), "%s %s with %s",
1502                 system_utsname.sysname, system_utsname.release,
1503                 gadget->name);
1504
1505         memset(dev, 0, sizeof(struct gs_dev));
1506         dev->dev_gadget = gadget;
1507         spin_lock_init(&dev->dev_lock);
1508         INIT_LIST_HEAD(&dev->dev_req_list);
1509         set_gadget_data(gadget, dev);
1510
1511         if ((ret=gs_alloc_ports(dev, GFP_KERNEL)) != 0) {
1512                 printk(KERN_ERR "gs_bind: cannot allocate ports\n");
1513                 gs_unbind(gadget);
1514                 return ret;
1515         }
1516
1517         /* preallocate control response and buffer */
1518         dev->dev_ctrl_req = gs_alloc_req(gadget->ep0, GS_MAX_DESC_LEN,
1519                 GFP_KERNEL);
1520         if (dev->dev_ctrl_req == NULL) {
1521                 gs_unbind(gadget);
1522                 return -ENOMEM;
1523         }
1524         dev->dev_ctrl_req->complete = gs_setup_complete;
1525
1526         gadget->ep0->driver_data = dev;
1527
1528         printk(KERN_INFO "gs_bind: %s %s bound\n",
1529                 GS_LONG_NAME, GS_VERSION_STR);
1530
1531         return 0;
1532
1533 autoconf_fail:
1534         printk(KERN_ERR "gs_bind: cannot autoconfigure on %s\n", gadget->name);
1535         return -ENODEV;
1536 }
1537
1538 /*
1539  * gs_unbind
1540  *
1541  * Called on module unload.  Frees the control request and device
1542  * structure.
1543  */
1544 static void gs_unbind(struct usb_gadget *gadget)
1545 {
1546         struct gs_dev *dev = get_gadget_data(gadget);
1547
1548         gs_device = NULL;
1549
1550         /* read/write requests already freed, only control request remains */
1551         if (dev != NULL) {
1552                 if (dev->dev_ctrl_req != NULL) {
1553                         gs_free_req(gadget->ep0, dev->dev_ctrl_req);
1554                         dev->dev_ctrl_req = NULL;
1555                 }
1556                 gs_free_ports(dev);
1557                 kfree(dev);
1558                 set_gadget_data(gadget, NULL);
1559         }
1560
1561         printk(KERN_INFO "gs_unbind: %s %s unbound\n", GS_LONG_NAME,
1562                 GS_VERSION_STR);
1563 }
1564
1565 /*
1566  * gs_setup
1567  *
1568  * Implements all the control endpoint functionality that's not
1569  * handled in hardware or the hardware driver.
1570  *
1571  * Returns the size of the data sent to the host, or a negative
1572  * error number.
1573  */
1574 static int gs_setup(struct usb_gadget *gadget,
1575         const struct usb_ctrlrequest *ctrl)
1576 {
1577         int ret = -EOPNOTSUPP;
1578         struct gs_dev *dev = get_gadget_data(gadget);
1579         struct usb_request *req = dev->dev_ctrl_req;
1580         u16 wIndex = le16_to_cpu(ctrl->wIndex);
1581         u16 wValue = le16_to_cpu(ctrl->wValue);
1582         u16 wLength = le16_to_cpu(ctrl->wLength);
1583
1584         switch (ctrl->bRequestType & USB_TYPE_MASK) {
1585         case USB_TYPE_STANDARD:
1586                 ret = gs_setup_standard(gadget,ctrl);
1587                 break;
1588
1589         case USB_TYPE_CLASS:
1590                 ret = gs_setup_class(gadget,ctrl);
1591                 break;
1592
1593         default:
1594                 printk(KERN_ERR "gs_setup: unknown request, type=%02x, request=%02x, value=%04x, index=%04x, length=%d\n",
1595                         ctrl->bRequestType, ctrl->bRequest,
1596                         wValue, wIndex, wLength);
1597                 break;
1598         }
1599
1600         /* respond with data transfer before status phase? */
1601         if (ret >= 0) {
1602                 req->length = ret;
1603                 req->zero = ret < wLength
1604                                 && (ret % gadget->ep0->maxpacket) == 0;
1605                 ret = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
1606                 if (ret < 0) {
1607                         printk(KERN_ERR "gs_setup: cannot queue response, ret=%d\n",
1608                                 ret);
1609                         req->status = 0;
1610                         gs_setup_complete(gadget->ep0, req);
1611                 }
1612         }
1613
1614         /* device either stalls (ret < 0) or reports success */
1615         return ret;
1616 }
1617
1618 static int gs_setup_standard(struct usb_gadget *gadget,
1619         const struct usb_ctrlrequest *ctrl)
1620 {
1621         int ret = -EOPNOTSUPP;
1622         struct gs_dev *dev = get_gadget_data(gadget);
1623         struct usb_request *req = dev->dev_ctrl_req;
1624         u16 wIndex = le16_to_cpu(ctrl->wIndex);
1625         u16 wValue = le16_to_cpu(ctrl->wValue);
1626         u16 wLength = le16_to_cpu(ctrl->wLength);
1627
1628         switch (ctrl->bRequest) {
1629         case USB_REQ_GET_DESCRIPTOR:
1630                 if (ctrl->bRequestType != USB_DIR_IN)
1631                         break;
1632
1633                 switch (wValue >> 8) {
1634                 case USB_DT_DEVICE:
1635                         ret = min(wLength,
1636                                 (u16)sizeof(struct usb_device_descriptor));
1637                         memcpy(req->buf, &gs_device_desc, ret);
1638                         break;
1639
1640 #ifdef CONFIG_USB_GADGET_DUALSPEED
1641                 case USB_DT_DEVICE_QUALIFIER:
1642                         if (!gadget->is_dualspeed)
1643                                 break;
1644                         ret = min(wLength,
1645                                 (u16)sizeof(struct usb_qualifier_descriptor));
1646                         memcpy(req->buf, &gs_qualifier_desc, ret);
1647                         break;
1648
1649                 case USB_DT_OTHER_SPEED_CONFIG:
1650                         if (!gadget->is_dualspeed)
1651                                 break;
1652                         /* fall through */
1653 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1654                 case USB_DT_CONFIG:
1655                         ret = gs_build_config_buf(req->buf, gadget->speed,
1656                                 wValue >> 8, wValue & 0xff,
1657                                 gadget->is_otg);
1658                         if (ret >= 0)
1659                                 ret = min(wLength, (u16)ret);
1660                         break;
1661
1662                 case USB_DT_STRING:
1663                         /* wIndex == language code. */
1664                         ret = usb_gadget_get_string(&gs_string_table,
1665                                 wValue & 0xff, req->buf);
1666                         if (ret >= 0)
1667                                 ret = min(wLength, (u16)ret);
1668                         break;
1669                 }
1670                 break;
1671
1672         case USB_REQ_SET_CONFIGURATION:
1673                 if (ctrl->bRequestType != 0)
1674                         break;
1675                 spin_lock(&dev->dev_lock);
1676                 ret = gs_set_config(dev, wValue);
1677                 spin_unlock(&dev->dev_lock);
1678                 break;
1679
1680         case USB_REQ_GET_CONFIGURATION:
1681                 if (ctrl->bRequestType != USB_DIR_IN)
1682                         break;
1683                 *(u8 *)req->buf = dev->dev_config;
1684                 ret = min(wLength, (u16)1);
1685                 break;
1686
1687         case USB_REQ_SET_INTERFACE:
1688                 if (ctrl->bRequestType != USB_RECIP_INTERFACE
1689                                 || !dev->dev_config
1690                                 || wIndex >= GS_MAX_NUM_INTERFACES)
1691                         break;
1692                 if (dev->dev_config == GS_BULK_CONFIG_ID
1693                                 && wIndex != GS_BULK_INTERFACE_ID)
1694                         break;
1695                 /* no alternate interface settings */
1696                 if (wValue != 0)
1697                         break;
1698                 spin_lock(&dev->dev_lock);
1699                 /* PXA hardware partially handles SET_INTERFACE;
1700                  * we need to kluge around that interference.  */
1701                 if (gadget_is_pxa(gadget)) {
1702                         ret = gs_set_config(dev, use_acm ?
1703                                 GS_ACM_CONFIG_ID : GS_BULK_CONFIG_ID);
1704                         goto set_interface_done;
1705                 }
1706                 if (dev->dev_config != GS_BULK_CONFIG_ID
1707                                 && wIndex == GS_CONTROL_INTERFACE_ID) {
1708                         if (dev->dev_notify_ep) {
1709                                 usb_ep_disable(dev->dev_notify_ep);
1710                                 usb_ep_enable(dev->dev_notify_ep, dev->dev_notify_ep_desc);
1711                         }
1712                 } else {
1713                         usb_ep_disable(dev->dev_in_ep);
1714                         usb_ep_disable(dev->dev_out_ep);
1715                         usb_ep_enable(dev->dev_in_ep, dev->dev_in_ep_desc);
1716                         usb_ep_enable(dev->dev_out_ep, dev->dev_out_ep_desc);
1717                 }
1718                 ret = 0;
1719 set_interface_done:
1720                 spin_unlock(&dev->dev_lock);
1721                 break;
1722
1723         case USB_REQ_GET_INTERFACE:
1724                 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)
1725                 || dev->dev_config == GS_NO_CONFIG_ID)
1726                         break;
1727                 if (wIndex >= GS_MAX_NUM_INTERFACES
1728                                 || (dev->dev_config == GS_BULK_CONFIG_ID
1729                                 && wIndex != GS_BULK_INTERFACE_ID)) {
1730                         ret = -EDOM;
1731                         break;
1732                 }
1733                 /* no alternate interface settings */
1734                 *(u8 *)req->buf = 0;
1735                 ret = min(wLength, (u16)1);
1736                 break;
1737
1738         default:
1739                 printk(KERN_ERR "gs_setup: unknown standard request, type=%02x, request=%02x, value=%04x, index=%04x, length=%d\n",
1740                         ctrl->bRequestType, ctrl->bRequest,
1741                         wValue, wIndex, wLength);
1742                 break;
1743         }
1744
1745         return ret;
1746 }
1747
1748 static int gs_setup_class(struct usb_gadget *gadget,
1749         const struct usb_ctrlrequest *ctrl)
1750 {
1751         int ret = -EOPNOTSUPP;
1752         struct gs_dev *dev = get_gadget_data(gadget);
1753         struct gs_port *port = dev->dev_port[0];        /* ACM only has one port */
1754         struct usb_request *req = dev->dev_ctrl_req;
1755         u16 wIndex = le16_to_cpu(ctrl->wIndex);
1756         u16 wValue = le16_to_cpu(ctrl->wValue);
1757         u16 wLength = le16_to_cpu(ctrl->wLength);
1758
1759         switch (ctrl->bRequest) {
1760         case USB_CDC_REQ_SET_LINE_CODING:
1761                 ret = min(wLength,
1762                         (u16)sizeof(struct usb_cdc_line_coding));
1763                 if (port) {
1764                         spin_lock(&port->port_lock);
1765                         memcpy(&port->port_line_coding, req->buf, ret);
1766                         spin_unlock(&port->port_lock);
1767                 }
1768                 break;
1769
1770         case USB_CDC_REQ_GET_LINE_CODING:
1771                 port = dev->dev_port[0];        /* ACM only has one port */
1772                 ret = min(wLength,
1773                         (u16)sizeof(struct usb_cdc_line_coding));
1774                 if (port) {
1775                         spin_lock(&port->port_lock);
1776                         memcpy(req->buf, &port->port_line_coding, ret);
1777                         spin_unlock(&port->port_lock);
1778                 }
1779                 break;
1780
1781         case USB_CDC_REQ_SET_CONTROL_LINE_STATE:
1782                 ret = 0;
1783                 break;
1784
1785         default:
1786                 printk(KERN_ERR "gs_setup: unknown class request, type=%02x, request=%02x, value=%04x, index=%04x, length=%d\n",
1787                         ctrl->bRequestType, ctrl->bRequest,
1788                         wValue, wIndex, wLength);
1789                 break;
1790         }
1791
1792         return ret;
1793 }
1794
1795 /*
1796  * gs_setup_complete
1797  */
1798 static void gs_setup_complete(struct usb_ep *ep, struct usb_request *req)
1799 {
1800         if (req->status || req->actual != req->length) {
1801                 printk(KERN_ERR "gs_setup_complete: status error, status=%d, actual=%d, length=%d\n",
1802                         req->status, req->actual, req->length);
1803         }
1804 }
1805
1806 /*
1807  * gs_disconnect
1808  *
1809  * Called when the device is disconnected.  Frees the closed
1810  * ports and disconnects open ports.  Open ports will be freed
1811  * on close.  Then reallocates the ports for the next connection.
1812  */
1813 static void gs_disconnect(struct usb_gadget *gadget)
1814 {
1815         unsigned long flags;
1816         struct gs_dev *dev = get_gadget_data(gadget);
1817
1818         spin_lock_irqsave(&dev->dev_lock, flags);
1819
1820         gs_reset_config(dev);
1821
1822         /* free closed ports and disconnect open ports */
1823         /* (open ports will be freed when closed) */
1824         gs_free_ports(dev);
1825
1826         /* re-allocate ports for the next connection */
1827         if (gs_alloc_ports(dev, GFP_ATOMIC) != 0)
1828                 printk(KERN_ERR "gs_disconnect: cannot re-allocate ports\n");
1829
1830         spin_unlock_irqrestore(&dev->dev_lock, flags);
1831
1832         printk(KERN_INFO "gs_disconnect: %s disconnected\n", GS_LONG_NAME);
1833 }
1834
1835 /*
1836  * gs_set_config
1837  *
1838  * Configures the device by enabling device specific
1839  * optimizations, setting up the endpoints, allocating
1840  * read and write requests and queuing read requests.
1841  *
1842  * The device lock must be held when calling this function.
1843  */
1844 static int gs_set_config(struct gs_dev *dev, unsigned config)
1845 {
1846         int i;
1847         int ret = 0;
1848         struct usb_gadget *gadget = dev->dev_gadget;
1849         struct usb_ep *ep;
1850         struct usb_endpoint_descriptor *ep_desc;
1851         struct usb_request *req;
1852         struct gs_req_entry *req_entry;
1853
1854         if (dev == NULL) {
1855                 printk(KERN_ERR "gs_set_config: NULL device pointer\n");
1856                 return 0;
1857         }
1858
1859         if (config == dev->dev_config)
1860                 return 0;
1861
1862         gs_reset_config(dev);
1863
1864         switch (config) {
1865         case GS_NO_CONFIG_ID:
1866                 return 0;
1867         case GS_BULK_CONFIG_ID:
1868                 if (use_acm)
1869                         return -EINVAL;
1870                 /* device specific optimizations */
1871                 if (gadget_is_net2280(gadget))
1872                         net2280_set_fifo_mode(gadget, 1);
1873                 break;
1874         case GS_ACM_CONFIG_ID:
1875                 if (!use_acm)
1876                         return -EINVAL;
1877                 /* device specific optimizations */
1878                 if (gadget_is_net2280(gadget))
1879                         net2280_set_fifo_mode(gadget, 1);
1880                 break;
1881         default:
1882                 return -EINVAL;
1883         }
1884
1885         dev->dev_config = config;
1886
1887         gadget_for_each_ep(ep, gadget) {
1888
1889                 if (EP_NOTIFY_NAME
1890                 && strcmp(ep->name, EP_NOTIFY_NAME) == 0) {
1891                         ep_desc = GS_SPEED_SELECT(
1892                                 gadget->speed == USB_SPEED_HIGH,
1893                                 &gs_highspeed_notify_desc,
1894                                 &gs_fullspeed_notify_desc);
1895                         ret = usb_ep_enable(ep,ep_desc);
1896                         if (ret == 0) {
1897                                 ep->driver_data = dev;
1898                                 dev->dev_notify_ep = ep;
1899                                 dev->dev_notify_ep_desc = ep_desc;
1900                         } else {
1901                                 printk(KERN_ERR "gs_set_config: cannot enable notify endpoint %s, ret=%d\n",
1902                                         ep->name, ret);
1903                                 goto exit_reset_config;
1904                         }
1905                 }
1906
1907                 else if (strcmp(ep->name, EP_IN_NAME) == 0) {
1908                         ep_desc = GS_SPEED_SELECT(
1909                                 gadget->speed == USB_SPEED_HIGH,
1910                                 &gs_highspeed_in_desc,
1911                                 &gs_fullspeed_in_desc);
1912                         ret = usb_ep_enable(ep,ep_desc);
1913                         if (ret == 0) {
1914                                 ep->driver_data = dev;
1915                                 dev->dev_in_ep = ep;
1916                                 dev->dev_in_ep_desc = ep_desc;
1917                         } else {
1918                                 printk(KERN_ERR "gs_set_config: cannot enable in endpoint %s, ret=%d\n",
1919                                         ep->name, ret);
1920                                 goto exit_reset_config;
1921                         }
1922                 }
1923
1924                 else if (strcmp(ep->name, EP_OUT_NAME) == 0) {
1925                         ep_desc = GS_SPEED_SELECT(
1926                                 gadget->speed == USB_SPEED_HIGH,
1927                                 &gs_highspeed_out_desc,
1928                                 &gs_fullspeed_out_desc);
1929                         ret = usb_ep_enable(ep,ep_desc);
1930                         if (ret == 0) {
1931                                 ep->driver_data = dev;
1932                                 dev->dev_out_ep = ep;
1933                                 dev->dev_out_ep_desc = ep_desc;
1934                         } else {
1935                                 printk(KERN_ERR "gs_set_config: cannot enable out endpoint %s, ret=%d\n",
1936                                         ep->name, ret);
1937                                 goto exit_reset_config;
1938                         }
1939                 }
1940
1941         }
1942
1943         if (dev->dev_in_ep == NULL || dev->dev_out_ep == NULL
1944         || (config != GS_BULK_CONFIG_ID && dev->dev_notify_ep == NULL)) {
1945                 printk(KERN_ERR "gs_set_config: cannot find endpoints\n");
1946                 ret = -ENODEV;
1947                 goto exit_reset_config;
1948         }
1949
1950         /* allocate and queue read requests */
1951         ep = dev->dev_out_ep;
1952         for (i=0; i<read_q_size && ret == 0; i++) {
1953                 if ((req=gs_alloc_req(ep, ep->maxpacket, GFP_ATOMIC))) {
1954                         req->complete = gs_read_complete;
1955                         if ((ret=usb_ep_queue(ep, req, GFP_ATOMIC))) {
1956                                 printk(KERN_ERR "gs_set_config: cannot queue read request, ret=%d\n",
1957                                         ret);
1958                         }
1959                 } else {
1960                         printk(KERN_ERR "gs_set_config: cannot allocate read requests\n");
1961                         ret = -ENOMEM;
1962                         goto exit_reset_config;
1963                 }
1964         }
1965
1966         /* allocate write requests, and put on free list */
1967         ep = dev->dev_in_ep;
1968         for (i=0; i<write_q_size; i++) {
1969                 if ((req_entry=gs_alloc_req_entry(ep, ep->maxpacket, GFP_ATOMIC))) {
1970                         req_entry->re_req->complete = gs_write_complete;
1971                         list_add(&req_entry->re_entry, &dev->dev_req_list);
1972                 } else {
1973                         printk(KERN_ERR "gs_set_config: cannot allocate write requests\n");
1974                         ret = -ENOMEM;
1975                         goto exit_reset_config;
1976                 }
1977         }
1978
1979         printk(KERN_INFO "gs_set_config: %s configured, %s speed %s config\n",
1980                 GS_LONG_NAME,
1981                 gadget->speed == USB_SPEED_HIGH ? "high" : "full",
1982                 config == GS_BULK_CONFIG_ID ? "BULK" : "CDC-ACM");
1983
1984         return 0;
1985
1986 exit_reset_config:
1987         gs_reset_config(dev);
1988         return ret;
1989 }
1990
1991 /*
1992  * gs_reset_config
1993  *
1994  * Mark the device as not configured, disable all endpoints,
1995  * which forces completion of pending I/O and frees queued
1996  * requests, and free the remaining write requests on the
1997  * free list.
1998  *
1999  * The device lock must be held when calling this function.
2000  */
2001 static void gs_reset_config(struct gs_dev *dev)
2002 {
2003         struct gs_req_entry *req_entry;
2004
2005         if (dev == NULL) {
2006                 printk(KERN_ERR "gs_reset_config: NULL device pointer\n");
2007                 return;
2008         }
2009
2010         if (dev->dev_config == GS_NO_CONFIG_ID)
2011                 return;
2012
2013         dev->dev_config = GS_NO_CONFIG_ID;
2014
2015         /* free write requests on the free list */
2016         while(!list_empty(&dev->dev_req_list)) {
2017                 req_entry = list_entry(dev->dev_req_list.next,
2018                         struct gs_req_entry, re_entry);
2019                 list_del(&req_entry->re_entry);
2020                 gs_free_req_entry(dev->dev_in_ep, req_entry);
2021         }
2022
2023         /* disable endpoints, forcing completion of pending i/o; */
2024         /* completion handlers free their requests in this case */
2025         if (dev->dev_notify_ep) {
2026                 usb_ep_disable(dev->dev_notify_ep);
2027                 dev->dev_notify_ep = NULL;
2028         }
2029         if (dev->dev_in_ep) {
2030                 usb_ep_disable(dev->dev_in_ep);
2031                 dev->dev_in_ep = NULL;
2032         }
2033         if (dev->dev_out_ep) {
2034                 usb_ep_disable(dev->dev_out_ep);
2035                 dev->dev_out_ep = NULL;
2036         }
2037 }
2038
2039 /*
2040  * gs_build_config_buf
2041  *
2042  * Builds the config descriptors in the given buffer and returns the
2043  * length, or a negative error number.
2044  */
2045 static int gs_build_config_buf(u8 *buf, enum usb_device_speed speed,
2046         u8 type, unsigned int index, int is_otg)
2047 {
2048         int len;
2049         int high_speed;
2050         const struct usb_config_descriptor *config_desc;
2051         const struct usb_descriptor_header **function;
2052
2053         if (index >= gs_device_desc.bNumConfigurations)
2054                 return -EINVAL;
2055
2056         /* other speed switches high and full speed */
2057         high_speed = (speed == USB_SPEED_HIGH);
2058         if (type == USB_DT_OTHER_SPEED_CONFIG)
2059                 high_speed = !high_speed;
2060
2061         if (use_acm) {
2062                 config_desc = &gs_acm_config_desc;
2063                 function = GS_SPEED_SELECT(high_speed,
2064                         gs_acm_highspeed_function,
2065                         gs_acm_fullspeed_function);
2066         } else {
2067                 config_desc = &gs_bulk_config_desc;
2068                 function = GS_SPEED_SELECT(high_speed,
2069                         gs_bulk_highspeed_function,
2070                         gs_bulk_fullspeed_function);
2071         }
2072
2073         /* for now, don't advertise srp-only devices */
2074         if (!is_otg)
2075                 function++;
2076
2077         len = usb_gadget_config_buf(config_desc, buf, GS_MAX_DESC_LEN, function);
2078         if (len < 0)
2079                 return len;
2080
2081         ((struct usb_config_descriptor *)buf)->bDescriptorType = type;
2082
2083         return len;
2084 }
2085
2086 /*
2087  * gs_alloc_req
2088  *
2089  * Allocate a usb_request and its buffer.  Returns a pointer to the
2090  * usb_request or NULL if there is an error.
2091  */
2092 static struct usb_request *
2093 gs_alloc_req(struct usb_ep *ep, unsigned int len, gfp_t kmalloc_flags)
2094 {
2095         struct usb_request *req;
2096
2097         if (ep == NULL)
2098                 return NULL;
2099
2100         req = usb_ep_alloc_request(ep, kmalloc_flags);
2101
2102         if (req != NULL) {
2103                 req->length = len;
2104                 req->buf = kmalloc(len, kmalloc_flags);
2105                 if (req->buf == NULL) {
2106                         usb_ep_free_request(ep, req);
2107                         return NULL;
2108                 }
2109         }
2110
2111         return req;
2112 }
2113
2114 /*
2115  * gs_free_req
2116  *
2117  * Free a usb_request and its buffer.
2118  */
2119 static void gs_free_req(struct usb_ep *ep, struct usb_request *req)
2120 {
2121         if (ep != NULL && req != NULL) {
2122                 kfree(req->buf);
2123                 usb_ep_free_request(ep, req);
2124         }
2125 }
2126
2127 /*
2128  * gs_alloc_req_entry
2129  *
2130  * Allocates a request and its buffer, using the given
2131  * endpoint, buffer len, and kmalloc flags.
2132  */
2133 static struct gs_req_entry *
2134 gs_alloc_req_entry(struct usb_ep *ep, unsigned len, gfp_t kmalloc_flags)
2135 {
2136         struct gs_req_entry     *req;
2137
2138         req = kmalloc(sizeof(struct gs_req_entry), kmalloc_flags);
2139         if (req == NULL)
2140                 return NULL;
2141
2142         req->re_req = gs_alloc_req(ep, len, kmalloc_flags);
2143         if (req->re_req == NULL) {
2144                 kfree(req);
2145                 return NULL;
2146         }
2147
2148         req->re_req->context = req;
2149
2150         return req;
2151 }
2152
2153 /*
2154  * gs_free_req_entry
2155  *
2156  * Frees a request and its buffer.
2157  */
2158 static void gs_free_req_entry(struct usb_ep *ep, struct gs_req_entry *req)
2159 {
2160         if (ep != NULL && req != NULL) {
2161                 if (req->re_req != NULL)
2162                         gs_free_req(ep, req->re_req);
2163                 kfree(req);
2164         }
2165 }
2166
2167 /*
2168  * gs_alloc_ports
2169  *
2170  * Allocate all ports and set the gs_dev struct to point to them.
2171  * Return 0 if successful, or a negative error number.
2172  *
2173  * The device lock is normally held when calling this function.
2174  */
2175 static int gs_alloc_ports(struct gs_dev *dev, gfp_t kmalloc_flags)
2176 {
2177         int i;
2178         struct gs_port *port;
2179
2180         if (dev == NULL)
2181                 return -EIO;
2182
2183         for (i=0; i<GS_NUM_PORTS; i++) {
2184                 if ((port=(struct gs_port *)kmalloc(sizeof(struct gs_port), kmalloc_flags)) == NULL)
2185                         return -ENOMEM;
2186
2187                 memset(port, 0, sizeof(struct gs_port));
2188                 port->port_dev = dev;
2189                 port->port_num = i;
2190                 port->port_line_coding.dwDTERate = cpu_to_le32(GS_DEFAULT_DTE_RATE);
2191                 port->port_line_coding.bCharFormat = GS_DEFAULT_CHAR_FORMAT;
2192                 port->port_line_coding.bParityType = GS_DEFAULT_PARITY;
2193                 port->port_line_coding.bDataBits = GS_DEFAULT_DATA_BITS;
2194                 spin_lock_init(&port->port_lock);
2195                 init_waitqueue_head(&port->port_write_wait);
2196
2197                 dev->dev_port[i] = port;
2198         }
2199
2200         return 0;
2201 }
2202
2203 /*
2204  * gs_free_ports
2205  *
2206  * Free all closed ports.  Open ports are disconnected by
2207  * freeing their write buffers, setting their device pointers
2208  * and the pointers to them in the device to NULL.  These
2209  * ports will be freed when closed.
2210  *
2211  * The device lock is normally held when calling this function.
2212  */
2213 static void gs_free_ports(struct gs_dev *dev)
2214 {
2215         int i;
2216         unsigned long flags;
2217         struct gs_port *port;
2218
2219         if (dev == NULL)
2220                 return;
2221
2222         for (i=0; i<GS_NUM_PORTS; i++) {
2223                 if ((port=dev->dev_port[i]) != NULL) {
2224                         dev->dev_port[i] = NULL;
2225
2226                         spin_lock_irqsave(&port->port_lock, flags);
2227
2228                         if (port->port_write_buf != NULL) {
2229                                 gs_buf_free(port->port_write_buf);
2230                                 port->port_write_buf = NULL;
2231                         }
2232
2233                         if (port->port_open_count > 0 || port->port_in_use) {
2234                                 port->port_dev = NULL;
2235                                 wake_up_interruptible(&port->port_write_wait);
2236                                 if (port->port_tty) {
2237                                         wake_up_interruptible(&port->port_tty->read_wait);
2238                                         wake_up_interruptible(&port->port_tty->write_wait);
2239                                 }
2240                                 spin_unlock_irqrestore(&port->port_lock, flags);
2241                         } else {
2242                                 spin_unlock_irqrestore(&port->port_lock, flags);
2243                                 kfree(port);
2244                         }
2245
2246                 }
2247         }
2248 }
2249
2250 /* Circular Buffer */
2251
2252 /*
2253  * gs_buf_alloc
2254  *
2255  * Allocate a circular buffer and all associated memory.
2256  */
2257 static struct gs_buf *gs_buf_alloc(unsigned int size, gfp_t kmalloc_flags)
2258 {
2259         struct gs_buf *gb;
2260
2261         if (size == 0)
2262                 return NULL;
2263
2264         gb = (struct gs_buf *)kmalloc(sizeof(struct gs_buf), kmalloc_flags);
2265         if (gb == NULL)
2266                 return NULL;
2267
2268         gb->buf_buf = kmalloc(size, kmalloc_flags);
2269         if (gb->buf_buf == NULL) {
2270                 kfree(gb);
2271                 return NULL;
2272         }
2273
2274         gb->buf_size = size;
2275         gb->buf_get = gb->buf_put = gb->buf_buf;
2276
2277         return gb;
2278 }
2279
2280 /*
2281  * gs_buf_free
2282  *
2283  * Free the buffer and all associated memory.
2284  */
2285 void gs_buf_free(struct gs_buf *gb)
2286 {
2287         if (gb) {
2288                 kfree(gb->buf_buf);
2289                 kfree(gb);
2290         }
2291 }
2292
2293 /*
2294  * gs_buf_clear
2295  *
2296  * Clear out all data in the circular buffer.
2297  */
2298 void gs_buf_clear(struct gs_buf *gb)
2299 {
2300         if (gb != NULL)
2301                 gb->buf_get = gb->buf_put;
2302                 /* equivalent to a get of all data available */
2303 }
2304
2305 /*
2306  * gs_buf_data_avail
2307  *
2308  * Return the number of bytes of data available in the circular
2309  * buffer.
2310  */
2311 unsigned int gs_buf_data_avail(struct gs_buf *gb)
2312 {
2313         if (gb != NULL)
2314                 return (gb->buf_size + gb->buf_put - gb->buf_get) % gb->buf_size;
2315         else
2316                 return 0;
2317 }
2318
2319 /*
2320  * gs_buf_space_avail
2321  *
2322  * Return the number of bytes of space available in the circular
2323  * buffer.
2324  */
2325 unsigned int gs_buf_space_avail(struct gs_buf *gb)
2326 {
2327         if (gb != NULL)
2328                 return (gb->buf_size + gb->buf_get - gb->buf_put - 1) % gb->buf_size;
2329         else
2330                 return 0;
2331 }
2332
2333 /*
2334  * gs_buf_put
2335  *
2336  * Copy data data from a user buffer and put it into the circular buffer.
2337  * Restrict to the amount of space available.
2338  *
2339  * Return the number of bytes copied.
2340  */
2341 unsigned int gs_buf_put(struct gs_buf *gb, const char *buf, unsigned int count)
2342 {
2343         unsigned int len;
2344
2345         if (gb == NULL)
2346                 return 0;
2347
2348         len  = gs_buf_space_avail(gb);
2349         if (count > len)
2350                 count = len;
2351
2352         if (count == 0)
2353                 return 0;
2354
2355         len = gb->buf_buf + gb->buf_size - gb->buf_put;
2356         if (count > len) {
2357                 memcpy(gb->buf_put, buf, len);
2358                 memcpy(gb->buf_buf, buf+len, count - len);
2359                 gb->buf_put = gb->buf_buf + count - len;
2360         } else {
2361                 memcpy(gb->buf_put, buf, count);
2362                 if (count < len)
2363                         gb->buf_put += count;
2364                 else /* count == len */
2365                         gb->buf_put = gb->buf_buf;
2366         }
2367
2368         return count;
2369 }
2370
2371 /*
2372  * gs_buf_get
2373  *
2374  * Get data from the circular buffer and copy to the given buffer.
2375  * Restrict to the amount of data available.
2376  *
2377  * Return the number of bytes copied.
2378  */
2379 unsigned int gs_buf_get(struct gs_buf *gb, char *buf, unsigned int count)
2380 {
2381         unsigned int len;
2382
2383         if (gb == NULL)
2384                 return 0;
2385
2386         len = gs_buf_data_avail(gb);
2387         if (count > len)
2388                 count = len;
2389
2390         if (count == 0)
2391                 return 0;
2392
2393         len = gb->buf_buf + gb->buf_size - gb->buf_get;
2394         if (count > len) {
2395                 memcpy(buf, gb->buf_get, len);
2396                 memcpy(buf+len, gb->buf_buf, count - len);
2397                 gb->buf_get = gb->buf_buf + count - len;
2398         } else {
2399                 memcpy(buf, gb->buf_get, count);
2400                 if (count < len)
2401                         gb->buf_get += count;
2402                 else /* count == len */
2403                         gb->buf_get = gb->buf_buf;
2404         }
2405
2406         return count;
2407 }