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

source code of linux/drivers/usb/class/cdc-acm.c