Linux 5.15-rc3
[linux-block.git] / drivers / usb / class / cdc-acm.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * cdc-acm.c
4  *
5  * Copyright (c) 1999 Armin Fuerst      <fuerst@in.tum.de>
6  * Copyright (c) 1999 Pavel Machek      <pavel@ucw.cz>
7  * Copyright (c) 1999 Johannes Erdfelt  <johannes@erdfelt.com>
8  * Copyright (c) 2000 Vojtech Pavlik    <vojtech@suse.cz>
9  * Copyright (c) 2004 Oliver Neukum     <oliver@neukum.name>
10  * Copyright (c) 2005 David Kubicek     <dave@awk.cz>
11  * Copyright (c) 2011 Johan Hovold      <jhovold@gmail.com>
12  *
13  * USB Abstract Control Model driver for USB modems and ISDN adapters
14  *
15  * Sponsored by SuSE
16  */
17
18 #undef DEBUG
19 #undef VERBOSE_DEBUG
20
21 #include <linux/kernel.h>
22 #include <linux/sched/signal.h>
23 #include <linux/errno.h>
24 #include <linux/init.h>
25 #include <linux/slab.h>
26 #include <linux/log2.h>
27 #include <linux/tty.h>
28 #include <linux/serial.h>
29 #include <linux/tty_driver.h>
30 #include <linux/tty_flip.h>
31 #include <linux/module.h>
32 #include <linux/mutex.h>
33 #include <linux/uaccess.h>
34 #include <linux/usb.h>
35 #include <linux/usb/cdc.h>
36 #include <asm/byteorder.h>
37 #include <asm/unaligned.h>
38 #include <linux/idr.h>
39 #include <linux/list.h>
40
41 #include "cdc-acm.h"
42
43
44 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
45 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
46
47 static struct usb_driver acm_driver;
48 static struct tty_driver *acm_tty_driver;
49
50 static DEFINE_IDR(acm_minors);
51 static DEFINE_MUTEX(acm_minors_lock);
52
53 static void acm_tty_set_termios(struct tty_struct *tty,
54                                 struct ktermios *termios_old);
55
56 /*
57  * acm_minors accessors
58  */
59
60 /*
61  * Look up an ACM structure by minor. If found and not disconnected, increment
62  * its refcount and return it with its mutex held.
63  */
64 static struct acm *acm_get_by_minor(unsigned int minor)
65 {
66         struct acm *acm;
67
68         mutex_lock(&acm_minors_lock);
69         acm = idr_find(&acm_minors, minor);
70         if (acm) {
71                 mutex_lock(&acm->mutex);
72                 if (acm->disconnected) {
73                         mutex_unlock(&acm->mutex);
74                         acm = NULL;
75                 } else {
76                         tty_port_get(&acm->port);
77                         mutex_unlock(&acm->mutex);
78                 }
79         }
80         mutex_unlock(&acm_minors_lock);
81         return acm;
82 }
83
84 /*
85  * Try to find an available minor number and if found, associate it with 'acm'.
86  */
87 static int acm_alloc_minor(struct acm *acm)
88 {
89         int minor;
90
91         mutex_lock(&acm_minors_lock);
92         minor = idr_alloc(&acm_minors, acm, 0, ACM_TTY_MINORS, GFP_KERNEL);
93         mutex_unlock(&acm_minors_lock);
94
95         return minor;
96 }
97
98 /* Release the minor number associated with 'acm'.  */
99 static void acm_release_minor(struct acm *acm)
100 {
101         mutex_lock(&acm_minors_lock);
102         idr_remove(&acm_minors, acm->minor);
103         mutex_unlock(&acm_minors_lock);
104 }
105
106 /*
107  * Functions for ACM control messages.
108  */
109
110 static int acm_ctrl_msg(struct acm *acm, int request, int value,
111                                                         void *buf, int len)
112 {
113         int retval;
114
115         retval = usb_autopm_get_interface(acm->control);
116         if (retval)
117                 return retval;
118
119         retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
120                 request, USB_RT_ACM, value,
121                 acm->control->altsetting[0].desc.bInterfaceNumber,
122                 buf, len, 5000);
123
124         dev_dbg(&acm->control->dev,
125                 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
126                 __func__, request, value, len, retval);
127
128         usb_autopm_put_interface(acm->control);
129
130         return retval < 0 ? retval : 0;
131 }
132
133 /* devices aren't required to support these requests.
134  * the cdc acm descriptor tells whether they do...
135  */
136 static inline int acm_set_control(struct acm *acm, int control)
137 {
138         if (acm->quirks & QUIRK_CONTROL_LINE_STATE)
139                 return -EOPNOTSUPP;
140
141         return acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE,
142                         control, NULL, 0);
143 }
144
145 #define acm_set_line(acm, line) \
146         acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
147 #define acm_send_break(acm, ms) \
148         acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
149
150 static void acm_poison_urbs(struct acm *acm)
151 {
152         int i;
153
154         usb_poison_urb(acm->ctrlurb);
155         for (i = 0; i < ACM_NW; i++)
156                 usb_poison_urb(acm->wb[i].urb);
157         for (i = 0; i < acm->rx_buflimit; i++)
158                 usb_poison_urb(acm->read_urbs[i]);
159 }
160
161 static void acm_unpoison_urbs(struct acm *acm)
162 {
163         int i;
164
165         for (i = 0; i < acm->rx_buflimit; i++)
166                 usb_unpoison_urb(acm->read_urbs[i]);
167         for (i = 0; i < ACM_NW; i++)
168                 usb_unpoison_urb(acm->wb[i].urb);
169         usb_unpoison_urb(acm->ctrlurb);
170 }
171
172
173 /*
174  * Write buffer management.
175  * All of these assume proper locks taken by the caller.
176  */
177
178 static int acm_wb_alloc(struct acm *acm)
179 {
180         int i, wbn;
181         struct acm_wb *wb;
182
183         wbn = 0;
184         i = 0;
185         for (;;) {
186                 wb = &acm->wb[wbn];
187                 if (!wb->use) {
188                         wb->use = true;
189                         wb->len = 0;
190                         return wbn;
191                 }
192                 wbn = (wbn + 1) % ACM_NW;
193                 if (++i >= ACM_NW)
194                         return -1;
195         }
196 }
197
198 static int acm_wb_is_avail(struct acm *acm)
199 {
200         int i, n;
201         unsigned long flags;
202
203         n = ACM_NW;
204         spin_lock_irqsave(&acm->write_lock, flags);
205         for (i = 0; i < ACM_NW; i++)
206                 if(acm->wb[i].use)
207                         n--;
208         spin_unlock_irqrestore(&acm->write_lock, flags);
209         return n;
210 }
211
212 /*
213  * Finish write. Caller must hold acm->write_lock
214  */
215 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
216 {
217         wb->use = false;
218         acm->transmitting--;
219         usb_autopm_put_interface_async(acm->control);
220 }
221
222 /*
223  * Poke write.
224  *
225  * the caller is responsible for locking
226  */
227
228 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
229 {
230         int rc;
231
232         acm->transmitting++;
233
234         wb->urb->transfer_buffer = wb->buf;
235         wb->urb->transfer_dma = wb->dmah;
236         wb->urb->transfer_buffer_length = wb->len;
237         wb->urb->dev = acm->dev;
238
239         rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
240         if (rc < 0) {
241                 if (rc != -EPERM)
242                         dev_err(&acm->data->dev,
243                                 "%s - usb_submit_urb(write bulk) failed: %d\n",
244                                 __func__, rc);
245                 acm_write_done(acm, wb);
246         }
247         return rc;
248 }
249
250 /*
251  * attributes exported through sysfs
252  */
253 static ssize_t bmCapabilities_show
254 (struct device *dev, struct device_attribute *attr, char *buf)
255 {
256         struct usb_interface *intf = to_usb_interface(dev);
257         struct acm *acm = usb_get_intfdata(intf);
258
259         return sprintf(buf, "%d", acm->ctrl_caps);
260 }
261 static DEVICE_ATTR_RO(bmCapabilities);
262
263 static ssize_t wCountryCodes_show
264 (struct device *dev, struct device_attribute *attr, char *buf)
265 {
266         struct usb_interface *intf = to_usb_interface(dev);
267         struct acm *acm = usb_get_intfdata(intf);
268
269         memcpy(buf, acm->country_codes, acm->country_code_size);
270         return acm->country_code_size;
271 }
272
273 static DEVICE_ATTR_RO(wCountryCodes);
274
275 static ssize_t iCountryCodeRelDate_show
276 (struct device *dev, struct device_attribute *attr, char *buf)
277 {
278         struct usb_interface *intf = to_usb_interface(dev);
279         struct acm *acm = usb_get_intfdata(intf);
280
281         return sprintf(buf, "%d", acm->country_rel_date);
282 }
283
284 static DEVICE_ATTR_RO(iCountryCodeRelDate);
285 /*
286  * Interrupt handlers for various ACM device responses
287  */
288
289 static void acm_process_notification(struct acm *acm, unsigned char *buf)
290 {
291         int newctrl;
292         int difference;
293         unsigned long flags;
294         struct usb_cdc_notification *dr = (struct usb_cdc_notification *)buf;
295         unsigned char *data = buf + sizeof(struct usb_cdc_notification);
296
297         switch (dr->bNotificationType) {
298         case USB_CDC_NOTIFY_NETWORK_CONNECTION:
299                 dev_dbg(&acm->control->dev,
300                         "%s - network connection: %d\n", __func__, dr->wValue);
301                 break;
302
303         case USB_CDC_NOTIFY_SERIAL_STATE:
304                 if (le16_to_cpu(dr->wLength) != 2) {
305                         dev_dbg(&acm->control->dev,
306                                 "%s - malformed serial state\n", __func__);
307                         break;
308                 }
309
310                 newctrl = get_unaligned_le16(data);
311                 dev_dbg(&acm->control->dev,
312                         "%s - serial state: 0x%x\n", __func__, newctrl);
313
314                 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
315                         dev_dbg(&acm->control->dev,
316                                 "%s - calling hangup\n", __func__);
317                         tty_port_tty_hangup(&acm->port, false);
318                 }
319
320                 difference = acm->ctrlin ^ newctrl;
321                 spin_lock_irqsave(&acm->read_lock, flags);
322                 acm->ctrlin = newctrl;
323                 acm->oldcount = acm->iocount;
324
325                 if (difference & ACM_CTRL_DSR)
326                         acm->iocount.dsr++;
327                 if (difference & ACM_CTRL_DCD)
328                         acm->iocount.dcd++;
329                 if (newctrl & ACM_CTRL_BRK) {
330                         acm->iocount.brk++;
331                         tty_insert_flip_char(&acm->port, 0, TTY_BREAK);
332                 }
333                 if (newctrl & ACM_CTRL_RI)
334                         acm->iocount.rng++;
335                 if (newctrl & ACM_CTRL_FRAMING)
336                         acm->iocount.frame++;
337                 if (newctrl & ACM_CTRL_PARITY)
338                         acm->iocount.parity++;
339                 if (newctrl & ACM_CTRL_OVERRUN)
340                         acm->iocount.overrun++;
341                 spin_unlock_irqrestore(&acm->read_lock, flags);
342
343                 if (difference)
344                         wake_up_all(&acm->wioctl);
345
346                 break;
347
348         default:
349                 dev_dbg(&acm->control->dev,
350                         "%s - unknown notification %d received: index %d len %d\n",
351                         __func__,
352                         dr->bNotificationType, dr->wIndex, dr->wLength);
353         }
354 }
355
356 /* control interface reports status changes with "interrupt" transfers */
357 static void acm_ctrl_irq(struct urb *urb)
358 {
359         struct acm *acm = urb->context;
360         struct usb_cdc_notification *dr = urb->transfer_buffer;
361         unsigned int current_size = urb->actual_length;
362         unsigned int expected_size, copy_size, alloc_size;
363         int retval;
364         int status = urb->status;
365
366         switch (status) {
367         case 0:
368                 /* success */
369                 break;
370         case -ECONNRESET:
371         case -ENOENT:
372         case -ESHUTDOWN:
373                 /* this urb is terminated, clean up */
374                 dev_dbg(&acm->control->dev,
375                         "%s - urb shutting down with status: %d\n",
376                         __func__, status);
377                 return;
378         default:
379                 dev_dbg(&acm->control->dev,
380                         "%s - nonzero urb status received: %d\n",
381                         __func__, status);
382                 goto exit;
383         }
384
385         usb_mark_last_busy(acm->dev);
386
387         if (acm->nb_index)
388                 dr = (struct usb_cdc_notification *)acm->notification_buffer;
389
390         /* size = notification-header + (optional) data */
391         expected_size = sizeof(struct usb_cdc_notification) +
392                                         le16_to_cpu(dr->wLength);
393
394         if (current_size < expected_size) {
395                 /* notification is transmitted fragmented, reassemble */
396                 if (acm->nb_size < expected_size) {
397                         u8 *new_buffer;
398                         alloc_size = roundup_pow_of_two(expected_size);
399                         /* Final freeing is done on disconnect. */
400                         new_buffer = krealloc(acm->notification_buffer,
401                                               alloc_size, GFP_ATOMIC);
402                         if (!new_buffer) {
403                                 acm->nb_index = 0;
404                                 goto exit;
405                         }
406
407                         acm->notification_buffer = new_buffer;
408                         acm->nb_size = alloc_size;
409                         dr = (struct usb_cdc_notification *)acm->notification_buffer;
410                 }
411
412                 copy_size = min(current_size,
413                                 expected_size - acm->nb_index);
414
415                 memcpy(&acm->notification_buffer[acm->nb_index],
416                        urb->transfer_buffer, copy_size);
417                 acm->nb_index += copy_size;
418                 current_size = acm->nb_index;
419         }
420
421         if (current_size >= expected_size) {
422                 /* notification complete */
423                 acm_process_notification(acm, (unsigned char *)dr);
424                 acm->nb_index = 0;
425         }
426
427 exit:
428         retval = usb_submit_urb(urb, GFP_ATOMIC);
429         if (retval && retval != -EPERM && retval != -ENODEV)
430                 dev_err(&acm->control->dev,
431                         "%s - usb_submit_urb failed: %d\n", __func__, retval);
432         else
433                 dev_vdbg(&acm->control->dev,
434                         "control resubmission terminated %d\n", retval);
435 }
436
437 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
438 {
439         int res;
440
441         if (!test_and_clear_bit(index, &acm->read_urbs_free))
442                 return 0;
443
444         res = usb_submit_urb(acm->read_urbs[index], mem_flags);
445         if (res) {
446                 if (res != -EPERM && res != -ENODEV) {
447                         dev_err(&acm->data->dev,
448                                 "urb %d failed submission with %d\n",
449                                 index, res);
450                 } else {
451                         dev_vdbg(&acm->data->dev, "intended failure %d\n", res);
452                 }
453                 set_bit(index, &acm->read_urbs_free);
454                 return res;
455         } else {
456                 dev_vdbg(&acm->data->dev, "submitted urb %d\n", index);
457         }
458
459         return 0;
460 }
461
462 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
463 {
464         int res;
465         int i;
466
467         for (i = 0; i < acm->rx_buflimit; ++i) {
468                 res = acm_submit_read_urb(acm, i, mem_flags);
469                 if (res)
470                         return res;
471         }
472
473         return 0;
474 }
475
476 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
477 {
478         if (!urb->actual_length)
479                 return;
480
481         tty_insert_flip_string(&acm->port, urb->transfer_buffer,
482                         urb->actual_length);
483         tty_flip_buffer_push(&acm->port);
484 }
485
486 static void acm_read_bulk_callback(struct urb *urb)
487 {
488         struct acm_rb *rb = urb->context;
489         struct acm *acm = rb->instance;
490         int status = urb->status;
491         bool stopped = false;
492         bool stalled = false;
493         bool cooldown = false;
494
495         dev_vdbg(&acm->data->dev, "got urb %d, len %d, status %d\n",
496                 rb->index, urb->actual_length, status);
497
498         switch (status) {
499         case 0:
500                 usb_mark_last_busy(acm->dev);
501                 acm_process_read_urb(acm, urb);
502                 break;
503         case -EPIPE:
504                 set_bit(EVENT_RX_STALL, &acm->flags);
505                 stalled = true;
506                 break;
507         case -ENOENT:
508         case -ECONNRESET:
509         case -ESHUTDOWN:
510                 dev_dbg(&acm->data->dev,
511                         "%s - urb shutting down with status: %d\n",
512                         __func__, status);
513                 stopped = true;
514                 break;
515         case -EOVERFLOW:
516         case -EPROTO:
517                 dev_dbg(&acm->data->dev,
518                         "%s - cooling babbling device\n", __func__);
519                 usb_mark_last_busy(acm->dev);
520                 set_bit(rb->index, &acm->urbs_in_error_delay);
521                 set_bit(ACM_ERROR_DELAY, &acm->flags);
522                 cooldown = true;
523                 break;
524         default:
525                 dev_dbg(&acm->data->dev,
526                         "%s - nonzero urb status received: %d\n",
527                         __func__, status);
528                 break;
529         }
530
531         /*
532          * Make sure URB processing is done before marking as free to avoid
533          * racing with unthrottle() on another CPU. Matches the barriers
534          * implied by the test_and_clear_bit() in acm_submit_read_urb().
535          */
536         smp_mb__before_atomic();
537         set_bit(rb->index, &acm->read_urbs_free);
538         /*
539          * Make sure URB is marked as free before checking the throttled flag
540          * to avoid racing with unthrottle() on another CPU. Matches the
541          * smp_mb() in unthrottle().
542          */
543         smp_mb__after_atomic();
544
545         if (stopped || stalled || cooldown) {
546                 if (stalled)
547                         schedule_delayed_work(&acm->dwork, 0);
548                 else if (cooldown)
549                         schedule_delayed_work(&acm->dwork, HZ / 2);
550                 return;
551         }
552
553         if (test_bit(ACM_THROTTLED, &acm->flags))
554                 return;
555
556         acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
557 }
558
559 /* data interface wrote those outgoing bytes */
560 static void acm_write_bulk(struct urb *urb)
561 {
562         struct acm_wb *wb = urb->context;
563         struct acm *acm = wb->instance;
564         unsigned long flags;
565         int status = urb->status;
566
567         if (status || (urb->actual_length != urb->transfer_buffer_length))
568                 dev_vdbg(&acm->data->dev, "wrote len %d/%d, status %d\n",
569                         urb->actual_length,
570                         urb->transfer_buffer_length,
571                         status);
572
573         spin_lock_irqsave(&acm->write_lock, flags);
574         acm_write_done(acm, wb);
575         spin_unlock_irqrestore(&acm->write_lock, flags);
576         set_bit(EVENT_TTY_WAKEUP, &acm->flags);
577         schedule_delayed_work(&acm->dwork, 0);
578 }
579
580 static void acm_softint(struct work_struct *work)
581 {
582         int i;
583         struct acm *acm = container_of(work, struct acm, dwork.work);
584
585         if (test_bit(EVENT_RX_STALL, &acm->flags)) {
586                 smp_mb(); /* against acm_suspend() */
587                 if (!acm->susp_count) {
588                         for (i = 0; i < acm->rx_buflimit; i++)
589                                 usb_kill_urb(acm->read_urbs[i]);
590                         usb_clear_halt(acm->dev, acm->in);
591                         acm_submit_read_urbs(acm, GFP_KERNEL);
592                         clear_bit(EVENT_RX_STALL, &acm->flags);
593                 }
594         }
595
596         if (test_and_clear_bit(ACM_ERROR_DELAY, &acm->flags)) {
597                 for (i = 0; i < acm->rx_buflimit; i++)
598                         if (test_and_clear_bit(i, &acm->urbs_in_error_delay))
599                                 acm_submit_read_urb(acm, i, GFP_KERNEL);
600         }
601
602         if (test_and_clear_bit(EVENT_TTY_WAKEUP, &acm->flags))
603                 tty_port_tty_wakeup(&acm->port);
604 }
605
606 /*
607  * TTY handlers
608  */
609
610 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
611 {
612         struct acm *acm;
613         int retval;
614
615         acm = acm_get_by_minor(tty->index);
616         if (!acm)
617                 return -ENODEV;
618
619         retval = tty_standard_install(driver, tty);
620         if (retval)
621                 goto error_init_termios;
622
623         /*
624          * Suppress initial echoing for some devices which might send data
625          * immediately after acm driver has been installed.
626          */
627         if (acm->quirks & DISABLE_ECHO)
628                 tty->termios.c_lflag &= ~ECHO;
629
630         tty->driver_data = acm;
631
632         return 0;
633
634 error_init_termios:
635         tty_port_put(&acm->port);
636         return retval;
637 }
638
639 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
640 {
641         struct acm *acm = tty->driver_data;
642
643         return tty_port_open(&acm->port, tty, filp);
644 }
645
646 static void acm_port_dtr_rts(struct tty_port *port, int raise)
647 {
648         struct acm *acm = container_of(port, struct acm, port);
649         int val;
650         int res;
651
652         if (raise)
653                 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
654         else
655                 val = 0;
656
657         /* FIXME: add missing ctrlout locking throughout driver */
658         acm->ctrlout = val;
659
660         res = acm_set_control(acm, val);
661         if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
662                 /* This is broken in too many devices to spam the logs */
663                 dev_dbg(&acm->control->dev, "failed to set dtr/rts\n");
664 }
665
666 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
667 {
668         struct acm *acm = container_of(port, struct acm, port);
669         int retval = -ENODEV;
670         int i;
671
672         mutex_lock(&acm->mutex);
673         if (acm->disconnected)
674                 goto disconnected;
675
676         retval = usb_autopm_get_interface(acm->control);
677         if (retval)
678                 goto error_get_interface;
679
680         /*
681          * FIXME: Why do we need this? Allocating 64K of physically contiguous
682          * memory is really nasty...
683          */
684         set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
685         acm->control->needs_remote_wakeup = 1;
686
687         acm->ctrlurb->dev = acm->dev;
688         retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
689         if (retval) {
690                 dev_err(&acm->control->dev,
691                         "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
692                 goto error_submit_urb;
693         }
694
695         acm_tty_set_termios(tty, NULL);
696
697         /*
698          * Unthrottle device in case the TTY was closed while throttled.
699          */
700         clear_bit(ACM_THROTTLED, &acm->flags);
701
702         retval = acm_submit_read_urbs(acm, GFP_KERNEL);
703         if (retval)
704                 goto error_submit_read_urbs;
705
706         usb_autopm_put_interface(acm->control);
707
708         mutex_unlock(&acm->mutex);
709
710         return 0;
711
712 error_submit_read_urbs:
713         for (i = 0; i < acm->rx_buflimit; i++)
714                 usb_kill_urb(acm->read_urbs[i]);
715         usb_kill_urb(acm->ctrlurb);
716 error_submit_urb:
717         usb_autopm_put_interface(acm->control);
718 error_get_interface:
719 disconnected:
720         mutex_unlock(&acm->mutex);
721
722         return usb_translate_errors(retval);
723 }
724
725 static void acm_port_destruct(struct tty_port *port)
726 {
727         struct acm *acm = container_of(port, struct acm, port);
728
729         if (acm->minor != ACM_MINOR_INVALID)
730                 acm_release_minor(acm);
731         usb_put_intf(acm->control);
732         kfree(acm->country_codes);
733         kfree(acm);
734 }
735
736 static void acm_port_shutdown(struct tty_port *port)
737 {
738         struct acm *acm = container_of(port, struct acm, port);
739         struct urb *urb;
740         struct acm_wb *wb;
741
742         /*
743          * Need to grab write_lock to prevent race with resume, but no need to
744          * hold it due to the tty-port initialised flag.
745          */
746         acm_poison_urbs(acm);
747         spin_lock_irq(&acm->write_lock);
748         spin_unlock_irq(&acm->write_lock);
749
750         usb_autopm_get_interface_no_resume(acm->control);
751         acm->control->needs_remote_wakeup = 0;
752         usb_autopm_put_interface(acm->control);
753
754         for (;;) {
755                 urb = usb_get_from_anchor(&acm->delayed);
756                 if (!urb)
757                         break;
758                 wb = urb->context;
759                 wb->use = false;
760                 usb_autopm_put_interface_async(acm->control);
761         }
762
763         acm_unpoison_urbs(acm);
764
765 }
766
767 static void acm_tty_cleanup(struct tty_struct *tty)
768 {
769         struct acm *acm = tty->driver_data;
770
771         tty_port_put(&acm->port);
772 }
773
774 static void acm_tty_hangup(struct tty_struct *tty)
775 {
776         struct acm *acm = tty->driver_data;
777
778         tty_port_hangup(&acm->port);
779 }
780
781 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
782 {
783         struct acm *acm = tty->driver_data;
784
785         tty_port_close(&acm->port, tty, filp);
786 }
787
788 static int acm_tty_write(struct tty_struct *tty,
789                                         const unsigned char *buf, int count)
790 {
791         struct acm *acm = tty->driver_data;
792         int stat;
793         unsigned long flags;
794         int wbn;
795         struct acm_wb *wb;
796
797         if (!count)
798                 return 0;
799
800         dev_vdbg(&acm->data->dev, "%d bytes from tty layer\n", count);
801
802         spin_lock_irqsave(&acm->write_lock, flags);
803         wbn = acm_wb_alloc(acm);
804         if (wbn < 0) {
805                 spin_unlock_irqrestore(&acm->write_lock, flags);
806                 return 0;
807         }
808         wb = &acm->wb[wbn];
809
810         if (!acm->dev) {
811                 wb->use = false;
812                 spin_unlock_irqrestore(&acm->write_lock, flags);
813                 return -ENODEV;
814         }
815
816         count = (count > acm->writesize) ? acm->writesize : count;
817         dev_vdbg(&acm->data->dev, "writing %d bytes\n", count);
818         memcpy(wb->buf, buf, count);
819         wb->len = count;
820
821         stat = usb_autopm_get_interface_async(acm->control);
822         if (stat) {
823                 wb->use = false;
824                 spin_unlock_irqrestore(&acm->write_lock, flags);
825                 return stat;
826         }
827
828         if (acm->susp_count) {
829                 usb_anchor_urb(wb->urb, &acm->delayed);
830                 spin_unlock_irqrestore(&acm->write_lock, flags);
831                 return count;
832         }
833
834         stat = acm_start_wb(acm, wb);
835         spin_unlock_irqrestore(&acm->write_lock, flags);
836
837         if (stat < 0)
838                 return stat;
839         return count;
840 }
841
842 static unsigned int acm_tty_write_room(struct tty_struct *tty)
843 {
844         struct acm *acm = tty->driver_data;
845         /*
846          * Do not let the line discipline to know that we have a reserve,
847          * or it might get too enthusiastic.
848          */
849         return acm_wb_is_avail(acm) ? acm->writesize : 0;
850 }
851
852 static unsigned int acm_tty_chars_in_buffer(struct tty_struct *tty)
853 {
854         struct acm *acm = tty->driver_data;
855         /*
856          * if the device was unplugged then any remaining characters fell out
857          * of the connector ;)
858          */
859         if (acm->disconnected)
860                 return 0;
861         /*
862          * This is inaccurate (overcounts), but it works.
863          */
864         return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
865 }
866
867 static void acm_tty_throttle(struct tty_struct *tty)
868 {
869         struct acm *acm = tty->driver_data;
870
871         set_bit(ACM_THROTTLED, &acm->flags);
872 }
873
874 static void acm_tty_unthrottle(struct tty_struct *tty)
875 {
876         struct acm *acm = tty->driver_data;
877
878         clear_bit(ACM_THROTTLED, &acm->flags);
879
880         /* Matches the smp_mb__after_atomic() in acm_read_bulk_callback(). */
881         smp_mb();
882
883         acm_submit_read_urbs(acm, GFP_KERNEL);
884 }
885
886 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
887 {
888         struct acm *acm = tty->driver_data;
889         int retval;
890
891         retval = acm_send_break(acm, state ? 0xffff : 0);
892         if (retval < 0)
893                 dev_dbg(&acm->control->dev,
894                         "%s - send break failed\n", __func__);
895         return retval;
896 }
897
898 static int acm_tty_tiocmget(struct tty_struct *tty)
899 {
900         struct acm *acm = tty->driver_data;
901
902         return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
903                (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
904                (acm->ctrlin  & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
905                (acm->ctrlin  & ACM_CTRL_RI  ? TIOCM_RI  : 0) |
906                (acm->ctrlin  & ACM_CTRL_DCD ? TIOCM_CD  : 0) |
907                TIOCM_CTS;
908 }
909
910 static int acm_tty_tiocmset(struct tty_struct *tty,
911                             unsigned int set, unsigned int clear)
912 {
913         struct acm *acm = tty->driver_data;
914         unsigned int newctrl;
915
916         newctrl = acm->ctrlout;
917         set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
918                                         (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
919         clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
920                                         (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
921
922         newctrl = (newctrl & ~clear) | set;
923
924         if (acm->ctrlout == newctrl)
925                 return 0;
926         return acm_set_control(acm, acm->ctrlout = newctrl);
927 }
928
929 static int get_serial_info(struct tty_struct *tty, struct serial_struct *ss)
930 {
931         struct acm *acm = tty->driver_data;
932
933         ss->line = acm->minor;
934         ss->close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
935         ss->closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
936                                 ASYNC_CLOSING_WAIT_NONE :
937                                 jiffies_to_msecs(acm->port.closing_wait) / 10;
938         return 0;
939 }
940
941 static int set_serial_info(struct tty_struct *tty, struct serial_struct *ss)
942 {
943         struct acm *acm = tty->driver_data;
944         unsigned int closing_wait, close_delay;
945         int retval = 0;
946
947         close_delay = msecs_to_jiffies(ss->close_delay * 10);
948         closing_wait = ss->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
949                         ASYNC_CLOSING_WAIT_NONE :
950                         msecs_to_jiffies(ss->closing_wait * 10);
951
952         mutex_lock(&acm->port.mutex);
953
954         if (!capable(CAP_SYS_ADMIN)) {
955                 if ((close_delay != acm->port.close_delay) ||
956                     (closing_wait != acm->port.closing_wait))
957                         retval = -EPERM;
958         } else {
959                 acm->port.close_delay  = close_delay;
960                 acm->port.closing_wait = closing_wait;
961         }
962
963         mutex_unlock(&acm->port.mutex);
964         return retval;
965 }
966
967 static int wait_serial_change(struct acm *acm, unsigned long arg)
968 {
969         int rv = 0;
970         DECLARE_WAITQUEUE(wait, current);
971         struct async_icount old, new;
972
973         do {
974                 spin_lock_irq(&acm->read_lock);
975                 old = acm->oldcount;
976                 new = acm->iocount;
977                 acm->oldcount = new;
978                 spin_unlock_irq(&acm->read_lock);
979
980                 if ((arg & TIOCM_DSR) &&
981                         old.dsr != new.dsr)
982                         break;
983                 if ((arg & TIOCM_CD)  &&
984                         old.dcd != new.dcd)
985                         break;
986                 if ((arg & TIOCM_RI) &&
987                         old.rng != new.rng)
988                         break;
989
990                 add_wait_queue(&acm->wioctl, &wait);
991                 set_current_state(TASK_INTERRUPTIBLE);
992                 schedule();
993                 remove_wait_queue(&acm->wioctl, &wait);
994                 if (acm->disconnected) {
995                         if (arg & TIOCM_CD)
996                                 break;
997                         else
998                                 rv = -ENODEV;
999                 } else {
1000                         if (signal_pending(current))
1001                                 rv = -ERESTARTSYS;
1002                 }
1003         } while (!rv);
1004
1005         
1006
1007         return rv;
1008 }
1009
1010 static int acm_tty_get_icount(struct tty_struct *tty,
1011                                         struct serial_icounter_struct *icount)
1012 {
1013         struct acm *acm = tty->driver_data;
1014
1015         icount->dsr = acm->iocount.dsr;
1016         icount->rng = acm->iocount.rng;
1017         icount->dcd = acm->iocount.dcd;
1018         icount->frame = acm->iocount.frame;
1019         icount->overrun = acm->iocount.overrun;
1020         icount->parity = acm->iocount.parity;
1021         icount->brk = acm->iocount.brk;
1022
1023         return 0;
1024 }
1025
1026 static int acm_tty_ioctl(struct tty_struct *tty,
1027                                         unsigned int cmd, unsigned long arg)
1028 {
1029         struct acm *acm = tty->driver_data;
1030         int rv = -ENOIOCTLCMD;
1031
1032         switch (cmd) {
1033         case TIOCMIWAIT:
1034                 rv = usb_autopm_get_interface(acm->control);
1035                 if (rv < 0) {
1036                         rv = -EIO;
1037                         break;
1038                 }
1039                 rv = wait_serial_change(acm, arg);
1040                 usb_autopm_put_interface(acm->control);
1041                 break;
1042         }
1043
1044         return rv;
1045 }
1046
1047 static void acm_tty_set_termios(struct tty_struct *tty,
1048                                                 struct ktermios *termios_old)
1049 {
1050         struct acm *acm = tty->driver_data;
1051         struct ktermios *termios = &tty->termios;
1052         struct usb_cdc_line_coding newline;
1053         int newctrl = acm->ctrlout;
1054
1055         newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
1056         newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1057         newline.bParityType = termios->c_cflag & PARENB ?
1058                                 (termios->c_cflag & PARODD ? 1 : 2) +
1059                                 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1060         newline.bDataBits = tty_get_char_size(termios->c_cflag);
1061
1062         /* FIXME: Needs to clear unsupported bits in the termios */
1063         acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1064
1065         if (C_BAUD(tty) == B0) {
1066                 newline.dwDTERate = acm->line.dwDTERate;
1067                 newctrl &= ~ACM_CTRL_DTR;
1068         } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1069                 newctrl |=  ACM_CTRL_DTR;
1070         }
1071
1072         if (newctrl != acm->ctrlout)
1073                 acm_set_control(acm, acm->ctrlout = newctrl);
1074
1075         if (memcmp(&acm->line, &newline, sizeof newline)) {
1076                 memcpy(&acm->line, &newline, sizeof newline);
1077                 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1078                         __func__,
1079                         le32_to_cpu(newline.dwDTERate),
1080                         newline.bCharFormat, newline.bParityType,
1081                         newline.bDataBits);
1082                 acm_set_line(acm, &acm->line);
1083         }
1084 }
1085
1086 static const struct tty_port_operations acm_port_ops = {
1087         .dtr_rts = acm_port_dtr_rts,
1088         .shutdown = acm_port_shutdown,
1089         .activate = acm_port_activate,
1090         .destruct = acm_port_destruct,
1091 };
1092
1093 /*
1094  * USB probe and disconnect routines.
1095  */
1096
1097 /* Little helpers: write/read buffers free */
1098 static void acm_write_buffers_free(struct acm *acm)
1099 {
1100         int i;
1101         struct acm_wb *wb;
1102
1103         for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1104                 usb_free_coherent(acm->dev, acm->writesize, wb->buf, wb->dmah);
1105 }
1106
1107 static void acm_read_buffers_free(struct acm *acm)
1108 {
1109         int i;
1110
1111         for (i = 0; i < acm->rx_buflimit; i++)
1112                 usb_free_coherent(acm->dev, acm->readsize,
1113                           acm->read_buffers[i].base, acm->read_buffers[i].dma);
1114 }
1115
1116 /* Little helper: write buffers allocate */
1117 static int acm_write_buffers_alloc(struct acm *acm)
1118 {
1119         int i;
1120         struct acm_wb *wb;
1121
1122         for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1123                 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1124                     &wb->dmah);
1125                 if (!wb->buf) {
1126                         while (i != 0) {
1127                                 --i;
1128                                 --wb;
1129                                 usb_free_coherent(acm->dev, acm->writesize,
1130                                     wb->buf, wb->dmah);
1131                         }
1132                         return -ENOMEM;
1133                 }
1134         }
1135         return 0;
1136 }
1137
1138 static int acm_probe(struct usb_interface *intf,
1139                      const struct usb_device_id *id)
1140 {
1141         struct usb_cdc_union_desc *union_header = NULL;
1142         struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
1143         unsigned char *buffer = intf->altsetting->extra;
1144         int buflen = intf->altsetting->extralen;
1145         struct usb_interface *control_interface;
1146         struct usb_interface *data_interface;
1147         struct usb_endpoint_descriptor *epctrl = NULL;
1148         struct usb_endpoint_descriptor *epread = NULL;
1149         struct usb_endpoint_descriptor *epwrite = NULL;
1150         struct usb_device *usb_dev = interface_to_usbdev(intf);
1151         struct usb_cdc_parsed_header h;
1152         struct acm *acm;
1153         int minor;
1154         int ctrlsize, readsize;
1155         u8 *buf;
1156         int call_intf_num = -1;
1157         int data_intf_num = -1;
1158         unsigned long quirks;
1159         int num_rx_buf;
1160         int i;
1161         int combined_interfaces = 0;
1162         struct device *tty_dev;
1163         int rv = -ENOMEM;
1164         int res;
1165
1166         /* normal quirks */
1167         quirks = (unsigned long)id->driver_info;
1168
1169         if (quirks == IGNORE_DEVICE)
1170                 return -ENODEV;
1171
1172         memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1173
1174         num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1175
1176         /* handle quirks deadly to normal probing*/
1177         if (quirks == NO_UNION_NORMAL) {
1178                 data_interface = usb_ifnum_to_if(usb_dev, 1);
1179                 control_interface = usb_ifnum_to_if(usb_dev, 0);
1180                 /* we would crash */
1181                 if (!data_interface || !control_interface)
1182                         return -ENODEV;
1183                 goto skip_normal_probe;
1184         }
1185
1186         /* normal probing*/
1187         if (!buffer) {
1188                 dev_err(&intf->dev, "Weird descriptor references\n");
1189                 return -EINVAL;
1190         }
1191
1192         if (!buflen) {
1193                 if (intf->cur_altsetting->endpoint &&
1194                                 intf->cur_altsetting->endpoint->extralen &&
1195                                 intf->cur_altsetting->endpoint->extra) {
1196                         dev_dbg(&intf->dev,
1197                                 "Seeking extra descriptors on endpoint\n");
1198                         buflen = intf->cur_altsetting->endpoint->extralen;
1199                         buffer = intf->cur_altsetting->endpoint->extra;
1200                 } else {
1201                         dev_err(&intf->dev,
1202                                 "Zero length descriptor references\n");
1203                         return -EINVAL;
1204                 }
1205         }
1206
1207         cdc_parse_cdc_header(&h, intf, buffer, buflen);
1208         union_header = h.usb_cdc_union_desc;
1209         cmgmd = h.usb_cdc_call_mgmt_descriptor;
1210         if (cmgmd)
1211                 call_intf_num = cmgmd->bDataInterface;
1212
1213         if (!union_header) {
1214                 if (intf->cur_altsetting->desc.bNumEndpoints == 3) {
1215                         dev_dbg(&intf->dev, "No union descriptor, assuming single interface\n");
1216                         combined_interfaces = 1;
1217                         control_interface = data_interface = intf;
1218                         goto look_for_collapsed_interface;
1219                 } else if (call_intf_num > 0) {
1220                         dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1221                         data_intf_num = call_intf_num;
1222                         data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1223                         control_interface = intf;
1224                 } else {
1225                         dev_dbg(&intf->dev, "No union descriptor, giving up\n");
1226                         return -ENODEV;
1227                 }
1228         } else {
1229                 int class = -1;
1230
1231                 data_intf_num = union_header->bSlaveInterface0;
1232                 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1233                 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1234
1235                 if (control_interface)
1236                         class = control_interface->cur_altsetting->desc.bInterfaceClass;
1237
1238                 if (class != USB_CLASS_COMM && class != USB_CLASS_CDC_DATA) {
1239                         dev_dbg(&intf->dev, "Broken union descriptor, assuming single interface\n");
1240                         combined_interfaces = 1;
1241                         control_interface = data_interface = intf;
1242                         goto look_for_collapsed_interface;
1243                 }
1244         }
1245
1246         if (!control_interface || !data_interface) {
1247                 dev_dbg(&intf->dev, "no interfaces\n");
1248                 return -ENODEV;
1249         }
1250
1251         if (data_intf_num != call_intf_num)
1252                 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1253
1254         if (control_interface == data_interface) {
1255                 /* some broken devices designed for windows work this way */
1256                 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1257                 combined_interfaces = 1;
1258                 /* a popular other OS doesn't use it */
1259                 quirks |= NO_CAP_LINE;
1260                 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1261                         dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1262                         return -EINVAL;
1263                 }
1264 look_for_collapsed_interface:
1265                 res = usb_find_common_endpoints(data_interface->cur_altsetting,
1266                                 &epread, &epwrite, &epctrl, NULL);
1267                 if (res)
1268                         return res;
1269
1270                 goto made_compressed_probe;
1271         }
1272
1273 skip_normal_probe:
1274
1275         /*workaround for switched interfaces */
1276         if (data_interface->cur_altsetting->desc.bInterfaceClass != USB_CLASS_CDC_DATA) {
1277                 if (control_interface->cur_altsetting->desc.bInterfaceClass == USB_CLASS_CDC_DATA) {
1278                         dev_dbg(&intf->dev,
1279                                 "Your device has switched interfaces.\n");
1280                         swap(control_interface, data_interface);
1281                 } else {
1282                         return -EINVAL;
1283                 }
1284         }
1285
1286         /* Accept probe requests only for the control interface */
1287         if (!combined_interfaces && intf != control_interface)
1288                 return -ENODEV;
1289
1290         if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1291             control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1292                 return -EINVAL;
1293
1294         epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1295         epread = &data_interface->cur_altsetting->endpoint[0].desc;
1296         epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1297
1298
1299         /* workaround for switched endpoints */
1300         if (!usb_endpoint_dir_in(epread)) {
1301                 /* descriptors are swapped */
1302                 dev_dbg(&intf->dev,
1303                         "The data interface has switched endpoints\n");
1304                 swap(epread, epwrite);
1305         }
1306 made_compressed_probe:
1307         dev_dbg(&intf->dev, "interfaces are valid\n");
1308
1309         acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1310         if (!acm)
1311                 return -ENOMEM;
1312
1313         tty_port_init(&acm->port);
1314         acm->port.ops = &acm_port_ops;
1315
1316         ctrlsize = usb_endpoint_maxp(epctrl);
1317         readsize = usb_endpoint_maxp(epread) *
1318                                 (quirks == SINGLE_RX_URB ? 1 : 2);
1319         acm->combined_interfaces = combined_interfaces;
1320         acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1321         acm->control = control_interface;
1322         acm->data = data_interface;
1323
1324         usb_get_intf(acm->control); /* undone in destruct() */
1325
1326         minor = acm_alloc_minor(acm);
1327         if (minor < 0) {
1328                 acm->minor = ACM_MINOR_INVALID;
1329                 goto err_put_port;
1330         }
1331
1332         acm->minor = minor;
1333         acm->dev = usb_dev;
1334         if (h.usb_cdc_acm_descriptor)
1335                 acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
1336         if (quirks & NO_CAP_LINE)
1337                 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1338         acm->ctrlsize = ctrlsize;
1339         acm->readsize = readsize;
1340         acm->rx_buflimit = num_rx_buf;
1341         INIT_DELAYED_WORK(&acm->dwork, acm_softint);
1342         init_waitqueue_head(&acm->wioctl);
1343         spin_lock_init(&acm->write_lock);
1344         spin_lock_init(&acm->read_lock);
1345         mutex_init(&acm->mutex);
1346         if (usb_endpoint_xfer_int(epread)) {
1347                 acm->bInterval = epread->bInterval;
1348                 acm->in = usb_rcvintpipe(usb_dev, epread->bEndpointAddress);
1349         } else {
1350                 acm->in = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1351         }
1352         if (usb_endpoint_xfer_int(epwrite))
1353                 acm->out = usb_sndintpipe(usb_dev, epwrite->bEndpointAddress);
1354         else
1355                 acm->out = usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress);
1356         init_usb_anchor(&acm->delayed);
1357         acm->quirks = quirks;
1358
1359         buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1360         if (!buf)
1361                 goto err_put_port;
1362         acm->ctrl_buffer = buf;
1363
1364         if (acm_write_buffers_alloc(acm) < 0)
1365                 goto err_free_ctrl_buffer;
1366
1367         acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1368         if (!acm->ctrlurb)
1369                 goto err_free_write_buffers;
1370
1371         for (i = 0; i < num_rx_buf; i++) {
1372                 struct acm_rb *rb = &(acm->read_buffers[i]);
1373                 struct urb *urb;
1374
1375                 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1376                                                                 &rb->dma);
1377                 if (!rb->base)
1378                         goto err_free_read_urbs;
1379                 rb->index = i;
1380                 rb->instance = acm;
1381
1382                 urb = usb_alloc_urb(0, GFP_KERNEL);
1383                 if (!urb)
1384                         goto err_free_read_urbs;
1385
1386                 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1387                 urb->transfer_dma = rb->dma;
1388                 if (usb_endpoint_xfer_int(epread))
1389                         usb_fill_int_urb(urb, acm->dev, acm->in, rb->base,
1390                                          acm->readsize,
1391                                          acm_read_bulk_callback, rb,
1392                                          acm->bInterval);
1393                 else
1394                         usb_fill_bulk_urb(urb, acm->dev, acm->in, rb->base,
1395                                           acm->readsize,
1396                                           acm_read_bulk_callback, rb);
1397
1398                 acm->read_urbs[i] = urb;
1399                 __set_bit(i, &acm->read_urbs_free);
1400         }
1401         for (i = 0; i < ACM_NW; i++) {
1402                 struct acm_wb *snd = &(acm->wb[i]);
1403
1404                 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1405                 if (!snd->urb)
1406                         goto err_free_write_urbs;
1407
1408                 if (usb_endpoint_xfer_int(epwrite))
1409                         usb_fill_int_urb(snd->urb, usb_dev, acm->out,
1410                                 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1411                 else
1412                         usb_fill_bulk_urb(snd->urb, usb_dev, acm->out,
1413                                 NULL, acm->writesize, acm_write_bulk, snd);
1414                 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1415                 if (quirks & SEND_ZERO_PACKET)
1416                         snd->urb->transfer_flags |= URB_ZERO_PACKET;
1417                 snd->instance = acm;
1418         }
1419
1420         usb_set_intfdata(intf, acm);
1421
1422         i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1423         if (i < 0)
1424                 goto err_free_write_urbs;
1425
1426         if (h.usb_cdc_country_functional_desc) { /* export the country data */
1427                 struct usb_cdc_country_functional_desc * cfd =
1428                                         h.usb_cdc_country_functional_desc;
1429
1430                 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1431                 if (!acm->country_codes)
1432                         goto skip_countries;
1433                 acm->country_code_size = cfd->bLength - 4;
1434                 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1435                                                         cfd->bLength - 4);
1436                 acm->country_rel_date = cfd->iCountryCodeRelDate;
1437
1438                 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1439                 if (i < 0) {
1440                         kfree(acm->country_codes);
1441                         acm->country_codes = NULL;
1442                         acm->country_code_size = 0;
1443                         goto skip_countries;
1444                 }
1445
1446                 i = device_create_file(&intf->dev,
1447                                                 &dev_attr_iCountryCodeRelDate);
1448                 if (i < 0) {
1449                         device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1450                         kfree(acm->country_codes);
1451                         acm->country_codes = NULL;
1452                         acm->country_code_size = 0;
1453                         goto skip_countries;
1454                 }
1455         }
1456
1457 skip_countries:
1458         usb_fill_int_urb(acm->ctrlurb, usb_dev,
1459                          usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1460                          acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1461                          /* works around buggy devices */
1462                          epctrl->bInterval ? epctrl->bInterval : 16);
1463         acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1464         acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1465         acm->notification_buffer = NULL;
1466         acm->nb_index = 0;
1467         acm->nb_size = 0;
1468
1469         acm->line.dwDTERate = cpu_to_le32(9600);
1470         acm->line.bDataBits = 8;
1471         acm_set_line(acm, &acm->line);
1472
1473         if (!acm->combined_interfaces) {
1474                 rv = usb_driver_claim_interface(&acm_driver, data_interface, acm);
1475                 if (rv)
1476                         goto err_remove_files;
1477         }
1478
1479         tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1480                         &control_interface->dev);
1481         if (IS_ERR(tty_dev)) {
1482                 rv = PTR_ERR(tty_dev);
1483                 goto err_release_data_interface;
1484         }
1485
1486         if (quirks & CLEAR_HALT_CONDITIONS) {
1487                 usb_clear_halt(usb_dev, acm->in);
1488                 usb_clear_halt(usb_dev, acm->out);
1489         }
1490
1491         dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1492
1493         return 0;
1494
1495 err_release_data_interface:
1496         if (!acm->combined_interfaces) {
1497                 /* Clear driver data so that disconnect() returns early. */
1498                 usb_set_intfdata(data_interface, NULL);
1499                 usb_driver_release_interface(&acm_driver, data_interface);
1500         }
1501 err_remove_files:
1502         if (acm->country_codes) {
1503                 device_remove_file(&acm->control->dev,
1504                                 &dev_attr_wCountryCodes);
1505                 device_remove_file(&acm->control->dev,
1506                                 &dev_attr_iCountryCodeRelDate);
1507         }
1508         device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1509 err_free_write_urbs:
1510         for (i = 0; i < ACM_NW; i++)
1511                 usb_free_urb(acm->wb[i].urb);
1512 err_free_read_urbs:
1513         for (i = 0; i < num_rx_buf; i++)
1514                 usb_free_urb(acm->read_urbs[i]);
1515         acm_read_buffers_free(acm);
1516         usb_free_urb(acm->ctrlurb);
1517 err_free_write_buffers:
1518         acm_write_buffers_free(acm);
1519 err_free_ctrl_buffer:
1520         usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1521 err_put_port:
1522         tty_port_put(&acm->port);
1523
1524         return rv;
1525 }
1526
1527 static void acm_disconnect(struct usb_interface *intf)
1528 {
1529         struct acm *acm = usb_get_intfdata(intf);
1530         struct tty_struct *tty;
1531         int i;
1532
1533         /* sibling interface is already cleaning up */
1534         if (!acm)
1535                 return;
1536
1537         acm->disconnected = true;
1538         /*
1539          * there is a circular dependency. acm_softint() can resubmit
1540          * the URBs in error handling so we need to block any
1541          * submission right away
1542          */
1543         acm_poison_urbs(acm);
1544         mutex_lock(&acm->mutex);
1545         if (acm->country_codes) {
1546                 device_remove_file(&acm->control->dev,
1547                                 &dev_attr_wCountryCodes);
1548                 device_remove_file(&acm->control->dev,
1549                                 &dev_attr_iCountryCodeRelDate);
1550         }
1551         wake_up_all(&acm->wioctl);
1552         device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1553         usb_set_intfdata(acm->control, NULL);
1554         usb_set_intfdata(acm->data, NULL);
1555         mutex_unlock(&acm->mutex);
1556
1557         tty = tty_port_tty_get(&acm->port);
1558         if (tty) {
1559                 tty_vhangup(tty);
1560                 tty_kref_put(tty);
1561         }
1562
1563         cancel_delayed_work_sync(&acm->dwork);
1564
1565         tty_unregister_device(acm_tty_driver, acm->minor);
1566
1567         usb_free_urb(acm->ctrlurb);
1568         for (i = 0; i < ACM_NW; i++)
1569                 usb_free_urb(acm->wb[i].urb);
1570         for (i = 0; i < acm->rx_buflimit; i++)
1571                 usb_free_urb(acm->read_urbs[i]);
1572         acm_write_buffers_free(acm);
1573         usb_free_coherent(acm->dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1574         acm_read_buffers_free(acm);
1575
1576         kfree(acm->notification_buffer);
1577
1578         if (!acm->combined_interfaces)
1579                 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1580                                         acm->data : acm->control);
1581
1582         tty_port_put(&acm->port);
1583 }
1584
1585 #ifdef CONFIG_PM
1586 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1587 {
1588         struct acm *acm = usb_get_intfdata(intf);
1589         int cnt;
1590
1591         spin_lock_irq(&acm->write_lock);
1592         if (PMSG_IS_AUTO(message)) {
1593                 if (acm->transmitting) {
1594                         spin_unlock_irq(&acm->write_lock);
1595                         return -EBUSY;
1596                 }
1597         }
1598         cnt = acm->susp_count++;
1599         spin_unlock_irq(&acm->write_lock);
1600
1601         if (cnt)
1602                 return 0;
1603
1604         acm_poison_urbs(acm);
1605         cancel_delayed_work_sync(&acm->dwork);
1606         acm->urbs_in_error_delay = 0;
1607
1608         return 0;
1609 }
1610
1611 static int acm_resume(struct usb_interface *intf)
1612 {
1613         struct acm *acm = usb_get_intfdata(intf);
1614         struct urb *urb;
1615         int rv = 0;
1616
1617         spin_lock_irq(&acm->write_lock);
1618
1619         if (--acm->susp_count)
1620                 goto out;
1621
1622         acm_unpoison_urbs(acm);
1623
1624         if (tty_port_initialized(&acm->port)) {
1625                 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1626
1627                 for (;;) {
1628                         urb = usb_get_from_anchor(&acm->delayed);
1629                         if (!urb)
1630                                 break;
1631
1632                         acm_start_wb(acm, urb->context);
1633                 }
1634
1635                 /*
1636                  * delayed error checking because we must
1637                  * do the write path at all cost
1638                  */
1639                 if (rv < 0)
1640                         goto out;
1641
1642                 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1643         }
1644 out:
1645         spin_unlock_irq(&acm->write_lock);
1646
1647         return rv;
1648 }
1649
1650 static int acm_reset_resume(struct usb_interface *intf)
1651 {
1652         struct acm *acm = usb_get_intfdata(intf);
1653
1654         if (tty_port_initialized(&acm->port))
1655                 tty_port_tty_hangup(&acm->port, false);
1656
1657         return acm_resume(intf);
1658 }
1659
1660 #endif /* CONFIG_PM */
1661
1662 static int acm_pre_reset(struct usb_interface *intf)
1663 {
1664         struct acm *acm = usb_get_intfdata(intf);
1665
1666         clear_bit(EVENT_RX_STALL, &acm->flags);
1667         acm->nb_index = 0; /* pending control transfers are lost */
1668
1669         return 0;
1670 }
1671
1672 #define NOKIA_PCSUITE_ACM_INFO(x) \
1673                 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1674                 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1675                 USB_CDC_ACM_PROTO_VENDOR)
1676
1677 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1678                 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1679                 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1680                 USB_CDC_ACM_PROTO_VENDOR)
1681
1682 /*
1683  * USB driver structure.
1684  */
1685
1686 static const struct usb_device_id acm_ids[] = {
1687         /* quirky and broken devices */
1688         { USB_DEVICE(0x0424, 0x274e), /* Microchip Technology, Inc. (formerly SMSC) */
1689           .driver_info = DISABLE_ECHO, }, /* DISABLE ECHO in termios flag */
1690         { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1691         .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1692         { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1693         .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1694         { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1695         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1696         },
1697         { USB_DEVICE(0x045b, 0x023c),   /* Renesas USB Download mode */
1698         .driver_info = DISABLE_ECHO,    /* Don't echo banner */
1699         },
1700         { USB_DEVICE(0x045b, 0x0248),   /* Renesas USB Download mode */
1701         .driver_info = DISABLE_ECHO,    /* Don't echo banner */
1702         },
1703         { USB_DEVICE(0x045b, 0x024D),   /* Renesas USB Download mode */
1704         .driver_info = DISABLE_ECHO,    /* Don't echo banner */
1705         },
1706         { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1707         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1708         },
1709         { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1710         .driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1711         },
1712         { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1713         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1714         },
1715         { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1716         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1717         },
1718         { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1719         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1720         },
1721         { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1722         .driver_info = SINGLE_RX_URB,
1723         },
1724         { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1725         .driver_info = SINGLE_RX_URB, /* firmware bug */
1726         },
1727         { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1728         .driver_info = SINGLE_RX_URB, /* firmware bug */
1729         },
1730         { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1731         .driver_info = SINGLE_RX_URB,
1732         },
1733         { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1734         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1735         },
1736         { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1737         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1738         },
1739         { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1740         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1741         },
1742         { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1743         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1744         },
1745         { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1746         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1747         },
1748         { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1749         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1750         },
1751         { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1752         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1753         },
1754         { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1755         .driver_info = QUIRK_CONTROL_LINE_STATE, },
1756         { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1757         { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1758         { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1759         },
1760         /* Motorola H24 HSPA module: */
1761         { USB_DEVICE(0x22b8, 0x2d91) }, /* modem                                */
1762         { USB_DEVICE(0x22b8, 0x2d92),   /* modem           + diagnostics        */
1763         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1764         },
1765         { USB_DEVICE(0x22b8, 0x2d93),   /* modem + AT port                      */
1766         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1767         },
1768         { USB_DEVICE(0x22b8, 0x2d95),   /* modem + AT port + diagnostics        */
1769         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1770         },
1771         { USB_DEVICE(0x22b8, 0x2d96),   /* modem                         + NMEA */
1772         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1773         },
1774         { USB_DEVICE(0x22b8, 0x2d97),   /* modem           + diagnostics + NMEA */
1775         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1776         },
1777         { USB_DEVICE(0x22b8, 0x2d99),   /* modem + AT port               + NMEA */
1778         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1779         },
1780         { USB_DEVICE(0x22b8, 0x2d9a),   /* modem + AT port + diagnostics + NMEA */
1781         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1782         },
1783
1784         { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1785         .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1786                                            data interface instead of
1787                                            communications interface.
1788                                            Maybe we should define a new
1789                                            quirk for this. */
1790         },
1791         { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1792         .driver_info = NO_UNION_NORMAL,
1793         },
1794         { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1795         .driver_info = NO_UNION_NORMAL,
1796         },
1797         { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1798         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1799         },
1800         { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1801         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1802         },
1803         { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1804         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1805         },
1806         { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1807         .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1808         },
1809         { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1810         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1811         },
1812
1813         { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1814         .driver_info = CLEAR_HALT_CONDITIONS,
1815         },
1816
1817         /* Nokia S60 phones expose two ACM channels. The first is
1818          * a modem and is picked up by the standard AT-command
1819          * information below. The second is 'vendor-specific' but
1820          * is treated as a serial device at the S60 end, so we want
1821          * to expose it on Linux too. */
1822         { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1823         { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1824         { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1825         { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1826         { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1827         { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1828         { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1829         { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1830         { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1831         { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1832         { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1833         { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1834         { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1835         { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1836         { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1837         { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1838         { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1839         { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i  */
1840         { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1841         { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1842         { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1843         { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic &  */
1844         { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1845         { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1846         { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1847         { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1848         { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1849         { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1850         { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1851         { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1852         { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1853         { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB  */
1854         { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1855         { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1856         { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1857         { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1858         { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1859         { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1860         { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1861         { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3  */
1862         { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1863         { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1864         { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1865         { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1866         { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1867         { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1868         { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1869         { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1870         { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1871         { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1872         { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1873         { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1874         { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1875         { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1876         { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1877         { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1878         { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1879         { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1880
1881         /* Support for Owen devices */
1882         { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1883
1884         /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1885
1886 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1887         { USB_DEVICE(0x04d8, 0x0082),   /* Application mode */
1888         .driver_info = IGNORE_DEVICE,
1889         },
1890         { USB_DEVICE(0x04d8, 0x0083),   /* Bootloader mode */
1891         .driver_info = IGNORE_DEVICE,
1892         },
1893 #endif
1894
1895 #if IS_ENABLED(CONFIG_IR_TOY)
1896         { USB_DEVICE(0x04d8, 0xfd08),
1897         .driver_info = IGNORE_DEVICE,
1898         },
1899
1900         { USB_DEVICE(0x04d8, 0xf58b),
1901         .driver_info = IGNORE_DEVICE,
1902         },
1903 #endif
1904
1905 #if IS_ENABLED(CONFIG_USB_SERIAL_XR)
1906         { USB_DEVICE(0x04e2, 0x1400), .driver_info = IGNORE_DEVICE },
1907         { USB_DEVICE(0x04e2, 0x1401), .driver_info = IGNORE_DEVICE },
1908         { USB_DEVICE(0x04e2, 0x1402), .driver_info = IGNORE_DEVICE },
1909         { USB_DEVICE(0x04e2, 0x1403), .driver_info = IGNORE_DEVICE },
1910         { USB_DEVICE(0x04e2, 0x1410), .driver_info = IGNORE_DEVICE },
1911         { USB_DEVICE(0x04e2, 0x1411), .driver_info = IGNORE_DEVICE },
1912         { USB_DEVICE(0x04e2, 0x1412), .driver_info = IGNORE_DEVICE },
1913         { USB_DEVICE(0x04e2, 0x1414), .driver_info = IGNORE_DEVICE },
1914         { USB_DEVICE(0x04e2, 0x1420), .driver_info = IGNORE_DEVICE },
1915         { USB_DEVICE(0x04e2, 0x1422), .driver_info = IGNORE_DEVICE },
1916         { USB_DEVICE(0x04e2, 0x1424), .driver_info = IGNORE_DEVICE },
1917 #endif
1918
1919         /*Samsung phone in firmware update mode */
1920         { USB_DEVICE(0x04e8, 0x685d),
1921         .driver_info = IGNORE_DEVICE,
1922         },
1923
1924         /* Exclude Infineon Flash Loader utility */
1925         { USB_DEVICE(0x058b, 0x0041),
1926         .driver_info = IGNORE_DEVICE,
1927         },
1928
1929         /* Exclude ETAS ES58x */
1930         { USB_DEVICE(0x108c, 0x0159), /* ES581.4 */
1931         .driver_info = IGNORE_DEVICE,
1932         },
1933         { USB_DEVICE(0x108c, 0x0168), /* ES582.1 */
1934         .driver_info = IGNORE_DEVICE,
1935         },
1936         { USB_DEVICE(0x108c, 0x0169), /* ES584.1 */
1937         .driver_info = IGNORE_DEVICE,
1938         },
1939
1940         { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1941         .driver_info = SEND_ZERO_PACKET,
1942         },
1943         { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1944         .driver_info = SEND_ZERO_PACKET,
1945         },
1946
1947         /* Exclude Goodix Fingerprint Reader */
1948         { USB_DEVICE(0x27c6, 0x5395),
1949         .driver_info = IGNORE_DEVICE,
1950         },
1951
1952         /* Exclude Heimann Sensor GmbH USB appset demo */
1953         { USB_DEVICE(0x32a7, 0x0000),
1954         .driver_info = IGNORE_DEVICE,
1955         },
1956
1957         /* control interfaces without any protocol set */
1958         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1959                 USB_CDC_PROTO_NONE) },
1960
1961         /* control interfaces with various AT-command sets */
1962         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1963                 USB_CDC_ACM_PROTO_AT_V25TER) },
1964         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1965                 USB_CDC_ACM_PROTO_AT_PCCA101) },
1966         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1967                 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1968         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1969                 USB_CDC_ACM_PROTO_AT_GSM) },
1970         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1971                 USB_CDC_ACM_PROTO_AT_3G) },
1972         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1973                 USB_CDC_ACM_PROTO_AT_CDMA) },
1974
1975         { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1976         .driver_info = SEND_ZERO_PACKET,
1977         },
1978
1979         { }
1980 };
1981
1982 MODULE_DEVICE_TABLE(usb, acm_ids);
1983
1984 static struct usb_driver acm_driver = {
1985         .name =         "cdc_acm",
1986         .probe =        acm_probe,
1987         .disconnect =   acm_disconnect,
1988 #ifdef CONFIG_PM
1989         .suspend =      acm_suspend,
1990         .resume =       acm_resume,
1991         .reset_resume = acm_reset_resume,
1992 #endif
1993         .pre_reset =    acm_pre_reset,
1994         .id_table =     acm_ids,
1995 #ifdef CONFIG_PM
1996         .supports_autosuspend = 1,
1997 #endif
1998         .disable_hub_initiated_lpm = 1,
1999 };
2000
2001 /*
2002  * TTY driver structures.
2003  */
2004
2005 static const struct tty_operations acm_ops = {
2006         .install =              acm_tty_install,
2007         .open =                 acm_tty_open,
2008         .close =                acm_tty_close,
2009         .cleanup =              acm_tty_cleanup,
2010         .hangup =               acm_tty_hangup,
2011         .write =                acm_tty_write,
2012         .write_room =           acm_tty_write_room,
2013         .ioctl =                acm_tty_ioctl,
2014         .throttle =             acm_tty_throttle,
2015         .unthrottle =           acm_tty_unthrottle,
2016         .chars_in_buffer =      acm_tty_chars_in_buffer,
2017         .break_ctl =            acm_tty_break_ctl,
2018         .set_termios =          acm_tty_set_termios,
2019         .tiocmget =             acm_tty_tiocmget,
2020         .tiocmset =             acm_tty_tiocmset,
2021         .get_serial =           get_serial_info,
2022         .set_serial =           set_serial_info,
2023         .get_icount =           acm_tty_get_icount,
2024 };
2025
2026 /*
2027  * Init / exit.
2028  */
2029
2030 static int __init acm_init(void)
2031 {
2032         int retval;
2033         acm_tty_driver = tty_alloc_driver(ACM_TTY_MINORS, TTY_DRIVER_REAL_RAW |
2034                         TTY_DRIVER_DYNAMIC_DEV);
2035         if (IS_ERR(acm_tty_driver))
2036                 return PTR_ERR(acm_tty_driver);
2037         acm_tty_driver->driver_name = "acm",
2038         acm_tty_driver->name = "ttyACM",
2039         acm_tty_driver->major = ACM_TTY_MAJOR,
2040         acm_tty_driver->minor_start = 0,
2041         acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2042         acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
2043         acm_tty_driver->init_termios = tty_std_termios;
2044         acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2045                                                                 HUPCL | CLOCAL;
2046         tty_set_operations(acm_tty_driver, &acm_ops);
2047
2048         retval = tty_register_driver(acm_tty_driver);
2049         if (retval) {
2050                 tty_driver_kref_put(acm_tty_driver);
2051                 return retval;
2052         }
2053
2054         retval = usb_register(&acm_driver);
2055         if (retval) {
2056                 tty_unregister_driver(acm_tty_driver);
2057                 tty_driver_kref_put(acm_tty_driver);
2058                 return retval;
2059         }
2060
2061         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2062
2063         return 0;
2064 }
2065
2066 static void __exit acm_exit(void)
2067 {
2068         usb_deregister(&acm_driver);
2069         tty_unregister_driver(acm_tty_driver);
2070         tty_driver_kref_put(acm_tty_driver);
2071         idr_destroy(&acm_minors);
2072 }
2073
2074 module_init(acm_init);
2075 module_exit(acm_exit);
2076
2077 MODULE_AUTHOR(DRIVER_AUTHOR);
2078 MODULE_DESCRIPTION(DRIVER_DESC);
2079 MODULE_LICENSE("GPL");
2080 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);