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