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)
66 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
67 SWIMS_USB_REQUEST_SetPower, /* __u8 request */
68 USB_TYPE_VENDOR, /* __u8 request type */
69 swiState, /* __u16 value */
71 NULL, /* void *data */
73 USB_CTRL_SET_TIMEOUT); /* int timeout */
76 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
78 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
79 SWIMS_USB_REQUEST_SetNmea, /* __u8 request */
80 USB_TYPE_VENDOR, /* __u8 request type */
81 enable, /* __u16 value */
82 0x0000, /* __u16 index */
83 NULL, /* void *data */
85 USB_CTRL_SET_TIMEOUT); /* int timeout */
88 static int sierra_calc_num_ports(struct usb_serial *serial)
91 u8 ifnum, numendpoints;
93 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
94 numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
96 /* Dummy interface present on some SKUs should be ignored */
99 else if (numendpoints <= 3)
102 num_ports = (numendpoints-1)/2;
106 static int is_blacklisted(const u8 ifnum,
107 const struct sierra_iface_info *blacklist)
113 info = blacklist->ifaceinfo;
115 for (i = 0; i < blacklist->infolen; i++) {
116 if (info[i] == ifnum)
123 static int is_himemory(const u8 ifnum,
124 const struct sierra_iface_info *himemorylist)
130 info = himemorylist->ifaceinfo;
132 for (i=0; i < himemorylist->infolen; i++) {
133 if (info[i] == ifnum)
140 static int sierra_calc_interface(struct usb_serial *serial)
143 struct usb_interface *p_interface;
144 struct usb_host_interface *p_host_interface;
146 /* Get the interface structure pointer from the serial struct */
147 p_interface = serial->interface;
149 /* Get a pointer to the host interface structure */
150 p_host_interface = p_interface->cur_altsetting;
152 /* read the interface descriptor for this active altsetting
153 * to find out the interface number we are on
155 interface = p_host_interface->desc.bInterfaceNumber;
160 static int sierra_probe(struct usb_serial *serial,
161 const struct usb_device_id *id)
164 struct usb_device *udev;
165 struct sierra_intf_private *data;
169 ifnum = sierra_calc_interface(serial);
172 * If this interface supports more than 1 alternate
175 if (serial->interface->num_altsetting == 2) {
176 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
178 /* We know the alternate setting is 1 for the MC8785 */
179 usb_set_interface(udev, ifnum, 1);
182 /* ifnum could have changed - by calling usb_set_interface */
183 ifnum = sierra_calc_interface(serial);
185 if (is_blacklisted(ifnum,
186 (struct sierra_iface_info *)id->driver_info)) {
187 dev_dbg(&serial->dev->dev,
188 "Ignoring blacklisted interface #%d\n", ifnum);
192 data = serial->private = kzalloc(sizeof(struct sierra_intf_private), GFP_KERNEL);
195 spin_lock_init(&data->susp_lock);
200 /* interfaces with higher memory requirements */
201 static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
202 static const struct sierra_iface_info typeA_interface_list = {
203 .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
204 .ifaceinfo = hi_memory_typeA_ifaces,
207 static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
208 static const struct sierra_iface_info typeB_interface_list = {
209 .infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
210 .ifaceinfo = hi_memory_typeB_ifaces,
213 /* 'blacklist' of interfaces not served by this driver */
214 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11, 19, 20 };
215 static const struct sierra_iface_info direct_ip_interface_blacklist = {
216 .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
217 .ifaceinfo = direct_ip_non_serial_ifaces,
220 static const struct usb_device_id id_table[] = {
221 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
222 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
223 { USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
224 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
226 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
227 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
228 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
229 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
230 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
231 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
232 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
233 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
234 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
235 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
236 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
237 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
238 { USB_DEVICE(0x1199, 0x0301) }, /* Sierra Wireless USB Dongle 250U */
239 /* Sierra Wireless C597 */
240 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
241 /* Sierra Wireless T598 */
242 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
243 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
244 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
245 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
246 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
248 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
249 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
250 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
251 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
252 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
253 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
254 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
255 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
256 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
257 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
258 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
259 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
260 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
261 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
262 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
263 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
264 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
265 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
266 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
267 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
268 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
269 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
270 { USB_DEVICE(0x1199, 0x683C) },
271 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
272 /* Sierra Wireless MC8790, MC8791, MC8792 */
273 { USB_DEVICE(0x1199, 0x683E) },
274 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
275 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
276 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
277 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
278 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
279 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
280 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
281 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
282 /* Sierra Wireless C885 */
283 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
284 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
285 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
286 /* Sierra Wireless C22/C33 */
287 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
288 /* Sierra Wireless HSPA Non-Composite Device */
289 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
290 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
291 { USB_DEVICE(0x1199, 0x68A2), /* Sierra Wireless MC77xx in QMI mode */
292 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
294 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */
295 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
297 { USB_DEVICE(0x0f3d, 0x68A3), /* Airprime/Sierra Wireless Direct IP modems */
298 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
300 { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */
304 MODULE_DEVICE_TABLE(usb, id_table);
307 struct sierra_port_private {
308 spinlock_t lock; /* lock the structure */
309 int outstanding_urbs; /* number of out urbs in flight */
310 struct usb_anchor active;
311 struct usb_anchor delayed;
315 /* Input endpoints and buffers for this port */
316 struct urb *in_urbs[N_IN_URB_HM];
318 /* Settings for the port */
319 int rts_state; /* Handshaking pins (outputs) */
321 int cts_state; /* Handshaking pins (inputs) */
325 unsigned int opened:1;
328 static int sierra_send_setup(struct usb_serial_port *port)
330 struct usb_serial *serial = port->serial;
331 struct sierra_port_private *portdata;
337 portdata = usb_get_serial_port_data(port);
339 if (portdata->dtr_state)
341 if (portdata->rts_state)
344 /* If composite device then properly report interface */
345 if (serial->num_ports == 1) {
346 interface = sierra_calc_interface(serial);
347 /* Control message is sent only to interfaces with
348 * interrupt_in endpoints
350 if (port->interrupt_in_urb) {
351 /* send control message */
356 /* Otherwise the need to do non-composite mapping */
358 if (port->bulk_out_endpointAddress == 2)
360 else if (port->bulk_out_endpointAddress == 4)
362 else if (port->bulk_out_endpointAddress == 5)
370 retval = usb_autopm_get_interface(serial->interface);
374 retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
375 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
376 usb_autopm_put_interface(serial->interface);
381 static void sierra_set_termios(struct tty_struct *tty,
382 struct usb_serial_port *port, struct ktermios *old_termios)
384 tty_termios_copy_hw(tty->termios, old_termios);
385 sierra_send_setup(port);
388 static int sierra_tiocmget(struct tty_struct *tty)
390 struct usb_serial_port *port = tty->driver_data;
392 struct sierra_port_private *portdata;
394 portdata = usb_get_serial_port_data(port);
396 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
397 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
398 ((portdata->cts_state) ? TIOCM_CTS : 0) |
399 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
400 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
401 ((portdata->ri_state) ? TIOCM_RNG : 0);
406 static int sierra_tiocmset(struct tty_struct *tty,
407 unsigned int set, unsigned int clear)
409 struct usb_serial_port *port = tty->driver_data;
410 struct sierra_port_private *portdata;
412 portdata = usb_get_serial_port_data(port);
415 portdata->rts_state = 1;
417 portdata->dtr_state = 1;
419 if (clear & TIOCM_RTS)
420 portdata->rts_state = 0;
421 if (clear & TIOCM_DTR)
422 portdata->dtr_state = 0;
423 return sierra_send_setup(port);
426 static void sierra_release_urb(struct urb *urb)
428 struct usb_serial_port *port;
431 kfree(urb->transfer_buffer);
436 static void sierra_outdat_callback(struct urb *urb)
438 struct usb_serial_port *port = urb->context;
439 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
440 struct sierra_intf_private *intfdata;
441 int status = urb->status;
443 intfdata = port->serial->private;
445 /* free up the transfer buffer, as usb_free_urb() does not do this */
446 kfree(urb->transfer_buffer);
447 usb_autopm_put_interface_async(port->serial->interface);
449 dev_dbg(&port->dev, "%s - nonzero write bulk status "
450 "received: %d\n", __func__, status);
452 spin_lock(&portdata->lock);
453 --portdata->outstanding_urbs;
454 spin_unlock(&portdata->lock);
455 spin_lock(&intfdata->susp_lock);
456 --intfdata->in_flight;
457 spin_unlock(&intfdata->susp_lock);
459 usb_serial_port_softint(port);
463 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
464 const unsigned char *buf, int count)
466 struct sierra_port_private *portdata;
467 struct sierra_intf_private *intfdata;
468 struct usb_serial *serial = port->serial;
470 unsigned char *buffer;
472 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
475 /* verify that we actually have some data to write */
479 portdata = usb_get_serial_port_data(port);
480 intfdata = serial->private;
482 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
483 spin_lock_irqsave(&portdata->lock, flags);
484 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
485 portdata->outstanding_urbs);
486 if (portdata->outstanding_urbs > portdata->num_out_urbs) {
487 spin_unlock_irqrestore(&portdata->lock, flags);
488 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
491 portdata->outstanding_urbs++;
492 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
493 portdata->outstanding_urbs);
494 spin_unlock_irqrestore(&portdata->lock, flags);
496 retval = usb_autopm_get_interface_async(serial->interface);
498 spin_lock_irqsave(&portdata->lock, flags);
499 portdata->outstanding_urbs--;
500 spin_unlock_irqrestore(&portdata->lock, flags);
504 buffer = kmalloc(writesize, GFP_ATOMIC);
506 dev_err(&port->dev, "out of memory\n");
508 goto error_no_buffer;
511 urb = usb_alloc_urb(0, GFP_ATOMIC);
513 dev_err(&port->dev, "no more free urbs\n");
518 memcpy(buffer, buf, writesize);
520 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
522 usb_fill_bulk_urb(urb, serial->dev,
523 usb_sndbulkpipe(serial->dev,
524 port->bulk_out_endpointAddress),
525 buffer, writesize, sierra_outdat_callback, port);
527 /* Handle the need to send a zero length packet */
528 urb->transfer_flags |= URB_ZERO_PACKET;
530 spin_lock_irqsave(&intfdata->susp_lock, flags);
532 if (intfdata->suspended) {
533 usb_anchor_urb(urb, &portdata->delayed);
534 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
537 usb_anchor_urb(urb, &portdata->active);
539 /* send it down the pipe */
540 retval = usb_submit_urb(urb, GFP_ATOMIC);
542 usb_unanchor_urb(urb);
543 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
544 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
545 "with status = %d\n", __func__, retval);
548 intfdata->in_flight++;
549 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
553 /* we are done with this urb, so let the host driver
554 * really free it when it is finished with it */
563 spin_lock_irqsave(&portdata->lock, flags);
564 --portdata->outstanding_urbs;
565 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
566 portdata->outstanding_urbs);
567 spin_unlock_irqrestore(&portdata->lock, flags);
568 usb_autopm_put_interface_async(serial->interface);
573 static void sierra_indat_callback(struct urb *urb)
577 struct usb_serial_port *port;
578 struct tty_struct *tty;
579 unsigned char *data = urb->transfer_buffer;
580 int status = urb->status;
582 endpoint = usb_pipeendpoint(urb->pipe);
586 dev_dbg(&port->dev, "%s: nonzero status: %d on"
587 " endpoint %02x\n", __func__, status, endpoint);
589 if (urb->actual_length) {
590 tty = tty_port_tty_get(&port->port);
592 tty_insert_flip_string(tty, data,
594 tty_flip_buffer_push(tty);
597 usb_serial_debug_data(debug, &port->dev,
598 __func__, urb->actual_length, data);
601 dev_dbg(&port->dev, "%s: empty read urb"
602 " received\n", __func__);
606 /* Resubmit urb so we continue receiving */
607 if (status != -ESHUTDOWN && status != -EPERM) {
608 usb_mark_last_busy(port->serial->dev);
609 err = usb_submit_urb(urb, GFP_ATOMIC);
610 if (err && err != -EPERM)
611 dev_err(&port->dev, "resubmit read urb failed."
616 static void sierra_instat_callback(struct urb *urb)
619 int status = urb->status;
620 struct usb_serial_port *port = urb->context;
621 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
622 struct usb_serial *serial = port->serial;
624 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
625 urb, port, portdata);
628 struct usb_ctrlrequest *req_pkt =
629 (struct usb_ctrlrequest *)urb->transfer_buffer;
632 dev_dbg(&port->dev, "%s: NULL req_pkt\n",
636 if ((req_pkt->bRequestType == 0xA1) &&
637 (req_pkt->bRequest == 0x20)) {
639 unsigned char signals = *((unsigned char *)
640 urb->transfer_buffer +
641 sizeof(struct usb_ctrlrequest));
642 struct tty_struct *tty;
644 dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
647 old_dcd_state = portdata->dcd_state;
648 portdata->cts_state = 1;
649 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
650 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
651 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
653 tty = tty_port_tty_get(&port->port);
654 if (tty && !C_CLOCAL(tty) &&
655 old_dcd_state && !portdata->dcd_state)
659 dev_dbg(&port->dev, "%s: type %x req %x\n",
660 __func__, req_pkt->bRequestType,
664 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
666 /* Resubmit urb so we continue receiving IRQ data */
667 if (status != -ESHUTDOWN && status != -ENOENT) {
668 usb_mark_last_busy(serial->dev);
669 err = usb_submit_urb(urb, GFP_ATOMIC);
670 if (err && err != -EPERM)
671 dev_err(&port->dev, "%s: resubmit intr urb "
672 "failed. (%d)\n", __func__, err);
676 static int sierra_write_room(struct tty_struct *tty)
678 struct usb_serial_port *port = tty->driver_data;
679 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
682 /* try to give a good number back based on if we have any free urbs at
683 * this point in time */
684 spin_lock_irqsave(&portdata->lock, flags);
685 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
686 spin_unlock_irqrestore(&portdata->lock, flags);
687 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
690 spin_unlock_irqrestore(&portdata->lock, flags);
695 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
698 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
700 for (i = 0; i < portdata->num_in_urbs; i++)
701 usb_kill_urb(portdata->in_urbs[i]);
703 usb_kill_urb(port->interrupt_in_urb);
706 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
712 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
715 for (i = 0; i < portdata->num_in_urbs; i++) {
716 urb = portdata->in_urbs[i];
719 err = usb_submit_urb(urb, mem_flags);
721 dev_err(&port->dev, "%s: submit urb failed: %d\n",
728 if (ok_cnt && port->interrupt_in_urb) {
729 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
731 dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
736 if (ok_cnt > 0) /* at least one rx urb submitted */
742 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
743 int dir, void *ctx, int len,
745 usb_complete_t callback)
753 urb = usb_alloc_urb(0, mem_flags);
755 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
760 buf = kmalloc(len, mem_flags);
762 /* Fill URB using supplied data */
763 usb_fill_bulk_urb(urb, serial->dev,
764 usb_sndbulkpipe(serial->dev, endpoint) | dir,
765 buf, len, callback, ctx);
768 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
769 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
771 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
772 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
774 sierra_release_urb(urb);
781 static void sierra_close(struct usb_serial_port *port)
784 struct usb_serial *serial = port->serial;
785 struct sierra_port_private *portdata;
786 struct sierra_intf_private *intfdata = port->serial->private;
788 portdata = usb_get_serial_port_data(port);
790 portdata->rts_state = 0;
791 portdata->dtr_state = 0;
794 mutex_lock(&serial->disc_mutex);
795 if (!serial->disconnected) {
796 serial->interface->needs_remote_wakeup = 0;
797 /* odd error handling due to pm counters */
798 if (!usb_autopm_get_interface(serial->interface))
799 sierra_send_setup(port);
801 usb_autopm_get_interface_no_resume(serial->interface);
804 mutex_unlock(&serial->disc_mutex);
805 spin_lock_irq(&intfdata->susp_lock);
806 portdata->opened = 0;
807 spin_unlock_irq(&intfdata->susp_lock);
810 /* Stop reading urbs */
811 sierra_stop_rx_urbs(port);
812 /* .. and release them */
813 for (i = 0; i < portdata->num_in_urbs; i++) {
814 sierra_release_urb(portdata->in_urbs[i]);
815 portdata->in_urbs[i] = NULL;
820 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
822 struct sierra_port_private *portdata;
823 struct usb_serial *serial = port->serial;
824 struct sierra_intf_private *intfdata = serial->private;
830 portdata = usb_get_serial_port_data(port);
832 /* Set some sane defaults */
833 portdata->rts_state = 1;
834 portdata->dtr_state = 1;
837 endpoint = port->bulk_in_endpointAddress;
838 for (i = 0; i < portdata->num_in_urbs; i++) {
839 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
840 IN_BUFLEN, GFP_KERNEL,
841 sierra_indat_callback);
842 portdata->in_urbs[i] = urb;
844 /* clear halt condition */
845 usb_clear_halt(serial->dev,
846 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
848 err = sierra_submit_rx_urbs(port, GFP_KERNEL);
850 /* get rid of everything as in close */
852 /* restore balance for autopm */
853 if (!serial->disconnected)
854 usb_autopm_put_interface(serial->interface);
857 sierra_send_setup(port);
859 serial->interface->needs_remote_wakeup = 1;
860 spin_lock_irq(&intfdata->susp_lock);
861 portdata->opened = 1;
862 spin_unlock_irq(&intfdata->susp_lock);
863 usb_autopm_put_interface(serial->interface);
869 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
871 struct usb_serial *serial = port->serial;
872 struct sierra_port_private *portdata;
874 portdata = usb_get_serial_port_data(port);
875 portdata->rts_state = on;
876 portdata->dtr_state = on;
879 mutex_lock(&serial->disc_mutex);
880 if (!serial->disconnected)
881 sierra_send_setup(port);
882 mutex_unlock(&serial->disc_mutex);
886 static int sierra_startup(struct usb_serial *serial)
888 struct usb_serial_port *port;
889 struct sierra_port_private *portdata;
890 struct sierra_iface_info *himemoryp = NULL;
894 /* Set Device mode to D0 */
895 sierra_set_power_state(serial->dev, 0x0000);
897 /* Check NMEA and set */
899 sierra_vsc_set_nmea(serial->dev, 1);
901 /* Now setup per port private data */
902 for (i = 0; i < serial->num_ports; i++) {
903 port = serial->port[i];
904 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
906 dev_dbg(&port->dev, "%s: kmalloc for "
907 "sierra_port_private (%d) failed!\n",
911 spin_lock_init(&portdata->lock);
912 init_usb_anchor(&portdata->active);
913 init_usb_anchor(&portdata->delayed);
915 /* Assume low memory requirements */
916 portdata->num_out_urbs = N_OUT_URB;
917 portdata->num_in_urbs = N_IN_URB;
919 /* Determine actual memory requirements */
920 if (serial->num_ports == 1) {
921 /* Get interface number for composite device */
922 ifnum = sierra_calc_interface(serial);
924 (struct sierra_iface_info *)&typeB_interface_list;
925 if (is_himemory(ifnum, himemoryp)) {
926 portdata->num_out_urbs = N_OUT_URB_HM;
927 portdata->num_in_urbs = N_IN_URB_HM;
932 (struct sierra_iface_info *)&typeA_interface_list;
933 if (is_himemory(i, himemoryp)) {
934 portdata->num_out_urbs = N_OUT_URB_HM;
935 portdata->num_in_urbs = N_IN_URB_HM;
938 dev_dbg(&serial->dev->dev,
939 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
940 ifnum,portdata->num_in_urbs, portdata->num_out_urbs );
941 /* Set the port private data pointer */
942 usb_set_serial_port_data(port, portdata);
948 static void sierra_release(struct usb_serial *serial)
951 struct usb_serial_port *port;
952 struct sierra_port_private *portdata;
954 for (i = 0; i < serial->num_ports; ++i) {
955 port = serial->port[i];
958 portdata = usb_get_serial_port_data(port);
966 static void stop_read_write_urbs(struct usb_serial *serial)
969 struct usb_serial_port *port;
970 struct sierra_port_private *portdata;
972 /* Stop reading/writing urbs */
973 for (i = 0; i < serial->num_ports; ++i) {
974 port = serial->port[i];
975 portdata = usb_get_serial_port_data(port);
976 sierra_stop_rx_urbs(port);
977 usb_kill_anchored_urbs(&portdata->active);
981 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
983 struct sierra_intf_private *intfdata;
986 if (PMSG_IS_AUTO(message)) {
987 intfdata = serial->private;
988 spin_lock_irq(&intfdata->susp_lock);
989 b = intfdata->in_flight;
992 spin_unlock_irq(&intfdata->susp_lock);
995 intfdata->suspended = 1;
996 spin_unlock_irq(&intfdata->susp_lock);
999 stop_read_write_urbs(serial);
1004 static int sierra_resume(struct usb_serial *serial)
1006 struct usb_serial_port *port;
1007 struct sierra_intf_private *intfdata = serial->private;
1008 struct sierra_port_private *portdata;
1013 spin_lock_irq(&intfdata->susp_lock);
1014 for (i = 0; i < serial->num_ports; i++) {
1015 port = serial->port[i];
1016 portdata = usb_get_serial_port_data(port);
1018 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
1019 usb_anchor_urb(urb, &portdata->active);
1020 intfdata->in_flight++;
1021 err = usb_submit_urb(urb, GFP_ATOMIC);
1023 intfdata->in_flight--;
1024 usb_unanchor_urb(urb);
1025 usb_scuttle_anchored_urbs(&portdata->delayed);
1030 if (portdata->opened) {
1031 err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1036 intfdata->suspended = 0;
1037 spin_unlock_irq(&intfdata->susp_lock);
1039 return ec ? -EIO : 0;
1042 static int sierra_reset_resume(struct usb_interface *intf)
1044 struct usb_serial *serial = usb_get_intfdata(intf);
1045 dev_err(&serial->dev->dev, "%s\n", __func__);
1046 return usb_serial_resume(intf);
1049 #define sierra_suspend NULL
1050 #define sierra_resume NULL
1051 #define sierra_reset_resume NULL
1054 static struct usb_driver sierra_driver = {
1056 .reset_resume = sierra_reset_resume,
1057 .id_table = id_table,
1060 static struct usb_serial_driver sierra_device = {
1062 .owner = THIS_MODULE,
1065 .description = "Sierra USB modem",
1066 .id_table = id_table,
1067 .calc_num_ports = sierra_calc_num_ports,
1068 .probe = sierra_probe,
1069 .open = sierra_open,
1070 .close = sierra_close,
1071 .dtr_rts = sierra_dtr_rts,
1072 .write = sierra_write,
1073 .write_room = sierra_write_room,
1074 .set_termios = sierra_set_termios,
1075 .tiocmget = sierra_tiocmget,
1076 .tiocmset = sierra_tiocmset,
1077 .attach = sierra_startup,
1078 .release = sierra_release,
1079 .suspend = sierra_suspend,
1080 .resume = sierra_resume,
1081 .read_int_callback = sierra_instat_callback,
1084 static struct usb_serial_driver * const serial_drivers[] = {
1085 &sierra_device, NULL
1088 module_usb_serial_driver(sierra_driver, serial_drivers);
1090 MODULE_AUTHOR(DRIVER_AUTHOR);
1091 MODULE_DESCRIPTION(DRIVER_DESC);
1092 MODULE_VERSION(DRIVER_VERSION);
1093 MODULE_LICENSE("GPL");
1095 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1096 MODULE_PARM_DESC(nmea, "NMEA streaming");
1098 module_param(debug, bool, S_IRUGO | S_IWUSR);
1099 MODULE_PARM_DESC(debug, "Debug messages");