cdc-acm: add sanity checks
[pandora-kernel.git] / drivers / usb / class / cdc-acm.c
1 /*
2  * cdc-acm.c
3  *
4  * Copyright (c) 1999 Armin Fuerst      <fuerst@in.tum.de>
5  * Copyright (c) 1999 Pavel Machek      <pavel@ucw.cz>
6  * Copyright (c) 1999 Johannes Erdfelt  <johannes@erdfelt.com>
7  * Copyright (c) 2000 Vojtech Pavlik    <vojtech@suse.cz>
8  * Copyright (c) 2004 Oliver Neukum     <oliver@neukum.name>
9  * Copyright (c) 2005 David Kubicek     <dave@awk.cz>
10  * Copyright (c) 2011 Johan Hovold      <jhovold@gmail.com>
11  *
12  * USB Abstract Control Model driver for USB modems and ISDN adapters
13  *
14  * Sponsored by SuSE
15  *
16  * This program is free software; you can redistribute it and/or modify
17  * it under the terms of the GNU General Public License as published by
18  * the Free Software Foundation; either version 2 of the License, or
19  * (at your option) any later version.
20  *
21  * This program is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, write to the Free Software
28  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29  */
30
31 #undef DEBUG
32 #undef VERBOSE_DEBUG
33
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/serial.h>
40 #include <linux/tty_driver.h>
41 #include <linux/tty_flip.h>
42 #include <linux/module.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/usb/cdc.h>
47 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
49 #include <linux/list.h>
50
51 #include "cdc-acm.h"
52
53
54 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
55 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
56
57 static struct usb_driver acm_driver;
58 static struct tty_driver *acm_tty_driver;
59 static struct acm *acm_table[ACM_TTY_MINORS];
60
61 static DEFINE_MUTEX(open_mutex);
62
63 #define ACM_READY(acm)  (acm && acm->dev && acm->port.count)
64
65 static const struct tty_port_operations acm_port_ops = {
66 };
67
68 /*
69  * Functions for ACM control messages.
70  */
71
72 static int acm_ctrl_msg(struct acm *acm, int request, int value,
73                                                         void *buf, int len)
74 {
75         int retval;
76
77         retval = usb_autopm_get_interface(acm->control);
78         if (retval)
79                 return retval;
80
81         retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
82                 request, USB_RT_ACM, value,
83                 acm->control->altsetting[0].desc.bInterfaceNumber,
84                 buf, len, 5000);
85
86         dev_dbg(&acm->control->dev,
87                         "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
88                         __func__, request, value, len, retval);
89
90         usb_autopm_put_interface(acm->control);
91
92         return retval < 0 ? retval : 0;
93 }
94
95 /* devices aren't required to support these requests.
96  * the cdc acm descriptor tells whether they do...
97  */
98 #define acm_set_control(acm, control) \
99         acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
100 #define acm_set_line(acm, line) \
101         acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
102 #define acm_send_break(acm, ms) \
103         acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
104
105 /*
106  * Write buffer management.
107  * All of these assume proper locks taken by the caller.
108  */
109
110 static int acm_wb_alloc(struct acm *acm)
111 {
112         int i, wbn;
113         struct acm_wb *wb;
114
115         wbn = 0;
116         i = 0;
117         for (;;) {
118                 wb = &acm->wb[wbn];
119                 if (!wb->use) {
120                         wb->use = 1;
121                         return wbn;
122                 }
123                 wbn = (wbn + 1) % ACM_NW;
124                 if (++i >= ACM_NW)
125                         return -1;
126         }
127 }
128
129 static int acm_wb_is_avail(struct acm *acm)
130 {
131         int i, n;
132         unsigned long flags;
133
134         n = ACM_NW;
135         spin_lock_irqsave(&acm->write_lock, flags);
136         for (i = 0; i < ACM_NW; i++)
137                 n -= acm->wb[i].use;
138         spin_unlock_irqrestore(&acm->write_lock, flags);
139         return n;
140 }
141
142 /*
143  * Finish write. Caller must hold acm->write_lock
144  */
145 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
146 {
147         wb->use = 0;
148         acm->transmitting--;
149         usb_autopm_put_interface_async(acm->control);
150 }
151
152 /*
153  * Poke write.
154  *
155  * the caller is responsible for locking
156  */
157
158 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
159 {
160         int rc;
161
162         acm->transmitting++;
163
164         wb->urb->transfer_buffer = wb->buf;
165         wb->urb->transfer_dma = wb->dmah;
166         wb->urb->transfer_buffer_length = wb->len;
167         wb->urb->dev = acm->dev;
168
169         rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
170         if (rc < 0) {
171                 dev_err(&acm->data->dev,
172                         "%s - usb_submit_urb(write bulk) failed: %d\n",
173                         __func__, rc);
174                 acm_write_done(acm, wb);
175         }
176         return rc;
177 }
178
179 static int acm_write_start(struct acm *acm, int wbn)
180 {
181         unsigned long flags;
182         struct acm_wb *wb = &acm->wb[wbn];
183         int rc;
184
185         spin_lock_irqsave(&acm->write_lock, flags);
186         if (!acm->dev) {
187                 wb->use = 0;
188                 spin_unlock_irqrestore(&acm->write_lock, flags);
189                 return -ENODEV;
190         }
191
192         dev_vdbg(&acm->data->dev, "%s - susp_count %d\n", __func__,
193                                                         acm->susp_count);
194         rc = usb_autopm_get_interface_async(acm->control);
195         if (rc) {
196                 wb->use = 0;
197                 spin_unlock_irqrestore(&acm->write_lock, flags);
198                 return rc;
199         }
200
201         if (acm->susp_count) {
202                 usb_anchor_urb(wb->urb, &acm->delayed);
203                 spin_unlock_irqrestore(&acm->write_lock, flags);
204                 return 0;
205         }
206         usb_mark_last_busy(acm->dev);
207
208         rc = acm_start_wb(acm, wb);
209         spin_unlock_irqrestore(&acm->write_lock, flags);
210
211         return rc;
212
213 }
214 /*
215  * attributes exported through sysfs
216  */
217 static ssize_t show_caps
218 (struct device *dev, struct device_attribute *attr, char *buf)
219 {
220         struct usb_interface *intf = to_usb_interface(dev);
221         struct acm *acm = usb_get_intfdata(intf);
222
223         return sprintf(buf, "%d", acm->ctrl_caps);
224 }
225 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
226
227 static ssize_t show_country_codes
228 (struct device *dev, struct device_attribute *attr, char *buf)
229 {
230         struct usb_interface *intf = to_usb_interface(dev);
231         struct acm *acm = usb_get_intfdata(intf);
232
233         memcpy(buf, acm->country_codes, acm->country_code_size);
234         return acm->country_code_size;
235 }
236
237 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
238
239 static ssize_t show_country_rel_date
240 (struct device *dev, struct device_attribute *attr, char *buf)
241 {
242         struct usb_interface *intf = to_usb_interface(dev);
243         struct acm *acm = usb_get_intfdata(intf);
244
245         return sprintf(buf, "%d", acm->country_rel_date);
246 }
247
248 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
249 /*
250  * Interrupt handlers for various ACM device responses
251  */
252
253 /* control interface reports status changes with "interrupt" transfers */
254 static void acm_ctrl_irq(struct urb *urb)
255 {
256         struct acm *acm = urb->context;
257         struct usb_cdc_notification *dr = urb->transfer_buffer;
258         struct tty_struct *tty;
259         unsigned char *data;
260         int newctrl;
261         int retval;
262         int status = urb->status;
263
264         switch (status) {
265         case 0:
266                 /* success */
267                 break;
268         case -ECONNRESET:
269         case -ENOENT:
270         case -ESHUTDOWN:
271                 /* this urb is terminated, clean up */
272                 dev_dbg(&acm->control->dev,
273                                 "%s - urb shutting down with status: %d\n",
274                                 __func__, status);
275                 return;
276         default:
277                 dev_dbg(&acm->control->dev,
278                                 "%s - nonzero urb status received: %d\n",
279                                 __func__, status);
280                 goto exit;
281         }
282
283         if (!ACM_READY(acm))
284                 goto exit;
285
286         usb_mark_last_busy(acm->dev);
287
288         data = (unsigned char *)(dr + 1);
289         switch (dr->bNotificationType) {
290         case USB_CDC_NOTIFY_NETWORK_CONNECTION:
291                 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
292                                                         __func__, dr->wValue);
293                 break;
294
295         case USB_CDC_NOTIFY_SERIAL_STATE:
296                 tty = tty_port_tty_get(&acm->port);
297                 newctrl = get_unaligned_le16(data);
298
299                 if (tty) {
300                         if (!acm->clocal &&
301                                 (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
302                                 dev_dbg(&acm->control->dev,
303                                         "%s - calling hangup\n", __func__);
304                                 tty_hangup(tty);
305                         }
306                         tty_kref_put(tty);
307                 }
308
309                 acm->ctrlin = newctrl;
310
311                 dev_dbg(&acm->control->dev,
312                         "%s - input control lines: dcd%c dsr%c break%c "
313                         "ring%c framing%c parity%c overrun%c\n",
314                         __func__,
315                         acm->ctrlin & ACM_CTRL_DCD ? '+' : '-',
316                         acm->ctrlin & ACM_CTRL_DSR ? '+' : '-',
317                         acm->ctrlin & ACM_CTRL_BRK ? '+' : '-',
318                         acm->ctrlin & ACM_CTRL_RI  ? '+' : '-',
319                         acm->ctrlin & ACM_CTRL_FRAMING ? '+' : '-',
320                         acm->ctrlin & ACM_CTRL_PARITY ? '+' : '-',
321                         acm->ctrlin & ACM_CTRL_OVERRUN ? '+' : '-');
322                         break;
323
324         default:
325                 dev_dbg(&acm->control->dev,
326                         "%s - unknown notification %d received: index %d "
327                         "len %d data0 %d data1 %d\n",
328                         __func__,
329                         dr->bNotificationType, dr->wIndex,
330                         dr->wLength, data[0], data[1]);
331                 break;
332         }
333 exit:
334         retval = usb_submit_urb(urb, GFP_ATOMIC);
335         if (retval)
336                 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
337                                                         __func__, retval);
338 }
339
340 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
341 {
342         int res;
343
344         if (!test_and_clear_bit(index, &acm->read_urbs_free))
345                 return 0;
346
347         dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
348
349         res = usb_submit_urb(acm->read_urbs[index], mem_flags);
350         if (res) {
351                 if (res != -EPERM) {
352                         dev_err(&acm->data->dev,
353                                         "%s - usb_submit_urb failed: %d\n",
354                                         __func__, res);
355                 }
356                 set_bit(index, &acm->read_urbs_free);
357                 return res;
358         }
359
360         return 0;
361 }
362
363 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
364 {
365         int res;
366         int i;
367
368         for (i = 0; i < acm->rx_buflimit; ++i) {
369                 res = acm_submit_read_urb(acm, i, mem_flags);
370                 if (res)
371                         return res;
372         }
373
374         return 0;
375 }
376
377 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
378 {
379         struct tty_struct *tty;
380
381         if (!urb->actual_length)
382                 return;
383
384         tty = tty_port_tty_get(&acm->port);
385         if (!tty)
386                 return;
387
388         tty_insert_flip_string(tty, urb->transfer_buffer, urb->actual_length);
389         tty_flip_buffer_push(tty);
390
391         tty_kref_put(tty);
392 }
393
394 static void acm_read_bulk_callback(struct urb *urb)
395 {
396         struct acm_rb *rb = urb->context;
397         struct acm *acm = rb->instance;
398         unsigned long flags;
399
400         dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
401                                         rb->index, urb->actual_length);
402         set_bit(rb->index, &acm->read_urbs_free);
403
404         if (!acm->dev) {
405                 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
406                 return;
407         }
408         usb_mark_last_busy(acm->dev);
409
410         if (urb->status) {
411                 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
412                                                         __func__, urb->status);
413                 return;
414         }
415         acm_process_read_urb(acm, urb);
416
417         /* throttle device if requested by tty */
418         spin_lock_irqsave(&acm->read_lock, flags);
419         acm->throttled = acm->throttle_req;
420         if (!acm->throttled && !acm->susp_count) {
421                 spin_unlock_irqrestore(&acm->read_lock, flags);
422                 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
423         } else {
424                 spin_unlock_irqrestore(&acm->read_lock, flags);
425         }
426 }
427
428 /* data interface wrote those outgoing bytes */
429 static void acm_write_bulk(struct urb *urb)
430 {
431         struct acm_wb *wb = urb->context;
432         struct acm *acm = wb->instance;
433         unsigned long flags;
434
435         if (urb->status || (urb->actual_length != urb->transfer_buffer_length))
436                 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
437                         __func__,
438                         urb->actual_length,
439                         urb->transfer_buffer_length,
440                         urb->status);
441
442         spin_lock_irqsave(&acm->write_lock, flags);
443         acm_write_done(acm, wb);
444         spin_unlock_irqrestore(&acm->write_lock, flags);
445         if (ACM_READY(acm))
446                 schedule_work(&acm->work);
447 }
448
449 static void acm_softint(struct work_struct *work)
450 {
451         struct acm *acm = container_of(work, struct acm, work);
452         struct tty_struct *tty;
453
454         dev_vdbg(&acm->data->dev, "%s\n", __func__);
455
456         if (!ACM_READY(acm))
457                 return;
458         tty = tty_port_tty_get(&acm->port);
459         if (!tty)
460                 return;
461         tty_wakeup(tty);
462         tty_kref_put(tty);
463 }
464
465 /*
466  * TTY handlers
467  */
468
469 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
470 {
471         struct acm *acm;
472         int rv = -ENODEV;
473
474         mutex_lock(&open_mutex);
475
476         acm = acm_table[tty->index];
477         if (!acm || !acm->dev)
478                 goto out;
479         else
480                 rv = 0;
481
482         dev_dbg(&acm->control->dev, "%s\n", __func__);
483
484         set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
485
486         tty->driver_data = acm;
487         tty_port_tty_set(&acm->port, tty);
488
489         if (usb_autopm_get_interface(acm->control) < 0)
490                 goto early_bail;
491         else
492                 acm->control->needs_remote_wakeup = 1;
493
494         mutex_lock(&acm->mutex);
495         if (acm->port.count++) {
496                 mutex_unlock(&acm->mutex);
497                 usb_autopm_put_interface(acm->control);
498                 goto out;
499         }
500
501         acm->ctrlurb->dev = acm->dev;
502         if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
503                 dev_err(&acm->control->dev,
504                         "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
505                 goto bail_out;
506         }
507
508         if (0 > acm_set_control(acm, acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS) &&
509             (acm->ctrl_caps & USB_CDC_CAP_LINE))
510                 goto bail_out;
511
512         usb_autopm_put_interface(acm->control);
513
514         /*
515          * Unthrottle device in case the TTY was closed while throttled.
516          */
517         spin_lock_irq(&acm->read_lock);
518         acm->throttled = 0;
519         acm->throttle_req = 0;
520         spin_unlock_irq(&acm->read_lock);
521
522         if (acm_submit_read_urbs(acm, GFP_KERNEL))
523                 goto bail_out;
524
525         set_bit(ASYNCB_INITIALIZED, &acm->port.flags);
526         rv = tty_port_block_til_ready(&acm->port, tty, filp);
527
528         mutex_unlock(&acm->mutex);
529 out:
530         mutex_unlock(&open_mutex);
531         return rv;
532
533 bail_out:
534         acm->port.count--;
535         mutex_unlock(&acm->mutex);
536         usb_autopm_put_interface(acm->control);
537 early_bail:
538         mutex_unlock(&open_mutex);
539         tty_port_tty_set(&acm->port, NULL);
540         return -EIO;
541 }
542
543 static void acm_tty_unregister(struct acm *acm)
544 {
545         int i;
546
547         tty_unregister_device(acm_tty_driver, acm->minor);
548         usb_put_intf(acm->control);
549         acm_table[acm->minor] = NULL;
550         usb_free_urb(acm->ctrlurb);
551         for (i = 0; i < ACM_NW; i++)
552                 usb_free_urb(acm->wb[i].urb);
553         for (i = 0; i < acm->rx_buflimit; i++)
554                 usb_free_urb(acm->read_urbs[i]);
555         kfree(acm->country_codes);
556         kfree(acm);
557 }
558
559 static void acm_port_down(struct acm *acm)
560 {
561         struct urb *urb;
562         struct acm_wb *wb;
563         int i;
564
565         if (acm->dev) {
566                 usb_autopm_get_interface(acm->control);
567                 acm_set_control(acm, acm->ctrlout = 0);
568
569                 for (;;) {
570                         urb = usb_get_from_anchor(&acm->delayed);
571                         if (!urb)
572                                 break;
573                         wb = urb->context;
574                         wb->use = 0;
575                         usb_autopm_put_interface_async(acm->control);
576                 }
577
578                 usb_kill_urb(acm->ctrlurb);
579                 for (i = 0; i < ACM_NW; i++)
580                         usb_kill_urb(acm->wb[i].urb);
581                 for (i = 0; i < acm->rx_buflimit; i++)
582                         usb_kill_urb(acm->read_urbs[i]);
583                 acm->control->needs_remote_wakeup = 0;
584                 usb_autopm_put_interface(acm->control);
585         }
586 }
587
588 static void acm_tty_hangup(struct tty_struct *tty)
589 {
590         struct acm *acm;
591
592         mutex_lock(&open_mutex);
593         acm = tty->driver_data;
594
595         if (!acm)
596                 goto out;
597
598         tty_port_hangup(&acm->port);
599         acm_port_down(acm);
600
601 out:
602         mutex_unlock(&open_mutex);
603 }
604
605 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
606 {
607         struct acm *acm = tty->driver_data;
608
609         /* Perform the closing process and see if we need to do the hardware
610            shutdown */
611         if (!acm)
612                 return;
613
614         mutex_lock(&open_mutex);
615         if (tty_port_close_start(&acm->port, tty, filp) == 0) {
616                 if (!acm->dev) {
617                         tty_port_tty_set(&acm->port, NULL);
618                         acm_tty_unregister(acm);
619                         tty->driver_data = NULL;
620                 }
621                 mutex_unlock(&open_mutex);
622                 return;
623         }
624         acm_port_down(acm);
625         tty_port_close_end(&acm->port, tty);
626         tty_port_tty_set(&acm->port, NULL);
627         mutex_unlock(&open_mutex);
628 }
629
630 static int acm_tty_write(struct tty_struct *tty,
631                                         const unsigned char *buf, int count)
632 {
633         struct acm *acm = tty->driver_data;
634         int stat;
635         unsigned long flags;
636         int wbn;
637         struct acm_wb *wb;
638
639         if (!ACM_READY(acm))
640                 return -EINVAL;
641         if (!count)
642                 return 0;
643
644         dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
645
646         spin_lock_irqsave(&acm->write_lock, flags);
647         wbn = acm_wb_alloc(acm);
648         if (wbn < 0) {
649                 spin_unlock_irqrestore(&acm->write_lock, flags);
650                 return 0;
651         }
652         wb = &acm->wb[wbn];
653
654         count = (count > acm->writesize) ? acm->writesize : count;
655         dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
656         memcpy(wb->buf, buf, count);
657         wb->len = count;
658         spin_unlock_irqrestore(&acm->write_lock, flags);
659
660         stat = acm_write_start(acm, wbn);
661         if (stat < 0)
662                 return stat;
663         return count;
664 }
665
666 static int acm_tty_write_room(struct tty_struct *tty)
667 {
668         struct acm *acm = tty->driver_data;
669         if (!ACM_READY(acm))
670                 return -EINVAL;
671         /*
672          * Do not let the line discipline to know that we have a reserve,
673          * or it might get too enthusiastic.
674          */
675         return acm_wb_is_avail(acm) ? acm->writesize : 0;
676 }
677
678 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
679 {
680         struct acm *acm = tty->driver_data;
681         if (!ACM_READY(acm))
682                 return 0;
683         /*
684          * This is inaccurate (overcounts), but it works.
685          */
686         return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
687 }
688
689 static void acm_tty_throttle(struct tty_struct *tty)
690 {
691         struct acm *acm = tty->driver_data;
692
693         if (!ACM_READY(acm))
694                 return;
695
696         spin_lock_irq(&acm->read_lock);
697         acm->throttle_req = 1;
698         spin_unlock_irq(&acm->read_lock);
699 }
700
701 static void acm_tty_unthrottle(struct tty_struct *tty)
702 {
703         struct acm *acm = tty->driver_data;
704         unsigned int was_throttled;
705
706         if (!ACM_READY(acm))
707                 return;
708
709         spin_lock_irq(&acm->read_lock);
710         was_throttled = acm->throttled;
711         acm->throttled = 0;
712         acm->throttle_req = 0;
713         spin_unlock_irq(&acm->read_lock);
714
715         if (was_throttled)
716                 acm_submit_read_urbs(acm, GFP_KERNEL);
717 }
718
719 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
720 {
721         struct acm *acm = tty->driver_data;
722         int retval;
723         if (!ACM_READY(acm))
724                 return -EINVAL;
725         retval = acm_send_break(acm, state ? 0xffff : 0);
726         if (retval < 0)
727                 dev_dbg(&acm->control->dev, "%s - send break failed\n",
728                                                                 __func__);
729         return retval;
730 }
731
732 static int acm_tty_tiocmget(struct tty_struct *tty)
733 {
734         struct acm *acm = tty->driver_data;
735
736         if (!ACM_READY(acm))
737                 return -EINVAL;
738
739         return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
740                (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
741                (acm->ctrlin  & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
742                (acm->ctrlin  & ACM_CTRL_RI  ? TIOCM_RI  : 0) |
743                (acm->ctrlin  & ACM_CTRL_DCD ? TIOCM_CD  : 0) |
744                TIOCM_CTS;
745 }
746
747 static int acm_tty_tiocmset(struct tty_struct *tty,
748                             unsigned int set, unsigned int clear)
749 {
750         struct acm *acm = tty->driver_data;
751         unsigned int newctrl;
752
753         if (!ACM_READY(acm))
754                 return -EINVAL;
755
756         newctrl = acm->ctrlout;
757         set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
758                                         (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
759         clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
760                                         (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
761
762         newctrl = (newctrl & ~clear) | set;
763
764         if (acm->ctrlout == newctrl)
765                 return 0;
766         return acm_set_control(acm, acm->ctrlout = newctrl);
767 }
768
769 static int acm_tty_ioctl(struct tty_struct *tty,
770                                         unsigned int cmd, unsigned long arg)
771 {
772         struct acm *acm = tty->driver_data;
773
774         if (!ACM_READY(acm))
775                 return -EINVAL;
776
777         return -ENOIOCTLCMD;
778 }
779
780 static const __u32 acm_tty_speed[] = {
781         0, 50, 75, 110, 134, 150, 200, 300, 600,
782         1200, 1800, 2400, 4800, 9600, 19200, 38400,
783         57600, 115200, 230400, 460800, 500000, 576000,
784         921600, 1000000, 1152000, 1500000, 2000000,
785         2500000, 3000000, 3500000, 4000000
786 };
787
788 static void acm_tty_set_termios(struct tty_struct *tty,
789                                                 struct ktermios *termios_old)
790 {
791         struct acm *acm = tty->driver_data;
792         struct ktermios *termios = tty->termios;
793         struct usb_cdc_line_coding newline;
794         int newctrl = acm->ctrlout;
795
796         if (!ACM_READY(acm))
797                 return;
798
799         newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
800         newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
801         newline.bParityType = termios->c_cflag & PARENB ?
802                                 (termios->c_cflag & PARODD ? 1 : 2) +
803                                 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
804         switch (termios->c_cflag & CSIZE) {
805         case CS5:
806                 newline.bDataBits = 5;
807                 break;
808         case CS6:
809                 newline.bDataBits = 6;
810                 break;
811         case CS7:
812                 newline.bDataBits = 7;
813                 break;
814         case CS8:
815         default:
816                 newline.bDataBits = 8;
817                 break;
818         }
819         /* FIXME: Needs to clear unsupported bits in the termios */
820         acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
821
822         if (C_BAUD(tty) == B0) {
823                 newline.dwDTERate = acm->line.dwDTERate;
824                 newctrl &= ~ACM_CTRL_DTR;
825         } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
826                 newctrl |=  ACM_CTRL_DTR;
827         }
828
829         if (newctrl != acm->ctrlout)
830                 acm_set_control(acm, acm->ctrlout = newctrl);
831
832         if (memcmp(&acm->line, &newline, sizeof newline)) {
833                 memcpy(&acm->line, &newline, sizeof newline);
834                 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
835                         __func__,
836                         le32_to_cpu(newline.dwDTERate),
837                         newline.bCharFormat, newline.bParityType,
838                         newline.bDataBits);
839                 acm_set_line(acm, &acm->line);
840         }
841 }
842
843 /*
844  * USB probe and disconnect routines.
845  */
846
847 /* Little helpers: write/read buffers free */
848 static void acm_write_buffers_free(struct acm *acm)
849 {
850         int i;
851         struct acm_wb *wb;
852         struct usb_device *usb_dev = interface_to_usbdev(acm->control);
853
854         for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
855                 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
856 }
857
858 static void acm_read_buffers_free(struct acm *acm)
859 {
860         struct usb_device *usb_dev = interface_to_usbdev(acm->control);
861         int i;
862
863         for (i = 0; i < acm->rx_buflimit; i++)
864                 usb_free_coherent(usb_dev, acm->readsize,
865                           acm->read_buffers[i].base, acm->read_buffers[i].dma);
866 }
867
868 /* Little helper: write buffers allocate */
869 static int acm_write_buffers_alloc(struct acm *acm)
870 {
871         int i;
872         struct acm_wb *wb;
873
874         for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
875                 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
876                     &wb->dmah);
877                 if (!wb->buf) {
878                         while (i != 0) {
879                                 --i;
880                                 --wb;
881                                 usb_free_coherent(acm->dev, acm->writesize,
882                                     wb->buf, wb->dmah);
883                         }
884                         return -ENOMEM;
885                 }
886         }
887         return 0;
888 }
889
890 static int acm_probe(struct usb_interface *intf,
891                      const struct usb_device_id *id)
892 {
893         struct usb_cdc_union_desc *union_header = NULL;
894         struct usb_cdc_country_functional_desc *cfd = NULL;
895         unsigned char *buffer = intf->altsetting->extra;
896         int buflen = intf->altsetting->extralen;
897         struct usb_interface *control_interface;
898         struct usb_interface *data_interface;
899         struct usb_endpoint_descriptor *epctrl = NULL;
900         struct usb_endpoint_descriptor *epread = NULL;
901         struct usb_endpoint_descriptor *epwrite = NULL;
902         struct usb_device *usb_dev = interface_to_usbdev(intf);
903         struct acm *acm;
904         int minor;
905         int ctrlsize, readsize;
906         u8 *buf;
907         u8 ac_management_function = 0;
908         u8 call_management_function = 0;
909         int call_interface_num = -1;
910         int data_interface_num = -1;
911         unsigned long quirks;
912         int num_rx_buf;
913         int i;
914         unsigned int elength = 0;
915         int combined_interfaces = 0;
916
917         /* normal quirks */
918         quirks = (unsigned long)id->driver_info;
919         num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
920
921         /* handle quirks deadly to normal probing*/
922         if (quirks == NO_UNION_NORMAL) {
923                 data_interface = usb_ifnum_to_if(usb_dev, 1);
924                 control_interface = usb_ifnum_to_if(usb_dev, 0);
925                 goto skip_normal_probe;
926         }
927
928         /* normal probing*/
929         if (!buffer) {
930                 dev_err(&intf->dev, "Weird descriptor references\n");
931                 return -EINVAL;
932         }
933
934         if (!buflen) {
935                 if (intf->cur_altsetting->endpoint &&
936                                 intf->cur_altsetting->endpoint->extralen &&
937                                 intf->cur_altsetting->endpoint->extra) {
938                         dev_dbg(&intf->dev,
939                                 "Seeking extra descriptors on endpoint\n");
940                         buflen = intf->cur_altsetting->endpoint->extralen;
941                         buffer = intf->cur_altsetting->endpoint->extra;
942                 } else {
943                         dev_err(&intf->dev,
944                                 "Zero length descriptor references\n");
945                         return -EINVAL;
946                 }
947         }
948
949         while (buflen > 0) {
950                 if (buffer[1] != USB_DT_CS_INTERFACE) {
951                         dev_err(&intf->dev, "skipping garbage\n");
952                         goto next_desc;
953                 }
954                 elength = buffer[0];
955
956                 switch (buffer[2]) {
957                 case USB_CDC_UNION_TYPE: /* we've found it */
958                         if (elength < sizeof(struct usb_cdc_union_desc))
959                                 goto next_desc;
960                         if (union_header) {
961                                 dev_err(&intf->dev, "More than one "
962                                         "union descriptor, skipping ...\n");
963                                 goto next_desc;
964                         }
965                         union_header = (struct usb_cdc_union_desc *)buffer;
966                         break;
967                 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
968                         if (elength < sizeof(struct usb_cdc_country_functional_desc))
969                                 goto next_desc;
970                         cfd = (struct usb_cdc_country_functional_desc *)buffer;
971                         break;
972                 case USB_CDC_HEADER_TYPE: /* maybe check version */
973                         break; /* for now we ignore it */
974                 case USB_CDC_ACM_TYPE:
975                         if (elength < 4)
976                                 goto next_desc;
977                         ac_management_function = buffer[3];
978                         break;
979                 case USB_CDC_CALL_MANAGEMENT_TYPE:
980                         if (elength < 5)
981                                 goto next_desc;
982                         call_management_function = buffer[3];
983                         call_interface_num = buffer[4];
984                         if ( (quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
985                                 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
986                         break;
987                 default:
988                         /*
989                          * there are LOTS more CDC descriptors that
990                          * could legitimately be found here.
991                          */
992                         dev_dbg(&intf->dev, "Ignoring descriptor: "
993                                         "type %02x, length %ud\n",
994                                         buffer[2], elength);
995                         break;
996                 }
997 next_desc:
998                 buflen -= elength;
999                 buffer += elength;
1000         }
1001
1002         if (!union_header) {
1003                 if (call_interface_num > 0) {
1004                         dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1005                         /* quirks for Droids MuIn LCD */
1006                         if (quirks & NO_DATA_INTERFACE)
1007                                 data_interface = usb_ifnum_to_if(usb_dev, 0);
1008                         else
1009                                 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1010                         control_interface = intf;
1011                 } else {
1012                         if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1013                                 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1014                                 return -ENODEV;
1015                         } else {
1016                                 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1017                                 combined_interfaces = 1;
1018                                 control_interface = data_interface = intf;
1019                                 goto look_for_collapsed_interface;
1020                         }
1021                 }
1022         } else {
1023                 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1024                 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1025         }
1026
1027         if (!control_interface || !data_interface) {
1028                 dev_dbg(&intf->dev, "no interfaces\n");
1029                 return -ENODEV;
1030         }
1031
1032         if (data_interface_num != call_interface_num)
1033                 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1034
1035         if (control_interface == data_interface) {
1036                 /* some broken devices designed for windows work this way */
1037                 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1038                 combined_interfaces = 1;
1039                 /* a popular other OS doesn't use it */
1040                 quirks |= NO_CAP_LINE;
1041                 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1042                         dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1043                         return -EINVAL;
1044                 }
1045 look_for_collapsed_interface:
1046                 for (i = 0; i < 3; i++) {
1047                         struct usb_endpoint_descriptor *ep;
1048                         ep = &data_interface->cur_altsetting->endpoint[i].desc;
1049
1050                         if (usb_endpoint_is_int_in(ep))
1051                                 epctrl = ep;
1052                         else if (usb_endpoint_is_bulk_out(ep))
1053                                 epwrite = ep;
1054                         else if (usb_endpoint_is_bulk_in(ep))
1055                                 epread = ep;
1056                         else
1057                                 return -EINVAL;
1058                 }
1059                 if (!epctrl || !epread || !epwrite)
1060                         return -ENODEV;
1061                 else
1062                         goto made_compressed_probe;
1063         }
1064
1065 skip_normal_probe:
1066
1067         /*workaround for switched interfaces */
1068         if (data_interface->cur_altsetting->desc.bInterfaceClass
1069                                                 != CDC_DATA_INTERFACE_TYPE) {
1070                 if (control_interface->cur_altsetting->desc.bInterfaceClass
1071                                                 == CDC_DATA_INTERFACE_TYPE) {
1072                         struct usb_interface *t;
1073                         dev_dbg(&intf->dev,
1074                                 "Your device has switched interfaces.\n");
1075                         t = control_interface;
1076                         control_interface = data_interface;
1077                         data_interface = t;
1078                 } else {
1079                         return -EINVAL;
1080                 }
1081         }
1082
1083         /* Accept probe requests only for the control interface */
1084         if (!combined_interfaces && intf != control_interface)
1085                 return -ENODEV;
1086
1087         if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1088                 /* valid in this context */
1089                 dev_dbg(&intf->dev, "The data interface isn't available\n");
1090                 return -EBUSY;
1091         }
1092
1093
1094         if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1095             control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1096                 return -EINVAL;
1097
1098         epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1099         epread = &data_interface->cur_altsetting->endpoint[0].desc;
1100         epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1101
1102
1103         /* workaround for switched endpoints */
1104         if (!usb_endpoint_dir_in(epread)) {
1105                 /* descriptors are swapped */
1106                 struct usb_endpoint_descriptor *t;
1107                 dev_dbg(&intf->dev,
1108                         "The data interface has switched endpoints\n");
1109                 t = epread;
1110                 epread = epwrite;
1111                 epwrite = t;
1112         }
1113 made_compressed_probe:
1114         dev_dbg(&intf->dev, "interfaces are valid\n");
1115         for (minor = 0; minor < ACM_TTY_MINORS && acm_table[minor]; minor++);
1116
1117         if (minor == ACM_TTY_MINORS) {
1118                 dev_err(&intf->dev, "no more free acm devices\n");
1119                 return -ENODEV;
1120         }
1121
1122         acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1123         if (acm == NULL) {
1124                 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1125                 goto alloc_fail;
1126         }
1127
1128         ctrlsize = usb_endpoint_maxp(epctrl);
1129         readsize = usb_endpoint_maxp(epread) *
1130                                 (quirks == SINGLE_RX_URB ? 1 : 2);
1131         acm->combined_interfaces = combined_interfaces;
1132         acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1133         acm->control = control_interface;
1134         acm->data = data_interface;
1135         acm->minor = minor;
1136         acm->dev = usb_dev;
1137         acm->ctrl_caps = ac_management_function;
1138         if (quirks & NO_CAP_LINE)
1139                 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1140         acm->ctrlsize = ctrlsize;
1141         acm->readsize = readsize;
1142         acm->rx_buflimit = num_rx_buf;
1143         INIT_WORK(&acm->work, acm_softint);
1144         spin_lock_init(&acm->write_lock);
1145         spin_lock_init(&acm->read_lock);
1146         mutex_init(&acm->mutex);
1147         acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1148         acm->is_int_ep = usb_endpoint_xfer_int(epread);
1149         if (acm->is_int_ep)
1150                 acm->bInterval = epread->bInterval;
1151         tty_port_init(&acm->port);
1152         acm->port.ops = &acm_port_ops;
1153         init_usb_anchor(&acm->delayed);
1154
1155         buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1156         if (!buf) {
1157                 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1158                 goto alloc_fail2;
1159         }
1160         acm->ctrl_buffer = buf;
1161
1162         if (acm_write_buffers_alloc(acm) < 0) {
1163                 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1164                 goto alloc_fail4;
1165         }
1166
1167         acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1168         if (!acm->ctrlurb) {
1169                 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1170                 goto alloc_fail5;
1171         }
1172         for (i = 0; i < num_rx_buf; i++) {
1173                 struct acm_rb *rb = &(acm->read_buffers[i]);
1174                 struct urb *urb;
1175
1176                 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1177                                                                 &rb->dma);
1178                 if (!rb->base) {
1179                         dev_err(&intf->dev, "out of memory "
1180                                         "(read bufs usb_alloc_coherent)\n");
1181                         goto alloc_fail6;
1182                 }
1183                 rb->index = i;
1184                 rb->instance = acm;
1185
1186                 urb = usb_alloc_urb(0, GFP_KERNEL);
1187                 if (!urb) {
1188                         dev_err(&intf->dev,
1189                                 "out of memory (read urbs usb_alloc_urb)\n");
1190                         goto alloc_fail6;
1191                 }
1192                 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1193                 urb->transfer_dma = rb->dma;
1194                 if (acm->is_int_ep) {
1195                         usb_fill_int_urb(urb, acm->dev,
1196                                          acm->rx_endpoint,
1197                                          rb->base,
1198                                          acm->readsize,
1199                                          acm_read_bulk_callback, rb,
1200                                          acm->bInterval);
1201                 } else {
1202                         usb_fill_bulk_urb(urb, acm->dev,
1203                                           acm->rx_endpoint,
1204                                           rb->base,
1205                                           acm->readsize,
1206                                           acm_read_bulk_callback, rb);
1207                 }
1208
1209                 acm->read_urbs[i] = urb;
1210                 __set_bit(i, &acm->read_urbs_free);
1211         }
1212         for (i = 0; i < ACM_NW; i++) {
1213                 struct acm_wb *snd = &(acm->wb[i]);
1214
1215                 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1216                 if (snd->urb == NULL) {
1217                         dev_err(&intf->dev,
1218                                 "out of memory (write urbs usb_alloc_urb)\n");
1219                         goto alloc_fail7;
1220                 }
1221
1222                 if (usb_endpoint_xfer_int(epwrite))
1223                         usb_fill_int_urb(snd->urb, usb_dev,
1224                                 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1225                                 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1226                 else
1227                         usb_fill_bulk_urb(snd->urb, usb_dev,
1228                                 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1229                                 NULL, acm->writesize, acm_write_bulk, snd);
1230                 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1231                 snd->instance = acm;
1232         }
1233
1234         usb_set_intfdata(intf, acm);
1235
1236         i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1237         if (i < 0)
1238                 goto alloc_fail7;
1239
1240         if (cfd) { /* export the country data */
1241                 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1242                 if (!acm->country_codes)
1243                         goto skip_countries;
1244                 acm->country_code_size = cfd->bLength - 4;
1245                 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1246                                                         cfd->bLength - 4);
1247                 acm->country_rel_date = cfd->iCountryCodeRelDate;
1248
1249                 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1250                 if (i < 0) {
1251                         kfree(acm->country_codes);
1252                         acm->country_codes = NULL;
1253                         acm->country_code_size = 0;
1254                         goto skip_countries;
1255                 }
1256
1257                 i = device_create_file(&intf->dev,
1258                                                 &dev_attr_iCountryCodeRelDate);
1259                 if (i < 0) {
1260                         device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1261                         kfree(acm->country_codes);
1262                         acm->country_codes = NULL;
1263                         acm->country_code_size = 0;
1264                         goto skip_countries;
1265                 }
1266         }
1267
1268 skip_countries:
1269         usb_fill_int_urb(acm->ctrlurb, usb_dev,
1270                          usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1271                          acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1272                          /* works around buggy devices */
1273                          epctrl->bInterval ? epctrl->bInterval : 0xff);
1274         acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1275         acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1276
1277         dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1278
1279         acm_set_control(acm, acm->ctrlout);
1280
1281         acm->line.dwDTERate = cpu_to_le32(9600);
1282         acm->line.bDataBits = 8;
1283         acm_set_line(acm, &acm->line);
1284
1285         usb_driver_claim_interface(&acm_driver, data_interface, acm);
1286         usb_set_intfdata(data_interface, acm);
1287
1288         usb_get_intf(control_interface);
1289         tty_register_device(acm_tty_driver, minor, &control_interface->dev);
1290
1291         acm_table[minor] = acm;
1292
1293         return 0;
1294 alloc_fail7:
1295         for (i = 0; i < ACM_NW; i++)
1296                 usb_free_urb(acm->wb[i].urb);
1297 alloc_fail6:
1298         for (i = 0; i < num_rx_buf; i++)
1299                 usb_free_urb(acm->read_urbs[i]);
1300         acm_read_buffers_free(acm);
1301         usb_free_urb(acm->ctrlurb);
1302 alloc_fail5:
1303         acm_write_buffers_free(acm);
1304 alloc_fail4:
1305         usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1306 alloc_fail2:
1307         kfree(acm);
1308 alloc_fail:
1309         return -ENOMEM;
1310 }
1311
1312 static void stop_data_traffic(struct acm *acm)
1313 {
1314         int i;
1315
1316         dev_dbg(&acm->control->dev, "%s\n", __func__);
1317
1318         usb_kill_urb(acm->ctrlurb);
1319         for (i = 0; i < ACM_NW; i++)
1320                 usb_kill_urb(acm->wb[i].urb);
1321         for (i = 0; i < acm->rx_buflimit; i++)
1322                 usb_kill_urb(acm->read_urbs[i]);
1323
1324         cancel_work_sync(&acm->work);
1325 }
1326
1327 static void acm_disconnect(struct usb_interface *intf)
1328 {
1329         struct acm *acm = usb_get_intfdata(intf);
1330         struct usb_device *usb_dev = interface_to_usbdev(intf);
1331         struct tty_struct *tty;
1332
1333         /* sibling interface is already cleaning up */
1334         if (!acm)
1335                 return;
1336
1337         mutex_lock(&open_mutex);
1338         if (acm->country_codes) {
1339                 device_remove_file(&acm->control->dev,
1340                                 &dev_attr_wCountryCodes);
1341                 device_remove_file(&acm->control->dev,
1342                                 &dev_attr_iCountryCodeRelDate);
1343         }
1344         device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1345         acm->dev = NULL;
1346         usb_set_intfdata(acm->control, NULL);
1347         usb_set_intfdata(acm->data, NULL);
1348
1349         stop_data_traffic(acm);
1350
1351         acm_write_buffers_free(acm);
1352         usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer,
1353                           acm->ctrl_dma);
1354         acm_read_buffers_free(acm);
1355
1356         if (!acm->combined_interfaces)
1357                 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1358                                         acm->data : acm->control);
1359
1360         if (acm->port.count == 0) {
1361                 acm_tty_unregister(acm);
1362                 mutex_unlock(&open_mutex);
1363                 return;
1364         }
1365
1366         mutex_unlock(&open_mutex);
1367         tty = tty_port_tty_get(&acm->port);
1368         if (tty) {
1369                 tty_hangup(tty);
1370                 tty_kref_put(tty);
1371         }
1372 }
1373
1374 #ifdef CONFIG_PM
1375 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1376 {
1377         struct acm *acm = usb_get_intfdata(intf);
1378         int cnt;
1379
1380         spin_lock_irq(&acm->read_lock);
1381         spin_lock(&acm->write_lock);
1382         if (PMSG_IS_AUTO(message)) {
1383                 if (acm->transmitting) {
1384                         spin_unlock(&acm->write_lock);
1385                         spin_unlock_irq(&acm->read_lock);
1386                         return -EBUSY;
1387                 }
1388         }
1389         cnt = acm->susp_count++;
1390         spin_unlock(&acm->write_lock);
1391         spin_unlock_irq(&acm->read_lock);
1392
1393         if (cnt)
1394                 return 0;
1395         /*
1396         we treat opened interfaces differently,
1397         we must guard against open
1398         */
1399         mutex_lock(&acm->mutex);
1400
1401         if (acm->port.count)
1402                 stop_data_traffic(acm);
1403
1404         mutex_unlock(&acm->mutex);
1405         return 0;
1406 }
1407
1408 static int acm_resume(struct usb_interface *intf)
1409 {
1410         struct acm *acm = usb_get_intfdata(intf);
1411         struct urb *urb;
1412         int rv = 0;
1413
1414         mutex_lock(&acm->mutex);
1415         spin_lock_irq(&acm->read_lock);
1416         spin_lock(&acm->write_lock);
1417
1418         if (--acm->susp_count)
1419                 goto out;
1420
1421         if (acm->port.count) {
1422                 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1423
1424                 for (;;) {
1425                         urb = usb_get_from_anchor(&acm->delayed);
1426                         if (!urb)
1427                                 break;
1428
1429                         acm_start_wb(acm, urb->context);
1430                 }
1431
1432                 /*
1433                  * delayed error checking because we must
1434                  * do the write path at all cost
1435                  */
1436                 if (rv < 0)
1437                         goto out;
1438
1439                 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1440         }
1441 out:
1442         spin_unlock(&acm->write_lock);
1443         spin_unlock_irq(&acm->read_lock);
1444         mutex_unlock(&acm->mutex);
1445
1446         return rv;
1447 }
1448
1449 static int acm_reset_resume(struct usb_interface *intf)
1450 {
1451         struct acm *acm = usb_get_intfdata(intf);
1452         struct tty_struct *tty;
1453
1454         mutex_lock(&acm->mutex);
1455         if (acm->port.count) {
1456                 tty = tty_port_tty_get(&acm->port);
1457                 if (tty) {
1458                         tty_hangup(tty);
1459                         tty_kref_put(tty);
1460                 }
1461         }
1462         mutex_unlock(&acm->mutex);
1463         return acm_resume(intf);
1464 }
1465
1466 #endif /* CONFIG_PM */
1467
1468 #define NOKIA_PCSUITE_ACM_INFO(x) \
1469                 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1470                 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1471                 USB_CDC_ACM_PROTO_VENDOR)
1472
1473 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1474                 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1475                 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1476                 USB_CDC_ACM_PROTO_VENDOR)
1477
1478 /*
1479  * USB driver structure.
1480  */
1481
1482 static const struct usb_device_id acm_ids[] = {
1483         /* quirky and broken devices */
1484         { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1485         .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1486         { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1487         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1488         },
1489         { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1490         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1491         },
1492         { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1493         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1494         },
1495         { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1496         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1497         },
1498         { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1499         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1500         },
1501         { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1502         .driver_info = SINGLE_RX_URB,
1503         },
1504         { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1505         .driver_info = SINGLE_RX_URB, /* firmware bug */
1506         },
1507         { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1508         .driver_info = SINGLE_RX_URB, /* firmware bug */
1509         },
1510         { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1511         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1512         },
1513         { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1514         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1515         },
1516         { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1517         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1518         },
1519         { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1520         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1521         },
1522         { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1523         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1524         },
1525         { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1526         { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1527         },
1528         /* Motorola H24 HSPA module: */
1529         { USB_DEVICE(0x22b8, 0x2d91) }, /* modem                                */
1530         { USB_DEVICE(0x22b8, 0x2d92),   /* modem           + diagnostics        */
1531         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1532         },
1533         { USB_DEVICE(0x22b8, 0x2d93),   /* modem + AT port                      */
1534         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1535         },
1536         { USB_DEVICE(0x22b8, 0x2d95),   /* modem + AT port + diagnostics        */
1537         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1538         },
1539         { USB_DEVICE(0x22b8, 0x2d96),   /* modem                         + NMEA */
1540         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1541         },
1542         { USB_DEVICE(0x22b8, 0x2d97),   /* modem           + diagnostics + NMEA */
1543         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1544         },
1545         { USB_DEVICE(0x22b8, 0x2d99),   /* modem + AT port               + NMEA */
1546         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1547         },
1548         { USB_DEVICE(0x22b8, 0x2d9a),   /* modem + AT port + diagnostics + NMEA */
1549         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1550         },
1551
1552         { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1553         .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1554                                            data interface instead of
1555                                            communications interface.
1556                                            Maybe we should define a new
1557                                            quirk for this. */
1558         },
1559         { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1560         .driver_info = NO_UNION_NORMAL,
1561         },
1562         { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1563         .driver_info = NO_UNION_NORMAL,
1564         },
1565         { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1566         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1567         },
1568         { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1569         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1570         },
1571
1572         /* Nokia S60 phones expose two ACM channels. The first is
1573          * a modem and is picked up by the standard AT-command
1574          * information below. The second is 'vendor-specific' but
1575          * is treated as a serial device at the S60 end, so we want
1576          * to expose it on Linux too. */
1577         { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1578         { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1579         { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1580         { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1581         { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1582         { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1583         { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1584         { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1585         { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1586         { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1587         { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1588         { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1589         { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1590         { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1591         { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1592         { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1593         { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1594         { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i  */
1595         { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1596         { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1597         { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1598         { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic &  */
1599         { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1600         { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1601         { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1602         { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1603         { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1604         { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1605         { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1606         { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1607         { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1608         { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB  */
1609         { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1610         { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1611         { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1612         { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1613         { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1614         { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1615         { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1616         { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3  */
1617         { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1618         { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1619         { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1620         { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1621         { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1622         { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1623         { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1624         { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1625         { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1626         { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1627         { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1628         { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1629         { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1630         { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1631         { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1632         { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1633         { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1634         { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1635
1636         /* Support for Owen devices */
1637         { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1638
1639         /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1640
1641         /* Support Lego NXT using pbLua firmware */
1642         { USB_DEVICE(0x0694, 0xff00),
1643         .driver_info = NOT_A_MODEM,
1644         },
1645
1646         /* Support for Droids MuIn LCD */
1647         { USB_DEVICE(0x04d8, 0x000b),
1648         .driver_info = NO_DATA_INTERFACE,
1649         },
1650
1651         /* control interfaces without any protocol set */
1652         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1653                 USB_CDC_PROTO_NONE) },
1654
1655         /* control interfaces with various AT-command sets */
1656         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1657                 USB_CDC_ACM_PROTO_AT_V25TER) },
1658         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1659                 USB_CDC_ACM_PROTO_AT_PCCA101) },
1660         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1661                 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1662         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1663                 USB_CDC_ACM_PROTO_AT_GSM) },
1664         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1665                 USB_CDC_ACM_PROTO_AT_3G) },
1666         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1667                 USB_CDC_ACM_PROTO_AT_CDMA) },
1668
1669         { }
1670 };
1671
1672 MODULE_DEVICE_TABLE(usb, acm_ids);
1673
1674 static struct usb_driver acm_driver = {
1675         .name =         "cdc_acm",
1676         .probe =        acm_probe,
1677         .disconnect =   acm_disconnect,
1678 #ifdef CONFIG_PM
1679         .suspend =      acm_suspend,
1680         .resume =       acm_resume,
1681         .reset_resume = acm_reset_resume,
1682 #endif
1683         .id_table =     acm_ids,
1684 #ifdef CONFIG_PM
1685         .supports_autosuspend = 1,
1686 #endif
1687 };
1688
1689 /*
1690  * TTY driver structures.
1691  */
1692
1693 static const struct tty_operations acm_ops = {
1694         .open =                 acm_tty_open,
1695         .close =                acm_tty_close,
1696         .hangup =               acm_tty_hangup,
1697         .write =                acm_tty_write,
1698         .write_room =           acm_tty_write_room,
1699         .ioctl =                acm_tty_ioctl,
1700         .throttle =             acm_tty_throttle,
1701         .unthrottle =           acm_tty_unthrottle,
1702         .chars_in_buffer =      acm_tty_chars_in_buffer,
1703         .break_ctl =            acm_tty_break_ctl,
1704         .set_termios =          acm_tty_set_termios,
1705         .tiocmget =             acm_tty_tiocmget,
1706         .tiocmset =             acm_tty_tiocmset,
1707 };
1708
1709 /*
1710  * Init / exit.
1711  */
1712
1713 static int __init acm_init(void)
1714 {
1715         int retval;
1716         acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1717         if (!acm_tty_driver)
1718                 return -ENOMEM;
1719         acm_tty_driver->owner = THIS_MODULE,
1720         acm_tty_driver->driver_name = "acm",
1721         acm_tty_driver->name = "ttyACM",
1722         acm_tty_driver->major = ACM_TTY_MAJOR,
1723         acm_tty_driver->minor_start = 0,
1724         acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1725         acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1726         acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1727         acm_tty_driver->init_termios = tty_std_termios;
1728         acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1729                                                                 HUPCL | CLOCAL;
1730         tty_set_operations(acm_tty_driver, &acm_ops);
1731
1732         retval = tty_register_driver(acm_tty_driver);
1733         if (retval) {
1734                 put_tty_driver(acm_tty_driver);
1735                 return retval;
1736         }
1737
1738         retval = usb_register(&acm_driver);
1739         if (retval) {
1740                 tty_unregister_driver(acm_tty_driver);
1741                 put_tty_driver(acm_tty_driver);
1742                 return retval;
1743         }
1744
1745         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1746
1747         return 0;
1748 }
1749
1750 static void __exit acm_exit(void)
1751 {
1752         usb_deregister(&acm_driver);
1753         tty_unregister_driver(acm_tty_driver);
1754         put_tty_driver(acm_tty_driver);
1755 }
1756
1757 module_init(acm_init);
1758 module_exit(acm_exit);
1759
1760 MODULE_AUTHOR(DRIVER_AUTHOR);
1761 MODULE_DESCRIPTION(DRIVER_DESC);
1762 MODULE_LICENSE("GPL");
1763 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);