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 (!newline.dwDTERate) {
887 newline.dwDTERate = acm->line.dwDTERate;
888 newctrl &= ~ACM_CTRL_DTR;
890 newctrl |= ACM_CTRL_DTR;
892 if (newctrl != acm->ctrlout)
893 acm_set_control(acm, acm->ctrlout = newctrl);
895 if (memcmp(&acm->line, &newline, sizeof newline)) {
896 memcpy(&acm->line, &newline, sizeof newline);
897 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
899 le32_to_cpu(newline.dwDTERate),
900 newline.bCharFormat, newline.bParityType,
902 acm_set_line(acm, &acm->line);
906 static const struct tty_port_operations acm_port_ops = {
907 .shutdown = acm_port_shutdown,
908 .activate = acm_port_activate,
909 .destruct = acm_port_destruct,
913 * USB probe and disconnect routines.
916 /* Little helpers: write/read buffers free */
917 static void acm_write_buffers_free(struct acm *acm)
921 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
923 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
924 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
927 static void acm_read_buffers_free(struct acm *acm)
929 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
932 for (i = 0; i < acm->rx_buflimit; i++)
933 usb_free_coherent(usb_dev, acm->readsize,
934 acm->read_buffers[i].base, acm->read_buffers[i].dma);
937 /* Little helper: write buffers allocate */
938 static int acm_write_buffers_alloc(struct acm *acm)
943 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
944 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
950 usb_free_coherent(acm->dev, acm->writesize,
959 static int acm_probe(struct usb_interface *intf,
960 const struct usb_device_id *id)
962 struct usb_cdc_union_desc *union_header = NULL;
963 struct usb_cdc_country_functional_desc *cfd = NULL;
964 unsigned char *buffer = intf->altsetting->extra;
965 int buflen = intf->altsetting->extralen;
966 struct usb_interface *control_interface;
967 struct usb_interface *data_interface;
968 struct usb_endpoint_descriptor *epctrl = NULL;
969 struct usb_endpoint_descriptor *epread = NULL;
970 struct usb_endpoint_descriptor *epwrite = NULL;
971 struct usb_device *usb_dev = interface_to_usbdev(intf);
974 int ctrlsize, readsize;
976 u8 ac_management_function = 0;
977 u8 call_management_function = 0;
978 int call_interface_num = -1;
979 int data_interface_num = -1;
980 unsigned long quirks;
983 int combined_interfaces = 0;
984 struct device *tty_dev;
988 quirks = (unsigned long)id->driver_info;
990 if (quirks == IGNORE_DEVICE)
993 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
995 /* handle quirks deadly to normal probing*/
996 if (quirks == NO_UNION_NORMAL) {
997 data_interface = usb_ifnum_to_if(usb_dev, 1);
998 control_interface = usb_ifnum_to_if(usb_dev, 0);
999 goto skip_normal_probe;
1004 dev_err(&intf->dev, "Weird descriptor references\n");
1009 if (intf->cur_altsetting->endpoint &&
1010 intf->cur_altsetting->endpoint->extralen &&
1011 intf->cur_altsetting->endpoint->extra) {
1013 "Seeking extra descriptors on endpoint\n");
1014 buflen = intf->cur_altsetting->endpoint->extralen;
1015 buffer = intf->cur_altsetting->endpoint->extra;
1018 "Zero length descriptor references\n");
1023 while (buflen > 0) {
1024 if (buffer[1] != USB_DT_CS_INTERFACE) {
1025 dev_err(&intf->dev, "skipping garbage\n");
1029 switch (buffer[2]) {
1030 case USB_CDC_UNION_TYPE: /* we've found it */
1032 dev_err(&intf->dev, "More than one "
1033 "union descriptor, skipping ...\n");
1036 union_header = (struct usb_cdc_union_desc *)buffer;
1038 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1039 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1041 case USB_CDC_HEADER_TYPE: /* maybe check version */
1042 break; /* for now we ignore it */
1043 case USB_CDC_ACM_TYPE:
1044 ac_management_function = buffer[3];
1046 case USB_CDC_CALL_MANAGEMENT_TYPE:
1047 call_management_function = buffer[3];
1048 call_interface_num = buffer[4];
1049 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1050 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1053 /* there are LOTS more CDC descriptors that
1054 * could legitimately be found here.
1056 dev_dbg(&intf->dev, "Ignoring descriptor: "
1057 "type %02x, length %d\n",
1058 buffer[2], buffer[0]);
1062 buflen -= buffer[0];
1063 buffer += buffer[0];
1066 if (!union_header) {
1067 if (call_interface_num > 0) {
1068 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1069 /* quirks for Droids MuIn LCD */
1070 if (quirks & NO_DATA_INTERFACE)
1071 data_interface = usb_ifnum_to_if(usb_dev, 0);
1073 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1074 control_interface = intf;
1076 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1077 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1080 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1081 combined_interfaces = 1;
1082 control_interface = data_interface = intf;
1083 goto look_for_collapsed_interface;
1087 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1088 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1089 if (!control_interface || !data_interface) {
1090 dev_dbg(&intf->dev, "no interfaces\n");
1095 if (data_interface_num != call_interface_num)
1096 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1098 if (control_interface == data_interface) {
1099 /* some broken devices designed for windows work this way */
1100 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1101 combined_interfaces = 1;
1102 /* a popular other OS doesn't use it */
1103 quirks |= NO_CAP_LINE;
1104 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1105 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1108 look_for_collapsed_interface:
1109 for (i = 0; i < 3; i++) {
1110 struct usb_endpoint_descriptor *ep;
1111 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1113 if (usb_endpoint_is_int_in(ep))
1115 else if (usb_endpoint_is_bulk_out(ep))
1117 else if (usb_endpoint_is_bulk_in(ep))
1122 if (!epctrl || !epread || !epwrite)
1125 goto made_compressed_probe;
1130 /*workaround for switched interfaces */
1131 if (data_interface->cur_altsetting->desc.bInterfaceClass
1132 != CDC_DATA_INTERFACE_TYPE) {
1133 if (control_interface->cur_altsetting->desc.bInterfaceClass
1134 == CDC_DATA_INTERFACE_TYPE) {
1135 struct usb_interface *t;
1137 "Your device has switched interfaces.\n");
1138 t = control_interface;
1139 control_interface = data_interface;
1146 /* Accept probe requests only for the control interface */
1147 if (!combined_interfaces && intf != control_interface)
1150 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1151 /* valid in this context */
1152 dev_dbg(&intf->dev, "The data interface isn't available\n");
1157 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1158 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1161 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1162 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1163 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1166 /* workaround for switched endpoints */
1167 if (!usb_endpoint_dir_in(epread)) {
1168 /* descriptors are swapped */
1169 struct usb_endpoint_descriptor *t;
1171 "The data interface has switched endpoints\n");
1176 made_compressed_probe:
1177 dev_dbg(&intf->dev, "interfaces are valid\n");
1179 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1181 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1185 minor = acm_alloc_minor(acm);
1186 if (minor == ACM_TTY_MINORS) {
1187 dev_err(&intf->dev, "no more free acm devices\n");
1192 ctrlsize = usb_endpoint_maxp(epctrl);
1193 readsize = usb_endpoint_maxp(epread) *
1194 (quirks == SINGLE_RX_URB ? 1 : 2);
1195 acm->combined_interfaces = combined_interfaces;
1196 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1197 acm->control = control_interface;
1198 acm->data = data_interface;
1201 acm->ctrl_caps = ac_management_function;
1202 if (quirks & NO_CAP_LINE)
1203 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1204 acm->ctrlsize = ctrlsize;
1205 acm->readsize = readsize;
1206 acm->rx_buflimit = num_rx_buf;
1207 INIT_WORK(&acm->work, acm_softint);
1208 spin_lock_init(&acm->write_lock);
1209 spin_lock_init(&acm->read_lock);
1210 mutex_init(&acm->mutex);
1211 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1212 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1214 acm->bInterval = epread->bInterval;
1215 tty_port_init(&acm->port);
1216 acm->port.ops = &acm_port_ops;
1217 init_usb_anchor(&acm->delayed);
1219 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1221 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1224 acm->ctrl_buffer = buf;
1226 if (acm_write_buffers_alloc(acm) < 0) {
1227 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1231 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1232 if (!acm->ctrlurb) {
1233 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1236 for (i = 0; i < num_rx_buf; i++) {
1237 struct acm_rb *rb = &(acm->read_buffers[i]);
1240 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1243 dev_err(&intf->dev, "out of memory "
1244 "(read bufs usb_alloc_coherent)\n");
1250 urb = usb_alloc_urb(0, GFP_KERNEL);
1253 "out of memory (read urbs usb_alloc_urb)\n");
1256 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1257 urb->transfer_dma = rb->dma;
1258 if (acm->is_int_ep) {
1259 usb_fill_int_urb(urb, acm->dev,
1263 acm_read_bulk_callback, rb,
1266 usb_fill_bulk_urb(urb, acm->dev,
1270 acm_read_bulk_callback, rb);
1273 acm->read_urbs[i] = urb;
1274 __set_bit(i, &acm->read_urbs_free);
1276 for (i = 0; i < ACM_NW; i++) {
1277 struct acm_wb *snd = &(acm->wb[i]);
1279 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1280 if (snd->urb == NULL) {
1282 "out of memory (write urbs usb_alloc_urb)\n");
1286 if (usb_endpoint_xfer_int(epwrite))
1287 usb_fill_int_urb(snd->urb, usb_dev,
1288 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1289 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1291 usb_fill_bulk_urb(snd->urb, usb_dev,
1292 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1293 NULL, acm->writesize, acm_write_bulk, snd);
1294 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1295 snd->instance = acm;
1298 usb_set_intfdata(intf, acm);
1300 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1304 if (cfd) { /* export the country data */
1305 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1306 if (!acm->country_codes)
1307 goto skip_countries;
1308 acm->country_code_size = cfd->bLength - 4;
1309 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1311 acm->country_rel_date = cfd->iCountryCodeRelDate;
1313 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1315 kfree(acm->country_codes);
1316 acm->country_codes = NULL;
1317 acm->country_code_size = 0;
1318 goto skip_countries;
1321 i = device_create_file(&intf->dev,
1322 &dev_attr_iCountryCodeRelDate);
1324 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1325 kfree(acm->country_codes);
1326 acm->country_codes = NULL;
1327 acm->country_code_size = 0;
1328 goto skip_countries;
1333 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1334 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1335 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1336 /* works around buggy devices */
1337 epctrl->bInterval ? epctrl->bInterval : 0xff);
1338 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1339 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1341 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1343 acm_set_control(acm, acm->ctrlout);
1345 acm->line.dwDTERate = cpu_to_le32(9600);
1346 acm->line.bDataBits = 8;
1347 acm_set_line(acm, &acm->line);
1349 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1350 usb_set_intfdata(data_interface, acm);
1352 usb_get_intf(control_interface);
1353 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1354 &control_interface->dev);
1355 if (IS_ERR(tty_dev)) {
1356 rv = PTR_ERR(tty_dev);
1362 if (acm->country_codes) {
1363 device_remove_file(&acm->control->dev,
1364 &dev_attr_wCountryCodes);
1365 device_remove_file(&acm->control->dev,
1366 &dev_attr_iCountryCodeRelDate);
1368 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1370 usb_set_intfdata(intf, NULL);
1371 for (i = 0; i < ACM_NW; i++)
1372 usb_free_urb(acm->wb[i].urb);
1374 for (i = 0; i < num_rx_buf; i++)
1375 usb_free_urb(acm->read_urbs[i]);
1376 acm_read_buffers_free(acm);
1377 usb_free_urb(acm->ctrlurb);
1379 acm_write_buffers_free(acm);
1381 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1383 acm_release_minor(acm);
1389 static void stop_data_traffic(struct acm *acm)
1393 dev_dbg(&acm->control->dev, "%s\n", __func__);
1395 usb_kill_urb(acm->ctrlurb);
1396 for (i = 0; i < ACM_NW; i++)
1397 usb_kill_urb(acm->wb[i].urb);
1398 for (i = 0; i < acm->rx_buflimit; i++)
1399 usb_kill_urb(acm->read_urbs[i]);
1401 cancel_work_sync(&acm->work);
1404 static void acm_disconnect(struct usb_interface *intf)
1406 struct acm *acm = usb_get_intfdata(intf);
1407 struct usb_device *usb_dev = interface_to_usbdev(intf);
1408 struct tty_struct *tty;
1411 dev_dbg(&intf->dev, "%s\n", __func__);
1413 /* sibling interface is already cleaning up */
1417 mutex_lock(&acm->mutex);
1418 acm->disconnected = true;
1419 if (acm->country_codes) {
1420 device_remove_file(&acm->control->dev,
1421 &dev_attr_wCountryCodes);
1422 device_remove_file(&acm->control->dev,
1423 &dev_attr_iCountryCodeRelDate);
1425 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1426 usb_set_intfdata(acm->control, NULL);
1427 usb_set_intfdata(acm->data, NULL);
1428 mutex_unlock(&acm->mutex);
1430 tty = tty_port_tty_get(&acm->port);
1436 stop_data_traffic(acm);
1438 tty_unregister_device(acm_tty_driver, acm->minor);
1440 usb_free_urb(acm->ctrlurb);
1441 for (i = 0; i < ACM_NW; i++)
1442 usb_free_urb(acm->wb[i].urb);
1443 for (i = 0; i < acm->rx_buflimit; i++)
1444 usb_free_urb(acm->read_urbs[i]);
1445 acm_write_buffers_free(acm);
1446 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1447 acm_read_buffers_free(acm);
1449 if (!acm->combined_interfaces)
1450 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1451 acm->data : acm->control);
1453 tty_port_put(&acm->port);
1457 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1459 struct acm *acm = usb_get_intfdata(intf);
1462 spin_lock_irq(&acm->read_lock);
1463 spin_lock(&acm->write_lock);
1464 if (PMSG_IS_AUTO(message)) {
1465 if (acm->transmitting) {
1466 spin_unlock(&acm->write_lock);
1467 spin_unlock_irq(&acm->read_lock);
1471 cnt = acm->susp_count++;
1472 spin_unlock(&acm->write_lock);
1473 spin_unlock_irq(&acm->read_lock);
1478 stop_data_traffic(acm);
1483 static int acm_resume(struct usb_interface *intf)
1485 struct acm *acm = usb_get_intfdata(intf);
1489 spin_lock_irq(&acm->read_lock);
1490 spin_lock(&acm->write_lock);
1492 if (--acm->susp_count)
1495 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1496 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1499 urb = usb_get_from_anchor(&acm->delayed);
1503 acm_start_wb(acm, urb->context);
1507 * delayed error checking because we must
1508 * do the write path at all cost
1513 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1516 spin_unlock(&acm->write_lock);
1517 spin_unlock_irq(&acm->read_lock);
1522 static int acm_reset_resume(struct usb_interface *intf)
1524 struct acm *acm = usb_get_intfdata(intf);
1526 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1527 tty_port_tty_hangup(&acm->port, false);
1529 return acm_resume(intf);
1532 #endif /* CONFIG_PM */
1534 #define NOKIA_PCSUITE_ACM_INFO(x) \
1535 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1536 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1537 USB_CDC_ACM_PROTO_VENDOR)
1539 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1540 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1541 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1542 USB_CDC_ACM_PROTO_VENDOR)
1545 * USB driver structure.
1548 static const struct usb_device_id acm_ids[] = {
1549 /* quirky and broken devices */
1550 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1551 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1552 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1553 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1555 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1556 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1558 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1559 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1561 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1562 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1564 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1565 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1567 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1568 .driver_info = SINGLE_RX_URB,
1570 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1571 .driver_info = SINGLE_RX_URB, /* firmware bug */
1573 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1574 .driver_info = SINGLE_RX_URB, /* firmware bug */
1576 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1577 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1579 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1580 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1582 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1583 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1585 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1586 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1588 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1589 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1591 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1593 /* Motorola H24 HSPA module: */
1594 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1595 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1596 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1598 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1599 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1601 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1602 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1604 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1605 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1607 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1608 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1610 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1611 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1613 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1614 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1617 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1618 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1619 data interface instead of
1620 communications interface.
1621 Maybe we should define a new
1624 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1625 .driver_info = NO_UNION_NORMAL,
1627 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1628 .driver_info = NO_UNION_NORMAL,
1630 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1631 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1633 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1634 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1637 /* Nokia S60 phones expose two ACM channels. The first is
1638 * a modem and is picked up by the standard AT-command
1639 * information below. The second is 'vendor-specific' but
1640 * is treated as a serial device at the S60 end, so we want
1641 * to expose it on Linux too. */
1642 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1643 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1644 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1645 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1646 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1647 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1648 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1649 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1650 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1651 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1652 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1653 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1654 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1655 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1656 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1657 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1658 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1659 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1660 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1661 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1662 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1663 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1664 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1665 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1666 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1667 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1668 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1669 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1670 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1671 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1672 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1673 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1674 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1675 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1676 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1677 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1678 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1679 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1680 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1681 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1682 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1683 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1684 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1685 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1686 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1687 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1688 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1689 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1690 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1691 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1692 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1693 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1694 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1695 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1696 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1697 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1698 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1699 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1701 /* Support for Owen devices */
1702 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1704 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1706 /* Support Lego NXT using pbLua firmware */
1707 { USB_DEVICE(0x0694, 0xff00),
1708 .driver_info = NOT_A_MODEM,
1711 /* Support for Droids MuIn LCD */
1712 { USB_DEVICE(0x04d8, 0x000b),
1713 .driver_info = NO_DATA_INTERFACE,
1716 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1717 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1718 .driver_info = IGNORE_DEVICE,
1720 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1721 .driver_info = IGNORE_DEVICE,
1725 /* control interfaces without any protocol set */
1726 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1727 USB_CDC_PROTO_NONE) },
1729 /* control interfaces with various AT-command sets */
1730 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1731 USB_CDC_ACM_PROTO_AT_V25TER) },
1732 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1733 USB_CDC_ACM_PROTO_AT_PCCA101) },
1734 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1735 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1736 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1737 USB_CDC_ACM_PROTO_AT_GSM) },
1738 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1739 USB_CDC_ACM_PROTO_AT_3G) },
1740 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1741 USB_CDC_ACM_PROTO_AT_CDMA) },
1746 MODULE_DEVICE_TABLE(usb, acm_ids);
1748 static struct usb_driver acm_driver = {
1751 .disconnect = acm_disconnect,
1753 .suspend = acm_suspend,
1754 .resume = acm_resume,
1755 .reset_resume = acm_reset_resume,
1757 .id_table = acm_ids,
1759 .supports_autosuspend = 1,
1761 .disable_hub_initiated_lpm = 1,
1765 * TTY driver structures.
1768 static const struct tty_operations acm_ops = {
1769 .install = acm_tty_install,
1770 .open = acm_tty_open,
1771 .close = acm_tty_close,
1772 .cleanup = acm_tty_cleanup,
1773 .hangup = acm_tty_hangup,
1774 .write = acm_tty_write,
1775 .write_room = acm_tty_write_room,
1776 .ioctl = acm_tty_ioctl,
1777 .throttle = acm_tty_throttle,
1778 .unthrottle = acm_tty_unthrottle,
1779 .chars_in_buffer = acm_tty_chars_in_buffer,
1780 .break_ctl = acm_tty_break_ctl,
1781 .set_termios = acm_tty_set_termios,
1782 .tiocmget = acm_tty_tiocmget,
1783 .tiocmset = acm_tty_tiocmset,
1790 static int __init acm_init(void)
1793 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1794 if (!acm_tty_driver)
1796 acm_tty_driver->driver_name = "acm",
1797 acm_tty_driver->name = "ttyACM",
1798 acm_tty_driver->major = ACM_TTY_MAJOR,
1799 acm_tty_driver->minor_start = 0,
1800 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1801 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1802 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1803 acm_tty_driver->init_termios = tty_std_termios;
1804 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1806 tty_set_operations(acm_tty_driver, &acm_ops);
1808 retval = tty_register_driver(acm_tty_driver);
1810 put_tty_driver(acm_tty_driver);
1814 retval = usb_register(&acm_driver);
1816 tty_unregister_driver(acm_tty_driver);
1817 put_tty_driver(acm_tty_driver);
1821 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1826 static void __exit acm_exit(void)
1828 usb_deregister(&acm_driver);
1829 tty_unregister_driver(acm_tty_driver);
1830 put_tty_driver(acm_tty_driver);
1833 module_init(acm_init);
1834 module_exit(acm_exit);
1836 MODULE_AUTHOR(DRIVER_AUTHOR);
1837 MODULE_DESCRIPTION(DRIVER_DESC);
1838 MODULE_LICENSE("GPL");
1839 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);