4 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
5 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
6 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
9 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
10 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 * USB Abstract Control Model driver for USB modems and ISDN adapters
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/serial.h>
40 #include <linux/tty_driver.h>
41 #include <linux/tty_flip.h>
42 #include <linux/module.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/usb/cdc.h>
47 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
49 #include <linux/list.h>
54 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
55 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
57 static struct usb_driver acm_driver;
58 static struct tty_driver *acm_tty_driver;
59 static struct acm *acm_table[ACM_TTY_MINORS];
61 static DEFINE_MUTEX(acm_table_lock);
68 * Look up an ACM structure by index. If found and not disconnected, increment
69 * its refcount and return it with its mutex held.
71 static struct acm *acm_get_by_index(unsigned index)
75 mutex_lock(&acm_table_lock);
76 acm = acm_table[index];
78 mutex_lock(&acm->mutex);
79 if (acm->disconnected) {
80 mutex_unlock(&acm->mutex);
83 tty_port_get(&acm->port);
84 mutex_unlock(&acm->mutex);
87 mutex_unlock(&acm_table_lock);
92 * Try to find an available minor number and if found, associate it with 'acm'.
94 static int acm_alloc_minor(struct acm *acm)
98 mutex_lock(&acm_table_lock);
99 for (minor = 0; minor < ACM_TTY_MINORS; minor++) {
100 if (!acm_table[minor]) {
101 acm_table[minor] = acm;
105 mutex_unlock(&acm_table_lock);
110 /* Release the minor number associated with 'acm'. */
111 static void acm_release_minor(struct acm *acm)
113 mutex_lock(&acm_table_lock);
114 acm_table[acm->minor] = NULL;
115 mutex_unlock(&acm_table_lock);
119 * Functions for ACM control messages.
122 static int acm_ctrl_msg(struct acm *acm, int request, int value,
127 retval = usb_autopm_get_interface(acm->control);
131 retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
132 request, USB_RT_ACM, value,
133 acm->control->altsetting[0].desc.bInterfaceNumber,
136 dev_dbg(&acm->control->dev,
137 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
138 __func__, request, value, len, retval);
140 usb_autopm_put_interface(acm->control);
142 return retval < 0 ? retval : 0;
145 /* devices aren't required to support these requests.
146 * the cdc acm descriptor tells whether they do...
148 #define acm_set_control(acm, control) \
149 acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
150 #define acm_set_line(acm, line) \
151 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
152 #define acm_send_break(acm, ms) \
153 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
156 * Write buffer management.
157 * All of these assume proper locks taken by the caller.
160 static int acm_wb_alloc(struct acm *acm)
173 wbn = (wbn + 1) % ACM_NW;
179 static int acm_wb_is_avail(struct acm *acm)
185 spin_lock_irqsave(&acm->write_lock, flags);
186 for (i = 0; i < ACM_NW; i++)
188 spin_unlock_irqrestore(&acm->write_lock, flags);
193 * Finish write. Caller must hold acm->write_lock
195 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
199 usb_autopm_put_interface_async(acm->control);
205 * the caller is responsible for locking
208 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
214 wb->urb->transfer_buffer = wb->buf;
215 wb->urb->transfer_dma = wb->dmah;
216 wb->urb->transfer_buffer_length = wb->len;
217 wb->urb->dev = acm->dev;
219 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
221 dev_err(&acm->data->dev,
222 "%s - usb_submit_urb(write bulk) failed: %d\n",
224 acm_write_done(acm, wb);
230 * attributes exported through sysfs
232 static ssize_t show_caps
233 (struct device *dev, struct device_attribute *attr, char *buf)
235 struct usb_interface *intf = to_usb_interface(dev);
236 struct acm *acm = usb_get_intfdata(intf);
238 return sprintf(buf, "%d", acm->ctrl_caps);
240 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
242 static ssize_t show_country_codes
243 (struct device *dev, struct device_attribute *attr, char *buf)
245 struct usb_interface *intf = to_usb_interface(dev);
246 struct acm *acm = usb_get_intfdata(intf);
248 memcpy(buf, acm->country_codes, acm->country_code_size);
249 return acm->country_code_size;
252 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
254 static ssize_t show_country_rel_date
255 (struct device *dev, struct device_attribute *attr, char *buf)
257 struct usb_interface *intf = to_usb_interface(dev);
258 struct acm *acm = usb_get_intfdata(intf);
260 return sprintf(buf, "%d", acm->country_rel_date);
263 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
265 * Interrupt handlers for various ACM device responses
268 /* control interface reports status changes with "interrupt" transfers */
269 static void acm_ctrl_irq(struct urb *urb)
271 struct acm *acm = urb->context;
272 struct usb_cdc_notification *dr = urb->transfer_buffer;
277 int status = urb->status;
286 /* this urb is terminated, clean up */
287 dev_dbg(&acm->control->dev,
288 "%s - urb shutting down with status: %d\n",
292 dev_dbg(&acm->control->dev,
293 "%s - nonzero urb status received: %d\n",
298 usb_mark_last_busy(acm->dev);
300 data = (unsigned char *)(dr + 1);
301 switch (dr->bNotificationType) {
302 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
303 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
304 __func__, dr->wValue);
307 case USB_CDC_NOTIFY_SERIAL_STATE:
308 newctrl = get_unaligned_le16(data);
310 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
311 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
313 tty_port_tty_hangup(&acm->port, false);
316 difference = acm->ctrlin ^ newctrl;
317 spin_lock(&acm->read_lock);
318 acm->ctrlin = newctrl;
319 acm->oldcount = acm->iocount;
321 if (difference & ACM_CTRL_DSR)
323 if (difference & ACM_CTRL_BRK)
325 if (difference & ACM_CTRL_RI)
327 if (difference & ACM_CTRL_DCD)
329 if (difference & ACM_CTRL_FRAMING)
330 acm->iocount.frame++;
331 if (difference & ACM_CTRL_PARITY)
332 acm->iocount.parity++;
333 if (difference & ACM_CTRL_OVERRUN)
334 acm->iocount.overrun++;
335 spin_unlock(&acm->read_lock);
338 wake_up_all(&acm->wioctl);
343 dev_dbg(&acm->control->dev,
344 "%s - unknown notification %d received: index %d "
345 "len %d data0 %d data1 %d\n",
347 dr->bNotificationType, dr->wIndex,
348 dr->wLength, data[0], data[1]);
352 retval = usb_submit_urb(urb, GFP_ATOMIC);
354 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
358 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
362 if (!test_and_clear_bit(index, &acm->read_urbs_free))
365 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
367 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
370 dev_err(&acm->data->dev,
371 "%s - usb_submit_urb failed: %d\n",
374 set_bit(index, &acm->read_urbs_free);
381 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
386 for (i = 0; i < acm->rx_buflimit; ++i) {
387 res = acm_submit_read_urb(acm, i, mem_flags);
395 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
397 if (!urb->actual_length)
400 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
402 tty_flip_buffer_push(&acm->port);
405 static void acm_read_bulk_callback(struct urb *urb)
407 struct acm_rb *rb = urb->context;
408 struct acm *acm = rb->instance;
411 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
412 rb->index, urb->actual_length);
413 set_bit(rb->index, &acm->read_urbs_free);
416 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
421 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
422 __func__, urb->status);
426 usb_mark_last_busy(acm->dev);
428 acm_process_read_urb(acm, urb);
430 /* throttle device if requested by tty */
431 spin_lock_irqsave(&acm->read_lock, flags);
432 acm->throttled = acm->throttle_req;
433 if (!acm->throttled) {
434 spin_unlock_irqrestore(&acm->read_lock, flags);
435 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
437 spin_unlock_irqrestore(&acm->read_lock, flags);
441 /* data interface wrote those outgoing bytes */
442 static void acm_write_bulk(struct urb *urb)
444 struct acm_wb *wb = urb->context;
445 struct acm *acm = wb->instance;
448 if (urb->status || (urb->actual_length != urb->transfer_buffer_length))
449 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
452 urb->transfer_buffer_length,
455 spin_lock_irqsave(&acm->write_lock, flags);
456 acm_write_done(acm, wb);
457 spin_unlock_irqrestore(&acm->write_lock, flags);
458 schedule_work(&acm->work);
461 static void acm_softint(struct work_struct *work)
463 struct acm *acm = container_of(work, struct acm, work);
465 dev_vdbg(&acm->data->dev, "%s\n", __func__);
467 tty_port_tty_wakeup(&acm->port);
474 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
479 dev_dbg(tty->dev, "%s\n", __func__);
481 acm = acm_get_by_index(tty->index);
485 retval = tty_standard_install(driver, tty);
487 goto error_init_termios;
489 tty->driver_data = acm;
494 tty_port_put(&acm->port);
498 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
500 struct acm *acm = tty->driver_data;
502 dev_dbg(tty->dev, "%s\n", __func__);
504 return tty_port_open(&acm->port, tty, filp);
507 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
509 struct acm *acm = container_of(port, struct acm, port);
510 int retval = -ENODEV;
513 dev_dbg(&acm->control->dev, "%s\n", __func__);
515 mutex_lock(&acm->mutex);
516 if (acm->disconnected)
519 retval = usb_autopm_get_interface(acm->control);
521 goto error_get_interface;
524 * FIXME: Why do we need this? Allocating 64K of physically contiguous
525 * memory is really nasty...
527 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
528 acm->control->needs_remote_wakeup = 1;
530 acm->ctrlurb->dev = acm->dev;
531 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
533 dev_err(&acm->control->dev,
534 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
535 goto error_submit_urb;
538 acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS;
539 retval = acm_set_control(acm, acm->ctrlout);
540 if (retval < 0 && (acm->ctrl_caps & USB_CDC_CAP_LINE))
541 goto error_set_control;
544 * Unthrottle device in case the TTY was closed while throttled.
546 spin_lock_irq(&acm->read_lock);
548 acm->throttle_req = 0;
549 spin_unlock_irq(&acm->read_lock);
551 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
553 goto error_submit_read_urbs;
555 usb_autopm_put_interface(acm->control);
557 mutex_unlock(&acm->mutex);
561 error_submit_read_urbs:
562 for (i = 0; i < acm->rx_buflimit; i++)
563 usb_kill_urb(acm->read_urbs[i]);
565 acm_set_control(acm, acm->ctrlout);
567 usb_kill_urb(acm->ctrlurb);
569 usb_autopm_put_interface(acm->control);
572 mutex_unlock(&acm->mutex);
574 return usb_translate_errors(retval);
577 static void acm_port_destruct(struct tty_port *port)
579 struct acm *acm = container_of(port, struct acm, port);
581 dev_dbg(&acm->control->dev, "%s\n", __func__);
583 acm_release_minor(acm);
584 usb_put_intf(acm->control);
585 kfree(acm->country_codes);
589 static void acm_port_shutdown(struct tty_port *port)
591 struct acm *acm = container_of(port, struct acm, port);
596 dev_dbg(&acm->control->dev, "%s\n", __func__);
598 acm_set_control(acm, acm->ctrlout = 0);
601 * Need to grab write_lock to prevent race with resume, but no need to
602 * hold it due to the tty-port initialised flag.
604 spin_lock_irq(&acm->write_lock);
605 spin_unlock_irq(&acm->write_lock);
607 usb_autopm_get_interface_no_resume(acm->control);
608 acm->control->needs_remote_wakeup = 0;
609 usb_autopm_put_interface(acm->control);
612 urb = usb_get_from_anchor(&acm->delayed);
617 usb_autopm_put_interface_async(acm->control);
620 usb_kill_urb(acm->ctrlurb);
621 for (i = 0; i < ACM_NW; i++)
622 usb_kill_urb(acm->wb[i].urb);
623 for (i = 0; i < acm->rx_buflimit; i++)
624 usb_kill_urb(acm->read_urbs[i]);
627 static void acm_tty_cleanup(struct tty_struct *tty)
629 struct acm *acm = tty->driver_data;
630 dev_dbg(&acm->control->dev, "%s\n", __func__);
631 tty_port_put(&acm->port);
634 static void acm_tty_hangup(struct tty_struct *tty)
636 struct acm *acm = tty->driver_data;
637 dev_dbg(&acm->control->dev, "%s\n", __func__);
638 tty_port_hangup(&acm->port);
641 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
643 struct acm *acm = tty->driver_data;
644 dev_dbg(&acm->control->dev, "%s\n", __func__);
645 tty_port_close(&acm->port, tty, filp);
648 static int acm_tty_write(struct tty_struct *tty,
649 const unsigned char *buf, int count)
651 struct acm *acm = tty->driver_data;
660 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
662 spin_lock_irqsave(&acm->write_lock, flags);
663 wbn = acm_wb_alloc(acm);
665 spin_unlock_irqrestore(&acm->write_lock, flags);
672 spin_unlock_irqrestore(&acm->write_lock, flags);
676 count = (count > acm->writesize) ? acm->writesize : count;
677 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
678 memcpy(wb->buf, buf, count);
681 stat = usb_autopm_get_interface_async(acm->control);
684 spin_unlock_irqrestore(&acm->write_lock, flags);
688 if (acm->susp_count) {
689 usb_anchor_urb(wb->urb, &acm->delayed);
690 spin_unlock_irqrestore(&acm->write_lock, flags);
694 stat = acm_start_wb(acm, wb);
695 spin_unlock_irqrestore(&acm->write_lock, flags);
702 static int acm_tty_write_room(struct tty_struct *tty)
704 struct acm *acm = tty->driver_data;
706 * Do not let the line discipline to know that we have a reserve,
707 * or it might get too enthusiastic.
709 return acm_wb_is_avail(acm) ? acm->writesize : 0;
712 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
714 struct acm *acm = tty->driver_data;
716 * if the device was unplugged then any remaining characters fell out
717 * of the connector ;)
719 if (acm->disconnected)
722 * This is inaccurate (overcounts), but it works.
724 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
727 static void acm_tty_throttle(struct tty_struct *tty)
729 struct acm *acm = tty->driver_data;
731 spin_lock_irq(&acm->read_lock);
732 acm->throttle_req = 1;
733 spin_unlock_irq(&acm->read_lock);
736 static void acm_tty_unthrottle(struct tty_struct *tty)
738 struct acm *acm = tty->driver_data;
739 unsigned int was_throttled;
741 spin_lock_irq(&acm->read_lock);
742 was_throttled = acm->throttled;
744 acm->throttle_req = 0;
745 spin_unlock_irq(&acm->read_lock);
748 acm_submit_read_urbs(acm, GFP_KERNEL);
751 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
753 struct acm *acm = tty->driver_data;
756 retval = acm_send_break(acm, state ? 0xffff : 0);
758 dev_dbg(&acm->control->dev, "%s - send break failed\n",
763 static int acm_tty_tiocmget(struct tty_struct *tty)
765 struct acm *acm = tty->driver_data;
767 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
768 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
769 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
770 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
771 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
775 static int acm_tty_tiocmset(struct tty_struct *tty,
776 unsigned int set, unsigned int clear)
778 struct acm *acm = tty->driver_data;
779 unsigned int newctrl;
781 newctrl = acm->ctrlout;
782 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
783 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
784 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
785 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
787 newctrl = (newctrl & ~clear) | set;
789 if (acm->ctrlout == newctrl)
791 return acm_set_control(acm, acm->ctrlout = newctrl);
794 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
796 struct serial_struct tmp;
801 memset(&tmp, 0, sizeof(tmp));
802 tmp.flags = ASYNC_LOW_LATENCY;
803 tmp.xmit_fifo_size = acm->writesize;
804 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
805 tmp.close_delay = acm->port.close_delay / 10;
806 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
807 ASYNC_CLOSING_WAIT_NONE :
808 acm->port.closing_wait / 10;
810 if (copy_to_user(info, &tmp, sizeof(tmp)))
816 static int set_serial_info(struct acm *acm,
817 struct serial_struct __user *newinfo)
819 struct serial_struct new_serial;
820 unsigned int closing_wait, close_delay;
823 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
826 close_delay = new_serial.close_delay * 10;
827 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
828 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
830 mutex_lock(&acm->port.mutex);
832 if (!capable(CAP_SYS_ADMIN)) {
833 if ((close_delay != acm->port.close_delay) ||
834 (closing_wait != acm->port.closing_wait))
837 retval = -EOPNOTSUPP;
839 acm->port.close_delay = close_delay;
840 acm->port.closing_wait = closing_wait;
843 mutex_unlock(&acm->port.mutex);
847 static int wait_serial_change(struct acm *acm, unsigned long arg)
850 DECLARE_WAITQUEUE(wait, current);
851 struct async_icount old, new;
853 if (arg & (TIOCM_DSR | TIOCM_RI | TIOCM_CD ))
856 spin_lock_irq(&acm->read_lock);
860 spin_unlock_irq(&acm->read_lock);
862 if ((arg & TIOCM_DSR) &&
865 if ((arg & TIOCM_CD) &&
868 if ((arg & TIOCM_RI) &&
872 add_wait_queue(&acm->wioctl, &wait);
873 set_current_state(TASK_INTERRUPTIBLE);
875 remove_wait_queue(&acm->wioctl, &wait);
876 if (acm->disconnected) {
882 if (signal_pending(current))
892 static int get_serial_usage(struct acm *acm,
893 struct serial_icounter_struct __user *count)
895 struct serial_icounter_struct icount;
898 memset(&icount, 0, sizeof(icount));
899 icount.dsr = acm->iocount.dsr;
900 icount.rng = acm->iocount.rng;
901 icount.dcd = acm->iocount.dcd;
902 icount.frame = acm->iocount.frame;
903 icount.overrun = acm->iocount.overrun;
904 icount.parity = acm->iocount.parity;
905 icount.brk = acm->iocount.brk;
907 if (copy_to_user(count, &icount, sizeof(icount)) > 0)
913 static int acm_tty_ioctl(struct tty_struct *tty,
914 unsigned int cmd, unsigned long arg)
916 struct acm *acm = tty->driver_data;
917 int rv = -ENOIOCTLCMD;
920 case TIOCGSERIAL: /* gets serial port data */
921 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
924 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
927 rv = usb_autopm_get_interface(acm->control);
932 rv = wait_serial_change(acm, arg);
933 usb_autopm_put_interface(acm->control);
936 rv = get_serial_usage(acm, (struct serial_icounter_struct __user *) arg);
943 static void acm_tty_set_termios(struct tty_struct *tty,
944 struct ktermios *termios_old)
946 struct acm *acm = tty->driver_data;
947 struct ktermios *termios = &tty->termios;
948 struct usb_cdc_line_coding newline;
949 int newctrl = acm->ctrlout;
951 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
952 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
953 newline.bParityType = termios->c_cflag & PARENB ?
954 (termios->c_cflag & PARODD ? 1 : 2) +
955 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
956 switch (termios->c_cflag & CSIZE) {
958 newline.bDataBits = 5;
961 newline.bDataBits = 6;
964 newline.bDataBits = 7;
968 newline.bDataBits = 8;
971 /* FIXME: Needs to clear unsupported bits in the termios */
972 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
974 if (!newline.dwDTERate) {
975 newline.dwDTERate = acm->line.dwDTERate;
976 newctrl &= ~ACM_CTRL_DTR;
978 newctrl |= ACM_CTRL_DTR;
980 if (newctrl != acm->ctrlout)
981 acm_set_control(acm, acm->ctrlout = newctrl);
983 if (memcmp(&acm->line, &newline, sizeof newline)) {
984 memcpy(&acm->line, &newline, sizeof newline);
985 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
987 le32_to_cpu(newline.dwDTERate),
988 newline.bCharFormat, newline.bParityType,
990 acm_set_line(acm, &acm->line);
994 static const struct tty_port_operations acm_port_ops = {
995 .shutdown = acm_port_shutdown,
996 .activate = acm_port_activate,
997 .destruct = acm_port_destruct,
1001 * USB probe and disconnect routines.
1004 /* Little helpers: write/read buffers free */
1005 static void acm_write_buffers_free(struct acm *acm)
1009 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1011 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1012 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
1015 static void acm_read_buffers_free(struct acm *acm)
1017 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1020 for (i = 0; i < acm->rx_buflimit; i++)
1021 usb_free_coherent(usb_dev, acm->readsize,
1022 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1025 /* Little helper: write buffers allocate */
1026 static int acm_write_buffers_alloc(struct acm *acm)
1031 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1032 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1038 usb_free_coherent(acm->dev, acm->writesize,
1047 static int acm_probe(struct usb_interface *intf,
1048 const struct usb_device_id *id)
1050 struct usb_cdc_union_desc *union_header = NULL;
1051 struct usb_cdc_country_functional_desc *cfd = NULL;
1052 unsigned char *buffer = intf->altsetting->extra;
1053 int buflen = intf->altsetting->extralen;
1054 struct usb_interface *control_interface;
1055 struct usb_interface *data_interface;
1056 struct usb_endpoint_descriptor *epctrl = NULL;
1057 struct usb_endpoint_descriptor *epread = NULL;
1058 struct usb_endpoint_descriptor *epwrite = NULL;
1059 struct usb_device *usb_dev = interface_to_usbdev(intf);
1062 int ctrlsize, readsize;
1064 u8 ac_management_function = 0;
1065 u8 call_management_function = 0;
1066 int call_interface_num = -1;
1067 int data_interface_num = -1;
1068 unsigned long quirks;
1071 int combined_interfaces = 0;
1072 struct device *tty_dev;
1076 quirks = (unsigned long)id->driver_info;
1078 if (quirks == IGNORE_DEVICE)
1081 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1083 /* handle quirks deadly to normal probing*/
1084 if (quirks == NO_UNION_NORMAL) {
1085 data_interface = usb_ifnum_to_if(usb_dev, 1);
1086 control_interface = usb_ifnum_to_if(usb_dev, 0);
1087 goto skip_normal_probe;
1092 dev_err(&intf->dev, "Weird descriptor references\n");
1097 if (intf->cur_altsetting->endpoint &&
1098 intf->cur_altsetting->endpoint->extralen &&
1099 intf->cur_altsetting->endpoint->extra) {
1101 "Seeking extra descriptors on endpoint\n");
1102 buflen = intf->cur_altsetting->endpoint->extralen;
1103 buffer = intf->cur_altsetting->endpoint->extra;
1106 "Zero length descriptor references\n");
1111 while (buflen > 0) {
1112 if (buffer[1] != USB_DT_CS_INTERFACE) {
1113 dev_err(&intf->dev, "skipping garbage\n");
1117 switch (buffer[2]) {
1118 case USB_CDC_UNION_TYPE: /* we've found it */
1120 dev_err(&intf->dev, "More than one "
1121 "union descriptor, skipping ...\n");
1124 union_header = (struct usb_cdc_union_desc *)buffer;
1126 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1127 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1129 case USB_CDC_HEADER_TYPE: /* maybe check version */
1130 break; /* for now we ignore it */
1131 case USB_CDC_ACM_TYPE:
1132 ac_management_function = buffer[3];
1134 case USB_CDC_CALL_MANAGEMENT_TYPE:
1135 call_management_function = buffer[3];
1136 call_interface_num = buffer[4];
1137 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1138 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1141 /* there are LOTS more CDC descriptors that
1142 * could legitimately be found here.
1144 dev_dbg(&intf->dev, "Ignoring descriptor: "
1145 "type %02x, length %d\n",
1146 buffer[2], buffer[0]);
1150 buflen -= buffer[0];
1151 buffer += buffer[0];
1154 if (!union_header) {
1155 if (call_interface_num > 0) {
1156 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1157 /* quirks for Droids MuIn LCD */
1158 if (quirks & NO_DATA_INTERFACE)
1159 data_interface = usb_ifnum_to_if(usb_dev, 0);
1161 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1162 control_interface = intf;
1164 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1165 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1168 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1169 combined_interfaces = 1;
1170 control_interface = data_interface = intf;
1171 goto look_for_collapsed_interface;
1175 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1176 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1177 if (!control_interface || !data_interface) {
1178 dev_dbg(&intf->dev, "no interfaces\n");
1183 if (data_interface_num != call_interface_num)
1184 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1186 if (control_interface == data_interface) {
1187 /* some broken devices designed for windows work this way */
1188 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1189 combined_interfaces = 1;
1190 /* a popular other OS doesn't use it */
1191 quirks |= NO_CAP_LINE;
1192 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1193 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1196 look_for_collapsed_interface:
1197 for (i = 0; i < 3; i++) {
1198 struct usb_endpoint_descriptor *ep;
1199 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1201 if (usb_endpoint_is_int_in(ep))
1203 else if (usb_endpoint_is_bulk_out(ep))
1205 else if (usb_endpoint_is_bulk_in(ep))
1210 if (!epctrl || !epread || !epwrite)
1213 goto made_compressed_probe;
1218 /*workaround for switched interfaces */
1219 if (data_interface->cur_altsetting->desc.bInterfaceClass
1220 != CDC_DATA_INTERFACE_TYPE) {
1221 if (control_interface->cur_altsetting->desc.bInterfaceClass
1222 == CDC_DATA_INTERFACE_TYPE) {
1223 struct usb_interface *t;
1225 "Your device has switched interfaces.\n");
1226 t = control_interface;
1227 control_interface = data_interface;
1234 /* Accept probe requests only for the control interface */
1235 if (!combined_interfaces && intf != control_interface)
1238 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1239 /* valid in this context */
1240 dev_dbg(&intf->dev, "The data interface isn't available\n");
1245 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1246 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1249 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1250 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1251 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1254 /* workaround for switched endpoints */
1255 if (!usb_endpoint_dir_in(epread)) {
1256 /* descriptors are swapped */
1257 struct usb_endpoint_descriptor *t;
1259 "The data interface has switched endpoints\n");
1264 made_compressed_probe:
1265 dev_dbg(&intf->dev, "interfaces are valid\n");
1267 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1269 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1273 minor = acm_alloc_minor(acm);
1274 if (minor == ACM_TTY_MINORS) {
1275 dev_err(&intf->dev, "no more free acm devices\n");
1280 ctrlsize = usb_endpoint_maxp(epctrl);
1281 readsize = usb_endpoint_maxp(epread) *
1282 (quirks == SINGLE_RX_URB ? 1 : 2);
1283 acm->combined_interfaces = combined_interfaces;
1284 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1285 acm->control = control_interface;
1286 acm->data = data_interface;
1289 acm->ctrl_caps = ac_management_function;
1290 if (quirks & NO_CAP_LINE)
1291 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1292 acm->ctrlsize = ctrlsize;
1293 acm->readsize = readsize;
1294 acm->rx_buflimit = num_rx_buf;
1295 INIT_WORK(&acm->work, acm_softint);
1296 init_waitqueue_head(&acm->wioctl);
1297 spin_lock_init(&acm->write_lock);
1298 spin_lock_init(&acm->read_lock);
1299 mutex_init(&acm->mutex);
1300 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1301 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1303 acm->bInterval = epread->bInterval;
1304 tty_port_init(&acm->port);
1305 acm->port.ops = &acm_port_ops;
1306 init_usb_anchor(&acm->delayed);
1308 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1310 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1313 acm->ctrl_buffer = buf;
1315 if (acm_write_buffers_alloc(acm) < 0) {
1316 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1320 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1321 if (!acm->ctrlurb) {
1322 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1325 for (i = 0; i < num_rx_buf; i++) {
1326 struct acm_rb *rb = &(acm->read_buffers[i]);
1329 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1332 dev_err(&intf->dev, "out of memory "
1333 "(read bufs usb_alloc_coherent)\n");
1339 urb = usb_alloc_urb(0, GFP_KERNEL);
1342 "out of memory (read urbs usb_alloc_urb)\n");
1345 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1346 urb->transfer_dma = rb->dma;
1347 if (acm->is_int_ep) {
1348 usb_fill_int_urb(urb, acm->dev,
1352 acm_read_bulk_callback, rb,
1355 usb_fill_bulk_urb(urb, acm->dev,
1359 acm_read_bulk_callback, rb);
1362 acm->read_urbs[i] = urb;
1363 __set_bit(i, &acm->read_urbs_free);
1365 for (i = 0; i < ACM_NW; i++) {
1366 struct acm_wb *snd = &(acm->wb[i]);
1368 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1369 if (snd->urb == NULL) {
1371 "out of memory (write urbs usb_alloc_urb)\n");
1375 if (usb_endpoint_xfer_int(epwrite))
1376 usb_fill_int_urb(snd->urb, usb_dev,
1377 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1378 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1380 usb_fill_bulk_urb(snd->urb, usb_dev,
1381 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1382 NULL, acm->writesize, acm_write_bulk, snd);
1383 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1384 snd->instance = acm;
1387 usb_set_intfdata(intf, acm);
1389 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1393 if (cfd) { /* export the country data */
1394 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1395 if (!acm->country_codes)
1396 goto skip_countries;
1397 acm->country_code_size = cfd->bLength - 4;
1398 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1400 acm->country_rel_date = cfd->iCountryCodeRelDate;
1402 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1404 kfree(acm->country_codes);
1405 acm->country_codes = NULL;
1406 acm->country_code_size = 0;
1407 goto skip_countries;
1410 i = device_create_file(&intf->dev,
1411 &dev_attr_iCountryCodeRelDate);
1413 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1414 kfree(acm->country_codes);
1415 acm->country_codes = NULL;
1416 acm->country_code_size = 0;
1417 goto skip_countries;
1422 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1423 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1424 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1425 /* works around buggy devices */
1426 epctrl->bInterval ? epctrl->bInterval : 16);
1427 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1428 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1430 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1432 acm_set_control(acm, acm->ctrlout);
1434 acm->line.dwDTERate = cpu_to_le32(9600);
1435 acm->line.bDataBits = 8;
1436 acm_set_line(acm, &acm->line);
1438 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1439 usb_set_intfdata(data_interface, acm);
1441 usb_get_intf(control_interface);
1442 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1443 &control_interface->dev);
1444 if (IS_ERR(tty_dev)) {
1445 rv = PTR_ERR(tty_dev);
1451 if (acm->country_codes) {
1452 device_remove_file(&acm->control->dev,
1453 &dev_attr_wCountryCodes);
1454 device_remove_file(&acm->control->dev,
1455 &dev_attr_iCountryCodeRelDate);
1457 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1459 usb_set_intfdata(intf, NULL);
1460 for (i = 0; i < ACM_NW; i++)
1461 usb_free_urb(acm->wb[i].urb);
1463 for (i = 0; i < num_rx_buf; i++)
1464 usb_free_urb(acm->read_urbs[i]);
1465 acm_read_buffers_free(acm);
1466 usb_free_urb(acm->ctrlurb);
1468 acm_write_buffers_free(acm);
1470 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1472 acm_release_minor(acm);
1478 static void stop_data_traffic(struct acm *acm)
1482 dev_dbg(&acm->control->dev, "%s\n", __func__);
1484 usb_kill_urb(acm->ctrlurb);
1485 for (i = 0; i < ACM_NW; i++)
1486 usb_kill_urb(acm->wb[i].urb);
1487 for (i = 0; i < acm->rx_buflimit; i++)
1488 usb_kill_urb(acm->read_urbs[i]);
1490 cancel_work_sync(&acm->work);
1493 static void acm_disconnect(struct usb_interface *intf)
1495 struct acm *acm = usb_get_intfdata(intf);
1496 struct usb_device *usb_dev = interface_to_usbdev(intf);
1497 struct tty_struct *tty;
1500 dev_dbg(&intf->dev, "%s\n", __func__);
1502 /* sibling interface is already cleaning up */
1506 mutex_lock(&acm->mutex);
1507 acm->disconnected = true;
1508 if (acm->country_codes) {
1509 device_remove_file(&acm->control->dev,
1510 &dev_attr_wCountryCodes);
1511 device_remove_file(&acm->control->dev,
1512 &dev_attr_iCountryCodeRelDate);
1514 wake_up_all(&acm->wioctl);
1515 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1516 usb_set_intfdata(acm->control, NULL);
1517 usb_set_intfdata(acm->data, NULL);
1518 mutex_unlock(&acm->mutex);
1520 tty = tty_port_tty_get(&acm->port);
1526 stop_data_traffic(acm);
1528 tty_unregister_device(acm_tty_driver, acm->minor);
1530 usb_free_urb(acm->ctrlurb);
1531 for (i = 0; i < ACM_NW; i++)
1532 usb_free_urb(acm->wb[i].urb);
1533 for (i = 0; i < acm->rx_buflimit; i++)
1534 usb_free_urb(acm->read_urbs[i]);
1535 acm_write_buffers_free(acm);
1536 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1537 acm_read_buffers_free(acm);
1539 if (!acm->combined_interfaces)
1540 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1541 acm->data : acm->control);
1543 tty_port_put(&acm->port);
1547 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1549 struct acm *acm = usb_get_intfdata(intf);
1552 spin_lock_irq(&acm->write_lock);
1553 if (PMSG_IS_AUTO(message)) {
1554 if (acm->transmitting) {
1555 spin_unlock_irq(&acm->write_lock);
1559 cnt = acm->susp_count++;
1560 spin_unlock_irq(&acm->write_lock);
1565 stop_data_traffic(acm);
1570 static int acm_resume(struct usb_interface *intf)
1572 struct acm *acm = usb_get_intfdata(intf);
1576 spin_lock_irq(&acm->write_lock);
1578 if (--acm->susp_count)
1581 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1582 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1585 urb = usb_get_from_anchor(&acm->delayed);
1589 acm_start_wb(acm, urb->context);
1593 * delayed error checking because we must
1594 * do the write path at all cost
1599 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1602 spin_unlock_irq(&acm->write_lock);
1607 static int acm_reset_resume(struct usb_interface *intf)
1609 struct acm *acm = usb_get_intfdata(intf);
1611 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1612 tty_port_tty_hangup(&acm->port, false);
1614 return acm_resume(intf);
1617 #endif /* CONFIG_PM */
1619 #define NOKIA_PCSUITE_ACM_INFO(x) \
1620 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1621 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1622 USB_CDC_ACM_PROTO_VENDOR)
1624 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1625 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1626 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1627 USB_CDC_ACM_PROTO_VENDOR)
1630 * USB driver structure.
1633 static const struct usb_device_id acm_ids[] = {
1634 /* quirky and broken devices */
1635 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1636 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1637 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1638 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1640 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1641 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1643 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1644 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1646 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1647 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1649 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1650 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1652 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1653 .driver_info = SINGLE_RX_URB,
1655 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1656 .driver_info = SINGLE_RX_URB, /* firmware bug */
1658 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1659 .driver_info = SINGLE_RX_URB, /* firmware bug */
1661 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1662 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1664 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1665 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1667 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1668 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1670 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1671 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1673 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1674 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1676 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1678 /* Motorola H24 HSPA module: */
1679 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1680 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1681 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1683 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1684 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1686 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1687 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1689 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1690 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1692 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1693 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1695 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1696 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1698 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1699 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1702 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1703 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1704 data interface instead of
1705 communications interface.
1706 Maybe we should define a new
1709 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1710 .driver_info = NO_UNION_NORMAL,
1712 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1713 .driver_info = NO_UNION_NORMAL,
1715 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1716 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1718 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1719 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1722 /* Nokia S60 phones expose two ACM channels. The first is
1723 * a modem and is picked up by the standard AT-command
1724 * information below. The second is 'vendor-specific' but
1725 * is treated as a serial device at the S60 end, so we want
1726 * to expose it on Linux too. */
1727 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1728 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1729 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1730 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1731 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1732 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1733 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1734 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1735 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1736 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1737 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1738 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1739 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1740 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1741 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1742 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1743 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1744 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1745 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1746 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1747 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1748 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1749 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1750 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1751 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1752 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1753 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1754 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1755 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1756 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1757 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1758 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1759 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1760 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1761 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1762 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1763 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1764 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1765 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1766 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1767 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1768 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1769 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1770 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1771 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1772 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1773 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1774 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1775 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1776 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1777 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1778 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1779 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1780 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1781 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1782 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1783 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1784 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1786 /* Support for Owen devices */
1787 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1789 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1791 /* Support Lego NXT using pbLua firmware */
1792 { USB_DEVICE(0x0694, 0xff00),
1793 .driver_info = NOT_A_MODEM,
1796 /* Support for Droids MuIn LCD */
1797 { USB_DEVICE(0x04d8, 0x000b),
1798 .driver_info = NO_DATA_INTERFACE,
1801 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1802 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1803 .driver_info = IGNORE_DEVICE,
1805 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1806 .driver_info = IGNORE_DEVICE,
1810 /* control interfaces without any protocol set */
1811 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1812 USB_CDC_PROTO_NONE) },
1814 /* control interfaces with various AT-command sets */
1815 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1816 USB_CDC_ACM_PROTO_AT_V25TER) },
1817 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1818 USB_CDC_ACM_PROTO_AT_PCCA101) },
1819 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1820 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1821 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1822 USB_CDC_ACM_PROTO_AT_GSM) },
1823 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1824 USB_CDC_ACM_PROTO_AT_3G) },
1825 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1826 USB_CDC_ACM_PROTO_AT_CDMA) },
1831 MODULE_DEVICE_TABLE(usb, acm_ids);
1833 static struct usb_driver acm_driver = {
1836 .disconnect = acm_disconnect,
1838 .suspend = acm_suspend,
1839 .resume = acm_resume,
1840 .reset_resume = acm_reset_resume,
1842 .id_table = acm_ids,
1844 .supports_autosuspend = 1,
1846 .disable_hub_initiated_lpm = 1,
1850 * TTY driver structures.
1853 static const struct tty_operations acm_ops = {
1854 .install = acm_tty_install,
1855 .open = acm_tty_open,
1856 .close = acm_tty_close,
1857 .cleanup = acm_tty_cleanup,
1858 .hangup = acm_tty_hangup,
1859 .write = acm_tty_write,
1860 .write_room = acm_tty_write_room,
1861 .ioctl = acm_tty_ioctl,
1862 .throttle = acm_tty_throttle,
1863 .unthrottle = acm_tty_unthrottle,
1864 .chars_in_buffer = acm_tty_chars_in_buffer,
1865 .break_ctl = acm_tty_break_ctl,
1866 .set_termios = acm_tty_set_termios,
1867 .tiocmget = acm_tty_tiocmget,
1868 .tiocmset = acm_tty_tiocmset,
1875 static int __init acm_init(void)
1878 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1879 if (!acm_tty_driver)
1881 acm_tty_driver->driver_name = "acm",
1882 acm_tty_driver->name = "ttyACM",
1883 acm_tty_driver->major = ACM_TTY_MAJOR,
1884 acm_tty_driver->minor_start = 0,
1885 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1886 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1887 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1888 acm_tty_driver->init_termios = tty_std_termios;
1889 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1891 tty_set_operations(acm_tty_driver, &acm_ops);
1893 retval = tty_register_driver(acm_tty_driver);
1895 put_tty_driver(acm_tty_driver);
1899 retval = usb_register(&acm_driver);
1901 tty_unregister_driver(acm_tty_driver);
1902 put_tty_driver(acm_tty_driver);
1906 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1911 static void __exit acm_exit(void)
1913 usb_deregister(&acm_driver);
1914 tty_unregister_driver(acm_tty_driver);
1915 put_tty_driver(acm_tty_driver);
1918 module_init(acm_init);
1919 module_exit(acm_exit);
1921 MODULE_AUTHOR(DRIVER_AUTHOR);
1922 MODULE_DESCRIPTION(DRIVER_DESC);
1923 MODULE_LICENSE("GPL");
1924 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);