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
30 Work sponsored by: Sigos GmbH, Germany <info@sigos.de>
34 #define DRIVER_VERSION "v0.4"
35 #define DRIVER_AUTHOR "Matthias Urlichs <smurf@smurf.noris.de>"
36 #define DRIVER_DESC "Option Card (PC-Card to) USB to Serial Driver"
38 #include <linux/config.h>
39 #include <linux/kernel.h>
40 #include <linux/jiffies.h>
41 #include <linux/errno.h>
42 #include <linux/tty.h>
43 #include <linux/tty_flip.h>
44 #include <linux/module.h>
45 #include <linux/usb.h>
46 #include "usb-serial.h"
48 /* Function prototypes */
49 static int option_open(struct usb_serial_port
*port
, struct file
*filp
);
50 static void option_close(struct usb_serial_port
*port
, struct file
*filp
);
51 static int option_startup(struct usb_serial
*serial
);
52 static void option_shutdown(struct usb_serial
*serial
);
53 static void option_rx_throttle(struct usb_serial_port
*port
);
54 static void option_rx_unthrottle(struct usb_serial_port
*port
);
55 static int option_write_room(struct usb_serial_port
*port
);
57 static void option_instat_callback(struct urb
*urb
, struct pt_regs
*regs
);
59 static int option_write(struct usb_serial_port
*port
,
60 const unsigned char *buf
, int count
);
62 static int option_chars_in_buffer(struct usb_serial_port
*port
);
63 static int option_ioctl(struct usb_serial_port
*port
, struct file
*file
,
64 unsigned int cmd
, unsigned long arg
);
65 static void option_set_termios(struct usb_serial_port
*port
,
67 static void option_break_ctl(struct usb_serial_port
*port
, int break_state
);
68 static int option_tiocmget(struct usb_serial_port
*port
, struct file
*file
);
69 static int option_tiocmset(struct usb_serial_port
*port
, struct file
*file
,
70 unsigned int set
, unsigned int clear
);
71 static int option_send_setup(struct usb_serial_port
*port
);
73 /* Vendor and product IDs */
74 #define OPTION_VENDOR_ID 0x0AF0
75 #define HUAWEI_VENDOR_ID 0x12D1
76 #define AUDIOVOX_VENDOR_ID 0x0F3D
78 #define OPTION_PRODUCT_OLD 0x5000
79 #define OPTION_PRODUCT_FUSION 0x6000
80 #define OPTION_PRODUCT_FUSION2 0x6300
81 #define HUAWEI_PRODUCT_E600 0x1001
82 #define AUDIOVOX_PRODUCT_AIRCARD 0x0112
84 static struct usb_device_id option_ids
[] = {
85 { USB_DEVICE(OPTION_VENDOR_ID
, OPTION_PRODUCT_OLD
) },
86 { USB_DEVICE(OPTION_VENDOR_ID
, OPTION_PRODUCT_FUSION
) },
87 { USB_DEVICE(OPTION_VENDOR_ID
, OPTION_PRODUCT_FUSION2
) },
88 { USB_DEVICE(HUAWEI_VENDOR_ID
, HUAWEI_PRODUCT_E600
) },
89 { USB_DEVICE(AUDIOVOX_VENDOR_ID
, AUDIOVOX_PRODUCT_AIRCARD
) },
90 { } /* Terminating entry */
93 MODULE_DEVICE_TABLE(usb
, option_ids
);
95 static struct usb_driver option_driver
= {
98 .probe
= usb_serial_probe
,
99 .disconnect
= usb_serial_disconnect
,
100 .id_table
= option_ids
,
103 /* The card has three separate interfaces, wich the serial driver
104 * recognizes separately, thus num_port=1.
106 static struct usb_serial_device_type option_3port_device
= {
107 .owner
= THIS_MODULE
,
108 .name
= "Option 3G data card",
109 .short_name
= "option",
110 .id_table
= option_ids
,
111 .num_interrupt_in
= NUM_DONT_CARE
,
112 .num_bulk_in
= NUM_DONT_CARE
,
113 .num_bulk_out
= NUM_DONT_CARE
,
114 .num_ports
= 1, /* 3, but the card reports its ports separately */
116 .close
= option_close
,
117 .write
= option_write
,
118 .write_room
= option_write_room
,
119 .chars_in_buffer
= option_chars_in_buffer
,
120 .throttle
= option_rx_throttle
,
121 .unthrottle
= option_rx_unthrottle
,
122 .ioctl
= option_ioctl
,
123 .set_termios
= option_set_termios
,
124 .break_ctl
= option_break_ctl
,
125 .tiocmget
= option_tiocmget
,
126 .tiocmset
= option_tiocmset
,
127 .attach
= option_startup
,
128 .shutdown
= option_shutdown
,
129 .read_int_callback
= option_instat_callback
,
132 #ifdef CONFIG_USB_DEBUG
138 /* per port private data */
142 #define IN_BUFLEN 1024
143 #define OUT_BUFLEN 128
145 struct option_port_private
{
146 /* Input endpoints and buffer for this port */
147 struct urb
*in_urbs
[N_IN_URB
];
148 char in_buffer
[N_IN_URB
][IN_BUFLEN
];
149 /* Output endpoints and buffer for this port */
150 struct urb
*out_urbs
[N_OUT_URB
];
151 char out_buffer
[N_OUT_URB
][OUT_BUFLEN
];
153 /* Settings for the port */
154 int rts_state
; /* Handshaking pins (outputs) */
156 int cts_state
; /* Handshaking pins (inputs) */
161 unsigned long tx_start_time
[N_OUT_URB
];
164 /* Functions used by new usb-serial code. */
165 static int __init
option_init(void)
168 retval
= usb_serial_register(&option_3port_device
);
170 goto failed_3port_device_register
;
171 retval
= usb_register(&option_driver
);
173 goto failed_driver_register
;
175 info(DRIVER_DESC
": " DRIVER_VERSION
);
179 failed_driver_register
:
180 usb_serial_deregister (&option_3port_device
);
181 failed_3port_device_register
:
185 static void __exit
option_exit(void)
187 usb_deregister (&option_driver
);
188 usb_serial_deregister (&option_3port_device
);
191 module_init(option_init
);
192 module_exit(option_exit
);
194 static void option_rx_throttle(struct usb_serial_port
*port
)
196 dbg("%s", __FUNCTION__
);
199 static void option_rx_unthrottle(struct usb_serial_port
*port
)
201 dbg("%s", __FUNCTION__
);
204 static void option_break_ctl(struct usb_serial_port
*port
, int break_state
)
206 /* Unfortunately, I don't know how to send a break */
207 dbg("%s", __FUNCTION__
);
210 static void option_set_termios(struct usb_serial_port
*port
,
211 struct termios
*old_termios
)
213 dbg("%s", __FUNCTION__
);
215 option_send_setup(port
);
218 static int option_tiocmget(struct usb_serial_port
*port
, struct file
*file
)
221 struct option_port_private
*portdata
;
223 portdata
= usb_get_serial_port_data(port
);
225 value
= ((portdata
->rts_state
) ? TIOCM_RTS
: 0) |
226 ((portdata
->dtr_state
) ? TIOCM_DTR
: 0) |
227 ((portdata
->cts_state
) ? TIOCM_CTS
: 0) |
228 ((portdata
->dsr_state
) ? TIOCM_DSR
: 0) |
229 ((portdata
->dcd_state
) ? TIOCM_CAR
: 0) |
230 ((portdata
->ri_state
) ? TIOCM_RNG
: 0);
235 static int option_tiocmset(struct usb_serial_port
*port
, struct file
*file
,
236 unsigned int set
, unsigned int clear
)
238 struct option_port_private
*portdata
;
240 portdata
= usb_get_serial_port_data(port
);
243 portdata
->rts_state
= 1;
245 portdata
->dtr_state
= 1;
247 if (clear
& TIOCM_RTS
)
248 portdata
->rts_state
= 0;
249 if (clear
& TIOCM_DTR
)
250 portdata
->dtr_state
= 0;
251 return option_send_setup(port
);
254 static int option_ioctl(struct usb_serial_port
*port
, struct file
*file
,
255 unsigned int cmd
, unsigned long arg
)
261 static int option_write(struct usb_serial_port
*port
,
262 const unsigned char *buf
, int count
)
264 struct option_port_private
*portdata
;
267 struct urb
*this_urb
= NULL
; /* spurious */
270 portdata
= usb_get_serial_port_data(port
);
272 dbg("%s: write (%d chars)", __FUNCTION__
, count
);
276 for (i
=0; left
> 0 && i
< N_OUT_URB
; i
++) {
278 if (todo
> OUT_BUFLEN
)
281 this_urb
= portdata
->out_urbs
[i
];
282 if (this_urb
->status
== -EINPROGRESS
) {
283 if (time_before(jiffies
,
284 portdata
->tx_start_time
[i
] + 10 * HZ
))
286 usb_unlink_urb(this_urb
);
289 if (this_urb
->status
!= 0)
290 dbg("usb_write %p failed (err=%d)",
291 this_urb
, this_urb
->status
);
293 dbg("%s: endpoint %d buf %d", __FUNCTION__
,
294 usb_pipeendpoint(this_urb
->pipe
), i
);
297 memcpy (this_urb
->transfer_buffer
, buf
, todo
);
298 this_urb
->transfer_buffer_length
= todo
;
300 this_urb
->dev
= port
->serial
->dev
;
301 err
= usb_submit_urb(this_urb
, GFP_ATOMIC
);
303 dbg("usb_submit_urb %p (write bulk) failed "
304 "(%d, has %d)", this_urb
,
305 err
, this_urb
->status
);
308 portdata
->tx_start_time
[i
] = jiffies
;
314 dbg("%s: wrote (did %d)", __FUNCTION__
, count
);
318 static void option_indat_callback(struct urb
*urb
, struct pt_regs
*regs
)
322 struct usb_serial_port
*port
;
323 struct tty_struct
*tty
;
324 unsigned char *data
= urb
->transfer_buffer
;
326 dbg("%s: %p", __FUNCTION__
, urb
);
328 endpoint
= usb_pipeendpoint(urb
->pipe
);
329 port
= (struct usb_serial_port
*) urb
->context
;
332 dbg("%s: nonzero status: %d on endpoint %02x.",
333 __FUNCTION__
, urb
->status
, endpoint
);
336 if (urb
->actual_length
) {
337 for (i
= 0; i
< urb
->actual_length
; ++i
) {
338 if (tty
->flip
.count
>= TTY_FLIPBUF_SIZE
)
339 tty_flip_buffer_push(tty
);
340 tty_insert_flip_char(tty
, data
[i
], 0);
342 tty_flip_buffer_push(tty
);
344 dbg("%s: empty read urb received", __FUNCTION__
);
347 /* Resubmit urb so we continue receiving */
348 if (port
->open_count
&& urb
->status
!= -ESHUTDOWN
) {
349 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
351 printk(KERN_ERR
"%s: resubmit read urb failed. "
352 "(%d)", __FUNCTION__
, err
);
358 static void option_outdat_callback(struct urb
*urb
, struct pt_regs
*regs
)
360 struct usb_serial_port
*port
;
362 dbg("%s", __FUNCTION__
);
364 port
= (struct usb_serial_port
*) urb
->context
;
366 if (port
->open_count
)
367 schedule_work(&port
->work
);
370 static void option_instat_callback(struct urb
*urb
, struct pt_regs
*regs
)
373 struct usb_serial_port
*port
= (struct usb_serial_port
*) urb
->context
;
374 struct option_port_private
*portdata
= usb_get_serial_port_data(port
);
375 struct usb_serial
*serial
= port
->serial
;
377 dbg("%s", __FUNCTION__
);
378 dbg("%s: urb %p port %p has data %p", __FUNCTION__
,urb
,port
,portdata
);
380 if (urb
->status
== 0) {
381 struct usb_ctrlrequest
*req_pkt
=
382 (struct usb_ctrlrequest
*)urb
->transfer_buffer
;
385 dbg("%s: NULL req_pkt\n", __FUNCTION__
);
388 if ((req_pkt
->bRequestType
== 0xA1) &&
389 (req_pkt
->bRequest
== 0x20)) {
391 unsigned char signals
= *((unsigned char *)
392 urb
->transfer_buffer
+
393 sizeof(struct usb_ctrlrequest
));
395 dbg("%s: signal x%x", __FUNCTION__
, signals
);
397 old_dcd_state
= portdata
->dcd_state
;
398 portdata
->cts_state
= 1;
399 portdata
->dcd_state
= ((signals
& 0x01) ? 1 : 0);
400 portdata
->dsr_state
= ((signals
& 0x02) ? 1 : 0);
401 portdata
->ri_state
= ((signals
& 0x08) ? 1 : 0);
403 if (port
->tty
&& !C_CLOCAL(port
->tty
) &&
404 old_dcd_state
&& !portdata
->dcd_state
)
405 tty_hangup(port
->tty
);
407 dbg("%s: type %x req %x", __FUNCTION__
,
408 req_pkt
->bRequestType
,req_pkt
->bRequest
);
411 dbg("%s: error %d", __FUNCTION__
, urb
->status
);
413 /* Resubmit urb so we continue receiving IRQ data */
414 if (urb
->status
!= -ESHUTDOWN
) {
415 urb
->dev
= serial
->dev
;
416 err
= usb_submit_urb(urb
, GFP_ATOMIC
);
418 dbg("%s: resubmit intr urb failed. (%d)",
423 static int option_write_room(struct usb_serial_port
*port
)
425 struct option_port_private
*portdata
;
428 struct urb
*this_urb
;
430 portdata
= usb_get_serial_port_data(port
);
432 for (i
=0; i
< N_OUT_URB
; i
++) {
433 this_urb
= portdata
->out_urbs
[i
];
434 if (this_urb
&& this_urb
->status
!= -EINPROGRESS
)
435 data_len
+= OUT_BUFLEN
;
438 dbg("%s: %d", __FUNCTION__
, data_len
);
442 static int option_chars_in_buffer(struct usb_serial_port
*port
)
444 struct option_port_private
*portdata
;
447 struct urb
*this_urb
;
449 portdata
= usb_get_serial_port_data(port
);
451 for (i
=0; i
< N_OUT_URB
; i
++) {
452 this_urb
= portdata
->out_urbs
[i
];
453 if (this_urb
&& this_urb
->status
== -EINPROGRESS
)
454 data_len
+= this_urb
->transfer_buffer_length
;
456 dbg("%s: %d", __FUNCTION__
, data_len
);
460 static int option_open(struct usb_serial_port
*port
, struct file
*filp
)
462 struct option_port_private
*portdata
;
463 struct usb_serial
*serial
= port
->serial
;
467 portdata
= usb_get_serial_port_data(port
);
469 dbg("%s", __FUNCTION__
);
471 /* Set some sane defaults */
472 portdata
->rts_state
= 1;
473 portdata
->dtr_state
= 1;
475 /* Reset low level data toggle and start reading from endpoints */
476 for (i
= 0; i
< N_IN_URB
; i
++) {
477 urb
= portdata
->in_urbs
[i
];
480 if (urb
->dev
!= serial
->dev
) {
481 dbg("%s: dev %p != %p", __FUNCTION__
,
482 urb
->dev
, serial
->dev
);
487 * make sure endpoint data toggle is synchronized with the
490 usb_clear_halt(urb
->dev
, urb
->pipe
);
492 err
= usb_submit_urb(urb
, GFP_KERNEL
);
494 dbg("%s: submit urb %d failed (%d) %d",
495 __FUNCTION__
, i
, err
,
496 urb
->transfer_buffer_length
);
500 /* Reset low level data toggle on out endpoints */
501 for (i
= 0; i
< N_OUT_URB
; i
++) {
502 urb
= portdata
->out_urbs
[i
];
505 urb
->dev
= serial
->dev
;
506 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
507 usb_pipeout(urb->pipe), 0); */
510 port
->tty
->low_latency
= 1;
512 option_send_setup(port
);
517 static inline void stop_urb(struct urb
*urb
)
519 if (urb
&& urb
->status
== -EINPROGRESS
)
523 static void option_close(struct usb_serial_port
*port
, struct file
*filp
)
526 struct usb_serial
*serial
= port
->serial
;
527 struct option_port_private
*portdata
;
529 dbg("%s", __FUNCTION__
);
530 portdata
= usb_get_serial_port_data(port
);
532 portdata
->rts_state
= 0;
533 portdata
->dtr_state
= 0;
536 option_send_setup(port
);
538 /* Stop reading/writing urbs */
539 for (i
= 0; i
< N_IN_URB
; i
++)
540 stop_urb(portdata
->in_urbs
[i
]);
541 for (i
= 0; i
< N_OUT_URB
; i
++)
542 stop_urb(portdata
->out_urbs
[i
]);
547 /* Helper functions used by option_setup_urbs */
548 static struct urb
*option_setup_urb(struct usb_serial
*serial
, int endpoint
,
549 int dir
, void *ctx
, char *buf
, int len
,
550 void (*callback
)(struct urb
*, struct pt_regs
*regs
))
555 return NULL
; /* endpoint not needed */
557 urb
= usb_alloc_urb(0, GFP_KERNEL
); /* No ISO */
559 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__
, endpoint
);
563 /* Fill URB using supplied data. */
564 usb_fill_bulk_urb(urb
, serial
->dev
,
565 usb_sndbulkpipe(serial
->dev
, endpoint
) | dir
,
566 buf
, len
, callback
, ctx
);
572 static void option_setup_urbs(struct usb_serial
*serial
)
575 struct usb_serial_port
*port
;
576 struct option_port_private
*portdata
;
578 dbg("%s", __FUNCTION__
);
580 port
= serial
->port
[0];
581 portdata
= usb_get_serial_port_data(port
);
583 /* Do indat endpoints first */
584 for (j
= 0; j
<= N_IN_URB
; ++j
) {
585 portdata
->in_urbs
[j
] = option_setup_urb (serial
,
586 port
->bulk_in_endpointAddress
, USB_DIR_IN
, port
,
587 portdata
->in_buffer
[j
], IN_BUFLEN
, option_indat_callback
);
590 /* outdat endpoints */
591 for (j
= 0; j
<= N_OUT_URB
; ++j
) {
592 portdata
->out_urbs
[j
] = option_setup_urb (serial
,
593 port
->bulk_out_endpointAddress
, USB_DIR_OUT
, port
,
594 portdata
->out_buffer
[j
], OUT_BUFLEN
, option_outdat_callback
);
598 static int option_send_setup(struct usb_serial_port
*port
)
600 struct usb_serial
*serial
= port
->serial
;
601 struct option_port_private
*portdata
;
603 dbg("%s", __FUNCTION__
);
605 portdata
= usb_get_serial_port_data(port
);
609 if (portdata
->dtr_state
)
611 if (portdata
->rts_state
)
614 return usb_control_msg(serial
->dev
,
615 usb_rcvctrlpipe(serial
->dev
, 0),
616 0x22,0x21,val
,0,NULL
,0,USB_CTRL_SET_TIMEOUT
);
622 static int option_startup(struct usb_serial
*serial
)
625 struct usb_serial_port
*port
;
626 struct option_port_private
*portdata
;
628 dbg("%s", __FUNCTION__
);
630 /* Now setup per port private data */
631 for (i
= 0; i
< serial
->num_ports
; i
++) {
632 port
= serial
->port
[i
];
633 portdata
= kmalloc(sizeof(*portdata
), GFP_KERNEL
);
635 dbg("%s: kmalloc for option_port_private (%d) failed!.",
639 memset(portdata
, 0, sizeof(struct option_port_private
));
641 usb_set_serial_port_data(port
, portdata
);
643 if (! port
->interrupt_in_urb
)
645 err
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
647 dbg("%s: submit irq_in urb failed %d",
651 option_setup_urbs(serial
);
656 static void option_shutdown(struct usb_serial
*serial
)
659 struct usb_serial_port
*port
;
660 struct option_port_private
*portdata
;
662 dbg("%s", __FUNCTION__
);
664 /* Stop reading/writing urbs */
665 for (i
= 0; i
< serial
->num_ports
; ++i
) {
666 port
= serial
->port
[i
];
667 portdata
= usb_get_serial_port_data(port
);
668 for (j
= 0; j
< N_IN_URB
; j
++)
669 stop_urb(portdata
->in_urbs
[j
]);
670 for (j
= 0; j
< N_OUT_URB
; j
++)
671 stop_urb(portdata
->out_urbs
[j
]);
675 for (i
= 0; i
< serial
->num_ports
; ++i
) {
676 port
= serial
->port
[i
];
677 portdata
= usb_get_serial_port_data(port
);
679 for (j
= 0; j
< N_IN_URB
; j
++) {
680 if (portdata
->in_urbs
[j
]) {
681 usb_free_urb(portdata
->in_urbs
[j
]);
682 portdata
->in_urbs
[j
] = NULL
;
685 for (j
= 0; j
< N_OUT_URB
; j
++) {
686 if (portdata
->out_urbs
[j
]) {
687 usb_free_urb(portdata
->out_urbs
[j
]);
688 portdata
->out_urbs
[j
] = NULL
;
693 /* Now free per port private data */
694 for (i
= 0; i
< serial
->num_ports
; i
++) {
695 port
= serial
->port
[i
];
696 kfree(usb_get_serial_port_data(port
));
700 MODULE_AUTHOR(DRIVER_AUTHOR
);
701 MODULE_DESCRIPTION(DRIVER_DESC
);
702 MODULE_VERSION(DRIVER_VERSION
);
703 MODULE_LICENSE("GPL");
705 #ifdef CONFIG_USB_DEBUG
706 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
707 MODULE_PARM_DESC(debug
, "Debug messages");