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;
528 dev_dbg(&acm->control->dev, "%s\n", __func__);
530 mutex_lock(&acm->mutex);
531 if (acm->disconnected)
534 retval = usb_autopm_get_interface(acm->control);
536 goto error_get_interface;
539 * FIXME: Why do we need this? Allocating 64K of physically contiguous
540 * memory is really nasty...
542 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
543 acm->control->needs_remote_wakeup = 1;
545 acm->ctrlurb->dev = acm->dev;
546 if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
547 dev_err(&acm->control->dev,
548 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
549 goto error_submit_urb;
552 acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS;
553 if (acm_set_control(acm, acm->ctrlout) < 0 &&
554 (acm->ctrl_caps & USB_CDC_CAP_LINE))
555 goto error_set_control;
557 usb_autopm_put_interface(acm->control);
560 * Unthrottle device in case the TTY was closed while throttled.
562 spin_lock_irq(&acm->read_lock);
564 acm->throttle_req = 0;
565 spin_unlock_irq(&acm->read_lock);
567 if (acm_submit_read_urbs(acm, GFP_KERNEL))
568 goto error_submit_read_urbs;
570 mutex_unlock(&acm->mutex);
574 error_submit_read_urbs:
575 for (i = 0; i < acm->rx_buflimit; i++)
576 usb_kill_urb(acm->read_urbs[i]);
578 acm_set_control(acm, acm->ctrlout);
580 usb_kill_urb(acm->ctrlurb);
582 usb_autopm_put_interface(acm->control);
585 mutex_unlock(&acm->mutex);
589 static void acm_port_destruct(struct tty_port *port)
591 struct acm *acm = container_of(port, struct acm, port);
593 dev_dbg(&acm->control->dev, "%s\n", __func__);
595 acm_release_minor(acm);
596 usb_put_intf(acm->control);
597 kfree(acm->country_codes);
601 static void acm_port_shutdown(struct tty_port *port)
603 struct acm *acm = container_of(port, struct acm, port);
609 dev_dbg(&acm->control->dev, "%s\n", __func__);
611 mutex_lock(&acm->mutex);
612 if (!acm->disconnected) {
613 pm_err = usb_autopm_get_interface(acm->control);
614 acm_set_control(acm, acm->ctrlout = 0);
617 urb = usb_get_from_anchor(&acm->delayed);
622 usb_autopm_put_interface_async(acm->control);
625 usb_kill_urb(acm->ctrlurb);
626 for (i = 0; i < ACM_NW; i++)
627 usb_kill_urb(acm->wb[i].urb);
628 for (i = 0; i < acm->rx_buflimit; i++)
629 usb_kill_urb(acm->read_urbs[i]);
630 acm->control->needs_remote_wakeup = 0;
632 usb_autopm_put_interface(acm->control);
634 mutex_unlock(&acm->mutex);
637 static void acm_tty_cleanup(struct tty_struct *tty)
639 struct acm *acm = tty->driver_data;
640 dev_dbg(&acm->control->dev, "%s\n", __func__);
641 tty_port_put(&acm->port);
644 static void acm_tty_hangup(struct tty_struct *tty)
646 struct acm *acm = tty->driver_data;
647 dev_dbg(&acm->control->dev, "%s\n", __func__);
648 tty_port_hangup(&acm->port);
651 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
653 struct acm *acm = tty->driver_data;
654 dev_dbg(&acm->control->dev, "%s\n", __func__);
655 tty_port_close(&acm->port, tty, filp);
658 static int acm_tty_write(struct tty_struct *tty,
659 const unsigned char *buf, int count)
661 struct acm *acm = tty->driver_data;
670 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
672 spin_lock_irqsave(&acm->write_lock, flags);
673 wbn = acm_wb_alloc(acm);
675 spin_unlock_irqrestore(&acm->write_lock, flags);
680 count = (count > acm->writesize) ? acm->writesize : count;
681 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
682 memcpy(wb->buf, buf, count);
684 spin_unlock_irqrestore(&acm->write_lock, flags);
686 stat = acm_write_start(acm, wbn);
692 static int acm_tty_write_room(struct tty_struct *tty)
694 struct acm *acm = tty->driver_data;
696 * Do not let the line discipline to know that we have a reserve,
697 * or it might get too enthusiastic.
699 return acm_wb_is_avail(acm) ? acm->writesize : 0;
702 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
704 struct acm *acm = tty->driver_data;
706 * if the device was unplugged then any remaining characters fell out
707 * of the connector ;)
709 if (acm->disconnected)
712 * This is inaccurate (overcounts), but it works.
714 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
717 static void acm_tty_throttle(struct tty_struct *tty)
719 struct acm *acm = tty->driver_data;
721 spin_lock_irq(&acm->read_lock);
722 acm->throttle_req = 1;
723 spin_unlock_irq(&acm->read_lock);
726 static void acm_tty_unthrottle(struct tty_struct *tty)
728 struct acm *acm = tty->driver_data;
729 unsigned int was_throttled;
731 spin_lock_irq(&acm->read_lock);
732 was_throttled = acm->throttled;
734 acm->throttle_req = 0;
735 spin_unlock_irq(&acm->read_lock);
738 acm_submit_read_urbs(acm, GFP_KERNEL);
741 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
743 struct acm *acm = tty->driver_data;
746 retval = acm_send_break(acm, state ? 0xffff : 0);
748 dev_dbg(&acm->control->dev, "%s - send break failed\n",
753 static int acm_tty_tiocmget(struct tty_struct *tty)
755 struct acm *acm = tty->driver_data;
757 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
758 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
759 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
760 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
761 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
765 static int acm_tty_tiocmset(struct tty_struct *tty,
766 unsigned int set, unsigned int clear)
768 struct acm *acm = tty->driver_data;
769 unsigned int newctrl;
771 newctrl = acm->ctrlout;
772 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
773 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
774 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
775 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
777 newctrl = (newctrl & ~clear) | set;
779 if (acm->ctrlout == newctrl)
781 return acm_set_control(acm, acm->ctrlout = newctrl);
784 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
786 struct serial_struct tmp;
791 memset(&tmp, 0, sizeof(tmp));
792 tmp.flags = ASYNC_LOW_LATENCY;
793 tmp.xmit_fifo_size = acm->writesize;
794 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
795 tmp.close_delay = acm->port.close_delay / 10;
796 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
797 ASYNC_CLOSING_WAIT_NONE :
798 acm->port.closing_wait / 10;
800 if (copy_to_user(info, &tmp, sizeof(tmp)))
806 static int set_serial_info(struct acm *acm,
807 struct serial_struct __user *newinfo)
809 struct serial_struct new_serial;
810 unsigned int closing_wait, close_delay;
813 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
816 close_delay = new_serial.close_delay * 10;
817 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
818 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
820 mutex_lock(&acm->port.mutex);
822 if (!capable(CAP_SYS_ADMIN)) {
823 if ((close_delay != acm->port.close_delay) ||
824 (closing_wait != acm->port.closing_wait))
827 retval = -EOPNOTSUPP;
829 acm->port.close_delay = close_delay;
830 acm->port.closing_wait = closing_wait;
833 mutex_unlock(&acm->port.mutex);
837 static int acm_tty_ioctl(struct tty_struct *tty,
838 unsigned int cmd, unsigned long arg)
840 struct acm *acm = tty->driver_data;
841 int rv = -ENOIOCTLCMD;
844 case TIOCGSERIAL: /* gets serial port data */
845 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
848 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
855 static void acm_tty_set_termios(struct tty_struct *tty,
856 struct ktermios *termios_old)
858 struct acm *acm = tty->driver_data;
859 struct ktermios *termios = &tty->termios;
860 struct usb_cdc_line_coding newline;
861 int newctrl = acm->ctrlout;
863 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
864 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
865 newline.bParityType = termios->c_cflag & PARENB ?
866 (termios->c_cflag & PARODD ? 1 : 2) +
867 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
868 switch (termios->c_cflag & CSIZE) {
870 newline.bDataBits = 5;
873 newline.bDataBits = 6;
876 newline.bDataBits = 7;
880 newline.bDataBits = 8;
883 /* FIXME: Needs to clear unsupported bits in the termios */
884 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
886 if (C_BAUD(tty) == B0) {
887 newline.dwDTERate = acm->line.dwDTERate;
888 newctrl &= ~ACM_CTRL_DTR;
889 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
890 newctrl |= ACM_CTRL_DTR;
893 if (newctrl != acm->ctrlout)
894 acm_set_control(acm, acm->ctrlout = newctrl);
896 if (memcmp(&acm->line, &newline, sizeof newline)) {
897 memcpy(&acm->line, &newline, sizeof newline);
898 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
900 le32_to_cpu(newline.dwDTERate),
901 newline.bCharFormat, newline.bParityType,
903 acm_set_line(acm, &acm->line);
907 static const struct tty_port_operations acm_port_ops = {
908 .shutdown = acm_port_shutdown,
909 .activate = acm_port_activate,
910 .destruct = acm_port_destruct,
914 * USB probe and disconnect routines.
917 /* Little helpers: write/read buffers free */
918 static void acm_write_buffers_free(struct acm *acm)
922 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
924 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
925 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
928 static void acm_read_buffers_free(struct acm *acm)
930 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
933 for (i = 0; i < acm->rx_buflimit; i++)
934 usb_free_coherent(usb_dev, acm->readsize,
935 acm->read_buffers[i].base, acm->read_buffers[i].dma);
938 /* Little helper: write buffers allocate */
939 static int acm_write_buffers_alloc(struct acm *acm)
944 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
945 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
951 usb_free_coherent(acm->dev, acm->writesize,
960 static int acm_probe(struct usb_interface *intf,
961 const struct usb_device_id *id)
963 struct usb_cdc_union_desc *union_header = NULL;
964 struct usb_cdc_country_functional_desc *cfd = NULL;
965 unsigned char *buffer = intf->altsetting->extra;
966 int buflen = intf->altsetting->extralen;
967 struct usb_interface *control_interface;
968 struct usb_interface *data_interface;
969 struct usb_endpoint_descriptor *epctrl = NULL;
970 struct usb_endpoint_descriptor *epread = NULL;
971 struct usb_endpoint_descriptor *epwrite = NULL;
972 struct usb_device *usb_dev = interface_to_usbdev(intf);
975 int ctrlsize, readsize;
977 u8 ac_management_function = 0;
978 u8 call_management_function = 0;
979 int call_interface_num = -1;
980 int data_interface_num = -1;
981 unsigned long quirks;
984 int combined_interfaces = 0;
985 struct device *tty_dev;
989 quirks = (unsigned long)id->driver_info;
991 if (quirks == IGNORE_DEVICE)
994 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
996 /* handle quirks deadly to normal probing*/
997 if (quirks == NO_UNION_NORMAL) {
998 data_interface = usb_ifnum_to_if(usb_dev, 1);
999 control_interface = usb_ifnum_to_if(usb_dev, 0);
1000 goto skip_normal_probe;
1005 dev_err(&intf->dev, "Weird descriptor references\n");
1010 if (intf->cur_altsetting->endpoint &&
1011 intf->cur_altsetting->endpoint->extralen &&
1012 intf->cur_altsetting->endpoint->extra) {
1014 "Seeking extra descriptors on endpoint\n");
1015 buflen = intf->cur_altsetting->endpoint->extralen;
1016 buffer = intf->cur_altsetting->endpoint->extra;
1019 "Zero length descriptor references\n");
1024 while (buflen > 0) {
1025 if (buffer[1] != USB_DT_CS_INTERFACE) {
1026 dev_err(&intf->dev, "skipping garbage\n");
1030 switch (buffer[2]) {
1031 case USB_CDC_UNION_TYPE: /* we've found it */
1033 dev_err(&intf->dev, "More than one "
1034 "union descriptor, skipping ...\n");
1037 union_header = (struct usb_cdc_union_desc *)buffer;
1039 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1040 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1042 case USB_CDC_HEADER_TYPE: /* maybe check version */
1043 break; /* for now we ignore it */
1044 case USB_CDC_ACM_TYPE:
1045 ac_management_function = buffer[3];
1047 case USB_CDC_CALL_MANAGEMENT_TYPE:
1048 call_management_function = buffer[3];
1049 call_interface_num = buffer[4];
1050 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1051 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1054 /* there are LOTS more CDC descriptors that
1055 * could legitimately be found here.
1057 dev_dbg(&intf->dev, "Ignoring descriptor: "
1058 "type %02x, length %d\n",
1059 buffer[2], buffer[0]);
1063 buflen -= buffer[0];
1064 buffer += buffer[0];
1067 if (!union_header) {
1068 if (call_interface_num > 0) {
1069 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1070 /* quirks for Droids MuIn LCD */
1071 if (quirks & NO_DATA_INTERFACE)
1072 data_interface = usb_ifnum_to_if(usb_dev, 0);
1074 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1075 control_interface = intf;
1077 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1078 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1081 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1082 combined_interfaces = 1;
1083 control_interface = data_interface = intf;
1084 goto look_for_collapsed_interface;
1088 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1089 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1090 if (!control_interface || !data_interface) {
1091 dev_dbg(&intf->dev, "no interfaces\n");
1096 if (data_interface_num != call_interface_num)
1097 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1099 if (control_interface == data_interface) {
1100 /* some broken devices designed for windows work this way */
1101 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1102 combined_interfaces = 1;
1103 /* a popular other OS doesn't use it */
1104 quirks |= NO_CAP_LINE;
1105 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1106 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1109 look_for_collapsed_interface:
1110 for (i = 0; i < 3; i++) {
1111 struct usb_endpoint_descriptor *ep;
1112 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1114 if (usb_endpoint_is_int_in(ep))
1116 else if (usb_endpoint_is_bulk_out(ep))
1118 else if (usb_endpoint_is_bulk_in(ep))
1123 if (!epctrl || !epread || !epwrite)
1126 goto made_compressed_probe;
1131 /*workaround for switched interfaces */
1132 if (data_interface->cur_altsetting->desc.bInterfaceClass
1133 != CDC_DATA_INTERFACE_TYPE) {
1134 if (control_interface->cur_altsetting->desc.bInterfaceClass
1135 == CDC_DATA_INTERFACE_TYPE) {
1136 struct usb_interface *t;
1138 "Your device has switched interfaces.\n");
1139 t = control_interface;
1140 control_interface = data_interface;
1147 /* Accept probe requests only for the control interface */
1148 if (!combined_interfaces && intf != control_interface)
1151 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1152 /* valid in this context */
1153 dev_dbg(&intf->dev, "The data interface isn't available\n");
1158 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1159 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1162 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1163 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1164 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1167 /* workaround for switched endpoints */
1168 if (!usb_endpoint_dir_in(epread)) {
1169 /* descriptors are swapped */
1170 struct usb_endpoint_descriptor *t;
1172 "The data interface has switched endpoints\n");
1177 made_compressed_probe:
1178 dev_dbg(&intf->dev, "interfaces are valid\n");
1180 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1182 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1186 minor = acm_alloc_minor(acm);
1187 if (minor == ACM_TTY_MINORS) {
1188 dev_err(&intf->dev, "no more free acm devices\n");
1193 ctrlsize = usb_endpoint_maxp(epctrl);
1194 readsize = usb_endpoint_maxp(epread) *
1195 (quirks == SINGLE_RX_URB ? 1 : 2);
1196 acm->combined_interfaces = combined_interfaces;
1197 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1198 acm->control = control_interface;
1199 acm->data = data_interface;
1202 acm->ctrl_caps = ac_management_function;
1203 if (quirks & NO_CAP_LINE)
1204 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1205 acm->ctrlsize = ctrlsize;
1206 acm->readsize = readsize;
1207 acm->rx_buflimit = num_rx_buf;
1208 INIT_WORK(&acm->work, acm_softint);
1209 spin_lock_init(&acm->write_lock);
1210 spin_lock_init(&acm->read_lock);
1211 mutex_init(&acm->mutex);
1212 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1213 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1215 acm->bInterval = epread->bInterval;
1216 tty_port_init(&acm->port);
1217 acm->port.ops = &acm_port_ops;
1218 init_usb_anchor(&acm->delayed);
1220 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1222 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1225 acm->ctrl_buffer = buf;
1227 if (acm_write_buffers_alloc(acm) < 0) {
1228 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1232 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1233 if (!acm->ctrlurb) {
1234 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1237 for (i = 0; i < num_rx_buf; i++) {
1238 struct acm_rb *rb = &(acm->read_buffers[i]);
1241 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1244 dev_err(&intf->dev, "out of memory "
1245 "(read bufs usb_alloc_coherent)\n");
1251 urb = usb_alloc_urb(0, GFP_KERNEL);
1254 "out of memory (read urbs usb_alloc_urb)\n");
1257 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1258 urb->transfer_dma = rb->dma;
1259 if (acm->is_int_ep) {
1260 usb_fill_int_urb(urb, acm->dev,
1264 acm_read_bulk_callback, rb,
1267 usb_fill_bulk_urb(urb, acm->dev,
1271 acm_read_bulk_callback, rb);
1274 acm->read_urbs[i] = urb;
1275 __set_bit(i, &acm->read_urbs_free);
1277 for (i = 0; i < ACM_NW; i++) {
1278 struct acm_wb *snd = &(acm->wb[i]);
1280 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1281 if (snd->urb == NULL) {
1283 "out of memory (write urbs usb_alloc_urb)\n");
1287 if (usb_endpoint_xfer_int(epwrite))
1288 usb_fill_int_urb(snd->urb, usb_dev,
1289 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1290 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1292 usb_fill_bulk_urb(snd->urb, usb_dev,
1293 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1294 NULL, acm->writesize, acm_write_bulk, snd);
1295 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1296 snd->instance = acm;
1299 usb_set_intfdata(intf, acm);
1301 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1305 if (cfd) { /* export the country data */
1306 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1307 if (!acm->country_codes)
1308 goto skip_countries;
1309 acm->country_code_size = cfd->bLength - 4;
1310 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1312 acm->country_rel_date = cfd->iCountryCodeRelDate;
1314 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1316 kfree(acm->country_codes);
1317 acm->country_codes = NULL;
1318 acm->country_code_size = 0;
1319 goto skip_countries;
1322 i = device_create_file(&intf->dev,
1323 &dev_attr_iCountryCodeRelDate);
1325 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1326 kfree(acm->country_codes);
1327 acm->country_codes = NULL;
1328 acm->country_code_size = 0;
1329 goto skip_countries;
1334 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1335 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1336 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1337 /* works around buggy devices */
1338 epctrl->bInterval ? epctrl->bInterval : 0xff);
1339 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1340 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1342 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1344 acm_set_control(acm, acm->ctrlout);
1346 acm->line.dwDTERate = cpu_to_le32(9600);
1347 acm->line.bDataBits = 8;
1348 acm_set_line(acm, &acm->line);
1350 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1351 usb_set_intfdata(data_interface, acm);
1353 usb_get_intf(control_interface);
1354 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1355 &control_interface->dev);
1356 if (IS_ERR(tty_dev)) {
1357 rv = PTR_ERR(tty_dev);
1363 if (acm->country_codes) {
1364 device_remove_file(&acm->control->dev,
1365 &dev_attr_wCountryCodes);
1366 device_remove_file(&acm->control->dev,
1367 &dev_attr_iCountryCodeRelDate);
1369 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1371 usb_set_intfdata(intf, NULL);
1372 for (i = 0; i < ACM_NW; i++)
1373 usb_free_urb(acm->wb[i].urb);
1375 for (i = 0; i < num_rx_buf; i++)
1376 usb_free_urb(acm->read_urbs[i]);
1377 acm_read_buffers_free(acm);
1378 usb_free_urb(acm->ctrlurb);
1380 acm_write_buffers_free(acm);
1382 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1384 acm_release_minor(acm);
1390 static void stop_data_traffic(struct acm *acm)
1394 dev_dbg(&acm->control->dev, "%s\n", __func__);
1396 usb_kill_urb(acm->ctrlurb);
1397 for (i = 0; i < ACM_NW; i++)
1398 usb_kill_urb(acm->wb[i].urb);
1399 for (i = 0; i < acm->rx_buflimit; i++)
1400 usb_kill_urb(acm->read_urbs[i]);
1402 cancel_work_sync(&acm->work);
1405 static void acm_disconnect(struct usb_interface *intf)
1407 struct acm *acm = usb_get_intfdata(intf);
1408 struct usb_device *usb_dev = interface_to_usbdev(intf);
1409 struct tty_struct *tty;
1412 dev_dbg(&intf->dev, "%s\n", __func__);
1414 /* sibling interface is already cleaning up */
1418 mutex_lock(&acm->mutex);
1419 acm->disconnected = true;
1420 if (acm->country_codes) {
1421 device_remove_file(&acm->control->dev,
1422 &dev_attr_wCountryCodes);
1423 device_remove_file(&acm->control->dev,
1424 &dev_attr_iCountryCodeRelDate);
1426 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1427 usb_set_intfdata(acm->control, NULL);
1428 usb_set_intfdata(acm->data, NULL);
1429 mutex_unlock(&acm->mutex);
1431 tty = tty_port_tty_get(&acm->port);
1437 stop_data_traffic(acm);
1439 tty_unregister_device(acm_tty_driver, acm->minor);
1441 usb_free_urb(acm->ctrlurb);
1442 for (i = 0; i < ACM_NW; i++)
1443 usb_free_urb(acm->wb[i].urb);
1444 for (i = 0; i < acm->rx_buflimit; i++)
1445 usb_free_urb(acm->read_urbs[i]);
1446 acm_write_buffers_free(acm);
1447 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1448 acm_read_buffers_free(acm);
1450 if (!acm->combined_interfaces)
1451 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1452 acm->data : acm->control);
1454 tty_port_put(&acm->port);
1458 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1460 struct acm *acm = usb_get_intfdata(intf);
1463 spin_lock_irq(&acm->read_lock);
1464 spin_lock(&acm->write_lock);
1465 if (PMSG_IS_AUTO(message)) {
1466 if (acm->transmitting) {
1467 spin_unlock(&acm->write_lock);
1468 spin_unlock_irq(&acm->read_lock);
1472 cnt = acm->susp_count++;
1473 spin_unlock(&acm->write_lock);
1474 spin_unlock_irq(&acm->read_lock);
1479 stop_data_traffic(acm);
1484 static int acm_resume(struct usb_interface *intf)
1486 struct acm *acm = usb_get_intfdata(intf);
1490 spin_lock_irq(&acm->read_lock);
1491 spin_lock(&acm->write_lock);
1493 if (--acm->susp_count)
1496 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1497 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1500 urb = usb_get_from_anchor(&acm->delayed);
1504 acm_start_wb(acm, urb->context);
1508 * delayed error checking because we must
1509 * do the write path at all cost
1514 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1517 spin_unlock(&acm->write_lock);
1518 spin_unlock_irq(&acm->read_lock);
1523 static int acm_reset_resume(struct usb_interface *intf)
1525 struct acm *acm = usb_get_intfdata(intf);
1527 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1528 tty_port_tty_hangup(&acm->port, false);
1530 return acm_resume(intf);
1533 #endif /* CONFIG_PM */
1535 #define NOKIA_PCSUITE_ACM_INFO(x) \
1536 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1537 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1538 USB_CDC_ACM_PROTO_VENDOR)
1540 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1541 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1542 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1543 USB_CDC_ACM_PROTO_VENDOR)
1546 * USB driver structure.
1549 static const struct usb_device_id acm_ids[] = {
1550 /* quirky and broken devices */
1551 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1552 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1553 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1554 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1556 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1557 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1559 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1560 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1562 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1563 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1565 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1566 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1568 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1569 .driver_info = SINGLE_RX_URB,
1571 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1572 .driver_info = SINGLE_RX_URB, /* firmware bug */
1574 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1575 .driver_info = SINGLE_RX_URB, /* firmware bug */
1577 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1578 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1580 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1581 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1583 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1584 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1586 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1587 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1589 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1590 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1592 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1593 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1595 /* Motorola H24 HSPA module: */
1596 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1597 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1598 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1600 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1601 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1603 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1604 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1606 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1607 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1609 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1610 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1612 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1613 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1615 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1616 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1619 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1620 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1621 data interface instead of
1622 communications interface.
1623 Maybe we should define a new
1626 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1627 .driver_info = NO_UNION_NORMAL,
1629 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1630 .driver_info = NO_UNION_NORMAL,
1632 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1633 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1635 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1636 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1639 /* Nokia S60 phones expose two ACM channels. The first is
1640 * a modem and is picked up by the standard AT-command
1641 * information below. The second is 'vendor-specific' but
1642 * is treated as a serial device at the S60 end, so we want
1643 * to expose it on Linux too. */
1644 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1645 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1646 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1647 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1648 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1649 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1650 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1651 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1652 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1653 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1654 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1655 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1656 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1657 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1658 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1659 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1660 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1661 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1662 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1663 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1664 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1665 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1666 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1667 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1668 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1669 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1670 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1671 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1672 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1673 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1674 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1675 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1676 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1677 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1678 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1679 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1680 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1681 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1682 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1683 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1684 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1685 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1686 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1687 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1688 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1689 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1690 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1691 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1692 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1693 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1694 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1695 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1696 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1697 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1698 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1699 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1700 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1701 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1703 /* Support for Owen devices */
1704 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1706 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1708 /* Support Lego NXT using pbLua firmware */
1709 { USB_DEVICE(0x0694, 0xff00),
1710 .driver_info = NOT_A_MODEM,
1713 /* Support for Droids MuIn LCD */
1714 { USB_DEVICE(0x04d8, 0x000b),
1715 .driver_info = NO_DATA_INTERFACE,
1718 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1719 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1720 .driver_info = IGNORE_DEVICE,
1722 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1723 .driver_info = IGNORE_DEVICE,
1727 /* control interfaces without any protocol set */
1728 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1729 USB_CDC_PROTO_NONE) },
1731 /* control interfaces with various AT-command sets */
1732 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1733 USB_CDC_ACM_PROTO_AT_V25TER) },
1734 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1735 USB_CDC_ACM_PROTO_AT_PCCA101) },
1736 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1737 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1738 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1739 USB_CDC_ACM_PROTO_AT_GSM) },
1740 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1741 USB_CDC_ACM_PROTO_AT_3G) },
1742 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1743 USB_CDC_ACM_PROTO_AT_CDMA) },
1748 MODULE_DEVICE_TABLE(usb, acm_ids);
1750 static struct usb_driver acm_driver = {
1753 .disconnect = acm_disconnect,
1755 .suspend = acm_suspend,
1756 .resume = acm_resume,
1757 .reset_resume = acm_reset_resume,
1759 .id_table = acm_ids,
1761 .supports_autosuspend = 1,
1763 .disable_hub_initiated_lpm = 1,
1767 * TTY driver structures.
1770 static const struct tty_operations acm_ops = {
1771 .install = acm_tty_install,
1772 .open = acm_tty_open,
1773 .close = acm_tty_close,
1774 .cleanup = acm_tty_cleanup,
1775 .hangup = acm_tty_hangup,
1776 .write = acm_tty_write,
1777 .write_room = acm_tty_write_room,
1778 .ioctl = acm_tty_ioctl,
1779 .throttle = acm_tty_throttle,
1780 .unthrottle = acm_tty_unthrottle,
1781 .chars_in_buffer = acm_tty_chars_in_buffer,
1782 .break_ctl = acm_tty_break_ctl,
1783 .set_termios = acm_tty_set_termios,
1784 .tiocmget = acm_tty_tiocmget,
1785 .tiocmset = acm_tty_tiocmset,
1792 static int __init acm_init(void)
1795 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1796 if (!acm_tty_driver)
1798 acm_tty_driver->driver_name = "acm",
1799 acm_tty_driver->name = "ttyACM",
1800 acm_tty_driver->major = ACM_TTY_MAJOR,
1801 acm_tty_driver->minor_start = 0,
1802 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1803 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1804 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1805 acm_tty_driver->init_termios = tty_std_termios;
1806 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1808 tty_set_operations(acm_tty_driver, &acm_ops);
1810 retval = tty_register_driver(acm_tty_driver);
1812 put_tty_driver(acm_tty_driver);
1816 retval = usb_register(&acm_driver);
1818 tty_unregister_driver(acm_tty_driver);
1819 put_tty_driver(acm_tty_driver);
1823 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1828 static void __exit acm_exit(void)
1830 usb_deregister(&acm_driver);
1831 tty_unregister_driver(acm_tty_driver);
1832 put_tty_driver(acm_tty_driver);
1835 module_init(acm_init);
1836 module_exit(acm_exit);
1838 MODULE_AUTHOR(DRIVER_AUTHOR);
1839 MODULE_DESCRIPTION(DRIVER_DESC);
1840 MODULE_LICENSE("GPL");
1841 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);