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;
64 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
67 dev_dbg(&udev->dev, "%s\n", __func__);
68 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
69 SWIMS_USB_REQUEST_SetPower, /* __u8 request */
70 USB_TYPE_VENDOR, /* __u8 request type */
71 swiState, /* __u16 value */
73 NULL, /* void *data */
75 USB_CTRL_SET_TIMEOUT); /* int timeout */
79 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
82 dev_dbg(&udev->dev, "%s\n", __func__);
83 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
84 SWIMS_USB_REQUEST_SetNmea, /* __u8 request */
85 USB_TYPE_VENDOR, /* __u8 request type */
86 enable, /* __u16 value */
87 0x0000, /* __u16 index */
88 NULL, /* void *data */
90 USB_CTRL_SET_TIMEOUT); /* int timeout */
94 static int sierra_calc_num_ports(struct usb_serial *serial)
97 u8 ifnum, numendpoints;
99 dev_dbg(&serial->dev->dev, "%s\n", __func__);
101 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
102 numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
104 /* Dummy interface present on some SKUs should be ignored */
107 else if (numendpoints <= 3)
110 num_ports = (numendpoints-1)/2;
114 static int is_blacklisted(const u8 ifnum,
115 const struct sierra_iface_info *blacklist)
121 info = blacklist->ifaceinfo;
123 for (i = 0; i < blacklist->infolen; i++) {
124 if (info[i] == ifnum)
131 static int is_himemory(const u8 ifnum,
132 const struct sierra_iface_info *himemorylist)
138 info = himemorylist->ifaceinfo;
140 for (i=0; i < himemorylist->infolen; i++) {
141 if (info[i] == ifnum)
148 static int sierra_calc_interface(struct usb_serial *serial)
151 struct usb_interface *p_interface;
152 struct usb_host_interface *p_host_interface;
153 dev_dbg(&serial->dev->dev, "%s\n", __func__);
155 /* Get the interface structure pointer from the serial struct */
156 p_interface = serial->interface;
158 /* Get a pointer to the host interface structure */
159 p_host_interface = p_interface->cur_altsetting;
161 /* read the interface descriptor for this active altsetting
162 * to find out the interface number we are on
164 interface = p_host_interface->desc.bInterfaceNumber;
169 static int sierra_probe(struct usb_serial *serial,
170 const struct usb_device_id *id)
173 struct usb_device *udev;
174 struct sierra_intf_private *data;
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);
202 data = serial->private = kzalloc(sizeof(struct sierra_intf_private), GFP_KERNEL);
205 spin_lock_init(&data->susp_lock);
210 /* interfaces with higher memory requirements */
211 static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
212 static const struct sierra_iface_info typeA_interface_list = {
213 .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
214 .ifaceinfo = hi_memory_typeA_ifaces,
217 static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
218 static const struct sierra_iface_info typeB_interface_list = {
219 .infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
220 .ifaceinfo = hi_memory_typeB_ifaces,
223 /* 'blacklist' of interfaces not served by this driver */
224 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11 };
225 static const struct sierra_iface_info direct_ip_interface_blacklist = {
226 .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
227 .ifaceinfo = direct_ip_non_serial_ifaces,
230 static const struct usb_device_id id_table[] = {
231 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
232 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
233 { USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
234 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
236 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
237 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
238 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
239 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
240 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
241 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
242 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
243 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
244 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
245 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
246 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
247 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
248 { USB_DEVICE(0x1199, 0x0301) }, /* Sierra Wireless USB Dongle 250U */
249 /* Sierra Wireless C597 */
250 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
251 /* Sierra Wireless T598 */
252 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
253 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
254 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
255 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
256 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
258 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
259 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
260 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
261 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
262 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
263 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
264 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
265 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
266 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
267 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
268 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
269 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
270 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
271 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
272 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
273 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
274 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
275 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
276 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
277 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
278 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
279 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
280 { USB_DEVICE(0x1199, 0x683C) },
281 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
282 /* Sierra Wireless MC8790, MC8791, MC8792 */
283 { USB_DEVICE(0x1199, 0x683E) },
284 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
285 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
286 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
287 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
288 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
289 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
290 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
291 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
292 { USB_DEVICE(0x1199, 0x68A2) }, /* Sierra Wireless MC7710 */
293 /* Sierra Wireless C885 */
294 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
295 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
296 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
297 /* Sierra Wireless C22/C33 */
298 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
299 /* Sierra Wireless HSPA Non-Composite Device */
300 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
301 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
302 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */
303 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
305 { USB_DEVICE(0x0f3d, 0x68A3), /* Airprime/Sierra Wireless Direct IP modems */
306 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
308 { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */
312 MODULE_DEVICE_TABLE(usb, id_table);
315 struct sierra_port_private {
316 spinlock_t lock; /* lock the structure */
317 int outstanding_urbs; /* number of out urbs in flight */
318 struct usb_anchor active;
319 struct usb_anchor delayed;
323 /* Input endpoints and buffers for this port */
324 struct urb *in_urbs[N_IN_URB_HM];
326 /* Settings for the port */
327 int rts_state; /* Handshaking pins (outputs) */
329 int cts_state; /* Handshaking pins (inputs) */
333 unsigned int opened:1;
336 static int sierra_send_setup(struct usb_serial_port *port)
338 struct usb_serial *serial = port->serial;
339 struct sierra_port_private *portdata;
345 dev_dbg(&port->dev, "%s\n", __func__);
347 portdata = usb_get_serial_port_data(port);
349 if (portdata->dtr_state)
351 if (portdata->rts_state)
354 /* If composite device then properly report interface */
355 if (serial->num_ports == 1) {
356 interface = sierra_calc_interface(serial);
357 /* Control message is sent only to interfaces with
358 * interrupt_in endpoints
360 if (port->interrupt_in_urb) {
361 /* send control message */
366 /* Otherwise the need to do non-composite mapping */
368 if (port->bulk_out_endpointAddress == 2)
370 else if (port->bulk_out_endpointAddress == 4)
372 else if (port->bulk_out_endpointAddress == 5)
380 retval = usb_autopm_get_interface(serial->interface);
384 retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
385 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
386 usb_autopm_put_interface(serial->interface);
391 static void sierra_set_termios(struct tty_struct *tty,
392 struct usb_serial_port *port, struct ktermios *old_termios)
394 dev_dbg(&port->dev, "%s\n", __func__);
395 tty_termios_copy_hw(tty->termios, old_termios);
396 sierra_send_setup(port);
399 static int sierra_tiocmget(struct tty_struct *tty)
401 struct usb_serial_port *port = tty->driver_data;
403 struct sierra_port_private *portdata;
405 dev_dbg(&port->dev, "%s\n", __func__);
406 portdata = usb_get_serial_port_data(port);
408 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
409 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
410 ((portdata->cts_state) ? TIOCM_CTS : 0) |
411 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
412 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
413 ((portdata->ri_state) ? TIOCM_RNG : 0);
418 static int sierra_tiocmset(struct tty_struct *tty,
419 unsigned int set, unsigned int clear)
421 struct usb_serial_port *port = tty->driver_data;
422 struct sierra_port_private *portdata;
424 portdata = usb_get_serial_port_data(port);
427 portdata->rts_state = 1;
429 portdata->dtr_state = 1;
431 if (clear & TIOCM_RTS)
432 portdata->rts_state = 0;
433 if (clear & TIOCM_DTR)
434 portdata->dtr_state = 0;
435 return sierra_send_setup(port);
438 static void sierra_release_urb(struct urb *urb)
440 struct usb_serial_port *port;
443 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
444 kfree(urb->transfer_buffer);
449 static void sierra_outdat_callback(struct urb *urb)
451 struct usb_serial_port *port = urb->context;
452 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
453 struct sierra_intf_private *intfdata;
454 int status = urb->status;
456 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
457 intfdata = port->serial->private;
459 /* free up the transfer buffer, as usb_free_urb() does not do this */
460 kfree(urb->transfer_buffer);
461 usb_autopm_put_interface_async(port->serial->interface);
463 dev_dbg(&port->dev, "%s - nonzero write bulk status "
464 "received: %d\n", __func__, status);
466 spin_lock(&portdata->lock);
467 --portdata->outstanding_urbs;
468 spin_unlock(&portdata->lock);
469 spin_lock(&intfdata->susp_lock);
470 --intfdata->in_flight;
471 spin_unlock(&intfdata->susp_lock);
473 usb_serial_port_softint(port);
477 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
478 const unsigned char *buf, int count)
480 struct sierra_port_private *portdata;
481 struct sierra_intf_private *intfdata;
482 struct usb_serial *serial = port->serial;
484 unsigned char *buffer;
486 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
489 /* verify that we actually have some data to write */
493 portdata = usb_get_serial_port_data(port);
494 intfdata = serial->private;
496 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
497 spin_lock_irqsave(&portdata->lock, flags);
498 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
499 portdata->outstanding_urbs);
500 if (portdata->outstanding_urbs > portdata->num_out_urbs) {
501 spin_unlock_irqrestore(&portdata->lock, flags);
502 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
505 portdata->outstanding_urbs++;
506 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
507 portdata->outstanding_urbs);
508 spin_unlock_irqrestore(&portdata->lock, flags);
510 retval = usb_autopm_get_interface_async(serial->interface);
512 spin_lock_irqsave(&portdata->lock, flags);
513 portdata->outstanding_urbs--;
514 spin_unlock_irqrestore(&portdata->lock, flags);
518 buffer = kmalloc(writesize, GFP_ATOMIC);
520 dev_err(&port->dev, "out of memory\n");
522 goto error_no_buffer;
525 urb = usb_alloc_urb(0, GFP_ATOMIC);
527 dev_err(&port->dev, "no more free urbs\n");
532 memcpy(buffer, buf, writesize);
534 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
536 usb_fill_bulk_urb(urb, serial->dev,
537 usb_sndbulkpipe(serial->dev,
538 port->bulk_out_endpointAddress),
539 buffer, writesize, sierra_outdat_callback, port);
541 /* Handle the need to send a zero length packet */
542 urb->transfer_flags |= URB_ZERO_PACKET;
544 spin_lock_irqsave(&intfdata->susp_lock, flags);
546 if (intfdata->suspended) {
547 usb_anchor_urb(urb, &portdata->delayed);
548 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
551 usb_anchor_urb(urb, &portdata->active);
553 /* send it down the pipe */
554 retval = usb_submit_urb(urb, GFP_ATOMIC);
556 usb_unanchor_urb(urb);
557 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
558 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
559 "with status = %d\n", __func__, retval);
562 intfdata->in_flight++;
563 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
567 /* we are done with this urb, so let the host driver
568 * really free it when it is finished with it */
577 spin_lock_irqsave(&portdata->lock, flags);
578 --portdata->outstanding_urbs;
579 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
580 portdata->outstanding_urbs);
581 spin_unlock_irqrestore(&portdata->lock, flags);
582 usb_autopm_put_interface_async(serial->interface);
587 static void sierra_indat_callback(struct urb *urb)
591 struct usb_serial_port *port;
592 struct tty_struct *tty;
593 unsigned char *data = urb->transfer_buffer;
594 int status = urb->status;
596 endpoint = usb_pipeendpoint(urb->pipe);
599 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
602 dev_dbg(&port->dev, "%s: nonzero status: %d on"
603 " endpoint %02x\n", __func__, status, endpoint);
605 if (urb->actual_length) {
606 tty = tty_port_tty_get(&port->port);
608 tty_insert_flip_string(tty, data,
610 tty_flip_buffer_push(tty);
613 usb_serial_debug_data(debug, &port->dev,
614 __func__, urb->actual_length, data);
617 dev_dbg(&port->dev, "%s: empty read urb"
618 " received\n", __func__);
622 /* Resubmit urb so we continue receiving */
623 if (status != -ESHUTDOWN && status != -EPERM) {
624 usb_mark_last_busy(port->serial->dev);
625 err = usb_submit_urb(urb, GFP_ATOMIC);
626 if (err && err != -EPERM)
627 dev_err(&port->dev, "resubmit read urb failed."
632 static void sierra_instat_callback(struct urb *urb)
635 int status = urb->status;
636 struct usb_serial_port *port = urb->context;
637 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
638 struct usb_serial *serial = port->serial;
640 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
641 urb, port, portdata);
644 struct usb_ctrlrequest *req_pkt =
645 (struct usb_ctrlrequest *)urb->transfer_buffer;
648 dev_dbg(&port->dev, "%s: NULL req_pkt\n",
652 if ((req_pkt->bRequestType == 0xA1) &&
653 (req_pkt->bRequest == 0x20)) {
655 unsigned char signals = *((unsigned char *)
656 urb->transfer_buffer +
657 sizeof(struct usb_ctrlrequest));
658 struct tty_struct *tty;
660 dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
663 old_dcd_state = portdata->dcd_state;
664 portdata->cts_state = 1;
665 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
666 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
667 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
669 tty = tty_port_tty_get(&port->port);
670 if (tty && !C_CLOCAL(tty) &&
671 old_dcd_state && !portdata->dcd_state)
675 dev_dbg(&port->dev, "%s: type %x req %x\n",
676 __func__, req_pkt->bRequestType,
680 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
682 /* Resubmit urb so we continue receiving IRQ data */
683 if (status != -ESHUTDOWN && status != -ENOENT) {
684 usb_mark_last_busy(serial->dev);
685 err = usb_submit_urb(urb, GFP_ATOMIC);
686 if (err && err != -EPERM)
687 dev_err(&port->dev, "%s: resubmit intr urb "
688 "failed. (%d)\n", __func__, err);
692 static int sierra_write_room(struct tty_struct *tty)
694 struct usb_serial_port *port = tty->driver_data;
695 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
698 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
700 /* try to give a good number back based on if we have any free urbs at
701 * this point in time */
702 spin_lock_irqsave(&portdata->lock, flags);
703 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
704 spin_unlock_irqrestore(&portdata->lock, flags);
705 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
708 spin_unlock_irqrestore(&portdata->lock, flags);
713 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
716 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
718 for (i = 0; i < portdata->num_in_urbs; i++)
719 usb_kill_urb(portdata->in_urbs[i]);
721 usb_kill_urb(port->interrupt_in_urb);
724 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
730 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
733 for (i = 0; i < portdata->num_in_urbs; i++) {
734 urb = portdata->in_urbs[i];
737 err = usb_submit_urb(urb, mem_flags);
739 dev_err(&port->dev, "%s: submit urb failed: %d\n",
746 if (ok_cnt && port->interrupt_in_urb) {
747 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
749 dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
754 if (ok_cnt > 0) /* at least one rx urb submitted */
760 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
761 int dir, void *ctx, int len,
763 usb_complete_t callback)
771 urb = usb_alloc_urb(0, mem_flags);
773 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
778 buf = kmalloc(len, mem_flags);
780 /* Fill URB using supplied data */
781 usb_fill_bulk_urb(urb, serial->dev,
782 usb_sndbulkpipe(serial->dev, endpoint) | dir,
783 buf, len, callback, ctx);
786 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
787 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
789 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
790 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
792 sierra_release_urb(urb);
799 static void sierra_close(struct usb_serial_port *port)
802 struct usb_serial *serial = port->serial;
803 struct sierra_port_private *portdata;
804 struct sierra_intf_private *intfdata = port->serial->private;
807 dev_dbg(&port->dev, "%s\n", __func__);
808 portdata = usb_get_serial_port_data(port);
810 portdata->rts_state = 0;
811 portdata->dtr_state = 0;
814 mutex_lock(&serial->disc_mutex);
815 if (!serial->disconnected) {
816 serial->interface->needs_remote_wakeup = 0;
817 /* odd error handling due to pm counters */
818 if (!usb_autopm_get_interface(serial->interface))
819 sierra_send_setup(port);
821 usb_autopm_get_interface_no_resume(serial->interface);
824 mutex_unlock(&serial->disc_mutex);
825 spin_lock_irq(&intfdata->susp_lock);
826 portdata->opened = 0;
827 spin_unlock_irq(&intfdata->susp_lock);
830 /* Stop reading urbs */
831 sierra_stop_rx_urbs(port);
832 /* .. and release them */
833 for (i = 0; i < portdata->num_in_urbs; i++) {
834 sierra_release_urb(portdata->in_urbs[i]);
835 portdata->in_urbs[i] = NULL;
840 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
842 struct sierra_port_private *portdata;
843 struct usb_serial *serial = port->serial;
844 struct sierra_intf_private *intfdata = serial->private;
850 portdata = usb_get_serial_port_data(port);
852 dev_dbg(&port->dev, "%s\n", __func__);
854 /* Set some sane defaults */
855 portdata->rts_state = 1;
856 portdata->dtr_state = 1;
859 endpoint = port->bulk_in_endpointAddress;
860 for (i = 0; i < portdata->num_in_urbs; i++) {
861 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
862 IN_BUFLEN, GFP_KERNEL,
863 sierra_indat_callback);
864 portdata->in_urbs[i] = urb;
866 /* clear halt condition */
867 usb_clear_halt(serial->dev,
868 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
870 err = sierra_submit_rx_urbs(port, GFP_KERNEL);
872 /* get rid of everything as in close */
874 /* restore balance for autopm */
875 if (!serial->disconnected)
876 usb_autopm_put_interface(serial->interface);
879 sierra_send_setup(port);
881 serial->interface->needs_remote_wakeup = 1;
882 spin_lock_irq(&intfdata->susp_lock);
883 portdata->opened = 1;
884 spin_unlock_irq(&intfdata->susp_lock);
885 usb_autopm_put_interface(serial->interface);
891 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
893 struct usb_serial *serial = port->serial;
894 struct sierra_port_private *portdata;
896 portdata = usb_get_serial_port_data(port);
897 portdata->rts_state = on;
898 portdata->dtr_state = on;
901 mutex_lock(&serial->disc_mutex);
902 if (!serial->disconnected)
903 sierra_send_setup(port);
904 mutex_unlock(&serial->disc_mutex);
908 static int sierra_startup(struct usb_serial *serial)
910 struct usb_serial_port *port;
911 struct sierra_port_private *portdata;
912 struct sierra_iface_info *himemoryp = NULL;
916 dev_dbg(&serial->dev->dev, "%s\n", __func__);
918 /* Set Device mode to D0 */
919 sierra_set_power_state(serial->dev, 0x0000);
921 /* Check NMEA and set */
923 sierra_vsc_set_nmea(serial->dev, 1);
925 /* Now setup per port private data */
926 for (i = 0; i < serial->num_ports; i++) {
927 port = serial->port[i];
928 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
930 dev_dbg(&port->dev, "%s: kmalloc for "
931 "sierra_port_private (%d) failed!\n",
935 spin_lock_init(&portdata->lock);
936 init_usb_anchor(&portdata->active);
937 init_usb_anchor(&portdata->delayed);
939 /* Assume low memory requirements */
940 portdata->num_out_urbs = N_OUT_URB;
941 portdata->num_in_urbs = N_IN_URB;
943 /* Determine actual memory requirements */
944 if (serial->num_ports == 1) {
945 /* Get interface number for composite device */
946 ifnum = sierra_calc_interface(serial);
948 (struct sierra_iface_info *)&typeB_interface_list;
949 if (is_himemory(ifnum, himemoryp)) {
950 portdata->num_out_urbs = N_OUT_URB_HM;
951 portdata->num_in_urbs = N_IN_URB_HM;
956 (struct sierra_iface_info *)&typeA_interface_list;
957 if (is_himemory(i, himemoryp)) {
958 portdata->num_out_urbs = N_OUT_URB_HM;
959 portdata->num_in_urbs = N_IN_URB_HM;
962 dev_dbg(&serial->dev->dev,
963 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
964 ifnum,portdata->num_in_urbs, portdata->num_out_urbs );
965 /* Set the port private data pointer */
966 usb_set_serial_port_data(port, portdata);
972 static void sierra_release(struct usb_serial *serial)
975 struct usb_serial_port *port;
976 struct sierra_port_private *portdata;
978 dev_dbg(&serial->dev->dev, "%s\n", __func__);
980 for (i = 0; i < serial->num_ports; ++i) {
981 port = serial->port[i];
984 portdata = usb_get_serial_port_data(port);
992 static void stop_read_write_urbs(struct usb_serial *serial)
995 struct usb_serial_port *port;
996 struct sierra_port_private *portdata;
998 /* Stop reading/writing urbs */
999 for (i = 0; i < serial->num_ports; ++i) {
1000 port = serial->port[i];
1001 portdata = usb_get_serial_port_data(port);
1002 sierra_stop_rx_urbs(port);
1003 usb_kill_anchored_urbs(&portdata->active);
1007 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
1009 struct sierra_intf_private *intfdata;
1012 if (PMSG_IS_AUTO(message)) {
1013 intfdata = serial->private;
1014 spin_lock_irq(&intfdata->susp_lock);
1015 b = intfdata->in_flight;
1018 spin_unlock_irq(&intfdata->susp_lock);
1021 intfdata->suspended = 1;
1022 spin_unlock_irq(&intfdata->susp_lock);
1025 stop_read_write_urbs(serial);
1030 static int sierra_resume(struct usb_serial *serial)
1032 struct usb_serial_port *port;
1033 struct sierra_intf_private *intfdata = serial->private;
1034 struct sierra_port_private *portdata;
1039 spin_lock_irq(&intfdata->susp_lock);
1040 for (i = 0; i < serial->num_ports; i++) {
1041 port = serial->port[i];
1042 portdata = usb_get_serial_port_data(port);
1044 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
1045 usb_anchor_urb(urb, &portdata->active);
1046 intfdata->in_flight++;
1047 err = usb_submit_urb(urb, GFP_ATOMIC);
1049 intfdata->in_flight--;
1050 usb_unanchor_urb(urb);
1051 usb_scuttle_anchored_urbs(&portdata->delayed);
1056 if (portdata->opened) {
1057 err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1062 intfdata->suspended = 0;
1063 spin_unlock_irq(&intfdata->susp_lock);
1065 return ec ? -EIO : 0;
1068 static int sierra_reset_resume(struct usb_interface *intf)
1070 struct usb_serial *serial = usb_get_intfdata(intf);
1071 dev_err(&serial->dev->dev, "%s\n", __func__);
1072 return usb_serial_resume(intf);
1075 #define sierra_suspend NULL
1076 #define sierra_resume NULL
1077 #define sierra_reset_resume NULL
1080 static struct usb_driver sierra_driver = {
1082 .probe = usb_serial_probe,
1083 .disconnect = usb_serial_disconnect,
1084 .suspend = usb_serial_suspend,
1085 .resume = usb_serial_resume,
1086 .reset_resume = sierra_reset_resume,
1087 .id_table = id_table,
1088 .supports_autosuspend = 1,
1091 static struct usb_serial_driver sierra_device = {
1093 .owner = THIS_MODULE,
1096 .description = "Sierra USB modem",
1097 .id_table = id_table,
1098 .calc_num_ports = sierra_calc_num_ports,
1099 .probe = sierra_probe,
1100 .open = sierra_open,
1101 .close = sierra_close,
1102 .dtr_rts = sierra_dtr_rts,
1103 .write = sierra_write,
1104 .write_room = sierra_write_room,
1105 .set_termios = sierra_set_termios,
1106 .tiocmget = sierra_tiocmget,
1107 .tiocmset = sierra_tiocmset,
1108 .attach = sierra_startup,
1109 .release = sierra_release,
1110 .suspend = sierra_suspend,
1111 .resume = sierra_resume,
1112 .read_int_callback = sierra_instat_callback,
1115 static struct usb_serial_driver * const serial_drivers[] = {
1116 &sierra_device, NULL
1119 module_usb_serial_driver(sierra_driver, serial_drivers);
1121 MODULE_AUTHOR(DRIVER_AUTHOR);
1122 MODULE_DESCRIPTION(DRIVER_DESC);
1123 MODULE_VERSION(DRIVER_VERSION);
1124 MODULE_LICENSE("GPL");
1126 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1127 MODULE_PARM_DESC(nmea, "NMEA streaming");
1129 module_param(debug, bool, S_IRUGO | S_IWUSR);
1130 MODULE_PARM_DESC(debug, "Debug messages");