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>
18 #define DRIVER_VERSION "v.1.0.6"
19 #define DRIVER_AUTHOR "Kevin Lloyd <linux@sierrawireless.com>"
20 #define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
22 #include <linux/kernel.h>
23 #include <linux/jiffies.h>
24 #include <linux/errno.h>
25 #include <linux/tty.h>
26 #include <linux/tty_flip.h>
27 #include <linux/module.h>
28 #include <linux/usb.h>
29 #include <linux/usb/serial.h>
32 static struct usb_device_id id_table [] = {
33 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
34 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
35 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
36 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
37 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
38 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless AirCard 595U */
39 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
40 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
41 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
42 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
43 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
44 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
46 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
47 { USB_DEVICE(0x0F3D, 0x0112) }, /* AirPrime/Sierra PC 5220 */
50 MODULE_DEVICE_TABLE(usb, id_table);
52 static struct usb_device_id id_table_1port [] = {
53 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
54 { USB_DEVICE(0x0F3D, 0x0112) }, /* AirPrime/Sierra PC 5220 */
58 static struct usb_device_id id_table_3port [] = {
59 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
60 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
61 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
62 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
63 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
64 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless AirCard 595U */
65 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
66 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
67 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
68 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
69 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
70 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
74 static struct usb_driver sierra_driver = {
76 .probe = usb_serial_probe,
77 .disconnect = usb_serial_disconnect,
85 /* per port private data */
88 #define IN_BUFLEN 4096
89 #define OUT_BUFLEN 128
91 struct sierra_port_private {
92 /* Input endpoints and buffer for this port */
93 struct urb *in_urbs[N_IN_URB];
94 char in_buffer[N_IN_URB][IN_BUFLEN];
95 /* Output endpoints and buffer for this port */
96 struct urb *out_urbs[N_OUT_URB];
97 char out_buffer[N_OUT_URB][OUT_BUFLEN];
99 /* Settings for the port */
100 int rts_state; /* Handshaking pins (outputs) */
102 int cts_state; /* Handshaking pins (inputs) */
107 unsigned long tx_start_time[N_OUT_URB];
110 static int sierra_send_setup(struct usb_serial_port *port)
112 struct usb_serial *serial = port->serial;
113 struct sierra_port_private *portdata;
115 dbg("%s", __FUNCTION__);
117 portdata = usb_get_serial_port_data(port);
121 if (portdata->dtr_state)
123 if (portdata->rts_state)
126 return usb_control_msg(serial->dev,
127 usb_rcvctrlpipe(serial->dev, 0),
128 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
134 static void sierra_rx_throttle(struct usb_serial_port *port)
136 dbg("%s", __FUNCTION__);
139 static void sierra_rx_unthrottle(struct usb_serial_port *port)
141 dbg("%s", __FUNCTION__);
144 static void sierra_break_ctl(struct usb_serial_port *port, int break_state)
146 /* Unfortunately, I don't know how to send a break */
147 dbg("%s", __FUNCTION__);
150 static void sierra_set_termios(struct usb_serial_port *port,
151 struct ktermios *old_termios)
153 dbg("%s", __FUNCTION__);
155 sierra_send_setup(port);
158 static int sierra_tiocmget(struct usb_serial_port *port, struct file *file)
161 struct sierra_port_private *portdata;
163 portdata = usb_get_serial_port_data(port);
165 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
166 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
167 ((portdata->cts_state) ? TIOCM_CTS : 0) |
168 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
169 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
170 ((portdata->ri_state) ? TIOCM_RNG : 0);
175 static int sierra_tiocmset(struct usb_serial_port *port, struct file *file,
176 unsigned int set, unsigned int clear)
178 struct sierra_port_private *portdata;
180 portdata = usb_get_serial_port_data(port);
183 portdata->rts_state = 1;
185 portdata->dtr_state = 1;
187 if (clear & TIOCM_RTS)
188 portdata->rts_state = 0;
189 if (clear & TIOCM_DTR)
190 portdata->dtr_state = 0;
191 return sierra_send_setup(port);
194 static int sierra_ioctl(struct usb_serial_port *port, struct file *file,
195 unsigned int cmd, unsigned long arg)
201 static int sierra_write(struct usb_serial_port *port,
202 const unsigned char *buf, int count)
204 struct sierra_port_private *portdata;
207 struct urb *this_urb = NULL; /* spurious */
210 portdata = usb_get_serial_port_data(port);
212 dbg("%s: write (%d chars)", __FUNCTION__, count);
216 for (i=0; left > 0 && i < N_OUT_URB; i++) {
218 if (todo > OUT_BUFLEN)
221 this_urb = portdata->out_urbs[i];
222 if (this_urb->status == -EINPROGRESS) {
223 if (time_before(jiffies,
224 portdata->tx_start_time[i] + 10 * HZ))
226 usb_unlink_urb(this_urb);
229 if (this_urb->status != 0)
230 dbg("usb_write %p failed (err=%d)",
231 this_urb, this_urb->status);
233 dbg("%s: endpoint %d buf %d", __FUNCTION__,
234 usb_pipeendpoint(this_urb->pipe), i);
237 memcpy (this_urb->transfer_buffer, buf, todo);
238 this_urb->transfer_buffer_length = todo;
240 this_urb->dev = port->serial->dev;
241 err = usb_submit_urb(this_urb, GFP_ATOMIC);
243 dbg("usb_submit_urb %p (write bulk) failed "
244 "(%d, has %d)", this_urb,
245 err, this_urb->status);
248 portdata->tx_start_time[i] = jiffies;
254 dbg("%s: wrote (did %d)", __FUNCTION__, count);
258 static void sierra_indat_callback(struct urb *urb)
262 struct usb_serial_port *port;
263 struct tty_struct *tty;
264 unsigned char *data = urb->transfer_buffer;
265 int status = urb->status;
267 dbg("%s: %p", __FUNCTION__, urb);
269 endpoint = usb_pipeendpoint(urb->pipe);
270 port = (struct usb_serial_port *) urb->context;
273 dbg("%s: nonzero status: %d on endpoint %02x.",
274 __FUNCTION__, status, endpoint);
277 if (urb->actual_length) {
278 tty_buffer_request_room(tty, urb->actual_length);
279 tty_insert_flip_string(tty, data, urb->actual_length);
280 tty_flip_buffer_push(tty);
282 dbg("%s: empty read urb received", __FUNCTION__);
285 /* Resubmit urb so we continue receiving */
286 if (port->open_count && status != -ESHUTDOWN) {
287 err = usb_submit_urb(urb, GFP_ATOMIC);
289 printk(KERN_ERR "%s: resubmit read urb failed. "
290 "(%d)", __FUNCTION__, err);
296 static void sierra_outdat_callback(struct urb *urb)
298 struct usb_serial_port *port;
300 dbg("%s", __FUNCTION__);
302 port = (struct usb_serial_port *) urb->context;
304 usb_serial_port_softint(port);
307 static void sierra_instat_callback(struct urb *urb)
310 int status = urb->status;
311 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
312 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
313 struct usb_serial *serial = port->serial;
315 dbg("%s", __FUNCTION__);
316 dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
319 struct usb_ctrlrequest *req_pkt =
320 (struct usb_ctrlrequest *)urb->transfer_buffer;
323 dbg("%s: NULL req_pkt\n", __FUNCTION__);
326 if ((req_pkt->bRequestType == 0xA1) &&
327 (req_pkt->bRequest == 0x20)) {
329 unsigned char signals = *((unsigned char *)
330 urb->transfer_buffer +
331 sizeof(struct usb_ctrlrequest));
333 dbg("%s: signal x%x", __FUNCTION__, signals);
335 old_dcd_state = portdata->dcd_state;
336 portdata->cts_state = 1;
337 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
338 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
339 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
341 if (port->tty && !C_CLOCAL(port->tty) &&
342 old_dcd_state && !portdata->dcd_state)
343 tty_hangup(port->tty);
345 dbg("%s: type %x req %x", __FUNCTION__,
346 req_pkt->bRequestType,req_pkt->bRequest);
349 dbg("%s: error %d", __FUNCTION__, status);
351 /* Resubmit urb so we continue receiving IRQ data */
352 if (status != -ESHUTDOWN) {
353 urb->dev = serial->dev;
354 err = usb_submit_urb(urb, GFP_ATOMIC);
356 dbg("%s: resubmit intr urb failed. (%d)",
361 static int sierra_write_room(struct usb_serial_port *port)
363 struct sierra_port_private *portdata;
366 struct urb *this_urb;
368 portdata = usb_get_serial_port_data(port);
370 for (i=0; i < N_OUT_URB; i++) {
371 this_urb = portdata->out_urbs[i];
372 if (this_urb && this_urb->status != -EINPROGRESS)
373 data_len += OUT_BUFLEN;
376 dbg("%s: %d", __FUNCTION__, data_len);
380 static int sierra_chars_in_buffer(struct usb_serial_port *port)
382 struct sierra_port_private *portdata;
385 struct urb *this_urb;
387 portdata = usb_get_serial_port_data(port);
389 for (i=0; i < N_OUT_URB; i++) {
390 this_urb = portdata->out_urbs[i];
391 if (this_urb && this_urb->status == -EINPROGRESS)
392 data_len += this_urb->transfer_buffer_length;
394 dbg("%s: %d", __FUNCTION__, data_len);
398 static int sierra_open(struct usb_serial_port *port, struct file *filp)
400 struct sierra_port_private *portdata;
401 struct usb_serial *serial = port->serial;
405 __u16 set_mode_dzero = 0x0000;
407 portdata = usb_get_serial_port_data(port);
409 dbg("%s", __FUNCTION__);
411 /* Set some sane defaults */
412 portdata->rts_state = 1;
413 portdata->dtr_state = 1;
415 /* Reset low level data toggle and start reading from endpoints */
416 for (i = 0; i < N_IN_URB; i++) {
417 urb = portdata->in_urbs[i];
420 if (urb->dev != serial->dev) {
421 dbg("%s: dev %p != %p", __FUNCTION__,
422 urb->dev, serial->dev);
427 * make sure endpoint data toggle is synchronized with the
430 usb_clear_halt(urb->dev, urb->pipe);
432 err = usb_submit_urb(urb, GFP_KERNEL);
434 dbg("%s: submit urb %d failed (%d) %d",
435 __FUNCTION__, i, err,
436 urb->transfer_buffer_length);
440 /* Reset low level data toggle on out endpoints */
441 for (i = 0; i < N_OUT_URB; i++) {
442 urb = portdata->out_urbs[i];
445 urb->dev = serial->dev;
446 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
447 usb_pipeout(urb->pipe), 0); */
450 port->tty->low_latency = 1;
453 result = usb_control_msg(serial->dev,
454 usb_rcvctrlpipe(serial->dev, 0),
455 0x00, 0x40, set_mode_dzero, 0, NULL,
456 0, USB_CTRL_SET_TIMEOUT);
458 sierra_send_setup(port);
463 static void sierra_close(struct usb_serial_port *port, struct file *filp)
466 struct usb_serial *serial = port->serial;
467 struct sierra_port_private *portdata;
469 dbg("%s", __FUNCTION__);
470 portdata = usb_get_serial_port_data(port);
472 portdata->rts_state = 0;
473 portdata->dtr_state = 0;
476 sierra_send_setup(port);
478 /* Stop reading/writing urbs */
479 for (i = 0; i < N_IN_URB; i++)
480 usb_unlink_urb(portdata->in_urbs[i]);
481 for (i = 0; i < N_OUT_URB; i++)
482 usb_unlink_urb(portdata->out_urbs[i]);
487 /* Helper functions used by sierra_setup_urbs */
488 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
489 int dir, void *ctx, char *buf, int len,
490 usb_complete_t callback)
495 return NULL; /* endpoint not needed */
497 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
499 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__, endpoint);
503 /* Fill URB using supplied data. */
504 usb_fill_bulk_urb(urb, serial->dev,
505 usb_sndbulkpipe(serial->dev, endpoint) | dir,
506 buf, len, callback, ctx);
512 static void sierra_setup_urbs(struct usb_serial *serial)
515 struct usb_serial_port *port;
516 struct sierra_port_private *portdata;
518 dbg("%s", __FUNCTION__);
520 for (i = 0; i < serial->num_ports; i++) {
521 port = serial->port[i];
522 portdata = usb_get_serial_port_data(port);
524 /* Do indat endpoints first */
525 for (j = 0; j < N_IN_URB; ++j) {
526 portdata->in_urbs[j] = sierra_setup_urb (serial,
527 port->bulk_in_endpointAddress, USB_DIR_IN, port,
528 portdata->in_buffer[j], IN_BUFLEN, sierra_indat_callback);
531 /* outdat endpoints */
532 for (j = 0; j < N_OUT_URB; ++j) {
533 portdata->out_urbs[j] = sierra_setup_urb (serial,
534 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
535 portdata->out_buffer[j], OUT_BUFLEN, sierra_outdat_callback);
540 static int sierra_startup(struct usb_serial *serial)
543 struct usb_serial_port *port;
544 struct sierra_port_private *portdata;
546 dbg("%s", __FUNCTION__);
548 /* Now setup per port private data */
549 for (i = 0; i < serial->num_ports; i++) {
550 port = serial->port[i];
551 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
553 dbg("%s: kmalloc for sierra_port_private (%d) failed!.",
558 usb_set_serial_port_data(port, portdata);
560 if (! port->interrupt_in_urb)
562 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
564 dbg("%s: submit irq_in urb failed %d",
568 sierra_setup_urbs(serial);
573 static void sierra_shutdown(struct usb_serial *serial)
576 struct usb_serial_port *port;
577 struct sierra_port_private *portdata;
579 dbg("%s", __FUNCTION__);
581 /* Stop reading/writing urbs */
582 for (i = 0; i < serial->num_ports; ++i) {
583 port = serial->port[i];
586 portdata = usb_get_serial_port_data(port);
590 for (j = 0; j < N_IN_URB; j++)
591 usb_unlink_urb(portdata->in_urbs[j]);
592 for (j = 0; j < N_OUT_URB; j++)
593 usb_unlink_urb(portdata->out_urbs[j]);
597 for (i = 0; i < serial->num_ports; ++i) {
598 port = serial->port[i];
601 portdata = usb_get_serial_port_data(port);
605 for (j = 0; j < N_IN_URB; j++) {
606 if (portdata->in_urbs[j]) {
607 usb_free_urb(portdata->in_urbs[j]);
608 portdata->in_urbs[j] = NULL;
611 for (j = 0; j < N_OUT_URB; j++) {
612 if (portdata->out_urbs[j]) {
613 usb_free_urb(portdata->out_urbs[j]);
614 portdata->out_urbs[j] = NULL;
619 /* Now free per port private data */
620 for (i = 0; i < serial->num_ports; i++) {
621 port = serial->port[i];
624 kfree(usb_get_serial_port_data(port));
628 static struct usb_serial_driver sierra_1port_device = {
630 .owner = THIS_MODULE,
633 .description = "Sierra USB modem (1 port)",
634 .id_table = id_table_1port,
635 .usb_driver = &sierra_driver,
636 .num_interrupt_in = NUM_DONT_CARE,
641 .close = sierra_close,
642 .write = sierra_write,
643 .write_room = sierra_write_room,
644 .chars_in_buffer = sierra_chars_in_buffer,
645 .throttle = sierra_rx_throttle,
646 .unthrottle = sierra_rx_unthrottle,
647 .ioctl = sierra_ioctl,
648 .set_termios = sierra_set_termios,
649 .break_ctl = sierra_break_ctl,
650 .tiocmget = sierra_tiocmget,
651 .tiocmset = sierra_tiocmset,
652 .attach = sierra_startup,
653 .shutdown = sierra_shutdown,
654 .read_int_callback = sierra_instat_callback,
657 static struct usb_serial_driver sierra_3port_device = {
659 .owner = THIS_MODULE,
662 .description = "Sierra USB modem (3 port)",
663 .id_table = id_table_3port,
664 .usb_driver = &sierra_driver,
665 .num_interrupt_in = NUM_DONT_CARE,
670 .close = sierra_close,
671 .write = sierra_write,
672 .write_room = sierra_write_room,
673 .chars_in_buffer = sierra_chars_in_buffer,
674 .throttle = sierra_rx_throttle,
675 .unthrottle = sierra_rx_unthrottle,
676 .ioctl = sierra_ioctl,
677 .set_termios = sierra_set_termios,
678 .break_ctl = sierra_break_ctl,
679 .tiocmget = sierra_tiocmget,
680 .tiocmset = sierra_tiocmset,
681 .attach = sierra_startup,
682 .shutdown = sierra_shutdown,
683 .read_int_callback = sierra_instat_callback,
686 /* Functions used by new usb-serial code. */
687 static int __init sierra_init(void)
690 retval = usb_serial_register(&sierra_1port_device);
692 goto failed_1port_device_register;
693 retval = usb_serial_register(&sierra_3port_device);
695 goto failed_3port_device_register;
698 retval = usb_register(&sierra_driver);
700 goto failed_driver_register;
702 info(DRIVER_DESC ": " DRIVER_VERSION);
706 failed_driver_register:
707 usb_serial_deregister(&sierra_3port_device);
708 failed_3port_device_register:
709 usb_serial_deregister(&sierra_1port_device);
710 failed_1port_device_register:
714 static void __exit sierra_exit(void)
716 usb_deregister (&sierra_driver);
717 usb_serial_deregister(&sierra_1port_device);
718 usb_serial_deregister(&sierra_3port_device);
721 module_init(sierra_init);
722 module_exit(sierra_exit);
724 MODULE_AUTHOR(DRIVER_AUTHOR);
725 MODULE_DESCRIPTION(DRIVER_DESC);
726 MODULE_VERSION(DRIVER_VERSION);
727 MODULE_LICENSE("GPL");
729 #ifdef CONFIG_USB_DEBUG
730 module_param(debug, bool, S_IRUGO | S_IWUSR);
731 MODULE_PARM_DESC(debug, "Debug messages");