2 USB Driver for Sierra Wireless
4 Copyright (C) 2006, 2007 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>
17 #define DRIVER_VERSION "v.1.2.5b"
18 #define DRIVER_AUTHOR "Kevin Lloyd <linux@sierrawireless.com>"
19 #define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
21 #include <linux/kernel.h>
22 #include <linux/jiffies.h>
23 #include <linux/errno.h>
24 #include <linux/tty.h>
25 #include <linux/tty_flip.h>
26 #include <linux/module.h>
27 #include <linux/usb.h>
28 #include <linux/usb/serial.h>
30 #define SWIMS_USB_REQUEST_SetMode 0x0B
31 #define SWIMS_USB_REQUEST_TYPE_SetMode 0x40
32 #define SWIMS_USB_INDEX_SetMode 0x0000
33 #define SWIMS_SET_MODE_Modem 0x0001
35 /* per port private data */
38 #define IN_BUFLEN 4096
48 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
51 dev_dbg(&udev->dev, "%s", "SET POWER STATE\n");
52 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
53 0x00, /* __u8 request */
54 0x40, /* __u8 request type */
55 swiState, /* __u16 value */
57 NULL, /* void *data */
59 USB_CTRL_SET_TIMEOUT); /* int timeout */
63 static int sierra_set_ms_mode(struct usb_device *udev, __u16 eSocMode)
66 dev_dbg(&udev->dev, "%s", "DEVICE MODE SWITCH\n");
67 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
68 SWIMS_USB_REQUEST_SetMode, /* __u8 request */
69 SWIMS_USB_REQUEST_TYPE_SetMode, /* __u8 request type */
70 eSocMode, /* __u16 value */
71 SWIMS_USB_INDEX_SetMode, /* __u16 index */
72 NULL, /* void *data */
74 USB_CTRL_SET_TIMEOUT); /* int timeout */
78 static int sierra_probe(struct usb_interface *iface,
79 const struct usb_device_id *id)
82 struct usb_device *udev;
84 udev = usb_get_dev(interface_to_usbdev(iface));
86 /* Check if in installer mode */
87 if (id->driver_info == DEVICE_INSTALLER) {
88 dev_dbg(&udev->dev, "%s", "FOUND DEVICE(SW)\n");
89 result = sierra_set_ms_mode(udev, SWIMS_SET_MODE_Modem);
90 /*We do not want to bind to the device when in installer mode*/
94 return usb_serial_probe(iface, id);
97 static struct usb_device_id id_table [] = {
98 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
99 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
100 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
101 { USB_DEVICE(0x0f30, 0x1b1d) }, /* Sierra Wireless MC5720 */
102 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
103 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
104 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
105 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
106 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
108 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
109 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
110 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
111 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
112 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
113 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780*/
114 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781*/
115 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
116 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
117 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
118 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
120 { USB_DEVICE(0x1199, 0x0112), .driver_info = DEVICE_1_PORT }, /* Sierra Wireless AirCard 580 */
121 { USB_DEVICE(0x0F3D, 0x0112), .driver_info = DEVICE_1_PORT }, /* Airprime/Sierra PC 5220 */
123 { USB_DEVICE(0x1199, 0x0FFF), .driver_info = DEVICE_INSTALLER},
126 MODULE_DEVICE_TABLE(usb, id_table);
128 static struct usb_device_id id_table_1port [] = {
129 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
130 { USB_DEVICE(0x0F3D, 0x0112) }, /* AirPrime/Sierra PC 5220 */
134 static struct usb_device_id id_table_3port [] = {
135 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
136 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
137 { USB_DEVICE(0x0f30, 0x1b1d) }, /* Sierra Wireless MC5720 */
138 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
139 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
140 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
141 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
142 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
143 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U*/
145 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
146 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
147 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
148 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
149 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
150 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780*/
151 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781*/
152 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
153 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
154 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880E */
155 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881E */
159 static struct usb_driver sierra_driver = {
161 .probe = sierra_probe,
162 .disconnect = usb_serial_disconnect,
163 .id_table = id_table,
168 struct sierra_port_private {
169 spinlock_t lock; /* lock the structure */
170 int outstanding_urbs; /* number of out urbs in flight */
172 /* Input endpoints and buffer for this port */
173 struct urb *in_urbs[N_IN_URB];
174 char in_buffer[N_IN_URB][IN_BUFLEN];
176 /* Settings for the port */
177 int rts_state; /* Handshaking pins (outputs) */
179 int cts_state; /* Handshaking pins (inputs) */
185 static int sierra_send_setup(struct usb_serial_port *port)
187 struct usb_serial *serial = port->serial;
188 struct sierra_port_private *portdata;
190 dbg("%s", __FUNCTION__);
192 portdata = usb_get_serial_port_data(port);
196 if (portdata->dtr_state)
198 if (portdata->rts_state)
201 return usb_control_msg(serial->dev,
202 usb_rcvctrlpipe(serial->dev, 0),
203 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
209 static void sierra_rx_throttle(struct usb_serial_port *port)
211 dbg("%s", __FUNCTION__);
214 static void sierra_rx_unthrottle(struct usb_serial_port *port)
216 dbg("%s", __FUNCTION__);
219 static void sierra_break_ctl(struct usb_serial_port *port, int break_state)
221 /* Unfortunately, I don't know how to send a break */
222 dbg("%s", __FUNCTION__);
225 static void sierra_set_termios(struct usb_serial_port *port,
226 struct ktermios *old_termios)
228 dbg("%s", __FUNCTION__);
229 tty_termios_copy_hw(port->tty->termios, old_termios);
230 sierra_send_setup(port);
233 static int sierra_tiocmget(struct usb_serial_port *port, struct file *file)
236 struct sierra_port_private *portdata;
238 portdata = usb_get_serial_port_data(port);
240 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
241 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
242 ((portdata->cts_state) ? TIOCM_CTS : 0) |
243 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
244 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
245 ((portdata->ri_state) ? TIOCM_RNG : 0);
250 static int sierra_tiocmset(struct usb_serial_port *port, struct file *file,
251 unsigned int set, unsigned int clear)
253 struct sierra_port_private *portdata;
255 portdata = usb_get_serial_port_data(port);
258 portdata->rts_state = 1;
260 portdata->dtr_state = 1;
262 if (clear & TIOCM_RTS)
263 portdata->rts_state = 0;
264 if (clear & TIOCM_DTR)
265 portdata->dtr_state = 0;
266 return sierra_send_setup(port);
269 static int sierra_ioctl(struct usb_serial_port *port, struct file *file,
270 unsigned int cmd, unsigned long arg)
275 static void sierra_outdat_callback(struct urb *urb)
277 struct usb_serial_port *port = urb->context;
278 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
279 int status = urb->status;
282 dbg("%s - port %d", __FUNCTION__, port->number);
284 /* free up the transfer buffer, as usb_free_urb() does not do this */
285 kfree(urb->transfer_buffer);
288 dbg("%s - nonzero write bulk status received: %d",
289 __FUNCTION__, status);
291 spin_lock_irqsave(&portdata->lock, flags);
292 --portdata->outstanding_urbs;
293 spin_unlock_irqrestore(&portdata->lock, flags);
295 usb_serial_port_softint(port);
299 static int sierra_write(struct usb_serial_port *port,
300 const unsigned char *buf, int count)
302 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
303 struct usb_serial *serial = port->serial;
305 unsigned char *buffer;
309 portdata = usb_get_serial_port_data(port);
311 dbg("%s: write (%d chars)", __FUNCTION__, count);
313 spin_lock_irqsave(&portdata->lock, flags);
314 if (portdata->outstanding_urbs > N_OUT_URB) {
315 spin_unlock_irqrestore(&portdata->lock, flags);
316 dbg("%s - write limit hit\n", __FUNCTION__);
319 portdata->outstanding_urbs++;
320 spin_unlock_irqrestore(&portdata->lock, flags);
322 buffer = kmalloc(count, GFP_ATOMIC);
324 dev_err(&port->dev, "out of memory\n");
326 goto error_no_buffer;
329 urb = usb_alloc_urb(0, GFP_ATOMIC);
331 dev_err(&port->dev, "no more free urbs\n");
336 memcpy(buffer, buf, count);
338 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, buffer);
340 usb_fill_bulk_urb(urb, serial->dev,
341 usb_sndbulkpipe(serial->dev,
342 port->bulk_out_endpointAddress),
343 buffer, count, sierra_outdat_callback, port);
345 /* send it down the pipe */
346 status = usb_submit_urb(urb, GFP_ATOMIC);
348 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
349 "with status = %d\n", __FUNCTION__, status);
354 /* we are done with this urb, so let the host driver
355 * really free it when it is finished with it */
364 spin_lock_irqsave(&portdata->lock, flags);
365 --portdata->outstanding_urbs;
366 spin_unlock_irqrestore(&portdata->lock, flags);
370 static void sierra_indat_callback(struct urb *urb)
374 struct usb_serial_port *port;
375 struct tty_struct *tty;
376 unsigned char *data = urb->transfer_buffer;
377 int status = urb->status;
379 dbg("%s: %p", __FUNCTION__, urb);
381 endpoint = usb_pipeendpoint(urb->pipe);
382 port = (struct usb_serial_port *) urb->context;
385 dbg("%s: nonzero status: %d on endpoint %02x.",
386 __FUNCTION__, status, endpoint);
389 if (urb->actual_length) {
390 tty_buffer_request_room(tty, urb->actual_length);
391 tty_insert_flip_string(tty, data, urb->actual_length);
392 tty_flip_buffer_push(tty);
394 dbg("%s: empty read urb received", __FUNCTION__);
397 /* Resubmit urb so we continue receiving */
398 if (port->open_count && status != -ESHUTDOWN) {
399 err = usb_submit_urb(urb, GFP_ATOMIC);
401 dev_err(&port->dev, "resubmit read urb failed."
408 static void sierra_instat_callback(struct urb *urb)
411 int status = urb->status;
412 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
413 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
414 struct usb_serial *serial = port->serial;
416 dbg("%s", __FUNCTION__);
417 dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
420 struct usb_ctrlrequest *req_pkt =
421 (struct usb_ctrlrequest *)urb->transfer_buffer;
424 dbg("%s: NULL req_pkt\n", __FUNCTION__);
427 if ((req_pkt->bRequestType == 0xA1) &&
428 (req_pkt->bRequest == 0x20)) {
430 unsigned char signals = *((unsigned char *)
431 urb->transfer_buffer +
432 sizeof(struct usb_ctrlrequest));
434 dbg("%s: signal x%x", __FUNCTION__, signals);
436 old_dcd_state = portdata->dcd_state;
437 portdata->cts_state = 1;
438 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
439 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
440 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
442 if (port->tty && !C_CLOCAL(port->tty) &&
443 old_dcd_state && !portdata->dcd_state)
444 tty_hangup(port->tty);
446 dbg("%s: type %x req %x", __FUNCTION__,
447 req_pkt->bRequestType,req_pkt->bRequest);
450 dbg("%s: error %d", __FUNCTION__, status);
452 /* Resubmit urb so we continue receiving IRQ data */
453 if (status != -ESHUTDOWN) {
454 urb->dev = serial->dev;
455 err = usb_submit_urb(urb, GFP_ATOMIC);
457 dbg("%s: resubmit intr urb failed. (%d)",
462 static int sierra_write_room(struct usb_serial_port *port)
464 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
467 dbg("%s - port %d", __FUNCTION__, port->number);
469 /* try to give a good number back based on if we have any free urbs at
470 * this point in time */
471 spin_lock_irqsave(&portdata->lock, flags);
472 if (portdata->outstanding_urbs > N_OUT_URB * 2 / 3) {
473 spin_unlock_irqrestore(&portdata->lock, flags);
474 dbg("%s - write limit hit\n", __FUNCTION__);
477 spin_unlock_irqrestore(&portdata->lock, flags);
482 static int sierra_chars_in_buffer(struct usb_serial_port *port)
484 dbg("%s - port %d", __FUNCTION__, port->number);
487 * We can't really account for how much data we
488 * have sent out, but hasn't made it through to the
489 * device as we can't see the backend here, so just
490 * tell the tty layer that everything is flushed.
495 static int sierra_open(struct usb_serial_port *port, struct file *filp)
497 struct sierra_port_private *portdata;
498 struct usb_serial *serial = port->serial;
503 portdata = usb_get_serial_port_data(port);
505 dbg("%s", __FUNCTION__);
507 /* Set some sane defaults */
508 portdata->rts_state = 1;
509 portdata->dtr_state = 1;
511 /* Reset low level data toggle and start reading from endpoints */
512 for (i = 0; i < N_IN_URB; i++) {
513 urb = portdata->in_urbs[i];
516 if (urb->dev != serial->dev) {
517 dbg("%s: dev %p != %p", __FUNCTION__,
518 urb->dev, serial->dev);
523 * make sure endpoint data toggle is synchronized with the
526 usb_clear_halt(urb->dev, urb->pipe);
528 result = usb_submit_urb(urb, GFP_KERNEL);
530 dev_err(&port->dev, "submit urb %d failed (%d) %d\n",
531 i, result, urb->transfer_buffer_length);
535 port->tty->low_latency = 1;
537 sierra_send_setup(port);
539 /* start up the interrupt endpoint if we have one */
540 if (port->interrupt_in_urb) {
541 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
543 dev_err(&port->dev, "submit irq_in urb failed %d\n",
549 static void sierra_close(struct usb_serial_port *port, struct file *filp)
552 struct usb_serial *serial = port->serial;
553 struct sierra_port_private *portdata;
555 dbg("%s", __FUNCTION__);
556 portdata = usb_get_serial_port_data(port);
558 portdata->rts_state = 0;
559 portdata->dtr_state = 0;
562 sierra_send_setup(port);
564 /* Stop reading/writing urbs */
565 for (i = 0; i < N_IN_URB; i++)
566 usb_kill_urb(portdata->in_urbs[i]);
569 usb_kill_urb(port->interrupt_in_urb);
574 static int sierra_startup(struct usb_serial *serial)
576 struct usb_serial_port *port;
577 struct sierra_port_private *portdata;
582 dbg("%s", __FUNCTION__);
584 /*Set Device mode to D0 */
585 sierra_set_power_state(serial->dev, 0x0000);
587 /* Now setup per port private data */
588 for (i = 0; i < serial->num_ports; i++) {
589 port = serial->port[i];
590 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
592 dbg("%s: kmalloc for sierra_port_private (%d) failed!.",
596 spin_lock_init(&portdata->lock);
598 usb_set_serial_port_data(port, portdata);
600 /* initialize the in urbs */
601 for (j = 0; j < N_IN_URB; ++j) {
602 urb = usb_alloc_urb(0, GFP_KERNEL);
604 dbg("%s: alloc for in port failed.",
608 /* Fill URB using supplied data. */
609 usb_fill_bulk_urb(urb, serial->dev,
610 usb_rcvbulkpipe(serial->dev,
611 port->bulk_in_endpointAddress),
612 portdata->in_buffer[j], IN_BUFLEN,
613 sierra_indat_callback, port);
614 portdata->in_urbs[j] = urb;
621 static void sierra_shutdown(struct usb_serial *serial)
624 struct usb_serial_port *port;
625 struct sierra_port_private *portdata;
627 dbg("%s", __FUNCTION__);
629 for (i = 0; i < serial->num_ports; ++i) {
630 port = serial->port[i];
633 portdata = usb_get_serial_port_data(port);
637 for (j = 0; j < N_IN_URB; j++) {
638 usb_kill_urb(portdata->in_urbs[j]);
639 usb_free_urb(portdata->in_urbs[j]);
640 portdata->in_urbs[j] = NULL;
643 usb_set_serial_port_data(port, NULL);
647 static struct usb_serial_driver sierra_1port_device = {
649 .owner = THIS_MODULE,
652 .description = "Sierra USB modem (1 port)",
653 .id_table = id_table_1port,
654 .usb_driver = &sierra_driver,
655 .num_interrupt_in = NUM_DONT_CARE,
660 .close = sierra_close,
661 .write = sierra_write,
662 .write_room = sierra_write_room,
663 .chars_in_buffer = sierra_chars_in_buffer,
664 .throttle = sierra_rx_throttle,
665 .unthrottle = sierra_rx_unthrottle,
666 .ioctl = sierra_ioctl,
667 .set_termios = sierra_set_termios,
668 .break_ctl = sierra_break_ctl,
669 .tiocmget = sierra_tiocmget,
670 .tiocmset = sierra_tiocmset,
671 .attach = sierra_startup,
672 .shutdown = sierra_shutdown,
673 .read_int_callback = sierra_instat_callback,
676 static struct usb_serial_driver sierra_3port_device = {
678 .owner = THIS_MODULE,
681 .description = "Sierra USB modem (3 port)",
682 .id_table = id_table_3port,
683 .usb_driver = &sierra_driver,
684 .num_interrupt_in = NUM_DONT_CARE,
689 .close = sierra_close,
690 .write = sierra_write,
691 .write_room = sierra_write_room,
692 .chars_in_buffer = sierra_chars_in_buffer,
693 .throttle = sierra_rx_throttle,
694 .unthrottle = sierra_rx_unthrottle,
695 .ioctl = sierra_ioctl,
696 .set_termios = sierra_set_termios,
697 .break_ctl = sierra_break_ctl,
698 .tiocmget = sierra_tiocmget,
699 .tiocmset = sierra_tiocmset,
700 .attach = sierra_startup,
701 .shutdown = sierra_shutdown,
702 .read_int_callback = sierra_instat_callback,
705 /* Functions used by new usb-serial code. */
706 static int __init sierra_init(void)
709 retval = usb_serial_register(&sierra_1port_device);
711 goto failed_1port_device_register;
712 retval = usb_serial_register(&sierra_3port_device);
714 goto failed_3port_device_register;
717 retval = usb_register(&sierra_driver);
719 goto failed_driver_register;
721 info(DRIVER_DESC ": " DRIVER_VERSION);
725 failed_driver_register:
726 usb_serial_deregister(&sierra_3port_device);
727 failed_3port_device_register:
728 usb_serial_deregister(&sierra_1port_device);
729 failed_1port_device_register:
733 static void __exit sierra_exit(void)
735 usb_deregister (&sierra_driver);
736 usb_serial_deregister(&sierra_1port_device);
737 usb_serial_deregister(&sierra_3port_device);
740 module_init(sierra_init);
741 module_exit(sierra_exit);
743 MODULE_AUTHOR(DRIVER_AUTHOR);
744 MODULE_DESCRIPTION(DRIVER_DESC);
745 MODULE_VERSION(DRIVER_VERSION);
746 MODULE_LICENSE("GPL");
748 #ifdef CONFIG_USB_DEBUG
749 module_param(debug, bool, S_IRUGO | S_IWUSR);
750 MODULE_PARM_DESC(debug, "Debug messages");