4 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
5 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
6 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
9 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
10 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 * USB Abstract Control Model driver for USB modems and ISDN adapters
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/serial.h>
40 #include <linux/tty_driver.h>
41 #include <linux/tty_flip.h>
42 #include <linux/module.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/usb/cdc.h>
47 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
49 #include <linux/idr.h>
50 #include <linux/list.h>
55 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
56 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
58 static struct usb_driver acm_driver;
59 static struct tty_driver *acm_tty_driver;
61 static DEFINE_IDR(acm_minors);
62 static DEFINE_MUTEX(acm_minors_lock);
64 static void acm_tty_set_termios(struct tty_struct *tty,
65 struct ktermios *termios_old);
68 * acm_minors accessors
72 * Look up an ACM structure by minor. If found and not disconnected, increment
73 * its refcount and return it with its mutex held.
75 static struct acm *acm_get_by_minor(unsigned int minor)
79 mutex_lock(&acm_minors_lock);
80 acm = idr_find(&acm_minors, minor);
82 mutex_lock(&acm->mutex);
83 if (acm->disconnected) {
84 mutex_unlock(&acm->mutex);
87 tty_port_get(&acm->port);
88 mutex_unlock(&acm->mutex);
91 mutex_unlock(&acm_minors_lock);
96 * Try to find an available minor number and if found, associate it with 'acm'.
98 static int acm_alloc_minor(struct acm *acm)
102 mutex_lock(&acm_minors_lock);
103 minor = idr_alloc(&acm_minors, acm, 0, ACM_TTY_MINORS, GFP_KERNEL);
104 mutex_unlock(&acm_minors_lock);
109 /* Release the minor number associated with 'acm'. */
110 static void acm_release_minor(struct acm *acm)
112 mutex_lock(&acm_minors_lock);
113 idr_remove(&acm_minors, acm->minor);
114 mutex_unlock(&acm_minors_lock);
118 * Functions for ACM control messages.
121 static int acm_ctrl_msg(struct acm *acm, int request, int value,
126 retval = usb_autopm_get_interface(acm->control);
130 retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
131 request, USB_RT_ACM, value,
132 acm->control->altsetting[0].desc.bInterfaceNumber,
135 dev_dbg(&acm->control->dev,
136 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
137 __func__, request, value, len, retval);
139 usb_autopm_put_interface(acm->control);
141 return retval < 0 ? retval : 0;
144 /* devices aren't required to support these requests.
145 * the cdc acm descriptor tells whether they do...
147 static inline int acm_set_control(struct acm *acm, int control)
149 if (acm->quirks & QUIRK_CONTROL_LINE_STATE)
152 return acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE,
156 #define acm_set_line(acm, line) \
157 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
158 #define acm_send_break(acm, ms) \
159 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
162 * Write buffer management.
163 * All of these assume proper locks taken by the caller.
166 static int acm_wb_alloc(struct acm *acm)
180 wbn = (wbn + 1) % ACM_NW;
186 static int acm_wb_is_avail(struct acm *acm)
192 spin_lock_irqsave(&acm->write_lock, flags);
193 for (i = 0; i < ACM_NW; i++)
195 spin_unlock_irqrestore(&acm->write_lock, flags);
200 * Finish write. Caller must hold acm->write_lock
202 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
206 usb_autopm_put_interface_async(acm->control);
212 * the caller is responsible for locking
215 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
221 wb->urb->transfer_buffer = wb->buf;
222 wb->urb->transfer_dma = wb->dmah;
223 wb->urb->transfer_buffer_length = wb->len;
224 wb->urb->dev = acm->dev;
226 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
228 dev_err(&acm->data->dev,
229 "%s - usb_submit_urb(write bulk) failed: %d\n",
231 acm_write_done(acm, wb);
237 * attributes exported through sysfs
239 static ssize_t show_caps
240 (struct device *dev, struct device_attribute *attr, char *buf)
242 struct usb_interface *intf = to_usb_interface(dev);
243 struct acm *acm = usb_get_intfdata(intf);
245 return sprintf(buf, "%d", acm->ctrl_caps);
247 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
249 static ssize_t show_country_codes
250 (struct device *dev, struct device_attribute *attr, char *buf)
252 struct usb_interface *intf = to_usb_interface(dev);
253 struct acm *acm = usb_get_intfdata(intf);
255 memcpy(buf, acm->country_codes, acm->country_code_size);
256 return acm->country_code_size;
259 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
261 static ssize_t show_country_rel_date
262 (struct device *dev, struct device_attribute *attr, char *buf)
264 struct usb_interface *intf = to_usb_interface(dev);
265 struct acm *acm = usb_get_intfdata(intf);
267 return sprintf(buf, "%d", acm->country_rel_date);
270 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
272 * Interrupt handlers for various ACM device responses
275 /* control interface reports status changes with "interrupt" transfers */
276 static void acm_ctrl_irq(struct urb *urb)
278 struct acm *acm = urb->context;
279 struct usb_cdc_notification *dr = urb->transfer_buffer;
284 int status = urb->status;
293 /* this urb is terminated, clean up */
294 dev_dbg(&acm->control->dev,
295 "%s - urb shutting down with status: %d\n",
299 dev_dbg(&acm->control->dev,
300 "%s - nonzero urb status received: %d\n",
305 usb_mark_last_busy(acm->dev);
307 data = (unsigned char *)(dr + 1);
308 switch (dr->bNotificationType) {
309 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
310 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
311 __func__, dr->wValue);
314 case USB_CDC_NOTIFY_SERIAL_STATE:
315 if (le16_to_cpu(dr->wLength) != 2) {
316 dev_dbg(&acm->control->dev,
317 "%s - malformed serial state\n", __func__);
321 newctrl = get_unaligned_le16(data);
323 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
324 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
326 tty_port_tty_hangup(&acm->port, false);
329 difference = acm->ctrlin ^ newctrl;
330 spin_lock(&acm->read_lock);
331 acm->ctrlin = newctrl;
332 acm->oldcount = acm->iocount;
334 if (difference & ACM_CTRL_DSR)
336 if (difference & ACM_CTRL_DCD)
338 if (newctrl & ACM_CTRL_BRK) {
340 tty_insert_flip_char(&acm->port, 0, TTY_BREAK);
342 if (newctrl & ACM_CTRL_RI)
344 if (newctrl & ACM_CTRL_FRAMING)
345 acm->iocount.frame++;
346 if (newctrl & ACM_CTRL_PARITY)
347 acm->iocount.parity++;
348 if (newctrl & ACM_CTRL_OVERRUN)
349 acm->iocount.overrun++;
350 spin_unlock(&acm->read_lock);
353 wake_up_all(&acm->wioctl);
358 dev_dbg(&acm->control->dev,
359 "%s - unknown notification %d received: index %d len %d\n",
361 dr->bNotificationType, dr->wIndex, dr->wLength);
366 retval = usb_submit_urb(urb, GFP_ATOMIC);
367 if (retval && retval != -EPERM)
368 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
372 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
376 if (!test_and_clear_bit(index, &acm->read_urbs_free))
379 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
381 if (res != -EPERM && res != -ENODEV) {
382 dev_err(&acm->data->dev,
383 "urb %d failed submission with %d\n",
386 set_bit(index, &acm->read_urbs_free);
389 dev_vdbg(&acm->data->dev, "submitted urb %d\n", index);
395 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
400 for (i = 0; i < acm->rx_buflimit; ++i) {
401 res = acm_submit_read_urb(acm, i, mem_flags);
409 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
411 if (!urb->actual_length)
414 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
416 tty_flip_buffer_push(&acm->port);
419 static void acm_read_bulk_callback(struct urb *urb)
421 struct acm_rb *rb = urb->context;
422 struct acm *acm = rb->instance;
424 int status = urb->status;
426 dev_vdbg(&acm->data->dev, "got urb %d, len %d, status %d\n",
427 rb->index, urb->actual_length,
431 set_bit(rb->index, &acm->read_urbs_free);
432 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
437 set_bit(rb->index, &acm->read_urbs_free);
438 if ((status != -ENOENT) || (urb->actual_length == 0))
442 usb_mark_last_busy(acm->dev);
444 acm_process_read_urb(acm, urb);
446 * Unthrottle may run on another CPU which needs to see events
447 * in the same order. Submission has an implict barrier
449 smp_mb__before_atomic();
450 set_bit(rb->index, &acm->read_urbs_free);
452 /* throttle device if requested by tty */
453 spin_lock_irqsave(&acm->read_lock, flags);
454 acm->throttled = acm->throttle_req;
455 if (!acm->throttled) {
456 spin_unlock_irqrestore(&acm->read_lock, flags);
457 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
459 spin_unlock_irqrestore(&acm->read_lock, flags);
463 /* data interface wrote those outgoing bytes */
464 static void acm_write_bulk(struct urb *urb)
466 struct acm_wb *wb = urb->context;
467 struct acm *acm = wb->instance;
469 int status = urb->status;
471 if (status || (urb->actual_length != urb->transfer_buffer_length))
472 dev_vdbg(&acm->data->dev, "wrote len %d/%d, status %d\n",
474 urb->transfer_buffer_length,
477 spin_lock_irqsave(&acm->write_lock, flags);
478 acm_write_done(acm, wb);
479 spin_unlock_irqrestore(&acm->write_lock, flags);
480 schedule_work(&acm->work);
483 static void acm_softint(struct work_struct *work)
485 struct acm *acm = container_of(work, struct acm, work);
487 tty_port_tty_wakeup(&acm->port);
494 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
499 acm = acm_get_by_minor(tty->index);
503 retval = tty_standard_install(driver, tty);
505 goto error_init_termios;
508 * Suppress initial echoing for some devices which might send data
509 * immediately after acm driver has been installed.
511 if (acm->quirks & DISABLE_ECHO)
512 tty->termios.c_lflag &= ~ECHO;
514 tty->driver_data = acm;
519 tty_port_put(&acm->port);
523 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
525 struct acm *acm = tty->driver_data;
527 return tty_port_open(&acm->port, tty, filp);
530 static void acm_port_dtr_rts(struct tty_port *port, int raise)
532 struct acm *acm = container_of(port, struct acm, port);
537 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
541 /* FIXME: add missing ctrlout locking throughout driver */
544 res = acm_set_control(acm, val);
545 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
546 /* This is broken in too many devices to spam the logs */
547 dev_dbg(&acm->control->dev, "failed to set dtr/rts\n");
550 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
552 struct acm *acm = container_of(port, struct acm, port);
553 int retval = -ENODEV;
556 mutex_lock(&acm->mutex);
557 if (acm->disconnected)
560 retval = usb_autopm_get_interface(acm->control);
562 goto error_get_interface;
565 * FIXME: Why do we need this? Allocating 64K of physically contiguous
566 * memory is really nasty...
568 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
569 acm->control->needs_remote_wakeup = 1;
571 acm->ctrlurb->dev = acm->dev;
572 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
574 dev_err(&acm->control->dev,
575 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
576 goto error_submit_urb;
579 acm_tty_set_termios(tty, NULL);
582 * Unthrottle device in case the TTY was closed while throttled.
584 spin_lock_irq(&acm->read_lock);
586 acm->throttle_req = 0;
587 spin_unlock_irq(&acm->read_lock);
589 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
591 goto error_submit_read_urbs;
593 usb_autopm_put_interface(acm->control);
595 mutex_unlock(&acm->mutex);
599 error_submit_read_urbs:
600 for (i = 0; i < acm->rx_buflimit; i++)
601 usb_kill_urb(acm->read_urbs[i]);
602 usb_kill_urb(acm->ctrlurb);
604 usb_autopm_put_interface(acm->control);
607 mutex_unlock(&acm->mutex);
609 return usb_translate_errors(retval);
612 static void acm_port_destruct(struct tty_port *port)
614 struct acm *acm = container_of(port, struct acm, port);
616 acm_release_minor(acm);
617 usb_put_intf(acm->control);
618 kfree(acm->country_codes);
622 static void acm_port_shutdown(struct tty_port *port)
624 struct acm *acm = container_of(port, struct acm, port);
630 * Need to grab write_lock to prevent race with resume, but no need to
631 * hold it due to the tty-port initialised flag.
633 spin_lock_irq(&acm->write_lock);
634 spin_unlock_irq(&acm->write_lock);
636 usb_autopm_get_interface_no_resume(acm->control);
637 acm->control->needs_remote_wakeup = 0;
638 usb_autopm_put_interface(acm->control);
641 urb = usb_get_from_anchor(&acm->delayed);
646 usb_autopm_put_interface_async(acm->control);
649 usb_kill_urb(acm->ctrlurb);
650 for (i = 0; i < ACM_NW; i++)
651 usb_kill_urb(acm->wb[i].urb);
652 for (i = 0; i < acm->rx_buflimit; i++)
653 usb_kill_urb(acm->read_urbs[i]);
656 static void acm_tty_cleanup(struct tty_struct *tty)
658 struct acm *acm = tty->driver_data;
660 tty_port_put(&acm->port);
663 static void acm_tty_hangup(struct tty_struct *tty)
665 struct acm *acm = tty->driver_data;
667 tty_port_hangup(&acm->port);
670 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
672 struct acm *acm = tty->driver_data;
674 tty_port_close(&acm->port, tty, filp);
677 static int acm_tty_write(struct tty_struct *tty,
678 const unsigned char *buf, int count)
680 struct acm *acm = tty->driver_data;
689 dev_vdbg(&acm->data->dev, "%d bytes from tty layer\n", count);
691 spin_lock_irqsave(&acm->write_lock, flags);
692 wbn = acm_wb_alloc(acm);
694 spin_unlock_irqrestore(&acm->write_lock, flags);
701 spin_unlock_irqrestore(&acm->write_lock, flags);
705 count = (count > acm->writesize) ? acm->writesize : count;
706 dev_vdbg(&acm->data->dev, "writing %d bytes\n", count);
707 memcpy(wb->buf, buf, count);
710 stat = usb_autopm_get_interface_async(acm->control);
713 spin_unlock_irqrestore(&acm->write_lock, flags);
717 if (acm->susp_count) {
718 usb_anchor_urb(wb->urb, &acm->delayed);
719 spin_unlock_irqrestore(&acm->write_lock, flags);
723 stat = acm_start_wb(acm, wb);
724 spin_unlock_irqrestore(&acm->write_lock, flags);
731 static int acm_tty_write_room(struct tty_struct *tty)
733 struct acm *acm = tty->driver_data;
735 * Do not let the line discipline to know that we have a reserve,
736 * or it might get too enthusiastic.
738 return acm_wb_is_avail(acm) ? acm->writesize : 0;
741 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
743 struct acm *acm = tty->driver_data;
745 * if the device was unplugged then any remaining characters fell out
746 * of the connector ;)
748 if (acm->disconnected)
751 * This is inaccurate (overcounts), but it works.
753 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
756 static void acm_tty_throttle(struct tty_struct *tty)
758 struct acm *acm = tty->driver_data;
760 spin_lock_irq(&acm->read_lock);
761 acm->throttle_req = 1;
762 spin_unlock_irq(&acm->read_lock);
765 static void acm_tty_unthrottle(struct tty_struct *tty)
767 struct acm *acm = tty->driver_data;
768 unsigned int was_throttled;
770 spin_lock_irq(&acm->read_lock);
771 was_throttled = acm->throttled;
773 acm->throttle_req = 0;
774 spin_unlock_irq(&acm->read_lock);
777 acm_submit_read_urbs(acm, GFP_KERNEL);
780 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
782 struct acm *acm = tty->driver_data;
785 retval = acm_send_break(acm, state ? 0xffff : 0);
787 dev_dbg(&acm->control->dev, "%s - send break failed\n",
792 static int acm_tty_tiocmget(struct tty_struct *tty)
794 struct acm *acm = tty->driver_data;
796 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
797 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
798 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
799 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
800 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
804 static int acm_tty_tiocmset(struct tty_struct *tty,
805 unsigned int set, unsigned int clear)
807 struct acm *acm = tty->driver_data;
808 unsigned int newctrl;
810 newctrl = acm->ctrlout;
811 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
812 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
813 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
814 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
816 newctrl = (newctrl & ~clear) | set;
818 if (acm->ctrlout == newctrl)
820 return acm_set_control(acm, acm->ctrlout = newctrl);
823 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
825 struct serial_struct tmp;
830 memset(&tmp, 0, sizeof(tmp));
831 tmp.flags = ASYNC_LOW_LATENCY;
832 tmp.xmit_fifo_size = acm->writesize;
833 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
834 tmp.close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
835 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
836 ASYNC_CLOSING_WAIT_NONE :
837 jiffies_to_msecs(acm->port.closing_wait) / 10;
839 if (copy_to_user(info, &tmp, sizeof(tmp)))
845 static int set_serial_info(struct acm *acm,
846 struct serial_struct __user *newinfo)
848 struct serial_struct new_serial;
849 unsigned int closing_wait, close_delay;
850 unsigned int old_closing_wait, old_close_delay;
853 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
856 close_delay = msecs_to_jiffies(new_serial.close_delay * 10);
857 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
858 ASYNC_CLOSING_WAIT_NONE :
859 msecs_to_jiffies(new_serial.closing_wait * 10);
861 /* we must redo the rounding here, so that the values match */
862 old_close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
863 old_closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
864 ASYNC_CLOSING_WAIT_NONE :
865 jiffies_to_msecs(acm->port.closing_wait) / 10;
867 mutex_lock(&acm->port.mutex);
869 if (!capable(CAP_SYS_ADMIN)) {
870 if ((new_serial.close_delay != old_close_delay) ||
871 (new_serial.closing_wait != old_closing_wait))
874 acm->port.close_delay = close_delay;
875 acm->port.closing_wait = closing_wait;
878 mutex_unlock(&acm->port.mutex);
882 static int wait_serial_change(struct acm *acm, unsigned long arg)
885 DECLARE_WAITQUEUE(wait, current);
886 struct async_icount old, new;
889 spin_lock_irq(&acm->read_lock);
893 spin_unlock_irq(&acm->read_lock);
895 if ((arg & TIOCM_DSR) &&
898 if ((arg & TIOCM_CD) &&
901 if ((arg & TIOCM_RI) &&
905 add_wait_queue(&acm->wioctl, &wait);
906 set_current_state(TASK_INTERRUPTIBLE);
908 remove_wait_queue(&acm->wioctl, &wait);
909 if (acm->disconnected) {
915 if (signal_pending(current))
925 static int get_serial_usage(struct acm *acm,
926 struct serial_icounter_struct __user *count)
928 struct serial_icounter_struct icount;
931 memset(&icount, 0, sizeof(icount));
932 icount.dsr = acm->iocount.dsr;
933 icount.rng = acm->iocount.rng;
934 icount.dcd = acm->iocount.dcd;
935 icount.frame = acm->iocount.frame;
936 icount.overrun = acm->iocount.overrun;
937 icount.parity = acm->iocount.parity;
938 icount.brk = acm->iocount.brk;
940 if (copy_to_user(count, &icount, sizeof(icount)) > 0)
946 static int acm_tty_ioctl(struct tty_struct *tty,
947 unsigned int cmd, unsigned long arg)
949 struct acm *acm = tty->driver_data;
950 int rv = -ENOIOCTLCMD;
953 case TIOCGSERIAL: /* gets serial port data */
954 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
957 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
960 rv = usb_autopm_get_interface(acm->control);
965 rv = wait_serial_change(acm, arg);
966 usb_autopm_put_interface(acm->control);
969 rv = get_serial_usage(acm, (struct serial_icounter_struct __user *) arg);
976 static void acm_tty_set_termios(struct tty_struct *tty,
977 struct ktermios *termios_old)
979 struct acm *acm = tty->driver_data;
980 struct ktermios *termios = &tty->termios;
981 struct usb_cdc_line_coding newline;
982 int newctrl = acm->ctrlout;
984 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
985 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
986 newline.bParityType = termios->c_cflag & PARENB ?
987 (termios->c_cflag & PARODD ? 1 : 2) +
988 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
989 switch (termios->c_cflag & CSIZE) {
991 newline.bDataBits = 5;
994 newline.bDataBits = 6;
997 newline.bDataBits = 7;
1001 newline.bDataBits = 8;
1004 /* FIXME: Needs to clear unsupported bits in the termios */
1005 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1007 if (C_BAUD(tty) == B0) {
1008 newline.dwDTERate = acm->line.dwDTERate;
1009 newctrl &= ~ACM_CTRL_DTR;
1010 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1011 newctrl |= ACM_CTRL_DTR;
1014 if (newctrl != acm->ctrlout)
1015 acm_set_control(acm, acm->ctrlout = newctrl);
1017 if (memcmp(&acm->line, &newline, sizeof newline)) {
1018 memcpy(&acm->line, &newline, sizeof newline);
1019 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1021 le32_to_cpu(newline.dwDTERate),
1022 newline.bCharFormat, newline.bParityType,
1024 acm_set_line(acm, &acm->line);
1028 static const struct tty_port_operations acm_port_ops = {
1029 .dtr_rts = acm_port_dtr_rts,
1030 .shutdown = acm_port_shutdown,
1031 .activate = acm_port_activate,
1032 .destruct = acm_port_destruct,
1036 * USB probe and disconnect routines.
1039 /* Little helpers: write/read buffers free */
1040 static void acm_write_buffers_free(struct acm *acm)
1044 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1046 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1047 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
1050 static void acm_read_buffers_free(struct acm *acm)
1052 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1055 for (i = 0; i < acm->rx_buflimit; i++)
1056 usb_free_coherent(usb_dev, acm->readsize,
1057 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1060 /* Little helper: write buffers allocate */
1061 static int acm_write_buffers_alloc(struct acm *acm)
1066 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1067 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1073 usb_free_coherent(acm->dev, acm->writesize,
1082 static int acm_probe(struct usb_interface *intf,
1083 const struct usb_device_id *id)
1085 struct usb_cdc_union_desc *union_header = NULL;
1086 struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
1087 unsigned char *buffer = intf->altsetting->extra;
1088 int buflen = intf->altsetting->extralen;
1089 struct usb_interface *control_interface;
1090 struct usb_interface *data_interface;
1091 struct usb_endpoint_descriptor *epctrl = NULL;
1092 struct usb_endpoint_descriptor *epread = NULL;
1093 struct usb_endpoint_descriptor *epwrite = NULL;
1094 struct usb_device *usb_dev = interface_to_usbdev(intf);
1095 struct usb_cdc_parsed_header h;
1098 int ctrlsize, readsize;
1100 int call_intf_num = -1;
1101 int data_intf_num = -1;
1102 unsigned long quirks;
1105 int combined_interfaces = 0;
1106 struct device *tty_dev;
1110 quirks = (unsigned long)id->driver_info;
1112 if (quirks == IGNORE_DEVICE)
1115 memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1117 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1119 /* handle quirks deadly to normal probing*/
1120 if (quirks == NO_UNION_NORMAL) {
1121 data_interface = usb_ifnum_to_if(usb_dev, 1);
1122 control_interface = usb_ifnum_to_if(usb_dev, 0);
1123 /* we would crash */
1124 if (!data_interface || !control_interface)
1126 goto skip_normal_probe;
1131 dev_err(&intf->dev, "Weird descriptor references\n");
1135 if (!intf->cur_altsetting)
1139 if (intf->cur_altsetting->endpoint &&
1140 intf->cur_altsetting->endpoint->extralen &&
1141 intf->cur_altsetting->endpoint->extra) {
1143 "Seeking extra descriptors on endpoint\n");
1144 buflen = intf->cur_altsetting->endpoint->extralen;
1145 buffer = intf->cur_altsetting->endpoint->extra;
1148 "Zero length descriptor references\n");
1153 cdc_parse_cdc_header(&h, intf, buffer, buflen);
1154 union_header = h.usb_cdc_union_desc;
1155 cmgmd = h.usb_cdc_call_mgmt_descriptor;
1157 call_intf_num = cmgmd->bDataInterface;
1159 if (!union_header) {
1160 if (call_intf_num > 0) {
1161 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1162 /* quirks for Droids MuIn LCD */
1163 if (quirks & NO_DATA_INTERFACE) {
1164 data_interface = usb_ifnum_to_if(usb_dev, 0);
1166 data_intf_num = call_intf_num;
1167 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1169 control_interface = intf;
1171 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1172 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1175 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1176 combined_interfaces = 1;
1177 control_interface = data_interface = intf;
1178 goto look_for_collapsed_interface;
1184 data_intf_num = union_header->bSlaveInterface0;
1185 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1186 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1188 if (control_interface)
1189 class = control_interface->cur_altsetting->desc.bInterfaceClass;
1191 if (class != USB_CLASS_COMM && class != USB_CLASS_CDC_DATA) {
1192 dev_dbg(&intf->dev, "Broken union descriptor, assuming single interface\n");
1193 combined_interfaces = 1;
1194 control_interface = data_interface = intf;
1195 goto look_for_collapsed_interface;
1199 if (!control_interface || !data_interface) {
1200 dev_dbg(&intf->dev, "no interfaces\n");
1203 if (!data_interface->cur_altsetting || !control_interface->cur_altsetting)
1206 if (data_intf_num != call_intf_num)
1207 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1209 if (control_interface == data_interface) {
1210 /* some broken devices designed for windows work this way */
1211 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1212 combined_interfaces = 1;
1213 /* a popular other OS doesn't use it */
1214 quirks |= NO_CAP_LINE;
1215 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1216 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1219 look_for_collapsed_interface:
1220 for (i = 0; i < 3; i++) {
1221 struct usb_endpoint_descriptor *ep;
1222 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1224 if (usb_endpoint_is_int_in(ep))
1226 else if (usb_endpoint_is_bulk_out(ep))
1228 else if (usb_endpoint_is_bulk_in(ep))
1233 if (!epctrl || !epread || !epwrite)
1236 goto made_compressed_probe;
1241 /*workaround for switched interfaces */
1242 if (data_interface->cur_altsetting->desc.bInterfaceClass
1243 != CDC_DATA_INTERFACE_TYPE) {
1244 if (control_interface->cur_altsetting->desc.bInterfaceClass
1245 == CDC_DATA_INTERFACE_TYPE) {
1247 "Your device has switched interfaces.\n");
1248 swap(control_interface, data_interface);
1254 /* Accept probe requests only for the control interface */
1255 if (!combined_interfaces && intf != control_interface)
1258 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1259 /* valid in this context */
1260 dev_dbg(&intf->dev, "The data interface isn't available\n");
1265 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1266 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1269 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1270 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1271 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1274 /* workaround for switched endpoints */
1275 if (!usb_endpoint_dir_in(epread)) {
1276 /* descriptors are swapped */
1278 "The data interface has switched endpoints\n");
1279 swap(epread, epwrite);
1281 made_compressed_probe:
1282 dev_dbg(&intf->dev, "interfaces are valid\n");
1284 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1288 ctrlsize = usb_endpoint_maxp(epctrl);
1289 readsize = usb_endpoint_maxp(epread) *
1290 (quirks == SINGLE_RX_URB ? 1 : 2);
1291 acm->combined_interfaces = combined_interfaces;
1292 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1293 acm->control = control_interface;
1294 acm->data = data_interface;
1296 usb_get_intf(acm->control); /* undone in destruct() */
1298 minor = acm_alloc_minor(acm);
1304 if (h.usb_cdc_acm_descriptor)
1305 acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
1306 if (quirks & NO_CAP_LINE)
1307 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1308 acm->ctrlsize = ctrlsize;
1309 acm->readsize = readsize;
1310 acm->rx_buflimit = num_rx_buf;
1311 INIT_WORK(&acm->work, acm_softint);
1312 init_waitqueue_head(&acm->wioctl);
1313 spin_lock_init(&acm->write_lock);
1314 spin_lock_init(&acm->read_lock);
1315 mutex_init(&acm->mutex);
1316 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1318 acm->bInterval = epread->bInterval;
1319 tty_port_init(&acm->port);
1320 acm->port.ops = &acm_port_ops;
1321 init_usb_anchor(&acm->delayed);
1322 acm->quirks = quirks;
1324 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1327 acm->ctrl_buffer = buf;
1329 if (acm_write_buffers_alloc(acm) < 0)
1332 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1336 for (i = 0; i < num_rx_buf; i++) {
1337 struct acm_rb *rb = &(acm->read_buffers[i]);
1340 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1347 urb = usb_alloc_urb(0, GFP_KERNEL);
1351 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1352 urb->transfer_dma = rb->dma;
1353 if (acm->is_int_ep) {
1354 usb_fill_int_urb(urb, acm->dev,
1355 usb_rcvintpipe(usb_dev, epread->bEndpointAddress),
1358 acm_read_bulk_callback, rb,
1361 usb_fill_bulk_urb(urb, acm->dev,
1362 usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress),
1365 acm_read_bulk_callback, rb);
1368 acm->read_urbs[i] = urb;
1369 __set_bit(i, &acm->read_urbs_free);
1371 for (i = 0; i < ACM_NW; i++) {
1372 struct acm_wb *snd = &(acm->wb[i]);
1374 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1375 if (snd->urb == NULL)
1378 if (usb_endpoint_xfer_int(epwrite))
1379 usb_fill_int_urb(snd->urb, usb_dev,
1380 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1381 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1383 usb_fill_bulk_urb(snd->urb, usb_dev,
1384 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1385 NULL, acm->writesize, acm_write_bulk, snd);
1386 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1387 if (quirks & SEND_ZERO_PACKET)
1388 snd->urb->transfer_flags |= URB_ZERO_PACKET;
1389 snd->instance = acm;
1392 usb_set_intfdata(intf, acm);
1394 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1398 if (h.usb_cdc_country_functional_desc) { /* export the country data */
1399 struct usb_cdc_country_functional_desc * cfd =
1400 h.usb_cdc_country_functional_desc;
1402 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1403 if (!acm->country_codes)
1404 goto skip_countries;
1405 acm->country_code_size = cfd->bLength - 4;
1406 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1408 acm->country_rel_date = cfd->iCountryCodeRelDate;
1410 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1412 kfree(acm->country_codes);
1413 acm->country_codes = NULL;
1414 acm->country_code_size = 0;
1415 goto skip_countries;
1418 i = device_create_file(&intf->dev,
1419 &dev_attr_iCountryCodeRelDate);
1421 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1422 kfree(acm->country_codes);
1423 acm->country_codes = NULL;
1424 acm->country_code_size = 0;
1425 goto skip_countries;
1430 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1431 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1432 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1433 /* works around buggy devices */
1434 epctrl->bInterval ? epctrl->bInterval : 16);
1435 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1436 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1438 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1440 acm->line.dwDTERate = cpu_to_le32(9600);
1441 acm->line.bDataBits = 8;
1442 acm_set_line(acm, &acm->line);
1444 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1445 usb_set_intfdata(data_interface, acm);
1447 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1448 &control_interface->dev);
1449 if (IS_ERR(tty_dev)) {
1450 rv = PTR_ERR(tty_dev);
1454 if (quirks & CLEAR_HALT_CONDITIONS) {
1455 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress));
1456 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress));
1461 if (!acm->combined_interfaces) {
1462 /* Clear driver data so that disconnect() returns early. */
1463 usb_set_intfdata(data_interface, NULL);
1464 usb_driver_release_interface(&acm_driver, data_interface);
1466 if (acm->country_codes) {
1467 device_remove_file(&acm->control->dev,
1468 &dev_attr_wCountryCodes);
1469 device_remove_file(&acm->control->dev,
1470 &dev_attr_iCountryCodeRelDate);
1471 kfree(acm->country_codes);
1473 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1475 usb_set_intfdata(intf, NULL);
1476 for (i = 0; i < ACM_NW; i++)
1477 usb_free_urb(acm->wb[i].urb);
1479 for (i = 0; i < num_rx_buf; i++)
1480 usb_free_urb(acm->read_urbs[i]);
1481 acm_read_buffers_free(acm);
1482 usb_free_urb(acm->ctrlurb);
1484 acm_write_buffers_free(acm);
1486 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1488 acm_release_minor(acm);
1495 static void stop_data_traffic(struct acm *acm)
1499 usb_kill_urb(acm->ctrlurb);
1500 for (i = 0; i < ACM_NW; i++)
1501 usb_kill_urb(acm->wb[i].urb);
1502 for (i = 0; i < acm->rx_buflimit; i++)
1503 usb_kill_urb(acm->read_urbs[i]);
1505 cancel_work_sync(&acm->work);
1508 static void acm_disconnect(struct usb_interface *intf)
1510 struct acm *acm = usb_get_intfdata(intf);
1511 struct usb_device *usb_dev = interface_to_usbdev(intf);
1512 struct tty_struct *tty;
1515 /* sibling interface is already cleaning up */
1519 mutex_lock(&acm->mutex);
1520 acm->disconnected = true;
1521 if (acm->country_codes) {
1522 device_remove_file(&acm->control->dev,
1523 &dev_attr_wCountryCodes);
1524 device_remove_file(&acm->control->dev,
1525 &dev_attr_iCountryCodeRelDate);
1527 wake_up_all(&acm->wioctl);
1528 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1529 usb_set_intfdata(acm->control, NULL);
1530 usb_set_intfdata(acm->data, NULL);
1531 mutex_unlock(&acm->mutex);
1533 tty = tty_port_tty_get(&acm->port);
1539 stop_data_traffic(acm);
1541 tty_unregister_device(acm_tty_driver, acm->minor);
1543 usb_free_urb(acm->ctrlurb);
1544 for (i = 0; i < ACM_NW; i++)
1545 usb_free_urb(acm->wb[i].urb);
1546 for (i = 0; i < acm->rx_buflimit; i++)
1547 usb_free_urb(acm->read_urbs[i]);
1548 acm_write_buffers_free(acm);
1549 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1550 acm_read_buffers_free(acm);
1552 if (!acm->combined_interfaces)
1553 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1554 acm->data : acm->control);
1556 tty_port_put(&acm->port);
1560 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1562 struct acm *acm = usb_get_intfdata(intf);
1565 spin_lock_irq(&acm->write_lock);
1566 if (PMSG_IS_AUTO(message)) {
1567 if (acm->transmitting) {
1568 spin_unlock_irq(&acm->write_lock);
1572 cnt = acm->susp_count++;
1573 spin_unlock_irq(&acm->write_lock);
1578 stop_data_traffic(acm);
1583 static int acm_resume(struct usb_interface *intf)
1585 struct acm *acm = usb_get_intfdata(intf);
1589 spin_lock_irq(&acm->write_lock);
1591 if (--acm->susp_count)
1594 if (tty_port_initialized(&acm->port)) {
1595 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1598 urb = usb_get_from_anchor(&acm->delayed);
1602 acm_start_wb(acm, urb->context);
1606 * delayed error checking because we must
1607 * do the write path at all cost
1612 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1615 spin_unlock_irq(&acm->write_lock);
1620 static int acm_reset_resume(struct usb_interface *intf)
1622 struct acm *acm = usb_get_intfdata(intf);
1624 if (tty_port_initialized(&acm->port))
1625 tty_port_tty_hangup(&acm->port, false);
1627 return acm_resume(intf);
1630 #endif /* CONFIG_PM */
1632 #define NOKIA_PCSUITE_ACM_INFO(x) \
1633 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1634 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1635 USB_CDC_ACM_PROTO_VENDOR)
1637 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1638 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1639 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1640 USB_CDC_ACM_PROTO_VENDOR)
1643 * USB driver structure.
1646 static const struct usb_device_id acm_ids[] = {
1647 /* quirky and broken devices */
1648 { USB_DEVICE(0x0424, 0x274e), /* Microchip Technology, Inc. (formerly SMSC) */
1649 .driver_info = DISABLE_ECHO, }, /* DISABLE ECHO in termios flag */
1650 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1651 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1652 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1653 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1654 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1655 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1657 { USB_DEVICE(0x045b, 0x023c), /* Renesas USB Download mode */
1658 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1660 { USB_DEVICE(0x045b, 0x0248), /* Renesas USB Download mode */
1661 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1663 { USB_DEVICE(0x045b, 0x024D), /* Renesas USB Download mode */
1664 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1666 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1667 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1669 { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1670 .driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1672 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1673 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1675 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1676 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1678 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1679 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1681 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1682 .driver_info = SINGLE_RX_URB,
1684 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1685 .driver_info = SINGLE_RX_URB, /* firmware bug */
1687 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1688 .driver_info = SINGLE_RX_URB, /* firmware bug */
1690 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1691 .driver_info = SINGLE_RX_URB,
1693 { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1694 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1696 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1697 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1699 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1700 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1702 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1703 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1705 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1706 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1708 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1709 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1711 { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1712 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1714 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1715 .driver_info = QUIRK_CONTROL_LINE_STATE, },
1716 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1717 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1718 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1720 /* Motorola H24 HSPA module: */
1721 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1722 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1723 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1725 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1726 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1728 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1729 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1731 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1732 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1734 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1735 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1737 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1738 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1740 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1741 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1744 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1745 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1746 data interface instead of
1747 communications interface.
1748 Maybe we should define a new
1751 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1752 .driver_info = NO_UNION_NORMAL,
1754 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1755 .driver_info = NO_UNION_NORMAL,
1757 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1758 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1760 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1761 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1763 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1764 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1766 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1767 .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1769 { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1770 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1773 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1774 .driver_info = CLEAR_HALT_CONDITIONS,
1777 /* Nokia S60 phones expose two ACM channels. The first is
1778 * a modem and is picked up by the standard AT-command
1779 * information below. The second is 'vendor-specific' but
1780 * is treated as a serial device at the S60 end, so we want
1781 * to expose it on Linux too. */
1782 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1783 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1784 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1785 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1786 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1787 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1788 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1789 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1790 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1791 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1792 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1793 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1794 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1795 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1796 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1797 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1798 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1799 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1800 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1801 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1802 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1803 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1804 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1805 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1806 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1807 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1808 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1809 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1810 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1811 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1812 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1813 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1814 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1815 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1816 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1817 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1818 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1819 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1820 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1821 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1822 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1823 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1824 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1825 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1826 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1827 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1828 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1829 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1830 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1831 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1832 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1833 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1834 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1835 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1836 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1837 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1838 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1839 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1841 /* Support for Owen devices */
1842 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1844 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1846 /* Support for Droids MuIn LCD */
1847 { USB_DEVICE(0x04d8, 0x000b),
1848 .driver_info = NO_DATA_INTERFACE,
1851 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1852 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1853 .driver_info = IGNORE_DEVICE,
1855 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1856 .driver_info = IGNORE_DEVICE,
1859 { USB_DEVICE(0x04d8, 0xf58b),
1860 .driver_info = IGNORE_DEVICE,
1864 /*Samsung phone in firmware update mode */
1865 { USB_DEVICE(0x04e8, 0x685d),
1866 .driver_info = IGNORE_DEVICE,
1869 /* Exclude Infineon Flash Loader utility */
1870 { USB_DEVICE(0x058b, 0x0041),
1871 .driver_info = IGNORE_DEVICE,
1874 /* Exclude ETAS ES58x */
1875 { USB_DEVICE(0x108c, 0x0159), /* ES581.4 */
1876 .driver_info = IGNORE_DEVICE,
1878 { USB_DEVICE(0x108c, 0x0168), /* ES582.1 */
1879 .driver_info = IGNORE_DEVICE,
1881 { USB_DEVICE(0x108c, 0x0169), /* ES584.1 */
1882 .driver_info = IGNORE_DEVICE,
1885 { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1886 .driver_info = SEND_ZERO_PACKET,
1888 { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1889 .driver_info = SEND_ZERO_PACKET,
1892 /* Exclude Goodix Fingerprint Reader */
1893 { USB_DEVICE(0x27c6, 0x5395),
1894 .driver_info = IGNORE_DEVICE,
1897 /* Exclude Heimann Sensor GmbH USB appset demo */
1898 { USB_DEVICE(0x32a7, 0x0000),
1899 .driver_info = IGNORE_DEVICE,
1902 /* control interfaces without any protocol set */
1903 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1904 USB_CDC_PROTO_NONE) },
1906 /* control interfaces with various AT-command sets */
1907 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1908 USB_CDC_ACM_PROTO_AT_V25TER) },
1909 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1910 USB_CDC_ACM_PROTO_AT_PCCA101) },
1911 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1912 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1913 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1914 USB_CDC_ACM_PROTO_AT_GSM) },
1915 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1916 USB_CDC_ACM_PROTO_AT_3G) },
1917 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1918 USB_CDC_ACM_PROTO_AT_CDMA) },
1920 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1921 .driver_info = SEND_ZERO_PACKET,
1927 MODULE_DEVICE_TABLE(usb, acm_ids);
1929 static struct usb_driver acm_driver = {
1932 .disconnect = acm_disconnect,
1934 .suspend = acm_suspend,
1935 .resume = acm_resume,
1936 .reset_resume = acm_reset_resume,
1938 .id_table = acm_ids,
1940 .supports_autosuspend = 1,
1942 .disable_hub_initiated_lpm = 1,
1946 * TTY driver structures.
1949 static const struct tty_operations acm_ops = {
1950 .install = acm_tty_install,
1951 .open = acm_tty_open,
1952 .close = acm_tty_close,
1953 .cleanup = acm_tty_cleanup,
1954 .hangup = acm_tty_hangup,
1955 .write = acm_tty_write,
1956 .write_room = acm_tty_write_room,
1957 .ioctl = acm_tty_ioctl,
1958 .throttle = acm_tty_throttle,
1959 .unthrottle = acm_tty_unthrottle,
1960 .chars_in_buffer = acm_tty_chars_in_buffer,
1961 .break_ctl = acm_tty_break_ctl,
1962 .set_termios = acm_tty_set_termios,
1963 .tiocmget = acm_tty_tiocmget,
1964 .tiocmset = acm_tty_tiocmset,
1971 static int __init acm_init(void)
1974 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1975 if (!acm_tty_driver)
1977 acm_tty_driver->driver_name = "acm",
1978 acm_tty_driver->name = "ttyACM",
1979 acm_tty_driver->major = ACM_TTY_MAJOR,
1980 acm_tty_driver->minor_start = 0,
1981 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1982 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1983 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1984 acm_tty_driver->init_termios = tty_std_termios;
1985 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1987 tty_set_operations(acm_tty_driver, &acm_ops);
1989 retval = tty_register_driver(acm_tty_driver);
1991 put_tty_driver(acm_tty_driver);
1995 retval = usb_register(&acm_driver);
1997 tty_unregister_driver(acm_tty_driver);
1998 put_tty_driver(acm_tty_driver);
2002 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2007 static void __exit acm_exit(void)
2009 usb_deregister(&acm_driver);
2010 tty_unregister_driver(acm_tty_driver);
2011 put_tty_driver(acm_tty_driver);
2012 idr_destroy(&acm_minors);
2015 module_init(acm_init);
2016 module_exit(acm_exit);
2018 MODULE_AUTHOR(DRIVER_AUTHOR);
2019 MODULE_DESCRIPTION(DRIVER_DESC);
2020 MODULE_LICENSE("GPL");
2021 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);