USB: support for autosuspend in sierra while online
[wandboard.git] / drivers / usb / serial / sierra.c
blob68fa0e43b78107fd7b02bac3d6ede9049edcbf01
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>
20 #define DRIVER_VERSION "v.1.3.7"
21 #define DRIVER_AUTHOR "Kevin Lloyd, Elina Pasheva, Matthew Safar, Rory Filer"
22 #define DRIVER_DESC "USB Driver for Sierra Wireless USB modems"
24 #include <linux/kernel.h>
25 #include <linux/jiffies.h>
26 #include <linux/errno.h>
27 #include <linux/tty.h>
28 #include <linux/tty_flip.h>
29 #include <linux/module.h>
30 #include <linux/usb.h>
31 #include <linux/usb/serial.h>
33 #define SWIMS_USB_REQUEST_SetPower 0x00
34 #define SWIMS_USB_REQUEST_SetNmea 0x07
36 #define N_IN_URB 8
37 #define N_OUT_URB 64
38 #define IN_BUFLEN 4096
40 #define MAX_TRANSFER (PAGE_SIZE - 512)
41 /* MAX_TRANSFER is chosen so that the VM is not stressed by
42 allocations > PAGE_SIZE and the number of packets in a page
43 is an integer 512 is the largest possible packet on EHCI */
45 static int debug;
46 static int nmea;
48 /* Used in interface blacklisting */
49 struct sierra_iface_info {
50 const u32 infolen; /* number of interface numbers on blacklist */
51 const u8 *ifaceinfo; /* pointer to the array holding the numbers */
54 struct sierra_intf_private {
55 spinlock_t susp_lock;
56 unsigned int suspended:1;
57 int in_flight;
60 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
62 int result;
63 dev_dbg(&udev->dev, "%s\n", __func__);
64 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
65 SWIMS_USB_REQUEST_SetPower, /* __u8 request */
66 USB_TYPE_VENDOR, /* __u8 request type */
67 swiState, /* __u16 value */
68 0, /* __u16 index */
69 NULL, /* void *data */
70 0, /* __u16 size */
71 USB_CTRL_SET_TIMEOUT); /* int timeout */
72 return result;
75 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
77 int result;
78 dev_dbg(&udev->dev, "%s\n", __func__);
79 result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
80 SWIMS_USB_REQUEST_SetNmea, /* __u8 request */
81 USB_TYPE_VENDOR, /* __u8 request type */
82 enable, /* __u16 value */
83 0x0000, /* __u16 index */
84 NULL, /* void *data */
85 0, /* __u16 size */
86 USB_CTRL_SET_TIMEOUT); /* int timeout */
87 return result;
90 static int sierra_calc_num_ports(struct usb_serial *serial)
92 int num_ports = 0;
93 u8 ifnum, numendpoints;
95 dev_dbg(&serial->dev->dev, "%s\n", __func__);
97 ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
98 numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
100 /* Dummy interface present on some SKUs should be ignored */
101 if (ifnum == 0x99)
102 num_ports = 0;
103 else if (numendpoints <= 3)
104 num_ports = 1;
105 else
106 num_ports = (numendpoints-1)/2;
107 return num_ports;
110 static int is_blacklisted(const u8 ifnum,
111 const struct sierra_iface_info *blacklist)
113 const u8 *info;
114 int i;
116 if (blacklist) {
117 info = blacklist->ifaceinfo;
119 for (i = 0; i < blacklist->infolen; i++) {
120 if (info[i] == ifnum)
121 return 1;
124 return 0;
127 static int sierra_calc_interface(struct usb_serial *serial)
129 int interface;
130 struct usb_interface *p_interface;
131 struct usb_host_interface *p_host_interface;
132 dev_dbg(&serial->dev->dev, "%s\n", __func__);
134 /* Get the interface structure pointer from the serial struct */
135 p_interface = serial->interface;
137 /* Get a pointer to the host interface structure */
138 p_host_interface = p_interface->cur_altsetting;
140 /* read the interface descriptor for this active altsetting
141 * to find out the interface number we are on
143 interface = p_host_interface->desc.bInterfaceNumber;
145 return interface;
148 static int sierra_probe(struct usb_serial *serial,
149 const struct usb_device_id *id)
151 int result = 0;
152 struct usb_device *udev;
153 struct sierra_intf_private *data;
154 u8 ifnum;
156 udev = serial->dev;
157 dev_dbg(&udev->dev, "%s\n", __func__);
159 ifnum = sierra_calc_interface(serial);
161 * If this interface supports more than 1 alternate
162 * select the 2nd one
164 if (serial->interface->num_altsetting == 2) {
165 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
166 ifnum);
167 /* We know the alternate setting is 1 for the MC8785 */
168 usb_set_interface(udev, ifnum, 1);
171 /* ifnum could have changed - by calling usb_set_interface */
172 ifnum = sierra_calc_interface(serial);
174 if (is_blacklisted(ifnum,
175 (struct sierra_iface_info *)id->driver_info)) {
176 dev_dbg(&serial->dev->dev,
177 "Ignoring blacklisted interface #%d\n", ifnum);
178 return -ENODEV;
181 data = serial->private = kzalloc(sizeof(struct sierra_intf_private), GFP_KERNEL);
182 if (!data)
183 return -ENOMEM;
184 spin_lock_init(&data->susp_lock);
186 return result;
189 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11 };
190 static const struct sierra_iface_info direct_ip_interface_blacklist = {
191 .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
192 .ifaceinfo = direct_ip_non_serial_ifaces,
195 static struct usb_device_id id_table [] = {
196 { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
197 { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
198 { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
200 { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
201 { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
202 { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
203 { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
204 { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
205 { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
206 { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
207 { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
208 { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
209 { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
210 { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
211 { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
212 /* Sierra Wireless C597 */
213 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
214 /* Sierra Wireless T598 */
215 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
216 { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
217 { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
218 { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
219 { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
221 { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
222 { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
223 { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
224 { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
225 { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
226 { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
227 { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
228 { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
229 { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
230 { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
231 { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
232 { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
233 { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
234 { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
235 { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
236 { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
237 { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
238 { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
239 { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
240 { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
241 { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
242 /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
243 { USB_DEVICE(0x1199, 0x683C) },
244 { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
245 /* Sierra Wireless MC8790, MC8791, MC8792 */
246 { USB_DEVICE(0x1199, 0x683E) },
247 { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
248 { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
249 { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
250 { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
251 { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
252 { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
253 { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
254 { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
255 /* Sierra Wireless C885 */
256 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
257 /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
258 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
259 /* Sierra Wireless C22/C33 */
260 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
261 /* Sierra Wireless HSPA Non-Composite Device */
262 { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
263 { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
264 { USB_DEVICE(0x1199, 0x68A3), /* Sierra Wireless Direct IP modems */
265 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
270 MODULE_DEVICE_TABLE(usb, id_table);
272 static struct usb_driver sierra_driver = {
273 .name = "sierra",
274 .probe = usb_serial_probe,
275 .disconnect = usb_serial_disconnect,
276 .suspend = usb_serial_suspend,
277 .resume = usb_serial_resume,
278 .id_table = id_table,
279 .no_dynamic_id = 1,
280 .supports_autosuspend = 1,
283 struct sierra_port_private {
284 spinlock_t lock; /* lock the structure */
285 int outstanding_urbs; /* number of out urbs in flight */
286 struct usb_anchor active;
287 struct usb_anchor delayed;
289 /* Input endpoints and buffers for this port */
290 struct urb *in_urbs[N_IN_URB];
292 /* Settings for the port */
293 int rts_state; /* Handshaking pins (outputs) */
294 int dtr_state;
295 int cts_state; /* Handshaking pins (inputs) */
296 int dsr_state;
297 int dcd_state;
298 int ri_state;
300 unsigned int opened:1;
303 static int sierra_send_setup(struct usb_serial_port *port)
305 struct usb_serial *serial = port->serial;
306 struct sierra_port_private *portdata;
307 __u16 interface = 0;
308 int val = 0;
310 dev_dbg(&port->dev, "%s\n", __func__);
312 portdata = usb_get_serial_port_data(port);
314 if (portdata->dtr_state)
315 val |= 0x01;
316 if (portdata->rts_state)
317 val |= 0x02;
319 /* If composite device then properly report interface */
320 if (serial->num_ports == 1) {
321 interface = sierra_calc_interface(serial);
322 /* Control message is sent only to interfaces with
323 * interrupt_in endpoints
325 if (port->interrupt_in_urb) {
326 /* send control message */
327 return usb_control_msg(serial->dev,
328 usb_rcvctrlpipe(serial->dev, 0),
329 0x22, 0x21, val, interface,
330 NULL, 0, USB_CTRL_SET_TIMEOUT);
334 /* Otherwise the need to do non-composite mapping */
335 else {
336 if (port->bulk_out_endpointAddress == 2)
337 interface = 0;
338 else if (port->bulk_out_endpointAddress == 4)
339 interface = 1;
340 else if (port->bulk_out_endpointAddress == 5)
341 interface = 2;
342 return usb_control_msg(serial->dev,
343 usb_rcvctrlpipe(serial->dev, 0),
344 0x22, 0x21, val, interface,
345 NULL, 0, USB_CTRL_SET_TIMEOUT);
347 return 0;
350 static void sierra_set_termios(struct tty_struct *tty,
351 struct usb_serial_port *port, struct ktermios *old_termios)
353 dev_dbg(&port->dev, "%s\n", __func__);
354 tty_termios_copy_hw(tty->termios, old_termios);
355 sierra_send_setup(port);
358 static int sierra_tiocmget(struct tty_struct *tty, struct file *file)
360 struct usb_serial_port *port = tty->driver_data;
361 unsigned int value;
362 struct sierra_port_private *portdata;
364 dev_dbg(&port->dev, "%s\n", __func__);
365 portdata = usb_get_serial_port_data(port);
367 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
368 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
369 ((portdata->cts_state) ? TIOCM_CTS : 0) |
370 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
371 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
372 ((portdata->ri_state) ? TIOCM_RNG : 0);
374 return value;
377 static int sierra_tiocmset(struct tty_struct *tty, struct file *file,
378 unsigned int set, unsigned int clear)
380 struct usb_serial_port *port = tty->driver_data;
381 struct sierra_port_private *portdata;
383 portdata = usb_get_serial_port_data(port);
385 if (set & TIOCM_RTS)
386 portdata->rts_state = 1;
387 if (set & TIOCM_DTR)
388 portdata->dtr_state = 1;
390 if (clear & TIOCM_RTS)
391 portdata->rts_state = 0;
392 if (clear & TIOCM_DTR)
393 portdata->dtr_state = 0;
394 return sierra_send_setup(port);
397 static void sierra_release_urb(struct urb *urb)
399 struct usb_serial_port *port;
400 if (urb) {
401 port = urb->context;
402 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
403 kfree(urb->transfer_buffer);
404 usb_free_urb(urb);
408 static void sierra_outdat_callback(struct urb *urb)
410 struct usb_serial_port *port = urb->context;
411 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
412 struct sierra_intf_private *intfdata;
413 int status = urb->status;
415 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
416 intfdata = port->serial->private;
418 /* free up the transfer buffer, as usb_free_urb() does not do this */
419 kfree(urb->transfer_buffer);
420 usb_autopm_put_interface_async(port->serial->interface);
421 if (status)
422 dev_dbg(&port->dev, "%s - nonzero write bulk status "
423 "received: %d\n", __func__, status);
425 spin_lock(&portdata->lock);
426 --portdata->outstanding_urbs;
427 spin_unlock(&portdata->lock);
428 spin_lock(&intfdata->susp_lock);
429 --intfdata->in_flight;
430 spin_unlock(&intfdata->susp_lock);
432 usb_serial_port_softint(port);
435 /* Write */
436 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
437 const unsigned char *buf, int count)
439 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
440 struct sierra_intf_private *intfdata;
441 struct usb_serial *serial = port->serial;
442 unsigned long flags;
443 unsigned char *buffer;
444 struct urb *urb;
445 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
446 int retval = 0;
448 /* verify that we actually have some data to write */
449 if (count == 0)
450 return 0;
452 portdata = usb_get_serial_port_data(port);
453 intfdata = serial->private;
455 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
456 spin_lock_irqsave(&portdata->lock, flags);
457 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
458 portdata->outstanding_urbs);
459 if (portdata->outstanding_urbs > N_OUT_URB) {
460 spin_unlock_irqrestore(&portdata->lock, flags);
461 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
462 return 0;
464 portdata->outstanding_urbs++;
465 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
466 portdata->outstanding_urbs);
467 spin_unlock_irqrestore(&portdata->lock, flags);
469 retval = usb_autopm_get_interface_async(serial->interface);
470 if (retval < 0) {
471 spin_lock_irqsave(&portdata->lock, flags);
472 portdata->outstanding_urbs--;
473 spin_unlock_irqrestore(&portdata->lock, flags);
474 goto error_simple;
477 buffer = kmalloc(writesize, GFP_ATOMIC);
478 if (!buffer) {
479 dev_err(&port->dev, "out of memory\n");
480 retval = -ENOMEM;
481 goto error_no_buffer;
484 urb = usb_alloc_urb(0, GFP_ATOMIC);
485 if (!urb) {
486 dev_err(&port->dev, "no more free urbs\n");
487 retval = -ENOMEM;
488 goto error_no_urb;
491 memcpy(buffer, buf, writesize);
493 usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
495 usb_fill_bulk_urb(urb, serial->dev,
496 usb_sndbulkpipe(serial->dev,
497 port->bulk_out_endpointAddress),
498 buffer, writesize, sierra_outdat_callback, port);
500 /* Handle the need to send a zero length packet */
501 urb->transfer_flags |= URB_ZERO_PACKET;
503 spin_lock_irqsave(&intfdata->susp_lock, flags);
505 if (intfdata->suspended) {
506 usb_anchor_urb(urb, &portdata->delayed);
507 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
508 goto skip_power;
509 } else {
510 usb_anchor_urb(urb, &portdata->active);
512 /* send it down the pipe */
513 retval = usb_submit_urb(urb, GFP_ATOMIC);
514 if (retval) {
515 usb_unanchor_urb(urb);
516 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
517 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
518 "with status = %d\n", __func__, retval);
519 goto error;
520 } else {
521 intfdata->in_flight++;
522 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
525 skip_power:
526 /* we are done with this urb, so let the host driver
527 * really free it when it is finished with it */
528 usb_free_urb(urb);
530 return writesize;
531 error:
532 usb_free_urb(urb);
533 error_no_urb:
534 kfree(buffer);
535 error_no_buffer:
536 spin_lock_irqsave(&portdata->lock, flags);
537 --portdata->outstanding_urbs;
538 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
539 portdata->outstanding_urbs);
540 spin_unlock_irqrestore(&portdata->lock, flags);
541 usb_autopm_put_interface_async(serial->interface);
542 error_simple:
543 return retval;
546 static void sierra_indat_callback(struct urb *urb)
548 int err;
549 int endpoint;
550 struct usb_serial_port *port;
551 struct tty_struct *tty;
552 unsigned char *data = urb->transfer_buffer;
553 int status = urb->status;
555 endpoint = usb_pipeendpoint(urb->pipe);
556 port = urb->context;
558 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
560 if (status) {
561 dev_dbg(&port->dev, "%s: nonzero status: %d on"
562 " endpoint %02x\n", __func__, status, endpoint);
563 } else {
564 if (urb->actual_length) {
565 tty = tty_port_tty_get(&port->port);
567 tty_buffer_request_room(tty, urb->actual_length);
568 tty_insert_flip_string(tty, data, urb->actual_length);
569 tty_flip_buffer_push(tty);
571 tty_kref_put(tty);
572 usb_serial_debug_data(debug, &port->dev, __func__,
573 urb->actual_length, data);
574 } else {
575 dev_dbg(&port->dev, "%s: empty read urb"
576 " received\n", __func__);
580 /* Resubmit urb so we continue receiving */
581 if (port->port.count && status != -ESHUTDOWN && status != -EPERM) {
582 usb_mark_last_busy(port->serial->dev);
583 err = usb_submit_urb(urb, GFP_ATOMIC);
584 if (err)
585 dev_err(&port->dev, "resubmit read urb failed."
586 "(%d)\n", err);
589 return;
592 static void sierra_instat_callback(struct urb *urb)
594 int err;
595 int status = urb->status;
596 struct usb_serial_port *port = urb->context;
597 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
598 struct usb_serial *serial = port->serial;
600 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
601 urb, port, portdata);
603 if (status == 0) {
604 struct usb_ctrlrequest *req_pkt =
605 (struct usb_ctrlrequest *)urb->transfer_buffer;
607 if (!req_pkt) {
608 dev_dbg(&port->dev, "%s: NULL req_pkt\n",
609 __func__);
610 return;
612 if ((req_pkt->bRequestType == 0xA1) &&
613 (req_pkt->bRequest == 0x20)) {
614 int old_dcd_state;
615 unsigned char signals = *((unsigned char *)
616 urb->transfer_buffer +
617 sizeof(struct usb_ctrlrequest));
618 struct tty_struct *tty;
620 dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
621 signals);
623 old_dcd_state = portdata->dcd_state;
624 portdata->cts_state = 1;
625 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
626 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
627 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
629 tty = tty_port_tty_get(&port->port);
630 if (tty && !C_CLOCAL(tty) &&
631 old_dcd_state && !portdata->dcd_state)
632 tty_hangup(tty);
633 tty_kref_put(tty);
634 } else {
635 dev_dbg(&port->dev, "%s: type %x req %x\n",
636 __func__, req_pkt->bRequestType,
637 req_pkt->bRequest);
639 } else
640 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
642 /* Resubmit urb so we continue receiving IRQ data */
643 if (port->port.count && status != -ESHUTDOWN && status != -ENOENT) {
644 usb_mark_last_busy(serial->dev);
645 urb->dev = serial->dev;
646 err = usb_submit_urb(urb, GFP_ATOMIC);
647 if (err)
648 dev_err(&port->dev, "%s: resubmit intr urb "
649 "failed. (%d)\n", __func__, err);
653 static int sierra_write_room(struct tty_struct *tty)
655 struct usb_serial_port *port = tty->driver_data;
656 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
657 unsigned long flags;
659 dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
661 /* try to give a good number back based on if we have any free urbs at
662 * this point in time */
663 spin_lock_irqsave(&portdata->lock, flags);
664 if (portdata->outstanding_urbs > N_OUT_URB * 2 / 3) {
665 spin_unlock_irqrestore(&portdata->lock, flags);
666 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
667 return 0;
669 spin_unlock_irqrestore(&portdata->lock, flags);
671 return 2048;
674 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
676 int i;
677 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
679 for (i = 0; i < ARRAY_SIZE(portdata->in_urbs); i++)
680 usb_kill_urb(portdata->in_urbs[i]);
682 usb_kill_urb(port->interrupt_in_urb);
685 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
687 int ok_cnt;
688 int err = -EINVAL;
689 int i;
690 struct urb *urb;
691 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
693 ok_cnt = 0;
694 for (i = 0; i < ARRAY_SIZE(portdata->in_urbs); i++) {
695 urb = portdata->in_urbs[i];
696 if (!urb)
697 continue;
698 err = usb_submit_urb(urb, mem_flags);
699 if (err) {
700 dev_err(&port->dev, "%s: submit urb failed: %d\n",
701 __func__, err);
702 } else {
703 ok_cnt++;
707 if (ok_cnt && port->interrupt_in_urb) {
708 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
709 if (err) {
710 dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
711 __func__, err);
715 if (ok_cnt > 0) /* at least one rx urb submitted */
716 return 0;
717 else
718 return err;
721 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
722 int dir, void *ctx, int len,
723 gfp_t mem_flags,
724 usb_complete_t callback)
726 struct urb *urb;
727 u8 *buf;
729 if (endpoint == -1)
730 return NULL;
732 urb = usb_alloc_urb(0, mem_flags);
733 if (urb == NULL) {
734 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
735 __func__, endpoint);
736 return NULL;
739 buf = kmalloc(len, mem_flags);
740 if (buf) {
741 /* Fill URB using supplied data */
742 usb_fill_bulk_urb(urb, serial->dev,
743 usb_sndbulkpipe(serial->dev, endpoint) | dir,
744 buf, len, callback, ctx);
746 /* debug */
747 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
748 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
749 } else {
750 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
751 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
753 sierra_release_urb(urb);
754 urb = NULL;
757 return urb;
760 static void sierra_close(struct usb_serial_port *port)
762 int i;
763 struct usb_serial *serial = port->serial;
764 struct sierra_port_private *portdata;
765 struct sierra_intf_private *intfdata = port->serial->private;
768 dev_dbg(&port->dev, "%s\n", __func__);
769 portdata = usb_get_serial_port_data(port);
771 portdata->rts_state = 0;
772 portdata->dtr_state = 0;
774 if (serial->dev) {
775 mutex_lock(&serial->disc_mutex);
776 if (!serial->disconnected)
777 sierra_send_setup(port);
778 mutex_unlock(&serial->disc_mutex);
779 spin_lock_irq(&intfdata->susp_lock);
780 portdata->opened = 0;
781 spin_unlock_irq(&intfdata->susp_lock);
784 /* Stop reading urbs */
785 sierra_stop_rx_urbs(port);
786 /* .. and release them */
787 for (i = 0; i < N_IN_URB; i++) {
788 sierra_release_urb(portdata->in_urbs[i]);
789 portdata->in_urbs[i] = NULL;
791 usb_autopm_get_interface(serial->interface);
792 serial->interface->needs_remote_wakeup = 0;
796 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
798 struct sierra_port_private *portdata;
799 struct usb_serial *serial = port->serial;
800 struct sierra_intf_private *intfdata = serial->private;
801 int i;
802 int err;
803 int endpoint;
804 struct urb *urb;
806 portdata = usb_get_serial_port_data(port);
808 dev_dbg(&port->dev, "%s\n", __func__);
810 /* Set some sane defaults */
811 portdata->rts_state = 1;
812 portdata->dtr_state = 1;
815 endpoint = port->bulk_in_endpointAddress;
816 for (i = 0; i < ARRAY_SIZE(portdata->in_urbs); i++) {
817 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
818 IN_BUFLEN, GFP_KERNEL,
819 sierra_indat_callback);
820 portdata->in_urbs[i] = urb;
822 /* clear halt condition */
823 usb_clear_halt(serial->dev,
824 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
826 err = sierra_submit_rx_urbs(port, GFP_KERNEL);
827 if (err) {
828 /* get rid of everything as in close */
829 sierra_close(port);
830 return err;
832 sierra_send_setup(port);
834 serial->interface->needs_remote_wakeup = 1;
835 spin_lock_irq(&intfdata->susp_lock);
836 portdata->opened = 1;
837 spin_unlock_irq(&intfdata->susp_lock);
838 usb_autopm_put_interface(serial->interface);
840 return 0;
844 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
846 struct usb_serial *serial = port->serial;
847 struct sierra_port_private *portdata;
849 portdata = usb_get_serial_port_data(port);
850 portdata->rts_state = on;
851 portdata->dtr_state = on;
853 if (serial->dev) {
854 mutex_lock(&serial->disc_mutex);
855 if (!serial->disconnected)
856 sierra_send_setup(port);
857 mutex_unlock(&serial->disc_mutex);
861 static int sierra_startup(struct usb_serial *serial)
863 struct usb_serial_port *port;
864 struct sierra_port_private *portdata;
865 int i;
867 dev_dbg(&serial->dev->dev, "%s\n", __func__);
869 /* Set Device mode to D0 */
870 sierra_set_power_state(serial->dev, 0x0000);
872 /* Check NMEA and set */
873 if (nmea)
874 sierra_vsc_set_nmea(serial->dev, 1);
876 /* Now setup per port private data */
877 for (i = 0; i < serial->num_ports; i++) {
878 port = serial->port[i];
879 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
880 if (!portdata) {
881 dev_dbg(&port->dev, "%s: kmalloc for "
882 "sierra_port_private (%d) failed!.\n",
883 __func__, i);
884 return -ENOMEM;
886 spin_lock_init(&portdata->lock);
887 init_usb_anchor(&portdata->active);
888 init_usb_anchor(&portdata->delayed);
889 /* Set the port private data pointer */
890 usb_set_serial_port_data(port, portdata);
893 return 0;
896 static void sierra_release(struct usb_serial *serial)
898 int i;
899 struct usb_serial_port *port;
900 struct sierra_port_private *portdata;
902 dev_dbg(&serial->dev->dev, "%s\n", __func__);
904 for (i = 0; i < serial->num_ports; ++i) {
905 port = serial->port[i];
906 if (!port)
907 continue;
908 portdata = usb_get_serial_port_data(port);
909 if (!portdata)
910 continue;
911 kfree(portdata);
915 static void stop_read_write_urbs(struct usb_serial *serial)
917 int i, j;
918 struct usb_serial_port *port;
919 struct sierra_port_private *portdata;
921 /* Stop reading/writing urbs */
922 for (i = 0; i < serial->num_ports; ++i) {
923 port = serial->port[i];
924 portdata = usb_get_serial_port_data(port);
925 for (j = 0; j < N_IN_URB; j++)
926 usb_kill_urb(portdata->in_urbs[j]);
927 usb_kill_anchored_urbs(&portdata->active);
931 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
933 struct sierra_intf_private *intfdata;
934 int b;
936 if (serial->dev->auto_pm) {
937 intfdata = serial->private;
938 spin_lock_irq(&intfdata->susp_lock);
939 b = intfdata->in_flight;
941 if (b) {
942 spin_unlock_irq(&intfdata->susp_lock);
943 return -EBUSY;
944 } else {
945 intfdata->suspended = 1;
946 spin_unlock_irq(&intfdata->susp_lock);
949 stop_read_write_urbs(serial);
951 return 0;
954 static int sierra_resume(struct usb_serial *serial)
956 struct usb_serial_port *port;
957 struct sierra_intf_private *intfdata = serial->private;
958 struct sierra_port_private *portdata;
959 struct urb *urb;
960 int ec = 0;
961 int i, err;
963 spin_lock_irq(&intfdata->susp_lock);
964 for (i = 0; i < serial->num_ports; i++) {
965 port = serial->port[i];
966 portdata = usb_get_serial_port_data(port);
968 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
969 usb_anchor_urb(urb, &portdata->active);
970 intfdata->in_flight++;
971 err = usb_submit_urb(urb, GFP_ATOMIC);
972 if (err < 0) {
973 intfdata->in_flight--;
974 usb_unanchor_urb(urb);
975 usb_scuttle_anchored_urbs(&portdata->delayed);
976 break;
980 if (portdata->opened) {
981 err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
982 if (err)
983 ec++;
986 intfdata->suspended = 0;
987 spin_unlock_irq(&intfdata->susp_lock);
989 return ec ? -EIO : 0;
992 static struct usb_serial_driver sierra_device = {
993 .driver = {
994 .owner = THIS_MODULE,
995 .name = "sierra",
997 .description = "Sierra USB modem",
998 .id_table = id_table,
999 .usb_driver = &sierra_driver,
1000 .calc_num_ports = sierra_calc_num_ports,
1001 .probe = sierra_probe,
1002 .open = sierra_open,
1003 .close = sierra_close,
1004 .dtr_rts = sierra_dtr_rts,
1005 .write = sierra_write,
1006 .write_room = sierra_write_room,
1007 .set_termios = sierra_set_termios,
1008 .tiocmget = sierra_tiocmget,
1009 .tiocmset = sierra_tiocmset,
1010 .attach = sierra_startup,
1011 .release = sierra_release,
1012 .suspend = sierra_suspend,
1013 .resume = sierra_resume,
1014 .read_int_callback = sierra_instat_callback,
1017 /* Functions used by new usb-serial code. */
1018 static int __init sierra_init(void)
1020 int retval;
1021 retval = usb_serial_register(&sierra_device);
1022 if (retval)
1023 goto failed_device_register;
1026 retval = usb_register(&sierra_driver);
1027 if (retval)
1028 goto failed_driver_register;
1030 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1031 DRIVER_DESC "\n");
1033 return 0;
1035 failed_driver_register:
1036 usb_serial_deregister(&sierra_device);
1037 failed_device_register:
1038 return retval;
1041 static void __exit sierra_exit(void)
1043 usb_deregister(&sierra_driver);
1044 usb_serial_deregister(&sierra_device);
1047 module_init(sierra_init);
1048 module_exit(sierra_exit);
1050 MODULE_AUTHOR(DRIVER_AUTHOR);
1051 MODULE_DESCRIPTION(DRIVER_DESC);
1052 MODULE_VERSION(DRIVER_VERSION);
1053 MODULE_LICENSE("GPL");
1055 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1056 MODULE_PARM_DESC(nmea, "NMEA streaming");
1058 module_param(debug, bool, S_IRUGO | S_IWUSR);
1059 MODULE_PARM_DESC(debug, "Debug messages");