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);
230 * attributes exported through sysfs
232 static ssize_t show_caps
233 (struct device *dev, struct device_attribute *attr, char *buf)
235 struct usb_interface *intf = to_usb_interface(dev);
236 struct acm *acm = usb_get_intfdata(intf);
238 return sprintf(buf, "%d", acm->ctrl_caps);
240 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
242 static ssize_t show_country_codes
243 (struct device *dev, struct device_attribute *attr, char *buf)
245 struct usb_interface *intf = to_usb_interface(dev);
246 struct acm *acm = usb_get_intfdata(intf);
248 memcpy(buf, acm->country_codes, acm->country_code_size);
249 return acm->country_code_size;
252 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
254 static ssize_t show_country_rel_date
255 (struct device *dev, struct device_attribute *attr, char *buf)
257 struct usb_interface *intf = to_usb_interface(dev);
258 struct acm *acm = usb_get_intfdata(intf);
260 return sprintf(buf, "%d", acm->country_rel_date);
263 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
265 * Interrupt handlers for various ACM device responses
268 /* control interface reports status changes with "interrupt" transfers */
269 static void acm_ctrl_irq(struct urb *urb)
271 struct acm *acm = urb->context;
272 struct usb_cdc_notification *dr = urb->transfer_buffer;
277 int status = urb->status;
286 /* this urb is terminated, clean up */
287 dev_dbg(&acm->control->dev,
288 "%s - urb shutting down with status: %d\n",
292 dev_dbg(&acm->control->dev,
293 "%s - nonzero urb status received: %d\n",
298 usb_mark_last_busy(acm->dev);
300 data = (unsigned char *)(dr + 1);
301 switch (dr->bNotificationType) {
302 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
303 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
304 __func__, dr->wValue);
307 case USB_CDC_NOTIFY_SERIAL_STATE:
308 newctrl = get_unaligned_le16(data);
310 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
311 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
313 tty_port_tty_hangup(&acm->port, false);
316 difference = acm->ctrlin ^ newctrl;
317 spin_lock(&acm->read_lock);
318 acm->ctrlin = newctrl;
319 acm->oldcount = acm->iocount;
321 if (difference & ACM_CTRL_DSR)
323 if (difference & ACM_CTRL_BRK)
325 if (difference & ACM_CTRL_RI)
327 if (difference & ACM_CTRL_DCD)
329 if (difference & ACM_CTRL_FRAMING)
330 acm->iocount.frame++;
331 if (difference & ACM_CTRL_PARITY)
332 acm->iocount.parity++;
333 if (difference & ACM_CTRL_OVERRUN)
334 acm->iocount.overrun++;
335 spin_unlock(&acm->read_lock);
338 wake_up_all(&acm->wioctl);
343 dev_dbg(&acm->control->dev,
344 "%s - unknown notification %d received: index %d "
345 "len %d data0 %d data1 %d\n",
347 dr->bNotificationType, dr->wIndex,
348 dr->wLength, data[0], data[1]);
352 retval = usb_submit_urb(urb, GFP_ATOMIC);
354 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
358 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
362 if (!test_and_clear_bit(index, &acm->read_urbs_free))
365 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
367 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
370 dev_err(&acm->data->dev,
371 "%s - usb_submit_urb failed: %d\n",
374 set_bit(index, &acm->read_urbs_free);
381 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
386 for (i = 0; i < acm->rx_buflimit; ++i) {
387 res = acm_submit_read_urb(acm, i, mem_flags);
395 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
397 if (!urb->actual_length)
400 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
402 tty_flip_buffer_push(&acm->port);
405 static void acm_read_bulk_callback(struct urb *urb)
407 struct acm_rb *rb = urb->context;
408 struct acm *acm = rb->instance;
411 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
412 rb->index, urb->actual_length);
413 set_bit(rb->index, &acm->read_urbs_free);
416 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
419 usb_mark_last_busy(acm->dev);
422 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
423 __func__, urb->status);
426 acm_process_read_urb(acm, urb);
428 /* throttle device if requested by tty */
429 spin_lock_irqsave(&acm->read_lock, flags);
430 acm->throttled = acm->throttle_req;
431 if (!acm->throttled && !acm->susp_count) {
432 spin_unlock_irqrestore(&acm->read_lock, flags);
433 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
435 spin_unlock_irqrestore(&acm->read_lock, flags);
439 /* data interface wrote those outgoing bytes */
440 static void acm_write_bulk(struct urb *urb)
442 struct acm_wb *wb = urb->context;
443 struct acm *acm = wb->instance;
446 if (urb->status || (urb->actual_length != urb->transfer_buffer_length))
447 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
450 urb->transfer_buffer_length,
453 spin_lock_irqsave(&acm->write_lock, flags);
454 acm_write_done(acm, wb);
455 spin_unlock_irqrestore(&acm->write_lock, flags);
456 schedule_work(&acm->work);
459 static void acm_softint(struct work_struct *work)
461 struct acm *acm = container_of(work, struct acm, work);
463 dev_vdbg(&acm->data->dev, "%s\n", __func__);
465 tty_port_tty_wakeup(&acm->port);
472 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
477 dev_dbg(tty->dev, "%s\n", __func__);
479 acm = acm_get_by_index(tty->index);
483 retval = tty_standard_install(driver, tty);
485 goto error_init_termios;
487 tty->driver_data = acm;
492 tty_port_put(&acm->port);
496 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
498 struct acm *acm = tty->driver_data;
500 dev_dbg(tty->dev, "%s\n", __func__);
502 return tty_port_open(&acm->port, tty, filp);
505 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
507 struct acm *acm = container_of(port, struct acm, port);
508 int retval = -ENODEV;
510 dev_dbg(&acm->control->dev, "%s\n", __func__);
512 mutex_lock(&acm->mutex);
513 if (acm->disconnected)
516 retval = usb_autopm_get_interface(acm->control);
518 goto error_get_interface;
521 * FIXME: Why do we need this? Allocating 64K of physically contiguous
522 * memory is really nasty...
524 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
525 acm->control->needs_remote_wakeup = 1;
527 acm->ctrlurb->dev = acm->dev;
528 if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
529 dev_err(&acm->control->dev,
530 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
531 usb_autopm_put_interface(acm->control);
532 goto error_submit_urb;
535 acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS;
536 if (acm_set_control(acm, acm->ctrlout) < 0 &&
537 (acm->ctrl_caps & USB_CDC_CAP_LINE)) {
538 usb_autopm_put_interface(acm->control);
539 goto error_set_control;
542 usb_autopm_put_interface(acm->control);
545 * Unthrottle device in case the TTY was closed while throttled.
547 spin_lock_irq(&acm->read_lock);
549 acm->throttle_req = 0;
550 spin_unlock_irq(&acm->read_lock);
552 if (acm_submit_read_urbs(acm, GFP_KERNEL))
553 goto error_submit_read_urbs;
555 mutex_unlock(&acm->mutex);
559 error_submit_read_urbs:
561 acm_set_control(acm, acm->ctrlout);
563 usb_kill_urb(acm->ctrlurb);
567 mutex_unlock(&acm->mutex);
571 static void acm_port_destruct(struct tty_port *port)
573 struct acm *acm = container_of(port, struct acm, port);
575 dev_dbg(&acm->control->dev, "%s\n", __func__);
577 acm_release_minor(acm);
578 usb_put_intf(acm->control);
579 kfree(acm->country_codes);
583 static void acm_port_shutdown(struct tty_port *port)
585 struct acm *acm = container_of(port, struct acm, port);
590 dev_dbg(&acm->control->dev, "%s\n", __func__);
592 mutex_lock(&acm->mutex);
593 if (!acm->disconnected) {
594 usb_autopm_get_interface(acm->control);
595 acm_set_control(acm, acm->ctrlout = 0);
598 urb = usb_get_from_anchor(&acm->delayed);
603 usb_autopm_put_interface_async(acm->control);
606 usb_kill_urb(acm->ctrlurb);
607 for (i = 0; i < ACM_NW; i++)
608 usb_kill_urb(acm->wb[i].urb);
609 for (i = 0; i < acm->rx_buflimit; i++)
610 usb_kill_urb(acm->read_urbs[i]);
611 acm->control->needs_remote_wakeup = 0;
612 usb_autopm_put_interface(acm->control);
614 mutex_unlock(&acm->mutex);
617 static void acm_tty_cleanup(struct tty_struct *tty)
619 struct acm *acm = tty->driver_data;
620 dev_dbg(&acm->control->dev, "%s\n", __func__);
621 tty_port_put(&acm->port);
624 static void acm_tty_hangup(struct tty_struct *tty)
626 struct acm *acm = tty->driver_data;
627 dev_dbg(&acm->control->dev, "%s\n", __func__);
628 tty_port_hangup(&acm->port);
631 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
633 struct acm *acm = tty->driver_data;
634 dev_dbg(&acm->control->dev, "%s\n", __func__);
635 tty_port_close(&acm->port, tty, filp);
638 static int acm_tty_write(struct tty_struct *tty,
639 const unsigned char *buf, int count)
641 struct acm *acm = tty->driver_data;
650 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
652 spin_lock_irqsave(&acm->write_lock, flags);
653 wbn = acm_wb_alloc(acm);
655 spin_unlock_irqrestore(&acm->write_lock, flags);
662 spin_unlock_irqrestore(&acm->write_lock, flags);
666 count = (count > acm->writesize) ? acm->writesize : count;
667 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
668 memcpy(wb->buf, buf, count);
671 usb_autopm_get_interface_async(acm->control);
672 if (acm->susp_count) {
673 usb_anchor_urb(wb->urb, &acm->delayed);
674 spin_unlock_irqrestore(&acm->write_lock, flags);
677 usb_mark_last_busy(acm->dev);
679 stat = acm_start_wb(acm, wb);
680 spin_unlock_irqrestore(&acm->write_lock, flags);
687 static int acm_tty_write_room(struct tty_struct *tty)
689 struct acm *acm = tty->driver_data;
691 * Do not let the line discipline to know that we have a reserve,
692 * or it might get too enthusiastic.
694 return acm_wb_is_avail(acm) ? acm->writesize : 0;
697 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
699 struct acm *acm = tty->driver_data;
701 * if the device was unplugged then any remaining characters fell out
702 * of the connector ;)
704 if (acm->disconnected)
707 * This is inaccurate (overcounts), but it works.
709 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
712 static void acm_tty_throttle(struct tty_struct *tty)
714 struct acm *acm = tty->driver_data;
716 spin_lock_irq(&acm->read_lock);
717 acm->throttle_req = 1;
718 spin_unlock_irq(&acm->read_lock);
721 static void acm_tty_unthrottle(struct tty_struct *tty)
723 struct acm *acm = tty->driver_data;
724 unsigned int was_throttled;
726 spin_lock_irq(&acm->read_lock);
727 was_throttled = acm->throttled;
729 acm->throttle_req = 0;
730 spin_unlock_irq(&acm->read_lock);
733 acm_submit_read_urbs(acm, GFP_KERNEL);
736 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
738 struct acm *acm = tty->driver_data;
741 retval = acm_send_break(acm, state ? 0xffff : 0);
743 dev_dbg(&acm->control->dev, "%s - send break failed\n",
748 static int acm_tty_tiocmget(struct tty_struct *tty)
750 struct acm *acm = tty->driver_data;
752 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
753 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
754 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
755 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
756 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
760 static int acm_tty_tiocmset(struct tty_struct *tty,
761 unsigned int set, unsigned int clear)
763 struct acm *acm = tty->driver_data;
764 unsigned int newctrl;
766 newctrl = acm->ctrlout;
767 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
768 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
769 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
770 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
772 newctrl = (newctrl & ~clear) | set;
774 if (acm->ctrlout == newctrl)
776 return acm_set_control(acm, acm->ctrlout = newctrl);
779 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
781 struct serial_struct tmp;
786 memset(&tmp, 0, sizeof(tmp));
787 tmp.flags = ASYNC_LOW_LATENCY;
788 tmp.xmit_fifo_size = acm->writesize;
789 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
790 tmp.close_delay = acm->port.close_delay / 10;
791 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
792 ASYNC_CLOSING_WAIT_NONE :
793 acm->port.closing_wait / 10;
795 if (copy_to_user(info, &tmp, sizeof(tmp)))
801 static int set_serial_info(struct acm *acm,
802 struct serial_struct __user *newinfo)
804 struct serial_struct new_serial;
805 unsigned int closing_wait, close_delay;
808 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
811 close_delay = new_serial.close_delay * 10;
812 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
813 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
815 mutex_lock(&acm->port.mutex);
817 if (!capable(CAP_SYS_ADMIN)) {
818 if ((close_delay != acm->port.close_delay) ||
819 (closing_wait != acm->port.closing_wait))
822 retval = -EOPNOTSUPP;
824 acm->port.close_delay = close_delay;
825 acm->port.closing_wait = closing_wait;
828 mutex_unlock(&acm->port.mutex);
832 static int wait_serial_change(struct acm *acm, unsigned long arg)
835 DECLARE_WAITQUEUE(wait, current);
836 struct async_icount old, new;
838 if (arg & (TIOCM_DSR | TIOCM_RI | TIOCM_CD ))
841 spin_lock_irq(&acm->read_lock);
845 spin_unlock_irq(&acm->read_lock);
847 if ((arg & TIOCM_DSR) &&
850 if ((arg & TIOCM_CD) &&
853 if ((arg & TIOCM_RI) &&
857 add_wait_queue(&acm->wioctl, &wait);
858 set_current_state(TASK_INTERRUPTIBLE);
860 remove_wait_queue(&acm->wioctl, &wait);
861 if (acm->disconnected) {
867 if (signal_pending(current))
877 static int get_serial_usage(struct acm *acm,
878 struct serial_icounter_struct __user *count)
880 struct serial_icounter_struct icount;
883 memset(&icount, 0, sizeof(icount));
884 icount.dsr = acm->iocount.dsr;
885 icount.rng = acm->iocount.rng;
886 icount.dcd = acm->iocount.dcd;
887 icount.frame = acm->iocount.frame;
888 icount.overrun = acm->iocount.overrun;
889 icount.parity = acm->iocount.parity;
890 icount.brk = acm->iocount.brk;
892 if (copy_to_user(count, &icount, sizeof(icount)) > 0)
898 static int acm_tty_ioctl(struct tty_struct *tty,
899 unsigned int cmd, unsigned long arg)
901 struct acm *acm = tty->driver_data;
902 int rv = -ENOIOCTLCMD;
905 case TIOCGSERIAL: /* gets serial port data */
906 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
909 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
912 rv = usb_autopm_get_interface(acm->control);
917 rv = wait_serial_change(acm, arg);
918 usb_autopm_put_interface(acm->control);
921 rv = get_serial_usage(acm, (struct serial_icounter_struct __user *) arg);
928 static void acm_tty_set_termios(struct tty_struct *tty,
929 struct ktermios *termios_old)
931 struct acm *acm = tty->driver_data;
932 struct ktermios *termios = &tty->termios;
933 struct usb_cdc_line_coding newline;
934 int newctrl = acm->ctrlout;
936 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
937 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
938 newline.bParityType = termios->c_cflag & PARENB ?
939 (termios->c_cflag & PARODD ? 1 : 2) +
940 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
941 switch (termios->c_cflag & CSIZE) {
943 newline.bDataBits = 5;
946 newline.bDataBits = 6;
949 newline.bDataBits = 7;
953 newline.bDataBits = 8;
956 /* FIXME: Needs to clear unsupported bits in the termios */
957 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
959 if (!newline.dwDTERate) {
960 newline.dwDTERate = acm->line.dwDTERate;
961 newctrl &= ~ACM_CTRL_DTR;
963 newctrl |= ACM_CTRL_DTR;
965 if (newctrl != acm->ctrlout)
966 acm_set_control(acm, acm->ctrlout = newctrl);
968 if (memcmp(&acm->line, &newline, sizeof newline)) {
969 memcpy(&acm->line, &newline, sizeof newline);
970 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
972 le32_to_cpu(newline.dwDTERate),
973 newline.bCharFormat, newline.bParityType,
975 acm_set_line(acm, &acm->line);
979 static const struct tty_port_operations acm_port_ops = {
980 .shutdown = acm_port_shutdown,
981 .activate = acm_port_activate,
982 .destruct = acm_port_destruct,
986 * USB probe and disconnect routines.
989 /* Little helpers: write/read buffers free */
990 static void acm_write_buffers_free(struct acm *acm)
994 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
996 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
997 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
1000 static void acm_read_buffers_free(struct acm *acm)
1002 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1005 for (i = 0; i < acm->rx_buflimit; i++)
1006 usb_free_coherent(usb_dev, acm->readsize,
1007 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1010 /* Little helper: write buffers allocate */
1011 static int acm_write_buffers_alloc(struct acm *acm)
1016 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1017 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1023 usb_free_coherent(acm->dev, acm->writesize,
1032 static int acm_probe(struct usb_interface *intf,
1033 const struct usb_device_id *id)
1035 struct usb_cdc_union_desc *union_header = NULL;
1036 struct usb_cdc_country_functional_desc *cfd = NULL;
1037 unsigned char *buffer = intf->altsetting->extra;
1038 int buflen = intf->altsetting->extralen;
1039 struct usb_interface *control_interface;
1040 struct usb_interface *data_interface;
1041 struct usb_endpoint_descriptor *epctrl = NULL;
1042 struct usb_endpoint_descriptor *epread = NULL;
1043 struct usb_endpoint_descriptor *epwrite = NULL;
1044 struct usb_device *usb_dev = interface_to_usbdev(intf);
1047 int ctrlsize, readsize;
1049 u8 ac_management_function = 0;
1050 u8 call_management_function = 0;
1051 int call_interface_num = -1;
1052 int data_interface_num = -1;
1053 unsigned long quirks;
1056 int combined_interfaces = 0;
1057 struct device *tty_dev;
1061 quirks = (unsigned long)id->driver_info;
1063 if (quirks == IGNORE_DEVICE)
1066 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1068 /* handle quirks deadly to normal probing*/
1069 if (quirks == NO_UNION_NORMAL) {
1070 data_interface = usb_ifnum_to_if(usb_dev, 1);
1071 control_interface = usb_ifnum_to_if(usb_dev, 0);
1072 goto skip_normal_probe;
1077 dev_err(&intf->dev, "Weird descriptor references\n");
1082 if (intf->cur_altsetting->endpoint &&
1083 intf->cur_altsetting->endpoint->extralen &&
1084 intf->cur_altsetting->endpoint->extra) {
1086 "Seeking extra descriptors on endpoint\n");
1087 buflen = intf->cur_altsetting->endpoint->extralen;
1088 buffer = intf->cur_altsetting->endpoint->extra;
1091 "Zero length descriptor references\n");
1096 while (buflen > 0) {
1097 if (buffer[1] != USB_DT_CS_INTERFACE) {
1098 dev_err(&intf->dev, "skipping garbage\n");
1102 switch (buffer[2]) {
1103 case USB_CDC_UNION_TYPE: /* we've found it */
1105 dev_err(&intf->dev, "More than one "
1106 "union descriptor, skipping ...\n");
1109 union_header = (struct usb_cdc_union_desc *)buffer;
1111 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1112 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1114 case USB_CDC_HEADER_TYPE: /* maybe check version */
1115 break; /* for now we ignore it */
1116 case USB_CDC_ACM_TYPE:
1117 ac_management_function = buffer[3];
1119 case USB_CDC_CALL_MANAGEMENT_TYPE:
1120 call_management_function = buffer[3];
1121 call_interface_num = buffer[4];
1122 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1123 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1126 /* there are LOTS more CDC descriptors that
1127 * could legitimately be found here.
1129 dev_dbg(&intf->dev, "Ignoring descriptor: "
1130 "type %02x, length %d\n",
1131 buffer[2], buffer[0]);
1135 buflen -= buffer[0];
1136 buffer += buffer[0];
1139 if (!union_header) {
1140 if (call_interface_num > 0) {
1141 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1142 /* quirks for Droids MuIn LCD */
1143 if (quirks & NO_DATA_INTERFACE)
1144 data_interface = usb_ifnum_to_if(usb_dev, 0);
1146 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1147 control_interface = intf;
1149 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1150 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1153 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1154 combined_interfaces = 1;
1155 control_interface = data_interface = intf;
1156 goto look_for_collapsed_interface;
1160 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1161 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1162 if (!control_interface || !data_interface) {
1163 dev_dbg(&intf->dev, "no interfaces\n");
1168 if (data_interface_num != call_interface_num)
1169 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1171 if (control_interface == data_interface) {
1172 /* some broken devices designed for windows work this way */
1173 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1174 combined_interfaces = 1;
1175 /* a popular other OS doesn't use it */
1176 quirks |= NO_CAP_LINE;
1177 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1178 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1181 look_for_collapsed_interface:
1182 for (i = 0; i < 3; i++) {
1183 struct usb_endpoint_descriptor *ep;
1184 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1186 if (usb_endpoint_is_int_in(ep))
1188 else if (usb_endpoint_is_bulk_out(ep))
1190 else if (usb_endpoint_is_bulk_in(ep))
1195 if (!epctrl || !epread || !epwrite)
1198 goto made_compressed_probe;
1203 /*workaround for switched interfaces */
1204 if (data_interface->cur_altsetting->desc.bInterfaceClass
1205 != CDC_DATA_INTERFACE_TYPE) {
1206 if (control_interface->cur_altsetting->desc.bInterfaceClass
1207 == CDC_DATA_INTERFACE_TYPE) {
1208 struct usb_interface *t;
1210 "Your device has switched interfaces.\n");
1211 t = control_interface;
1212 control_interface = data_interface;
1219 /* Accept probe requests only for the control interface */
1220 if (!combined_interfaces && intf != control_interface)
1223 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1224 /* valid in this context */
1225 dev_dbg(&intf->dev, "The data interface isn't available\n");
1230 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1231 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1234 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1235 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1236 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1239 /* workaround for switched endpoints */
1240 if (!usb_endpoint_dir_in(epread)) {
1241 /* descriptors are swapped */
1242 struct usb_endpoint_descriptor *t;
1244 "The data interface has switched endpoints\n");
1249 made_compressed_probe:
1250 dev_dbg(&intf->dev, "interfaces are valid\n");
1252 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1254 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1258 minor = acm_alloc_minor(acm);
1259 if (minor == ACM_TTY_MINORS) {
1260 dev_err(&intf->dev, "no more free acm devices\n");
1265 ctrlsize = usb_endpoint_maxp(epctrl);
1266 readsize = usb_endpoint_maxp(epread) *
1267 (quirks == SINGLE_RX_URB ? 1 : 2);
1268 acm->combined_interfaces = combined_interfaces;
1269 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1270 acm->control = control_interface;
1271 acm->data = data_interface;
1274 acm->ctrl_caps = ac_management_function;
1275 if (quirks & NO_CAP_LINE)
1276 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1277 acm->ctrlsize = ctrlsize;
1278 acm->readsize = readsize;
1279 acm->rx_buflimit = num_rx_buf;
1280 INIT_WORK(&acm->work, acm_softint);
1281 init_waitqueue_head(&acm->wioctl);
1282 spin_lock_init(&acm->write_lock);
1283 spin_lock_init(&acm->read_lock);
1284 mutex_init(&acm->mutex);
1285 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1286 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1288 acm->bInterval = epread->bInterval;
1289 tty_port_init(&acm->port);
1290 acm->port.ops = &acm_port_ops;
1291 init_usb_anchor(&acm->delayed);
1293 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1295 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1298 acm->ctrl_buffer = buf;
1300 if (acm_write_buffers_alloc(acm) < 0) {
1301 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1305 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1306 if (!acm->ctrlurb) {
1307 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1310 for (i = 0; i < num_rx_buf; i++) {
1311 struct acm_rb *rb = &(acm->read_buffers[i]);
1314 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1317 dev_err(&intf->dev, "out of memory "
1318 "(read bufs usb_alloc_coherent)\n");
1324 urb = usb_alloc_urb(0, GFP_KERNEL);
1327 "out of memory (read urbs usb_alloc_urb)\n");
1330 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1331 urb->transfer_dma = rb->dma;
1332 if (acm->is_int_ep) {
1333 usb_fill_int_urb(urb, acm->dev,
1337 acm_read_bulk_callback, rb,
1340 usb_fill_bulk_urb(urb, acm->dev,
1344 acm_read_bulk_callback, rb);
1347 acm->read_urbs[i] = urb;
1348 __set_bit(i, &acm->read_urbs_free);
1350 for (i = 0; i < ACM_NW; i++) {
1351 struct acm_wb *snd = &(acm->wb[i]);
1353 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1354 if (snd->urb == NULL) {
1356 "out of memory (write urbs usb_alloc_urb)\n");
1360 if (usb_endpoint_xfer_int(epwrite))
1361 usb_fill_int_urb(snd->urb, usb_dev,
1362 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1363 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1365 usb_fill_bulk_urb(snd->urb, usb_dev,
1366 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1367 NULL, acm->writesize, acm_write_bulk, snd);
1368 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1369 snd->instance = acm;
1372 usb_set_intfdata(intf, acm);
1374 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1378 if (cfd) { /* export the country data */
1379 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1380 if (!acm->country_codes)
1381 goto skip_countries;
1382 acm->country_code_size = cfd->bLength - 4;
1383 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1385 acm->country_rel_date = cfd->iCountryCodeRelDate;
1387 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1389 kfree(acm->country_codes);
1390 acm->country_codes = NULL;
1391 acm->country_code_size = 0;
1392 goto skip_countries;
1395 i = device_create_file(&intf->dev,
1396 &dev_attr_iCountryCodeRelDate);
1398 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1399 kfree(acm->country_codes);
1400 acm->country_codes = NULL;
1401 acm->country_code_size = 0;
1402 goto skip_countries;
1407 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1408 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1409 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1410 /* works around buggy devices */
1411 epctrl->bInterval ? epctrl->bInterval : 16);
1412 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1413 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1415 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1417 acm_set_control(acm, acm->ctrlout);
1419 acm->line.dwDTERate = cpu_to_le32(9600);
1420 acm->line.bDataBits = 8;
1421 acm_set_line(acm, &acm->line);
1423 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1424 usb_set_intfdata(data_interface, acm);
1426 usb_get_intf(control_interface);
1427 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1428 &control_interface->dev);
1429 if (IS_ERR(tty_dev)) {
1430 rv = PTR_ERR(tty_dev);
1436 if (acm->country_codes) {
1437 device_remove_file(&acm->control->dev,
1438 &dev_attr_wCountryCodes);
1439 device_remove_file(&acm->control->dev,
1440 &dev_attr_iCountryCodeRelDate);
1442 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1444 usb_set_intfdata(intf, NULL);
1445 for (i = 0; i < ACM_NW; i++)
1446 usb_free_urb(acm->wb[i].urb);
1448 for (i = 0; i < num_rx_buf; i++)
1449 usb_free_urb(acm->read_urbs[i]);
1450 acm_read_buffers_free(acm);
1451 usb_free_urb(acm->ctrlurb);
1453 acm_write_buffers_free(acm);
1455 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1457 acm_release_minor(acm);
1463 static void stop_data_traffic(struct acm *acm)
1467 dev_dbg(&acm->control->dev, "%s\n", __func__);
1469 usb_kill_urb(acm->ctrlurb);
1470 for (i = 0; i < ACM_NW; i++)
1471 usb_kill_urb(acm->wb[i].urb);
1472 for (i = 0; i < acm->rx_buflimit; i++)
1473 usb_kill_urb(acm->read_urbs[i]);
1475 cancel_work_sync(&acm->work);
1478 static void acm_disconnect(struct usb_interface *intf)
1480 struct acm *acm = usb_get_intfdata(intf);
1481 struct usb_device *usb_dev = interface_to_usbdev(intf);
1482 struct tty_struct *tty;
1485 dev_dbg(&intf->dev, "%s\n", __func__);
1487 /* sibling interface is already cleaning up */
1491 mutex_lock(&acm->mutex);
1492 acm->disconnected = true;
1493 if (acm->country_codes) {
1494 device_remove_file(&acm->control->dev,
1495 &dev_attr_wCountryCodes);
1496 device_remove_file(&acm->control->dev,
1497 &dev_attr_iCountryCodeRelDate);
1499 wake_up_all(&acm->wioctl);
1500 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1501 usb_set_intfdata(acm->control, NULL);
1502 usb_set_intfdata(acm->data, NULL);
1503 mutex_unlock(&acm->mutex);
1505 tty = tty_port_tty_get(&acm->port);
1511 stop_data_traffic(acm);
1513 tty_unregister_device(acm_tty_driver, acm->minor);
1515 usb_free_urb(acm->ctrlurb);
1516 for (i = 0; i < ACM_NW; i++)
1517 usb_free_urb(acm->wb[i].urb);
1518 for (i = 0; i < acm->rx_buflimit; i++)
1519 usb_free_urb(acm->read_urbs[i]);
1520 acm_write_buffers_free(acm);
1521 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1522 acm_read_buffers_free(acm);
1524 if (!acm->combined_interfaces)
1525 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1526 acm->data : acm->control);
1528 tty_port_put(&acm->port);
1532 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1534 struct acm *acm = usb_get_intfdata(intf);
1537 spin_lock_irq(&acm->read_lock);
1538 spin_lock(&acm->write_lock);
1539 if (PMSG_IS_AUTO(message)) {
1540 if (acm->transmitting) {
1541 spin_unlock(&acm->write_lock);
1542 spin_unlock_irq(&acm->read_lock);
1546 cnt = acm->susp_count++;
1547 spin_unlock(&acm->write_lock);
1548 spin_unlock_irq(&acm->read_lock);
1553 stop_data_traffic(acm);
1558 static int acm_resume(struct usb_interface *intf)
1560 struct acm *acm = usb_get_intfdata(intf);
1564 spin_lock_irq(&acm->read_lock);
1565 spin_lock(&acm->write_lock);
1567 if (--acm->susp_count)
1570 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1571 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1574 urb = usb_get_from_anchor(&acm->delayed);
1578 acm_start_wb(acm, urb->context);
1582 * delayed error checking because we must
1583 * do the write path at all cost
1588 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1591 spin_unlock(&acm->write_lock);
1592 spin_unlock_irq(&acm->read_lock);
1597 static int acm_reset_resume(struct usb_interface *intf)
1599 struct acm *acm = usb_get_intfdata(intf);
1601 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1602 tty_port_tty_hangup(&acm->port, false);
1604 return acm_resume(intf);
1607 #endif /* CONFIG_PM */
1609 #define NOKIA_PCSUITE_ACM_INFO(x) \
1610 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1611 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1612 USB_CDC_ACM_PROTO_VENDOR)
1614 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1615 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1616 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1617 USB_CDC_ACM_PROTO_VENDOR)
1620 * USB driver structure.
1623 static const struct usb_device_id acm_ids[] = {
1624 /* quirky and broken devices */
1625 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1626 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1627 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1628 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1630 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1631 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1633 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1634 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1636 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1637 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1639 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1640 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1642 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1643 .driver_info = SINGLE_RX_URB,
1645 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1646 .driver_info = SINGLE_RX_URB, /* firmware bug */
1648 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1649 .driver_info = SINGLE_RX_URB, /* firmware bug */
1651 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1652 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1654 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1655 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1657 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1658 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1660 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1661 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1663 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1664 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1666 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1668 /* Motorola H24 HSPA module: */
1669 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1670 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1671 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1673 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1674 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1676 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1677 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1679 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1680 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1682 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1683 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1685 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1686 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1688 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1689 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1692 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1693 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1694 data interface instead of
1695 communications interface.
1696 Maybe we should define a new
1699 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1700 .driver_info = NO_UNION_NORMAL,
1702 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1703 .driver_info = NO_UNION_NORMAL,
1705 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1706 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1708 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1709 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1712 /* Nokia S60 phones expose two ACM channels. The first is
1713 * a modem and is picked up by the standard AT-command
1714 * information below. The second is 'vendor-specific' but
1715 * is treated as a serial device at the S60 end, so we want
1716 * to expose it on Linux too. */
1717 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1718 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1719 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1720 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1721 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1722 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1723 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1724 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1725 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1726 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1727 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1728 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1729 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1730 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1731 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1732 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1733 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1734 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1735 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1736 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1737 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1738 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1739 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1740 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1741 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1742 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1743 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1744 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1745 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1746 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1747 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1748 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1749 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1750 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1751 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1752 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1753 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1754 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1755 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1756 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1757 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1758 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1759 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1760 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1761 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1762 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1763 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1764 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1765 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1766 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1767 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1768 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1769 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1770 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1771 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1772 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1773 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1774 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1776 /* Support for Owen devices */
1777 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1779 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1781 /* Support Lego NXT using pbLua firmware */
1782 { USB_DEVICE(0x0694, 0xff00),
1783 .driver_info = NOT_A_MODEM,
1786 /* Support for Droids MuIn LCD */
1787 { USB_DEVICE(0x04d8, 0x000b),
1788 .driver_info = NO_DATA_INTERFACE,
1791 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1792 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1793 .driver_info = IGNORE_DEVICE,
1795 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1796 .driver_info = IGNORE_DEVICE,
1800 /* control interfaces without any protocol set */
1801 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1802 USB_CDC_PROTO_NONE) },
1804 /* control interfaces with various AT-command sets */
1805 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1806 USB_CDC_ACM_PROTO_AT_V25TER) },
1807 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1808 USB_CDC_ACM_PROTO_AT_PCCA101) },
1809 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1810 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1811 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1812 USB_CDC_ACM_PROTO_AT_GSM) },
1813 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1814 USB_CDC_ACM_PROTO_AT_3G) },
1815 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1816 USB_CDC_ACM_PROTO_AT_CDMA) },
1821 MODULE_DEVICE_TABLE(usb, acm_ids);
1823 static struct usb_driver acm_driver = {
1826 .disconnect = acm_disconnect,
1828 .suspend = acm_suspend,
1829 .resume = acm_resume,
1830 .reset_resume = acm_reset_resume,
1832 .id_table = acm_ids,
1834 .supports_autosuspend = 1,
1836 .disable_hub_initiated_lpm = 1,
1840 * TTY driver structures.
1843 static const struct tty_operations acm_ops = {
1844 .install = acm_tty_install,
1845 .open = acm_tty_open,
1846 .close = acm_tty_close,
1847 .cleanup = acm_tty_cleanup,
1848 .hangup = acm_tty_hangup,
1849 .write = acm_tty_write,
1850 .write_room = acm_tty_write_room,
1851 .ioctl = acm_tty_ioctl,
1852 .throttle = acm_tty_throttle,
1853 .unthrottle = acm_tty_unthrottle,
1854 .chars_in_buffer = acm_tty_chars_in_buffer,
1855 .break_ctl = acm_tty_break_ctl,
1856 .set_termios = acm_tty_set_termios,
1857 .tiocmget = acm_tty_tiocmget,
1858 .tiocmset = acm_tty_tiocmset,
1865 static int __init acm_init(void)
1868 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1869 if (!acm_tty_driver)
1871 acm_tty_driver->driver_name = "acm",
1872 acm_tty_driver->name = "ttyACM",
1873 acm_tty_driver->major = ACM_TTY_MAJOR,
1874 acm_tty_driver->minor_start = 0,
1875 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1876 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1877 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1878 acm_tty_driver->init_termios = tty_std_termios;
1879 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1881 tty_set_operations(acm_tty_driver, &acm_ops);
1883 retval = tty_register_driver(acm_tty_driver);
1885 put_tty_driver(acm_tty_driver);
1889 retval = usb_register(&acm_driver);
1891 tty_unregister_driver(acm_tty_driver);
1892 put_tty_driver(acm_tty_driver);
1896 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1901 static void __exit acm_exit(void)
1903 usb_deregister(&acm_driver);
1904 tty_unregister_driver(acm_tty_driver);
1905 put_tty_driver(acm_tty_driver);
1908 module_init(acm_init);
1909 module_exit(acm_exit);
1911 MODULE_AUTHOR(DRIVER_AUTHOR);
1912 MODULE_DESCRIPTION(DRIVER_DESC);
1913 MODULE_LICENSE("GPL");
1914 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);