1 // SPDX-License-Identifier: GPL-2.0+
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>
13 * USB Abstract Control Model driver for USB modems and ISDN adapters
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>
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"
47 static struct usb_driver acm_driver;
48 static struct tty_driver *acm_tty_driver;
50 static DEFINE_IDR(acm_minors);
51 static DEFINE_MUTEX(acm_minors_lock);
53 static void acm_tty_set_termios(struct tty_struct *tty,
54 struct ktermios *termios_old);
57 * acm_minors accessors
61 * Look up an ACM structure by minor. If found and not disconnected, increment
62 * its refcount and return it with its mutex held.
64 static struct acm *acm_get_by_minor(unsigned int minor)
68 mutex_lock(&acm_minors_lock);
69 acm = idr_find(&acm_minors, minor);
71 mutex_lock(&acm->mutex);
72 if (acm->disconnected) {
73 mutex_unlock(&acm->mutex);
76 tty_port_get(&acm->port);
77 mutex_unlock(&acm->mutex);
80 mutex_unlock(&acm_minors_lock);
85 * Try to find an available minor number and if found, associate it with 'acm'.
87 static int acm_alloc_minor(struct acm *acm)
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);
98 /* Release the minor number associated with 'acm'. */
99 static void acm_release_minor(struct acm *acm)
101 mutex_lock(&acm_minors_lock);
102 idr_remove(&acm_minors, acm->minor);
103 mutex_unlock(&acm_minors_lock);
107 * Functions for ACM control messages.
110 static int acm_ctrl_msg(struct acm *acm, int request, int value,
115 retval = usb_autopm_get_interface(acm->control);
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,
124 dev_dbg(&acm->control->dev,
125 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
126 __func__, request, value, len, retval);
128 usb_autopm_put_interface(acm->control);
130 return retval < 0 ? retval : 0;
133 /* devices aren't required to support these requests.
134 * the cdc acm descriptor tells whether they do...
136 static inline int acm_set_control(struct acm *acm, int control)
138 if (acm->quirks & QUIRK_CONTROL_LINE_STATE)
141 return acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE,
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)
150 static void acm_poison_urbs(struct acm *acm)
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]);
161 static void acm_unpoison_urbs(struct acm *acm)
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);
174 * Write buffer management.
175 * All of these assume proper locks taken by the caller.
178 static int acm_wb_alloc(struct acm *acm)
192 wbn = (wbn + 1) % ACM_NW;
198 static int acm_wb_is_avail(struct acm *acm)
204 spin_lock_irqsave(&acm->write_lock, flags);
205 for (i = 0; i < ACM_NW; i++)
208 spin_unlock_irqrestore(&acm->write_lock, flags);
213 * Finish write. Caller must hold acm->write_lock
215 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
219 usb_autopm_put_interface_async(acm->control);
225 * the caller is responsible for locking
228 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
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;
239 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
242 dev_err(&acm->data->dev,
243 "%s - usb_submit_urb(write bulk) failed: %d\n",
245 acm_write_done(acm, wb);
251 * attributes exported through sysfs
253 static ssize_t bmCapabilities_show
254 (struct device *dev, struct device_attribute *attr, char *buf)
256 struct usb_interface *intf = to_usb_interface(dev);
257 struct acm *acm = usb_get_intfdata(intf);
259 return sprintf(buf, "%d", acm->ctrl_caps);
261 static DEVICE_ATTR_RO(bmCapabilities);
263 static ssize_t wCountryCodes_show
264 (struct device *dev, struct device_attribute *attr, char *buf)
266 struct usb_interface *intf = to_usb_interface(dev);
267 struct acm *acm = usb_get_intfdata(intf);
269 memcpy(buf, acm->country_codes, acm->country_code_size);
270 return acm->country_code_size;
273 static DEVICE_ATTR_RO(wCountryCodes);
275 static ssize_t iCountryCodeRelDate_show
276 (struct device *dev, struct device_attribute *attr, char *buf)
278 struct usb_interface *intf = to_usb_interface(dev);
279 struct acm *acm = usb_get_intfdata(intf);
281 return sprintf(buf, "%d", acm->country_rel_date);
284 static DEVICE_ATTR_RO(iCountryCodeRelDate);
286 * Interrupt handlers for various ACM device responses
289 static void acm_process_notification(struct acm *acm, unsigned char *buf)
294 struct usb_cdc_notification *dr = (struct usb_cdc_notification *)buf;
295 unsigned char *data = buf + sizeof(struct usb_cdc_notification);
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);
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__);
310 newctrl = get_unaligned_le16(data);
311 dev_dbg(&acm->control->dev,
312 "%s - serial state: 0x%x\n", __func__, newctrl);
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);
320 difference = acm->ctrlin ^ newctrl;
321 spin_lock_irqsave(&acm->read_lock, flags);
322 acm->ctrlin = newctrl;
323 acm->oldcount = acm->iocount;
325 if (difference & ACM_CTRL_DSR)
327 if (difference & ACM_CTRL_DCD)
329 if (newctrl & ACM_CTRL_BRK) {
331 tty_insert_flip_char(&acm->port, 0, TTY_BREAK);
333 if (newctrl & ACM_CTRL_RI)
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);
343 if (newctrl & ACM_CTRL_BRK)
344 tty_flip_buffer_push(&acm->port);
347 wake_up_all(&acm->wioctl);
352 dev_dbg(&acm->control->dev,
353 "%s - unknown notification %d received: index %d len %d\n",
355 dr->bNotificationType, dr->wIndex, dr->wLength);
359 /* control interface reports status changes with "interrupt" transfers */
360 static void acm_ctrl_irq(struct urb *urb)
362 struct acm *acm = urb->context;
363 struct usb_cdc_notification *dr = urb->transfer_buffer;
364 unsigned int current_size = urb->actual_length;
365 unsigned int expected_size, copy_size, alloc_size;
367 int status = urb->status;
376 /* this urb is terminated, clean up */
377 dev_dbg(&acm->control->dev,
378 "%s - urb shutting down with status: %d\n",
382 dev_dbg(&acm->control->dev,
383 "%s - nonzero urb status received: %d\n",
388 usb_mark_last_busy(acm->dev);
391 dr = (struct usb_cdc_notification *)acm->notification_buffer;
393 /* size = notification-header + (optional) data */
394 expected_size = sizeof(struct usb_cdc_notification) +
395 le16_to_cpu(dr->wLength);
397 if (current_size < expected_size) {
398 /* notification is transmitted fragmented, reassemble */
399 if (acm->nb_size < expected_size) {
401 alloc_size = roundup_pow_of_two(expected_size);
402 /* Final freeing is done on disconnect. */
403 new_buffer = krealloc(acm->notification_buffer,
404 alloc_size, GFP_ATOMIC);
410 acm->notification_buffer = new_buffer;
411 acm->nb_size = alloc_size;
412 dr = (struct usb_cdc_notification *)acm->notification_buffer;
415 copy_size = min(current_size,
416 expected_size - acm->nb_index);
418 memcpy(&acm->notification_buffer[acm->nb_index],
419 urb->transfer_buffer, copy_size);
420 acm->nb_index += copy_size;
421 current_size = acm->nb_index;
424 if (current_size >= expected_size) {
425 /* notification complete */
426 acm_process_notification(acm, (unsigned char *)dr);
431 retval = usb_submit_urb(urb, GFP_ATOMIC);
432 if (retval && retval != -EPERM && retval != -ENODEV)
433 dev_err(&acm->control->dev,
434 "%s - usb_submit_urb failed: %d\n", __func__, retval);
436 dev_vdbg(&acm->control->dev,
437 "control resubmission terminated %d\n", retval);
440 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
444 if (!test_and_clear_bit(index, &acm->read_urbs_free))
447 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
449 if (res != -EPERM && res != -ENODEV) {
450 dev_err(&acm->data->dev,
451 "urb %d failed submission with %d\n",
454 dev_vdbg(&acm->data->dev, "intended failure %d\n", res);
456 set_bit(index, &acm->read_urbs_free);
459 dev_vdbg(&acm->data->dev, "submitted urb %d\n", index);
465 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
470 for (i = 0; i < acm->rx_buflimit; ++i) {
471 res = acm_submit_read_urb(acm, i, mem_flags);
479 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
483 if (!urb->actual_length)
486 spin_lock_irqsave(&acm->read_lock, flags);
487 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
489 spin_unlock_irqrestore(&acm->read_lock, flags);
491 tty_flip_buffer_push(&acm->port);
494 static void acm_read_bulk_callback(struct urb *urb)
496 struct acm_rb *rb = urb->context;
497 struct acm *acm = rb->instance;
498 int status = urb->status;
499 bool stopped = false;
500 bool stalled = false;
501 bool cooldown = false;
503 dev_vdbg(&acm->data->dev, "got urb %d, len %d, status %d\n",
504 rb->index, urb->actual_length, status);
508 usb_mark_last_busy(acm->dev);
509 acm_process_read_urb(acm, urb);
512 set_bit(EVENT_RX_STALL, &acm->flags);
518 dev_dbg(&acm->data->dev,
519 "%s - urb shutting down with status: %d\n",
525 dev_dbg(&acm->data->dev,
526 "%s - cooling babbling device\n", __func__);
527 usb_mark_last_busy(acm->dev);
528 set_bit(rb->index, &acm->urbs_in_error_delay);
529 set_bit(ACM_ERROR_DELAY, &acm->flags);
533 dev_dbg(&acm->data->dev,
534 "%s - nonzero urb status received: %d\n",
540 * Make sure URB processing is done before marking as free to avoid
541 * racing with unthrottle() on another CPU. Matches the barriers
542 * implied by the test_and_clear_bit() in acm_submit_read_urb().
544 smp_mb__before_atomic();
545 set_bit(rb->index, &acm->read_urbs_free);
547 * Make sure URB is marked as free before checking the throttled flag
548 * to avoid racing with unthrottle() on another CPU. Matches the
549 * smp_mb() in unthrottle().
551 smp_mb__after_atomic();
553 if (stopped || stalled || cooldown) {
555 schedule_delayed_work(&acm->dwork, 0);
557 schedule_delayed_work(&acm->dwork, HZ / 2);
561 if (test_bit(ACM_THROTTLED, &acm->flags))
564 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
567 /* data interface wrote those outgoing bytes */
568 static void acm_write_bulk(struct urb *urb)
570 struct acm_wb *wb = urb->context;
571 struct acm *acm = wb->instance;
573 int status = urb->status;
575 if (status || (urb->actual_length != urb->transfer_buffer_length))
576 dev_vdbg(&acm->data->dev, "wrote len %d/%d, status %d\n",
578 urb->transfer_buffer_length,
581 spin_lock_irqsave(&acm->write_lock, flags);
582 acm_write_done(acm, wb);
583 spin_unlock_irqrestore(&acm->write_lock, flags);
584 set_bit(EVENT_TTY_WAKEUP, &acm->flags);
585 schedule_delayed_work(&acm->dwork, 0);
588 static void acm_softint(struct work_struct *work)
591 struct acm *acm = container_of(work, struct acm, dwork.work);
593 if (test_bit(EVENT_RX_STALL, &acm->flags)) {
594 smp_mb(); /* against acm_suspend() */
595 if (!acm->susp_count) {
596 for (i = 0; i < acm->rx_buflimit; i++)
597 usb_kill_urb(acm->read_urbs[i]);
598 usb_clear_halt(acm->dev, acm->in);
599 acm_submit_read_urbs(acm, GFP_KERNEL);
600 clear_bit(EVENT_RX_STALL, &acm->flags);
604 if (test_and_clear_bit(ACM_ERROR_DELAY, &acm->flags)) {
605 for (i = 0; i < acm->rx_buflimit; i++)
606 if (test_and_clear_bit(i, &acm->urbs_in_error_delay))
607 acm_submit_read_urb(acm, i, GFP_KERNEL);
610 if (test_and_clear_bit(EVENT_TTY_WAKEUP, &acm->flags))
611 tty_port_tty_wakeup(&acm->port);
618 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
623 acm = acm_get_by_minor(tty->index);
627 retval = tty_standard_install(driver, tty);
629 goto error_init_termios;
632 * Suppress initial echoing for some devices which might send data
633 * immediately after acm driver has been installed.
635 if (acm->quirks & DISABLE_ECHO)
636 tty->termios.c_lflag &= ~ECHO;
638 tty->driver_data = acm;
643 tty_port_put(&acm->port);
647 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
649 struct acm *acm = tty->driver_data;
651 return tty_port_open(&acm->port, tty, filp);
654 static void acm_port_dtr_rts(struct tty_port *port, int raise)
656 struct acm *acm = container_of(port, struct acm, port);
661 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
665 /* FIXME: add missing ctrlout locking throughout driver */
668 res = acm_set_control(acm, val);
669 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
670 /* This is broken in too many devices to spam the logs */
671 dev_dbg(&acm->control->dev, "failed to set dtr/rts\n");
674 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
676 struct acm *acm = container_of(port, struct acm, port);
677 int retval = -ENODEV;
680 mutex_lock(&acm->mutex);
681 if (acm->disconnected)
684 retval = usb_autopm_get_interface(acm->control);
686 goto error_get_interface;
689 * FIXME: Why do we need this? Allocating 64K of physically contiguous
690 * memory is really nasty...
692 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
693 acm->control->needs_remote_wakeup = 1;
695 acm->ctrlurb->dev = acm->dev;
696 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
698 dev_err(&acm->control->dev,
699 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
700 goto error_submit_urb;
703 acm_tty_set_termios(tty, NULL);
706 * Unthrottle device in case the TTY was closed while throttled.
708 clear_bit(ACM_THROTTLED, &acm->flags);
710 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
712 goto error_submit_read_urbs;
714 usb_autopm_put_interface(acm->control);
716 mutex_unlock(&acm->mutex);
720 error_submit_read_urbs:
721 for (i = 0; i < acm->rx_buflimit; i++)
722 usb_kill_urb(acm->read_urbs[i]);
723 usb_kill_urb(acm->ctrlurb);
725 usb_autopm_put_interface(acm->control);
728 mutex_unlock(&acm->mutex);
730 return usb_translate_errors(retval);
733 static void acm_port_destruct(struct tty_port *port)
735 struct acm *acm = container_of(port, struct acm, port);
737 if (acm->minor != ACM_MINOR_INVALID)
738 acm_release_minor(acm);
739 usb_put_intf(acm->control);
740 kfree(acm->country_codes);
744 static void acm_port_shutdown(struct tty_port *port)
746 struct acm *acm = container_of(port, struct acm, port);
751 * Need to grab write_lock to prevent race with resume, but no need to
752 * hold it due to the tty-port initialised flag.
754 acm_poison_urbs(acm);
755 spin_lock_irq(&acm->write_lock);
756 spin_unlock_irq(&acm->write_lock);
758 usb_autopm_get_interface_no_resume(acm->control);
759 acm->control->needs_remote_wakeup = 0;
760 usb_autopm_put_interface(acm->control);
763 urb = usb_get_from_anchor(&acm->delayed);
768 usb_autopm_put_interface_async(acm->control);
771 acm_unpoison_urbs(acm);
775 static void acm_tty_cleanup(struct tty_struct *tty)
777 struct acm *acm = tty->driver_data;
779 tty_port_put(&acm->port);
782 static void acm_tty_hangup(struct tty_struct *tty)
784 struct acm *acm = tty->driver_data;
786 tty_port_hangup(&acm->port);
789 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
791 struct acm *acm = tty->driver_data;
793 tty_port_close(&acm->port, tty, filp);
796 static int acm_tty_write(struct tty_struct *tty,
797 const unsigned char *buf, int count)
799 struct acm *acm = tty->driver_data;
808 dev_vdbg(&acm->data->dev, "%d bytes from tty layer\n", count);
810 spin_lock_irqsave(&acm->write_lock, flags);
811 wbn = acm_wb_alloc(acm);
813 spin_unlock_irqrestore(&acm->write_lock, flags);
820 spin_unlock_irqrestore(&acm->write_lock, flags);
824 count = (count > acm->writesize) ? acm->writesize : count;
825 dev_vdbg(&acm->data->dev, "writing %d bytes\n", count);
826 memcpy(wb->buf, buf, count);
829 stat = usb_autopm_get_interface_async(acm->control);
832 spin_unlock_irqrestore(&acm->write_lock, flags);
836 if (acm->susp_count) {
837 usb_anchor_urb(wb->urb, &acm->delayed);
838 spin_unlock_irqrestore(&acm->write_lock, flags);
842 stat = acm_start_wb(acm, wb);
843 spin_unlock_irqrestore(&acm->write_lock, flags);
850 static int acm_tty_write_room(struct tty_struct *tty)
852 struct acm *acm = tty->driver_data;
854 * Do not let the line discipline to know that we have a reserve,
855 * or it might get too enthusiastic.
857 return acm_wb_is_avail(acm) ? acm->writesize : 0;
860 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
862 struct acm *acm = tty->driver_data;
864 * if the device was unplugged then any remaining characters fell out
865 * of the connector ;)
867 if (acm->disconnected)
870 * This is inaccurate (overcounts), but it works.
872 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
875 static void acm_tty_throttle(struct tty_struct *tty)
877 struct acm *acm = tty->driver_data;
879 set_bit(ACM_THROTTLED, &acm->flags);
882 static void acm_tty_unthrottle(struct tty_struct *tty)
884 struct acm *acm = tty->driver_data;
886 clear_bit(ACM_THROTTLED, &acm->flags);
888 /* Matches the smp_mb__after_atomic() in acm_read_bulk_callback(). */
891 acm_submit_read_urbs(acm, GFP_KERNEL);
894 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
896 struct acm *acm = tty->driver_data;
899 retval = acm_send_break(acm, state ? 0xffff : 0);
901 dev_dbg(&acm->control->dev,
902 "%s - send break failed\n", __func__);
906 static int acm_tty_tiocmget(struct tty_struct *tty)
908 struct acm *acm = tty->driver_data;
910 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
911 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
912 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
913 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
914 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
918 static int acm_tty_tiocmset(struct tty_struct *tty,
919 unsigned int set, unsigned int clear)
921 struct acm *acm = tty->driver_data;
922 unsigned int newctrl;
924 newctrl = acm->ctrlout;
925 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
926 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
927 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
928 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
930 newctrl = (newctrl & ~clear) | set;
932 if (acm->ctrlout == newctrl)
934 return acm_set_control(acm, acm->ctrlout = newctrl);
937 static int get_serial_info(struct tty_struct *tty, struct serial_struct *ss)
939 struct acm *acm = tty->driver_data;
941 ss->line = acm->minor;
942 ss->close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
943 ss->closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
944 ASYNC_CLOSING_WAIT_NONE :
945 jiffies_to_msecs(acm->port.closing_wait) / 10;
949 static int set_serial_info(struct tty_struct *tty, struct serial_struct *ss)
951 struct acm *acm = tty->driver_data;
952 unsigned int closing_wait, close_delay;
955 close_delay = msecs_to_jiffies(ss->close_delay * 10);
956 closing_wait = ss->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
957 ASYNC_CLOSING_WAIT_NONE :
958 msecs_to_jiffies(ss->closing_wait * 10);
960 mutex_lock(&acm->port.mutex);
962 if (!capable(CAP_SYS_ADMIN)) {
963 if ((close_delay != acm->port.close_delay) ||
964 (closing_wait != acm->port.closing_wait))
967 acm->port.close_delay = close_delay;
968 acm->port.closing_wait = closing_wait;
971 mutex_unlock(&acm->port.mutex);
975 static int wait_serial_change(struct acm *acm, unsigned long arg)
978 DECLARE_WAITQUEUE(wait, current);
979 struct async_icount old, new;
982 spin_lock_irq(&acm->read_lock);
986 spin_unlock_irq(&acm->read_lock);
988 if ((arg & TIOCM_DSR) &&
991 if ((arg & TIOCM_CD) &&
994 if ((arg & TIOCM_RI) &&
998 add_wait_queue(&acm->wioctl, &wait);
999 set_current_state(TASK_INTERRUPTIBLE);
1001 remove_wait_queue(&acm->wioctl, &wait);
1002 if (acm->disconnected) {
1008 if (signal_pending(current))
1018 static int acm_tty_get_icount(struct tty_struct *tty,
1019 struct serial_icounter_struct *icount)
1021 struct acm *acm = tty->driver_data;
1023 icount->dsr = acm->iocount.dsr;
1024 icount->rng = acm->iocount.rng;
1025 icount->dcd = acm->iocount.dcd;
1026 icount->frame = acm->iocount.frame;
1027 icount->overrun = acm->iocount.overrun;
1028 icount->parity = acm->iocount.parity;
1029 icount->brk = acm->iocount.brk;
1034 static int acm_tty_ioctl(struct tty_struct *tty,
1035 unsigned int cmd, unsigned long arg)
1037 struct acm *acm = tty->driver_data;
1038 int rv = -ENOIOCTLCMD;
1042 rv = usb_autopm_get_interface(acm->control);
1047 rv = wait_serial_change(acm, arg);
1048 usb_autopm_put_interface(acm->control);
1055 static void acm_tty_set_termios(struct tty_struct *tty,
1056 struct ktermios *termios_old)
1058 struct acm *acm = tty->driver_data;
1059 struct ktermios *termios = &tty->termios;
1060 struct usb_cdc_line_coding newline;
1061 int newctrl = acm->ctrlout;
1063 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
1064 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1065 newline.bParityType = termios->c_cflag & PARENB ?
1066 (termios->c_cflag & PARODD ? 1 : 2) +
1067 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1068 switch (termios->c_cflag & CSIZE) {
1070 newline.bDataBits = 5;
1073 newline.bDataBits = 6;
1076 newline.bDataBits = 7;
1080 newline.bDataBits = 8;
1083 /* FIXME: Needs to clear unsupported bits in the termios */
1084 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1086 if (C_BAUD(tty) == B0) {
1087 newline.dwDTERate = acm->line.dwDTERate;
1088 newctrl &= ~ACM_CTRL_DTR;
1089 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1090 newctrl |= ACM_CTRL_DTR;
1093 if (newctrl != acm->ctrlout)
1094 acm_set_control(acm, acm->ctrlout = newctrl);
1096 if (memcmp(&acm->line, &newline, sizeof newline)) {
1097 memcpy(&acm->line, &newline, sizeof newline);
1098 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1100 le32_to_cpu(newline.dwDTERate),
1101 newline.bCharFormat, newline.bParityType,
1103 acm_set_line(acm, &acm->line);
1107 static const struct tty_port_operations acm_port_ops = {
1108 .dtr_rts = acm_port_dtr_rts,
1109 .shutdown = acm_port_shutdown,
1110 .activate = acm_port_activate,
1111 .destruct = acm_port_destruct,
1115 * USB probe and disconnect routines.
1118 /* Little helpers: write/read buffers free */
1119 static void acm_write_buffers_free(struct acm *acm)
1124 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1125 usb_free_coherent(acm->dev, acm->writesize, wb->buf, wb->dmah);
1128 static void acm_read_buffers_free(struct acm *acm)
1132 for (i = 0; i < acm->rx_buflimit; i++)
1133 usb_free_coherent(acm->dev, acm->readsize,
1134 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1137 /* Little helper: write buffers allocate */
1138 static int acm_write_buffers_alloc(struct acm *acm)
1143 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1144 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1150 usb_free_coherent(acm->dev, acm->writesize,
1159 static int acm_probe(struct usb_interface *intf,
1160 const struct usb_device_id *id)
1162 struct usb_cdc_union_desc *union_header = NULL;
1163 struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
1164 unsigned char *buffer = intf->altsetting->extra;
1165 int buflen = intf->altsetting->extralen;
1166 struct usb_interface *control_interface;
1167 struct usb_interface *data_interface;
1168 struct usb_endpoint_descriptor *epctrl = NULL;
1169 struct usb_endpoint_descriptor *epread = NULL;
1170 struct usb_endpoint_descriptor *epwrite = NULL;
1171 struct usb_device *usb_dev = interface_to_usbdev(intf);
1172 struct usb_cdc_parsed_header h;
1175 int ctrlsize, readsize;
1177 int call_intf_num = -1;
1178 int data_intf_num = -1;
1179 unsigned long quirks;
1182 int combined_interfaces = 0;
1183 struct device *tty_dev;
1188 quirks = (unsigned long)id->driver_info;
1190 if (quirks == IGNORE_DEVICE)
1193 memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1195 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1197 /* handle quirks deadly to normal probing*/
1198 if (quirks == NO_UNION_NORMAL) {
1199 data_interface = usb_ifnum_to_if(usb_dev, 1);
1200 control_interface = usb_ifnum_to_if(usb_dev, 0);
1201 /* we would crash */
1202 if (!data_interface || !control_interface)
1204 goto skip_normal_probe;
1209 dev_err(&intf->dev, "Weird descriptor references\n");
1214 if (intf->cur_altsetting->endpoint &&
1215 intf->cur_altsetting->endpoint->extralen &&
1216 intf->cur_altsetting->endpoint->extra) {
1218 "Seeking extra descriptors on endpoint\n");
1219 buflen = intf->cur_altsetting->endpoint->extralen;
1220 buffer = intf->cur_altsetting->endpoint->extra;
1223 "Zero length descriptor references\n");
1228 cdc_parse_cdc_header(&h, intf, buffer, buflen);
1229 union_header = h.usb_cdc_union_desc;
1230 cmgmd = h.usb_cdc_call_mgmt_descriptor;
1232 call_intf_num = cmgmd->bDataInterface;
1234 if (!union_header) {
1235 if (intf->cur_altsetting->desc.bNumEndpoints == 3) {
1236 dev_dbg(&intf->dev, "No union descriptor, assuming single interface\n");
1237 combined_interfaces = 1;
1238 control_interface = data_interface = intf;
1239 goto look_for_collapsed_interface;
1240 } else if (call_intf_num > 0) {
1241 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1242 data_intf_num = call_intf_num;
1243 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1244 control_interface = intf;
1246 dev_dbg(&intf->dev, "No union descriptor, giving up\n");
1252 data_intf_num = union_header->bSlaveInterface0;
1253 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1254 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1256 if (control_interface)
1257 class = control_interface->cur_altsetting->desc.bInterfaceClass;
1259 if (class != USB_CLASS_COMM && class != USB_CLASS_CDC_DATA) {
1260 dev_dbg(&intf->dev, "Broken union descriptor, assuming single interface\n");
1261 combined_interfaces = 1;
1262 control_interface = data_interface = intf;
1263 goto look_for_collapsed_interface;
1267 if (!control_interface || !data_interface) {
1268 dev_dbg(&intf->dev, "no interfaces\n");
1272 if (data_intf_num != call_intf_num)
1273 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1275 if (control_interface == data_interface) {
1276 /* some broken devices designed for windows work this way */
1277 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1278 combined_interfaces = 1;
1279 /* a popular other OS doesn't use it */
1280 quirks |= NO_CAP_LINE;
1281 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1282 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1285 look_for_collapsed_interface:
1286 res = usb_find_common_endpoints(data_interface->cur_altsetting,
1287 &epread, &epwrite, &epctrl, NULL);
1291 goto made_compressed_probe;
1296 /*workaround for switched interfaces */
1297 if (data_interface->cur_altsetting->desc.bInterfaceClass != USB_CLASS_CDC_DATA) {
1298 if (control_interface->cur_altsetting->desc.bInterfaceClass == USB_CLASS_CDC_DATA) {
1300 "Your device has switched interfaces.\n");
1301 swap(control_interface, data_interface);
1307 /* Accept probe requests only for the control interface */
1308 if (!combined_interfaces && intf != control_interface)
1311 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1312 /* valid in this context */
1313 dev_dbg(&intf->dev, "The data interface isn't available\n");
1318 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1319 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
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;
1327 /* workaround for switched endpoints */
1328 if (!usb_endpoint_dir_in(epread)) {
1329 /* descriptors are swapped */
1331 "The data interface has switched endpoints\n");
1332 swap(epread, epwrite);
1334 made_compressed_probe:
1335 dev_dbg(&intf->dev, "interfaces are valid\n");
1337 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1341 tty_port_init(&acm->port);
1342 acm->port.ops = &acm_port_ops;
1344 ctrlsize = usb_endpoint_maxp(epctrl);
1345 readsize = usb_endpoint_maxp(epread) *
1346 (quirks == SINGLE_RX_URB ? 1 : 2);
1347 acm->combined_interfaces = combined_interfaces;
1348 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1349 acm->control = control_interface;
1350 acm->data = data_interface;
1352 usb_get_intf(acm->control); /* undone in destruct() */
1354 minor = acm_alloc_minor(acm);
1356 acm->minor = ACM_MINOR_INVALID;
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(epread)) {
1375 acm->bInterval = epread->bInterval;
1376 acm->in = usb_rcvintpipe(usb_dev, epread->bEndpointAddress);
1378 acm->in = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1380 if (usb_endpoint_xfer_int(epwrite))
1381 acm->out = usb_sndintpipe(usb_dev, epwrite->bEndpointAddress);
1383 acm->out = usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress);
1384 init_usb_anchor(&acm->delayed);
1385 acm->quirks = quirks;
1387 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1390 acm->ctrl_buffer = buf;
1392 if (acm_write_buffers_alloc(acm) < 0)
1395 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1399 for (i = 0; i < num_rx_buf; i++) {
1400 struct acm_rb *rb = &(acm->read_buffers[i]);
1403 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1410 urb = usb_alloc_urb(0, GFP_KERNEL);
1414 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1415 urb->transfer_dma = rb->dma;
1416 if (usb_endpoint_xfer_int(epread))
1417 usb_fill_int_urb(urb, acm->dev, acm->in, rb->base,
1419 acm_read_bulk_callback, rb,
1422 usb_fill_bulk_urb(urb, acm->dev, acm->in, rb->base,
1424 acm_read_bulk_callback, rb);
1426 acm->read_urbs[i] = urb;
1427 __set_bit(i, &acm->read_urbs_free);
1429 for (i = 0; i < ACM_NW; i++) {
1430 struct acm_wb *snd = &(acm->wb[i]);
1432 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1433 if (snd->urb == NULL)
1436 if (usb_endpoint_xfer_int(epwrite))
1437 usb_fill_int_urb(snd->urb, usb_dev, acm->out,
1438 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1440 usb_fill_bulk_urb(snd->urb, usb_dev, acm->out,
1441 NULL, acm->writesize, acm_write_bulk, 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;
1448 usb_set_intfdata(intf, acm);
1450 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
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;
1458 acm->country_codes = kmalloc(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,
1464 acm->country_rel_date = cfd->iCountryCodeRelDate;
1466 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1468 kfree(acm->country_codes);
1469 acm->country_codes = NULL;
1470 acm->country_code_size = 0;
1471 goto skip_countries;
1474 i = device_create_file(&intf->dev,
1475 &dev_attr_iCountryCodeRelDate);
1477 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1478 kfree(acm->country_codes);
1479 acm->country_codes = NULL;
1480 acm->country_code_size = 0;
1481 goto skip_countries;
1486 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1487 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1488 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1489 /* works around buggy devices */
1490 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;
1497 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1499 acm->line.dwDTERate = cpu_to_le32(9600);
1500 acm->line.bDataBits = 8;
1501 acm_set_line(acm, &acm->line);
1503 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1504 usb_set_intfdata(data_interface, acm);
1506 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1507 &control_interface->dev);
1508 if (IS_ERR(tty_dev)) {
1509 rv = PTR_ERR(tty_dev);
1513 if (quirks & CLEAR_HALT_CONDITIONS) {
1514 usb_clear_halt(usb_dev, acm->in);
1515 usb_clear_halt(usb_dev, acm->out);
1520 if (!acm->combined_interfaces) {
1521 /* Clear driver data so that disconnect() returns early. */
1522 usb_set_intfdata(data_interface, NULL);
1523 usb_driver_release_interface(&acm_driver, data_interface);
1525 if (acm->country_codes) {
1526 device_remove_file(&acm->control->dev,
1527 &dev_attr_wCountryCodes);
1528 device_remove_file(&acm->control->dev,
1529 &dev_attr_iCountryCodeRelDate);
1531 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1533 usb_set_intfdata(intf, NULL);
1534 for (i = 0; i < ACM_NW; i++)
1535 usb_free_urb(acm->wb[i].urb);
1537 for (i = 0; i < num_rx_buf; i++)
1538 usb_free_urb(acm->read_urbs[i]);
1539 acm_read_buffers_free(acm);
1540 usb_free_urb(acm->ctrlurb);
1542 acm_write_buffers_free(acm);
1544 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1546 tty_port_put(&acm->port);
1551 static void acm_disconnect(struct usb_interface *intf)
1553 struct acm *acm = usb_get_intfdata(intf);
1554 struct tty_struct *tty;
1557 /* sibling interface is already cleaning up */
1561 acm->disconnected = true;
1563 * there is a circular dependency. acm_softint() can resubmit
1564 * the URBs in error handling so we need to block any
1565 * submission right away
1567 acm_poison_urbs(acm);
1568 mutex_lock(&acm->mutex);
1569 if (acm->country_codes) {
1570 device_remove_file(&acm->control->dev,
1571 &dev_attr_wCountryCodes);
1572 device_remove_file(&acm->control->dev,
1573 &dev_attr_iCountryCodeRelDate);
1575 wake_up_all(&acm->wioctl);
1576 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1577 usb_set_intfdata(acm->control, NULL);
1578 usb_set_intfdata(acm->data, NULL);
1579 mutex_unlock(&acm->mutex);
1581 tty = tty_port_tty_get(&acm->port);
1587 cancel_delayed_work_sync(&acm->dwork);
1589 tty_unregister_device(acm_tty_driver, acm->minor);
1591 usb_free_urb(acm->ctrlurb);
1592 for (i = 0; i < ACM_NW; i++)
1593 usb_free_urb(acm->wb[i].urb);
1594 for (i = 0; i < acm->rx_buflimit; i++)
1595 usb_free_urb(acm->read_urbs[i]);
1596 acm_write_buffers_free(acm);
1597 usb_free_coherent(acm->dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1598 acm_read_buffers_free(acm);
1600 kfree(acm->notification_buffer);
1602 if (!acm->combined_interfaces)
1603 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1604 acm->data : acm->control);
1606 tty_port_put(&acm->port);
1610 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1612 struct acm *acm = usb_get_intfdata(intf);
1615 spin_lock_irq(&acm->write_lock);
1616 if (PMSG_IS_AUTO(message)) {
1617 if (acm->transmitting) {
1618 spin_unlock_irq(&acm->write_lock);
1622 cnt = acm->susp_count++;
1623 spin_unlock_irq(&acm->write_lock);
1628 acm_poison_urbs(acm);
1629 cancel_delayed_work_sync(&acm->dwork);
1630 acm->urbs_in_error_delay = 0;
1635 static int acm_resume(struct usb_interface *intf)
1637 struct acm *acm = usb_get_intfdata(intf);
1641 spin_lock_irq(&acm->write_lock);
1643 if (--acm->susp_count)
1646 acm_unpoison_urbs(acm);
1648 if (tty_port_initialized(&acm->port)) {
1649 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1652 urb = usb_get_from_anchor(&acm->delayed);
1656 acm_start_wb(acm, urb->context);
1660 * delayed error checking because we must
1661 * do the write path at all cost
1666 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1669 spin_unlock_irq(&acm->write_lock);
1674 static int acm_reset_resume(struct usb_interface *intf)
1676 struct acm *acm = usb_get_intfdata(intf);
1678 if (tty_port_initialized(&acm->port))
1679 tty_port_tty_hangup(&acm->port, false);
1681 return acm_resume(intf);
1684 #endif /* CONFIG_PM */
1686 static int acm_pre_reset(struct usb_interface *intf)
1688 struct acm *acm = usb_get_intfdata(intf);
1690 clear_bit(EVENT_RX_STALL, &acm->flags);
1691 acm->nb_index = 0; /* pending control transfers are lost */
1696 #define NOKIA_PCSUITE_ACM_INFO(x) \
1697 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1698 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1699 USB_CDC_ACM_PROTO_VENDOR)
1701 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1702 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1703 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1704 USB_CDC_ACM_PROTO_VENDOR)
1707 * USB driver structure.
1710 static const struct usb_device_id acm_ids[] = {
1711 /* quirky and broken devices */
1712 { USB_DEVICE(0x0424, 0x274e), /* Microchip Technology, Inc. (formerly SMSC) */
1713 .driver_info = DISABLE_ECHO, }, /* DISABLE ECHO in termios flag */
1714 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1715 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1716 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1717 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1718 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1719 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1721 { USB_DEVICE(0x045b, 0x023c), /* Renesas USB Download mode */
1722 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1724 { USB_DEVICE(0x045b, 0x0248), /* Renesas USB Download mode */
1725 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1727 { USB_DEVICE(0x045b, 0x024D), /* Renesas USB Download mode */
1728 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1730 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1731 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1733 { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1734 .driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1736 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1737 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1739 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1740 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1742 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1743 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1745 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1746 .driver_info = SINGLE_RX_URB,
1748 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1749 .driver_info = SINGLE_RX_URB, /* firmware bug */
1751 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1752 .driver_info = SINGLE_RX_URB, /* firmware bug */
1754 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1755 .driver_info = SINGLE_RX_URB,
1757 { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1758 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1760 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1761 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1763 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1764 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1766 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1767 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1769 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1770 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1772 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1773 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1775 { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1776 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1778 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1779 .driver_info = QUIRK_CONTROL_LINE_STATE, },
1780 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1781 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1782 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1784 /* Motorola H24 HSPA module: */
1785 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1786 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1787 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1789 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1790 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1792 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1793 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1795 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1796 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1798 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1799 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1801 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1802 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1804 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1805 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1808 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1809 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1810 data interface instead of
1811 communications interface.
1812 Maybe we should define a new
1815 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1816 .driver_info = NO_UNION_NORMAL,
1818 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1819 .driver_info = NO_UNION_NORMAL,
1821 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1822 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1824 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1825 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1827 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1828 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1830 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1831 .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1833 { USB_DEVICE(0x0c26, 0x0020), /* Icom ICF3400 Serie */
1834 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1836 { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1837 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1840 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1841 .driver_info = CLEAR_HALT_CONDITIONS,
1844 /* Nokia S60 phones expose two ACM channels. The first is
1845 * a modem and is picked up by the standard AT-command
1846 * information below. The second is 'vendor-specific' but
1847 * is treated as a serial device at the S60 end, so we want
1848 * to expose it on Linux too. */
1849 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1850 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1851 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1852 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1853 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1854 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1855 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1856 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1857 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1858 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1859 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1860 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1861 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1862 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1863 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1864 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1865 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1866 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1867 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1868 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1869 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1870 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1871 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1872 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1873 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1874 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1875 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1876 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1877 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1878 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1879 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1880 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1881 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1882 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1883 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1884 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1885 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1886 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1887 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1888 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1889 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1890 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1891 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1892 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1893 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1894 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1895 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1896 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1897 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1898 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1899 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1900 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1901 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1902 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1903 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1904 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1905 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1906 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1908 /* Support for Owen devices */
1909 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1911 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1913 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1914 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1915 .driver_info = IGNORE_DEVICE,
1917 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1918 .driver_info = IGNORE_DEVICE,
1922 #if IS_ENABLED(CONFIG_IR_TOY)
1923 { USB_DEVICE(0x04d8, 0xfd08),
1924 .driver_info = IGNORE_DEVICE,
1927 { USB_DEVICE(0x04d8, 0xf58b),
1928 .driver_info = IGNORE_DEVICE,
1932 /*Samsung phone in firmware update mode */
1933 { USB_DEVICE(0x04e8, 0x685d),
1934 .driver_info = IGNORE_DEVICE,
1937 /* Exclude Infineon Flash Loader utility */
1938 { USB_DEVICE(0x058b, 0x0041),
1939 .driver_info = IGNORE_DEVICE,
1942 /* Exclude ETAS ES58x */
1943 { USB_DEVICE(0x108c, 0x0159), /* ES581.4 */
1944 .driver_info = IGNORE_DEVICE,
1946 { USB_DEVICE(0x108c, 0x0168), /* ES582.1 */
1947 .driver_info = IGNORE_DEVICE,
1949 { USB_DEVICE(0x108c, 0x0169), /* ES584.1 */
1950 .driver_info = IGNORE_DEVICE,
1953 { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1954 .driver_info = SEND_ZERO_PACKET,
1956 { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1957 .driver_info = SEND_ZERO_PACKET,
1960 /* Exclude Goodix Fingerprint Reader */
1961 { USB_DEVICE(0x27c6, 0x5395),
1962 .driver_info = IGNORE_DEVICE,
1965 /* Exclude Heimann Sensor GmbH USB appset demo */
1966 { USB_DEVICE(0x32a7, 0x0000),
1967 .driver_info = IGNORE_DEVICE,
1970 /* control interfaces without any protocol set */
1971 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1972 USB_CDC_PROTO_NONE) },
1974 /* control interfaces with various AT-command sets */
1975 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1976 USB_CDC_ACM_PROTO_AT_V25TER) },
1977 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1978 USB_CDC_ACM_PROTO_AT_PCCA101) },
1979 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1980 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1981 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1982 USB_CDC_ACM_PROTO_AT_GSM) },
1983 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1984 USB_CDC_ACM_PROTO_AT_3G) },
1985 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1986 USB_CDC_ACM_PROTO_AT_CDMA) },
1988 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1989 .driver_info = SEND_ZERO_PACKET,
1995 MODULE_DEVICE_TABLE(usb, acm_ids);
1997 static struct usb_driver acm_driver = {
2000 .disconnect = acm_disconnect,
2002 .suspend = acm_suspend,
2003 .resume = acm_resume,
2004 .reset_resume = acm_reset_resume,
2006 .pre_reset = acm_pre_reset,
2007 .id_table = acm_ids,
2009 .supports_autosuspend = 1,
2011 .disable_hub_initiated_lpm = 1,
2015 * TTY driver structures.
2018 static const struct tty_operations acm_ops = {
2019 .install = acm_tty_install,
2020 .open = acm_tty_open,
2021 .close = acm_tty_close,
2022 .cleanup = acm_tty_cleanup,
2023 .hangup = acm_tty_hangup,
2024 .write = acm_tty_write,
2025 .write_room = acm_tty_write_room,
2026 .ioctl = acm_tty_ioctl,
2027 .throttle = acm_tty_throttle,
2028 .unthrottle = acm_tty_unthrottle,
2029 .chars_in_buffer = acm_tty_chars_in_buffer,
2030 .break_ctl = acm_tty_break_ctl,
2031 .set_termios = acm_tty_set_termios,
2032 .tiocmget = acm_tty_tiocmget,
2033 .tiocmset = acm_tty_tiocmset,
2034 .get_serial = get_serial_info,
2035 .set_serial = set_serial_info,
2036 .get_icount = acm_tty_get_icount,
2043 static int __init acm_init(void)
2046 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
2047 if (!acm_tty_driver)
2049 acm_tty_driver->driver_name = "acm",
2050 acm_tty_driver->name = "ttyACM",
2051 acm_tty_driver->major = ACM_TTY_MAJOR,
2052 acm_tty_driver->minor_start = 0,
2053 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2054 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
2055 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2056 acm_tty_driver->init_termios = tty_std_termios;
2057 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2059 tty_set_operations(acm_tty_driver, &acm_ops);
2061 retval = tty_register_driver(acm_tty_driver);
2063 put_tty_driver(acm_tty_driver);
2067 retval = usb_register(&acm_driver);
2069 tty_unregister_driver(acm_tty_driver);
2070 put_tty_driver(acm_tty_driver);
2074 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2079 static void __exit acm_exit(void)
2081 usb_deregister(&acm_driver);
2082 tty_unregister_driver(acm_tty_driver);
2083 put_tty_driver(acm_tty_driver);
2084 idr_destroy(&acm_minors);
2087 module_init(acm_init);
2088 module_exit(acm_exit);
2090 MODULE_AUTHOR(DRIVER_AUTHOR);
2091 MODULE_DESCRIPTION(DRIVER_DESC);
2092 MODULE_LICENSE("GPL");
2093 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);