2 * g_serial.c -- USB gadget serial driver
4 * Copyright 2003 (C) Al Borchers (alborchers@steinerpoint.com)
6 * This code is based in part on the Gadget Zero driver, which
7 * is Copyright (C) 2003 by David Brownell, all rights reserved.
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)
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.
20 #include <linux/kernel.h>
21 #include <linux/utsname.h>
22 #include <linux/device.h>
23 #include <linux/tty.h>
24 #include <linux/tty_flip.h>
26 #include <linux/usb/ch9.h>
27 #include <linux/usb/cdc.h>
28 #include <linux/usb/gadget.h>
30 #include "gadget_chips.h"
35 #define GS_VERSION_STR "v2.2"
36 #define GS_VERSION_NUM 0x0202
38 #define GS_LONG_NAME "Gadget Serial"
39 #define GS_SHORT_NAME "g_serial"
42 #define GS_MINOR_START 0
44 #define GS_NUM_PORTS 16
46 #define GS_NUM_CONFIGS 1
47 #define GS_NO_CONFIG_ID 0
48 #define GS_BULK_CONFIG_ID 1
49 #define GS_ACM_CONFIG_ID 2
51 #define GS_MAX_NUM_INTERFACES 2
52 #define GS_BULK_INTERFACE_ID 0
53 #define GS_CONTROL_INTERFACE_ID 0
54 #define GS_DATA_INTERFACE_ID 1
56 #define GS_MAX_DESC_LEN 256
58 #define GS_DEFAULT_READ_Q_SIZE 32
59 #define GS_DEFAULT_WRITE_Q_SIZE 32
61 #define GS_DEFAULT_WRITE_BUF_SIZE 8192
62 #define GS_TMP_BUF_SIZE 8192
64 #define GS_CLOSE_TIMEOUT 15
66 #define GS_DEFAULT_USE_ACM 0
68 #define GS_DEFAULT_DTE_RATE 9600
69 #define GS_DEFAULT_DATA_BITS 8
70 #define GS_DEFAULT_PARITY USB_CDC_NO_PARITY
71 #define GS_DEFAULT_CHAR_FORMAT USB_CDC_1_STOP_BITS
73 /* maxpacket and other transfer characteristics vary by speed. */
74 static inline struct usb_endpoint_descriptor *
75 choose_ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *hs,
76 struct usb_endpoint_descriptor *fs)
78 if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
91 #define gs_debug(format, arg...) \
92 do { if (debug) pr_debug(format, ## arg); } while (0)
93 #define gs_debug_level(level, format, arg...) \
94 do { if (debug >= level) pr_debug(format, ## arg); } while (0)
97 /* Thanks to NetChip Technologies for donating this product ID.
99 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
100 * Instead: allocate your own, using normal USB-IF procedures.
102 #define GS_VENDOR_ID 0x0525 /* NetChip */
103 #define GS_PRODUCT_ID 0xa4a6 /* Linux-USB Serial Gadget */
104 #define GS_CDC_PRODUCT_ID 0xa4a7 /* ... as CDC-ACM */
106 #define GS_LOG2_NOTIFY_INTERVAL 5 /* 1 << 5 == 32 msec */
107 #define GS_NOTIFY_MAXPACKET 8
114 /* circular buffer */
116 unsigned int buf_size;
122 /* list of requests */
123 struct gs_req_entry {
124 struct list_head re_entry;
125 struct usb_request *re_req;
128 /* the port structure holds info for each port, one for each minor number */
130 struct gs_dev *port_dev; /* pointer to device struct */
131 struct tty_struct *port_tty; /* pointer to tty struct */
132 spinlock_t port_lock;
135 int port_in_use; /* open/close in progress */
136 wait_queue_head_t port_write_wait;/* waiting to write */
137 struct gs_buf *port_write_buf;
138 struct usb_cdc_line_coding port_line_coding;
141 /* the device structure holds info for the USB device */
143 struct usb_gadget *dev_gadget; /* gadget device pointer */
144 spinlock_t dev_lock; /* lock for set/reset config */
145 int dev_config; /* configuration number */
146 struct usb_ep *dev_notify_ep; /* address of notify endpoint */
147 struct usb_ep *dev_in_ep; /* address of in endpoint */
148 struct usb_ep *dev_out_ep; /* address of out endpoint */
149 struct usb_endpoint_descriptor /* descriptor of notify ep */
151 struct usb_endpoint_descriptor /* descriptor of in endpoint */
153 struct usb_endpoint_descriptor /* descriptor of out endpoint */
155 struct usb_request *dev_ctrl_req; /* control request */
156 struct list_head dev_req_list; /* list of write requests */
157 int dev_sched_port; /* round robin port scheduled */
158 struct gs_port *dev_port[GS_NUM_PORTS]; /* the ports */
165 static int __init gs_module_init(void);
166 static void __exit gs_module_exit(void);
169 static int gs_open(struct tty_struct *tty, struct file *file);
170 static void gs_close(struct tty_struct *tty, struct file *file);
171 static int gs_write(struct tty_struct *tty,
172 const unsigned char *buf, int count);
173 static int gs_put_char(struct tty_struct *tty, unsigned char ch);
174 static void gs_flush_chars(struct tty_struct *tty);
175 static int gs_write_room(struct tty_struct *tty);
176 static int gs_chars_in_buffer(struct tty_struct *tty);
177 static void gs_throttle(struct tty_struct * tty);
178 static void gs_unthrottle(struct tty_struct * tty);
179 static void gs_break(struct tty_struct *tty, int break_state);
180 static int gs_ioctl(struct tty_struct *tty, struct file *file,
181 unsigned int cmd, unsigned long arg);
182 static void gs_set_termios(struct tty_struct *tty, struct ktermios *old);
184 static int gs_send(struct gs_dev *dev);
185 static int gs_send_packet(struct gs_dev *dev, char *packet,
187 static int gs_recv_packet(struct gs_dev *dev, char *packet,
189 static void gs_read_complete(struct usb_ep *ep, struct usb_request *req);
190 static void gs_write_complete(struct usb_ep *ep, struct usb_request *req);
193 static int gs_bind(struct usb_gadget *gadget);
194 static void gs_unbind(struct usb_gadget *gadget);
195 static int gs_setup(struct usb_gadget *gadget,
196 const struct usb_ctrlrequest *ctrl);
197 static int gs_setup_standard(struct usb_gadget *gadget,
198 const struct usb_ctrlrequest *ctrl);
199 static int gs_setup_class(struct usb_gadget *gadget,
200 const struct usb_ctrlrequest *ctrl);
201 static void gs_setup_complete(struct usb_ep *ep, struct usb_request *req);
202 static void gs_disconnect(struct usb_gadget *gadget);
203 static int gs_set_config(struct gs_dev *dev, unsigned config);
204 static void gs_reset_config(struct gs_dev *dev);
205 static int gs_build_config_buf(u8 *buf, struct usb_gadget *g,
206 u8 type, unsigned int index, int is_otg);
208 static struct usb_request *gs_alloc_req(struct usb_ep *ep, unsigned int len,
209 gfp_t kmalloc_flags);
210 static void gs_free_req(struct usb_ep *ep, struct usb_request *req);
212 static struct gs_req_entry *gs_alloc_req_entry(struct usb_ep *ep, unsigned len,
213 gfp_t kmalloc_flags);
214 static void gs_free_req_entry(struct usb_ep *ep, struct gs_req_entry *req);
216 static int gs_alloc_ports(struct gs_dev *dev, gfp_t kmalloc_flags);
217 static void gs_free_ports(struct gs_dev *dev);
219 /* circular buffer */
220 static struct gs_buf *gs_buf_alloc(unsigned int size, gfp_t kmalloc_flags);
221 static void gs_buf_free(struct gs_buf *gb);
222 static void gs_buf_clear(struct gs_buf *gb);
223 static unsigned int gs_buf_data_avail(struct gs_buf *gb);
224 static unsigned int gs_buf_space_avail(struct gs_buf *gb);
225 static unsigned int gs_buf_put(struct gs_buf *gb, const char *buf,
227 static unsigned int gs_buf_get(struct gs_buf *gb, char *buf,
230 /* external functions */
231 extern int net2280_set_fifo_mode(struct usb_gadget *gadget, int mode);
236 static struct gs_dev *gs_device;
238 static const char *EP_IN_NAME;
239 static const char *EP_OUT_NAME;
240 static const char *EP_NOTIFY_NAME;
242 static struct mutex gs_open_close_lock[GS_NUM_PORTS];
244 static unsigned int read_q_size = GS_DEFAULT_READ_Q_SIZE;
245 static unsigned int write_q_size = GS_DEFAULT_WRITE_Q_SIZE;
247 static unsigned int write_buf_size = GS_DEFAULT_WRITE_BUF_SIZE;
249 static unsigned int use_acm = GS_DEFAULT_USE_ACM;
252 /* tty driver struct */
253 static const struct tty_operations gs_tty_ops = {
257 .put_char = gs_put_char,
258 .flush_chars = gs_flush_chars,
259 .write_room = gs_write_room,
261 .set_termios = gs_set_termios,
262 .throttle = gs_throttle,
263 .unthrottle = gs_unthrottle,
264 .break_ctl = gs_break,
265 .chars_in_buffer = gs_chars_in_buffer,
267 static struct tty_driver *gs_tty_driver;
269 /* gadget driver struct */
270 static struct usb_gadget_driver gs_gadget_driver = {
271 #ifdef CONFIG_USB_GADGET_DUALSPEED
272 .speed = USB_SPEED_HIGH,
274 .speed = USB_SPEED_FULL,
275 #endif /* CONFIG_USB_GADGET_DUALSPEED */
276 .function = GS_LONG_NAME,
280 .disconnect = gs_disconnect,
282 .name = GS_SHORT_NAME,
287 /* USB descriptors */
289 #define GS_MANUFACTURER_STR_ID 1
290 #define GS_PRODUCT_STR_ID 2
291 #define GS_SERIAL_STR_ID 3
292 #define GS_BULK_CONFIG_STR_ID 4
293 #define GS_ACM_CONFIG_STR_ID 5
294 #define GS_CONTROL_STR_ID 6
295 #define GS_DATA_STR_ID 7
297 /* static strings, in UTF-8 */
298 static char manufacturer[50];
299 static struct usb_string gs_strings[] = {
300 { GS_MANUFACTURER_STR_ID, manufacturer },
301 { GS_PRODUCT_STR_ID, GS_LONG_NAME },
302 { GS_SERIAL_STR_ID, "0" },
303 { GS_BULK_CONFIG_STR_ID, "Gadget Serial Bulk" },
304 { GS_ACM_CONFIG_STR_ID, "Gadget Serial CDC ACM" },
305 { GS_CONTROL_STR_ID, "Gadget Serial Control" },
306 { GS_DATA_STR_ID, "Gadget Serial Data" },
307 { } /* end of list */
310 static struct usb_gadget_strings gs_string_table = {
311 .language = 0x0409, /* en-us */
312 .strings = gs_strings,
315 static struct usb_device_descriptor gs_device_desc = {
316 .bLength = USB_DT_DEVICE_SIZE,
317 .bDescriptorType = USB_DT_DEVICE,
318 .bcdUSB = __constant_cpu_to_le16(0x0200),
319 .bDeviceSubClass = 0,
320 .bDeviceProtocol = 0,
321 .idVendor = __constant_cpu_to_le16(GS_VENDOR_ID),
322 .idProduct = __constant_cpu_to_le16(GS_PRODUCT_ID),
323 .iManufacturer = GS_MANUFACTURER_STR_ID,
324 .iProduct = GS_PRODUCT_STR_ID,
325 .iSerialNumber = GS_SERIAL_STR_ID,
326 .bNumConfigurations = GS_NUM_CONFIGS,
329 static struct usb_otg_descriptor gs_otg_descriptor = {
330 .bLength = sizeof(gs_otg_descriptor),
331 .bDescriptorType = USB_DT_OTG,
332 .bmAttributes = USB_OTG_SRP,
335 static struct usb_config_descriptor gs_bulk_config_desc = {
336 .bLength = USB_DT_CONFIG_SIZE,
337 .bDescriptorType = USB_DT_CONFIG,
338 /* .wTotalLength computed dynamically */
340 .bConfigurationValue = GS_BULK_CONFIG_ID,
341 .iConfiguration = GS_BULK_CONFIG_STR_ID,
342 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
346 static struct usb_config_descriptor gs_acm_config_desc = {
347 .bLength = USB_DT_CONFIG_SIZE,
348 .bDescriptorType = USB_DT_CONFIG,
349 /* .wTotalLength computed dynamically */
351 .bConfigurationValue = GS_ACM_CONFIG_ID,
352 .iConfiguration = GS_ACM_CONFIG_STR_ID,
353 .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
357 static const struct usb_interface_descriptor gs_bulk_interface_desc = {
358 .bLength = USB_DT_INTERFACE_SIZE,
359 .bDescriptorType = USB_DT_INTERFACE,
360 .bInterfaceNumber = GS_BULK_INTERFACE_ID,
362 .bInterfaceClass = USB_CLASS_CDC_DATA,
363 .bInterfaceSubClass = 0,
364 .bInterfaceProtocol = 0,
365 .iInterface = GS_DATA_STR_ID,
368 static const struct usb_interface_descriptor gs_control_interface_desc = {
369 .bLength = USB_DT_INTERFACE_SIZE,
370 .bDescriptorType = USB_DT_INTERFACE,
371 .bInterfaceNumber = GS_CONTROL_INTERFACE_ID,
373 .bInterfaceClass = USB_CLASS_COMM,
374 .bInterfaceSubClass = USB_CDC_SUBCLASS_ACM,
375 .bInterfaceProtocol = USB_CDC_ACM_PROTO_AT_V25TER,
376 .iInterface = GS_CONTROL_STR_ID,
379 static const struct usb_interface_descriptor gs_data_interface_desc = {
380 .bLength = USB_DT_INTERFACE_SIZE,
381 .bDescriptorType = USB_DT_INTERFACE,
382 .bInterfaceNumber = GS_DATA_INTERFACE_ID,
384 .bInterfaceClass = USB_CLASS_CDC_DATA,
385 .bInterfaceSubClass = 0,
386 .bInterfaceProtocol = 0,
387 .iInterface = GS_DATA_STR_ID,
390 static const struct usb_cdc_header_desc gs_header_desc = {
391 .bLength = sizeof(gs_header_desc),
392 .bDescriptorType = USB_DT_CS_INTERFACE,
393 .bDescriptorSubType = USB_CDC_HEADER_TYPE,
394 .bcdCDC = __constant_cpu_to_le16(0x0110),
397 static const struct usb_cdc_call_mgmt_descriptor gs_call_mgmt_descriptor = {
398 .bLength = sizeof(gs_call_mgmt_descriptor),
399 .bDescriptorType = USB_DT_CS_INTERFACE,
400 .bDescriptorSubType = USB_CDC_CALL_MANAGEMENT_TYPE,
402 .bDataInterface = 1, /* index of data interface */
405 static struct usb_cdc_acm_descriptor gs_acm_descriptor = {
406 .bLength = sizeof(gs_acm_descriptor),
407 .bDescriptorType = USB_DT_CS_INTERFACE,
408 .bDescriptorSubType = USB_CDC_ACM_TYPE,
412 static const struct usb_cdc_union_desc gs_union_desc = {
413 .bLength = sizeof(gs_union_desc),
414 .bDescriptorType = USB_DT_CS_INTERFACE,
415 .bDescriptorSubType = USB_CDC_UNION_TYPE,
416 .bMasterInterface0 = 0, /* index of control interface */
417 .bSlaveInterface0 = 1, /* index of data interface */
420 static struct usb_endpoint_descriptor gs_fullspeed_notify_desc = {
421 .bLength = USB_DT_ENDPOINT_SIZE,
422 .bDescriptorType = USB_DT_ENDPOINT,
423 .bEndpointAddress = USB_DIR_IN,
424 .bmAttributes = USB_ENDPOINT_XFER_INT,
425 .wMaxPacketSize = __constant_cpu_to_le16(GS_NOTIFY_MAXPACKET),
426 .bInterval = 1 << GS_LOG2_NOTIFY_INTERVAL,
429 static struct usb_endpoint_descriptor gs_fullspeed_in_desc = {
430 .bLength = USB_DT_ENDPOINT_SIZE,
431 .bDescriptorType = USB_DT_ENDPOINT,
432 .bEndpointAddress = USB_DIR_IN,
433 .bmAttributes = USB_ENDPOINT_XFER_BULK,
436 static struct usb_endpoint_descriptor gs_fullspeed_out_desc = {
437 .bLength = USB_DT_ENDPOINT_SIZE,
438 .bDescriptorType = USB_DT_ENDPOINT,
439 .bEndpointAddress = USB_DIR_OUT,
440 .bmAttributes = USB_ENDPOINT_XFER_BULK,
443 static const struct usb_descriptor_header *gs_bulk_fullspeed_function[] = {
444 (struct usb_descriptor_header *) &gs_otg_descriptor,
445 (struct usb_descriptor_header *) &gs_bulk_interface_desc,
446 (struct usb_descriptor_header *) &gs_fullspeed_in_desc,
447 (struct usb_descriptor_header *) &gs_fullspeed_out_desc,
451 static const struct usb_descriptor_header *gs_acm_fullspeed_function[] = {
452 (struct usb_descriptor_header *) &gs_otg_descriptor,
453 (struct usb_descriptor_header *) &gs_control_interface_desc,
454 (struct usb_descriptor_header *) &gs_header_desc,
455 (struct usb_descriptor_header *) &gs_call_mgmt_descriptor,
456 (struct usb_descriptor_header *) &gs_acm_descriptor,
457 (struct usb_descriptor_header *) &gs_union_desc,
458 (struct usb_descriptor_header *) &gs_fullspeed_notify_desc,
459 (struct usb_descriptor_header *) &gs_data_interface_desc,
460 (struct usb_descriptor_header *) &gs_fullspeed_in_desc,
461 (struct usb_descriptor_header *) &gs_fullspeed_out_desc,
465 static struct usb_endpoint_descriptor gs_highspeed_notify_desc = {
466 .bLength = USB_DT_ENDPOINT_SIZE,
467 .bDescriptorType = USB_DT_ENDPOINT,
468 .bEndpointAddress = USB_DIR_IN,
469 .bmAttributes = USB_ENDPOINT_XFER_INT,
470 .wMaxPacketSize = __constant_cpu_to_le16(GS_NOTIFY_MAXPACKET),
471 .bInterval = GS_LOG2_NOTIFY_INTERVAL+4,
474 static struct usb_endpoint_descriptor gs_highspeed_in_desc = {
475 .bLength = USB_DT_ENDPOINT_SIZE,
476 .bDescriptorType = USB_DT_ENDPOINT,
477 .bmAttributes = USB_ENDPOINT_XFER_BULK,
478 .wMaxPacketSize = __constant_cpu_to_le16(512),
481 static struct usb_endpoint_descriptor gs_highspeed_out_desc = {
482 .bLength = USB_DT_ENDPOINT_SIZE,
483 .bDescriptorType = USB_DT_ENDPOINT,
484 .bmAttributes = USB_ENDPOINT_XFER_BULK,
485 .wMaxPacketSize = __constant_cpu_to_le16(512),
488 static struct usb_qualifier_descriptor gs_qualifier_desc = {
489 .bLength = sizeof(struct usb_qualifier_descriptor),
490 .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
491 .bcdUSB = __constant_cpu_to_le16 (0x0200),
492 /* assumes ep0 uses the same value for both speeds ... */
493 .bNumConfigurations = GS_NUM_CONFIGS,
496 static const struct usb_descriptor_header *gs_bulk_highspeed_function[] = {
497 (struct usb_descriptor_header *) &gs_otg_descriptor,
498 (struct usb_descriptor_header *) &gs_bulk_interface_desc,
499 (struct usb_descriptor_header *) &gs_highspeed_in_desc,
500 (struct usb_descriptor_header *) &gs_highspeed_out_desc,
504 static const struct usb_descriptor_header *gs_acm_highspeed_function[] = {
505 (struct usb_descriptor_header *) &gs_otg_descriptor,
506 (struct usb_descriptor_header *) &gs_control_interface_desc,
507 (struct usb_descriptor_header *) &gs_header_desc,
508 (struct usb_descriptor_header *) &gs_call_mgmt_descriptor,
509 (struct usb_descriptor_header *) &gs_acm_descriptor,
510 (struct usb_descriptor_header *) &gs_union_desc,
511 (struct usb_descriptor_header *) &gs_highspeed_notify_desc,
512 (struct usb_descriptor_header *) &gs_data_interface_desc,
513 (struct usb_descriptor_header *) &gs_highspeed_in_desc,
514 (struct usb_descriptor_header *) &gs_highspeed_out_desc,
520 MODULE_DESCRIPTION(GS_LONG_NAME);
521 MODULE_AUTHOR("Al Borchers");
522 MODULE_LICENSE("GPL");
525 module_param(debug, int, S_IRUGO|S_IWUSR);
526 MODULE_PARM_DESC(debug, "Enable debugging, 0=off, 1=on");
529 module_param(read_q_size, uint, S_IRUGO);
530 MODULE_PARM_DESC(read_q_size, "Read request queue size, default=32");
532 module_param(write_q_size, uint, S_IRUGO);
533 MODULE_PARM_DESC(write_q_size, "Write request queue size, default=32");
535 module_param(write_buf_size, uint, S_IRUGO);
536 MODULE_PARM_DESC(write_buf_size, "Write buffer size, default=8192");
538 module_param(use_acm, uint, S_IRUGO);
539 MODULE_PARM_DESC(use_acm, "Use CDC ACM, 0=no, 1=yes, default=no");
541 module_init(gs_module_init);
542 module_exit(gs_module_exit);
547 * Register as a USB gadget driver and a tty driver.
549 static int __init gs_module_init(void)
554 retval = usb_gadget_register_driver(&gs_gadget_driver);
556 pr_err("gs_module_init: cannot register gadget driver, "
561 gs_tty_driver = alloc_tty_driver(GS_NUM_PORTS);
564 gs_tty_driver->owner = THIS_MODULE;
565 gs_tty_driver->driver_name = GS_SHORT_NAME;
566 gs_tty_driver->name = "ttygs";
567 gs_tty_driver->major = GS_MAJOR;
568 gs_tty_driver->minor_start = GS_MINOR_START;
569 gs_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
570 gs_tty_driver->subtype = SERIAL_TYPE_NORMAL;
571 gs_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
572 gs_tty_driver->init_termios = tty_std_termios;
573 gs_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
574 tty_set_operations(gs_tty_driver, &gs_tty_ops);
576 for (i=0; i < GS_NUM_PORTS; i++)
577 mutex_init(&gs_open_close_lock[i]);
579 retval = tty_register_driver(gs_tty_driver);
581 usb_gadget_unregister_driver(&gs_gadget_driver);
582 put_tty_driver(gs_tty_driver);
583 pr_err("gs_module_init: cannot register tty driver, "
588 pr_info("gs_module_init: %s %s loaded\n",
589 GS_LONG_NAME, GS_VERSION_STR);
596 * Unregister as a tty driver and a USB gadget driver.
598 static void __exit gs_module_exit(void)
600 tty_unregister_driver(gs_tty_driver);
601 put_tty_driver(gs_tty_driver);
602 usb_gadget_unregister_driver(&gs_gadget_driver);
604 pr_info("gs_module_exit: %s %s unloaded\n",
605 GS_LONG_NAME, GS_VERSION_STR);
613 static int gs_open(struct tty_struct *tty, struct file *file)
617 struct gs_port *port;
623 port_num = tty->index;
625 gs_debug("gs_open: (%d,%p,%p)\n", port_num, tty, file);
627 if (port_num < 0 || port_num >= GS_NUM_PORTS) {
628 pr_err("gs_open: (%d,%p,%p) invalid port number\n",
629 port_num, tty, file);
636 pr_err("gs_open: (%d,%p,%p) NULL device pointer\n",
637 port_num, tty, file);
641 mtx = &gs_open_close_lock[port_num];
642 if (mutex_lock_interruptible(mtx)) {
643 pr_err("gs_open: (%d,%p,%p) interrupted waiting for mutex\n",
644 port_num, tty, file);
648 spin_lock_irqsave(&dev->dev_lock, flags);
650 if (dev->dev_config == GS_NO_CONFIG_ID) {
651 pr_err("gs_open: (%d,%p,%p) device is not connected\n",
652 port_num, tty, file);
654 goto exit_unlock_dev;
657 port = dev->dev_port[port_num];
660 pr_err("gs_open: (%d,%p,%p) NULL port pointer\n",
661 port_num, tty, file);
663 goto exit_unlock_dev;
666 spin_lock(&port->port_lock);
667 spin_unlock(&dev->dev_lock);
669 if (port->port_dev == NULL) {
670 pr_err("gs_open: (%d,%p,%p) port disconnected (1)\n",
671 port_num, tty, file);
673 goto exit_unlock_port;
676 if (port->port_open_count > 0) {
677 ++port->port_open_count;
678 gs_debug("gs_open: (%d,%p,%p) already open\n",
679 port_num, tty, file);
681 goto exit_unlock_port;
684 tty->driver_data = NULL;
686 /* mark port as in use, we can drop port lock and sleep if necessary */
687 port->port_in_use = 1;
689 /* allocate write buffer on first open */
690 if (port->port_write_buf == NULL) {
691 spin_unlock_irqrestore(&port->port_lock, flags);
692 buf = gs_buf_alloc(write_buf_size, GFP_KERNEL);
693 spin_lock_irqsave(&port->port_lock, flags);
695 /* might have been disconnected while asleep, check */
696 if (port->port_dev == NULL) {
697 pr_err("gs_open: (%d,%p,%p) port disconnected (2)\n",
698 port_num, tty, file);
699 port->port_in_use = 0;
701 goto exit_unlock_port;
704 if ((port->port_write_buf=buf) == NULL) {
705 pr_err("gs_open: (%d,%p,%p) cannot allocate "
706 "port write buffer\n",
707 port_num, tty, file);
708 port->port_in_use = 0;
710 goto exit_unlock_port;
715 /* wait for carrier detect (not implemented) */
717 /* might have been disconnected while asleep, check */
718 if (port->port_dev == NULL) {
719 pr_err("gs_open: (%d,%p,%p) port disconnected (3)\n",
720 port_num, tty, file);
721 port->port_in_use = 0;
723 goto exit_unlock_port;
726 tty->driver_data = port;
727 port->port_tty = tty;
728 port->port_open_count = 1;
729 port->port_in_use = 0;
731 gs_debug("gs_open: (%d,%p,%p) completed\n", port_num, tty, file);
736 spin_unlock_irqrestore(&port->port_lock, flags);
741 spin_unlock_irqrestore(&dev->dev_lock, flags);
751 #define GS_WRITE_FINISHED_EVENT_SAFELY(p) \
755 spin_lock_irq(&(p)->port_lock); \
756 cond = !(p)->port_dev || !gs_buf_data_avail((p)->port_write_buf); \
757 spin_unlock_irq(&(p)->port_lock); \
761 static void gs_close(struct tty_struct *tty, struct file *file)
763 struct gs_port *port = tty->driver_data;
767 pr_err("gs_close: NULL port pointer\n");
771 gs_debug("gs_close: (%d,%p,%p)\n", port->port_num, tty, file);
773 mtx = &gs_open_close_lock[port->port_num];
776 spin_lock_irq(&port->port_lock);
778 if (port->port_open_count == 0) {
779 pr_err("gs_close: (%d,%p,%p) port is already closed\n",
780 port->port_num, tty, file);
784 if (port->port_open_count > 1) {
785 --port->port_open_count;
789 /* free disconnected port on final close */
790 if (port->port_dev == NULL) {
795 /* mark port as closed but in use, we can drop port lock */
796 /* and sleep if necessary */
797 port->port_in_use = 1;
798 port->port_open_count = 0;
800 /* wait for write buffer to drain, or */
801 /* at most GS_CLOSE_TIMEOUT seconds */
802 if (gs_buf_data_avail(port->port_write_buf) > 0) {
803 spin_unlock_irq(&port->port_lock);
804 wait_event_interruptible_timeout(port->port_write_wait,
805 GS_WRITE_FINISHED_EVENT_SAFELY(port),
806 GS_CLOSE_TIMEOUT * HZ);
807 spin_lock_irq(&port->port_lock);
810 /* free disconnected port on final close */
811 /* (might have happened during the above sleep) */
812 if (port->port_dev == NULL) {
817 gs_buf_clear(port->port_write_buf);
819 tty->driver_data = NULL;
820 port->port_tty = NULL;
821 port->port_in_use = 0;
823 gs_debug("gs_close: (%d,%p,%p) completed\n",
824 port->port_num, tty, file);
827 spin_unlock_irq(&port->port_lock);
834 static int gs_write(struct tty_struct *tty, const unsigned char *buf, int count)
837 struct gs_port *port = tty->driver_data;
841 pr_err("gs_write: NULL port pointer\n");
845 gs_debug("gs_write: (%d,%p) writing %d bytes\n", port->port_num, tty,
851 spin_lock_irqsave(&port->port_lock, flags);
853 if (port->port_dev == NULL) {
854 pr_err("gs_write: (%d,%p) port is not connected\n",
855 port->port_num, tty);
860 if (port->port_open_count == 0) {
861 pr_err("gs_write: (%d,%p) port is closed\n",
862 port->port_num, tty);
867 count = gs_buf_put(port->port_write_buf, buf, count);
869 spin_unlock_irqrestore(&port->port_lock, flags);
873 gs_debug("gs_write: (%d,%p) wrote %d bytes\n", port->port_num, tty,
879 spin_unlock_irqrestore(&port->port_lock, flags);
886 static int gs_put_char(struct tty_struct *tty, unsigned char ch)
889 struct gs_port *port = tty->driver_data;
893 pr_err("gs_put_char: NULL port pointer\n");
897 gs_debug("gs_put_char: (%d,%p) char=0x%x, called from %p\n",
898 port->port_num, tty, ch, __builtin_return_address(0));
900 spin_lock_irqsave(&port->port_lock, flags);
902 if (port->port_dev == NULL) {
903 pr_err("gs_put_char: (%d,%p) port is not connected\n",
904 port->port_num, tty);
908 if (port->port_open_count == 0) {
909 pr_err("gs_put_char: (%d,%p) port is closed\n",
910 port->port_num, tty);
914 ret = gs_buf_put(port->port_write_buf, &ch, 1);
917 spin_unlock_irqrestore(&port->port_lock, flags);
924 static void gs_flush_chars(struct tty_struct *tty)
927 struct gs_port *port = tty->driver_data;
930 pr_err("gs_flush_chars: NULL port pointer\n");
934 gs_debug("gs_flush_chars: (%d,%p)\n", port->port_num, tty);
936 spin_lock_irqsave(&port->port_lock, flags);
938 if (port->port_dev == NULL) {
939 pr_err("gs_flush_chars: (%d,%p) port is not connected\n",
940 port->port_num, tty);
944 if (port->port_open_count == 0) {
945 pr_err("gs_flush_chars: (%d,%p) port is closed\n",
946 port->port_num, tty);
950 spin_unlock_irqrestore(&port->port_lock, flags);
957 spin_unlock_irqrestore(&port->port_lock, flags);
963 static int gs_write_room(struct tty_struct *tty)
968 struct gs_port *port = tty->driver_data;
974 spin_lock_irqsave(&port->port_lock, flags);
976 if (port->port_dev != NULL && port->port_open_count > 0
977 && port->port_write_buf != NULL)
978 room = gs_buf_space_avail(port->port_write_buf);
980 spin_unlock_irqrestore(&port->port_lock, flags);
982 gs_debug("gs_write_room: (%d,%p) room=%d\n",
983 port->port_num, tty, room);
991 static int gs_chars_in_buffer(struct tty_struct *tty)
995 struct gs_port *port = tty->driver_data;
1000 spin_lock_irqsave(&port->port_lock, flags);
1002 if (port->port_dev != NULL && port->port_open_count > 0
1003 && port->port_write_buf != NULL)
1004 chars = gs_buf_data_avail(port->port_write_buf);
1006 spin_unlock_irqrestore(&port->port_lock, flags);
1008 gs_debug("gs_chars_in_buffer: (%d,%p) chars=%d\n",
1009 port->port_num, tty, chars);
1017 static void gs_throttle(struct tty_struct *tty)
1024 static void gs_unthrottle(struct tty_struct *tty)
1031 static void gs_break(struct tty_struct *tty, int break_state)
1038 static int gs_ioctl(struct tty_struct *tty, struct file *file, unsigned int cmd, unsigned long arg)
1040 struct gs_port *port = tty->driver_data;
1043 pr_err("gs_ioctl: NULL port pointer\n");
1047 gs_debug("gs_ioctl: (%d,%p,%p) cmd=0x%4.4x, arg=%lu\n",
1048 port->port_num, tty, file, cmd, arg);
1052 /* could not handle ioctl */
1053 return -ENOIOCTLCMD;
1059 static void gs_set_termios(struct tty_struct *tty, struct ktermios *old)
1066 * This function finds available write requests, calls
1067 * gs_send_packet to fill these packets with data, and
1068 * continues until either there are no more write requests
1069 * available or no more data to send. This function is
1070 * run whenever data arrives or write requests are available.
1072 static int gs_send(struct gs_dev *dev)
1075 unsigned long flags;
1077 struct usb_request *req;
1078 struct gs_req_entry *req_entry;
1081 pr_err("gs_send: NULL device pointer\n");
1085 spin_lock_irqsave(&dev->dev_lock, flags);
1087 ep = dev->dev_in_ep;
1089 while(!list_empty(&dev->dev_req_list)) {
1091 req_entry = list_entry(dev->dev_req_list.next,
1092 struct gs_req_entry, re_entry);
1094 req = req_entry->re_req;
1096 len = gs_send_packet(dev, req->buf, ep->maxpacket);
1099 gs_debug_level(3, "gs_send: len=%d, 0x%2.2x "
1100 "0x%2.2x 0x%2.2x ...\n", len,
1101 *((unsigned char *)req->buf),
1102 *((unsigned char *)req->buf+1),
1103 *((unsigned char *)req->buf+2));
1104 list_del(&req_entry->re_entry);
1106 spin_unlock_irqrestore(&dev->dev_lock, flags);
1107 if ((ret=usb_ep_queue(ep, req, GFP_ATOMIC))) {
1109 "gs_send: cannot queue read request, ret=%d\n",
1111 spin_lock_irqsave(&dev->dev_lock, flags);
1114 spin_lock_irqsave(&dev->dev_lock, flags);
1121 spin_unlock_irqrestore(&dev->dev_lock, flags);
1129 * If there is data to send, a packet is built in the given
1130 * buffer and the size is returned. If there is no data to
1131 * send, 0 is returned. If there is any error a negative
1132 * error number is returned.
1134 * Called during USB completion routine, on interrupt time.
1136 * We assume that disconnect will not happen until all completion
1137 * routines have completed, so we can assume that the dev_port
1138 * array does not change during the lifetime of this function.
1140 static int gs_send_packet(struct gs_dev *dev, char *packet, unsigned int size)
1143 struct gs_port *port;
1145 /* TEMPORARY -- only port 0 is supported right now */
1146 port = dev->dev_port[0];
1149 pr_err("gs_send_packet: port=%d, NULL port pointer\n", 0);
1153 spin_lock(&port->port_lock);
1155 len = gs_buf_data_avail(port->port_write_buf);
1162 size = gs_buf_get(port->port_write_buf, packet, size);
1165 wake_up_interruptible(&port->port_tty->write_wait);
1168 spin_unlock(&port->port_lock);
1175 * Called for each USB packet received. Reads the packet
1176 * header and stuffs the data in the appropriate tty buffer.
1177 * Returns 0 if successful, or a negative error number.
1179 * Called during USB completion routine, on interrupt time.
1181 * We assume that disconnect will not happen until all completion
1182 * routines have completed, so we can assume that the dev_port
1183 * array does not change during the lifetime of this function.
1185 static int gs_recv_packet(struct gs_dev *dev, char *packet, unsigned int size)
1188 struct gs_port *port;
1190 struct tty_struct *tty;
1192 /* TEMPORARY -- only port 0 is supported right now */
1193 port = dev->dev_port[0];
1196 pr_err("gs_recv_packet: port=%d, NULL port pointer\n",
1201 spin_lock(&port->port_lock);
1203 if (port->port_open_count == 0) {
1204 pr_err("gs_recv_packet: port=%d, port is closed\n",
1211 tty = port->port_tty;
1214 pr_err("gs_recv_packet: port=%d, NULL tty pointer\n",
1220 if (port->port_tty->magic != TTY_MAGIC) {
1221 pr_err("gs_recv_packet: port=%d, bad tty magic\n",
1227 len = tty_buffer_request_room(tty, size);
1229 tty_insert_flip_string(tty, packet, len);
1230 tty_flip_buffer_push(port->port_tty);
1231 wake_up_interruptible(&port->port_tty->read_wait);
1235 spin_unlock(&port->port_lock);
1242 static void gs_read_complete(struct usb_ep *ep, struct usb_request *req)
1245 struct gs_dev *dev = ep->driver_data;
1248 pr_err("gs_read_complete: NULL device pointer\n");
1252 switch(req->status) {
1254 /* normal completion */
1255 gs_recv_packet(dev, req->buf, req->actual);
1257 req->length = ep->maxpacket;
1258 if ((ret=usb_ep_queue(ep, req, GFP_ATOMIC))) {
1260 "gs_read_complete: cannot queue read request, ret=%d\n",
1267 gs_debug("gs_read_complete: shutdown\n");
1268 gs_free_req(ep, req);
1274 "gs_read_complete: unexpected status error, status=%d\n",
1284 static void gs_write_complete(struct usb_ep *ep, struct usb_request *req)
1286 struct gs_dev *dev = ep->driver_data;
1287 struct gs_req_entry *gs_req = req->context;
1290 pr_err("gs_write_complete: NULL device pointer\n");
1294 switch(req->status) {
1296 /* normal completion */
1298 if (gs_req == NULL) {
1299 pr_err("gs_write_complete: NULL request pointer\n");
1303 spin_lock(&dev->dev_lock);
1304 list_add(&gs_req->re_entry, &dev->dev_req_list);
1305 spin_unlock(&dev->dev_lock);
1313 gs_debug("gs_write_complete: shutdown\n");
1314 gs_free_req(ep, req);
1319 "gs_write_complete: unexpected status error, status=%d\n",
1331 * Called on module load. Allocates and initializes the device
1332 * structure and a control request.
1334 static int __init gs_bind(struct usb_gadget *gadget)
1341 /* Some controllers can't support CDC ACM:
1342 * - sh doesn't support multiple interfaces or configs;
1343 * - sa1100 doesn't have a third interrupt endpoint
1345 if (gadget_is_sh(gadget) || gadget_is_sa1100(gadget))
1348 gcnum = usb_gadget_controller_number(gadget);
1350 gs_device_desc.bcdDevice =
1351 cpu_to_le16(GS_VERSION_NUM | gcnum);
1353 pr_warning("gs_bind: controller '%s' not recognized\n",
1355 /* unrecognized, but safe unless bulk is REALLY quirky */
1356 gs_device_desc.bcdDevice =
1357 __constant_cpu_to_le16(GS_VERSION_NUM|0x0099);
1360 usb_ep_autoconfig_reset(gadget);
1362 ep = usb_ep_autoconfig(gadget, &gs_fullspeed_in_desc);
1365 EP_IN_NAME = ep->name;
1366 ep->driver_data = ep; /* claim the endpoint */
1368 ep = usb_ep_autoconfig(gadget, &gs_fullspeed_out_desc);
1371 EP_OUT_NAME = ep->name;
1372 ep->driver_data = ep; /* claim the endpoint */
1375 ep = usb_ep_autoconfig(gadget, &gs_fullspeed_notify_desc);
1377 pr_err("gs_bind: cannot run ACM on %s\n", gadget->name);
1380 gs_device_desc.idProduct = __constant_cpu_to_le16(
1382 EP_NOTIFY_NAME = ep->name;
1383 ep->driver_data = ep; /* claim the endpoint */
1386 gs_device_desc.bDeviceClass = use_acm
1387 ? USB_CLASS_COMM : USB_CLASS_VENDOR_SPEC;
1388 gs_device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
1390 if (gadget_is_dualspeed(gadget)) {
1391 gs_qualifier_desc.bDeviceClass = use_acm
1392 ? USB_CLASS_COMM : USB_CLASS_VENDOR_SPEC;
1393 /* assume ep0 uses the same packet size for both speeds */
1394 gs_qualifier_desc.bMaxPacketSize0 =
1395 gs_device_desc.bMaxPacketSize0;
1396 /* assume endpoints are dual-speed */
1397 gs_highspeed_notify_desc.bEndpointAddress =
1398 gs_fullspeed_notify_desc.bEndpointAddress;
1399 gs_highspeed_in_desc.bEndpointAddress =
1400 gs_fullspeed_in_desc.bEndpointAddress;
1401 gs_highspeed_out_desc.bEndpointAddress =
1402 gs_fullspeed_out_desc.bEndpointAddress;
1405 usb_gadget_set_selfpowered(gadget);
1407 if (gadget_is_otg(gadget)) {
1408 gs_otg_descriptor.bmAttributes |= USB_OTG_HNP,
1409 gs_bulk_config_desc.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1410 gs_acm_config_desc.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1413 gs_device = dev = kzalloc(sizeof(struct gs_dev), GFP_KERNEL);
1417 snprintf(manufacturer, sizeof(manufacturer), "%s %s with %s",
1418 init_utsname()->sysname, init_utsname()->release,
1421 dev->dev_gadget = gadget;
1422 spin_lock_init(&dev->dev_lock);
1423 INIT_LIST_HEAD(&dev->dev_req_list);
1424 set_gadget_data(gadget, dev);
1426 if ((ret=gs_alloc_ports(dev, GFP_KERNEL)) != 0) {
1427 pr_err("gs_bind: cannot allocate ports\n");
1432 /* preallocate control response and buffer */
1433 dev->dev_ctrl_req = gs_alloc_req(gadget->ep0, GS_MAX_DESC_LEN,
1435 if (dev->dev_ctrl_req == NULL) {
1439 dev->dev_ctrl_req->complete = gs_setup_complete;
1441 gadget->ep0->driver_data = dev;
1443 pr_info("gs_bind: %s %s bound\n",
1444 GS_LONG_NAME, GS_VERSION_STR);
1449 pr_err("gs_bind: cannot autoconfigure on %s\n", gadget->name);
1456 * Called on module unload. Frees the control request and device
1459 static void /* __init_or_exit */ gs_unbind(struct usb_gadget *gadget)
1461 struct gs_dev *dev = get_gadget_data(gadget);
1465 /* read/write requests already freed, only control request remains */
1467 if (dev->dev_ctrl_req != NULL) {
1468 gs_free_req(gadget->ep0, dev->dev_ctrl_req);
1469 dev->dev_ctrl_req = NULL;
1472 if (dev->dev_notify_ep)
1473 usb_ep_disable(dev->dev_notify_ep);
1475 usb_ep_disable(dev->dev_in_ep);
1476 if (dev->dev_out_ep)
1477 usb_ep_disable(dev->dev_out_ep);
1479 set_gadget_data(gadget, NULL);
1482 pr_info("gs_unbind: %s %s unbound\n", GS_LONG_NAME,
1489 * Implements all the control endpoint functionality that's not
1490 * handled in hardware or the hardware driver.
1492 * Returns the size of the data sent to the host, or a negative
1495 static int gs_setup(struct usb_gadget *gadget,
1496 const struct usb_ctrlrequest *ctrl)
1498 int ret = -EOPNOTSUPP;
1499 struct gs_dev *dev = get_gadget_data(gadget);
1500 struct usb_request *req = dev->dev_ctrl_req;
1501 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1502 u16 wValue = le16_to_cpu(ctrl->wValue);
1503 u16 wLength = le16_to_cpu(ctrl->wLength);
1505 switch (ctrl->bRequestType & USB_TYPE_MASK) {
1506 case USB_TYPE_STANDARD:
1507 ret = gs_setup_standard(gadget,ctrl);
1510 case USB_TYPE_CLASS:
1511 ret = gs_setup_class(gadget,ctrl);
1515 pr_err("gs_setup: unknown request, type=%02x, request=%02x, "
1516 "value=%04x, index=%04x, length=%d\n",
1517 ctrl->bRequestType, ctrl->bRequest,
1518 wValue, wIndex, wLength);
1522 /* respond with data transfer before status phase? */
1525 req->zero = ret < wLength
1526 && (ret % gadget->ep0->maxpacket) == 0;
1527 ret = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
1529 pr_err("gs_setup: cannot queue response, ret=%d\n",
1532 gs_setup_complete(gadget->ep0, req);
1536 /* device either stalls (ret < 0) or reports success */
1540 static int gs_setup_standard(struct usb_gadget *gadget,
1541 const struct usb_ctrlrequest *ctrl)
1543 int ret = -EOPNOTSUPP;
1544 struct gs_dev *dev = get_gadget_data(gadget);
1545 struct usb_request *req = dev->dev_ctrl_req;
1546 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1547 u16 wValue = le16_to_cpu(ctrl->wValue);
1548 u16 wLength = le16_to_cpu(ctrl->wLength);
1550 switch (ctrl->bRequest) {
1551 case USB_REQ_GET_DESCRIPTOR:
1552 if (ctrl->bRequestType != USB_DIR_IN)
1555 switch (wValue >> 8) {
1558 (u16)sizeof(struct usb_device_descriptor));
1559 memcpy(req->buf, &gs_device_desc, ret);
1562 case USB_DT_DEVICE_QUALIFIER:
1563 if (!gadget_is_dualspeed(gadget))
1566 (u16)sizeof(struct usb_qualifier_descriptor));
1567 memcpy(req->buf, &gs_qualifier_desc, ret);
1570 case USB_DT_OTHER_SPEED_CONFIG:
1571 if (!gadget_is_dualspeed(gadget))
1575 ret = gs_build_config_buf(req->buf, gadget,
1576 wValue >> 8, wValue & 0xff,
1577 gadget_is_otg(gadget));
1579 ret = min(wLength, (u16)ret);
1583 /* wIndex == language code. */
1584 ret = usb_gadget_get_string(&gs_string_table,
1585 wValue & 0xff, req->buf);
1587 ret = min(wLength, (u16)ret);
1592 case USB_REQ_SET_CONFIGURATION:
1593 if (ctrl->bRequestType != 0)
1595 spin_lock(&dev->dev_lock);
1596 ret = gs_set_config(dev, wValue);
1597 spin_unlock(&dev->dev_lock);
1600 case USB_REQ_GET_CONFIGURATION:
1601 if (ctrl->bRequestType != USB_DIR_IN)
1603 *(u8 *)req->buf = dev->dev_config;
1604 ret = min(wLength, (u16)1);
1607 case USB_REQ_SET_INTERFACE:
1608 if (ctrl->bRequestType != USB_RECIP_INTERFACE
1610 || wIndex >= GS_MAX_NUM_INTERFACES)
1612 if (dev->dev_config == GS_BULK_CONFIG_ID
1613 && wIndex != GS_BULK_INTERFACE_ID)
1615 /* no alternate interface settings */
1618 spin_lock(&dev->dev_lock);
1619 /* PXA hardware partially handles SET_INTERFACE;
1620 * we need to kluge around that interference. */
1621 if (gadget_is_pxa(gadget)) {
1622 ret = gs_set_config(dev, use_acm ?
1623 GS_ACM_CONFIG_ID : GS_BULK_CONFIG_ID);
1624 goto set_interface_done;
1626 if (dev->dev_config != GS_BULK_CONFIG_ID
1627 && wIndex == GS_CONTROL_INTERFACE_ID) {
1628 if (dev->dev_notify_ep) {
1629 usb_ep_disable(dev->dev_notify_ep);
1630 usb_ep_enable(dev->dev_notify_ep, dev->dev_notify_ep_desc);
1633 usb_ep_disable(dev->dev_in_ep);
1634 usb_ep_disable(dev->dev_out_ep);
1635 usb_ep_enable(dev->dev_in_ep, dev->dev_in_ep_desc);
1636 usb_ep_enable(dev->dev_out_ep, dev->dev_out_ep_desc);
1640 spin_unlock(&dev->dev_lock);
1643 case USB_REQ_GET_INTERFACE:
1644 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)
1645 || dev->dev_config == GS_NO_CONFIG_ID)
1647 if (wIndex >= GS_MAX_NUM_INTERFACES
1648 || (dev->dev_config == GS_BULK_CONFIG_ID
1649 && wIndex != GS_BULK_INTERFACE_ID)) {
1653 /* no alternate interface settings */
1654 *(u8 *)req->buf = 0;
1655 ret = min(wLength, (u16)1);
1659 pr_err("gs_setup: unknown standard request, type=%02x, "
1660 "request=%02x, value=%04x, index=%04x, length=%d\n",
1661 ctrl->bRequestType, ctrl->bRequest,
1662 wValue, wIndex, wLength);
1669 static int gs_setup_class(struct usb_gadget *gadget,
1670 const struct usb_ctrlrequest *ctrl)
1672 int ret = -EOPNOTSUPP;
1673 struct gs_dev *dev = get_gadget_data(gadget);
1674 struct gs_port *port = dev->dev_port[0]; /* ACM only has one port */
1675 struct usb_request *req = dev->dev_ctrl_req;
1676 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1677 u16 wValue = le16_to_cpu(ctrl->wValue);
1678 u16 wLength = le16_to_cpu(ctrl->wLength);
1680 switch (ctrl->bRequest) {
1681 case USB_CDC_REQ_SET_LINE_CODING:
1682 /* FIXME Submit req to read the data; have its completion
1683 * handler copy that data to port->port_line_coding (iff
1684 * it's valid) and maybe pass it on. Until then, fail.
1686 pr_warning("gs_setup: set_line_coding "
1690 case USB_CDC_REQ_GET_LINE_CODING:
1691 port = dev->dev_port[0]; /* ACM only has one port */
1693 (u16)sizeof(struct usb_cdc_line_coding));
1695 spin_lock(&port->port_lock);
1696 memcpy(req->buf, &port->port_line_coding, ret);
1697 spin_unlock(&port->port_lock);
1701 case USB_CDC_REQ_SET_CONTROL_LINE_STATE:
1702 /* FIXME Submit req to read the data; have its completion
1703 * handler use that to set the state (iff it's valid) and
1704 * maybe pass it on. Until then, fail.
1706 pr_warning("gs_setup: set_control_line_state "
1711 pr_err("gs_setup: unknown class request, "
1712 "type=%02x, request=%02x, value=%04x, "
1713 "index=%04x, length=%d\n",
1714 ctrl->bRequestType, ctrl->bRequest,
1715 wValue, wIndex, wLength);
1725 static void gs_setup_complete(struct usb_ep *ep, struct usb_request *req)
1727 if (req->status || req->actual != req->length) {
1728 pr_err("gs_setup_complete: status error, status=%d, "
1729 "actual=%d, length=%d\n",
1730 req->status, req->actual, req->length);
1737 * Called when the device is disconnected. Frees the closed
1738 * ports and disconnects open ports. Open ports will be freed
1739 * on close. Then reallocates the ports for the next connection.
1741 static void gs_disconnect(struct usb_gadget *gadget)
1743 unsigned long flags;
1744 struct gs_dev *dev = get_gadget_data(gadget);
1746 spin_lock_irqsave(&dev->dev_lock, flags);
1748 gs_reset_config(dev);
1750 /* free closed ports and disconnect open ports */
1751 /* (open ports will be freed when closed) */
1754 /* re-allocate ports for the next connection */
1755 if (gs_alloc_ports(dev, GFP_ATOMIC) != 0)
1756 pr_err("gs_disconnect: cannot re-allocate ports\n");
1758 spin_unlock_irqrestore(&dev->dev_lock, flags);
1760 pr_info("gs_disconnect: %s disconnected\n", GS_LONG_NAME);
1766 * Configures the device by enabling device specific
1767 * optimizations, setting up the endpoints, allocating
1768 * read and write requests and queuing read requests.
1770 * The device lock must be held when calling this function.
1772 static int gs_set_config(struct gs_dev *dev, unsigned config)
1776 struct usb_gadget *gadget = dev->dev_gadget;
1778 struct usb_endpoint_descriptor *ep_desc;
1779 struct usb_request *req;
1780 struct gs_req_entry *req_entry;
1783 pr_err("gs_set_config: NULL device pointer\n");
1787 if (config == dev->dev_config)
1790 gs_reset_config(dev);
1793 case GS_NO_CONFIG_ID:
1795 case GS_BULK_CONFIG_ID:
1798 /* device specific optimizations */
1799 if (gadget_is_net2280(gadget))
1800 net2280_set_fifo_mode(gadget, 1);
1802 case GS_ACM_CONFIG_ID:
1805 /* device specific optimizations */
1806 if (gadget_is_net2280(gadget))
1807 net2280_set_fifo_mode(gadget, 1);
1813 dev->dev_config = config;
1815 gadget_for_each_ep(ep, gadget) {
1818 && strcmp(ep->name, EP_NOTIFY_NAME) == 0) {
1819 ep_desc = choose_ep_desc(gadget,
1820 &gs_highspeed_notify_desc,
1821 &gs_fullspeed_notify_desc);
1822 ret = usb_ep_enable(ep,ep_desc);
1824 ep->driver_data = dev;
1825 dev->dev_notify_ep = ep;
1826 dev->dev_notify_ep_desc = ep_desc;
1828 pr_err("gs_set_config: cannot enable NOTIFY "
1829 "endpoint %s, ret=%d\n",
1831 goto exit_reset_config;
1835 else if (strcmp(ep->name, EP_IN_NAME) == 0) {
1836 ep_desc = choose_ep_desc(gadget,
1837 &gs_highspeed_in_desc,
1838 &gs_fullspeed_in_desc);
1839 ret = usb_ep_enable(ep,ep_desc);
1841 ep->driver_data = dev;
1842 dev->dev_in_ep = ep;
1843 dev->dev_in_ep_desc = ep_desc;
1845 pr_err("gs_set_config: cannot enable IN "
1846 "endpoint %s, ret=%d\n",
1848 goto exit_reset_config;
1852 else if (strcmp(ep->name, EP_OUT_NAME) == 0) {
1853 ep_desc = choose_ep_desc(gadget,
1854 &gs_highspeed_out_desc,
1855 &gs_fullspeed_out_desc);
1856 ret = usb_ep_enable(ep,ep_desc);
1858 ep->driver_data = dev;
1859 dev->dev_out_ep = ep;
1860 dev->dev_out_ep_desc = ep_desc;
1862 pr_err("gs_set_config: cannot enable OUT "
1863 "endpoint %s, ret=%d\n",
1865 goto exit_reset_config;
1871 if (dev->dev_in_ep == NULL || dev->dev_out_ep == NULL
1872 || (config != GS_BULK_CONFIG_ID && dev->dev_notify_ep == NULL)) {
1873 pr_err("gs_set_config: cannot find endpoints\n");
1875 goto exit_reset_config;
1878 /* allocate and queue read requests */
1879 ep = dev->dev_out_ep;
1880 for (i=0; i<read_q_size && ret == 0; i++) {
1881 if ((req=gs_alloc_req(ep, ep->maxpacket, GFP_ATOMIC))) {
1882 req->complete = gs_read_complete;
1883 if ((ret=usb_ep_queue(ep, req, GFP_ATOMIC))) {
1884 pr_err("gs_set_config: cannot queue read "
1885 "request, ret=%d\n", ret);
1888 pr_err("gs_set_config: cannot allocate "
1891 goto exit_reset_config;
1895 /* allocate write requests, and put on free list */
1896 ep = dev->dev_in_ep;
1897 for (i=0; i<write_q_size; i++) {
1898 if ((req_entry=gs_alloc_req_entry(ep, ep->maxpacket, GFP_ATOMIC))) {
1899 req_entry->re_req->complete = gs_write_complete;
1900 list_add(&req_entry->re_entry, &dev->dev_req_list);
1902 pr_err("gs_set_config: cannot allocate "
1903 "write requests\n");
1905 goto exit_reset_config;
1909 pr_info("gs_set_config: %s configured, %s speed %s config\n",
1911 gadget->speed == USB_SPEED_HIGH ? "high" : "full",
1912 config == GS_BULK_CONFIG_ID ? "BULK" : "CDC-ACM");
1917 gs_reset_config(dev);
1924 * Mark the device as not configured, disable all endpoints,
1925 * which forces completion of pending I/O and frees queued
1926 * requests, and free the remaining write requests on the
1929 * The device lock must be held when calling this function.
1931 static void gs_reset_config(struct gs_dev *dev)
1933 struct gs_req_entry *req_entry;
1936 pr_err("gs_reset_config: NULL device pointer\n");
1940 if (dev->dev_config == GS_NO_CONFIG_ID)
1943 dev->dev_config = GS_NO_CONFIG_ID;
1945 /* free write requests on the free list */
1946 while(!list_empty(&dev->dev_req_list)) {
1947 req_entry = list_entry(dev->dev_req_list.next,
1948 struct gs_req_entry, re_entry);
1949 list_del(&req_entry->re_entry);
1950 gs_free_req_entry(dev->dev_in_ep, req_entry);
1953 /* disable endpoints, forcing completion of pending i/o; */
1954 /* completion handlers free their requests in this case */
1955 if (dev->dev_notify_ep) {
1956 usb_ep_disable(dev->dev_notify_ep);
1957 dev->dev_notify_ep = NULL;
1959 if (dev->dev_in_ep) {
1960 usb_ep_disable(dev->dev_in_ep);
1961 dev->dev_in_ep = NULL;
1963 if (dev->dev_out_ep) {
1964 usb_ep_disable(dev->dev_out_ep);
1965 dev->dev_out_ep = NULL;
1970 * gs_build_config_buf
1972 * Builds the config descriptors in the given buffer and returns the
1973 * length, or a negative error number.
1975 static int gs_build_config_buf(u8 *buf, struct usb_gadget *g,
1976 u8 type, unsigned int index, int is_otg)
1980 const struct usb_config_descriptor *config_desc;
1981 const struct usb_descriptor_header **function;
1983 if (index >= gs_device_desc.bNumConfigurations)
1986 /* other speed switches high and full speed */
1987 if (gadget_is_dualspeed(g)) {
1988 high_speed = (g->speed == USB_SPEED_HIGH);
1989 if (type == USB_DT_OTHER_SPEED_CONFIG)
1990 high_speed = !high_speed;
1994 config_desc = &gs_acm_config_desc;
1995 function = high_speed
1996 ? gs_acm_highspeed_function
1997 : gs_acm_fullspeed_function;
1999 config_desc = &gs_bulk_config_desc;
2000 function = high_speed
2001 ? gs_bulk_highspeed_function
2002 : gs_bulk_fullspeed_function;
2005 /* for now, don't advertise srp-only devices */
2009 len = usb_gadget_config_buf(config_desc, buf, GS_MAX_DESC_LEN, function);
2013 ((struct usb_config_descriptor *)buf)->bDescriptorType = type;
2021 * Allocate a usb_request and its buffer. Returns a pointer to the
2022 * usb_request or NULL if there is an error.
2024 static struct usb_request *
2025 gs_alloc_req(struct usb_ep *ep, unsigned int len, gfp_t kmalloc_flags)
2027 struct usb_request *req;
2032 req = usb_ep_alloc_request(ep, kmalloc_flags);
2036 req->buf = kmalloc(len, kmalloc_flags);
2037 if (req->buf == NULL) {
2038 usb_ep_free_request(ep, req);
2049 * Free a usb_request and its buffer.
2051 static void gs_free_req(struct usb_ep *ep, struct usb_request *req)
2053 if (ep != NULL && req != NULL) {
2055 usb_ep_free_request(ep, req);
2060 * gs_alloc_req_entry
2062 * Allocates a request and its buffer, using the given
2063 * endpoint, buffer len, and kmalloc flags.
2065 static struct gs_req_entry *
2066 gs_alloc_req_entry(struct usb_ep *ep, unsigned len, gfp_t kmalloc_flags)
2068 struct gs_req_entry *req;
2070 req = kmalloc(sizeof(struct gs_req_entry), kmalloc_flags);
2074 req->re_req = gs_alloc_req(ep, len, kmalloc_flags);
2075 if (req->re_req == NULL) {
2080 req->re_req->context = req;
2088 * Frees a request and its buffer.
2090 static void gs_free_req_entry(struct usb_ep *ep, struct gs_req_entry *req)
2092 if (ep != NULL && req != NULL) {
2093 if (req->re_req != NULL)
2094 gs_free_req(ep, req->re_req);
2102 * Allocate all ports and set the gs_dev struct to point to them.
2103 * Return 0 if successful, or a negative error number.
2105 * The device lock is normally held when calling this function.
2107 static int gs_alloc_ports(struct gs_dev *dev, gfp_t kmalloc_flags)
2110 struct gs_port *port;
2115 for (i=0; i<GS_NUM_PORTS; i++) {
2116 if ((port=kzalloc(sizeof(struct gs_port), kmalloc_flags)) == NULL)
2119 port->port_dev = dev;
2121 port->port_line_coding.dwDTERate = cpu_to_le32(GS_DEFAULT_DTE_RATE);
2122 port->port_line_coding.bCharFormat = GS_DEFAULT_CHAR_FORMAT;
2123 port->port_line_coding.bParityType = GS_DEFAULT_PARITY;
2124 port->port_line_coding.bDataBits = GS_DEFAULT_DATA_BITS;
2125 spin_lock_init(&port->port_lock);
2126 init_waitqueue_head(&port->port_write_wait);
2128 dev->dev_port[i] = port;
2137 * Free all closed ports. Open ports are disconnected by
2138 * freeing their write buffers, setting their device pointers
2139 * and the pointers to them in the device to NULL. These
2140 * ports will be freed when closed.
2142 * The device lock is normally held when calling this function.
2144 static void gs_free_ports(struct gs_dev *dev)
2147 unsigned long flags;
2148 struct gs_port *port;
2153 for (i=0; i<GS_NUM_PORTS; i++) {
2154 if ((port=dev->dev_port[i]) != NULL) {
2155 dev->dev_port[i] = NULL;
2157 spin_lock_irqsave(&port->port_lock, flags);
2159 if (port->port_write_buf != NULL) {
2160 gs_buf_free(port->port_write_buf);
2161 port->port_write_buf = NULL;
2164 if (port->port_open_count > 0 || port->port_in_use) {
2165 port->port_dev = NULL;
2166 wake_up_interruptible(&port->port_write_wait);
2167 if (port->port_tty) {
2168 tty_hangup(port->port_tty);
2170 spin_unlock_irqrestore(&port->port_lock, flags);
2172 spin_unlock_irqrestore(&port->port_lock, flags);
2180 /* Circular Buffer */
2185 * Allocate a circular buffer and all associated memory.
2187 static struct gs_buf *gs_buf_alloc(unsigned int size, gfp_t kmalloc_flags)
2194 gb = kmalloc(sizeof(struct gs_buf), kmalloc_flags);
2198 gb->buf_buf = kmalloc(size, kmalloc_flags);
2199 if (gb->buf_buf == NULL) {
2204 gb->buf_size = size;
2205 gb->buf_get = gb->buf_put = gb->buf_buf;
2213 * Free the buffer and all associated memory.
2215 static void gs_buf_free(struct gs_buf *gb)
2226 * Clear out all data in the circular buffer.
2228 static void gs_buf_clear(struct gs_buf *gb)
2231 gb->buf_get = gb->buf_put;
2232 /* equivalent to a get of all data available */
2238 * Return the number of bytes of data available in the circular
2241 static unsigned int gs_buf_data_avail(struct gs_buf *gb)
2244 return (gb->buf_size + gb->buf_put - gb->buf_get) % gb->buf_size;
2250 * gs_buf_space_avail
2252 * Return the number of bytes of space available in the circular
2255 static unsigned int gs_buf_space_avail(struct gs_buf *gb)
2258 return (gb->buf_size + gb->buf_get - gb->buf_put - 1) % gb->buf_size;
2266 * Copy data data from a user buffer and put it into the circular buffer.
2267 * Restrict to the amount of space available.
2269 * Return the number of bytes copied.
2272 gs_buf_put(struct gs_buf *gb, const char *buf, unsigned int count)
2279 len = gs_buf_space_avail(gb);
2286 len = gb->buf_buf + gb->buf_size - gb->buf_put;
2288 memcpy(gb->buf_put, buf, len);
2289 memcpy(gb->buf_buf, buf+len, count - len);
2290 gb->buf_put = gb->buf_buf + count - len;
2292 memcpy(gb->buf_put, buf, count);
2294 gb->buf_put += count;
2295 else /* count == len */
2296 gb->buf_put = gb->buf_buf;
2305 * Get data from the circular buffer and copy to the given buffer.
2306 * Restrict to the amount of data available.
2308 * Return the number of bytes copied.
2311 gs_buf_get(struct gs_buf *gb, char *buf, unsigned int count)
2318 len = gs_buf_data_avail(gb);
2325 len = gb->buf_buf + gb->buf_size - gb->buf_get;
2327 memcpy(buf, gb->buf_get, len);
2328 memcpy(buf+len, gb->buf_buf, count - len);
2329 gb->buf_get = gb->buf_buf + count - len;
2331 memcpy(buf, gb->buf_get, count);
2333 gb->buf_get += count;
2334 else /* count == len */
2335 gb->buf_get = gb->buf_buf;