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 newctrl = get_unaligned_le16(data);
316 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
317 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
319 tty_port_tty_hangup(&acm->port, false);
322 difference = acm->ctrlin ^ newctrl;
323 spin_lock(&acm->read_lock);
324 acm->ctrlin = newctrl;
325 acm->oldcount = acm->iocount;
327 if (difference & ACM_CTRL_DSR)
329 if (difference & ACM_CTRL_BRK)
331 if (difference & ACM_CTRL_RI)
333 if (difference & ACM_CTRL_DCD)
335 if (difference & ACM_CTRL_FRAMING)
336 acm->iocount.frame++;
337 if (difference & ACM_CTRL_PARITY)
338 acm->iocount.parity++;
339 if (difference & ACM_CTRL_OVERRUN)
340 acm->iocount.overrun++;
341 spin_unlock(&acm->read_lock);
344 wake_up_all(&acm->wioctl);
349 dev_dbg(&acm->control->dev,
350 "%s - unknown notification %d received: index %d "
351 "len %d data0 %d data1 %d\n",
353 dr->bNotificationType, dr->wIndex,
354 dr->wLength, data[0], data[1]);
358 retval = usb_submit_urb(urb, GFP_ATOMIC);
359 if (retval && retval != -EPERM)
360 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
364 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
368 if (!test_and_clear_bit(index, &acm->read_urbs_free))
371 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
373 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
376 dev_err(&acm->data->dev,
377 "%s - usb_submit_urb failed: %d\n",
380 set_bit(index, &acm->read_urbs_free);
387 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
392 for (i = 0; i < acm->rx_buflimit; ++i) {
393 res = acm_submit_read_urb(acm, i, mem_flags);
401 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
403 if (!urb->actual_length)
406 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
408 tty_flip_buffer_push(&acm->port);
411 static void acm_read_bulk_callback(struct urb *urb)
413 struct acm_rb *rb = urb->context;
414 struct acm *acm = rb->instance;
416 int status = urb->status;
418 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
419 rb->index, urb->actual_length);
422 set_bit(rb->index, &acm->read_urbs_free);
423 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
428 set_bit(rb->index, &acm->read_urbs_free);
429 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
431 if ((status != -ENOENT) || (urb->actual_length == 0))
435 usb_mark_last_busy(acm->dev);
437 acm_process_read_urb(acm, urb);
439 * Unthrottle may run on another CPU which needs to see events
440 * in the same order. Submission has an implict barrier
442 smp_mb__before_atomic();
443 set_bit(rb->index, &acm->read_urbs_free);
445 /* throttle device if requested by tty */
446 spin_lock_irqsave(&acm->read_lock, flags);
447 acm->throttled = acm->throttle_req;
448 if (!acm->throttled) {
449 spin_unlock_irqrestore(&acm->read_lock, flags);
450 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
452 spin_unlock_irqrestore(&acm->read_lock, flags);
456 /* data interface wrote those outgoing bytes */
457 static void acm_write_bulk(struct urb *urb)
459 struct acm_wb *wb = urb->context;
460 struct acm *acm = wb->instance;
462 int status = urb->status;
464 if (status || (urb->actual_length != urb->transfer_buffer_length))
465 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
468 urb->transfer_buffer_length,
471 spin_lock_irqsave(&acm->write_lock, flags);
472 acm_write_done(acm, wb);
473 spin_unlock_irqrestore(&acm->write_lock, flags);
474 schedule_work(&acm->work);
477 static void acm_softint(struct work_struct *work)
479 struct acm *acm = container_of(work, struct acm, work);
481 dev_vdbg(&acm->data->dev, "%s\n", __func__);
483 tty_port_tty_wakeup(&acm->port);
490 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
495 dev_dbg(tty->dev, "%s\n", __func__);
497 acm = acm_get_by_minor(tty->index);
501 retval = tty_standard_install(driver, tty);
503 goto error_init_termios;
505 tty->driver_data = acm;
510 tty_port_put(&acm->port);
514 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
516 struct acm *acm = tty->driver_data;
518 dev_dbg(tty->dev, "%s\n", __func__);
520 return tty_port_open(&acm->port, tty, filp);
523 static void acm_port_dtr_rts(struct tty_port *port, int raise)
525 struct acm *acm = container_of(port, struct acm, port);
530 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
534 /* FIXME: add missing ctrlout locking throughout driver */
537 res = acm_set_control(acm, val);
538 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
539 dev_err(&acm->control->dev, "failed to set dtr/rts\n");
542 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
544 struct acm *acm = container_of(port, struct acm, port);
545 int retval = -ENODEV;
548 dev_dbg(&acm->control->dev, "%s\n", __func__);
550 mutex_lock(&acm->mutex);
551 if (acm->disconnected)
554 retval = usb_autopm_get_interface(acm->control);
556 goto error_get_interface;
559 * FIXME: Why do we need this? Allocating 64K of physically contiguous
560 * memory is really nasty...
562 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
563 acm->control->needs_remote_wakeup = 1;
565 acm->ctrlurb->dev = acm->dev;
566 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
568 dev_err(&acm->control->dev,
569 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
570 goto error_submit_urb;
573 acm_tty_set_termios(tty, NULL);
576 * Unthrottle device in case the TTY was closed while throttled.
578 spin_lock_irq(&acm->read_lock);
580 acm->throttle_req = 0;
581 spin_unlock_irq(&acm->read_lock);
583 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
585 goto error_submit_read_urbs;
587 usb_autopm_put_interface(acm->control);
589 mutex_unlock(&acm->mutex);
593 error_submit_read_urbs:
594 for (i = 0; i < acm->rx_buflimit; i++)
595 usb_kill_urb(acm->read_urbs[i]);
596 usb_kill_urb(acm->ctrlurb);
598 usb_autopm_put_interface(acm->control);
601 mutex_unlock(&acm->mutex);
603 return usb_translate_errors(retval);
606 static void acm_port_destruct(struct tty_port *port)
608 struct acm *acm = container_of(port, struct acm, port);
610 dev_dbg(&acm->control->dev, "%s\n", __func__);
612 acm_release_minor(acm);
613 usb_put_intf(acm->control);
614 kfree(acm->country_codes);
618 static void acm_port_shutdown(struct tty_port *port)
620 struct acm *acm = container_of(port, struct acm, port);
625 dev_dbg(&acm->control->dev, "%s\n", __func__);
628 * Need to grab write_lock to prevent race with resume, but no need to
629 * hold it due to the tty-port initialised flag.
631 spin_lock_irq(&acm->write_lock);
632 spin_unlock_irq(&acm->write_lock);
634 usb_autopm_get_interface_no_resume(acm->control);
635 acm->control->needs_remote_wakeup = 0;
636 usb_autopm_put_interface(acm->control);
639 urb = usb_get_from_anchor(&acm->delayed);
644 usb_autopm_put_interface_async(acm->control);
647 usb_kill_urb(acm->ctrlurb);
648 for (i = 0; i < ACM_NW; i++)
649 usb_kill_urb(acm->wb[i].urb);
650 for (i = 0; i < acm->rx_buflimit; i++)
651 usb_kill_urb(acm->read_urbs[i]);
654 static void acm_tty_cleanup(struct tty_struct *tty)
656 struct acm *acm = tty->driver_data;
657 dev_dbg(&acm->control->dev, "%s\n", __func__);
658 tty_port_put(&acm->port);
661 static void acm_tty_hangup(struct tty_struct *tty)
663 struct acm *acm = tty->driver_data;
664 dev_dbg(&acm->control->dev, "%s\n", __func__);
665 tty_port_hangup(&acm->port);
668 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
670 struct acm *acm = tty->driver_data;
671 dev_dbg(&acm->control->dev, "%s\n", __func__);
672 tty_port_close(&acm->port, tty, filp);
675 static int acm_tty_write(struct tty_struct *tty,
676 const unsigned char *buf, int count)
678 struct acm *acm = tty->driver_data;
687 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
689 spin_lock_irqsave(&acm->write_lock, flags);
690 wbn = acm_wb_alloc(acm);
692 spin_unlock_irqrestore(&acm->write_lock, flags);
699 spin_unlock_irqrestore(&acm->write_lock, flags);
703 count = (count > acm->writesize) ? acm->writesize : count;
704 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
705 memcpy(wb->buf, buf, count);
708 stat = usb_autopm_get_interface_async(acm->control);
711 spin_unlock_irqrestore(&acm->write_lock, flags);
715 if (acm->susp_count) {
716 if (acm->putbuffer) {
717 /* now to preserve order */
718 usb_anchor_urb(acm->putbuffer->urb, &acm->delayed);
719 acm->putbuffer = NULL;
721 usb_anchor_urb(wb->urb, &acm->delayed);
722 spin_unlock_irqrestore(&acm->write_lock, flags);
725 if (acm->putbuffer) {
726 /* at this point there is no good way to handle errors */
727 acm_start_wb(acm, acm->putbuffer);
728 acm->putbuffer = NULL;
732 stat = acm_start_wb(acm, wb);
733 spin_unlock_irqrestore(&acm->write_lock, flags);
740 static void acm_tty_flush_chars(struct tty_struct *tty)
742 struct acm *acm = tty->driver_data;
743 struct acm_wb *cur = acm->putbuffer;
747 acm->putbuffer = NULL;
748 err = usb_autopm_get_interface_async(acm->control);
749 spin_lock_irqsave(&acm->write_lock, flags);
756 usb_anchor_urb(cur->urb, &acm->delayed);
758 acm_start_wb(acm, cur);
760 spin_unlock_irqrestore(&acm->write_lock, flags);
764 static int acm_tty_put_char(struct tty_struct *tty, unsigned char ch)
766 struct acm *acm = tty->driver_data;
772 cur = acm->putbuffer;
774 spin_lock_irqsave(&acm->write_lock, flags);
775 wbn = acm_wb_alloc(acm);
778 acm->putbuffer = cur;
780 spin_unlock_irqrestore(&acm->write_lock, flags);
785 if (cur->len == acm->writesize) {
786 acm_tty_flush_chars(tty);
790 cur->buf[cur->len++] = ch;
794 static int acm_tty_write_room(struct tty_struct *tty)
796 struct acm *acm = tty->driver_data;
798 * Do not let the line discipline to know that we have a reserve,
799 * or it might get too enthusiastic.
801 return acm_wb_is_avail(acm) ? acm->writesize : 0;
804 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
806 struct acm *acm = tty->driver_data;
808 * if the device was unplugged then any remaining characters fell out
809 * of the connector ;)
811 if (acm->disconnected)
814 * This is inaccurate (overcounts), but it works.
816 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
819 static void acm_tty_throttle(struct tty_struct *tty)
821 struct acm *acm = tty->driver_data;
823 spin_lock_irq(&acm->read_lock);
824 acm->throttle_req = 1;
825 spin_unlock_irq(&acm->read_lock);
828 static void acm_tty_unthrottle(struct tty_struct *tty)
830 struct acm *acm = tty->driver_data;
831 unsigned int was_throttled;
833 spin_lock_irq(&acm->read_lock);
834 was_throttled = acm->throttled;
836 acm->throttle_req = 0;
837 spin_unlock_irq(&acm->read_lock);
840 acm_submit_read_urbs(acm, GFP_KERNEL);
843 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
845 struct acm *acm = tty->driver_data;
848 retval = acm_send_break(acm, state ? 0xffff : 0);
850 dev_dbg(&acm->control->dev, "%s - send break failed\n",
855 static int acm_tty_tiocmget(struct tty_struct *tty)
857 struct acm *acm = tty->driver_data;
859 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
860 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
861 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
862 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
863 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
867 static int acm_tty_tiocmset(struct tty_struct *tty,
868 unsigned int set, unsigned int clear)
870 struct acm *acm = tty->driver_data;
871 unsigned int newctrl;
873 newctrl = acm->ctrlout;
874 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
875 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
876 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
877 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
879 newctrl = (newctrl & ~clear) | set;
881 if (acm->ctrlout == newctrl)
883 return acm_set_control(acm, acm->ctrlout = newctrl);
886 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
888 struct serial_struct tmp;
893 memset(&tmp, 0, sizeof(tmp));
894 tmp.flags = ASYNC_LOW_LATENCY;
895 tmp.xmit_fifo_size = acm->writesize;
896 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
897 tmp.close_delay = acm->port.close_delay / 10;
898 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
899 ASYNC_CLOSING_WAIT_NONE :
900 acm->port.closing_wait / 10;
902 if (copy_to_user(info, &tmp, sizeof(tmp)))
908 static int set_serial_info(struct acm *acm,
909 struct serial_struct __user *newinfo)
911 struct serial_struct new_serial;
912 unsigned int closing_wait, close_delay;
915 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
918 close_delay = new_serial.close_delay * 10;
919 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
920 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
922 mutex_lock(&acm->port.mutex);
924 if (!capable(CAP_SYS_ADMIN)) {
925 if ((close_delay != acm->port.close_delay) ||
926 (closing_wait != acm->port.closing_wait))
929 retval = -EOPNOTSUPP;
931 acm->port.close_delay = close_delay;
932 acm->port.closing_wait = closing_wait;
935 mutex_unlock(&acm->port.mutex);
939 static int wait_serial_change(struct acm *acm, unsigned long arg)
942 DECLARE_WAITQUEUE(wait, current);
943 struct async_icount old, new;
945 if (arg & (TIOCM_DSR | TIOCM_RI | TIOCM_CD ))
948 spin_lock_irq(&acm->read_lock);
952 spin_unlock_irq(&acm->read_lock);
954 if ((arg & TIOCM_DSR) &&
957 if ((arg & TIOCM_CD) &&
960 if ((arg & TIOCM_RI) &&
964 add_wait_queue(&acm->wioctl, &wait);
965 set_current_state(TASK_INTERRUPTIBLE);
967 remove_wait_queue(&acm->wioctl, &wait);
968 if (acm->disconnected) {
974 if (signal_pending(current))
984 static int get_serial_usage(struct acm *acm,
985 struct serial_icounter_struct __user *count)
987 struct serial_icounter_struct icount;
990 memset(&icount, 0, sizeof(icount));
991 icount.dsr = acm->iocount.dsr;
992 icount.rng = acm->iocount.rng;
993 icount.dcd = acm->iocount.dcd;
994 icount.frame = acm->iocount.frame;
995 icount.overrun = acm->iocount.overrun;
996 icount.parity = acm->iocount.parity;
997 icount.brk = acm->iocount.brk;
999 if (copy_to_user(count, &icount, sizeof(icount)) > 0)
1005 static int acm_tty_ioctl(struct tty_struct *tty,
1006 unsigned int cmd, unsigned long arg)
1008 struct acm *acm = tty->driver_data;
1009 int rv = -ENOIOCTLCMD;
1012 case TIOCGSERIAL: /* gets serial port data */
1013 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
1016 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
1019 rv = usb_autopm_get_interface(acm->control);
1024 rv = wait_serial_change(acm, arg);
1025 usb_autopm_put_interface(acm->control);
1028 rv = get_serial_usage(acm, (struct serial_icounter_struct __user *) arg);
1035 static void acm_tty_set_termios(struct tty_struct *tty,
1036 struct ktermios *termios_old)
1038 struct acm *acm = tty->driver_data;
1039 struct ktermios *termios = &tty->termios;
1040 struct usb_cdc_line_coding newline;
1041 int newctrl = acm->ctrlout;
1043 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
1044 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1045 newline.bParityType = termios->c_cflag & PARENB ?
1046 (termios->c_cflag & PARODD ? 1 : 2) +
1047 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1048 switch (termios->c_cflag & CSIZE) {
1050 newline.bDataBits = 5;
1053 newline.bDataBits = 6;
1056 newline.bDataBits = 7;
1060 newline.bDataBits = 8;
1063 /* FIXME: Needs to clear unsupported bits in the termios */
1064 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1066 if (C_BAUD(tty) == B0) {
1067 newline.dwDTERate = acm->line.dwDTERate;
1068 newctrl &= ~ACM_CTRL_DTR;
1069 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1070 newctrl |= ACM_CTRL_DTR;
1073 if (newctrl != acm->ctrlout)
1074 acm_set_control(acm, acm->ctrlout = newctrl);
1076 if (memcmp(&acm->line, &newline, sizeof newline)) {
1077 memcpy(&acm->line, &newline, sizeof newline);
1078 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1080 le32_to_cpu(newline.dwDTERate),
1081 newline.bCharFormat, newline.bParityType,
1083 acm_set_line(acm, &acm->line);
1087 static const struct tty_port_operations acm_port_ops = {
1088 .dtr_rts = acm_port_dtr_rts,
1089 .shutdown = acm_port_shutdown,
1090 .activate = acm_port_activate,
1091 .destruct = acm_port_destruct,
1095 * USB probe and disconnect routines.
1098 /* Little helpers: write/read buffers free */
1099 static void acm_write_buffers_free(struct acm *acm)
1103 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1105 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1106 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
1109 static void acm_read_buffers_free(struct acm *acm)
1111 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1114 for (i = 0; i < acm->rx_buflimit; i++)
1115 usb_free_coherent(usb_dev, acm->readsize,
1116 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1119 /* Little helper: write buffers allocate */
1120 static int acm_write_buffers_alloc(struct acm *acm)
1125 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1126 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1132 usb_free_coherent(acm->dev, acm->writesize,
1141 static int acm_probe(struct usb_interface *intf,
1142 const struct usb_device_id *id)
1144 struct usb_cdc_union_desc *union_header = NULL;
1145 struct usb_cdc_country_functional_desc *cfd = NULL;
1146 unsigned char *buffer = intf->altsetting->extra;
1147 int buflen = intf->altsetting->extralen;
1148 struct usb_interface *control_interface;
1149 struct usb_interface *data_interface;
1150 struct usb_endpoint_descriptor *epctrl = NULL;
1151 struct usb_endpoint_descriptor *epread = NULL;
1152 struct usb_endpoint_descriptor *epwrite = NULL;
1153 struct usb_device *usb_dev = interface_to_usbdev(intf);
1156 int ctrlsize, readsize;
1158 u8 ac_management_function = 0;
1159 u8 call_management_function = 0;
1160 int call_interface_num = -1;
1161 int data_interface_num = -1;
1162 unsigned long quirks;
1165 unsigned int elength = 0;
1166 int combined_interfaces = 0;
1167 struct device *tty_dev;
1171 quirks = (unsigned long)id->driver_info;
1173 if (quirks == IGNORE_DEVICE)
1176 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1178 /* handle quirks deadly to normal probing*/
1179 if (quirks == NO_UNION_NORMAL) {
1180 data_interface = usb_ifnum_to_if(usb_dev, 1);
1181 control_interface = usb_ifnum_to_if(usb_dev, 0);
1182 /* we would crash */
1183 if (!data_interface || !control_interface)
1185 goto skip_normal_probe;
1190 dev_err(&intf->dev, "Weird descriptor references\n");
1195 if (intf->cur_altsetting->endpoint &&
1196 intf->cur_altsetting->endpoint->extralen &&
1197 intf->cur_altsetting->endpoint->extra) {
1199 "Seeking extra descriptors on endpoint\n");
1200 buflen = intf->cur_altsetting->endpoint->extralen;
1201 buffer = intf->cur_altsetting->endpoint->extra;
1204 "Zero length descriptor references\n");
1209 while (buflen > 0) {
1210 elength = buffer[0];
1212 dev_err(&intf->dev, "skipping garbage byte\n");
1216 if (buffer[1] != USB_DT_CS_INTERFACE) {
1217 dev_err(&intf->dev, "skipping garbage\n");
1221 switch (buffer[2]) {
1222 case USB_CDC_UNION_TYPE: /* we've found it */
1223 if (elength < sizeof(struct usb_cdc_union_desc))
1226 dev_err(&intf->dev, "More than one "
1227 "union descriptor, skipping ...\n");
1230 union_header = (struct usb_cdc_union_desc *)buffer;
1232 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1233 if (elength < sizeof(struct usb_cdc_country_functional_desc))
1235 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1237 case USB_CDC_HEADER_TYPE: /* maybe check version */
1238 break; /* for now we ignore it */
1239 case USB_CDC_ACM_TYPE:
1242 ac_management_function = buffer[3];
1244 case USB_CDC_CALL_MANAGEMENT_TYPE:
1247 call_management_function = buffer[3];
1248 call_interface_num = buffer[4];
1252 * there are LOTS more CDC descriptors that
1253 * could legitimately be found here.
1255 dev_dbg(&intf->dev, "Ignoring descriptor: "
1256 "type %02x, length %ud\n",
1257 buffer[2], elength);
1265 if (!union_header) {
1266 if (call_interface_num > 0) {
1267 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1268 /* quirks for Droids MuIn LCD */
1269 if (quirks & NO_DATA_INTERFACE)
1270 data_interface = usb_ifnum_to_if(usb_dev, 0);
1272 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1273 control_interface = intf;
1275 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1276 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1279 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1280 combined_interfaces = 1;
1281 control_interface = data_interface = intf;
1282 goto look_for_collapsed_interface;
1286 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1287 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1290 if (!control_interface || !data_interface) {
1291 dev_dbg(&intf->dev, "no interfaces\n");
1295 if (data_interface_num != call_interface_num)
1296 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1298 if (control_interface == data_interface) {
1299 /* some broken devices designed for windows work this way */
1300 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1301 combined_interfaces = 1;
1302 /* a popular other OS doesn't use it */
1303 quirks |= NO_CAP_LINE;
1304 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1305 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1308 look_for_collapsed_interface:
1309 for (i = 0; i < 3; i++) {
1310 struct usb_endpoint_descriptor *ep;
1311 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1313 if (usb_endpoint_is_int_in(ep))
1315 else if (usb_endpoint_is_bulk_out(ep))
1317 else if (usb_endpoint_is_bulk_in(ep))
1322 if (!epctrl || !epread || !epwrite)
1325 goto made_compressed_probe;
1330 /*workaround for switched interfaces */
1331 if (data_interface->cur_altsetting->desc.bInterfaceClass
1332 != CDC_DATA_INTERFACE_TYPE) {
1333 if (control_interface->cur_altsetting->desc.bInterfaceClass
1334 == CDC_DATA_INTERFACE_TYPE) {
1336 "Your device has switched interfaces.\n");
1337 swap(control_interface, data_interface);
1343 /* Accept probe requests only for the control interface */
1344 if (!combined_interfaces && intf != control_interface)
1347 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1348 /* valid in this context */
1349 dev_dbg(&intf->dev, "The data interface isn't available\n");
1354 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1355 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1358 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1359 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1360 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1363 /* workaround for switched endpoints */
1364 if (!usb_endpoint_dir_in(epread)) {
1365 /* descriptors are swapped */
1367 "The data interface has switched endpoints\n");
1368 swap(epread, epwrite);
1370 made_compressed_probe:
1371 dev_dbg(&intf->dev, "interfaces are valid\n");
1373 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1377 minor = acm_alloc_minor(acm);
1379 dev_err(&intf->dev, "no more free acm devices\n");
1384 ctrlsize = usb_endpoint_maxp(epctrl);
1385 readsize = usb_endpoint_maxp(epread) *
1386 (quirks == SINGLE_RX_URB ? 1 : 2);
1387 acm->combined_interfaces = combined_interfaces;
1388 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1389 acm->control = control_interface;
1390 acm->data = data_interface;
1393 acm->ctrl_caps = ac_management_function;
1394 if (quirks & NO_CAP_LINE)
1395 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1396 acm->ctrlsize = ctrlsize;
1397 acm->readsize = readsize;
1398 acm->rx_buflimit = num_rx_buf;
1399 INIT_WORK(&acm->work, acm_softint);
1400 init_waitqueue_head(&acm->wioctl);
1401 spin_lock_init(&acm->write_lock);
1402 spin_lock_init(&acm->read_lock);
1403 mutex_init(&acm->mutex);
1404 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1405 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1407 acm->bInterval = epread->bInterval;
1408 tty_port_init(&acm->port);
1409 acm->port.ops = &acm_port_ops;
1410 init_usb_anchor(&acm->delayed);
1411 acm->quirks = quirks;
1413 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1416 acm->ctrl_buffer = buf;
1418 if (acm_write_buffers_alloc(acm) < 0)
1421 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1425 for (i = 0; i < num_rx_buf; i++) {
1426 struct acm_rb *rb = &(acm->read_buffers[i]);
1429 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1436 urb = usb_alloc_urb(0, GFP_KERNEL);
1440 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1441 urb->transfer_dma = rb->dma;
1442 if (acm->is_int_ep) {
1443 usb_fill_int_urb(urb, acm->dev,
1447 acm_read_bulk_callback, rb,
1450 usb_fill_bulk_urb(urb, acm->dev,
1454 acm_read_bulk_callback, rb);
1457 acm->read_urbs[i] = urb;
1458 __set_bit(i, &acm->read_urbs_free);
1460 for (i = 0; i < ACM_NW; i++) {
1461 struct acm_wb *snd = &(acm->wb[i]);
1463 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1464 if (snd->urb == NULL)
1467 if (usb_endpoint_xfer_int(epwrite))
1468 usb_fill_int_urb(snd->urb, usb_dev,
1469 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1470 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1472 usb_fill_bulk_urb(snd->urb, usb_dev,
1473 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1474 NULL, acm->writesize, acm_write_bulk, snd);
1475 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1476 if (quirks & SEND_ZERO_PACKET)
1477 snd->urb->transfer_flags |= URB_ZERO_PACKET;
1478 snd->instance = acm;
1481 usb_set_intfdata(intf, acm);
1483 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1487 if (cfd) { /* export the country data */
1488 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1489 if (!acm->country_codes)
1490 goto skip_countries;
1491 acm->country_code_size = cfd->bLength - 4;
1492 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1494 acm->country_rel_date = cfd->iCountryCodeRelDate;
1496 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1498 kfree(acm->country_codes);
1499 acm->country_codes = NULL;
1500 acm->country_code_size = 0;
1501 goto skip_countries;
1504 i = device_create_file(&intf->dev,
1505 &dev_attr_iCountryCodeRelDate);
1507 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1508 kfree(acm->country_codes);
1509 acm->country_codes = NULL;
1510 acm->country_code_size = 0;
1511 goto skip_countries;
1516 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1517 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1518 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1519 /* works around buggy devices */
1520 epctrl->bInterval ? epctrl->bInterval : 16);
1521 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1522 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1524 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1526 acm->line.dwDTERate = cpu_to_le32(9600);
1527 acm->line.bDataBits = 8;
1528 acm_set_line(acm, &acm->line);
1530 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1531 usb_set_intfdata(data_interface, acm);
1533 usb_get_intf(control_interface);
1534 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1535 &control_interface->dev);
1536 if (IS_ERR(tty_dev)) {
1537 rv = PTR_ERR(tty_dev);
1541 if (quirks & CLEAR_HALT_CONDITIONS) {
1542 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress));
1543 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress));
1548 if (acm->country_codes) {
1549 device_remove_file(&acm->control->dev,
1550 &dev_attr_wCountryCodes);
1551 device_remove_file(&acm->control->dev,
1552 &dev_attr_iCountryCodeRelDate);
1553 kfree(acm->country_codes);
1555 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1557 usb_set_intfdata(intf, NULL);
1558 for (i = 0; i < ACM_NW; i++)
1559 usb_free_urb(acm->wb[i].urb);
1561 for (i = 0; i < num_rx_buf; i++)
1562 usb_free_urb(acm->read_urbs[i]);
1563 acm_read_buffers_free(acm);
1564 usb_free_urb(acm->ctrlurb);
1566 acm_write_buffers_free(acm);
1568 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1570 acm_release_minor(acm);
1576 static void stop_data_traffic(struct acm *acm)
1580 dev_dbg(&acm->control->dev, "%s\n", __func__);
1582 usb_kill_urb(acm->ctrlurb);
1583 for (i = 0; i < ACM_NW; i++)
1584 usb_kill_urb(acm->wb[i].urb);
1585 for (i = 0; i < acm->rx_buflimit; i++)
1586 usb_kill_urb(acm->read_urbs[i]);
1588 cancel_work_sync(&acm->work);
1591 static void acm_disconnect(struct usb_interface *intf)
1593 struct acm *acm = usb_get_intfdata(intf);
1594 struct usb_device *usb_dev = interface_to_usbdev(intf);
1595 struct tty_struct *tty;
1598 dev_dbg(&intf->dev, "%s\n", __func__);
1600 /* sibling interface is already cleaning up */
1604 mutex_lock(&acm->mutex);
1605 acm->disconnected = true;
1606 if (acm->country_codes) {
1607 device_remove_file(&acm->control->dev,
1608 &dev_attr_wCountryCodes);
1609 device_remove_file(&acm->control->dev,
1610 &dev_attr_iCountryCodeRelDate);
1612 wake_up_all(&acm->wioctl);
1613 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1614 usb_set_intfdata(acm->control, NULL);
1615 usb_set_intfdata(acm->data, NULL);
1616 mutex_unlock(&acm->mutex);
1618 tty = tty_port_tty_get(&acm->port);
1624 stop_data_traffic(acm);
1626 tty_unregister_device(acm_tty_driver, acm->minor);
1628 usb_free_urb(acm->ctrlurb);
1629 for (i = 0; i < ACM_NW; i++)
1630 usb_free_urb(acm->wb[i].urb);
1631 for (i = 0; i < acm->rx_buflimit; i++)
1632 usb_free_urb(acm->read_urbs[i]);
1633 acm_write_buffers_free(acm);
1634 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1635 acm_read_buffers_free(acm);
1637 if (!acm->combined_interfaces)
1638 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1639 acm->data : acm->control);
1641 tty_port_put(&acm->port);
1645 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1647 struct acm *acm = usb_get_intfdata(intf);
1650 spin_lock_irq(&acm->write_lock);
1651 if (PMSG_IS_AUTO(message)) {
1652 if (acm->transmitting) {
1653 spin_unlock_irq(&acm->write_lock);
1657 cnt = acm->susp_count++;
1658 spin_unlock_irq(&acm->write_lock);
1663 stop_data_traffic(acm);
1668 static int acm_resume(struct usb_interface *intf)
1670 struct acm *acm = usb_get_intfdata(intf);
1674 spin_lock_irq(&acm->write_lock);
1676 if (--acm->susp_count)
1679 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1680 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1683 urb = usb_get_from_anchor(&acm->delayed);
1687 acm_start_wb(acm, urb->context);
1691 * delayed error checking because we must
1692 * do the write path at all cost
1697 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1700 spin_unlock_irq(&acm->write_lock);
1705 static int acm_reset_resume(struct usb_interface *intf)
1707 struct acm *acm = usb_get_intfdata(intf);
1709 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1710 tty_port_tty_hangup(&acm->port, false);
1712 return acm_resume(intf);
1715 #endif /* CONFIG_PM */
1717 #define NOKIA_PCSUITE_ACM_INFO(x) \
1718 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1719 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1720 USB_CDC_ACM_PROTO_VENDOR)
1722 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1723 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1724 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1725 USB_CDC_ACM_PROTO_VENDOR)
1728 * USB driver structure.
1731 static const struct usb_device_id acm_ids[] = {
1732 /* quirky and broken devices */
1733 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1734 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1735 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1736 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1737 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1738 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1740 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1741 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1743 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1744 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1746 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1747 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1749 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1750 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1752 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1753 .driver_info = SINGLE_RX_URB,
1755 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1756 .driver_info = SINGLE_RX_URB, /* firmware bug */
1758 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1759 .driver_info = SINGLE_RX_URB, /* firmware bug */
1761 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1762 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1764 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1765 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1767 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1768 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1770 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1771 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1773 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1774 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1776 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1777 .driver_info = QUIRK_CONTROL_LINE_STATE, },
1778 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1779 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1781 /* Motorola H24 HSPA module: */
1782 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1783 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1784 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1786 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1787 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1789 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1790 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1792 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1793 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1795 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1796 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1798 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1799 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1801 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1802 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1805 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1806 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1807 data interface instead of
1808 communications interface.
1809 Maybe we should define a new
1812 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1813 .driver_info = NO_UNION_NORMAL,
1815 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1816 .driver_info = NO_UNION_NORMAL,
1818 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1819 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1821 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1822 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1825 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1826 .driver_info = CLEAR_HALT_CONDITIONS,
1829 /* Nokia S60 phones expose two ACM channels. The first is
1830 * a modem and is picked up by the standard AT-command
1831 * information below. The second is 'vendor-specific' but
1832 * is treated as a serial device at the S60 end, so we want
1833 * to expose it on Linux too. */
1834 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1835 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1836 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1837 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1838 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1839 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1840 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1841 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1842 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1843 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1844 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1845 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1846 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1847 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1848 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1849 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1850 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1851 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1852 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1853 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1854 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1855 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1856 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1857 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1858 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1859 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1860 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1861 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1862 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1863 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1864 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1865 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1866 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1867 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1868 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1869 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1870 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1871 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1872 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1873 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1874 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1875 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1876 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1877 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1878 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1879 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1880 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1881 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1882 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1883 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1884 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1885 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1886 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1887 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1888 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1889 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1890 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1891 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1893 /* Support for Owen devices */
1894 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1896 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1898 /* Support for Droids MuIn LCD */
1899 { USB_DEVICE(0x04d8, 0x000b),
1900 .driver_info = NO_DATA_INTERFACE,
1903 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1904 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1905 .driver_info = IGNORE_DEVICE,
1907 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1908 .driver_info = IGNORE_DEVICE,
1912 /*Samsung phone in firmware update mode */
1913 { USB_DEVICE(0x04e8, 0x685d),
1914 .driver_info = IGNORE_DEVICE,
1917 /* Exclude Infineon Flash Loader utility */
1918 { USB_DEVICE(0x058b, 0x0041),
1919 .driver_info = IGNORE_DEVICE,
1922 /* control interfaces without any protocol set */
1923 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1924 USB_CDC_PROTO_NONE) },
1926 /* control interfaces with various AT-command sets */
1927 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1928 USB_CDC_ACM_PROTO_AT_V25TER) },
1929 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1930 USB_CDC_ACM_PROTO_AT_PCCA101) },
1931 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1932 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1933 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1934 USB_CDC_ACM_PROTO_AT_GSM) },
1935 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1936 USB_CDC_ACM_PROTO_AT_3G) },
1937 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1938 USB_CDC_ACM_PROTO_AT_CDMA) },
1940 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1941 .driver_info = SEND_ZERO_PACKET,
1947 MODULE_DEVICE_TABLE(usb, acm_ids);
1949 static struct usb_driver acm_driver = {
1952 .disconnect = acm_disconnect,
1954 .suspend = acm_suspend,
1955 .resume = acm_resume,
1956 .reset_resume = acm_reset_resume,
1958 .id_table = acm_ids,
1960 .supports_autosuspend = 1,
1962 .disable_hub_initiated_lpm = 1,
1966 * TTY driver structures.
1969 static const struct tty_operations acm_ops = {
1970 .install = acm_tty_install,
1971 .open = acm_tty_open,
1972 .close = acm_tty_close,
1973 .cleanup = acm_tty_cleanup,
1974 .hangup = acm_tty_hangup,
1975 .write = acm_tty_write,
1976 .put_char = acm_tty_put_char,
1977 .flush_chars = acm_tty_flush_chars,
1978 .write_room = acm_tty_write_room,
1979 .ioctl = acm_tty_ioctl,
1980 .throttle = acm_tty_throttle,
1981 .unthrottle = acm_tty_unthrottle,
1982 .chars_in_buffer = acm_tty_chars_in_buffer,
1983 .break_ctl = acm_tty_break_ctl,
1984 .set_termios = acm_tty_set_termios,
1985 .tiocmget = acm_tty_tiocmget,
1986 .tiocmset = acm_tty_tiocmset,
1993 static int __init acm_init(void)
1996 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1997 if (!acm_tty_driver)
1999 acm_tty_driver->driver_name = "acm",
2000 acm_tty_driver->name = "ttyACM",
2001 acm_tty_driver->major = ACM_TTY_MAJOR,
2002 acm_tty_driver->minor_start = 0,
2003 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2004 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
2005 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2006 acm_tty_driver->init_termios = tty_std_termios;
2007 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2009 tty_set_operations(acm_tty_driver, &acm_ops);
2011 retval = tty_register_driver(acm_tty_driver);
2013 put_tty_driver(acm_tty_driver);
2017 retval = usb_register(&acm_driver);
2019 tty_unregister_driver(acm_tty_driver);
2020 put_tty_driver(acm_tty_driver);
2024 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2029 static void __exit acm_exit(void)
2031 usb_deregister(&acm_driver);
2032 tty_unregister_driver(acm_tty_driver);
2033 put_tty_driver(acm_tty_driver);
2034 idr_destroy(&acm_minors);
2037 module_init(acm_init);
2038 module_exit(acm_exit);
2040 MODULE_AUTHOR(DRIVER_AUTHOR);
2041 MODULE_DESCRIPTION(DRIVER_DESC);
2042 MODULE_LICENSE("GPL");
2043 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);