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/list.h>
54 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
55 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
57 static struct usb_driver acm_driver;
58 static struct tty_driver *acm_tty_driver;
59 static struct acm *acm_table[ACM_TTY_MINORS];
61 static DEFINE_MUTEX(acm_table_lock);
68 * Look up an ACM structure by index. If found and not disconnected, increment
69 * its refcount and return it with its mutex held.
71 static struct acm *acm_get_by_index(unsigned index)
75 mutex_lock(&acm_table_lock);
76 acm = acm_table[index];
78 mutex_lock(&acm->mutex);
79 if (acm->disconnected) {
80 mutex_unlock(&acm->mutex);
83 tty_port_get(&acm->port);
84 mutex_unlock(&acm->mutex);
87 mutex_unlock(&acm_table_lock);
92 * Try to find an available minor number and if found, associate it with 'acm'.
94 static int acm_alloc_minor(struct acm *acm)
98 mutex_lock(&acm_table_lock);
99 for (minor = 0; minor < ACM_TTY_MINORS; minor++) {
100 if (!acm_table[minor]) {
101 acm_table[minor] = acm;
105 mutex_unlock(&acm_table_lock);
110 /* Release the minor number associated with 'acm'. */
111 static void acm_release_minor(struct acm *acm)
113 mutex_lock(&acm_table_lock);
114 acm_table[acm->minor] = NULL;
115 mutex_unlock(&acm_table_lock);
119 * Functions for ACM control messages.
122 static int acm_ctrl_msg(struct acm *acm, int request, int value,
127 retval = usb_autopm_get_interface(acm->control);
131 retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
132 request, USB_RT_ACM, value,
133 acm->control->altsetting[0].desc.bInterfaceNumber,
136 dev_dbg(&acm->control->dev,
137 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
138 __func__, request, value, len, retval);
140 usb_autopm_put_interface(acm->control);
142 return retval < 0 ? retval : 0;
145 /* devices aren't required to support these requests.
146 * the cdc acm descriptor tells whether they do...
148 #define acm_set_control(acm, control) \
149 acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
150 #define acm_set_line(acm, line) \
151 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
152 #define acm_send_break(acm, ms) \
153 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
156 * Write buffer management.
157 * All of these assume proper locks taken by the caller.
160 static int acm_wb_alloc(struct acm *acm)
173 wbn = (wbn + 1) % ACM_NW;
179 static int acm_wb_is_avail(struct acm *acm)
185 spin_lock_irqsave(&acm->write_lock, flags);
186 for (i = 0; i < ACM_NW; i++)
188 spin_unlock_irqrestore(&acm->write_lock, flags);
193 * Finish write. Caller must hold acm->write_lock
195 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
199 usb_autopm_put_interface_async(acm->control);
205 * the caller is responsible for locking
208 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
214 wb->urb->transfer_buffer = wb->buf;
215 wb->urb->transfer_dma = wb->dmah;
216 wb->urb->transfer_buffer_length = wb->len;
217 wb->urb->dev = acm->dev;
219 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
221 dev_err(&acm->data->dev,
222 "%s - usb_submit_urb(write bulk) failed: %d\n",
224 acm_write_done(acm, wb);
229 static int acm_write_start(struct acm *acm, int wbn)
232 struct acm_wb *wb = &acm->wb[wbn];
235 spin_lock_irqsave(&acm->write_lock, flags);
238 spin_unlock_irqrestore(&acm->write_lock, flags);
242 dev_vdbg(&acm->data->dev, "%s - susp_count %d\n", __func__,
244 usb_autopm_get_interface_async(acm->control);
245 if (acm->susp_count) {
246 usb_anchor_urb(wb->urb, &acm->delayed);
247 spin_unlock_irqrestore(&acm->write_lock, flags);
250 usb_mark_last_busy(acm->dev);
252 rc = acm_start_wb(acm, wb);
253 spin_unlock_irqrestore(&acm->write_lock, flags);
259 * attributes exported through sysfs
261 static ssize_t show_caps
262 (struct device *dev, struct device_attribute *attr, char *buf)
264 struct usb_interface *intf = to_usb_interface(dev);
265 struct acm *acm = usb_get_intfdata(intf);
267 return sprintf(buf, "%d", acm->ctrl_caps);
269 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
271 static ssize_t show_country_codes
272 (struct device *dev, struct device_attribute *attr, char *buf)
274 struct usb_interface *intf = to_usb_interface(dev);
275 struct acm *acm = usb_get_intfdata(intf);
277 memcpy(buf, acm->country_codes, acm->country_code_size);
278 return acm->country_code_size;
281 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
283 static ssize_t show_country_rel_date
284 (struct device *dev, struct device_attribute *attr, char *buf)
286 struct usb_interface *intf = to_usb_interface(dev);
287 struct acm *acm = usb_get_intfdata(intf);
289 return sprintf(buf, "%d", acm->country_rel_date);
292 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
294 * Interrupt handlers for various ACM device responses
297 /* control interface reports status changes with "interrupt" transfers */
298 static void acm_ctrl_irq(struct urb *urb)
300 struct acm *acm = urb->context;
301 struct usb_cdc_notification *dr = urb->transfer_buffer;
305 int status = urb->status;
314 /* this urb is terminated, clean up */
315 dev_dbg(&acm->control->dev,
316 "%s - urb shutting down with status: %d\n",
320 dev_dbg(&acm->control->dev,
321 "%s - nonzero urb status received: %d\n",
326 usb_mark_last_busy(acm->dev);
328 data = (unsigned char *)(dr + 1);
329 switch (dr->bNotificationType) {
330 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
331 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
332 __func__, dr->wValue);
335 case USB_CDC_NOTIFY_SERIAL_STATE:
336 newctrl = get_unaligned_le16(data);
338 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
339 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
341 tty_port_tty_hangup(&acm->port, false);
344 acm->ctrlin = newctrl;
346 dev_dbg(&acm->control->dev,
347 "%s - input control lines: dcd%c dsr%c break%c "
348 "ring%c framing%c parity%c overrun%c\n",
350 acm->ctrlin & ACM_CTRL_DCD ? '+' : '-',
351 acm->ctrlin & ACM_CTRL_DSR ? '+' : '-',
352 acm->ctrlin & ACM_CTRL_BRK ? '+' : '-',
353 acm->ctrlin & ACM_CTRL_RI ? '+' : '-',
354 acm->ctrlin & ACM_CTRL_FRAMING ? '+' : '-',
355 acm->ctrlin & ACM_CTRL_PARITY ? '+' : '-',
356 acm->ctrlin & ACM_CTRL_OVERRUN ? '+' : '-');
360 dev_dbg(&acm->control->dev,
361 "%s - unknown notification %d received: index %d "
362 "len %d data0 %d data1 %d\n",
364 dr->bNotificationType, dr->wIndex,
365 dr->wLength, data[0], data[1]);
369 retval = usb_submit_urb(urb, GFP_ATOMIC);
371 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
375 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
379 if (!test_and_clear_bit(index, &acm->read_urbs_free))
382 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
384 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
387 dev_err(&acm->data->dev,
388 "%s - usb_submit_urb failed: %d\n",
391 set_bit(index, &acm->read_urbs_free);
398 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
403 for (i = 0; i < acm->rx_buflimit; ++i) {
404 res = acm_submit_read_urb(acm, i, mem_flags);
412 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
414 if (!urb->actual_length)
417 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
419 tty_flip_buffer_push(&acm->port);
422 static void acm_read_bulk_callback(struct urb *urb)
424 struct acm_rb *rb = urb->context;
425 struct acm *acm = rb->instance;
428 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
429 rb->index, urb->actual_length);
430 set_bit(rb->index, &acm->read_urbs_free);
433 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
436 usb_mark_last_busy(acm->dev);
439 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
440 __func__, urb->status);
443 acm_process_read_urb(acm, urb);
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 && !acm->susp_count) {
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;
463 if (urb->status || (urb->actual_length != urb->transfer_buffer_length))
464 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
467 urb->transfer_buffer_length,
470 spin_lock_irqsave(&acm->write_lock, flags);
471 acm_write_done(acm, wb);
472 spin_unlock_irqrestore(&acm->write_lock, flags);
473 schedule_work(&acm->work);
476 static void acm_softint(struct work_struct *work)
478 struct acm *acm = container_of(work, struct acm, work);
480 dev_vdbg(&acm->data->dev, "%s\n", __func__);
482 tty_port_tty_wakeup(&acm->port);
489 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
494 dev_dbg(tty->dev, "%s\n", __func__);
496 acm = acm_get_by_index(tty->index);
500 retval = tty_standard_install(driver, tty);
502 goto error_init_termios;
504 tty->driver_data = acm;
509 tty_port_put(&acm->port);
513 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
515 struct acm *acm = tty->driver_data;
517 dev_dbg(tty->dev, "%s\n", __func__);
519 return tty_port_open(&acm->port, tty, filp);
522 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
524 struct acm *acm = container_of(port, struct acm, port);
525 int retval = -ENODEV;
527 dev_dbg(&acm->control->dev, "%s\n", __func__);
529 mutex_lock(&acm->mutex);
530 if (acm->disconnected)
533 retval = usb_autopm_get_interface(acm->control);
535 goto error_get_interface;
538 * FIXME: Why do we need this? Allocating 64K of physically contiguous
539 * memory is really nasty...
541 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
542 acm->control->needs_remote_wakeup = 1;
544 acm->ctrlurb->dev = acm->dev;
545 if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
546 dev_err(&acm->control->dev,
547 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
548 goto error_submit_urb;
551 acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS;
552 if (acm_set_control(acm, acm->ctrlout) < 0 &&
553 (acm->ctrl_caps & USB_CDC_CAP_LINE))
554 goto error_set_control;
556 usb_autopm_put_interface(acm->control);
559 * Unthrottle device in case the TTY was closed while throttled.
561 spin_lock_irq(&acm->read_lock);
563 acm->throttle_req = 0;
564 spin_unlock_irq(&acm->read_lock);
566 if (acm_submit_read_urbs(acm, GFP_KERNEL))
567 goto error_submit_read_urbs;
569 mutex_unlock(&acm->mutex);
573 error_submit_read_urbs:
575 acm_set_control(acm, acm->ctrlout);
577 usb_kill_urb(acm->ctrlurb);
579 usb_autopm_put_interface(acm->control);
582 mutex_unlock(&acm->mutex);
586 static void acm_port_destruct(struct tty_port *port)
588 struct acm *acm = container_of(port, struct acm, port);
590 dev_dbg(&acm->control->dev, "%s\n", __func__);
592 acm_release_minor(acm);
593 usb_put_intf(acm->control);
594 kfree(acm->country_codes);
598 static void acm_port_shutdown(struct tty_port *port)
600 struct acm *acm = container_of(port, struct acm, port);
605 dev_dbg(&acm->control->dev, "%s\n", __func__);
607 mutex_lock(&acm->mutex);
608 if (!acm->disconnected) {
609 usb_autopm_get_interface(acm->control);
610 acm_set_control(acm, acm->ctrlout = 0);
613 urb = usb_get_from_anchor(&acm->delayed);
618 usb_autopm_put_interface_async(acm->control);
621 usb_kill_urb(acm->ctrlurb);
622 for (i = 0; i < ACM_NW; i++)
623 usb_kill_urb(acm->wb[i].urb);
624 for (i = 0; i < acm->rx_buflimit; i++)
625 usb_kill_urb(acm->read_urbs[i]);
626 acm->control->needs_remote_wakeup = 0;
627 usb_autopm_put_interface(acm->control);
629 mutex_unlock(&acm->mutex);
632 static void acm_tty_cleanup(struct tty_struct *tty)
634 struct acm *acm = tty->driver_data;
635 dev_dbg(&acm->control->dev, "%s\n", __func__);
636 tty_port_put(&acm->port);
639 static void acm_tty_hangup(struct tty_struct *tty)
641 struct acm *acm = tty->driver_data;
642 dev_dbg(&acm->control->dev, "%s\n", __func__);
643 tty_port_hangup(&acm->port);
646 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
648 struct acm *acm = tty->driver_data;
649 dev_dbg(&acm->control->dev, "%s\n", __func__);
650 tty_port_close(&acm->port, tty, filp);
653 static int acm_tty_write(struct tty_struct *tty,
654 const unsigned char *buf, int count)
656 struct acm *acm = tty->driver_data;
665 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
667 spin_lock_irqsave(&acm->write_lock, flags);
668 wbn = acm_wb_alloc(acm);
670 spin_unlock_irqrestore(&acm->write_lock, flags);
675 count = (count > acm->writesize) ? acm->writesize : count;
676 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
677 memcpy(wb->buf, buf, count);
679 spin_unlock_irqrestore(&acm->write_lock, flags);
681 stat = acm_write_start(acm, wbn);
687 static int acm_tty_write_room(struct tty_struct *tty)
689 struct acm *acm = tty->driver_data;
691 * Do not let the line discipline to know that we have a reserve,
692 * or it might get too enthusiastic.
694 return acm_wb_is_avail(acm) ? acm->writesize : 0;
697 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
699 struct acm *acm = tty->driver_data;
701 * if the device was unplugged then any remaining characters fell out
702 * of the connector ;)
704 if (acm->disconnected)
707 * This is inaccurate (overcounts), but it works.
709 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
712 static void acm_tty_throttle(struct tty_struct *tty)
714 struct acm *acm = tty->driver_data;
716 spin_lock_irq(&acm->read_lock);
717 acm->throttle_req = 1;
718 spin_unlock_irq(&acm->read_lock);
721 static void acm_tty_unthrottle(struct tty_struct *tty)
723 struct acm *acm = tty->driver_data;
724 unsigned int was_throttled;
726 spin_lock_irq(&acm->read_lock);
727 was_throttled = acm->throttled;
729 acm->throttle_req = 0;
730 spin_unlock_irq(&acm->read_lock);
733 acm_submit_read_urbs(acm, GFP_KERNEL);
736 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
738 struct acm *acm = tty->driver_data;
741 retval = acm_send_break(acm, state ? 0xffff : 0);
743 dev_dbg(&acm->control->dev, "%s - send break failed\n",
748 static int acm_tty_tiocmget(struct tty_struct *tty)
750 struct acm *acm = tty->driver_data;
752 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
753 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
754 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
755 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
756 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
760 static int acm_tty_tiocmset(struct tty_struct *tty,
761 unsigned int set, unsigned int clear)
763 struct acm *acm = tty->driver_data;
764 unsigned int newctrl;
766 newctrl = acm->ctrlout;
767 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
768 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
769 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
770 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
772 newctrl = (newctrl & ~clear) | set;
774 if (acm->ctrlout == newctrl)
776 return acm_set_control(acm, acm->ctrlout = newctrl);
779 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
781 struct serial_struct tmp;
786 memset(&tmp, 0, sizeof(tmp));
787 tmp.flags = ASYNC_LOW_LATENCY;
788 tmp.xmit_fifo_size = acm->writesize;
789 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
790 tmp.close_delay = acm->port.close_delay / 10;
791 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
792 ASYNC_CLOSING_WAIT_NONE :
793 acm->port.closing_wait / 10;
795 if (copy_to_user(info, &tmp, sizeof(tmp)))
801 static int set_serial_info(struct acm *acm,
802 struct serial_struct __user *newinfo)
804 struct serial_struct new_serial;
805 unsigned int closing_wait, close_delay;
808 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
811 close_delay = new_serial.close_delay * 10;
812 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
813 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
815 mutex_lock(&acm->port.mutex);
817 if (!capable(CAP_SYS_ADMIN)) {
818 if ((close_delay != acm->port.close_delay) ||
819 (closing_wait != acm->port.closing_wait))
822 retval = -EOPNOTSUPP;
824 acm->port.close_delay = close_delay;
825 acm->port.closing_wait = closing_wait;
828 mutex_unlock(&acm->port.mutex);
832 static int acm_tty_ioctl(struct tty_struct *tty,
833 unsigned int cmd, unsigned long arg)
835 struct acm *acm = tty->driver_data;
836 int rv = -ENOIOCTLCMD;
839 case TIOCGSERIAL: /* gets serial port data */
840 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
843 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
850 static void acm_tty_set_termios(struct tty_struct *tty,
851 struct ktermios *termios_old)
853 struct acm *acm = tty->driver_data;
854 struct ktermios *termios = &tty->termios;
855 struct usb_cdc_line_coding newline;
856 int newctrl = acm->ctrlout;
858 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
859 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
860 newline.bParityType = termios->c_cflag & PARENB ?
861 (termios->c_cflag & PARODD ? 1 : 2) +
862 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
863 switch (termios->c_cflag & CSIZE) {
865 newline.bDataBits = 5;
868 newline.bDataBits = 6;
871 newline.bDataBits = 7;
875 newline.bDataBits = 8;
878 /* FIXME: Needs to clear unsupported bits in the termios */
879 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
881 if (!newline.dwDTERate) {
882 newline.dwDTERate = acm->line.dwDTERate;
883 newctrl &= ~ACM_CTRL_DTR;
885 newctrl |= ACM_CTRL_DTR;
887 if (newctrl != acm->ctrlout)
888 acm_set_control(acm, acm->ctrlout = newctrl);
890 if (memcmp(&acm->line, &newline, sizeof newline)) {
891 memcpy(&acm->line, &newline, sizeof newline);
892 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
894 le32_to_cpu(newline.dwDTERate),
895 newline.bCharFormat, newline.bParityType,
897 acm_set_line(acm, &acm->line);
901 static const struct tty_port_operations acm_port_ops = {
902 .shutdown = acm_port_shutdown,
903 .activate = acm_port_activate,
904 .destruct = acm_port_destruct,
908 * USB probe and disconnect routines.
911 /* Little helpers: write/read buffers free */
912 static void acm_write_buffers_free(struct acm *acm)
916 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
918 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
919 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
922 static void acm_read_buffers_free(struct acm *acm)
924 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
927 for (i = 0; i < acm->rx_buflimit; i++)
928 usb_free_coherent(usb_dev, acm->readsize,
929 acm->read_buffers[i].base, acm->read_buffers[i].dma);
932 /* Little helper: write buffers allocate */
933 static int acm_write_buffers_alloc(struct acm *acm)
938 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
939 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
945 usb_free_coherent(acm->dev, acm->writesize,
954 static int acm_probe(struct usb_interface *intf,
955 const struct usb_device_id *id)
957 struct usb_cdc_union_desc *union_header = NULL;
958 struct usb_cdc_country_functional_desc *cfd = NULL;
959 unsigned char *buffer = intf->altsetting->extra;
960 int buflen = intf->altsetting->extralen;
961 struct usb_interface *control_interface;
962 struct usb_interface *data_interface;
963 struct usb_endpoint_descriptor *epctrl = NULL;
964 struct usb_endpoint_descriptor *epread = NULL;
965 struct usb_endpoint_descriptor *epwrite = NULL;
966 struct usb_device *usb_dev = interface_to_usbdev(intf);
969 int ctrlsize, readsize;
971 u8 ac_management_function = 0;
972 u8 call_management_function = 0;
973 int call_interface_num = -1;
974 int data_interface_num = -1;
975 unsigned long quirks;
978 int combined_interfaces = 0;
979 struct device *tty_dev;
983 quirks = (unsigned long)id->driver_info;
985 if (quirks == IGNORE_DEVICE)
988 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
990 /* handle quirks deadly to normal probing*/
991 if (quirks == NO_UNION_NORMAL) {
992 data_interface = usb_ifnum_to_if(usb_dev, 1);
993 control_interface = usb_ifnum_to_if(usb_dev, 0);
994 goto skip_normal_probe;
999 dev_err(&intf->dev, "Weird descriptor references\n");
1004 if (intf->cur_altsetting->endpoint &&
1005 intf->cur_altsetting->endpoint->extralen &&
1006 intf->cur_altsetting->endpoint->extra) {
1008 "Seeking extra descriptors on endpoint\n");
1009 buflen = intf->cur_altsetting->endpoint->extralen;
1010 buffer = intf->cur_altsetting->endpoint->extra;
1013 "Zero length descriptor references\n");
1018 while (buflen > 0) {
1019 if (buffer[1] != USB_DT_CS_INTERFACE) {
1020 dev_err(&intf->dev, "skipping garbage\n");
1024 switch (buffer[2]) {
1025 case USB_CDC_UNION_TYPE: /* we've found it */
1027 dev_err(&intf->dev, "More than one "
1028 "union descriptor, skipping ...\n");
1031 union_header = (struct usb_cdc_union_desc *)buffer;
1033 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1034 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1036 case USB_CDC_HEADER_TYPE: /* maybe check version */
1037 break; /* for now we ignore it */
1038 case USB_CDC_ACM_TYPE:
1039 ac_management_function = buffer[3];
1041 case USB_CDC_CALL_MANAGEMENT_TYPE:
1042 call_management_function = buffer[3];
1043 call_interface_num = buffer[4];
1044 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1045 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1048 /* there are LOTS more CDC descriptors that
1049 * could legitimately be found here.
1051 dev_dbg(&intf->dev, "Ignoring descriptor: "
1052 "type %02x, length %d\n",
1053 buffer[2], buffer[0]);
1057 buflen -= buffer[0];
1058 buffer += buffer[0];
1061 if (!union_header) {
1062 if (call_interface_num > 0) {
1063 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1064 /* quirks for Droids MuIn LCD */
1065 if (quirks & NO_DATA_INTERFACE)
1066 data_interface = usb_ifnum_to_if(usb_dev, 0);
1068 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1069 control_interface = intf;
1071 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1072 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1075 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1076 combined_interfaces = 1;
1077 control_interface = data_interface = intf;
1078 goto look_for_collapsed_interface;
1082 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1083 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1084 if (!control_interface || !data_interface) {
1085 dev_dbg(&intf->dev, "no interfaces\n");
1090 if (data_interface_num != call_interface_num)
1091 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1093 if (control_interface == data_interface) {
1094 /* some broken devices designed for windows work this way */
1095 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1096 combined_interfaces = 1;
1097 /* a popular other OS doesn't use it */
1098 quirks |= NO_CAP_LINE;
1099 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1100 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1103 look_for_collapsed_interface:
1104 for (i = 0; i < 3; i++) {
1105 struct usb_endpoint_descriptor *ep;
1106 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1108 if (usb_endpoint_is_int_in(ep))
1110 else if (usb_endpoint_is_bulk_out(ep))
1112 else if (usb_endpoint_is_bulk_in(ep))
1117 if (!epctrl || !epread || !epwrite)
1120 goto made_compressed_probe;
1125 /*workaround for switched interfaces */
1126 if (data_interface->cur_altsetting->desc.bInterfaceClass
1127 != CDC_DATA_INTERFACE_TYPE) {
1128 if (control_interface->cur_altsetting->desc.bInterfaceClass
1129 == CDC_DATA_INTERFACE_TYPE) {
1130 struct usb_interface *t;
1132 "Your device has switched interfaces.\n");
1133 t = control_interface;
1134 control_interface = data_interface;
1141 /* Accept probe requests only for the control interface */
1142 if (!combined_interfaces && intf != control_interface)
1145 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1146 /* valid in this context */
1147 dev_dbg(&intf->dev, "The data interface isn't available\n");
1152 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1153 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1156 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1157 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1158 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1161 /* workaround for switched endpoints */
1162 if (!usb_endpoint_dir_in(epread)) {
1163 /* descriptors are swapped */
1164 struct usb_endpoint_descriptor *t;
1166 "The data interface has switched endpoints\n");
1171 made_compressed_probe:
1172 dev_dbg(&intf->dev, "interfaces are valid\n");
1174 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1176 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1180 minor = acm_alloc_minor(acm);
1181 if (minor == ACM_TTY_MINORS) {
1182 dev_err(&intf->dev, "no more free acm devices\n");
1187 ctrlsize = usb_endpoint_maxp(epctrl);
1188 readsize = usb_endpoint_maxp(epread) *
1189 (quirks == SINGLE_RX_URB ? 1 : 2);
1190 acm->combined_interfaces = combined_interfaces;
1191 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1192 acm->control = control_interface;
1193 acm->data = data_interface;
1196 acm->ctrl_caps = ac_management_function;
1197 if (quirks & NO_CAP_LINE)
1198 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1199 acm->ctrlsize = ctrlsize;
1200 acm->readsize = readsize;
1201 acm->rx_buflimit = num_rx_buf;
1202 INIT_WORK(&acm->work, acm_softint);
1203 spin_lock_init(&acm->write_lock);
1204 spin_lock_init(&acm->read_lock);
1205 mutex_init(&acm->mutex);
1206 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1207 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1209 acm->bInterval = epread->bInterval;
1210 tty_port_init(&acm->port);
1211 acm->port.ops = &acm_port_ops;
1212 init_usb_anchor(&acm->delayed);
1214 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1216 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1219 acm->ctrl_buffer = buf;
1221 if (acm_write_buffers_alloc(acm) < 0) {
1222 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1226 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1227 if (!acm->ctrlurb) {
1228 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1231 for (i = 0; i < num_rx_buf; i++) {
1232 struct acm_rb *rb = &(acm->read_buffers[i]);
1235 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1238 dev_err(&intf->dev, "out of memory "
1239 "(read bufs usb_alloc_coherent)\n");
1245 urb = usb_alloc_urb(0, GFP_KERNEL);
1248 "out of memory (read urbs usb_alloc_urb)\n");
1251 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1252 urb->transfer_dma = rb->dma;
1253 if (acm->is_int_ep) {
1254 usb_fill_int_urb(urb, acm->dev,
1258 acm_read_bulk_callback, rb,
1261 usb_fill_bulk_urb(urb, acm->dev,
1265 acm_read_bulk_callback, rb);
1268 acm->read_urbs[i] = urb;
1269 __set_bit(i, &acm->read_urbs_free);
1271 for (i = 0; i < ACM_NW; i++) {
1272 struct acm_wb *snd = &(acm->wb[i]);
1274 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1275 if (snd->urb == NULL) {
1277 "out of memory (write urbs usb_alloc_urb)\n");
1281 if (usb_endpoint_xfer_int(epwrite))
1282 usb_fill_int_urb(snd->urb, usb_dev,
1283 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1284 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1286 usb_fill_bulk_urb(snd->urb, usb_dev,
1287 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1288 NULL, acm->writesize, acm_write_bulk, snd);
1289 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1290 snd->instance = acm;
1293 usb_set_intfdata(intf, acm);
1295 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1299 if (cfd) { /* export the country data */
1300 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1301 if (!acm->country_codes)
1302 goto skip_countries;
1303 acm->country_code_size = cfd->bLength - 4;
1304 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1306 acm->country_rel_date = cfd->iCountryCodeRelDate;
1308 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1310 kfree(acm->country_codes);
1311 acm->country_codes = NULL;
1312 acm->country_code_size = 0;
1313 goto skip_countries;
1316 i = device_create_file(&intf->dev,
1317 &dev_attr_iCountryCodeRelDate);
1319 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1320 kfree(acm->country_codes);
1321 acm->country_codes = NULL;
1322 acm->country_code_size = 0;
1323 goto skip_countries;
1328 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1329 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1330 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1331 /* works around buggy devices */
1332 epctrl->bInterval ? epctrl->bInterval : 0xff);
1333 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1334 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1336 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1338 acm_set_control(acm, acm->ctrlout);
1340 acm->line.dwDTERate = cpu_to_le32(9600);
1341 acm->line.bDataBits = 8;
1342 acm_set_line(acm, &acm->line);
1344 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1345 usb_set_intfdata(data_interface, acm);
1347 usb_get_intf(control_interface);
1348 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1349 &control_interface->dev);
1350 if (IS_ERR(tty_dev)) {
1351 rv = PTR_ERR(tty_dev);
1357 if (acm->country_codes) {
1358 device_remove_file(&acm->control->dev,
1359 &dev_attr_wCountryCodes);
1360 device_remove_file(&acm->control->dev,
1361 &dev_attr_iCountryCodeRelDate);
1363 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1365 usb_set_intfdata(intf, NULL);
1366 for (i = 0; i < ACM_NW; i++)
1367 usb_free_urb(acm->wb[i].urb);
1369 for (i = 0; i < num_rx_buf; i++)
1370 usb_free_urb(acm->read_urbs[i]);
1371 acm_read_buffers_free(acm);
1372 usb_free_urb(acm->ctrlurb);
1374 acm_write_buffers_free(acm);
1376 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1378 acm_release_minor(acm);
1384 static void stop_data_traffic(struct acm *acm)
1388 dev_dbg(&acm->control->dev, "%s\n", __func__);
1390 usb_kill_urb(acm->ctrlurb);
1391 for (i = 0; i < ACM_NW; i++)
1392 usb_kill_urb(acm->wb[i].urb);
1393 for (i = 0; i < acm->rx_buflimit; i++)
1394 usb_kill_urb(acm->read_urbs[i]);
1396 cancel_work_sync(&acm->work);
1399 static void acm_disconnect(struct usb_interface *intf)
1401 struct acm *acm = usb_get_intfdata(intf);
1402 struct usb_device *usb_dev = interface_to_usbdev(intf);
1403 struct tty_struct *tty;
1406 dev_dbg(&intf->dev, "%s\n", __func__);
1408 /* sibling interface is already cleaning up */
1412 mutex_lock(&acm->mutex);
1413 acm->disconnected = true;
1414 if (acm->country_codes) {
1415 device_remove_file(&acm->control->dev,
1416 &dev_attr_wCountryCodes);
1417 device_remove_file(&acm->control->dev,
1418 &dev_attr_iCountryCodeRelDate);
1420 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1421 usb_set_intfdata(acm->control, NULL);
1422 usb_set_intfdata(acm->data, NULL);
1423 mutex_unlock(&acm->mutex);
1425 tty = tty_port_tty_get(&acm->port);
1431 stop_data_traffic(acm);
1433 tty_unregister_device(acm_tty_driver, acm->minor);
1435 usb_free_urb(acm->ctrlurb);
1436 for (i = 0; i < ACM_NW; i++)
1437 usb_free_urb(acm->wb[i].urb);
1438 for (i = 0; i < acm->rx_buflimit; i++)
1439 usb_free_urb(acm->read_urbs[i]);
1440 acm_write_buffers_free(acm);
1441 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1442 acm_read_buffers_free(acm);
1444 if (!acm->combined_interfaces)
1445 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1446 acm->data : acm->control);
1448 tty_port_put(&acm->port);
1452 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1454 struct acm *acm = usb_get_intfdata(intf);
1457 spin_lock_irq(&acm->read_lock);
1458 spin_lock(&acm->write_lock);
1459 if (PMSG_IS_AUTO(message)) {
1460 if (acm->transmitting) {
1461 spin_unlock(&acm->write_lock);
1462 spin_unlock_irq(&acm->read_lock);
1466 cnt = acm->susp_count++;
1467 spin_unlock(&acm->write_lock);
1468 spin_unlock_irq(&acm->read_lock);
1473 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1474 stop_data_traffic(acm);
1479 static int acm_resume(struct usb_interface *intf)
1481 struct acm *acm = usb_get_intfdata(intf);
1485 spin_lock_irq(&acm->read_lock);
1486 spin_lock(&acm->write_lock);
1488 if (--acm->susp_count)
1491 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1492 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1495 urb = usb_get_from_anchor(&acm->delayed);
1499 acm_start_wb(acm, urb->context);
1503 * delayed error checking because we must
1504 * do the write path at all cost
1509 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1512 spin_unlock(&acm->write_lock);
1513 spin_unlock_irq(&acm->read_lock);
1518 static int acm_reset_resume(struct usb_interface *intf)
1520 struct acm *acm = usb_get_intfdata(intf);
1522 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1523 tty_port_tty_hangup(&acm->port, false);
1525 return acm_resume(intf);
1528 #endif /* CONFIG_PM */
1530 #define NOKIA_PCSUITE_ACM_INFO(x) \
1531 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1532 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1533 USB_CDC_ACM_PROTO_VENDOR)
1535 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1536 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1537 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1538 USB_CDC_ACM_PROTO_VENDOR)
1541 * USB driver structure.
1544 static const struct usb_device_id acm_ids[] = {
1545 /* quirky and broken devices */
1546 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1547 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1548 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1549 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1551 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1552 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1554 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1555 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1557 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1558 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1560 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1561 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1563 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1564 .driver_info = SINGLE_RX_URB,
1566 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1567 .driver_info = SINGLE_RX_URB, /* firmware bug */
1569 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1570 .driver_info = SINGLE_RX_URB, /* firmware bug */
1572 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1573 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1575 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1576 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1578 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1579 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1581 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1582 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1584 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1585 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1587 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1589 /* Motorola H24 HSPA module: */
1590 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1591 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1592 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1594 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1595 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1597 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1598 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1600 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1601 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1603 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1604 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1606 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1607 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1609 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1610 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1613 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1614 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1615 data interface instead of
1616 communications interface.
1617 Maybe we should define a new
1620 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1621 .driver_info = NO_UNION_NORMAL,
1623 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1624 .driver_info = NO_UNION_NORMAL,
1626 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1627 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1629 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1630 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1633 /* Nokia S60 phones expose two ACM channels. The first is
1634 * a modem and is picked up by the standard AT-command
1635 * information below. The second is 'vendor-specific' but
1636 * is treated as a serial device at the S60 end, so we want
1637 * to expose it on Linux too. */
1638 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1639 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1640 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1641 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1642 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1643 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1644 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1645 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1646 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1647 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1648 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1649 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1650 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1651 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1652 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1653 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1654 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1655 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1656 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1657 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1658 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1659 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1660 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1661 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1662 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1663 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1664 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1665 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1666 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1667 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1668 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1669 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1670 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1671 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1672 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1673 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1674 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1675 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1676 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1677 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1678 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1679 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1680 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1681 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1682 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1683 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1684 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1685 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1686 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1687 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1688 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1689 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1690 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1691 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1692 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1693 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1694 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1695 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1697 /* Support for Owen devices */
1698 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1700 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1702 /* Support Lego NXT using pbLua firmware */
1703 { USB_DEVICE(0x0694, 0xff00),
1704 .driver_info = NOT_A_MODEM,
1707 /* Support for Droids MuIn LCD */
1708 { USB_DEVICE(0x04d8, 0x000b),
1709 .driver_info = NO_DATA_INTERFACE,
1712 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1713 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1714 .driver_info = IGNORE_DEVICE,
1716 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1717 .driver_info = IGNORE_DEVICE,
1721 /* control interfaces without any protocol set */
1722 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1723 USB_CDC_PROTO_NONE) },
1725 /* control interfaces with various AT-command sets */
1726 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1727 USB_CDC_ACM_PROTO_AT_V25TER) },
1728 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1729 USB_CDC_ACM_PROTO_AT_PCCA101) },
1730 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1731 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1732 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1733 USB_CDC_ACM_PROTO_AT_GSM) },
1734 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1735 USB_CDC_ACM_PROTO_AT_3G) },
1736 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1737 USB_CDC_ACM_PROTO_AT_CDMA) },
1742 MODULE_DEVICE_TABLE(usb, acm_ids);
1744 static struct usb_driver acm_driver = {
1747 .disconnect = acm_disconnect,
1749 .suspend = acm_suspend,
1750 .resume = acm_resume,
1751 .reset_resume = acm_reset_resume,
1753 .id_table = acm_ids,
1755 .supports_autosuspend = 1,
1757 .disable_hub_initiated_lpm = 1,
1761 * TTY driver structures.
1764 static const struct tty_operations acm_ops = {
1765 .install = acm_tty_install,
1766 .open = acm_tty_open,
1767 .close = acm_tty_close,
1768 .cleanup = acm_tty_cleanup,
1769 .hangup = acm_tty_hangup,
1770 .write = acm_tty_write,
1771 .write_room = acm_tty_write_room,
1772 .ioctl = acm_tty_ioctl,
1773 .throttle = acm_tty_throttle,
1774 .unthrottle = acm_tty_unthrottle,
1775 .chars_in_buffer = acm_tty_chars_in_buffer,
1776 .break_ctl = acm_tty_break_ctl,
1777 .set_termios = acm_tty_set_termios,
1778 .tiocmget = acm_tty_tiocmget,
1779 .tiocmset = acm_tty_tiocmset,
1786 static int __init acm_init(void)
1789 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1790 if (!acm_tty_driver)
1792 acm_tty_driver->driver_name = "acm",
1793 acm_tty_driver->name = "ttyACM",
1794 acm_tty_driver->major = ACM_TTY_MAJOR,
1795 acm_tty_driver->minor_start = 0,
1796 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1797 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1798 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1799 acm_tty_driver->init_termios = tty_std_termios;
1800 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1802 tty_set_operations(acm_tty_driver, &acm_ops);
1804 retval = tty_register_driver(acm_tty_driver);
1806 put_tty_driver(acm_tty_driver);
1810 retval = usb_register(&acm_driver);
1812 tty_unregister_driver(acm_tty_driver);
1813 put_tty_driver(acm_tty_driver);
1817 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1822 static void __exit acm_exit(void)
1824 usb_deregister(&acm_driver);
1825 tty_unregister_driver(acm_tty_driver);
1826 put_tty_driver(acm_tty_driver);
1829 module_init(acm_init);
1830 module_exit(acm_exit);
1832 MODULE_AUTHOR(DRIVER_AUTHOR);
1833 MODULE_DESCRIPTION(DRIVER_DESC);
1834 MODULE_LICENSE("GPL");
1835 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);