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, 0x6804) }, /* Sierra Wireless MC8755 for Europe */
41 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
42 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
44 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
45 { USB_DEVICE(0x0F3D, 0x0112) }, /* AirPrime/Sierra PC 5220 */
48 MODULE_DEVICE_TABLE(usb, id_table);
50 static struct usb_device_id id_table_1port [] = {
51 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
52 { USB_DEVICE(0x0F3D, 0x0112) }, /* AirPrime/Sierra PC 5220 */
56 static struct usb_device_id id_table_3port [] = {
57 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
58 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
59 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
60 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
61 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
62 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
63 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 */
64 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
68 static struct usb_driver sierra_driver = {
70 .probe = usb_serial_probe,
71 .disconnect = usb_serial_disconnect,
79 /* per port private data */
82 #define IN_BUFLEN 4096
83 #define OUT_BUFLEN 128
85 struct sierra_port_private {
86 /* Input endpoints and buffer for this port */
87 struct urb *in_urbs[N_IN_URB];
88 char in_buffer[N_IN_URB][IN_BUFLEN];
89 /* Output endpoints and buffer for this port */
90 struct urb *out_urbs[N_OUT_URB];
91 char out_buffer[N_OUT_URB][OUT_BUFLEN];
93 /* Settings for the port */
94 int rts_state; /* Handshaking pins (outputs) */
96 int cts_state; /* Handshaking pins (inputs) */
101 unsigned long tx_start_time[N_OUT_URB];
104 static int sierra_send_setup(struct usb_serial_port *port)
106 struct usb_serial *serial = port->serial;
107 struct sierra_port_private *portdata;
109 dbg("%s", __FUNCTION__);
111 portdata = usb_get_serial_port_data(port);
115 if (portdata->dtr_state)
117 if (portdata->rts_state)
120 return usb_control_msg(serial->dev,
121 usb_rcvctrlpipe(serial->dev, 0),
122 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
128 static void sierra_rx_throttle(struct usb_serial_port *port)
130 dbg("%s", __FUNCTION__);
133 static void sierra_rx_unthrottle(struct usb_serial_port *port)
135 dbg("%s", __FUNCTION__);
138 static void sierra_break_ctl(struct usb_serial_port *port, int break_state)
140 /* Unfortunately, I don't know how to send a break */
141 dbg("%s", __FUNCTION__);
144 static void sierra_set_termios(struct usb_serial_port *port,
145 struct termios *old_termios)
147 dbg("%s", __FUNCTION__);
149 sierra_send_setup(port);
152 static int sierra_tiocmget(struct usb_serial_port *port, struct file *file)
155 struct sierra_port_private *portdata;
157 portdata = usb_get_serial_port_data(port);
159 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
160 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
161 ((portdata->cts_state) ? TIOCM_CTS : 0) |
162 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
163 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
164 ((portdata->ri_state) ? TIOCM_RNG : 0);
169 static int sierra_tiocmset(struct usb_serial_port *port, struct file *file,
170 unsigned int set, unsigned int clear)
172 struct sierra_port_private *portdata;
174 portdata = usb_get_serial_port_data(port);
177 portdata->rts_state = 1;
179 portdata->dtr_state = 1;
181 if (clear & TIOCM_RTS)
182 portdata->rts_state = 0;
183 if (clear & TIOCM_DTR)
184 portdata->dtr_state = 0;
185 return sierra_send_setup(port);
188 static int sierra_ioctl(struct usb_serial_port *port, struct file *file,
189 unsigned int cmd, unsigned long arg)
195 static int sierra_write(struct usb_serial_port *port,
196 const unsigned char *buf, int count)
198 struct sierra_port_private *portdata;
201 struct urb *this_urb = NULL; /* spurious */
204 portdata = usb_get_serial_port_data(port);
206 dbg("%s: write (%d chars)", __FUNCTION__, count);
210 for (i=0; left > 0 && i < N_OUT_URB; i++) {
212 if (todo > OUT_BUFLEN)
215 this_urb = portdata->out_urbs[i];
216 if (this_urb->status == -EINPROGRESS) {
217 if (time_before(jiffies,
218 portdata->tx_start_time[i] + 10 * HZ))
220 usb_unlink_urb(this_urb);
223 if (this_urb->status != 0)
224 dbg("usb_write %p failed (err=%d)",
225 this_urb, this_urb->status);
227 dbg("%s: endpoint %d buf %d", __FUNCTION__,
228 usb_pipeendpoint(this_urb->pipe), i);
231 memcpy (this_urb->transfer_buffer, buf, todo);
232 this_urb->transfer_buffer_length = todo;
234 this_urb->dev = port->serial->dev;
235 err = usb_submit_urb(this_urb, GFP_ATOMIC);
237 dbg("usb_submit_urb %p (write bulk) failed "
238 "(%d, has %d)", this_urb,
239 err, this_urb->status);
242 portdata->tx_start_time[i] = jiffies;
248 dbg("%s: wrote (did %d)", __FUNCTION__, count);
252 static void sierra_indat_callback(struct urb *urb)
256 struct usb_serial_port *port;
257 struct tty_struct *tty;
258 unsigned char *data = urb->transfer_buffer;
260 dbg("%s: %p", __FUNCTION__, urb);
262 endpoint = usb_pipeendpoint(urb->pipe);
263 port = (struct usb_serial_port *) urb->context;
266 dbg("%s: nonzero status: %d on endpoint %02x.",
267 __FUNCTION__, urb->status, endpoint);
270 if (urb->actual_length) {
271 tty_buffer_request_room(tty, urb->actual_length);
272 tty_insert_flip_string(tty, data, urb->actual_length);
273 tty_flip_buffer_push(tty);
275 dbg("%s: empty read urb received", __FUNCTION__);
278 /* Resubmit urb so we continue receiving */
279 if (port->open_count && urb->status != -ESHUTDOWN) {
280 err = usb_submit_urb(urb, GFP_ATOMIC);
282 printk(KERN_ERR "%s: resubmit read urb failed. "
283 "(%d)", __FUNCTION__, err);
289 static void sierra_outdat_callback(struct urb *urb)
291 struct usb_serial_port *port;
293 dbg("%s", __FUNCTION__);
295 port = (struct usb_serial_port *) urb->context;
297 usb_serial_port_softint(port);
300 static void sierra_instat_callback(struct urb *urb)
303 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
304 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
305 struct usb_serial *serial = port->serial;
307 dbg("%s", __FUNCTION__);
308 dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
310 if (urb->status == 0) {
311 struct usb_ctrlrequest *req_pkt =
312 (struct usb_ctrlrequest *)urb->transfer_buffer;
315 dbg("%s: NULL req_pkt\n", __FUNCTION__);
318 if ((req_pkt->bRequestType == 0xA1) &&
319 (req_pkt->bRequest == 0x20)) {
321 unsigned char signals = *((unsigned char *)
322 urb->transfer_buffer +
323 sizeof(struct usb_ctrlrequest));
325 dbg("%s: signal x%x", __FUNCTION__, signals);
327 old_dcd_state = portdata->dcd_state;
328 portdata->cts_state = 1;
329 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
330 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
331 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
333 if (port->tty && !C_CLOCAL(port->tty) &&
334 old_dcd_state && !portdata->dcd_state)
335 tty_hangup(port->tty);
337 dbg("%s: type %x req %x", __FUNCTION__,
338 req_pkt->bRequestType,req_pkt->bRequest);
341 dbg("%s: error %d", __FUNCTION__, urb->status);
343 /* Resubmit urb so we continue receiving IRQ data */
344 if (urb->status != -ESHUTDOWN) {
345 urb->dev = serial->dev;
346 err = usb_submit_urb(urb, GFP_ATOMIC);
348 dbg("%s: resubmit intr urb failed. (%d)",
353 static int sierra_write_room(struct usb_serial_port *port)
355 struct sierra_port_private *portdata;
358 struct urb *this_urb;
360 portdata = usb_get_serial_port_data(port);
362 for (i=0; i < N_OUT_URB; i++) {
363 this_urb = portdata->out_urbs[i];
364 if (this_urb && this_urb->status != -EINPROGRESS)
365 data_len += OUT_BUFLEN;
368 dbg("%s: %d", __FUNCTION__, data_len);
372 static int sierra_chars_in_buffer(struct usb_serial_port *port)
374 struct sierra_port_private *portdata;
377 struct urb *this_urb;
379 portdata = usb_get_serial_port_data(port);
381 for (i=0; i < N_OUT_URB; i++) {
382 this_urb = portdata->out_urbs[i];
383 if (this_urb && this_urb->status == -EINPROGRESS)
384 data_len += this_urb->transfer_buffer_length;
386 dbg("%s: %d", __FUNCTION__, data_len);
390 static int sierra_open(struct usb_serial_port *port, struct file *filp)
392 struct sierra_port_private *portdata;
393 struct usb_serial *serial = port->serial;
397 portdata = usb_get_serial_port_data(port);
399 dbg("%s", __FUNCTION__);
401 /* Set some sane defaults */
402 portdata->rts_state = 1;
403 portdata->dtr_state = 1;
405 /* Reset low level data toggle and start reading from endpoints */
406 for (i = 0; i < N_IN_URB; i++) {
407 urb = portdata->in_urbs[i];
410 if (urb->dev != serial->dev) {
411 dbg("%s: dev %p != %p", __FUNCTION__,
412 urb->dev, serial->dev);
417 * make sure endpoint data toggle is synchronized with the
420 usb_clear_halt(urb->dev, urb->pipe);
422 err = usb_submit_urb(urb, GFP_KERNEL);
424 dbg("%s: submit urb %d failed (%d) %d",
425 __FUNCTION__, i, err,
426 urb->transfer_buffer_length);
430 /* Reset low level data toggle on out endpoints */
431 for (i = 0; i < N_OUT_URB; i++) {
432 urb = portdata->out_urbs[i];
435 urb->dev = serial->dev;
436 /* usb_settoggle(urb->dev, usb_pipeendpoint(urb->pipe),
437 usb_pipeout(urb->pipe), 0); */
440 port->tty->low_latency = 1;
442 sierra_send_setup(port);
447 static inline void stop_urb(struct urb *urb)
449 if (urb && urb->status == -EINPROGRESS)
453 static void sierra_close(struct usb_serial_port *port, struct file *filp)
456 struct usb_serial *serial = port->serial;
457 struct sierra_port_private *portdata;
459 dbg("%s", __FUNCTION__);
460 portdata = usb_get_serial_port_data(port);
462 portdata->rts_state = 0;
463 portdata->dtr_state = 0;
466 sierra_send_setup(port);
468 /* Stop reading/writing urbs */
469 for (i = 0; i < N_IN_URB; i++)
470 stop_urb(portdata->in_urbs[i]);
471 for (i = 0; i < N_OUT_URB; i++)
472 stop_urb(portdata->out_urbs[i]);
477 /* Helper functions used by sierra_setup_urbs */
478 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
479 int dir, void *ctx, char *buf, int len,
480 usb_complete_t callback)
485 return NULL; /* endpoint not needed */
487 urb = usb_alloc_urb(0, GFP_KERNEL); /* No ISO */
489 dbg("%s: alloc for endpoint %d failed.", __FUNCTION__, endpoint);
493 /* Fill URB using supplied data. */
494 usb_fill_bulk_urb(urb, serial->dev,
495 usb_sndbulkpipe(serial->dev, endpoint) | dir,
496 buf, len, callback, ctx);
502 static void sierra_setup_urbs(struct usb_serial *serial)
505 struct usb_serial_port *port;
506 struct sierra_port_private *portdata;
508 dbg("%s", __FUNCTION__);
510 for (i = 0; i < serial->num_ports; i++) {
511 port = serial->port[i];
512 portdata = usb_get_serial_port_data(port);
514 /* Do indat endpoints first */
515 for (j = 0; j < N_IN_URB; ++j) {
516 portdata->in_urbs[j] = sierra_setup_urb (serial,
517 port->bulk_in_endpointAddress, USB_DIR_IN, port,
518 portdata->in_buffer[j], IN_BUFLEN, sierra_indat_callback);
521 /* outdat endpoints */
522 for (j = 0; j < N_OUT_URB; ++j) {
523 portdata->out_urbs[j] = sierra_setup_urb (serial,
524 port->bulk_out_endpointAddress, USB_DIR_OUT, port,
525 portdata->out_buffer[j], OUT_BUFLEN, sierra_outdat_callback);
530 static int sierra_startup(struct usb_serial *serial)
533 struct usb_serial_port *port;
534 struct sierra_port_private *portdata;
536 dbg("%s", __FUNCTION__);
538 /* Now setup per port private data */
539 for (i = 0; i < serial->num_ports; i++) {
540 port = serial->port[i];
541 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
543 dbg("%s: kmalloc for sierra_port_private (%d) failed!.",
548 usb_set_serial_port_data(port, portdata);
550 if (! port->interrupt_in_urb)
552 err = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
554 dbg("%s: submit irq_in urb failed %d",
558 sierra_setup_urbs(serial);
563 static void sierra_shutdown(struct usb_serial *serial)
566 struct usb_serial_port *port;
567 struct sierra_port_private *portdata;
569 dbg("%s", __FUNCTION__);
571 /* Stop reading/writing urbs */
572 for (i = 0; i < serial->num_ports; ++i) {
573 port = serial->port[i];
574 portdata = usb_get_serial_port_data(port);
575 for (j = 0; j < N_IN_URB; j++)
576 stop_urb(portdata->in_urbs[j]);
577 for (j = 0; j < N_OUT_URB; j++)
578 stop_urb(portdata->out_urbs[j]);
582 for (i = 0; i < serial->num_ports; ++i) {
583 port = serial->port[i];
584 portdata = usb_get_serial_port_data(port);
586 for (j = 0; j < N_IN_URB; j++) {
587 if (portdata->in_urbs[j]) {
588 usb_free_urb(portdata->in_urbs[j]);
589 portdata->in_urbs[j] = NULL;
592 for (j = 0; j < N_OUT_URB; j++) {
593 if (portdata->out_urbs[j]) {
594 usb_free_urb(portdata->out_urbs[j]);
595 portdata->out_urbs[j] = NULL;
600 /* Now free per port private data */
601 for (i = 0; i < serial->num_ports; i++) {
602 port = serial->port[i];
603 kfree(usb_get_serial_port_data(port));
607 static struct usb_serial_driver sierra_1port_device = {
609 .owner = THIS_MODULE,
612 .description = "Sierra USB modem (1 port)",
613 .id_table = id_table_1port,
614 .num_interrupt_in = NUM_DONT_CARE,
619 .close = sierra_close,
620 .write = sierra_write,
621 .write_room = sierra_write_room,
622 .chars_in_buffer = sierra_chars_in_buffer,
623 .throttle = sierra_rx_throttle,
624 .unthrottle = sierra_rx_unthrottle,
625 .ioctl = sierra_ioctl,
626 .set_termios = sierra_set_termios,
627 .break_ctl = sierra_break_ctl,
628 .tiocmget = sierra_tiocmget,
629 .tiocmset = sierra_tiocmset,
630 .attach = sierra_startup,
631 .shutdown = sierra_shutdown,
632 .read_int_callback = sierra_instat_callback,
635 static struct usb_serial_driver sierra_3port_device = {
637 .owner = THIS_MODULE,
640 .description = "Sierra USB modem (3 port)",
641 .id_table = id_table_3port,
642 .num_interrupt_in = NUM_DONT_CARE,
647 .close = sierra_close,
648 .write = sierra_write,
649 .write_room = sierra_write_room,
650 .chars_in_buffer = sierra_chars_in_buffer,
651 .throttle = sierra_rx_throttle,
652 .unthrottle = sierra_rx_unthrottle,
653 .ioctl = sierra_ioctl,
654 .set_termios = sierra_set_termios,
655 .break_ctl = sierra_break_ctl,
656 .tiocmget = sierra_tiocmget,
657 .tiocmset = sierra_tiocmset,
658 .attach = sierra_startup,
659 .shutdown = sierra_shutdown,
660 .read_int_callback = sierra_instat_callback,
663 /* Functions used by new usb-serial code. */
664 static int __init sierra_init(void)
667 retval = usb_serial_register(&sierra_1port_device);
669 goto failed_1port_device_register;
670 retval = usb_serial_register(&sierra_3port_device);
672 goto failed_3port_device_register;
675 retval = usb_register(&sierra_driver);
677 goto failed_driver_register;
679 info(DRIVER_DESC ": " DRIVER_VERSION);
683 failed_driver_register:
684 usb_serial_deregister(&sierra_3port_device);
685 failed_3port_device_register:
686 usb_serial_deregister(&sierra_1port_device);
687 failed_1port_device_register:
691 static void __exit sierra_exit(void)
693 usb_deregister (&sierra_driver);
694 usb_serial_deregister(&sierra_1port_device);
695 usb_serial_deregister(&sierra_3port_device);
698 module_init(sierra_init);
699 module_exit(sierra_exit);
701 MODULE_AUTHOR(DRIVER_AUTHOR);
702 MODULE_DESCRIPTION(DRIVER_DESC);
703 MODULE_VERSION(DRIVER_VERSION);
704 MODULE_LICENSE("GPL");
706 #ifdef CONFIG_USB_DEBUG
707 module_param(debug, bool, S_IRUGO | S_IWUSR);
708 MODULE_PARM_DESC(debug, "Debug messages");