USB: keyspan: fix overrun-error reporting
[pandora-kernel.git] / drivers / usb / serial / sierra.c
1 /*
2   USB Driver for Sierra Wireless
3
4   Copyright (C) 2006, 2007, 2008  Kevin Lloyd <klloyd@sierrawireless.com>,
5
6   Copyright (C) 2008, 2009  Elina Pasheva, Matthew Safar, Rory Filer
7                         <linux@sierrawireless.com>
8
9   IMPORTANT DISCLAIMER: This driver is not commercially supported by
10   Sierra Wireless. Use at your own risk.
11
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.
15
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>
18 */
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"
24
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>
34
35 #define SWIMS_USB_REQUEST_SetPower      0x00
36 #define SWIMS_USB_REQUEST_SetNmea       0x07
37
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
43
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 */
48
49 static int debug;
50 static int nmea;
51
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 */
56 };
57
58 struct sierra_intf_private {
59         spinlock_t susp_lock;
60         unsigned int suspended:1;
61         int in_flight;
62         unsigned int open_ports;
63 };
64
65 static int sierra_set_power_state(struct usb_device *udev, __u16 swiState)
66 {
67         int result;
68         dev_dbg(&udev->dev, "%s\n", __func__);
69         result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
70                         SWIMS_USB_REQUEST_SetPower,     /* __u8 request      */
71                         USB_TYPE_VENDOR,                /* __u8 request type */
72                         swiState,                       /* __u16 value       */
73                         0,                              /* __u16 index       */
74                         NULL,                           /* void *data        */
75                         0,                              /* __u16 size        */
76                         USB_CTRL_SET_TIMEOUT);          /* int timeout       */
77         return result;
78 }
79
80 static int sierra_vsc_set_nmea(struct usb_device *udev, __u16 enable)
81 {
82         int result;
83         dev_dbg(&udev->dev, "%s\n", __func__);
84         result = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
85                         SWIMS_USB_REQUEST_SetNmea,      /* __u8 request      */
86                         USB_TYPE_VENDOR,                /* __u8 request type */
87                         enable,                         /* __u16 value       */
88                         0x0000,                         /* __u16 index       */
89                         NULL,                           /* void *data        */
90                         0,                              /* __u16 size        */
91                         USB_CTRL_SET_TIMEOUT);          /* int timeout       */
92         return result;
93 }
94
95 static int sierra_calc_num_ports(struct usb_serial *serial)
96 {
97         int num_ports = 0;
98         u8 ifnum, numendpoints;
99
100         dev_dbg(&serial->dev->dev, "%s\n", __func__);
101
102         ifnum = serial->interface->cur_altsetting->desc.bInterfaceNumber;
103         numendpoints = serial->interface->cur_altsetting->desc.bNumEndpoints;
104
105         /* Dummy interface present on some SKUs should be ignored */
106         if (ifnum == 0x99)
107                 num_ports = 0;
108         else if (numendpoints <= 3)
109                 num_ports = 1;
110         else
111                 num_ports = (numendpoints-1)/2;
112         return num_ports;
113 }
114
115 static int is_blacklisted(const u8 ifnum,
116                                 const struct sierra_iface_info *blacklist)
117 {
118         const u8  *info;
119         int i;
120
121         if (blacklist) {
122                 info = blacklist->ifaceinfo;
123
124                 for (i = 0; i < blacklist->infolen; i++) {
125                         if (info[i] == ifnum)
126                                 return 1;
127                 }
128         }
129         return 0;
130 }
131
132 static int is_himemory(const u8 ifnum,
133                                 const struct sierra_iface_info *himemorylist)
134 {
135         const u8  *info;
136         int i;
137
138         if (himemorylist) {
139                 info = himemorylist->ifaceinfo;
140
141                 for (i=0; i < himemorylist->infolen; i++) {
142                         if (info[i] == ifnum)
143                                 return 1;
144                 }
145         }
146         return 0;
147 }
148
149 static int sierra_calc_interface(struct usb_serial *serial)
150 {
151         int interface;
152         struct usb_interface *p_interface;
153         struct usb_host_interface *p_host_interface;
154         dev_dbg(&serial->dev->dev, "%s\n", __func__);
155
156         /* Get the interface structure pointer from the serial struct */
157         p_interface = serial->interface;
158
159         /* Get a pointer to the host interface structure */
160         p_host_interface = p_interface->cur_altsetting;
161
162         /* read the interface descriptor for this active altsetting
163          * to find out the interface number we are on
164         */
165         interface = p_host_interface->desc.bInterfaceNumber;
166
167         return interface;
168 }
169
170 static int sierra_probe(struct usb_serial *serial,
171                         const struct usb_device_id *id)
172 {
173         int result = 0;
174         struct usb_device *udev;
175         u8 ifnum;
176
177         udev = serial->dev;
178         dev_dbg(&udev->dev, "%s\n", __func__);
179
180         ifnum = sierra_calc_interface(serial);
181         /*
182          * If this interface supports more than 1 alternate
183          * select the 2nd one
184          */
185         if (serial->interface->num_altsetting == 2) {
186                 dev_dbg(&udev->dev, "Selecting alt setting for interface %d\n",
187                         ifnum);
188                 /* We know the alternate setting is 1 for the MC8785 */
189                 usb_set_interface(udev, ifnum, 1);
190         }
191
192         /* ifnum could have changed - by calling usb_set_interface */
193         ifnum = sierra_calc_interface(serial);
194
195         if (is_blacklisted(ifnum,
196                                 (struct sierra_iface_info *)id->driver_info)) {
197                 dev_dbg(&serial->dev->dev,
198                         "Ignoring blacklisted interface #%d\n", ifnum);
199                 return -ENODEV;
200         }
201
202         return result;
203 }
204
205 /* interfaces with higher memory requirements */
206 static const u8 hi_memory_typeA_ifaces[] = { 0, 2 };
207 static const struct sierra_iface_info typeA_interface_list = {
208         .infolen = ARRAY_SIZE(hi_memory_typeA_ifaces),
209         .ifaceinfo = hi_memory_typeA_ifaces,
210 };
211
212 static const u8 hi_memory_typeB_ifaces[] = { 3, 4, 5, 6 };
213 static const struct sierra_iface_info typeB_interface_list = {
214         .infolen = ARRAY_SIZE(hi_memory_typeB_ifaces),
215         .ifaceinfo = hi_memory_typeB_ifaces,
216 };
217
218 /* 'blacklist' of interfaces not served by this driver */
219 static const u8 direct_ip_non_serial_ifaces[] = { 7, 8, 9, 10, 11, 19, 20 };
220 static const struct sierra_iface_info direct_ip_interface_blacklist = {
221         .infolen = ARRAY_SIZE(direct_ip_non_serial_ifaces),
222         .ifaceinfo = direct_ip_non_serial_ifaces,
223 };
224
225 static const struct usb_device_id id_table[] = {
226         { USB_DEVICE(0x0F3D, 0x0112) }, /* Airprime/Sierra PC 5220 */
227         { USB_DEVICE(0x03F0, 0x1B1D) }, /* HP ev2200 a.k.a MC5720 */
228         { USB_DEVICE(0x03F0, 0x211D) }, /* HP ev2210 a.k.a MC5725 */
229         { USB_DEVICE(0x03F0, 0x1E1D) }, /* HP hs2300 a.k.a MC8775 */
230
231         { USB_DEVICE(0x1199, 0x0017) }, /* Sierra Wireless EM5625 */
232         { USB_DEVICE(0x1199, 0x0018) }, /* Sierra Wireless MC5720 */
233         { USB_DEVICE(0x1199, 0x0218) }, /* Sierra Wireless MC5720 */
234         { USB_DEVICE(0x1199, 0x0020) }, /* Sierra Wireless MC5725 */
235         { USB_DEVICE(0x1199, 0x0220) }, /* Sierra Wireless MC5725 */
236         { USB_DEVICE(0x1199, 0x0022) }, /* Sierra Wireless EM5725 */
237         { USB_DEVICE(0x1199, 0x0024) }, /* Sierra Wireless MC5727 */
238         { USB_DEVICE(0x1199, 0x0224) }, /* Sierra Wireless MC5727 */
239         { USB_DEVICE(0x1199, 0x0019) }, /* Sierra Wireless AirCard 595 */
240         { USB_DEVICE(0x1199, 0x0021) }, /* Sierra Wireless AirCard 597E */
241         { USB_DEVICE(0x1199, 0x0112) }, /* Sierra Wireless AirCard 580 */
242         { USB_DEVICE(0x1199, 0x0120) }, /* Sierra Wireless USB Dongle 595U */
243         { USB_DEVICE(0x1199, 0x0301) }, /* Sierra Wireless USB Dongle 250U */
244         /* Sierra Wireless C597 */
245         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0023, 0xFF, 0xFF, 0xFF) },
246         /* Sierra Wireless T598 */
247         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x0025, 0xFF, 0xFF, 0xFF) },
248         { USB_DEVICE(0x1199, 0x0026) }, /* Sierra Wireless T11 */
249         { USB_DEVICE(0x1199, 0x0027) }, /* Sierra Wireless AC402 */
250         { USB_DEVICE(0x1199, 0x0028) }, /* Sierra Wireless MC5728 */
251         { USB_DEVICE(0x1199, 0x0029) }, /* Sierra Wireless Device */
252
253         { USB_DEVICE(0x1199, 0x6802) }, /* Sierra Wireless MC8755 */
254         { USB_DEVICE(0x1199, 0x6803) }, /* Sierra Wireless MC8765 */
255         { USB_DEVICE(0x1199, 0x6804) }, /* Sierra Wireless MC8755 */
256         { USB_DEVICE(0x1199, 0x6805) }, /* Sierra Wireless MC8765 */
257         { USB_DEVICE(0x1199, 0x6808) }, /* Sierra Wireless MC8755 */
258         { USB_DEVICE(0x1199, 0x6809) }, /* Sierra Wireless MC8765 */
259         { USB_DEVICE(0x1199, 0x6812) }, /* Sierra Wireless MC8775 & AC 875U */
260         { USB_DEVICE(0x1199, 0x6813) }, /* Sierra Wireless MC8775 */
261         { USB_DEVICE(0x1199, 0x6815) }, /* Sierra Wireless MC8775 */
262         { USB_DEVICE(0x1199, 0x6816) }, /* Sierra Wireless MC8775 */
263         { USB_DEVICE(0x1199, 0x6820) }, /* Sierra Wireless AirCard 875 */
264         { USB_DEVICE(0x1199, 0x6821) }, /* Sierra Wireless AirCard 875U */
265         { USB_DEVICE(0x1199, 0x6822) }, /* Sierra Wireless AirCard 875E */
266         { USB_DEVICE(0x1199, 0x6832) }, /* Sierra Wireless MC8780 */
267         { USB_DEVICE(0x1199, 0x6833) }, /* Sierra Wireless MC8781 */
268         { USB_DEVICE(0x1199, 0x6834) }, /* Sierra Wireless MC8780 */
269         { USB_DEVICE(0x1199, 0x6835) }, /* Sierra Wireless MC8781 */
270         { USB_DEVICE(0x1199, 0x6838) }, /* Sierra Wireless MC8780 */
271         { USB_DEVICE(0x1199, 0x6839) }, /* Sierra Wireless MC8781 */
272         { USB_DEVICE(0x1199, 0x683A) }, /* Sierra Wireless MC8785 */
273         { USB_DEVICE(0x1199, 0x683B) }, /* Sierra Wireless MC8785 Composite */
274         /* Sierra Wireless MC8790, MC8791, MC8792 Composite */
275         { USB_DEVICE(0x1199, 0x683C) },
276         { USB_DEVICE(0x1199, 0x683D) }, /* Sierra Wireless MC8791 Composite */
277         /* Sierra Wireless MC8790, MC8791, MC8792 */
278         { USB_DEVICE(0x1199, 0x683E) },
279         { USB_DEVICE(0x1199, 0x6850) }, /* Sierra Wireless AirCard 880 */
280         { USB_DEVICE(0x1199, 0x6851) }, /* Sierra Wireless AirCard 881 */
281         { USB_DEVICE(0x1199, 0x6852) }, /* Sierra Wireless AirCard 880 E */
282         { USB_DEVICE(0x1199, 0x6853) }, /* Sierra Wireless AirCard 881 E */
283         { USB_DEVICE(0x1199, 0x6855) }, /* Sierra Wireless AirCard 880 U */
284         { USB_DEVICE(0x1199, 0x6856) }, /* Sierra Wireless AirCard 881 U */
285         { USB_DEVICE(0x1199, 0x6859) }, /* Sierra Wireless AirCard 885 E */
286         { USB_DEVICE(0x1199, 0x685A) }, /* Sierra Wireless AirCard 885 E */
287         /* Sierra Wireless C885 */
288         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6880, 0xFF, 0xFF, 0xFF)},
289         /* Sierra Wireless C888, Air Card 501, USB 303, USB 304 */
290         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6890, 0xFF, 0xFF, 0xFF)},
291         /* Sierra Wireless C22/C33 */
292         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6891, 0xFF, 0xFF, 0xFF)},
293         /* Sierra Wireless HSPA Non-Composite Device */
294         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x6892, 0xFF, 0xFF, 0xFF)},
295         { USB_DEVICE(0x1199, 0x6893) }, /* Sierra Wireless Device */
296         { USB_DEVICE(0x1199, 0x68A2),   /* Sierra Wireless MC77xx in QMI mode */
297           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
298         },
299         /* Sierra Wireless Direct IP modems */
300         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68A3, 0xFF, 0xFF, 0xFF),
301           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
302         },
303         { USB_DEVICE_AND_INTERFACE_INFO(0x1199, 0x68AA, 0xFF, 0xFF, 0xFF),
304           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
305         },
306         /* AT&T Direct IP LTE modems */
307         { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
308           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
309         },
310         /* Airprime/Sierra Wireless Direct IP modems */
311         { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68A3, 0xFF, 0xFF, 0xFF),
312           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
313         },
314
315         { }
316 };
317 MODULE_DEVICE_TABLE(usb, id_table);
318
319
320 struct sierra_port_private {
321         spinlock_t lock;        /* lock the structure */
322         int outstanding_urbs;   /* number of out urbs in flight */
323         struct usb_anchor active;
324         struct usb_anchor delayed;
325
326         int num_out_urbs;
327         int num_in_urbs;
328         /* Input endpoints and buffers for this port */
329         struct urb *in_urbs[N_IN_URB_HM];
330
331         /* Settings for the port */
332         int rts_state;  /* Handshaking pins (outputs) */
333         int dtr_state;
334         int cts_state;  /* Handshaking pins (inputs) */
335         int dsr_state;
336         int dcd_state;
337         int ri_state;
338         unsigned int opened:1;
339 };
340
341 static int sierra_send_setup(struct usb_serial_port *port)
342 {
343         struct usb_serial *serial = port->serial;
344         struct sierra_port_private *portdata;
345         __u16 interface = 0;
346         int val = 0;
347         int do_send = 0;
348         int retval;
349
350         dev_dbg(&port->dev, "%s\n", __func__);
351
352         portdata = usb_get_serial_port_data(port);
353
354         if (portdata->dtr_state)
355                 val |= 0x01;
356         if (portdata->rts_state)
357                 val |= 0x02;
358
359         /* If composite device then properly report interface */
360         if (serial->num_ports == 1) {
361                 interface = sierra_calc_interface(serial);
362                 /* Control message is sent only to interfaces with
363                  * interrupt_in endpoints
364                  */
365                 if (port->interrupt_in_urb) {
366                         /* send control message */
367                         do_send = 1;
368                 }
369         }
370
371         /* Otherwise the need to do non-composite mapping */
372         else {
373                 if (port->bulk_out_endpointAddress == 2)
374                         interface = 0;
375                 else if (port->bulk_out_endpointAddress == 4)
376                         interface = 1;
377                 else if (port->bulk_out_endpointAddress == 5)
378                         interface = 2;
379
380                 do_send = 1;
381         }
382         if (!do_send)
383                 return 0;
384
385         retval = usb_autopm_get_interface(serial->interface);
386         if (retval < 0)
387                 return retval;
388
389         retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
390                 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
391         usb_autopm_put_interface(serial->interface);
392
393         return retval;
394 }
395
396 static void sierra_set_termios(struct tty_struct *tty,
397                 struct usb_serial_port *port, struct ktermios *old_termios)
398 {
399         dev_dbg(&port->dev, "%s\n", __func__);
400         tty_termios_copy_hw(tty->termios, old_termios);
401         sierra_send_setup(port);
402 }
403
404 static int sierra_tiocmget(struct tty_struct *tty)
405 {
406         struct usb_serial_port *port = tty->driver_data;
407         unsigned int value;
408         struct sierra_port_private *portdata;
409
410         dev_dbg(&port->dev, "%s\n", __func__);
411         portdata = usb_get_serial_port_data(port);
412
413         value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
414                 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
415                 ((portdata->cts_state) ? TIOCM_CTS : 0) |
416                 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
417                 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
418                 ((portdata->ri_state) ? TIOCM_RNG : 0);
419
420         return value;
421 }
422
423 static int sierra_tiocmset(struct tty_struct *tty,
424                         unsigned int set, unsigned int clear)
425 {
426         struct usb_serial_port *port = tty->driver_data;
427         struct sierra_port_private *portdata;
428
429         portdata = usb_get_serial_port_data(port);
430
431         if (set & TIOCM_RTS)
432                 portdata->rts_state = 1;
433         if (set & TIOCM_DTR)
434                 portdata->dtr_state = 1;
435
436         if (clear & TIOCM_RTS)
437                 portdata->rts_state = 0;
438         if (clear & TIOCM_DTR)
439                 portdata->dtr_state = 0;
440         return sierra_send_setup(port);
441 }
442
443 static void sierra_release_urb(struct urb *urb)
444 {
445         struct usb_serial_port *port;
446         if (urb) {
447                 port =  urb->context;
448                 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
449                 kfree(urb->transfer_buffer);
450                 usb_free_urb(urb);
451         }
452 }
453
454 static void sierra_outdat_callback(struct urb *urb)
455 {
456         struct usb_serial_port *port = urb->context;
457         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
458         struct sierra_intf_private *intfdata;
459         int status = urb->status;
460
461         dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
462         intfdata = port->serial->private;
463
464         /* free up the transfer buffer, as usb_free_urb() does not do this */
465         kfree(urb->transfer_buffer);
466         usb_autopm_put_interface_async(port->serial->interface);
467         if (status)
468                 dev_dbg(&port->dev, "%s - nonzero write bulk status "
469                     "received: %d\n", __func__, status);
470
471         spin_lock(&portdata->lock);
472         --portdata->outstanding_urbs;
473         spin_unlock(&portdata->lock);
474         spin_lock(&intfdata->susp_lock);
475         --intfdata->in_flight;
476         spin_unlock(&intfdata->susp_lock);
477
478         usb_serial_port_softint(port);
479 }
480
481 /* Write */
482 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
483                                         const unsigned char *buf, int count)
484 {
485         struct sierra_port_private *portdata;
486         struct sierra_intf_private *intfdata;
487         struct usb_serial *serial = port->serial;
488         unsigned long flags;
489         unsigned char *buffer;
490         struct urb *urb;
491         size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
492         int retval = 0;
493
494         /* verify that we actually have some data to write */
495         if (count == 0)
496                 return 0;
497
498         portdata = usb_get_serial_port_data(port);
499         intfdata = serial->private;
500
501         dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
502         spin_lock_irqsave(&portdata->lock, flags);
503         dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
504                 portdata->outstanding_urbs);
505         if (portdata->outstanding_urbs > portdata->num_out_urbs) {
506                 spin_unlock_irqrestore(&portdata->lock, flags);
507                 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
508                 return 0;
509         }
510         portdata->outstanding_urbs++;
511         dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
512                 portdata->outstanding_urbs);
513         spin_unlock_irqrestore(&portdata->lock, flags);
514
515         retval = usb_autopm_get_interface_async(serial->interface);
516         if (retval < 0) {
517                 spin_lock_irqsave(&portdata->lock, flags);
518                 portdata->outstanding_urbs--;
519                 spin_unlock_irqrestore(&portdata->lock, flags);
520                 goto error_simple;
521         }
522
523         buffer = kmalloc(writesize, GFP_ATOMIC);
524         if (!buffer) {
525                 dev_err(&port->dev, "out of memory\n");
526                 retval = -ENOMEM;
527                 goto error_no_buffer;
528         }
529
530         urb = usb_alloc_urb(0, GFP_ATOMIC);
531         if (!urb) {
532                 dev_err(&port->dev, "no more free urbs\n");
533                 retval = -ENOMEM;
534                 goto error_no_urb;
535         }
536
537         memcpy(buffer, buf, writesize);
538
539         usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
540
541         usb_fill_bulk_urb(urb, serial->dev,
542                           usb_sndbulkpipe(serial->dev,
543                                           port->bulk_out_endpointAddress),
544                           buffer, writesize, sierra_outdat_callback, port);
545
546         /* Handle the need to send a zero length packet */
547         urb->transfer_flags |= URB_ZERO_PACKET;
548
549         spin_lock_irqsave(&intfdata->susp_lock, flags);
550
551         if (intfdata->suspended) {
552                 usb_anchor_urb(urb, &portdata->delayed);
553                 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
554                 goto skip_power;
555         } else {
556                 usb_anchor_urb(urb, &portdata->active);
557         }
558         /* send it down the pipe */
559         retval = usb_submit_urb(urb, GFP_ATOMIC);
560         if (retval) {
561                 usb_unanchor_urb(urb);
562                 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
563                 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
564                         "with status = %d\n", __func__, retval);
565                 goto error;
566         } else {
567                 intfdata->in_flight++;
568                 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
569         }
570
571 skip_power:
572         /* we are done with this urb, so let the host driver
573          * really free it when it is finished with it */
574         usb_free_urb(urb);
575
576         return writesize;
577 error:
578         usb_free_urb(urb);
579 error_no_urb:
580         kfree(buffer);
581 error_no_buffer:
582         spin_lock_irqsave(&portdata->lock, flags);
583         --portdata->outstanding_urbs;
584         dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
585                 portdata->outstanding_urbs);
586         spin_unlock_irqrestore(&portdata->lock, flags);
587         usb_autopm_put_interface_async(serial->interface);
588 error_simple:
589         return retval;
590 }
591
592 static void sierra_indat_callback(struct urb *urb)
593 {
594         int err;
595         int endpoint;
596         struct usb_serial_port *port;
597         struct tty_struct *tty;
598         unsigned char *data = urb->transfer_buffer;
599         int status = urb->status;
600
601         endpoint = usb_pipeendpoint(urb->pipe);
602         port = urb->context;
603
604         dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
605
606         if (status) {
607                 dev_dbg(&port->dev, "%s: nonzero status: %d on"
608                         " endpoint %02x\n", __func__, status, endpoint);
609         } else {
610                 if (urb->actual_length) {
611                         tty = tty_port_tty_get(&port->port);
612                         if (tty) {
613                                 tty_insert_flip_string(tty, data,
614                                         urb->actual_length);
615                                 tty_flip_buffer_push(tty);
616
617                                 tty_kref_put(tty);
618                                 usb_serial_debug_data(debug, &port->dev,
619                                         __func__, urb->actual_length, data);
620                         }
621                 } else {
622                         dev_dbg(&port->dev, "%s: empty read urb"
623                                 " received\n", __func__);
624                 }
625         }
626
627         /* Resubmit urb so we continue receiving */
628         if (status != -ESHUTDOWN && status != -EPERM) {
629                 usb_mark_last_busy(port->serial->dev);
630                 err = usb_submit_urb(urb, GFP_ATOMIC);
631                 if (err && err != -EPERM)
632                         dev_err(&port->dev, "resubmit read urb failed."
633                                 "(%d)\n", err);
634         }
635 }
636
637 static void sierra_instat_callback(struct urb *urb)
638 {
639         int err;
640         int status = urb->status;
641         struct usb_serial_port *port =  urb->context;
642         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
643         struct usb_serial *serial = port->serial;
644
645         dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
646                 urb, port, portdata);
647
648         if (status == 0) {
649                 struct usb_ctrlrequest *req_pkt =
650                                 (struct usb_ctrlrequest *)urb->transfer_buffer;
651
652                 if (!req_pkt) {
653                         dev_dbg(&port->dev, "%s: NULL req_pkt\n",
654                                 __func__);
655                         return;
656                 }
657                 if ((req_pkt->bRequestType == 0xA1) &&
658                                 (req_pkt->bRequest == 0x20)) {
659                         int old_dcd_state;
660                         unsigned char signals = *((unsigned char *)
661                                         urb->transfer_buffer +
662                                         sizeof(struct usb_ctrlrequest));
663                         struct tty_struct *tty;
664
665                         dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
666                                 signals);
667
668                         old_dcd_state = portdata->dcd_state;
669                         portdata->cts_state = 1;
670                         portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
671                         portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
672                         portdata->ri_state = ((signals & 0x08) ? 1 : 0);
673
674                         tty = tty_port_tty_get(&port->port);
675                         if (tty && !C_CLOCAL(tty) &&
676                                         old_dcd_state && !portdata->dcd_state)
677                                 tty_hangup(tty);
678                         tty_kref_put(tty);
679                 } else {
680                         dev_dbg(&port->dev, "%s: type %x req %x\n",
681                                 __func__, req_pkt->bRequestType,
682                                 req_pkt->bRequest);
683                 }
684         } else
685                 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
686
687         /* Resubmit urb so we continue receiving IRQ data */
688         if (status != -ESHUTDOWN && status != -ENOENT) {
689                 usb_mark_last_busy(serial->dev);
690                 urb->dev = serial->dev;
691                 err = usb_submit_urb(urb, GFP_ATOMIC);
692                 if (err && err != -EPERM)
693                         dev_err(&port->dev, "%s: resubmit intr urb "
694                                 "failed. (%d)\n", __func__, err);
695         }
696 }
697
698 static int sierra_write_room(struct tty_struct *tty)
699 {
700         struct usb_serial_port *port = tty->driver_data;
701         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
702         unsigned long flags;
703
704         dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
705
706         /* try to give a good number back based on if we have any free urbs at
707          * this point in time */
708         spin_lock_irqsave(&portdata->lock, flags);
709         if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
710                 spin_unlock_irqrestore(&portdata->lock, flags);
711                 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
712                 return 0;
713         }
714         spin_unlock_irqrestore(&portdata->lock, flags);
715
716         return 2048;
717 }
718
719 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
720 {
721         int i;
722         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
723
724         for (i = 0; i < portdata->num_in_urbs; i++)
725                 usb_kill_urb(portdata->in_urbs[i]);
726
727         usb_kill_urb(port->interrupt_in_urb);
728 }
729
730 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
731 {
732         int ok_cnt;
733         int err = -EINVAL;
734         int i;
735         struct urb *urb;
736         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
737
738         ok_cnt = 0;
739         for (i = 0; i < portdata->num_in_urbs; i++) {
740                 urb = portdata->in_urbs[i];
741                 if (!urb)
742                         continue;
743                 err = usb_submit_urb(urb, mem_flags);
744                 if (err) {
745                         dev_err(&port->dev, "%s: submit urb failed: %d\n",
746                                 __func__, err);
747                 } else {
748                         ok_cnt++;
749                 }
750         }
751
752         if (ok_cnt && port->interrupt_in_urb) {
753                 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
754                 if (err) {
755                         dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
756                                 __func__, err);
757                 }
758         }
759
760         if (ok_cnt > 0) /* at least one rx urb submitted */
761                 return 0;
762         else
763                 return err;
764 }
765
766 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
767                                         int dir, void *ctx, int len,
768                                         gfp_t mem_flags,
769                                         usb_complete_t callback)
770 {
771         struct urb      *urb;
772         u8              *buf;
773
774         if (endpoint == -1)
775                 return NULL;
776
777         urb = usb_alloc_urb(0, mem_flags);
778         if (urb == NULL) {
779                 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
780                         __func__, endpoint);
781                 return NULL;
782         }
783
784         buf = kmalloc(len, mem_flags);
785         if (buf) {
786                 /* Fill URB using supplied data */
787                 usb_fill_bulk_urb(urb, serial->dev,
788                         usb_sndbulkpipe(serial->dev, endpoint) | dir,
789                         buf, len, callback, ctx);
790
791                 /* debug */
792                 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
793                                 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
794         } else {
795                 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
796                                 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
797
798                 sierra_release_urb(urb);
799                 urb = NULL;
800         }
801
802         return urb;
803 }
804
805 static void sierra_close(struct usb_serial_port *port)
806 {
807         int i;
808         struct usb_serial *serial = port->serial;
809         struct sierra_port_private *portdata;
810         struct sierra_intf_private *intfdata = port->serial->private;
811         struct urb *urb;
812
813
814         dev_dbg(&port->dev, "%s\n", __func__);
815         portdata = usb_get_serial_port_data(port);
816
817         portdata->rts_state = 0;
818         portdata->dtr_state = 0;
819
820         if (serial->dev) {
821                 mutex_lock(&serial->disc_mutex);
822                 if (!serial->disconnected) {
823                         /* odd error handling due to pm counters */
824                         if (!usb_autopm_get_interface(serial->interface))
825                                 sierra_send_setup(port);
826                         else
827                                 usb_autopm_get_interface_no_resume(serial->interface);
828                                 
829                 }
830                 mutex_unlock(&serial->disc_mutex);
831                 spin_lock_irq(&intfdata->susp_lock);
832                 portdata->opened = 0;
833                 if (--intfdata->open_ports == 0)
834                         serial->interface->needs_remote_wakeup = 0;
835                 spin_unlock_irq(&intfdata->susp_lock);
836
837                 for (;;) {
838                         urb = usb_get_from_anchor(&portdata->delayed);
839                         if (!urb)
840                                 break;
841                         kfree(urb->transfer_buffer);
842                         usb_free_urb(urb);
843                         usb_autopm_put_interface_async(serial->interface);
844                         spin_lock(&portdata->lock);
845                         portdata->outstanding_urbs--;
846                         spin_unlock(&portdata->lock);
847                 }
848
849                 /* Stop reading urbs */
850                 sierra_stop_rx_urbs(port);
851                 /* .. and release them */
852                 for (i = 0; i < portdata->num_in_urbs; i++) {
853                         sierra_release_urb(portdata->in_urbs[i]);
854                         portdata->in_urbs[i] = NULL;
855                 }
856         }
857 }
858
859 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
860 {
861         struct sierra_port_private *portdata;
862         struct usb_serial *serial = port->serial;
863         struct sierra_intf_private *intfdata = serial->private;
864         int i;
865         int err;
866         int endpoint;
867         struct urb *urb;
868
869         portdata = usb_get_serial_port_data(port);
870
871         dev_dbg(&port->dev, "%s\n", __func__);
872
873         /* Set some sane defaults */
874         portdata->rts_state = 1;
875         portdata->dtr_state = 1;
876
877
878         endpoint = port->bulk_in_endpointAddress;
879         for (i = 0; i < portdata->num_in_urbs; i++) {
880                 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
881                                         IN_BUFLEN, GFP_KERNEL,
882                                         sierra_indat_callback);
883                 portdata->in_urbs[i] = urb;
884         }
885         /* clear halt condition */
886         usb_clear_halt(serial->dev,
887                         usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
888
889         err = sierra_submit_rx_urbs(port, GFP_KERNEL);
890         if (err)
891                 goto err_submit;
892
893         sierra_send_setup(port);
894
895         spin_lock_irq(&intfdata->susp_lock);
896         portdata->opened = 1;
897         if (++intfdata->open_ports == 1)
898                 serial->interface->needs_remote_wakeup = 1;
899         spin_unlock_irq(&intfdata->susp_lock);
900         usb_autopm_put_interface(serial->interface);
901
902         return 0;
903
904 err_submit:
905         sierra_stop_rx_urbs(port);
906
907         for (i = 0; i < portdata->num_in_urbs; i++) {
908                 sierra_release_urb(portdata->in_urbs[i]);
909                 portdata->in_urbs[i] = NULL;
910         }
911
912         return err;
913 }
914
915
916 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
917 {
918         struct sierra_port_private *portdata;
919
920         portdata = usb_get_serial_port_data(port);
921         portdata->rts_state = on;
922         portdata->dtr_state = on;
923
924         sierra_send_setup(port);
925 }
926
927 static int sierra_startup(struct usb_serial *serial)
928 {
929         struct usb_serial_port *port;
930         struct sierra_intf_private *intfdata;
931         struct sierra_port_private *portdata;
932         struct sierra_iface_info *himemoryp = NULL;
933         int i;
934         u8 ifnum;
935
936         dev_dbg(&serial->dev->dev, "%s\n", __func__);
937
938         intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
939         if (!intfdata)
940                 return -ENOMEM;
941
942         spin_lock_init(&intfdata->susp_lock);
943
944         usb_set_serial_data(serial, intfdata);
945
946         /* Set Device mode to D0 */
947         sierra_set_power_state(serial->dev, 0x0000);
948
949         /* Check NMEA and set */
950         if (nmea)
951                 sierra_vsc_set_nmea(serial->dev, 1);
952
953         /* Now setup per port private data */
954         for (i = 0; i < serial->num_ports; i++) {
955                 port = serial->port[i];
956                 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
957                 if (!portdata) {
958                         dev_dbg(&port->dev, "%s: kmalloc for "
959                                 "sierra_port_private (%d) failed!\n",
960                                 __func__, i);
961                         goto err;
962                 }
963                 spin_lock_init(&portdata->lock);
964                 init_usb_anchor(&portdata->active);
965                 init_usb_anchor(&portdata->delayed);
966                 ifnum = i;
967                 /* Assume low memory requirements */
968                 portdata->num_out_urbs = N_OUT_URB;
969                 portdata->num_in_urbs  = N_IN_URB;
970
971                 /* Determine actual memory requirements */
972                 if (serial->num_ports == 1) {
973                         /* Get interface number for composite device */
974                         ifnum = sierra_calc_interface(serial);
975                         himemoryp =
976                             (struct sierra_iface_info *)&typeB_interface_list;
977                         if (is_himemory(ifnum, himemoryp)) {
978                                 portdata->num_out_urbs = N_OUT_URB_HM;
979                                 portdata->num_in_urbs  = N_IN_URB_HM;
980                         }
981                 }
982                 else {
983                         himemoryp =
984                             (struct sierra_iface_info *)&typeA_interface_list;
985                         if (is_himemory(i, himemoryp)) {
986                                 portdata->num_out_urbs = N_OUT_URB_HM;
987                                 portdata->num_in_urbs  = N_IN_URB_HM;
988                         }
989                 }
990                 dev_dbg(&serial->dev->dev,
991                         "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
992                         ifnum,portdata->num_in_urbs, portdata->num_out_urbs );
993                 /* Set the port private data pointer */
994                 usb_set_serial_port_data(port, portdata);
995         }
996
997         return 0;
998 err:
999         for (--i; i >= 0; --i) {
1000                 portdata = usb_get_serial_port_data(serial->port[i]);
1001                 kfree(portdata);
1002         }
1003         kfree(intfdata);
1004
1005         return -ENOMEM;
1006 }
1007
1008 static void sierra_release(struct usb_serial *serial)
1009 {
1010         int i;
1011         struct usb_serial_port *port;
1012         struct sierra_port_private *portdata;
1013
1014         dev_dbg(&serial->dev->dev, "%s\n", __func__);
1015
1016         for (i = 0; i < serial->num_ports; ++i) {
1017                 port = serial->port[i];
1018                 if (!port)
1019                         continue;
1020                 portdata = usb_get_serial_port_data(port);
1021                 if (!portdata)
1022                         continue;
1023                 kfree(portdata);
1024         }
1025         kfree(serial->private);
1026 }
1027
1028 #ifdef CONFIG_PM
1029 static void stop_read_write_urbs(struct usb_serial *serial)
1030 {
1031         int i;
1032         struct usb_serial_port *port;
1033         struct sierra_port_private *portdata;
1034
1035         /* Stop reading/writing urbs */
1036         for (i = 0; i < serial->num_ports; ++i) {
1037                 port = serial->port[i];
1038                 portdata = usb_get_serial_port_data(port);
1039                 sierra_stop_rx_urbs(port);
1040                 usb_kill_anchored_urbs(&portdata->active);
1041         }
1042 }
1043
1044 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
1045 {
1046         struct sierra_intf_private *intfdata;
1047         int b;
1048
1049         if (PMSG_IS_AUTO(message)) {
1050                 intfdata = serial->private;
1051                 spin_lock_irq(&intfdata->susp_lock);
1052                 b = intfdata->in_flight;
1053
1054                 if (b) {
1055                         spin_unlock_irq(&intfdata->susp_lock);
1056                         return -EBUSY;
1057                 } else {
1058                         intfdata->suspended = 1;
1059                         spin_unlock_irq(&intfdata->susp_lock);
1060                 }
1061         }
1062         stop_read_write_urbs(serial);
1063
1064         return 0;
1065 }
1066
1067 static int sierra_resume(struct usb_serial *serial)
1068 {
1069         struct usb_serial_port *port;
1070         struct sierra_intf_private *intfdata = serial->private;
1071         struct sierra_port_private *portdata;
1072         struct urb *urb;
1073         int ec = 0;
1074         int i, err;
1075
1076         spin_lock_irq(&intfdata->susp_lock);
1077         for (i = 0; i < serial->num_ports; i++) {
1078                 port = serial->port[i];
1079                 portdata = usb_get_serial_port_data(port);
1080
1081                 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
1082                         usb_anchor_urb(urb, &portdata->active);
1083                         intfdata->in_flight++;
1084                         err = usb_submit_urb(urb, GFP_ATOMIC);
1085                         if (err < 0) {
1086                                 intfdata->in_flight--;
1087                                 usb_unanchor_urb(urb);
1088                                 kfree(urb->transfer_buffer);
1089                                 usb_free_urb(urb);
1090                                 spin_lock(&portdata->lock);
1091                                 portdata->outstanding_urbs--;
1092                                 spin_unlock(&portdata->lock);
1093                                 continue;
1094                         }
1095                 }
1096
1097                 if (portdata->opened) {
1098                         err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1099                         if (err)
1100                                 ec++;
1101                 }
1102         }
1103         intfdata->suspended = 0;
1104         spin_unlock_irq(&intfdata->susp_lock);
1105
1106         return ec ? -EIO : 0;
1107 }
1108
1109 static int sierra_reset_resume(struct usb_interface *intf)
1110 {
1111         struct usb_serial *serial = usb_get_intfdata(intf);
1112         dev_err(&serial->dev->dev, "%s\n", __func__);
1113         return usb_serial_resume(intf);
1114 }
1115 #else
1116 #define sierra_suspend NULL
1117 #define sierra_resume NULL
1118 #define sierra_reset_resume NULL
1119 #endif
1120
1121 static struct usb_driver sierra_driver = {
1122         .name       = "sierra",
1123         .probe      = usb_serial_probe,
1124         .disconnect = usb_serial_disconnect,
1125         .suspend    = usb_serial_suspend,
1126         .resume     = usb_serial_resume,
1127         .reset_resume = sierra_reset_resume,
1128         .id_table   = id_table,
1129         .no_dynamic_id =        1,
1130         .supports_autosuspend = 1,
1131 };
1132
1133 static struct usb_serial_driver sierra_device = {
1134         .driver = {
1135                 .owner =        THIS_MODULE,
1136                 .name =         "sierra",
1137         },
1138         .description       = "Sierra USB modem",
1139         .id_table          = id_table,
1140         .usb_driver        = &sierra_driver,
1141         .calc_num_ports    = sierra_calc_num_ports,
1142         .probe             = sierra_probe,
1143         .open              = sierra_open,
1144         .close             = sierra_close,
1145         .dtr_rts           = sierra_dtr_rts,
1146         .write             = sierra_write,
1147         .write_room        = sierra_write_room,
1148         .set_termios       = sierra_set_termios,
1149         .tiocmget          = sierra_tiocmget,
1150         .tiocmset          = sierra_tiocmset,
1151         .attach            = sierra_startup,
1152         .release           = sierra_release,
1153         .suspend           = sierra_suspend,
1154         .resume            = sierra_resume,
1155         .read_int_callback = sierra_instat_callback,
1156 };
1157
1158 /* Functions used by new usb-serial code. */
1159 static int __init sierra_init(void)
1160 {
1161         int retval;
1162         retval = usb_serial_register(&sierra_device);
1163         if (retval)
1164                 goto failed_device_register;
1165
1166
1167         retval = usb_register(&sierra_driver);
1168         if (retval)
1169                 goto failed_driver_register;
1170
1171         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1172                DRIVER_DESC "\n");
1173
1174         return 0;
1175
1176 failed_driver_register:
1177         usb_serial_deregister(&sierra_device);
1178 failed_device_register:
1179         return retval;
1180 }
1181
1182 static void __exit sierra_exit(void)
1183 {
1184         usb_deregister(&sierra_driver);
1185         usb_serial_deregister(&sierra_device);
1186 }
1187
1188 module_init(sierra_init);
1189 module_exit(sierra_exit);
1190
1191 MODULE_AUTHOR(DRIVER_AUTHOR);
1192 MODULE_DESCRIPTION(DRIVER_DESC);
1193 MODULE_VERSION(DRIVER_VERSION);
1194 MODULE_LICENSE("GPL");
1195
1196 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1197 MODULE_PARM_DESC(nmea, "NMEA streaming");
1198
1199 module_param(debug, bool, S_IRUGO | S_IWUSR);
1200 MODULE_PARM_DESC(debug, "Debug messages");