2 Option Card (PCMCIA to) USB to Serial Driver
4 Copyright (C) 2005 Matthias Urlichs <smurf@smurf.noris.de>
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.
10 Portions copied from the Keyspan driver by Hugh Blemings <hugh@blemings.org>
14 2005-05-19 v0.1 Initial version, based on incomplete docs
15 and analysis of misbehavior with the standard driver
16 2005-05-20 v0.2 Extended the input buffer to avoid losing
17 random 64-byte chunks of data
18 2005-05-21 v0.3 implemented chars_in_buffer()
20 simplified the code somewhat
21 2005-05-24 v0.4 option_write() sometimes deadlocked under heavy load
22 removed some dead code
25 2005-06-20 v0.4.1 add missing braces :-/
26 killed end-of-line whitespace
27 2005-07-15 v0.4.2 rename WLAN product to FUSION, add FUSION2
28 2005-09-10 v0.4.3 added HUAWEI E600 card and Audiovox AirCard
29 2005-09-20 v0.4.4 increased recv buffer size: the card sometimes
30 wants to send >2000 bytes.
32 Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
36 #define DRIVER_VERSION "v0.4"
37 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
38 #define DRIVER_DESC "Option Card (PC-Card to) USB to Serial Driver"
40 #include <linux/config.h>
41 #include <linux/kernel.h>
42 #include <linux/jiffies.h>
43 #include <linux/errno.h>
44 #include <linux/tty.h>
45 #include <linux/tty_flip.h>
46 #include <linux/module.h>
47 #include <linux/usb.h>
48 #include "usb-serial.h"
50 /* Function prototypes */
51 static int option_open(struct usb_serial_port *port, struct file *filp);
52 static void option_close(struct usb_serial_port *port, struct file *filp);
53 static int option_startup(struct usb_serial *serial);
54 static void option_shutdown(struct usb_serial *serial);
55 static void option_rx_throttle(struct usb_serial_port *port);
56 static void option_rx_unthrottle(struct usb_serial_port *port);
57 static int option_write_room(struct usb_serial_port *port);
59 static void option_instat_callback(struct urb *urb, struct pt_regs *regs);
61 static int option_write(struct usb_serial_port *port,
62 const unsigned char *buf, int count);
64 static int option_chars_in_buffer(struct usb_serial_port *port);
65 static int option_ioctl(struct usb_serial_port *port, struct file *file,
66 unsigned int cmd, unsigned long arg);
67 static void option_set_termios(struct usb_serial_port *port,
69 static void option_break_ctl(struct usb_serial_port *port, int break_state);
70 static int option_tiocmget(struct usb_serial_port *port, struct file *file);
71 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
72 unsigned int set, unsigned int clear);
73 static int option_send_setup(struct usb_serial_port *port);
75 /* Vendor and product IDs */
76 #define OPTION_VENDOR_ID 0x0AF0
77 #define HUAWEI_VENDOR_ID 0x12D1
78 #define AUDIOVOX_VENDOR_ID 0x0F3D
80 #define OPTION_PRODUCT_OLD 0x5000
81 #define OPTION_PRODUCT_FUSION 0x6000
82 #define OPTION_PRODUCT_FUSION2 0x6300
83 #define HUAWEI_PRODUCT_E600 0x1001
84 #define AUDIOVOX_PRODUCT_AIRCARD 0x0112
86 static struct usb_device_id option_ids[] = {
87 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_OLD) },
88 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUSION) },
89 { USB_DEVICE(OPTION_VENDOR_ID, OPTION_PRODUCT_FUSION2) },
90 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_E600) },
91 { USB_DEVICE(AUDIOVOX_VENDOR_ID, AUDIOVOX_PRODUCT_AIRCARD) },
92 { } /* Terminating entry */
95 MODULE_DEVICE_TABLE(usb, option_ids);
97 static struct usb_driver option_driver = {
100 .probe = usb_serial_probe,
101 .disconnect = usb_serial_disconnect,
102 .id_table = option_ids,
105 /* The card has three separate interfaces, wich the serial driver
106 * recognizes separately, thus num_port=1.
108 static struct usb_serial_driver option_3port_device = {
110 .owner = THIS_MODULE,
113 .description = "Option 3G data card",
114 .id_table = option_ids,
115 .num_interrupt_in = NUM_DONT_CARE,
116 .num_bulk_in = NUM_DONT_CARE,
117 .num_bulk_out = NUM_DONT_CARE,
118 .num_ports = 1, /* 3, but the card reports its ports separately */
120 .close = option_close,
121 .write = option_write,
122 .write_room = option_write_room,
123 .chars_in_buffer = option_chars_in_buffer,
124 .throttle = option_rx_throttle,
125 .unthrottle = option_rx_unthrottle,
126 .ioctl = option_ioctl,
127 .set_termios = option_set_termios,
128 .break_ctl = option_break_ctl,
129 .tiocmget = option_tiocmget,
130 .tiocmset = option_tiocmset,
131 .attach = option_startup,
132 .shutdown = option_shutdown,
133 .read_int_callback = option_instat_callback,
136 #ifdef CONFIG_USB_DEBUG
142 /* per port private data */
146 #define IN_BUFLEN 4096
147 #define OUT_BUFLEN 128
149 struct option_port_private {
150 /* Input endpoints and buffer for this port */
151 struct urb *in_urbs[N_IN_URB];
152 char in_buffer[N_IN_URB][IN_BUFLEN];
153 /* Output endpoints and buffer for this port */
154 struct urb *out_urbs[N_OUT_URB];
155 char out_buffer[N_OUT_URB][OUT_BUFLEN];
157 /* Settings for the port */
158 int rts_state; /* Handshaking pins (outputs) */
160 int cts_state; /* Handshaking pins (inputs) */
165 unsigned long tx_start_time[N_OUT_URB];
168 /* Functions used by new usb-serial code. */
169 static int __init option_init(void)
172 retval = usb_serial_register(&option_3port_device);
174 goto failed_3port_device_register;
175 retval = usb_register(&option_driver);
177 goto failed_driver_register;
179 info(DRIVER_DESC ": " DRIVER_VERSION);
183 failed_driver_register:
184 usb_serial_deregister (&option_3port_device);
185 failed_3port_device_register:
189 static void __exit option_exit(void)
191 usb_deregister (&option_driver);
192 usb_serial_deregister (&option_3port_device);
195 module_init(option_init);
196 module_exit(option_exit);
198 static void option_rx_throttle(struct usb_serial_port *port)
200 dbg("%s", __FUNCTION__);
203 static void option_rx_unthrottle(struct usb_serial_port *port)
205 dbg("%s", __FUNCTION__);
208 static void option_break_ctl(struct usb_serial_port *port, int break_state)
210 /* Unfortunately, I don't know how to send a break */
211 dbg("%s", __FUNCTION__);
214 static void option_set_termios(struct usb_serial_port *port,
215 struct termios *old_termios)
217 dbg("%s", __FUNCTION__);
219 option_send_setup(port);
222 static int option_tiocmget(struct usb_serial_port *port, struct file *file)
225 struct option_port_private *portdata;
227 portdata = usb_get_serial_port_data(port);
229 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
230 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
231 ((portdata->cts_state) ? TIOCM_CTS : 0) |
232 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
233 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
234 ((portdata->ri_state) ? TIOCM_RNG : 0);
239 static int option_tiocmset(struct usb_serial_port *port, struct file *file,
240 unsigned int set, unsigned int clear)
242 struct option_port_private *portdata;
244 portdata = usb_get_serial_port_data(port);
247 portdata->rts_state = 1;
249 portdata->dtr_state = 1;
251 if (clear & TIOCM_RTS)
252 portdata->rts_state = 0;
253 if (clear & TIOCM_DTR)
254 portdata->dtr_state = 0;
255 return option_send_setup(port);
258 static int option_ioctl(struct usb_serial_port *port, struct file *file,
259 unsigned int cmd, unsigned long arg)
265 static int option_write(struct usb_serial_port *port,
266 const unsigned char *buf, int count)
268 struct option_port_private *portdata;
271 struct urb *this_urb = NULL; /* spurious */
274 portdata = usb_get_serial_port_data(port);
276 dbg("%s: write (%d chars)", __FUNCTION__, count);
280 for (i=0; left > 0 && i < N_OUT_URB; i++) {
282 if (todo > OUT_BUFLEN)
285 this_urb = portdata->out_urbs[i];
286 if (this_urb->status == -EINPROGRESS) {
287 if (time_before(jiffies,
288 portdata->tx_start_time[i] + 10 * HZ))
290 usb_unlink_urb(this_urb);
293 if (this_urb->status != 0)
294 dbg("usb_write %p failed (err=%d)",
295 this_urb, this_urb->status);
297 dbg("%s: endpoint %d buf %d", __FUNCTION__,
298 usb_pipeendpoint(this_urb->pipe), i);
301 memcpy (this_urb->transfer_buffer, buf, todo);
302 this_urb->transfer_buffer_length = todo;
304 this_urb->dev = port->serial->dev;
305 err = usb_submit_urb(this_urb, GFP_ATOMIC);
307 dbg("usb_submit_urb %p (write bulk) failed "
308 "(%d, has %d)", this_urb,
309 err, this_urb->status);
312 portdata->tx_start_time[i] = jiffies;
318 dbg("%s: wrote (did %d)", __FUNCTION__, count);
322 static void option_indat_callback(struct urb *urb, struct pt_regs *regs)
326 struct usb_serial_port *port;
327 struct tty_struct *tty;
328 unsigned char *data = urb->transfer_buffer;
330 dbg("%s: %p", __FUNCTION__, urb);
332 endpoint = usb_pipeendpoint(urb->pipe);
333 port = (struct usb_serial_port *) urb->context;
336 dbg("%s: nonzero status: %d on endpoint %02x.",
337 __FUNCTION__, urb->status, endpoint);
340 if (urb->actual_length) {
341 for (i = 0; i < urb->actual_length ; ++i) {
342 if (tty->flip.count >= TTY_FLIPBUF_SIZE)
343 tty_flip_buffer_push(tty);
344 tty_insert_flip_char(tty, data[i], 0);
346 tty_flip_buffer_push(tty);
348 dbg("%s: empty read urb received", __FUNCTION__);
351 /* Resubmit urb so we continue receiving */
352 if (port->open_count && urb->status != -ESHUTDOWN) {
353 err = usb_submit_urb(urb, GFP_ATOMIC);
355 printk(KERN_ERR "%s: resubmit read urb failed. "
356 "(%d)", __FUNCTION__, err);
362 static void option_outdat_callback(struct urb *urb, struct pt_regs *regs)
364 struct usb_serial_port *port;
366 dbg("%s", __FUNCTION__);
368 port = (struct usb_serial_port *) urb->context;
370 if (port->open_count)
371 schedule_work(&port->work);
374 static void option_instat_callback(struct urb *urb, struct pt_regs *regs)
377 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
378 struct option_port_private *portdata = usb_get_serial_port_data(port);
379 struct usb_serial *serial = port->serial;
381 dbg("%s", __FUNCTION__);
382 dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
384 if (urb->status == 0) {
385 struct usb_ctrlrequest *req_pkt =
386 (struct usb_ctrlrequest *)urb->transfer_buffer;
389 dbg("%s: NULL req_pkt\n", __FUNCTION__);
392 if ((req_pkt->bRequestType == 0xA1) &&
393 (req_pkt->bRequest == 0x20)) {
395 unsigned char signals = *((unsigned char *)
396 urb->transfer_buffer +
397 sizeof(struct usb_ctrlrequest));
399 dbg("%s: signal x%x", __FUNCTION__, signals);
401 old_dcd_state = portdata->dcd_state;
402 portdata->cts_state = 1;
403 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
404 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
405 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
407 if (port->tty && !C_CLOCAL(port->tty) &&
408 old_dcd_state && !portdata->dcd_state)
409 tty_hangup(port->tty);
411 dbg("%s: type %x req %x", __FUNCTION__,
412 req_pkt->bRequestType,req_pkt->bRequest);
415 dbg("%s: error %d", __FUNCTION__, urb->status);
417 /* Resubmit urb so we continue receiving IRQ data */
418 if (urb->status != -ESHUTDOWN) {
419 urb->dev = serial->dev;
420 err = usb_submit_urb(urb, GFP_ATOMIC);
422 dbg("%s: resubmit intr urb failed. (%d)",
427 static int option_write_room(struct usb_serial_port *port)
429 struct option_port_private *portdata;
432 struct urb *this_urb;
434 portdata = usb_get_serial_port_data(port);
436 for (i=0; i < N_OUT_URB; i++) {
437 this_urb = portdata->out_urbs[i];
438 if (this_urb && this_urb->status != -EINPROGRESS)
439 data_len += OUT_BUFLEN;
442 dbg("%s: %d", __FUNCTION__, data_len);
446 static int option_chars_in_buffer(struct usb_serial_port *port)
448 struct option_port_private *portdata;
451 struct urb *this_urb;
453 portdata = usb_get_serial_port_data(port);
455 for (i=0; i < N_OUT_URB; i++) {
456 this_urb = portdata->out_urbs[i];
457 if (this_urb && this_urb->status == -EINPROGRESS)
458 data_len += this_urb->transfer_buffer_length;
460 dbg("%s: %d", __FUNCTION__, data_len);
464 static int option_open(struct usb_serial_port *port, struct file *filp)
466 struct option_port_private *portdata;
467 struct usb_serial *serial = port->serial;
471 portdata = usb_get_serial_port_data(port);
473 dbg("%s", __FUNCTION__);
475 /* Set some sane defaults */
476 portdata->rts_state = 1;
477 portdata->dtr_state = 1;
479 /* Reset low level data toggle and start reading from endpoints */
480 for (i = 0; i < N_IN_URB; i++) {
481 urb = portdata->in_urbs[i];
484 if (urb->dev != serial->dev) {
485 dbg("%s: dev %p != %p", __FUNCTION__,
486 urb->dev, serial->dev);
491 * make sure endpoint data toggle is synchronized with the
494 usb_clear_halt(urb->dev, urb->pipe);
496 err = usb_submit_urb(urb, GFP_KERNEL);
498 dbg("%s: submit urb %d failed (%d) %d",
499 __FUNCTION__, i, err,
500 urb->transfer_buffer_length);
504 /* Reset low level data toggle on out endpoints */
505 for (i = 0; i < N_OUT_URB; i++) {
506 urb = portdata->out_urbs[i];
509 urb->dev = serial->dev;
510 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
511 usb_pipeout(urb->pipe), 0); */
514 port->tty->low_latency = 1;
516 option_send_setup(port);
521 static inline void stop_urb(struct urb *urb)
523 if (urb && urb->status == -EINPROGRESS)
527 static void option_close(struct usb_serial_port *port, struct file *filp)
530 struct usb_serial *serial = port->serial;
531 struct option_port_private *portdata;
533 dbg("%s", __FUNCTION__);
534 portdata = usb_get_serial_port_data(port);
536 portdata->rts_state = 0;
537 portdata->dtr_state = 0;
540 option_send_setup(port);
542 /* Stop reading/writing urbs */
543 for (i = 0; i < N_IN_URB; i++)
544 stop_urb(portdata->in_urbs[i]);
545 for (i = 0; i < N_OUT_URB; i++)
546 stop_urb(portdata->out_urbs[i]);
551 /* Helper functions used by option_setup_urbs */
552 static struct urb *option_setup_urb(struct usb_serial *serial, int endpoint,
553 int dir, void *ctx, char *buf, int len,
554 void (*callback)(struct urb *, struct pt_regs *regs))
559 return NULL; /* endpoint not needed */
561 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
563 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__, endpoint);
567 /* Fill URB using supplied data. */
568 usb_fill_bulk_urb(urb, serial->dev,
569 usb_sndbulkpipe(serial->dev, endpoint) | dir,
570 buf, len, callback, ctx);
576 static void option_setup_urbs(struct usb_serial *serial)
579 struct usb_serial_port *port;
580 struct option_port_private *portdata;
582 dbg("%s", __FUNCTION__);
584 port = serial->port[0];
585 portdata = usb_get_serial_port_data(port);
587 /* Do indat endpoints first */
588 for (j = 0; j <= N_IN_URB; ++j) {
589 portdata->in_urbs[j] = option_setup_urb (serial,
590 port->bulk_in_endpointAddress, USB_DIR_IN, port,
591 portdata->in_buffer[j], IN_BUFLEN, option_indat_callback);
594 /* outdat endpoints */
595 for (j = 0; j <= N_OUT_URB; ++j) {
596 portdata->out_urbs[j] = option_setup_urb (serial,
597 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
598 portdata->out_buffer[j], OUT_BUFLEN, option_outdat_callback);
602 static int option_send_setup(struct usb_serial_port *port)
604 struct usb_serial *serial = port->serial;
605 struct option_port_private *portdata;
607 dbg("%s", __FUNCTION__);
609 portdata = usb_get_serial_port_data(port);
613 if (portdata->dtr_state)
615 if (portdata->rts_state)
618 return usb_control_msg(serial->dev,
619 usb_rcvctrlpipe(serial->dev, 0),
620 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
626 static int option_startup(struct usb_serial *serial)
629 struct usb_serial_port *port;
630 struct option_port_private *portdata;
632 dbg("%s", __FUNCTION__);
634 /* Now setup per port private data */
635 for (i = 0; i < serial->num_ports; i++) {
636 port = serial->port[i];
637 portdata = kmalloc(sizeof(*portdata), GFP_KERNEL);
639 dbg("%s: kmalloc for option_port_private (%d) failed!.",
643 memset(portdata, 0, sizeof(struct option_port_private));
645 usb_set_serial_port_data(port, portdata);
647 if (! port->interrupt_in_urb)
649 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
651 dbg("%s: submit irq_in urb failed %d",
655 option_setup_urbs(serial);
660 static void option_shutdown(struct usb_serial *serial)
663 struct usb_serial_port *port;
664 struct option_port_private *portdata;
666 dbg("%s", __FUNCTION__);
668 /* Stop reading/writing urbs */
669 for (i = 0; i < serial->num_ports; ++i) {
670 port = serial->port[i];
671 portdata = usb_get_serial_port_data(port);
672 for (j = 0; j < N_IN_URB; j++)
673 stop_urb(portdata->in_urbs[j]);
674 for (j = 0; j < N_OUT_URB; j++)
675 stop_urb(portdata->out_urbs[j]);
679 for (i = 0; i < serial->num_ports; ++i) {
680 port = serial->port[i];
681 portdata = usb_get_serial_port_data(port);
683 for (j = 0; j < N_IN_URB; j++) {
684 if (portdata->in_urbs[j]) {
685 usb_free_urb(portdata->in_urbs[j]);
686 portdata->in_urbs[j] = NULL;
689 for (j = 0; j < N_OUT_URB; j++) {
690 if (portdata->out_urbs[j]) {
691 usb_free_urb(portdata->out_urbs[j]);
692 portdata->out_urbs[j] = NULL;
697 /* Now free per port private data */
698 for (i = 0; i < serial->num_ports; i++) {
699 port = serial->port[i];
700 kfree(usb_get_serial_port_data(port));
704 MODULE_AUTHOR(DRIVER_AUTHOR);
705 MODULE_DESCRIPTION(DRIVER_DESC);
706 MODULE_VERSION(DRIVER_VERSION);
707 MODULE_LICENSE("GPL");
709 #ifdef CONFIG_USB_DEBUG
710 module_param(debug, bool, S_IRUGO | S_IWUSR);
711 MODULE_PARM_DESC(debug, "Debug messages");