4 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
5 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
6 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
9 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
10 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 * USB Abstract Control Model driver for USB modems and ISDN adapters
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/serial.h>
40 #include <linux/tty_driver.h>
41 #include <linux/tty_flip.h>
42 #include <linux/module.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/usb/cdc.h>
47 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
49 #include <linux/list.h>
54 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
55 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
57 static struct usb_driver acm_driver;
58 static struct tty_driver *acm_tty_driver;
59 static struct acm *acm_table[ACM_TTY_MINORS];
61 static DEFINE_MUTEX(acm_table_lock);
68 * Look up an ACM structure by index. If found and not disconnected, increment
69 * its refcount and return it with its mutex held.
71 static struct acm *acm_get_by_index(unsigned index)
75 mutex_lock(&acm_table_lock);
76 acm = acm_table[index];
78 mutex_lock(&acm->mutex);
79 if (acm->disconnected) {
80 mutex_unlock(&acm->mutex);
83 tty_port_get(&acm->port);
84 mutex_unlock(&acm->mutex);
87 mutex_unlock(&acm_table_lock);
92 * Try to find an available minor number and if found, associate it with 'acm'.
94 static int acm_alloc_minor(struct acm *acm)
98 mutex_lock(&acm_table_lock);
99 for (minor = 0; minor < ACM_TTY_MINORS; minor++) {
100 if (!acm_table[minor]) {
101 acm_table[minor] = acm;
105 mutex_unlock(&acm_table_lock);
110 /* Release the minor number associated with 'acm'. */
111 static void acm_release_minor(struct acm *acm)
113 mutex_lock(&acm_table_lock);
114 acm_table[acm->minor] = NULL;
115 mutex_unlock(&acm_table_lock);
119 * Functions for ACM control messages.
122 static int acm_ctrl_msg(struct acm *acm, int request, int value,
125 int retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
126 request, USB_RT_ACM, value,
127 acm->control->altsetting[0].desc.bInterfaceNumber,
129 dev_dbg(&acm->control->dev,
130 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
131 __func__, request, value, len, retval);
132 return retval < 0 ? retval : 0;
135 /* devices aren't required to support these requests.
136 * the cdc acm descriptor tells whether they do...
138 #define acm_set_control(acm, control) \
139 acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
140 #define acm_set_line(acm, line) \
141 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
142 #define acm_send_break(acm, ms) \
143 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
146 * Write buffer management.
147 * All of these assume proper locks taken by the caller.
150 static int acm_wb_alloc(struct acm *acm)
163 wbn = (wbn + 1) % ACM_NW;
169 static int acm_wb_is_avail(struct acm *acm)
175 spin_lock_irqsave(&acm->write_lock, flags);
176 for (i = 0; i < ACM_NW; i++)
178 spin_unlock_irqrestore(&acm->write_lock, flags);
183 * Finish write. Caller must hold acm->write_lock
185 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
189 usb_autopm_put_interface_async(acm->control);
195 * the caller is responsible for locking
198 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
204 wb->urb->transfer_buffer = wb->buf;
205 wb->urb->transfer_dma = wb->dmah;
206 wb->urb->transfer_buffer_length = wb->len;
207 wb->urb->dev = acm->dev;
209 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
211 dev_err(&acm->data->dev,
212 "%s - usb_submit_urb(write bulk) failed: %d\n",
214 acm_write_done(acm, wb);
219 static int acm_write_start(struct acm *acm, int wbn)
222 struct acm_wb *wb = &acm->wb[wbn];
225 spin_lock_irqsave(&acm->write_lock, flags);
228 spin_unlock_irqrestore(&acm->write_lock, flags);
232 dev_vdbg(&acm->data->dev, "%s - susp_count %d\n", __func__,
234 usb_autopm_get_interface_async(acm->control);
235 if (acm->susp_count) {
236 if (!acm->delayed_wb)
237 acm->delayed_wb = wb;
239 usb_autopm_put_interface_async(acm->control);
240 spin_unlock_irqrestore(&acm->write_lock, flags);
241 return 0; /* A white lie */
243 usb_mark_last_busy(acm->dev);
245 rc = acm_start_wb(acm, wb);
246 spin_unlock_irqrestore(&acm->write_lock, flags);
252 * attributes exported through sysfs
254 static ssize_t show_caps
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->ctrl_caps);
262 static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);
264 static ssize_t show_country_codes
265 (struct device *dev, struct device_attribute *attr, char *buf)
267 struct usb_interface *intf = to_usb_interface(dev);
268 struct acm *acm = usb_get_intfdata(intf);
270 memcpy(buf, acm->country_codes, acm->country_code_size);
271 return acm->country_code_size;
274 static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);
276 static ssize_t show_country_rel_date
277 (struct device *dev, struct device_attribute *attr, char *buf)
279 struct usb_interface *intf = to_usb_interface(dev);
280 struct acm *acm = usb_get_intfdata(intf);
282 return sprintf(buf, "%d", acm->country_rel_date);
285 static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
287 * Interrupt handlers for various ACM device responses
290 /* control interface reports status changes with "interrupt" transfers */
291 static void acm_ctrl_irq(struct urb *urb)
293 struct acm *acm = urb->context;
294 struct usb_cdc_notification *dr = urb->transfer_buffer;
295 struct tty_struct *tty;
299 int status = urb->status;
308 /* this urb is terminated, clean up */
309 dev_dbg(&acm->control->dev,
310 "%s - urb shutting down with status: %d\n",
314 dev_dbg(&acm->control->dev,
315 "%s - nonzero urb status received: %d\n",
320 usb_mark_last_busy(acm->dev);
322 data = (unsigned char *)(dr + 1);
323 switch (dr->bNotificationType) {
324 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
325 dev_dbg(&acm->control->dev, "%s - network connection: %d\n",
326 __func__, dr->wValue);
329 case USB_CDC_NOTIFY_SERIAL_STATE:
330 tty = tty_port_tty_get(&acm->port);
331 newctrl = get_unaligned_le16(data);
335 (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
336 dev_dbg(&acm->control->dev,
337 "%s - calling hangup\n", __func__);
343 acm->ctrlin = newctrl;
345 dev_dbg(&acm->control->dev,
346 "%s - input control lines: dcd%c dsr%c break%c "
347 "ring%c framing%c parity%c overrun%c\n",
349 acm->ctrlin & ACM_CTRL_DCD ? '+' : '-',
350 acm->ctrlin & ACM_CTRL_DSR ? '+' : '-',
351 acm->ctrlin & ACM_CTRL_BRK ? '+' : '-',
352 acm->ctrlin & ACM_CTRL_RI ? '+' : '-',
353 acm->ctrlin & ACM_CTRL_FRAMING ? '+' : '-',
354 acm->ctrlin & ACM_CTRL_PARITY ? '+' : '-',
355 acm->ctrlin & ACM_CTRL_OVERRUN ? '+' : '-');
359 dev_dbg(&acm->control->dev,
360 "%s - unknown notification %d received: index %d "
361 "len %d data0 %d data1 %d\n",
363 dr->bNotificationType, dr->wIndex,
364 dr->wLength, data[0], data[1]);
368 retval = usb_submit_urb(urb, GFP_ATOMIC);
370 dev_err(&acm->control->dev, "%s - usb_submit_urb failed: %d\n",
374 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
378 if (!test_and_clear_bit(index, &acm->read_urbs_free))
381 dev_vdbg(&acm->data->dev, "%s - urb %d\n", __func__, index);
383 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
386 dev_err(&acm->data->dev,
387 "%s - usb_submit_urb failed: %d\n",
390 set_bit(index, &acm->read_urbs_free);
397 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
402 for (i = 0; i < acm->rx_buflimit; ++i) {
403 res = acm_submit_read_urb(acm, i, mem_flags);
411 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
413 if (!urb->actual_length)
416 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
418 tty_flip_buffer_push(&acm->port);
421 static void acm_read_bulk_callback(struct urb *urb)
423 struct acm_rb *rb = urb->context;
424 struct acm *acm = rb->instance;
427 dev_vdbg(&acm->data->dev, "%s - urb %d, len %d\n", __func__,
428 rb->index, urb->actual_length);
429 set_bit(rb->index, &acm->read_urbs_free);
432 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
435 usb_mark_last_busy(acm->dev);
438 dev_dbg(&acm->data->dev, "%s - non-zero urb status: %d\n",
439 __func__, urb->status);
442 acm_process_read_urb(acm, urb);
444 /* throttle device if requested by tty */
445 spin_lock_irqsave(&acm->read_lock, flags);
446 acm->throttled = acm->throttle_req;
447 if (!acm->throttled && !acm->susp_count) {
448 spin_unlock_irqrestore(&acm->read_lock, flags);
449 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
451 spin_unlock_irqrestore(&acm->read_lock, flags);
455 /* data interface wrote those outgoing bytes */
456 static void acm_write_bulk(struct urb *urb)
458 struct acm_wb *wb = urb->context;
459 struct acm *acm = wb->instance;
462 if (urb->status || (urb->actual_length != urb->transfer_buffer_length))
463 dev_vdbg(&acm->data->dev, "%s - len %d/%d, status %d\n",
466 urb->transfer_buffer_length,
469 spin_lock_irqsave(&acm->write_lock, flags);
470 acm_write_done(acm, wb);
471 spin_unlock_irqrestore(&acm->write_lock, flags);
472 schedule_work(&acm->work);
475 static void acm_softint(struct work_struct *work)
477 struct acm *acm = container_of(work, struct acm, work);
478 struct tty_struct *tty;
480 dev_vdbg(&acm->data->dev, "%s\n", __func__);
482 tty = tty_port_tty_get(&acm->port);
493 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
498 dev_dbg(tty->dev, "%s\n", __func__);
500 acm = acm_get_by_index(tty->index);
504 retval = tty_standard_install(driver, tty);
506 goto error_init_termios;
508 tty->driver_data = acm;
513 tty_port_put(&acm->port);
517 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
519 struct acm *acm = tty->driver_data;
521 dev_dbg(tty->dev, "%s\n", __func__);
523 return tty_port_open(&acm->port, tty, filp);
526 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
528 struct acm *acm = container_of(port, struct acm, port);
529 int retval = -ENODEV;
531 dev_dbg(&acm->control->dev, "%s\n", __func__);
533 mutex_lock(&acm->mutex);
534 if (acm->disconnected)
537 retval = usb_autopm_get_interface(acm->control);
539 goto error_get_interface;
542 * FIXME: Why do we need this? Allocating 64K of physically contiguous
543 * memory is really nasty...
545 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
546 acm->control->needs_remote_wakeup = 1;
548 acm->ctrlurb->dev = acm->dev;
549 if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
550 dev_err(&acm->control->dev,
551 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
552 goto error_submit_urb;
555 acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS;
556 if (acm_set_control(acm, acm->ctrlout) < 0 &&
557 (acm->ctrl_caps & USB_CDC_CAP_LINE))
558 goto error_set_control;
560 usb_autopm_put_interface(acm->control);
563 * Unthrottle device in case the TTY was closed while throttled.
565 spin_lock_irq(&acm->read_lock);
567 acm->throttle_req = 0;
568 spin_unlock_irq(&acm->read_lock);
570 if (acm_submit_read_urbs(acm, GFP_KERNEL))
571 goto error_submit_read_urbs;
573 mutex_unlock(&acm->mutex);
577 error_submit_read_urbs:
579 acm_set_control(acm, acm->ctrlout);
581 usb_kill_urb(acm->ctrlurb);
583 usb_autopm_put_interface(acm->control);
586 mutex_unlock(&acm->mutex);
590 static void acm_port_destruct(struct tty_port *port)
592 struct acm *acm = container_of(port, struct acm, port);
594 dev_dbg(&acm->control->dev, "%s\n", __func__);
596 acm_release_minor(acm);
597 usb_put_intf(acm->control);
598 kfree(acm->country_codes);
602 static void acm_port_shutdown(struct tty_port *port)
604 struct acm *acm = container_of(port, struct acm, port);
607 dev_dbg(&acm->control->dev, "%s\n", __func__);
609 mutex_lock(&acm->mutex);
610 if (!acm->disconnected) {
611 usb_autopm_get_interface(acm->control);
612 acm_set_control(acm, acm->ctrlout = 0);
613 usb_kill_urb(acm->ctrlurb);
614 for (i = 0; i < ACM_NW; i++)
615 usb_kill_urb(acm->wb[i].urb);
616 for (i = 0; i < acm->rx_buflimit; i++)
617 usb_kill_urb(acm->read_urbs[i]);
618 acm->control->needs_remote_wakeup = 0;
619 usb_autopm_put_interface(acm->control);
621 mutex_unlock(&acm->mutex);
624 static void acm_tty_cleanup(struct tty_struct *tty)
626 struct acm *acm = tty->driver_data;
627 dev_dbg(&acm->control->dev, "%s\n", __func__);
628 tty_port_put(&acm->port);
631 static void acm_tty_hangup(struct tty_struct *tty)
633 struct acm *acm = tty->driver_data;
634 dev_dbg(&acm->control->dev, "%s\n", __func__);
635 tty_port_hangup(&acm->port);
638 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
640 struct acm *acm = tty->driver_data;
641 dev_dbg(&acm->control->dev, "%s\n", __func__);
642 tty_port_close(&acm->port, tty, filp);
645 static int acm_tty_write(struct tty_struct *tty,
646 const unsigned char *buf, int count)
648 struct acm *acm = tty->driver_data;
657 dev_vdbg(&acm->data->dev, "%s - count %d\n", __func__, count);
659 spin_lock_irqsave(&acm->write_lock, flags);
660 wbn = acm_wb_alloc(acm);
662 spin_unlock_irqrestore(&acm->write_lock, flags);
667 count = (count > acm->writesize) ? acm->writesize : count;
668 dev_vdbg(&acm->data->dev, "%s - write %d\n", __func__, count);
669 memcpy(wb->buf, buf, count);
671 spin_unlock_irqrestore(&acm->write_lock, flags);
673 stat = acm_write_start(acm, wbn);
679 static int acm_tty_write_room(struct tty_struct *tty)
681 struct acm *acm = tty->driver_data;
683 * Do not let the line discipline to know that we have a reserve,
684 * or it might get too enthusiastic.
686 return acm_wb_is_avail(acm) ? acm->writesize : 0;
689 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
691 struct acm *acm = tty->driver_data;
693 * if the device was unplugged then any remaining characters fell out
694 * of the connector ;)
696 if (acm->disconnected)
699 * This is inaccurate (overcounts), but it works.
701 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
704 static void acm_tty_throttle(struct tty_struct *tty)
706 struct acm *acm = tty->driver_data;
708 spin_lock_irq(&acm->read_lock);
709 acm->throttle_req = 1;
710 spin_unlock_irq(&acm->read_lock);
713 static void acm_tty_unthrottle(struct tty_struct *tty)
715 struct acm *acm = tty->driver_data;
716 unsigned int was_throttled;
718 spin_lock_irq(&acm->read_lock);
719 was_throttled = acm->throttled;
721 acm->throttle_req = 0;
722 spin_unlock_irq(&acm->read_lock);
725 acm_submit_read_urbs(acm, GFP_KERNEL);
728 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
730 struct acm *acm = tty->driver_data;
733 retval = acm_send_break(acm, state ? 0xffff : 0);
735 dev_dbg(&acm->control->dev, "%s - send break failed\n",
740 static int acm_tty_tiocmget(struct tty_struct *tty)
742 struct acm *acm = tty->driver_data;
744 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
745 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
746 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
747 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
748 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
752 static int acm_tty_tiocmset(struct tty_struct *tty,
753 unsigned int set, unsigned int clear)
755 struct acm *acm = tty->driver_data;
756 unsigned int newctrl;
758 newctrl = acm->ctrlout;
759 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
760 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
761 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
762 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
764 newctrl = (newctrl & ~clear) | set;
766 if (acm->ctrlout == newctrl)
768 return acm_set_control(acm, acm->ctrlout = newctrl);
771 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
773 struct serial_struct tmp;
778 memset(&tmp, 0, sizeof(tmp));
779 tmp.flags = ASYNC_LOW_LATENCY;
780 tmp.xmit_fifo_size = acm->writesize;
781 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
782 tmp.close_delay = acm->port.close_delay / 10;
783 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
784 ASYNC_CLOSING_WAIT_NONE :
785 acm->port.closing_wait / 10;
787 if (copy_to_user(info, &tmp, sizeof(tmp)))
793 static int set_serial_info(struct acm *acm,
794 struct serial_struct __user *newinfo)
796 struct serial_struct new_serial;
797 unsigned int closing_wait, close_delay;
800 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
803 close_delay = new_serial.close_delay * 10;
804 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
805 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
807 mutex_lock(&acm->port.mutex);
809 if (!capable(CAP_SYS_ADMIN)) {
810 if ((close_delay != acm->port.close_delay) ||
811 (closing_wait != acm->port.closing_wait))
814 retval = -EOPNOTSUPP;
816 acm->port.close_delay = close_delay;
817 acm->port.closing_wait = closing_wait;
820 mutex_unlock(&acm->port.mutex);
824 static int acm_tty_ioctl(struct tty_struct *tty,
825 unsigned int cmd, unsigned long arg)
827 struct acm *acm = tty->driver_data;
828 int rv = -ENOIOCTLCMD;
831 case TIOCGSERIAL: /* gets serial port data */
832 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
835 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
842 static const __u32 acm_tty_speed[] = {
843 0, 50, 75, 110, 134, 150, 200, 300, 600,
844 1200, 1800, 2400, 4800, 9600, 19200, 38400,
845 57600, 115200, 230400, 460800, 500000, 576000,
846 921600, 1000000, 1152000, 1500000, 2000000,
847 2500000, 3000000, 3500000, 4000000
850 static void acm_tty_set_termios(struct tty_struct *tty,
851 struct ktermios *termios_old)
853 struct acm *acm = tty->driver_data;
854 struct ktermios *termios = &tty->termios;
855 struct usb_cdc_line_coding newline;
856 int newctrl = acm->ctrlout;
858 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
859 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
860 newline.bParityType = termios->c_cflag & PARENB ?
861 (termios->c_cflag & PARODD ? 1 : 2) +
862 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
863 switch (termios->c_cflag & CSIZE) {
865 newline.bDataBits = 5;
868 newline.bDataBits = 6;
871 newline.bDataBits = 7;
875 newline.bDataBits = 8;
878 /* FIXME: Needs to clear unsupported bits in the termios */
879 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
881 if (!newline.dwDTERate) {
882 newline.dwDTERate = acm->line.dwDTERate;
883 newctrl &= ~ACM_CTRL_DTR;
885 newctrl |= ACM_CTRL_DTR;
887 if (newctrl != acm->ctrlout)
888 acm_set_control(acm, acm->ctrlout = newctrl);
890 if (memcmp(&acm->line, &newline, sizeof newline)) {
891 memcpy(&acm->line, &newline, sizeof newline);
892 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
894 le32_to_cpu(newline.dwDTERate),
895 newline.bCharFormat, newline.bParityType,
897 acm_set_line(acm, &acm->line);
901 static const struct tty_port_operations acm_port_ops = {
902 .shutdown = acm_port_shutdown,
903 .activate = acm_port_activate,
904 .destruct = acm_port_destruct,
908 * USB probe and disconnect routines.
911 /* Little helpers: write/read buffers free */
912 static void acm_write_buffers_free(struct acm *acm)
916 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
918 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
919 usb_free_coherent(usb_dev, acm->writesize, wb->buf, wb->dmah);
922 static void acm_read_buffers_free(struct acm *acm)
924 struct usb_device *usb_dev = interface_to_usbdev(acm->control);
927 for (i = 0; i < acm->rx_buflimit; i++)
928 usb_free_coherent(usb_dev, acm->readsize,
929 acm->read_buffers[i].base, acm->read_buffers[i].dma);
932 /* Little helper: write buffers allocate */
933 static int acm_write_buffers_alloc(struct acm *acm)
938 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
939 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
945 usb_free_coherent(acm->dev, acm->writesize,
954 static int acm_probe(struct usb_interface *intf,
955 const struct usb_device_id *id)
957 struct usb_cdc_union_desc *union_header = NULL;
958 struct usb_cdc_country_functional_desc *cfd = NULL;
959 unsigned char *buffer = intf->altsetting->extra;
960 int buflen = intf->altsetting->extralen;
961 struct usb_interface *control_interface;
962 struct usb_interface *data_interface;
963 struct usb_endpoint_descriptor *epctrl = NULL;
964 struct usb_endpoint_descriptor *epread = NULL;
965 struct usb_endpoint_descriptor *epwrite = NULL;
966 struct usb_device *usb_dev = interface_to_usbdev(intf);
969 int ctrlsize, readsize;
971 u8 ac_management_function = 0;
972 u8 call_management_function = 0;
973 int call_interface_num = -1;
974 int data_interface_num = -1;
975 unsigned long quirks;
978 int combined_interfaces = 0;
979 struct device *tty_dev;
983 quirks = (unsigned long)id->driver_info;
984 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
986 /* handle quirks deadly to normal probing*/
987 if (quirks == NO_UNION_NORMAL) {
988 data_interface = usb_ifnum_to_if(usb_dev, 1);
989 control_interface = usb_ifnum_to_if(usb_dev, 0);
990 goto skip_normal_probe;
995 dev_err(&intf->dev, "Weird descriptor references\n");
1000 if (intf->cur_altsetting->endpoint &&
1001 intf->cur_altsetting->endpoint->extralen &&
1002 intf->cur_altsetting->endpoint->extra) {
1004 "Seeking extra descriptors on endpoint\n");
1005 buflen = intf->cur_altsetting->endpoint->extralen;
1006 buffer = intf->cur_altsetting->endpoint->extra;
1009 "Zero length descriptor references\n");
1014 while (buflen > 0) {
1015 if (buffer[1] != USB_DT_CS_INTERFACE) {
1016 dev_err(&intf->dev, "skipping garbage\n");
1020 switch (buffer[2]) {
1021 case USB_CDC_UNION_TYPE: /* we've found it */
1023 dev_err(&intf->dev, "More than one "
1024 "union descriptor, skipping ...\n");
1027 union_header = (struct usb_cdc_union_desc *)buffer;
1029 case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
1030 cfd = (struct usb_cdc_country_functional_desc *)buffer;
1032 case USB_CDC_HEADER_TYPE: /* maybe check version */
1033 break; /* for now we ignore it */
1034 case USB_CDC_ACM_TYPE:
1035 ac_management_function = buffer[3];
1037 case USB_CDC_CALL_MANAGEMENT_TYPE:
1038 call_management_function = buffer[3];
1039 call_interface_num = buffer[4];
1040 if ((quirks & NOT_A_MODEM) == 0 && (call_management_function & 3) != 3)
1041 dev_err(&intf->dev, "This device cannot do calls on its own. It is not a modem.\n");
1044 /* there are LOTS more CDC descriptors that
1045 * could legitimately be found here.
1047 dev_dbg(&intf->dev, "Ignoring descriptor: "
1048 "type %02x, length %d\n",
1049 buffer[2], buffer[0]);
1053 buflen -= buffer[0];
1054 buffer += buffer[0];
1057 if (!union_header) {
1058 if (call_interface_num > 0) {
1059 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1060 /* quirks for Droids MuIn LCD */
1061 if (quirks & NO_DATA_INTERFACE)
1062 data_interface = usb_ifnum_to_if(usb_dev, 0);
1064 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
1065 control_interface = intf;
1067 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1068 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1071 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1072 combined_interfaces = 1;
1073 control_interface = data_interface = intf;
1074 goto look_for_collapsed_interface;
1078 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1079 data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
1080 if (!control_interface || !data_interface) {
1081 dev_dbg(&intf->dev, "no interfaces\n");
1086 if (data_interface_num != call_interface_num)
1087 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1089 if (control_interface == data_interface) {
1090 /* some broken devices designed for windows work this way */
1091 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1092 combined_interfaces = 1;
1093 /* a popular other OS doesn't use it */
1094 quirks |= NO_CAP_LINE;
1095 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1096 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1099 look_for_collapsed_interface:
1100 for (i = 0; i < 3; i++) {
1101 struct usb_endpoint_descriptor *ep;
1102 ep = &data_interface->cur_altsetting->endpoint[i].desc;
1104 if (usb_endpoint_is_int_in(ep))
1106 else if (usb_endpoint_is_bulk_out(ep))
1108 else if (usb_endpoint_is_bulk_in(ep))
1113 if (!epctrl || !epread || !epwrite)
1116 goto made_compressed_probe;
1121 /*workaround for switched interfaces */
1122 if (data_interface->cur_altsetting->desc.bInterfaceClass
1123 != CDC_DATA_INTERFACE_TYPE) {
1124 if (control_interface->cur_altsetting->desc.bInterfaceClass
1125 == CDC_DATA_INTERFACE_TYPE) {
1126 struct usb_interface *t;
1128 "Your device has switched interfaces.\n");
1129 t = control_interface;
1130 control_interface = data_interface;
1137 /* Accept probe requests only for the control interface */
1138 if (!combined_interfaces && intf != control_interface)
1141 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1142 /* valid in this context */
1143 dev_dbg(&intf->dev, "The data interface isn't available\n");
1148 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1149 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1152 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1153 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1154 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1157 /* workaround for switched endpoints */
1158 if (!usb_endpoint_dir_in(epread)) {
1159 /* descriptors are swapped */
1160 struct usb_endpoint_descriptor *t;
1162 "The data interface has switched endpoints\n");
1167 made_compressed_probe:
1168 dev_dbg(&intf->dev, "interfaces are valid\n");
1170 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1172 dev_err(&intf->dev, "out of memory (acm kzalloc)\n");
1176 minor = acm_alloc_minor(acm);
1177 if (minor == ACM_TTY_MINORS) {
1178 dev_err(&intf->dev, "no more free acm devices\n");
1183 ctrlsize = usb_endpoint_maxp(epctrl);
1184 readsize = usb_endpoint_maxp(epread) *
1185 (quirks == SINGLE_RX_URB ? 1 : 2);
1186 acm->combined_interfaces = combined_interfaces;
1187 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1188 acm->control = control_interface;
1189 acm->data = data_interface;
1192 acm->ctrl_caps = ac_management_function;
1193 if (quirks & NO_CAP_LINE)
1194 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1195 acm->ctrlsize = ctrlsize;
1196 acm->readsize = readsize;
1197 acm->rx_buflimit = num_rx_buf;
1198 INIT_WORK(&acm->work, acm_softint);
1199 spin_lock_init(&acm->write_lock);
1200 spin_lock_init(&acm->read_lock);
1201 mutex_init(&acm->mutex);
1202 acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1203 acm->is_int_ep = usb_endpoint_xfer_int(epread);
1205 acm->bInterval = epread->bInterval;
1206 tty_port_init(&acm->port);
1207 acm->port.ops = &acm_port_ops;
1209 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1211 dev_err(&intf->dev, "out of memory (ctrl buffer alloc)\n");
1214 acm->ctrl_buffer = buf;
1216 if (acm_write_buffers_alloc(acm) < 0) {
1217 dev_err(&intf->dev, "out of memory (write buffer alloc)\n");
1221 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1222 if (!acm->ctrlurb) {
1223 dev_err(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
1226 for (i = 0; i < num_rx_buf; i++) {
1227 struct acm_rb *rb = &(acm->read_buffers[i]);
1230 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1233 dev_err(&intf->dev, "out of memory "
1234 "(read bufs usb_alloc_coherent)\n");
1240 urb = usb_alloc_urb(0, GFP_KERNEL);
1243 "out of memory (read urbs usb_alloc_urb)\n");
1246 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1247 urb->transfer_dma = rb->dma;
1248 if (acm->is_int_ep) {
1249 usb_fill_int_urb(urb, acm->dev,
1253 acm_read_bulk_callback, rb,
1256 usb_fill_bulk_urb(urb, acm->dev,
1260 acm_read_bulk_callback, rb);
1263 acm->read_urbs[i] = urb;
1264 __set_bit(i, &acm->read_urbs_free);
1266 for (i = 0; i < ACM_NW; i++) {
1267 struct acm_wb *snd = &(acm->wb[i]);
1269 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1270 if (snd->urb == NULL) {
1272 "out of memory (write urbs usb_alloc_urb)\n");
1276 if (usb_endpoint_xfer_int(epwrite))
1277 usb_fill_int_urb(snd->urb, usb_dev,
1278 usb_sndintpipe(usb_dev, epwrite->bEndpointAddress),
1279 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1281 usb_fill_bulk_urb(snd->urb, usb_dev,
1282 usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
1283 NULL, acm->writesize, acm_write_bulk, snd);
1284 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1285 snd->instance = acm;
1288 usb_set_intfdata(intf, acm);
1290 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1294 if (cfd) { /* export the country data */
1295 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1296 if (!acm->country_codes)
1297 goto skip_countries;
1298 acm->country_code_size = cfd->bLength - 4;
1299 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1301 acm->country_rel_date = cfd->iCountryCodeRelDate;
1303 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1305 kfree(acm->country_codes);
1306 acm->country_codes = NULL;
1307 acm->country_code_size = 0;
1308 goto skip_countries;
1311 i = device_create_file(&intf->dev,
1312 &dev_attr_iCountryCodeRelDate);
1314 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1315 kfree(acm->country_codes);
1316 acm->country_codes = NULL;
1317 acm->country_code_size = 0;
1318 goto skip_countries;
1323 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1324 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1325 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1326 /* works around buggy devices */
1327 epctrl->bInterval ? epctrl->bInterval : 0xff);
1328 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1329 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1331 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1333 acm_set_control(acm, acm->ctrlout);
1335 acm->line.dwDTERate = cpu_to_le32(9600);
1336 acm->line.bDataBits = 8;
1337 acm_set_line(acm, &acm->line);
1339 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1340 usb_set_intfdata(data_interface, acm);
1342 usb_get_intf(control_interface);
1343 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1344 &control_interface->dev);
1345 if (IS_ERR(tty_dev)) {
1346 rv = PTR_ERR(tty_dev);
1352 if (acm->country_codes) {
1353 device_remove_file(&acm->control->dev,
1354 &dev_attr_wCountryCodes);
1355 device_remove_file(&acm->control->dev,
1356 &dev_attr_iCountryCodeRelDate);
1358 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1360 usb_set_intfdata(intf, NULL);
1361 for (i = 0; i < ACM_NW; i++)
1362 usb_free_urb(acm->wb[i].urb);
1364 for (i = 0; i < num_rx_buf; i++)
1365 usb_free_urb(acm->read_urbs[i]);
1366 acm_read_buffers_free(acm);
1367 usb_free_urb(acm->ctrlurb);
1369 acm_write_buffers_free(acm);
1371 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1373 acm_release_minor(acm);
1379 static void stop_data_traffic(struct acm *acm)
1383 dev_dbg(&acm->control->dev, "%s\n", __func__);
1385 usb_kill_urb(acm->ctrlurb);
1386 for (i = 0; i < ACM_NW; i++)
1387 usb_kill_urb(acm->wb[i].urb);
1388 for (i = 0; i < acm->rx_buflimit; i++)
1389 usb_kill_urb(acm->read_urbs[i]);
1391 cancel_work_sync(&acm->work);
1394 static void acm_disconnect(struct usb_interface *intf)
1396 struct acm *acm = usb_get_intfdata(intf);
1397 struct usb_device *usb_dev = interface_to_usbdev(intf);
1398 struct tty_struct *tty;
1401 dev_dbg(&intf->dev, "%s\n", __func__);
1403 /* sibling interface is already cleaning up */
1407 mutex_lock(&acm->mutex);
1408 acm->disconnected = true;
1409 if (acm->country_codes) {
1410 device_remove_file(&acm->control->dev,
1411 &dev_attr_wCountryCodes);
1412 device_remove_file(&acm->control->dev,
1413 &dev_attr_iCountryCodeRelDate);
1415 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1416 usb_set_intfdata(acm->control, NULL);
1417 usb_set_intfdata(acm->data, NULL);
1418 mutex_unlock(&acm->mutex);
1420 tty = tty_port_tty_get(&acm->port);
1426 stop_data_traffic(acm);
1428 tty_unregister_device(acm_tty_driver, acm->minor);
1430 usb_free_urb(acm->ctrlurb);
1431 for (i = 0; i < ACM_NW; i++)
1432 usb_free_urb(acm->wb[i].urb);
1433 for (i = 0; i < acm->rx_buflimit; i++)
1434 usb_free_urb(acm->read_urbs[i]);
1435 acm_write_buffers_free(acm);
1436 usb_free_coherent(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1437 acm_read_buffers_free(acm);
1439 if (!acm->combined_interfaces)
1440 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1441 acm->data : acm->control);
1443 tty_port_put(&acm->port);
1447 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1449 struct acm *acm = usb_get_intfdata(intf);
1452 if (PMSG_IS_AUTO(message)) {
1455 spin_lock_irq(&acm->write_lock);
1456 b = acm->transmitting;
1457 spin_unlock_irq(&acm->write_lock);
1462 spin_lock_irq(&acm->read_lock);
1463 spin_lock(&acm->write_lock);
1464 cnt = acm->susp_count++;
1465 spin_unlock(&acm->write_lock);
1466 spin_unlock_irq(&acm->read_lock);
1471 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags))
1472 stop_data_traffic(acm);
1477 static int acm_resume(struct usb_interface *intf)
1479 struct acm *acm = usb_get_intfdata(intf);
1484 spin_lock_irq(&acm->read_lock);
1485 acm->susp_count -= 1;
1486 cnt = acm->susp_count;
1487 spin_unlock_irq(&acm->read_lock);
1492 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1493 rv = usb_submit_urb(acm->ctrlurb, GFP_NOIO);
1495 spin_lock_irq(&acm->write_lock);
1496 if (acm->delayed_wb) {
1497 wb = acm->delayed_wb;
1498 acm->delayed_wb = NULL;
1499 spin_unlock_irq(&acm->write_lock);
1500 acm_start_wb(acm, wb);
1502 spin_unlock_irq(&acm->write_lock);
1506 * delayed error checking because we must
1507 * do the write path at all cost
1512 rv = acm_submit_read_urbs(acm, GFP_NOIO);
1519 static int acm_reset_resume(struct usb_interface *intf)
1521 struct acm *acm = usb_get_intfdata(intf);
1522 struct tty_struct *tty;
1524 if (test_bit(ASYNCB_INITIALIZED, &acm->port.flags)) {
1525 tty = tty_port_tty_get(&acm->port);
1532 return acm_resume(intf);
1535 #endif /* CONFIG_PM */
1537 #define NOKIA_PCSUITE_ACM_INFO(x) \
1538 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1539 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1540 USB_CDC_ACM_PROTO_VENDOR)
1542 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1543 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1544 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1545 USB_CDC_ACM_PROTO_VENDOR)
1548 * USB driver structure.
1551 static const struct usb_device_id acm_ids[] = {
1552 /* quirky and broken devices */
1553 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1554 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1556 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1557 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1559 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1560 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1562 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1563 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1565 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1566 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1568 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1569 .driver_info = SINGLE_RX_URB,
1571 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1572 .driver_info = SINGLE_RX_URB, /* firmware bug */
1574 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1575 .driver_info = SINGLE_RX_URB, /* firmware bug */
1577 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1578 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1580 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1581 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1583 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1584 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1586 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1587 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1589 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1590 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1592 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1594 /* Motorola H24 HSPA module: */
1595 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1596 { USB_DEVICE(0x22b8, 0x2d92) }, /* modem + diagnostics */
1597 { USB_DEVICE(0x22b8, 0x2d93) }, /* modem + AT port */
1598 { USB_DEVICE(0x22b8, 0x2d95) }, /* modem + AT port + diagnostics */
1599 { USB_DEVICE(0x22b8, 0x2d96) }, /* modem + NMEA */
1600 { USB_DEVICE(0x22b8, 0x2d97) }, /* modem + diagnostics + NMEA */
1601 { USB_DEVICE(0x22b8, 0x2d99) }, /* modem + AT port + NMEA */
1602 { USB_DEVICE(0x22b8, 0x2d9a) }, /* modem + AT port + diagnostics + NMEA */
1604 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1605 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1606 data interface instead of
1607 communications interface.
1608 Maybe we should define a new
1611 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1612 .driver_info = NO_UNION_NORMAL,
1614 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1615 .driver_info = NO_UNION_NORMAL,
1617 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1618 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1620 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1621 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1624 /* Nokia S60 phones expose two ACM channels. The first is
1625 * a modem and is picked up by the standard AT-command
1626 * information below. The second is 'vendor-specific' but
1627 * is treated as a serial device at the S60 end, so we want
1628 * to expose it on Linux too. */
1629 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1630 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1631 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1632 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1633 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1634 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1635 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1636 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1637 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1638 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1639 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1640 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1641 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1642 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1643 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1644 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1645 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1646 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1647 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1648 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1649 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1650 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1651 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1652 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1653 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1654 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1655 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1656 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1657 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1658 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1659 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1660 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1661 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1662 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1663 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1664 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1665 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1666 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1667 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1668 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1669 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1670 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1671 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1672 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1673 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1674 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1675 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1676 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1677 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1678 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1679 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1680 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1681 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1682 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1683 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1684 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1685 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1686 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1688 /* Support for Owen devices */
1689 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1691 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1693 /* Support Lego NXT using pbLua firmware */
1694 { USB_DEVICE(0x0694, 0xff00),
1695 .driver_info = NOT_A_MODEM,
1698 /* Support for Droids MuIn LCD */
1699 { USB_DEVICE(0x04d8, 0x000b),
1700 .driver_info = NO_DATA_INTERFACE,
1703 /* control interfaces without any protocol set */
1704 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1705 USB_CDC_PROTO_NONE) },
1707 /* control interfaces with various AT-command sets */
1708 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1709 USB_CDC_ACM_PROTO_AT_V25TER) },
1710 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1711 USB_CDC_ACM_PROTO_AT_PCCA101) },
1712 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1713 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1714 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1715 USB_CDC_ACM_PROTO_AT_GSM) },
1716 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1717 USB_CDC_ACM_PROTO_AT_3G) },
1718 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1719 USB_CDC_ACM_PROTO_AT_CDMA) },
1724 MODULE_DEVICE_TABLE(usb, acm_ids);
1726 static struct usb_driver acm_driver = {
1729 .disconnect = acm_disconnect,
1731 .suspend = acm_suspend,
1732 .resume = acm_resume,
1733 .reset_resume = acm_reset_resume,
1735 .id_table = acm_ids,
1737 .supports_autosuspend = 1,
1739 .disable_hub_initiated_lpm = 1,
1743 * TTY driver structures.
1746 static const struct tty_operations acm_ops = {
1747 .install = acm_tty_install,
1748 .open = acm_tty_open,
1749 .close = acm_tty_close,
1750 .cleanup = acm_tty_cleanup,
1751 .hangup = acm_tty_hangup,
1752 .write = acm_tty_write,
1753 .write_room = acm_tty_write_room,
1754 .ioctl = acm_tty_ioctl,
1755 .throttle = acm_tty_throttle,
1756 .unthrottle = acm_tty_unthrottle,
1757 .chars_in_buffer = acm_tty_chars_in_buffer,
1758 .break_ctl = acm_tty_break_ctl,
1759 .set_termios = acm_tty_set_termios,
1760 .tiocmget = acm_tty_tiocmget,
1761 .tiocmset = acm_tty_tiocmset,
1768 static int __init acm_init(void)
1771 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1772 if (!acm_tty_driver)
1774 acm_tty_driver->driver_name = "acm",
1775 acm_tty_driver->name = "ttyACM",
1776 acm_tty_driver->major = ACM_TTY_MAJOR,
1777 acm_tty_driver->minor_start = 0,
1778 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1779 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1780 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1781 acm_tty_driver->init_termios = tty_std_termios;
1782 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1784 tty_set_operations(acm_tty_driver, &acm_ops);
1786 retval = tty_register_driver(acm_tty_driver);
1788 put_tty_driver(acm_tty_driver);
1792 retval = usb_register(&acm_driver);
1794 tty_unregister_driver(acm_tty_driver);
1795 put_tty_driver(acm_tty_driver);
1799 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1804 static void __exit acm_exit(void)
1806 usb_deregister(&acm_driver);
1807 tty_unregister_driver(acm_tty_driver);
1808 put_tty_driver(acm_tty_driver);
1811 module_init(acm_init);
1812 module_exit(acm_exit);
1814 MODULE_AUTHOR(DRIVER_AUTHOR);
1815 MODULE_DESCRIPTION(DRIVER_DESC);
1816 MODULE_LICENSE("GPL");
1817 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);