4 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
5 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
6 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
9 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
10 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 * USB Abstract Control Model driver for USB modems and ISDN adapters
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/serial.h>
40 #include <linux/tty_driver.h>
41 #include <linux/tty_flip.h>
42 #include <linux/module.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/usb/cdc.h>
47 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
49 #include <linux/list.h>
54 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
55 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
57 static struct usb_driver acm_driver;
58 static struct tty_driver *acm_tty_driver;
59 static struct acm *acm_table[ACM_TTY_MINORS];
61 static DEFINE_MUTEX(acm_table_lock);
68 * Look up an ACM structure by index. If found and not disconnected, increment
69 * its refcount and return it with its mutex held.
71 static struct acm *acm_get_by_index(unsigned index)
75 mutex_lock(&acm_table_lock);
76 acm = acm_table[index];
78 mutex_lock(&acm->mutex);
79 if (acm->disconnected) {
80 mutex_unlock(&acm->mutex);
83 tty_port_get(&acm->port);
84 mutex_unlock(&acm->mutex);
87 mutex_unlock(&acm_table_lock);
92 * Try to find an available minor number and if found, associate it with 'acm'.
94 static int acm_alloc_minor(struct acm *acm)
98 mutex_lock(&acm_table_lock);
99 for (minor = 0; minor < ACM_TTY_MINORS; minor++) {
100 if (!acm_table[minor]) {
101 acm_table[minor] = acm;
105 mutex_unlock(&acm_table_lock);
110 /* Release the minor number associated with 'acm'. */
111 static void acm_release_minor(struct acm *acm)
113 mutex_lock(&acm_table_lock);
114 acm_table[acm->minor] = NULL;
115 mutex_unlock(&acm_table_lock);
119 * Functions for ACM control messages.
122 static int acm_ctrl_msg(struct acm *acm, int request, int value,
127 retval = usb_autopm_get_interface(acm->control);
131 retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
132 request, USB_RT_ACM, value,
133 acm->control->altsetting[0].desc.bInterfaceNumber,
136 dev_dbg(&acm->control->dev,
137 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
138 __func__, request, value, len, retval);
140 usb_autopm_put_interface(acm->control);
142 return retval < 0 ? retval : 0;
145 /* devices aren't required to support these requests.
146 * the cdc acm descriptor tells whether they do...
148 #define acm_set_control(acm, control) \
149 acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
150 #define acm_set_line(acm, line) \
151 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
152 #define acm_send_break(acm, ms) \
153 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
156 * Write buffer management.
157 * All of these assume proper locks taken by the caller.
160 static int acm_wb_alloc(struct acm *acm)
173 wbn = (wbn + 1) % ACM_NW;
179 static int acm_wb_is_avail(struct acm *acm)
185 spin_lock_irqsave(&acm->write_lock, flags);
186 for (i = 0; i < ACM_NW; i++)
188 spin_unlock_irqrestore(&acm->write_lock, flags);
193 * Finish write. Caller must hold acm->write_lock
195 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
199 usb_autopm_put_interface_async(acm->control);
205 * the caller is responsible for locking
208 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
214 wb->urb->transfer_buffer = wb->buf;
215 wb->urb->transfer_dma = wb->dmah;
216 wb->urb->transfer_buffer_length = wb->len;
217 wb->urb->dev = acm->dev;
219 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
221 dev_err(&acm->data->dev,
222 "%s - usb_submit_urb(write bulk) failed: %d\n",
224 acm_write_done(acm, wb);
230 * attributes exported through sysfs
232 static ssize_t show_caps
233 (struct device *dev, struct device_attribute *attr, char *buf)
235 struct usb_interface *intf = to_usb_interface(dev);
236 struct acm *acm = usb_get_intfdata(intf);
238 return sprintf(buf, "%d", acm->ctrl_caps);
240 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
242 static ssize_t show_country_codes
243 (struct device *dev, struct device_attribute *attr, char *buf)
245 struct usb_interface *intf = to_usb_interface(dev);
246 struct acm *acm = usb_get_intfdata(intf);
248 memcpy(buf, acm->country_codes, acm->country_code_size);
249 return acm->country_code_size;
252 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
254 static ssize_t show_country_rel_date
255 (struct device *dev, struct device_attribute *attr, char *buf)
257 struct usb_interface *intf = to_usb_interface(dev);
258 struct acm *acm = usb_get_intfdata(intf);
260 return sprintf(buf, "%d", acm->country_rel_date);
263 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
265 * Interrupt handlers for various ACM device responses
268 /* control interface reports status changes with "interrupt" transfers */
269 static void acm_ctrl_irq(struct urb *urb)
271 struct acm *acm = urb->context;
272 struct usb_cdc_notification *dr = urb->transfer_buffer;
277 int status = urb->status;
286 /* this urb is terminated, clean up */
287 dev_dbg(&acm->control->dev,
288 "%s - urb shutting down with status: %d\n",
292 dev_dbg(&acm->control->dev,
293 "%s - nonzero urb status received: %d\n",
298 usb_mark_last_busy(acm->dev);
300 data = (unsigned char *)(dr + 1);
301 switch (dr->bNotificationType) {
302 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
303 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
304 __func__, dr->wValue);
307 case USB_CDC_NOTIFY_SERIAL_STATE:
308 newctrl = get_unaligned_le16(data);
310 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
311 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
313 tty_port_tty_hangup(&acm->port, false);
316 difference = acm->ctrlin ^ newctrl;
317 spin_lock(&acm->read_lock);
318 acm->ctrlin = newctrl;
319 acm->oldcount = acm->iocount;
321 if (difference & ACM_CTRL_DSR)
323 if (difference & ACM_CTRL_BRK)
325 if (difference & ACM_CTRL_RI)
327 if (difference & ACM_CTRL_DCD)
329 if (difference & ACM_CTRL_FRAMING)
330 acm->iocount.frame++;
331 if (difference & ACM_CTRL_PARITY)
332 acm->iocount.parity++;
333 if (difference & ACM_CTRL_OVERRUN)
334 acm->iocount.overrun++;
335 spin_unlock(&acm->read_lock);
338 wake_up_all(&acm->wioctl);
343 dev_dbg(&acm->control->dev,
344 "%s - unknown notification %d received: index %d "
345 "len %d data0 %d data1 %d\n",
347 dr->bNotificationType, dr->wIndex,
348 dr->wLength, data[0], data[1]);
352 retval = usb_submit_urb(urb, GFP_ATOMIC);
354 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
358 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
362 if (!test_and_clear_bit(index, &acm->read_urbs_free))
365 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
367 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
370 dev_err(&acm->data->dev,
371 "%s - usb_submit_urb failed: %d\n",
374 set_bit(index, &acm->read_urbs_free);
381 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
386 for (i = 0; i < acm->rx_buflimit; ++i) {
387 res = acm_submit_read_urb(acm, i, mem_flags);
395 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
397 if (!urb->actual_length)
400 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
402 tty_flip_buffer_push(&acm->port);
405 static void acm_read_bulk_callback(struct urb *urb)
407 struct acm_rb *rb = urb->context;
408 struct acm *acm = rb->instance;
411 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
412 rb->index, urb->actual_length);
413 set_bit(rb->index, &acm->read_urbs_free);
416 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
419 usb_mark_last_busy(acm->dev);
422 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
423 __func__, urb->status);
426 acm_process_read_urb(acm, urb);
428 /* throttle device if requested by tty */
429 spin_lock_irqsave(&acm->read_lock, flags);
430 acm->throttled = acm->throttle_req;
431 if (!acm->throttled && !acm->susp_count) {
432 spin_unlock_irqrestore(&acm->read_lock, flags);
433 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
435 spin_unlock_irqrestore(&acm->read_lock, flags);
439 /* data interface wrote those outgoing bytes */
440 static void acm_write_bulk(struct urb *urb)
442 struct acm_wb *wb = urb->context;
443 struct acm *acm = wb->instance;
446 if (urb->status || (urb->actual_length != urb->transfer_buffer_length))
447 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
450 urb->transfer_buffer_length,
453 spin_lock_irqsave(&acm->write_lock, flags);
454 acm_write_done(acm, wb);
455 spin_unlock_irqrestore(&acm->write_lock, flags);
456 schedule_work(&acm->work);
459 static void acm_softint(struct work_struct *work)
461 struct acm *acm = container_of(work, struct acm, work);
463 dev_vdbg(&acm->data->dev, "%s\n", __func__);
465 tty_port_tty_wakeup(&acm->port);
472 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
477 dev_dbg(tty->dev, "%s\n", __func__);
479 acm = acm_get_by_index(tty->index);
483 retval = tty_standard_install(driver, tty);
485 goto error_init_termios;
487 tty->driver_data = acm;
492 tty_port_put(&acm->port);
496 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
498 struct acm *acm = tty->driver_data;
500 dev_dbg(tty->dev, "%s\n", __func__);
502 return tty_port_open(&acm->port, tty, filp);
505 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
507 struct acm *acm = container_of(port, struct acm, port);
508 int retval = -ENODEV;
511 dev_dbg(&acm->control->dev, "%s\n", __func__);
513 mutex_lock(&acm->mutex);
514 if (acm->disconnected)
517 retval = usb_autopm_get_interface(acm->control);
519 goto error_get_interface;
522 * FIXME: Why do we need this? Allocating 64K of physically contiguous
523 * memory is really nasty...
525 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
526 acm->control->needs_remote_wakeup = 1;
528 acm->ctrlurb->dev = acm->dev;
529 if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
530 dev_err(&acm->control->dev,
531 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
532 goto error_submit_urb;
535 acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS;
536 if (acm_set_control(acm, acm->ctrlout) < 0 &&
537 (acm->ctrl_caps & USB_CDC_CAP_LINE))
538 goto error_set_control;
540 usb_autopm_put_interface(acm->control);
543 * Unthrottle device in case the TTY was closed while throttled.
545 spin_lock_irq(&acm->read_lock);
547 acm->throttle_req = 0;
548 spin_unlock_irq(&acm->read_lock);
550 if (acm_submit_read_urbs(acm, GFP_KERNEL))
551 goto error_submit_read_urbs;
553 mutex_unlock(&acm->mutex);
557 error_submit_read_urbs:
558 for (i = 0; i < acm->rx_buflimit; i++)
559 usb_kill_urb(acm->read_urbs[i]);
561 acm_set_control(acm, acm->ctrlout);
563 usb_kill_urb(acm->ctrlurb);
565 usb_autopm_put_interface(acm->control);
568 mutex_unlock(&acm->mutex);
572 static void acm_port_destruct(struct tty_port *port)
574 struct acm *acm = container_of(port, struct acm, port);
576 dev_dbg(&acm->control->dev, "%s\n", __func__);
578 acm_release_minor(acm);
579 usb_put_intf(acm->control);
580 kfree(acm->country_codes);
584 static void acm_port_shutdown(struct tty_port *port)
586 struct acm *acm = container_of(port, struct acm, port);
592 dev_dbg(&acm->control->dev, "%s\n", __func__);
594 mutex_lock(&acm->mutex);
595 if (!acm->disconnected) {
596 pm_err = usb_autopm_get_interface(acm->control);
597 acm_set_control(acm, acm->ctrlout = 0);
600 urb = usb_get_from_anchor(&acm->delayed);
605 usb_autopm_put_interface_async(acm->control);
608 usb_kill_urb(acm->ctrlurb);
609 for (i = 0; i < ACM_NW; i++)
610 usb_kill_urb(acm->wb[i].urb);
611 for (i = 0; i < acm->rx_buflimit; i++)
612 usb_kill_urb(acm->read_urbs[i]);
613 acm->control->needs_remote_wakeup = 0;
615 usb_autopm_put_interface(acm->control);
617 mutex_unlock(&acm->mutex);
620 static void acm_tty_cleanup(struct tty_struct *tty)
622 struct acm *acm = tty->driver_data;
623 dev_dbg(&acm->control->dev, "%s\n", __func__);
624 tty_port_put(&acm->port);
627 static void acm_tty_hangup(struct tty_struct *tty)
629 struct acm *acm = tty->driver_data;
630 dev_dbg(&acm->control->dev, "%s\n", __func__);
631 tty_port_hangup(&acm->port);
634 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
636 struct acm *acm = tty->driver_data;
637 dev_dbg(&acm->control->dev, "%s\n", __func__);
638 tty_port_close(&acm->port, tty, filp);
641 static int acm_tty_write(struct tty_struct *tty,
642 const unsigned char *buf, int count)
644 struct acm *acm = tty->driver_data;
653 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
655 spin_lock_irqsave(&acm->write_lock, flags);
656 wbn = acm_wb_alloc(acm);
658 spin_unlock_irqrestore(&acm->write_lock, flags);
665 spin_unlock_irqrestore(&acm->write_lock, flags);
669 count = (count > acm->writesize) ? acm->writesize : count;
670 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
671 memcpy(wb->buf, buf, count);
674 stat = usb_autopm_get_interface_async(acm->control);
677 spin_unlock_irqrestore(&acm->write_lock, flags);
681 if (acm->susp_count) {
682 usb_anchor_urb(wb->urb, &acm->delayed);
683 spin_unlock_irqrestore(&acm->write_lock, flags);
686 usb_mark_last_busy(acm->dev);
688 stat = acm_start_wb(acm, wb);
689 spin_unlock_irqrestore(&acm->write_lock, flags);
696 static int acm_tty_write_room(struct tty_struct *tty)
698 struct acm *acm = tty->driver_data;
700 * Do not let the line discipline to know that we have a reserve,
701 * or it might get too enthusiastic.
703 return acm_wb_is_avail(acm) ? acm->writesize : 0;
706 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
708 struct acm *acm = tty->driver_data;
710 * if the device was unplugged then any remaining characters fell out
711 * of the connector ;)
713 if (acm->disconnected)
716 * This is inaccurate (overcounts), but it works.
718 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
721 static void acm_tty_throttle(struct tty_struct *tty)
723 struct acm *acm = tty->driver_data;
725 spin_lock_irq(&acm->read_lock);
726 acm->throttle_req = 1;
727 spin_unlock_irq(&acm->read_lock);
730 static void acm_tty_unthrottle(struct tty_struct *tty)
732 struct acm *acm = tty->driver_data;
733 unsigned int was_throttled;
735 spin_lock_irq(&acm->read_lock);
736 was_throttled = acm->throttled;
738 acm->throttle_req = 0;
739 spin_unlock_irq(&acm->read_lock);
742 acm_submit_read_urbs(acm, GFP_KERNEL);
745 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
747 struct acm *acm = tty->driver_data;
750 retval = acm_send_break(acm, state ? 0xffff : 0);
752 dev_dbg(&acm->control->dev, "%s - send break failed\n",
757 static int acm_tty_tiocmget(struct tty_struct *tty)
759 struct acm *acm = tty->driver_data;
761 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
762 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
763 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
764 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
765 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
769 static int acm_tty_tiocmset(struct tty_struct *tty,
770 unsigned int set, unsigned int clear)
772 struct acm *acm = tty->driver_data;
773 unsigned int newctrl;
775 newctrl = acm->ctrlout;
776 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
777 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
778 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
779 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
781 newctrl = (newctrl & ~clear) | set;
783 if (acm->ctrlout == newctrl)
785 return acm_set_control(acm, acm->ctrlout = newctrl);
788 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
790 struct serial_struct tmp;
795 memset(&tmp, 0, sizeof(tmp));
796 tmp.flags = ASYNC_LOW_LATENCY;
797 tmp.xmit_fifo_size = acm->writesize;
798 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
799 tmp.close_delay = acm->port.close_delay / 10;
800 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
801 ASYNC_CLOSING_WAIT_NONE :
802 acm->port.closing_wait / 10;
804 if (copy_to_user(info, &tmp, sizeof(tmp)))
810 static int set_serial_info(struct acm *acm,
811 struct serial_struct __user *newinfo)
813 struct serial_struct new_serial;
814 unsigned int closing_wait, close_delay;
817 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
820 close_delay = new_serial.close_delay * 10;
821 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
822 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
824 mutex_lock(&acm->port.mutex);
826 if (!capable(CAP_SYS_ADMIN)) {
827 if ((close_delay != acm->port.close_delay) ||
828 (closing_wait != acm->port.closing_wait))
831 retval = -EOPNOTSUPP;
833 acm->port.close_delay = close_delay;
834 acm->port.closing_wait = closing_wait;
837 mutex_unlock(&acm->port.mutex);
841 static int wait_serial_change(struct acm *acm, unsigned long arg)
844 DECLARE_WAITQUEUE(wait, current);
845 struct async_icount old, new;
847 if (arg & (TIOCM_DSR | TIOCM_RI | TIOCM_CD ))
850 spin_lock_irq(&acm->read_lock);
854 spin_unlock_irq(&acm->read_lock);
856 if ((arg & TIOCM_DSR) &&
859 if ((arg & TIOCM_CD) &&
862 if ((arg & TIOCM_RI) &&
866 add_wait_queue(&acm->wioctl, &wait);
867 set_current_state(TASK_INTERRUPTIBLE);
869 remove_wait_queue(&acm->wioctl, &wait);
870 if (acm->disconnected) {
876 if (signal_pending(current))
886 static int get_serial_usage(struct acm *acm,
887 struct serial_icounter_struct __user *count)
889 struct serial_icounter_struct icount;
892 memset(&icount, 0, sizeof(icount));
893 icount.dsr = acm->iocount.dsr;
894 icount.rng = acm->iocount.rng;
895 icount.dcd = acm->iocount.dcd;
896 icount.frame = acm->iocount.frame;
897 icount.overrun = acm->iocount.overrun;
898 icount.parity = acm->iocount.parity;
899 icount.brk = acm->iocount.brk;
901 if (copy_to_user(count, &icount, sizeof(icount)) > 0)
907 static int acm_tty_ioctl(struct tty_struct *tty,
908 unsigned int cmd, unsigned long arg)
910 struct acm *acm = tty->driver_data;
911 int rv = -ENOIOCTLCMD;
914 case TIOCGSERIAL: /* gets serial port data */
915 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
918 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
921 rv = usb_autopm_get_interface(acm->control);
926 rv = wait_serial_change(acm, arg);
927 usb_autopm_put_interface(acm->control);
930 rv = get_serial_usage(acm, (struct serial_icounter_struct __user *) arg);
937 static void acm_tty_set_termios(struct tty_struct *tty,
938 struct ktermios *termios_old)
940 struct acm *acm = tty->driver_data;
941 struct ktermios *termios = &tty->termios;
942 struct usb_cdc_line_coding newline;
943 int newctrl = acm->ctrlout;
945 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
946 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
947 newline.bParityType = termios->c_cflag & PARENB ?
948 (termios->c_cflag & PARODD ? 1 : 2) +
949 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
950 switch (termios->c_cflag & CSIZE) {
952 newline.bDataBits = 5;
955 newline.bDataBits = 6;
958 newline.bDataBits = 7;
962 newline.bDataBits = 8;
965 /* FIXME: Needs to clear unsupported bits in the termios */
966 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
968 if (!newline.dwDTERate) {
969 newline.dwDTERate = acm->line.dwDTERate;
970 newctrl &= ~ACM_CTRL_DTR;
972 newctrl |= ACM_CTRL_DTR;
974 if (newctrl != acm->ctrlout)
975 acm_set_control(acm, acm->ctrlout = newctrl);
977 if (memcmp(&acm->line, &newline, sizeof newline)) {
978 memcpy(&acm->line, &newline, sizeof newline);
979 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
981 le32_to_cpu(newline.dwDTERate),
982 newline.bCharFormat, newline.bParityType,
984 acm_set_line(acm, &acm->line);
988 static const struct tty_port_operations acm_port_ops = {
989 .shutdown = acm_port_shutdown,
990 .activate = acm_port_activate,
991 .destruct = acm_port_destruct,
995 * USB probe and disconnect routines.
998 /* Little helpers: write/read buffers free */
999 static void acm_write_buffers_free(struct acm *acm)
1003 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1005 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1006 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
1009 static void acm_read_buffers_free(struct acm *acm)
1011 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
1014 for (i = 0; i < acm->rx_buflimit; i++)
1015 usb_free_coherent(usb_dev, acm->readsize,
1016 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1019 /* Little helper: write buffers allocate */
1020 static int acm_write_buffers_alloc(struct acm *acm)
1025 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1026 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1032 usb_free_coherent(acm->dev, acm->writesize,
1041 static int acm_probe(struct usb_interface *intf,
1042 const struct usb_device_id *id)
1044 struct usb_cdc_union_desc *union_header = NULL;
1045 struct usb_cdc_country_functional_desc *cfd = NULL;
1046 unsigned char *buffer = intf->altsetting->extra;
1047 int buflen = intf->altsetting->extralen;
1048 struct usb_interface *control_interface;
1049 struct usb_interface *data_interface;
1050 struct usb_endpoint_descriptor *epctrl = NULL;
1051 struct usb_endpoint_descriptor *epread = NULL;
1052 struct usb_endpoint_descriptor *epwrite = NULL;
1053 struct usb_device *usb_dev = interface_to_usbdev(intf);
1056 int ctrlsize, readsize;
1058 u8 ac_management_function = 0;
1059 u8 call_management_function = 0;
1060 int call_interface_num = -1;
1061 int data_interface_num = -1;
1062 unsigned long quirks;
1065 int combined_interfaces = 0;
1066 struct device *tty_dev;
1070 quirks = (unsigned long)id->driver_info;
1072 if (quirks == IGNORE_DEVICE)
1075 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1077 /* handle quirks deadly to normal probing*/
1078 if (quirks == NO_UNION_NORMAL) {
1079 data_interface = usb_ifnum_to_if(usb_dev, 1);
1080 control_interface = usb_ifnum_to_if(usb_dev, 0);
1081 goto skip_normal_probe;
1086 dev_err(&intf->dev, "Weird descriptor references\n");
1091 if (intf->cur_altsetting->endpoint &&
1092 intf->cur_altsetting->endpoint->extralen &&
1093 intf->cur_altsetting->endpoint->extra) {
1095 "Seeking extra descriptors on endpoint\n");
1096 buflen = intf->cur_altsetting->endpoint->extralen;
1097 buffer = intf->cur_altsetting->endpoint->extra;
1100 "Zero length descriptor references\n");
1105 while (buflen > 0) {
1106 if (buffer[1] != USB_DT_CS_INTERFACE) {
1107 dev_err(&intf->dev, "skipping garbage\n");
1111 switch (buffer[2]) {
1112 case USB_CDC_UNION_TYPE: /* we've found it */
1114 dev_err(&intf->dev, "More than one "
1115 "union descriptor, skipping ...\n");
1118 union_header = (struct usb_cdc_union_desc *)buffer;
1120 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1121 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1123 case USB_CDC_HEADER_TYPE: /* maybe check version */
1124 break; /* for now we ignore it */
1125 case USB_CDC_ACM_TYPE:
1126 ac_management_function = buffer[3];
1128 case USB_CDC_CALL_MANAGEMENT_TYPE:
1129 call_management_function = buffer[3];
1130 call_interface_num = buffer[4];
1131 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1132 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1135 /* there are LOTS more CDC descriptors that
1136 * could legitimately be found here.
1138 dev_dbg(&intf->dev, "Ignoring descriptor: "
1139 "type %02x, length %d\n",
1140 buffer[2], buffer[0]);
1144 buflen -= buffer[0];
1145 buffer += buffer[0];
1148 if (!union_header) {
1149 if (call_interface_num > 0) {
1150 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1151 /* quirks for Droids MuIn LCD */
1152 if (quirks & NO_DATA_INTERFACE)
1153 data_interface = usb_ifnum_to_if(usb_dev, 0);
1155 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1156 control_interface = intf;
1158 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1159 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1162 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1163 combined_interfaces = 1;
1164 control_interface = data_interface = intf;
1165 goto look_for_collapsed_interface;
1169 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1170 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1171 if (!control_interface || !data_interface) {
1172 dev_dbg(&intf->dev, "no interfaces\n");
1177 if (data_interface_num != call_interface_num)
1178 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1180 if (control_interface == data_interface) {
1181 /* some broken devices designed for windows work this way */
1182 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1183 combined_interfaces = 1;
1184 /* a popular other OS doesn't use it */
1185 quirks |= NO_CAP_LINE;
1186 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1187 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1190 look_for_collapsed_interface:
1191 for (i = 0; i < 3; i++) {
1192 struct usb_endpoint_descriptor *ep;
1193 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1195 if (usb_endpoint_is_int_in(ep))
1197 else if (usb_endpoint_is_bulk_out(ep))
1199 else if (usb_endpoint_is_bulk_in(ep))
1204 if (!epctrl || !epread || !epwrite)
1207 goto made_compressed_probe;
1212 /*workaround for switched interfaces */
1213 if (data_interface->cur_altsetting->desc.bInterfaceClass
1214 != CDC_DATA_INTERFACE_TYPE) {
1215 if (control_interface->cur_altsetting->desc.bInterfaceClass
1216 == CDC_DATA_INTERFACE_TYPE) {
1217 struct usb_interface *t;
1219 "Your device has switched interfaces.\n");
1220 t = control_interface;
1221 control_interface = data_interface;
1228 /* Accept probe requests only for the control interface */
1229 if (!combined_interfaces && intf != control_interface)
1232 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1233 /* valid in this context */
1234 dev_dbg(&intf->dev, "The data interface isn't available\n");
1239 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1240 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1243 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1244 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1245 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1248 /* workaround for switched endpoints */
1249 if (!usb_endpoint_dir_in(epread)) {
1250 /* descriptors are swapped */
1251 struct usb_endpoint_descriptor *t;
1253 "The data interface has switched endpoints\n");
1258 made_compressed_probe:
1259 dev_dbg(&intf->dev, "interfaces are valid\n");
1261 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1263 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1267 minor = acm_alloc_minor(acm);
1268 if (minor == ACM_TTY_MINORS) {
1269 dev_err(&intf->dev, "no more free acm devices\n");
1274 ctrlsize = usb_endpoint_maxp(epctrl);
1275 readsize = usb_endpoint_maxp(epread) *
1276 (quirks == SINGLE_RX_URB ? 1 : 2);
1277 acm->combined_interfaces = combined_interfaces;
1278 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1279 acm->control = control_interface;
1280 acm->data = data_interface;
1283 acm->ctrl_caps = ac_management_function;
1284 if (quirks & NO_CAP_LINE)
1285 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1286 acm->ctrlsize = ctrlsize;
1287 acm->readsize = readsize;
1288 acm->rx_buflimit = num_rx_buf;
1289 INIT_WORK(&acm->work, acm_softint);
1290 init_waitqueue_head(&acm->wioctl);
1291 spin_lock_init(&acm->write_lock);
1292 spin_lock_init(&acm->read_lock);
1293 mutex_init(&acm->mutex);
1294 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1295 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1297 acm->bInterval = epread->bInterval;
1298 tty_port_init(&acm->port);
1299 acm->port.ops = &acm_port_ops;
1300 init_usb_anchor(&acm->delayed);
1302 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1304 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1307 acm->ctrl_buffer = buf;
1309 if (acm_write_buffers_alloc(acm) < 0) {
1310 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1314 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1315 if (!acm->ctrlurb) {
1316 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1319 for (i = 0; i < num_rx_buf; i++) {
1320 struct acm_rb *rb = &(acm->read_buffers[i]);
1323 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1326 dev_err(&intf->dev, "out of memory "
1327 "(read bufs usb_alloc_coherent)\n");
1333 urb = usb_alloc_urb(0, GFP_KERNEL);
1336 "out of memory (read urbs usb_alloc_urb)\n");
1339 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1340 urb->transfer_dma = rb->dma;
1341 if (acm->is_int_ep) {
1342 usb_fill_int_urb(urb, acm->dev,
1346 acm_read_bulk_callback, rb,
1349 usb_fill_bulk_urb(urb, acm->dev,
1353 acm_read_bulk_callback, rb);
1356 acm->read_urbs[i] = urb;
1357 __set_bit(i, &acm->read_urbs_free);
1359 for (i = 0; i < ACM_NW; i++) {
1360 struct acm_wb *snd = &(acm->wb[i]);
1362 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1363 if (snd->urb == NULL) {
1365 "out of memory (write urbs usb_alloc_urb)\n");
1369 if (usb_endpoint_xfer_int(epwrite))
1370 usb_fill_int_urb(snd->urb, usb_dev,
1371 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1372 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1374 usb_fill_bulk_urb(snd->urb, usb_dev,
1375 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1376 NULL, acm->writesize, acm_write_bulk, snd);
1377 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1378 snd->instance = acm;
1381 usb_set_intfdata(intf, acm);
1383 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1387 if (cfd) { /* export the country data */
1388 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1389 if (!acm->country_codes)
1390 goto skip_countries;
1391 acm->country_code_size = cfd->bLength - 4;
1392 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1394 acm->country_rel_date = cfd->iCountryCodeRelDate;
1396 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1398 kfree(acm->country_codes);
1399 acm->country_codes = NULL;
1400 acm->country_code_size = 0;
1401 goto skip_countries;
1404 i = device_create_file(&intf->dev,
1405 &dev_attr_iCountryCodeRelDate);
1407 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1408 kfree(acm->country_codes);
1409 acm->country_codes = NULL;
1410 acm->country_code_size = 0;
1411 goto skip_countries;
1416 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1417 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1418 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1419 /* works around buggy devices */
1420 epctrl->bInterval ? epctrl->bInterval : 16);
1421 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1422 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1424 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1426 acm_set_control(acm, acm->ctrlout);
1428 acm->line.dwDTERate = cpu_to_le32(9600);
1429 acm->line.bDataBits = 8;
1430 acm_set_line(acm, &acm->line);
1432 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1433 usb_set_intfdata(data_interface, acm);
1435 usb_get_intf(control_interface);
1436 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1437 &control_interface->dev);
1438 if (IS_ERR(tty_dev)) {
1439 rv = PTR_ERR(tty_dev);
1445 if (acm->country_codes) {
1446 device_remove_file(&acm->control->dev,
1447 &dev_attr_wCountryCodes);
1448 device_remove_file(&acm->control->dev,
1449 &dev_attr_iCountryCodeRelDate);
1451 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1453 usb_set_intfdata(intf, NULL);
1454 for (i = 0; i < ACM_NW; i++)
1455 usb_free_urb(acm->wb[i].urb);
1457 for (i = 0; i < num_rx_buf; i++)
1458 usb_free_urb(acm->read_urbs[i]);
1459 acm_read_buffers_free(acm);
1460 usb_free_urb(acm->ctrlurb);
1462 acm_write_buffers_free(acm);
1464 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1466 acm_release_minor(acm);
1472 static void stop_data_traffic(struct acm *acm)
1476 dev_dbg(&acm->control->dev, "%s\n", __func__);
1478 usb_kill_urb(acm->ctrlurb);
1479 for (i = 0; i < ACM_NW; i++)
1480 usb_kill_urb(acm->wb[i].urb);
1481 for (i = 0; i < acm->rx_buflimit; i++)
1482 usb_kill_urb(acm->read_urbs[i]);
1484 cancel_work_sync(&acm->work);
1487 static void acm_disconnect(struct usb_interface *intf)
1489 struct acm *acm = usb_get_intfdata(intf);
1490 struct usb_device *usb_dev = interface_to_usbdev(intf);
1491 struct tty_struct *tty;
1494 dev_dbg(&intf->dev, "%s\n", __func__);
1496 /* sibling interface is already cleaning up */
1500 mutex_lock(&acm->mutex);
1501 acm->disconnected = true;
1502 if (acm->country_codes) {
1503 device_remove_file(&acm->control->dev,
1504 &dev_attr_wCountryCodes);
1505 device_remove_file(&acm->control->dev,
1506 &dev_attr_iCountryCodeRelDate);
1508 wake_up_all(&acm->wioctl);
1509 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1510 usb_set_intfdata(acm->control, NULL);
1511 usb_set_intfdata(acm->data, NULL);
1512 mutex_unlock(&acm->mutex);
1514 tty = tty_port_tty_get(&acm->port);
1520 stop_data_traffic(acm);
1522 tty_unregister_device(acm_tty_driver, acm->minor);
1524 usb_free_urb(acm->ctrlurb);
1525 for (i = 0; i < ACM_NW; i++)
1526 usb_free_urb(acm->wb[i].urb);
1527 for (i = 0; i < acm->rx_buflimit; i++)
1528 usb_free_urb(acm->read_urbs[i]);
1529 acm_write_buffers_free(acm);
1530 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1531 acm_read_buffers_free(acm);
1533 if (!acm->combined_interfaces)
1534 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1535 acm->data : acm->control);
1537 tty_port_put(&acm->port);
1541 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1543 struct acm *acm = usb_get_intfdata(intf);
1546 spin_lock_irq(&acm->read_lock);
1547 spin_lock(&acm->write_lock);
1548 if (PMSG_IS_AUTO(message)) {
1549 if (acm->transmitting) {
1550 spin_unlock(&acm->write_lock);
1551 spin_unlock_irq(&acm->read_lock);
1555 cnt = acm->susp_count++;
1556 spin_unlock(&acm->write_lock);
1557 spin_unlock_irq(&acm->read_lock);
1562 stop_data_traffic(acm);
1567 static int acm_resume(struct usb_interface *intf)
1569 struct acm *acm = usb_get_intfdata(intf);
1573 spin_lock_irq(&acm->read_lock);
1574 spin_lock(&acm->write_lock);
1576 if (--acm->susp_count)
1579 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1580 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1583 urb = usb_get_from_anchor(&acm->delayed);
1587 acm_start_wb(acm, urb->context);
1591 * delayed error checking because we must
1592 * do the write path at all cost
1597 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1600 spin_unlock(&acm->write_lock);
1601 spin_unlock_irq(&acm->read_lock);
1606 static int acm_reset_resume(struct usb_interface *intf)
1608 struct acm *acm = usb_get_intfdata(intf);
1610 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1611 tty_port_tty_hangup(&acm->port, false);
1613 return acm_resume(intf);
1616 #endif /* CONFIG_PM */
1618 #define NOKIA_PCSUITE_ACM_INFO(x) \
1619 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1620 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1621 USB_CDC_ACM_PROTO_VENDOR)
1623 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1624 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1625 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1626 USB_CDC_ACM_PROTO_VENDOR)
1629 * USB driver structure.
1632 static const struct usb_device_id acm_ids[] = {
1633 /* quirky and broken devices */
1634 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1635 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1636 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1637 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1639 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1640 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1642 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1643 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1645 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1646 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1648 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1649 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1651 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1652 .driver_info = SINGLE_RX_URB,
1654 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1655 .driver_info = SINGLE_RX_URB, /* firmware bug */
1657 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1658 .driver_info = SINGLE_RX_URB, /* firmware bug */
1660 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1661 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1663 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1664 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1666 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1667 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1669 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1670 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1672 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1673 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1675 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1677 /* Motorola H24 HSPA module: */
1678 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1679 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1680 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1682 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1683 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1685 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1686 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1688 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1689 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1691 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1692 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1694 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1695 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1697 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1698 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1701 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1702 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1703 data interface instead of
1704 communications interface.
1705 Maybe we should define a new
1708 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1709 .driver_info = NO_UNION_NORMAL,
1711 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1712 .driver_info = NO_UNION_NORMAL,
1714 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1715 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1717 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1718 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1721 /* Nokia S60 phones expose two ACM channels. The first is
1722 * a modem and is picked up by the standard AT-command
1723 * information below. The second is 'vendor-specific' but
1724 * is treated as a serial device at the S60 end, so we want
1725 * to expose it on Linux too. */
1726 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1727 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1728 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1729 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1730 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1731 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1732 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1733 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1734 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1735 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1736 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1737 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1738 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1739 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1740 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1741 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1742 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1743 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1744 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1745 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1746 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1747 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1748 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1749 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1750 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1751 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1752 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1753 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1754 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1755 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1756 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1757 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1758 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1759 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1760 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1761 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1762 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1763 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1764 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1765 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1766 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1767 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1768 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1769 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1770 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1771 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1772 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1773 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1774 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1775 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1776 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1777 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1778 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1779 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1780 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1781 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1782 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1783 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1785 /* Support for Owen devices */
1786 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1788 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1790 /* Support Lego NXT using pbLua firmware */
1791 { USB_DEVICE(0x0694, 0xff00),
1792 .driver_info = NOT_A_MODEM,
1795 /* Support for Droids MuIn LCD */
1796 { USB_DEVICE(0x04d8, 0x000b),
1797 .driver_info = NO_DATA_INTERFACE,
1800 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1801 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1802 .driver_info = IGNORE_DEVICE,
1804 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1805 .driver_info = IGNORE_DEVICE,
1809 /* control interfaces without any protocol set */
1810 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1811 USB_CDC_PROTO_NONE) },
1813 /* control interfaces with various AT-command sets */
1814 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1815 USB_CDC_ACM_PROTO_AT_V25TER) },
1816 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1817 USB_CDC_ACM_PROTO_AT_PCCA101) },
1818 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1819 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1820 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1821 USB_CDC_ACM_PROTO_AT_GSM) },
1822 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1823 USB_CDC_ACM_PROTO_AT_3G) },
1824 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1825 USB_CDC_ACM_PROTO_AT_CDMA) },
1830 MODULE_DEVICE_TABLE(usb, acm_ids);
1832 static struct usb_driver acm_driver = {
1835 .disconnect = acm_disconnect,
1837 .suspend = acm_suspend,
1838 .resume = acm_resume,
1839 .reset_resume = acm_reset_resume,
1841 .id_table = acm_ids,
1843 .supports_autosuspend = 1,
1845 .disable_hub_initiated_lpm = 1,
1849 * TTY driver structures.
1852 static const struct tty_operations acm_ops = {
1853 .install = acm_tty_install,
1854 .open = acm_tty_open,
1855 .close = acm_tty_close,
1856 .cleanup = acm_tty_cleanup,
1857 .hangup = acm_tty_hangup,
1858 .write = acm_tty_write,
1859 .write_room = acm_tty_write_room,
1860 .ioctl = acm_tty_ioctl,
1861 .throttle = acm_tty_throttle,
1862 .unthrottle = acm_tty_unthrottle,
1863 .chars_in_buffer = acm_tty_chars_in_buffer,
1864 .break_ctl = acm_tty_break_ctl,
1865 .set_termios = acm_tty_set_termios,
1866 .tiocmget = acm_tty_tiocmget,
1867 .tiocmset = acm_tty_tiocmset,
1874 static int __init acm_init(void)
1877 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1878 if (!acm_tty_driver)
1880 acm_tty_driver->driver_name = "acm",
1881 acm_tty_driver->name = "ttyACM",
1882 acm_tty_driver->major = ACM_TTY_MAJOR,
1883 acm_tty_driver->minor_start = 0,
1884 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1885 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1886 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1887 acm_tty_driver->init_termios = tty_std_termios;
1888 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1890 tty_set_operations(acm_tty_driver, &acm_ops);
1892 retval = tty_register_driver(acm_tty_driver);
1894 put_tty_driver(acm_tty_driver);
1898 retval = usb_register(&acm_driver);
1900 tty_unregister_driver(acm_tty_driver);
1901 put_tty_driver(acm_tty_driver);
1905 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1910 static void __exit acm_exit(void)
1912 usb_deregister(&acm_driver);
1913 tty_unregister_driver(acm_tty_driver);
1914 put_tty_driver(acm_tty_driver);
1917 module_init(acm_init);
1918 module_exit(acm_exit);
1920 MODULE_AUTHOR(DRIVER_AUTHOR);
1921 MODULE_DESCRIPTION(DRIVER_DESC);
1922 MODULE_LICENSE("GPL");
1923 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);