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