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