Linux 3.9-rc4
[linux-2.6/cjktty.git] / drivers / usb / serial / sierra.c
blobc13f6e747748b31d16c0d087fa4f8b1953826285
1 /*
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 */
20 /* #define DEBUG */
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
38 #define N_IN_URB_HM 8
39 #define N_OUT_URB_HM 64
40 #define N_IN_URB 4
41 #define N_OUT_URB 4
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 */
49 static bool nmea;
51 /* Used in interface blacklisting */
52 struct sierra_iface_info {
53 const u32 infolen; /* number of interface numbers on blacklist */
54 const u8 *ifaceinfo; /* pointer to the array holding the numbers */
57 struct sierra_intf_private {
58 spinlock_t susp_lock;
59 unsigned int suspended:1;
60 int in_flight;
63 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
65 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
66 SWIMS_USB_REQUEST_SetPower, /* __u8 request */
67 USB_TYPE_VENDOR, /* __u8 request type */
68 swiState, /* __u16 value */
69 0, /* __u16 index */
70 NULL, /* void *data */
71 0, /* __u16 size */
72 USB_CTRL_SET_TIMEOUT); /* int timeout */
75 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
77 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
78 SWIMS_USB_REQUEST_SetNmea, /* __u8 request */
79 USB_TYPE_VENDOR, /* __u8 request type */
80 enable, /* __u16 value */
81 0x0000, /* __u16 index */
82 NULL, /* void *data */
83 0, /* __u16 size */
84 USB_CTRL_SET_TIMEOUT); /* int timeout */
87 static int sierra_calc_num_ports(struct usb_serial *serial)
89 int num_ports = 0;
90 u8 ifnum, numendpoints;
92 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
93 numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
95 /* Dummy interface present on some SKUs should be ignored */
96 if (ifnum == 0x99)
97 num_ports = 0;
98 else if (numendpoints <= 3)
99 num_ports = 1;
100 else
101 num_ports = (numendpoints-1)/2;
102 return num_ports;
105 static int is_blacklisted(const u8 ifnum,
106 const struct sierra_iface_info *blacklist)
108 const u8 *info;
109 int i;
111 if (blacklist) {
112 info = blacklist->ifaceinfo;
114 for (i = 0; i < blacklist->infolen; i++) {
115 if (info[i] == ifnum)
116 return 1;
119 return 0;
122 static int is_himemory(const u8 ifnum,
123 const struct sierra_iface_info *himemorylist)
125 const u8 *info;
126 int i;
128 if (himemorylist) {
129 info = himemorylist->ifaceinfo;
131 for (i=0; i < himemorylist->infolen; i++) {
132 if (info[i] == ifnum)
133 return 1;
136 return 0;
139 static int sierra_calc_interface(struct usb_serial *serial)
141 int interface;
142 struct usb_interface *p_interface;
143 struct usb_host_interface *p_host_interface;
145 /* Get the interface structure pointer from the serial struct */
146 p_interface = serial->interface;
148 /* Get a pointer to the host interface structure */
149 p_host_interface = p_interface->cur_altsetting;
151 /* read the interface descriptor for this active altsetting
152 * to find out the interface number we are on
154 interface = p_host_interface->desc.bInterfaceNumber;
156 return interface;
159 static int sierra_probe(struct usb_serial *serial,
160 const struct usb_device_id *id)
162 int result = 0;
163 struct usb_device *udev;
164 u8 ifnum;
166 udev = serial->dev;
167 ifnum = sierra_calc_interface(serial);
170 * If this interface supports more than 1 alternate
171 * select the 2nd one
173 if (serial->interface->num_altsetting == 2) {
174 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
175 ifnum);
176 /* We know the alternate setting is 1 for the MC8785 */
177 usb_set_interface(udev, ifnum, 1);
180 /* ifnum could have changed - by calling usb_set_interface */
181 ifnum = sierra_calc_interface(serial);
183 if (is_blacklisted(ifnum,
184 (struct sierra_iface_info *)id->driver_info)) {
185 dev_dbg(&serial->dev->dev,
186 "Ignoring blacklisted interface #%d\n", ifnum);
187 return -ENODEV;
190 return result;
193 /* interfaces with higher memory requirements */
194 static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
195 static const struct sierra_iface_info typeA_interface_list = {
196 .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
197 .ifaceinfo = hi_memory_typeA_ifaces,
200 static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
201 static const struct sierra_iface_info typeB_interface_list = {
202 .infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
203 .ifaceinfo = hi_memory_typeB_ifaces,
206 /* 'blacklist' of interfaces not served by this driver */
207 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11, 19, 20 };
208 static const struct sierra_iface_info direct_ip_interface_blacklist = {
209 .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
210 .ifaceinfo = direct_ip_non_serial_ifaces,
213 static const struct usb_device_id id_table[] = {
214 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
215 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
216 { USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
217 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
219 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
220 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
221 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
222 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
223 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
224 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
225 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
226 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
227 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
228 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
229 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
230 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
231 { USB_DEVICE(0x1199, 0x0301) }, /* Sierra Wireless USB Dongle 250U */
232 /* Sierra Wireless C597 */
233 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
234 /* Sierra Wireless T598 */
235 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
236 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
237 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
238 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
239 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
241 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
242 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
243 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
244 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
245 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
246 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
247 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
248 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
249 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
250 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
251 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
252 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
253 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
254 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
255 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
256 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
257 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
258 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
259 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
260 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
261 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
262 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
263 { USB_DEVICE(0x1199, 0x683C) },
264 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
265 /* Sierra Wireless MC8790, MC8791, MC8792 */
266 { USB_DEVICE(0x1199, 0x683E) },
267 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
268 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
269 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
270 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
271 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
272 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
273 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
274 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
275 /* Sierra Wireless C885 */
276 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
277 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
278 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
279 /* Sierra Wireless C22/C33 */
280 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
281 /* Sierra Wireless HSPA Non-Composite Device */
282 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
283 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
284 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */
285 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
287 /* AT&T Direct IP LTE modems */
288 { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
289 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
291 { USB_DEVICE(0x0f3d, 0x68A3), /* Airprime/Sierra Wireless Direct IP modems */
292 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
294 { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */
298 MODULE_DEVICE_TABLE(usb, id_table);
301 struct sierra_port_private {
302 spinlock_t lock; /* lock the structure */
303 int outstanding_urbs; /* number of out urbs in flight */
304 struct usb_anchor active;
305 struct usb_anchor delayed;
307 int num_out_urbs;
308 int num_in_urbs;
309 /* Input endpoints and buffers for this port */
310 struct urb *in_urbs[N_IN_URB_HM];
312 /* Settings for the port */
313 int rts_state; /* Handshaking pins (outputs) */
314 int dtr_state;
315 int cts_state; /* Handshaking pins (inputs) */
316 int dsr_state;
317 int dcd_state;
318 int ri_state;
319 unsigned int opened:1;
322 static int sierra_send_setup(struct usb_serial_port *port)
324 struct usb_serial *serial = port->serial;
325 struct sierra_port_private *portdata;
326 __u16 interface = 0;
327 int val = 0;
328 int do_send = 0;
329 int retval;
331 portdata = usb_get_serial_port_data(port);
333 if (portdata->dtr_state)
334 val |= 0x01;
335 if (portdata->rts_state)
336 val |= 0x02;
338 /* If composite device then properly report interface */
339 if (serial->num_ports == 1) {
340 interface = sierra_calc_interface(serial);
341 /* Control message is sent only to interfaces with
342 * interrupt_in endpoints
344 if (port->interrupt_in_urb) {
345 /* send control message */
346 do_send = 1;
350 /* Otherwise the need to do non-composite mapping */
351 else {
352 if (port->bulk_out_endpointAddress == 2)
353 interface = 0;
354 else if (port->bulk_out_endpointAddress == 4)
355 interface = 1;
356 else if (port->bulk_out_endpointAddress == 5)
357 interface = 2;
359 do_send = 1;
361 if (!do_send)
362 return 0;
364 retval = usb_autopm_get_interface(serial->interface);
365 if (retval < 0)
366 return retval;
368 retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
369 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
370 usb_autopm_put_interface(serial->interface);
372 return retval;
375 static void sierra_set_termios(struct tty_struct *tty,
376 struct usb_serial_port *port, struct ktermios *old_termios)
378 tty_termios_copy_hw(&tty->termios, old_termios);
379 sierra_send_setup(port);
382 static int sierra_tiocmget(struct tty_struct *tty)
384 struct usb_serial_port *port = tty->driver_data;
385 unsigned int value;
386 struct sierra_port_private *portdata;
388 portdata = usb_get_serial_port_data(port);
390 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
391 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
392 ((portdata->cts_state) ? TIOCM_CTS : 0) |
393 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
394 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
395 ((portdata->ri_state) ? TIOCM_RNG : 0);
397 return value;
400 static int sierra_tiocmset(struct tty_struct *tty,
401 unsigned int set, unsigned int clear)
403 struct usb_serial_port *port = tty->driver_data;
404 struct sierra_port_private *portdata;
406 portdata = usb_get_serial_port_data(port);
408 if (set & TIOCM_RTS)
409 portdata->rts_state = 1;
410 if (set & TIOCM_DTR)
411 portdata->dtr_state = 1;
413 if (clear & TIOCM_RTS)
414 portdata->rts_state = 0;
415 if (clear & TIOCM_DTR)
416 portdata->dtr_state = 0;
417 return sierra_send_setup(port);
420 static void sierra_release_urb(struct urb *urb)
422 struct usb_serial_port *port;
423 if (urb) {
424 port = urb->context;
425 kfree(urb->transfer_buffer);
426 usb_free_urb(urb);
430 static void sierra_outdat_callback(struct urb *urb)
432 struct usb_serial_port *port = urb->context;
433 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
434 struct sierra_intf_private *intfdata;
435 int status = urb->status;
437 intfdata = port->serial->private;
439 /* free up the transfer buffer, as usb_free_urb() does not do this */
440 kfree(urb->transfer_buffer);
441 usb_autopm_put_interface_async(port->serial->interface);
442 if (status)
443 dev_dbg(&port->dev, "%s - nonzero write bulk status "
444 "received: %d\n", __func__, status);
446 spin_lock(&portdata->lock);
447 --portdata->outstanding_urbs;
448 spin_unlock(&portdata->lock);
449 spin_lock(&intfdata->susp_lock);
450 --intfdata->in_flight;
451 spin_unlock(&intfdata->susp_lock);
453 usb_serial_port_softint(port);
456 /* Write */
457 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
458 const unsigned char *buf, int count)
460 struct sierra_port_private *portdata;
461 struct sierra_intf_private *intfdata;
462 struct usb_serial *serial = port->serial;
463 unsigned long flags;
464 unsigned char *buffer;
465 struct urb *urb;
466 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
467 int retval = 0;
469 /* verify that we actually have some data to write */
470 if (count == 0)
471 return 0;
473 portdata = usb_get_serial_port_data(port);
474 intfdata = serial->private;
476 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
477 spin_lock_irqsave(&portdata->lock, flags);
478 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
479 portdata->outstanding_urbs);
480 if (portdata->outstanding_urbs > portdata->num_out_urbs) {
481 spin_unlock_irqrestore(&portdata->lock, flags);
482 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
483 return 0;
485 portdata->outstanding_urbs++;
486 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
487 portdata->outstanding_urbs);
488 spin_unlock_irqrestore(&portdata->lock, flags);
490 retval = usb_autopm_get_interface_async(serial->interface);
491 if (retval < 0) {
492 spin_lock_irqsave(&portdata->lock, flags);
493 portdata->outstanding_urbs--;
494 spin_unlock_irqrestore(&portdata->lock, flags);
495 goto error_simple;
498 buffer = kmalloc(writesize, GFP_ATOMIC);
499 if (!buffer) {
500 dev_err(&port->dev, "out of memory\n");
501 retval = -ENOMEM;
502 goto error_no_buffer;
505 urb = usb_alloc_urb(0, GFP_ATOMIC);
506 if (!urb) {
507 dev_err(&port->dev, "no more free urbs\n");
508 retval = -ENOMEM;
509 goto error_no_urb;
512 memcpy(buffer, buf, writesize);
514 usb_serial_debug_data(&port->dev, __func__, writesize, buffer);
516 usb_fill_bulk_urb(urb, serial->dev,
517 usb_sndbulkpipe(serial->dev,
518 port->bulk_out_endpointAddress),
519 buffer, writesize, sierra_outdat_callback, port);
521 /* Handle the need to send a zero length packet */
522 urb->transfer_flags |= URB_ZERO_PACKET;
524 spin_lock_irqsave(&intfdata->susp_lock, flags);
526 if (intfdata->suspended) {
527 usb_anchor_urb(urb, &portdata->delayed);
528 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
529 goto skip_power;
530 } else {
531 usb_anchor_urb(urb, &portdata->active);
533 /* send it down the pipe */
534 retval = usb_submit_urb(urb, GFP_ATOMIC);
535 if (retval) {
536 usb_unanchor_urb(urb);
537 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
538 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
539 "with status = %d\n", __func__, retval);
540 goto error;
541 } else {
542 intfdata->in_flight++;
543 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
546 skip_power:
547 /* we are done with this urb, so let the host driver
548 * really free it when it is finished with it */
549 usb_free_urb(urb);
551 return writesize;
552 error:
553 usb_free_urb(urb);
554 error_no_urb:
555 kfree(buffer);
556 error_no_buffer:
557 spin_lock_irqsave(&portdata->lock, flags);
558 --portdata->outstanding_urbs;
559 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
560 portdata->outstanding_urbs);
561 spin_unlock_irqrestore(&portdata->lock, flags);
562 usb_autopm_put_interface_async(serial->interface);
563 error_simple:
564 return retval;
567 static void sierra_indat_callback(struct urb *urb)
569 int err;
570 int endpoint;
571 struct usb_serial_port *port;
572 unsigned char *data = urb->transfer_buffer;
573 int status = urb->status;
575 endpoint = usb_pipeendpoint(urb->pipe);
576 port = urb->context;
578 if (status) {
579 dev_dbg(&port->dev, "%s: nonzero status: %d on"
580 " endpoint %02x\n", __func__, status, endpoint);
581 } else {
582 if (urb->actual_length) {
583 tty_insert_flip_string(&port->port, data,
584 urb->actual_length);
585 tty_flip_buffer_push(&port->port);
587 usb_serial_debug_data(&port->dev, __func__,
588 urb->actual_length, data);
589 } else {
590 dev_dbg(&port->dev, "%s: empty read urb"
591 " received\n", __func__);
595 /* Resubmit urb so we continue receiving */
596 if (status != -ESHUTDOWN && status != -EPERM) {
597 usb_mark_last_busy(port->serial->dev);
598 err = usb_submit_urb(urb, GFP_ATOMIC);
599 if (err && err != -EPERM)
600 dev_err(&port->dev, "resubmit read urb failed."
601 "(%d)\n", err);
605 static void sierra_instat_callback(struct urb *urb)
607 int err;
608 int status = urb->status;
609 struct usb_serial_port *port = urb->context;
610 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
611 struct usb_serial *serial = port->serial;
613 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
614 urb, port, portdata);
616 if (status == 0) {
617 struct usb_ctrlrequest *req_pkt =
618 (struct usb_ctrlrequest *)urb->transfer_buffer;
620 if (!req_pkt) {
621 dev_dbg(&port->dev, "%s: NULL req_pkt\n",
622 __func__);
623 return;
625 if ((req_pkt->bRequestType == 0xA1) &&
626 (req_pkt->bRequest == 0x20)) {
627 int old_dcd_state;
628 unsigned char signals = *((unsigned char *)
629 urb->transfer_buffer +
630 sizeof(struct usb_ctrlrequest));
631 struct tty_struct *tty;
633 dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
634 signals);
636 old_dcd_state = portdata->dcd_state;
637 portdata->cts_state = 1;
638 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
639 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
640 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
642 tty = tty_port_tty_get(&port->port);
643 if (tty && !C_CLOCAL(tty) &&
644 old_dcd_state && !portdata->dcd_state)
645 tty_hangup(tty);
646 tty_kref_put(tty);
647 } else {
648 dev_dbg(&port->dev, "%s: type %x req %x\n",
649 __func__, req_pkt->bRequestType,
650 req_pkt->bRequest);
652 } else
653 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
655 /* Resubmit urb so we continue receiving IRQ data */
656 if (status != -ESHUTDOWN && status != -ENOENT) {
657 usb_mark_last_busy(serial->dev);
658 err = usb_submit_urb(urb, GFP_ATOMIC);
659 if (err && err != -EPERM)
660 dev_err(&port->dev, "%s: resubmit intr urb "
661 "failed. (%d)\n", __func__, err);
665 static int sierra_write_room(struct tty_struct *tty)
667 struct usb_serial_port *port = tty->driver_data;
668 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
669 unsigned long flags;
671 /* try to give a good number back based on if we have any free urbs at
672 * this point in time */
673 spin_lock_irqsave(&portdata->lock, flags);
674 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
675 spin_unlock_irqrestore(&portdata->lock, flags);
676 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
677 return 0;
679 spin_unlock_irqrestore(&portdata->lock, flags);
681 return 2048;
684 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
686 int i;
687 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
689 for (i = 0; i < portdata->num_in_urbs; i++)
690 usb_kill_urb(portdata->in_urbs[i]);
692 usb_kill_urb(port->interrupt_in_urb);
695 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
697 int ok_cnt;
698 int err = -EINVAL;
699 int i;
700 struct urb *urb;
701 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
703 ok_cnt = 0;
704 for (i = 0; i < portdata->num_in_urbs; i++) {
705 urb = portdata->in_urbs[i];
706 if (!urb)
707 continue;
708 err = usb_submit_urb(urb, mem_flags);
709 if (err) {
710 dev_err(&port->dev, "%s: submit urb failed: %d\n",
711 __func__, err);
712 } else {
713 ok_cnt++;
717 if (ok_cnt && port->interrupt_in_urb) {
718 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
719 if (err) {
720 dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
721 __func__, err);
725 if (ok_cnt > 0) /* at least one rx urb submitted */
726 return 0;
727 else
728 return err;
731 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
732 int dir, void *ctx, int len,
733 gfp_t mem_flags,
734 usb_complete_t callback)
736 struct urb *urb;
737 u8 *buf;
739 if (endpoint == -1)
740 return NULL;
742 urb = usb_alloc_urb(0, mem_flags);
743 if (urb == NULL) {
744 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
745 __func__, endpoint);
746 return NULL;
749 buf = kmalloc(len, mem_flags);
750 if (buf) {
751 /* Fill URB using supplied data */
752 usb_fill_bulk_urb(urb, serial->dev,
753 usb_sndbulkpipe(serial->dev, endpoint) | dir,
754 buf, len, callback, ctx);
756 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
757 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
758 } else {
759 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
760 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
762 sierra_release_urb(urb);
763 urb = NULL;
766 return urb;
769 static void sierra_close(struct usb_serial_port *port)
771 int i;
772 struct usb_serial *serial = port->serial;
773 struct sierra_port_private *portdata;
774 struct sierra_intf_private *intfdata = port->serial->private;
776 portdata = usb_get_serial_port_data(port);
778 portdata->rts_state = 0;
779 portdata->dtr_state = 0;
781 if (serial->dev) {
782 mutex_lock(&serial->disc_mutex);
783 if (!serial->disconnected) {
784 serial->interface->needs_remote_wakeup = 0;
785 /* odd error handling due to pm counters */
786 if (!usb_autopm_get_interface(serial->interface))
787 sierra_send_setup(port);
788 else
789 usb_autopm_get_interface_no_resume(serial->interface);
792 mutex_unlock(&serial->disc_mutex);
793 spin_lock_irq(&intfdata->susp_lock);
794 portdata->opened = 0;
795 spin_unlock_irq(&intfdata->susp_lock);
798 /* Stop reading urbs */
799 sierra_stop_rx_urbs(port);
800 /* .. and release them */
801 for (i = 0; i < portdata->num_in_urbs; i++) {
802 sierra_release_urb(portdata->in_urbs[i]);
803 portdata->in_urbs[i] = NULL;
808 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
810 struct sierra_port_private *portdata;
811 struct usb_serial *serial = port->serial;
812 struct sierra_intf_private *intfdata = serial->private;
813 int i;
814 int err;
815 int endpoint;
816 struct urb *urb;
818 portdata = usb_get_serial_port_data(port);
820 /* Set some sane defaults */
821 portdata->rts_state = 1;
822 portdata->dtr_state = 1;
825 endpoint = port->bulk_in_endpointAddress;
826 for (i = 0; i < portdata->num_in_urbs; i++) {
827 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
828 IN_BUFLEN, GFP_KERNEL,
829 sierra_indat_callback);
830 portdata->in_urbs[i] = urb;
832 /* clear halt condition */
833 usb_clear_halt(serial->dev,
834 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
836 err = sierra_submit_rx_urbs(port, GFP_KERNEL);
837 if (err) {
838 /* get rid of everything as in close */
839 sierra_close(port);
840 /* restore balance for autopm */
841 if (!serial->disconnected)
842 usb_autopm_put_interface(serial->interface);
843 return err;
845 sierra_send_setup(port);
847 serial->interface->needs_remote_wakeup = 1;
848 spin_lock_irq(&intfdata->susp_lock);
849 portdata->opened = 1;
850 spin_unlock_irq(&intfdata->susp_lock);
851 usb_autopm_put_interface(serial->interface);
853 return 0;
857 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
859 struct sierra_port_private *portdata;
861 portdata = usb_get_serial_port_data(port);
862 portdata->rts_state = on;
863 portdata->dtr_state = on;
865 sierra_send_setup(port);
868 static int sierra_startup(struct usb_serial *serial)
870 struct sierra_intf_private *intfdata;
872 intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
873 if (!intfdata)
874 return -ENOMEM;
876 spin_lock_init(&intfdata->susp_lock);
878 usb_set_serial_data(serial, intfdata);
880 /* Set Device mode to D0 */
881 sierra_set_power_state(serial->dev, 0x0000);
883 /* Check NMEA and set */
884 if (nmea)
885 sierra_vsc_set_nmea(serial->dev, 1);
887 return 0;
890 static void sierra_release(struct usb_serial *serial)
892 struct sierra_intf_private *intfdata;
894 intfdata = usb_get_serial_data(serial);
895 kfree(intfdata);
898 static int sierra_port_probe(struct usb_serial_port *port)
900 struct usb_serial *serial = port->serial;
901 struct sierra_port_private *portdata;
902 const struct sierra_iface_info *himemoryp;
903 u8 ifnum;
905 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
906 if (!portdata)
907 return -ENOMEM;
909 spin_lock_init(&portdata->lock);
910 init_usb_anchor(&portdata->active);
911 init_usb_anchor(&portdata->delayed);
913 /* Assume low memory requirements */
914 portdata->num_out_urbs = N_OUT_URB;
915 portdata->num_in_urbs = N_IN_URB;
917 /* Determine actual memory requirements */
918 if (serial->num_ports == 1) {
919 /* Get interface number for composite device */
920 ifnum = sierra_calc_interface(serial);
921 himemoryp = &typeB_interface_list;
922 } else {
923 /* This is really the usb-serial port number of the interface
924 * rather than the interface number.
926 ifnum = port->number - serial->minor;
927 himemoryp = &typeA_interface_list;
930 if (is_himemory(ifnum, himemoryp)) {
931 portdata->num_out_urbs = N_OUT_URB_HM;
932 portdata->num_in_urbs = N_IN_URB_HM;
935 dev_dbg(&port->dev,
936 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
937 ifnum, portdata->num_in_urbs, portdata->num_out_urbs);
939 usb_set_serial_port_data(port, portdata);
941 return 0;
944 static int sierra_port_remove(struct usb_serial_port *port)
946 struct sierra_port_private *portdata;
948 portdata = usb_get_serial_port_data(port);
949 kfree(portdata);
951 return 0;
954 #ifdef CONFIG_PM
955 static void stop_read_write_urbs(struct usb_serial *serial)
957 int i;
958 struct usb_serial_port *port;
959 struct sierra_port_private *portdata;
961 /* Stop reading/writing urbs */
962 for (i = 0; i < serial->num_ports; ++i) {
963 port = serial->port[i];
964 portdata = usb_get_serial_port_data(port);
965 sierra_stop_rx_urbs(port);
966 usb_kill_anchored_urbs(&portdata->active);
970 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
972 struct sierra_intf_private *intfdata;
973 int b;
975 if (PMSG_IS_AUTO(message)) {
976 intfdata = serial->private;
977 spin_lock_irq(&intfdata->susp_lock);
978 b = intfdata->in_flight;
980 if (b) {
981 spin_unlock_irq(&intfdata->susp_lock);
982 return -EBUSY;
983 } else {
984 intfdata->suspended = 1;
985 spin_unlock_irq(&intfdata->susp_lock);
988 stop_read_write_urbs(serial);
990 return 0;
993 static int sierra_resume(struct usb_serial *serial)
995 struct usb_serial_port *port;
996 struct sierra_intf_private *intfdata = serial->private;
997 struct sierra_port_private *portdata;
998 struct urb *urb;
999 int ec = 0;
1000 int i, err;
1002 spin_lock_irq(&intfdata->susp_lock);
1003 for (i = 0; i < serial->num_ports; i++) {
1004 port = serial->port[i];
1005 portdata = usb_get_serial_port_data(port);
1007 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
1008 usb_anchor_urb(urb, &portdata->active);
1009 intfdata->in_flight++;
1010 err = usb_submit_urb(urb, GFP_ATOMIC);
1011 if (err < 0) {
1012 intfdata->in_flight--;
1013 usb_unanchor_urb(urb);
1014 usb_scuttle_anchored_urbs(&portdata->delayed);
1015 break;
1019 if (portdata->opened) {
1020 err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1021 if (err)
1022 ec++;
1025 intfdata->suspended = 0;
1026 spin_unlock_irq(&intfdata->susp_lock);
1028 return ec ? -EIO : 0;
1031 #else
1032 #define sierra_suspend NULL
1033 #define sierra_resume NULL
1034 #endif
1036 static struct usb_serial_driver sierra_device = {
1037 .driver = {
1038 .owner = THIS_MODULE,
1039 .name = "sierra",
1041 .description = "Sierra USB modem",
1042 .id_table = id_table,
1043 .calc_num_ports = sierra_calc_num_ports,
1044 .probe = sierra_probe,
1045 .open = sierra_open,
1046 .close = sierra_close,
1047 .dtr_rts = sierra_dtr_rts,
1048 .write = sierra_write,
1049 .write_room = sierra_write_room,
1050 .set_termios = sierra_set_termios,
1051 .tiocmget = sierra_tiocmget,
1052 .tiocmset = sierra_tiocmset,
1053 .attach = sierra_startup,
1054 .release = sierra_release,
1055 .port_probe = sierra_port_probe,
1056 .port_remove = sierra_port_remove,
1057 .suspend = sierra_suspend,
1058 .resume = sierra_resume,
1059 .read_int_callback = sierra_instat_callback,
1062 static struct usb_serial_driver * const serial_drivers[] = {
1063 &sierra_device, NULL
1066 module_usb_serial_driver(serial_drivers, id_table);
1068 MODULE_AUTHOR(DRIVER_AUTHOR);
1069 MODULE_DESCRIPTION(DRIVER_DESC);
1070 MODULE_LICENSE("GPL");
1072 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1073 MODULE_PARM_DESC(nmea, "NMEA streaming");