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)
179 wbn = (wbn + 1) % ACM_NW;
185 static int acm_wb_is_avail(struct acm *acm)
191 spin_lock_irqsave(&acm->write_lock, flags);
192 for (i = 0; i < ACM_NW; i++)
194 spin_unlock_irqrestore(&acm->write_lock, flags);
199 * Finish write. Caller must hold acm->write_lock
201 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
205 usb_autopm_put_interface_async(acm->control);
211 * the caller is responsible for locking
214 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
220 wb->urb->transfer_buffer = wb->buf;
221 wb->urb->transfer_dma = wb->dmah;
222 wb->urb->transfer_buffer_length = wb->len;
223 wb->urb->dev = acm->dev;
225 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
227 dev_err(&acm->data->dev,
228 "%s - usb_submit_urb(write bulk) failed: %d\n",
230 acm_write_done(acm, wb);
236 * attributes exported through sysfs
238 static ssize_t show_caps
239 (struct device *dev, struct device_attribute *attr, char *buf)
241 struct usb_interface *intf = to_usb_interface(dev);
242 struct acm *acm = usb_get_intfdata(intf);
244 return sprintf(buf, "%d", acm->ctrl_caps);
246 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
248 static ssize_t show_country_codes
249 (struct device *dev, struct device_attribute *attr, char *buf)
251 struct usb_interface *intf = to_usb_interface(dev);
252 struct acm *acm = usb_get_intfdata(intf);
254 memcpy(buf, acm->country_codes, acm->country_code_size);
255 return acm->country_code_size;
258 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
260 static ssize_t show_country_rel_date
261 (struct device *dev, struct device_attribute *attr, char *buf)
263 struct usb_interface *intf = to_usb_interface(dev);
264 struct acm *acm = usb_get_intfdata(intf);
266 return sprintf(buf, "%d", acm->country_rel_date);
269 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
271 * Interrupt handlers for various ACM device responses
274 /* control interface reports status changes with "interrupt" transfers */
275 static void acm_ctrl_irq(struct urb *urb)
277 struct acm *acm = urb->context;
278 struct usb_cdc_notification *dr = urb->transfer_buffer;
283 int status = urb->status;
292 /* this urb is terminated, clean up */
293 dev_dbg(&acm->control->dev,
294 "%s - urb shutting down with status: %d\n",
298 dev_dbg(&acm->control->dev,
299 "%s - nonzero urb status received: %d\n",
304 usb_mark_last_busy(acm->dev);
306 data = (unsigned char *)(dr + 1);
307 switch (dr->bNotificationType) {
308 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
309 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
310 __func__, dr->wValue);
313 case USB_CDC_NOTIFY_SERIAL_STATE:
314 if (le16_to_cpu(dr->wLength) != 2) {
315 dev_dbg(&acm->control->dev,
316 "%s - malformed serial state\n", __func__);
320 newctrl = get_unaligned_le16(data);
322 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
323 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
325 tty_port_tty_hangup(&acm->port, false);
328 difference = acm->ctrlin ^ newctrl;
329 spin_lock(&acm->read_lock);
330 acm->ctrlin = newctrl;
331 acm->oldcount = acm->iocount;
333 if (difference & ACM_CTRL_DSR)
335 if (difference & ACM_CTRL_DCD)
337 if (newctrl & ACM_CTRL_BRK) {
339 tty_insert_flip_char(&acm->port, 0, TTY_BREAK);
341 if (newctrl & ACM_CTRL_RI)
343 if (newctrl & ACM_CTRL_FRAMING)
344 acm->iocount.frame++;
345 if (newctrl & ACM_CTRL_PARITY)
346 acm->iocount.parity++;
347 if (newctrl & ACM_CTRL_OVERRUN)
348 acm->iocount.overrun++;
349 spin_unlock(&acm->read_lock);
352 wake_up_all(&acm->wioctl);
357 dev_dbg(&acm->control->dev,
358 "%s - unknown notification %d received: index %d len %d\n",
360 dr->bNotificationType, dr->wIndex, dr->wLength);
365 retval = usb_submit_urb(urb, GFP_ATOMIC);
366 if (retval && retval != -EPERM)
367 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
371 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
375 if (!test_and_clear_bit(index, &acm->read_urbs_free))
378 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
380 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
382 if (res != -EPERM && res != -ENODEV) {
383 dev_err(&acm->data->dev,
384 "%s - usb_submit_urb failed: %d\n",
387 set_bit(index, &acm->read_urbs_free);
394 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
399 for (i = 0; i < acm->rx_buflimit; ++i) {
400 res = acm_submit_read_urb(acm, i, mem_flags);
408 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
410 if (!urb->actual_length)
413 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
415 tty_flip_buffer_push(&acm->port);
418 static void acm_read_bulk_callback(struct urb *urb)
420 struct acm_rb *rb = urb->context;
421 struct acm *acm = rb->instance;
423 int status = urb->status;
425 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
426 rb->index, urb->actual_length);
429 set_bit(rb->index, &acm->read_urbs_free);
430 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
435 set_bit(rb->index, &acm->read_urbs_free);
436 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
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, "%s - len %d/%d, status %d\n",
475 urb->transfer_buffer_length,
478 spin_lock_irqsave(&acm->write_lock, flags);
479 acm_write_done(acm, wb);
480 spin_unlock_irqrestore(&acm->write_lock, flags);
481 schedule_work(&acm->work);
484 static void acm_softint(struct work_struct *work)
486 struct acm *acm = container_of(work, struct acm, work);
488 dev_vdbg(&acm->data->dev, "%s\n", __func__);
490 tty_port_tty_wakeup(&acm->port);
497 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
502 dev_dbg(tty->dev, "%s\n", __func__);
504 acm = acm_get_by_minor(tty->index);
508 retval = tty_standard_install(driver, tty);
510 goto error_init_termios;
513 * Suppress initial echoing for some devices which might send data
514 * immediately after acm driver has been installed.
516 if (acm->quirks & DISABLE_ECHO)
517 tty->termios.c_lflag &= ~ECHO;
519 tty->driver_data = acm;
524 tty_port_put(&acm->port);
528 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
530 struct acm *acm = tty->driver_data;
532 dev_dbg(tty->dev, "%s\n", __func__);
534 return tty_port_open(&acm->port, tty, filp);
537 static void acm_port_dtr_rts(struct tty_port *port, int raise)
539 struct acm *acm = container_of(port, struct acm, port);
544 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
548 /* FIXME: add missing ctrlout locking throughout driver */
551 res = acm_set_control(acm, val);
552 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
553 /* This is broken in too many devices to spam the logs */
554 dev_dbg(&acm->control->dev, "failed to set dtr/rts\n");
557 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
559 struct acm *acm = container_of(port, struct acm, port);
560 int retval = -ENODEV;
563 dev_dbg(&acm->control->dev, "%s\n", __func__);
565 mutex_lock(&acm->mutex);
566 if (acm->disconnected)
569 retval = usb_autopm_get_interface(acm->control);
571 goto error_get_interface;
574 * FIXME: Why do we need this? Allocating 64K of physically contiguous
575 * memory is really nasty...
577 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
578 acm->control->needs_remote_wakeup = 1;
580 acm->ctrlurb->dev = acm->dev;
581 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
583 dev_err(&acm->control->dev,
584 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
585 goto error_submit_urb;
588 acm_tty_set_termios(tty, NULL);
591 * Unthrottle device in case the TTY was closed while throttled.
593 spin_lock_irq(&acm->read_lock);
595 acm->throttle_req = 0;
596 spin_unlock_irq(&acm->read_lock);
598 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
600 goto error_submit_read_urbs;
602 usb_autopm_put_interface(acm->control);
604 mutex_unlock(&acm->mutex);
608 error_submit_read_urbs:
609 for (i = 0; i < acm->rx_buflimit; i++)
610 usb_kill_urb(acm->read_urbs[i]);
611 usb_kill_urb(acm->ctrlurb);
613 usb_autopm_put_interface(acm->control);
616 mutex_unlock(&acm->mutex);
618 return usb_translate_errors(retval);
621 static void acm_port_destruct(struct tty_port *port)
623 struct acm *acm = container_of(port, struct acm, port);
625 dev_dbg(&acm->control->dev, "%s\n", __func__);
627 acm_release_minor(acm);
628 usb_put_intf(acm->control);
629 kfree(acm->country_codes);
633 static void acm_port_shutdown(struct tty_port *port)
635 struct acm *acm = container_of(port, struct acm, port);
640 dev_dbg(&acm->control->dev, "%s\n", __func__);
643 * Need to grab write_lock to prevent race with resume, but no need to
644 * hold it due to the tty-port initialised flag.
646 spin_lock_irq(&acm->write_lock);
647 spin_unlock_irq(&acm->write_lock);
649 usb_autopm_get_interface_no_resume(acm->control);
650 acm->control->needs_remote_wakeup = 0;
651 usb_autopm_put_interface(acm->control);
654 urb = usb_get_from_anchor(&acm->delayed);
659 usb_autopm_put_interface_async(acm->control);
662 usb_kill_urb(acm->ctrlurb);
663 for (i = 0; i < ACM_NW; i++)
664 usb_kill_urb(acm->wb[i].urb);
665 for (i = 0; i < acm->rx_buflimit; i++)
666 usb_kill_urb(acm->read_urbs[i]);
669 static void acm_tty_cleanup(struct tty_struct *tty)
671 struct acm *acm = tty->driver_data;
672 dev_dbg(&acm->control->dev, "%s\n", __func__);
673 tty_port_put(&acm->port);
676 static void acm_tty_hangup(struct tty_struct *tty)
678 struct acm *acm = tty->driver_data;
679 dev_dbg(&acm->control->dev, "%s\n", __func__);
680 tty_port_hangup(&acm->port);
683 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
685 struct acm *acm = tty->driver_data;
686 dev_dbg(&acm->control->dev, "%s\n", __func__);
687 tty_port_close(&acm->port, tty, filp);
690 static int acm_tty_write(struct tty_struct *tty,
691 const unsigned char *buf, int count)
693 struct acm *acm = tty->driver_data;
702 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
704 spin_lock_irqsave(&acm->write_lock, flags);
705 wbn = acm_wb_alloc(acm);
707 spin_unlock_irqrestore(&acm->write_lock, flags);
714 spin_unlock_irqrestore(&acm->write_lock, flags);
718 count = (count > acm->writesize) ? acm->writesize : count;
719 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
720 memcpy(wb->buf, buf, count);
723 stat = usb_autopm_get_interface_async(acm->control);
726 spin_unlock_irqrestore(&acm->write_lock, flags);
730 if (acm->susp_count) {
731 usb_anchor_urb(wb->urb, &acm->delayed);
732 spin_unlock_irqrestore(&acm->write_lock, flags);
736 stat = acm_start_wb(acm, wb);
737 spin_unlock_irqrestore(&acm->write_lock, flags);
744 static int acm_tty_write_room(struct tty_struct *tty)
746 struct acm *acm = tty->driver_data;
748 * Do not let the line discipline to know that we have a reserve,
749 * or it might get too enthusiastic.
751 return acm_wb_is_avail(acm) ? acm->writesize : 0;
754 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
756 struct acm *acm = tty->driver_data;
758 * if the device was unplugged then any remaining characters fell out
759 * of the connector ;)
761 if (acm->disconnected)
764 * This is inaccurate (overcounts), but it works.
766 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
769 static void acm_tty_throttle(struct tty_struct *tty)
771 struct acm *acm = tty->driver_data;
773 spin_lock_irq(&acm->read_lock);
774 acm->throttle_req = 1;
775 spin_unlock_irq(&acm->read_lock);
778 static void acm_tty_unthrottle(struct tty_struct *tty)
780 struct acm *acm = tty->driver_data;
781 unsigned int was_throttled;
783 spin_lock_irq(&acm->read_lock);
784 was_throttled = acm->throttled;
786 acm->throttle_req = 0;
787 spin_unlock_irq(&acm->read_lock);
790 acm_submit_read_urbs(acm, GFP_KERNEL);
793 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
795 struct acm *acm = tty->driver_data;
798 retval = acm_send_break(acm, state ? 0xffff : 0);
800 dev_dbg(&acm->control->dev, "%s - send break failed\n",
805 static int acm_tty_tiocmget(struct tty_struct *tty)
807 struct acm *acm = tty->driver_data;
809 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
810 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
811 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
812 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
813 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
817 static int acm_tty_tiocmset(struct tty_struct *tty,
818 unsigned int set, unsigned int clear)
820 struct acm *acm = tty->driver_data;
821 unsigned int newctrl;
823 newctrl = acm->ctrlout;
824 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
825 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
826 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
827 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
829 newctrl = (newctrl & ~clear) | set;
831 if (acm->ctrlout == newctrl)
833 return acm_set_control(acm, acm->ctrlout = newctrl);
836 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
838 struct serial_struct tmp;
843 memset(&tmp, 0, sizeof(tmp));
844 tmp.flags = ASYNC_LOW_LATENCY;
845 tmp.xmit_fifo_size = acm->writesize;
846 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
847 tmp.close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
848 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
849 ASYNC_CLOSING_WAIT_NONE :
850 jiffies_to_msecs(acm->port.closing_wait) / 10;
852 if (copy_to_user(info, &tmp, sizeof(tmp)))
858 static int set_serial_info(struct acm *acm,
859 struct serial_struct __user *newinfo)
861 struct serial_struct new_serial;
862 unsigned int closing_wait, close_delay;
863 unsigned int old_closing_wait, old_close_delay;
866 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
869 close_delay = msecs_to_jiffies(new_serial.close_delay * 10);
870 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
871 ASYNC_CLOSING_WAIT_NONE :
872 msecs_to_jiffies(new_serial.closing_wait * 10);
874 /* we must redo the rounding here, so that the values match */
875 old_close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
876 old_closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
877 ASYNC_CLOSING_WAIT_NONE :
878 jiffies_to_msecs(acm->port.closing_wait) / 10;
880 mutex_lock(&acm->port.mutex);
882 if (!capable(CAP_SYS_ADMIN)) {
883 if ((new_serial.close_delay != old_close_delay) ||
884 (new_serial.closing_wait != old_closing_wait))
887 acm->port.close_delay = close_delay;
888 acm->port.closing_wait = closing_wait;
891 mutex_unlock(&acm->port.mutex);
895 static int wait_serial_change(struct acm *acm, unsigned long arg)
898 DECLARE_WAITQUEUE(wait, current);
899 struct async_icount old, new;
902 spin_lock_irq(&acm->read_lock);
906 spin_unlock_irq(&acm->read_lock);
908 if ((arg & TIOCM_DSR) &&
911 if ((arg & TIOCM_CD) &&
914 if ((arg & TIOCM_RI) &&
918 add_wait_queue(&acm->wioctl, &wait);
919 set_current_state(TASK_INTERRUPTIBLE);
921 remove_wait_queue(&acm->wioctl, &wait);
922 if (acm->disconnected) {
928 if (signal_pending(current))
938 static int get_serial_usage(struct acm *acm,
939 struct serial_icounter_struct __user *count)
941 struct serial_icounter_struct icount;
944 memset(&icount, 0, sizeof(icount));
945 icount.dsr = acm->iocount.dsr;
946 icount.rng = acm->iocount.rng;
947 icount.dcd = acm->iocount.dcd;
948 icount.frame = acm->iocount.frame;
949 icount.overrun = acm->iocount.overrun;
950 icount.parity = acm->iocount.parity;
951 icount.brk = acm->iocount.brk;
953 if (copy_to_user(count, &icount, sizeof(icount)) > 0)
959 static int acm_tty_ioctl(struct tty_struct *tty,
960 unsigned int cmd, unsigned long arg)
962 struct acm *acm = tty->driver_data;
963 int rv = -ENOIOCTLCMD;
966 case TIOCGSERIAL: /* gets serial port data */
967 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
970 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
973 rv = usb_autopm_get_interface(acm->control);
978 rv = wait_serial_change(acm, arg);
979 usb_autopm_put_interface(acm->control);
982 rv = get_serial_usage(acm, (struct serial_icounter_struct __user *) arg);
989 static void acm_tty_set_termios(struct tty_struct *tty,
990 struct ktermios *termios_old)
992 struct acm *acm = tty->driver_data;
993 struct ktermios *termios = &tty->termios;
994 struct usb_cdc_line_coding newline;
995 int newctrl = acm->ctrlout;
997 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
998 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
999 newline.bParityType = termios->c_cflag & PARENB ?
1000 (termios->c_cflag & PARODD ? 1 : 2) +
1001 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1002 switch (termios->c_cflag & CSIZE) {
1004 newline.bDataBits = 5;
1007 newline.bDataBits = 6;
1010 newline.bDataBits = 7;
1014 newline.bDataBits = 8;
1017 /* FIXME: Needs to clear unsupported bits in the termios */
1018 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1020 if (C_BAUD(tty) == B0) {
1021 newline.dwDTERate = acm->line.dwDTERate;
1022 newctrl &= ~ACM_CTRL_DTR;
1023 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1024 newctrl |= ACM_CTRL_DTR;
1027 if (newctrl != acm->ctrlout)
1028 acm_set_control(acm, acm->ctrlout = newctrl);
1030 if (memcmp(&acm->line, &newline, sizeof newline)) {
1031 memcpy(&acm->line, &newline, sizeof newline);
1032 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1034 le32_to_cpu(newline.dwDTERate),
1035 newline.bCharFormat, newline.bParityType,
1037 acm_set_line(acm, &acm->line);
1041 static const struct tty_port_operations acm_port_ops = {
1042 .dtr_rts = acm_port_dtr_rts,
1043 .shutdown = acm_port_shutdown,
1044 .activate = acm_port_activate,
1045 .destruct = acm_port_destruct,
1049 * USB probe and disconnect routines.
1052 /* Little helpers: write/read buffers free */
1053 static void acm_write_buffers_free(struct acm *acm)
1057 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1059 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1060 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
1063 static void acm_read_buffers_free(struct acm *acm)
1065 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1068 for (i = 0; i < acm->rx_buflimit; i++)
1069 usb_free_coherent(usb_dev, acm->readsize,
1070 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1073 /* Little helper: write buffers allocate */
1074 static int acm_write_buffers_alloc(struct acm *acm)
1079 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1080 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1086 usb_free_coherent(acm->dev, acm->writesize,
1095 static int acm_probe(struct usb_interface *intf,
1096 const struct usb_device_id *id)
1098 struct usb_cdc_union_desc *union_header = NULL;
1099 struct usb_cdc_country_functional_desc *cfd = NULL;
1100 unsigned char *buffer = intf->altsetting->extra;
1101 int buflen = intf->altsetting->extralen;
1102 struct usb_interface *control_interface;
1103 struct usb_interface *data_interface;
1104 struct usb_endpoint_descriptor *epctrl = NULL;
1105 struct usb_endpoint_descriptor *epread = NULL;
1106 struct usb_endpoint_descriptor *epwrite = NULL;
1107 struct usb_device *usb_dev = interface_to_usbdev(intf);
1110 int ctrlsize, readsize;
1112 u8 ac_management_function = 0;
1113 u8 call_management_function = 0;
1114 int call_interface_num = -1;
1115 int data_interface_num = -1;
1116 unsigned long quirks;
1119 unsigned int elength = 0;
1120 int combined_interfaces = 0;
1121 struct device *tty_dev;
1125 quirks = (unsigned long)id->driver_info;
1127 if (quirks == IGNORE_DEVICE)
1130 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1132 /* handle quirks deadly to normal probing*/
1133 if (quirks == NO_UNION_NORMAL) {
1134 data_interface = usb_ifnum_to_if(usb_dev, 1);
1135 control_interface = usb_ifnum_to_if(usb_dev, 0);
1136 /* we would crash */
1137 if (!data_interface || !control_interface)
1139 goto skip_normal_probe;
1144 dev_err(&intf->dev, "Weird descriptor references\n");
1149 if (intf->cur_altsetting->endpoint &&
1150 intf->cur_altsetting->endpoint->extralen &&
1151 intf->cur_altsetting->endpoint->extra) {
1153 "Seeking extra descriptors on endpoint\n");
1154 buflen = intf->cur_altsetting->endpoint->extralen;
1155 buffer = intf->cur_altsetting->endpoint->extra;
1158 "Zero length descriptor references\n");
1163 while (buflen > 0) {
1164 elength = buffer[0];
1166 dev_err(&intf->dev, "skipping garbage byte\n");
1170 if (buffer[1] != USB_DT_CS_INTERFACE) {
1171 dev_err(&intf->dev, "skipping garbage\n");
1175 switch (buffer[2]) {
1176 case USB_CDC_UNION_TYPE: /* we've found it */
1177 if (elength < sizeof(struct usb_cdc_union_desc))
1180 dev_err(&intf->dev, "More than one "
1181 "union descriptor, skipping ...\n");
1184 union_header = (struct usb_cdc_union_desc *)buffer;
1186 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1187 if (elength < sizeof(struct usb_cdc_country_functional_desc))
1189 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1191 case USB_CDC_HEADER_TYPE: /* maybe check version */
1192 break; /* for now we ignore it */
1193 case USB_CDC_ACM_TYPE:
1196 ac_management_function = buffer[3];
1198 case USB_CDC_CALL_MANAGEMENT_TYPE:
1201 call_management_function = buffer[3];
1202 call_interface_num = buffer[4];
1206 * there are LOTS more CDC descriptors that
1207 * could legitimately be found here.
1209 dev_dbg(&intf->dev, "Ignoring descriptor: "
1210 "type %02x, length %ud\n",
1211 buffer[2], elength);
1219 if (!union_header) {
1220 if (call_interface_num > 0) {
1221 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1222 /* quirks for Droids MuIn LCD */
1223 if (quirks & NO_DATA_INTERFACE)
1224 data_interface = usb_ifnum_to_if(usb_dev, 0);
1226 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1227 control_interface = intf;
1229 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1230 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1233 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1234 combined_interfaces = 1;
1235 control_interface = data_interface = intf;
1236 goto look_for_collapsed_interface;
1240 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1241 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1244 if (!control_interface || !data_interface) {
1245 dev_dbg(&intf->dev, "no interfaces\n");
1249 if (data_interface_num != call_interface_num)
1250 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1252 if (control_interface == data_interface) {
1253 /* some broken devices designed for windows work this way */
1254 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1255 combined_interfaces = 1;
1256 /* a popular other OS doesn't use it */
1257 quirks |= NO_CAP_LINE;
1258 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1259 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1262 look_for_collapsed_interface:
1263 for (i = 0; i < 3; i++) {
1264 struct usb_endpoint_descriptor *ep;
1265 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1267 if (usb_endpoint_is_int_in(ep))
1269 else if (usb_endpoint_is_bulk_out(ep))
1271 else if (usb_endpoint_is_bulk_in(ep))
1276 if (!epctrl || !epread || !epwrite)
1279 goto made_compressed_probe;
1284 /*workaround for switched interfaces */
1285 if (data_interface->cur_altsetting->desc.bInterfaceClass
1286 != CDC_DATA_INTERFACE_TYPE) {
1287 if (control_interface->cur_altsetting->desc.bInterfaceClass
1288 == CDC_DATA_INTERFACE_TYPE) {
1290 "Your device has switched interfaces.\n");
1291 swap(control_interface, data_interface);
1297 /* Accept probe requests only for the control interface */
1298 if (!combined_interfaces && intf != control_interface)
1301 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1302 /* valid in this context */
1303 dev_dbg(&intf->dev, "The data interface isn't available\n");
1308 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1309 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1312 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1313 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1314 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1317 /* workaround for switched endpoints */
1318 if (!usb_endpoint_dir_in(epread)) {
1319 /* descriptors are swapped */
1321 "The data interface has switched endpoints\n");
1322 swap(epread, epwrite);
1324 made_compressed_probe:
1325 dev_dbg(&intf->dev, "interfaces are valid\n");
1327 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1331 ctrlsize = usb_endpoint_maxp(epctrl);
1332 readsize = usb_endpoint_maxp(epread) *
1333 (quirks == SINGLE_RX_URB ? 1 : 2);
1334 acm->combined_interfaces = combined_interfaces;
1335 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1336 acm->control = control_interface;
1337 acm->data = data_interface;
1339 usb_get_intf(acm->control); /* undone in destruct() */
1341 minor = acm_alloc_minor(acm);
1343 dev_err(&intf->dev, "no more free acm devices\n");
1350 acm->ctrl_caps = ac_management_function;
1351 if (quirks & NO_CAP_LINE)
1352 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1353 acm->ctrlsize = ctrlsize;
1354 acm->readsize = readsize;
1355 acm->rx_buflimit = num_rx_buf;
1356 INIT_WORK(&acm->work, acm_softint);
1357 init_waitqueue_head(&acm->wioctl);
1358 spin_lock_init(&acm->write_lock);
1359 spin_lock_init(&acm->read_lock);
1360 mutex_init(&acm->mutex);
1361 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1363 acm->bInterval = epread->bInterval;
1364 tty_port_init(&acm->port);
1365 acm->port.ops = &acm_port_ops;
1366 init_usb_anchor(&acm->delayed);
1367 acm->quirks = quirks;
1369 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1372 acm->ctrl_buffer = buf;
1374 if (acm_write_buffers_alloc(acm) < 0)
1377 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1381 for (i = 0; i < num_rx_buf; i++) {
1382 struct acm_rb *rb = &(acm->read_buffers[i]);
1385 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1392 urb = usb_alloc_urb(0, GFP_KERNEL);
1396 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1397 urb->transfer_dma = rb->dma;
1398 if (acm->is_int_ep) {
1399 usb_fill_int_urb(urb, acm->dev,
1400 usb_rcvintpipe(usb_dev, epread->bEndpointAddress),
1403 acm_read_bulk_callback, rb,
1406 usb_fill_bulk_urb(urb, acm->dev,
1407 usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress),
1410 acm_read_bulk_callback, rb);
1413 acm->read_urbs[i] = urb;
1414 __set_bit(i, &acm->read_urbs_free);
1416 for (i = 0; i < ACM_NW; i++) {
1417 struct acm_wb *snd = &(acm->wb[i]);
1419 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1420 if (snd->urb == NULL)
1423 if (usb_endpoint_xfer_int(epwrite))
1424 usb_fill_int_urb(snd->urb, usb_dev,
1425 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1426 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1428 usb_fill_bulk_urb(snd->urb, usb_dev,
1429 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1430 NULL, acm->writesize, acm_write_bulk, snd);
1431 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1432 if (quirks & SEND_ZERO_PACKET)
1433 snd->urb->transfer_flags |= URB_ZERO_PACKET;
1434 snd->instance = acm;
1437 usb_set_intfdata(intf, acm);
1439 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1443 if (cfd) { /* export the country data */
1444 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1445 if (!acm->country_codes)
1446 goto skip_countries;
1447 acm->country_code_size = cfd->bLength - 4;
1448 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1450 acm->country_rel_date = cfd->iCountryCodeRelDate;
1452 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1454 kfree(acm->country_codes);
1455 acm->country_codes = NULL;
1456 acm->country_code_size = 0;
1457 goto skip_countries;
1460 i = device_create_file(&intf->dev,
1461 &dev_attr_iCountryCodeRelDate);
1463 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1464 kfree(acm->country_codes);
1465 acm->country_codes = NULL;
1466 acm->country_code_size = 0;
1467 goto skip_countries;
1472 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1473 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1474 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1475 /* works around buggy devices */
1476 epctrl->bInterval ? epctrl->bInterval : 16);
1477 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1478 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1480 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1482 acm->line.dwDTERate = cpu_to_le32(9600);
1483 acm->line.bDataBits = 8;
1484 acm_set_line(acm, &acm->line);
1486 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1487 usb_set_intfdata(data_interface, acm);
1489 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1490 &control_interface->dev);
1491 if (IS_ERR(tty_dev)) {
1492 rv = PTR_ERR(tty_dev);
1496 if (quirks & CLEAR_HALT_CONDITIONS) {
1497 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress));
1498 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress));
1503 if (!acm->combined_interfaces) {
1504 /* Clear driver data so that disconnect() returns early. */
1505 usb_set_intfdata(data_interface, NULL);
1506 usb_driver_release_interface(&acm_driver, data_interface);
1508 if (acm->country_codes) {
1509 device_remove_file(&acm->control->dev,
1510 &dev_attr_wCountryCodes);
1511 device_remove_file(&acm->control->dev,
1512 &dev_attr_iCountryCodeRelDate);
1513 kfree(acm->country_codes);
1515 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1517 usb_set_intfdata(intf, NULL);
1518 for (i = 0; i < ACM_NW; i++)
1519 usb_free_urb(acm->wb[i].urb);
1521 for (i = 0; i < num_rx_buf; i++)
1522 usb_free_urb(acm->read_urbs[i]);
1523 acm_read_buffers_free(acm);
1524 usb_free_urb(acm->ctrlurb);
1526 acm_write_buffers_free(acm);
1528 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1530 acm_release_minor(acm);
1536 static void stop_data_traffic(struct acm *acm)
1540 dev_dbg(&acm->control->dev, "%s\n", __func__);
1542 usb_kill_urb(acm->ctrlurb);
1543 for (i = 0; i < ACM_NW; i++)
1544 usb_kill_urb(acm->wb[i].urb);
1545 for (i = 0; i < acm->rx_buflimit; i++)
1546 usb_kill_urb(acm->read_urbs[i]);
1548 cancel_work_sync(&acm->work);
1551 static void acm_disconnect(struct usb_interface *intf)
1553 struct acm *acm = usb_get_intfdata(intf);
1554 struct usb_device *usb_dev = interface_to_usbdev(intf);
1555 struct tty_struct *tty;
1558 dev_dbg(&intf->dev, "%s\n", __func__);
1560 /* sibling interface is already cleaning up */
1564 mutex_lock(&acm->mutex);
1565 acm->disconnected = true;
1566 if (acm->country_codes) {
1567 device_remove_file(&acm->control->dev,
1568 &dev_attr_wCountryCodes);
1569 device_remove_file(&acm->control->dev,
1570 &dev_attr_iCountryCodeRelDate);
1572 wake_up_all(&acm->wioctl);
1573 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1574 usb_set_intfdata(acm->control, NULL);
1575 usb_set_intfdata(acm->data, NULL);
1576 mutex_unlock(&acm->mutex);
1578 tty = tty_port_tty_get(&acm->port);
1584 stop_data_traffic(acm);
1586 tty_unregister_device(acm_tty_driver, acm->minor);
1588 usb_free_urb(acm->ctrlurb);
1589 for (i = 0; i < ACM_NW; i++)
1590 usb_free_urb(acm->wb[i].urb);
1591 for (i = 0; i < acm->rx_buflimit; i++)
1592 usb_free_urb(acm->read_urbs[i]);
1593 acm_write_buffers_free(acm);
1594 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1595 acm_read_buffers_free(acm);
1597 if (!acm->combined_interfaces)
1598 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1599 acm->data : acm->control);
1601 tty_port_put(&acm->port);
1605 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1607 struct acm *acm = usb_get_intfdata(intf);
1610 spin_lock_irq(&acm->write_lock);
1611 if (PMSG_IS_AUTO(message)) {
1612 if (acm->transmitting) {
1613 spin_unlock_irq(&acm->write_lock);
1617 cnt = acm->susp_count++;
1618 spin_unlock_irq(&acm->write_lock);
1623 stop_data_traffic(acm);
1628 static int acm_resume(struct usb_interface *intf)
1630 struct acm *acm = usb_get_intfdata(intf);
1634 spin_lock_irq(&acm->write_lock);
1636 if (--acm->susp_count)
1639 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1640 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1643 urb = usb_get_from_anchor(&acm->delayed);
1647 acm_start_wb(acm, urb->context);
1651 * delayed error checking because we must
1652 * do the write path at all cost
1657 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1660 spin_unlock_irq(&acm->write_lock);
1665 static int acm_reset_resume(struct usb_interface *intf)
1667 struct acm *acm = usb_get_intfdata(intf);
1669 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1670 tty_port_tty_hangup(&acm->port, false);
1672 return acm_resume(intf);
1675 #endif /* CONFIG_PM */
1677 #define NOKIA_PCSUITE_ACM_INFO(x) \
1678 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1679 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1680 USB_CDC_ACM_PROTO_VENDOR)
1682 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1683 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1684 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1685 USB_CDC_ACM_PROTO_VENDOR)
1688 * USB driver structure.
1691 static const struct usb_device_id acm_ids[] = {
1692 /* quirky and broken devices */
1693 { USB_DEVICE(0x0424, 0x274e), /* Microchip Technology, Inc. (formerly SMSC) */
1694 .driver_info = DISABLE_ECHO, }, /* DISABLE ECHO in termios flag */
1695 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1696 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1697 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1698 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1699 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1700 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1702 { USB_DEVICE(0x045b, 0x023c), /* Renesas USB Download mode */
1703 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1705 { USB_DEVICE(0x045b, 0x0248), /* Renesas USB Download mode */
1706 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1708 { USB_DEVICE(0x045b, 0x024D), /* Renesas USB Download mode */
1709 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1711 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1712 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1714 { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1715 .driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1717 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1718 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1720 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1721 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1723 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1724 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1726 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1727 .driver_info = SINGLE_RX_URB,
1729 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1730 .driver_info = SINGLE_RX_URB, /* firmware bug */
1732 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1733 .driver_info = SINGLE_RX_URB, /* firmware bug */
1735 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1736 .driver_info = SINGLE_RX_URB,
1738 { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1739 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1741 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1742 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1744 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1745 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1747 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1748 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1750 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1751 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1753 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1754 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1756 { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1757 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1759 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1760 .driver_info = QUIRK_CONTROL_LINE_STATE, },
1761 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1762 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1763 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1765 /* Motorola H24 HSPA module: */
1766 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1767 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1768 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1770 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1771 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1773 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1774 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1776 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1777 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1779 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1780 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1782 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1783 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1785 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1786 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1789 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1790 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1791 data interface instead of
1792 communications interface.
1793 Maybe we should define a new
1796 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1797 .driver_info = NO_UNION_NORMAL,
1799 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1800 .driver_info = NO_UNION_NORMAL,
1802 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1803 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1805 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1806 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1808 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1809 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1811 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1812 .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1814 { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1815 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1818 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1819 .driver_info = CLEAR_HALT_CONDITIONS,
1822 /* Nokia S60 phones expose two ACM channels. The first is
1823 * a modem and is picked up by the standard AT-command
1824 * information below. The second is 'vendor-specific' but
1825 * is treated as a serial device at the S60 end, so we want
1826 * to expose it on Linux too. */
1827 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1828 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1829 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1830 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1831 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1832 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1833 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1834 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1835 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1836 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1837 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1838 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1839 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1840 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1841 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1842 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1843 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1844 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1845 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1846 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1847 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1848 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1849 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1850 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1851 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1852 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1853 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1854 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1855 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1856 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1857 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1858 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1859 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1860 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1861 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1862 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1863 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1864 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1865 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1866 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1867 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1868 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1869 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1870 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1871 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1872 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1873 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1874 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1875 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1876 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1877 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1878 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1879 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1880 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1881 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1882 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1883 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1884 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1886 /* Support for Owen devices */
1887 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1889 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1891 /* Support for Droids MuIn LCD */
1892 { USB_DEVICE(0x04d8, 0x000b),
1893 .driver_info = NO_DATA_INTERFACE,
1896 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1897 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1898 .driver_info = IGNORE_DEVICE,
1900 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1901 .driver_info = IGNORE_DEVICE,
1904 { USB_DEVICE(0x04d8, 0xf58b),
1905 .driver_info = IGNORE_DEVICE,
1909 /*Samsung phone in firmware update mode */
1910 { USB_DEVICE(0x04e8, 0x685d),
1911 .driver_info = IGNORE_DEVICE,
1914 /* Exclude Infineon Flash Loader utility */
1915 { USB_DEVICE(0x058b, 0x0041),
1916 .driver_info = IGNORE_DEVICE,
1919 /* Exclude ETAS ES58x */
1920 { USB_DEVICE(0x108c, 0x0159), /* ES581.4 */
1921 .driver_info = IGNORE_DEVICE,
1923 { USB_DEVICE(0x108c, 0x0168), /* ES582.1 */
1924 .driver_info = IGNORE_DEVICE,
1926 { USB_DEVICE(0x108c, 0x0169), /* ES584.1 */
1927 .driver_info = IGNORE_DEVICE,
1930 { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1931 .driver_info = SEND_ZERO_PACKET,
1933 { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1934 .driver_info = SEND_ZERO_PACKET,
1937 /* Exclude Goodix Fingerprint Reader */
1938 { USB_DEVICE(0x27c6, 0x5395),
1939 .driver_info = IGNORE_DEVICE,
1942 /* Exclude Heimann Sensor GmbH USB appset demo */
1943 { USB_DEVICE(0x32a7, 0x0000),
1944 .driver_info = IGNORE_DEVICE,
1947 /* control interfaces without any protocol set */
1948 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1949 USB_CDC_PROTO_NONE) },
1951 /* control interfaces with various AT-command sets */
1952 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1953 USB_CDC_ACM_PROTO_AT_V25TER) },
1954 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1955 USB_CDC_ACM_PROTO_AT_PCCA101) },
1956 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1957 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1958 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1959 USB_CDC_ACM_PROTO_AT_GSM) },
1960 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1961 USB_CDC_ACM_PROTO_AT_3G) },
1962 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1963 USB_CDC_ACM_PROTO_AT_CDMA) },
1965 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1966 .driver_info = SEND_ZERO_PACKET,
1972 MODULE_DEVICE_TABLE(usb, acm_ids);
1974 static struct usb_driver acm_driver = {
1977 .disconnect = acm_disconnect,
1979 .suspend = acm_suspend,
1980 .resume = acm_resume,
1981 .reset_resume = acm_reset_resume,
1983 .id_table = acm_ids,
1985 .supports_autosuspend = 1,
1987 .disable_hub_initiated_lpm = 1,
1991 * TTY driver structures.
1994 static const struct tty_operations acm_ops = {
1995 .install = acm_tty_install,
1996 .open = acm_tty_open,
1997 .close = acm_tty_close,
1998 .cleanup = acm_tty_cleanup,
1999 .hangup = acm_tty_hangup,
2000 .write = acm_tty_write,
2001 .write_room = acm_tty_write_room,
2002 .ioctl = acm_tty_ioctl,
2003 .throttle = acm_tty_throttle,
2004 .unthrottle = acm_tty_unthrottle,
2005 .chars_in_buffer = acm_tty_chars_in_buffer,
2006 .break_ctl = acm_tty_break_ctl,
2007 .set_termios = acm_tty_set_termios,
2008 .tiocmget = acm_tty_tiocmget,
2009 .tiocmset = acm_tty_tiocmset,
2016 static int __init acm_init(void)
2019 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
2020 if (!acm_tty_driver)
2022 acm_tty_driver->driver_name = "acm",
2023 acm_tty_driver->name = "ttyACM",
2024 acm_tty_driver->major = ACM_TTY_MAJOR,
2025 acm_tty_driver->minor_start = 0,
2026 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2027 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
2028 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2029 acm_tty_driver->init_termios = tty_std_termios;
2030 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2032 tty_set_operations(acm_tty_driver, &acm_ops);
2034 retval = tty_register_driver(acm_tty_driver);
2036 put_tty_driver(acm_tty_driver);
2040 retval = usb_register(&acm_driver);
2042 tty_unregister_driver(acm_tty_driver);
2043 put_tty_driver(acm_tty_driver);
2047 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2052 static void __exit acm_exit(void)
2054 usb_deregister(&acm_driver);
2055 tty_unregister_driver(acm_tty_driver);
2056 put_tty_driver(acm_tty_driver);
2057 idr_destroy(&acm_minors);
2060 module_init(acm_init);
2061 module_exit(acm_exit);
2063 MODULE_AUTHOR(DRIVER_AUTHOR);
2064 MODULE_DESCRIPTION(DRIVER_DESC);
2065 MODULE_LICENSE("GPL");
2066 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);