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/idr.h>
50 #include <linux/list.h>
55 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
56 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
58 static struct usb_driver acm_driver;
59 static struct tty_driver *acm_tty_driver;
61 static DEFINE_IDR(acm_minors);
62 static DEFINE_MUTEX(acm_minors_lock);
64 static void acm_tty_set_termios(struct tty_struct *tty,
65 struct ktermios *termios_old);
68 * acm_minors accessors
72 * Look up an ACM structure by minor. If found and not disconnected, increment
73 * its refcount and return it with its mutex held.
75 static struct acm *acm_get_by_minor(unsigned int minor)
79 mutex_lock(&acm_minors_lock);
80 acm = idr_find(&acm_minors, minor);
82 mutex_lock(&acm->mutex);
83 if (acm->disconnected) {
84 mutex_unlock(&acm->mutex);
87 tty_port_get(&acm->port);
88 mutex_unlock(&acm->mutex);
91 mutex_unlock(&acm_minors_lock);
96 * Try to find an available minor number and if found, associate it with 'acm'.
98 static int acm_alloc_minor(struct acm *acm)
102 mutex_lock(&acm_minors_lock);
103 minor = idr_alloc(&acm_minors, acm, 0, ACM_TTY_MINORS, GFP_KERNEL);
104 mutex_unlock(&acm_minors_lock);
109 /* Release the minor number associated with 'acm'. */
110 static void acm_release_minor(struct acm *acm)
112 mutex_lock(&acm_minors_lock);
113 idr_remove(&acm_minors, acm->minor);
114 mutex_unlock(&acm_minors_lock);
118 * Functions for ACM control messages.
121 static int acm_ctrl_msg(struct acm *acm, int request, int value,
126 retval = usb_autopm_get_interface(acm->control);
130 retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
131 request, USB_RT_ACM, value,
132 acm->control->altsetting[0].desc.bInterfaceNumber,
135 dev_dbg(&acm->control->dev,
136 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
137 __func__, request, value, len, retval);
139 usb_autopm_put_interface(acm->control);
141 return retval < 0 ? retval : 0;
144 /* devices aren't required to support these requests.
145 * the cdc acm descriptor tells whether they do...
147 static inline int acm_set_control(struct acm *acm, int control)
149 if (acm->quirks & QUIRK_CONTROL_LINE_STATE)
152 return acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE,
156 #define acm_set_line(acm, line) \
157 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
158 #define acm_send_break(acm, ms) \
159 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
162 * Write buffer management.
163 * All of these assume proper locks taken by the caller.
166 static int acm_wb_alloc(struct acm *acm)
179 wbn = (wbn + 1) % ACM_NW;
185 static int acm_wb_is_avail(struct acm *acm)
191 spin_lock_irqsave(&acm->write_lock, flags);
192 for (i = 0; i < ACM_NW; i++)
194 spin_unlock_irqrestore(&acm->write_lock, flags);
199 * Finish write. Caller must hold acm->write_lock
201 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
205 usb_autopm_put_interface_async(acm->control);
211 * the caller is responsible for locking
214 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
220 wb->urb->transfer_buffer = wb->buf;
221 wb->urb->transfer_dma = wb->dmah;
222 wb->urb->transfer_buffer_length = wb->len;
223 wb->urb->dev = acm->dev;
225 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
227 dev_err(&acm->data->dev,
228 "%s - usb_submit_urb(write bulk) failed: %d\n",
230 acm_write_done(acm, wb);
236 * attributes exported through sysfs
238 static ssize_t show_caps
239 (struct device *dev, struct device_attribute *attr, char *buf)
241 struct usb_interface *intf = to_usb_interface(dev);
242 struct acm *acm = usb_get_intfdata(intf);
244 return sprintf(buf, "%d", acm->ctrl_caps);
246 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
248 static ssize_t show_country_codes
249 (struct device *dev, struct device_attribute *attr, char *buf)
251 struct usb_interface *intf = to_usb_interface(dev);
252 struct acm *acm = usb_get_intfdata(intf);
254 memcpy(buf, acm->country_codes, acm->country_code_size);
255 return acm->country_code_size;
258 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
260 static ssize_t show_country_rel_date
261 (struct device *dev, struct device_attribute *attr, char *buf)
263 struct usb_interface *intf = to_usb_interface(dev);
264 struct acm *acm = usb_get_intfdata(intf);
266 return sprintf(buf, "%d", acm->country_rel_date);
269 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
271 * Interrupt handlers for various ACM device responses
274 /* control interface reports status changes with "interrupt" transfers */
275 static void acm_ctrl_irq(struct urb *urb)
277 struct acm *acm = urb->context;
278 struct usb_cdc_notification *dr = urb->transfer_buffer;
283 int status = urb->status;
292 /* this urb is terminated, clean up */
293 dev_dbg(&acm->control->dev,
294 "%s - urb shutting down with status: %d\n",
298 dev_dbg(&acm->control->dev,
299 "%s - nonzero urb status received: %d\n",
304 usb_mark_last_busy(acm->dev);
306 data = (unsigned char *)(dr + 1);
307 switch (dr->bNotificationType) {
308 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
309 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
310 __func__, dr->wValue);
313 case USB_CDC_NOTIFY_SERIAL_STATE:
314 if (le16_to_cpu(dr->wLength) != 2) {
315 dev_dbg(&acm->control->dev,
316 "%s - malformed serial state\n", __func__);
320 newctrl = get_unaligned_le16(data);
322 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
323 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
325 tty_port_tty_hangup(&acm->port, false);
328 difference = acm->ctrlin ^ newctrl;
329 spin_lock(&acm->read_lock);
330 acm->ctrlin = newctrl;
331 acm->oldcount = acm->iocount;
333 if (difference & ACM_CTRL_DSR)
335 if (difference & ACM_CTRL_DCD)
337 if (newctrl & ACM_CTRL_BRK)
339 if (newctrl & ACM_CTRL_RI)
341 if (newctrl & ACM_CTRL_FRAMING)
342 acm->iocount.frame++;
343 if (newctrl & ACM_CTRL_PARITY)
344 acm->iocount.parity++;
345 if (newctrl & ACM_CTRL_OVERRUN)
346 acm->iocount.overrun++;
347 spin_unlock(&acm->read_lock);
350 wake_up_all(&acm->wioctl);
355 dev_dbg(&acm->control->dev,
356 "%s - unknown notification %d received: index %d len %d\n",
358 dr->bNotificationType, dr->wIndex, dr->wLength);
363 retval = usb_submit_urb(urb, GFP_ATOMIC);
364 if (retval && retval != -EPERM)
365 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
369 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
373 if (!test_and_clear_bit(index, &acm->read_urbs_free))
376 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
378 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
380 if (res != -EPERM && res != -ENODEV) {
381 dev_err(&acm->data->dev,
382 "%s - usb_submit_urb failed: %d\n",
385 set_bit(index, &acm->read_urbs_free);
392 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
397 for (i = 0; i < acm->rx_buflimit; ++i) {
398 res = acm_submit_read_urb(acm, i, mem_flags);
406 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
408 if (!urb->actual_length)
411 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
413 tty_flip_buffer_push(&acm->port);
416 static void acm_read_bulk_callback(struct urb *urb)
418 struct acm_rb *rb = urb->context;
419 struct acm *acm = rb->instance;
421 int status = urb->status;
423 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
424 rb->index, urb->actual_length);
427 set_bit(rb->index, &acm->read_urbs_free);
428 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
433 set_bit(rb->index, &acm->read_urbs_free);
434 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
436 if ((status != -ENOENT) || (urb->actual_length == 0))
440 usb_mark_last_busy(acm->dev);
442 acm_process_read_urb(acm, urb);
444 * Unthrottle may run on another CPU which needs to see events
445 * in the same order. Submission has an implict barrier
447 smp_mb__before_atomic();
448 set_bit(rb->index, &acm->read_urbs_free);
450 /* throttle device if requested by tty */
451 spin_lock_irqsave(&acm->read_lock, flags);
452 acm->throttled = acm->throttle_req;
453 if (!acm->throttled) {
454 spin_unlock_irqrestore(&acm->read_lock, flags);
455 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
457 spin_unlock_irqrestore(&acm->read_lock, flags);
461 /* data interface wrote those outgoing bytes */
462 static void acm_write_bulk(struct urb *urb)
464 struct acm_wb *wb = urb->context;
465 struct acm *acm = wb->instance;
467 int status = urb->status;
469 if (status || (urb->actual_length != urb->transfer_buffer_length))
470 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
473 urb->transfer_buffer_length,
476 spin_lock_irqsave(&acm->write_lock, flags);
477 acm_write_done(acm, wb);
478 spin_unlock_irqrestore(&acm->write_lock, flags);
479 schedule_work(&acm->work);
482 static void acm_softint(struct work_struct *work)
484 struct acm *acm = container_of(work, struct acm, work);
486 dev_vdbg(&acm->data->dev, "%s\n", __func__);
488 tty_port_tty_wakeup(&acm->port);
495 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
500 dev_dbg(tty->dev, "%s\n", __func__);
502 acm = acm_get_by_minor(tty->index);
506 retval = tty_standard_install(driver, tty);
508 goto error_init_termios;
511 * Suppress initial echoing for some devices which might send data
512 * immediately after acm driver has been installed.
514 if (acm->quirks & DISABLE_ECHO)
515 tty->termios.c_lflag &= ~ECHO;
517 tty->driver_data = acm;
522 tty_port_put(&acm->port);
526 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
528 struct acm *acm = tty->driver_data;
530 dev_dbg(tty->dev, "%s\n", __func__);
532 return tty_port_open(&acm->port, tty, filp);
535 static void acm_port_dtr_rts(struct tty_port *port, int raise)
537 struct acm *acm = container_of(port, struct acm, port);
542 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
546 /* FIXME: add missing ctrlout locking throughout driver */
549 res = acm_set_control(acm, val);
550 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
551 dev_err(&acm->control->dev, "failed to set dtr/rts\n");
554 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
556 struct acm *acm = container_of(port, struct acm, port);
557 int retval = -ENODEV;
560 dev_dbg(&acm->control->dev, "%s\n", __func__);
562 mutex_lock(&acm->mutex);
563 if (acm->disconnected)
566 retval = usb_autopm_get_interface(acm->control);
568 goto error_get_interface;
571 * FIXME: Why do we need this? Allocating 64K of physically contiguous
572 * memory is really nasty...
574 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
575 acm->control->needs_remote_wakeup = 1;
577 acm->ctrlurb->dev = acm->dev;
578 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
580 dev_err(&acm->control->dev,
581 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
582 goto error_submit_urb;
585 acm_tty_set_termios(tty, NULL);
588 * Unthrottle device in case the TTY was closed while throttled.
590 spin_lock_irq(&acm->read_lock);
592 acm->throttle_req = 0;
593 spin_unlock_irq(&acm->read_lock);
595 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
597 goto error_submit_read_urbs;
599 usb_autopm_put_interface(acm->control);
601 mutex_unlock(&acm->mutex);
605 error_submit_read_urbs:
606 for (i = 0; i < acm->rx_buflimit; i++)
607 usb_kill_urb(acm->read_urbs[i]);
608 usb_kill_urb(acm->ctrlurb);
610 usb_autopm_put_interface(acm->control);
613 mutex_unlock(&acm->mutex);
615 return usb_translate_errors(retval);
618 static void acm_port_destruct(struct tty_port *port)
620 struct acm *acm = container_of(port, struct acm, port);
622 dev_dbg(&acm->control->dev, "%s\n", __func__);
624 acm_release_minor(acm);
625 usb_put_intf(acm->control);
626 kfree(acm->country_codes);
630 static void acm_port_shutdown(struct tty_port *port)
632 struct acm *acm = container_of(port, struct acm, port);
637 dev_dbg(&acm->control->dev, "%s\n", __func__);
640 * Need to grab write_lock to prevent race with resume, but no need to
641 * hold it due to the tty-port initialised flag.
643 spin_lock_irq(&acm->write_lock);
644 spin_unlock_irq(&acm->write_lock);
646 usb_autopm_get_interface_no_resume(acm->control);
647 acm->control->needs_remote_wakeup = 0;
648 usb_autopm_put_interface(acm->control);
651 urb = usb_get_from_anchor(&acm->delayed);
656 usb_autopm_put_interface_async(acm->control);
659 usb_kill_urb(acm->ctrlurb);
660 for (i = 0; i < ACM_NW; i++)
661 usb_kill_urb(acm->wb[i].urb);
662 for (i = 0; i < acm->rx_buflimit; i++)
663 usb_kill_urb(acm->read_urbs[i]);
666 static void acm_tty_cleanup(struct tty_struct *tty)
668 struct acm *acm = tty->driver_data;
669 dev_dbg(&acm->control->dev, "%s\n", __func__);
670 tty_port_put(&acm->port);
673 static void acm_tty_hangup(struct tty_struct *tty)
675 struct acm *acm = tty->driver_data;
676 dev_dbg(&acm->control->dev, "%s\n", __func__);
677 tty_port_hangup(&acm->port);
680 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
682 struct acm *acm = tty->driver_data;
683 dev_dbg(&acm->control->dev, "%s\n", __func__);
684 tty_port_close(&acm->port, tty, filp);
687 static int acm_tty_write(struct tty_struct *tty,
688 const unsigned char *buf, int count)
690 struct acm *acm = tty->driver_data;
699 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
701 spin_lock_irqsave(&acm->write_lock, flags);
702 wbn = acm_wb_alloc(acm);
704 spin_unlock_irqrestore(&acm->write_lock, flags);
711 spin_unlock_irqrestore(&acm->write_lock, flags);
715 count = (count > acm->writesize) ? acm->writesize : count;
716 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
717 memcpy(wb->buf, buf, count);
720 stat = usb_autopm_get_interface_async(acm->control);
723 spin_unlock_irqrestore(&acm->write_lock, flags);
727 if (acm->susp_count) {
728 usb_anchor_urb(wb->urb, &acm->delayed);
729 spin_unlock_irqrestore(&acm->write_lock, flags);
733 stat = acm_start_wb(acm, wb);
734 spin_unlock_irqrestore(&acm->write_lock, flags);
741 static int acm_tty_write_room(struct tty_struct *tty)
743 struct acm *acm = tty->driver_data;
745 * Do not let the line discipline to know that we have a reserve,
746 * or it might get too enthusiastic.
748 return acm_wb_is_avail(acm) ? acm->writesize : 0;
751 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
753 struct acm *acm = tty->driver_data;
755 * if the device was unplugged then any remaining characters fell out
756 * of the connector ;)
758 if (acm->disconnected)
761 * This is inaccurate (overcounts), but it works.
763 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
766 static void acm_tty_throttle(struct tty_struct *tty)
768 struct acm *acm = tty->driver_data;
770 spin_lock_irq(&acm->read_lock);
771 acm->throttle_req = 1;
772 spin_unlock_irq(&acm->read_lock);
775 static void acm_tty_unthrottle(struct tty_struct *tty)
777 struct acm *acm = tty->driver_data;
778 unsigned int was_throttled;
780 spin_lock_irq(&acm->read_lock);
781 was_throttled = acm->throttled;
783 acm->throttle_req = 0;
784 spin_unlock_irq(&acm->read_lock);
787 acm_submit_read_urbs(acm, GFP_KERNEL);
790 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
792 struct acm *acm = tty->driver_data;
795 retval = acm_send_break(acm, state ? 0xffff : 0);
797 dev_dbg(&acm->control->dev, "%s - send break failed\n",
802 static int acm_tty_tiocmget(struct tty_struct *tty)
804 struct acm *acm = tty->driver_data;
806 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
807 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
808 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
809 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
810 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
814 static int acm_tty_tiocmset(struct tty_struct *tty,
815 unsigned int set, unsigned int clear)
817 struct acm *acm = tty->driver_data;
818 unsigned int newctrl;
820 newctrl = acm->ctrlout;
821 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
822 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
823 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
824 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
826 newctrl = (newctrl & ~clear) | set;
828 if (acm->ctrlout == newctrl)
830 return acm_set_control(acm, acm->ctrlout = newctrl);
833 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
835 struct serial_struct tmp;
840 memset(&tmp, 0, sizeof(tmp));
841 tmp.flags = ASYNC_LOW_LATENCY;
842 tmp.xmit_fifo_size = acm->writesize;
843 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
844 tmp.close_delay = acm->port.close_delay / 10;
845 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
846 ASYNC_CLOSING_WAIT_NONE :
847 acm->port.closing_wait / 10;
849 if (copy_to_user(info, &tmp, sizeof(tmp)))
855 static int set_serial_info(struct acm *acm,
856 struct serial_struct __user *newinfo)
858 struct serial_struct new_serial;
859 unsigned int closing_wait, close_delay;
862 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
865 close_delay = new_serial.close_delay * 10;
866 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
867 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
869 mutex_lock(&acm->port.mutex);
871 if (!capable(CAP_SYS_ADMIN)) {
872 if ((close_delay != acm->port.close_delay) ||
873 (closing_wait != acm->port.closing_wait))
876 retval = -EOPNOTSUPP;
878 acm->port.close_delay = close_delay;
879 acm->port.closing_wait = closing_wait;
882 mutex_unlock(&acm->port.mutex);
886 static int wait_serial_change(struct acm *acm, unsigned long arg)
889 DECLARE_WAITQUEUE(wait, current);
890 struct async_icount old, new;
893 spin_lock_irq(&acm->read_lock);
897 spin_unlock_irq(&acm->read_lock);
899 if ((arg & TIOCM_DSR) &&
902 if ((arg & TIOCM_CD) &&
905 if ((arg & TIOCM_RI) &&
909 add_wait_queue(&acm->wioctl, &wait);
910 set_current_state(TASK_INTERRUPTIBLE);
912 remove_wait_queue(&acm->wioctl, &wait);
913 if (acm->disconnected) {
919 if (signal_pending(current))
929 static int get_serial_usage(struct acm *acm,
930 struct serial_icounter_struct __user *count)
932 struct serial_icounter_struct icount;
935 memset(&icount, 0, sizeof(icount));
936 icount.dsr = acm->iocount.dsr;
937 icount.rng = acm->iocount.rng;
938 icount.dcd = acm->iocount.dcd;
939 icount.frame = acm->iocount.frame;
940 icount.overrun = acm->iocount.overrun;
941 icount.parity = acm->iocount.parity;
942 icount.brk = acm->iocount.brk;
944 if (copy_to_user(count, &icount, sizeof(icount)) > 0)
950 static int acm_tty_ioctl(struct tty_struct *tty,
951 unsigned int cmd, unsigned long arg)
953 struct acm *acm = tty->driver_data;
954 int rv = -ENOIOCTLCMD;
957 case TIOCGSERIAL: /* gets serial port data */
958 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
961 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
964 rv = usb_autopm_get_interface(acm->control);
969 rv = wait_serial_change(acm, arg);
970 usb_autopm_put_interface(acm->control);
973 rv = get_serial_usage(acm, (struct serial_icounter_struct __user *) arg);
980 static void acm_tty_set_termios(struct tty_struct *tty,
981 struct ktermios *termios_old)
983 struct acm *acm = tty->driver_data;
984 struct ktermios *termios = &tty->termios;
985 struct usb_cdc_line_coding newline;
986 int newctrl = acm->ctrlout;
988 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
989 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
990 newline.bParityType = termios->c_cflag & PARENB ?
991 (termios->c_cflag & PARODD ? 1 : 2) +
992 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
993 switch (termios->c_cflag & CSIZE) {
995 newline.bDataBits = 5;
998 newline.bDataBits = 6;
1001 newline.bDataBits = 7;
1005 newline.bDataBits = 8;
1008 /* FIXME: Needs to clear unsupported bits in the termios */
1009 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1011 if (C_BAUD(tty) == B0) {
1012 newline.dwDTERate = acm->line.dwDTERate;
1013 newctrl &= ~ACM_CTRL_DTR;
1014 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1015 newctrl |= ACM_CTRL_DTR;
1018 if (newctrl != acm->ctrlout)
1019 acm_set_control(acm, acm->ctrlout = newctrl);
1021 if (memcmp(&acm->line, &newline, sizeof newline)) {
1022 memcpy(&acm->line, &newline, sizeof newline);
1023 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1025 le32_to_cpu(newline.dwDTERate),
1026 newline.bCharFormat, newline.bParityType,
1028 acm_set_line(acm, &acm->line);
1032 static const struct tty_port_operations acm_port_ops = {
1033 .dtr_rts = acm_port_dtr_rts,
1034 .shutdown = acm_port_shutdown,
1035 .activate = acm_port_activate,
1036 .destruct = acm_port_destruct,
1040 * USB probe and disconnect routines.
1043 /* Little helpers: write/read buffers free */
1044 static void acm_write_buffers_free(struct acm *acm)
1048 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1050 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1051 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
1054 static void acm_read_buffers_free(struct acm *acm)
1056 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1059 for (i = 0; i < acm->rx_buflimit; i++)
1060 usb_free_coherent(usb_dev, acm->readsize,
1061 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1064 /* Little helper: write buffers allocate */
1065 static int acm_write_buffers_alloc(struct acm *acm)
1070 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1071 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1077 usb_free_coherent(acm->dev, acm->writesize,
1086 static int acm_probe(struct usb_interface *intf,
1087 const struct usb_device_id *id)
1089 struct usb_cdc_union_desc *union_header = NULL;
1090 struct usb_cdc_country_functional_desc *cfd = NULL;
1091 unsigned char *buffer = intf->altsetting->extra;
1092 int buflen = intf->altsetting->extralen;
1093 struct usb_interface *control_interface;
1094 struct usb_interface *data_interface;
1095 struct usb_endpoint_descriptor *epctrl = NULL;
1096 struct usb_endpoint_descriptor *epread = NULL;
1097 struct usb_endpoint_descriptor *epwrite = NULL;
1098 struct usb_device *usb_dev = interface_to_usbdev(intf);
1101 int ctrlsize, readsize;
1103 u8 ac_management_function = 0;
1104 u8 call_management_function = 0;
1105 int call_interface_num = -1;
1106 int data_interface_num = -1;
1107 unsigned long quirks;
1110 unsigned int elength = 0;
1111 int combined_interfaces = 0;
1112 struct device *tty_dev;
1116 quirks = (unsigned long)id->driver_info;
1118 if (quirks == IGNORE_DEVICE)
1121 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1123 /* handle quirks deadly to normal probing*/
1124 if (quirks == NO_UNION_NORMAL) {
1125 data_interface = usb_ifnum_to_if(usb_dev, 1);
1126 control_interface = usb_ifnum_to_if(usb_dev, 0);
1127 /* we would crash */
1128 if (!data_interface || !control_interface)
1130 goto skip_normal_probe;
1135 dev_err(&intf->dev, "Weird descriptor references\n");
1140 if (intf->cur_altsetting->endpoint &&
1141 intf->cur_altsetting->endpoint->extralen &&
1142 intf->cur_altsetting->endpoint->extra) {
1144 "Seeking extra descriptors on endpoint\n");
1145 buflen = intf->cur_altsetting->endpoint->extralen;
1146 buffer = intf->cur_altsetting->endpoint->extra;
1149 "Zero length descriptor references\n");
1154 while (buflen > 0) {
1155 elength = buffer[0];
1157 dev_err(&intf->dev, "skipping garbage byte\n");
1161 if (buffer[1] != USB_DT_CS_INTERFACE) {
1162 dev_err(&intf->dev, "skipping garbage\n");
1166 switch (buffer[2]) {
1167 case USB_CDC_UNION_TYPE: /* we've found it */
1168 if (elength < sizeof(struct usb_cdc_union_desc))
1171 dev_err(&intf->dev, "More than one "
1172 "union descriptor, skipping ...\n");
1175 union_header = (struct usb_cdc_union_desc *)buffer;
1177 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1178 if (elength < sizeof(struct usb_cdc_country_functional_desc))
1180 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1182 case USB_CDC_HEADER_TYPE: /* maybe check version */
1183 break; /* for now we ignore it */
1184 case USB_CDC_ACM_TYPE:
1187 ac_management_function = buffer[3];
1189 case USB_CDC_CALL_MANAGEMENT_TYPE:
1192 call_management_function = buffer[3];
1193 call_interface_num = buffer[4];
1197 * there are LOTS more CDC descriptors that
1198 * could legitimately be found here.
1200 dev_dbg(&intf->dev, "Ignoring descriptor: "
1201 "type %02x, length %ud\n",
1202 buffer[2], elength);
1210 if (!union_header) {
1211 if (call_interface_num > 0) {
1212 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1213 /* quirks for Droids MuIn LCD */
1214 if (quirks & NO_DATA_INTERFACE)
1215 data_interface = usb_ifnum_to_if(usb_dev, 0);
1217 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1218 control_interface = intf;
1220 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1221 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1224 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1225 combined_interfaces = 1;
1226 control_interface = data_interface = intf;
1227 goto look_for_collapsed_interface;
1231 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1232 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1235 if (!control_interface || !data_interface) {
1236 dev_dbg(&intf->dev, "no interfaces\n");
1240 if (data_interface_num != call_interface_num)
1241 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1243 if (control_interface == data_interface) {
1244 /* some broken devices designed for windows work this way */
1245 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1246 combined_interfaces = 1;
1247 /* a popular other OS doesn't use it */
1248 quirks |= NO_CAP_LINE;
1249 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1250 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1253 look_for_collapsed_interface:
1254 for (i = 0; i < 3; i++) {
1255 struct usb_endpoint_descriptor *ep;
1256 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1258 if (usb_endpoint_is_int_in(ep))
1260 else if (usb_endpoint_is_bulk_out(ep))
1262 else if (usb_endpoint_is_bulk_in(ep))
1267 if (!epctrl || !epread || !epwrite)
1270 goto made_compressed_probe;
1275 /*workaround for switched interfaces */
1276 if (data_interface->cur_altsetting->desc.bInterfaceClass
1277 != CDC_DATA_INTERFACE_TYPE) {
1278 if (control_interface->cur_altsetting->desc.bInterfaceClass
1279 == CDC_DATA_INTERFACE_TYPE) {
1281 "Your device has switched interfaces.\n");
1282 swap(control_interface, data_interface);
1288 /* Accept probe requests only for the control interface */
1289 if (!combined_interfaces && intf != control_interface)
1292 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1293 /* valid in this context */
1294 dev_dbg(&intf->dev, "The data interface isn't available\n");
1299 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1300 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1303 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1304 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1305 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1308 /* workaround for switched endpoints */
1309 if (!usb_endpoint_dir_in(epread)) {
1310 /* descriptors are swapped */
1312 "The data interface has switched endpoints\n");
1313 swap(epread, epwrite);
1315 made_compressed_probe:
1316 dev_dbg(&intf->dev, "interfaces are valid\n");
1318 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1322 minor = acm_alloc_minor(acm);
1324 dev_err(&intf->dev, "no more free acm devices\n");
1329 ctrlsize = usb_endpoint_maxp(epctrl);
1330 readsize = usb_endpoint_maxp(epread) *
1331 (quirks == SINGLE_RX_URB ? 1 : 2);
1332 acm->combined_interfaces = combined_interfaces;
1333 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1334 acm->control = control_interface;
1335 acm->data = data_interface;
1338 acm->ctrl_caps = ac_management_function;
1339 if (quirks & NO_CAP_LINE)
1340 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1341 acm->ctrlsize = ctrlsize;
1342 acm->readsize = readsize;
1343 acm->rx_buflimit = num_rx_buf;
1344 INIT_WORK(&acm->work, acm_softint);
1345 init_waitqueue_head(&acm->wioctl);
1346 spin_lock_init(&acm->write_lock);
1347 spin_lock_init(&acm->read_lock);
1348 mutex_init(&acm->mutex);
1349 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1351 acm->bInterval = epread->bInterval;
1352 tty_port_init(&acm->port);
1353 acm->port.ops = &acm_port_ops;
1354 init_usb_anchor(&acm->delayed);
1355 acm->quirks = quirks;
1357 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1360 acm->ctrl_buffer = buf;
1362 if (acm_write_buffers_alloc(acm) < 0)
1365 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1369 for (i = 0; i < num_rx_buf; i++) {
1370 struct acm_rb *rb = &(acm->read_buffers[i]);
1373 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1380 urb = usb_alloc_urb(0, GFP_KERNEL);
1384 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1385 urb->transfer_dma = rb->dma;
1386 if (acm->is_int_ep) {
1387 usb_fill_int_urb(urb, acm->dev,
1388 usb_rcvintpipe(usb_dev, epread->bEndpointAddress),
1391 acm_read_bulk_callback, rb,
1394 usb_fill_bulk_urb(urb, acm->dev,
1395 usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress),
1398 acm_read_bulk_callback, rb);
1401 acm->read_urbs[i] = urb;
1402 __set_bit(i, &acm->read_urbs_free);
1404 for (i = 0; i < ACM_NW; i++) {
1405 struct acm_wb *snd = &(acm->wb[i]);
1407 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1408 if (snd->urb == NULL)
1411 if (usb_endpoint_xfer_int(epwrite))
1412 usb_fill_int_urb(snd->urb, usb_dev,
1413 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1414 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1416 usb_fill_bulk_urb(snd->urb, usb_dev,
1417 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1418 NULL, acm->writesize, acm_write_bulk, snd);
1419 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1420 if (quirks & SEND_ZERO_PACKET)
1421 snd->urb->transfer_flags |= URB_ZERO_PACKET;
1422 snd->instance = acm;
1425 usb_set_intfdata(intf, acm);
1427 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1431 if (cfd) { /* export the country data */
1432 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1433 if (!acm->country_codes)
1434 goto skip_countries;
1435 acm->country_code_size = cfd->bLength - 4;
1436 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1438 acm->country_rel_date = cfd->iCountryCodeRelDate;
1440 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1442 kfree(acm->country_codes);
1443 acm->country_codes = NULL;
1444 acm->country_code_size = 0;
1445 goto skip_countries;
1448 i = device_create_file(&intf->dev,
1449 &dev_attr_iCountryCodeRelDate);
1451 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1452 kfree(acm->country_codes);
1453 acm->country_codes = NULL;
1454 acm->country_code_size = 0;
1455 goto skip_countries;
1460 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1461 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1462 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1463 /* works around buggy devices */
1464 epctrl->bInterval ? epctrl->bInterval : 16);
1465 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1466 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1468 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1470 acm->line.dwDTERate = cpu_to_le32(9600);
1471 acm->line.bDataBits = 8;
1472 acm_set_line(acm, &acm->line);
1474 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1475 usb_set_intfdata(data_interface, acm);
1477 usb_get_intf(control_interface);
1478 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1479 &control_interface->dev);
1480 if (IS_ERR(tty_dev)) {
1481 rv = PTR_ERR(tty_dev);
1485 if (quirks & CLEAR_HALT_CONDITIONS) {
1486 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress));
1487 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress));
1492 if (acm->country_codes) {
1493 device_remove_file(&acm->control->dev,
1494 &dev_attr_wCountryCodes);
1495 device_remove_file(&acm->control->dev,
1496 &dev_attr_iCountryCodeRelDate);
1497 kfree(acm->country_codes);
1499 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1501 usb_set_intfdata(intf, NULL);
1502 for (i = 0; i < ACM_NW; i++)
1503 usb_free_urb(acm->wb[i].urb);
1505 for (i = 0; i < num_rx_buf; i++)
1506 usb_free_urb(acm->read_urbs[i]);
1507 acm_read_buffers_free(acm);
1508 usb_free_urb(acm->ctrlurb);
1510 acm_write_buffers_free(acm);
1512 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1514 acm_release_minor(acm);
1520 static void stop_data_traffic(struct acm *acm)
1524 dev_dbg(&acm->control->dev, "%s\n", __func__);
1526 usb_kill_urb(acm->ctrlurb);
1527 for (i = 0; i < ACM_NW; i++)
1528 usb_kill_urb(acm->wb[i].urb);
1529 for (i = 0; i < acm->rx_buflimit; i++)
1530 usb_kill_urb(acm->read_urbs[i]);
1532 cancel_work_sync(&acm->work);
1535 static void acm_disconnect(struct usb_interface *intf)
1537 struct acm *acm = usb_get_intfdata(intf);
1538 struct usb_device *usb_dev = interface_to_usbdev(intf);
1539 struct tty_struct *tty;
1542 dev_dbg(&intf->dev, "%s\n", __func__);
1544 /* sibling interface is already cleaning up */
1548 mutex_lock(&acm->mutex);
1549 acm->disconnected = true;
1550 if (acm->country_codes) {
1551 device_remove_file(&acm->control->dev,
1552 &dev_attr_wCountryCodes);
1553 device_remove_file(&acm->control->dev,
1554 &dev_attr_iCountryCodeRelDate);
1556 wake_up_all(&acm->wioctl);
1557 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1558 usb_set_intfdata(acm->control, NULL);
1559 usb_set_intfdata(acm->data, NULL);
1560 mutex_unlock(&acm->mutex);
1562 tty = tty_port_tty_get(&acm->port);
1568 stop_data_traffic(acm);
1570 tty_unregister_device(acm_tty_driver, acm->minor);
1572 usb_free_urb(acm->ctrlurb);
1573 for (i = 0; i < ACM_NW; i++)
1574 usb_free_urb(acm->wb[i].urb);
1575 for (i = 0; i < acm->rx_buflimit; i++)
1576 usb_free_urb(acm->read_urbs[i]);
1577 acm_write_buffers_free(acm);
1578 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1579 acm_read_buffers_free(acm);
1581 if (!acm->combined_interfaces)
1582 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1583 acm->data : acm->control);
1585 tty_port_put(&acm->port);
1589 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1591 struct acm *acm = usb_get_intfdata(intf);
1594 spin_lock_irq(&acm->write_lock);
1595 if (PMSG_IS_AUTO(message)) {
1596 if (acm->transmitting) {
1597 spin_unlock_irq(&acm->write_lock);
1601 cnt = acm->susp_count++;
1602 spin_unlock_irq(&acm->write_lock);
1607 stop_data_traffic(acm);
1612 static int acm_resume(struct usb_interface *intf)
1614 struct acm *acm = usb_get_intfdata(intf);
1618 spin_lock_irq(&acm->write_lock);
1620 if (--acm->susp_count)
1623 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1624 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1627 urb = usb_get_from_anchor(&acm->delayed);
1631 acm_start_wb(acm, urb->context);
1635 * delayed error checking because we must
1636 * do the write path at all cost
1641 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1644 spin_unlock_irq(&acm->write_lock);
1649 static int acm_reset_resume(struct usb_interface *intf)
1651 struct acm *acm = usb_get_intfdata(intf);
1653 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1654 tty_port_tty_hangup(&acm->port, false);
1656 return acm_resume(intf);
1659 #endif /* CONFIG_PM */
1661 #define NOKIA_PCSUITE_ACM_INFO(x) \
1662 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1663 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1664 USB_CDC_ACM_PROTO_VENDOR)
1666 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1667 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1668 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1669 USB_CDC_ACM_PROTO_VENDOR)
1672 * USB driver structure.
1675 static const struct usb_device_id acm_ids[] = {
1676 /* quirky and broken devices */
1677 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1678 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1679 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1680 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1681 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1682 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1684 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1685 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1687 { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1688 .driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1690 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1691 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1693 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1694 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1696 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1697 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1699 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1700 .driver_info = SINGLE_RX_URB,
1702 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1703 .driver_info = SINGLE_RX_URB, /* firmware bug */
1705 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1706 .driver_info = SINGLE_RX_URB, /* firmware bug */
1708 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1709 .driver_info = SINGLE_RX_URB,
1711 { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1712 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1714 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1715 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1717 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1718 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1720 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1721 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1723 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1724 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1726 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1727 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1729 { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1730 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1732 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1733 .driver_info = QUIRK_CONTROL_LINE_STATE, },
1734 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1735 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1736 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1738 /* Motorola H24 HSPA module: */
1739 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1740 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1741 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1743 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1744 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1746 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1747 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1749 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1750 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1752 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1753 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1755 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1756 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1758 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1759 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1762 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1763 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1764 data interface instead of
1765 communications interface.
1766 Maybe we should define a new
1769 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1770 .driver_info = NO_UNION_NORMAL,
1772 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1773 .driver_info = NO_UNION_NORMAL,
1775 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1776 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1778 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1779 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1781 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1782 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1784 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1785 .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1787 { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1788 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1791 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1792 .driver_info = CLEAR_HALT_CONDITIONS,
1795 /* Nokia S60 phones expose two ACM channels. The first is
1796 * a modem and is picked up by the standard AT-command
1797 * information below. The second is 'vendor-specific' but
1798 * is treated as a serial device at the S60 end, so we want
1799 * to expose it on Linux too. */
1800 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1801 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1802 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1803 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1804 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1805 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1806 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1807 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1808 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1809 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1810 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1811 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1812 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1813 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1814 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1815 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1816 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1817 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1818 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1819 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1820 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1821 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1822 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1823 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1824 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1825 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1826 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1827 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1828 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1829 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1830 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1831 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1832 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1833 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1834 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1835 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1836 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1837 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1838 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1839 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1840 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1841 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1842 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1843 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1844 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1845 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1846 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1847 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1848 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1849 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1850 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1851 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1852 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1853 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1854 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1855 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1856 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1857 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1859 /* Support for Owen devices */
1860 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1862 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1864 /* Support for Droids MuIn LCD */
1865 { USB_DEVICE(0x04d8, 0x000b),
1866 .driver_info = NO_DATA_INTERFACE,
1869 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1870 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1871 .driver_info = IGNORE_DEVICE,
1873 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1874 .driver_info = IGNORE_DEVICE,
1878 /*Samsung phone in firmware update mode */
1879 { USB_DEVICE(0x04e8, 0x685d),
1880 .driver_info = IGNORE_DEVICE,
1883 /* Exclude Infineon Flash Loader utility */
1884 { USB_DEVICE(0x058b, 0x0041),
1885 .driver_info = IGNORE_DEVICE,
1888 { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1889 .driver_info = SEND_ZERO_PACKET,
1891 { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1892 .driver_info = SEND_ZERO_PACKET,
1895 /* control interfaces without any protocol set */
1896 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1897 USB_CDC_PROTO_NONE) },
1899 /* control interfaces with various AT-command sets */
1900 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1901 USB_CDC_ACM_PROTO_AT_V25TER) },
1902 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1903 USB_CDC_ACM_PROTO_AT_PCCA101) },
1904 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1905 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1906 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1907 USB_CDC_ACM_PROTO_AT_GSM) },
1908 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1909 USB_CDC_ACM_PROTO_AT_3G) },
1910 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1911 USB_CDC_ACM_PROTO_AT_CDMA) },
1913 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1914 .driver_info = SEND_ZERO_PACKET,
1920 MODULE_DEVICE_TABLE(usb, acm_ids);
1922 static struct usb_driver acm_driver = {
1925 .disconnect = acm_disconnect,
1927 .suspend = acm_suspend,
1928 .resume = acm_resume,
1929 .reset_resume = acm_reset_resume,
1931 .id_table = acm_ids,
1933 .supports_autosuspend = 1,
1935 .disable_hub_initiated_lpm = 1,
1939 * TTY driver structures.
1942 static const struct tty_operations acm_ops = {
1943 .install = acm_tty_install,
1944 .open = acm_tty_open,
1945 .close = acm_tty_close,
1946 .cleanup = acm_tty_cleanup,
1947 .hangup = acm_tty_hangup,
1948 .write = acm_tty_write,
1949 .write_room = acm_tty_write_room,
1950 .ioctl = acm_tty_ioctl,
1951 .throttle = acm_tty_throttle,
1952 .unthrottle = acm_tty_unthrottle,
1953 .chars_in_buffer = acm_tty_chars_in_buffer,
1954 .break_ctl = acm_tty_break_ctl,
1955 .set_termios = acm_tty_set_termios,
1956 .tiocmget = acm_tty_tiocmget,
1957 .tiocmset = acm_tty_tiocmset,
1964 static int __init acm_init(void)
1967 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1968 if (!acm_tty_driver)
1970 acm_tty_driver->driver_name = "acm",
1971 acm_tty_driver->name = "ttyACM",
1972 acm_tty_driver->major = ACM_TTY_MAJOR,
1973 acm_tty_driver->minor_start = 0,
1974 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1975 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1976 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1977 acm_tty_driver->init_termios = tty_std_termios;
1978 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1980 tty_set_operations(acm_tty_driver, &acm_ops);
1982 retval = tty_register_driver(acm_tty_driver);
1984 put_tty_driver(acm_tty_driver);
1988 retval = usb_register(&acm_driver);
1990 tty_unregister_driver(acm_tty_driver);
1991 put_tty_driver(acm_tty_driver);
1995 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2000 static void __exit acm_exit(void)
2002 usb_deregister(&acm_driver);
2003 tty_unregister_driver(acm_tty_driver);
2004 put_tty_driver(acm_tty_driver);
2005 idr_destroy(&acm_minors);
2008 module_init(acm_init);
2009 module_exit(acm_exit);
2011 MODULE_AUTHOR(DRIVER_AUTHOR);
2012 MODULE_DESCRIPTION(DRIVER_DESC);
2013 MODULE_LICENSE("GPL");
2014 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);