Adding support for MOXA ART SoC. Testing port of linux-2.6.32.60-moxart.
[linux-3.6.7-moxart.git] / drivers / usb / serial / sierra.c
blobcf6d149e3922504616d9deb54722dd6c7e253ddc
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 */
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
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 debug;
50 static bool nmea;
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 {
59 spinlock_t susp_lock;
60 unsigned int suspended:1;
61 int in_flight;
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 */
70 0, /* __u16 index */
71 NULL, /* void *data */
72 0, /* __u16 size */
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 */
84 0, /* __u16 size */
85 USB_CTRL_SET_TIMEOUT); /* int timeout */
88 static int sierra_calc_num_ports(struct usb_serial *serial)
90 int num_ports = 0;
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 */
97 if (ifnum == 0x99)
98 num_ports = 0;
99 else if (numendpoints <= 3)
100 num_ports = 1;
101 else
102 num_ports = (numendpoints-1)/2;
103 return num_ports;
106 static int is_blacklisted(const u8 ifnum,
107 const struct sierra_iface_info *blacklist)
109 const u8 *info;
110 int i;
112 if (blacklist) {
113 info = blacklist->ifaceinfo;
115 for (i = 0; i < blacklist->infolen; i++) {
116 if (info[i] == ifnum)
117 return 1;
120 return 0;
123 static int is_himemory(const u8 ifnum,
124 const struct sierra_iface_info *himemorylist)
126 const u8 *info;
127 int i;
129 if (himemorylist) {
130 info = himemorylist->ifaceinfo;
132 for (i=0; i < himemorylist->infolen; i++) {
133 if (info[i] == ifnum)
134 return 1;
137 return 0;
140 static int sierra_calc_interface(struct usb_serial *serial)
142 int interface;
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;
157 return interface;
160 static int sierra_probe(struct usb_serial *serial,
161 const struct usb_device_id *id)
163 int result = 0;
164 struct usb_device *udev;
165 u8 ifnum;
167 udev = serial->dev;
168 ifnum = sierra_calc_interface(serial);
171 * If this interface supports more than 1 alternate
172 * select the 2nd one
174 if (serial->interface->num_altsetting == 2) {
175 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
176 ifnum);
177 /* We know the alternate setting is 1 for the MC8785 */
178 usb_set_interface(udev, ifnum, 1);
181 /* ifnum could have changed - by calling usb_set_interface */
182 ifnum = sierra_calc_interface(serial);
184 if (is_blacklisted(ifnum,
185 (struct sierra_iface_info *)id->driver_info)) {
186 dev_dbg(&serial->dev->dev,
187 "Ignoring blacklisted interface #%d\n", ifnum);
188 return -ENODEV;
191 return result;
194 /* interfaces with higher memory requirements */
195 static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
196 static const struct sierra_iface_info typeA_interface_list = {
197 .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
198 .ifaceinfo = hi_memory_typeA_ifaces,
201 static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
202 static const struct sierra_iface_info typeB_interface_list = {
203 .infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
204 .ifaceinfo = hi_memory_typeB_ifaces,
207 /* 'blacklist' of interfaces not served by this driver */
208 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11, 19, 20 };
209 static const struct sierra_iface_info direct_ip_interface_blacklist = {
210 .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
211 .ifaceinfo = direct_ip_non_serial_ifaces,
214 static const struct usb_device_id id_table[] = {
215 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
216 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
217 { USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
218 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
220 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
221 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
222 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
223 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
224 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
225 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
226 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
227 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
228 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
229 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
230 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
231 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
232 { USB_DEVICE(0x1199, 0x0301) }, /* Sierra Wireless USB Dongle 250U */
233 /* Sierra Wireless C597 */
234 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
235 /* Sierra Wireless T598 */
236 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
237 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
238 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
239 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
240 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
242 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
243 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
244 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
245 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
246 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
247 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
248 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
249 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
250 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
251 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
252 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
253 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
254 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
255 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
256 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
257 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
258 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
259 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
260 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
261 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
262 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
263 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
264 { USB_DEVICE(0x1199, 0x683C) },
265 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
266 /* Sierra Wireless MC8790, MC8791, MC8792 */
267 { USB_DEVICE(0x1199, 0x683E) },
268 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
269 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
270 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
271 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
272 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
273 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
274 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
275 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
276 /* Sierra Wireless C885 */
277 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
278 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
279 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
280 /* Sierra Wireless C22/C33 */
281 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
282 /* Sierra Wireless HSPA Non-Composite Device */
283 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
284 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
285 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */
286 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
288 /* AT&T Direct IP LTE modems */
289 { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
290 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
292 { USB_DEVICE(0x0f3d, 0x68A3), /* Airprime/Sierra Wireless Direct IP modems */
293 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
295 { USB_DEVICE(0x413C, 0x08133) }, /* Dell Computer Corp. Wireless 5720 VZW Mobile Broadband (EVDO Rev-A) Minicard GPS Port */
299 MODULE_DEVICE_TABLE(usb, id_table);
302 struct sierra_port_private {
303 spinlock_t lock; /* lock the structure */
304 int outstanding_urbs; /* number of out urbs in flight */
305 struct usb_anchor active;
306 struct usb_anchor delayed;
308 int num_out_urbs;
309 int num_in_urbs;
310 /* Input endpoints and buffers for this port */
311 struct urb *in_urbs[N_IN_URB_HM];
313 /* Settings for the port */
314 int rts_state; /* Handshaking pins (outputs) */
315 int dtr_state;
316 int cts_state; /* Handshaking pins (inputs) */
317 int dsr_state;
318 int dcd_state;
319 int ri_state;
320 unsigned int opened:1;
323 static int sierra_send_setup(struct usb_serial_port *port)
325 struct usb_serial *serial = port->serial;
326 struct sierra_port_private *portdata;
327 __u16 interface = 0;
328 int val = 0;
329 int do_send = 0;
330 int retval;
332 portdata = usb_get_serial_port_data(port);
334 if (portdata->dtr_state)
335 val |= 0x01;
336 if (portdata->rts_state)
337 val |= 0x02;
339 /* If composite device then properly report interface */
340 if (serial->num_ports == 1) {
341 interface = sierra_calc_interface(serial);
342 /* Control message is sent only to interfaces with
343 * interrupt_in endpoints
345 if (port->interrupt_in_urb) {
346 /* send control message */
347 do_send = 1;
351 /* Otherwise the need to do non-composite mapping */
352 else {
353 if (port->bulk_out_endpointAddress == 2)
354 interface = 0;
355 else if (port->bulk_out_endpointAddress == 4)
356 interface = 1;
357 else if (port->bulk_out_endpointAddress == 5)
358 interface = 2;
360 do_send = 1;
362 if (!do_send)
363 return 0;
365 retval = usb_autopm_get_interface(serial->interface);
366 if (retval < 0)
367 return retval;
369 retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
370 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
371 usb_autopm_put_interface(serial->interface);
373 return retval;
376 static void sierra_set_termios(struct tty_struct *tty,
377 struct usb_serial_port *port, struct ktermios *old_termios)
379 tty_termios_copy_hw(tty->termios, old_termios);
380 sierra_send_setup(port);
383 static int sierra_tiocmget(struct tty_struct *tty)
385 struct usb_serial_port *port = tty->driver_data;
386 unsigned int value;
387 struct sierra_port_private *portdata;
389 portdata = usb_get_serial_port_data(port);
391 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
392 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
393 ((portdata->cts_state) ? TIOCM_CTS : 0) |
394 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
395 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
396 ((portdata->ri_state) ? TIOCM_RNG : 0);
398 return value;
401 static int sierra_tiocmset(struct tty_struct *tty,
402 unsigned int set, unsigned int clear)
404 struct usb_serial_port *port = tty->driver_data;
405 struct sierra_port_private *portdata;
407 portdata = usb_get_serial_port_data(port);
409 if (set & TIOCM_RTS)
410 portdata->rts_state = 1;
411 if (set & TIOCM_DTR)
412 portdata->dtr_state = 1;
414 if (clear & TIOCM_RTS)
415 portdata->rts_state = 0;
416 if (clear & TIOCM_DTR)
417 portdata->dtr_state = 0;
418 return sierra_send_setup(port);
421 static void sierra_release_urb(struct urb *urb)
423 struct usb_serial_port *port;
424 if (urb) {
425 port = urb->context;
426 kfree(urb->transfer_buffer);
427 usb_free_urb(urb);
431 static void sierra_outdat_callback(struct urb *urb)
433 struct usb_serial_port *port = urb->context;
434 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
435 struct sierra_intf_private *intfdata;
436 int status = urb->status;
438 intfdata = port->serial->private;
440 /* free up the transfer buffer, as usb_free_urb() does not do this */
441 kfree(urb->transfer_buffer);
442 usb_autopm_put_interface_async(port->serial->interface);
443 if (status)
444 dev_dbg(&port->dev, "%s - nonzero write bulk status "
445 "received: %d\n", __func__, status);
447 spin_lock(&portdata->lock);
448 --portdata->outstanding_urbs;
449 spin_unlock(&portdata->lock);
450 spin_lock(&intfdata->susp_lock);
451 --intfdata->in_flight;
452 spin_unlock(&intfdata->susp_lock);
454 usb_serial_port_softint(port);
457 /* Write */
458 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
459 const unsigned char *buf, int count)
461 struct sierra_port_private *portdata;
462 struct sierra_intf_private *intfdata;
463 struct usb_serial *serial = port->serial;
464 unsigned long flags;
465 unsigned char *buffer;
466 struct urb *urb;
467 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
468 int retval = 0;
470 /* verify that we actually have some data to write */
471 if (count == 0)
472 return 0;
474 portdata = usb_get_serial_port_data(port);
475 intfdata = serial->private;
477 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
478 spin_lock_irqsave(&portdata->lock, flags);
479 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
480 portdata->outstanding_urbs);
481 if (portdata->outstanding_urbs > portdata->num_out_urbs) {
482 spin_unlock_irqrestore(&portdata->lock, flags);
483 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
484 return 0;
486 portdata->outstanding_urbs++;
487 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
488 portdata->outstanding_urbs);
489 spin_unlock_irqrestore(&portdata->lock, flags);
491 retval = usb_autopm_get_interface_async(serial->interface);
492 if (retval < 0) {
493 spin_lock_irqsave(&portdata->lock, flags);
494 portdata->outstanding_urbs--;
495 spin_unlock_irqrestore(&portdata->lock, flags);
496 goto error_simple;
499 buffer = kmalloc(writesize, GFP_ATOMIC);
500 if (!buffer) {
501 dev_err(&port->dev, "out of memory\n");
502 retval = -ENOMEM;
503 goto error_no_buffer;
506 urb = usb_alloc_urb(0, GFP_ATOMIC);
507 if (!urb) {
508 dev_err(&port->dev, "no more free urbs\n");
509 retval = -ENOMEM;
510 goto error_no_urb;
513 memcpy(buffer, buf, writesize);
515 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
517 usb_fill_bulk_urb(urb, serial->dev,
518 usb_sndbulkpipe(serial->dev,
519 port->bulk_out_endpointAddress),
520 buffer, writesize, sierra_outdat_callback, port);
522 /* Handle the need to send a zero length packet */
523 urb->transfer_flags |= URB_ZERO_PACKET;
525 spin_lock_irqsave(&intfdata->susp_lock, flags);
527 if (intfdata->suspended) {
528 usb_anchor_urb(urb, &portdata->delayed);
529 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
530 goto skip_power;
531 } else {
532 usb_anchor_urb(urb, &portdata->active);
534 /* send it down the pipe */
535 retval = usb_submit_urb(urb, GFP_ATOMIC);
536 if (retval) {
537 usb_unanchor_urb(urb);
538 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
539 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
540 "with status = %d\n", __func__, retval);
541 goto error;
542 } else {
543 intfdata->in_flight++;
544 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
547 skip_power:
548 /* we are done with this urb, so let the host driver
549 * really free it when it is finished with it */
550 usb_free_urb(urb);
552 return writesize;
553 error:
554 usb_free_urb(urb);
555 error_no_urb:
556 kfree(buffer);
557 error_no_buffer:
558 spin_lock_irqsave(&portdata->lock, flags);
559 --portdata->outstanding_urbs;
560 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
561 portdata->outstanding_urbs);
562 spin_unlock_irqrestore(&portdata->lock, flags);
563 usb_autopm_put_interface_async(serial->interface);
564 error_simple:
565 return retval;
568 static void sierra_indat_callback(struct urb *urb)
570 int err;
571 int endpoint;
572 struct usb_serial_port *port;
573 struct tty_struct *tty;
574 unsigned char *data = urb->transfer_buffer;
575 int status = urb->status;
577 endpoint = usb_pipeendpoint(urb->pipe);
578 port = urb->context;
580 if (status) {
581 dev_dbg(&port->dev, "%s: nonzero status: %d on"
582 " endpoint %02x\n", __func__, status, endpoint);
583 } else {
584 if (urb->actual_length) {
585 tty = tty_port_tty_get(&port->port);
586 if (tty) {
587 tty_insert_flip_string(tty, data,
588 urb->actual_length);
589 tty_flip_buffer_push(tty);
591 tty_kref_put(tty);
592 usb_serial_debug_data(debug, &port->dev,
593 __func__, urb->actual_length, data);
595 } else {
596 dev_dbg(&port->dev, "%s: empty read urb"
597 " received\n", __func__);
601 /* Resubmit urb so we continue receiving */
602 if (status != -ESHUTDOWN && status != -EPERM) {
603 usb_mark_last_busy(port->serial->dev);
604 err = usb_submit_urb(urb, GFP_ATOMIC);
605 if (err && err != -EPERM)
606 dev_err(&port->dev, "resubmit read urb failed."
607 "(%d)\n", err);
611 static void sierra_instat_callback(struct urb *urb)
613 int err;
614 int status = urb->status;
615 struct usb_serial_port *port = urb->context;
616 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
617 struct usb_serial *serial = port->serial;
619 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
620 urb, port, portdata);
622 if (status == 0) {
623 struct usb_ctrlrequest *req_pkt =
624 (struct usb_ctrlrequest *)urb->transfer_buffer;
626 if (!req_pkt) {
627 dev_dbg(&port->dev, "%s: NULL req_pkt\n",
628 __func__);
629 return;
631 if ((req_pkt->bRequestType == 0xA1) &&
632 (req_pkt->bRequest == 0x20)) {
633 int old_dcd_state;
634 unsigned char signals = *((unsigned char *)
635 urb->transfer_buffer +
636 sizeof(struct usb_ctrlrequest));
637 struct tty_struct *tty;
639 dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
640 signals);
642 old_dcd_state = portdata->dcd_state;
643 portdata->cts_state = 1;
644 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
645 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
646 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
648 tty = tty_port_tty_get(&port->port);
649 if (tty && !C_CLOCAL(tty) &&
650 old_dcd_state && !portdata->dcd_state)
651 tty_hangup(tty);
652 tty_kref_put(tty);
653 } else {
654 dev_dbg(&port->dev, "%s: type %x req %x\n",
655 __func__, req_pkt->bRequestType,
656 req_pkt->bRequest);
658 } else
659 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
661 /* Resubmit urb so we continue receiving IRQ data */
662 if (status != -ESHUTDOWN && status != -ENOENT) {
663 usb_mark_last_busy(serial->dev);
664 err = usb_submit_urb(urb, GFP_ATOMIC);
665 if (err && err != -EPERM)
666 dev_err(&port->dev, "%s: resubmit intr urb "
667 "failed. (%d)\n", __func__, err);
671 static int sierra_write_room(struct tty_struct *tty)
673 struct usb_serial_port *port = tty->driver_data;
674 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
675 unsigned long flags;
677 /* try to give a good number back based on if we have any free urbs at
678 * this point in time */
679 spin_lock_irqsave(&portdata->lock, flags);
680 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
681 spin_unlock_irqrestore(&portdata->lock, flags);
682 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
683 return 0;
685 spin_unlock_irqrestore(&portdata->lock, flags);
687 return 2048;
690 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
692 int i;
693 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
695 for (i = 0; i < portdata->num_in_urbs; i++)
696 usb_kill_urb(portdata->in_urbs[i]);
698 usb_kill_urb(port->interrupt_in_urb);
701 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
703 int ok_cnt;
704 int err = -EINVAL;
705 int i;
706 struct urb *urb;
707 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
709 ok_cnt = 0;
710 for (i = 0; i < portdata->num_in_urbs; i++) {
711 urb = portdata->in_urbs[i];
712 if (!urb)
713 continue;
714 err = usb_submit_urb(urb, mem_flags);
715 if (err) {
716 dev_err(&port->dev, "%s: submit urb failed: %d\n",
717 __func__, err);
718 } else {
719 ok_cnt++;
723 if (ok_cnt && port->interrupt_in_urb) {
724 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
725 if (err) {
726 dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
727 __func__, err);
731 if (ok_cnt > 0) /* at least one rx urb submitted */
732 return 0;
733 else
734 return err;
737 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
738 int dir, void *ctx, int len,
739 gfp_t mem_flags,
740 usb_complete_t callback)
742 struct urb *urb;
743 u8 *buf;
745 if (endpoint == -1)
746 return NULL;
748 urb = usb_alloc_urb(0, mem_flags);
749 if (urb == NULL) {
750 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
751 __func__, endpoint);
752 return NULL;
755 buf = kmalloc(len, mem_flags);
756 if (buf) {
757 /* Fill URB using supplied data */
758 usb_fill_bulk_urb(urb, serial->dev,
759 usb_sndbulkpipe(serial->dev, endpoint) | dir,
760 buf, len, callback, ctx);
762 /* debug */
763 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
764 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
765 } else {
766 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
767 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
769 sierra_release_urb(urb);
770 urb = NULL;
773 return urb;
776 static void sierra_close(struct usb_serial_port *port)
778 int i;
779 struct usb_serial *serial = port->serial;
780 struct sierra_port_private *portdata;
781 struct sierra_intf_private *intfdata = port->serial->private;
783 portdata = usb_get_serial_port_data(port);
785 portdata->rts_state = 0;
786 portdata->dtr_state = 0;
788 if (serial->dev) {
789 mutex_lock(&serial->disc_mutex);
790 if (!serial->disconnected) {
791 serial->interface->needs_remote_wakeup = 0;
792 /* odd error handling due to pm counters */
793 if (!usb_autopm_get_interface(serial->interface))
794 sierra_send_setup(port);
795 else
796 usb_autopm_get_interface_no_resume(serial->interface);
799 mutex_unlock(&serial->disc_mutex);
800 spin_lock_irq(&intfdata->susp_lock);
801 portdata->opened = 0;
802 spin_unlock_irq(&intfdata->susp_lock);
805 /* Stop reading urbs */
806 sierra_stop_rx_urbs(port);
807 /* .. and release them */
808 for (i = 0; i < portdata->num_in_urbs; i++) {
809 sierra_release_urb(portdata->in_urbs[i]);
810 portdata->in_urbs[i] = NULL;
815 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
817 struct sierra_port_private *portdata;
818 struct usb_serial *serial = port->serial;
819 struct sierra_intf_private *intfdata = serial->private;
820 int i;
821 int err;
822 int endpoint;
823 struct urb *urb;
825 portdata = usb_get_serial_port_data(port);
827 /* Set some sane defaults */
828 portdata->rts_state = 1;
829 portdata->dtr_state = 1;
832 endpoint = port->bulk_in_endpointAddress;
833 for (i = 0; i < portdata->num_in_urbs; i++) {
834 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
835 IN_BUFLEN, GFP_KERNEL,
836 sierra_indat_callback);
837 portdata->in_urbs[i] = urb;
839 /* clear halt condition */
840 usb_clear_halt(serial->dev,
841 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
843 err = sierra_submit_rx_urbs(port, GFP_KERNEL);
844 if (err) {
845 /* get rid of everything as in close */
846 sierra_close(port);
847 /* restore balance for autopm */
848 if (!serial->disconnected)
849 usb_autopm_put_interface(serial->interface);
850 return err;
852 sierra_send_setup(port);
854 serial->interface->needs_remote_wakeup = 1;
855 spin_lock_irq(&intfdata->susp_lock);
856 portdata->opened = 1;
857 spin_unlock_irq(&intfdata->susp_lock);
858 usb_autopm_put_interface(serial->interface);
860 return 0;
864 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
866 struct usb_serial *serial = port->serial;
867 struct sierra_port_private *portdata;
869 portdata = usb_get_serial_port_data(port);
870 portdata->rts_state = on;
871 portdata->dtr_state = on;
873 if (serial->dev) {
874 mutex_lock(&serial->disc_mutex);
875 if (!serial->disconnected)
876 sierra_send_setup(port);
877 mutex_unlock(&serial->disc_mutex);
881 static int sierra_startup(struct usb_serial *serial)
883 struct sierra_intf_private *intfdata;
885 intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
886 if (!intfdata)
887 return -ENOMEM;
889 spin_lock_init(&intfdata->susp_lock);
891 usb_set_serial_data(serial, intfdata);
893 /* Set Device mode to D0 */
894 sierra_set_power_state(serial->dev, 0x0000);
896 /* Check NMEA and set */
897 if (nmea)
898 sierra_vsc_set_nmea(serial->dev, 1);
900 return 0;
903 static void sierra_release(struct usb_serial *serial)
905 struct sierra_intf_private *intfdata;
907 intfdata = usb_get_serial_data(serial);
908 kfree(intfdata);
911 static int sierra_port_probe(struct usb_serial_port *port)
913 struct usb_serial *serial = port->serial;
914 struct sierra_port_private *portdata;
915 const struct sierra_iface_info *himemoryp;
916 u8 ifnum;
918 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
919 if (!portdata)
920 return -ENOMEM;
922 spin_lock_init(&portdata->lock);
923 init_usb_anchor(&portdata->active);
924 init_usb_anchor(&portdata->delayed);
926 /* Assume low memory requirements */
927 portdata->num_out_urbs = N_OUT_URB;
928 portdata->num_in_urbs = N_IN_URB;
930 /* Determine actual memory requirements */
931 if (serial->num_ports == 1) {
932 /* Get interface number for composite device */
933 ifnum = sierra_calc_interface(serial);
934 himemoryp = &typeB_interface_list;
935 } else {
936 /* This is really the usb-serial port number of the interface
937 * rather than the interface number.
939 ifnum = port->number - serial->minor;
940 himemoryp = &typeA_interface_list;
943 if (is_himemory(ifnum, himemoryp)) {
944 portdata->num_out_urbs = N_OUT_URB_HM;
945 portdata->num_in_urbs = N_IN_URB_HM;
948 dev_dbg(&port->dev,
949 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
950 ifnum, portdata->num_in_urbs, portdata->num_out_urbs);
952 usb_set_serial_port_data(port, portdata);
954 return 0;
957 static int sierra_port_remove(struct usb_serial_port *port)
959 struct sierra_port_private *portdata;
961 portdata = usb_get_serial_port_data(port);
962 kfree(portdata);
964 return 0;
967 #ifdef CONFIG_PM
968 static void stop_read_write_urbs(struct usb_serial *serial)
970 int i;
971 struct usb_serial_port *port;
972 struct sierra_port_private *portdata;
974 /* Stop reading/writing urbs */
975 for (i = 0; i < serial->num_ports; ++i) {
976 port = serial->port[i];
977 portdata = usb_get_serial_port_data(port);
978 sierra_stop_rx_urbs(port);
979 usb_kill_anchored_urbs(&portdata->active);
983 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
985 struct sierra_intf_private *intfdata;
986 int b;
988 if (PMSG_IS_AUTO(message)) {
989 intfdata = serial->private;
990 spin_lock_irq(&intfdata->susp_lock);
991 b = intfdata->in_flight;
993 if (b) {
994 spin_unlock_irq(&intfdata->susp_lock);
995 return -EBUSY;
996 } else {
997 intfdata->suspended = 1;
998 spin_unlock_irq(&intfdata->susp_lock);
1001 stop_read_write_urbs(serial);
1003 return 0;
1006 static int sierra_resume(struct usb_serial *serial)
1008 struct usb_serial_port *port;
1009 struct sierra_intf_private *intfdata = serial->private;
1010 struct sierra_port_private *portdata;
1011 struct urb *urb;
1012 int ec = 0;
1013 int i, err;
1015 spin_lock_irq(&intfdata->susp_lock);
1016 for (i = 0; i < serial->num_ports; i++) {
1017 port = serial->port[i];
1018 portdata = usb_get_serial_port_data(port);
1020 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
1021 usb_anchor_urb(urb, &portdata->active);
1022 intfdata->in_flight++;
1023 err = usb_submit_urb(urb, GFP_ATOMIC);
1024 if (err < 0) {
1025 intfdata->in_flight--;
1026 usb_unanchor_urb(urb);
1027 usb_scuttle_anchored_urbs(&portdata->delayed);
1028 break;
1032 if (portdata->opened) {
1033 err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1034 if (err)
1035 ec++;
1038 intfdata->suspended = 0;
1039 spin_unlock_irq(&intfdata->susp_lock);
1041 return ec ? -EIO : 0;
1044 #else
1045 #define sierra_suspend NULL
1046 #define sierra_resume NULL
1047 #endif
1049 static struct usb_serial_driver sierra_device = {
1050 .driver = {
1051 .owner = THIS_MODULE,
1052 .name = "sierra",
1054 .description = "Sierra USB modem",
1055 .id_table = id_table,
1056 .calc_num_ports = sierra_calc_num_ports,
1057 .probe = sierra_probe,
1058 .open = sierra_open,
1059 .close = sierra_close,
1060 .dtr_rts = sierra_dtr_rts,
1061 .write = sierra_write,
1062 .write_room = sierra_write_room,
1063 .set_termios = sierra_set_termios,
1064 .tiocmget = sierra_tiocmget,
1065 .tiocmset = sierra_tiocmset,
1066 .attach = sierra_startup,
1067 .release = sierra_release,
1068 .port_probe = sierra_port_probe,
1069 .port_remove = sierra_port_remove,
1070 .suspend = sierra_suspend,
1071 .resume = sierra_resume,
1072 .read_int_callback = sierra_instat_callback,
1075 static struct usb_serial_driver * const serial_drivers[] = {
1076 &sierra_device, NULL
1079 module_usb_serial_driver(serial_drivers, id_table);
1081 MODULE_AUTHOR(DRIVER_AUTHOR);
1082 MODULE_DESCRIPTION(DRIVER_DESC);
1083 MODULE_VERSION(DRIVER_VERSION);
1084 MODULE_LICENSE("GPL");
1086 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1087 MODULE_PARM_DESC(nmea, "NMEA streaming");
1089 module_param(debug, bool, S_IRUGO | S_IWUSR);
1090 MODULE_PARM_DESC(debug, "Debug messages");