USB: serial: io_edgeport: fix NULL-deref at open
[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         { USB_DEVICE(0x1199, 0x68AB) }, /* Sierra Wireless AR8550 */
307         /* AT&T Direct IP LTE modems */
308         { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
309           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
310         },
311         /* Airprime/Sierra Wireless Direct IP modems */
312         { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68A3, 0xFF, 0xFF, 0xFF),
313           .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
314         },
315
316         { }
317 };
318 MODULE_DEVICE_TABLE(usb, id_table);
319
320
321 struct sierra_port_private {
322         spinlock_t lock;        /* lock the structure */
323         int outstanding_urbs;   /* number of out urbs in flight */
324         struct usb_anchor active;
325         struct usb_anchor delayed;
326
327         int num_out_urbs;
328         int num_in_urbs;
329         /* Input endpoints and buffers for this port */
330         struct urb *in_urbs[N_IN_URB_HM];
331
332         /* Settings for the port */
333         int rts_state;  /* Handshaking pins (outputs) */
334         int dtr_state;
335         int cts_state;  /* Handshaking pins (inputs) */
336         int dsr_state;
337         int dcd_state;
338         int ri_state;
339         unsigned int opened:1;
340 };
341
342 static int sierra_send_setup(struct usb_serial_port *port)
343 {
344         struct usb_serial *serial = port->serial;
345         struct sierra_port_private *portdata;
346         __u16 interface = 0;
347         int val = 0;
348         int do_send = 0;
349         int retval;
350
351         dev_dbg(&port->dev, "%s\n", __func__);
352
353         portdata = usb_get_serial_port_data(port);
354
355         if (portdata->dtr_state)
356                 val |= 0x01;
357         if (portdata->rts_state)
358                 val |= 0x02;
359
360         /* If composite device then properly report interface */
361         if (serial->num_ports == 1) {
362                 interface = sierra_calc_interface(serial);
363                 /* Control message is sent only to interfaces with
364                  * interrupt_in endpoints
365                  */
366                 if (port->interrupt_in_urb) {
367                         /* send control message */
368                         do_send = 1;
369                 }
370         }
371
372         /* Otherwise the need to do non-composite mapping */
373         else {
374                 if (port->bulk_out_endpointAddress == 2)
375                         interface = 0;
376                 else if (port->bulk_out_endpointAddress == 4)
377                         interface = 1;
378                 else if (port->bulk_out_endpointAddress == 5)
379                         interface = 2;
380
381                 do_send = 1;
382         }
383         if (!do_send)
384                 return 0;
385
386         retval = usb_autopm_get_interface(serial->interface);
387         if (retval < 0)
388                 return retval;
389
390         retval = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
391                 0x22, 0x21, val, interface, NULL, 0, USB_CTRL_SET_TIMEOUT);
392         usb_autopm_put_interface(serial->interface);
393
394         return retval;
395 }
396
397 static void sierra_set_termios(struct tty_struct *tty,
398                 struct usb_serial_port *port, struct ktermios *old_termios)
399 {
400         dev_dbg(&port->dev, "%s\n", __func__);
401         tty_termios_copy_hw(tty->termios, old_termios);
402         sierra_send_setup(port);
403 }
404
405 static int sierra_tiocmget(struct tty_struct *tty)
406 {
407         struct usb_serial_port *port = tty->driver_data;
408         unsigned int value;
409         struct sierra_port_private *portdata;
410
411         dev_dbg(&port->dev, "%s\n", __func__);
412         portdata = usb_get_serial_port_data(port);
413
414         value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
415                 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
416                 ((portdata->cts_state) ? TIOCM_CTS : 0) |
417                 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
418                 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
419                 ((portdata->ri_state) ? TIOCM_RNG : 0);
420
421         return value;
422 }
423
424 static int sierra_tiocmset(struct tty_struct *tty,
425                         unsigned int set, unsigned int clear)
426 {
427         struct usb_serial_port *port = tty->driver_data;
428         struct sierra_port_private *portdata;
429
430         portdata = usb_get_serial_port_data(port);
431
432         if (set & TIOCM_RTS)
433                 portdata->rts_state = 1;
434         if (set & TIOCM_DTR)
435                 portdata->dtr_state = 1;
436
437         if (clear & TIOCM_RTS)
438                 portdata->rts_state = 0;
439         if (clear & TIOCM_DTR)
440                 portdata->dtr_state = 0;
441         return sierra_send_setup(port);
442 }
443
444 static void sierra_release_urb(struct urb *urb)
445 {
446         struct usb_serial_port *port;
447         if (urb) {
448                 port =  urb->context;
449                 dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
450                 kfree(urb->transfer_buffer);
451                 usb_free_urb(urb);
452         }
453 }
454
455 static void sierra_outdat_callback(struct urb *urb)
456 {
457         struct usb_serial_port *port = urb->context;
458         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
459         struct sierra_intf_private *intfdata;
460         int status = urb->status;
461
462         dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
463         intfdata = port->serial->private;
464
465         /* free up the transfer buffer, as usb_free_urb() does not do this */
466         kfree(urb->transfer_buffer);
467         usb_autopm_put_interface_async(port->serial->interface);
468         if (status)
469                 dev_dbg(&port->dev, "%s - nonzero write bulk status "
470                     "received: %d\n", __func__, status);
471
472         spin_lock(&portdata->lock);
473         --portdata->outstanding_urbs;
474         spin_unlock(&portdata->lock);
475         spin_lock(&intfdata->susp_lock);
476         --intfdata->in_flight;
477         spin_unlock(&intfdata->susp_lock);
478
479         usb_serial_port_softint(port);
480 }
481
482 /* Write */
483 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
484                                         const unsigned char *buf, int count)
485 {
486         struct sierra_port_private *portdata;
487         struct sierra_intf_private *intfdata;
488         struct usb_serial *serial = port->serial;
489         unsigned long flags;
490         unsigned char *buffer;
491         struct urb *urb;
492         size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
493         int retval = 0;
494
495         /* verify that we actually have some data to write */
496         if (count == 0)
497                 return 0;
498
499         portdata = usb_get_serial_port_data(port);
500         intfdata = serial->private;
501
502         dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
503         spin_lock_irqsave(&portdata->lock, flags);
504         dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
505                 portdata->outstanding_urbs);
506         if (portdata->outstanding_urbs > portdata->num_out_urbs) {
507                 spin_unlock_irqrestore(&portdata->lock, flags);
508                 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
509                 return 0;
510         }
511         portdata->outstanding_urbs++;
512         dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
513                 portdata->outstanding_urbs);
514         spin_unlock_irqrestore(&portdata->lock, flags);
515
516         retval = usb_autopm_get_interface_async(serial->interface);
517         if (retval < 0) {
518                 spin_lock_irqsave(&portdata->lock, flags);
519                 portdata->outstanding_urbs--;
520                 spin_unlock_irqrestore(&portdata->lock, flags);
521                 goto error_simple;
522         }
523
524         buffer = kmalloc(writesize, GFP_ATOMIC);
525         if (!buffer) {
526                 dev_err(&port->dev, "out of memory\n");
527                 retval = -ENOMEM;
528                 goto error_no_buffer;
529         }
530
531         urb = usb_alloc_urb(0, GFP_ATOMIC);
532         if (!urb) {
533                 dev_err(&port->dev, "no more free urbs\n");
534                 retval = -ENOMEM;
535                 goto error_no_urb;
536         }
537
538         memcpy(buffer, buf, writesize);
539
540         usb_serial_debug_data(debug, &port->dev, __func__, writesize, buffer);
541
542         usb_fill_bulk_urb(urb, serial->dev,
543                           usb_sndbulkpipe(serial->dev,
544                                           port->bulk_out_endpointAddress),
545                           buffer, writesize, sierra_outdat_callback, port);
546
547         /* Handle the need to send a zero length packet */
548         urb->transfer_flags |= URB_ZERO_PACKET;
549
550         spin_lock_irqsave(&intfdata->susp_lock, flags);
551
552         if (intfdata->suspended) {
553                 usb_anchor_urb(urb, &portdata->delayed);
554                 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
555                 goto skip_power;
556         } else {
557                 usb_anchor_urb(urb, &portdata->active);
558         }
559         /* send it down the pipe */
560         retval = usb_submit_urb(urb, GFP_ATOMIC);
561         if (retval) {
562                 usb_unanchor_urb(urb);
563                 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
564                 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
565                         "with status = %d\n", __func__, retval);
566                 goto error;
567         } else {
568                 intfdata->in_flight++;
569                 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
570         }
571
572 skip_power:
573         /* we are done with this urb, so let the host driver
574          * really free it when it is finished with it */
575         usb_free_urb(urb);
576
577         return writesize;
578 error:
579         usb_free_urb(urb);
580 error_no_urb:
581         kfree(buffer);
582 error_no_buffer:
583         spin_lock_irqsave(&portdata->lock, flags);
584         --portdata->outstanding_urbs;
585         dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
586                 portdata->outstanding_urbs);
587         spin_unlock_irqrestore(&portdata->lock, flags);
588         usb_autopm_put_interface_async(serial->interface);
589 error_simple:
590         return retval;
591 }
592
593 static void sierra_indat_callback(struct urb *urb)
594 {
595         int err;
596         int endpoint;
597         struct usb_serial_port *port;
598         struct tty_struct *tty;
599         unsigned char *data = urb->transfer_buffer;
600         int status = urb->status;
601
602         endpoint = usb_pipeendpoint(urb->pipe);
603         port = urb->context;
604
605         dev_dbg(&port->dev, "%s: %p\n", __func__, urb);
606
607         if (status) {
608                 dev_dbg(&port->dev, "%s: nonzero status: %d on"
609                         " endpoint %02x\n", __func__, status, endpoint);
610         } else {
611                 if (urb->actual_length) {
612                         tty = tty_port_tty_get(&port->port);
613                         if (tty) {
614                                 tty_insert_flip_string(tty, data,
615                                         urb->actual_length);
616                                 tty_flip_buffer_push(tty);
617
618                                 tty_kref_put(tty);
619                                 usb_serial_debug_data(debug, &port->dev,
620                                         __func__, urb->actual_length, data);
621                         }
622                 } else {
623                         dev_dbg(&port->dev, "%s: empty read urb"
624                                 " received\n", __func__);
625                 }
626         }
627
628         /* Resubmit urb so we continue receiving */
629         if (status != -ESHUTDOWN && status != -EPERM) {
630                 usb_mark_last_busy(port->serial->dev);
631                 err = usb_submit_urb(urb, GFP_ATOMIC);
632                 if (err && err != -EPERM)
633                         dev_err(&port->dev, "resubmit read urb failed."
634                                 "(%d)\n", err);
635         }
636 }
637
638 static void sierra_instat_callback(struct urb *urb)
639 {
640         int err;
641         int status = urb->status;
642         struct usb_serial_port *port =  urb->context;
643         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
644         struct usb_serial *serial = port->serial;
645
646         dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
647                 urb, port, portdata);
648
649         if (status == 0) {
650                 struct usb_ctrlrequest *req_pkt =
651                                 (struct usb_ctrlrequest *)urb->transfer_buffer;
652
653                 if (!req_pkt) {
654                         dev_dbg(&port->dev, "%s: NULL req_pkt\n",
655                                 __func__);
656                         return;
657                 }
658                 if ((req_pkt->bRequestType == 0xA1) &&
659                                 (req_pkt->bRequest == 0x20)) {
660                         int old_dcd_state;
661                         unsigned char signals = *((unsigned char *)
662                                         urb->transfer_buffer +
663                                         sizeof(struct usb_ctrlrequest));
664                         struct tty_struct *tty;
665
666                         dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
667                                 signals);
668
669                         old_dcd_state = portdata->dcd_state;
670                         portdata->cts_state = 1;
671                         portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
672                         portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
673                         portdata->ri_state = ((signals & 0x08) ? 1 : 0);
674
675                         tty = tty_port_tty_get(&port->port);
676                         if (tty && !C_CLOCAL(tty) &&
677                                         old_dcd_state && !portdata->dcd_state)
678                                 tty_hangup(tty);
679                         tty_kref_put(tty);
680                 } else {
681                         dev_dbg(&port->dev, "%s: type %x req %x\n",
682                                 __func__, req_pkt->bRequestType,
683                                 req_pkt->bRequest);
684                 }
685         } else
686                 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
687
688         /* Resubmit urb so we continue receiving IRQ data */
689         if (status != -ESHUTDOWN && status != -ENOENT) {
690                 usb_mark_last_busy(serial->dev);
691                 urb->dev = serial->dev;
692                 err = usb_submit_urb(urb, GFP_ATOMIC);
693                 if (err && err != -EPERM)
694                         dev_err(&port->dev, "%s: resubmit intr urb "
695                                 "failed. (%d)\n", __func__, err);
696         }
697 }
698
699 static int sierra_write_room(struct tty_struct *tty)
700 {
701         struct usb_serial_port *port = tty->driver_data;
702         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
703         unsigned long flags;
704
705         dev_dbg(&port->dev, "%s - port %d\n", __func__, port->number);
706
707         /* try to give a good number back based on if we have any free urbs at
708          * this point in time */
709         spin_lock_irqsave(&portdata->lock, flags);
710         if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
711                 spin_unlock_irqrestore(&portdata->lock, flags);
712                 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
713                 return 0;
714         }
715         spin_unlock_irqrestore(&portdata->lock, flags);
716
717         return 2048;
718 }
719
720 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
721 {
722         int i;
723         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
724
725         for (i = 0; i < portdata->num_in_urbs; i++)
726                 usb_kill_urb(portdata->in_urbs[i]);
727
728         usb_kill_urb(port->interrupt_in_urb);
729 }
730
731 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
732 {
733         int ok_cnt;
734         int err = -EINVAL;
735         int i;
736         struct urb *urb;
737         struct sierra_port_private *portdata = usb_get_serial_port_data(port);
738
739         ok_cnt = 0;
740         for (i = 0; i < portdata->num_in_urbs; i++) {
741                 urb = portdata->in_urbs[i];
742                 if (!urb)
743                         continue;
744                 err = usb_submit_urb(urb, mem_flags);
745                 if (err) {
746                         dev_err(&port->dev, "%s: submit urb failed: %d\n",
747                                 __func__, err);
748                 } else {
749                         ok_cnt++;
750                 }
751         }
752
753         if (ok_cnt && port->interrupt_in_urb) {
754                 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
755                 if (err) {
756                         dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
757                                 __func__, err);
758                 }
759         }
760
761         if (ok_cnt > 0) /* at least one rx urb submitted */
762                 return 0;
763         else
764                 return err;
765 }
766
767 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
768                                         int dir, void *ctx, int len,
769                                         gfp_t mem_flags,
770                                         usb_complete_t callback)
771 {
772         struct urb      *urb;
773         u8              *buf;
774
775         if (endpoint == -1)
776                 return NULL;
777
778         urb = usb_alloc_urb(0, mem_flags);
779         if (urb == NULL) {
780                 dev_dbg(&serial->dev->dev, "%s: alloc for endpoint %d failed\n",
781                         __func__, endpoint);
782                 return NULL;
783         }
784
785         buf = kmalloc(len, mem_flags);
786         if (buf) {
787                 /* Fill URB using supplied data */
788                 usb_fill_bulk_urb(urb, serial->dev,
789                         usb_sndbulkpipe(serial->dev, endpoint) | dir,
790                         buf, len, callback, ctx);
791
792                 /* debug */
793                 dev_dbg(&serial->dev->dev, "%s %c u : %p d:%p\n", __func__,
794                                 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
795         } else {
796                 dev_dbg(&serial->dev->dev, "%s %c u:%p d:%p\n", __func__,
797                                 dir == USB_DIR_IN ? 'i' : 'o', urb, buf);
798
799                 sierra_release_urb(urb);
800                 urb = NULL;
801         }
802
803         return urb;
804 }
805
806 static void sierra_close(struct usb_serial_port *port)
807 {
808         int i;
809         struct usb_serial *serial = port->serial;
810         struct sierra_port_private *portdata;
811         struct sierra_intf_private *intfdata = port->serial->private;
812         struct urb *urb;
813
814
815         dev_dbg(&port->dev, "%s\n", __func__);
816         portdata = usb_get_serial_port_data(port);
817
818         portdata->rts_state = 0;
819         portdata->dtr_state = 0;
820
821         if (serial->dev) {
822                 mutex_lock(&serial->disc_mutex);
823                 if (!serial->disconnected) {
824                         /* odd error handling due to pm counters */
825                         if (!usb_autopm_get_interface(serial->interface))
826                                 sierra_send_setup(port);
827                         else
828                                 usb_autopm_get_interface_no_resume(serial->interface);
829                                 
830                 }
831                 mutex_unlock(&serial->disc_mutex);
832                 spin_lock_irq(&intfdata->susp_lock);
833                 portdata->opened = 0;
834                 if (--intfdata->open_ports == 0)
835                         serial->interface->needs_remote_wakeup = 0;
836                 spin_unlock_irq(&intfdata->susp_lock);
837
838                 for (;;) {
839                         urb = usb_get_from_anchor(&portdata->delayed);
840                         if (!urb)
841                                 break;
842                         kfree(urb->transfer_buffer);
843                         usb_free_urb(urb);
844                         usb_autopm_put_interface_async(serial->interface);
845                         spin_lock(&portdata->lock);
846                         portdata->outstanding_urbs--;
847                         spin_unlock(&portdata->lock);
848                 }
849
850                 /* Stop reading urbs */
851                 sierra_stop_rx_urbs(port);
852                 /* .. and release them */
853                 for (i = 0; i < portdata->num_in_urbs; i++) {
854                         sierra_release_urb(portdata->in_urbs[i]);
855                         portdata->in_urbs[i] = NULL;
856                 }
857         }
858 }
859
860 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
861 {
862         struct sierra_port_private *portdata;
863         struct usb_serial *serial = port->serial;
864         struct sierra_intf_private *intfdata = serial->private;
865         int i;
866         int err;
867         int endpoint;
868         struct urb *urb;
869
870         portdata = usb_get_serial_port_data(port);
871
872         dev_dbg(&port->dev, "%s\n", __func__);
873
874         /* Set some sane defaults */
875         portdata->rts_state = 1;
876         portdata->dtr_state = 1;
877
878
879         endpoint = port->bulk_in_endpointAddress;
880         for (i = 0; i < portdata->num_in_urbs; i++) {
881                 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
882                                         IN_BUFLEN, GFP_KERNEL,
883                                         sierra_indat_callback);
884                 portdata->in_urbs[i] = urb;
885         }
886         /* clear halt condition */
887         usb_clear_halt(serial->dev,
888                         usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
889
890         err = sierra_submit_rx_urbs(port, GFP_KERNEL);
891         if (err)
892                 goto err_submit;
893
894         sierra_send_setup(port);
895
896         spin_lock_irq(&intfdata->susp_lock);
897         portdata->opened = 1;
898         if (++intfdata->open_ports == 1)
899                 serial->interface->needs_remote_wakeup = 1;
900         spin_unlock_irq(&intfdata->susp_lock);
901         usb_autopm_put_interface(serial->interface);
902
903         return 0;
904
905 err_submit:
906         sierra_stop_rx_urbs(port);
907
908         for (i = 0; i < portdata->num_in_urbs; i++) {
909                 sierra_release_urb(portdata->in_urbs[i]);
910                 portdata->in_urbs[i] = NULL;
911         }
912
913         return err;
914 }
915
916
917 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
918 {
919         struct sierra_port_private *portdata;
920
921         portdata = usb_get_serial_port_data(port);
922         portdata->rts_state = on;
923         portdata->dtr_state = on;
924
925         sierra_send_setup(port);
926 }
927
928 static int sierra_startup(struct usb_serial *serial)
929 {
930         struct usb_serial_port *port;
931         struct sierra_intf_private *intfdata;
932         struct sierra_port_private *portdata;
933         struct sierra_iface_info *himemoryp = NULL;
934         int i;
935         u8 ifnum;
936
937         dev_dbg(&serial->dev->dev, "%s\n", __func__);
938
939         intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
940         if (!intfdata)
941                 return -ENOMEM;
942
943         spin_lock_init(&intfdata->susp_lock);
944
945         usb_set_serial_data(serial, intfdata);
946
947         /* Set Device mode to D0 */
948         sierra_set_power_state(serial->dev, 0x0000);
949
950         /* Check NMEA and set */
951         if (nmea)
952                 sierra_vsc_set_nmea(serial->dev, 1);
953
954         /* Now setup per port private data */
955         for (i = 0; i < serial->num_ports; i++) {
956                 port = serial->port[i];
957                 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
958                 if (!portdata) {
959                         dev_dbg(&port->dev, "%s: kmalloc for "
960                                 "sierra_port_private (%d) failed!\n",
961                                 __func__, i);
962                         goto err;
963                 }
964                 spin_lock_init(&portdata->lock);
965                 init_usb_anchor(&portdata->active);
966                 init_usb_anchor(&portdata->delayed);
967                 ifnum = i;
968                 /* Assume low memory requirements */
969                 portdata->num_out_urbs = N_OUT_URB;
970                 portdata->num_in_urbs  = N_IN_URB;
971
972                 /* Determine actual memory requirements */
973                 if (serial->num_ports == 1) {
974                         /* Get interface number for composite device */
975                         ifnum = sierra_calc_interface(serial);
976                         himemoryp =
977                             (struct sierra_iface_info *)&typeB_interface_list;
978                         if (is_himemory(ifnum, himemoryp)) {
979                                 portdata->num_out_urbs = N_OUT_URB_HM;
980                                 portdata->num_in_urbs  = N_IN_URB_HM;
981                         }
982                 }
983                 else {
984                         himemoryp =
985                             (struct sierra_iface_info *)&typeA_interface_list;
986                         if (is_himemory(i, himemoryp)) {
987                                 portdata->num_out_urbs = N_OUT_URB_HM;
988                                 portdata->num_in_urbs  = N_IN_URB_HM;
989                         }
990                 }
991                 dev_dbg(&serial->dev->dev,
992                         "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
993                         ifnum,portdata->num_in_urbs, portdata->num_out_urbs );
994                 /* Set the port private data pointer */
995                 usb_set_serial_port_data(port, portdata);
996         }
997
998         return 0;
999 err:
1000         for (--i; i >= 0; --i) {
1001                 portdata = usb_get_serial_port_data(serial->port[i]);
1002                 kfree(portdata);
1003         }
1004         kfree(intfdata);
1005
1006         return -ENOMEM;
1007 }
1008
1009 static void sierra_release(struct usb_serial *serial)
1010 {
1011         int i;
1012         struct usb_serial_port *port;
1013         struct sierra_port_private *portdata;
1014
1015         dev_dbg(&serial->dev->dev, "%s\n", __func__);
1016
1017         for (i = 0; i < serial->num_ports; ++i) {
1018                 port = serial->port[i];
1019                 if (!port)
1020                         continue;
1021                 portdata = usb_get_serial_port_data(port);
1022                 if (!portdata)
1023                         continue;
1024                 kfree(portdata);
1025         }
1026         kfree(serial->private);
1027 }
1028
1029 #ifdef CONFIG_PM
1030 static void stop_read_write_urbs(struct usb_serial *serial)
1031 {
1032         int i;
1033         struct usb_serial_port *port;
1034         struct sierra_port_private *portdata;
1035
1036         /* Stop reading/writing urbs */
1037         for (i = 0; i < serial->num_ports; ++i) {
1038                 port = serial->port[i];
1039                 portdata = usb_get_serial_port_data(port);
1040                 sierra_stop_rx_urbs(port);
1041                 usb_kill_anchored_urbs(&portdata->active);
1042         }
1043 }
1044
1045 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
1046 {
1047         struct sierra_intf_private *intfdata;
1048         int b;
1049
1050         if (PMSG_IS_AUTO(message)) {
1051                 intfdata = serial->private;
1052                 spin_lock_irq(&intfdata->susp_lock);
1053                 b = intfdata->in_flight;
1054
1055                 if (b) {
1056                         spin_unlock_irq(&intfdata->susp_lock);
1057                         return -EBUSY;
1058                 } else {
1059                         intfdata->suspended = 1;
1060                         spin_unlock_irq(&intfdata->susp_lock);
1061                 }
1062         }
1063         stop_read_write_urbs(serial);
1064
1065         return 0;
1066 }
1067
1068 static int sierra_resume(struct usb_serial *serial)
1069 {
1070         struct usb_serial_port *port;
1071         struct sierra_intf_private *intfdata = serial->private;
1072         struct sierra_port_private *portdata;
1073         struct urb *urb;
1074         int ec = 0;
1075         int i, err;
1076
1077         spin_lock_irq(&intfdata->susp_lock);
1078         for (i = 0; i < serial->num_ports; i++) {
1079                 port = serial->port[i];
1080                 portdata = usb_get_serial_port_data(port);
1081
1082                 while ((urb = usb_get_from_anchor(&portdata->delayed))) {
1083                         usb_anchor_urb(urb, &portdata->active);
1084                         intfdata->in_flight++;
1085                         err = usb_submit_urb(urb, GFP_ATOMIC);
1086                         if (err < 0) {
1087                                 intfdata->in_flight--;
1088                                 usb_unanchor_urb(urb);
1089                                 kfree(urb->transfer_buffer);
1090                                 usb_free_urb(urb);
1091                                 spin_lock(&portdata->lock);
1092                                 portdata->outstanding_urbs--;
1093                                 spin_unlock(&portdata->lock);
1094                                 continue;
1095                         }
1096                 }
1097
1098                 if (portdata->opened) {
1099                         err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1100                         if (err)
1101                                 ec++;
1102                 }
1103         }
1104         intfdata->suspended = 0;
1105         spin_unlock_irq(&intfdata->susp_lock);
1106
1107         return ec ? -EIO : 0;
1108 }
1109
1110 static int sierra_reset_resume(struct usb_interface *intf)
1111 {
1112         struct usb_serial *serial = usb_get_intfdata(intf);
1113         dev_err(&serial->dev->dev, "%s\n", __func__);
1114         return usb_serial_resume(intf);
1115 }
1116 #else
1117 #define sierra_suspend NULL
1118 #define sierra_resume NULL
1119 #define sierra_reset_resume NULL
1120 #endif
1121
1122 static struct usb_driver sierra_driver = {
1123         .name       = "sierra",
1124         .probe      = usb_serial_probe,
1125         .disconnect = usb_serial_disconnect,
1126         .suspend    = usb_serial_suspend,
1127         .resume     = usb_serial_resume,
1128         .reset_resume = sierra_reset_resume,
1129         .id_table   = id_table,
1130         .no_dynamic_id =        1,
1131         .supports_autosuspend = 1,
1132 };
1133
1134 static struct usb_serial_driver sierra_device = {
1135         .driver = {
1136                 .owner =        THIS_MODULE,
1137                 .name =         "sierra",
1138         },
1139         .description       = "Sierra USB modem",
1140         .id_table          = id_table,
1141         .usb_driver        = &sierra_driver,
1142         .calc_num_ports    = sierra_calc_num_ports,
1143         .probe             = sierra_probe,
1144         .open              = sierra_open,
1145         .close             = sierra_close,
1146         .dtr_rts           = sierra_dtr_rts,
1147         .write             = sierra_write,
1148         .write_room        = sierra_write_room,
1149         .set_termios       = sierra_set_termios,
1150         .tiocmget          = sierra_tiocmget,
1151         .tiocmset          = sierra_tiocmset,
1152         .attach            = sierra_startup,
1153         .release           = sierra_release,
1154         .suspend           = sierra_suspend,
1155         .resume            = sierra_resume,
1156         .read_int_callback = sierra_instat_callback,
1157 };
1158
1159 /* Functions used by new usb-serial code. */
1160 static int __init sierra_init(void)
1161 {
1162         int retval;
1163         retval = usb_serial_register(&sierra_device);
1164         if (retval)
1165                 goto failed_device_register;
1166
1167
1168         retval = usb_register(&sierra_driver);
1169         if (retval)
1170                 goto failed_driver_register;
1171
1172         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1173                DRIVER_DESC "\n");
1174
1175         return 0;
1176
1177 failed_driver_register:
1178         usb_serial_deregister(&sierra_device);
1179 failed_device_register:
1180         return retval;
1181 }
1182
1183 static void __exit sierra_exit(void)
1184 {
1185         usb_deregister(&sierra_driver);
1186         usb_serial_deregister(&sierra_device);
1187 }
1188
1189 module_init(sierra_init);
1190 module_exit(sierra_exit);
1191
1192 MODULE_AUTHOR(DRIVER_AUTHOR);
1193 MODULE_DESCRIPTION(DRIVER_DESC);
1194 MODULE_VERSION(DRIVER_VERSION);
1195 MODULE_LICENSE("GPL");
1196
1197 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1198 MODULE_PARM_DESC(nmea, "NMEA streaming");
1199
1200 module_param(debug, bool, S_IRUGO | S_IWUSR);
1201 MODULE_PARM_DESC(debug, "Debug messages");