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>
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"
56 #define __wait_cond_interruptible(wq, condition, lock, flags, ret) \
58 wait_queue_t __wait; \
59 init_waitqueue_entry(&__wait, current); \
61 add_wait_queue(&wq, &__wait); \
63 set_current_state(TASK_INTERRUPTIBLE); \
66 if (!signal_pending(current)) { \
67 spin_unlock_irqrestore(lock, flags); \
69 spin_lock_irqsave(lock, flags); \
75 current->state = TASK_RUNNING; \
76 remove_wait_queue(&wq, &__wait); \
79 #define wait_cond_interruptible(wq, condition, lock, flags) \
83 __wait_cond_interruptible(wq, condition, lock, flags, \
88 #define __wait_cond_interruptible_timeout(wq, condition, lock, flags, \
91 signed long __timeout = timeout; \
92 wait_queue_t __wait; \
93 init_waitqueue_entry(&__wait, current); \
95 add_wait_queue(&wq, &__wait); \
97 set_current_state(TASK_INTERRUPTIBLE); \
102 if (!signal_pending(current)) { \
103 spin_unlock_irqrestore(lock, flags); \
104 __timeout = schedule_timeout(__timeout); \
105 spin_lock_irqsave(lock, flags); \
108 ret = -ERESTARTSYS; \
111 current->state = TASK_RUNNING; \
112 remove_wait_queue(&wq, &__wait); \
115 #define wait_cond_interruptible_timeout(wq, condition, lock, flags, \
120 __wait_cond_interruptible_timeout(wq, condition, lock, \
121 flags, timeout, __ret); \
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"
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))
170 #define GS_SPEED_SELECT(is_hs,hs,fs) (fs)
171 #endif /* CONFIG_USB_GADGET_DUALSPEED */
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)
184 #define gs_debug(format, arg...) \
186 #define gs_debug_level(level, format, arg...) \
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
208 /* circular buffer */
210 unsigned int buf_size
;
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 */
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
;
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 */
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
/* desciptor of notify ep */
245 struct usb_endpoint_descriptor
/* descriptor of in endpoint */
247 struct usb_endpoint_descriptor
/* descriptor of out endpoint */
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 */
259 static int __init
gs_module_init(void);
260 static void __exit
gs_module_exit(void);
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
,
281 static int gs_recv_packet(struct gs_dev
*dev
, char *packet
,
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
);
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
,
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
,
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
, int 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
, int 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
,
321 static unsigned int gs_buf_get(struct gs_buf
*gb
, char *buf
,
324 /* external functions */
325 extern int net2280_set_fifo_mode(struct usb_gadget
*gadget
, int mode
);
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
= {
351 .put_char
= gs_put_char
,
352 .flush_chars
= gs_flush_chars
,
353 .write_room
= gs_write_room
,
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
,
368 .speed
= USB_SPEED_FULL
,
369 #endif /* CONFIG_USB_GADGET_DUALSPEED */
370 .function
= GS_LONG_NAME
,
374 .disconnect
= gs_disconnect
,
376 .name
= GS_SHORT_NAME
,
377 /* .shutdown = ... */
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 */
437 .bConfigurationValue
= GS_BULK_CONFIG_ID
,
438 .iConfiguration
= GS_BULK_CONFIG_STR_ID
,
439 .bmAttributes
= USB_CONFIG_ATT_ONE
| USB_CONFIG_ATT_SELFPOWER
,
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 */
448 .bConfigurationValue
= GS_ACM_CONFIG_ID
,
449 .iConfiguration
= GS_ACM_CONFIG_STR_ID
,
450 .bmAttributes
= USB_CONFIG_ATT_ONE
| USB_CONFIG_ATT_SELFPOWER
,
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
,
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
,
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
,
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
,
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
,
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
,
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
,
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
,
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
,
616 #endif /* CONFIG_USB_GADGET_DUALSPEED */
620 MODULE_DESCRIPTION(GS_LONG_NAME
);
621 MODULE_AUTHOR("Al Borchers");
622 MODULE_LICENSE("GPL");
625 module_param(debug
, int, S_IRUGO
|S_IWUSR
);
626 MODULE_PARM_DESC(debug
, "Enable debugging, 0=off, 1=on");
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
);
647 * Register as a USB gadget driver and a tty driver.
649 static int __init
gs_module_init(void)
654 retval
= usb_gadget_register_driver(&gs_gadget_driver
);
656 printk(KERN_ERR
"gs_module_init: cannot register gadget driver, ret=%d\n", retval
);
660 gs_tty_driver
= alloc_tty_driver(GS_NUM_PORTS
);
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
);
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
);
687 printk(KERN_INFO
"gs_module_init: %s %s loaded\n", GS_LONG_NAME
, GS_VERSION_STR
);
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
);
710 static int gs_open(struct tty_struct
*tty
, struct file
*file
)
714 struct gs_port
*port
;
717 struct semaphore
*sem
;
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
);
733 printk(KERN_ERR
"gs_open: (%d,%p,%p) NULL device pointer\n",
734 port_num
, tty
, file
);
738 sem
= &gs_open_close_sem
[port_num
];
739 if (down_interruptible(sem
)) {
741 "gs_open: (%d,%p,%p) interrupted waiting for semaphore\n",
742 port_num
, tty
, file
);
746 spin_lock_irqsave(&dev
->dev_lock
, flags
);
748 if (dev
->dev_config
== GS_NO_CONFIG_ID
) {
750 "gs_open: (%d,%p,%p) device is not connected\n",
751 port_num
, tty
, file
);
753 goto exit_unlock_dev
;
756 port
= dev
->dev_port
[port_num
];
759 printk(KERN_ERR
"gs_open: (%d,%p,%p) NULL port pointer\n",
760 port_num
, tty
, file
);
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
);
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
);
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
) {
797 "gs_open: (%d,%p,%p) port disconnected (2)\n",
798 port_num
, tty
, file
);
799 port
->port_in_use
= 0;
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;
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;
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
);
835 spin_unlock_irqrestore(&port
->port_lock
, flags
);
840 spin_unlock_irqrestore(&dev
->dev_lock
, flags
);
849 static void gs_close(struct tty_struct
*tty
, struct file
*file
)
852 struct gs_port
*port
= tty
->driver_data
;
853 struct semaphore
*sem
;
856 printk(KERN_ERR
"gs_close: NULL port pointer\n");
860 gs_debug("gs_close: (%d,%p,%p)\n", port
->port_num
, tty
, file
);
862 sem
= &gs_open_close_sem
[port
->port_num
];
865 spin_lock_irqsave(&port
->port_lock
, flags
);
867 if (port
->port_open_count
== 0) {
869 "gs_close: (%d,%p,%p) port is already closed\n",
870 port
->port_num
, tty
, file
);
874 if (port
->port_open_count
> 1) {
875 --port
->port_open_count
;
879 /* free disconnected port on final close */
880 if (port
->port_dev
== NULL
) {
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 wait_cond_interruptible_timeout(port
->port_write_wait
,
894 port
->port_dev
== NULL
895 || gs_buf_data_avail(port
->port_write_buf
) == 0,
896 &port
->port_lock
, flags
, GS_CLOSE_TIMEOUT
* HZ
);
899 /* free disconnected port on final close */
900 /* (might have happened during the above sleep) */
901 if (port
->port_dev
== NULL
) {
906 gs_buf_clear(port
->port_write_buf
);
908 tty
->driver_data
= NULL
;
909 port
->port_tty
= NULL
;
910 port
->port_in_use
= 0;
912 gs_debug("gs_close: (%d,%p,%p) completed\n",
913 port
->port_num
, tty
, file
);
916 spin_unlock_irqrestore(&port
->port_lock
, flags
);
923 static int gs_write(struct tty_struct
*tty
, const unsigned char *buf
, int count
)
926 struct gs_port
*port
= tty
->driver_data
;
930 printk(KERN_ERR
"gs_write: NULL port pointer\n");
934 gs_debug("gs_write: (%d,%p) writing %d bytes\n", port
->port_num
, tty
,
940 spin_lock_irqsave(&port
->port_lock
, flags
);
942 if (port
->port_dev
== NULL
) {
943 printk(KERN_ERR
"gs_write: (%d,%p) port is not connected\n",
944 port
->port_num
, tty
);
949 if (port
->port_open_count
== 0) {
950 printk(KERN_ERR
"gs_write: (%d,%p) port is closed\n",
951 port
->port_num
, tty
);
956 count
= gs_buf_put(port
->port_write_buf
, buf
, count
);
958 spin_unlock_irqrestore(&port
->port_lock
, flags
);
962 gs_debug("gs_write: (%d,%p) wrote %d bytes\n", port
->port_num
, tty
,
968 spin_unlock_irqrestore(&port
->port_lock
, flags
);
975 static void gs_put_char(struct tty_struct
*tty
, unsigned char ch
)
978 struct gs_port
*port
= tty
->driver_data
;
981 printk(KERN_ERR
"gs_put_char: NULL port pointer\n");
985 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));
987 spin_lock_irqsave(&port
->port_lock
, flags
);
989 if (port
->port_dev
== NULL
) {
990 printk(KERN_ERR
"gs_put_char: (%d,%p) port is not connected\n",
991 port
->port_num
, tty
);
995 if (port
->port_open_count
== 0) {
996 printk(KERN_ERR
"gs_put_char: (%d,%p) port is closed\n",
997 port
->port_num
, tty
);
1001 gs_buf_put(port
->port_write_buf
, &ch
, 1);
1004 spin_unlock_irqrestore(&port
->port_lock
, flags
);
1010 static void gs_flush_chars(struct tty_struct
*tty
)
1012 unsigned long flags
;
1013 struct gs_port
*port
= tty
->driver_data
;
1016 printk(KERN_ERR
"gs_flush_chars: NULL port pointer\n");
1020 gs_debug("gs_flush_chars: (%d,%p)\n", port
->port_num
, tty
);
1022 spin_lock_irqsave(&port
->port_lock
, flags
);
1024 if (port
->port_dev
== NULL
) {
1026 "gs_flush_chars: (%d,%p) port is not connected\n",
1027 port
->port_num
, tty
);
1031 if (port
->port_open_count
== 0) {
1032 printk(KERN_ERR
"gs_flush_chars: (%d,%p) port is closed\n",
1033 port
->port_num
, tty
);
1037 spin_unlock_irqrestore(&port
->port_lock
, flags
);
1044 spin_unlock_irqrestore(&port
->port_lock
, flags
);
1050 static int gs_write_room(struct tty_struct
*tty
)
1054 unsigned long flags
;
1055 struct gs_port
*port
= tty
->driver_data
;
1061 spin_lock_irqsave(&port
->port_lock
, flags
);
1063 if (port
->port_dev
!= NULL
&& port
->port_open_count
> 0
1064 && port
->port_write_buf
!= NULL
)
1065 room
= gs_buf_space_avail(port
->port_write_buf
);
1067 spin_unlock_irqrestore(&port
->port_lock
, flags
);
1069 gs_debug("gs_write_room: (%d,%p) room=%d\n",
1070 port
->port_num
, tty
, room
);
1076 * gs_chars_in_buffer
1078 static int gs_chars_in_buffer(struct tty_struct
*tty
)
1081 unsigned long flags
;
1082 struct gs_port
*port
= tty
->driver_data
;
1087 spin_lock_irqsave(&port
->port_lock
, flags
);
1089 if (port
->port_dev
!= NULL
&& port
->port_open_count
> 0
1090 && port
->port_write_buf
!= NULL
)
1091 chars
= gs_buf_data_avail(port
->port_write_buf
);
1093 spin_unlock_irqrestore(&port
->port_lock
, flags
);
1095 gs_debug("gs_chars_in_buffer: (%d,%p) chars=%d\n",
1096 port
->port_num
, tty
, chars
);
1104 static void gs_throttle(struct tty_struct
*tty
)
1111 static void gs_unthrottle(struct tty_struct
*tty
)
1118 static void gs_break(struct tty_struct
*tty
, int break_state
)
1125 static int gs_ioctl(struct tty_struct
*tty
, struct file
*file
, unsigned int cmd
, unsigned long arg
)
1127 struct gs_port
*port
= tty
->driver_data
;
1130 printk(KERN_ERR
"gs_ioctl: NULL port pointer\n");
1134 gs_debug("gs_ioctl: (%d,%p,%p) cmd=0x%4.4x, arg=%lu\n",
1135 port
->port_num
, tty
, file
, cmd
, arg
);
1139 /* could not handle ioctl */
1140 return -ENOIOCTLCMD
;
1146 static void gs_set_termios(struct tty_struct
*tty
, struct termios
*old
)
1153 * This function finds available write requests, calls
1154 * gs_send_packet to fill these packets with data, and
1155 * continues until either there are no more write requests
1156 * available or no more data to send. This function is
1157 * run whenever data arrives or write requests are available.
1159 static int gs_send(struct gs_dev
*dev
)
1162 unsigned long flags
;
1164 struct usb_request
*req
;
1165 struct gs_req_entry
*req_entry
;
1168 printk(KERN_ERR
"gs_send: NULL device pointer\n");
1172 spin_lock_irqsave(&dev
->dev_lock
, flags
);
1174 ep
= dev
->dev_in_ep
;
1176 while(!list_empty(&dev
->dev_req_list
)) {
1178 req_entry
= list_entry(dev
->dev_req_list
.next
,
1179 struct gs_req_entry
, re_entry
);
1181 req
= req_entry
->re_req
;
1183 len
= gs_send_packet(dev
, req
->buf
, ep
->maxpacket
);
1186 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));
1187 list_del(&req_entry
->re_entry
);
1189 if ((ret
=usb_ep_queue(ep
, req
, GFP_ATOMIC
))) {
1191 "gs_send: cannot queue read request, ret=%d\n",
1201 spin_unlock_irqrestore(&dev
->dev_lock
, flags
);
1209 * If there is data to send, a packet is built in the given
1210 * buffer and the size is returned. If there is no data to
1211 * send, 0 is returned. If there is any error a negative
1212 * error number is returned.
1214 * Called during USB completion routine, on interrupt time.
1216 * We assume that disconnect will not happen until all completion
1217 * routines have completed, so we can assume that the dev_port
1218 * array does not change during the lifetime of this function.
1220 static int gs_send_packet(struct gs_dev
*dev
, char *packet
, unsigned int size
)
1223 struct gs_port
*port
;
1225 /* TEMPORARY -- only port 0 is supported right now */
1226 port
= dev
->dev_port
[0];
1230 "gs_send_packet: port=%d, NULL port pointer\n",
1235 spin_lock(&port
->port_lock
);
1237 len
= gs_buf_data_avail(port
->port_write_buf
);
1244 size
= gs_buf_get(port
->port_write_buf
, packet
, size
);
1247 wake_up_interruptible(&port
->port_tty
->write_wait
);
1250 spin_unlock(&port
->port_lock
);
1257 * Called for each USB packet received. Reads the packet
1258 * header and stuffs the data in the appropriate tty buffer.
1259 * Returns 0 if successful, or a negative error number.
1261 * Called during USB completion routine, on interrupt time.
1263 * We assume that disconnect will not happen until all completion
1264 * routines have completed, so we can assume that the dev_port
1265 * array does not change during the lifetime of this function.
1267 static int gs_recv_packet(struct gs_dev
*dev
, char *packet
, unsigned int size
)
1270 struct gs_port
*port
;
1273 /* TEMPORARY -- only port 0 is supported right now */
1274 port
= dev
->dev_port
[0];
1277 printk(KERN_ERR
"gs_recv_packet: port=%d, NULL port pointer\n",
1282 spin_lock(&port
->port_lock
);
1284 if (port
->port_open_count
== 0) {
1285 printk(KERN_ERR
"gs_recv_packet: port=%d, port is closed\n",
1291 if (port
->port_tty
== NULL
) {
1292 printk(KERN_ERR
"gs_recv_packet: port=%d, NULL tty pointer\n",
1298 if (port
->port_tty
->magic
!= TTY_MAGIC
) {
1299 printk(KERN_ERR
"gs_recv_packet: port=%d, bad tty magic\n",
1305 len
= (unsigned int)(TTY_FLIPBUF_SIZE
- port
->port_tty
->flip
.count
);
1310 memcpy(port
->port_tty
->flip
.char_buf_ptr
, packet
, size
);
1311 port
->port_tty
->flip
.char_buf_ptr
+= size
;
1312 port
->port_tty
->flip
.count
+= size
;
1313 tty_flip_buffer_push(port
->port_tty
);
1314 wake_up_interruptible(&port
->port_tty
->read_wait
);
1320 spin_unlock(&port
->port_lock
);
1327 static void gs_read_complete(struct usb_ep
*ep
, struct usb_request
*req
)
1330 struct gs_dev
*dev
= ep
->driver_data
;
1333 printk(KERN_ERR
"gs_read_complete: NULL device pointer\n");
1337 switch(req
->status
) {
1339 /* normal completion */
1340 gs_recv_packet(dev
, req
->buf
, req
->actual
);
1342 req
->length
= ep
->maxpacket
;
1343 if ((ret
=usb_ep_queue(ep
, req
, GFP_ATOMIC
))) {
1345 "gs_read_complete: cannot queue read request, ret=%d\n",
1352 gs_debug("gs_read_complete: shutdown\n");
1353 gs_free_req(ep
, req
);
1359 "gs_read_complete: unexpected status error, status=%d\n",
1369 static void gs_write_complete(struct usb_ep
*ep
, struct usb_request
*req
)
1371 struct gs_dev
*dev
= ep
->driver_data
;
1372 struct gs_req_entry
*gs_req
= req
->context
;
1375 printk(KERN_ERR
"gs_write_complete: NULL device pointer\n");
1379 switch(req
->status
) {
1381 /* normal completion */
1383 if (gs_req
== NULL
) {
1385 "gs_write_complete: NULL request pointer\n");
1389 spin_lock(&dev
->dev_lock
);
1390 list_add(&gs_req
->re_entry
, &dev
->dev_req_list
);
1391 spin_unlock(&dev
->dev_lock
);
1399 gs_debug("gs_write_complete: shutdown\n");
1400 gs_free_req(ep
, req
);
1405 "gs_write_complete: unexpected status error, status=%d\n",
1417 * Called on module load. Allocates and initializes the device
1418 * structure and a control request.
1420 static int gs_bind(struct usb_gadget
*gadget
)
1426 /* device specific */
1427 if (gadget_is_net2280(gadget
)) {
1428 gs_device_desc
.bcdDevice
=
1429 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0001);
1430 } else if (gadget_is_pxa(gadget
)) {
1431 gs_device_desc
.bcdDevice
=
1432 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0002);
1433 } else if (gadget_is_sh(gadget
)) {
1434 gs_device_desc
.bcdDevice
=
1435 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0003);
1436 /* sh doesn't support multiple interfaces or configs */
1438 } else if (gadget_is_sa1100(gadget
)) {
1439 gs_device_desc
.bcdDevice
=
1440 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0004);
1441 /* sa1100 doesn't support necessary endpoints */
1443 } else if (gadget_is_goku(gadget
)) {
1444 gs_device_desc
.bcdDevice
=
1445 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0005);
1446 } else if (gadget_is_mq11xx(gadget
)) {
1447 gs_device_desc
.bcdDevice
=
1448 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0006);
1449 } else if (gadget_is_omap(gadget
)) {
1450 gs_device_desc
.bcdDevice
=
1451 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0007);
1452 } else if (gadget_is_lh7a40x(gadget
)) {
1453 gs_device_desc
.bcdDevice
=
1454 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0008);
1455 } else if (gadget_is_n9604(gadget
)) {
1456 gs_device_desc
.bcdDevice
=
1457 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0009);
1458 } else if (gadget_is_pxa27x(gadget
)) {
1459 gs_device_desc
.bcdDevice
=
1460 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0011);
1461 } else if (gadget_is_s3c2410(gadget
)) {
1462 gs_device_desc
.bcdDevice
=
1463 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0012);
1464 } else if (gadget_is_at91(gadget
)) {
1465 gs_device_desc
.bcdDevice
=
1466 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0013);
1468 printk(KERN_WARNING
"gs_bind: controller '%s' not recognized\n",
1470 /* unrecognized, but safe unless bulk is REALLY quirky */
1471 gs_device_desc
.bcdDevice
=
1472 __constant_cpu_to_le16(GS_VERSION_NUM
|0x0099);
1475 usb_ep_autoconfig_reset(gadget
);
1477 ep
= usb_ep_autoconfig(gadget
, &gs_fullspeed_in_desc
);
1480 EP_IN_NAME
= ep
->name
;
1481 ep
->driver_data
= ep
; /* claim the endpoint */
1483 ep
= usb_ep_autoconfig(gadget
, &gs_fullspeed_out_desc
);
1486 EP_OUT_NAME
= ep
->name
;
1487 ep
->driver_data
= ep
; /* claim the endpoint */
1490 ep
= usb_ep_autoconfig(gadget
, &gs_fullspeed_notify_desc
);
1492 printk(KERN_ERR
"gs_bind: cannot run ACM on %s\n", gadget
->name
);
1495 gs_device_desc
.idProduct
= __constant_cpu_to_le16(
1497 EP_NOTIFY_NAME
= ep
->name
;
1498 ep
->driver_data
= ep
; /* claim the endpoint */
1501 gs_device_desc
.bDeviceClass
= use_acm
1502 ? USB_CLASS_COMM
: USB_CLASS_VENDOR_SPEC
;
1503 gs_device_desc
.bMaxPacketSize0
= gadget
->ep0
->maxpacket
;
1505 #ifdef CONFIG_USB_GADGET_DUALSPEED
1506 gs_qualifier_desc
.bDeviceClass
= use_acm
1507 ? USB_CLASS_COMM
: USB_CLASS_VENDOR_SPEC
;
1508 /* assume ep0 uses the same packet size for both speeds */
1509 gs_qualifier_desc
.bMaxPacketSize0
= gs_device_desc
.bMaxPacketSize0
;
1510 /* assume endpoints are dual-speed */
1511 gs_highspeed_notify_desc
.bEndpointAddress
=
1512 gs_fullspeed_notify_desc
.bEndpointAddress
;
1513 gs_highspeed_in_desc
.bEndpointAddress
=
1514 gs_fullspeed_in_desc
.bEndpointAddress
;
1515 gs_highspeed_out_desc
.bEndpointAddress
=
1516 gs_fullspeed_out_desc
.bEndpointAddress
;
1517 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1519 usb_gadget_set_selfpowered(gadget
);
1521 if (gadget
->is_otg
) {
1522 gs_otg_descriptor
.bmAttributes
|= USB_OTG_HNP
,
1523 gs_bulk_config_desc
.bmAttributes
|= USB_CONFIG_ATT_WAKEUP
;
1524 gs_acm_config_desc
.bmAttributes
|= USB_CONFIG_ATT_WAKEUP
;
1527 gs_device
= dev
= kmalloc(sizeof(struct gs_dev
), GFP_KERNEL
);
1531 snprintf(manufacturer
, sizeof(manufacturer
), "%s %s with %s",
1532 system_utsname
.sysname
, system_utsname
.release
,
1535 memset(dev
, 0, sizeof(struct gs_dev
));
1536 dev
->dev_gadget
= gadget
;
1537 spin_lock_init(&dev
->dev_lock
);
1538 INIT_LIST_HEAD(&dev
->dev_req_list
);
1539 set_gadget_data(gadget
, dev
);
1541 if ((ret
=gs_alloc_ports(dev
, GFP_KERNEL
)) != 0) {
1542 printk(KERN_ERR
"gs_bind: cannot allocate ports\n");
1547 /* preallocate control response and buffer */
1548 dev
->dev_ctrl_req
= gs_alloc_req(gadget
->ep0
, GS_MAX_DESC_LEN
,
1550 if (dev
->dev_ctrl_req
== NULL
) {
1554 dev
->dev_ctrl_req
->complete
= gs_setup_complete
;
1556 gadget
->ep0
->driver_data
= dev
;
1558 printk(KERN_INFO
"gs_bind: %s %s bound\n",
1559 GS_LONG_NAME
, GS_VERSION_STR
);
1564 printk(KERN_ERR
"gs_bind: cannot autoconfigure on %s\n", gadget
->name
);
1571 * Called on module unload. Frees the control request and device
1574 static void gs_unbind(struct usb_gadget
*gadget
)
1576 struct gs_dev
*dev
= get_gadget_data(gadget
);
1580 /* read/write requests already freed, only control request remains */
1582 if (dev
->dev_ctrl_req
!= NULL
) {
1583 gs_free_req(gadget
->ep0
, dev
->dev_ctrl_req
);
1584 dev
->dev_ctrl_req
= NULL
;
1588 set_gadget_data(gadget
, NULL
);
1591 printk(KERN_INFO
"gs_unbind: %s %s unbound\n", GS_LONG_NAME
,
1598 * Implements all the control endpoint functionality that's not
1599 * handled in hardware or the hardware driver.
1601 * Returns the size of the data sent to the host, or a negative
1604 static int gs_setup(struct usb_gadget
*gadget
,
1605 const struct usb_ctrlrequest
*ctrl
)
1607 int ret
= -EOPNOTSUPP
;
1608 struct gs_dev
*dev
= get_gadget_data(gadget
);
1609 struct usb_request
*req
= dev
->dev_ctrl_req
;
1610 u16 wIndex
= ctrl
->wIndex
;
1611 u16 wValue
= ctrl
->wValue
;
1612 u16 wLength
= ctrl
->wLength
;
1614 switch (ctrl
->bRequestType
& USB_TYPE_MASK
) {
1615 case USB_TYPE_STANDARD
:
1616 ret
= gs_setup_standard(gadget
,ctrl
);
1619 case USB_TYPE_CLASS
:
1620 ret
= gs_setup_class(gadget
,ctrl
);
1624 printk(KERN_ERR
"gs_setup: unknown request, type=%02x, request=%02x, value=%04x, index=%04x, length=%d\n",
1625 ctrl
->bRequestType
, ctrl
->bRequest
,
1626 wValue
, wIndex
, wLength
);
1630 /* respond with data transfer before status phase? */
1633 req
->zero
= ret
< wLength
1634 && (ret
% gadget
->ep0
->maxpacket
) == 0;
1635 ret
= usb_ep_queue(gadget
->ep0
, req
, GFP_ATOMIC
);
1637 printk(KERN_ERR
"gs_setup: cannot queue response, ret=%d\n",
1640 gs_setup_complete(gadget
->ep0
, req
);
1644 /* device either stalls (ret < 0) or reports success */
1648 static int gs_setup_standard(struct usb_gadget
*gadget
,
1649 const struct usb_ctrlrequest
*ctrl
)
1651 int ret
= -EOPNOTSUPP
;
1652 struct gs_dev
*dev
= get_gadget_data(gadget
);
1653 struct usb_request
*req
= dev
->dev_ctrl_req
;
1654 u16 wIndex
= ctrl
->wIndex
;
1655 u16 wValue
= ctrl
->wValue
;
1656 u16 wLength
= ctrl
->wLength
;
1658 switch (ctrl
->bRequest
) {
1659 case USB_REQ_GET_DESCRIPTOR
:
1660 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1663 switch (wValue
>> 8) {
1666 (u16
)sizeof(struct usb_device_descriptor
));
1667 memcpy(req
->buf
, &gs_device_desc
, ret
);
1670 #ifdef CONFIG_USB_GADGET_DUALSPEED
1671 case USB_DT_DEVICE_QUALIFIER
:
1672 if (!gadget
->is_dualspeed
)
1675 (u16
)sizeof(struct usb_qualifier_descriptor
));
1676 memcpy(req
->buf
, &gs_qualifier_desc
, ret
);
1679 case USB_DT_OTHER_SPEED_CONFIG
:
1680 if (!gadget
->is_dualspeed
)
1683 #endif /* CONFIG_USB_GADGET_DUALSPEED */
1685 ret
= gs_build_config_buf(req
->buf
, gadget
->speed
,
1686 wValue
>> 8, wValue
& 0xff,
1689 ret
= min(wLength
, (u16
)ret
);
1693 /* wIndex == language code. */
1694 ret
= usb_gadget_get_string(&gs_string_table
,
1695 wValue
& 0xff, req
->buf
);
1697 ret
= min(wLength
, (u16
)ret
);
1702 case USB_REQ_SET_CONFIGURATION
:
1703 if (ctrl
->bRequestType
!= 0)
1705 spin_lock(&dev
->dev_lock
);
1706 ret
= gs_set_config(dev
, wValue
);
1707 spin_unlock(&dev
->dev_lock
);
1710 case USB_REQ_GET_CONFIGURATION
:
1711 if (ctrl
->bRequestType
!= USB_DIR_IN
)
1713 *(u8
*)req
->buf
= dev
->dev_config
;
1714 ret
= min(wLength
, (u16
)1);
1717 case USB_REQ_SET_INTERFACE
:
1718 if (ctrl
->bRequestType
!= USB_RECIP_INTERFACE
1720 || wIndex
>= GS_MAX_NUM_INTERFACES
)
1722 if (dev
->dev_config
== GS_BULK_CONFIG_ID
1723 && wIndex
!= GS_BULK_INTERFACE_ID
)
1725 /* no alternate interface settings */
1728 spin_lock(&dev
->dev_lock
);
1729 /* PXA hardware partially handles SET_INTERFACE;
1730 * we need to kluge around that interference. */
1731 if (gadget_is_pxa(gadget
)) {
1732 ret
= gs_set_config(dev
, use_acm
?
1733 GS_ACM_CONFIG_ID
: GS_BULK_CONFIG_ID
);
1734 goto set_interface_done
;
1736 if (dev
->dev_config
!= GS_BULK_CONFIG_ID
1737 && wIndex
== GS_CONTROL_INTERFACE_ID
) {
1738 if (dev
->dev_notify_ep
) {
1739 usb_ep_disable(dev
->dev_notify_ep
);
1740 usb_ep_enable(dev
->dev_notify_ep
, dev
->dev_notify_ep_desc
);
1743 usb_ep_disable(dev
->dev_in_ep
);
1744 usb_ep_disable(dev
->dev_out_ep
);
1745 usb_ep_enable(dev
->dev_in_ep
, dev
->dev_in_ep_desc
);
1746 usb_ep_enable(dev
->dev_out_ep
, dev
->dev_out_ep_desc
);
1750 spin_unlock(&dev
->dev_lock
);
1753 case USB_REQ_GET_INTERFACE
:
1754 if (ctrl
->bRequestType
!= (USB_DIR_IN
|USB_RECIP_INTERFACE
)
1755 || dev
->dev_config
== GS_NO_CONFIG_ID
)
1757 if (wIndex
>= GS_MAX_NUM_INTERFACES
1758 || (dev
->dev_config
== GS_BULK_CONFIG_ID
1759 && wIndex
!= GS_BULK_INTERFACE_ID
)) {
1763 /* no alternate interface settings */
1764 *(u8
*)req
->buf
= 0;
1765 ret
= min(wLength
, (u16
)1);
1769 printk(KERN_ERR
"gs_setup: unknown standard request, type=%02x, request=%02x, value=%04x, index=%04x, length=%d\n",
1770 ctrl
->bRequestType
, ctrl
->bRequest
,
1771 wValue
, wIndex
, wLength
);
1778 static int gs_setup_class(struct usb_gadget
*gadget
,
1779 const struct usb_ctrlrequest
*ctrl
)
1781 int ret
= -EOPNOTSUPP
;
1782 struct gs_dev
*dev
= get_gadget_data(gadget
);
1783 struct gs_port
*port
= dev
->dev_port
[0]; /* ACM only has one port */
1784 struct usb_request
*req
= dev
->dev_ctrl_req
;
1785 u16 wIndex
= ctrl
->wIndex
;
1786 u16 wValue
= ctrl
->wValue
;
1787 u16 wLength
= ctrl
->wLength
;
1789 switch (ctrl
->bRequest
) {
1790 case USB_CDC_REQ_SET_LINE_CODING
:
1792 (u16
)sizeof(struct usb_cdc_line_coding
));
1794 spin_lock(&port
->port_lock
);
1795 memcpy(&port
->port_line_coding
, req
->buf
, ret
);
1796 spin_unlock(&port
->port_lock
);
1800 case USB_CDC_REQ_GET_LINE_CODING
:
1801 port
= dev
->dev_port
[0]; /* ACM only has one port */
1803 (u16
)sizeof(struct usb_cdc_line_coding
));
1805 spin_lock(&port
->port_lock
);
1806 memcpy(req
->buf
, &port
->port_line_coding
, ret
);
1807 spin_unlock(&port
->port_lock
);
1811 case USB_CDC_REQ_SET_CONTROL_LINE_STATE
:
1816 printk(KERN_ERR
"gs_setup: unknown class request, type=%02x, request=%02x, value=%04x, index=%04x, length=%d\n",
1817 ctrl
->bRequestType
, ctrl
->bRequest
,
1818 wValue
, wIndex
, wLength
);
1828 static void gs_setup_complete(struct usb_ep
*ep
, struct usb_request
*req
)
1830 if (req
->status
|| req
->actual
!= req
->length
) {
1831 printk(KERN_ERR
"gs_setup_complete: status error, status=%d, actual=%d, length=%d\n",
1832 req
->status
, req
->actual
, req
->length
);
1839 * Called when the device is disconnected. Frees the closed
1840 * ports and disconnects open ports. Open ports will be freed
1841 * on close. Then reallocates the ports for the next connection.
1843 static void gs_disconnect(struct usb_gadget
*gadget
)
1845 unsigned long flags
;
1846 struct gs_dev
*dev
= get_gadget_data(gadget
);
1848 spin_lock_irqsave(&dev
->dev_lock
, flags
);
1850 gs_reset_config(dev
);
1852 /* free closed ports and disconnect open ports */
1853 /* (open ports will be freed when closed) */
1856 /* re-allocate ports for the next connection */
1857 if (gs_alloc_ports(dev
, GFP_ATOMIC
) != 0)
1858 printk(KERN_ERR
"gs_disconnect: cannot re-allocate ports\n");
1860 spin_unlock_irqrestore(&dev
->dev_lock
, flags
);
1862 printk(KERN_INFO
"gs_disconnect: %s disconnected\n", GS_LONG_NAME
);
1868 * Configures the device by enabling device specific
1869 * optimizations, setting up the endpoints, allocating
1870 * read and write requests and queuing read requests.
1872 * The device lock must be held when calling this function.
1874 static int gs_set_config(struct gs_dev
*dev
, unsigned config
)
1878 struct usb_gadget
*gadget
= dev
->dev_gadget
;
1880 struct usb_endpoint_descriptor
*ep_desc
;
1881 struct usb_request
*req
;
1882 struct gs_req_entry
*req_entry
;
1885 printk(KERN_ERR
"gs_set_config: NULL device pointer\n");
1889 if (config
== dev
->dev_config
)
1892 gs_reset_config(dev
);
1895 case GS_NO_CONFIG_ID
:
1897 case GS_BULK_CONFIG_ID
:
1900 /* device specific optimizations */
1901 if (gadget_is_net2280(gadget
))
1902 net2280_set_fifo_mode(gadget
, 1);
1904 case GS_ACM_CONFIG_ID
:
1907 /* device specific optimizations */
1908 if (gadget_is_net2280(gadget
))
1909 net2280_set_fifo_mode(gadget
, 1);
1915 dev
->dev_config
= config
;
1917 gadget_for_each_ep(ep
, gadget
) {
1920 && strcmp(ep
->name
, EP_NOTIFY_NAME
) == 0) {
1921 ep_desc
= GS_SPEED_SELECT(
1922 gadget
->speed
== USB_SPEED_HIGH
,
1923 &gs_highspeed_notify_desc
,
1924 &gs_fullspeed_notify_desc
);
1925 ret
= usb_ep_enable(ep
,ep_desc
);
1927 ep
->driver_data
= dev
;
1928 dev
->dev_notify_ep
= ep
;
1929 dev
->dev_notify_ep_desc
= ep_desc
;
1931 printk(KERN_ERR
"gs_set_config: cannot enable notify endpoint %s, ret=%d\n",
1933 goto exit_reset_config
;
1937 else if (strcmp(ep
->name
, EP_IN_NAME
) == 0) {
1938 ep_desc
= GS_SPEED_SELECT(
1939 gadget
->speed
== USB_SPEED_HIGH
,
1940 &gs_highspeed_in_desc
,
1941 &gs_fullspeed_in_desc
);
1942 ret
= usb_ep_enable(ep
,ep_desc
);
1944 ep
->driver_data
= dev
;
1945 dev
->dev_in_ep
= ep
;
1946 dev
->dev_in_ep_desc
= ep_desc
;
1948 printk(KERN_ERR
"gs_set_config: cannot enable in endpoint %s, ret=%d\n",
1950 goto exit_reset_config
;
1954 else if (strcmp(ep
->name
, EP_OUT_NAME
) == 0) {
1955 ep_desc
= GS_SPEED_SELECT(
1956 gadget
->speed
== USB_SPEED_HIGH
,
1957 &gs_highspeed_out_desc
,
1958 &gs_fullspeed_out_desc
);
1959 ret
= usb_ep_enable(ep
,ep_desc
);
1961 ep
->driver_data
= dev
;
1962 dev
->dev_out_ep
= ep
;
1963 dev
->dev_out_ep_desc
= ep_desc
;
1965 printk(KERN_ERR
"gs_set_config: cannot enable out endpoint %s, ret=%d\n",
1967 goto exit_reset_config
;
1973 if (dev
->dev_in_ep
== NULL
|| dev
->dev_out_ep
== NULL
1974 || (config
!= GS_BULK_CONFIG_ID
&& dev
->dev_notify_ep
== NULL
)) {
1975 printk(KERN_ERR
"gs_set_config: cannot find endpoints\n");
1977 goto exit_reset_config
;
1980 /* allocate and queue read requests */
1981 ep
= dev
->dev_out_ep
;
1982 for (i
=0; i
<read_q_size
&& ret
== 0; i
++) {
1983 if ((req
=gs_alloc_req(ep
, ep
->maxpacket
, GFP_ATOMIC
))) {
1984 req
->complete
= gs_read_complete
;
1985 if ((ret
=usb_ep_queue(ep
, req
, GFP_ATOMIC
))) {
1986 printk(KERN_ERR
"gs_set_config: cannot queue read request, ret=%d\n",
1990 printk(KERN_ERR
"gs_set_config: cannot allocate read requests\n");
1992 goto exit_reset_config
;
1996 /* allocate write requests, and put on free list */
1997 ep
= dev
->dev_in_ep
;
1998 for (i
=0; i
<write_q_size
; i
++) {
1999 if ((req_entry
=gs_alloc_req_entry(ep
, ep
->maxpacket
, GFP_ATOMIC
))) {
2000 req_entry
->re_req
->complete
= gs_write_complete
;
2001 list_add(&req_entry
->re_entry
, &dev
->dev_req_list
);
2003 printk(KERN_ERR
"gs_set_config: cannot allocate write requests\n");
2005 goto exit_reset_config
;
2009 printk(KERN_INFO
"gs_set_config: %s configured, %s speed %s config\n",
2011 gadget
->speed
== USB_SPEED_HIGH
? "high" : "full",
2012 config
== GS_BULK_CONFIG_ID
? "BULK" : "CDC-ACM");
2017 gs_reset_config(dev
);
2024 * Mark the device as not configured, disable all endpoints,
2025 * which forces completion of pending I/O and frees queued
2026 * requests, and free the remaining write requests on the
2029 * The device lock must be held when calling this function.
2031 static void gs_reset_config(struct gs_dev
*dev
)
2033 struct gs_req_entry
*req_entry
;
2036 printk(KERN_ERR
"gs_reset_config: NULL device pointer\n");
2040 if (dev
->dev_config
== GS_NO_CONFIG_ID
)
2043 dev
->dev_config
= GS_NO_CONFIG_ID
;
2045 /* free write requests on the free list */
2046 while(!list_empty(&dev
->dev_req_list
)) {
2047 req_entry
= list_entry(dev
->dev_req_list
.next
,
2048 struct gs_req_entry
, re_entry
);
2049 list_del(&req_entry
->re_entry
);
2050 gs_free_req_entry(dev
->dev_in_ep
, req_entry
);
2053 /* disable endpoints, forcing completion of pending i/o; */
2054 /* completion handlers free their requests in this case */
2055 if (dev
->dev_notify_ep
) {
2056 usb_ep_disable(dev
->dev_notify_ep
);
2057 dev
->dev_notify_ep
= NULL
;
2059 if (dev
->dev_in_ep
) {
2060 usb_ep_disable(dev
->dev_in_ep
);
2061 dev
->dev_in_ep
= NULL
;
2063 if (dev
->dev_out_ep
) {
2064 usb_ep_disable(dev
->dev_out_ep
);
2065 dev
->dev_out_ep
= NULL
;
2070 * gs_build_config_buf
2072 * Builds the config descriptors in the given buffer and returns the
2073 * length, or a negative error number.
2075 static int gs_build_config_buf(u8
*buf
, enum usb_device_speed speed
,
2076 u8 type
, unsigned int index
, int is_otg
)
2080 const struct usb_config_descriptor
*config_desc
;
2081 const struct usb_descriptor_header
**function
;
2083 if (index
>= gs_device_desc
.bNumConfigurations
)
2086 /* other speed switches high and full speed */
2087 high_speed
= (speed
== USB_SPEED_HIGH
);
2088 if (type
== USB_DT_OTHER_SPEED_CONFIG
)
2089 high_speed
= !high_speed
;
2092 config_desc
= &gs_acm_config_desc
;
2093 function
= GS_SPEED_SELECT(high_speed
,
2094 gs_acm_highspeed_function
,
2095 gs_acm_fullspeed_function
);
2097 config_desc
= &gs_bulk_config_desc
;
2098 function
= GS_SPEED_SELECT(high_speed
,
2099 gs_bulk_highspeed_function
,
2100 gs_bulk_fullspeed_function
);
2103 /* for now, don't advertise srp-only devices */
2107 len
= usb_gadget_config_buf(config_desc
, buf
, GS_MAX_DESC_LEN
, function
);
2111 ((struct usb_config_descriptor
*)buf
)->bDescriptorType
= type
;
2119 * Allocate a usb_request and its buffer. Returns a pointer to the
2120 * usb_request or NULL if there is an error.
2122 static struct usb_request
*gs_alloc_req(struct usb_ep
*ep
, unsigned int len
, int kmalloc_flags
)
2124 struct usb_request
*req
;
2129 req
= usb_ep_alloc_request(ep
, kmalloc_flags
);
2133 req
->buf
= kmalloc(len
, kmalloc_flags
);
2134 if (req
->buf
== NULL
) {
2135 usb_ep_free_request(ep
, req
);
2146 * Free a usb_request and its buffer.
2148 static void gs_free_req(struct usb_ep
*ep
, struct usb_request
*req
)
2150 if (ep
!= NULL
&& req
!= NULL
) {
2152 usb_ep_free_request(ep
, req
);
2157 * gs_alloc_req_entry
2159 * Allocates a request and its buffer, using the given
2160 * endpoint, buffer len, and kmalloc flags.
2162 static struct gs_req_entry
*gs_alloc_req_entry(struct usb_ep
*ep
, unsigned len
, int kmalloc_flags
)
2164 struct gs_req_entry
*req
;
2166 req
= kmalloc(sizeof(struct gs_req_entry
), kmalloc_flags
);
2170 req
->re_req
= gs_alloc_req(ep
, len
, kmalloc_flags
);
2171 if (req
->re_req
== NULL
) {
2176 req
->re_req
->context
= req
;
2184 * Frees a request and its buffer.
2186 static void gs_free_req_entry(struct usb_ep
*ep
, struct gs_req_entry
*req
)
2188 if (ep
!= NULL
&& req
!= NULL
) {
2189 if (req
->re_req
!= NULL
)
2190 gs_free_req(ep
, req
->re_req
);
2198 * Allocate all ports and set the gs_dev struct to point to them.
2199 * Return 0 if successful, or a negative error number.
2201 * The device lock is normally held when calling this function.
2203 static int gs_alloc_ports(struct gs_dev
*dev
, int kmalloc_flags
)
2206 struct gs_port
*port
;
2211 for (i
=0; i
<GS_NUM_PORTS
; i
++) {
2212 if ((port
=(struct gs_port
*)kmalloc(sizeof(struct gs_port
), kmalloc_flags
)) == NULL
)
2215 memset(port
, 0, sizeof(struct gs_port
));
2216 port
->port_dev
= dev
;
2218 port
->port_line_coding
.dwDTERate
= cpu_to_le32(GS_DEFAULT_DTE_RATE
);
2219 port
->port_line_coding
.bCharFormat
= GS_DEFAULT_CHAR_FORMAT
;
2220 port
->port_line_coding
.bParityType
= GS_DEFAULT_PARITY
;
2221 port
->port_line_coding
.bDataBits
= GS_DEFAULT_DATA_BITS
;
2222 spin_lock_init(&port
->port_lock
);
2223 init_waitqueue_head(&port
->port_write_wait
);
2225 dev
->dev_port
[i
] = port
;
2234 * Free all closed ports. Open ports are disconnected by
2235 * freeing their write buffers, setting their device pointers
2236 * and the pointers to them in the device to NULL. These
2237 * ports will be freed when closed.
2239 * The device lock is normally held when calling this function.
2241 static void gs_free_ports(struct gs_dev
*dev
)
2244 unsigned long flags
;
2245 struct gs_port
*port
;
2250 for (i
=0; i
<GS_NUM_PORTS
; i
++) {
2251 if ((port
=dev
->dev_port
[i
]) != NULL
) {
2252 dev
->dev_port
[i
] = NULL
;
2254 spin_lock_irqsave(&port
->port_lock
, flags
);
2256 if (port
->port_write_buf
!= NULL
) {
2257 gs_buf_free(port
->port_write_buf
);
2258 port
->port_write_buf
= NULL
;
2261 if (port
->port_open_count
> 0 || port
->port_in_use
) {
2262 port
->port_dev
= NULL
;
2263 wake_up_interruptible(&port
->port_write_wait
);
2264 if (port
->port_tty
) {
2265 wake_up_interruptible(&port
->port_tty
->read_wait
);
2266 wake_up_interruptible(&port
->port_tty
->write_wait
);
2268 spin_unlock_irqrestore(&port
->port_lock
, flags
);
2270 spin_unlock_irqrestore(&port
->port_lock
, flags
);
2278 /* Circular Buffer */
2283 * Allocate a circular buffer and all associated memory.
2285 static struct gs_buf
*gs_buf_alloc(unsigned int size
, int kmalloc_flags
)
2292 gb
= (struct gs_buf
*)kmalloc(sizeof(struct gs_buf
), kmalloc_flags
);
2296 gb
->buf_buf
= kmalloc(size
, kmalloc_flags
);
2297 if (gb
->buf_buf
== NULL
) {
2302 gb
->buf_size
= size
;
2303 gb
->buf_get
= gb
->buf_put
= gb
->buf_buf
;
2311 * Free the buffer and all associated memory.
2313 void gs_buf_free(struct gs_buf
*gb
)
2316 if (gb
->buf_buf
!= NULL
)
2325 * Clear out all data in the circular buffer.
2327 void gs_buf_clear(struct gs_buf
*gb
)
2330 gb
->buf_get
= gb
->buf_put
;
2331 /* equivalent to a get of all data available */
2337 * Return the number of bytes of data available in the circular
2340 unsigned int gs_buf_data_avail(struct gs_buf
*gb
)
2343 return (gb
->buf_size
+ gb
->buf_put
- gb
->buf_get
) % gb
->buf_size
;
2349 * gs_buf_space_avail
2351 * Return the number of bytes of space available in the circular
2354 unsigned int gs_buf_space_avail(struct gs_buf
*gb
)
2357 return (gb
->buf_size
+ gb
->buf_get
- gb
->buf_put
- 1) % gb
->buf_size
;
2365 * Copy data data from a user buffer and put it into the circular buffer.
2366 * Restrict to the amount of space available.
2368 * Return the number of bytes copied.
2370 unsigned int gs_buf_put(struct gs_buf
*gb
, const char *buf
, unsigned int count
)
2377 len
= gs_buf_space_avail(gb
);
2384 len
= gb
->buf_buf
+ gb
->buf_size
- gb
->buf_put
;
2386 memcpy(gb
->buf_put
, buf
, len
);
2387 memcpy(gb
->buf_buf
, buf
+len
, count
- len
);
2388 gb
->buf_put
= gb
->buf_buf
+ count
- len
;
2390 memcpy(gb
->buf_put
, buf
, count
);
2392 gb
->buf_put
+= count
;
2393 else /* count == len */
2394 gb
->buf_put
= gb
->buf_buf
;
2403 * Get data from the circular buffer and copy to the given buffer.
2404 * Restrict to the amount of data available.
2406 * Return the number of bytes copied.
2408 unsigned int gs_buf_get(struct gs_buf
*gb
, char *buf
, unsigned int count
)
2415 len
= gs_buf_data_avail(gb
);
2422 len
= gb
->buf_buf
+ gb
->buf_size
- gb
->buf_get
;
2424 memcpy(buf
, gb
->buf_get
, len
);
2425 memcpy(buf
+len
, gb
->buf_buf
, count
- len
);
2426 gb
->buf_get
= gb
->buf_buf
+ count
- len
;
2428 memcpy(buf
, gb
->buf_get
, count
);
2430 gb
->buf_get
+= count
;
2431 else /* count == len */
2432 gb
->buf_get
= gb
->buf_buf
;