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");
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");
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, 0x0019) }, /* Sierra Wireless AirCard 595 */
104 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
105 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
107 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
108 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
109 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
110 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
111 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
112 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780*/
113 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781*/
114 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
115 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
116 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
117 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
119 { USB_DEVICE(0x1199, 0x0112), .driver_info = DEVICE_1_PORT }, /* Sierra Wireless AirCard 580 */
120 { USB_DEVICE(0x0F3D, 0x0112), .driver_info = DEVICE_1_PORT }, /* Airprime/Sierra PC 5220 */
122 { USB_DEVICE(0x1199, 0x0FFF), .driver_info = DEVICE_INSTALLER},
125 MODULE_DEVICE_TABLE(usb, id_table);
127 static struct usb_device_id id_table_1port [] = {
128 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
129 { USB_DEVICE(0x0F3D, 0x0112) }, /* AirPrime/Sierra PC 5220 */
133 static struct usb_device_id id_table_3port [] = {
134 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
135 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
136 { USB_DEVICE(0x0f30, 0x1b1d) }, /* Sierra Wireless MC5720 */
137 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
138 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
139 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
140 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
141 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U*/
143 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
144 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
145 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
146 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
147 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
148 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780*/
149 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781*/
150 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
151 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
152 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880E */
153 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881E */
157 static struct usb_driver sierra_driver = {
159 .probe = sierra_probe,
160 .disconnect = usb_serial_disconnect,
161 .id_table = id_table,
166 struct sierra_port_private {
167 spinlock_t lock; /* lock the structure */
168 int outstanding_urbs; /* number of out urbs in flight */
170 /* Input endpoints and buffer for this port */
171 struct urb *in_urbs[N_IN_URB];
172 char in_buffer[N_IN_URB][IN_BUFLEN];
174 /* Settings for the port */
175 int rts_state; /* Handshaking pins (outputs) */
177 int cts_state; /* Handshaking pins (inputs) */
183 static int sierra_send_setup(struct usb_serial_port *port)
185 struct usb_serial *serial = port->serial;
186 struct sierra_port_private *portdata;
188 dbg("%s", __FUNCTION__);
190 portdata = usb_get_serial_port_data(port);
194 if (portdata->dtr_state)
196 if (portdata->rts_state)
199 return usb_control_msg(serial->dev,
200 usb_rcvctrlpipe(serial->dev, 0),
201 0x22,0x21,val,0,NULL,0,USB_CTRL_SET_TIMEOUT);
207 static void sierra_rx_throttle(struct usb_serial_port *port)
209 dbg("%s", __FUNCTION__);
212 static void sierra_rx_unthrottle(struct usb_serial_port *port)
214 dbg("%s", __FUNCTION__);
217 static void sierra_break_ctl(struct usb_serial_port *port, int break_state)
219 /* Unfortunately, I don't know how to send a break */
220 dbg("%s", __FUNCTION__);
223 static void sierra_set_termios(struct usb_serial_port *port,
224 struct ktermios *old_termios)
226 dbg("%s", __FUNCTION__);
228 sierra_send_setup(port);
231 static int sierra_tiocmget(struct usb_serial_port *port, struct file *file)
234 struct sierra_port_private *portdata;
236 portdata = usb_get_serial_port_data(port);
238 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
239 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
240 ((portdata->cts_state) ? TIOCM_CTS : 0) |
241 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
242 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
243 ((portdata->ri_state) ? TIOCM_RNG : 0);
248 static int sierra_tiocmset(struct usb_serial_port *port, struct file *file,
249 unsigned int set, unsigned int clear)
251 struct sierra_port_private *portdata;
253 portdata = usb_get_serial_port_data(port);
256 portdata->rts_state = 1;
258 portdata->dtr_state = 1;
260 if (clear & TIOCM_RTS)
261 portdata->rts_state = 0;
262 if (clear & TIOCM_DTR)
263 portdata->dtr_state = 0;
264 return sierra_send_setup(port);
267 static int sierra_ioctl(struct usb_serial_port *port, struct file *file,
268 unsigned int cmd, unsigned long arg)
273 static void sierra_outdat_callback(struct urb *urb)
275 struct usb_serial_port *port = urb->context;
276 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
277 int status = urb->status;
280 dbg("%s - port %d", __FUNCTION__, port->number);
282 /* free up the transfer buffer, as usb_free_urb() does not do this */
283 kfree(urb->transfer_buffer);
286 dbg("%s - nonzero write bulk status received: %d",
287 __FUNCTION__, status);
289 spin_lock_irqsave(&portdata->lock, flags);
290 --portdata->outstanding_urbs;
291 spin_unlock_irqrestore(&portdata->lock, flags);
293 usb_serial_port_softint(port);
297 static int sierra_write(struct usb_serial_port *port,
298 const unsigned char *buf, int count)
300 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
301 struct usb_serial *serial = port->serial;
303 unsigned char *buffer;
307 portdata = usb_get_serial_port_data(port);
309 dbg("%s: write (%d chars)", __FUNCTION__, count);
311 spin_lock_irqsave(&portdata->lock, flags);
312 if (portdata->outstanding_urbs > N_OUT_URB) {
313 spin_unlock_irqrestore(&portdata->lock, flags);
314 dbg("%s - write limit hit\n", __FUNCTION__);
317 portdata->outstanding_urbs++;
318 spin_unlock_irqrestore(&portdata->lock, flags);
320 buffer = kmalloc(count, GFP_ATOMIC);
322 dev_err(&port->dev, "out of memory\n");
324 goto error_no_buffer;
327 urb = usb_alloc_urb(0, GFP_ATOMIC);
329 dev_err(&port->dev, "no more free urbs\n");
334 memcpy(buffer, buf, count);
336 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, buffer);
338 usb_fill_bulk_urb(urb, serial->dev,
339 usb_sndbulkpipe(serial->dev,
340 port->bulk_out_endpointAddress),
341 buffer, count, sierra_outdat_callback, port);
343 /* send it down the pipe */
344 status = usb_submit_urb(urb, GFP_ATOMIC);
346 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
347 "with status = %d\n", __FUNCTION__, status);
352 /* we are done with this urb, so let the host driver
353 * really free it when it is finished with it */
362 spin_lock_irqsave(&portdata->lock, flags);
363 --portdata->outstanding_urbs;
364 spin_unlock_irqrestore(&portdata->lock, flags);
368 static void sierra_indat_callback(struct urb *urb)
372 struct usb_serial_port *port;
373 struct tty_struct *tty;
374 unsigned char *data = urb->transfer_buffer;
375 int status = urb->status;
377 dbg("%s: %p", __FUNCTION__, urb);
379 endpoint = usb_pipeendpoint(urb->pipe);
380 port = (struct usb_serial_port *) urb->context;
383 dbg("%s: nonzero status: %d on endpoint %02x.",
384 __FUNCTION__, status, endpoint);
387 if (urb->actual_length) {
388 tty_buffer_request_room(tty, urb->actual_length);
389 tty_insert_flip_string(tty, data, urb->actual_length);
390 tty_flip_buffer_push(tty);
392 dbg("%s: empty read urb received", __FUNCTION__);
395 /* Resubmit urb so we continue receiving */
396 if (port->open_count && status != -ESHUTDOWN) {
397 err = usb_submit_urb(urb, GFP_ATOMIC);
399 dev_err(&port->dev, "resubmit read urb failed."
406 static void sierra_instat_callback(struct urb *urb)
409 int status = urb->status;
410 struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
411 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
412 struct usb_serial *serial = port->serial;
414 dbg("%s", __FUNCTION__);
415 dbg("%s: urb %p port %p has data %p", __FUNCTION__,urb,port,portdata);
418 struct usb_ctrlrequest *req_pkt =
419 (struct usb_ctrlrequest *)urb->transfer_buffer;
422 dbg("%s: NULL req_pkt\n", __FUNCTION__);
425 if ((req_pkt->bRequestType == 0xA1) &&
426 (req_pkt->bRequest == 0x20)) {
428 unsigned char signals = *((unsigned char *)
429 urb->transfer_buffer +
430 sizeof(struct usb_ctrlrequest));
432 dbg("%s: signal x%x", __FUNCTION__, signals);
434 old_dcd_state = portdata->dcd_state;
435 portdata->cts_state = 1;
436 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
437 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
438 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
440 if (port->tty && !C_CLOCAL(port->tty) &&
441 old_dcd_state && !portdata->dcd_state)
442 tty_hangup(port->tty);
444 dbg("%s: type %x req %x", __FUNCTION__,
445 req_pkt->bRequestType,req_pkt->bRequest);
448 dbg("%s: error %d", __FUNCTION__, status);
450 /* Resubmit urb so we continue receiving IRQ data */
451 if (status != -ESHUTDOWN) {
452 urb->dev = serial->dev;
453 err = usb_submit_urb(urb, GFP_ATOMIC);
455 dbg("%s: resubmit intr urb failed. (%d)",
460 static int sierra_write_room(struct usb_serial_port *port)
462 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
465 dbg("%s - port %d", __FUNCTION__, port->number);
467 /* try to give a good number back based on if we have any free urbs at
468 * this point in time */
469 spin_lock_irqsave(&portdata->lock, flags);
470 if (portdata->outstanding_urbs > N_OUT_URB * 2 / 3) {
471 spin_unlock_irqrestore(&portdata->lock, flags);
472 dbg("%s - write limit hit\n", __FUNCTION__);
475 spin_unlock_irqrestore(&portdata->lock, flags);
480 static int sierra_chars_in_buffer(struct usb_serial_port *port)
482 dbg("%s - port %d", __FUNCTION__, port->number);
485 * We can't really account for how much data we
486 * have sent out, but hasn't made it through to the
487 * device as we can't see the backend here, so just
488 * tell the tty layer that everything is flushed.
493 static int sierra_open(struct usb_serial_port *port, struct file *filp)
495 struct sierra_port_private *portdata;
496 struct usb_serial *serial = port->serial;
501 portdata = usb_get_serial_port_data(port);
503 dbg("%s", __FUNCTION__);
505 /* Set some sane defaults */
506 portdata->rts_state = 1;
507 portdata->dtr_state = 1;
509 /* Reset low level data toggle and start reading from endpoints */
510 for (i = 0; i < N_IN_URB; i++) {
511 urb = portdata->in_urbs[i];
514 if (urb->dev != serial->dev) {
515 dbg("%s: dev %p != %p", __FUNCTION__,
516 urb->dev, serial->dev);
521 * make sure endpoint data toggle is synchronized with the
524 usb_clear_halt(urb->dev, urb->pipe);
526 result = usb_submit_urb(urb, GFP_KERNEL);
528 dev_err(&port->dev, "submit urb %d failed (%d) %d",
529 i, result, urb->transfer_buffer_length);
533 port->tty->low_latency = 1;
535 sierra_send_setup(port);
537 /* start up the interrupt endpoint if we have one */
538 if (port->interrupt_in_urb) {
539 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
541 dev_err(&port->dev, "submit irq_in urb failed %d",
547 static void sierra_close(struct usb_serial_port *port, struct file *filp)
550 struct usb_serial *serial = port->serial;
551 struct sierra_port_private *portdata;
553 dbg("%s", __FUNCTION__);
554 portdata = usb_get_serial_port_data(port);
556 portdata->rts_state = 0;
557 portdata->dtr_state = 0;
560 sierra_send_setup(port);
562 /* Stop reading/writing urbs */
563 for (i = 0; i < N_IN_URB; i++)
564 usb_kill_urb(portdata->in_urbs[i]);
567 usb_kill_urb(port->interrupt_in_urb);
572 static int sierra_startup(struct usb_serial *serial)
574 struct usb_serial_port *port;
575 struct sierra_port_private *portdata;
580 dbg("%s", __FUNCTION__);
582 /*Set Device mode to D0 */
583 sierra_set_power_state(serial->dev, 0x0000);
585 /* Now setup per port private data */
586 for (i = 0; i < serial->num_ports; i++) {
587 port = serial->port[i];
588 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
590 dbg("%s: kmalloc for sierra_port_private (%d) failed!.",
594 spin_lock_init(&portdata->lock);
596 usb_set_serial_port_data(port, portdata);
598 /* initialize the in urbs */
599 for (j = 0; j < N_IN_URB; ++j) {
600 urb = usb_alloc_urb(0, GFP_KERNEL);
602 dbg("%s: alloc for in port failed.",
606 /* Fill URB using supplied data. */
607 usb_fill_bulk_urb(urb, serial->dev,
608 usb_rcvbulkpipe(serial->dev,
609 port->bulk_in_endpointAddress),
610 portdata->in_buffer[j], IN_BUFLEN,
611 sierra_indat_callback, port);
612 portdata->in_urbs[j] = urb;
619 static void sierra_shutdown(struct usb_serial *serial)
622 struct usb_serial_port *port;
623 struct sierra_port_private *portdata;
625 dbg("%s", __FUNCTION__);
627 for (i = 0; i < serial->num_ports; ++i) {
628 port = serial->port[i];
631 portdata = usb_get_serial_port_data(port);
635 for (j = 0; j < N_IN_URB; j++) {
636 usb_kill_urb(portdata->in_urbs[j]);
637 usb_free_urb(portdata->in_urbs[j]);
638 portdata->in_urbs[j] = NULL;
641 usb_set_serial_port_data(port, NULL);
645 static struct usb_serial_driver sierra_1port_device = {
647 .owner = THIS_MODULE,
650 .description = "Sierra USB modem (1 port)",
651 .id_table = id_table_1port,
652 .usb_driver = &sierra_driver,
653 .num_interrupt_in = NUM_DONT_CARE,
658 .close = sierra_close,
659 .write = sierra_write,
660 .write_room = sierra_write_room,
661 .chars_in_buffer = sierra_chars_in_buffer,
662 .throttle = sierra_rx_throttle,
663 .unthrottle = sierra_rx_unthrottle,
664 .ioctl = sierra_ioctl,
665 .set_termios = sierra_set_termios,
666 .break_ctl = sierra_break_ctl,
667 .tiocmget = sierra_tiocmget,
668 .tiocmset = sierra_tiocmset,
669 .attach = sierra_startup,
670 .shutdown = sierra_shutdown,
671 .read_int_callback = sierra_instat_callback,
674 static struct usb_serial_driver sierra_3port_device = {
676 .owner = THIS_MODULE,
679 .description = "Sierra USB modem (3 port)",
680 .id_table = id_table_3port,
681 .usb_driver = &sierra_driver,
682 .num_interrupt_in = NUM_DONT_CARE,
687 .close = sierra_close,
688 .write = sierra_write,
689 .write_room = sierra_write_room,
690 .chars_in_buffer = sierra_chars_in_buffer,
691 .throttle = sierra_rx_throttle,
692 .unthrottle = sierra_rx_unthrottle,
693 .ioctl = sierra_ioctl,
694 .set_termios = sierra_set_termios,
695 .break_ctl = sierra_break_ctl,
696 .tiocmget = sierra_tiocmget,
697 .tiocmset = sierra_tiocmset,
698 .attach = sierra_startup,
699 .shutdown = sierra_shutdown,
700 .read_int_callback = sierra_instat_callback,
703 /* Functions used by new usb-serial code. */
704 static int __init sierra_init(void)
707 retval = usb_serial_register(&sierra_1port_device);
709 goto failed_1port_device_register;
710 retval = usb_serial_register(&sierra_3port_device);
712 goto failed_3port_device_register;
715 retval = usb_register(&sierra_driver);
717 goto failed_driver_register;
719 info(DRIVER_DESC ": " DRIVER_VERSION);
723 failed_driver_register:
724 usb_serial_deregister(&sierra_3port_device);
725 failed_3port_device_register:
726 usb_serial_deregister(&sierra_1port_device);
727 failed_1port_device_register:
731 static void __exit sierra_exit(void)
733 usb_deregister (&sierra_driver);
734 usb_serial_deregister(&sierra_1port_device);
735 usb_serial_deregister(&sierra_3port_device);
738 module_init(sierra_init);
739 module_exit(sierra_exit);
741 MODULE_AUTHOR(DRIVER_AUTHOR);
742 MODULE_DESCRIPTION(DRIVER_DESC);
743 MODULE_VERSION(DRIVER_VERSION);
744 MODULE_LICENSE("GPL");
746 #ifdef CONFIG_USB_DEBUG
747 module_param(debug, bool, S_IRUGO | S_IWUSR);
748 MODULE_PARM_DESC(debug, "Debug messages");