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 /* Sierra Wireless C885 */
293 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
294 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
295 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
296 /* Sierra Wireless C22/C33 */
297 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
298 /* Sierra Wireless HSPA Non-Composite Device */
299 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
300 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
301 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */
302 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
304 { USB_DEVICE(0x0f3d, 0x68A3), /* Airprime/Sierra Wireless Direct IP modems */
305 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
307 { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */
311 MODULE_DEVICE_TABLE(usb, id_table);
314 struct sierra_port_private {
315 spinlock_t lock; /* lock the structure */
316 int outstanding_urbs; /* number of out urbs in flight */
317 struct usb_anchor active;
318 struct usb_anchor delayed;
322 /* Input endpoints and buffers for this port */
323 struct urb *in_urbs[N_IN_URB_HM];
325 /* Settings for the port */
326 int rts_state; /* Handshaking pins (outputs) */
328 int cts_state; /* Handshaking pins (inputs) */
332 unsigned int opened:1;
335 static int sierra_send_setup(struct usb_serial_port *port)
337 struct usb_serial *serial = port->serial;
338 struct sierra_port_private *portdata;
344 dev_dbg(&port->dev, "%s\n", __func__);
346 portdata = usb_get_serial_port_data(port);
348 if (portdata->dtr_state)
350 if (portdata->rts_state)
353 /* If composite device then properly report interface */
354 if (serial->num_ports == 1) {
355 interface = sierra_calc_interface(serial);
356 /* Control message is sent only to interfaces with
357 * interrupt_in endpoints
359 if (port->interrupt_in_urb) {
360 /* send control message */
365 /* Otherwise the need to do non-composite mapping */
367 if (port->bulk_out_endpointAddress == 2)
369 else if (port->bulk_out_endpointAddress == 4)
371 else if (port->bulk_out_endpointAddress == 5)
379 usb_autopm_get_interface(serial->interface);
380 retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
381 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
382 usb_autopm_put_interface(serial->interface);
387 static void sierra_set_termios(struct tty_struct *tty,
388 struct usb_serial_port *port, struct ktermios *old_termios)
390 dev_dbg(&port->dev, "%s\n", __func__);
391 tty_termios_copy_hw(tty->termios, old_termios);
392 sierra_send_setup(port);
395 static int sierra_tiocmget(struct tty_struct *tty, struct file *file)
397 struct usb_serial_port *port = tty->driver_data;
399 struct sierra_port_private *portdata;
401 dev_dbg(&port->dev, "%s\n", __func__);
402 portdata = usb_get_serial_port_data(port);
404 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
405 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
406 ((portdata->cts_state) ? TIOCM_CTS : 0) |
407 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
408 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
409 ((portdata->ri_state) ? TIOCM_RNG : 0);
414 static int sierra_tiocmset(struct tty_struct *tty, struct file *file,
415 unsigned int set, unsigned int clear)
417 struct usb_serial_port *port = tty->driver_data;
418 struct sierra_port_private *portdata;
420 portdata = usb_get_serial_port_data(port);
423 portdata->rts_state = 1;
425 portdata->dtr_state = 1;
427 if (clear & TIOCM_RTS)
428 portdata->rts_state = 0;
429 if (clear & TIOCM_DTR)
430 portdata->dtr_state = 0;
431 return sierra_send_setup(port);
434 static void sierra_release_urb(struct urb *urb)
436 struct usb_serial_port *port;
439 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
440 kfree(urb->transfer_buffer);
445 static void sierra_outdat_callback(struct urb *urb)
447 struct usb_serial_port *port = urb->context;
448 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
449 struct sierra_intf_private *intfdata;
450 int status = urb->status;
452 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
453 intfdata = port->serial->private;
455 /* free up the transfer buffer, as usb_free_urb() does not do this */
456 kfree(urb->transfer_buffer);
457 usb_autopm_put_interface_async(port->serial->interface);
459 dev_dbg(&port->dev, "%s - nonzero write bulk status "
460 "received: %d\n", __func__, status);
462 spin_lock(&portdata->lock);
463 --portdata->outstanding_urbs;
464 spin_unlock(&portdata->lock);
465 spin_lock(&intfdata->susp_lock);
466 --intfdata->in_flight;
467 spin_unlock(&intfdata->susp_lock);
469 usb_serial_port_softint(port);
473 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
474 const unsigned char *buf, int count)
476 struct sierra_port_private *portdata;
477 struct sierra_intf_private *intfdata;
478 struct usb_serial *serial = port->serial;
480 unsigned char *buffer;
482 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
485 /* verify that we actually have some data to write */
489 portdata = usb_get_serial_port_data(port);
490 intfdata = serial->private;
492 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
493 spin_lock_irqsave(&portdata->lock, flags);
494 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
495 portdata->outstanding_urbs);
496 if (portdata->outstanding_urbs > portdata->num_out_urbs) {
497 spin_unlock_irqrestore(&portdata->lock, flags);
498 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
501 portdata->outstanding_urbs++;
502 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
503 portdata->outstanding_urbs);
504 spin_unlock_irqrestore(&portdata->lock, flags);
506 retval = usb_autopm_get_interface_async(serial->interface);
508 spin_lock_irqsave(&portdata->lock, flags);
509 portdata->outstanding_urbs--;
510 spin_unlock_irqrestore(&portdata->lock, flags);
514 buffer = kmalloc(writesize, GFP_ATOMIC);
516 dev_err(&port->dev, "out of memory\n");
518 goto error_no_buffer;
521 urb = usb_alloc_urb(0, GFP_ATOMIC);
523 dev_err(&port->dev, "no more free urbs\n");
528 memcpy(buffer, buf, writesize);
530 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
532 usb_fill_bulk_urb(urb, serial->dev,
533 usb_sndbulkpipe(serial->dev,
534 port->bulk_out_endpointAddress),
535 buffer, writesize, sierra_outdat_callback, port);
537 /* Handle the need to send a zero length packet */
538 urb->transfer_flags |= URB_ZERO_PACKET;
540 spin_lock_irqsave(&intfdata->susp_lock, flags);
542 if (intfdata->suspended) {
543 usb_anchor_urb(urb, &portdata->delayed);
544 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
547 usb_anchor_urb(urb, &portdata->active);
549 /* send it down the pipe */
550 retval = usb_submit_urb(urb, GFP_ATOMIC);
552 usb_unanchor_urb(urb);
553 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
554 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
555 "with status = %d\n", __func__, retval);
558 intfdata->in_flight++;
559 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
563 /* we are done with this urb, so let the host driver
564 * really free it when it is finished with it */
573 spin_lock_irqsave(&portdata->lock, flags);
574 --portdata->outstanding_urbs;
575 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
576 portdata->outstanding_urbs);
577 spin_unlock_irqrestore(&portdata->lock, flags);
578 usb_autopm_put_interface_async(serial->interface);
583 static void sierra_indat_callback(struct urb *urb)
587 struct usb_serial_port *port;
588 struct tty_struct *tty;
589 unsigned char *data = urb->transfer_buffer;
590 int status = urb->status;
592 endpoint = usb_pipeendpoint(urb->pipe);
595 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
598 dev_dbg(&port->dev, "%s: nonzero status: %d on"
599 " endpoint %02x\n", __func__, status, endpoint);
601 if (urb->actual_length) {
602 tty = tty_port_tty_get(&port->port);
604 tty_insert_flip_string(tty, data,
606 tty_flip_buffer_push(tty);
609 usb_serial_debug_data(debug, &port->dev,
610 __func__, urb->actual_length, data);
613 dev_dbg(&port->dev, "%s: empty read urb"
614 " received\n", __func__);
618 /* Resubmit urb so we continue receiving */
619 if (status != -ESHUTDOWN && status != -EPERM) {
620 usb_mark_last_busy(port->serial->dev);
621 err = usb_submit_urb(urb, GFP_ATOMIC);
622 if (err && err != -EPERM)
623 dev_err(&port->dev, "resubmit read urb failed."
628 static void sierra_instat_callback(struct urb *urb)
631 int status = urb->status;
632 struct usb_serial_port *port = urb->context;
633 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
634 struct usb_serial *serial = port->serial;
636 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
637 urb, port, portdata);
640 struct usb_ctrlrequest *req_pkt =
641 (struct usb_ctrlrequest *)urb->transfer_buffer;
644 dev_dbg(&port->dev, "%s: NULL req_pkt\n",
648 if ((req_pkt->bRequestType == 0xA1) &&
649 (req_pkt->bRequest == 0x20)) {
651 unsigned char signals = *((unsigned char *)
652 urb->transfer_buffer +
653 sizeof(struct usb_ctrlrequest));
654 struct tty_struct *tty;
656 dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
659 old_dcd_state = portdata->dcd_state;
660 portdata->cts_state = 1;
661 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
662 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
663 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
665 tty = tty_port_tty_get(&port->port);
666 if (tty && !C_CLOCAL(tty) &&
667 old_dcd_state && !portdata->dcd_state)
671 dev_dbg(&port->dev, "%s: type %x req %x\n",
672 __func__, req_pkt->bRequestType,
676 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
678 /* Resubmit urb so we continue receiving IRQ data */
679 if (status != -ESHUTDOWN && status != -ENOENT) {
680 usb_mark_last_busy(serial->dev);
681 urb->dev = serial->dev;
682 err = usb_submit_urb(urb, GFP_ATOMIC);
683 if (err && err != -EPERM)
684 dev_err(&port->dev, "%s: resubmit intr urb "
685 "failed. (%d)\n", __func__, err);
689 static int sierra_write_room(struct tty_struct *tty)
691 struct usb_serial_port *port = tty->driver_data;
692 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
695 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
697 /* try to give a good number back based on if we have any free urbs at
698 * this point in time */
699 spin_lock_irqsave(&portdata->lock, flags);
700 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
701 spin_unlock_irqrestore(&portdata->lock, flags);
702 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
705 spin_unlock_irqrestore(&portdata->lock, flags);
710 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
713 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
715 for (i = 0; i < portdata->num_in_urbs; i++)
716 usb_kill_urb(portdata->in_urbs[i]);
718 usb_kill_urb(port->interrupt_in_urb);
721 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
727 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
730 for (i = 0; i < portdata->num_in_urbs; i++) {
731 urb = portdata->in_urbs[i];
734 err = usb_submit_urb(urb, mem_flags);
736 dev_err(&port->dev, "%s: submit urb failed: %d\n",
743 if (ok_cnt && port->interrupt_in_urb) {
744 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
746 dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
751 if (ok_cnt > 0) /* at least one rx urb submitted */
757 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
758 int dir, void *ctx, int len,
760 usb_complete_t callback)
768 urb = usb_alloc_urb(0, mem_flags);
770 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
775 buf = kmalloc(len, mem_flags);
777 /* Fill URB using supplied data */
778 usb_fill_bulk_urb(urb, serial->dev,
779 usb_sndbulkpipe(serial->dev, endpoint) | dir,
780 buf, len, callback, ctx);
783 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
784 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
786 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
787 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
789 sierra_release_urb(urb);
796 static void sierra_close(struct usb_serial_port *port)
799 struct usb_serial *serial = port->serial;
800 struct sierra_port_private *portdata;
801 struct sierra_intf_private *intfdata = port->serial->private;
804 dev_dbg(&port->dev, "%s\n", __func__);
805 portdata = usb_get_serial_port_data(port);
807 portdata->rts_state = 0;
808 portdata->dtr_state = 0;
811 mutex_lock(&serial->disc_mutex);
812 if (!serial->disconnected) {
813 serial->interface->needs_remote_wakeup = 0;
814 usb_autopm_get_interface(serial->interface);
815 sierra_send_setup(port);
817 mutex_unlock(&serial->disc_mutex);
818 spin_lock_irq(&intfdata->susp_lock);
819 portdata->opened = 0;
820 spin_unlock_irq(&intfdata->susp_lock);
823 /* Stop reading urbs */
824 sierra_stop_rx_urbs(port);
825 /* .. and release them */
826 for (i = 0; i < portdata->num_in_urbs; i++) {
827 sierra_release_urb(portdata->in_urbs[i]);
828 portdata->in_urbs[i] = NULL;
833 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
835 struct sierra_port_private *portdata;
836 struct usb_serial *serial = port->serial;
837 struct sierra_intf_private *intfdata = serial->private;
843 portdata = usb_get_serial_port_data(port);
845 dev_dbg(&port->dev, "%s\n", __func__);
847 /* Set some sane defaults */
848 portdata->rts_state = 1;
849 portdata->dtr_state = 1;
852 endpoint = port->bulk_in_endpointAddress;
853 for (i = 0; i < portdata->num_in_urbs; i++) {
854 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
855 IN_BUFLEN, GFP_KERNEL,
856 sierra_indat_callback);
857 portdata->in_urbs[i] = urb;
859 /* clear halt condition */
860 usb_clear_halt(serial->dev,
861 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
863 err = sierra_submit_rx_urbs(port, GFP_KERNEL);
865 /* get rid of everything as in close */
867 /* restore balance for autopm */
868 usb_autopm_put_interface(serial->interface);
871 sierra_send_setup(port);
873 serial->interface->needs_remote_wakeup = 1;
874 spin_lock_irq(&intfdata->susp_lock);
875 portdata->opened = 1;
876 spin_unlock_irq(&intfdata->susp_lock);
877 usb_autopm_put_interface(serial->interface);
883 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
885 struct usb_serial *serial = port->serial;
886 struct sierra_port_private *portdata;
888 portdata = usb_get_serial_port_data(port);
889 portdata->rts_state = on;
890 portdata->dtr_state = on;
893 mutex_lock(&serial->disc_mutex);
894 if (!serial->disconnected)
895 sierra_send_setup(port);
896 mutex_unlock(&serial->disc_mutex);
900 static int sierra_startup(struct usb_serial *serial)
902 struct usb_serial_port *port;
903 struct sierra_port_private *portdata;
904 struct sierra_iface_info *himemoryp = NULL;
908 dev_dbg(&serial->dev->dev, "%s\n", __func__);
910 /* Set Device mode to D0 */
911 sierra_set_power_state(serial->dev, 0x0000);
913 /* Check NMEA and set */
915 sierra_vsc_set_nmea(serial->dev, 1);
917 /* Now setup per port private data */
918 for (i = 0; i < serial->num_ports; i++) {
919 port = serial->port[i];
920 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
922 dev_dbg(&port->dev, "%s: kmalloc for "
923 "sierra_port_private (%d) failed!\n",
927 spin_lock_init(&portdata->lock);
928 init_usb_anchor(&portdata->active);
929 init_usb_anchor(&portdata->delayed);
931 /* Assume low memory requirements */
932 portdata->num_out_urbs = N_OUT_URB;
933 portdata->num_in_urbs = N_IN_URB;
935 /* Determine actual memory requirements */
936 if (serial->num_ports == 1) {
937 /* Get interface number for composite device */
938 ifnum = sierra_calc_interface(serial);
940 (struct sierra_iface_info *)&typeB_interface_list;
941 if (is_himemory(ifnum, himemoryp)) {
942 portdata->num_out_urbs = N_OUT_URB_HM;
943 portdata->num_in_urbs = N_IN_URB_HM;
948 (struct sierra_iface_info *)&typeA_interface_list;
949 if (is_himemory(i, himemoryp)) {
950 portdata->num_out_urbs = N_OUT_URB_HM;
951 portdata->num_in_urbs = N_IN_URB_HM;
954 dev_dbg(&serial->dev->dev,
955 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
956 ifnum,portdata->num_in_urbs, portdata->num_out_urbs );
957 /* Set the port private data pointer */
958 usb_set_serial_port_data(port, portdata);
964 static void sierra_release(struct usb_serial *serial)
967 struct usb_serial_port *port;
968 struct sierra_port_private *portdata;
970 dev_dbg(&serial->dev->dev, "%s\n", __func__);
972 for (i = 0; i < serial->num_ports; ++i) {
973 port = serial->port[i];
976 portdata = usb_get_serial_port_data(port);
984 static void stop_read_write_urbs(struct usb_serial *serial)
987 struct usb_serial_port *port;
988 struct sierra_port_private *portdata;
990 /* Stop reading/writing urbs */
991 for (i = 0; i < serial->num_ports; ++i) {
992 port = serial->port[i];
993 portdata = usb_get_serial_port_data(port);
994 sierra_stop_rx_urbs(port);
995 usb_kill_anchored_urbs(&portdata->active);
999 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
1001 struct sierra_intf_private *intfdata;
1004 if (message.event & PM_EVENT_AUTO) {
1005 intfdata = serial->private;
1006 spin_lock_irq(&intfdata->susp_lock);
1007 b = intfdata->in_flight;
1010 spin_unlock_irq(&intfdata->susp_lock);
1013 intfdata->suspended = 1;
1014 spin_unlock_irq(&intfdata->susp_lock);
1017 stop_read_write_urbs(serial);
1022 static int sierra_resume(struct usb_serial *serial)
1024 struct usb_serial_port *port;
1025 struct sierra_intf_private *intfdata = serial->private;
1026 struct sierra_port_private *portdata;
1031 spin_lock_irq(&intfdata->susp_lock);
1032 for (i = 0; i < serial->num_ports; i++) {
1033 port = serial->port[i];
1034 portdata = usb_get_serial_port_data(port);
1036 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
1037 usb_anchor_urb(urb, &portdata->active);
1038 intfdata->in_flight++;
1039 err = usb_submit_urb(urb, GFP_ATOMIC);
1041 intfdata->in_flight--;
1042 usb_unanchor_urb(urb);
1043 usb_scuttle_anchored_urbs(&portdata->delayed);
1048 if (portdata->opened) {
1049 err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1054 intfdata->suspended = 0;
1055 spin_unlock_irq(&intfdata->susp_lock);
1057 return ec ? -EIO : 0;
1060 static int sierra_reset_resume(struct usb_interface *intf)
1062 struct usb_serial *serial = usb_get_intfdata(intf);
1063 dev_err(&serial->dev->dev, "%s\n", __func__);
1064 return usb_serial_resume(intf);
1067 #define sierra_suspend NULL
1068 #define sierra_resume NULL
1069 #define sierra_reset_resume NULL
1072 static struct usb_driver sierra_driver = {
1074 .probe = usb_serial_probe,
1075 .disconnect = usb_serial_disconnect,
1076 .suspend = usb_serial_suspend,
1077 .resume = usb_serial_resume,
1078 .reset_resume = sierra_reset_resume,
1079 .id_table = id_table,
1081 .supports_autosuspend = 1,
1084 static struct usb_serial_driver sierra_device = {
1086 .owner = THIS_MODULE,
1089 .description = "Sierra USB modem",
1090 .id_table = id_table,
1091 .usb_driver = &sierra_driver,
1092 .calc_num_ports = sierra_calc_num_ports,
1093 .probe = sierra_probe,
1094 .open = sierra_open,
1095 .close = sierra_close,
1096 .dtr_rts = sierra_dtr_rts,
1097 .write = sierra_write,
1098 .write_room = sierra_write_room,
1099 .set_termios = sierra_set_termios,
1100 .tiocmget = sierra_tiocmget,
1101 .tiocmset = sierra_tiocmset,
1102 .attach = sierra_startup,
1103 .release = sierra_release,
1104 .suspend = sierra_suspend,
1105 .resume = sierra_resume,
1106 .read_int_callback = sierra_instat_callback,
1109 /* Functions used by new usb-serial code. */
1110 static int __init sierra_init(void)
1113 retval = usb_serial_register(&sierra_device);
1115 goto failed_device_register;
1118 retval = usb_register(&sierra_driver);
1120 goto failed_driver_register;
1122 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1127 failed_driver_register:
1128 usb_serial_deregister(&sierra_device);
1129 failed_device_register:
1133 static void __exit sierra_exit(void)
1135 usb_deregister(&sierra_driver);
1136 usb_serial_deregister(&sierra_device);
1139 module_init(sierra_init);
1140 module_exit(sierra_exit);
1142 MODULE_AUTHOR(DRIVER_AUTHOR);
1143 MODULE_DESCRIPTION(DRIVER_DESC);
1144 MODULE_VERSION(DRIVER_VERSION);
1145 MODULE_LICENSE("GPL");
1147 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1148 MODULE_PARM_DESC(nmea, "NMEA streaming");
1150 module_param(debug, bool, S_IRUGO | S_IWUSR);
1151 MODULE_PARM_DESC(debug, "Debug messages");