2 USB Driver for Sierra Wireless
4 Copyright (C) 2006, 2007, 2008 Kevin Lloyd <klloyd@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.13a"
18 #define DRIVER_AUTHOR "Kevin Lloyd <klloyd@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>
29 #include <linux/usb/ch9.h>
31 #define SWIMS_USB_REQUEST_SetPower 0x00
32 #define SWIMS_USB_REQUEST_SetNmea 0x07
33 #define SWIMS_USB_REQUEST_SetMode 0x0B
34 #define SWIMS_USB_REQUEST_GetSwocInfo 0x0A
35 #define SWIMS_SET_MODE_Modem 0x0001
37 /* per port private data */
40 #define IN_BUFLEN 4096
45 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
48 dev_dbg(&udev->dev, "%s", __func__);
49 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
50 SWIMS_USB_REQUEST_SetPower, /* __u8 request */
51 USB_TYPE_VENDOR, /* __u8 request type */
52 swiState, /* __u16 value */
54 NULL, /* void *data */
56 USB_CTRL_SET_TIMEOUT); /* int timeout */
60 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
63 dev_dbg(&udev->dev, "%s", __func__);
64 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
65 SWIMS_USB_REQUEST_SetNmea, /* __u8 request */
66 USB_TYPE_VENDOR, /* __u8 request type */
67 enable, /* __u16 value */
68 0x0000, /* __u16 index */
69 NULL, /* void *data */
71 USB_CTRL_SET_TIMEOUT); /* int timeout */
75 static int sierra_calc_num_ports(struct usb_serial *serial)
78 int *num_ports = usb_get_serial_data(serial);
79 dev_dbg(&serial->dev->dev, "%s", __func__);
85 usb_set_serial_data(serial, NULL);
91 static int sierra_calc_interface(struct usb_serial *serial)
94 struct usb_interface *p_interface;
95 struct usb_host_interface *p_host_interface;
96 dev_dbg(&serial->dev->dev, "%s", __func__);
98 /* Get the interface structure pointer from the serial struct */
99 p_interface = serial->interface;
101 /* Get a pointer to the host interface structure */
102 p_host_interface = p_interface->cur_altsetting;
104 /* read the interface descriptor for this active altsetting
105 * to find out the interface number we are on
107 interface = p_host_interface->desc.bInterfaceNumber;
112 static int sierra_probe(struct usb_serial *serial,
113 const struct usb_device_id *id)
116 struct usb_device *udev;
121 dev_dbg(&serial->dev->dev, "%s", __func__);
123 num_ports = kmalloc(sizeof(*num_ports), GFP_KERNEL);
127 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
128 numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
131 /* Figure out the interface number from the serial structure */
132 ifnum = sierra_calc_interface(serial);
135 * If this interface supports more than 1 alternate
138 if (serial->interface->num_altsetting == 2) {
139 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
141 /* We know the alternate setting is 1 for the MC8785 */
142 usb_set_interface(udev, ifnum, 1);
145 /* Dummy interface present on some SKUs should be ignored */
148 else if (numendpoints <= 3)
151 *num_ports = (numendpoints-1)/2;
154 * save off our num_ports info so that we can use it in the
155 * calc_num_ports callback
157 usb_set_serial_data(serial, (void *)num_ports);
162 static struct usb_device_id id_table [] = {
163 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
164 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
165 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
166 { USB_DEVICE(0x0f30, 0x1b1d) }, /* Sierra Wireless MC5720 */
167 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
168 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
169 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
170 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
171 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
172 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
173 /* Sierra Wireless C597 */
174 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
175 /* Sierra Wireless Device */
176 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
177 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless Device */
179 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
180 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
181 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
182 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
183 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 (Lenovo) */
184 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
185 { USB_DEVICE(0x03f0, 0x1e1d) }, /* HP hs2300 a.k.a MC8775 */
186 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
187 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
188 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
189 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
190 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
191 { USB_DEVICE(0x1199, 0x683C) }, /* Sierra Wireless MC8790 */
192 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8790 */
193 { USB_DEVICE(0x1199, 0x683E) }, /* Sierra Wireless MC8790 */
194 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
195 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
196 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
197 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
198 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
199 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
200 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
201 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
202 /* Sierra Wireless C885 */
203 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
204 /* Sierra Wireless Device */
205 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
206 /* Sierra Wireless Device */
207 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
209 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
210 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
214 MODULE_DEVICE_TABLE(usb, id_table);
216 static struct usb_driver sierra_driver = {
218 .probe = usb_serial_probe,
219 .disconnect = usb_serial_disconnect,
220 .id_table = id_table,
224 struct sierra_port_private {
225 spinlock_t lock; /* lock the structure */
226 int outstanding_urbs; /* number of out urbs in flight */
228 /* Input endpoints and buffers for this port */
229 struct urb *in_urbs[N_IN_URB];
230 char *in_buffer[N_IN_URB];
232 /* Settings for the port */
233 int rts_state; /* Handshaking pins (outputs) */
235 int cts_state; /* Handshaking pins (inputs) */
241 static int sierra_send_setup(struct tty_struct *tty,
242 struct usb_serial_port *port)
244 struct usb_serial *serial = port->serial;
245 struct sierra_port_private *portdata;
250 portdata = usb_get_serial_port_data(port);
254 if (portdata->dtr_state)
256 if (portdata->rts_state)
259 /* If composite device then properly report interface */
260 if (serial->num_ports == 1)
261 interface = sierra_calc_interface(serial);
263 /* Otherwise the need to do non-composite mapping */
265 if (port->bulk_out_endpointAddress == 2)
267 else if (port->bulk_out_endpointAddress == 4)
269 else if (port->bulk_out_endpointAddress == 5)
273 return usb_control_msg(serial->dev,
274 usb_rcvctrlpipe(serial->dev, 0),
275 0x22, 0x21, val, interface,
276 NULL, 0, USB_CTRL_SET_TIMEOUT);
282 static void sierra_set_termios(struct tty_struct *tty,
283 struct usb_serial_port *port, struct ktermios *old_termios)
286 tty_termios_copy_hw(tty->termios, old_termios);
287 sierra_send_setup(tty, port);
290 static int sierra_tiocmget(struct tty_struct *tty, struct file *file)
292 struct usb_serial_port *port = tty->driver_data;
294 struct sierra_port_private *portdata;
296 portdata = usb_get_serial_port_data(port);
298 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
299 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
300 ((portdata->cts_state) ? TIOCM_CTS : 0) |
301 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
302 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
303 ((portdata->ri_state) ? TIOCM_RNG : 0);
308 static int sierra_tiocmset(struct tty_struct *tty, struct file *file,
309 unsigned int set, unsigned int clear)
311 struct usb_serial_port *port = tty->driver_data;
312 struct sierra_port_private *portdata;
314 portdata = usb_get_serial_port_data(port);
317 portdata->rts_state = 1;
319 portdata->dtr_state = 1;
321 if (clear & TIOCM_RTS)
322 portdata->rts_state = 0;
323 if (clear & TIOCM_DTR)
324 portdata->dtr_state = 0;
325 return sierra_send_setup(tty, port);
328 static void sierra_outdat_callback(struct urb *urb)
330 struct usb_serial_port *port = urb->context;
331 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
332 int status = urb->status;
335 dbg("%s - port %d", __func__, port->number);
337 /* free up the transfer buffer, as usb_free_urb() does not do this */
338 kfree(urb->transfer_buffer);
341 dbg("%s - nonzero write bulk status received: %d",
344 spin_lock_irqsave(&portdata->lock, flags);
345 --portdata->outstanding_urbs;
346 spin_unlock_irqrestore(&portdata->lock, flags);
348 usb_serial_port_softint(port);
352 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
353 const unsigned char *buf, int count)
355 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
356 struct usb_serial *serial = port->serial;
358 unsigned char *buffer;
362 portdata = usb_get_serial_port_data(port);
364 dbg("%s: write (%d chars)", __func__, count);
366 spin_lock_irqsave(&portdata->lock, flags);
367 if (portdata->outstanding_urbs > N_OUT_URB) {
368 spin_unlock_irqrestore(&portdata->lock, flags);
369 dbg("%s - write limit hit\n", __func__);
372 portdata->outstanding_urbs++;
373 spin_unlock_irqrestore(&portdata->lock, flags);
375 buffer = kmalloc(count, GFP_ATOMIC);
377 dev_err(&port->dev, "out of memory\n");
379 goto error_no_buffer;
382 urb = usb_alloc_urb(0, GFP_ATOMIC);
384 dev_err(&port->dev, "no more free urbs\n");
389 memcpy(buffer, buf, count);
391 usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
393 usb_fill_bulk_urb(urb, serial->dev,
394 usb_sndbulkpipe(serial->dev,
395 port->bulk_out_endpointAddress),
396 buffer, count, sierra_outdat_callback, port);
398 /* send it down the pipe */
399 status = usb_submit_urb(urb, GFP_ATOMIC);
401 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
402 "with status = %d\n", __func__, status);
407 /* we are done with this urb, so let the host driver
408 * really free it when it is finished with it */
417 spin_lock_irqsave(&portdata->lock, flags);
418 --portdata->outstanding_urbs;
419 spin_unlock_irqrestore(&portdata->lock, flags);
423 static void sierra_indat_callback(struct urb *urb)
427 struct usb_serial_port *port;
428 struct tty_struct *tty;
429 unsigned char *data = urb->transfer_buffer;
430 int status = urb->status;
432 dbg("%s: %p", __func__, urb);
434 endpoint = usb_pipeendpoint(urb->pipe);
438 dbg("%s: nonzero status: %d on endpoint %02x.",
439 __func__, status, endpoint);
441 tty = port->port.tty;
442 if (urb->actual_length) {
443 tty_buffer_request_room(tty, urb->actual_length);
444 tty_insert_flip_string(tty, data, urb->actual_length);
445 tty_flip_buffer_push(tty);
447 dbg("%s: empty read urb received", __func__);
450 /* Resubmit urb so we continue receiving */
451 if (port->port.count && status != -ESHUTDOWN) {
452 err = usb_submit_urb(urb, GFP_ATOMIC);
454 dev_err(&port->dev, "resubmit read urb failed."
461 static void sierra_instat_callback(struct urb *urb)
464 int status = urb->status;
465 struct usb_serial_port *port = urb->context;
466 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
467 struct usb_serial *serial = port->serial;
470 dbg("%s: urb %p port %p has data %p", __func__, urb, port, portdata);
473 struct usb_ctrlrequest *req_pkt =
474 (struct usb_ctrlrequest *)urb->transfer_buffer;
477 dbg("%s: NULL req_pkt\n", __func__);
480 if ((req_pkt->bRequestType == 0xA1) &&
481 (req_pkt->bRequest == 0x20)) {
483 unsigned char signals = *((unsigned char *)
484 urb->transfer_buffer +
485 sizeof(struct usb_ctrlrequest));
487 dbg("%s: signal x%x", __func__, signals);
489 old_dcd_state = portdata->dcd_state;
490 portdata->cts_state = 1;
491 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
492 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
493 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
495 if (port->port.tty && !C_CLOCAL(port->port.tty) &&
496 old_dcd_state && !portdata->dcd_state)
497 tty_hangup(port->port.tty);
499 dbg("%s: type %x req %x", __func__,
500 req_pkt->bRequestType, req_pkt->bRequest);
503 dbg("%s: error %d", __func__, status);
505 /* Resubmit urb so we continue receiving IRQ data */
506 if (status != -ESHUTDOWN) {
507 urb->dev = serial->dev;
508 err = usb_submit_urb(urb, GFP_ATOMIC);
510 dbg("%s: resubmit intr urb failed. (%d)",
515 static int sierra_write_room(struct tty_struct *tty)
517 struct usb_serial_port *port = tty->driver_data;
518 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
521 dbg("%s - port %d", __func__, port->number);
523 /* try to give a good number back based on if we have any free urbs at
524 * this point in time */
525 spin_lock_irqsave(&portdata->lock, flags);
526 if (portdata->outstanding_urbs > N_OUT_URB * 2 / 3) {
527 spin_unlock_irqrestore(&portdata->lock, flags);
528 dbg("%s - write limit hit\n", __func__);
531 spin_unlock_irqrestore(&portdata->lock, flags);
536 static int sierra_open(struct tty_struct *tty,
537 struct usb_serial_port *port, struct file *filp)
539 struct sierra_port_private *portdata;
540 struct usb_serial *serial = port->serial;
545 portdata = usb_get_serial_port_data(port);
549 /* Set some sane defaults */
550 portdata->rts_state = 1;
551 portdata->dtr_state = 1;
553 /* Reset low level data toggle and start reading from endpoints */
554 for (i = 0; i < N_IN_URB; i++) {
555 urb = portdata->in_urbs[i];
558 if (urb->dev != serial->dev) {
559 dbg("%s: dev %p != %p", __func__,
560 urb->dev, serial->dev);
565 * make sure endpoint data toggle is synchronized with the
568 usb_clear_halt(urb->dev, urb->pipe);
570 result = usb_submit_urb(urb, GFP_KERNEL);
572 dev_err(&port->dev, "submit urb %d failed (%d) %d\n",
573 i, result, urb->transfer_buffer_length);
578 tty->low_latency = 1;
580 sierra_send_setup(tty, port);
582 /* start up the interrupt endpoint if we have one */
583 if (port->interrupt_in_urb) {
584 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
586 dev_err(&port->dev, "submit irq_in urb failed %d\n",
592 static void sierra_close(struct tty_struct *tty,
593 struct usb_serial_port *port, struct file *filp)
596 struct usb_serial *serial = port->serial;
597 struct sierra_port_private *portdata;
600 portdata = usb_get_serial_port_data(port);
602 portdata->rts_state = 0;
603 portdata->dtr_state = 0;
606 mutex_lock(&serial->disc_mutex);
607 if (!serial->disconnected)
608 sierra_send_setup(tty, port);
609 mutex_unlock(&serial->disc_mutex);
611 /* Stop reading/writing urbs */
612 for (i = 0; i < N_IN_URB; i++)
613 usb_kill_urb(portdata->in_urbs[i]);
616 usb_kill_urb(port->interrupt_in_urb);
618 port->port.tty = NULL; /* FIXME */
621 static int sierra_startup(struct usb_serial *serial)
623 struct usb_serial_port *port;
624 struct sierra_port_private *portdata;
631 /* Set Device mode to D0 */
632 sierra_set_power_state(serial->dev, 0x0000);
634 /* Check NMEA and set */
636 sierra_vsc_set_nmea(serial->dev, 1);
638 /* Now setup per port private data */
639 for (i = 0; i < serial->num_ports; i++) {
640 port = serial->port[i];
641 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
643 dbg("%s: kmalloc for sierra_port_private (%d) failed!.",
647 spin_lock_init(&portdata->lock);
648 for (j = 0; j < N_IN_URB; j++) {
649 portdata->in_buffer[j] = kmalloc(IN_BUFLEN, GFP_KERNEL);
650 if (!portdata->in_buffer[j]) {
651 for (--j; j >= 0; j--)
652 kfree(portdata->in_buffer[j]);
658 usb_set_serial_port_data(port, portdata);
660 /* initialize the in urbs */
661 for (j = 0; j < N_IN_URB; ++j) {
662 urb = usb_alloc_urb(0, GFP_KERNEL);
664 dbg("%s: alloc for in port failed.",
668 /* Fill URB using supplied data. */
669 usb_fill_bulk_urb(urb, serial->dev,
670 usb_rcvbulkpipe(serial->dev,
671 port->bulk_in_endpointAddress),
672 portdata->in_buffer[j], IN_BUFLEN,
673 sierra_indat_callback, port);
674 portdata->in_urbs[j] = urb;
681 static void sierra_shutdown(struct usb_serial *serial)
684 struct usb_serial_port *port;
685 struct sierra_port_private *portdata;
689 for (i = 0; i < serial->num_ports; ++i) {
690 port = serial->port[i];
693 portdata = usb_get_serial_port_data(port);
697 for (j = 0; j < N_IN_URB; j++) {
698 usb_kill_urb(portdata->in_urbs[j]);
699 usb_free_urb(portdata->in_urbs[j]);
700 kfree(portdata->in_buffer[j]);
703 usb_set_serial_port_data(port, NULL);
707 static struct usb_serial_driver sierra_device = {
709 .owner = THIS_MODULE,
712 .description = "Sierra USB modem",
713 .id_table = id_table,
714 .usb_driver = &sierra_driver,
715 .calc_num_ports = sierra_calc_num_ports,
716 .probe = sierra_probe,
718 .close = sierra_close,
719 .write = sierra_write,
720 .write_room = sierra_write_room,
721 .set_termios = sierra_set_termios,
722 .tiocmget = sierra_tiocmget,
723 .tiocmset = sierra_tiocmset,
724 .attach = sierra_startup,
725 .shutdown = sierra_shutdown,
726 .read_int_callback = sierra_instat_callback,
729 /* Functions used by new usb-serial code. */
730 static int __init sierra_init(void)
733 retval = usb_serial_register(&sierra_device);
735 goto failed_device_register;
738 retval = usb_register(&sierra_driver);
740 goto failed_driver_register;
742 info(DRIVER_DESC ": " DRIVER_VERSION);
746 failed_driver_register:
747 usb_serial_deregister(&sierra_device);
748 failed_device_register:
752 static void __exit sierra_exit(void)
754 usb_deregister(&sierra_driver);
755 usb_serial_deregister(&sierra_device);
758 module_init(sierra_init);
759 module_exit(sierra_exit);
761 MODULE_AUTHOR(DRIVER_AUTHOR);
762 MODULE_DESCRIPTION(DRIVER_DESC);
763 MODULE_VERSION(DRIVER_VERSION);
764 MODULE_LICENSE("GPL");
766 module_param(nmea, bool, S_IRUGO | S_IWUSR);
767 MODULE_PARM_DESC(nmea, "NMEA streaming");
769 module_param(debug, bool, S_IRUGO | S_IWUSR);
770 MODULE_PARM_DESC(debug, "Debug messages");