4 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
5 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
6 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
9 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
10 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 * USB Abstract Control Model driver for USB modems and ISDN adapters
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/serial.h>
40 #include <linux/tty_driver.h>
41 #include <linux/tty_flip.h>
42 #include <linux/module.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/usb/cdc.h>
47 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
49 #include <linux/list.h>
54 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
55 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
57 static struct usb_driver acm_driver
;
58 static struct tty_driver
*acm_tty_driver
;
59 static struct acm
*acm_table
[ACM_TTY_MINORS
];
61 static DEFINE_MUTEX(acm_table_lock
);
68 * Look up an ACM structure by index. If found and not disconnected, increment
69 * its refcount and return it with its mutex held.
71 static struct acm
*acm_get_by_index(unsigned index
)
75 mutex_lock(&acm_table_lock
);
76 acm
= acm_table
[index
];
78 mutex_lock(&acm
->mutex
);
79 if (acm
->disconnected
) {
80 mutex_unlock(&acm
->mutex
);
83 tty_port_get(&acm
->port
);
84 mutex_unlock(&acm
->mutex
);
87 mutex_unlock(&acm_table_lock
);
92 * Try to find an available minor number and if found, associate it with 'acm'.
94 static int acm_alloc_minor(struct acm
*acm
)
98 mutex_lock(&acm_table_lock
);
99 for (minor
= 0; minor
< ACM_TTY_MINORS
; minor
++) {
100 if (!acm_table
[minor
]) {
101 acm_table
[minor
] = acm
;
105 mutex_unlock(&acm_table_lock
);
110 /* Release the minor number associated with 'acm'. */
111 static void acm_release_minor(struct acm
*acm
)
113 mutex_lock(&acm_table_lock
);
114 acm_table
[acm
->minor
] = NULL
;
115 mutex_unlock(&acm_table_lock
);
119 * Functions for ACM control messages.
122 static int acm_ctrl_msg(struct acm
*acm
, int request
, int value
,
127 retval
= usb_autopm_get_interface(acm
->control
);
131 retval
= usb_control_msg(acm
->dev
, usb_sndctrlpipe(acm
->dev
, 0),
132 request
, USB_RT_ACM
, value
,
133 acm
->control
->altsetting
[0].desc
.bInterfaceNumber
,
136 dev_dbg(&acm
->control
->dev
,
137 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
138 __func__
, request
, value
, len
, retval
);
140 usb_autopm_put_interface(acm
->control
);
142 return retval
< 0 ? retval
: 0;
145 /* devices aren't required to support these requests.
146 * the cdc acm descriptor tells whether they do...
148 #define acm_set_control(acm, control) \
149 acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
150 #define acm_set_line(acm, line) \
151 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
152 #define acm_send_break(acm, ms) \
153 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
156 * Write buffer management.
157 * All of these assume proper locks taken by the caller.
160 static int acm_wb_alloc(struct acm
*acm
)
173 wbn
= (wbn
+ 1) % ACM_NW
;
179 static int acm_wb_is_avail(struct acm
*acm
)
185 spin_lock_irqsave(&acm
->write_lock
, flags
);
186 for (i
= 0; i
< ACM_NW
; i
++)
188 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
193 * Finish write. Caller must hold acm->write_lock
195 static void acm_write_done(struct acm
*acm
, struct acm_wb
*wb
)
199 usb_autopm_put_interface_async(acm
->control
);
205 * the caller is responsible for locking
208 static int acm_start_wb(struct acm
*acm
, struct acm_wb
*wb
)
214 wb
->urb
->transfer_buffer
= wb
->buf
;
215 wb
->urb
->transfer_dma
= wb
->dmah
;
216 wb
->urb
->transfer_buffer_length
= wb
->len
;
217 wb
->urb
->dev
= acm
->dev
;
219 rc
= usb_submit_urb(wb
->urb
, GFP_ATOMIC
);
221 dev_err(&acm
->data
->dev
,
222 "%s - usb_submit_urb(write bulk) failed: %d\n",
224 acm_write_done(acm
, wb
);
229 static int acm_write_start(struct acm
*acm
, int wbn
)
232 struct acm_wb
*wb
= &acm
->wb
[wbn
];
235 spin_lock_irqsave(&acm
->write_lock
, flags
);
238 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
242 dev_vdbg(&acm
->data
->dev
, "%s - susp_count %d\n", __func__
,
244 usb_autopm_get_interface_async(acm
->control
);
245 if (acm
->susp_count
) {
246 usb_anchor_urb(wb
->urb
, &acm
->delayed
);
247 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
250 usb_mark_last_busy(acm
->dev
);
252 rc
= acm_start_wb(acm
, wb
);
253 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
259 * attributes exported through sysfs
261 static ssize_t show_caps
262 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
264 struct usb_interface
*intf
= to_usb_interface(dev
);
265 struct acm
*acm
= usb_get_intfdata(intf
);
267 return sprintf(buf
, "%d", acm
->ctrl_caps
);
269 static DEVICE_ATTR(bmCapabilities
, S_IRUGO
, show_caps
, NULL
);
271 static ssize_t show_country_codes
272 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
274 struct usb_interface
*intf
= to_usb_interface(dev
);
275 struct acm
*acm
= usb_get_intfdata(intf
);
277 memcpy(buf
, acm
->country_codes
, acm
->country_code_size
);
278 return acm
->country_code_size
;
281 static DEVICE_ATTR(wCountryCodes
, S_IRUGO
, show_country_codes
, NULL
);
283 static ssize_t show_country_rel_date
284 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
286 struct usb_interface
*intf
= to_usb_interface(dev
);
287 struct acm
*acm
= usb_get_intfdata(intf
);
289 return sprintf(buf
, "%d", acm
->country_rel_date
);
292 static DEVICE_ATTR(iCountryCodeRelDate
, S_IRUGO
, show_country_rel_date
, NULL
);
294 * Interrupt handlers for various ACM device responses
297 /* control interface reports status changes with "interrupt" transfers */
298 static void acm_ctrl_irq(struct urb
*urb
)
300 struct acm
*acm
= urb
->context
;
301 struct usb_cdc_notification
*dr
= urb
->transfer_buffer
;
305 int status
= urb
->status
;
314 /* this urb is terminated, clean up */
315 dev_dbg(&acm
->control
->dev
,
316 "%s - urb shutting down with status: %d\n",
320 dev_dbg(&acm
->control
->dev
,
321 "%s - nonzero urb status received: %d\n",
326 usb_mark_last_busy(acm
->dev
);
328 data
= (unsigned char *)(dr
+ 1);
329 switch (dr
->bNotificationType
) {
330 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
331 dev_dbg(&acm
->control
->dev
, "%s - network connection: %d\n",
332 __func__
, dr
->wValue
);
335 case USB_CDC_NOTIFY_SERIAL_STATE
:
336 newctrl
= get_unaligned_le16(data
);
338 if (!acm
->clocal
&& (acm
->ctrlin
& ~newctrl
& ACM_CTRL_DCD
)) {
339 dev_dbg(&acm
->control
->dev
, "%s - calling hangup\n",
341 tty_port_tty_hangup(&acm
->port
, false);
344 acm
->ctrlin
= newctrl
;
346 dev_dbg(&acm
->control
->dev
,
347 "%s - input control lines: dcd%c dsr%c break%c "
348 "ring%c framing%c parity%c overrun%c\n",
350 acm
->ctrlin
& ACM_CTRL_DCD
? '+' : '-',
351 acm
->ctrlin
& ACM_CTRL_DSR
? '+' : '-',
352 acm
->ctrlin
& ACM_CTRL_BRK
? '+' : '-',
353 acm
->ctrlin
& ACM_CTRL_RI
? '+' : '-',
354 acm
->ctrlin
& ACM_CTRL_FRAMING
? '+' : '-',
355 acm
->ctrlin
& ACM_CTRL_PARITY
? '+' : '-',
356 acm
->ctrlin
& ACM_CTRL_OVERRUN
? '+' : '-');
360 dev_dbg(&acm
->control
->dev
,
361 "%s - unknown notification %d received: index %d "
362 "len %d data0 %d data1 %d\n",
364 dr
->bNotificationType
, dr
->wIndex
,
365 dr
->wLength
, data
[0], data
[1]);
369 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
371 dev_err(&acm
->control
->dev
, "%s - usb_submit_urb failed: %d\n",
375 static int acm_submit_read_urb(struct acm
*acm
, int index
, gfp_t mem_flags
)
379 if (!test_and_clear_bit(index
, &acm
->read_urbs_free
))
382 dev_vdbg(&acm
->data
->dev
, "%s - urb %d\n", __func__
, index
);
384 res
= usb_submit_urb(acm
->read_urbs
[index
], mem_flags
);
387 dev_err(&acm
->data
->dev
,
388 "%s - usb_submit_urb failed: %d\n",
391 set_bit(index
, &acm
->read_urbs_free
);
398 static int acm_submit_read_urbs(struct acm
*acm
, gfp_t mem_flags
)
403 for (i
= 0; i
< acm
->rx_buflimit
; ++i
) {
404 res
= acm_submit_read_urb(acm
, i
, mem_flags
);
412 static void acm_process_read_urb(struct acm
*acm
, struct urb
*urb
)
414 if (!urb
->actual_length
)
417 tty_insert_flip_string(&acm
->port
, urb
->transfer_buffer
,
419 tty_flip_buffer_push(&acm
->port
);
422 static void acm_read_bulk_callback(struct urb
*urb
)
424 struct acm_rb
*rb
= urb
->context
;
425 struct acm
*acm
= rb
->instance
;
428 dev_vdbg(&acm
->data
->dev
, "%s - urb %d, len %d\n", __func__
,
429 rb
->index
, urb
->actual_length
);
430 set_bit(rb
->index
, &acm
->read_urbs_free
);
433 dev_dbg(&acm
->data
->dev
, "%s - disconnected\n", __func__
);
436 usb_mark_last_busy(acm
->dev
);
439 dev_dbg(&acm
->data
->dev
, "%s - non-zero urb status: %d\n",
440 __func__
, urb
->status
);
443 acm_process_read_urb(acm
, urb
);
445 /* throttle device if requested by tty */
446 spin_lock_irqsave(&acm
->read_lock
, flags
);
447 acm
->throttled
= acm
->throttle_req
;
448 if (!acm
->throttled
&& !acm
->susp_count
) {
449 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
450 acm_submit_read_urb(acm
, rb
->index
, GFP_ATOMIC
);
452 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
456 /* data interface wrote those outgoing bytes */
457 static void acm_write_bulk(struct urb
*urb
)
459 struct acm_wb
*wb
= urb
->context
;
460 struct acm
*acm
= wb
->instance
;
463 if (urb
->status
|| (urb
->actual_length
!= urb
->transfer_buffer_length
))
464 dev_vdbg(&acm
->data
->dev
, "%s - len %d/%d, status %d\n",
467 urb
->transfer_buffer_length
,
470 spin_lock_irqsave(&acm
->write_lock
, flags
);
471 acm_write_done(acm
, wb
);
472 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
473 schedule_work(&acm
->work
);
476 static void acm_softint(struct work_struct
*work
)
478 struct acm
*acm
= container_of(work
, struct acm
, work
);
480 dev_vdbg(&acm
->data
->dev
, "%s\n", __func__
);
482 tty_port_tty_wakeup(&acm
->port
);
489 static int acm_tty_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
494 dev_dbg(tty
->dev
, "%s\n", __func__
);
496 acm
= acm_get_by_index(tty
->index
);
500 retval
= tty_standard_install(driver
, tty
);
502 goto error_init_termios
;
504 tty
->driver_data
= acm
;
509 tty_port_put(&acm
->port
);
513 static int acm_tty_open(struct tty_struct
*tty
, struct file
*filp
)
515 struct acm
*acm
= tty
->driver_data
;
517 dev_dbg(tty
->dev
, "%s\n", __func__
);
519 return tty_port_open(&acm
->port
, tty
, filp
);
522 static int acm_port_activate(struct tty_port
*port
, struct tty_struct
*tty
)
524 struct acm
*acm
= container_of(port
, struct acm
, port
);
525 int retval
= -ENODEV
;
528 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
530 mutex_lock(&acm
->mutex
);
531 if (acm
->disconnected
)
534 retval
= usb_autopm_get_interface(acm
->control
);
536 goto error_get_interface
;
539 * FIXME: Why do we need this? Allocating 64K of physically contiguous
540 * memory is really nasty...
542 set_bit(TTY_NO_WRITE_SPLIT
, &tty
->flags
);
543 acm
->control
->needs_remote_wakeup
= 1;
545 acm
->ctrlurb
->dev
= acm
->dev
;
546 retval
= usb_submit_urb(acm
->ctrlurb
, GFP_KERNEL
);
548 dev_err(&acm
->control
->dev
,
549 "%s - usb_submit_urb(ctrl irq) failed\n", __func__
);
550 goto error_submit_urb
;
553 acm
->ctrlout
= ACM_CTRL_DTR
| ACM_CTRL_RTS
;
554 retval
= acm_set_control(acm
, acm
->ctrlout
);
555 if (retval
< 0 && (acm
->ctrl_caps
& USB_CDC_CAP_LINE
))
556 goto error_set_control
;
559 * Unthrottle device in case the TTY was closed while throttled.
561 spin_lock_irq(&acm
->read_lock
);
563 acm
->throttle_req
= 0;
564 spin_unlock_irq(&acm
->read_lock
);
566 retval
= acm_submit_read_urbs(acm
, GFP_KERNEL
);
568 goto error_submit_read_urbs
;
570 usb_autopm_put_interface(acm
->control
);
572 mutex_unlock(&acm
->mutex
);
576 error_submit_read_urbs
:
577 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
578 usb_kill_urb(acm
->read_urbs
[i
]);
580 acm_set_control(acm
, acm
->ctrlout
);
582 usb_kill_urb(acm
->ctrlurb
);
584 usb_autopm_put_interface(acm
->control
);
587 mutex_unlock(&acm
->mutex
);
589 return usb_translate_errors(retval
);
592 static void acm_port_destruct(struct tty_port
*port
)
594 struct acm
*acm
= container_of(port
, struct acm
, port
);
596 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
598 acm_release_minor(acm
);
599 usb_put_intf(acm
->control
);
600 kfree(acm
->country_codes
);
604 static void acm_port_shutdown(struct tty_port
*port
)
606 struct acm
*acm
= container_of(port
, struct acm
, port
);
612 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
614 mutex_lock(&acm
->mutex
);
615 if (!acm
->disconnected
) {
616 pm_err
= usb_autopm_get_interface(acm
->control
);
617 acm_set_control(acm
, acm
->ctrlout
= 0);
620 urb
= usb_get_from_anchor(&acm
->delayed
);
625 usb_autopm_put_interface_async(acm
->control
);
628 usb_kill_urb(acm
->ctrlurb
);
629 for (i
= 0; i
< ACM_NW
; i
++)
630 usb_kill_urb(acm
->wb
[i
].urb
);
631 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
632 usb_kill_urb(acm
->read_urbs
[i
]);
633 acm
->control
->needs_remote_wakeup
= 0;
635 usb_autopm_put_interface(acm
->control
);
637 mutex_unlock(&acm
->mutex
);
640 static void acm_tty_cleanup(struct tty_struct
*tty
)
642 struct acm
*acm
= tty
->driver_data
;
643 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
644 tty_port_put(&acm
->port
);
647 static void acm_tty_hangup(struct tty_struct
*tty
)
649 struct acm
*acm
= tty
->driver_data
;
650 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
651 tty_port_hangup(&acm
->port
);
654 static void acm_tty_close(struct tty_struct
*tty
, struct file
*filp
)
656 struct acm
*acm
= tty
->driver_data
;
657 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
658 tty_port_close(&acm
->port
, tty
, filp
);
661 static int acm_tty_write(struct tty_struct
*tty
,
662 const unsigned char *buf
, int count
)
664 struct acm
*acm
= tty
->driver_data
;
673 dev_vdbg(&acm
->data
->dev
, "%s - count %d\n", __func__
, count
);
675 spin_lock_irqsave(&acm
->write_lock
, flags
);
676 wbn
= acm_wb_alloc(acm
);
678 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
683 count
= (count
> acm
->writesize
) ? acm
->writesize
: count
;
684 dev_vdbg(&acm
->data
->dev
, "%s - write %d\n", __func__
, count
);
685 memcpy(wb
->buf
, buf
, count
);
687 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
689 stat
= acm_write_start(acm
, wbn
);
695 static int acm_tty_write_room(struct tty_struct
*tty
)
697 struct acm
*acm
= tty
->driver_data
;
699 * Do not let the line discipline to know that we have a reserve,
700 * or it might get too enthusiastic.
702 return acm_wb_is_avail(acm
) ? acm
->writesize
: 0;
705 static int acm_tty_chars_in_buffer(struct tty_struct
*tty
)
707 struct acm
*acm
= tty
->driver_data
;
709 * if the device was unplugged then any remaining characters fell out
710 * of the connector ;)
712 if (acm
->disconnected
)
715 * This is inaccurate (overcounts), but it works.
717 return (ACM_NW
- acm_wb_is_avail(acm
)) * acm
->writesize
;
720 static void acm_tty_throttle(struct tty_struct
*tty
)
722 struct acm
*acm
= tty
->driver_data
;
724 spin_lock_irq(&acm
->read_lock
);
725 acm
->throttle_req
= 1;
726 spin_unlock_irq(&acm
->read_lock
);
729 static void acm_tty_unthrottle(struct tty_struct
*tty
)
731 struct acm
*acm
= tty
->driver_data
;
732 unsigned int was_throttled
;
734 spin_lock_irq(&acm
->read_lock
);
735 was_throttled
= acm
->throttled
;
737 acm
->throttle_req
= 0;
738 spin_unlock_irq(&acm
->read_lock
);
741 acm_submit_read_urbs(acm
, GFP_KERNEL
);
744 static int acm_tty_break_ctl(struct tty_struct
*tty
, int state
)
746 struct acm
*acm
= tty
->driver_data
;
749 retval
= acm_send_break(acm
, state
? 0xffff : 0);
751 dev_dbg(&acm
->control
->dev
, "%s - send break failed\n",
756 static int acm_tty_tiocmget(struct tty_struct
*tty
)
758 struct acm
*acm
= tty
->driver_data
;
760 return (acm
->ctrlout
& ACM_CTRL_DTR
? TIOCM_DTR
: 0) |
761 (acm
->ctrlout
& ACM_CTRL_RTS
? TIOCM_RTS
: 0) |
762 (acm
->ctrlin
& ACM_CTRL_DSR
? TIOCM_DSR
: 0) |
763 (acm
->ctrlin
& ACM_CTRL_RI
? TIOCM_RI
: 0) |
764 (acm
->ctrlin
& ACM_CTRL_DCD
? TIOCM_CD
: 0) |
768 static int acm_tty_tiocmset(struct tty_struct
*tty
,
769 unsigned int set
, unsigned int clear
)
771 struct acm
*acm
= tty
->driver_data
;
772 unsigned int newctrl
;
774 newctrl
= acm
->ctrlout
;
775 set
= (set
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
776 (set
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
777 clear
= (clear
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
778 (clear
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
780 newctrl
= (newctrl
& ~clear
) | set
;
782 if (acm
->ctrlout
== newctrl
)
784 return acm_set_control(acm
, acm
->ctrlout
= newctrl
);
787 static int get_serial_info(struct acm
*acm
, struct serial_struct __user
*info
)
789 struct serial_struct tmp
;
794 memset(&tmp
, 0, sizeof(tmp
));
795 tmp
.flags
= ASYNC_LOW_LATENCY
;
796 tmp
.xmit_fifo_size
= acm
->writesize
;
797 tmp
.baud_base
= le32_to_cpu(acm
->line
.dwDTERate
);
798 tmp
.close_delay
= acm
->port
.close_delay
/ 10;
799 tmp
.closing_wait
= acm
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
800 ASYNC_CLOSING_WAIT_NONE
:
801 acm
->port
.closing_wait
/ 10;
803 if (copy_to_user(info
, &tmp
, sizeof(tmp
)))
809 static int set_serial_info(struct acm
*acm
,
810 struct serial_struct __user
*newinfo
)
812 struct serial_struct new_serial
;
813 unsigned int closing_wait
, close_delay
;
816 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
819 close_delay
= new_serial
.close_delay
* 10;
820 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
821 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
823 mutex_lock(&acm
->port
.mutex
);
825 if (!capable(CAP_SYS_ADMIN
)) {
826 if ((close_delay
!= acm
->port
.close_delay
) ||
827 (closing_wait
!= acm
->port
.closing_wait
))
830 retval
= -EOPNOTSUPP
;
832 acm
->port
.close_delay
= close_delay
;
833 acm
->port
.closing_wait
= closing_wait
;
836 mutex_unlock(&acm
->port
.mutex
);
840 static int acm_tty_ioctl(struct tty_struct
*tty
,
841 unsigned int cmd
, unsigned long arg
)
843 struct acm
*acm
= tty
->driver_data
;
844 int rv
= -ENOIOCTLCMD
;
847 case TIOCGSERIAL
: /* gets serial port data */
848 rv
= get_serial_info(acm
, (struct serial_struct __user
*) arg
);
851 rv
= set_serial_info(acm
, (struct serial_struct __user
*) arg
);
858 static void acm_tty_set_termios(struct tty_struct
*tty
,
859 struct ktermios
*termios_old
)
861 struct acm
*acm
= tty
->driver_data
;
862 struct ktermios
*termios
= &tty
->termios
;
863 struct usb_cdc_line_coding newline
;
864 int newctrl
= acm
->ctrlout
;
866 newline
.dwDTERate
= cpu_to_le32(tty_get_baud_rate(tty
));
867 newline
.bCharFormat
= termios
->c_cflag
& CSTOPB
? 2 : 0;
868 newline
.bParityType
= termios
->c_cflag
& PARENB
?
869 (termios
->c_cflag
& PARODD
? 1 : 2) +
870 (termios
->c_cflag
& CMSPAR
? 2 : 0) : 0;
871 switch (termios
->c_cflag
& CSIZE
) {
873 newline
.bDataBits
= 5;
876 newline
.bDataBits
= 6;
879 newline
.bDataBits
= 7;
883 newline
.bDataBits
= 8;
886 /* FIXME: Needs to clear unsupported bits in the termios */
887 acm
->clocal
= ((termios
->c_cflag
& CLOCAL
) != 0);
889 if (C_BAUD(tty
) == B0
) {
890 newline
.dwDTERate
= acm
->line
.dwDTERate
;
891 newctrl
&= ~ACM_CTRL_DTR
;
892 } else if (termios_old
&& (termios_old
->c_cflag
& CBAUD
) == B0
) {
893 newctrl
|= ACM_CTRL_DTR
;
896 if (newctrl
!= acm
->ctrlout
)
897 acm_set_control(acm
, acm
->ctrlout
= newctrl
);
899 if (memcmp(&acm
->line
, &newline
, sizeof newline
)) {
900 memcpy(&acm
->line
, &newline
, sizeof newline
);
901 dev_dbg(&acm
->control
->dev
, "%s - set line: %d %d %d %d\n",
903 le32_to_cpu(newline
.dwDTERate
),
904 newline
.bCharFormat
, newline
.bParityType
,
906 acm_set_line(acm
, &acm
->line
);
910 static const struct tty_port_operations acm_port_ops
= {
911 .shutdown
= acm_port_shutdown
,
912 .activate
= acm_port_activate
,
913 .destruct
= acm_port_destruct
,
917 * USB probe and disconnect routines.
920 /* Little helpers: write/read buffers free */
921 static void acm_write_buffers_free(struct acm
*acm
)
925 struct usb_device
*usb_dev
= interface_to_usbdev(acm
->control
);
927 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++)
928 usb_free_coherent(usb_dev
, acm
->writesize
, wb
->buf
, wb
->dmah
);
931 static void acm_read_buffers_free(struct acm
*acm
)
933 struct usb_device
*usb_dev
= interface_to_usbdev(acm
->control
);
936 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
937 usb_free_coherent(usb_dev
, acm
->readsize
,
938 acm
->read_buffers
[i
].base
, acm
->read_buffers
[i
].dma
);
941 /* Little helper: write buffers allocate */
942 static int acm_write_buffers_alloc(struct acm
*acm
)
947 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++) {
948 wb
->buf
= usb_alloc_coherent(acm
->dev
, acm
->writesize
, GFP_KERNEL
,
954 usb_free_coherent(acm
->dev
, acm
->writesize
,
963 static int acm_probe(struct usb_interface
*intf
,
964 const struct usb_device_id
*id
)
966 struct usb_cdc_union_desc
*union_header
= NULL
;
967 struct usb_cdc_country_functional_desc
*cfd
= NULL
;
968 unsigned char *buffer
= intf
->altsetting
->extra
;
969 int buflen
= intf
->altsetting
->extralen
;
970 struct usb_interface
*control_interface
;
971 struct usb_interface
*data_interface
;
972 struct usb_endpoint_descriptor
*epctrl
= NULL
;
973 struct usb_endpoint_descriptor
*epread
= NULL
;
974 struct usb_endpoint_descriptor
*epwrite
= NULL
;
975 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
978 int ctrlsize
, readsize
;
980 u8 ac_management_function
= 0;
981 u8 call_management_function
= 0;
982 int call_interface_num
= -1;
983 int data_interface_num
= -1;
984 unsigned long quirks
;
987 int combined_interfaces
= 0;
988 struct device
*tty_dev
;
992 quirks
= (unsigned long)id
->driver_info
;
994 if (quirks
== IGNORE_DEVICE
)
997 num_rx_buf
= (quirks
== SINGLE_RX_URB
) ? 1 : ACM_NR
;
999 /* handle quirks deadly to normal probing*/
1000 if (quirks
== NO_UNION_NORMAL
) {
1001 data_interface
= usb_ifnum_to_if(usb_dev
, 1);
1002 control_interface
= usb_ifnum_to_if(usb_dev
, 0);
1003 /* we would crash */
1004 if (!data_interface
|| !control_interface
)
1006 goto skip_normal_probe
;
1011 dev_err(&intf
->dev
, "Weird descriptor references\n");
1016 if (intf
->cur_altsetting
->endpoint
&&
1017 intf
->cur_altsetting
->endpoint
->extralen
&&
1018 intf
->cur_altsetting
->endpoint
->extra
) {
1020 "Seeking extra descriptors on endpoint\n");
1021 buflen
= intf
->cur_altsetting
->endpoint
->extralen
;
1022 buffer
= intf
->cur_altsetting
->endpoint
->extra
;
1025 "Zero length descriptor references\n");
1030 while (buflen
> 0) {
1031 if (buffer
[1] != USB_DT_CS_INTERFACE
) {
1032 dev_err(&intf
->dev
, "skipping garbage\n");
1036 switch (buffer
[2]) {
1037 case USB_CDC_UNION_TYPE
: /* we've found it */
1039 dev_err(&intf
->dev
, "More than one "
1040 "union descriptor, skipping ...\n");
1043 union_header
= (struct usb_cdc_union_desc
*)buffer
;
1045 case USB_CDC_COUNTRY_TYPE
: /* export through sysfs*/
1046 cfd
= (struct usb_cdc_country_functional_desc
*)buffer
;
1048 case USB_CDC_HEADER_TYPE
: /* maybe check version */
1049 break; /* for now we ignore it */
1050 case USB_CDC_ACM_TYPE
:
1051 ac_management_function
= buffer
[3];
1053 case USB_CDC_CALL_MANAGEMENT_TYPE
:
1054 call_management_function
= buffer
[3];
1055 call_interface_num
= buffer
[4];
1056 if ((quirks
& NOT_A_MODEM
) == 0 && (call_management_function
& 3) != 3)
1057 dev_err(&intf
->dev
, "This device cannot do calls on its own. It is not a modem.\n");
1060 /* there are LOTS more CDC descriptors that
1061 * could legitimately be found here.
1063 dev_dbg(&intf
->dev
, "Ignoring descriptor: "
1064 "type %02x, length %d\n",
1065 buffer
[2], buffer
[0]);
1069 buflen
-= buffer
[0];
1070 buffer
+= buffer
[0];
1073 if (!union_header
) {
1074 if (call_interface_num
> 0) {
1075 dev_dbg(&intf
->dev
, "No union descriptor, using call management descriptor\n");
1076 /* quirks for Droids MuIn LCD */
1077 if (quirks
& NO_DATA_INTERFACE
)
1078 data_interface
= usb_ifnum_to_if(usb_dev
, 0);
1080 data_interface
= usb_ifnum_to_if(usb_dev
, (data_interface_num
= call_interface_num
));
1081 control_interface
= intf
;
1083 if (intf
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1084 dev_dbg(&intf
->dev
,"No union descriptor, giving up\n");
1087 dev_warn(&intf
->dev
,"No union descriptor, testing for castrated device\n");
1088 combined_interfaces
= 1;
1089 control_interface
= data_interface
= intf
;
1090 goto look_for_collapsed_interface
;
1094 control_interface
= usb_ifnum_to_if(usb_dev
, union_header
->bMasterInterface0
);
1095 data_interface
= usb_ifnum_to_if(usb_dev
, (data_interface_num
= union_header
->bSlaveInterface0
));
1098 if (!control_interface
|| !data_interface
) {
1099 dev_dbg(&intf
->dev
, "no interfaces\n");
1103 if (data_interface_num
!= call_interface_num
)
1104 dev_dbg(&intf
->dev
, "Separate call control interface. That is not fully supported.\n");
1106 if (control_interface
== data_interface
) {
1107 /* some broken devices designed for windows work this way */
1108 dev_warn(&intf
->dev
,"Control and data interfaces are not separated!\n");
1109 combined_interfaces
= 1;
1110 /* a popular other OS doesn't use it */
1111 quirks
|= NO_CAP_LINE
;
1112 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1113 dev_err(&intf
->dev
, "This needs exactly 3 endpoints\n");
1116 look_for_collapsed_interface
:
1117 for (i
= 0; i
< 3; i
++) {
1118 struct usb_endpoint_descriptor
*ep
;
1119 ep
= &data_interface
->cur_altsetting
->endpoint
[i
].desc
;
1121 if (usb_endpoint_is_int_in(ep
))
1123 else if (usb_endpoint_is_bulk_out(ep
))
1125 else if (usb_endpoint_is_bulk_in(ep
))
1130 if (!epctrl
|| !epread
|| !epwrite
)
1133 goto made_compressed_probe
;
1138 /*workaround for switched interfaces */
1139 if (data_interface
->cur_altsetting
->desc
.bInterfaceClass
1140 != CDC_DATA_INTERFACE_TYPE
) {
1141 if (control_interface
->cur_altsetting
->desc
.bInterfaceClass
1142 == CDC_DATA_INTERFACE_TYPE
) {
1143 struct usb_interface
*t
;
1145 "Your device has switched interfaces.\n");
1146 t
= control_interface
;
1147 control_interface
= data_interface
;
1154 /* Accept probe requests only for the control interface */
1155 if (!combined_interfaces
&& intf
!= control_interface
)
1158 if (!combined_interfaces
&& usb_interface_claimed(data_interface
)) {
1159 /* valid in this context */
1160 dev_dbg(&intf
->dev
, "The data interface isn't available\n");
1165 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
< 2 ||
1166 control_interface
->cur_altsetting
->desc
.bNumEndpoints
== 0)
1169 epctrl
= &control_interface
->cur_altsetting
->endpoint
[0].desc
;
1170 epread
= &data_interface
->cur_altsetting
->endpoint
[0].desc
;
1171 epwrite
= &data_interface
->cur_altsetting
->endpoint
[1].desc
;
1174 /* workaround for switched endpoints */
1175 if (!usb_endpoint_dir_in(epread
)) {
1176 /* descriptors are swapped */
1177 struct usb_endpoint_descriptor
*t
;
1179 "The data interface has switched endpoints\n");
1184 made_compressed_probe
:
1185 dev_dbg(&intf
->dev
, "interfaces are valid\n");
1187 acm
= kzalloc(sizeof(struct acm
), GFP_KERNEL
);
1189 dev_err(&intf
->dev
, "out of memory (acm kzalloc)\n");
1193 minor
= acm_alloc_minor(acm
);
1194 if (minor
== ACM_TTY_MINORS
) {
1195 dev_err(&intf
->dev
, "no more free acm devices\n");
1200 ctrlsize
= usb_endpoint_maxp(epctrl
);
1201 readsize
= usb_endpoint_maxp(epread
) *
1202 (quirks
== SINGLE_RX_URB
? 1 : 2);
1203 acm
->combined_interfaces
= combined_interfaces
;
1204 acm
->writesize
= usb_endpoint_maxp(epwrite
) * 20;
1205 acm
->control
= control_interface
;
1206 acm
->data
= data_interface
;
1209 acm
->ctrl_caps
= ac_management_function
;
1210 if (quirks
& NO_CAP_LINE
)
1211 acm
->ctrl_caps
&= ~USB_CDC_CAP_LINE
;
1212 acm
->ctrlsize
= ctrlsize
;
1213 acm
->readsize
= readsize
;
1214 acm
->rx_buflimit
= num_rx_buf
;
1215 INIT_WORK(&acm
->work
, acm_softint
);
1216 spin_lock_init(&acm
->write_lock
);
1217 spin_lock_init(&acm
->read_lock
);
1218 mutex_init(&acm
->mutex
);
1219 acm
->is_int_ep
= usb_endpoint_xfer_int(epread
);
1221 acm
->bInterval
= epread
->bInterval
;
1222 tty_port_init(&acm
->port
);
1223 acm
->port
.ops
= &acm_port_ops
;
1224 init_usb_anchor(&acm
->delayed
);
1226 buf
= usb_alloc_coherent(usb_dev
, ctrlsize
, GFP_KERNEL
, &acm
->ctrl_dma
);
1228 dev_err(&intf
->dev
, "out of memory (ctrl buffer alloc)\n");
1231 acm
->ctrl_buffer
= buf
;
1233 if (acm_write_buffers_alloc(acm
) < 0) {
1234 dev_err(&intf
->dev
, "out of memory (write buffer alloc)\n");
1238 acm
->ctrlurb
= usb_alloc_urb(0, GFP_KERNEL
);
1239 if (!acm
->ctrlurb
) {
1240 dev_err(&intf
->dev
, "out of memory (ctrlurb kmalloc)\n");
1243 for (i
= 0; i
< num_rx_buf
; i
++) {
1244 struct acm_rb
*rb
= &(acm
->read_buffers
[i
]);
1247 rb
->base
= usb_alloc_coherent(acm
->dev
, readsize
, GFP_KERNEL
,
1250 dev_err(&intf
->dev
, "out of memory "
1251 "(read bufs usb_alloc_coherent)\n");
1257 urb
= usb_alloc_urb(0, GFP_KERNEL
);
1260 "out of memory (read urbs usb_alloc_urb)\n");
1263 urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1264 urb
->transfer_dma
= rb
->dma
;
1265 if (acm
->is_int_ep
) {
1266 usb_fill_int_urb(urb
, acm
->dev
,
1267 usb_rcvintpipe(usb_dev
, epread
->bEndpointAddress
),
1270 acm_read_bulk_callback
, rb
,
1273 usb_fill_bulk_urb(urb
, acm
->dev
,
1274 usb_rcvbulkpipe(usb_dev
, epread
->bEndpointAddress
),
1277 acm_read_bulk_callback
, rb
);
1280 acm
->read_urbs
[i
] = urb
;
1281 __set_bit(i
, &acm
->read_urbs_free
);
1283 for (i
= 0; i
< ACM_NW
; i
++) {
1284 struct acm_wb
*snd
= &(acm
->wb
[i
]);
1286 snd
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1287 if (snd
->urb
== NULL
) {
1289 "out of memory (write urbs usb_alloc_urb)\n");
1293 if (usb_endpoint_xfer_int(epwrite
))
1294 usb_fill_int_urb(snd
->urb
, usb_dev
,
1295 usb_sndintpipe(usb_dev
, epwrite
->bEndpointAddress
),
1296 NULL
, acm
->writesize
, acm_write_bulk
, snd
, epwrite
->bInterval
);
1298 usb_fill_bulk_urb(snd
->urb
, usb_dev
,
1299 usb_sndbulkpipe(usb_dev
, epwrite
->bEndpointAddress
),
1300 NULL
, acm
->writesize
, acm_write_bulk
, snd
);
1301 snd
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1302 snd
->instance
= acm
;
1305 usb_set_intfdata(intf
, acm
);
1307 i
= device_create_file(&intf
->dev
, &dev_attr_bmCapabilities
);
1311 if (cfd
) { /* export the country data */
1312 acm
->country_codes
= kmalloc(cfd
->bLength
- 4, GFP_KERNEL
);
1313 if (!acm
->country_codes
)
1314 goto skip_countries
;
1315 acm
->country_code_size
= cfd
->bLength
- 4;
1316 memcpy(acm
->country_codes
, (u8
*)&cfd
->wCountyCode0
,
1318 acm
->country_rel_date
= cfd
->iCountryCodeRelDate
;
1320 i
= device_create_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1322 kfree(acm
->country_codes
);
1323 acm
->country_codes
= NULL
;
1324 acm
->country_code_size
= 0;
1325 goto skip_countries
;
1328 i
= device_create_file(&intf
->dev
,
1329 &dev_attr_iCountryCodeRelDate
);
1331 device_remove_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1332 kfree(acm
->country_codes
);
1333 acm
->country_codes
= NULL
;
1334 acm
->country_code_size
= 0;
1335 goto skip_countries
;
1340 usb_fill_int_urb(acm
->ctrlurb
, usb_dev
,
1341 usb_rcvintpipe(usb_dev
, epctrl
->bEndpointAddress
),
1342 acm
->ctrl_buffer
, ctrlsize
, acm_ctrl_irq
, acm
,
1343 /* works around buggy devices */
1344 epctrl
->bInterval
? epctrl
->bInterval
: 0xff);
1345 acm
->ctrlurb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1346 acm
->ctrlurb
->transfer_dma
= acm
->ctrl_dma
;
1348 dev_info(&intf
->dev
, "ttyACM%d: USB ACM device\n", minor
);
1350 acm_set_control(acm
, acm
->ctrlout
);
1352 acm
->line
.dwDTERate
= cpu_to_le32(9600);
1353 acm
->line
.bDataBits
= 8;
1354 acm_set_line(acm
, &acm
->line
);
1356 usb_driver_claim_interface(&acm_driver
, data_interface
, acm
);
1357 usb_set_intfdata(data_interface
, acm
);
1359 usb_get_intf(control_interface
);
1360 tty_dev
= tty_port_register_device(&acm
->port
, acm_tty_driver
, minor
,
1361 &control_interface
->dev
);
1362 if (IS_ERR(tty_dev
)) {
1363 rv
= PTR_ERR(tty_dev
);
1369 if (acm
->country_codes
) {
1370 device_remove_file(&acm
->control
->dev
,
1371 &dev_attr_wCountryCodes
);
1372 device_remove_file(&acm
->control
->dev
,
1373 &dev_attr_iCountryCodeRelDate
);
1374 kfree(acm
->country_codes
);
1376 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1378 usb_set_intfdata(intf
, NULL
);
1379 for (i
= 0; i
< ACM_NW
; i
++)
1380 usb_free_urb(acm
->wb
[i
].urb
);
1382 for (i
= 0; i
< num_rx_buf
; i
++)
1383 usb_free_urb(acm
->read_urbs
[i
]);
1384 acm_read_buffers_free(acm
);
1385 usb_free_urb(acm
->ctrlurb
);
1387 acm_write_buffers_free(acm
);
1389 usb_free_coherent(usb_dev
, ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1391 acm_release_minor(acm
);
1397 static void stop_data_traffic(struct acm
*acm
)
1401 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
1403 usb_kill_urb(acm
->ctrlurb
);
1404 for (i
= 0; i
< ACM_NW
; i
++)
1405 usb_kill_urb(acm
->wb
[i
].urb
);
1406 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1407 usb_kill_urb(acm
->read_urbs
[i
]);
1409 cancel_work_sync(&acm
->work
);
1412 static void acm_disconnect(struct usb_interface
*intf
)
1414 struct acm
*acm
= usb_get_intfdata(intf
);
1415 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1416 struct tty_struct
*tty
;
1419 dev_dbg(&intf
->dev
, "%s\n", __func__
);
1421 /* sibling interface is already cleaning up */
1425 mutex_lock(&acm
->mutex
);
1426 acm
->disconnected
= true;
1427 if (acm
->country_codes
) {
1428 device_remove_file(&acm
->control
->dev
,
1429 &dev_attr_wCountryCodes
);
1430 device_remove_file(&acm
->control
->dev
,
1431 &dev_attr_iCountryCodeRelDate
);
1433 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1434 usb_set_intfdata(acm
->control
, NULL
);
1435 usb_set_intfdata(acm
->data
, NULL
);
1436 mutex_unlock(&acm
->mutex
);
1438 tty
= tty_port_tty_get(&acm
->port
);
1444 stop_data_traffic(acm
);
1446 tty_unregister_device(acm_tty_driver
, acm
->minor
);
1448 usb_free_urb(acm
->ctrlurb
);
1449 for (i
= 0; i
< ACM_NW
; i
++)
1450 usb_free_urb(acm
->wb
[i
].urb
);
1451 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1452 usb_free_urb(acm
->read_urbs
[i
]);
1453 acm_write_buffers_free(acm
);
1454 usb_free_coherent(usb_dev
, acm
->ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1455 acm_read_buffers_free(acm
);
1457 if (!acm
->combined_interfaces
)
1458 usb_driver_release_interface(&acm_driver
, intf
== acm
->control
?
1459 acm
->data
: acm
->control
);
1461 tty_port_put(&acm
->port
);
1465 static int acm_suspend(struct usb_interface
*intf
, pm_message_t message
)
1467 struct acm
*acm
= usb_get_intfdata(intf
);
1470 spin_lock_irq(&acm
->read_lock
);
1471 spin_lock(&acm
->write_lock
);
1472 if (PMSG_IS_AUTO(message
)) {
1473 if (acm
->transmitting
) {
1474 spin_unlock(&acm
->write_lock
);
1475 spin_unlock_irq(&acm
->read_lock
);
1479 cnt
= acm
->susp_count
++;
1480 spin_unlock(&acm
->write_lock
);
1481 spin_unlock_irq(&acm
->read_lock
);
1486 stop_data_traffic(acm
);
1491 static int acm_resume(struct usb_interface
*intf
)
1493 struct acm
*acm
= usb_get_intfdata(intf
);
1497 spin_lock_irq(&acm
->read_lock
);
1498 spin_lock(&acm
->write_lock
);
1500 if (--acm
->susp_count
)
1503 if (test_bit(ASYNCB_INITIALIZED
, &acm
->port
.flags
)) {
1504 rv
= usb_submit_urb(acm
->ctrlurb
, GFP_ATOMIC
);
1507 urb
= usb_get_from_anchor(&acm
->delayed
);
1511 acm_start_wb(acm
, urb
->context
);
1515 * delayed error checking because we must
1516 * do the write path at all cost
1521 rv
= acm_submit_read_urbs(acm
, GFP_ATOMIC
);
1524 spin_unlock(&acm
->write_lock
);
1525 spin_unlock_irq(&acm
->read_lock
);
1530 static int acm_reset_resume(struct usb_interface
*intf
)
1532 struct acm
*acm
= usb_get_intfdata(intf
);
1534 if (test_bit(ASYNCB_INITIALIZED
, &acm
->port
.flags
))
1535 tty_port_tty_hangup(&acm
->port
, false);
1537 return acm_resume(intf
);
1540 #endif /* CONFIG_PM */
1542 #define NOKIA_PCSUITE_ACM_INFO(x) \
1543 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1544 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1545 USB_CDC_ACM_PROTO_VENDOR)
1547 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1548 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1549 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1550 USB_CDC_ACM_PROTO_VENDOR)
1553 * USB driver structure.
1556 static const struct usb_device_id acm_ids
[] = {
1557 /* quirky and broken devices */
1558 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1559 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1560 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1561 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1563 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1564 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1566 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1567 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1569 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1570 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1572 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1573 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1575 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1576 .driver_info
= SINGLE_RX_URB
,
1578 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1579 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1581 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1582 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1584 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1585 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1587 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1588 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1590 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1591 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1593 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1594 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1596 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1597 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1599 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1600 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1602 /* Motorola H24 HSPA module: */
1603 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1604 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1605 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1607 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1608 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1610 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1611 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1613 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1614 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1616 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1617 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1619 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1620 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1622 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1623 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1626 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1627 .driver_info
= NO_UNION_NORMAL
, /* union descriptor misplaced on
1628 data interface instead of
1629 communications interface.
1630 Maybe we should define a new
1633 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1634 .driver_info
= NO_UNION_NORMAL
,
1636 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1637 .driver_info
= NO_UNION_NORMAL
,
1639 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1640 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1642 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1643 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1646 /* Nokia S60 phones expose two ACM channels. The first is
1647 * a modem and is picked up by the standard AT-command
1648 * information below. The second is 'vendor-specific' but
1649 * is treated as a serial device at the S60 end, so we want
1650 * to expose it on Linux too. */
1651 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1652 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1653 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1654 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1655 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1656 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1657 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1658 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1659 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1660 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1661 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1662 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1663 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1664 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1665 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1666 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1667 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1668 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1669 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1670 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1671 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1672 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1673 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1674 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1675 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1676 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1677 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1678 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1679 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1680 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1681 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1682 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1683 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1684 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1685 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1686 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1687 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1688 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1689 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1690 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1691 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1692 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1693 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1694 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1695 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1696 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1697 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1698 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1699 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1700 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1701 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1702 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1703 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1704 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1705 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1706 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1707 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1708 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1710 /* Support for Owen devices */
1711 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1713 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1715 /* Support Lego NXT using pbLua firmware */
1716 { USB_DEVICE(0x0694, 0xff00),
1717 .driver_info
= NOT_A_MODEM
,
1720 /* Support for Droids MuIn LCD */
1721 { USB_DEVICE(0x04d8, 0x000b),
1722 .driver_info
= NO_DATA_INTERFACE
,
1725 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1726 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1727 .driver_info
= IGNORE_DEVICE
,
1729 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1730 .driver_info
= IGNORE_DEVICE
,
1734 /*Samsung phone in firmware update mode */
1735 { USB_DEVICE(0x04e8, 0x685d),
1736 .driver_info
= IGNORE_DEVICE
,
1739 /* Exclude Infineon Flash Loader utility */
1740 { USB_DEVICE(0x058b, 0x0041),
1741 .driver_info
= IGNORE_DEVICE
,
1744 /* control interfaces without any protocol set */
1745 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1746 USB_CDC_PROTO_NONE
) },
1748 /* control interfaces with various AT-command sets */
1749 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1750 USB_CDC_ACM_PROTO_AT_V25TER
) },
1751 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1752 USB_CDC_ACM_PROTO_AT_PCCA101
) },
1753 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1754 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE
) },
1755 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1756 USB_CDC_ACM_PROTO_AT_GSM
) },
1757 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1758 USB_CDC_ACM_PROTO_AT_3G
) },
1759 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1760 USB_CDC_ACM_PROTO_AT_CDMA
) },
1765 MODULE_DEVICE_TABLE(usb
, acm_ids
);
1767 static struct usb_driver acm_driver
= {
1770 .disconnect
= acm_disconnect
,
1772 .suspend
= acm_suspend
,
1773 .resume
= acm_resume
,
1774 .reset_resume
= acm_reset_resume
,
1776 .id_table
= acm_ids
,
1778 .supports_autosuspend
= 1,
1780 .disable_hub_initiated_lpm
= 1,
1784 * TTY driver structures.
1787 static const struct tty_operations acm_ops
= {
1788 .install
= acm_tty_install
,
1789 .open
= acm_tty_open
,
1790 .close
= acm_tty_close
,
1791 .cleanup
= acm_tty_cleanup
,
1792 .hangup
= acm_tty_hangup
,
1793 .write
= acm_tty_write
,
1794 .write_room
= acm_tty_write_room
,
1795 .ioctl
= acm_tty_ioctl
,
1796 .throttle
= acm_tty_throttle
,
1797 .unthrottle
= acm_tty_unthrottle
,
1798 .chars_in_buffer
= acm_tty_chars_in_buffer
,
1799 .break_ctl
= acm_tty_break_ctl
,
1800 .set_termios
= acm_tty_set_termios
,
1801 .tiocmget
= acm_tty_tiocmget
,
1802 .tiocmset
= acm_tty_tiocmset
,
1809 static int __init
acm_init(void)
1812 acm_tty_driver
= alloc_tty_driver(ACM_TTY_MINORS
);
1813 if (!acm_tty_driver
)
1815 acm_tty_driver
->driver_name
= "acm",
1816 acm_tty_driver
->name
= "ttyACM",
1817 acm_tty_driver
->major
= ACM_TTY_MAJOR
,
1818 acm_tty_driver
->minor_start
= 0,
1819 acm_tty_driver
->type
= TTY_DRIVER_TYPE_SERIAL
,
1820 acm_tty_driver
->subtype
= SERIAL_TYPE_NORMAL
,
1821 acm_tty_driver
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
1822 acm_tty_driver
->init_termios
= tty_std_termios
;
1823 acm_tty_driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
|
1825 tty_set_operations(acm_tty_driver
, &acm_ops
);
1827 retval
= tty_register_driver(acm_tty_driver
);
1829 put_tty_driver(acm_tty_driver
);
1833 retval
= usb_register(&acm_driver
);
1835 tty_unregister_driver(acm_tty_driver
);
1836 put_tty_driver(acm_tty_driver
);
1840 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1845 static void __exit
acm_exit(void)
1847 usb_deregister(&acm_driver
);
1848 tty_unregister_driver(acm_tty_driver
);
1849 put_tty_driver(acm_tty_driver
);
1852 module_init(acm_init
);
1853 module_exit(acm_exit
);
1855 MODULE_AUTHOR(DRIVER_AUTHOR
);
1856 MODULE_DESCRIPTION(DRIVER_DESC
);
1857 MODULE_LICENSE("GPL");
1858 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR
);