4 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
5 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
6 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
9 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
10 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 * USB Abstract Control Model driver for USB modems and ISDN adapters
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/serial.h>
40 #include <linux/tty_driver.h>
41 #include <linux/tty_flip.h>
42 #include <linux/module.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/usb/cdc.h>
47 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
49 #include <linux/list.h>
54 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
55 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
57 static struct usb_driver acm_driver;
58 static struct tty_driver *acm_tty_driver;
59 static struct acm *acm_table[ACM_TTY_MINORS];
61 static DEFINE_MUTEX(acm_table_lock);
68 * Look up an ACM structure by index. If found and not disconnected, increment
69 * its refcount and return it with its mutex held.
71 static struct acm *acm_get_by_index(unsigned index)
75 mutex_lock(&acm_table_lock);
76 acm = acm_table[index];
78 mutex_lock(&acm->mutex);
79 if (acm->disconnected) {
80 mutex_unlock(&acm->mutex);
83 tty_port_get(&acm->port);
84 mutex_unlock(&acm->mutex);
87 mutex_unlock(&acm_table_lock);
92 * Try to find an available minor number and if found, associate it with 'acm'.
94 static int acm_alloc_minor(struct acm *acm)
98 mutex_lock(&acm_table_lock);
99 for (minor = 0; minor < ACM_TTY_MINORS; minor++) {
100 if (!acm_table[minor]) {
101 acm_table[minor] = acm;
105 mutex_unlock(&acm_table_lock);
110 /* Release the minor number associated with 'acm'. */
111 static void acm_release_minor(struct acm *acm)
113 mutex_lock(&acm_table_lock);
114 acm_table[acm->minor] = NULL;
115 mutex_unlock(&acm_table_lock);
119 * Functions for ACM control messages.
122 static int acm_ctrl_msg(struct acm *acm, int request, int value,
125 int retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
126 request, USB_RT_ACM, value,
127 acm->control->altsetting[0].desc.bInterfaceNumber,
129 dev_dbg(&acm->control->dev,
130 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
131 __func__, request, value, len, retval);
132 return retval < 0 ? retval : 0;
135 /* devices aren't required to support these requests.
136 * the cdc acm descriptor tells whether they do...
138 #define acm_set_control(acm, control) \
139 acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
140 #define acm_set_line(acm, line) \
141 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
142 #define acm_send_break(acm, ms) \
143 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
146 * Write buffer management.
147 * All of these assume proper locks taken by the caller.
150 static int acm_wb_alloc(struct acm *acm)
163 wbn = (wbn + 1) % ACM_NW;
169 static int acm_wb_is_avail(struct acm *acm)
175 spin_lock_irqsave(&acm->write_lock, flags);
176 for (i = 0; i < ACM_NW; i++)
178 spin_unlock_irqrestore(&acm->write_lock, flags);
183 * Finish write. Caller must hold acm->write_lock
185 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
189 usb_autopm_put_interface_async(acm->control);
195 * the caller is responsible for locking
198 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
204 wb->urb->transfer_buffer = wb->buf;
205 wb->urb->transfer_dma = wb->dmah;
206 wb->urb->transfer_buffer_length = wb->len;
207 wb->urb->dev = acm->dev;
208 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
210 dev_err(&acm->data->dev,
211 "%s - usb_submit_urb(write bulk) failed: %d\n",
213 acm_write_done(acm, wb);
218 static int acm_write_start(struct acm *acm, int wbn)
221 struct acm_wb *wb = &acm->wb[wbn];
227 spin_lock_irqsave(&acm->write_lock, flags);
230 spin_unlock_irqrestore(&acm->write_lock, flags);
234 dev_vdbg(&acm->data->dev, "%s - susp_count %d\n", __func__,
236 usb_autopm_get_interface_async(acm->control);
237 if (acm->susp_count) {
240 wb->urb->transfer_buffer = wb->buf;
241 wb->urb->transfer_dma = wb->dmah;
242 wb->urb->transfer_buffer_length = wb->len;
243 wb->urb->dev = acm->dev;
244 usb_anchor_urb(wb->urb, &acm->deferred);
246 if (!acm->delayed_wb)
247 acm->delayed_wb = wb;
249 usb_autopm_put_interface_async(acm->control);
251 spin_unlock_irqrestore(&acm->write_lock, flags);
252 return 0; /* A white lie */
254 usb_mark_last_busy(acm->dev);
256 while ((res = usb_get_from_anchor(&acm->deferred))) {
257 /* decrement ref count*/
259 rc = usb_submit_urb(res, GFP_ATOMIC);
261 dev_dbg(&acm->data->dev,
262 "usb_submit_urb(pending request) failed: %d",
264 usb_unanchor_urb(res);
265 acm_write_done(acm, res->context);
269 rc = acm_start_wb(acm, wb);
270 spin_unlock_irqrestore(&acm->write_lock, flags);
276 * attributes exported through sysfs
278 static ssize_t show_caps
279 (struct device *dev, struct device_attribute *attr, char *buf)
281 struct usb_interface *intf = to_usb_interface(dev);
282 struct acm *acm = usb_get_intfdata(intf);
284 return sprintf(buf, "%d", acm->ctrl_caps);
286 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
288 static ssize_t show_country_codes
289 (struct device *dev, struct device_attribute *attr, char *buf)
291 struct usb_interface *intf = to_usb_interface(dev);
292 struct acm *acm = usb_get_intfdata(intf);
294 memcpy(buf, acm->country_codes, acm->country_code_size);
295 return acm->country_code_size;
298 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
300 static ssize_t show_country_rel_date
301 (struct device *dev, struct device_attribute *attr, char *buf)
303 struct usb_interface *intf = to_usb_interface(dev);
304 struct acm *acm = usb_get_intfdata(intf);
306 return sprintf(buf, "%d", acm->country_rel_date);
309 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
311 * Interrupt handlers for various ACM device responses
314 /* control interface reports status changes with "interrupt" transfers */
315 static void acm_ctrl_irq(struct urb *urb)
317 struct acm *acm = urb->context;
318 struct usb_cdc_notification *dr = urb->transfer_buffer;
322 int status = urb->status;
331 /* this urb is terminated, clean up */
332 dev_dbg(&acm->control->dev,
333 "%s - urb shutting down with status: %d\n",
337 dev_dbg(&acm->control->dev,
338 "%s - nonzero urb status received: %d\n",
343 usb_mark_last_busy(acm->dev);
345 data = (unsigned char *)(dr + 1);
346 switch (dr->bNotificationType) {
347 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
348 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
349 __func__, dr->wValue);
352 case USB_CDC_NOTIFY_SERIAL_STATE:
353 newctrl = get_unaligned_le16(data);
355 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
356 dev_dbg(&acm->control->dev, "%s - calling hangup\n",
358 tty_port_tty_hangup(&acm->port, false);
361 acm->ctrlin = newctrl;
363 dev_dbg(&acm->control->dev,
364 "%s - input control lines: dcd%c dsr%c break%c "
365 "ring%c framing%c parity%c overrun%c\n",
367 acm->ctrlin & ACM_CTRL_DCD ? '+' : '-',
368 acm->ctrlin & ACM_CTRL_DSR ? '+' : '-',
369 acm->ctrlin & ACM_CTRL_BRK ? '+' : '-',
370 acm->ctrlin & ACM_CTRL_RI ? '+' : '-',
371 acm->ctrlin & ACM_CTRL_FRAMING ? '+' : '-',
372 acm->ctrlin & ACM_CTRL_PARITY ? '+' : '-',
373 acm->ctrlin & ACM_CTRL_OVERRUN ? '+' : '-');
377 dev_dbg(&acm->control->dev,
378 "%s - unknown notification %d received: index %d "
379 "len %d data0 %d data1 %d\n",
381 dr->bNotificationType, dr->wIndex,
382 dr->wLength, data[0], data[1]);
386 retval = usb_submit_urb(urb, GFP_ATOMIC);
388 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
392 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
396 if (!test_and_clear_bit(index, &acm->read_urbs_free))
399 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
401 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
404 dev_err(&acm->data->dev,
405 "%s - usb_submit_urb failed: %d\n",
408 set_bit(index, &acm->read_urbs_free);
415 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
420 for (i = 0; i < acm->rx_buflimit; ++i) {
421 res = acm_submit_read_urb(acm, i, mem_flags);
429 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
431 struct acm_rb *rb = urb->context;
434 if (!urb->actual_length) {
435 set_bit(rb->index, &acm->read_urbs_free);
439 rb->data = (unsigned char *)urb->transfer_buffer;
440 rb->alen = urb->actual_length;
441 spin_lock_irqsave(&acm->read_lock, flags);
442 if (!acm->int_throttled && !acm->throttled) {
443 int count = tty_insert_flip_string(&acm->port,
445 if (count != rb->alen) {
446 acm->int_throttled = 1;
451 if (!acm->int_throttled && !acm->throttled)
452 set_bit(rb->index, &acm->read_urbs_free);
454 list_add_tail(&rb->rb_node, &acm->rb_head);
455 spin_unlock_irqrestore(&acm->read_lock, flags);
457 tty_flip_buffer_push(&acm->port);
460 static void acm_read_bulk_callback(struct urb *urb)
462 struct acm_rb *rb = urb->context;
463 struct acm *acm = rb->instance;
466 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
467 rb->index, urb->actual_length);
470 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
471 set_bit(rb->index, &acm->read_urbs_free);
474 usb_mark_last_busy(acm->dev);
476 if (urb->status && !urb->actual_length) {
477 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
478 __func__, urb->status);
479 set_bit(rb->index, &acm->read_urbs_free);
483 acm_process_read_urb(acm, urb);
485 /* throttle device if requested by tty */
486 spin_lock_irqsave(&acm->read_lock, flags);
487 acm->throttled = acm->throttle_req;
488 if (!acm->int_throttled && !acm->throttled && !acm->susp_count) {
489 spin_unlock_irqrestore(&acm->read_lock, flags);
490 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
492 spin_unlock_irqrestore(&acm->read_lock, flags);
496 /* data interface wrote those outgoing bytes */
497 static void acm_write_bulk(struct urb *urb)
499 struct acm_wb *wb = urb->context;
500 struct acm *acm = wb->instance;
503 if (urb->status || (urb->actual_length != urb->transfer_buffer_length))
504 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
507 urb->transfer_buffer_length,
510 spin_lock_irqsave(&acm->write_lock, flags);
511 acm_write_done(acm, wb);
512 spin_unlock_irqrestore(&acm->write_lock, flags);
513 schedule_work(&acm->work);
516 static void acm_softint(struct work_struct *work)
518 struct acm *acm = container_of(work, struct acm, work);
520 dev_vdbg(&acm->data->dev, "%s\n", __func__);
522 tty_port_tty_wakeup(&acm->port);
529 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
534 dev_dbg(tty->dev, "%s\n", __func__);
536 acm = acm_get_by_index(tty->index);
540 retval = tty_standard_install(driver, tty);
542 goto error_init_termios;
544 tty->driver_data = acm;
549 tty_port_put(&acm->port);
553 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
555 struct acm *acm = tty->driver_data;
557 dev_dbg(tty->dev, "%s\n", __func__);
559 return tty_port_open(&acm->port, tty, filp);
562 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
564 struct acm *acm = container_of(port, struct acm, port);
565 int retval = -ENODEV;
567 dev_dbg(&acm->control->dev, "%s\n", __func__);
569 mutex_lock(&acm->mutex);
570 if (acm->disconnected)
573 retval = usb_autopm_get_interface(acm->control);
575 goto error_get_interface;
578 * FIXME: Why do we need this? Allocating 64K of physically contiguous
579 * memory is really nasty...
581 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
582 acm->control->needs_remote_wakeup = 1;
584 if (acm_submit_read_urbs(acm, GFP_KERNEL))
585 goto error_submit_urb;
587 acm->ctrlurb->dev = acm->dev;
588 if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
589 dev_err(&acm->control->dev,
590 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
591 goto error_submit_urb;
594 acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS;
595 if (acm_set_control(acm, acm->ctrlout) < 0 &&
596 (acm->ctrl_caps & USB_CDC_CAP_LINE))
597 goto error_set_control;
599 usb_autopm_put_interface(acm->control);
602 * Unthrottle device in case the TTY was closed while throttled.
604 spin_lock_irq(&acm->read_lock);
605 acm->int_throttled = 0;
607 acm->throttle_req = 0;
608 while (!list_empty(&acm->rb_head)) {
609 struct acm_rb *rb = list_entry(acm->rb_head.next,
610 struct acm_rb, rb_node);
611 list_del(acm->rb_head.next);
612 set_bit(rb->index, &acm->read_urbs_free);
614 spin_unlock_irq(&acm->read_lock);
616 if (acm_submit_read_urbs(acm, GFP_KERNEL))
617 goto error_submit_read_urbs;
619 mutex_unlock(&acm->mutex);
623 error_submit_read_urbs:
625 acm_set_control(acm, acm->ctrlout);
627 usb_kill_urb(acm->ctrlurb);
629 usb_autopm_put_interface(acm->control);
632 mutex_unlock(&acm->mutex);
636 static void acm_port_destruct(struct tty_port *port)
638 struct acm *acm = container_of(port, struct acm, port);
640 dev_dbg(&acm->control->dev, "%s\n", __func__);
642 acm_release_minor(acm);
643 usb_put_intf(acm->control);
644 kfree(acm->country_codes);
648 static void acm_port_shutdown(struct tty_port *port)
650 struct acm *acm = container_of(port, struct acm, port);
654 dev_dbg(&acm->control->dev, "%s\n", __func__);
656 mutex_lock(&acm->mutex);
657 if (!acm->disconnected) {
658 pm_err = usb_autopm_get_interface(acm->control);
659 acm_set_control(acm, acm->ctrlout = 0);
660 usb_kill_urb(acm->ctrlurb);
661 for (i = 0; i < ACM_NW; i++)
662 usb_kill_urb(acm->wb[i].urb);
663 for (i = 0; i < acm->rx_buflimit; i++)
664 usb_kill_urb(acm->read_urbs[i]);
665 acm->control->needs_remote_wakeup = 0;
667 usb_autopm_put_interface(acm->control);
669 mutex_unlock(&acm->mutex);
672 static void acm_tty_cleanup(struct tty_struct *tty)
674 struct acm *acm = tty->driver_data;
675 dev_dbg(&acm->control->dev, "%s\n", __func__);
676 tty_port_put(&acm->port);
679 static void acm_tty_hangup(struct tty_struct *tty)
681 struct acm *acm = tty->driver_data;
682 dev_dbg(&acm->control->dev, "%s\n", __func__);
683 tty_port_hangup(&acm->port);
686 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
688 struct acm *acm = tty->driver_data;
689 dev_dbg(&acm->control->dev, "%s\n", __func__);
690 tty_port_close(&acm->port, tty, filp);
693 static int acm_tty_write(struct tty_struct *tty,
694 const unsigned char *buf, int count)
696 struct acm *acm = tty->driver_data;
705 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
707 spin_lock_irqsave(&acm->write_lock, flags);
708 wbn = acm_wb_alloc(acm);
710 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);
719 spin_unlock_irqrestore(&acm->write_lock, flags);
721 stat = acm_write_start(acm, wbn);
727 static int acm_tty_write_room(struct tty_struct *tty)
729 struct acm *acm = tty->driver_data;
731 * Do not let the line discipline to know that we have a reserve,
732 * or it might get too enthusiastic.
734 return acm_wb_is_avail(acm) ? acm->writesize : 0;
737 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
739 struct acm *acm = tty->driver_data;
741 * if the device was unplugged then any remaining characters fell out
742 * of the connector ;)
744 if (acm->disconnected)
747 * This is inaccurate (overcounts), but it works.
749 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
752 static void acm_tty_throttle(struct tty_struct *tty)
754 struct acm *acm = tty->driver_data;
756 spin_lock_irq(&acm->read_lock);
757 acm->throttle_req = 1;
758 spin_unlock_irq(&acm->read_lock);
761 static void acm_tty_unthrottle(struct tty_struct *tty)
763 struct acm *acm = tty->driver_data;
764 unsigned int was_throttled;
766 spin_lock_irq(&acm->read_lock);
767 was_throttled = acm->int_throttled | acm->throttled;
768 acm->int_throttled = 0;
770 acm->throttle_req = 0;
773 while (!list_empty(&acm->rb_head)) {
774 struct acm_rb *rb = list_entry(acm->rb_head.next,
775 struct acm_rb, rb_node);
776 int count = tty_insert_flip_string(&acm->port,
778 if (count != rb->alen) {
779 acm->int_throttled = 1;
784 list_del(acm->rb_head.next);
785 set_bit(rb->index, &acm->read_urbs_free);
788 spin_unlock_irq(&acm->read_lock);
790 tty_flip_buffer_push(&acm->port);
792 if (!acm->int_throttled)
793 acm_submit_read_urbs(acm, GFP_KERNEL);
795 spin_unlock_irq(&acm->read_lock);
799 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
801 struct acm *acm = tty->driver_data;
804 retval = acm_send_break(acm, state ? 0xffff : 0);
806 dev_dbg(&acm->control->dev, "%s - send break failed\n",
811 static int acm_tty_tiocmget(struct tty_struct *tty)
813 struct acm *acm = tty->driver_data;
815 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
816 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
817 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
818 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
819 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
823 static int acm_tty_tiocmset(struct tty_struct *tty,
824 unsigned int set, unsigned int clear)
826 struct acm *acm = tty->driver_data;
827 unsigned int newctrl;
829 newctrl = acm->ctrlout;
830 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
831 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
832 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
833 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
835 newctrl = (newctrl & ~clear) | set;
837 if (acm->ctrlout == newctrl)
839 return acm_set_control(acm, acm->ctrlout = newctrl);
842 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
844 struct serial_struct tmp;
849 memset(&tmp, 0, sizeof(tmp));
850 tmp.flags = ASYNC_LOW_LATENCY;
851 tmp.xmit_fifo_size = acm->writesize;
852 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
853 tmp.close_delay = acm->port.close_delay / 10;
854 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
855 ASYNC_CLOSING_WAIT_NONE :
856 acm->port.closing_wait / 10;
858 if (copy_to_user(info, &tmp, sizeof(tmp)))
864 static int set_serial_info(struct acm *acm,
865 struct serial_struct __user *newinfo)
867 struct serial_struct new_serial;
868 unsigned int closing_wait, close_delay;
871 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
874 close_delay = new_serial.close_delay * 10;
875 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
876 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
878 mutex_lock(&acm->port.mutex);
880 if (!capable(CAP_SYS_ADMIN)) {
881 if ((close_delay != acm->port.close_delay) ||
882 (closing_wait != acm->port.closing_wait))
885 retval = -EOPNOTSUPP;
887 acm->port.close_delay = close_delay;
888 acm->port.closing_wait = closing_wait;
891 mutex_unlock(&acm->port.mutex);
895 static int acm_tty_ioctl(struct tty_struct *tty,
896 unsigned int cmd, unsigned long arg)
898 struct acm *acm = tty->driver_data;
899 int rv = -ENOIOCTLCMD;
902 case TIOCGSERIAL: /* gets serial port data */
903 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
906 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
913 static void acm_tty_set_termios(struct tty_struct *tty,
914 struct ktermios *termios_old)
916 struct acm *acm = tty->driver_data;
917 struct ktermios *termios = &tty->termios;
918 struct usb_cdc_line_coding newline;
919 int newctrl = acm->ctrlout;
921 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
922 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
923 newline.bParityType = termios->c_cflag & PARENB ?
924 (termios->c_cflag & PARODD ? 1 : 2) +
925 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
926 switch (termios->c_cflag & CSIZE) {
928 newline.bDataBits = 5;
931 newline.bDataBits = 6;
934 newline.bDataBits = 7;
938 newline.bDataBits = 8;
941 /* FIXME: Needs to clear unsupported bits in the termios */
942 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
944 if (!newline.dwDTERate) {
945 newline.dwDTERate = acm->line.dwDTERate;
946 newctrl &= ~ACM_CTRL_DTR;
948 newctrl |= ACM_CTRL_DTR;
950 if (newctrl != acm->ctrlout)
951 acm_set_control(acm, acm->ctrlout = newctrl);
953 if (memcmp(&acm->line, &newline, sizeof newline)) {
954 memcpy(&acm->line, &newline, sizeof newline);
955 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
957 le32_to_cpu(newline.dwDTERate),
958 newline.bCharFormat, newline.bParityType,
960 acm_set_line(acm, &acm->line);
964 static const struct tty_port_operations acm_port_ops = {
965 .shutdown = acm_port_shutdown,
966 .activate = acm_port_activate,
967 .destruct = acm_port_destruct,
971 * USB probe and disconnect routines.
974 /* Little helpers: write/read buffers free */
975 static void acm_write_buffers_free(struct acm *acm)
979 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
981 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
982 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
985 static void acm_read_buffers_free(struct acm *acm)
987 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
990 for (i = 0; i < acm->rx_buflimit; i++)
991 usb_free_coherent(usb_dev, acm->readsize,
992 acm->read_buffers[i].base, acm->read_buffers[i].dma);
995 /* Little helper: write buffers allocate */
996 static int acm_write_buffers_alloc(struct acm *acm)
1001 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1002 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1008 usb_free_coherent(acm->dev, acm->writesize,
1017 static int acm_probe(struct usb_interface *intf,
1018 const struct usb_device_id *id)
1020 struct usb_cdc_union_desc *union_header = NULL;
1021 struct usb_cdc_country_functional_desc *cfd = NULL;
1022 unsigned char *buffer = intf->altsetting->extra;
1023 int buflen = intf->altsetting->extralen;
1024 struct usb_interface *control_interface;
1025 struct usb_interface *data_interface;
1026 struct usb_endpoint_descriptor *epctrl = NULL;
1027 struct usb_endpoint_descriptor *epread = NULL;
1028 struct usb_endpoint_descriptor *epwrite = NULL;
1029 struct usb_device *usb_dev = interface_to_usbdev(intf);
1032 int ctrlsize, readsize;
1034 u8 ac_management_function = 0;
1035 u8 call_management_function = 0;
1036 int call_interface_num = -1;
1037 int data_interface_num = -1;
1038 unsigned long quirks;
1041 int combined_interfaces = 0;
1042 struct device *tty_dev;
1046 quirks = (unsigned long)id->driver_info;
1048 if (quirks & IGNORE_DEVICE)
1051 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1053 /* handle quirks deadly to normal probing*/
1054 if (quirks & NO_UNION_NORMAL) {
1055 data_interface = usb_ifnum_to_if(usb_dev, 1);
1056 control_interface = usb_ifnum_to_if(usb_dev, 0);
1057 goto skip_normal_probe;
1062 dev_err(&intf->dev, "Weird descriptor references\n");
1067 if (intf->cur_altsetting->endpoint &&
1068 intf->cur_altsetting->endpoint->extralen &&
1069 intf->cur_altsetting->endpoint->extra) {
1071 "Seeking extra descriptors on endpoint\n");
1072 buflen = intf->cur_altsetting->endpoint->extralen;
1073 buffer = intf->cur_altsetting->endpoint->extra;
1076 "Zero length descriptor references\n");
1081 while (buflen > 0) {
1082 if (buffer[1] != USB_DT_CS_INTERFACE) {
1083 dev_err(&intf->dev, "skipping garbage\n");
1087 switch (buffer[2]) {
1088 case USB_CDC_UNION_TYPE: /* we've found it */
1090 dev_err(&intf->dev, "More than one "
1091 "union descriptor, skipping ...\n");
1094 union_header = (struct usb_cdc_union_desc *)buffer;
1096 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1097 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1099 case USB_CDC_HEADER_TYPE: /* maybe check version */
1100 break; /* for now we ignore it */
1101 case USB_CDC_ACM_TYPE:
1102 ac_management_function = buffer[3];
1104 case USB_CDC_CALL_MANAGEMENT_TYPE:
1105 call_management_function = buffer[3];
1106 call_interface_num = buffer[4];
1107 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1108 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1111 /* there are LOTS more CDC descriptors that
1112 * could legitimately be found here.
1114 dev_dbg(&intf->dev, "Ignoring descriptor: "
1115 "type %02x, length %d\n",
1116 buffer[2], buffer[0]);
1120 buflen -= buffer[0];
1121 buffer += buffer[0];
1124 if (!union_header) {
1125 if (call_interface_num > 0) {
1126 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1127 /* quirks for Droids MuIn LCD */
1128 if (quirks & NO_DATA_INTERFACE)
1129 data_interface = usb_ifnum_to_if(usb_dev, 0);
1131 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1132 control_interface = intf;
1134 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1135 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1138 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1139 combined_interfaces = 1;
1140 control_interface = data_interface = intf;
1141 goto look_for_collapsed_interface;
1145 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1146 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1147 if (!control_interface || !data_interface) {
1148 dev_dbg(&intf->dev, "no interfaces\n");
1153 if (data_interface_num != call_interface_num)
1154 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1156 if (control_interface == data_interface) {
1157 /* some broken devices designed for windows work this way */
1158 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1159 combined_interfaces = 1;
1160 /* a popular other OS doesn't use it */
1161 quirks |= NO_CAP_LINE;
1162 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1163 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1166 look_for_collapsed_interface:
1167 for (i = 0; i < 3; i++) {
1168 struct usb_endpoint_descriptor *ep;
1169 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1171 if (usb_endpoint_is_int_in(ep))
1173 else if (usb_endpoint_is_bulk_out(ep))
1175 else if (usb_endpoint_is_bulk_in(ep))
1180 if (!epctrl || !epread || !epwrite)
1183 goto made_compressed_probe;
1188 /*workaround for switched interfaces */
1189 if (data_interface->cur_altsetting->desc.bInterfaceClass
1190 != CDC_DATA_INTERFACE_TYPE) {
1191 if (control_interface->cur_altsetting->desc.bInterfaceClass
1192 == CDC_DATA_INTERFACE_TYPE) {
1193 struct usb_interface *t;
1195 "Your device has switched interfaces.\n");
1196 t = control_interface;
1197 control_interface = data_interface;
1204 /* Accept probe requests only for the control interface */
1205 if (!combined_interfaces && intf != control_interface)
1208 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1209 /* valid in this context */
1210 dev_dbg(&intf->dev, "The data interface isn't available\n");
1215 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1216 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1219 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1220 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1221 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1224 /* workaround for switched endpoints */
1225 if (!usb_endpoint_dir_in(epread)) {
1226 /* descriptors are swapped */
1227 struct usb_endpoint_descriptor *t;
1229 "The data interface has switched endpoints\n");
1234 made_compressed_probe:
1235 dev_dbg(&intf->dev, "interfaces are valid\n");
1237 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1239 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1243 minor = acm_alloc_minor(acm);
1244 if (minor == ACM_TTY_MINORS) {
1245 dev_err(&intf->dev, "no more free acm devices\n");
1250 ctrlsize = usb_endpoint_maxp(epctrl);
1251 readsize = usb_endpoint_maxp(epread) *
1252 (quirks == SINGLE_RX_URB ? 1 : 2);
1253 acm->combined_interfaces = combined_interfaces;
1254 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1255 acm->control = control_interface;
1256 acm->data = data_interface;
1259 acm->ctrl_caps = ac_management_function;
1260 if (quirks & NO_CAP_LINE)
1261 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1262 acm->ctrlsize = ctrlsize;
1263 acm->readsize = readsize;
1264 INIT_LIST_HEAD(&acm->rb_head);
1265 acm->rx_buflimit = num_rx_buf;
1266 INIT_WORK(&acm->work, acm_softint);
1267 init_usb_anchor(&acm->deferred);
1268 spin_lock_init(&acm->write_lock);
1269 spin_lock_init(&acm->read_lock);
1270 mutex_init(&acm->mutex);
1271 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1272 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1274 acm->bInterval = epread->bInterval;
1275 if (quirks & NO_HANGUP_IN_RESET_RESUME)
1276 acm->no_hangup_in_reset_resume = 1;
1277 tty_port_init(&acm->port);
1278 acm->port.ops = &acm_port_ops;
1280 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1282 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1285 acm->ctrl_buffer = buf;
1287 if (acm_write_buffers_alloc(acm) < 0) {
1288 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1292 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1293 if (!acm->ctrlurb) {
1294 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1297 for (i = 0; i < num_rx_buf; i++) {
1298 struct acm_rb *rb = &(acm->read_buffers[i]);
1301 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1304 dev_err(&intf->dev, "out of memory "
1305 "(read bufs usb_alloc_coherent)\n");
1311 urb = usb_alloc_urb(0, GFP_KERNEL);
1314 "out of memory (read urbs usb_alloc_urb)\n");
1317 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1318 urb->transfer_dma = rb->dma;
1319 if (acm->is_int_ep) {
1320 usb_fill_int_urb(urb, acm->dev,
1324 acm_read_bulk_callback, rb,
1327 usb_fill_bulk_urb(urb, acm->dev,
1331 acm_read_bulk_callback, rb);
1334 acm->read_urbs[i] = urb;
1335 __set_bit(i, &acm->read_urbs_free);
1337 for (i = 0; i < ACM_NW; i++) {
1338 struct acm_wb *snd = &(acm->wb[i]);
1340 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1341 if (snd->urb == NULL) {
1343 "out of memory (write urbs usb_alloc_urb)\n");
1347 if (usb_endpoint_xfer_int(epwrite))
1348 usb_fill_int_urb(snd->urb, usb_dev,
1349 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1350 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1352 usb_fill_bulk_urb(snd->urb, usb_dev,
1353 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1354 NULL, acm->writesize, acm_write_bulk, snd);
1355 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1356 snd->instance = acm;
1359 usb_set_intfdata(intf, acm);
1361 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1365 if (cfd) { /* export the country data */
1366 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1367 if (!acm->country_codes)
1368 goto skip_countries;
1369 acm->country_code_size = cfd->bLength - 4;
1370 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1372 acm->country_rel_date = cfd->iCountryCodeRelDate;
1374 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1376 kfree(acm->country_codes);
1377 acm->country_codes = NULL;
1378 acm->country_code_size = 0;
1379 goto skip_countries;
1382 i = device_create_file(&intf->dev,
1383 &dev_attr_iCountryCodeRelDate);
1385 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1386 kfree(acm->country_codes);
1387 acm->country_codes = NULL;
1388 acm->country_code_size = 0;
1389 goto skip_countries;
1394 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1395 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1396 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1397 /* works around buggy devices */
1398 epctrl->bInterval ? epctrl->bInterval : 0xff);
1399 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1400 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1402 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1404 acm_set_control(acm, acm->ctrlout);
1406 acm->line.dwDTERate = cpu_to_le32(9600);
1407 acm->line.bDataBits = 8;
1408 acm_set_line(acm, &acm->line);
1410 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1411 usb_set_intfdata(data_interface, acm);
1413 usb_get_intf(control_interface);
1414 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1415 &control_interface->dev);
1416 if (IS_ERR(tty_dev)) {
1417 rv = PTR_ERR(tty_dev);
1423 if (acm->country_codes) {
1424 device_remove_file(&acm->control->dev,
1425 &dev_attr_wCountryCodes);
1426 device_remove_file(&acm->control->dev,
1427 &dev_attr_iCountryCodeRelDate);
1429 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1431 usb_set_intfdata(intf, NULL);
1432 for (i = 0; i < ACM_NW; i++)
1433 usb_free_urb(acm->wb[i].urb);
1435 for (i = 0; i < num_rx_buf; i++)
1436 usb_free_urb(acm->read_urbs[i]);
1437 acm_read_buffers_free(acm);
1438 usb_free_urb(acm->ctrlurb);
1440 acm_write_buffers_free(acm);
1442 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1444 acm_release_minor(acm);
1450 static void stop_data_traffic(struct acm *acm)
1455 pr_err("%s: !acm\n", __func__);
1459 dev_dbg(&acm->control->dev, "%s\n", __func__);
1461 usb_kill_urb(acm->ctrlurb);
1462 for (i = 0; i < ACM_NW; i++)
1463 usb_kill_urb(acm->wb[i].urb);
1464 for (i = 0; i < acm->rx_buflimit; i++)
1465 usb_kill_urb(acm->read_urbs[i]);
1467 cancel_work_sync(&acm->work);
1470 static void acm_disconnect(struct usb_interface *intf)
1472 struct acm *acm = usb_get_intfdata(intf);
1473 struct usb_device *usb_dev = interface_to_usbdev(intf);
1474 struct tty_struct *tty;
1478 dev_dbg(&intf->dev, "%s\n", __func__);
1480 /* sibling interface is already cleaning up */
1484 mutex_lock(&acm->mutex);
1485 acm->disconnected = true;
1486 if (acm->country_codes) {
1487 device_remove_file(&acm->control->dev,
1488 &dev_attr_wCountryCodes);
1489 device_remove_file(&acm->control->dev,
1490 &dev_attr_iCountryCodeRelDate);
1492 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1493 usb_set_intfdata(acm->control, NULL);
1494 usb_set_intfdata(acm->data, NULL);
1495 mutex_unlock(&acm->mutex);
1497 tty = tty_port_tty_get(&acm->port);
1503 stop_data_traffic(acm);
1505 tty_unregister_device(acm_tty_driver, acm->minor);
1507 /* decrement ref count of anchored urbs */
1508 while ((res = usb_get_from_anchor(&acm->deferred)))
1510 usb_free_urb(acm->ctrlurb);
1511 for (i = 0; i < ACM_NW; i++)
1512 usb_free_urb(acm->wb[i].urb);
1513 for (i = 0; i < acm->rx_buflimit; i++)
1514 usb_free_urb(acm->read_urbs[i]);
1515 acm_write_buffers_free(acm);
1516 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1517 acm_read_buffers_free(acm);
1519 if (!acm->combined_interfaces)
1520 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1521 acm->data : acm->control);
1523 tty_port_put(&acm->port);
1527 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1529 struct acm *acm = usb_get_intfdata(intf);
1533 pr_err("%s: !acm\n", __func__);
1537 if (PMSG_IS_AUTO(message)) {
1540 spin_lock_irq(&acm->write_lock);
1541 b = acm->transmitting;
1542 spin_unlock_irq(&acm->write_lock);
1547 spin_lock_irq(&acm->read_lock);
1548 spin_lock(&acm->write_lock);
1549 cnt = acm->susp_count++;
1550 spin_unlock(&acm->write_lock);
1551 spin_unlock_irq(&acm->read_lock);
1556 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1557 stop_data_traffic(acm);
1562 static int acm_resume(struct usb_interface *intf)
1564 struct acm *acm = usb_get_intfdata(intf);
1574 pr_err("%s: !acm\n", __func__);
1578 spin_lock_irq(&acm->read_lock);
1579 if (acm->susp_count > 0) {
1580 acm->susp_count -= 1;
1581 cnt = acm->susp_count;
1583 spin_unlock_irq(&acm->read_lock);
1586 spin_unlock_irq(&acm->read_lock);
1591 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1592 rv = usb_submit_urb(acm->ctrlurb, GFP_NOIO);
1593 spin_lock_irq(&acm->write_lock);
1595 while ((res = usb_get_from_anchor(&acm->deferred))) {
1596 /* decrement ref count*/
1598 rv = usb_submit_urb(res, GFP_ATOMIC);
1600 dev_dbg(&acm->data->dev,
1601 "usb_submit_urb(pending request) failed: %d",
1603 usb_unanchor_urb(res);
1604 acm_write_done(acm, res->context);
1607 spin_unlock_irq(&acm->write_lock);
1609 if (acm->delayed_wb) {
1610 wb = acm->delayed_wb;
1611 acm->delayed_wb = NULL;
1612 spin_unlock_irq(&acm->write_lock);
1613 acm_start_wb(acm, wb);
1615 spin_unlock_irq(&acm->write_lock);
1620 * delayed error checking because we must
1621 * do the write path at all cost
1626 rv = acm_submit_read_urbs(acm, GFP_NOIO);
1633 static int acm_reset_resume(struct usb_interface *intf)
1635 struct acm *acm = usb_get_intfdata(intf);
1636 struct tty_struct *tty;
1639 pr_err("%s: !acm\n", __func__);
1643 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1644 tty = tty_port_tty_get(&acm->port);
1646 if (!acm->no_hangup_in_reset_resume)
1652 return acm_resume(intf);
1655 #endif /* CONFIG_PM */
1657 #define NOKIA_PCSUITE_ACM_INFO(x) \
1658 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1659 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1660 USB_CDC_ACM_PROTO_VENDOR)
1662 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1663 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1664 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1665 USB_CDC_ACM_PROTO_VENDOR)
1668 * USB driver structure.
1671 static const struct usb_device_id acm_ids[] = {
1672 /* quirky and broken devices */
1673 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1674 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1675 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1676 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1678 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1679 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1681 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1682 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1684 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1685 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1687 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1688 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1690 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1691 .driver_info = SINGLE_RX_URB,
1693 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1694 .driver_info = SINGLE_RX_URB, /* firmware bug */
1696 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1697 .driver_info = SINGLE_RX_URB, /* firmware bug */
1699 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1700 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1702 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1703 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1705 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1706 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1708 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1709 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1711 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1712 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1714 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1716 /* Motorola H24 HSPA module: */
1717 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1718 { USB_DEVICE(0x22b8, 0x2d92) }, /* modem + diagnostics */
1719 { USB_DEVICE(0x22b8, 0x2d93) }, /* modem + AT port */
1720 { USB_DEVICE(0x22b8, 0x2d95) }, /* modem + AT port + diagnostics */
1721 { USB_DEVICE(0x22b8, 0x2d96) }, /* modem + NMEA */
1722 { USB_DEVICE(0x22b8, 0x2d97) }, /* modem + diagnostics + NMEA */
1723 { USB_DEVICE(0x22b8, 0x2d99) }, /* modem + AT port + NMEA */
1724 { USB_DEVICE(0x22b8, 0x2d9a) }, /* modem + AT port + diagnostics + NMEA */
1726 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1727 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1728 data interface instead of
1729 communications interface.
1730 Maybe we should define a new
1733 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1734 .driver_info = NO_UNION_NORMAL,
1736 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1737 .driver_info = NO_UNION_NORMAL,
1739 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1740 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1742 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1743 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1745 { USB_DEVICE(0x1519, 0x0020),
1746 .driver_info = NO_UNION_NORMAL | NO_HANGUP_IN_RESET_RESUME, /* has no union descriptor */
1749 /* Nokia S60 phones expose two ACM channels. The first is
1750 * a modem and is picked up by the standard AT-command
1751 * information below. The second is 'vendor-specific' but
1752 * is treated as a serial device at the S60 end, so we want
1753 * to expose it on Linux too. */
1754 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1755 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1756 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1757 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1758 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1759 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1760 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1761 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1762 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1763 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1764 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1765 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1766 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1767 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1768 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1769 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1770 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1771 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1772 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1773 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1774 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1775 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1776 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1777 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1778 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1779 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1780 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1781 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1782 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1783 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1784 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1785 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1786 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1787 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1788 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1789 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1790 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1791 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1792 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1793 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1794 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1795 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1796 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1797 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1798 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1799 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1800 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1801 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1802 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1803 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1804 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1805 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1806 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1807 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1808 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1809 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1810 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1811 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1813 /* Support for Owen devices */
1814 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1816 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1818 /* Support Lego NXT using pbLua firmware */
1819 { USB_DEVICE(0x0694, 0xff00),
1820 .driver_info = NOT_A_MODEM,
1823 /* Support for Droids MuIn LCD */
1824 { USB_DEVICE(0x04d8, 0x000b),
1825 .driver_info = NO_DATA_INTERFACE,
1828 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1829 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1830 .driver_info = IGNORE_DEVICE,
1832 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1833 .driver_info = IGNORE_DEVICE,
1837 /* Exclude XMM6260 boot rom (not running modem software yet) */
1838 { USB_DEVICE(0x058b, 0x0041),
1839 .driver_info = IGNORE_DEVICE,
1843 { USB_DEVICE(0x1983, 0x0321),
1844 .driver_info = NO_HANGUP_IN_RESET_RESUME,
1847 /* control interfaces without any protocol set */
1848 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1849 USB_CDC_PROTO_NONE) },
1851 /* control interfaces with various AT-command sets */
1852 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1853 USB_CDC_ACM_PROTO_AT_V25TER) },
1854 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1855 USB_CDC_ACM_PROTO_AT_PCCA101) },
1856 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1857 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1858 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1859 USB_CDC_ACM_PROTO_AT_GSM) },
1860 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1861 USB_CDC_ACM_PROTO_AT_3G) },
1862 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1863 USB_CDC_ACM_PROTO_AT_CDMA) },
1868 MODULE_DEVICE_TABLE(usb, acm_ids);
1870 static struct usb_driver acm_driver = {
1873 .disconnect = acm_disconnect,
1875 .suspend = acm_suspend,
1876 .resume = acm_resume,
1877 .reset_resume = acm_reset_resume,
1879 .id_table = acm_ids,
1881 .supports_autosuspend = 1,
1883 .disable_hub_initiated_lpm = 1,
1887 * TTY driver structures.
1890 static const struct tty_operations acm_ops = {
1891 .install = acm_tty_install,
1892 .open = acm_tty_open,
1893 .close = acm_tty_close,
1894 .cleanup = acm_tty_cleanup,
1895 .hangup = acm_tty_hangup,
1896 .write = acm_tty_write,
1897 .write_room = acm_tty_write_room,
1898 .ioctl = acm_tty_ioctl,
1899 .throttle = acm_tty_throttle,
1900 .unthrottle = acm_tty_unthrottle,
1901 .chars_in_buffer = acm_tty_chars_in_buffer,
1902 .break_ctl = acm_tty_break_ctl,
1903 .set_termios = acm_tty_set_termios,
1904 .tiocmget = acm_tty_tiocmget,
1905 .tiocmset = acm_tty_tiocmset,
1912 static int __init acm_init(void)
1915 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1916 if (!acm_tty_driver)
1918 acm_tty_driver->driver_name = "acm",
1919 acm_tty_driver->name = "ttyACM",
1920 acm_tty_driver->major = ACM_TTY_MAJOR,
1921 acm_tty_driver->minor_start = 0,
1922 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1923 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1924 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1925 acm_tty_driver->init_termios = tty_std_termios;
1926 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1928 tty_set_operations(acm_tty_driver, &acm_ops);
1930 retval = tty_register_driver(acm_tty_driver);
1932 put_tty_driver(acm_tty_driver);
1936 retval = usb_register(&acm_driver);
1938 tty_unregister_driver(acm_tty_driver);
1939 put_tty_driver(acm_tty_driver);
1943 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1948 static void __exit acm_exit(void)
1950 usb_deregister(&acm_driver);
1951 tty_unregister_driver(acm_tty_driver);
1952 put_tty_driver(acm_tty_driver);
1955 module_init(acm_init);
1956 module_exit(acm_exit);
1958 MODULE_AUTHOR(DRIVER_AUTHOR);
1959 MODULE_DESCRIPTION(DRIVER_DESC);
1960 MODULE_LICENSE("GPL");
1961 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);