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.9c"
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_SET_MODE_Modem 0x0001
36 /* per port private data */
39 #define IN_BUFLEN 4096
43 static int truinstall = 1;
51 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
54 dev_dbg(&udev->dev, "%s", "SET POWER STATE\n");
55 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
56 SWIMS_USB_REQUEST_SetPower, /* __u8 request */
57 USB_TYPE_VENDOR, /* __u8 request type */
58 swiState, /* __u16 value */
60 NULL, /* void *data */
62 USB_CTRL_SET_TIMEOUT); /* int timeout */
66 static int sierra_set_ms_mode(struct usb_device *udev, __u16 eSWocMode)
69 dev_dbg(&udev->dev, "%s", "DEVICE MODE SWITCH\n");
70 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
71 SWIMS_USB_REQUEST_SetMode, /* __u8 request */
72 USB_TYPE_VENDOR, /* __u8 request type */
73 eSWocMode, /* __u16 value */
74 0x0000, /* __u16 index */
75 NULL, /* void *data */
77 USB_CTRL_SET_TIMEOUT); /* int timeout */
81 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
84 dev_dbg(&udev->dev, "%s", "NMEA Enable sent\n");
85 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
86 SWIMS_USB_REQUEST_SetNmea, /* __u8 request */
87 USB_TYPE_VENDOR, /* __u8 request type */
88 enable, /* __u16 value */
89 0x0000, /* __u16 index */
90 NULL, /* void *data */
92 USB_CTRL_SET_TIMEOUT); /* int timeout */
96 static int sierra_calc_num_ports(struct usb_serial *serial)
99 int *num_ports = usb_get_serial_data(serial);
105 usb_set_serial_data(serial, NULL);
111 static int sierra_calc_interface(struct usb_serial *serial)
114 struct usb_interface *p_interface;
115 struct usb_host_interface *p_host_interface;
117 /* Get the interface structure pointer from the serial struct */
118 p_interface = serial->interface;
120 /* Get a pointer to the host interface structure */
121 p_host_interface = p_interface->cur_altsetting;
123 /* read the interface descriptor for this active altsetting
124 * to find out the interface number we are on
126 interface = p_host_interface->desc.bInterfaceNumber;
131 static int sierra_probe(struct usb_serial *serial,
132 const struct usb_device_id *id)
135 struct usb_device *udev;
139 num_ports = kmalloc(sizeof(*num_ports), GFP_KERNEL);
143 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
146 /* Figure out the interface number from the serial structure */
147 ifnum = sierra_calc_interface(serial);
150 * If this interface supports more than 1 alternate
153 if (serial->interface->num_altsetting == 2) {
155 "Selecting alt setting for interface %d\n",
158 /* We know the alternate setting is 1 for the MC8785 */
159 usb_set_interface(udev, ifnum, 1);
162 /* Check if in installer mode */
163 if (truinstall && id->driver_info == DEVICE_INSTALLER) {
164 dev_dbg(&udev->dev, "%s", "FOUND TRU-INSTALL DEVICE(SW)\n");
165 result = sierra_set_ms_mode(udev, SWIMS_SET_MODE_Modem);
166 /* Don't bind to the device when in installer mode */
169 } else if (id->driver_info == DEVICE_1_PORT)
171 else if (ifnum == 0x99)
176 * save off our num_ports info so that we can use it in the
177 * calc_num_ports callback
179 usb_set_serial_data(serial, (void *)num_ports);
184 static struct usb_device_id id_table [] = {
185 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
186 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
187 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
188 { USB_DEVICE(0x0f30, 0x1b1d) }, /* Sierra Wireless MC5720 */
189 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
190 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
191 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
192 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
193 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
194 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) }, /* Sierra Wireless C597 */
196 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
197 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
198 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
199 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
200 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 (Thinkpad internal) */
201 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
202 { USB_DEVICE(0x03f0, 0x1e1d) }, /* HP hs2300 a.k.a MC8775 */
203 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
204 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
205 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780*/
206 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781*/
207 { USB_DEVICE(0x1199, 0x683B), .driver_info = DEVICE_1_PORT }, /* Sierra Wireless MC8785 Composite*/
208 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
209 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
210 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
211 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
212 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
213 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
214 { USB_DEVICE(0x1199, 0x6859), .driver_info = DEVICE_1_PORT }, /* Sierra Wireless AirCard 885 E */
215 { USB_DEVICE(0x1199, 0x685A), .driver_info = DEVICE_1_PORT }, /* Sierra Wireless AirCard 885 E */
217 { USB_DEVICE(0x1199, 0x6468) }, /* Sierra Wireless MP3G - EVDO */
218 { USB_DEVICE(0x1199, 0x6469) }, /* Sierra Wireless MP3G - UMTS/HSPA */
220 { USB_DEVICE(0x1199, 0x0112), .driver_info = DEVICE_1_PORT }, /* Sierra Wireless AirCard 580 */
221 { USB_DEVICE(0x0F3D, 0x0112), .driver_info = DEVICE_1_PORT }, /* Airprime/Sierra PC 5220 */
223 { USB_DEVICE(0x1199, 0x0FFF), .driver_info = DEVICE_INSTALLER},
226 MODULE_DEVICE_TABLE(usb, id_table);
228 static struct usb_driver sierra_driver = {
230 .probe = usb_serial_probe,
231 .disconnect = usb_serial_disconnect,
232 .id_table = id_table,
236 struct sierra_port_private {
237 spinlock_t lock; /* lock the structure */
238 int outstanding_urbs; /* number of out urbs in flight */
240 /* Input endpoints and buffers for this port */
241 struct urb *in_urbs[N_IN_URB];
242 char *in_buffer[N_IN_URB];
244 /* Settings for the port */
245 int rts_state; /* Handshaking pins (outputs) */
247 int cts_state; /* Handshaking pins (inputs) */
253 static int sierra_send_setup(struct tty_struct *tty,
254 struct usb_serial_port *port)
256 struct usb_serial *serial = port->serial;
257 struct sierra_port_private *portdata;
262 portdata = usb_get_serial_port_data(port);
266 if (portdata->dtr_state)
268 if (portdata->rts_state)
271 /* Determine which port is targeted */
272 if (port->bulk_out_endpointAddress == 2)
274 else if (port->bulk_out_endpointAddress == 4)
276 else if (port->bulk_out_endpointAddress == 5)
279 return usb_control_msg(serial->dev,
280 usb_rcvctrlpipe(serial->dev, 0),
281 0x22, 0x21, val, interface,
282 NULL, 0, USB_CTRL_SET_TIMEOUT);
288 static void sierra_set_termios(struct tty_struct *tty,
289 struct usb_serial_port *port, struct ktermios *old_termios)
292 tty_termios_copy_hw(tty->termios, old_termios);
293 sierra_send_setup(tty, port);
296 static int sierra_tiocmget(struct tty_struct *tty, struct file *file)
298 struct usb_serial_port *port = tty->driver_data;
300 struct sierra_port_private *portdata;
302 portdata = usb_get_serial_port_data(port);
304 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
305 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
306 ((portdata->cts_state) ? TIOCM_CTS : 0) |
307 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
308 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
309 ((portdata->ri_state) ? TIOCM_RNG : 0);
314 static int sierra_tiocmset(struct tty_struct *tty, struct file *file,
315 unsigned int set, unsigned int clear)
317 struct usb_serial_port *port = tty->driver_data;
318 struct sierra_port_private *portdata;
320 portdata = usb_get_serial_port_data(port);
323 portdata->rts_state = 1;
325 portdata->dtr_state = 1;
327 if (clear & TIOCM_RTS)
328 portdata->rts_state = 0;
329 if (clear & TIOCM_DTR)
330 portdata->dtr_state = 0;
331 return sierra_send_setup(tty, port);
334 static void sierra_outdat_callback(struct urb *urb)
336 struct usb_serial_port *port = urb->context;
337 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
338 int status = urb->status;
341 dbg("%s - port %d", __func__, port->number);
343 /* free up the transfer buffer, as usb_free_urb() does not do this */
344 kfree(urb->transfer_buffer);
347 dbg("%s - nonzero write bulk status received: %d",
350 spin_lock_irqsave(&portdata->lock, flags);
351 --portdata->outstanding_urbs;
352 spin_unlock_irqrestore(&portdata->lock, flags);
354 usb_serial_port_softint(port);
358 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
359 const unsigned char *buf, int count)
361 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
362 struct usb_serial *serial = port->serial;
364 unsigned char *buffer;
368 portdata = usb_get_serial_port_data(port);
370 dbg("%s: write (%d chars)", __func__, count);
372 spin_lock_irqsave(&portdata->lock, flags);
373 if (portdata->outstanding_urbs > N_OUT_URB) {
374 spin_unlock_irqrestore(&portdata->lock, flags);
375 dbg("%s - write limit hit\n", __func__);
378 portdata->outstanding_urbs++;
379 spin_unlock_irqrestore(&portdata->lock, flags);
381 buffer = kmalloc(count, GFP_ATOMIC);
383 dev_err(&port->dev, "out of memory\n");
385 goto error_no_buffer;
388 urb = usb_alloc_urb(0, GFP_ATOMIC);
390 dev_err(&port->dev, "no more free urbs\n");
395 memcpy(buffer, buf, count);
397 usb_serial_debug_data(debug, &port->dev, __func__, count, buffer);
399 usb_fill_bulk_urb(urb, serial->dev,
400 usb_sndbulkpipe(serial->dev,
401 port->bulk_out_endpointAddress),
402 buffer, count, sierra_outdat_callback, port);
404 /* send it down the pipe */
405 status = usb_submit_urb(urb, GFP_ATOMIC);
407 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
408 "with status = %d\n", __func__, status);
413 /* we are done with this urb, so let the host driver
414 * really free it when it is finished with it */
423 spin_lock_irqsave(&portdata->lock, flags);
424 --portdata->outstanding_urbs;
425 spin_unlock_irqrestore(&portdata->lock, flags);
429 static void sierra_indat_callback(struct urb *urb)
433 struct usb_serial_port *port;
434 struct tty_struct *tty;
435 unsigned char *data = urb->transfer_buffer;
436 int status = urb->status;
438 dbg("%s: %p", __func__, urb);
440 endpoint = usb_pipeendpoint(urb->pipe);
444 dbg("%s: nonzero status: %d on endpoint %02x.",
445 __func__, status, endpoint);
447 tty = port->port.tty;
448 if (urb->actual_length) {
449 tty_buffer_request_room(tty, urb->actual_length);
450 tty_insert_flip_string(tty, data, urb->actual_length);
451 tty_flip_buffer_push(tty);
453 dbg("%s: empty read urb received", __func__);
456 /* Resubmit urb so we continue receiving */
457 if (port->port.count && status != -ESHUTDOWN) {
458 err = usb_submit_urb(urb, GFP_ATOMIC);
460 dev_err(&port->dev, "resubmit read urb failed."
467 static void sierra_instat_callback(struct urb *urb)
470 int status = urb->status;
471 struct usb_serial_port *port = urb->context;
472 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
473 struct usb_serial *serial = port->serial;
476 dbg("%s: urb %p port %p has data %p", __func__, urb, port, portdata);
479 struct usb_ctrlrequest *req_pkt =
480 (struct usb_ctrlrequest *)urb->transfer_buffer;
483 dbg("%s: NULL req_pkt\n", __func__);
486 if ((req_pkt->bRequestType == 0xA1) &&
487 (req_pkt->bRequest == 0x20)) {
489 unsigned char signals = *((unsigned char *)
490 urb->transfer_buffer +
491 sizeof(struct usb_ctrlrequest));
493 dbg("%s: signal x%x", __func__, signals);
495 old_dcd_state = portdata->dcd_state;
496 portdata->cts_state = 1;
497 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
498 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
499 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
501 if (port->port.tty && !C_CLOCAL(port->port.tty) &&
502 old_dcd_state && !portdata->dcd_state)
503 tty_hangup(port->port.tty);
505 dbg("%s: type %x req %x", __func__,
506 req_pkt->bRequestType, req_pkt->bRequest);
509 dbg("%s: error %d", __func__, status);
511 /* Resubmit urb so we continue receiving IRQ data */
512 if (status != -ESHUTDOWN) {
513 urb->dev = serial->dev;
514 err = usb_submit_urb(urb, GFP_ATOMIC);
516 dbg("%s: resubmit intr urb failed. (%d)",
521 static int sierra_write_room(struct tty_struct *tty)
523 struct usb_serial_port *port = tty->driver_data;
524 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
527 dbg("%s - port %d", __func__, port->number);
529 /* try to give a good number back based on if we have any free urbs at
530 * this point in time */
531 spin_lock_irqsave(&portdata->lock, flags);
532 if (portdata->outstanding_urbs > N_OUT_URB * 2 / 3) {
533 spin_unlock_irqrestore(&portdata->lock, flags);
534 dbg("%s - write limit hit\n", __func__);
537 spin_unlock_irqrestore(&portdata->lock, flags);
542 static int sierra_open(struct tty_struct *tty,
543 struct usb_serial_port *port, struct file *filp)
545 struct sierra_port_private *portdata;
546 struct usb_serial *serial = port->serial;
551 portdata = usb_get_serial_port_data(port);
555 /* Set some sane defaults */
556 portdata->rts_state = 1;
557 portdata->dtr_state = 1;
559 /* Reset low level data toggle and start reading from endpoints */
560 for (i = 0; i < N_IN_URB; i++) {
561 urb = portdata->in_urbs[i];
564 if (urb->dev != serial->dev) {
565 dbg("%s: dev %p != %p", __func__,
566 urb->dev, serial->dev);
571 * make sure endpoint data toggle is synchronized with the
574 usb_clear_halt(urb->dev, urb->pipe);
576 result = usb_submit_urb(urb, GFP_KERNEL);
578 dev_err(&port->dev, "submit urb %d failed (%d) %d\n",
579 i, result, urb->transfer_buffer_length);
584 tty->low_latency = 1;
586 sierra_send_setup(tty, port);
588 /* start up the interrupt endpoint if we have one */
589 if (port->interrupt_in_urb) {
590 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
592 dev_err(&port->dev, "submit irq_in urb failed %d\n",
598 static void sierra_close(struct tty_struct *tty,
599 struct usb_serial_port *port, struct file *filp)
602 struct usb_serial *serial = port->serial;
603 struct sierra_port_private *portdata;
606 portdata = usb_get_serial_port_data(port);
608 portdata->rts_state = 0;
609 portdata->dtr_state = 0;
612 mutex_lock(&serial->disc_mutex);
613 if (!serial->disconnected)
614 sierra_send_setup(tty, port);
615 mutex_unlock(&serial->disc_mutex);
617 /* Stop reading/writing urbs */
618 for (i = 0; i < N_IN_URB; i++)
619 usb_kill_urb(portdata->in_urbs[i]);
622 usb_kill_urb(port->interrupt_in_urb);
624 port->port.tty = NULL; /* FIXME */
627 static int sierra_startup(struct usb_serial *serial)
629 struct usb_serial_port *port;
630 struct sierra_port_private *portdata;
637 /* Set Device mode to D0 */
638 sierra_set_power_state(serial->dev, 0x0000);
640 /* Check NMEA and set */
642 sierra_vsc_set_nmea(serial->dev, 1);
644 /* Now setup per port private data */
645 for (i = 0; i < serial->num_ports; i++) {
646 port = serial->port[i];
647 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
649 dbg("%s: kmalloc for sierra_port_private (%d) failed!.",
653 spin_lock_init(&portdata->lock);
654 for (j = 0; j < N_IN_URB; j++) {
655 portdata->in_buffer[j] = kmalloc(IN_BUFLEN, GFP_KERNEL);
656 if (!portdata->in_buffer[j]) {
657 for (--j; j >= 0; j--)
658 kfree(portdata->in_buffer[j]);
664 usb_set_serial_port_data(port, portdata);
666 /* initialize the in urbs */
667 for (j = 0; j < N_IN_URB; ++j) {
668 urb = usb_alloc_urb(0, GFP_KERNEL);
670 dbg("%s: alloc for in port failed.",
674 /* Fill URB using supplied data. */
675 usb_fill_bulk_urb(urb, serial->dev,
676 usb_rcvbulkpipe(serial->dev,
677 port->bulk_in_endpointAddress),
678 portdata->in_buffer[j], IN_BUFLEN,
679 sierra_indat_callback, port);
680 portdata->in_urbs[j] = urb;
687 static void sierra_shutdown(struct usb_serial *serial)
690 struct usb_serial_port *port;
691 struct sierra_port_private *portdata;
695 for (i = 0; i < serial->num_ports; ++i) {
696 port = serial->port[i];
699 portdata = usb_get_serial_port_data(port);
703 for (j = 0; j < N_IN_URB; j++) {
704 usb_kill_urb(portdata->in_urbs[j]);
705 usb_free_urb(portdata->in_urbs[j]);
706 kfree(portdata->in_buffer[j]);
709 usb_set_serial_port_data(port, NULL);
713 static struct usb_serial_driver sierra_device = {
715 .owner = THIS_MODULE,
718 .description = "Sierra USB modem",
719 .id_table = id_table,
720 .usb_driver = &sierra_driver,
721 .calc_num_ports = sierra_calc_num_ports,
722 .probe = sierra_probe,
724 .close = sierra_close,
725 .write = sierra_write,
726 .write_room = sierra_write_room,
727 .set_termios = sierra_set_termios,
728 .tiocmget = sierra_tiocmget,
729 .tiocmset = sierra_tiocmset,
730 .attach = sierra_startup,
731 .shutdown = sierra_shutdown,
732 .read_int_callback = sierra_instat_callback,
735 /* Functions used by new usb-serial code. */
736 static int __init sierra_init(void)
739 retval = usb_serial_register(&sierra_device);
741 goto failed_device_register;
744 retval = usb_register(&sierra_driver);
746 goto failed_driver_register;
748 info(DRIVER_DESC ": " DRIVER_VERSION);
752 failed_driver_register:
753 usb_serial_deregister(&sierra_device);
754 failed_device_register:
758 static void __exit sierra_exit(void)
760 usb_deregister (&sierra_driver);
761 usb_serial_deregister(&sierra_device);
764 module_init(sierra_init);
765 module_exit(sierra_exit);
767 MODULE_AUTHOR(DRIVER_AUTHOR);
768 MODULE_DESCRIPTION(DRIVER_DESC);
769 MODULE_VERSION(DRIVER_VERSION);
770 MODULE_LICENSE("GPL");
772 module_param(truinstall, bool, 0);
773 MODULE_PARM_DESC(truinstall, "TRU-Install support");
775 module_param(nmea, bool, 0);
776 MODULE_PARM_DESC(nmea, "NMEA streaming");
778 #ifdef CONFIG_USB_DEBUG
779 module_param(debug, bool, S_IRUGO | S_IWUSR);
780 MODULE_PARM_DESC(debug, "Debug messages");