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 acm_tty_ioctl(struct tty_struct *tty,
857 unsigned int cmd, unsigned long arg)
859 struct acm *acm = tty->driver_data;
860 int rv = -ENOIOCTLCMD;
863 case TIOCGSERIAL: /* gets serial port data */
864 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
867 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
870 rv = wait_serial_change(acm, arg);
877 static void acm_tty_set_termios(struct tty_struct *tty,
878 struct ktermios *termios_old)
880 struct acm *acm = tty->driver_data;
881 struct ktermios *termios = &tty->termios;
882 struct usb_cdc_line_coding newline;
883 int newctrl = acm->ctrlout;
885 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
886 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
887 newline.bParityType = termios->c_cflag & PARENB ?
888 (termios->c_cflag & PARODD ? 1 : 2) +
889 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
890 switch (termios->c_cflag & CSIZE) {
892 newline.bDataBits = 5;
895 newline.bDataBits = 6;
898 newline.bDataBits = 7;
902 newline.bDataBits = 8;
905 /* FIXME: Needs to clear unsupported bits in the termios */
906 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
908 if (!newline.dwDTERate) {
909 newline.dwDTERate = acm->line.dwDTERate;
910 newctrl &= ~ACM_CTRL_DTR;
912 newctrl |= ACM_CTRL_DTR;
914 if (newctrl != acm->ctrlout)
915 acm_set_control(acm, acm->ctrlout = newctrl);
917 if (memcmp(&acm->line, &newline, sizeof newline)) {
918 memcpy(&acm->line, &newline, sizeof newline);
919 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
921 le32_to_cpu(newline.dwDTERate),
922 newline.bCharFormat, newline.bParityType,
924 acm_set_line(acm, &acm->line);
928 static const struct tty_port_operations acm_port_ops = {
929 .shutdown = acm_port_shutdown,
930 .activate = acm_port_activate,
931 .destruct = acm_port_destruct,
935 * USB probe and disconnect routines.
938 /* Little helpers: write/read buffers free */
939 static void acm_write_buffers_free(struct acm *acm)
943 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
945 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
946 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
949 static void acm_read_buffers_free(struct acm *acm)
951 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
954 for (i = 0; i < acm->rx_buflimit; i++)
955 usb_free_coherent(usb_dev, acm->readsize,
956 acm->read_buffers[i].base, acm->read_buffers[i].dma);
959 /* Little helper: write buffers allocate */
960 static int acm_write_buffers_alloc(struct acm *acm)
965 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
966 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
972 usb_free_coherent(acm->dev, acm->writesize,
981 static int acm_probe(struct usb_interface *intf,
982 const struct usb_device_id *id)
984 struct usb_cdc_union_desc *union_header = NULL;
985 struct usb_cdc_country_functional_desc *cfd = NULL;
986 unsigned char *buffer = intf->altsetting->extra;
987 int buflen = intf->altsetting->extralen;
988 struct usb_interface *control_interface;
989 struct usb_interface *data_interface;
990 struct usb_endpoint_descriptor *epctrl = NULL;
991 struct usb_endpoint_descriptor *epread = NULL;
992 struct usb_endpoint_descriptor *epwrite = NULL;
993 struct usb_device *usb_dev = interface_to_usbdev(intf);
996 int ctrlsize, readsize;
998 u8 ac_management_function = 0;
999 u8 call_management_function = 0;
1000 int call_interface_num = -1;
1001 int data_interface_num = -1;
1002 unsigned long quirks;
1005 int combined_interfaces = 0;
1006 struct device *tty_dev;
1010 quirks = (unsigned long)id->driver_info;
1012 if (quirks == IGNORE_DEVICE)
1015 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1017 /* handle quirks deadly to normal probing*/
1018 if (quirks == NO_UNION_NORMAL) {
1019 data_interface = usb_ifnum_to_if(usb_dev, 1);
1020 control_interface = usb_ifnum_to_if(usb_dev, 0);
1021 goto skip_normal_probe;
1026 dev_err(&intf->dev, "Weird descriptor references\n");
1031 if (intf->cur_altsetting->endpoint &&
1032 intf->cur_altsetting->endpoint->extralen &&
1033 intf->cur_altsetting->endpoint->extra) {
1035 "Seeking extra descriptors on endpoint\n");
1036 buflen = intf->cur_altsetting->endpoint->extralen;
1037 buffer = intf->cur_altsetting->endpoint->extra;
1040 "Zero length descriptor references\n");
1045 while (buflen > 0) {
1046 if (buffer[1] != USB_DT_CS_INTERFACE) {
1047 dev_err(&intf->dev, "skipping garbage\n");
1051 switch (buffer[2]) {
1052 case USB_CDC_UNION_TYPE: /* we've found it */
1054 dev_err(&intf->dev, "More than one "
1055 "union descriptor, skipping ...\n");
1058 union_header = (struct usb_cdc_union_desc *)buffer;
1060 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1061 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1063 case USB_CDC_HEADER_TYPE: /* maybe check version */
1064 break; /* for now we ignore it */
1065 case USB_CDC_ACM_TYPE:
1066 ac_management_function = buffer[3];
1068 case USB_CDC_CALL_MANAGEMENT_TYPE:
1069 call_management_function = buffer[3];
1070 call_interface_num = buffer[4];
1071 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1072 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1075 /* there are LOTS more CDC descriptors that
1076 * could legitimately be found here.
1078 dev_dbg(&intf->dev, "Ignoring descriptor: "
1079 "type %02x, length %d\n",
1080 buffer[2], buffer[0]);
1084 buflen -= buffer[0];
1085 buffer += buffer[0];
1088 if (!union_header) {
1089 if (call_interface_num > 0) {
1090 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1091 /* quirks for Droids MuIn LCD */
1092 if (quirks & NO_DATA_INTERFACE)
1093 data_interface = usb_ifnum_to_if(usb_dev, 0);
1095 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1096 control_interface = intf;
1098 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1099 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1102 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1103 combined_interfaces = 1;
1104 control_interface = data_interface = intf;
1105 goto look_for_collapsed_interface;
1109 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1110 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1111 if (!control_interface || !data_interface) {
1112 dev_dbg(&intf->dev, "no interfaces\n");
1117 if (data_interface_num != call_interface_num)
1118 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1120 if (control_interface == data_interface) {
1121 /* some broken devices designed for windows work this way */
1122 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1123 combined_interfaces = 1;
1124 /* a popular other OS doesn't use it */
1125 quirks |= NO_CAP_LINE;
1126 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1127 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1130 look_for_collapsed_interface:
1131 for (i = 0; i < 3; i++) {
1132 struct usb_endpoint_descriptor *ep;
1133 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1135 if (usb_endpoint_is_int_in(ep))
1137 else if (usb_endpoint_is_bulk_out(ep))
1139 else if (usb_endpoint_is_bulk_in(ep))
1144 if (!epctrl || !epread || !epwrite)
1147 goto made_compressed_probe;
1152 /*workaround for switched interfaces */
1153 if (data_interface->cur_altsetting->desc.bInterfaceClass
1154 != CDC_DATA_INTERFACE_TYPE) {
1155 if (control_interface->cur_altsetting->desc.bInterfaceClass
1156 == CDC_DATA_INTERFACE_TYPE) {
1157 struct usb_interface *t;
1159 "Your device has switched interfaces.\n");
1160 t = control_interface;
1161 control_interface = data_interface;
1168 /* Accept probe requests only for the control interface */
1169 if (!combined_interfaces && intf != control_interface)
1172 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1173 /* valid in this context */
1174 dev_dbg(&intf->dev, "The data interface isn't available\n");
1179 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1180 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1183 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1184 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1185 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1188 /* workaround for switched endpoints */
1189 if (!usb_endpoint_dir_in(epread)) {
1190 /* descriptors are swapped */
1191 struct usb_endpoint_descriptor *t;
1193 "The data interface has switched endpoints\n");
1198 made_compressed_probe:
1199 dev_dbg(&intf->dev, "interfaces are valid\n");
1201 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1203 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1207 minor = acm_alloc_minor(acm);
1208 if (minor == ACM_TTY_MINORS) {
1209 dev_err(&intf->dev, "no more free acm devices\n");
1214 ctrlsize = usb_endpoint_maxp(epctrl);
1215 readsize = usb_endpoint_maxp(epread) *
1216 (quirks == SINGLE_RX_URB ? 1 : 2);
1217 acm->combined_interfaces = combined_interfaces;
1218 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1219 acm->control = control_interface;
1220 acm->data = data_interface;
1223 acm->ctrl_caps = ac_management_function;
1224 if (quirks & NO_CAP_LINE)
1225 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1226 acm->ctrlsize = ctrlsize;
1227 acm->readsize = readsize;
1228 acm->rx_buflimit = num_rx_buf;
1229 INIT_WORK(&acm->work, acm_softint);
1230 init_waitqueue_head(&acm->wioctl);
1231 spin_lock_init(&acm->write_lock);
1232 spin_lock_init(&acm->read_lock);
1233 mutex_init(&acm->mutex);
1234 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1235 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1237 acm->bInterval = epread->bInterval;
1238 tty_port_init(&acm->port);
1239 acm->port.ops = &acm_port_ops;
1241 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1243 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1246 acm->ctrl_buffer = buf;
1248 if (acm_write_buffers_alloc(acm) < 0) {
1249 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1253 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1254 if (!acm->ctrlurb) {
1255 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1258 for (i = 0; i < num_rx_buf; i++) {
1259 struct acm_rb *rb = &(acm->read_buffers[i]);
1262 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1265 dev_err(&intf->dev, "out of memory "
1266 "(read bufs usb_alloc_coherent)\n");
1272 urb = usb_alloc_urb(0, GFP_KERNEL);
1275 "out of memory (read urbs usb_alloc_urb)\n");
1278 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1279 urb->transfer_dma = rb->dma;
1280 if (acm->is_int_ep) {
1281 usb_fill_int_urb(urb, acm->dev,
1285 acm_read_bulk_callback, rb,
1288 usb_fill_bulk_urb(urb, acm->dev,
1292 acm_read_bulk_callback, rb);
1295 acm->read_urbs[i] = urb;
1296 __set_bit(i, &acm->read_urbs_free);
1298 for (i = 0; i < ACM_NW; i++) {
1299 struct acm_wb *snd = &(acm->wb[i]);
1301 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1302 if (snd->urb == NULL) {
1304 "out of memory (write urbs usb_alloc_urb)\n");
1308 if (usb_endpoint_xfer_int(epwrite))
1309 usb_fill_int_urb(snd->urb, usb_dev,
1310 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1311 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1313 usb_fill_bulk_urb(snd->urb, usb_dev,
1314 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1315 NULL, acm->writesize, acm_write_bulk, snd);
1316 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1317 snd->instance = acm;
1320 usb_set_intfdata(intf, acm);
1322 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1326 if (cfd) { /* export the country data */
1327 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1328 if (!acm->country_codes)
1329 goto skip_countries;
1330 acm->country_code_size = cfd->bLength - 4;
1331 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1333 acm->country_rel_date = cfd->iCountryCodeRelDate;
1335 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1337 kfree(acm->country_codes);
1338 acm->country_codes = NULL;
1339 acm->country_code_size = 0;
1340 goto skip_countries;
1343 i = device_create_file(&intf->dev,
1344 &dev_attr_iCountryCodeRelDate);
1346 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1347 kfree(acm->country_codes);
1348 acm->country_codes = NULL;
1349 acm->country_code_size = 0;
1350 goto skip_countries;
1355 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1356 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1357 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1358 /* works around buggy devices */
1359 epctrl->bInterval ? epctrl->bInterval : 16);
1360 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1361 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1363 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1365 acm_set_control(acm, acm->ctrlout);
1367 acm->line.dwDTERate = cpu_to_le32(9600);
1368 acm->line.bDataBits = 8;
1369 acm_set_line(acm, &acm->line);
1371 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1372 usb_set_intfdata(data_interface, acm);
1374 usb_get_intf(control_interface);
1375 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1376 &control_interface->dev);
1377 if (IS_ERR(tty_dev)) {
1378 rv = PTR_ERR(tty_dev);
1384 if (acm->country_codes) {
1385 device_remove_file(&acm->control->dev,
1386 &dev_attr_wCountryCodes);
1387 device_remove_file(&acm->control->dev,
1388 &dev_attr_iCountryCodeRelDate);
1390 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1392 usb_set_intfdata(intf, NULL);
1393 for (i = 0; i < ACM_NW; i++)
1394 usb_free_urb(acm->wb[i].urb);
1396 for (i = 0; i < num_rx_buf; i++)
1397 usb_free_urb(acm->read_urbs[i]);
1398 acm_read_buffers_free(acm);
1399 usb_free_urb(acm->ctrlurb);
1401 acm_write_buffers_free(acm);
1403 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1405 acm_release_minor(acm);
1411 static void stop_data_traffic(struct acm *acm)
1415 dev_dbg(&acm->control->dev, "%s\n", __func__);
1417 usb_kill_urb(acm->ctrlurb);
1418 for (i = 0; i < ACM_NW; i++)
1419 usb_kill_urb(acm->wb[i].urb);
1420 for (i = 0; i < acm->rx_buflimit; i++)
1421 usb_kill_urb(acm->read_urbs[i]);
1423 cancel_work_sync(&acm->work);
1426 static void acm_disconnect(struct usb_interface *intf)
1428 struct acm *acm = usb_get_intfdata(intf);
1429 struct usb_device *usb_dev = interface_to_usbdev(intf);
1430 struct tty_struct *tty;
1433 dev_dbg(&intf->dev, "%s\n", __func__);
1435 /* sibling interface is already cleaning up */
1439 mutex_lock(&acm->mutex);
1440 acm->disconnected = true;
1441 if (acm->country_codes) {
1442 device_remove_file(&acm->control->dev,
1443 &dev_attr_wCountryCodes);
1444 device_remove_file(&acm->control->dev,
1445 &dev_attr_iCountryCodeRelDate);
1447 wake_up_all(&acm->wioctl);
1448 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1449 usb_set_intfdata(acm->control, NULL);
1450 usb_set_intfdata(acm->data, NULL);
1451 mutex_unlock(&acm->mutex);
1453 tty = tty_port_tty_get(&acm->port);
1459 stop_data_traffic(acm);
1461 tty_unregister_device(acm_tty_driver, acm->minor);
1463 usb_free_urb(acm->ctrlurb);
1464 for (i = 0; i < ACM_NW; i++)
1465 usb_free_urb(acm->wb[i].urb);
1466 for (i = 0; i < acm->rx_buflimit; i++)
1467 usb_free_urb(acm->read_urbs[i]);
1468 acm_write_buffers_free(acm);
1469 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1470 acm_read_buffers_free(acm);
1472 if (!acm->combined_interfaces)
1473 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1474 acm->data : acm->control);
1476 tty_port_put(&acm->port);
1480 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1482 struct acm *acm = usb_get_intfdata(intf);
1485 if (PMSG_IS_AUTO(message)) {
1488 spin_lock_irq(&acm->write_lock);
1489 b = acm->transmitting;
1490 spin_unlock_irq(&acm->write_lock);
1495 spin_lock_irq(&acm->read_lock);
1496 spin_lock(&acm->write_lock);
1497 cnt = acm->susp_count++;
1498 spin_unlock(&acm->write_lock);
1499 spin_unlock_irq(&acm->read_lock);
1504 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1505 stop_data_traffic(acm);
1510 static int acm_resume(struct usb_interface *intf)
1512 struct acm *acm = usb_get_intfdata(intf);
1517 spin_lock_irq(&acm->read_lock);
1518 acm->susp_count -= 1;
1519 cnt = acm->susp_count;
1520 spin_unlock_irq(&acm->read_lock);
1525 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1526 rv = usb_submit_urb(acm->ctrlurb, GFP_NOIO);
1528 spin_lock_irq(&acm->write_lock);
1529 if (acm->delayed_wb) {
1530 wb = acm->delayed_wb;
1531 acm->delayed_wb = NULL;
1532 spin_unlock_irq(&acm->write_lock);
1533 acm_start_wb(acm, wb);
1535 spin_unlock_irq(&acm->write_lock);
1539 * delayed error checking because we must
1540 * do the write path at all cost
1545 rv = acm_submit_read_urbs(acm, GFP_NOIO);
1552 static int acm_reset_resume(struct usb_interface *intf)
1554 struct acm *acm = usb_get_intfdata(intf);
1556 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1557 tty_port_tty_hangup(&acm->port, false);
1559 return acm_resume(intf);
1562 #endif /* CONFIG_PM */
1564 #define NOKIA_PCSUITE_ACM_INFO(x) \
1565 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1566 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1567 USB_CDC_ACM_PROTO_VENDOR)
1569 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1570 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1571 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1572 USB_CDC_ACM_PROTO_VENDOR)
1575 * USB driver structure.
1578 static const struct usb_device_id acm_ids[] = {
1579 /* quirky and broken devices */
1580 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1581 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1583 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1584 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1586 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1587 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1589 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1590 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1592 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1593 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1595 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1596 .driver_info = SINGLE_RX_URB,
1598 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1599 .driver_info = SINGLE_RX_URB, /* firmware bug */
1601 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1602 .driver_info = SINGLE_RX_URB, /* firmware bug */
1604 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1605 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1607 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1608 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1610 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1611 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1613 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1614 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1616 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1617 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1619 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1621 /* Motorola H24 HSPA module: */
1622 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1623 { USB_DEVICE(0x22b8, 0x2d92) }, /* modem + diagnostics */
1624 { USB_DEVICE(0x22b8, 0x2d93) }, /* modem + AT port */
1625 { USB_DEVICE(0x22b8, 0x2d95) }, /* modem + AT port + diagnostics */
1626 { USB_DEVICE(0x22b8, 0x2d96) }, /* modem + NMEA */
1627 { USB_DEVICE(0x22b8, 0x2d97) }, /* modem + diagnostics + NMEA */
1628 { USB_DEVICE(0x22b8, 0x2d99) }, /* modem + AT port + NMEA */
1629 { USB_DEVICE(0x22b8, 0x2d9a) }, /* modem + AT port + diagnostics + NMEA */
1631 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1632 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1633 data interface instead of
1634 communications interface.
1635 Maybe we should define a new
1638 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1639 .driver_info = NO_UNION_NORMAL,
1641 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1642 .driver_info = NO_UNION_NORMAL,
1644 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1645 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1647 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1648 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1651 /* Nokia S60 phones expose two ACM channels. The first is
1652 * a modem and is picked up by the standard AT-command
1653 * information below. The second is 'vendor-specific' but
1654 * is treated as a serial device at the S60 end, so we want
1655 * to expose it on Linux too. */
1656 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1657 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1658 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1659 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1660 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1661 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1662 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1663 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1664 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1665 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1666 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1667 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1668 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1669 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1670 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1671 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1672 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1673 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1674 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1675 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1676 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1677 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1678 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1679 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1680 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1681 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1682 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1683 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1684 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1685 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1686 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1687 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1688 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1689 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1690 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1691 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1692 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1693 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1694 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1695 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1696 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1697 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1698 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1699 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1700 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1701 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1702 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1703 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1704 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1705 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1706 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1707 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1708 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1709 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1710 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1711 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1712 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1713 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1715 /* Support for Owen devices */
1716 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1718 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1720 /* Support Lego NXT using pbLua firmware */
1721 { USB_DEVICE(0x0694, 0xff00),
1722 .driver_info = NOT_A_MODEM,
1725 /* Support for Droids MuIn LCD */
1726 { USB_DEVICE(0x04d8, 0x000b),
1727 .driver_info = NO_DATA_INTERFACE,
1730 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1731 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1732 .driver_info = IGNORE_DEVICE,
1734 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1735 .driver_info = IGNORE_DEVICE,
1739 /* control interfaces without any protocol set */
1740 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1741 USB_CDC_PROTO_NONE) },
1743 /* control interfaces with various AT-command sets */
1744 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1745 USB_CDC_ACM_PROTO_AT_V25TER) },
1746 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1747 USB_CDC_ACM_PROTO_AT_PCCA101) },
1748 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1749 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1750 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1751 USB_CDC_ACM_PROTO_AT_GSM) },
1752 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1753 USB_CDC_ACM_PROTO_AT_3G) },
1754 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1755 USB_CDC_ACM_PROTO_AT_CDMA) },
1760 MODULE_DEVICE_TABLE(usb, acm_ids);
1762 static struct usb_driver acm_driver = {
1765 .disconnect = acm_disconnect,
1767 .suspend = acm_suspend,
1768 .resume = acm_resume,
1769 .reset_resume = acm_reset_resume,
1771 .id_table = acm_ids,
1773 .supports_autosuspend = 1,
1775 .disable_hub_initiated_lpm = 1,
1779 * TTY driver structures.
1782 static const struct tty_operations acm_ops = {
1783 .install = acm_tty_install,
1784 .open = acm_tty_open,
1785 .close = acm_tty_close,
1786 .cleanup = acm_tty_cleanup,
1787 .hangup = acm_tty_hangup,
1788 .write = acm_tty_write,
1789 .write_room = acm_tty_write_room,
1790 .ioctl = acm_tty_ioctl,
1791 .throttle = acm_tty_throttle,
1792 .unthrottle = acm_tty_unthrottle,
1793 .chars_in_buffer = acm_tty_chars_in_buffer,
1794 .break_ctl = acm_tty_break_ctl,
1795 .set_termios = acm_tty_set_termios,
1796 .tiocmget = acm_tty_tiocmget,
1797 .tiocmset = acm_tty_tiocmset,
1804 static int __init acm_init(void)
1807 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1808 if (!acm_tty_driver)
1810 acm_tty_driver->driver_name = "acm",
1811 acm_tty_driver->name = "ttyACM",
1812 acm_tty_driver->major = ACM_TTY_MAJOR,
1813 acm_tty_driver->minor_start = 0,
1814 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1815 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1816 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1817 acm_tty_driver->init_termios = tty_std_termios;
1818 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1820 tty_set_operations(acm_tty_driver, &acm_ops);
1822 retval = tty_register_driver(acm_tty_driver);
1824 put_tty_driver(acm_tty_driver);
1828 retval = usb_register(&acm_driver);
1830 tty_unregister_driver(acm_tty_driver);
1831 put_tty_driver(acm_tty_driver);
1835 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1840 static void __exit acm_exit(void)
1842 usb_deregister(&acm_driver);
1843 tty_unregister_driver(acm_tty_driver);
1844 put_tty_driver(acm_tty_driver);
1847 module_init(acm_init);
1848 module_exit(acm_exit);
1850 MODULE_AUTHOR(DRIVER_AUTHOR);
1851 MODULE_DESCRIPTION(DRIVER_DESC);
1852 MODULE_LICENSE("GPL");
1853 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);