USB: BandRich BandLuxe HSDPA Data Card Driver
[safe/jmp/linux-2.6] / drivers / usb / serial / option.c
1 /*
2   USB Driver for GSM modems
3
4   Copyright (C) 2005  Matthias Urlichs <smurf@smurf.noris.de>
5
6   This driver is free software; you can redistribute it and/or modify
7   it under the terms of Version 2 of the GNU General Public License as
8   published by the Free Software Foundation.
9
10   Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
11
12   History: see the git log.
13
14   Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
15
16   This driver exists because the "normal" serial driver doesn't work too well
17   with GSM modems. Issues:
18   - data loss -- one single Receive URB is not nearly enough
19   - nonstandard flow (Option devices) control
20   - controlling the baud rate doesn't make sense
21
22   This driver is named "option" because the most common device it's
23   used for is a PC-Card (with an internal OHCI-USB interface, behind
24   which the GSM interface sits), made by Option Inc.
25
26   Some of the "one port" devices actually exhibit multiple USB instances
27   on the USB bus. This is not a bug, these ports are used for different
28   device features.
29 */
30
31 #define DRIVER_VERSION "v0.7.1"
32 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
33 #define DRIVER_DESC "USB Driver for GSM modems"
34
35 #include <linux/kernel.h>
36 #include <linux/jiffies.h>
37 #include <linux/errno.h>
38 #include <linux/tty.h>
39 #include <linux/tty_flip.h>
40 #include <linux/module.h>
41 #include <linux/usb.h>
42 #include <linux/usb/serial.h>
43
44 /* Function prototypes */
45 static int  option_open(struct usb_serial_port *port, struct file *filp);
46 static void option_close(struct usb_serial_port *port, struct file *filp);
47 static int  option_startup(struct usb_serial *serial);
48 static void option_shutdown(struct usb_serial *serial);
49 static void option_rx_throttle(struct usb_serial_port *port);
50 static void option_rx_unthrottle(struct usb_serial_port *port);
51 static int  option_write_room(struct usb_serial_port *port);
52
53 static void option_instat_callback(struct urb *urb);
54
55 static int option_write(struct usb_serial_port *port,
56                         const unsigned char *buf, int count);
57
58 static int  option_chars_in_buffer(struct usb_serial_port *port);
59 static int  option_ioctl(struct usb_serial_port *port, struct file *file,
60                         unsigned int cmd, unsigned long arg);
61 static void option_set_termios(struct usb_serial_port *port,
62                                 struct ktermios *old);
63 static void option_break_ctl(struct usb_serial_port *port, int break_state);
64 static int  option_tiocmget(struct usb_serial_port *port, struct file *file);
65 static int  option_tiocmset(struct usb_serial_port *port, struct file *file,
66                                 unsigned int set, unsigned int clear);
67 static int  option_send_setup(struct usb_serial_port *port);
68
69 /* Vendor and product IDs */
70 #define OPTION_VENDOR_ID                        0x0AF0
71 #define OPTION_PRODUCT_COLT                     0x5000
72 #define OPTION_PRODUCT_RICOLA                   0x6000
73 #define OPTION_PRODUCT_RICOLA_LIGHT             0x6100
74 #define OPTION_PRODUCT_RICOLA_QUAD              0x6200
75 #define OPTION_PRODUCT_RICOLA_QUAD_LIGHT        0x6300
76 #define OPTION_PRODUCT_RICOLA_NDIS              0x6050
77 #define OPTION_PRODUCT_RICOLA_NDIS_LIGHT        0x6150
78 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD         0x6250
79 #define OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT   0x6350
80 #define OPTION_PRODUCT_COBRA                    0x6500
81 #define OPTION_PRODUCT_COBRA_BUS                0x6501
82 #define OPTION_PRODUCT_VIPER                    0x6600
83 #define OPTION_PRODUCT_VIPER_BUS                0x6601
84 #define OPTION_PRODUCT_GT_MAX_READY             0x6701
85 #define OPTION_PRODUCT_GT_MAX                   0x6711
86 #define OPTION_PRODUCT_FUJI_MODEM_LIGHT         0x6721
87 #define OPTION_PRODUCT_FUJI_MODEM_GT            0x6741
88 #define OPTION_PRODUCT_FUJI_MODEM_EX            0x6761
89 #define OPTION_PRODUCT_FUJI_NETWORK_LIGHT       0x6731
90 #define OPTION_PRODUCT_FUJI_NETWORK_GT          0x6751
91 #define OPTION_PRODUCT_FUJI_NETWORK_EX          0x6771
92 #define OPTION_PRODUCT_KOI_MODEM                0x6800
93 #define OPTION_PRODUCT_KOI_NETWORK              0x6811
94 #define OPTION_PRODUCT_SCORPION_MODEM           0x6901
95 #define OPTION_PRODUCT_SCORPION_NETWORK         0x6911
96 #define OPTION_PRODUCT_ETNA_MODEM               0x7001
97 #define OPTION_PRODUCT_ETNA_NETWORK             0x7011
98 #define OPTION_PRODUCT_ETNA_MODEM_LITE          0x7021
99 #define OPTION_PRODUCT_ETNA_MODEM_GT            0x7041
100 #define OPTION_PRODUCT_ETNA_MODEM_EX            0x7061
101 #define OPTION_PRODUCT_ETNA_NETWORK_LITE        0x7031
102 #define OPTION_PRODUCT_ETNA_NETWORK_GT          0x7051
103 #define OPTION_PRODUCT_ETNA_NETWORK_EX          0x7071
104 #define OPTION_PRODUCT_ETNA_KOI_MODEM           0x7100
105 #define OPTION_PRODUCT_ETNA_KOI_NETWORK         0x7111
106
107 #define HUAWEI_VENDOR_ID                        0x12D1
108 #define HUAWEI_PRODUCT_E600                     0x1001
109 #define HUAWEI_PRODUCT_E220                     0x1003
110
111 #define NOVATELWIRELESS_VENDOR_ID               0x1410
112
113 #define ANYDATA_VENDOR_ID                       0x16d5
114 #define ANYDATA_PRODUCT_ID                      0x6501
115
116 #define BANDRICH_VENDOR_ID                      0x1A8D
117 #define BANDRICH_PRODUCT_C100_1                 0x1002
118 #define BANDRICH_PRODUCT_C100_2                 0x1003
119
120 static struct usb_device_id option_ids[] = {
121         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COLT) },
122         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA) },
123         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_LIGHT) },
124         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD) },
125         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_QUAD_LIGHT) },
126         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS) },
127         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_LIGHT) },
128         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD) },
129         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_RICOLA_NDIS_QUAD_LIGHT) },
130         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA) },
131         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_COBRA_BUS) },
132         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER) },
133         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_VIPER_BUS) },
134         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX_READY) },
135         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_GT_MAX) },
136         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_LIGHT) },
137         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_GT) },
138         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_MODEM_EX) },
139         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_LIGHT) },
140         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_GT) },
141         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUJI_NETWORK_EX) },
142         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_MODEM) },
143         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_KOI_NETWORK) },
144         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_MODEM) },
145         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_SCORPION_NETWORK) },
146         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM) },
147         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK) },
148         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_LITE) },
149         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_GT) },
150         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_MODEM_EX) },
151         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_LITE) },
152         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_GT) },
153         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_NETWORK_EX) },
154         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_MODEM) },
155         { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_ETNA_KOI_NETWORK) },
156         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600) },
157         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E220) },
158         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1100) }, /* Novatel Merlin XS620/S640 */
159         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1110) }, /* Novatel Merlin S620 */
160         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1120) }, /* Novatel Merlin EX720 */
161         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1130) }, /* Novatel Merlin S720 */
162         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1400) }, /* Novatel U730 */
163         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1410) }, /* Novatel U740 */
164         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1420) }, /* Novatel EU870 */
165         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1430) }, /* Novatel Merlin XU870 HSDPA/3G */
166         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x1430) }, /* Novatel XU870 */
167         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2100) }, /* Novatel EV620 CDMA/EV-DO */
168         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2110) }, /* Novatel Merlin ES620 / Merlin ES720 / Ovation U720 */
169         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2130) }, /* Novatel Merlin ES620 SM Bus */
170         { USB_DEVICE(NOVATELWIRELESS_VENDOR_ID, 0x2410) }, /* Novatel EU740 */
171         { USB_DEVICE(ANYDATA_VENDOR_ID, ANYDATA_PRODUCT_ID) },
172         { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_1) },
173         { USB_DEVICE(BANDRICH_VENDOR_ID, BANDRICH_PRODUCT_C100_2) },
174         { } /* Terminating entry */
175 };
176 MODULE_DEVICE_TABLE(usb, option_ids);
177
178 static struct usb_driver option_driver = {
179         .name       = "option",
180         .probe      = usb_serial_probe,
181         .disconnect = usb_serial_disconnect,
182         .id_table   = option_ids,
183         .no_dynamic_id =        1,
184 };
185
186 /* The card has three separate interfaces, which the serial driver
187  * recognizes separately, thus num_port=1.
188  */
189
190 static struct usb_serial_driver option_1port_device = {
191         .driver = {
192                 .owner =        THIS_MODULE,
193                 .name =         "option1",
194         },
195         .description       = "GSM modem (1-port)",
196         .usb_driver        = &option_driver,
197         .id_table          = option_ids,
198         .num_interrupt_in  = NUM_DONT_CARE,
199         .num_bulk_in       = NUM_DONT_CARE,
200         .num_bulk_out      = NUM_DONT_CARE,
201         .num_ports         = 1,
202         .open              = option_open,
203         .close             = option_close,
204         .write             = option_write,
205         .write_room        = option_write_room,
206         .chars_in_buffer   = option_chars_in_buffer,
207         .throttle          = option_rx_throttle,
208         .unthrottle        = option_rx_unthrottle,
209         .ioctl             = option_ioctl,
210         .set_termios       = option_set_termios,
211         .break_ctl         = option_break_ctl,
212         .tiocmget          = option_tiocmget,
213         .tiocmset          = option_tiocmset,
214         .attach            = option_startup,
215         .shutdown          = option_shutdown,
216         .read_int_callback = option_instat_callback,
217 };
218
219 #ifdef CONFIG_USB_DEBUG
220 static int debug;
221 #else
222 #define debug 0
223 #endif
224
225 /* per port private data */
226
227 #define N_IN_URB 4
228 #define N_OUT_URB 1
229 #define IN_BUFLEN 4096
230 #define OUT_BUFLEN 128
231
232 struct option_port_private {
233         /* Input endpoints and buffer for this port */
234         struct urb *in_urbs[N_IN_URB];
235         char in_buffer[N_IN_URB][IN_BUFLEN];
236         /* Output endpoints and buffer for this port */
237         struct urb *out_urbs[N_OUT_URB];
238         char out_buffer[N_OUT_URB][OUT_BUFLEN];
239
240         /* Settings for the port */
241         int rts_state;  /* Handshaking pins (outputs) */
242         int dtr_state;
243         int cts_state;  /* Handshaking pins (inputs) */
244         int dsr_state;
245         int dcd_state;
246         int ri_state;
247
248         unsigned long tx_start_time[N_OUT_URB];
249 };
250
251 /* Functions used by new usb-serial code. */
252 static int __init option_init(void)
253 {
254         int retval;
255         retval = usb_serial_register(&option_1port_device);
256         if (retval)
257                 goto failed_1port_device_register;
258         retval = usb_register(&option_driver);
259         if (retval)
260                 goto failed_driver_register;
261
262         info(DRIVER_DESC ": " DRIVER_VERSION);
263
264         return 0;
265
266 failed_driver_register:
267         usb_serial_deregister (&option_1port_device);
268 failed_1port_device_register:
269         return retval;
270 }
271
272 static void __exit option_exit(void)
273 {
274         usb_deregister (&option_driver);
275         usb_serial_deregister (&option_1port_device);
276 }
277
278 module_init(option_init);
279 module_exit(option_exit);
280
281 static void option_rx_throttle(struct usb_serial_port *port)
282 {
283         dbg("%s", __FUNCTION__);
284 }
285
286 static void option_rx_unthrottle(struct usb_serial_port *port)
287 {
288         dbg("%s", __FUNCTION__);
289 }
290
291 static void option_break_ctl(struct usb_serial_port *port, int break_state)
292 {
293         /* Unfortunately, I don't know how to send a break */
294         dbg("%s", __FUNCTION__);
295 }
296
297 static void option_set_termios(struct usb_serial_port *port,
298                         struct ktermios *old_termios)
299 {
300         dbg("%s", __FUNCTION__);
301
302         option_send_setup(port);
303 }
304
305 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
306 {
307         unsigned int value;
308         struct option_port_private *portdata;
309
310         portdata = usb_get_serial_port_data(port);
311
312         value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
313                 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
314                 ((portdata->cts_state) ? TIOCM_CTS : 0) |
315                 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
316                 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
317                 ((portdata->ri_state) ? TIOCM_RNG : 0);
318
319         return value;
320 }
321
322 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
323                         unsigned int set, unsigned int clear)
324 {
325         struct option_port_private *portdata;
326
327         portdata = usb_get_serial_port_data(port);
328
329         if (set & TIOCM_RTS)
330                 portdata->rts_state = 1;
331         if (set & TIOCM_DTR)
332                 portdata->dtr_state = 1;
333
334         if (clear & TIOCM_RTS)
335                 portdata->rts_state = 0;
336         if (clear & TIOCM_DTR)
337                 portdata->dtr_state = 0;
338         return option_send_setup(port);
339 }
340
341 static int option_ioctl(struct usb_serial_port *port, struct file *file,
342                         unsigned int cmd, unsigned long arg)
343 {
344         return -ENOIOCTLCMD;
345 }
346
347 /* Write */
348 static int option_write(struct usb_serial_port *port,
349                         const unsigned char *buf, int count)
350 {
351         struct option_port_private *portdata;
352         int i;
353         int left, todo;
354         struct urb *this_urb = NULL; /* spurious */
355         int err;
356
357         portdata = usb_get_serial_port_data(port);
358
359         dbg("%s: write (%d chars)", __FUNCTION__, count);
360
361         i = 0;
362         left = count;
363         for (i=0; left > 0 && i < N_OUT_URB; i++) {
364                 todo = left;
365                 if (todo > OUT_BUFLEN)
366                         todo = OUT_BUFLEN;
367
368                 this_urb = portdata->out_urbs[i];
369                 if (this_urb->status == -EINPROGRESS) {
370                         if (time_before(jiffies,
371                                         portdata->tx_start_time[i] + 10 * HZ))
372                                 continue;
373                         usb_unlink_urb(this_urb);
374                         continue;
375                 }
376                 if (this_urb->status != 0)
377                         dbg("usb_write %p failed (err=%d)",
378                                 this_urb, this_urb->status);
379
380                 dbg("%s: endpoint %d buf %d", __FUNCTION__,
381                         usb_pipeendpoint(this_urb->pipe), i);
382
383                 /* send the data */
384                 memcpy (this_urb->transfer_buffer, buf, todo);
385                 this_urb->transfer_buffer_length = todo;
386
387                 this_urb->dev = port->serial->dev;
388                 err = usb_submit_urb(this_urb, GFP_ATOMIC);
389                 if (err) {
390                         dbg("usb_submit_urb %p (write bulk) failed "
391                                 "(%d, has %d)", this_urb,
392                                 err, this_urb->status);
393                         continue;
394                 }
395                 portdata->tx_start_time[i] = jiffies;
396                 buf += todo;
397                 left -= todo;
398         }
399
400         count -= left;
401         dbg("%s: wrote (did %d)", __FUNCTION__, count);
402         return count;
403 }
404
405 static void option_indat_callback(struct urb *urb)
406 {
407         int err;
408         int endpoint;
409         struct usb_serial_port *port;
410         struct tty_struct *tty;
411         unsigned char *data = urb->transfer_buffer;
412
413         dbg("%s: %p", __FUNCTION__, urb);
414
415         endpoint = usb_pipeendpoint(urb->pipe);
416         port = (struct usb_serial_port *) urb->context;
417
418         if (urb->status) {
419                 dbg("%s: nonzero status: %d on endpoint %02x.",
420                     __FUNCTION__, urb->status, endpoint);
421         } else {
422                 tty = port->tty;
423                 if (urb->actual_length) {
424                         tty_buffer_request_room(tty, urb->actual_length);
425                         tty_insert_flip_string(tty, data, urb->actual_length);
426                         tty_flip_buffer_push(tty);
427                 } else {
428                         dbg("%s: empty read urb received", __FUNCTION__);
429                 }
430
431                 /* Resubmit urb so we continue receiving */
432                 if (port->open_count && urb->status != -ESHUTDOWN) {
433                         err = usb_submit_urb(urb, GFP_ATOMIC);
434                         if (err)
435                                 printk(KERN_ERR "%s: resubmit read urb failed. "
436                                         "(%d)", __FUNCTION__, err);
437                 }
438         }
439         return;
440 }
441
442 static void option_outdat_callback(struct urb *urb)
443 {
444         struct usb_serial_port *port;
445
446         dbg("%s", __FUNCTION__);
447
448         port = (struct usb_serial_port *) urb->context;
449
450         usb_serial_port_softint(port);
451 }
452
453 static void option_instat_callback(struct urb *urb)
454 {
455         int err;
456         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
457         struct option_port_private *portdata = usb_get_serial_port_data(port);
458         struct usb_serial *serial = port->serial;
459
460         dbg("%s", __FUNCTION__);
461         dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
462
463         if (urb->status == 0) {
464                 struct usb_ctrlrequest *req_pkt =
465                                 (struct usb_ctrlrequest *)urb->transfer_buffer;
466
467                 if (!req_pkt) {
468                         dbg("%s: NULL req_pkt\n", __FUNCTION__);
469                         return;
470                 }
471                 if ((req_pkt->bRequestType == 0xA1) &&
472                                 (req_pkt->bRequest == 0x20)) {
473                         int old_dcd_state;
474                         unsigned char signals = *((unsigned char *)
475                                         urb->transfer_buffer +
476                                         sizeof(struct usb_ctrlrequest));
477
478                         dbg("%s: signal x%x", __FUNCTION__, signals);
479
480                         old_dcd_state = portdata->dcd_state;
481                         portdata->cts_state = 1;
482                         portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
483                         portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
484                         portdata->ri_state = ((signals & 0x08) ? 1 : 0);
485
486                         if (port->tty && !C_CLOCAL(port->tty) &&
487                                         old_dcd_state && !portdata->dcd_state)
488                                 tty_hangup(port->tty);
489                 } else {
490                         dbg("%s: type %x req %x", __FUNCTION__,
491                                 req_pkt->bRequestType,req_pkt->bRequest);
492                 }
493         } else
494                 dbg("%s: error %d", __FUNCTION__, urb->status);
495
496         /* Resubmit urb so we continue receiving IRQ data */
497         if (urb->status != -ESHUTDOWN) {
498                 urb->dev = serial->dev;
499                 err = usb_submit_urb(urb, GFP_ATOMIC);
500                 if (err)
501                         dbg("%s: resubmit intr urb failed. (%d)",
502                                 __FUNCTION__, err);
503         }
504 }
505
506 static int option_write_room(struct usb_serial_port *port)
507 {
508         struct option_port_private *portdata;
509         int i;
510         int data_len = 0;
511         struct urb *this_urb;
512
513         portdata = usb_get_serial_port_data(port);
514
515         for (i=0; i < N_OUT_URB; i++) {
516                 this_urb = portdata->out_urbs[i];
517                 if (this_urb && this_urb->status != -EINPROGRESS)
518                         data_len += OUT_BUFLEN;
519         }
520
521         dbg("%s: %d", __FUNCTION__, data_len);
522         return data_len;
523 }
524
525 static int option_chars_in_buffer(struct usb_serial_port *port)
526 {
527         struct option_port_private *portdata;
528         int i;
529         int data_len = 0;
530         struct urb *this_urb;
531
532         portdata = usb_get_serial_port_data(port);
533
534         for (i=0; i < N_OUT_URB; i++) {
535                 this_urb = portdata->out_urbs[i];
536                 if (this_urb && this_urb->status == -EINPROGRESS)
537                         data_len += this_urb->transfer_buffer_length;
538         }
539         dbg("%s: %d", __FUNCTION__, data_len);
540         return data_len;
541 }
542
543 static int option_open(struct usb_serial_port *port, struct file *filp)
544 {
545         struct option_port_private *portdata;
546         struct usb_serial *serial = port->serial;
547         int i, err;
548         struct urb *urb;
549
550         portdata = usb_get_serial_port_data(port);
551
552         dbg("%s", __FUNCTION__);
553
554         /* Set some sane defaults */
555         portdata->rts_state = 1;
556         portdata->dtr_state = 1;
557
558         /* Reset low level data toggle and start reading from endpoints */
559         for (i = 0; i < N_IN_URB; i++) {
560                 urb = portdata->in_urbs[i];
561                 if (! urb)
562                         continue;
563                 if (urb->dev != serial->dev) {
564                         dbg("%s: dev %p != %p", __FUNCTION__,
565                                 urb->dev, serial->dev);
566                         continue;
567                 }
568
569                 /*
570                  * make sure endpoint data toggle is synchronized with the
571                  * device
572                  */
573                 usb_clear_halt(urb->dev, urb->pipe);
574
575                 err = usb_submit_urb(urb, GFP_KERNEL);
576                 if (err) {
577                         dbg("%s: submit urb %d failed (%d) %d",
578                                 __FUNCTION__, i, err,
579                                 urb->transfer_buffer_length);
580                 }
581         }
582
583         /* Reset low level data toggle on out endpoints */
584         for (i = 0; i < N_OUT_URB; i++) {
585                 urb = portdata->out_urbs[i];
586                 if (! urb)
587                         continue;
588                 urb->dev = serial->dev;
589                 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
590                                 usb_pipeout(urb->pipe), 0); */
591         }
592
593         port->tty->low_latency = 1;
594
595         option_send_setup(port);
596
597         return (0);
598 }
599
600 static void option_close(struct usb_serial_port *port, struct file *filp)
601 {
602         int i;
603         struct usb_serial *serial = port->serial;
604         struct option_port_private *portdata;
605
606         dbg("%s", __FUNCTION__);
607         portdata = usb_get_serial_port_data(port);
608
609         portdata->rts_state = 0;
610         portdata->dtr_state = 0;
611
612         if (serial->dev) {
613                 option_send_setup(port);
614
615                 /* Stop reading/writing urbs */
616                 for (i = 0; i < N_IN_URB; i++)
617                         usb_kill_urb(portdata->in_urbs[i]);
618                 for (i = 0; i < N_OUT_URB; i++)
619                         usb_kill_urb(portdata->out_urbs[i]);
620         }
621         port->tty = NULL;
622 }
623
624 /* Helper functions used by option_setup_urbs */
625 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
626                 int dir, void *ctx, char *buf, int len,
627                 void (*callback)(struct urb *))
628 {
629         struct urb *urb;
630
631         if (endpoint == -1)
632                 return NULL;            /* endpoint not needed */
633
634         urb = usb_alloc_urb(0, GFP_KERNEL);             /* No ISO */
635         if (urb == NULL) {
636                 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__, endpoint);
637                 return NULL;
638         }
639
640                 /* Fill URB using supplied data. */
641         usb_fill_bulk_urb(urb, serial->dev,
642                       usb_sndbulkpipe(serial->dev, endpoint) | dir,
643                       buf, len, callback, ctx);
644
645         return urb;
646 }
647
648 /* Setup urbs */
649 static void option_setup_urbs(struct usb_serial *serial)
650 {
651         int i,j;
652         struct usb_serial_port *port;
653         struct option_port_private *portdata;
654
655         dbg("%s", __FUNCTION__);
656
657         for (i = 0; i < serial->num_ports; i++) {
658                 port = serial->port[i];
659                 portdata = usb_get_serial_port_data(port);
660
661         /* Do indat endpoints first */
662                 for (j = 0; j < N_IN_URB; ++j) {
663                         portdata->in_urbs[j] = option_setup_urb (serial,
664                         port->bulk_in_endpointAddress, USB_DIR_IN, port,
665                         portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
666                 }
667
668                 /* outdat endpoints */
669                 for (j = 0; j < N_OUT_URB; ++j) {
670                         portdata->out_urbs[j] = option_setup_urb (serial,
671                         port->bulk_out_endpointAddress, USB_DIR_OUT, port,
672                         portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
673                 }
674         }
675 }
676
677 static int option_send_setup(struct usb_serial_port *port)
678 {
679         struct usb_serial *serial = port->serial;
680         struct option_port_private *portdata;
681
682         dbg("%s", __FUNCTION__);
683
684         if (port->number != 0)
685                 return 0;
686
687         portdata = usb_get_serial_port_data(port);
688
689         if (port->tty) {
690                 int val = 0;
691                 if (portdata->dtr_state)
692                         val |= 0x01;
693                 if (portdata->rts_state)
694                         val |= 0x02;
695
696                 return usb_control_msg(serial->dev,
697                                 usb_rcvctrlpipe(serial->dev, 0),
698                                 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
699         }
700
701         return 0;
702 }
703
704 static int option_startup(struct usb_serial *serial)
705 {
706         int i, err;
707         struct usb_serial_port *port;
708         struct option_port_private *portdata;
709
710         dbg("%s", __FUNCTION__);
711
712         /* Now setup per port private data */
713         for (i = 0; i < serial->num_ports; i++) {
714                 port = serial->port[i];
715                 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
716                 if (!portdata) {
717                         dbg("%s: kmalloc for option_port_private (%d) failed!.",
718                                         __FUNCTION__, i);
719                         return (1);
720                 }
721
722                 usb_set_serial_port_data(port, portdata);
723
724                 if (! port->interrupt_in_urb)
725                         continue;
726                 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
727                 if (err)
728                         dbg("%s: submit irq_in urb failed %d",
729                                 __FUNCTION__, err);
730         }
731
732         option_setup_urbs(serial);
733
734         return (0);
735 }
736
737 static void option_shutdown(struct usb_serial *serial)
738 {
739         int i, j;
740         struct usb_serial_port *port;
741         struct option_port_private *portdata;
742
743         dbg("%s", __FUNCTION__);
744
745         /* Stop reading/writing urbs */
746         for (i = 0; i < serial->num_ports; ++i) {
747                 port = serial->port[i];
748                 portdata = usb_get_serial_port_data(port);
749                 for (j = 0; j < N_IN_URB; j++)
750                         usb_kill_urb(portdata->in_urbs[j]);
751                 for (j = 0; j < N_OUT_URB; j++)
752                         usb_kill_urb(portdata->out_urbs[j]);
753         }
754
755         /* Now free them */
756         for (i = 0; i < serial->num_ports; ++i) {
757                 port = serial->port[i];
758                 portdata = usb_get_serial_port_data(port);
759
760                 for (j = 0; j < N_IN_URB; j++) {
761                         if (portdata->in_urbs[j]) {
762                                 usb_free_urb(portdata->in_urbs[j]);
763                                 portdata->in_urbs[j] = NULL;
764                         }
765                 }
766                 for (j = 0; j < N_OUT_URB; j++) {
767                         if (portdata->out_urbs[j]) {
768                                 usb_free_urb(portdata->out_urbs[j]);
769                                 portdata->out_urbs[j] = NULL;
770                         }
771                 }
772         }
773
774         /* Now free per port private data */
775         for (i = 0; i < serial->num_ports; i++) {
776                 port = serial->port[i];
777                 kfree(usb_get_serial_port_data(port));
778         }
779 }
780
781 MODULE_AUTHOR(DRIVER_AUTHOR);
782 MODULE_DESCRIPTION(DRIVER_DESC);
783 MODULE_VERSION(DRIVER_VERSION);
784 MODULE_LICENSE("GPL");
785
786 #ifdef CONFIG_USB_DEBUG
787 module_param(debug, bool, S_IRUGO | S_IWUSR);
788 MODULE_PARM_DESC(debug, "Debug messages");
789 #endif
790