2 USB Driver for Sierra Wireless
4 Copyright (C) 2006 Kevin Lloyd <linux@sierrawireless.com>
6 IMPORTANT DISCLAIMER: This driver is not commercially supported by
7 Sierra Wireless. Use at your own risk.
9 This driver is free software; you can redistribute it and/or modify
10 it under the terms of Version 2 of the GNU General Public License as
11 published by the Free Software Foundation.
13 Portions based on the option driver by Matthias Urlichs <smurf@smurf.noris.de>
14 Whom based his on the Keyspan driver by Hugh Blemings <hugh@blemings.org>
19 #define DRIVER_VERSION "v.1.0.5"
20 #define DRIVER_AUTHOR "Kevin Lloyd <linux@sierrawireless.com>"
21 #define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
23 #include <linux/kernel.h>
24 #include <linux/jiffies.h>
25 #include <linux/errno.h>
26 #include <linux/tty.h>
27 #include <linux/tty_flip.h>
28 #include <linux/module.h>
29 #include <linux/usb.h>
30 #include <linux/usb/serial.h>
33 static struct usb_device_id id_table [] = {
34 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
35 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
36 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
37 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
38 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
39 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
40 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
41 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
43 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
44 { USB_DEVICE(0x0F3D, 0x0112) }, /* AirPrime/Sierra PC 5220 */
47 MODULE_DEVICE_TABLE(usb, id_table);
49 static struct usb_device_id id_table_1port [] = {
50 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
51 { USB_DEVICE(0x0F3D, 0x0112) }, /* AirPrime/Sierra PC 5220 */
55 static struct usb_device_id id_table_3port [] = {
56 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
57 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
58 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
59 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
60 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
61 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
62 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
63 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
67 static struct usb_driver sierra_driver = {
69 .probe = usb_serial_probe,
70 .disconnect = usb_serial_disconnect,
78 /* per port private data */
81 #define IN_BUFLEN 4096
82 #define OUT_BUFLEN 128
84 struct sierra_port_private {
85 /* Input endpoints and buffer for this port */
86 struct urb *in_urbs[N_IN_URB];
87 char in_buffer[N_IN_URB][IN_BUFLEN];
88 /* Output endpoints and buffer for this port */
89 struct urb *out_urbs[N_OUT_URB];
90 char out_buffer[N_OUT_URB][OUT_BUFLEN];
92 /* Settings for the port */
93 int rts_state; /* Handshaking pins (outputs) */
95 int cts_state; /* Handshaking pins (inputs) */
100 unsigned long tx_start_time[N_OUT_URB];
103 static int sierra_send_setup(struct usb_serial_port *port)
105 struct usb_serial *serial = port->serial;
106 struct sierra_port_private *portdata;
108 dbg("%s", __FUNCTION__);
110 portdata = usb_get_serial_port_data(port);
114 if (portdata->dtr_state)
116 if (portdata->rts_state)
119 return usb_control_msg(serial->dev,
120 usb_rcvctrlpipe(serial->dev, 0),
121 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
127 static void sierra_rx_throttle(struct usb_serial_port *port)
129 dbg("%s", __FUNCTION__);
132 static void sierra_rx_unthrottle(struct usb_serial_port *port)
134 dbg("%s", __FUNCTION__);
137 static void sierra_break_ctl(struct usb_serial_port *port, int break_state)
139 /* Unfortunately, I don't know how to send a break */
140 dbg("%s", __FUNCTION__);
143 static void sierra_set_termios(struct usb_serial_port *port,
144 struct termios *old_termios)
146 dbg("%s", __FUNCTION__);
148 sierra_send_setup(port);
151 static int sierra_tiocmget(struct usb_serial_port *port, struct file *file)
154 struct sierra_port_private *portdata;
156 portdata = usb_get_serial_port_data(port);
158 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
159 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
160 ((portdata->cts_state) ? TIOCM_CTS : 0) |
161 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
162 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
163 ((portdata->ri_state) ? TIOCM_RNG : 0);
168 static int sierra_tiocmset(struct usb_serial_port *port, struct file *file,
169 unsigned int set, unsigned int clear)
171 struct sierra_port_private *portdata;
173 portdata = usb_get_serial_port_data(port);
176 portdata->rts_state = 1;
178 portdata->dtr_state = 1;
180 if (clear & TIOCM_RTS)
181 portdata->rts_state = 0;
182 if (clear & TIOCM_DTR)
183 portdata->dtr_state = 0;
184 return sierra_send_setup(port);
187 static int sierra_ioctl(struct usb_serial_port *port, struct file *file,
188 unsigned int cmd, unsigned long arg)
194 static int sierra_write(struct usb_serial_port *port,
195 const unsigned char *buf, int count)
197 struct sierra_port_private *portdata;
200 struct urb *this_urb = NULL; /* spurious */
203 portdata = usb_get_serial_port_data(port);
205 dbg("%s: write (%d chars)", __FUNCTION__, count);
209 for (i=0; left > 0 && i < N_OUT_URB; i++) {
211 if (todo > OUT_BUFLEN)
214 this_urb = portdata->out_urbs[i];
215 if (this_urb->status == -EINPROGRESS) {
216 if (time_before(jiffies,
217 portdata->tx_start_time[i] + 10 * HZ))
219 usb_unlink_urb(this_urb);
222 if (this_urb->status != 0)
223 dbg("usb_write %p failed (err=%d)",
224 this_urb, this_urb->status);
226 dbg("%s: endpoint %d buf %d", __FUNCTION__,
227 usb_pipeendpoint(this_urb->pipe), i);
230 memcpy (this_urb->transfer_buffer, buf, todo);
231 this_urb->transfer_buffer_length = todo;
233 this_urb->dev = port->serial->dev;
234 err = usb_submit_urb(this_urb, GFP_ATOMIC);
236 dbg("usb_submit_urb %p (write bulk) failed "
237 "(%d, has %d)", this_urb,
238 err, this_urb->status);
241 portdata->tx_start_time[i] = jiffies;
247 dbg("%s: wrote (did %d)", __FUNCTION__, count);
251 static void sierra_indat_callback(struct urb *urb)
255 struct usb_serial_port *port;
256 struct tty_struct *tty;
257 unsigned char *data = urb->transfer_buffer;
259 dbg("%s: %p", __FUNCTION__, urb);
261 endpoint = usb_pipeendpoint(urb->pipe);
262 port = (struct usb_serial_port *) urb->context;
265 dbg("%s: nonzero status: %d on endpoint %02x.",
266 __FUNCTION__, urb->status, endpoint);
269 if (urb->actual_length) {
270 tty_buffer_request_room(tty, urb->actual_length);
271 tty_insert_flip_string(tty, data, urb->actual_length);
272 tty_flip_buffer_push(tty);
274 dbg("%s: empty read urb received", __FUNCTION__);
277 /* Resubmit urb so we continue receiving */
278 if (port->open_count && urb->status != -ESHUTDOWN) {
279 err = usb_submit_urb(urb, GFP_ATOMIC);
281 printk(KERN_ERR "%s: resubmit read urb failed. "
282 "(%d)", __FUNCTION__, err);
288 static void sierra_outdat_callback(struct urb *urb)
290 struct usb_serial_port *port;
292 dbg("%s", __FUNCTION__);
294 port = (struct usb_serial_port *) urb->context;
296 usb_serial_port_softint(port);
299 static void sierra_instat_callback(struct urb *urb)
302 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
303 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
304 struct usb_serial *serial = port->serial;
306 dbg("%s", __FUNCTION__);
307 dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
309 if (urb->status == 0) {
310 struct usb_ctrlrequest *req_pkt =
311 (struct usb_ctrlrequest *)urb->transfer_buffer;
314 dbg("%s: NULL req_pkt\n", __FUNCTION__);
317 if ((req_pkt->bRequestType == 0xA1) &&
318 (req_pkt->bRequest == 0x20)) {
320 unsigned char signals = *((unsigned char *)
321 urb->transfer_buffer +
322 sizeof(struct usb_ctrlrequest));
324 dbg("%s: signal x%x", __FUNCTION__, signals);
326 old_dcd_state = portdata->dcd_state;
327 portdata->cts_state = 1;
328 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
329 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
330 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
332 if (port->tty && !C_CLOCAL(port->tty) &&
333 old_dcd_state && !portdata->dcd_state)
334 tty_hangup(port->tty);
336 dbg("%s: type %x req %x", __FUNCTION__,
337 req_pkt->bRequestType,req_pkt->bRequest);
340 dbg("%s: error %d", __FUNCTION__, urb->status);
342 /* Resubmit urb so we continue receiving IRQ data */
343 if (urb->status != -ESHUTDOWN) {
344 urb->dev = serial->dev;
345 err = usb_submit_urb(urb, GFP_ATOMIC);
347 dbg("%s: resubmit intr urb failed. (%d)",
352 static int sierra_write_room(struct usb_serial_port *port)
354 struct sierra_port_private *portdata;
357 struct urb *this_urb;
359 portdata = usb_get_serial_port_data(port);
361 for (i=0; i < N_OUT_URB; i++) {
362 this_urb = portdata->out_urbs[i];
363 if (this_urb && this_urb->status != -EINPROGRESS)
364 data_len += OUT_BUFLEN;
367 dbg("%s: %d", __FUNCTION__, data_len);
371 static int sierra_chars_in_buffer(struct usb_serial_port *port)
373 struct sierra_port_private *portdata;
376 struct urb *this_urb;
378 portdata = usb_get_serial_port_data(port);
380 for (i=0; i < N_OUT_URB; i++) {
381 this_urb = portdata->out_urbs[i];
382 if (this_urb && this_urb->status == -EINPROGRESS)
383 data_len += this_urb->transfer_buffer_length;
385 dbg("%s: %d", __FUNCTION__, data_len);
389 static int sierra_open(struct usb_serial_port *port, struct file *filp)
391 struct sierra_port_private *portdata;
392 struct usb_serial *serial = port->serial;
396 portdata = usb_get_serial_port_data(port);
398 dbg("%s", __FUNCTION__);
400 /* Set some sane defaults */
401 portdata->rts_state = 1;
402 portdata->dtr_state = 1;
404 /* Reset low level data toggle and start reading from endpoints */
405 for (i = 0; i < N_IN_URB; i++) {
406 urb = portdata->in_urbs[i];
409 if (urb->dev != serial->dev) {
410 dbg("%s: dev %p != %p", __FUNCTION__,
411 urb->dev, serial->dev);
416 * make sure endpoint data toggle is synchronized with the
419 usb_clear_halt(urb->dev, urb->pipe);
421 err = usb_submit_urb(urb, GFP_KERNEL);
423 dbg("%s: submit urb %d failed (%d) %d",
424 __FUNCTION__, i, err,
425 urb->transfer_buffer_length);
429 /* Reset low level data toggle on out endpoints */
430 for (i = 0; i < N_OUT_URB; i++) {
431 urb = portdata->out_urbs[i];
434 urb->dev = serial->dev;
435 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
436 usb_pipeout(urb->pipe), 0); */
439 port->tty->low_latency = 1;
441 sierra_send_setup(port);
446 static inline void stop_urb(struct urb *urb)
448 if (urb && urb->status == -EINPROGRESS)
452 static void sierra_close(struct usb_serial_port *port, struct file *filp)
455 struct usb_serial *serial = port->serial;
456 struct sierra_port_private *portdata;
458 dbg("%s", __FUNCTION__);
459 portdata = usb_get_serial_port_data(port);
461 portdata->rts_state = 0;
462 portdata->dtr_state = 0;
465 sierra_send_setup(port);
467 /* Stop reading/writing urbs */
468 for (i = 0; i < N_IN_URB; i++)
469 stop_urb(portdata->in_urbs[i]);
470 for (i = 0; i < N_OUT_URB; i++)
471 stop_urb(portdata->out_urbs[i]);
476 /* Helper functions used by sierra_setup_urbs */
477 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
478 int dir, void *ctx, char *buf, int len,
479 usb_complete_t callback)
484 return NULL; /* endpoint not needed */
486 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
488 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__, endpoint);
492 /* Fill URB using supplied data. */
493 usb_fill_bulk_urb(urb, serial->dev,
494 usb_sndbulkpipe(serial->dev, endpoint) | dir,
495 buf, len, callback, ctx);
501 static void sierra_setup_urbs(struct usb_serial *serial)
504 struct usb_serial_port *port;
505 struct sierra_port_private *portdata;
507 dbg("%s", __FUNCTION__);
509 for (i = 0; i < serial->num_ports; i++) {
510 port = serial->port[i];
511 portdata = usb_get_serial_port_data(port);
513 /* Do indat endpoints first */
514 for (j = 0; j < N_IN_URB; ++j) {
515 portdata->in_urbs[j] = sierra_setup_urb (serial,
516 port->bulk_in_endpointAddress, USB_DIR_IN, port,
517 portdata->in_buffer[j], IN_BUFLEN, sierra_indat_callback);
520 /* outdat endpoints */
521 for (j = 0; j < N_OUT_URB; ++j) {
522 portdata->out_urbs[j] = sierra_setup_urb (serial,
523 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
524 portdata->out_buffer[j], OUT_BUFLEN, sierra_outdat_callback);
529 static int sierra_startup(struct usb_serial *serial)
532 struct usb_serial_port *port;
533 struct sierra_port_private *portdata;
535 dbg("%s", __FUNCTION__);
537 /* Now setup per port private data */
538 for (i = 0; i < serial->num_ports; i++) {
539 port = serial->port[i];
540 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
542 dbg("%s: kmalloc for sierra_port_private (%d) failed!.",
547 usb_set_serial_port_data(port, portdata);
549 if (! port->interrupt_in_urb)
551 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
553 dbg("%s: submit irq_in urb failed %d",
557 sierra_setup_urbs(serial);
562 static void sierra_shutdown(struct usb_serial *serial)
565 struct usb_serial_port *port;
566 struct sierra_port_private *portdata;
568 dbg("%s", __FUNCTION__);
570 /* Stop reading/writing urbs */
571 for (i = 0; i < serial->num_ports; ++i) {
572 port = serial->port[i];
573 portdata = usb_get_serial_port_data(port);
574 for (j = 0; j < N_IN_URB; j++)
575 stop_urb(portdata->in_urbs[j]);
576 for (j = 0; j < N_OUT_URB; j++)
577 stop_urb(portdata->out_urbs[j]);
581 for (i = 0; i < serial->num_ports; ++i) {
582 port = serial->port[i];
583 portdata = usb_get_serial_port_data(port);
585 for (j = 0; j < N_IN_URB; j++) {
586 if (portdata->in_urbs[j]) {
587 usb_free_urb(portdata->in_urbs[j]);
588 portdata->in_urbs[j] = NULL;
591 for (j = 0; j < N_OUT_URB; j++) {
592 if (portdata->out_urbs[j]) {
593 usb_free_urb(portdata->out_urbs[j]);
594 portdata->out_urbs[j] = NULL;
599 /* Now free per port private data */
600 for (i = 0; i < serial->num_ports; i++) {
601 port = serial->port[i];
602 kfree(usb_get_serial_port_data(port));
606 static struct usb_serial_driver sierra_1port_device = {
608 .owner = THIS_MODULE,
611 .description = "Sierra USB modem (1 port)",
612 .id_table = id_table_1port,
613 .num_interrupt_in = NUM_DONT_CARE,
618 .close = sierra_close,
619 .write = sierra_write,
620 .write_room = sierra_write_room,
621 .chars_in_buffer = sierra_chars_in_buffer,
622 .throttle = sierra_rx_throttle,
623 .unthrottle = sierra_rx_unthrottle,
624 .ioctl = sierra_ioctl,
625 .set_termios = sierra_set_termios,
626 .break_ctl = sierra_break_ctl,
627 .tiocmget = sierra_tiocmget,
628 .tiocmset = sierra_tiocmset,
629 .attach = sierra_startup,
630 .shutdown = sierra_shutdown,
631 .read_int_callback = sierra_instat_callback,
634 static struct usb_serial_driver sierra_3port_device = {
636 .owner = THIS_MODULE,
639 .description = "Sierra USB modem (3 port)",
640 .id_table = id_table_3port,
641 .num_interrupt_in = NUM_DONT_CARE,
646 .close = sierra_close,
647 .write = sierra_write,
648 .write_room = sierra_write_room,
649 .chars_in_buffer = sierra_chars_in_buffer,
650 .throttle = sierra_rx_throttle,
651 .unthrottle = sierra_rx_unthrottle,
652 .ioctl = sierra_ioctl,
653 .set_termios = sierra_set_termios,
654 .break_ctl = sierra_break_ctl,
655 .tiocmget = sierra_tiocmget,
656 .tiocmset = sierra_tiocmset,
657 .attach = sierra_startup,
658 .shutdown = sierra_shutdown,
659 .read_int_callback = sierra_instat_callback,
662 /* Functions used by new usb-serial code. */
663 static int __init sierra_init(void)
666 retval = usb_serial_register(&sierra_1port_device);
668 goto failed_1port_device_register;
669 retval = usb_serial_register(&sierra_3port_device);
671 goto failed_3port_device_register;
674 retval = usb_register(&sierra_driver);
676 goto failed_driver_register;
678 info(DRIVER_DESC ": " DRIVER_VERSION);
682 failed_driver_register:
683 usb_serial_deregister(&sierra_3port_device);
684 failed_3port_device_register:
685 usb_serial_deregister(&sierra_1port_device);
686 failed_1port_device_register:
690 static void __exit sierra_exit(void)
692 usb_deregister (&sierra_driver);
693 usb_serial_deregister(&sierra_1port_device);
694 usb_serial_deregister(&sierra_3port_device);
697 module_init(sierra_init);
698 module_exit(sierra_exit);
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");