[PATCH] USB: One potential problem in gadget/serial.c
[linux-2.6/sactl.git] / drivers / usb / gadget / serial.c
blob65e084a2c87e13804d4a83c16bf8c0564bd26743
1 /*
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/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>
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>
47 #include <linux/usb_ch9.h>
48 #include <linux/usb_cdc.h>
49 #include <linux/usb_gadget.h>
51 #include "gadget_chips.h"
54 /* Wait Cond */
56 #define __wait_cond_interruptible(wq, condition, lock, flags, ret) \
57 do { \
58 wait_queue_t __wait; \
59 init_waitqueue_entry(&__wait, current); \
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)
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; \
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); \
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; \
108 ret = -ERESTARTSYS; \
109 break; \
111 current->state = TASK_RUNNING; \
112 remove_wait_queue(&wq, &__wait); \
113 } while (0)
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; \
126 /* Defines */
128 #define GS_VERSION_STR "v2.0"
129 #define GS_VERSION_NUM 0x0200
131 #define GS_LONG_NAME "Gadget Serial"
132 #define GS_SHORT_NAME "g_serial"
134 #define GS_MAJOR 127
135 #define GS_MINOR_START 0
137 #define GS_NUM_PORTS 16
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
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
149 #define GS_MAX_DESC_LEN 256
151 #define GS_DEFAULT_READ_Q_SIZE 32
152 #define GS_DEFAULT_WRITE_Q_SIZE 32
154 #define GS_DEFAULT_WRITE_BUF_SIZE 8192
155 #define GS_TMP_BUF_SIZE 8192
157 #define GS_CLOSE_TIMEOUT 15
159 #define GS_DEFAULT_USE_ACM 0
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
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 */
173 /* debug settings */
174 #ifdef GS_DEBUG
175 static int debug = 1;
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)
182 #else
184 #define gs_debug(format, arg...) \
185 do { } while(0)
186 #define gs_debug_level(level, format, arg...) \
187 do { } while(0)
189 #endif /* GS_DEBUG */
191 /* Thanks to NetChip Technologies for donating this product ID.
193 * DO NOT REUSE THESE IDs with a protocol-incompatible driver!! Ever!!
194 * Instead: allocate your own, using normal USB-IF procedures.
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 */
200 #define GS_LOG2_NOTIFY_INTERVAL 5 /* 1 << 5 == 32 msec */
201 #define GS_NOTIFY_MAXPACKET 8
204 /* Structures */
206 struct gs_dev;
208 /* circular buffer */
209 struct gs_buf {
210 unsigned int buf_size;
211 char *buf_buf;
212 char *buf_get;
213 char *buf_put;
216 /* list of requests */
217 struct gs_req_entry {
218 struct list_head re_entry;
219 struct usb_request *re_req;
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;
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 */
256 /* Functions */
258 /* module */
259 static int __init gs_module_init(void);
260 static void __exit gs_module_exit(void);
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);
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);
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);
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);
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);
310 static int gs_alloc_ports(struct gs_dev *dev, gfp_t kmalloc_flags);
311 static void gs_free_ports(struct gs_dev *dev);
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);
324 /* external functions */
325 extern int net2280_set_fifo_mode(struct usb_gadget *gadget, int mode);
328 /* Globals */
330 static struct gs_dev *gs_device;
332 static const char *EP_IN_NAME;
333 static const char *EP_OUT_NAME;
334 static const char *EP_NOTIFY_NAME;
336 static struct semaphore gs_open_close_sem[GS_NUM_PORTS];
338 static unsigned int read_q_size = GS_DEFAULT_READ_Q_SIZE;
339 static unsigned int write_q_size = GS_DEFAULT_WRITE_Q_SIZE;
341 static unsigned int write_buf_size = GS_DEFAULT_WRITE_BUF_SIZE;
343 static unsigned int use_acm = GS_DEFAULT_USE_ACM;
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,
361 static struct tty_driver *gs_tty_driver;
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 = ... */
384 /* USB descriptors */
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
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 */
407 static struct usb_gadget_strings gs_string_table = {
408 .language = 0x0409, /* en-us */
409 .strings = gs_strings,
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,
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,
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,
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,
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,
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,
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,
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),
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 */
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,
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 */
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,
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,
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,
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,
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,
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,
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),
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),
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,
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,
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,
616 #endif /* CONFIG_USB_GADGET_DUALSPEED */
619 /* Module */
620 MODULE_DESCRIPTION(GS_LONG_NAME);
621 MODULE_AUTHOR("Al Borchers");
622 MODULE_LICENSE("GPL");
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
629 module_param(read_q_size, uint, S_IRUGO);
630 MODULE_PARM_DESC(read_q_size, "Read request queue size, default=32");
632 module_param(write_q_size, uint, S_IRUGO);
633 MODULE_PARM_DESC(write_q_size, "Write request queue size, default=32");
635 module_param(write_buf_size, uint, S_IRUGO);
636 MODULE_PARM_DESC(write_buf_size, "Write buffer size, default=8192");
638 module_param(use_acm, uint, S_IRUGO);
639 MODULE_PARM_DESC(use_acm, "Use CDC ACM, 0=no, 1=yes, default=no");
641 module_init(gs_module_init);
642 module_exit(gs_module_exit);
645 * gs_module_init
647 * Register as a USB gadget driver and a tty driver.
649 static int __init gs_module_init(void)
651 int i;
652 int retval;
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;
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);
676 for (i=0; i < GS_NUM_PORTS; i++)
677 sema_init(&gs_open_close_sem[i], 1);
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;
687 printk(KERN_INFO "gs_module_init: %s %s loaded\n", GS_LONG_NAME, GS_VERSION_STR);
688 return 0;
692 * gs_module_exit
694 * Unregister as a tty driver and a USB gadget driver.
696 static void __exit gs_module_exit(void)
698 tty_unregister_driver(gs_tty_driver);
699 put_tty_driver(gs_tty_driver);
700 usb_gadget_unregister_driver(&gs_gadget_driver);
702 printk(KERN_INFO "gs_module_exit: %s %s unloaded\n", GS_LONG_NAME, GS_VERSION_STR);
705 /* TTY Driver */
708 * gs_open
710 static int gs_open(struct tty_struct *tty, struct file *file)
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;
720 port_num = tty->index;
722 gs_debug("gs_open: (%d,%p,%p)\n", port_num, tty, file);
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;
730 dev = gs_device;
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;
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;
746 spin_lock_irqsave(&dev->dev_lock, flags);
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;
756 port = dev->dev_port[port_num];
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;
765 spin_lock(&port->port_lock);
766 spin_unlock(&dev->dev_lock);
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;
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;
783 tty->driver_data = NULL;
785 /* mark port as in use, we can drop port lock and sleep if necessary */
786 port->port_in_use = 1;
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);
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;
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;
814 /* wait for carrier detect (not implemented) */
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;
825 tty->driver_data = port;
826 port->port_tty = tty;
827 port->port_open_count = 1;
828 port->port_in_use = 0;
830 gs_debug("gs_open: (%d,%p,%p) completed\n", port_num, tty, file);
832 ret = 0;
834 exit_unlock_port:
835 spin_unlock_irqrestore(&port->port_lock, flags);
836 up(sem);
837 return ret;
839 exit_unlock_dev:
840 spin_unlock_irqrestore(&dev->dev_lock, flags);
841 up(sem);
842 return ret;
847 * gs_close
849 static void gs_close(struct tty_struct *tty, struct file *file)
851 unsigned long flags;
852 struct gs_port *port = tty->driver_data;
853 struct semaphore *sem;
855 if (port == NULL) {
856 printk(KERN_ERR "gs_close: NULL port pointer\n");
857 return;
860 gs_debug("gs_close: (%d,%p,%p)\n", port->port_num, tty, file);
862 sem = &gs_open_close_sem[port->port_num];
863 down(sem);
865 spin_lock_irqsave(&port->port_lock, flags);
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;
874 if (port->port_open_count > 1) {
875 --port->port_open_count;
876 goto exit;
879 /* free disconnected port on final close */
880 if (port->port_dev == NULL) {
881 kfree(port);
882 goto exit;
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;
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);
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;
908 gs_buf_clear(port->port_write_buf);
910 tty->driver_data = NULL;
911 port->port_tty = NULL;
912 port->port_in_use = 0;
914 gs_debug("gs_close: (%d,%p,%p) completed\n",
915 port->port_num, tty, file);
917 exit:
918 spin_unlock_irqrestore(&port->port_lock, flags);
919 up(sem);
923 * gs_write
925 static int gs_write(struct tty_struct *tty, const unsigned char *buf, int count)
927 unsigned long flags;
928 struct gs_port *port = tty->driver_data;
929 int ret;
931 if (port == NULL) {
932 printk(KERN_ERR "gs_write: NULL port pointer\n");
933 return -EIO;
936 gs_debug("gs_write: (%d,%p) writing %d bytes\n", port->port_num, tty,
937 count);
939 if (count == 0)
940 return 0;
942 spin_lock_irqsave(&port->port_lock, flags);
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;
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;
958 count = gs_buf_put(port->port_write_buf, buf, count);
960 spin_unlock_irqrestore(&port->port_lock, flags);
962 gs_send(gs_device);
964 gs_debug("gs_write: (%d,%p) wrote %d bytes\n", port->port_num, tty,
965 count);
967 return count;
969 exit:
970 spin_unlock_irqrestore(&port->port_lock, flags);
971 return ret;
975 * gs_put_char
977 static void gs_put_char(struct tty_struct *tty, unsigned char ch)
979 unsigned long flags;
980 struct gs_port *port = tty->driver_data;
982 if (port == NULL) {
983 printk(KERN_ERR "gs_put_char: NULL port pointer\n");
984 return;
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));
989 spin_lock_irqsave(&port->port_lock, flags);
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;
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;
1003 gs_buf_put(port->port_write_buf, &ch, 1);
1005 exit:
1006 spin_unlock_irqrestore(&port->port_lock, flags);
1010 * gs_flush_chars
1012 static void gs_flush_chars(struct tty_struct *tty)
1014 unsigned long flags;
1015 struct gs_port *port = tty->driver_data;
1017 if (port == NULL) {
1018 printk(KERN_ERR "gs_flush_chars: NULL port pointer\n");
1019 return;
1022 gs_debug("gs_flush_chars: (%d,%p)\n", port->port_num, tty);
1024 spin_lock_irqsave(&port->port_lock, flags);
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;
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;
1039 spin_unlock_irqrestore(&port->port_lock, flags);
1041 gs_send(gs_device);
1043 return;
1045 exit:
1046 spin_unlock_irqrestore(&port->port_lock, flags);
1050 * gs_write_room
1052 static int gs_write_room(struct tty_struct *tty)
1055 int room = 0;
1056 unsigned long flags;
1057 struct gs_port *port = tty->driver_data;
1060 if (port == NULL)
1061 return 0;
1063 spin_lock_irqsave(&port->port_lock, flags);
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);
1069 spin_unlock_irqrestore(&port->port_lock, flags);
1071 gs_debug("gs_write_room: (%d,%p) room=%d\n",
1072 port->port_num, tty, room);
1074 return room;
1078 * gs_chars_in_buffer
1080 static int gs_chars_in_buffer(struct tty_struct *tty)
1082 int chars = 0;
1083 unsigned long flags;
1084 struct gs_port *port = tty->driver_data;
1086 if (port == NULL)
1087 return 0;
1089 spin_lock_irqsave(&port->port_lock, flags);
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);
1095 spin_unlock_irqrestore(&port->port_lock, flags);
1097 gs_debug("gs_chars_in_buffer: (%d,%p) chars=%d\n",
1098 port->port_num, tty, chars);
1100 return chars;
1104 * gs_throttle
1106 static void gs_throttle(struct tty_struct *tty)
1111 * gs_unthrottle
1113 static void gs_unthrottle(struct tty_struct *tty)
1118 * gs_break
1120 static void gs_break(struct tty_struct *tty, int break_state)
1125 * gs_ioctl
1127 static int gs_ioctl(struct tty_struct *tty, struct file *file, unsigned int cmd, unsigned long arg)
1129 struct gs_port *port = tty->driver_data;
1131 if (port == NULL) {
1132 printk(KERN_ERR "gs_ioctl: NULL port pointer\n");
1133 return -EIO;
1136 gs_debug("gs_ioctl: (%d,%p,%p) cmd=0x%4.4x, arg=%lu\n",
1137 port->port_num, tty, file, cmd, arg);
1139 /* handle ioctls */
1141 /* could not handle ioctl */
1142 return -ENOIOCTLCMD;
1146 * gs_set_termios
1148 static void gs_set_termios(struct tty_struct *tty, struct termios *old)
1153 * gs_send
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.
1161 static int gs_send(struct gs_dev *dev)
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;
1169 if (dev == NULL) {
1170 printk(KERN_ERR "gs_send: NULL device pointer\n");
1171 return -ENODEV;
1174 spin_lock_irqsave(&dev->dev_lock, flags);
1176 ep = dev->dev_in_ep;
1178 while(!list_empty(&dev->dev_req_list)) {
1180 req_entry = list_entry(dev->dev_req_list.next,
1181 struct gs_req_entry, re_entry);
1183 req = req_entry->re_req;
1185 len = gs_send_packet(dev, req->buf, ep->maxpacket);
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;
1197 } else {
1198 break;
1203 spin_unlock_irqrestore(&dev->dev_lock, flags);
1205 return 0;
1209 * gs_send_packet
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.
1216 * Called during USB completion routine, on interrupt time.
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.
1222 static int gs_send_packet(struct gs_dev *dev, char *packet, unsigned int size)
1224 unsigned int len;
1225 struct gs_port *port;
1227 /* TEMPORARY -- only port 0 is supported right now */
1228 port = dev->dev_port[0];
1230 if (port == NULL) {
1231 printk(KERN_ERR
1232 "gs_send_packet: port=%d, NULL port pointer\n",
1234 return -EIO;
1237 spin_lock(&port->port_lock);
1239 len = gs_buf_data_avail(port->port_write_buf);
1240 if (len < size)
1241 size = len;
1243 if (size == 0)
1244 goto exit;
1246 size = gs_buf_get(port->port_write_buf, packet, size);
1248 if (port->port_tty)
1249 wake_up_interruptible(&port->port_tty->write_wait);
1251 exit:
1252 spin_unlock(&port->port_lock);
1253 return size;
1257 * gs_recv_packet
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.
1263 * Called during USB completion routine, on interrupt time.
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.
1269 static int gs_recv_packet(struct gs_dev *dev, char *packet, unsigned int size)
1271 unsigned int len;
1272 struct gs_port *port;
1273 int ret;
1275 /* TEMPORARY -- only port 0 is supported right now */
1276 port = dev->dev_port[0];
1278 if (port == NULL) {
1279 printk(KERN_ERR "gs_recv_packet: port=%d, NULL port pointer\n",
1280 port->port_num);
1281 return -EIO;
1284 spin_lock(&port->port_lock);
1286 if (port->port_open_count == 0) {
1287 printk(KERN_ERR "gs_recv_packet: port=%d, port is closed\n",
1288 port->port_num);
1289 ret = -EIO;
1290 goto exit;
1293 if (port->port_tty == NULL) {
1294 printk(KERN_ERR "gs_recv_packet: port=%d, NULL tty pointer\n",
1295 port->port_num);
1296 ret = -EIO;
1297 goto exit;
1300 if (port->port_tty->magic != TTY_MAGIC) {
1301 printk(KERN_ERR "gs_recv_packet: port=%d, bad tty magic\n",
1302 port->port_num);
1303 ret = -EIO;
1304 goto exit;
1307 len = (unsigned int)(TTY_FLIPBUF_SIZE - port->port_tty->flip.count);
1308 if (len < size)
1309 size = len;
1311 if (size > 0) {
1312 memcpy(port->port_tty->flip.char_buf_ptr, packet, size);
1313 port->port_tty->flip.char_buf_ptr += size;
1314 port->port_tty->flip.count += size;
1315 tty_flip_buffer_push(port->port_tty);
1316 wake_up_interruptible(&port->port_tty->read_wait);
1319 ret = 0;
1321 exit:
1322 spin_unlock(&port->port_lock);
1323 return ret;
1327 * gs_read_complete
1329 static void gs_read_complete(struct usb_ep *ep, struct usb_request *req)
1331 int ret;
1332 struct gs_dev *dev = ep->driver_data;
1334 if (dev == NULL) {
1335 printk(KERN_ERR "gs_read_complete: NULL device pointer\n");
1336 return;
1339 switch(req->status) {
1340 case 0:
1341 /* normal completion */
1342 gs_recv_packet(dev, req->buf, req->actual);
1343 requeue:
1344 req->length = ep->maxpacket;
1345 if ((ret=usb_ep_queue(ep, req, GFP_ATOMIC))) {
1346 printk(KERN_ERR
1347 "gs_read_complete: cannot queue read request, ret=%d\n",
1348 ret);
1350 break;
1352 case -ESHUTDOWN:
1353 /* disconnect */
1354 gs_debug("gs_read_complete: shutdown\n");
1355 gs_free_req(ep, req);
1356 break;
1358 default:
1359 /* unexpected */
1360 printk(KERN_ERR
1361 "gs_read_complete: unexpected status error, status=%d\n",
1362 req->status);
1363 goto requeue;
1364 break;
1369 * gs_write_complete
1371 static void gs_write_complete(struct usb_ep *ep, struct usb_request *req)
1373 struct gs_dev *dev = ep->driver_data;
1374 struct gs_req_entry *gs_req = req->context;
1376 if (dev == NULL) {
1377 printk(KERN_ERR "gs_write_complete: NULL device pointer\n");
1378 return;
1381 switch(req->status) {
1382 case 0:
1383 /* normal completion */
1384 requeue:
1385 if (gs_req == NULL) {
1386 printk(KERN_ERR
1387 "gs_write_complete: NULL request pointer\n");
1388 return;
1391 spin_lock(&dev->dev_lock);
1392 list_add(&gs_req->re_entry, &dev->dev_req_list);
1393 spin_unlock(&dev->dev_lock);
1395 gs_send(dev);
1397 break;
1399 case -ESHUTDOWN:
1400 /* disconnect */
1401 gs_debug("gs_write_complete: shutdown\n");
1402 gs_free_req(ep, req);
1403 break;
1405 default:
1406 printk(KERN_ERR
1407 "gs_write_complete: unexpected status error, status=%d\n",
1408 req->status);
1409 goto requeue;
1410 break;
1414 /* Gadget Driver */
1417 * gs_bind
1419 * Called on module load. Allocates and initializes the device
1420 * structure and a control request.
1422 static int gs_bind(struct usb_gadget *gadget)
1424 int ret;
1425 struct usb_ep *ep;
1426 struct gs_dev *dev;
1427 int gcnum;
1429 /* Some controllers can't support CDC ACM:
1430 * - sh doesn't support multiple interfaces or configs;
1431 * - sa1100 doesn't have a third interrupt endpoint
1433 if (gadget_is_sh(gadget) || gadget_is_sa1100(gadget))
1434 use_acm = 0;
1436 gcnum = usb_gadget_controller_number(gadget);
1437 if (gcnum >= 0)
1438 gs_device_desc.bcdDevice =
1439 cpu_to_le16(GS_VERSION_NUM | gcnum);
1440 else {
1441 printk(KERN_WARNING "gs_bind: controller '%s' not recognized\n",
1442 gadget->name);
1443 /* unrecognized, but safe unless bulk is REALLY quirky */
1444 gs_device_desc.bcdDevice =
1445 __constant_cpu_to_le16(GS_VERSION_NUM|0x0099);
1448 usb_ep_autoconfig_reset(gadget);
1450 ep = usb_ep_autoconfig(gadget, &gs_fullspeed_in_desc);
1451 if (!ep)
1452 goto autoconf_fail;
1453 EP_IN_NAME = ep->name;
1454 ep->driver_data = ep; /* claim the endpoint */
1456 ep = usb_ep_autoconfig(gadget, &gs_fullspeed_out_desc);
1457 if (!ep)
1458 goto autoconf_fail;
1459 EP_OUT_NAME = ep->name;
1460 ep->driver_data = ep; /* claim the endpoint */
1462 if (use_acm) {
1463 ep = usb_ep_autoconfig(gadget, &gs_fullspeed_notify_desc);
1464 if (!ep) {
1465 printk(KERN_ERR "gs_bind: cannot run ACM on %s\n", gadget->name);
1466 goto autoconf_fail;
1468 gs_device_desc.idProduct = __constant_cpu_to_le16(
1469 GS_CDC_PRODUCT_ID),
1470 EP_NOTIFY_NAME = ep->name;
1471 ep->driver_data = ep; /* claim the endpoint */
1474 gs_device_desc.bDeviceClass = use_acm
1475 ? USB_CLASS_COMM : USB_CLASS_VENDOR_SPEC;
1476 gs_device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
1478 #ifdef CONFIG_USB_GADGET_DUALSPEED
1479 gs_qualifier_desc.bDeviceClass = use_acm
1480 ? USB_CLASS_COMM : USB_CLASS_VENDOR_SPEC;
1481 /* assume ep0 uses the same packet size for both speeds */
1482 gs_qualifier_desc.bMaxPacketSize0 = gs_device_desc.bMaxPacketSize0;
1483 /* assume endpoints are dual-speed */
1484 gs_highspeed_notify_desc.bEndpointAddress =
1485 gs_fullspeed_notify_desc.bEndpointAddress;
1486 gs_highspeed_in_desc.bEndpointAddress =
1487 gs_fullspeed_in_desc.bEndpointAddress;
1488 gs_highspeed_out_desc.bEndpointAddress =
1489 gs_fullspeed_out_desc.bEndpointAddress;
1490 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1492 usb_gadget_set_selfpowered(gadget);
1494 if (gadget->is_otg) {
1495 gs_otg_descriptor.bmAttributes |= USB_OTG_HNP,
1496 gs_bulk_config_desc.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1497 gs_acm_config_desc.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
1500 gs_device = dev = kmalloc(sizeof(struct gs_dev), GFP_KERNEL);
1501 if (dev == NULL)
1502 return -ENOMEM;
1504 snprintf(manufacturer, sizeof(manufacturer), "%s %s with %s",
1505 system_utsname.sysname, system_utsname.release,
1506 gadget->name);
1508 memset(dev, 0, sizeof(struct gs_dev));
1509 dev->dev_gadget = gadget;
1510 spin_lock_init(&dev->dev_lock);
1511 INIT_LIST_HEAD(&dev->dev_req_list);
1512 set_gadget_data(gadget, dev);
1514 if ((ret=gs_alloc_ports(dev, GFP_KERNEL)) != 0) {
1515 printk(KERN_ERR "gs_bind: cannot allocate ports\n");
1516 gs_unbind(gadget);
1517 return ret;
1520 /* preallocate control response and buffer */
1521 dev->dev_ctrl_req = gs_alloc_req(gadget->ep0, GS_MAX_DESC_LEN,
1522 GFP_KERNEL);
1523 if (dev->dev_ctrl_req == NULL) {
1524 gs_unbind(gadget);
1525 return -ENOMEM;
1527 dev->dev_ctrl_req->complete = gs_setup_complete;
1529 gadget->ep0->driver_data = dev;
1531 printk(KERN_INFO "gs_bind: %s %s bound\n",
1532 GS_LONG_NAME, GS_VERSION_STR);
1534 return 0;
1536 autoconf_fail:
1537 printk(KERN_ERR "gs_bind: cannot autoconfigure on %s\n", gadget->name);
1538 return -ENODEV;
1542 * gs_unbind
1544 * Called on module unload. Frees the control request and device
1545 * structure.
1547 static void gs_unbind(struct usb_gadget *gadget)
1549 struct gs_dev *dev = get_gadget_data(gadget);
1551 gs_device = NULL;
1553 /* read/write requests already freed, only control request remains */
1554 if (dev != NULL) {
1555 if (dev->dev_ctrl_req != NULL) {
1556 gs_free_req(gadget->ep0, dev->dev_ctrl_req);
1557 dev->dev_ctrl_req = NULL;
1559 gs_free_ports(dev);
1560 kfree(dev);
1561 set_gadget_data(gadget, NULL);
1564 printk(KERN_INFO "gs_unbind: %s %s unbound\n", GS_LONG_NAME,
1565 GS_VERSION_STR);
1569 * gs_setup
1571 * Implements all the control endpoint functionality that's not
1572 * handled in hardware or the hardware driver.
1574 * Returns the size of the data sent to the host, or a negative
1575 * error number.
1577 static int gs_setup(struct usb_gadget *gadget,
1578 const struct usb_ctrlrequest *ctrl)
1580 int ret = -EOPNOTSUPP;
1581 struct gs_dev *dev = get_gadget_data(gadget);
1582 struct usb_request *req = dev->dev_ctrl_req;
1583 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1584 u16 wValue = le16_to_cpu(ctrl->wValue);
1585 u16 wLength = le16_to_cpu(ctrl->wLength);
1587 switch (ctrl->bRequestType & USB_TYPE_MASK) {
1588 case USB_TYPE_STANDARD:
1589 ret = gs_setup_standard(gadget,ctrl);
1590 break;
1592 case USB_TYPE_CLASS:
1593 ret = gs_setup_class(gadget,ctrl);
1594 break;
1596 default:
1597 printk(KERN_ERR "gs_setup: unknown request, type=%02x, request=%02x, value=%04x, index=%04x, length=%d\n",
1598 ctrl->bRequestType, ctrl->bRequest,
1599 wValue, wIndex, wLength);
1600 break;
1603 /* respond with data transfer before status phase? */
1604 if (ret >= 0) {
1605 req->length = ret;
1606 req->zero = ret < wLength
1607 && (ret % gadget->ep0->maxpacket) == 0;
1608 ret = usb_ep_queue(gadget->ep0, req, GFP_ATOMIC);
1609 if (ret < 0) {
1610 printk(KERN_ERR "gs_setup: cannot queue response, ret=%d\n",
1611 ret);
1612 req->status = 0;
1613 gs_setup_complete(gadget->ep0, req);
1617 /* device either stalls (ret < 0) or reports success */
1618 return ret;
1621 static int gs_setup_standard(struct usb_gadget *gadget,
1622 const struct usb_ctrlrequest *ctrl)
1624 int ret = -EOPNOTSUPP;
1625 struct gs_dev *dev = get_gadget_data(gadget);
1626 struct usb_request *req = dev->dev_ctrl_req;
1627 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1628 u16 wValue = le16_to_cpu(ctrl->wValue);
1629 u16 wLength = le16_to_cpu(ctrl->wLength);
1631 switch (ctrl->bRequest) {
1632 case USB_REQ_GET_DESCRIPTOR:
1633 if (ctrl->bRequestType != USB_DIR_IN)
1634 break;
1636 switch (wValue >> 8) {
1637 case USB_DT_DEVICE:
1638 ret = min(wLength,
1639 (u16)sizeof(struct usb_device_descriptor));
1640 memcpy(req->buf, &gs_device_desc, ret);
1641 break;
1643 #ifdef CONFIG_USB_GADGET_DUALSPEED
1644 case USB_DT_DEVICE_QUALIFIER:
1645 if (!gadget->is_dualspeed)
1646 break;
1647 ret = min(wLength,
1648 (u16)sizeof(struct usb_qualifier_descriptor));
1649 memcpy(req->buf, &gs_qualifier_desc, ret);
1650 break;
1652 case USB_DT_OTHER_SPEED_CONFIG:
1653 if (!gadget->is_dualspeed)
1654 break;
1655 /* fall through */
1656 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1657 case USB_DT_CONFIG:
1658 ret = gs_build_config_buf(req->buf, gadget->speed,
1659 wValue >> 8, wValue & 0xff,
1660 gadget->is_otg);
1661 if (ret >= 0)
1662 ret = min(wLength, (u16)ret);
1663 break;
1665 case USB_DT_STRING:
1666 /* wIndex == language code. */
1667 ret = usb_gadget_get_string(&gs_string_table,
1668 wValue & 0xff, req->buf);
1669 if (ret >= 0)
1670 ret = min(wLength, (u16)ret);
1671 break;
1673 break;
1675 case USB_REQ_SET_CONFIGURATION:
1676 if (ctrl->bRequestType != 0)
1677 break;
1678 spin_lock(&dev->dev_lock);
1679 ret = gs_set_config(dev, wValue);
1680 spin_unlock(&dev->dev_lock);
1681 break;
1683 case USB_REQ_GET_CONFIGURATION:
1684 if (ctrl->bRequestType != USB_DIR_IN)
1685 break;
1686 *(u8 *)req->buf = dev->dev_config;
1687 ret = min(wLength, (u16)1);
1688 break;
1690 case USB_REQ_SET_INTERFACE:
1691 if (ctrl->bRequestType != USB_RECIP_INTERFACE
1692 || !dev->dev_config
1693 || wIndex >= GS_MAX_NUM_INTERFACES)
1694 break;
1695 if (dev->dev_config == GS_BULK_CONFIG_ID
1696 && wIndex != GS_BULK_INTERFACE_ID)
1697 break;
1698 /* no alternate interface settings */
1699 if (wValue != 0)
1700 break;
1701 spin_lock(&dev->dev_lock);
1702 /* PXA hardware partially handles SET_INTERFACE;
1703 * we need to kluge around that interference. */
1704 if (gadget_is_pxa(gadget)) {
1705 ret = gs_set_config(dev, use_acm ?
1706 GS_ACM_CONFIG_ID : GS_BULK_CONFIG_ID);
1707 goto set_interface_done;
1709 if (dev->dev_config != GS_BULK_CONFIG_ID
1710 && wIndex == GS_CONTROL_INTERFACE_ID) {
1711 if (dev->dev_notify_ep) {
1712 usb_ep_disable(dev->dev_notify_ep);
1713 usb_ep_enable(dev->dev_notify_ep, dev->dev_notify_ep_desc);
1715 } else {
1716 usb_ep_disable(dev->dev_in_ep);
1717 usb_ep_disable(dev->dev_out_ep);
1718 usb_ep_enable(dev->dev_in_ep, dev->dev_in_ep_desc);
1719 usb_ep_enable(dev->dev_out_ep, dev->dev_out_ep_desc);
1721 ret = 0;
1722 set_interface_done:
1723 spin_unlock(&dev->dev_lock);
1724 break;
1726 case USB_REQ_GET_INTERFACE:
1727 if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)
1728 || dev->dev_config == GS_NO_CONFIG_ID)
1729 break;
1730 if (wIndex >= GS_MAX_NUM_INTERFACES
1731 || (dev->dev_config == GS_BULK_CONFIG_ID
1732 && wIndex != GS_BULK_INTERFACE_ID)) {
1733 ret = -EDOM;
1734 break;
1736 /* no alternate interface settings */
1737 *(u8 *)req->buf = 0;
1738 ret = min(wLength, (u16)1);
1739 break;
1741 default:
1742 printk(KERN_ERR "gs_setup: unknown standard request, type=%02x, request=%02x, value=%04x, index=%04x, length=%d\n",
1743 ctrl->bRequestType, ctrl->bRequest,
1744 wValue, wIndex, wLength);
1745 break;
1748 return ret;
1751 static int gs_setup_class(struct usb_gadget *gadget,
1752 const struct usb_ctrlrequest *ctrl)
1754 int ret = -EOPNOTSUPP;
1755 struct gs_dev *dev = get_gadget_data(gadget);
1756 struct gs_port *port = dev->dev_port[0]; /* ACM only has one port */
1757 struct usb_request *req = dev->dev_ctrl_req;
1758 u16 wIndex = le16_to_cpu(ctrl->wIndex);
1759 u16 wValue = le16_to_cpu(ctrl->wValue);
1760 u16 wLength = le16_to_cpu(ctrl->wLength);
1762 switch (ctrl->bRequest) {
1763 case USB_CDC_REQ_SET_LINE_CODING:
1764 ret = min(wLength,
1765 (u16)sizeof(struct usb_cdc_line_coding));
1766 if (port) {
1767 spin_lock(&port->port_lock);
1768 memcpy(&port->port_line_coding, req->buf, ret);
1769 spin_unlock(&port->port_lock);
1771 break;
1773 case USB_CDC_REQ_GET_LINE_CODING:
1774 port = dev->dev_port[0]; /* ACM only has one port */
1775 ret = min(wLength,
1776 (u16)sizeof(struct usb_cdc_line_coding));
1777 if (port) {
1778 spin_lock(&port->port_lock);
1779 memcpy(req->buf, &port->port_line_coding, ret);
1780 spin_unlock(&port->port_lock);
1782 break;
1784 case USB_CDC_REQ_SET_CONTROL_LINE_STATE:
1785 ret = 0;
1786 break;
1788 default:
1789 printk(KERN_ERR "gs_setup: unknown class request, type=%02x, request=%02x, value=%04x, index=%04x, length=%d\n",
1790 ctrl->bRequestType, ctrl->bRequest,
1791 wValue, wIndex, wLength);
1792 break;
1795 return ret;
1799 * gs_setup_complete
1801 static void gs_setup_complete(struct usb_ep *ep, struct usb_request *req)
1803 if (req->status || req->actual != req->length) {
1804 printk(KERN_ERR "gs_setup_complete: status error, status=%d, actual=%d, length=%d\n",
1805 req->status, req->actual, req->length);
1810 * gs_disconnect
1812 * Called when the device is disconnected. Frees the closed
1813 * ports and disconnects open ports. Open ports will be freed
1814 * on close. Then reallocates the ports for the next connection.
1816 static void gs_disconnect(struct usb_gadget *gadget)
1818 unsigned long flags;
1819 struct gs_dev *dev = get_gadget_data(gadget);
1821 spin_lock_irqsave(&dev->dev_lock, flags);
1823 gs_reset_config(dev);
1825 /* free closed ports and disconnect open ports */
1826 /* (open ports will be freed when closed) */
1827 gs_free_ports(dev);
1829 /* re-allocate ports for the next connection */
1830 if (gs_alloc_ports(dev, GFP_ATOMIC) != 0)
1831 printk(KERN_ERR "gs_disconnect: cannot re-allocate ports\n");
1833 spin_unlock_irqrestore(&dev->dev_lock, flags);
1835 printk(KERN_INFO "gs_disconnect: %s disconnected\n", GS_LONG_NAME);
1839 * gs_set_config
1841 * Configures the device by enabling device specific
1842 * optimizations, setting up the endpoints, allocating
1843 * read and write requests and queuing read requests.
1845 * The device lock must be held when calling this function.
1847 static int gs_set_config(struct gs_dev *dev, unsigned config)
1849 int i;
1850 int ret = 0;
1851 struct usb_gadget *gadget = dev->dev_gadget;
1852 struct usb_ep *ep;
1853 struct usb_endpoint_descriptor *ep_desc;
1854 struct usb_request *req;
1855 struct gs_req_entry *req_entry;
1857 if (dev == NULL) {
1858 printk(KERN_ERR "gs_set_config: NULL device pointer\n");
1859 return 0;
1862 if (config == dev->dev_config)
1863 return 0;
1865 gs_reset_config(dev);
1867 switch (config) {
1868 case GS_NO_CONFIG_ID:
1869 return 0;
1870 case GS_BULK_CONFIG_ID:
1871 if (use_acm)
1872 return -EINVAL;
1873 /* device specific optimizations */
1874 if (gadget_is_net2280(gadget))
1875 net2280_set_fifo_mode(gadget, 1);
1876 break;
1877 case GS_ACM_CONFIG_ID:
1878 if (!use_acm)
1879 return -EINVAL;
1880 /* device specific optimizations */
1881 if (gadget_is_net2280(gadget))
1882 net2280_set_fifo_mode(gadget, 1);
1883 break;
1884 default:
1885 return -EINVAL;
1888 dev->dev_config = config;
1890 gadget_for_each_ep(ep, gadget) {
1892 if (EP_NOTIFY_NAME
1893 && strcmp(ep->name, EP_NOTIFY_NAME) == 0) {
1894 ep_desc = GS_SPEED_SELECT(
1895 gadget->speed == USB_SPEED_HIGH,
1896 &gs_highspeed_notify_desc,
1897 &gs_fullspeed_notify_desc);
1898 ret = usb_ep_enable(ep,ep_desc);
1899 if (ret == 0) {
1900 ep->driver_data = dev;
1901 dev->dev_notify_ep = ep;
1902 dev->dev_notify_ep_desc = ep_desc;
1903 } else {
1904 printk(KERN_ERR "gs_set_config: cannot enable notify endpoint %s, ret=%d\n",
1905 ep->name, ret);
1906 goto exit_reset_config;
1910 else if (strcmp(ep->name, EP_IN_NAME) == 0) {
1911 ep_desc = GS_SPEED_SELECT(
1912 gadget->speed == USB_SPEED_HIGH,
1913 &gs_highspeed_in_desc,
1914 &gs_fullspeed_in_desc);
1915 ret = usb_ep_enable(ep,ep_desc);
1916 if (ret == 0) {
1917 ep->driver_data = dev;
1918 dev->dev_in_ep = ep;
1919 dev->dev_in_ep_desc = ep_desc;
1920 } else {
1921 printk(KERN_ERR "gs_set_config: cannot enable in endpoint %s, ret=%d\n",
1922 ep->name, ret);
1923 goto exit_reset_config;
1927 else if (strcmp(ep->name, EP_OUT_NAME) == 0) {
1928 ep_desc = GS_SPEED_SELECT(
1929 gadget->speed == USB_SPEED_HIGH,
1930 &gs_highspeed_out_desc,
1931 &gs_fullspeed_out_desc);
1932 ret = usb_ep_enable(ep,ep_desc);
1933 if (ret == 0) {
1934 ep->driver_data = dev;
1935 dev->dev_out_ep = ep;
1936 dev->dev_out_ep_desc = ep_desc;
1937 } else {
1938 printk(KERN_ERR "gs_set_config: cannot enable out endpoint %s, ret=%d\n",
1939 ep->name, ret);
1940 goto exit_reset_config;
1946 if (dev->dev_in_ep == NULL || dev->dev_out_ep == NULL
1947 || (config != GS_BULK_CONFIG_ID && dev->dev_notify_ep == NULL)) {
1948 printk(KERN_ERR "gs_set_config: cannot find endpoints\n");
1949 ret = -ENODEV;
1950 goto exit_reset_config;
1953 /* allocate and queue read requests */
1954 ep = dev->dev_out_ep;
1955 for (i=0; i<read_q_size && ret == 0; i++) {
1956 if ((req=gs_alloc_req(ep, ep->maxpacket, GFP_ATOMIC))) {
1957 req->complete = gs_read_complete;
1958 if ((ret=usb_ep_queue(ep, req, GFP_ATOMIC))) {
1959 printk(KERN_ERR "gs_set_config: cannot queue read request, ret=%d\n",
1960 ret);
1962 } else {
1963 printk(KERN_ERR "gs_set_config: cannot allocate read requests\n");
1964 ret = -ENOMEM;
1965 goto exit_reset_config;
1969 /* allocate write requests, and put on free list */
1970 ep = dev->dev_in_ep;
1971 for (i=0; i<write_q_size; i++) {
1972 if ((req_entry=gs_alloc_req_entry(ep, ep->maxpacket, GFP_ATOMIC))) {
1973 req_entry->re_req->complete = gs_write_complete;
1974 list_add(&req_entry->re_entry, &dev->dev_req_list);
1975 } else {
1976 printk(KERN_ERR "gs_set_config: cannot allocate write requests\n");
1977 ret = -ENOMEM;
1978 goto exit_reset_config;
1982 printk(KERN_INFO "gs_set_config: %s configured, %s speed %s config\n",
1983 GS_LONG_NAME,
1984 gadget->speed == USB_SPEED_HIGH ? "high" : "full",
1985 config == GS_BULK_CONFIG_ID ? "BULK" : "CDC-ACM");
1987 return 0;
1989 exit_reset_config:
1990 gs_reset_config(dev);
1991 return ret;
1995 * gs_reset_config
1997 * Mark the device as not configured, disable all endpoints,
1998 * which forces completion of pending I/O and frees queued
1999 * requests, and free the remaining write requests on the
2000 * free list.
2002 * The device lock must be held when calling this function.
2004 static void gs_reset_config(struct gs_dev *dev)
2006 struct gs_req_entry *req_entry;
2008 if (dev == NULL) {
2009 printk(KERN_ERR "gs_reset_config: NULL device pointer\n");
2010 return;
2013 if (dev->dev_config == GS_NO_CONFIG_ID)
2014 return;
2016 dev->dev_config = GS_NO_CONFIG_ID;
2018 /* free write requests on the free list */
2019 while(!list_empty(&dev->dev_req_list)) {
2020 req_entry = list_entry(dev->dev_req_list.next,
2021 struct gs_req_entry, re_entry);
2022 list_del(&req_entry->re_entry);
2023 gs_free_req_entry(dev->dev_in_ep, req_entry);
2026 /* disable endpoints, forcing completion of pending i/o; */
2027 /* completion handlers free their requests in this case */
2028 if (dev->dev_notify_ep) {
2029 usb_ep_disable(dev->dev_notify_ep);
2030 dev->dev_notify_ep = NULL;
2032 if (dev->dev_in_ep) {
2033 usb_ep_disable(dev->dev_in_ep);
2034 dev->dev_in_ep = NULL;
2036 if (dev->dev_out_ep) {
2037 usb_ep_disable(dev->dev_out_ep);
2038 dev->dev_out_ep = NULL;
2043 * gs_build_config_buf
2045 * Builds the config descriptors in the given buffer and returns the
2046 * length, or a negative error number.
2048 static int gs_build_config_buf(u8 *buf, enum usb_device_speed speed,
2049 u8 type, unsigned int index, int is_otg)
2051 int len;
2052 int high_speed;
2053 const struct usb_config_descriptor *config_desc;
2054 const struct usb_descriptor_header **function;
2056 if (index >= gs_device_desc.bNumConfigurations)
2057 return -EINVAL;
2059 /* other speed switches high and full speed */
2060 high_speed = (speed == USB_SPEED_HIGH);
2061 if (type == USB_DT_OTHER_SPEED_CONFIG)
2062 high_speed = !high_speed;
2064 if (use_acm) {
2065 config_desc = &gs_acm_config_desc;
2066 function = GS_SPEED_SELECT(high_speed,
2067 gs_acm_highspeed_function,
2068 gs_acm_fullspeed_function);
2069 } else {
2070 config_desc = &gs_bulk_config_desc;
2071 function = GS_SPEED_SELECT(high_speed,
2072 gs_bulk_highspeed_function,
2073 gs_bulk_fullspeed_function);
2076 /* for now, don't advertise srp-only devices */
2077 if (!is_otg)
2078 function++;
2080 len = usb_gadget_config_buf(config_desc, buf, GS_MAX_DESC_LEN, function);
2081 if (len < 0)
2082 return len;
2084 ((struct usb_config_descriptor *)buf)->bDescriptorType = type;
2086 return len;
2090 * gs_alloc_req
2092 * Allocate a usb_request and its buffer. Returns a pointer to the
2093 * usb_request or NULL if there is an error.
2095 static struct usb_request *
2096 gs_alloc_req(struct usb_ep *ep, unsigned int len, gfp_t kmalloc_flags)
2098 struct usb_request *req;
2100 if (ep == NULL)
2101 return NULL;
2103 req = usb_ep_alloc_request(ep, kmalloc_flags);
2105 if (req != NULL) {
2106 req->length = len;
2107 req->buf = kmalloc(len, kmalloc_flags);
2108 if (req->buf == NULL) {
2109 usb_ep_free_request(ep, req);
2110 return NULL;
2114 return req;
2118 * gs_free_req
2120 * Free a usb_request and its buffer.
2122 static void gs_free_req(struct usb_ep *ep, struct usb_request *req)
2124 if (ep != NULL && req != NULL) {
2125 kfree(req->buf);
2126 usb_ep_free_request(ep, req);
2131 * gs_alloc_req_entry
2133 * Allocates a request and its buffer, using the given
2134 * endpoint, buffer len, and kmalloc flags.
2136 static struct gs_req_entry *
2137 gs_alloc_req_entry(struct usb_ep *ep, unsigned len, gfp_t kmalloc_flags)
2139 struct gs_req_entry *req;
2141 req = kmalloc(sizeof(struct gs_req_entry), kmalloc_flags);
2142 if (req == NULL)
2143 return NULL;
2145 req->re_req = gs_alloc_req(ep, len, kmalloc_flags);
2146 if (req->re_req == NULL) {
2147 kfree(req);
2148 return NULL;
2151 req->re_req->context = req;
2153 return req;
2157 * gs_free_req_entry
2159 * Frees a request and its buffer.
2161 static void gs_free_req_entry(struct usb_ep *ep, struct gs_req_entry *req)
2163 if (ep != NULL && req != NULL) {
2164 if (req->re_req != NULL)
2165 gs_free_req(ep, req->re_req);
2166 kfree(req);
2171 * gs_alloc_ports
2173 * Allocate all ports and set the gs_dev struct to point to them.
2174 * Return 0 if successful, or a negative error number.
2176 * The device lock is normally held when calling this function.
2178 static int gs_alloc_ports(struct gs_dev *dev, gfp_t kmalloc_flags)
2180 int i;
2181 struct gs_port *port;
2183 if (dev == NULL)
2184 return -EIO;
2186 for (i=0; i<GS_NUM_PORTS; i++) {
2187 if ((port=(struct gs_port *)kmalloc(sizeof(struct gs_port), kmalloc_flags)) == NULL)
2188 return -ENOMEM;
2190 memset(port, 0, sizeof(struct gs_port));
2191 port->port_dev = dev;
2192 port->port_num = i;
2193 port->port_line_coding.dwDTERate = cpu_to_le32(GS_DEFAULT_DTE_RATE);
2194 port->port_line_coding.bCharFormat = GS_DEFAULT_CHAR_FORMAT;
2195 port->port_line_coding.bParityType = GS_DEFAULT_PARITY;
2196 port->port_line_coding.bDataBits = GS_DEFAULT_DATA_BITS;
2197 spin_lock_init(&port->port_lock);
2198 init_waitqueue_head(&port->port_write_wait);
2200 dev->dev_port[i] = port;
2203 return 0;
2207 * gs_free_ports
2209 * Free all closed ports. Open ports are disconnected by
2210 * freeing their write buffers, setting their device pointers
2211 * and the pointers to them in the device to NULL. These
2212 * ports will be freed when closed.
2214 * The device lock is normally held when calling this function.
2216 static void gs_free_ports(struct gs_dev *dev)
2218 int i;
2219 unsigned long flags;
2220 struct gs_port *port;
2222 if (dev == NULL)
2223 return;
2225 for (i=0; i<GS_NUM_PORTS; i++) {
2226 if ((port=dev->dev_port[i]) != NULL) {
2227 dev->dev_port[i] = NULL;
2229 spin_lock_irqsave(&port->port_lock, flags);
2231 if (port->port_write_buf != NULL) {
2232 gs_buf_free(port->port_write_buf);
2233 port->port_write_buf = NULL;
2236 if (port->port_open_count > 0 || port->port_in_use) {
2237 port->port_dev = NULL;
2238 wake_up_interruptible(&port->port_write_wait);
2239 if (port->port_tty) {
2240 wake_up_interruptible(&port->port_tty->read_wait);
2241 wake_up_interruptible(&port->port_tty->write_wait);
2243 spin_unlock_irqrestore(&port->port_lock, flags);
2244 } else {
2245 spin_unlock_irqrestore(&port->port_lock, flags);
2246 kfree(port);
2253 /* Circular Buffer */
2256 * gs_buf_alloc
2258 * Allocate a circular buffer and all associated memory.
2260 static struct gs_buf *gs_buf_alloc(unsigned int size, gfp_t kmalloc_flags)
2262 struct gs_buf *gb;
2264 if (size == 0)
2265 return NULL;
2267 gb = (struct gs_buf *)kmalloc(sizeof(struct gs_buf), kmalloc_flags);
2268 if (gb == NULL)
2269 return NULL;
2271 gb->buf_buf = kmalloc(size, kmalloc_flags);
2272 if (gb->buf_buf == NULL) {
2273 kfree(gb);
2274 return NULL;
2277 gb->buf_size = size;
2278 gb->buf_get = gb->buf_put = gb->buf_buf;
2280 return gb;
2284 * gs_buf_free
2286 * Free the buffer and all associated memory.
2288 void gs_buf_free(struct gs_buf *gb)
2290 if (gb) {
2291 kfree(gb->buf_buf);
2292 kfree(gb);
2297 * gs_buf_clear
2299 * Clear out all data in the circular buffer.
2301 void gs_buf_clear(struct gs_buf *gb)
2303 if (gb != NULL)
2304 gb->buf_get = gb->buf_put;
2305 /* equivalent to a get of all data available */
2309 * gs_buf_data_avail
2311 * Return the number of bytes of data available in the circular
2312 * buffer.
2314 unsigned int gs_buf_data_avail(struct gs_buf *gb)
2316 if (gb != NULL)
2317 return (gb->buf_size + gb->buf_put - gb->buf_get) % gb->buf_size;
2318 else
2319 return 0;
2323 * gs_buf_space_avail
2325 * Return the number of bytes of space available in the circular
2326 * buffer.
2328 unsigned int gs_buf_space_avail(struct gs_buf *gb)
2330 if (gb != NULL)
2331 return (gb->buf_size + gb->buf_get - gb->buf_put - 1) % gb->buf_size;
2332 else
2333 return 0;
2337 * gs_buf_put
2339 * Copy data data from a user buffer and put it into the circular buffer.
2340 * Restrict to the amount of space available.
2342 * Return the number of bytes copied.
2344 unsigned int gs_buf_put(struct gs_buf *gb, const char *buf, unsigned int count)
2346 unsigned int len;
2348 if (gb == NULL)
2349 return 0;
2351 len = gs_buf_space_avail(gb);
2352 if (count > len)
2353 count = len;
2355 if (count == 0)
2356 return 0;
2358 len = gb->buf_buf + gb->buf_size - gb->buf_put;
2359 if (count > len) {
2360 memcpy(gb->buf_put, buf, len);
2361 memcpy(gb->buf_buf, buf+len, count - len);
2362 gb->buf_put = gb->buf_buf + count - len;
2363 } else {
2364 memcpy(gb->buf_put, buf, count);
2365 if (count < len)
2366 gb->buf_put += count;
2367 else /* count == len */
2368 gb->buf_put = gb->buf_buf;
2371 return count;
2375 * gs_buf_get
2377 * Get data from the circular buffer and copy to the given buffer.
2378 * Restrict to the amount of data available.
2380 * Return the number of bytes copied.
2382 unsigned int gs_buf_get(struct gs_buf *gb, char *buf, unsigned int count)
2384 unsigned int len;
2386 if (gb == NULL)
2387 return 0;
2389 len = gs_buf_data_avail(gb);
2390 if (count > len)
2391 count = len;
2393 if (count == 0)
2394 return 0;
2396 len = gb->buf_buf + gb->buf_size - gb->buf_get;
2397 if (count > len) {
2398 memcpy(buf, gb->buf_get, len);
2399 memcpy(buf+len, gb->buf_buf, count - len);
2400 gb->buf_get = gb->buf_buf + count - len;
2401 } else {
2402 memcpy(buf, gb->buf_get, count);
2403 if (count < len)
2404 gb->buf_get += count;
2405 else /* count == len */
2406 gb->buf_get = gb->buf_buf;
2409 return count;