2 USB Driver for Sierra Wireless
4 Copyright (C) 2006, 2007, 2008 Kevin Lloyd <klloyd@sierrawireless.com>,
6 Copyright (C) 2008, 2009 Elina Pasheva, Matthew Safar, Rory Filer
7 <linux@sierrawireless.com>
9 IMPORTANT DISCLAIMER: This driver is not commercially supported by
10 Sierra Wireless. Use at your own risk.
12 This driver is free software; you can redistribute it and/or modify
13 it under the terms of Version 2 of the GNU General Public License as
14 published by the Free Software Foundation.
16 Portions based on the option driver by Matthias Urlichs <smurf@smurf.noris.de>
17 Whom based his on the Keyspan driver by Hugh Blemings <hugh@blemings.org>
19 /* Uncomment to log function calls */
21 #define DRIVER_VERSION "v.1.7.16"
22 #define DRIVER_AUTHOR "Kevin Lloyd, Elina Pasheva, Matthew Safar, Rory Filer"
23 #define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
25 #include <linux/kernel.h>
26 #include <linux/jiffies.h>
27 #include <linux/errno.h>
28 #include <linux/tty.h>
29 #include <linux/slab.h>
30 #include <linux/tty_flip.h>
31 #include <linux/module.h>
32 #include <linux/usb.h>
33 #include <linux/usb/serial.h>
35 #define SWIMS_USB_REQUEST_SetPower 0x00
36 #define SWIMS_USB_REQUEST_SetNmea 0x07
39 #define N_OUT_URB_HM 64
42 #define IN_BUFLEN 4096
44 #define MAX_TRANSFER (PAGE_SIZE - 512)
45 /* MAX_TRANSFER is chosen so that the VM is not stressed by
46 allocations > PAGE_SIZE and the number of packets in a page
47 is an integer 512 is the largest possible packet on EHCI */
52 /* Used in interface blacklisting */
53 struct sierra_iface_info {
54 const u32 infolen; /* number of interface numbers on blacklist */
55 const u8 *ifaceinfo; /* pointer to the array holding the numbers */
58 struct sierra_intf_private {
60 unsigned int suspended:1;
62 unsigned int open_ports;
65 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
68 dev_dbg(&udev->dev, "%s\n", __func__);
69 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
70 SWIMS_USB_REQUEST_SetPower, /* __u8 request */
71 USB_TYPE_VENDOR, /* __u8 request type */
72 swiState, /* __u16 value */
74 NULL, /* void *data */
76 USB_CTRL_SET_TIMEOUT); /* int timeout */
80 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
83 dev_dbg(&udev->dev, "%s\n", __func__);
84 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
85 SWIMS_USB_REQUEST_SetNmea, /* __u8 request */
86 USB_TYPE_VENDOR, /* __u8 request type */
87 enable, /* __u16 value */
88 0x0000, /* __u16 index */
89 NULL, /* void *data */
91 USB_CTRL_SET_TIMEOUT); /* int timeout */
95 static int sierra_calc_num_ports(struct usb_serial *serial)
98 u8 ifnum, numendpoints;
100 dev_dbg(&serial->dev->dev, "%s\n", __func__);
102 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
103 numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
105 /* Dummy interface present on some SKUs should be ignored */
108 else if (numendpoints <= 3)
111 num_ports = (numendpoints-1)/2;
115 static int is_blacklisted(const u8 ifnum,
116 const struct sierra_iface_info *blacklist)
122 info = blacklist->ifaceinfo;
124 for (i = 0; i < blacklist->infolen; i++) {
125 if (info[i] == ifnum)
132 static int is_himemory(const u8 ifnum,
133 const struct sierra_iface_info *himemorylist)
139 info = himemorylist->ifaceinfo;
141 for (i=0; i < himemorylist->infolen; i++) {
142 if (info[i] == ifnum)
149 static int sierra_calc_interface(struct usb_serial *serial)
152 struct usb_interface *p_interface;
153 struct usb_host_interface *p_host_interface;
154 dev_dbg(&serial->dev->dev, "%s\n", __func__);
156 /* Get the interface structure pointer from the serial struct */
157 p_interface = serial->interface;
159 /* Get a pointer to the host interface structure */
160 p_host_interface = p_interface->cur_altsetting;
162 /* read the interface descriptor for this active altsetting
163 * to find out the interface number we are on
165 interface = p_host_interface->desc.bInterfaceNumber;
170 static int sierra_probe(struct usb_serial *serial,
171 const struct usb_device_id *id)
174 struct usb_device *udev;
178 dev_dbg(&udev->dev, "%s\n", __func__);
180 ifnum = sierra_calc_interface(serial);
182 * If this interface supports more than 1 alternate
185 if (serial->interface->num_altsetting == 2) {
186 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
188 /* We know the alternate setting is 1 for the MC8785 */
189 usb_set_interface(udev, ifnum, 1);
192 /* ifnum could have changed - by calling usb_set_interface */
193 ifnum = sierra_calc_interface(serial);
195 if (is_blacklisted(ifnum,
196 (struct sierra_iface_info *)id->driver_info)) {
197 dev_dbg(&serial->dev->dev,
198 "Ignoring blacklisted interface #%d\n", ifnum);
205 /* interfaces with higher memory requirements */
206 static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
207 static const struct sierra_iface_info typeA_interface_list = {
208 .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
209 .ifaceinfo = hi_memory_typeA_ifaces,
212 static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
213 static const struct sierra_iface_info typeB_interface_list = {
214 .infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
215 .ifaceinfo = hi_memory_typeB_ifaces,
218 /* 'blacklist' of interfaces not served by this driver */
219 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11, 19, 20 };
220 static const struct sierra_iface_info direct_ip_interface_blacklist = {
221 .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
222 .ifaceinfo = direct_ip_non_serial_ifaces,
225 static const struct usb_device_id id_table[] = {
226 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
227 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
228 { USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
229 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
231 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
232 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
233 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
234 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
235 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
236 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
237 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
238 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
239 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
240 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
241 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
242 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
243 { USB_DEVICE(0x1199, 0x0301) }, /* Sierra Wireless USB Dongle 250U */
244 /* Sierra Wireless C597 */
245 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
246 /* Sierra Wireless T598 */
247 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
248 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
249 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
250 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
251 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
253 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
254 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
255 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
256 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
257 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
258 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
259 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
260 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
261 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
262 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
263 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
264 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
265 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
266 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
267 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
268 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
269 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
270 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
271 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
272 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
273 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
274 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
275 { USB_DEVICE(0x1199, 0x683C) },
276 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
277 /* Sierra Wireless MC8790, MC8791, MC8792 */
278 { USB_DEVICE(0x1199, 0x683E) },
279 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
280 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
281 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
282 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
283 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
284 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
285 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
286 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
287 /* Sierra Wireless C885 */
288 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
289 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
290 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
291 /* Sierra Wireless C22/C33 */
292 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
293 /* Sierra Wireless HSPA Non-Composite Device */
294 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
295 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
296 { USB_DEVICE(0x1199, 0x68A2), /* Sierra Wireless MC77xx in QMI mode */
297 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
299 /* Sierra Wireless Direct IP modems */
300 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68A3, 0xFF, 0xFF, 0xFF),
301 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
303 /* AT&T Direct IP LTE modems */
304 { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
305 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
307 /* Airprime/Sierra Wireless Direct IP modems */
308 { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68A3, 0xFF, 0xFF, 0xFF),
309 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
314 MODULE_DEVICE_TABLE(usb, id_table);
317 struct sierra_port_private {
318 spinlock_t lock; /* lock the structure */
319 int outstanding_urbs; /* number of out urbs in flight */
320 struct usb_anchor active;
321 struct usb_anchor delayed;
325 /* Input endpoints and buffers for this port */
326 struct urb *in_urbs[N_IN_URB_HM];
328 /* Settings for the port */
329 int rts_state; /* Handshaking pins (outputs) */
331 int cts_state; /* Handshaking pins (inputs) */
335 unsigned int opened:1;
338 static int sierra_send_setup(struct usb_serial_port *port)
340 struct usb_serial *serial = port->serial;
341 struct sierra_port_private *portdata;
347 dev_dbg(&port->dev, "%s\n", __func__);
349 portdata = usb_get_serial_port_data(port);
351 if (portdata->dtr_state)
353 if (portdata->rts_state)
356 /* If composite device then properly report interface */
357 if (serial->num_ports == 1) {
358 interface = sierra_calc_interface(serial);
359 /* Control message is sent only to interfaces with
360 * interrupt_in endpoints
362 if (port->interrupt_in_urb) {
363 /* send control message */
368 /* Otherwise the need to do non-composite mapping */
370 if (port->bulk_out_endpointAddress == 2)
372 else if (port->bulk_out_endpointAddress == 4)
374 else if (port->bulk_out_endpointAddress == 5)
382 retval = usb_autopm_get_interface(serial->interface);
386 retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
387 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
388 usb_autopm_put_interface(serial->interface);
393 static void sierra_set_termios(struct tty_struct *tty,
394 struct usb_serial_port *port, struct ktermios *old_termios)
396 dev_dbg(&port->dev, "%s\n", __func__);
397 tty_termios_copy_hw(tty->termios, old_termios);
398 sierra_send_setup(port);
401 static int sierra_tiocmget(struct tty_struct *tty)
403 struct usb_serial_port *port = tty->driver_data;
405 struct sierra_port_private *portdata;
407 dev_dbg(&port->dev, "%s\n", __func__);
408 portdata = usb_get_serial_port_data(port);
410 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
411 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
412 ((portdata->cts_state) ? TIOCM_CTS : 0) |
413 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
414 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
415 ((portdata->ri_state) ? TIOCM_RNG : 0);
420 static int sierra_tiocmset(struct tty_struct *tty,
421 unsigned int set, unsigned int clear)
423 struct usb_serial_port *port = tty->driver_data;
424 struct sierra_port_private *portdata;
426 portdata = usb_get_serial_port_data(port);
429 portdata->rts_state = 1;
431 portdata->dtr_state = 1;
433 if (clear & TIOCM_RTS)
434 portdata->rts_state = 0;
435 if (clear & TIOCM_DTR)
436 portdata->dtr_state = 0;
437 return sierra_send_setup(port);
440 static void sierra_release_urb(struct urb *urb)
442 struct usb_serial_port *port;
445 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
446 kfree(urb->transfer_buffer);
451 static void sierra_outdat_callback(struct urb *urb)
453 struct usb_serial_port *port = urb->context;
454 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
455 struct sierra_intf_private *intfdata;
456 int status = urb->status;
458 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
459 intfdata = port->serial->private;
461 /* free up the transfer buffer, as usb_free_urb() does not do this */
462 kfree(urb->transfer_buffer);
463 usb_autopm_put_interface_async(port->serial->interface);
465 dev_dbg(&port->dev, "%s - nonzero write bulk status "
466 "received: %d\n", __func__, status);
468 spin_lock(&portdata->lock);
469 --portdata->outstanding_urbs;
470 spin_unlock(&portdata->lock);
471 spin_lock(&intfdata->susp_lock);
472 --intfdata->in_flight;
473 spin_unlock(&intfdata->susp_lock);
475 usb_serial_port_softint(port);
479 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
480 const unsigned char *buf, int count)
482 struct sierra_port_private *portdata;
483 struct sierra_intf_private *intfdata;
484 struct usb_serial *serial = port->serial;
486 unsigned char *buffer;
488 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
491 /* verify that we actually have some data to write */
495 portdata = usb_get_serial_port_data(port);
496 intfdata = serial->private;
498 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
499 spin_lock_irqsave(&portdata->lock, flags);
500 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
501 portdata->outstanding_urbs);
502 if (portdata->outstanding_urbs > portdata->num_out_urbs) {
503 spin_unlock_irqrestore(&portdata->lock, flags);
504 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
507 portdata->outstanding_urbs++;
508 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
509 portdata->outstanding_urbs);
510 spin_unlock_irqrestore(&portdata->lock, flags);
512 retval = usb_autopm_get_interface_async(serial->interface);
514 spin_lock_irqsave(&portdata->lock, flags);
515 portdata->outstanding_urbs--;
516 spin_unlock_irqrestore(&portdata->lock, flags);
520 buffer = kmalloc(writesize, GFP_ATOMIC);
522 dev_err(&port->dev, "out of memory\n");
524 goto error_no_buffer;
527 urb = usb_alloc_urb(0, GFP_ATOMIC);
529 dev_err(&port->dev, "no more free urbs\n");
534 memcpy(buffer, buf, writesize);
536 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
538 usb_fill_bulk_urb(urb, serial->dev,
539 usb_sndbulkpipe(serial->dev,
540 port->bulk_out_endpointAddress),
541 buffer, writesize, sierra_outdat_callback, port);
543 /* Handle the need to send a zero length packet */
544 urb->transfer_flags |= URB_ZERO_PACKET;
546 spin_lock_irqsave(&intfdata->susp_lock, flags);
548 if (intfdata->suspended) {
549 usb_anchor_urb(urb, &portdata->delayed);
550 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
553 usb_anchor_urb(urb, &portdata->active);
555 /* send it down the pipe */
556 retval = usb_submit_urb(urb, GFP_ATOMIC);
558 usb_unanchor_urb(urb);
559 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
560 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
561 "with status = %d\n", __func__, retval);
564 intfdata->in_flight++;
565 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
569 /* we are done with this urb, so let the host driver
570 * really free it when it is finished with it */
579 spin_lock_irqsave(&portdata->lock, flags);
580 --portdata->outstanding_urbs;
581 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
582 portdata->outstanding_urbs);
583 spin_unlock_irqrestore(&portdata->lock, flags);
584 usb_autopm_put_interface_async(serial->interface);
589 static void sierra_indat_callback(struct urb *urb)
593 struct usb_serial_port *port;
594 struct tty_struct *tty;
595 unsigned char *data = urb->transfer_buffer;
596 int status = urb->status;
598 endpoint = usb_pipeendpoint(urb->pipe);
601 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
604 dev_dbg(&port->dev, "%s: nonzero status: %d on"
605 " endpoint %02x\n", __func__, status, endpoint);
607 if (urb->actual_length) {
608 tty = tty_port_tty_get(&port->port);
610 tty_insert_flip_string(tty, data,
612 tty_flip_buffer_push(tty);
615 usb_serial_debug_data(debug, &port->dev,
616 __func__, urb->actual_length, data);
619 dev_dbg(&port->dev, "%s: empty read urb"
620 " received\n", __func__);
624 /* Resubmit urb so we continue receiving */
625 if (status != -ESHUTDOWN && status != -EPERM) {
626 usb_mark_last_busy(port->serial->dev);
627 err = usb_submit_urb(urb, GFP_ATOMIC);
628 if (err && err != -EPERM)
629 dev_err(&port->dev, "resubmit read urb failed."
634 static void sierra_instat_callback(struct urb *urb)
637 int status = urb->status;
638 struct usb_serial_port *port = urb->context;
639 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
640 struct usb_serial *serial = port->serial;
642 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
643 urb, port, portdata);
646 struct usb_ctrlrequest *req_pkt =
647 (struct usb_ctrlrequest *)urb->transfer_buffer;
650 dev_dbg(&port->dev, "%s: NULL req_pkt\n",
654 if ((req_pkt->bRequestType == 0xA1) &&
655 (req_pkt->bRequest == 0x20)) {
657 unsigned char signals = *((unsigned char *)
658 urb->transfer_buffer +
659 sizeof(struct usb_ctrlrequest));
660 struct tty_struct *tty;
662 dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
665 old_dcd_state = portdata->dcd_state;
666 portdata->cts_state = 1;
667 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
668 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
669 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
671 tty = tty_port_tty_get(&port->port);
672 if (tty && !C_CLOCAL(tty) &&
673 old_dcd_state && !portdata->dcd_state)
677 dev_dbg(&port->dev, "%s: type %x req %x\n",
678 __func__, req_pkt->bRequestType,
682 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
684 /* Resubmit urb so we continue receiving IRQ data */
685 if (status != -ESHUTDOWN && status != -ENOENT) {
686 usb_mark_last_busy(serial->dev);
687 urb->dev = serial->dev;
688 err = usb_submit_urb(urb, GFP_ATOMIC);
689 if (err && err != -EPERM)
690 dev_err(&port->dev, "%s: resubmit intr urb "
691 "failed. (%d)\n", __func__, err);
695 static int sierra_write_room(struct tty_struct *tty)
697 struct usb_serial_port *port = tty->driver_data;
698 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
701 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
703 /* try to give a good number back based on if we have any free urbs at
704 * this point in time */
705 spin_lock_irqsave(&portdata->lock, flags);
706 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
707 spin_unlock_irqrestore(&portdata->lock, flags);
708 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
711 spin_unlock_irqrestore(&portdata->lock, flags);
716 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
719 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
721 for (i = 0; i < portdata->num_in_urbs; i++)
722 usb_kill_urb(portdata->in_urbs[i]);
724 usb_kill_urb(port->interrupt_in_urb);
727 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
733 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
736 for (i = 0; i < portdata->num_in_urbs; i++) {
737 urb = portdata->in_urbs[i];
740 err = usb_submit_urb(urb, mem_flags);
742 dev_err(&port->dev, "%s: submit urb failed: %d\n",
749 if (ok_cnt && port->interrupt_in_urb) {
750 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
752 dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
757 if (ok_cnt > 0) /* at least one rx urb submitted */
763 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
764 int dir, void *ctx, int len,
766 usb_complete_t callback)
774 urb = usb_alloc_urb(0, mem_flags);
776 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
781 buf = kmalloc(len, mem_flags);
783 /* Fill URB using supplied data */
784 usb_fill_bulk_urb(urb, serial->dev,
785 usb_sndbulkpipe(serial->dev, endpoint) | dir,
786 buf, len, callback, ctx);
789 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
790 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
792 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
793 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
795 sierra_release_urb(urb);
802 static void sierra_close(struct usb_serial_port *port)
805 struct usb_serial *serial = port->serial;
806 struct sierra_port_private *portdata;
807 struct sierra_intf_private *intfdata = port->serial->private;
811 dev_dbg(&port->dev, "%s\n", __func__);
812 portdata = usb_get_serial_port_data(port);
814 portdata->rts_state = 0;
815 portdata->dtr_state = 0;
818 mutex_lock(&serial->disc_mutex);
819 if (!serial->disconnected) {
820 /* odd error handling due to pm counters */
821 if (!usb_autopm_get_interface(serial->interface))
822 sierra_send_setup(port);
824 usb_autopm_get_interface_no_resume(serial->interface);
827 mutex_unlock(&serial->disc_mutex);
828 spin_lock_irq(&intfdata->susp_lock);
829 portdata->opened = 0;
830 if (--intfdata->open_ports == 0)
831 serial->interface->needs_remote_wakeup = 0;
832 spin_unlock_irq(&intfdata->susp_lock);
835 urb = usb_get_from_anchor(&portdata->delayed);
838 kfree(urb->transfer_buffer);
840 usb_autopm_put_interface_async(serial->interface);
841 spin_lock(&portdata->lock);
842 portdata->outstanding_urbs--;
843 spin_unlock(&portdata->lock);
846 /* Stop reading urbs */
847 sierra_stop_rx_urbs(port);
848 /* .. and release them */
849 for (i = 0; i < portdata->num_in_urbs; i++) {
850 sierra_release_urb(portdata->in_urbs[i]);
851 portdata->in_urbs[i] = NULL;
856 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
858 struct sierra_port_private *portdata;
859 struct usb_serial *serial = port->serial;
860 struct sierra_intf_private *intfdata = serial->private;
866 portdata = usb_get_serial_port_data(port);
868 dev_dbg(&port->dev, "%s\n", __func__);
870 /* Set some sane defaults */
871 portdata->rts_state = 1;
872 portdata->dtr_state = 1;
875 endpoint = port->bulk_in_endpointAddress;
876 for (i = 0; i < portdata->num_in_urbs; i++) {
877 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
878 IN_BUFLEN, GFP_KERNEL,
879 sierra_indat_callback);
880 portdata->in_urbs[i] = urb;
882 /* clear halt condition */
883 usb_clear_halt(serial->dev,
884 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
886 err = sierra_submit_rx_urbs(port, GFP_KERNEL);
890 sierra_send_setup(port);
892 spin_lock_irq(&intfdata->susp_lock);
893 portdata->opened = 1;
894 if (++intfdata->open_ports == 1)
895 serial->interface->needs_remote_wakeup = 1;
896 spin_unlock_irq(&intfdata->susp_lock);
897 usb_autopm_put_interface(serial->interface);
902 sierra_stop_rx_urbs(port);
904 for (i = 0; i < portdata->num_in_urbs; i++) {
905 sierra_release_urb(portdata->in_urbs[i]);
906 portdata->in_urbs[i] = NULL;
913 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
915 struct sierra_port_private *portdata;
917 portdata = usb_get_serial_port_data(port);
918 portdata->rts_state = on;
919 portdata->dtr_state = on;
921 sierra_send_setup(port);
924 static int sierra_startup(struct usb_serial *serial)
926 struct usb_serial_port *port;
927 struct sierra_intf_private *intfdata;
928 struct sierra_port_private *portdata;
929 struct sierra_iface_info *himemoryp = NULL;
933 dev_dbg(&serial->dev->dev, "%s\n", __func__);
935 intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
939 spin_lock_init(&intfdata->susp_lock);
941 usb_set_serial_data(serial, intfdata);
943 /* Set Device mode to D0 */
944 sierra_set_power_state(serial->dev, 0x0000);
946 /* Check NMEA and set */
948 sierra_vsc_set_nmea(serial->dev, 1);
950 /* Now setup per port private data */
951 for (i = 0; i < serial->num_ports; i++) {
952 port = serial->port[i];
953 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
955 dev_dbg(&port->dev, "%s: kmalloc for "
956 "sierra_port_private (%d) failed!\n",
960 spin_lock_init(&portdata->lock);
961 init_usb_anchor(&portdata->active);
962 init_usb_anchor(&portdata->delayed);
964 /* Assume low memory requirements */
965 portdata->num_out_urbs = N_OUT_URB;
966 portdata->num_in_urbs = N_IN_URB;
968 /* Determine actual memory requirements */
969 if (serial->num_ports == 1) {
970 /* Get interface number for composite device */
971 ifnum = sierra_calc_interface(serial);
973 (struct sierra_iface_info *)&typeB_interface_list;
974 if (is_himemory(ifnum, himemoryp)) {
975 portdata->num_out_urbs = N_OUT_URB_HM;
976 portdata->num_in_urbs = N_IN_URB_HM;
981 (struct sierra_iface_info *)&typeA_interface_list;
982 if (is_himemory(i, himemoryp)) {
983 portdata->num_out_urbs = N_OUT_URB_HM;
984 portdata->num_in_urbs = N_IN_URB_HM;
987 dev_dbg(&serial->dev->dev,
988 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
989 ifnum,portdata->num_in_urbs, portdata->num_out_urbs );
990 /* Set the port private data pointer */
991 usb_set_serial_port_data(port, portdata);
996 for (--i; i >= 0; --i) {
997 portdata = usb_get_serial_port_data(serial->port[i]);
1005 static void sierra_release(struct usb_serial *serial)
1008 struct usb_serial_port *port;
1009 struct sierra_port_private *portdata;
1011 dev_dbg(&serial->dev->dev, "%s\n", __func__);
1013 for (i = 0; i < serial->num_ports; ++i) {
1014 port = serial->port[i];
1017 portdata = usb_get_serial_port_data(port);
1022 kfree(serial->private);
1026 static void stop_read_write_urbs(struct usb_serial *serial)
1029 struct usb_serial_port *port;
1030 struct sierra_port_private *portdata;
1032 /* Stop reading/writing urbs */
1033 for (i = 0; i < serial->num_ports; ++i) {
1034 port = serial->port[i];
1035 portdata = usb_get_serial_port_data(port);
1036 sierra_stop_rx_urbs(port);
1037 usb_kill_anchored_urbs(&portdata->active);
1041 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
1043 struct sierra_intf_private *intfdata;
1046 if (PMSG_IS_AUTO(message)) {
1047 intfdata = serial->private;
1048 spin_lock_irq(&intfdata->susp_lock);
1049 b = intfdata->in_flight;
1052 spin_unlock_irq(&intfdata->susp_lock);
1055 intfdata->suspended = 1;
1056 spin_unlock_irq(&intfdata->susp_lock);
1059 stop_read_write_urbs(serial);
1064 static int sierra_resume(struct usb_serial *serial)
1066 struct usb_serial_port *port;
1067 struct sierra_intf_private *intfdata = serial->private;
1068 struct sierra_port_private *portdata;
1073 spin_lock_irq(&intfdata->susp_lock);
1074 for (i = 0; i < serial->num_ports; i++) {
1075 port = serial->port[i];
1076 portdata = usb_get_serial_port_data(port);
1078 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
1079 usb_anchor_urb(urb, &portdata->active);
1080 intfdata->in_flight++;
1081 err = usb_submit_urb(urb, GFP_ATOMIC);
1083 intfdata->in_flight--;
1084 usb_unanchor_urb(urb);
1085 kfree(urb->transfer_buffer);
1087 spin_lock(&portdata->lock);
1088 portdata->outstanding_urbs--;
1089 spin_unlock(&portdata->lock);
1094 if (portdata->opened) {
1095 err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1100 intfdata->suspended = 0;
1101 spin_unlock_irq(&intfdata->susp_lock);
1103 return ec ? -EIO : 0;
1106 static int sierra_reset_resume(struct usb_interface *intf)
1108 struct usb_serial *serial = usb_get_intfdata(intf);
1109 dev_err(&serial->dev->dev, "%s\n", __func__);
1110 return usb_serial_resume(intf);
1113 #define sierra_suspend NULL
1114 #define sierra_resume NULL
1115 #define sierra_reset_resume NULL
1118 static struct usb_driver sierra_driver = {
1120 .probe = usb_serial_probe,
1121 .disconnect = usb_serial_disconnect,
1122 .suspend = usb_serial_suspend,
1123 .resume = usb_serial_resume,
1124 .reset_resume = sierra_reset_resume,
1125 .id_table = id_table,
1127 .supports_autosuspend = 1,
1130 static struct usb_serial_driver sierra_device = {
1132 .owner = THIS_MODULE,
1135 .description = "Sierra USB modem",
1136 .id_table = id_table,
1137 .usb_driver = &sierra_driver,
1138 .calc_num_ports = sierra_calc_num_ports,
1139 .probe = sierra_probe,
1140 .open = sierra_open,
1141 .close = sierra_close,
1142 .dtr_rts = sierra_dtr_rts,
1143 .write = sierra_write,
1144 .write_room = sierra_write_room,
1145 .set_termios = sierra_set_termios,
1146 .tiocmget = sierra_tiocmget,
1147 .tiocmset = sierra_tiocmset,
1148 .attach = sierra_startup,
1149 .release = sierra_release,
1150 .suspend = sierra_suspend,
1151 .resume = sierra_resume,
1152 .read_int_callback = sierra_instat_callback,
1155 /* Functions used by new usb-serial code. */
1156 static int __init sierra_init(void)
1159 retval = usb_serial_register(&sierra_device);
1161 goto failed_device_register;
1164 retval = usb_register(&sierra_driver);
1166 goto failed_driver_register;
1168 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1173 failed_driver_register:
1174 usb_serial_deregister(&sierra_device);
1175 failed_device_register:
1179 static void __exit sierra_exit(void)
1181 usb_deregister(&sierra_driver);
1182 usb_serial_deregister(&sierra_device);
1185 module_init(sierra_init);
1186 module_exit(sierra_exit);
1188 MODULE_AUTHOR(DRIVER_AUTHOR);
1189 MODULE_DESCRIPTION(DRIVER_DESC);
1190 MODULE_VERSION(DRIVER_VERSION);
1191 MODULE_LICENSE("GPL");
1193 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1194 MODULE_PARM_DESC(nmea, "NMEA streaming");
1196 module_param(debug, bool, S_IRUGO | S_IWUSR);
1197 MODULE_PARM_DESC(debug, "Debug messages");