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