?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux 4.2.1
[linux/fpc-iii.git] / drivers / usb / serial / sierra.c
blob07d1ecd564f79d9c51798f6941b1295d794d468c
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 { USB_DEVICE(0x1199, 0x68AB) }, /* Sierra Wireless AR8550 */
293 /* AT&T Direct IP LTE modems */
294 { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68AA, 0xFF, 0xFF, 0xFF),
295 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
296 },
297 /* Airprime/Sierra Wireless Direct IP modems */
298 { USB_DEVICE_AND_INTERFACE_INFO(0x0F3D, 0x68A3, 0xFF, 0xFF, 0xFF),
299 .driver_info = (kernel_ulong_t)&direct_ip_interface_blacklist
300 },
301
302 { }
303 };
304 MODULE_DEVICE_TABLE(usb, id_table);
305
306
307 struct sierra_port_private {
308 spinlock_t lock; /* lock the structure */
309 int outstanding_urbs; /* number of out urbs in flight */
310 struct usb_anchor active;
311 struct usb_anchor delayed;
312
313 int num_out_urbs;
314 int num_in_urbs;
315 /* Input endpoints and buffers for this port */
316 struct urb *in_urbs[N_IN_URB_HM];
317
318 /* Settings for the port */
319 int rts_state; /* Handshaking pins (outputs) */
320 int dtr_state;
321 int cts_state; /* Handshaking pins (inputs) */
322 int dsr_state;
323 int dcd_state;
324 int ri_state;
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_sndctrlpipe(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 int sierra_tiocmget(struct tty_struct *tty)
381 {
382 struct usb_serial_port *port = tty->driver_data;
383 unsigned int value;
384 struct sierra_port_private *portdata;
385
386 portdata = usb_get_serial_port_data(port);
387
388 value = ((portdata->rts_state) ? TIOCM_RTS : 0) |
389 ((portdata->dtr_state) ? TIOCM_DTR : 0) |
390 ((portdata->cts_state) ? TIOCM_CTS : 0) |
391 ((portdata->dsr_state) ? TIOCM_DSR : 0) |
392 ((portdata->dcd_state) ? TIOCM_CAR : 0) |
393 ((portdata->ri_state) ? TIOCM_RNG : 0);
394
395 return value;
396 }
397
398 static int sierra_tiocmset(struct tty_struct *tty,
399 unsigned int set, unsigned int clear)
400 {
401 struct usb_serial_port *port = tty->driver_data;
402 struct sierra_port_private *portdata;
403
404 portdata = usb_get_serial_port_data(port);
405
406 if (set & TIOCM_RTS)
407 portdata->rts_state = 1;
408 if (set & TIOCM_DTR)
409 portdata->dtr_state = 1;
410
411 if (clear & TIOCM_RTS)
412 portdata->rts_state = 0;
413 if (clear & TIOCM_DTR)
414 portdata->dtr_state = 0;
415 return sierra_send_setup(port);
416 }
417
418 static void sierra_release_urb(struct urb *urb)
419 {
420 if (urb) {
421 kfree(urb->transfer_buffer);
422 usb_free_urb(urb);
423 }
424 }
425
426 static void sierra_outdat_callback(struct urb *urb)
427 {
428 struct usb_serial_port *port = urb->context;
429 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
430 struct sierra_intf_private *intfdata;
431 int status = urb->status;
432
433 intfdata = usb_get_serial_data(port->serial);
434
435 /* free up the transfer buffer, as usb_free_urb() does not do this */
436 kfree(urb->transfer_buffer);
437 usb_autopm_put_interface_async(port->serial->interface);
438 if (status)
439 dev_dbg(&port->dev, "%s - nonzero write bulk status "
440 "received: %d\n", __func__, status);
441
442 spin_lock(&portdata->lock);
443 --portdata->outstanding_urbs;
444 spin_unlock(&portdata->lock);
445 spin_lock(&intfdata->susp_lock);
446 --intfdata->in_flight;
447 spin_unlock(&intfdata->susp_lock);
448
449 usb_serial_port_softint(port);
450 }
451
452 /* Write */
453 static int sierra_write(struct tty_struct *tty, struct usb_serial_port *port,
454 const unsigned char *buf, int count)
455 {
456 struct sierra_port_private *portdata;
457 struct sierra_intf_private *intfdata;
458 struct usb_serial *serial = port->serial;
459 unsigned long flags;
460 unsigned char *buffer;
461 struct urb *urb;
462 size_t writesize = min((size_t)count, (size_t)MAX_TRANSFER);
463 int retval = 0;
464
465 /* verify that we actually have some data to write */
466 if (count == 0)
467 return 0;
468
469 portdata = usb_get_serial_port_data(port);
470 intfdata = usb_get_serial_data(serial);
471
472 dev_dbg(&port->dev, "%s: write (%zd bytes)\n", __func__, writesize);
473 spin_lock_irqsave(&portdata->lock, flags);
474 dev_dbg(&port->dev, "%s - outstanding_urbs: %d\n", __func__,
475 portdata->outstanding_urbs);
476 if (portdata->outstanding_urbs > portdata->num_out_urbs) {
477 spin_unlock_irqrestore(&portdata->lock, flags);
478 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
479 return 0;
480 }
481 portdata->outstanding_urbs++;
482 dev_dbg(&port->dev, "%s - 1, outstanding_urbs: %d\n", __func__,
483 portdata->outstanding_urbs);
484 spin_unlock_irqrestore(&portdata->lock, flags);
485
486 retval = usb_autopm_get_interface_async(serial->interface);
487 if (retval < 0) {
488 spin_lock_irqsave(&portdata->lock, flags);
489 portdata->outstanding_urbs--;
490 spin_unlock_irqrestore(&portdata->lock, flags);
491 goto error_simple;
492 }
493
494 buffer = kmalloc(writesize, GFP_ATOMIC);
495 if (!buffer) {
496 retval = -ENOMEM;
497 goto error_no_buffer;
498 }
499
500 urb = usb_alloc_urb(0, GFP_ATOMIC);
501 if (!urb) {
502 retval = -ENOMEM;
503 goto error_no_urb;
504 }
505
506 memcpy(buffer, buf, writesize);
507
508 usb_serial_debug_data(&port->dev, __func__, writesize, buffer);
509
510 usb_fill_bulk_urb(urb, serial->dev,
511 usb_sndbulkpipe(serial->dev,
512 port->bulk_out_endpointAddress),
513 buffer, writesize, sierra_outdat_callback, port);
514
515 /* Handle the need to send a zero length packet */
516 urb->transfer_flags |= URB_ZERO_PACKET;
517
518 spin_lock_irqsave(&intfdata->susp_lock, flags);
519
520 if (intfdata->suspended) {
521 usb_anchor_urb(urb, &portdata->delayed);
522 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
523 goto skip_power;
524 } else {
525 usb_anchor_urb(urb, &portdata->active);
526 }
527 /* send it down the pipe */
528 retval = usb_submit_urb(urb, GFP_ATOMIC);
529 if (retval) {
530 usb_unanchor_urb(urb);
531 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
532 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
533 "with status = %d\n", __func__, retval);
534 goto error;
535 } else {
536 intfdata->in_flight++;
537 spin_unlock_irqrestore(&intfdata->susp_lock, flags);
538 }
539
540 skip_power:
541 /* we are done with this urb, so let the host driver
542 * really free it when it is finished with it */
543 usb_free_urb(urb);
544
545 return writesize;
546 error:
547 usb_free_urb(urb);
548 error_no_urb:
549 kfree(buffer);
550 error_no_buffer:
551 spin_lock_irqsave(&portdata->lock, flags);
552 --portdata->outstanding_urbs;
553 dev_dbg(&port->dev, "%s - 2. outstanding_urbs: %d\n", __func__,
554 portdata->outstanding_urbs);
555 spin_unlock_irqrestore(&portdata->lock, flags);
556 usb_autopm_put_interface_async(serial->interface);
557 error_simple:
558 return retval;
559 }
560
561 static void sierra_indat_callback(struct urb *urb)
562 {
563 int err;
564 int endpoint;
565 struct usb_serial_port *port;
566 unsigned char *data = urb->transfer_buffer;
567 int status = urb->status;
568
569 endpoint = usb_pipeendpoint(urb->pipe);
570 port = urb->context;
571
572 if (status) {
573 dev_dbg(&port->dev, "%s: nonzero status: %d on"
574 " endpoint %02x\n", __func__, status, endpoint);
575 } else {
576 if (urb->actual_length) {
577 tty_insert_flip_string(&port->port, data,
578 urb->actual_length);
579 tty_flip_buffer_push(&port->port);
580
581 usb_serial_debug_data(&port->dev, __func__,
582 urb->actual_length, data);
583 } else {
584 dev_dbg(&port->dev, "%s: empty read urb"
585 " received\n", __func__);
586 }
587 }
588
589 /* Resubmit urb so we continue receiving */
590 if (status != -ESHUTDOWN && status != -EPERM) {
591 usb_mark_last_busy(port->serial->dev);
592 err = usb_submit_urb(urb, GFP_ATOMIC);
593 if (err && err != -EPERM)
594 dev_err(&port->dev, "resubmit read urb failed."
595 "(%d)\n", err);
596 }
597 }
598
599 static void sierra_instat_callback(struct urb *urb)
600 {
601 int err;
602 int status = urb->status;
603 struct usb_serial_port *port = urb->context;
604 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
605 struct usb_serial *serial = port->serial;
606
607 dev_dbg(&port->dev, "%s: urb %p port %p has data %p\n", __func__,
608 urb, port, portdata);
609
610 if (status == 0) {
611 struct usb_ctrlrequest *req_pkt =
612 (struct usb_ctrlrequest *)urb->transfer_buffer;
613
614 if (!req_pkt) {
615 dev_dbg(&port->dev, "%s: NULL req_pkt\n",
616 __func__);
617 return;
618 }
619 if ((req_pkt->bRequestType == 0xA1) &&
620 (req_pkt->bRequest == 0x20)) {
621 int old_dcd_state;
622 unsigned char signals = *((unsigned char *)
623 urb->transfer_buffer +
624 sizeof(struct usb_ctrlrequest));
625
626 dev_dbg(&port->dev, "%s: signal x%x\n", __func__,
627 signals);
628
629 old_dcd_state = portdata->dcd_state;
630 portdata->cts_state = 1;
631 portdata->dcd_state = ((signals & 0x01) ? 1 : 0);
632 portdata->dsr_state = ((signals & 0x02) ? 1 : 0);
633 portdata->ri_state = ((signals & 0x08) ? 1 : 0);
634
635 if (old_dcd_state && !portdata->dcd_state)
636 tty_port_tty_hangup(&port->port, true);
637 } else {
638 dev_dbg(&port->dev, "%s: type %x req %x\n",
639 __func__, req_pkt->bRequestType,
640 req_pkt->bRequest);
641 }
642 } else
643 dev_dbg(&port->dev, "%s: error %d\n", __func__, status);
644
645 /* Resubmit urb so we continue receiving IRQ data */
646 if (status != -ESHUTDOWN && status != -ENOENT) {
647 usb_mark_last_busy(serial->dev);
648 err = usb_submit_urb(urb, GFP_ATOMIC);
649 if (err && err != -EPERM)
650 dev_err(&port->dev, "%s: resubmit intr urb "
651 "failed. (%d)\n", __func__, err);
652 }
653 }
654
655 static int sierra_write_room(struct tty_struct *tty)
656 {
657 struct usb_serial_port *port = tty->driver_data;
658 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
659 unsigned long flags;
660
661 /* try to give a good number back based on if we have any free urbs at
662 * this point in time */
663 spin_lock_irqsave(&portdata->lock, flags);
664 if (portdata->outstanding_urbs > (portdata->num_out_urbs * 2) / 3) {
665 spin_unlock_irqrestore(&portdata->lock, flags);
666 dev_dbg(&port->dev, "%s - write limit hit\n", __func__);
667 return 0;
668 }
669 spin_unlock_irqrestore(&portdata->lock, flags);
670
671 return 2048;
672 }
673
674 static int sierra_chars_in_buffer(struct tty_struct *tty)
675 {
676 struct usb_serial_port *port = tty->driver_data;
677 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
678 unsigned long flags;
679 int chars;
680
681 /* NOTE: This overcounts somewhat. */
682 spin_lock_irqsave(&portdata->lock, flags);
683 chars = portdata->outstanding_urbs * MAX_TRANSFER;
684 spin_unlock_irqrestore(&portdata->lock, flags);
685
686 dev_dbg(&port->dev, "%s - %d\n", __func__, chars);
687
688 return chars;
689 }
690
691 static void sierra_stop_rx_urbs(struct usb_serial_port *port)
692 {
693 int i;
694 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
695
696 for (i = 0; i < portdata->num_in_urbs; i++)
697 usb_kill_urb(portdata->in_urbs[i]);
698
699 usb_kill_urb(port->interrupt_in_urb);
700 }
701
702 static int sierra_submit_rx_urbs(struct usb_serial_port *port, gfp_t mem_flags)
703 {
704 int ok_cnt;
705 int err = -EINVAL;
706 int i;
707 struct urb *urb;
708 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
709
710 ok_cnt = 0;
711 for (i = 0; i < portdata->num_in_urbs; i++) {
712 urb = portdata->in_urbs[i];
713 if (!urb)
714 continue;
715 err = usb_submit_urb(urb, mem_flags);
716 if (err) {
717 dev_err(&port->dev, "%s: submit urb failed: %d\n",
718 __func__, err);
719 } else {
720 ok_cnt++;
721 }
722 }
723
724 if (ok_cnt && port->interrupt_in_urb) {
725 err = usb_submit_urb(port->interrupt_in_urb, mem_flags);
726 if (err) {
727 dev_err(&port->dev, "%s: submit intr urb failed: %d\n",
728 __func__, err);
729 }
730 }
731
732 if (ok_cnt > 0) /* at least one rx urb submitted */
733 return 0;
734 else
735 return err;
736 }
737
738 static struct urb *sierra_setup_urb(struct usb_serial *serial, int endpoint,
739 int dir, void *ctx, int len,
740 gfp_t mem_flags,
741 usb_complete_t callback)
742 {
743 struct urb *urb;
744 u8 *buf;
745
746 urb = usb_alloc_urb(0, mem_flags);
747 if (!urb)
748 return NULL;
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 sierra_release_urb(urb);
761 urb = NULL;
762 }
763
764 return urb;
765 }
766
767 static void sierra_close(struct usb_serial_port *port)
768 {
769 int i;
770 struct usb_serial *serial = port->serial;
771 struct sierra_port_private *portdata;
772 struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
773 struct urb *urb;
774
775 portdata = usb_get_serial_port_data(port);
776
777 /*
778 * Need to take susp_lock to make sure port is not already being
779 * resumed, but no need to hold it due to ASYNC_INITIALIZED.
780 */
781 spin_lock_irq(&intfdata->susp_lock);
782 if (--intfdata->open_ports == 0)
783 serial->interface->needs_remote_wakeup = 0;
784 spin_unlock_irq(&intfdata->susp_lock);
785
786 for (;;) {
787 urb = usb_get_from_anchor(&portdata->delayed);
788 if (!urb)
789 break;
790 kfree(urb->transfer_buffer);
791 usb_free_urb(urb);
792 usb_autopm_put_interface_async(serial->interface);
793 spin_lock(&portdata->lock);
794 portdata->outstanding_urbs--;
795 spin_unlock(&portdata->lock);
796 }
797
798 sierra_stop_rx_urbs(port);
799 usb_kill_anchored_urbs(&portdata->active);
800
801 for (i = 0; i < portdata->num_in_urbs; i++) {
802 sierra_release_urb(portdata->in_urbs[i]);
803 portdata->in_urbs[i] = NULL;
804 }
805
806 usb_autopm_get_interface_no_resume(serial->interface);
807 }
808
809 static int sierra_open(struct tty_struct *tty, struct usb_serial_port *port)
810 {
811 struct sierra_port_private *portdata;
812 struct usb_serial *serial = port->serial;
813 struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
814 int i;
815 int err;
816 int endpoint;
817 struct urb *urb;
818
819 portdata = usb_get_serial_port_data(port);
820
821 endpoint = port->bulk_in_endpointAddress;
822 for (i = 0; i < portdata->num_in_urbs; i++) {
823 urb = sierra_setup_urb(serial, endpoint, USB_DIR_IN, port,
824 IN_BUFLEN, GFP_KERNEL,
825 sierra_indat_callback);
826 portdata->in_urbs[i] = urb;
827 }
828 /* clear halt condition */
829 usb_clear_halt(serial->dev,
830 usb_sndbulkpipe(serial->dev, endpoint) | USB_DIR_IN);
831
832 err = sierra_submit_rx_urbs(port, GFP_KERNEL);
833 if (err)
834 goto err_submit;
835
836 spin_lock_irq(&intfdata->susp_lock);
837 if (++intfdata->open_ports == 1)
838 serial->interface->needs_remote_wakeup = 1;
839 spin_unlock_irq(&intfdata->susp_lock);
840 usb_autopm_put_interface(serial->interface);
841
842 return 0;
843
844 err_submit:
845 sierra_stop_rx_urbs(port);
846
847 for (i = 0; i < portdata->num_in_urbs; i++) {
848 sierra_release_urb(portdata->in_urbs[i]);
849 portdata->in_urbs[i] = NULL;
850 }
851
852 return err;
853 }
854
855
856 static void sierra_dtr_rts(struct usb_serial_port *port, int on)
857 {
858 struct sierra_port_private *portdata;
859
860 portdata = usb_get_serial_port_data(port);
861 portdata->rts_state = on;
862 portdata->dtr_state = on;
863
864 sierra_send_setup(port);
865 }
866
867 static int sierra_startup(struct usb_serial *serial)
868 {
869 struct sierra_intf_private *intfdata;
870
871 intfdata = kzalloc(sizeof(*intfdata), GFP_KERNEL);
872 if (!intfdata)
873 return -ENOMEM;
874
875 spin_lock_init(&intfdata->susp_lock);
876
877 usb_set_serial_data(serial, intfdata);
878
879 /* Set Device mode to D0 */
880 sierra_set_power_state(serial->dev, 0x0000);
881
882 /* Check NMEA and set */
883 if (nmea)
884 sierra_vsc_set_nmea(serial->dev, 1);
885
886 return 0;
887 }
888
889 static void sierra_release(struct usb_serial *serial)
890 {
891 struct sierra_intf_private *intfdata;
892
893 intfdata = usb_get_serial_data(serial);
894 kfree(intfdata);
895 }
896
897 static int sierra_port_probe(struct usb_serial_port *port)
898 {
899 struct usb_serial *serial = port->serial;
900 struct sierra_port_private *portdata;
901 const struct sierra_iface_info *himemoryp;
902 u8 ifnum;
903
904 portdata = kzalloc(sizeof(*portdata), GFP_KERNEL);
905 if (!portdata)
906 return -ENOMEM;
907
908 spin_lock_init(&portdata->lock);
909 init_usb_anchor(&portdata->active);
910 init_usb_anchor(&portdata->delayed);
911
912 /* Assume low memory requirements */
913 portdata->num_out_urbs = N_OUT_URB;
914 portdata->num_in_urbs = N_IN_URB;
915
916 /* Determine actual memory requirements */
917 if (serial->num_ports == 1) {
918 /* Get interface number for composite device */
919 ifnum = sierra_calc_interface(serial);
920 himemoryp = &typeB_interface_list;
921 } else {
922 /* This is really the usb-serial port number of the interface
923 * rather than the interface number.
924 */
925 ifnum = port->port_number;
926 himemoryp = &typeA_interface_list;
927 }
928
929 if (is_himemory(ifnum, himemoryp)) {
930 portdata->num_out_urbs = N_OUT_URB_HM;
931 portdata->num_in_urbs = N_IN_URB_HM;
932 }
933
934 dev_dbg(&port->dev,
935 "Memory usage (urbs) interface #%d, in=%d, out=%d\n",
936 ifnum, portdata->num_in_urbs, portdata->num_out_urbs);
937
938 usb_set_serial_port_data(port, portdata);
939
940 return 0;
941 }
942
943 static int sierra_port_remove(struct usb_serial_port *port)
944 {
945 struct sierra_port_private *portdata;
946
947 portdata = usb_get_serial_port_data(port);
948 usb_set_serial_port_data(port, NULL);
949 kfree(portdata);
950
951 return 0;
952 }
953
954 #ifdef CONFIG_PM
955 static void stop_read_write_urbs(struct usb_serial *serial)
956 {
957 int i;
958 struct usb_serial_port *port;
959 struct sierra_port_private *portdata;
960
961 /* Stop reading/writing urbs */
962 for (i = 0; i < serial->num_ports; ++i) {
963 port = serial->port[i];
964 portdata = usb_get_serial_port_data(port);
965 if (!portdata)
966 continue;
967 sierra_stop_rx_urbs(port);
968 usb_kill_anchored_urbs(&portdata->active);
969 }
970 }
971
972 static int sierra_suspend(struct usb_serial *serial, pm_message_t message)
973 {
974 struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
975
976 spin_lock_irq(&intfdata->susp_lock);
977 if (PMSG_IS_AUTO(message)) {
978 if (intfdata->in_flight) {
979 spin_unlock_irq(&intfdata->susp_lock);
980 return -EBUSY;
981 }
982 }
983 intfdata->suspended = 1;
984 spin_unlock_irq(&intfdata->susp_lock);
985
986 stop_read_write_urbs(serial);
987
988 return 0;
989 }
990
991 /* Caller must hold susp_lock. */
992 static int sierra_submit_delayed_urbs(struct usb_serial_port *port)
993 {
994 struct sierra_port_private *portdata = usb_get_serial_port_data(port);
995 struct sierra_intf_private *intfdata;
996 struct urb *urb;
997 int ec = 0;
998 int err;
999
1000 intfdata = usb_get_serial_data(port->serial);
1001
1002 for (;;) {
1003 urb = usb_get_from_anchor(&portdata->delayed);
1004 if (!urb)
1005 break;
1006
1007 usb_anchor_urb(urb, &portdata->active);
1008 intfdata->in_flight++;
1009 err = usb_submit_urb(urb, GFP_ATOMIC);
1010 if (err) {
1011 dev_err(&port->dev, "%s - submit urb failed: %d",
1012 __func__, err);
1013 ec++;
1014 intfdata->in_flight--;
1015 usb_unanchor_urb(urb);
1016 kfree(urb->transfer_buffer);
1017 usb_free_urb(urb);
1018
1019 spin_lock(&portdata->lock);
1020 portdata->outstanding_urbs--;
1021 spin_unlock(&portdata->lock);
1022 }
1023 }
1024
1025 if (ec)
1026 return -EIO;
1027
1028 return 0;
1029 }
1030
1031 static int sierra_resume(struct usb_serial *serial)
1032 {
1033 struct usb_serial_port *port;
1034 struct sierra_intf_private *intfdata = usb_get_serial_data(serial);
1035 int ec = 0;
1036 int i, err;
1037
1038 spin_lock_irq(&intfdata->susp_lock);
1039 for (i = 0; i < serial->num_ports; i++) {
1040 port = serial->port[i];
1041
1042 if (!test_bit(ASYNCB_INITIALIZED, &port->port.flags))
1043 continue;
1044
1045 err = sierra_submit_delayed_urbs(port);
1046 if (err)
1047 ec++;
1048
1049 err = sierra_submit_rx_urbs(port, GFP_ATOMIC);
1050 if (err)
1051 ec++;
1052 }
1053 intfdata->suspended = 0;
1054 spin_unlock_irq(&intfdata->susp_lock);
1055
1056 return ec ? -EIO : 0;
1057 }
1058
1059 #else
1060 #define sierra_suspend NULL
1061 #define sierra_resume NULL
1062 #endif
1063
1064 static struct usb_serial_driver sierra_device = {
1065 .driver = {
1066 .owner = THIS_MODULE,
1067 .name = "sierra",
1068 },
1069 .description = "Sierra USB modem",
1070 .id_table = id_table,
1071 .calc_num_ports = sierra_calc_num_ports,
1072 .probe = sierra_probe,
1073 .open = sierra_open,
1074 .close = sierra_close,
1075 .dtr_rts = sierra_dtr_rts,
1076 .write = sierra_write,
1077 .write_room = sierra_write_room,
1078 .chars_in_buffer = sierra_chars_in_buffer,
1079 .tiocmget = sierra_tiocmget,
1080 .tiocmset = sierra_tiocmset,
1081 .attach = sierra_startup,
1082 .release = sierra_release,
1083 .port_probe = sierra_port_probe,
1084 .port_remove = sierra_port_remove,
1085 .suspend = sierra_suspend,
1086 .resume = sierra_resume,
1087 .read_int_callback = sierra_instat_callback,
1088 };
1089
1090 static struct usb_serial_driver * const serial_drivers[] = {
1091 &sierra_device, NULL
1092 };
1093
1094 module_usb_serial_driver(serial_drivers, id_table);
1095
1096 MODULE_AUTHOR(DRIVER_AUTHOR);
1097 MODULE_DESCRIPTION(DRIVER_DESC);
1098 MODULE_LICENSE("GPL");
1099
1100 module_param(nmea, bool, S_IRUGO | S_IWUSR);
1101 MODULE_PARM_DESC(nmea, "NMEA streaming");
Linux with added FPC-III support