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 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
374 dev_err(&acm->data->dev,
375 "urb %d failed submission with %d\n",
378 set_bit(index, &acm->read_urbs_free);
381 dev_vdbg(&acm->data->dev, "submitted urb %d\n", index);
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 acm = acm_get_by_minor(tty->index);
499 retval = tty_standard_install(driver, tty);
501 goto error_init_termios;
503 tty->driver_data = acm;
508 tty_port_put(&acm->port);
512 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
514 struct acm *acm = tty->driver_data;
516 return tty_port_open(&acm->port, tty, filp);
519 static void acm_port_dtr_rts(struct tty_port *port, int raise)
521 struct acm *acm = container_of(port, struct acm, port);
526 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
530 /* FIXME: add missing ctrlout locking throughout driver */
533 res = acm_set_control(acm, val);
534 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
535 dev_err(&acm->control->dev, "failed to set dtr/rts\n");
538 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
540 struct acm *acm = container_of(port, struct acm, port);
541 int retval = -ENODEV;
544 mutex_lock(&acm->mutex);
545 if (acm->disconnected)
548 retval = usb_autopm_get_interface(acm->control);
550 goto error_get_interface;
553 * FIXME: Why do we need this? Allocating 64K of physically contiguous
554 * memory is really nasty...
556 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
557 acm->control->needs_remote_wakeup = 1;
559 acm->ctrlurb->dev = acm->dev;
560 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
562 dev_err(&acm->control->dev,
563 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
564 goto error_submit_urb;
567 acm_tty_set_termios(tty, NULL);
570 * Unthrottle device in case the TTY was closed while throttled.
572 spin_lock_irq(&acm->read_lock);
574 acm->throttle_req = 0;
575 spin_unlock_irq(&acm->read_lock);
577 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
579 goto error_submit_read_urbs;
581 usb_autopm_put_interface(acm->control);
583 mutex_unlock(&acm->mutex);
587 error_submit_read_urbs:
588 for (i = 0; i < acm->rx_buflimit; i++)
589 usb_kill_urb(acm->read_urbs[i]);
590 usb_kill_urb(acm->ctrlurb);
592 usb_autopm_put_interface(acm->control);
595 mutex_unlock(&acm->mutex);
597 return usb_translate_errors(retval);
600 static void acm_port_destruct(struct tty_port *port)
602 struct acm *acm = container_of(port, struct acm, port);
604 acm_release_minor(acm);
605 usb_put_intf(acm->control);
606 kfree(acm->country_codes);
610 static void acm_port_shutdown(struct tty_port *port)
612 struct acm *acm = container_of(port, struct acm, port);
618 * Need to grab write_lock to prevent race with resume, but no need to
619 * hold it due to the tty-port initialised flag.
621 spin_lock_irq(&acm->write_lock);
622 spin_unlock_irq(&acm->write_lock);
624 usb_autopm_get_interface_no_resume(acm->control);
625 acm->control->needs_remote_wakeup = 0;
626 usb_autopm_put_interface(acm->control);
629 urb = usb_get_from_anchor(&acm->delayed);
634 usb_autopm_put_interface_async(acm->control);
637 usb_kill_urb(acm->ctrlurb);
638 for (i = 0; i < ACM_NW; i++)
639 usb_kill_urb(acm->wb[i].urb);
640 for (i = 0; i < acm->rx_buflimit; i++)
641 usb_kill_urb(acm->read_urbs[i]);
644 static void acm_tty_cleanup(struct tty_struct *tty)
646 struct acm *acm = tty->driver_data;
648 tty_port_put(&acm->port);
651 static void acm_tty_hangup(struct tty_struct *tty)
653 struct acm *acm = tty->driver_data;
655 tty_port_hangup(&acm->port);
658 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
660 struct acm *acm = tty->driver_data;
662 tty_port_close(&acm->port, tty, filp);
665 static int acm_tty_write(struct tty_struct *tty,
666 const unsigned char *buf, int count)
668 struct acm *acm = tty->driver_data;
677 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
679 spin_lock_irqsave(&acm->write_lock, flags);
680 wbn = acm_wb_alloc(acm);
682 spin_unlock_irqrestore(&acm->write_lock, flags);
689 spin_unlock_irqrestore(&acm->write_lock, flags);
693 count = (count > acm->writesize) ? acm->writesize : count;
694 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
695 memcpy(wb->buf, buf, count);
698 stat = usb_autopm_get_interface_async(acm->control);
701 spin_unlock_irqrestore(&acm->write_lock, flags);
705 if (acm->susp_count) {
706 if (acm->putbuffer) {
707 /* now to preserve order */
708 usb_anchor_urb(acm->putbuffer->urb, &acm->delayed);
709 acm->putbuffer = NULL;
711 usb_anchor_urb(wb->urb, &acm->delayed);
712 spin_unlock_irqrestore(&acm->write_lock, flags);
715 if (acm->putbuffer) {
716 /* at this point there is no good way to handle errors */
717 acm_start_wb(acm, acm->putbuffer);
718 acm->putbuffer = NULL;
722 stat = acm_start_wb(acm, wb);
723 spin_unlock_irqrestore(&acm->write_lock, flags);
730 static void acm_tty_flush_chars(struct tty_struct *tty)
732 struct acm *acm = tty->driver_data;
733 struct acm_wb *cur = acm->putbuffer;
737 if (!cur) /* nothing to do */
740 acm->putbuffer = NULL;
741 err = usb_autopm_get_interface_async(acm->control);
742 spin_lock_irqsave(&acm->write_lock, flags);
745 acm->putbuffer = cur;
750 usb_anchor_urb(cur->urb, &acm->delayed);
752 acm_start_wb(acm, cur);
754 spin_unlock_irqrestore(&acm->write_lock, flags);
758 static int acm_tty_put_char(struct tty_struct *tty, unsigned char ch)
760 struct acm *acm = tty->driver_data;
766 cur = acm->putbuffer;
768 spin_lock_irqsave(&acm->write_lock, flags);
769 wbn = acm_wb_alloc(acm);
772 acm->putbuffer = cur;
774 spin_unlock_irqrestore(&acm->write_lock, flags);
779 if (cur->len == acm->writesize) {
780 acm_tty_flush_chars(tty);
784 cur->buf[cur->len++] = ch;
788 static int acm_tty_write_room(struct tty_struct *tty)
790 struct acm *acm = tty->driver_data;
792 * Do not let the line discipline to know that we have a reserve,
793 * or it might get too enthusiastic.
795 return acm_wb_is_avail(acm) ? acm->writesize : 0;
798 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
800 struct acm *acm = tty->driver_data;
802 * if the device was unplugged then any remaining characters fell out
803 * of the connector ;)
805 if (acm->disconnected)
808 * This is inaccurate (overcounts), but it works.
810 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
813 static void acm_tty_throttle(struct tty_struct *tty)
815 struct acm *acm = tty->driver_data;
817 spin_lock_irq(&acm->read_lock);
818 acm->throttle_req = 1;
819 spin_unlock_irq(&acm->read_lock);
822 static void acm_tty_unthrottle(struct tty_struct *tty)
824 struct acm *acm = tty->driver_data;
825 unsigned int was_throttled;
827 spin_lock_irq(&acm->read_lock);
828 was_throttled = acm->throttled;
830 acm->throttle_req = 0;
831 spin_unlock_irq(&acm->read_lock);
834 acm_submit_read_urbs(acm, GFP_KERNEL);
837 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
839 struct acm *acm = tty->driver_data;
842 retval = acm_send_break(acm, state ? 0xffff : 0);
844 dev_dbg(&acm->control->dev, "%s - send break failed\n",
849 static int acm_tty_tiocmget(struct tty_struct *tty)
851 struct acm *acm = tty->driver_data;
853 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
854 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
855 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
856 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
857 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
861 static int acm_tty_tiocmset(struct tty_struct *tty,
862 unsigned int set, unsigned int clear)
864 struct acm *acm = tty->driver_data;
865 unsigned int newctrl;
867 newctrl = acm->ctrlout;
868 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
869 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
870 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
871 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
873 newctrl = (newctrl & ~clear) | set;
875 if (acm->ctrlout == newctrl)
877 return acm_set_control(acm, acm->ctrlout = newctrl);
880 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
882 struct serial_struct tmp;
887 memset(&tmp, 0, sizeof(tmp));
888 tmp.flags = ASYNC_LOW_LATENCY;
889 tmp.xmit_fifo_size = acm->writesize;
890 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
891 tmp.close_delay = acm->port.close_delay / 10;
892 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
893 ASYNC_CLOSING_WAIT_NONE :
894 acm->port.closing_wait / 10;
896 if (copy_to_user(info, &tmp, sizeof(tmp)))
902 static int set_serial_info(struct acm *acm,
903 struct serial_struct __user *newinfo)
905 struct serial_struct new_serial;
906 unsigned int closing_wait, close_delay;
909 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
912 close_delay = new_serial.close_delay * 10;
913 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
914 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
916 mutex_lock(&acm->port.mutex);
918 if (!capable(CAP_SYS_ADMIN)) {
919 if ((close_delay != acm->port.close_delay) ||
920 (closing_wait != acm->port.closing_wait))
923 retval = -EOPNOTSUPP;
925 acm->port.close_delay = close_delay;
926 acm->port.closing_wait = closing_wait;
929 mutex_unlock(&acm->port.mutex);
933 static int wait_serial_change(struct acm *acm, unsigned long arg)
936 DECLARE_WAITQUEUE(wait, current);
937 struct async_icount old, new;
939 if (arg & (TIOCM_DSR | TIOCM_RI | TIOCM_CD))
942 spin_lock_irq(&acm->read_lock);
946 spin_unlock_irq(&acm->read_lock);
948 if ((arg & TIOCM_DSR) &&
951 if ((arg & TIOCM_CD) &&
954 if ((arg & TIOCM_RI) &&
958 add_wait_queue(&acm->wioctl, &wait);
959 set_current_state(TASK_INTERRUPTIBLE);
961 remove_wait_queue(&acm->wioctl, &wait);
962 if (acm->disconnected) {
968 if (signal_pending(current))
978 static int get_serial_usage(struct acm *acm,
979 struct serial_icounter_struct __user *count)
981 struct serial_icounter_struct icount;
984 memset(&icount, 0, sizeof(icount));
985 icount.dsr = acm->iocount.dsr;
986 icount.rng = acm->iocount.rng;
987 icount.dcd = acm->iocount.dcd;
988 icount.frame = acm->iocount.frame;
989 icount.overrun = acm->iocount.overrun;
990 icount.parity = acm->iocount.parity;
991 icount.brk = acm->iocount.brk;
993 if (copy_to_user(count, &icount, sizeof(icount)) > 0)
999 static int acm_tty_ioctl(struct tty_struct *tty,
1000 unsigned int cmd, unsigned long arg)
1002 struct acm *acm = tty->driver_data;
1003 int rv = -ENOIOCTLCMD;
1006 case TIOCGSERIAL: /* gets serial port data */
1007 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
1010 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
1013 rv = usb_autopm_get_interface(acm->control);
1018 rv = wait_serial_change(acm, arg);
1019 usb_autopm_put_interface(acm->control);
1022 rv = get_serial_usage(acm, (struct serial_icounter_struct __user *) arg);
1029 static void acm_tty_set_termios(struct tty_struct *tty,
1030 struct ktermios *termios_old)
1032 struct acm *acm = tty->driver_data;
1033 struct ktermios *termios = &tty->termios;
1034 struct usb_cdc_line_coding newline;
1035 int newctrl = acm->ctrlout;
1037 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
1038 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1039 newline.bParityType = termios->c_cflag & PARENB ?
1040 (termios->c_cflag & PARODD ? 1 : 2) +
1041 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1042 switch (termios->c_cflag & CSIZE) {
1044 newline.bDataBits = 5;
1047 newline.bDataBits = 6;
1050 newline.bDataBits = 7;
1054 newline.bDataBits = 8;
1057 /* FIXME: Needs to clear unsupported bits in the termios */
1058 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1060 if (C_BAUD(tty) == B0) {
1061 newline.dwDTERate = acm->line.dwDTERate;
1062 newctrl &= ~ACM_CTRL_DTR;
1063 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1064 newctrl |= ACM_CTRL_DTR;
1067 if (newctrl != acm->ctrlout)
1068 acm_set_control(acm, acm->ctrlout = newctrl);
1070 if (memcmp(&acm->line, &newline, sizeof newline)) {
1071 memcpy(&acm->line, &newline, sizeof newline);
1072 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1074 le32_to_cpu(newline.dwDTERate),
1075 newline.bCharFormat, newline.bParityType,
1077 acm_set_line(acm, &acm->line);
1081 static const struct tty_port_operations acm_port_ops = {
1082 .dtr_rts = acm_port_dtr_rts,
1083 .shutdown = acm_port_shutdown,
1084 .activate = acm_port_activate,
1085 .destruct = acm_port_destruct,
1089 * USB probe and disconnect routines.
1092 /* Little helpers: write/read buffers free */
1093 static void acm_write_buffers_free(struct acm *acm)
1097 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1099 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1100 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
1103 static void acm_read_buffers_free(struct acm *acm)
1105 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1108 for (i = 0; i < acm->rx_buflimit; i++)
1109 usb_free_coherent(usb_dev, acm->readsize,
1110 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1113 /* Little helper: write buffers allocate */
1114 static int acm_write_buffers_alloc(struct acm *acm)
1119 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1120 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1126 usb_free_coherent(acm->dev, acm->writesize,
1135 static int acm_probe(struct usb_interface *intf,
1136 const struct usb_device_id *id)
1138 struct usb_cdc_union_desc *union_header = NULL;
1139 struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
1140 unsigned char *buffer = intf->altsetting->extra;
1141 int buflen = intf->altsetting->extralen;
1142 struct usb_interface *control_interface;
1143 struct usb_interface *data_interface;
1144 struct usb_endpoint_descriptor *epctrl = NULL;
1145 struct usb_endpoint_descriptor *epread = NULL;
1146 struct usb_endpoint_descriptor *epwrite = NULL;
1147 struct usb_device *usb_dev = interface_to_usbdev(intf);
1148 struct usb_cdc_parsed_header h;
1151 int ctrlsize, readsize;
1153 int call_intf_num = -1;
1154 int data_intf_num = -1;
1155 unsigned long quirks;
1158 int combined_interfaces = 0;
1159 struct device *tty_dev;
1163 quirks = (unsigned long)id->driver_info;
1165 if (quirks == IGNORE_DEVICE)
1168 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1170 /* handle quirks deadly to normal probing*/
1171 if (quirks == NO_UNION_NORMAL) {
1172 data_interface = usb_ifnum_to_if(usb_dev, 1);
1173 control_interface = usb_ifnum_to_if(usb_dev, 0);
1174 /* we would crash */
1175 if (!data_interface || !control_interface)
1177 goto skip_normal_probe;
1182 dev_err(&intf->dev, "Weird descriptor references\n");
1187 if (intf->cur_altsetting->endpoint &&
1188 intf->cur_altsetting->endpoint->extralen &&
1189 intf->cur_altsetting->endpoint->extra) {
1191 "Seeking extra descriptors on endpoint\n");
1192 buflen = intf->cur_altsetting->endpoint->extralen;
1193 buffer = intf->cur_altsetting->endpoint->extra;
1196 "Zero length descriptor references\n");
1201 cdc_parse_cdc_header(&h, intf, buffer, buflen);
1202 union_header = h.usb_cdc_union_desc;
1203 cmgmd = h.usb_cdc_call_mgmt_descriptor;
1205 call_intf_num = cmgmd->bDataInterface;
1207 if (!union_header) {
1208 if (call_intf_num > 0) {
1209 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1210 /* quirks for Droids MuIn LCD */
1211 if (quirks & NO_DATA_INTERFACE) {
1212 data_interface = usb_ifnum_to_if(usb_dev, 0);
1214 data_intf_num = call_intf_num;
1215 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1217 control_interface = intf;
1219 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1220 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1223 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1224 combined_interfaces = 1;
1225 control_interface = data_interface = intf;
1226 goto look_for_collapsed_interface;
1230 data_intf_num = union_header->bSlaveInterface0;
1231 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1232 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1235 if (!control_interface || !data_interface) {
1236 dev_dbg(&intf->dev, "no interfaces\n");
1240 if (data_intf_num != call_intf_num)
1241 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1243 if (control_interface == data_interface) {
1244 /* some broken devices designed for windows work this way */
1245 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1246 combined_interfaces = 1;
1247 /* a popular other OS doesn't use it */
1248 quirks |= NO_CAP_LINE;
1249 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1250 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1253 look_for_collapsed_interface:
1254 for (i = 0; i < 3; i++) {
1255 struct usb_endpoint_descriptor *ep;
1256 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1258 if (usb_endpoint_is_int_in(ep))
1260 else if (usb_endpoint_is_bulk_out(ep))
1262 else if (usb_endpoint_is_bulk_in(ep))
1267 if (!epctrl || !epread || !epwrite)
1270 goto made_compressed_probe;
1275 /*workaround for switched interfaces */
1276 if (data_interface->cur_altsetting->desc.bInterfaceClass
1277 != CDC_DATA_INTERFACE_TYPE) {
1278 if (control_interface->cur_altsetting->desc.bInterfaceClass
1279 == CDC_DATA_INTERFACE_TYPE) {
1281 "Your device has switched interfaces.\n");
1282 swap(control_interface, data_interface);
1288 /* Accept probe requests only for the control interface */
1289 if (!combined_interfaces && intf != control_interface)
1292 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1293 /* valid in this context */
1294 dev_dbg(&intf->dev, "The data interface isn't available\n");
1299 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1300 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1303 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1304 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1305 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1308 /* workaround for switched endpoints */
1309 if (!usb_endpoint_dir_in(epread)) {
1310 /* descriptors are swapped */
1312 "The data interface has switched endpoints\n");
1313 swap(epread, epwrite);
1315 made_compressed_probe:
1316 dev_dbg(&intf->dev, "interfaces are valid\n");
1318 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1322 minor = acm_alloc_minor(acm);
1326 ctrlsize = usb_endpoint_maxp(epctrl);
1327 readsize = usb_endpoint_maxp(epread) *
1328 (quirks == SINGLE_RX_URB ? 1 : 2);
1329 acm->combined_interfaces = combined_interfaces;
1330 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1331 acm->control = control_interface;
1332 acm->data = data_interface;
1335 if (h.usb_cdc_acm_descriptor)
1336 acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
1337 if (quirks & NO_CAP_LINE)
1338 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1339 acm->ctrlsize = ctrlsize;
1340 acm->readsize = readsize;
1341 acm->rx_buflimit = num_rx_buf;
1342 INIT_WORK(&acm->work, acm_softint);
1343 init_waitqueue_head(&acm->wioctl);
1344 spin_lock_init(&acm->write_lock);
1345 spin_lock_init(&acm->read_lock);
1346 mutex_init(&acm->mutex);
1347 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1349 acm->bInterval = epread->bInterval;
1350 tty_port_init(&acm->port);
1351 acm->port.ops = &acm_port_ops;
1352 init_usb_anchor(&acm->delayed);
1353 acm->quirks = quirks;
1355 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1358 acm->ctrl_buffer = buf;
1360 if (acm_write_buffers_alloc(acm) < 0)
1363 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1367 for (i = 0; i < num_rx_buf; i++) {
1368 struct acm_rb *rb = &(acm->read_buffers[i]);
1371 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1378 urb = usb_alloc_urb(0, GFP_KERNEL);
1382 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1383 urb->transfer_dma = rb->dma;
1384 if (acm->is_int_ep) {
1385 usb_fill_int_urb(urb, acm->dev,
1386 usb_rcvintpipe(usb_dev, epread->bEndpointAddress),
1389 acm_read_bulk_callback, rb,
1392 usb_fill_bulk_urb(urb, acm->dev,
1393 usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress),
1396 acm_read_bulk_callback, rb);
1399 acm->read_urbs[i] = urb;
1400 __set_bit(i, &acm->read_urbs_free);
1402 for (i = 0; i < ACM_NW; i++) {
1403 struct acm_wb *snd = &(acm->wb[i]);
1405 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1406 if (snd->urb == NULL)
1409 if (usb_endpoint_xfer_int(epwrite))
1410 usb_fill_int_urb(snd->urb, usb_dev,
1411 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1412 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1414 usb_fill_bulk_urb(snd->urb, usb_dev,
1415 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1416 NULL, acm->writesize, acm_write_bulk, snd);
1417 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1418 if (quirks & SEND_ZERO_PACKET)
1419 snd->urb->transfer_flags |= URB_ZERO_PACKET;
1420 snd->instance = acm;
1423 usb_set_intfdata(intf, acm);
1425 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1429 if (h.usb_cdc_country_functional_desc) { /* export the country data */
1430 struct usb_cdc_country_functional_desc * cfd =
1431 h.usb_cdc_country_functional_desc;
1433 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1434 if (!acm->country_codes)
1435 goto skip_countries;
1436 acm->country_code_size = cfd->bLength - 4;
1437 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1439 acm->country_rel_date = cfd->iCountryCodeRelDate;
1441 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1443 kfree(acm->country_codes);
1444 acm->country_codes = NULL;
1445 acm->country_code_size = 0;
1446 goto skip_countries;
1449 i = device_create_file(&intf->dev,
1450 &dev_attr_iCountryCodeRelDate);
1452 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1453 kfree(acm->country_codes);
1454 acm->country_codes = NULL;
1455 acm->country_code_size = 0;
1456 goto skip_countries;
1461 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1462 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1463 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1464 /* works around buggy devices */
1465 epctrl->bInterval ? epctrl->bInterval : 16);
1466 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1467 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1469 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1471 acm->line.dwDTERate = cpu_to_le32(9600);
1472 acm->line.bDataBits = 8;
1473 acm_set_line(acm, &acm->line);
1475 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1476 usb_set_intfdata(data_interface, acm);
1478 usb_get_intf(control_interface);
1479 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1480 &control_interface->dev);
1481 if (IS_ERR(tty_dev)) {
1482 rv = PTR_ERR(tty_dev);
1486 if (quirks & CLEAR_HALT_CONDITIONS) {
1487 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress));
1488 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress));
1493 if (acm->country_codes) {
1494 device_remove_file(&acm->control->dev,
1495 &dev_attr_wCountryCodes);
1496 device_remove_file(&acm->control->dev,
1497 &dev_attr_iCountryCodeRelDate);
1498 kfree(acm->country_codes);
1500 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1502 usb_set_intfdata(intf, NULL);
1503 for (i = 0; i < ACM_NW; i++)
1504 usb_free_urb(acm->wb[i].urb);
1506 for (i = 0; i < num_rx_buf; i++)
1507 usb_free_urb(acm->read_urbs[i]);
1508 acm_read_buffers_free(acm);
1509 usb_free_urb(acm->ctrlurb);
1511 acm_write_buffers_free(acm);
1513 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1515 acm_release_minor(acm);
1522 static void stop_data_traffic(struct acm *acm)
1526 usb_kill_urb(acm->ctrlurb);
1527 for (i = 0; i < ACM_NW; i++)
1528 usb_kill_urb(acm->wb[i].urb);
1529 for (i = 0; i < acm->rx_buflimit; i++)
1530 usb_kill_urb(acm->read_urbs[i]);
1532 cancel_work_sync(&acm->work);
1535 static void acm_disconnect(struct usb_interface *intf)
1537 struct acm *acm = usb_get_intfdata(intf);
1538 struct usb_device *usb_dev = interface_to_usbdev(intf);
1539 struct tty_struct *tty;
1542 /* sibling interface is already cleaning up */
1546 mutex_lock(&acm->mutex);
1547 acm->disconnected = true;
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);
1554 wake_up_all(&acm->wioctl);
1555 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1556 usb_set_intfdata(acm->control, NULL);
1557 usb_set_intfdata(acm->data, NULL);
1558 mutex_unlock(&acm->mutex);
1560 tty = tty_port_tty_get(&acm->port);
1566 stop_data_traffic(acm);
1568 tty_unregister_device(acm_tty_driver, acm->minor);
1570 usb_free_urb(acm->ctrlurb);
1571 for (i = 0; i < ACM_NW; i++)
1572 usb_free_urb(acm->wb[i].urb);
1573 for (i = 0; i < acm->rx_buflimit; i++)
1574 usb_free_urb(acm->read_urbs[i]);
1575 acm_write_buffers_free(acm);
1576 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1577 acm_read_buffers_free(acm);
1579 if (!acm->combined_interfaces)
1580 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1581 acm->data : acm->control);
1583 tty_port_put(&acm->port);
1587 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1589 struct acm *acm = usb_get_intfdata(intf);
1592 spin_lock_irq(&acm->write_lock);
1593 if (PMSG_IS_AUTO(message)) {
1594 if (acm->transmitting) {
1595 spin_unlock_irq(&acm->write_lock);
1599 cnt = acm->susp_count++;
1600 spin_unlock_irq(&acm->write_lock);
1605 stop_data_traffic(acm);
1610 static int acm_resume(struct usb_interface *intf)
1612 struct acm *acm = usb_get_intfdata(intf);
1616 spin_lock_irq(&acm->write_lock);
1618 if (--acm->susp_count)
1621 if (tty_port_initialized(&acm->port)) {
1622 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1625 urb = usb_get_from_anchor(&acm->delayed);
1629 acm_start_wb(acm, urb->context);
1633 * delayed error checking because we must
1634 * do the write path at all cost
1639 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1642 spin_unlock_irq(&acm->write_lock);
1647 static int acm_reset_resume(struct usb_interface *intf)
1649 struct acm *acm = usb_get_intfdata(intf);
1651 if (tty_port_initialized(&acm->port))
1652 tty_port_tty_hangup(&acm->port, false);
1654 return acm_resume(intf);
1657 #endif /* CONFIG_PM */
1659 #define NOKIA_PCSUITE_ACM_INFO(x) \
1660 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1661 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1662 USB_CDC_ACM_PROTO_VENDOR)
1664 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1665 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1666 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1667 USB_CDC_ACM_PROTO_VENDOR)
1670 * USB driver structure.
1673 static const struct usb_device_id acm_ids[] = {
1674 /* quirky and broken devices */
1675 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1676 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1677 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1678 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1679 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1680 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1682 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1683 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1685 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1686 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1688 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1689 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1691 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1692 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1694 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1695 .driver_info = SINGLE_RX_URB,
1697 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1698 .driver_info = SINGLE_RX_URB, /* firmware bug */
1700 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1701 .driver_info = SINGLE_RX_URB, /* firmware bug */
1703 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1704 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1706 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1707 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1709 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1710 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1712 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1713 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1715 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1716 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1718 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1719 .driver_info = QUIRK_CONTROL_LINE_STATE, },
1720 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1721 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1723 /* Motorola H24 HSPA module: */
1724 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1725 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1726 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1728 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1729 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1731 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1732 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1734 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1735 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1737 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1738 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1740 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1741 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1743 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1744 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1747 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1748 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1749 data interface instead of
1750 communications interface.
1751 Maybe we should define a new
1754 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1755 .driver_info = NO_UNION_NORMAL,
1757 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1758 .driver_info = NO_UNION_NORMAL,
1760 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1761 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1763 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1764 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1767 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1768 .driver_info = CLEAR_HALT_CONDITIONS,
1771 /* Nokia S60 phones expose two ACM channels. The first is
1772 * a modem and is picked up by the standard AT-command
1773 * information below. The second is 'vendor-specific' but
1774 * is treated as a serial device at the S60 end, so we want
1775 * to expose it on Linux too. */
1776 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1777 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1778 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1779 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1780 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1781 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1782 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1783 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1784 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1785 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1786 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1787 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1788 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1789 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1790 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1791 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1792 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1793 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1794 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1795 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1796 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1797 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1798 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1799 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1800 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1801 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1802 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1803 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1804 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1805 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1806 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1807 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1808 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1809 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1810 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1811 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1812 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1813 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1814 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1815 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1816 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1817 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1818 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1819 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1820 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1821 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1822 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1823 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1824 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1825 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1826 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1827 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1828 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1829 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1830 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1831 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1832 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1833 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1835 /* Support for Owen devices */
1836 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1838 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1840 /* Support for Droids MuIn LCD */
1841 { USB_DEVICE(0x04d8, 0x000b),
1842 .driver_info = NO_DATA_INTERFACE,
1845 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1846 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1847 .driver_info = IGNORE_DEVICE,
1849 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1850 .driver_info = IGNORE_DEVICE,
1854 /*Samsung phone in firmware update mode */
1855 { USB_DEVICE(0x04e8, 0x685d),
1856 .driver_info = IGNORE_DEVICE,
1859 /* Exclude Infineon Flash Loader utility */
1860 { USB_DEVICE(0x058b, 0x0041),
1861 .driver_info = IGNORE_DEVICE,
1864 /* control interfaces without any protocol set */
1865 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1866 USB_CDC_PROTO_NONE) },
1868 /* control interfaces with various AT-command sets */
1869 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1870 USB_CDC_ACM_PROTO_AT_V25TER) },
1871 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1872 USB_CDC_ACM_PROTO_AT_PCCA101) },
1873 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1874 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1875 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1876 USB_CDC_ACM_PROTO_AT_GSM) },
1877 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1878 USB_CDC_ACM_PROTO_AT_3G) },
1879 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1880 USB_CDC_ACM_PROTO_AT_CDMA) },
1882 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1883 .driver_info = SEND_ZERO_PACKET,
1889 MODULE_DEVICE_TABLE(usb, acm_ids);
1891 static struct usb_driver acm_driver = {
1894 .disconnect = acm_disconnect,
1896 .suspend = acm_suspend,
1897 .resume = acm_resume,
1898 .reset_resume = acm_reset_resume,
1900 .id_table = acm_ids,
1902 .supports_autosuspend = 1,
1904 .disable_hub_initiated_lpm = 1,
1908 * TTY driver structures.
1911 static const struct tty_operations acm_ops = {
1912 .install = acm_tty_install,
1913 .open = acm_tty_open,
1914 .close = acm_tty_close,
1915 .cleanup = acm_tty_cleanup,
1916 .hangup = acm_tty_hangup,
1917 .write = acm_tty_write,
1918 .put_char = acm_tty_put_char,
1919 .flush_chars = acm_tty_flush_chars,
1920 .write_room = acm_tty_write_room,
1921 .ioctl = acm_tty_ioctl,
1922 .throttle = acm_tty_throttle,
1923 .unthrottle = acm_tty_unthrottle,
1924 .chars_in_buffer = acm_tty_chars_in_buffer,
1925 .break_ctl = acm_tty_break_ctl,
1926 .set_termios = acm_tty_set_termios,
1927 .tiocmget = acm_tty_tiocmget,
1928 .tiocmset = acm_tty_tiocmset,
1935 static int __init acm_init(void)
1938 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1939 if (!acm_tty_driver)
1941 acm_tty_driver->driver_name = "acm",
1942 acm_tty_driver->name = "ttyACM",
1943 acm_tty_driver->major = ACM_TTY_MAJOR,
1944 acm_tty_driver->minor_start = 0,
1945 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1946 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1947 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1948 acm_tty_driver->init_termios = tty_std_termios;
1949 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1951 tty_set_operations(acm_tty_driver, &acm_ops);
1953 retval = tty_register_driver(acm_tty_driver);
1955 put_tty_driver(acm_tty_driver);
1959 retval = usb_register(&acm_driver);
1961 tty_unregister_driver(acm_tty_driver);
1962 put_tty_driver(acm_tty_driver);
1966 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1971 static void __exit acm_exit(void)
1973 usb_deregister(&acm_driver);
1974 tty_unregister_driver(acm_tty_driver);
1975 put_tty_driver(acm_tty_driver);
1976 idr_destroy(&acm_minors);
1979 module_init(acm_init);
1980 module_exit(acm_exit);
1982 MODULE_AUTHOR(DRIVER_AUTHOR);
1983 MODULE_DESCRIPTION(DRIVER_DESC);
1984 MODULE_LICENSE("GPL");
1985 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);