Merge branch 'perf/urgent' into perf/core
[linux-2.6/kvm.git] / drivers / usb / serial / sierra.c
blobac1b6449fb6abc779f6904cd4899508f466426de
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/tty_flip.h>
30 #include <linux/module.h>
31 #include <linux/usb.h>
32 #include <linux/usb/serial.h>
34 #define SWIMS_USB_REQUEST_SetPower 0x00
35 #define SWIMS_USB_REQUEST_SetNmea 0x07
37 #define N_IN_URB_HM 8
38 #define N_OUT_URB_HM 64
39 #define N_IN_URB 4
40 #define N_OUT_URB 4
41 #define IN_BUFLEN 4096
43 #define MAX_TRANSFER (PAGE_SIZE - 512)
44 /* MAX_TRANSFER is chosen so that the VM is not stressed by
45 allocations > PAGE_SIZE and the number of packets in a page
46 is an integer 512 is the largest possible packet on EHCI */
48 static int debug;
49 static int 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 int result;
66 dev_dbg(&udev->dev, "%s\n", __func__);
67 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
68 SWIMS_USB_REQUEST_SetPower, /* __u8 request */
69 USB_TYPE_VENDOR, /* __u8 request type */
70 swiState, /* __u16 value */
71 0, /* __u16 index */
72 NULL, /* void *data */
73 0, /* __u16 size */
74 USB_CTRL_SET_TIMEOUT); /* int timeout */
75 return result;
78 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
80 int result;
81 dev_dbg(&udev->dev, "%s\n", __func__);
82 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
83 SWIMS_USB_REQUEST_SetNmea, /* __u8 request */
84 USB_TYPE_VENDOR, /* __u8 request type */
85 enable, /* __u16 value */
86 0x0000, /* __u16 index */
87 NULL, /* void *data */
88 0, /* __u16 size */
89 USB_CTRL_SET_TIMEOUT); /* int timeout */
90 return result;
93 static int sierra_calc_num_ports(struct usb_serial *serial)
95 int num_ports = 0;
96 u8 ifnum, numendpoints;
98 dev_dbg(&serial->dev->dev, "%s\n", __func__);
100 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
101 numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
103 /* Dummy interface present on some SKUs should be ignored */
104 if (ifnum == 0x99)
105 num_ports = 0;
106 else if (numendpoints <= 3)
107 num_ports = 1;
108 else
109 num_ports = (numendpoints-1)/2;
110 return num_ports;
113 static int is_blacklisted(const u8 ifnum,
114 const struct sierra_iface_info *blacklist)
116 const u8 *info;
117 int i;
119 if (blacklist) {
120 info = blacklist->ifaceinfo;
122 for (i = 0; i < blacklist->infolen; i++) {
123 if (info[i] == ifnum)
124 return 1;
127 return 0;
130 static int is_himemory(const u8 ifnum,
131 const struct sierra_iface_info *himemorylist)
133 const u8 *info;
134 int i;
136 if (himemorylist) {
137 info = himemorylist->ifaceinfo;
139 for (i=0; i < himemorylist->infolen; i++) {
140 if (info[i] == ifnum)
141 return 1;
144 return 0;
147 static int sierra_calc_interface(struct usb_serial *serial)
149 int interface;
150 struct usb_interface *p_interface;
151 struct usb_host_interface *p_host_interface;
152 dev_dbg(&serial->dev->dev, "%s\n", __func__);
154 /* Get the interface structure pointer from the serial struct */
155 p_interface = serial->interface;
157 /* Get a pointer to the host interface structure */
158 p_host_interface = p_interface->cur_altsetting;
160 /* read the interface descriptor for this active altsetting
161 * to find out the interface number we are on
163 interface = p_host_interface->desc.bInterfaceNumber;
165 return interface;
168 static int sierra_probe(struct usb_serial *serial,
169 const struct usb_device_id *id)
171 int result = 0;
172 struct usb_device *udev;
173 struct sierra_intf_private *data;
174 u8 ifnum;
176 udev = serial->dev;
177 dev_dbg(&udev->dev, "%s\n", __func__);
179 ifnum = sierra_calc_interface(serial);
181 * If this interface supports more than 1 alternate
182 * select the 2nd one
184 if (serial->interface->num_altsetting == 2) {
185 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
186 ifnum);
187 /* We know the alternate setting is 1 for the MC8785 */
188 usb_set_interface(udev, ifnum, 1);
191 /* ifnum could have changed - by calling usb_set_interface */
192 ifnum = sierra_calc_interface(serial);
194 if (is_blacklisted(ifnum,
195 (struct sierra_iface_info *)id->driver_info)) {
196 dev_dbg(&serial->dev->dev,
197 "Ignoring blacklisted interface #%d\n", ifnum);
198 return -ENODEV;
201 data = serial->private = kzalloc(sizeof(struct sierra_intf_private), GFP_KERNEL);
202 if (!data)
203 return -ENOMEM;
204 spin_lock_init(&data->susp_lock);
206 return result;
209 /* interfaces with higher memory requirements */
210 static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
211 static const struct sierra_iface_info typeA_interface_list = {
212 .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
213 .ifaceinfo = hi_memory_typeA_ifaces,
216 static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
217 static const struct sierra_iface_info typeB_interface_list = {
218 .infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
219 .ifaceinfo = hi_memory_typeB_ifaces,
222 /* 'blacklist' of interfaces not served by this driver */
223 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11 };
224 static const struct sierra_iface_info direct_ip_interface_blacklist = {
225 .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
226 .ifaceinfo = direct_ip_non_serial_ifaces,
229 static struct usb_device_id id_table [] = {
230 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
231 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
232 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
234 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
235 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
236 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
237 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
238 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
239 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
240 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
241 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
242 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
243 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
244 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
245 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
246 /* Sierra Wireless C597 */
247 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
248 /* Sierra Wireless T598 */
249 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
250 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
251 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
252 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
253 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
255 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
256 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
257 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
258 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
259 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
260 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
261 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
262 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
263 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
264 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
265 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
266 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
267 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
268 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
269 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
270 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
271 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
272 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
273 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
274 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
275 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
276 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
277 { USB_DEVICE(0x1199, 0x683C) },
278 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
279 /* Sierra Wireless MC8790, MC8791, MC8792 */
280 { USB_DEVICE(0x1199, 0x683E) },
281 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
282 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
283 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
284 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
285 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
286 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
287 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
288 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
289 /* Sierra Wireless C885 */
290 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
291 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
292 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
293 /* Sierra Wireless C22/C33 */
294 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
295 /* Sierra Wireless HSPA Non-Composite Device */
296 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
297 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
298 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */
299 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
304 MODULE_DEVICE_TABLE(usb, id_table);
306 static struct usb_driver sierra_driver = {
307 .name = "sierra",
308 .probe = usb_serial_probe,
309 .disconnect = usb_serial_disconnect,
310 .suspend = usb_serial_suspend,
311 .resume = usb_serial_resume,
312 .id_table = id_table,
313 .no_dynamic_id = 1,
314 .supports_autosuspend = 1,
317 struct sierra_port_private {
318 spinlock_t lock; /* lock the structure */
319 int outstanding_urbs; /* number of out urbs in flight */
320 struct usb_anchor active;
321 struct usb_anchor delayed;
323 int num_out_urbs;
324 int num_in_urbs;
325 /* Input endpoints and buffers for this port */
326 struct urb *in_urbs[N_IN_URB_HM];
328 /* Settings for the port */
329 int rts_state; /* Handshaking pins (outputs) */
330 int dtr_state;
331 int cts_state; /* Handshaking pins (inputs) */
332 int dsr_state;
333 int dcd_state;
334 int ri_state;
335 unsigned int opened:1;
338 static int sierra_send_setup(struct usb_serial_port *port)
340 struct usb_serial *serial = port->serial;
341 struct sierra_port_private *portdata;
342 __u16 interface = 0;
343 int val = 0;
344 int do_send = 0;
345 int retval;
347 dev_dbg(&port->dev, "%s\n", __func__);
349 portdata = usb_get_serial_port_data(port);
351 if (portdata->dtr_state)
352 val |= 0x01;
353 if (portdata->rts_state)
354 val |= 0x02;
356 /* If composite device then properly report interface */
357 if (serial->num_ports == 1) {
358 interface = sierra_calc_interface(serial);
359 /* Control message is sent only to interfaces with
360 * interrupt_in endpoints
362 if (port->interrupt_in_urb) {
363 /* send control message */
364 do_send = 1;
368 /* Otherwise the need to do non-composite mapping */
369 else {
370 if (port->bulk_out_endpointAddress == 2)
371 interface = 0;
372 else if (port->bulk_out_endpointAddress == 4)
373 interface = 1;
374 else if (port->bulk_out_endpointAddress == 5)
375 interface = 2;
377 do_send = 1;
379 if (!do_send)
380 return 0;
382 usb_autopm_get_interface(serial->interface);
383 retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
384 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
385 usb_autopm_put_interface(serial->interface);
387 return retval;
390 static void sierra_set_termios(struct tty_struct *tty,
391 struct usb_serial_port *port, struct ktermios *old_termios)
393 dev_dbg(&port->dev, "%s\n", __func__);
394 tty_termios_copy_hw(tty->termios, old_termios);
395 sierra_send_setup(port);
398 static int sierra_tiocmget(struct tty_struct *tty, struct file *file)
400 struct usb_serial_port *port = tty->driver_data;
401 unsigned int value;
402 struct sierra_port_private *portdata;
404 dev_dbg(&port->dev, "%s\n", __func__);
405 portdata = usb_get_serial_port_data(port);
407 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
408 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
409 ((portdata->cts_state) ? TIOCM_CTS : 0) |
410 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
411 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
412 ((portdata->ri_state) ? TIOCM_RNG : 0);
414 return value;
417 static int sierra_tiocmset(struct tty_struct *tty, struct file *file,
418 unsigned int set, unsigned int clear)
420 struct usb_serial_port *port = tty->driver_data;
421 struct sierra_port_private *portdata;
423 portdata = usb_get_serial_port_data(port);
425 if (set & TIOCM_RTS)
426 portdata->rts_state = 1;
427 if (set & TIOCM_DTR)
428 portdata->dtr_state = 1;
430 if (clear & TIOCM_RTS)
431 portdata->rts_state = 0;
432 if (clear & TIOCM_DTR)
433 portdata->dtr_state = 0;
434 return sierra_send_setup(port);
437 static void sierra_release_urb(struct urb *urb)
439 struct usb_serial_port *port;
440 if (urb) {
441 port = urb->context;
442 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
443 kfree(urb->transfer_buffer);
444 usb_free_urb(urb);
448 static void sierra_outdat_callback(struct urb *urb)
450 struct usb_serial_port *port = urb->context;
451 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
452 struct sierra_intf_private *intfdata;
453 int status = urb->status;
455 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
456 intfdata = port->serial->private;
458 /* free up the transfer buffer, as usb_free_urb() does not do this */
459 kfree(urb->transfer_buffer);
460 usb_autopm_put_interface_async(port->serial->interface);
461 if (status)
462 dev_dbg(&port->dev, "%s - nonzero write bulk status "
463 "received: %d\n", __func__, status);
465 spin_lock(&portdata->lock);
466 --portdata->outstanding_urbs;
467 spin_unlock(&portdata->lock);
468 spin_lock(&intfdata->susp_lock);
469 --intfdata->in_flight;
470 spin_unlock(&intfdata->susp_lock);
472 usb_serial_port_softint(port);
475 /* Write */
476 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
477 const unsigned char *buf, int count)
479 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
480 struct sierra_intf_private *intfdata;
481 struct usb_serial *serial = port->serial;
482 unsigned long flags;
483 unsigned char *buffer;
484 struct urb *urb;
485 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
486 int retval = 0;
488 /* verify that we actually have some data to write */
489 if (count == 0)
490 return 0;
492 portdata = usb_get_serial_port_data(port);
493 intfdata = serial->private;
495 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
496 spin_lock_irqsave(&portdata->lock, flags);
497 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
498 portdata->outstanding_urbs);
499 if (portdata->outstanding_urbs > portdata->num_out_urbs) {
500 spin_unlock_irqrestore(&portdata->lock, flags);
501 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
502 return 0;
504 portdata->outstanding_urbs++;
505 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
506 portdata->outstanding_urbs);
507 spin_unlock_irqrestore(&portdata->lock, flags);
509 retval = usb_autopm_get_interface_async(serial->interface);
510 if (retval < 0) {
511 spin_lock_irqsave(&portdata->lock, flags);
512 portdata->outstanding_urbs--;
513 spin_unlock_irqrestore(&portdata->lock, flags);
514 goto error_simple;
517 buffer = kmalloc(writesize, GFP_ATOMIC);
518 if (!buffer) {
519 dev_err(&port->dev, "out of memory\n");
520 retval = -ENOMEM;
521 goto error_no_buffer;
524 urb = usb_alloc_urb(0, GFP_ATOMIC);
525 if (!urb) {
526 dev_err(&port->dev, "no more free urbs\n");
527 retval = -ENOMEM;
528 goto error_no_urb;
531 memcpy(buffer, buf, writesize);
533 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
535 usb_fill_bulk_urb(urb, serial->dev,
536 usb_sndbulkpipe(serial->dev,
537 port->bulk_out_endpointAddress),
538 buffer, writesize, sierra_outdat_callback, port);
540 /* Handle the need to send a zero length packet */
541 urb->transfer_flags |= URB_ZERO_PACKET;
543 spin_lock_irqsave(&intfdata->susp_lock, flags);
545 if (intfdata->suspended) {
546 usb_anchor_urb(urb, &portdata->delayed);
547 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
548 goto skip_power;
549 } else {
550 usb_anchor_urb(urb, &portdata->active);
552 /* send it down the pipe */
553 retval = usb_submit_urb(urb, GFP_ATOMIC);
554 if (retval) {
555 usb_unanchor_urb(urb);
556 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
557 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
558 "with status = %d\n", __func__, retval);
559 goto error;
560 } else {
561 intfdata->in_flight++;
562 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
565 skip_power:
566 /* we are done with this urb, so let the host driver
567 * really free it when it is finished with it */
568 usb_free_urb(urb);
570 return writesize;
571 error:
572 usb_free_urb(urb);
573 error_no_urb:
574 kfree(buffer);
575 error_no_buffer:
576 spin_lock_irqsave(&portdata->lock, flags);
577 --portdata->outstanding_urbs;
578 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
579 portdata->outstanding_urbs);
580 spin_unlock_irqrestore(&portdata->lock, flags);
581 usb_autopm_put_interface_async(serial->interface);
582 error_simple:
583 return retval;
586 static void sierra_indat_callback(struct urb *urb)
588 int err;
589 int endpoint;
590 struct usb_serial_port *port;
591 struct tty_struct *tty;
592 unsigned char *data = urb->transfer_buffer;
593 int status = urb->status;
595 endpoint = usb_pipeendpoint(urb->pipe);
596 port = urb->context;
598 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
600 if (status) {
601 dev_dbg(&port->dev, "%s: nonzero status: %d on"
602 " endpoint %02x\n", __func__, status, endpoint);
603 } else {
604 if (urb->actual_length) {
605 tty = tty_port_tty_get(&port->port);
607 tty_buffer_request_room(tty, urb->actual_length);
608 tty_insert_flip_string(tty, data, urb->actual_length);
609 tty_flip_buffer_push(tty);
611 tty_kref_put(tty);
612 usb_serial_debug_data(debug, &port->dev, __func__,
613 urb->actual_length, data);
614 } else {
615 dev_dbg(&port->dev, "%s: empty read urb"
616 " received\n", __func__);
620 /* Resubmit urb so we continue receiving */
621 if (port->port.count && status != -ESHUTDOWN && status != -EPERM) {
622 usb_mark_last_busy(port->serial->dev);
623 err = usb_submit_urb(urb, GFP_ATOMIC);
624 if (err)
625 dev_err(&port->dev, "resubmit read urb failed."
626 "(%d)\n", err);
629 return;
632 static void sierra_instat_callback(struct urb *urb)
634 int err;
635 int status = urb->status;
636 struct usb_serial_port *port = urb->context;
637 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
638 struct usb_serial *serial = port->serial;
640 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
641 urb, port, portdata);
643 if (status == 0) {
644 struct usb_ctrlrequest *req_pkt =
645 (struct usb_ctrlrequest *)urb->transfer_buffer;
647 if (!req_pkt) {
648 dev_dbg(&port->dev, "%s: NULL req_pkt\n",
649 __func__);
650 return;
652 if ((req_pkt->bRequestType == 0xA1) &&
653 (req_pkt->bRequest == 0x20)) {
654 int old_dcd_state;
655 unsigned char signals = *((unsigned char *)
656 urb->transfer_buffer +
657 sizeof(struct usb_ctrlrequest));
658 struct tty_struct *tty;
660 dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
661 signals);
663 old_dcd_state = portdata->dcd_state;
664 portdata->cts_state = 1;
665 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
666 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
667 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
669 tty = tty_port_tty_get(&port->port);
670 if (tty && !C_CLOCAL(tty) &&
671 old_dcd_state && !portdata->dcd_state)
672 tty_hangup(tty);
673 tty_kref_put(tty);
674 } else {
675 dev_dbg(&port->dev, "%s: type %x req %x\n",
676 __func__, req_pkt->bRequestType,
677 req_pkt->bRequest);
679 } else
680 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
682 /* Resubmit urb so we continue receiving IRQ data */
683 if (port->port.count && status != -ESHUTDOWN && status != -ENOENT) {
684 usb_mark_last_busy(serial->dev);
685 urb->dev = serial->dev;
686 err = usb_submit_urb(urb, GFP_ATOMIC);
687 if (err)
688 dev_err(&port->dev, "%s: resubmit intr urb "
689 "failed. (%d)\n", __func__, err);
693 static int sierra_write_room(struct tty_struct *tty)
695 struct usb_serial_port *port = tty->driver_data;
696 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
697 unsigned long flags;
699 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
701 /* try to give a good number back based on if we have any free urbs at
702 * this point in time */
703 spin_lock_irqsave(&portdata->lock, flags);
704 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
705 spin_unlock_irqrestore(&portdata->lock, flags);
706 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
707 return 0;
709 spin_unlock_irqrestore(&portdata->lock, flags);
711 return 2048;
714 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
716 int i;
717 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
719 for (i = 0; i < portdata->num_in_urbs; i++)
720 usb_kill_urb(portdata->in_urbs[i]);
722 usb_kill_urb(port->interrupt_in_urb);
725 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
727 int ok_cnt;
728 int err = -EINVAL;
729 int i;
730 struct urb *urb;
731 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
733 ok_cnt = 0;
734 for (i = 0; i < portdata->num_in_urbs; i++) {
735 urb = portdata->in_urbs[i];
736 if (!urb)
737 continue;
738 err = usb_submit_urb(urb, mem_flags);
739 if (err) {
740 dev_err(&port->dev, "%s: submit urb failed: %d\n",
741 __func__, err);
742 } else {
743 ok_cnt++;
747 if (ok_cnt && port->interrupt_in_urb) {
748 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
749 if (err) {
750 dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
751 __func__, err);
755 if (ok_cnt > 0) /* at least one rx urb submitted */
756 return 0;
757 else
758 return err;
761 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
762 int dir, void *ctx, int len,
763 gfp_t mem_flags,
764 usb_complete_t callback)
766 struct urb *urb;
767 u8 *buf;
769 if (endpoint == -1)
770 return NULL;
772 urb = usb_alloc_urb(0, mem_flags);
773 if (urb == NULL) {
774 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
775 __func__, endpoint);
776 return NULL;
779 buf = kmalloc(len, mem_flags);
780 if (buf) {
781 /* Fill URB using supplied data */
782 usb_fill_bulk_urb(urb, serial->dev,
783 usb_sndbulkpipe(serial->dev, endpoint) | dir,
784 buf, len, callback, ctx);
786 /* debug */
787 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
788 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
789 } else {
790 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
791 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
793 sierra_release_urb(urb);
794 urb = NULL;
797 return urb;
800 static void sierra_close(struct usb_serial_port *port)
802 int i;
803 struct usb_serial *serial = port->serial;
804 struct sierra_port_private *portdata;
805 struct sierra_intf_private *intfdata = port->serial->private;
808 dev_dbg(&port->dev, "%s\n", __func__);
809 portdata = usb_get_serial_port_data(port);
811 portdata->rts_state = 0;
812 portdata->dtr_state = 0;
814 if (serial->dev) {
815 mutex_lock(&serial->disc_mutex);
816 if (!serial->disconnected) {
817 serial->interface->needs_remote_wakeup = 0;
818 usb_autopm_get_interface(serial->interface);
819 sierra_send_setup(port);
821 mutex_unlock(&serial->disc_mutex);
822 spin_lock_irq(&intfdata->susp_lock);
823 portdata->opened = 0;
824 spin_unlock_irq(&intfdata->susp_lock);
827 /* Stop reading urbs */
828 sierra_stop_rx_urbs(port);
829 /* .. and release them */
830 for (i = 0; i < portdata->num_in_urbs; i++) {
831 sierra_release_urb(portdata->in_urbs[i]);
832 portdata->in_urbs[i] = NULL;
837 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
839 struct sierra_port_private *portdata;
840 struct usb_serial *serial = port->serial;
841 struct sierra_intf_private *intfdata = serial->private;
842 int i;
843 int err;
844 int endpoint;
845 struct urb *urb;
847 portdata = usb_get_serial_port_data(port);
849 dev_dbg(&port->dev, "%s\n", __func__);
851 /* Set some sane defaults */
852 portdata->rts_state = 1;
853 portdata->dtr_state = 1;
856 endpoint = port->bulk_in_endpointAddress;
857 for (i = 0; i < portdata->num_in_urbs; i++) {
858 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
859 IN_BUFLEN, GFP_KERNEL,
860 sierra_indat_callback);
861 portdata->in_urbs[i] = urb;
863 /* clear halt condition */
864 usb_clear_halt(serial->dev,
865 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
867 err = sierra_submit_rx_urbs(port, GFP_KERNEL);
868 if (err) {
869 /* get rid of everything as in close */
870 sierra_close(port);
871 /* restore balance for autopm */
872 usb_autopm_put_interface(serial->interface);
873 return err;
875 sierra_send_setup(port);
877 serial->interface->needs_remote_wakeup = 1;
878 spin_lock_irq(&intfdata->susp_lock);
879 portdata->opened = 1;
880 spin_unlock_irq(&intfdata->susp_lock);
881 usb_autopm_put_interface(serial->interface);
883 return 0;
887 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
889 struct usb_serial *serial = port->serial;
890 struct sierra_port_private *portdata;
892 portdata = usb_get_serial_port_data(port);
893 portdata->rts_state = on;
894 portdata->dtr_state = on;
896 if (serial->dev) {
897 mutex_lock(&serial->disc_mutex);
898 if (!serial->disconnected)
899 sierra_send_setup(port);
900 mutex_unlock(&serial->disc_mutex);
904 static int sierra_startup(struct usb_serial *serial)
906 struct usb_serial_port *port;
907 struct sierra_port_private *portdata;
908 struct sierra_iface_info *himemoryp = NULL;
909 int i;
910 u8 ifnum;
912 dev_dbg(&serial->dev->dev, "%s\n", __func__);
914 /* Set Device mode to D0 */
915 sierra_set_power_state(serial->dev, 0x0000);
917 /* Check NMEA and set */
918 if (nmea)
919 sierra_vsc_set_nmea(serial->dev, 1);
921 /* Now setup per port private data */
922 for (i = 0; i < serial->num_ports; i++) {
923 port = serial->port[i];
924 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
925 if (!portdata) {
926 dev_dbg(&port->dev, "%s: kmalloc for "
927 "sierra_port_private (%d) failed!\n",
928 __func__, i);
929 return -ENOMEM;
931 spin_lock_init(&portdata->lock);
932 init_usb_anchor(&portdata->active);
933 init_usb_anchor(&portdata->delayed);
934 ifnum = i;
935 /* Assume low memory requirements */
936 portdata->num_out_urbs = N_OUT_URB;
937 portdata->num_in_urbs = N_IN_URB;
939 /* Determine actual memory requirements */
940 if (serial->num_ports == 1) {
941 /* Get interface number for composite device */
942 ifnum = sierra_calc_interface(serial);
943 himemoryp =
944 (struct sierra_iface_info *)&typeB_interface_list;
945 if (is_himemory(ifnum, himemoryp)) {
946 portdata->num_out_urbs = N_OUT_URB_HM;
947 portdata->num_in_urbs = N_IN_URB_HM;
950 else {
951 himemoryp =
952 (struct sierra_iface_info *)&typeA_interface_list;
953 if (is_himemory(i, himemoryp)) {
954 portdata->num_out_urbs = N_OUT_URB_HM;
955 portdata->num_in_urbs = N_IN_URB_HM;
958 dev_dbg(&serial->dev->dev,
959 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
960 ifnum,portdata->num_in_urbs, portdata->num_out_urbs );
961 /* Set the port private data pointer */
962 usb_set_serial_port_data(port, portdata);
965 return 0;
968 static void sierra_release(struct usb_serial *serial)
970 int i;
971 struct usb_serial_port *port;
972 struct sierra_port_private *portdata;
974 dev_dbg(&serial->dev->dev, "%s\n", __func__);
976 for (i = 0; i < serial->num_ports; ++i) {
977 port = serial->port[i];
978 if (!port)
979 continue;
980 portdata = usb_get_serial_port_data(port);
981 if (!portdata)
982 continue;
983 kfree(portdata);
987 #ifdef CONFIG_PM
988 static void stop_read_write_urbs(struct usb_serial *serial)
990 int i;
991 struct usb_serial_port *port;
992 struct sierra_port_private *portdata;
994 /* Stop reading/writing urbs */
995 for (i = 0; i < serial->num_ports; ++i) {
996 port = serial->port[i];
997 portdata = usb_get_serial_port_data(port);
998 sierra_stop_rx_urbs(port);
999 usb_kill_anchored_urbs(&portdata->active);
1003 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
1005 struct sierra_intf_private *intfdata;
1006 int b;
1008 if (message.event & PM_EVENT_AUTO) {
1009 intfdata = serial->private;
1010 spin_lock_irq(&intfdata->susp_lock);
1011 b = intfdata->in_flight;
1013 if (b) {
1014 spin_unlock_irq(&intfdata->susp_lock);
1015 return -EBUSY;
1016 } else {
1017 intfdata->suspended = 1;
1018 spin_unlock_irq(&intfdata->susp_lock);
1021 stop_read_write_urbs(serial);
1023 return 0;
1026 static int sierra_resume(struct usb_serial *serial)
1028 struct usb_serial_port *port;
1029 struct sierra_intf_private *intfdata = serial->private;
1030 struct sierra_port_private *portdata;
1031 struct urb *urb;
1032 int ec = 0;
1033 int i, err;
1035 spin_lock_irq(&intfdata->susp_lock);
1036 for (i = 0; i < serial->num_ports; i++) {
1037 port = serial->port[i];
1038 portdata = usb_get_serial_port_data(port);
1040 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
1041 usb_anchor_urb(urb, &portdata->active);
1042 intfdata->in_flight++;
1043 err = usb_submit_urb(urb, GFP_ATOMIC);
1044 if (err < 0) {
1045 intfdata->in_flight--;
1046 usb_unanchor_urb(urb);
1047 usb_scuttle_anchored_urbs(&portdata->delayed);
1048 break;
1052 if (portdata->opened) {
1053 err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1054 if (err)
1055 ec++;
1058 intfdata->suspended = 0;
1059 spin_unlock_irq(&intfdata->susp_lock);
1061 return ec ? -EIO : 0;
1063 #else
1064 #define sierra_suspend NULL
1065 #define sierra_resume NULL
1066 #endif
1068 static struct usb_serial_driver sierra_device = {
1069 .driver = {
1070 .owner = THIS_MODULE,
1071 .name = "sierra",
1073 .description = "Sierra USB modem",
1074 .id_table = id_table,
1075 .usb_driver = &sierra_driver,
1076 .calc_num_ports = sierra_calc_num_ports,
1077 .probe = sierra_probe,
1078 .open = sierra_open,
1079 .close = sierra_close,
1080 .dtr_rts = sierra_dtr_rts,
1081 .write = sierra_write,
1082 .write_room = sierra_write_room,
1083 .set_termios = sierra_set_termios,
1084 .tiocmget = sierra_tiocmget,
1085 .tiocmset = sierra_tiocmset,
1086 .attach = sierra_startup,
1087 .release = sierra_release,
1088 .suspend = sierra_suspend,
1089 .resume = sierra_resume,
1090 .read_int_callback = sierra_instat_callback,
1093 /* Functions used by new usb-serial code. */
1094 static int __init sierra_init(void)
1096 int retval;
1097 retval = usb_serial_register(&sierra_device);
1098 if (retval)
1099 goto failed_device_register;
1102 retval = usb_register(&sierra_driver);
1103 if (retval)
1104 goto failed_driver_register;
1106 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1107 DRIVER_DESC "\n");
1109 return 0;
1111 failed_driver_register:
1112 usb_serial_deregister(&sierra_device);
1113 failed_device_register:
1114 return retval;
1117 static void __exit sierra_exit(void)
1119 usb_deregister(&sierra_driver);
1120 usb_serial_deregister(&sierra_device);
1123 module_init(sierra_init);
1124 module_exit(sierra_exit);
1126 MODULE_AUTHOR(DRIVER_AUTHOR);
1127 MODULE_DESCRIPTION(DRIVER_DESC);
1128 MODULE_VERSION(DRIVER_VERSION);
1129 MODULE_LICENSE("GPL");
1131 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1132 MODULE_PARM_DESC(nmea, "NMEA streaming");
1134 module_param(debug, bool, S_IRUGO | S_IWUSR);
1135 MODULE_PARM_DESC(debug, "Debug messages");