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