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,
125 int retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
126 request, USB_RT_ACM, value,
127 acm->control->altsetting[0].desc.bInterfaceNumber,
129 dev_dbg(&acm->control->dev,
130 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
131 __func__, request, value, len, retval);
132 return retval < 0 ? retval : 0;
135 /* devices aren't required to support these requests.
136 * the cdc acm descriptor tells whether they do...
138 #define acm_set_control(acm, control) \
139 acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
140 #define acm_set_line(acm, line) \
141 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
142 #define acm_send_break(acm, ms) \
143 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
146 * Write buffer management.
147 * All of these assume proper locks taken by the caller.
150 static int acm_wb_alloc(struct acm *acm)
163 wbn = (wbn + 1) % ACM_NW;
169 static int acm_wb_is_avail(struct acm *acm)
175 spin_lock_irqsave(&acm->write_lock, flags);
176 for (i = 0; i < ACM_NW; i++)
178 spin_unlock_irqrestore(&acm->write_lock, flags);
183 * Finish write. Caller must hold acm->write_lock
185 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
189 usb_autopm_put_interface_async(acm->control);
195 * the caller is responsible for locking
198 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
204 wb->urb->transfer_buffer = wb->buf;
205 wb->urb->transfer_dma = wb->dmah;
206 wb->urb->transfer_buffer_length = wb->len;
207 wb->urb->dev = acm->dev;
209 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
211 dev_err(&acm->data->dev,
212 "%s - usb_submit_urb(write bulk) failed: %d\n",
214 acm_write_done(acm, wb);
220 * attributes exported through sysfs
222 static ssize_t show_caps
223 (struct device *dev, struct device_attribute *attr, char *buf)
225 struct usb_interface *intf = to_usb_interface(dev);
226 struct acm *acm = usb_get_intfdata(intf);
228 return sprintf(buf, "%d", acm->ctrl_caps);
230 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
232 static ssize_t show_country_codes
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 memcpy(buf, acm->country_codes, acm->country_code_size);
239 return acm->country_code_size;
242 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
244 static ssize_t show_country_rel_date
245 (struct device *dev, struct device_attribute *attr, char *buf)
247 struct usb_interface *intf = to_usb_interface(dev);
248 struct acm *acm = usb_get_intfdata(intf);
250 return sprintf(buf, "%d", acm->country_rel_date);
253 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
255 * Interrupt handlers for various ACM device responses
258 /* control interface reports status changes with "interrupt" transfers */
259 static void acm_ctrl_irq(struct urb *urb)
261 struct acm *acm = urb->context;
262 struct usb_cdc_notification *dr = urb->transfer_buffer;
267 int status = urb->status;
276 /* this urb is terminated, clean up */
277 dev_dbg(&acm->control->dev,
278 "%s - urb shutting down with status: %d\n",
282 dev_dbg(&acm->control->dev,
283 "%s - nonzero urb status received: %d\n",
288 usb_mark_last_busy(acm->dev);
290 data = (unsigned char *)(dr + 1);
291 switch (dr->bNotificationType) {
292 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
293 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
294 __func__, dr->wValue);
297 case USB_CDC_NOTIFY_SERIAL_STATE:
298 newctrl = get_unaligned_le16(data);
300 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
301 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
303 tty_port_tty_hangup(&acm->port, false);
306 difference = acm->ctrlin ^ newctrl;
307 spin_lock(&acm->read_lock);
308 acm->ctrlin = newctrl;
309 acm->oldcount = acm->iocount;
311 if (difference & ACM_CTRL_DSR)
313 if (difference & ACM_CTRL_BRK)
315 if (difference & ACM_CTRL_RI)
317 if (difference & ACM_CTRL_DCD)
319 if (difference & ACM_CTRL_FRAMING)
320 acm->iocount.frame++;
321 if (difference & ACM_CTRL_PARITY)
322 acm->iocount.parity++;
323 if (difference & ACM_CTRL_OVERRUN)
324 acm->iocount.overrun++;
325 spin_unlock(&acm->read_lock);
328 wake_up_all(&acm->wioctl);
333 dev_dbg(&acm->control->dev,
334 "%s - unknown notification %d received: index %d "
335 "len %d data0 %d data1 %d\n",
337 dr->bNotificationType, dr->wIndex,
338 dr->wLength, data[0], data[1]);
342 retval = usb_submit_urb(urb, GFP_ATOMIC);
344 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
348 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
352 if (!test_and_clear_bit(index, &acm->read_urbs_free))
355 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
357 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
360 dev_err(&acm->data->dev,
361 "%s - usb_submit_urb failed: %d\n",
364 set_bit(index, &acm->read_urbs_free);
371 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
376 for (i = 0; i < acm->rx_buflimit; ++i) {
377 res = acm_submit_read_urb(acm, i, mem_flags);
385 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
387 if (!urb->actual_length)
390 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
392 tty_flip_buffer_push(&acm->port);
395 static void acm_read_bulk_callback(struct urb *urb)
397 struct acm_rb *rb = urb->context;
398 struct acm *acm = rb->instance;
401 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
402 rb->index, urb->actual_length);
403 set_bit(rb->index, &acm->read_urbs_free);
406 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
409 usb_mark_last_busy(acm->dev);
412 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
413 __func__, urb->status);
416 acm_process_read_urb(acm, urb);
418 /* throttle device if requested by tty */
419 spin_lock_irqsave(&acm->read_lock, flags);
420 acm->throttled = acm->throttle_req;
421 if (!acm->throttled && !acm->susp_count) {
422 spin_unlock_irqrestore(&acm->read_lock, flags);
423 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
425 spin_unlock_irqrestore(&acm->read_lock, flags);
429 /* data interface wrote those outgoing bytes */
430 static void acm_write_bulk(struct urb *urb)
432 struct acm_wb *wb = urb->context;
433 struct acm *acm = wb->instance;
436 if (urb->status || (urb->actual_length != urb->transfer_buffer_length))
437 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
440 urb->transfer_buffer_length,
443 spin_lock_irqsave(&acm->write_lock, flags);
444 acm_write_done(acm, wb);
445 spin_unlock_irqrestore(&acm->write_lock, flags);
446 schedule_work(&acm->work);
449 static void acm_softint(struct work_struct *work)
451 struct acm *acm = container_of(work, struct acm, work);
453 dev_vdbg(&acm->data->dev, "%s\n", __func__);
455 tty_port_tty_wakeup(&acm->port);
462 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
467 dev_dbg(tty->dev, "%s\n", __func__);
469 acm = acm_get_by_index(tty->index);
473 retval = tty_standard_install(driver, tty);
475 goto error_init_termios;
477 tty->driver_data = acm;
482 tty_port_put(&acm->port);
486 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
488 struct acm *acm = tty->driver_data;
490 dev_dbg(tty->dev, "%s\n", __func__);
492 return tty_port_open(&acm->port, tty, filp);
495 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
497 struct acm *acm = container_of(port, struct acm, port);
498 int retval = -ENODEV;
500 dev_dbg(&acm->control->dev, "%s\n", __func__);
502 mutex_lock(&acm->mutex);
503 if (acm->disconnected)
506 retval = usb_autopm_get_interface(acm->control);
508 goto error_get_interface;
511 * FIXME: Why do we need this? Allocating 64K of physically contiguous
512 * memory is really nasty...
514 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
515 acm->control->needs_remote_wakeup = 1;
517 acm->ctrlurb->dev = acm->dev;
518 if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
519 dev_err(&acm->control->dev,
520 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
521 goto error_submit_urb;
524 acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS;
525 if (acm_set_control(acm, acm->ctrlout) < 0 &&
526 (acm->ctrl_caps & USB_CDC_CAP_LINE))
527 goto error_set_control;
529 usb_autopm_put_interface(acm->control);
532 * Unthrottle device in case the TTY was closed while throttled.
534 spin_lock_irq(&acm->read_lock);
536 acm->throttle_req = 0;
537 spin_unlock_irq(&acm->read_lock);
539 if (acm_submit_read_urbs(acm, GFP_KERNEL))
540 goto error_submit_read_urbs;
542 mutex_unlock(&acm->mutex);
546 error_submit_read_urbs:
548 acm_set_control(acm, acm->ctrlout);
550 usb_kill_urb(acm->ctrlurb);
552 usb_autopm_put_interface(acm->control);
555 mutex_unlock(&acm->mutex);
559 static void acm_port_destruct(struct tty_port *port)
561 struct acm *acm = container_of(port, struct acm, port);
563 dev_dbg(&acm->control->dev, "%s\n", __func__);
565 acm_release_minor(acm);
566 usb_put_intf(acm->control);
567 kfree(acm->country_codes);
571 static void acm_port_shutdown(struct tty_port *port)
573 struct acm *acm = container_of(port, struct acm, port);
576 dev_dbg(&acm->control->dev, "%s\n", __func__);
578 mutex_lock(&acm->mutex);
579 if (!acm->disconnected) {
580 usb_autopm_get_interface(acm->control);
581 acm_set_control(acm, acm->ctrlout = 0);
582 usb_kill_urb(acm->ctrlurb);
583 for (i = 0; i < ACM_NW; i++)
584 usb_kill_urb(acm->wb[i].urb);
585 for (i = 0; i < acm->rx_buflimit; i++)
586 usb_kill_urb(acm->read_urbs[i]);
587 acm->control->needs_remote_wakeup = 0;
588 usb_autopm_put_interface(acm->control);
590 mutex_unlock(&acm->mutex);
593 static void acm_tty_cleanup(struct tty_struct *tty)
595 struct acm *acm = tty->driver_data;
596 dev_dbg(&acm->control->dev, "%s\n", __func__);
597 tty_port_put(&acm->port);
600 static void acm_tty_hangup(struct tty_struct *tty)
602 struct acm *acm = tty->driver_data;
603 dev_dbg(&acm->control->dev, "%s\n", __func__);
604 tty_port_hangup(&acm->port);
607 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
609 struct acm *acm = tty->driver_data;
610 dev_dbg(&acm->control->dev, "%s\n", __func__);
611 tty_port_close(&acm->port, tty, filp);
614 static int acm_tty_write(struct tty_struct *tty,
615 const unsigned char *buf, int count)
617 struct acm *acm = tty->driver_data;
626 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
628 spin_lock_irqsave(&acm->write_lock, flags);
629 wbn = acm_wb_alloc(acm);
631 spin_unlock_irqrestore(&acm->write_lock, flags);
638 spin_unlock_irqrestore(&acm->write_lock, flags);
642 count = (count > acm->writesize) ? acm->writesize : count;
643 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
644 memcpy(wb->buf, buf, count);
647 usb_autopm_get_interface_async(acm->control);
648 if (acm->susp_count) {
649 if (!acm->delayed_wb)
650 acm->delayed_wb = wb;
652 usb_autopm_put_interface_async(acm->control);
653 spin_unlock_irqrestore(&acm->write_lock, flags);
654 return count; /* A white lie */
656 usb_mark_last_busy(acm->dev);
658 stat = acm_start_wb(acm, wb);
659 spin_unlock_irqrestore(&acm->write_lock, flags);
666 static int acm_tty_write_room(struct tty_struct *tty)
668 struct acm *acm = tty->driver_data;
670 * Do not let the line discipline to know that we have a reserve,
671 * or it might get too enthusiastic.
673 return acm_wb_is_avail(acm) ? acm->writesize : 0;
676 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
678 struct acm *acm = tty->driver_data;
680 * if the device was unplugged then any remaining characters fell out
681 * of the connector ;)
683 if (acm->disconnected)
686 * This is inaccurate (overcounts), but it works.
688 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
691 static void acm_tty_throttle(struct tty_struct *tty)
693 struct acm *acm = tty->driver_data;
695 spin_lock_irq(&acm->read_lock);
696 acm->throttle_req = 1;
697 spin_unlock_irq(&acm->read_lock);
700 static void acm_tty_unthrottle(struct tty_struct *tty)
702 struct acm *acm = tty->driver_data;
703 unsigned int was_throttled;
705 spin_lock_irq(&acm->read_lock);
706 was_throttled = acm->throttled;
708 acm->throttle_req = 0;
709 spin_unlock_irq(&acm->read_lock);
712 acm_submit_read_urbs(acm, GFP_KERNEL);
715 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
717 struct acm *acm = tty->driver_data;
720 retval = acm_send_break(acm, state ? 0xffff : 0);
722 dev_dbg(&acm->control->dev, "%s - send break failed\n",
727 static int acm_tty_tiocmget(struct tty_struct *tty)
729 struct acm *acm = tty->driver_data;
731 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
732 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
733 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
734 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
735 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
739 static int acm_tty_tiocmset(struct tty_struct *tty,
740 unsigned int set, unsigned int clear)
742 struct acm *acm = tty->driver_data;
743 unsigned int newctrl;
745 newctrl = acm->ctrlout;
746 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
747 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
748 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
749 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
751 newctrl = (newctrl & ~clear) | set;
753 if (acm->ctrlout == newctrl)
755 return acm_set_control(acm, acm->ctrlout = newctrl);
758 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
760 struct serial_struct tmp;
765 memset(&tmp, 0, sizeof(tmp));
766 tmp.flags = ASYNC_LOW_LATENCY;
767 tmp.xmit_fifo_size = acm->writesize;
768 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
769 tmp.close_delay = acm->port.close_delay / 10;
770 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
771 ASYNC_CLOSING_WAIT_NONE :
772 acm->port.closing_wait / 10;
774 if (copy_to_user(info, &tmp, sizeof(tmp)))
780 static int set_serial_info(struct acm *acm,
781 struct serial_struct __user *newinfo)
783 struct serial_struct new_serial;
784 unsigned int closing_wait, close_delay;
787 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
790 close_delay = new_serial.close_delay * 10;
791 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
792 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
794 mutex_lock(&acm->port.mutex);
796 if (!capable(CAP_SYS_ADMIN)) {
797 if ((close_delay != acm->port.close_delay) ||
798 (closing_wait != acm->port.closing_wait))
801 retval = -EOPNOTSUPP;
803 acm->port.close_delay = close_delay;
804 acm->port.closing_wait = closing_wait;
807 mutex_unlock(&acm->port.mutex);
811 static int wait_serial_change(struct acm *acm, unsigned long arg)
814 DECLARE_WAITQUEUE(wait, current);
815 struct async_icount old, new;
817 if (arg & (TIOCM_DSR | TIOCM_RI | TIOCM_CD ))
820 spin_lock_irq(&acm->read_lock);
824 spin_unlock_irq(&acm->read_lock);
826 if ((arg & TIOCM_DSR) &&
829 if ((arg & TIOCM_CD) &&
832 if ((arg & TIOCM_RI) &&
836 add_wait_queue(&acm->wioctl, &wait);
837 set_current_state(TASK_INTERRUPTIBLE);
839 remove_wait_queue(&acm->wioctl, &wait);
840 if (acm->disconnected) {
846 if (signal_pending(current))
856 static int get_serial_usage(struct acm *acm,
857 struct serial_icounter_struct __user *count)
859 struct serial_icounter_struct icount;
862 memset(&icount, 0, sizeof(icount));
863 icount.dsr = acm->iocount.dsr;
864 icount.rng = acm->iocount.rng;
865 icount.dcd = acm->iocount.dcd;
866 icount.frame = acm->iocount.frame;
867 icount.overrun = acm->iocount.overrun;
868 icount.parity = acm->iocount.parity;
869 icount.brk = acm->iocount.brk;
871 if (copy_to_user(count, &icount, sizeof(icount)) > 0)
877 static int acm_tty_ioctl(struct tty_struct *tty,
878 unsigned int cmd, unsigned long arg)
880 struct acm *acm = tty->driver_data;
881 int rv = -ENOIOCTLCMD;
884 case TIOCGSERIAL: /* gets serial port data */
885 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
888 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
891 rv = wait_serial_change(acm, arg);
894 rv = get_serial_usage(acm, (struct serial_icounter_struct __user *) arg);
901 static void acm_tty_set_termios(struct tty_struct *tty,
902 struct ktermios *termios_old)
904 struct acm *acm = tty->driver_data;
905 struct ktermios *termios = &tty->termios;
906 struct usb_cdc_line_coding newline;
907 int newctrl = acm->ctrlout;
909 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
910 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
911 newline.bParityType = termios->c_cflag & PARENB ?
912 (termios->c_cflag & PARODD ? 1 : 2) +
913 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
914 switch (termios->c_cflag & CSIZE) {
916 newline.bDataBits = 5;
919 newline.bDataBits = 6;
922 newline.bDataBits = 7;
926 newline.bDataBits = 8;
929 /* FIXME: Needs to clear unsupported bits in the termios */
930 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
932 if (!newline.dwDTERate) {
933 newline.dwDTERate = acm->line.dwDTERate;
934 newctrl &= ~ACM_CTRL_DTR;
936 newctrl |= ACM_CTRL_DTR;
938 if (newctrl != acm->ctrlout)
939 acm_set_control(acm, acm->ctrlout = newctrl);
941 if (memcmp(&acm->line, &newline, sizeof newline)) {
942 memcpy(&acm->line, &newline, sizeof newline);
943 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
945 le32_to_cpu(newline.dwDTERate),
946 newline.bCharFormat, newline.bParityType,
948 acm_set_line(acm, &acm->line);
952 static const struct tty_port_operations acm_port_ops = {
953 .shutdown = acm_port_shutdown,
954 .activate = acm_port_activate,
955 .destruct = acm_port_destruct,
959 * USB probe and disconnect routines.
962 /* Little helpers: write/read buffers free */
963 static void acm_write_buffers_free(struct acm *acm)
967 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
969 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
970 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
973 static void acm_read_buffers_free(struct acm *acm)
975 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
978 for (i = 0; i < acm->rx_buflimit; i++)
979 usb_free_coherent(usb_dev, acm->readsize,
980 acm->read_buffers[i].base, acm->read_buffers[i].dma);
983 /* Little helper: write buffers allocate */
984 static int acm_write_buffers_alloc(struct acm *acm)
989 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
990 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
996 usb_free_coherent(acm->dev, acm->writesize,
1005 static int acm_probe(struct usb_interface *intf,
1006 const struct usb_device_id *id)
1008 struct usb_cdc_union_desc *union_header = NULL;
1009 struct usb_cdc_country_functional_desc *cfd = NULL;
1010 unsigned char *buffer = intf->altsetting->extra;
1011 int buflen = intf->altsetting->extralen;
1012 struct usb_interface *control_interface;
1013 struct usb_interface *data_interface;
1014 struct usb_endpoint_descriptor *epctrl = NULL;
1015 struct usb_endpoint_descriptor *epread = NULL;
1016 struct usb_endpoint_descriptor *epwrite = NULL;
1017 struct usb_device *usb_dev = interface_to_usbdev(intf);
1020 int ctrlsize, readsize;
1022 u8 ac_management_function = 0;
1023 u8 call_management_function = 0;
1024 int call_interface_num = -1;
1025 int data_interface_num = -1;
1026 unsigned long quirks;
1029 int combined_interfaces = 0;
1030 struct device *tty_dev;
1034 quirks = (unsigned long)id->driver_info;
1036 if (quirks == IGNORE_DEVICE)
1039 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1041 /* handle quirks deadly to normal probing*/
1042 if (quirks == NO_UNION_NORMAL) {
1043 data_interface = usb_ifnum_to_if(usb_dev, 1);
1044 control_interface = usb_ifnum_to_if(usb_dev, 0);
1045 goto skip_normal_probe;
1050 dev_err(&intf->dev, "Weird descriptor references\n");
1055 if (intf->cur_altsetting->endpoint &&
1056 intf->cur_altsetting->endpoint->extralen &&
1057 intf->cur_altsetting->endpoint->extra) {
1059 "Seeking extra descriptors on endpoint\n");
1060 buflen = intf->cur_altsetting->endpoint->extralen;
1061 buffer = intf->cur_altsetting->endpoint->extra;
1064 "Zero length descriptor references\n");
1069 while (buflen > 0) {
1070 if (buffer[1] != USB_DT_CS_INTERFACE) {
1071 dev_err(&intf->dev, "skipping garbage\n");
1075 switch (buffer[2]) {
1076 case USB_CDC_UNION_TYPE: /* we've found it */
1078 dev_err(&intf->dev, "More than one "
1079 "union descriptor, skipping ...\n");
1082 union_header = (struct usb_cdc_union_desc *)buffer;
1084 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1085 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1087 case USB_CDC_HEADER_TYPE: /* maybe check version */
1088 break; /* for now we ignore it */
1089 case USB_CDC_ACM_TYPE:
1090 ac_management_function = buffer[3];
1092 case USB_CDC_CALL_MANAGEMENT_TYPE:
1093 call_management_function = buffer[3];
1094 call_interface_num = buffer[4];
1095 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1096 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1099 /* there are LOTS more CDC descriptors that
1100 * could legitimately be found here.
1102 dev_dbg(&intf->dev, "Ignoring descriptor: "
1103 "type %02x, length %d\n",
1104 buffer[2], buffer[0]);
1108 buflen -= buffer[0];
1109 buffer += buffer[0];
1112 if (!union_header) {
1113 if (call_interface_num > 0) {
1114 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1115 /* quirks for Droids MuIn LCD */
1116 if (quirks & NO_DATA_INTERFACE)
1117 data_interface = usb_ifnum_to_if(usb_dev, 0);
1119 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1120 control_interface = intf;
1122 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1123 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1126 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1127 combined_interfaces = 1;
1128 control_interface = data_interface = intf;
1129 goto look_for_collapsed_interface;
1133 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1134 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1135 if (!control_interface || !data_interface) {
1136 dev_dbg(&intf->dev, "no interfaces\n");
1141 if (data_interface_num != call_interface_num)
1142 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1144 if (control_interface == data_interface) {
1145 /* some broken devices designed for windows work this way */
1146 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1147 combined_interfaces = 1;
1148 /* a popular other OS doesn't use it */
1149 quirks |= NO_CAP_LINE;
1150 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1151 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1154 look_for_collapsed_interface:
1155 for (i = 0; i < 3; i++) {
1156 struct usb_endpoint_descriptor *ep;
1157 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1159 if (usb_endpoint_is_int_in(ep))
1161 else if (usb_endpoint_is_bulk_out(ep))
1163 else if (usb_endpoint_is_bulk_in(ep))
1168 if (!epctrl || !epread || !epwrite)
1171 goto made_compressed_probe;
1176 /*workaround for switched interfaces */
1177 if (data_interface->cur_altsetting->desc.bInterfaceClass
1178 != CDC_DATA_INTERFACE_TYPE) {
1179 if (control_interface->cur_altsetting->desc.bInterfaceClass
1180 == CDC_DATA_INTERFACE_TYPE) {
1181 struct usb_interface *t;
1183 "Your device has switched interfaces.\n");
1184 t = control_interface;
1185 control_interface = data_interface;
1192 /* Accept probe requests only for the control interface */
1193 if (!combined_interfaces && intf != control_interface)
1196 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1197 /* valid in this context */
1198 dev_dbg(&intf->dev, "The data interface isn't available\n");
1203 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1204 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1207 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1208 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1209 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1212 /* workaround for switched endpoints */
1213 if (!usb_endpoint_dir_in(epread)) {
1214 /* descriptors are swapped */
1215 struct usb_endpoint_descriptor *t;
1217 "The data interface has switched endpoints\n");
1222 made_compressed_probe:
1223 dev_dbg(&intf->dev, "interfaces are valid\n");
1225 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1227 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1231 minor = acm_alloc_minor(acm);
1232 if (minor == ACM_TTY_MINORS) {
1233 dev_err(&intf->dev, "no more free acm devices\n");
1238 ctrlsize = usb_endpoint_maxp(epctrl);
1239 readsize = usb_endpoint_maxp(epread) *
1240 (quirks == SINGLE_RX_URB ? 1 : 2);
1241 acm->combined_interfaces = combined_interfaces;
1242 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1243 acm->control = control_interface;
1244 acm->data = data_interface;
1247 acm->ctrl_caps = ac_management_function;
1248 if (quirks & NO_CAP_LINE)
1249 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1250 acm->ctrlsize = ctrlsize;
1251 acm->readsize = readsize;
1252 acm->rx_buflimit = num_rx_buf;
1253 INIT_WORK(&acm->work, acm_softint);
1254 init_waitqueue_head(&acm->wioctl);
1255 spin_lock_init(&acm->write_lock);
1256 spin_lock_init(&acm->read_lock);
1257 mutex_init(&acm->mutex);
1258 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1259 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1261 acm->bInterval = epread->bInterval;
1262 tty_port_init(&acm->port);
1263 acm->port.ops = &acm_port_ops;
1265 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1267 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1270 acm->ctrl_buffer = buf;
1272 if (acm_write_buffers_alloc(acm) < 0) {
1273 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1277 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1278 if (!acm->ctrlurb) {
1279 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1282 for (i = 0; i < num_rx_buf; i++) {
1283 struct acm_rb *rb = &(acm->read_buffers[i]);
1286 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1289 dev_err(&intf->dev, "out of memory "
1290 "(read bufs usb_alloc_coherent)\n");
1296 urb = usb_alloc_urb(0, GFP_KERNEL);
1299 "out of memory (read urbs usb_alloc_urb)\n");
1302 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1303 urb->transfer_dma = rb->dma;
1304 if (acm->is_int_ep) {
1305 usb_fill_int_urb(urb, acm->dev,
1309 acm_read_bulk_callback, rb,
1312 usb_fill_bulk_urb(urb, acm->dev,
1316 acm_read_bulk_callback, rb);
1319 acm->read_urbs[i] = urb;
1320 __set_bit(i, &acm->read_urbs_free);
1322 for (i = 0; i < ACM_NW; i++) {
1323 struct acm_wb *snd = &(acm->wb[i]);
1325 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1326 if (snd->urb == NULL) {
1328 "out of memory (write urbs usb_alloc_urb)\n");
1332 if (usb_endpoint_xfer_int(epwrite))
1333 usb_fill_int_urb(snd->urb, usb_dev,
1334 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1335 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1337 usb_fill_bulk_urb(snd->urb, usb_dev,
1338 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1339 NULL, acm->writesize, acm_write_bulk, snd);
1340 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1341 snd->instance = acm;
1344 usb_set_intfdata(intf, acm);
1346 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1350 if (cfd) { /* export the country data */
1351 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1352 if (!acm->country_codes)
1353 goto skip_countries;
1354 acm->country_code_size = cfd->bLength - 4;
1355 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1357 acm->country_rel_date = cfd->iCountryCodeRelDate;
1359 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1361 kfree(acm->country_codes);
1362 acm->country_codes = NULL;
1363 acm->country_code_size = 0;
1364 goto skip_countries;
1367 i = device_create_file(&intf->dev,
1368 &dev_attr_iCountryCodeRelDate);
1370 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1371 kfree(acm->country_codes);
1372 acm->country_codes = NULL;
1373 acm->country_code_size = 0;
1374 goto skip_countries;
1379 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1380 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1381 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1382 /* works around buggy devices */
1383 epctrl->bInterval ? epctrl->bInterval : 16);
1384 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1385 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1387 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1389 acm_set_control(acm, acm->ctrlout);
1391 acm->line.dwDTERate = cpu_to_le32(9600);
1392 acm->line.bDataBits = 8;
1393 acm_set_line(acm, &acm->line);
1395 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1396 usb_set_intfdata(data_interface, acm);
1398 usb_get_intf(control_interface);
1399 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1400 &control_interface->dev);
1401 if (IS_ERR(tty_dev)) {
1402 rv = PTR_ERR(tty_dev);
1408 if (acm->country_codes) {
1409 device_remove_file(&acm->control->dev,
1410 &dev_attr_wCountryCodes);
1411 device_remove_file(&acm->control->dev,
1412 &dev_attr_iCountryCodeRelDate);
1414 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1416 usb_set_intfdata(intf, NULL);
1417 for (i = 0; i < ACM_NW; i++)
1418 usb_free_urb(acm->wb[i].urb);
1420 for (i = 0; i < num_rx_buf; i++)
1421 usb_free_urb(acm->read_urbs[i]);
1422 acm_read_buffers_free(acm);
1423 usb_free_urb(acm->ctrlurb);
1425 acm_write_buffers_free(acm);
1427 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1429 acm_release_minor(acm);
1435 static void stop_data_traffic(struct acm *acm)
1439 dev_dbg(&acm->control->dev, "%s\n", __func__);
1441 usb_kill_urb(acm->ctrlurb);
1442 for (i = 0; i < ACM_NW; i++)
1443 usb_kill_urb(acm->wb[i].urb);
1444 for (i = 0; i < acm->rx_buflimit; i++)
1445 usb_kill_urb(acm->read_urbs[i]);
1447 cancel_work_sync(&acm->work);
1450 static void acm_disconnect(struct usb_interface *intf)
1452 struct acm *acm = usb_get_intfdata(intf);
1453 struct usb_device *usb_dev = interface_to_usbdev(intf);
1454 struct tty_struct *tty;
1457 dev_dbg(&intf->dev, "%s\n", __func__);
1459 /* sibling interface is already cleaning up */
1463 mutex_lock(&acm->mutex);
1464 acm->disconnected = true;
1465 if (acm->country_codes) {
1466 device_remove_file(&acm->control->dev,
1467 &dev_attr_wCountryCodes);
1468 device_remove_file(&acm->control->dev,
1469 &dev_attr_iCountryCodeRelDate);
1471 wake_up_all(&acm->wioctl);
1472 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1473 usb_set_intfdata(acm->control, NULL);
1474 usb_set_intfdata(acm->data, NULL);
1475 mutex_unlock(&acm->mutex);
1477 tty = tty_port_tty_get(&acm->port);
1483 stop_data_traffic(acm);
1485 tty_unregister_device(acm_tty_driver, acm->minor);
1487 usb_free_urb(acm->ctrlurb);
1488 for (i = 0; i < ACM_NW; i++)
1489 usb_free_urb(acm->wb[i].urb);
1490 for (i = 0; i < acm->rx_buflimit; i++)
1491 usb_free_urb(acm->read_urbs[i]);
1492 acm_write_buffers_free(acm);
1493 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1494 acm_read_buffers_free(acm);
1496 if (!acm->combined_interfaces)
1497 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1498 acm->data : acm->control);
1500 tty_port_put(&acm->port);
1504 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1506 struct acm *acm = usb_get_intfdata(intf);
1509 if (PMSG_IS_AUTO(message)) {
1512 spin_lock_irq(&acm->write_lock);
1513 b = acm->transmitting;
1514 spin_unlock_irq(&acm->write_lock);
1519 spin_lock_irq(&acm->read_lock);
1520 spin_lock(&acm->write_lock);
1521 cnt = acm->susp_count++;
1522 spin_unlock(&acm->write_lock);
1523 spin_unlock_irq(&acm->read_lock);
1528 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1529 stop_data_traffic(acm);
1534 static int acm_resume(struct usb_interface *intf)
1536 struct acm *acm = usb_get_intfdata(intf);
1541 spin_lock_irq(&acm->read_lock);
1542 acm->susp_count -= 1;
1543 cnt = acm->susp_count;
1544 spin_unlock_irq(&acm->read_lock);
1549 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1550 rv = usb_submit_urb(acm->ctrlurb, GFP_NOIO);
1552 spin_lock_irq(&acm->write_lock);
1553 if (acm->delayed_wb) {
1554 wb = acm->delayed_wb;
1555 acm->delayed_wb = NULL;
1556 spin_unlock_irq(&acm->write_lock);
1557 acm_start_wb(acm, wb);
1559 spin_unlock_irq(&acm->write_lock);
1563 * delayed error checking because we must
1564 * do the write path at all cost
1569 rv = acm_submit_read_urbs(acm, GFP_NOIO);
1576 static int acm_reset_resume(struct usb_interface *intf)
1578 struct acm *acm = usb_get_intfdata(intf);
1580 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1581 tty_port_tty_hangup(&acm->port, false);
1583 return acm_resume(intf);
1586 #endif /* CONFIG_PM */
1588 #define NOKIA_PCSUITE_ACM_INFO(x) \
1589 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1590 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1591 USB_CDC_ACM_PROTO_VENDOR)
1593 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1594 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1595 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1596 USB_CDC_ACM_PROTO_VENDOR)
1599 * USB driver structure.
1602 static const struct usb_device_id acm_ids[] = {
1603 /* quirky and broken devices */
1604 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1605 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1607 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1608 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1610 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1611 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1613 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1614 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1616 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1617 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1619 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1620 .driver_info = SINGLE_RX_URB,
1622 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1623 .driver_info = SINGLE_RX_URB, /* firmware bug */
1625 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1626 .driver_info = SINGLE_RX_URB, /* firmware bug */
1628 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1629 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1631 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1632 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1634 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1635 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1637 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1638 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1640 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1641 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1643 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1645 /* Motorola H24 HSPA module: */
1646 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1647 { USB_DEVICE(0x22b8, 0x2d92) }, /* modem + diagnostics */
1648 { USB_DEVICE(0x22b8, 0x2d93) }, /* modem + AT port */
1649 { USB_DEVICE(0x22b8, 0x2d95) }, /* modem + AT port + diagnostics */
1650 { USB_DEVICE(0x22b8, 0x2d96) }, /* modem + NMEA */
1651 { USB_DEVICE(0x22b8, 0x2d97) }, /* modem + diagnostics + NMEA */
1652 { USB_DEVICE(0x22b8, 0x2d99) }, /* modem + AT port + NMEA */
1653 { USB_DEVICE(0x22b8, 0x2d9a) }, /* modem + AT port + diagnostics + NMEA */
1655 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1656 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1657 data interface instead of
1658 communications interface.
1659 Maybe we should define a new
1662 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1663 .driver_info = NO_UNION_NORMAL,
1665 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1666 .driver_info = NO_UNION_NORMAL,
1668 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1669 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1671 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1672 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1675 /* Nokia S60 phones expose two ACM channels. The first is
1676 * a modem and is picked up by the standard AT-command
1677 * information below. The second is 'vendor-specific' but
1678 * is treated as a serial device at the S60 end, so we want
1679 * to expose it on Linux too. */
1680 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1681 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1682 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1683 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1684 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1685 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1686 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1687 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1688 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1689 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1690 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1691 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1692 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1693 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1694 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1695 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1696 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1697 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1698 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1699 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1700 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1701 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1702 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1703 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1704 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1705 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1706 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1707 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1708 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1709 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1710 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1711 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1712 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1713 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1714 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1715 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1716 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1717 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1718 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1719 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1720 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1721 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1722 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1723 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1724 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1725 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1726 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1727 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1728 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1729 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1730 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1731 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1732 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1733 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1734 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1735 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1736 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1737 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1739 /* Support for Owen devices */
1740 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1742 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1744 /* Support Lego NXT using pbLua firmware */
1745 { USB_DEVICE(0x0694, 0xff00),
1746 .driver_info = NOT_A_MODEM,
1749 /* Support for Droids MuIn LCD */
1750 { USB_DEVICE(0x04d8, 0x000b),
1751 .driver_info = NO_DATA_INTERFACE,
1754 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1755 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1756 .driver_info = IGNORE_DEVICE,
1758 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1759 .driver_info = IGNORE_DEVICE,
1763 /* control interfaces without any protocol set */
1764 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1765 USB_CDC_PROTO_NONE) },
1767 /* control interfaces with various AT-command sets */
1768 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1769 USB_CDC_ACM_PROTO_AT_V25TER) },
1770 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1771 USB_CDC_ACM_PROTO_AT_PCCA101) },
1772 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1773 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1774 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1775 USB_CDC_ACM_PROTO_AT_GSM) },
1776 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1777 USB_CDC_ACM_PROTO_AT_3G) },
1778 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1779 USB_CDC_ACM_PROTO_AT_CDMA) },
1784 MODULE_DEVICE_TABLE(usb, acm_ids);
1786 static struct usb_driver acm_driver = {
1789 .disconnect = acm_disconnect,
1791 .suspend = acm_suspend,
1792 .resume = acm_resume,
1793 .reset_resume = acm_reset_resume,
1795 .id_table = acm_ids,
1797 .supports_autosuspend = 1,
1799 .disable_hub_initiated_lpm = 1,
1803 * TTY driver structures.
1806 static const struct tty_operations acm_ops = {
1807 .install = acm_tty_install,
1808 .open = acm_tty_open,
1809 .close = acm_tty_close,
1810 .cleanup = acm_tty_cleanup,
1811 .hangup = acm_tty_hangup,
1812 .write = acm_tty_write,
1813 .write_room = acm_tty_write_room,
1814 .ioctl = acm_tty_ioctl,
1815 .throttle = acm_tty_throttle,
1816 .unthrottle = acm_tty_unthrottle,
1817 .chars_in_buffer = acm_tty_chars_in_buffer,
1818 .break_ctl = acm_tty_break_ctl,
1819 .set_termios = acm_tty_set_termios,
1820 .tiocmget = acm_tty_tiocmget,
1821 .tiocmset = acm_tty_tiocmset,
1828 static int __init acm_init(void)
1831 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1832 if (!acm_tty_driver)
1834 acm_tty_driver->driver_name = "acm",
1835 acm_tty_driver->name = "ttyACM",
1836 acm_tty_driver->major = ACM_TTY_MAJOR,
1837 acm_tty_driver->minor_start = 0,
1838 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1839 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1840 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1841 acm_tty_driver->init_termios = tty_std_termios;
1842 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1844 tty_set_operations(acm_tty_driver, &acm_ops);
1846 retval = tty_register_driver(acm_tty_driver);
1848 put_tty_driver(acm_tty_driver);
1852 retval = usb_register(&acm_driver);
1854 tty_unregister_driver(acm_tty_driver);
1855 put_tty_driver(acm_tty_driver);
1859 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1864 static void __exit acm_exit(void)
1866 usb_deregister(&acm_driver);
1867 tty_unregister_driver(acm_tty_driver);
1868 put_tty_driver(acm_tty_driver);
1871 module_init(acm_init);
1872 module_exit(acm_exit);
1874 MODULE_AUTHOR(DRIVER_AUTHOR);
1875 MODULE_DESCRIPTION(DRIVER_DESC);
1876 MODULE_LICENSE("GPL");
1877 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);