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
);
220 * attributes exported through sysfs
222 static ssize_t show_caps
223 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
225 struct usb_interface
*intf
= to_usb_interface(dev
);
226 struct acm
*acm
= usb_get_intfdata(intf
);
228 return sprintf(buf
, "%d", acm
->ctrl_caps
);
230 static DEVICE_ATTR(bmCapabilities
, S_IRUGO
, show_caps
, NULL
);
232 static ssize_t show_country_codes
233 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
235 struct usb_interface
*intf
= to_usb_interface(dev
);
236 struct acm
*acm
= usb_get_intfdata(intf
);
238 memcpy(buf
, acm
->country_codes
, acm
->country_code_size
);
239 return acm
->country_code_size
;
242 static DEVICE_ATTR(wCountryCodes
, S_IRUGO
, show_country_codes
, NULL
);
244 static ssize_t show_country_rel_date
245 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
247 struct usb_interface
*intf
= to_usb_interface(dev
);
248 struct acm
*acm
= usb_get_intfdata(intf
);
250 return sprintf(buf
, "%d", acm
->country_rel_date
);
253 static DEVICE_ATTR(iCountryCodeRelDate
, S_IRUGO
, show_country_rel_date
, NULL
);
255 * Interrupt handlers for various ACM device responses
258 /* control interface reports status changes with "interrupt" transfers */
259 static void acm_ctrl_irq(struct urb
*urb
)
261 struct acm
*acm
= urb
->context
;
262 struct usb_cdc_notification
*dr
= urb
->transfer_buffer
;
267 int status
= urb
->status
;
276 /* this urb is terminated, clean up */
277 dev_dbg(&acm
->control
->dev
,
278 "%s - urb shutting down with status: %d\n",
282 dev_dbg(&acm
->control
->dev
,
283 "%s - nonzero urb status received: %d\n",
288 usb_mark_last_busy(acm
->dev
);
290 data
= (unsigned char *)(dr
+ 1);
291 switch (dr
->bNotificationType
) {
292 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
293 dev_dbg(&acm
->control
->dev
, "%s - network connection: %d\n",
294 __func__
, dr
->wValue
);
297 case USB_CDC_NOTIFY_SERIAL_STATE
:
298 newctrl
= get_unaligned_le16(data
);
300 if (!acm
->clocal
&& (acm
->ctrlin
& ~newctrl
& ACM_CTRL_DCD
)) {
301 dev_dbg(&acm
->control
->dev
, "%s - calling hangup\n",
303 tty_port_tty_hangup(&acm
->port
, false);
306 difference
= acm
->ctrlin
^ newctrl
;
307 spin_lock(&acm
->read_lock
);
308 acm
->ctrlin
= newctrl
;
309 acm
->oldcount
= acm
->iocount
;
311 if (difference
& ACM_CTRL_DSR
)
313 if (difference
& ACM_CTRL_BRK
)
315 if (difference
& ACM_CTRL_RI
)
317 if (difference
& ACM_CTRL_DCD
)
319 if (difference
& ACM_CTRL_FRAMING
)
320 acm
->iocount
.frame
++;
321 if (difference
& ACM_CTRL_PARITY
)
322 acm
->iocount
.parity
++;
323 if (difference
& ACM_CTRL_OVERRUN
)
324 acm
->iocount
.overrun
++;
325 spin_unlock(&acm
->read_lock
);
328 wake_up_all(&acm
->wioctl
);
333 dev_dbg(&acm
->control
->dev
,
334 "%s - unknown notification %d received: index %d "
335 "len %d data0 %d data1 %d\n",
337 dr
->bNotificationType
, dr
->wIndex
,
338 dr
->wLength
, data
[0], data
[1]);
342 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
344 dev_err(&acm
->control
->dev
, "%s - usb_submit_urb failed: %d\n",
348 static int acm_submit_read_urb(struct acm
*acm
, int index
, gfp_t mem_flags
)
352 if (!test_and_clear_bit(index
, &acm
->read_urbs_free
))
355 dev_vdbg(&acm
->data
->dev
, "%s - urb %d\n", __func__
, index
);
357 res
= usb_submit_urb(acm
->read_urbs
[index
], mem_flags
);
360 dev_err(&acm
->data
->dev
,
361 "%s - usb_submit_urb failed: %d\n",
364 set_bit(index
, &acm
->read_urbs_free
);
371 static int acm_submit_read_urbs(struct acm
*acm
, gfp_t mem_flags
)
376 for (i
= 0; i
< acm
->rx_buflimit
; ++i
) {
377 res
= acm_submit_read_urb(acm
, i
, mem_flags
);
385 static void acm_process_read_urb(struct acm
*acm
, struct urb
*urb
)
387 if (!urb
->actual_length
)
390 tty_insert_flip_string(&acm
->port
, urb
->transfer_buffer
,
392 tty_flip_buffer_push(&acm
->port
);
395 static void acm_read_bulk_callback(struct urb
*urb
)
397 struct acm_rb
*rb
= urb
->context
;
398 struct acm
*acm
= rb
->instance
;
401 dev_vdbg(&acm
->data
->dev
, "%s - urb %d, len %d\n", __func__
,
402 rb
->index
, urb
->actual_length
);
403 set_bit(rb
->index
, &acm
->read_urbs_free
);
406 dev_dbg(&acm
->data
->dev
, "%s - disconnected\n", __func__
);
409 usb_mark_last_busy(acm
->dev
);
412 dev_dbg(&acm
->data
->dev
, "%s - non-zero urb status: %d\n",
413 __func__
, urb
->status
);
416 acm_process_read_urb(acm
, urb
);
418 /* throttle device if requested by tty */
419 spin_lock_irqsave(&acm
->read_lock
, flags
);
420 acm
->throttled
= acm
->throttle_req
;
421 if (!acm
->throttled
&& !acm
->susp_count
) {
422 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
423 acm_submit_read_urb(acm
, rb
->index
, GFP_ATOMIC
);
425 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
429 /* data interface wrote those outgoing bytes */
430 static void acm_write_bulk(struct urb
*urb
)
432 struct acm_wb
*wb
= urb
->context
;
433 struct acm
*acm
= wb
->instance
;
436 if (urb
->status
|| (urb
->actual_length
!= urb
->transfer_buffer_length
))
437 dev_vdbg(&acm
->data
->dev
, "%s - len %d/%d, status %d\n",
440 urb
->transfer_buffer_length
,
443 spin_lock_irqsave(&acm
->write_lock
, flags
);
444 acm_write_done(acm
, wb
);
445 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
446 schedule_work(&acm
->work
);
449 static void acm_softint(struct work_struct
*work
)
451 struct acm
*acm
= container_of(work
, struct acm
, work
);
453 dev_vdbg(&acm
->data
->dev
, "%s\n", __func__
);
455 tty_port_tty_wakeup(&acm
->port
);
462 static int acm_tty_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
467 dev_dbg(tty
->dev
, "%s\n", __func__
);
469 acm
= acm_get_by_index(tty
->index
);
473 retval
= tty_standard_install(driver
, tty
);
475 goto error_init_termios
;
477 tty
->driver_data
= acm
;
482 tty_port_put(&acm
->port
);
486 static int acm_tty_open(struct tty_struct
*tty
, struct file
*filp
)
488 struct acm
*acm
= tty
->driver_data
;
490 dev_dbg(tty
->dev
, "%s\n", __func__
);
492 return tty_port_open(&acm
->port
, tty
, filp
);
495 static int acm_port_activate(struct tty_port
*port
, struct tty_struct
*tty
)
497 struct acm
*acm
= container_of(port
, struct acm
, port
);
498 int retval
= -ENODEV
;
500 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
502 mutex_lock(&acm
->mutex
);
503 if (acm
->disconnected
)
506 retval
= usb_autopm_get_interface(acm
->control
);
508 goto error_get_interface
;
511 * FIXME: Why do we need this? Allocating 64K of physically contiguous
512 * memory is really nasty...
514 set_bit(TTY_NO_WRITE_SPLIT
, &tty
->flags
);
515 acm
->control
->needs_remote_wakeup
= 1;
517 acm
->ctrlurb
->dev
= acm
->dev
;
518 if (usb_submit_urb(acm
->ctrlurb
, GFP_KERNEL
)) {
519 dev_err(&acm
->control
->dev
,
520 "%s - usb_submit_urb(ctrl irq) failed\n", __func__
);
521 goto error_submit_urb
;
524 acm
->ctrlout
= ACM_CTRL_DTR
| ACM_CTRL_RTS
;
525 if (acm_set_control(acm
, acm
->ctrlout
) < 0 &&
526 (acm
->ctrl_caps
& USB_CDC_CAP_LINE
))
527 goto error_set_control
;
529 usb_autopm_put_interface(acm
->control
);
532 * Unthrottle device in case the TTY was closed while throttled.
534 spin_lock_irq(&acm
->read_lock
);
536 acm
->throttle_req
= 0;
537 spin_unlock_irq(&acm
->read_lock
);
539 if (acm_submit_read_urbs(acm
, GFP_KERNEL
))
540 goto error_submit_read_urbs
;
542 mutex_unlock(&acm
->mutex
);
546 error_submit_read_urbs
:
548 acm_set_control(acm
, acm
->ctrlout
);
550 usb_kill_urb(acm
->ctrlurb
);
552 usb_autopm_put_interface(acm
->control
);
555 mutex_unlock(&acm
->mutex
);
559 static void acm_port_destruct(struct tty_port
*port
)
561 struct acm
*acm
= container_of(port
, struct acm
, port
);
563 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
565 acm_release_minor(acm
);
566 usb_put_intf(acm
->control
);
567 kfree(acm
->country_codes
);
571 static void acm_port_shutdown(struct tty_port
*port
)
573 struct acm
*acm
= container_of(port
, struct acm
, port
);
576 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
578 mutex_lock(&acm
->mutex
);
579 if (!acm
->disconnected
) {
580 usb_autopm_get_interface(acm
->control
);
581 acm_set_control(acm
, acm
->ctrlout
= 0);
582 usb_kill_urb(acm
->ctrlurb
);
583 for (i
= 0; i
< ACM_NW
; i
++)
584 usb_kill_urb(acm
->wb
[i
].urb
);
585 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
586 usb_kill_urb(acm
->read_urbs
[i
]);
587 acm
->control
->needs_remote_wakeup
= 0;
588 usb_autopm_put_interface(acm
->control
);
590 mutex_unlock(&acm
->mutex
);
593 static void acm_tty_cleanup(struct tty_struct
*tty
)
595 struct acm
*acm
= tty
->driver_data
;
596 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
597 tty_port_put(&acm
->port
);
600 static void acm_tty_hangup(struct tty_struct
*tty
)
602 struct acm
*acm
= tty
->driver_data
;
603 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
604 tty_port_hangup(&acm
->port
);
607 static void acm_tty_close(struct tty_struct
*tty
, struct file
*filp
)
609 struct acm
*acm
= tty
->driver_data
;
610 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
611 tty_port_close(&acm
->port
, tty
, filp
);
614 static int acm_tty_write(struct tty_struct
*tty
,
615 const unsigned char *buf
, int count
)
617 struct acm
*acm
= tty
->driver_data
;
626 dev_vdbg(&acm
->data
->dev
, "%s - count %d\n", __func__
, count
);
628 spin_lock_irqsave(&acm
->write_lock
, flags
);
629 wbn
= acm_wb_alloc(acm
);
631 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
638 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
642 count
= (count
> acm
->writesize
) ? acm
->writesize
: count
;
643 dev_vdbg(&acm
->data
->dev
, "%s - write %d\n", __func__
, count
);
644 memcpy(wb
->buf
, buf
, count
);
647 usb_autopm_get_interface_async(acm
->control
);
648 if (acm
->susp_count
) {
649 if (!acm
->delayed_wb
)
650 acm
->delayed_wb
= wb
;
652 usb_autopm_put_interface_async(acm
->control
);
653 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
654 return count
; /* A white lie */
656 usb_mark_last_busy(acm
->dev
);
658 stat
= acm_start_wb(acm
, wb
);
659 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
666 static int acm_tty_write_room(struct tty_struct
*tty
)
668 struct acm
*acm
= tty
->driver_data
;
670 * Do not let the line discipline to know that we have a reserve,
671 * or it might get too enthusiastic.
673 return acm_wb_is_avail(acm
) ? acm
->writesize
: 0;
676 static int acm_tty_chars_in_buffer(struct tty_struct
*tty
)
678 struct acm
*acm
= tty
->driver_data
;
680 * if the device was unplugged then any remaining characters fell out
681 * of the connector ;)
683 if (acm
->disconnected
)
686 * This is inaccurate (overcounts), but it works.
688 return (ACM_NW
- acm_wb_is_avail(acm
)) * acm
->writesize
;
691 static void acm_tty_throttle(struct tty_struct
*tty
)
693 struct acm
*acm
= tty
->driver_data
;
695 spin_lock_irq(&acm
->read_lock
);
696 acm
->throttle_req
= 1;
697 spin_unlock_irq(&acm
->read_lock
);
700 static void acm_tty_unthrottle(struct tty_struct
*tty
)
702 struct acm
*acm
= tty
->driver_data
;
703 unsigned int was_throttled
;
705 spin_lock_irq(&acm
->read_lock
);
706 was_throttled
= acm
->throttled
;
708 acm
->throttle_req
= 0;
709 spin_unlock_irq(&acm
->read_lock
);
712 acm_submit_read_urbs(acm
, GFP_KERNEL
);
715 static int acm_tty_break_ctl(struct tty_struct
*tty
, int state
)
717 struct acm
*acm
= tty
->driver_data
;
720 retval
= acm_send_break(acm
, state
? 0xffff : 0);
722 dev_dbg(&acm
->control
->dev
, "%s - send break failed\n",
727 static int acm_tty_tiocmget(struct tty_struct
*tty
)
729 struct acm
*acm
= tty
->driver_data
;
731 return (acm
->ctrlout
& ACM_CTRL_DTR
? TIOCM_DTR
: 0) |
732 (acm
->ctrlout
& ACM_CTRL_RTS
? TIOCM_RTS
: 0) |
733 (acm
->ctrlin
& ACM_CTRL_DSR
? TIOCM_DSR
: 0) |
734 (acm
->ctrlin
& ACM_CTRL_RI
? TIOCM_RI
: 0) |
735 (acm
->ctrlin
& ACM_CTRL_DCD
? TIOCM_CD
: 0) |
739 static int acm_tty_tiocmset(struct tty_struct
*tty
,
740 unsigned int set
, unsigned int clear
)
742 struct acm
*acm
= tty
->driver_data
;
743 unsigned int newctrl
;
745 newctrl
= acm
->ctrlout
;
746 set
= (set
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
747 (set
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
748 clear
= (clear
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
749 (clear
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
751 newctrl
= (newctrl
& ~clear
) | set
;
753 if (acm
->ctrlout
== newctrl
)
755 return acm_set_control(acm
, acm
->ctrlout
= newctrl
);
758 static int get_serial_info(struct acm
*acm
, struct serial_struct __user
*info
)
760 struct serial_struct tmp
;
765 memset(&tmp
, 0, sizeof(tmp
));
766 tmp
.flags
= ASYNC_LOW_LATENCY
;
767 tmp
.xmit_fifo_size
= acm
->writesize
;
768 tmp
.baud_base
= le32_to_cpu(acm
->line
.dwDTERate
);
769 tmp
.close_delay
= acm
->port
.close_delay
/ 10;
770 tmp
.closing_wait
= acm
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
771 ASYNC_CLOSING_WAIT_NONE
:
772 acm
->port
.closing_wait
/ 10;
774 if (copy_to_user(info
, &tmp
, sizeof(tmp
)))
780 static int set_serial_info(struct acm
*acm
,
781 struct serial_struct __user
*newinfo
)
783 struct serial_struct new_serial
;
784 unsigned int closing_wait
, close_delay
;
787 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
790 close_delay
= new_serial
.close_delay
* 10;
791 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
792 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
794 mutex_lock(&acm
->port
.mutex
);
796 if (!capable(CAP_SYS_ADMIN
)) {
797 if ((close_delay
!= acm
->port
.close_delay
) ||
798 (closing_wait
!= acm
->port
.closing_wait
))
801 retval
= -EOPNOTSUPP
;
803 acm
->port
.close_delay
= close_delay
;
804 acm
->port
.closing_wait
= closing_wait
;
807 mutex_unlock(&acm
->port
.mutex
);
811 static int wait_serial_change(struct acm
*acm
, unsigned long arg
)
814 DECLARE_WAITQUEUE(wait
, current
);
815 struct async_icount old
, new;
817 if (arg
& (TIOCM_DSR
| TIOCM_RI
| TIOCM_CD
))
820 spin_lock_irq(&acm
->read_lock
);
824 spin_unlock_irq(&acm
->read_lock
);
826 if ((arg
& TIOCM_DSR
) &&
829 if ((arg
& TIOCM_CD
) &&
832 if ((arg
& TIOCM_RI
) &&
836 add_wait_queue(&acm
->wioctl
, &wait
);
837 set_current_state(TASK_INTERRUPTIBLE
);
839 remove_wait_queue(&acm
->wioctl
, &wait
);
840 if (acm
->disconnected
) {
846 if (signal_pending(current
))
856 static int get_serial_usage(struct acm
*acm
,
857 struct serial_icounter_struct __user
*count
)
859 struct serial_icounter_struct icount
;
862 memset(&icount
, 0, sizeof(icount
));
863 icount
.dsr
= acm
->iocount
.dsr
;
864 icount
.rng
= acm
->iocount
.rng
;
865 icount
.dcd
= acm
->iocount
.dcd
;
866 icount
.frame
= acm
->iocount
.frame
;
867 icount
.overrun
= acm
->iocount
.overrun
;
868 icount
.parity
= acm
->iocount
.parity
;
869 icount
.brk
= acm
->iocount
.brk
;
871 if (copy_to_user(count
, &icount
, sizeof(icount
)) > 0)
877 static int acm_tty_ioctl(struct tty_struct
*tty
,
878 unsigned int cmd
, unsigned long arg
)
880 struct acm
*acm
= tty
->driver_data
;
881 int rv
= -ENOIOCTLCMD
;
884 case TIOCGSERIAL
: /* gets serial port data */
885 rv
= get_serial_info(acm
, (struct serial_struct __user
*) arg
);
888 rv
= set_serial_info(acm
, (struct serial_struct __user
*) arg
);
891 rv
= usb_autopm_get_interface(acm
->control
);
896 rv
= wait_serial_change(acm
, arg
);
897 usb_autopm_put_interface(acm
->control
);
900 rv
= get_serial_usage(acm
, (struct serial_icounter_struct __user
*) arg
);
907 static void acm_tty_set_termios(struct tty_struct
*tty
,
908 struct ktermios
*termios_old
)
910 struct acm
*acm
= tty
->driver_data
;
911 struct ktermios
*termios
= &tty
->termios
;
912 struct usb_cdc_line_coding newline
;
913 int newctrl
= acm
->ctrlout
;
915 newline
.dwDTERate
= cpu_to_le32(tty_get_baud_rate(tty
));
916 newline
.bCharFormat
= termios
->c_cflag
& CSTOPB
? 2 : 0;
917 newline
.bParityType
= termios
->c_cflag
& PARENB
?
918 (termios
->c_cflag
& PARODD
? 1 : 2) +
919 (termios
->c_cflag
& CMSPAR
? 2 : 0) : 0;
920 switch (termios
->c_cflag
& CSIZE
) {
922 newline
.bDataBits
= 5;
925 newline
.bDataBits
= 6;
928 newline
.bDataBits
= 7;
932 newline
.bDataBits
= 8;
935 /* FIXME: Needs to clear unsupported bits in the termios */
936 acm
->clocal
= ((termios
->c_cflag
& CLOCAL
) != 0);
938 if (!newline
.dwDTERate
) {
939 newline
.dwDTERate
= acm
->line
.dwDTERate
;
940 newctrl
&= ~ACM_CTRL_DTR
;
942 newctrl
|= ACM_CTRL_DTR
;
944 if (newctrl
!= acm
->ctrlout
)
945 acm_set_control(acm
, acm
->ctrlout
= newctrl
);
947 if (memcmp(&acm
->line
, &newline
, sizeof newline
)) {
948 memcpy(&acm
->line
, &newline
, sizeof newline
);
949 dev_dbg(&acm
->control
->dev
, "%s - set line: %d %d %d %d\n",
951 le32_to_cpu(newline
.dwDTERate
),
952 newline
.bCharFormat
, newline
.bParityType
,
954 acm_set_line(acm
, &acm
->line
);
958 static const struct tty_port_operations acm_port_ops
= {
959 .shutdown
= acm_port_shutdown
,
960 .activate
= acm_port_activate
,
961 .destruct
= acm_port_destruct
,
965 * USB probe and disconnect routines.
968 /* Little helpers: write/read buffers free */
969 static void acm_write_buffers_free(struct acm
*acm
)
973 struct usb_device
*usb_dev
= interface_to_usbdev(acm
->control
);
975 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++)
976 usb_free_coherent(usb_dev
, acm
->writesize
, wb
->buf
, wb
->dmah
);
979 static void acm_read_buffers_free(struct acm
*acm
)
981 struct usb_device
*usb_dev
= interface_to_usbdev(acm
->control
);
984 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
985 usb_free_coherent(usb_dev
, acm
->readsize
,
986 acm
->read_buffers
[i
].base
, acm
->read_buffers
[i
].dma
);
989 /* Little helper: write buffers allocate */
990 static int acm_write_buffers_alloc(struct acm
*acm
)
995 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++) {
996 wb
->buf
= usb_alloc_coherent(acm
->dev
, acm
->writesize
, GFP_KERNEL
,
1002 usb_free_coherent(acm
->dev
, acm
->writesize
,
1011 static int acm_probe(struct usb_interface
*intf
,
1012 const struct usb_device_id
*id
)
1014 struct usb_cdc_union_desc
*union_header
= NULL
;
1015 struct usb_cdc_country_functional_desc
*cfd
= NULL
;
1016 unsigned char *buffer
= intf
->altsetting
->extra
;
1017 int buflen
= intf
->altsetting
->extralen
;
1018 struct usb_interface
*control_interface
;
1019 struct usb_interface
*data_interface
;
1020 struct usb_endpoint_descriptor
*epctrl
= NULL
;
1021 struct usb_endpoint_descriptor
*epread
= NULL
;
1022 struct usb_endpoint_descriptor
*epwrite
= NULL
;
1023 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1026 int ctrlsize
, readsize
;
1028 u8 ac_management_function
= 0;
1029 u8 call_management_function
= 0;
1030 int call_interface_num
= -1;
1031 int data_interface_num
= -1;
1032 unsigned long quirks
;
1035 int combined_interfaces
= 0;
1036 struct device
*tty_dev
;
1040 quirks
= (unsigned long)id
->driver_info
;
1042 if (quirks
== IGNORE_DEVICE
)
1045 num_rx_buf
= (quirks
== SINGLE_RX_URB
) ? 1 : ACM_NR
;
1047 /* handle quirks deadly to normal probing*/
1048 if (quirks
== NO_UNION_NORMAL
) {
1049 data_interface
= usb_ifnum_to_if(usb_dev
, 1);
1050 control_interface
= usb_ifnum_to_if(usb_dev
, 0);
1051 goto skip_normal_probe
;
1056 dev_err(&intf
->dev
, "Weird descriptor references\n");
1061 if (intf
->cur_altsetting
->endpoint
&&
1062 intf
->cur_altsetting
->endpoint
->extralen
&&
1063 intf
->cur_altsetting
->endpoint
->extra
) {
1065 "Seeking extra descriptors on endpoint\n");
1066 buflen
= intf
->cur_altsetting
->endpoint
->extralen
;
1067 buffer
= intf
->cur_altsetting
->endpoint
->extra
;
1070 "Zero length descriptor references\n");
1075 while (buflen
> 0) {
1076 if (buffer
[1] != USB_DT_CS_INTERFACE
) {
1077 dev_err(&intf
->dev
, "skipping garbage\n");
1081 switch (buffer
[2]) {
1082 case USB_CDC_UNION_TYPE
: /* we've found it */
1084 dev_err(&intf
->dev
, "More than one "
1085 "union descriptor, skipping ...\n");
1088 union_header
= (struct usb_cdc_union_desc
*)buffer
;
1090 case USB_CDC_COUNTRY_TYPE
: /* export through sysfs*/
1091 cfd
= (struct usb_cdc_country_functional_desc
*)buffer
;
1093 case USB_CDC_HEADER_TYPE
: /* maybe check version */
1094 break; /* for now we ignore it */
1095 case USB_CDC_ACM_TYPE
:
1096 ac_management_function
= buffer
[3];
1098 case USB_CDC_CALL_MANAGEMENT_TYPE
:
1099 call_management_function
= buffer
[3];
1100 call_interface_num
= buffer
[4];
1101 if ((quirks
& NOT_A_MODEM
) == 0 && (call_management_function
& 3) != 3)
1102 dev_err(&intf
->dev
, "This device cannot do calls on its own. It is not a modem.\n");
1105 /* there are LOTS more CDC descriptors that
1106 * could legitimately be found here.
1108 dev_dbg(&intf
->dev
, "Ignoring descriptor: "
1109 "type %02x, length %d\n",
1110 buffer
[2], buffer
[0]);
1114 buflen
-= buffer
[0];
1115 buffer
+= buffer
[0];
1118 if (!union_header
) {
1119 if (call_interface_num
> 0) {
1120 dev_dbg(&intf
->dev
, "No union descriptor, using call management descriptor\n");
1121 /* quirks for Droids MuIn LCD */
1122 if (quirks
& NO_DATA_INTERFACE
)
1123 data_interface
= usb_ifnum_to_if(usb_dev
, 0);
1125 data_interface
= usb_ifnum_to_if(usb_dev
, (data_interface_num
= call_interface_num
));
1126 control_interface
= intf
;
1128 if (intf
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1129 dev_dbg(&intf
->dev
,"No union descriptor, giving up\n");
1132 dev_warn(&intf
->dev
,"No union descriptor, testing for castrated device\n");
1133 combined_interfaces
= 1;
1134 control_interface
= data_interface
= intf
;
1135 goto look_for_collapsed_interface
;
1139 control_interface
= usb_ifnum_to_if(usb_dev
, union_header
->bMasterInterface0
);
1140 data_interface
= usb_ifnum_to_if(usb_dev
, (data_interface_num
= union_header
->bSlaveInterface0
));
1141 if (!control_interface
|| !data_interface
) {
1142 dev_dbg(&intf
->dev
, "no interfaces\n");
1147 if (data_interface_num
!= call_interface_num
)
1148 dev_dbg(&intf
->dev
, "Separate call control interface. That is not fully supported.\n");
1150 if (control_interface
== data_interface
) {
1151 /* some broken devices designed for windows work this way */
1152 dev_warn(&intf
->dev
,"Control and data interfaces are not separated!\n");
1153 combined_interfaces
= 1;
1154 /* a popular other OS doesn't use it */
1155 quirks
|= NO_CAP_LINE
;
1156 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1157 dev_err(&intf
->dev
, "This needs exactly 3 endpoints\n");
1160 look_for_collapsed_interface
:
1161 for (i
= 0; i
< 3; i
++) {
1162 struct usb_endpoint_descriptor
*ep
;
1163 ep
= &data_interface
->cur_altsetting
->endpoint
[i
].desc
;
1165 if (usb_endpoint_is_int_in(ep
))
1167 else if (usb_endpoint_is_bulk_out(ep
))
1169 else if (usb_endpoint_is_bulk_in(ep
))
1174 if (!epctrl
|| !epread
|| !epwrite
)
1177 goto made_compressed_probe
;
1182 /*workaround for switched interfaces */
1183 if (data_interface
->cur_altsetting
->desc
.bInterfaceClass
1184 != CDC_DATA_INTERFACE_TYPE
) {
1185 if (control_interface
->cur_altsetting
->desc
.bInterfaceClass
1186 == CDC_DATA_INTERFACE_TYPE
) {
1187 struct usb_interface
*t
;
1189 "Your device has switched interfaces.\n");
1190 t
= control_interface
;
1191 control_interface
= data_interface
;
1198 /* Accept probe requests only for the control interface */
1199 if (!combined_interfaces
&& intf
!= control_interface
)
1202 if (!combined_interfaces
&& usb_interface_claimed(data_interface
)) {
1203 /* valid in this context */
1204 dev_dbg(&intf
->dev
, "The data interface isn't available\n");
1209 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
< 2 ||
1210 control_interface
->cur_altsetting
->desc
.bNumEndpoints
== 0)
1213 epctrl
= &control_interface
->cur_altsetting
->endpoint
[0].desc
;
1214 epread
= &data_interface
->cur_altsetting
->endpoint
[0].desc
;
1215 epwrite
= &data_interface
->cur_altsetting
->endpoint
[1].desc
;
1218 /* workaround for switched endpoints */
1219 if (!usb_endpoint_dir_in(epread
)) {
1220 /* descriptors are swapped */
1221 struct usb_endpoint_descriptor
*t
;
1223 "The data interface has switched endpoints\n");
1228 made_compressed_probe
:
1229 dev_dbg(&intf
->dev
, "interfaces are valid\n");
1231 acm
= kzalloc(sizeof(struct acm
), GFP_KERNEL
);
1233 dev_err(&intf
->dev
, "out of memory (acm kzalloc)\n");
1237 minor
= acm_alloc_minor(acm
);
1238 if (minor
== ACM_TTY_MINORS
) {
1239 dev_err(&intf
->dev
, "no more free acm devices\n");
1244 ctrlsize
= usb_endpoint_maxp(epctrl
);
1245 readsize
= usb_endpoint_maxp(epread
) *
1246 (quirks
== SINGLE_RX_URB
? 1 : 2);
1247 acm
->combined_interfaces
= combined_interfaces
;
1248 acm
->writesize
= usb_endpoint_maxp(epwrite
) * 20;
1249 acm
->control
= control_interface
;
1250 acm
->data
= data_interface
;
1253 acm
->ctrl_caps
= ac_management_function
;
1254 if (quirks
& NO_CAP_LINE
)
1255 acm
->ctrl_caps
&= ~USB_CDC_CAP_LINE
;
1256 acm
->ctrlsize
= ctrlsize
;
1257 acm
->readsize
= readsize
;
1258 acm
->rx_buflimit
= num_rx_buf
;
1259 INIT_WORK(&acm
->work
, acm_softint
);
1260 init_waitqueue_head(&acm
->wioctl
);
1261 spin_lock_init(&acm
->write_lock
);
1262 spin_lock_init(&acm
->read_lock
);
1263 mutex_init(&acm
->mutex
);
1264 acm
->rx_endpoint
= usb_rcvbulkpipe(usb_dev
, epread
->bEndpointAddress
);
1265 acm
->is_int_ep
= usb_endpoint_xfer_int(epread
);
1267 acm
->bInterval
= epread
->bInterval
;
1268 tty_port_init(&acm
->port
);
1269 acm
->port
.ops
= &acm_port_ops
;
1271 buf
= usb_alloc_coherent(usb_dev
, ctrlsize
, GFP_KERNEL
, &acm
->ctrl_dma
);
1273 dev_err(&intf
->dev
, "out of memory (ctrl buffer alloc)\n");
1276 acm
->ctrl_buffer
= buf
;
1278 if (acm_write_buffers_alloc(acm
) < 0) {
1279 dev_err(&intf
->dev
, "out of memory (write buffer alloc)\n");
1283 acm
->ctrlurb
= usb_alloc_urb(0, GFP_KERNEL
);
1284 if (!acm
->ctrlurb
) {
1285 dev_err(&intf
->dev
, "out of memory (ctrlurb kmalloc)\n");
1288 for (i
= 0; i
< num_rx_buf
; i
++) {
1289 struct acm_rb
*rb
= &(acm
->read_buffers
[i
]);
1292 rb
->base
= usb_alloc_coherent(acm
->dev
, readsize
, GFP_KERNEL
,
1295 dev_err(&intf
->dev
, "out of memory "
1296 "(read bufs usb_alloc_coherent)\n");
1302 urb
= usb_alloc_urb(0, GFP_KERNEL
);
1305 "out of memory (read urbs usb_alloc_urb)\n");
1308 urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1309 urb
->transfer_dma
= rb
->dma
;
1310 if (acm
->is_int_ep
) {
1311 usb_fill_int_urb(urb
, acm
->dev
,
1315 acm_read_bulk_callback
, rb
,
1318 usb_fill_bulk_urb(urb
, acm
->dev
,
1322 acm_read_bulk_callback
, rb
);
1325 acm
->read_urbs
[i
] = urb
;
1326 __set_bit(i
, &acm
->read_urbs_free
);
1328 for (i
= 0; i
< ACM_NW
; i
++) {
1329 struct acm_wb
*snd
= &(acm
->wb
[i
]);
1331 snd
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1332 if (snd
->urb
== NULL
) {
1334 "out of memory (write urbs usb_alloc_urb)\n");
1338 if (usb_endpoint_xfer_int(epwrite
))
1339 usb_fill_int_urb(snd
->urb
, usb_dev
,
1340 usb_sndintpipe(usb_dev
, epwrite
->bEndpointAddress
),
1341 NULL
, acm
->writesize
, acm_write_bulk
, snd
, epwrite
->bInterval
);
1343 usb_fill_bulk_urb(snd
->urb
, usb_dev
,
1344 usb_sndbulkpipe(usb_dev
, epwrite
->bEndpointAddress
),
1345 NULL
, acm
->writesize
, acm_write_bulk
, snd
);
1346 snd
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1347 snd
->instance
= acm
;
1350 usb_set_intfdata(intf
, acm
);
1352 i
= device_create_file(&intf
->dev
, &dev_attr_bmCapabilities
);
1356 if (cfd
) { /* export the country data */
1357 acm
->country_codes
= kmalloc(cfd
->bLength
- 4, GFP_KERNEL
);
1358 if (!acm
->country_codes
)
1359 goto skip_countries
;
1360 acm
->country_code_size
= cfd
->bLength
- 4;
1361 memcpy(acm
->country_codes
, (u8
*)&cfd
->wCountyCode0
,
1363 acm
->country_rel_date
= cfd
->iCountryCodeRelDate
;
1365 i
= device_create_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1367 kfree(acm
->country_codes
);
1368 acm
->country_codes
= NULL
;
1369 acm
->country_code_size
= 0;
1370 goto skip_countries
;
1373 i
= device_create_file(&intf
->dev
,
1374 &dev_attr_iCountryCodeRelDate
);
1376 device_remove_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1377 kfree(acm
->country_codes
);
1378 acm
->country_codes
= NULL
;
1379 acm
->country_code_size
= 0;
1380 goto skip_countries
;
1385 usb_fill_int_urb(acm
->ctrlurb
, usb_dev
,
1386 usb_rcvintpipe(usb_dev
, epctrl
->bEndpointAddress
),
1387 acm
->ctrl_buffer
, ctrlsize
, acm_ctrl_irq
, acm
,
1388 /* works around buggy devices */
1389 epctrl
->bInterval
? epctrl
->bInterval
: 16);
1390 acm
->ctrlurb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1391 acm
->ctrlurb
->transfer_dma
= acm
->ctrl_dma
;
1393 dev_info(&intf
->dev
, "ttyACM%d: USB ACM device\n", minor
);
1395 acm_set_control(acm
, acm
->ctrlout
);
1397 acm
->line
.dwDTERate
= cpu_to_le32(9600);
1398 acm
->line
.bDataBits
= 8;
1399 acm_set_line(acm
, &acm
->line
);
1401 usb_driver_claim_interface(&acm_driver
, data_interface
, acm
);
1402 usb_set_intfdata(data_interface
, acm
);
1404 usb_get_intf(control_interface
);
1405 tty_dev
= tty_port_register_device(&acm
->port
, acm_tty_driver
, minor
,
1406 &control_interface
->dev
);
1407 if (IS_ERR(tty_dev
)) {
1408 rv
= PTR_ERR(tty_dev
);
1414 if (acm
->country_codes
) {
1415 device_remove_file(&acm
->control
->dev
,
1416 &dev_attr_wCountryCodes
);
1417 device_remove_file(&acm
->control
->dev
,
1418 &dev_attr_iCountryCodeRelDate
);
1420 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1422 usb_set_intfdata(intf
, NULL
);
1423 for (i
= 0; i
< ACM_NW
; i
++)
1424 usb_free_urb(acm
->wb
[i
].urb
);
1426 for (i
= 0; i
< num_rx_buf
; i
++)
1427 usb_free_urb(acm
->read_urbs
[i
]);
1428 acm_read_buffers_free(acm
);
1429 usb_free_urb(acm
->ctrlurb
);
1431 acm_write_buffers_free(acm
);
1433 usb_free_coherent(usb_dev
, ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1435 acm_release_minor(acm
);
1441 static void stop_data_traffic(struct acm
*acm
)
1445 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
1447 usb_kill_urb(acm
->ctrlurb
);
1448 for (i
= 0; i
< ACM_NW
; i
++)
1449 usb_kill_urb(acm
->wb
[i
].urb
);
1450 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1451 usb_kill_urb(acm
->read_urbs
[i
]);
1453 cancel_work_sync(&acm
->work
);
1456 static void acm_disconnect(struct usb_interface
*intf
)
1458 struct acm
*acm
= usb_get_intfdata(intf
);
1459 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1460 struct tty_struct
*tty
;
1463 dev_dbg(&intf
->dev
, "%s\n", __func__
);
1465 /* sibling interface is already cleaning up */
1469 mutex_lock(&acm
->mutex
);
1470 acm
->disconnected
= true;
1471 if (acm
->country_codes
) {
1472 device_remove_file(&acm
->control
->dev
,
1473 &dev_attr_wCountryCodes
);
1474 device_remove_file(&acm
->control
->dev
,
1475 &dev_attr_iCountryCodeRelDate
);
1477 wake_up_all(&acm
->wioctl
);
1478 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1479 usb_set_intfdata(acm
->control
, NULL
);
1480 usb_set_intfdata(acm
->data
, NULL
);
1481 mutex_unlock(&acm
->mutex
);
1483 tty
= tty_port_tty_get(&acm
->port
);
1489 stop_data_traffic(acm
);
1491 tty_unregister_device(acm_tty_driver
, acm
->minor
);
1493 usb_free_urb(acm
->ctrlurb
);
1494 for (i
= 0; i
< ACM_NW
; i
++)
1495 usb_free_urb(acm
->wb
[i
].urb
);
1496 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1497 usb_free_urb(acm
->read_urbs
[i
]);
1498 acm_write_buffers_free(acm
);
1499 usb_free_coherent(usb_dev
, acm
->ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1500 acm_read_buffers_free(acm
);
1502 if (!acm
->combined_interfaces
)
1503 usb_driver_release_interface(&acm_driver
, intf
== acm
->control
?
1504 acm
->data
: acm
->control
);
1506 tty_port_put(&acm
->port
);
1510 static int acm_suspend(struct usb_interface
*intf
, pm_message_t message
)
1512 struct acm
*acm
= usb_get_intfdata(intf
);
1515 if (PMSG_IS_AUTO(message
)) {
1518 spin_lock_irq(&acm
->write_lock
);
1519 b
= acm
->transmitting
;
1520 spin_unlock_irq(&acm
->write_lock
);
1525 spin_lock_irq(&acm
->read_lock
);
1526 spin_lock(&acm
->write_lock
);
1527 cnt
= acm
->susp_count
++;
1528 spin_unlock(&acm
->write_lock
);
1529 spin_unlock_irq(&acm
->read_lock
);
1534 if (test_bit(ASYNCB_INITIALIZED
, &acm
->port
.flags
))
1535 stop_data_traffic(acm
);
1540 static int acm_resume(struct usb_interface
*intf
)
1542 struct acm
*acm
= usb_get_intfdata(intf
);
1547 spin_lock_irq(&acm
->read_lock
);
1548 acm
->susp_count
-= 1;
1549 cnt
= acm
->susp_count
;
1550 spin_unlock_irq(&acm
->read_lock
);
1555 if (test_bit(ASYNCB_INITIALIZED
, &acm
->port
.flags
)) {
1556 rv
= usb_submit_urb(acm
->ctrlurb
, GFP_NOIO
);
1558 spin_lock_irq(&acm
->write_lock
);
1559 if (acm
->delayed_wb
) {
1560 wb
= acm
->delayed_wb
;
1561 acm
->delayed_wb
= NULL
;
1562 spin_unlock_irq(&acm
->write_lock
);
1563 acm_start_wb(acm
, wb
);
1565 spin_unlock_irq(&acm
->write_lock
);
1569 * delayed error checking because we must
1570 * do the write path at all cost
1575 rv
= acm_submit_read_urbs(acm
, GFP_NOIO
);
1582 static int acm_reset_resume(struct usb_interface
*intf
)
1584 struct acm
*acm
= usb_get_intfdata(intf
);
1586 if (test_bit(ASYNCB_INITIALIZED
, &acm
->port
.flags
))
1587 tty_port_tty_hangup(&acm
->port
, false);
1589 return acm_resume(intf
);
1592 #endif /* CONFIG_PM */
1594 #define NOKIA_PCSUITE_ACM_INFO(x) \
1595 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1596 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1597 USB_CDC_ACM_PROTO_VENDOR)
1599 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1600 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1601 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1602 USB_CDC_ACM_PROTO_VENDOR)
1605 * USB driver structure.
1608 static const struct usb_device_id acm_ids
[] = {
1609 /* quirky and broken devices */
1610 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1611 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1612 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1613 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1615 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1616 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1618 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1619 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1621 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1622 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1624 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1625 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1627 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1628 .driver_info
= SINGLE_RX_URB
,
1630 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1631 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1633 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1634 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1636 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1637 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1639 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1640 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1642 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1643 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1645 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1646 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1648 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1649 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1651 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1653 /* Motorola H24 HSPA module: */
1654 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1655 { USB_DEVICE(0x22b8, 0x2d92) }, /* modem + diagnostics */
1656 { USB_DEVICE(0x22b8, 0x2d93) }, /* modem + AT port */
1657 { USB_DEVICE(0x22b8, 0x2d95) }, /* modem + AT port + diagnostics */
1658 { USB_DEVICE(0x22b8, 0x2d96) }, /* modem + NMEA */
1659 { USB_DEVICE(0x22b8, 0x2d97) }, /* modem + diagnostics + NMEA */
1660 { USB_DEVICE(0x22b8, 0x2d99) }, /* modem + AT port + NMEA */
1661 { USB_DEVICE(0x22b8, 0x2d9a) }, /* modem + AT port + diagnostics + NMEA */
1663 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1664 .driver_info
= NO_UNION_NORMAL
, /* union descriptor misplaced on
1665 data interface instead of
1666 communications interface.
1667 Maybe we should define a new
1670 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1671 .driver_info
= NO_UNION_NORMAL
,
1673 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1674 .driver_info
= NO_UNION_NORMAL
,
1676 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1677 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1679 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1680 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1683 /* Nokia S60 phones expose two ACM channels. The first is
1684 * a modem and is picked up by the standard AT-command
1685 * information below. The second is 'vendor-specific' but
1686 * is treated as a serial device at the S60 end, so we want
1687 * to expose it on Linux too. */
1688 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1689 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1690 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1691 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1692 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1693 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1694 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1695 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1696 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1697 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1698 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1699 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1700 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1701 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1702 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1703 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1704 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1705 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1706 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1707 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1708 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1709 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1710 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1711 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1712 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1713 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1714 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1715 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1716 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1717 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1718 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1719 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1720 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1721 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1722 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1723 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1724 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1725 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1726 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1727 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1728 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1729 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1730 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1731 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1732 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1733 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1734 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1735 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1736 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1737 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1738 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1739 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1740 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1741 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1742 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1743 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1744 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1745 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1747 /* Support for Owen devices */
1748 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1750 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1752 /* Support Lego NXT using pbLua firmware */
1753 { USB_DEVICE(0x0694, 0xff00),
1754 .driver_info
= NOT_A_MODEM
,
1757 /* Support for Droids MuIn LCD */
1758 { USB_DEVICE(0x04d8, 0x000b),
1759 .driver_info
= NO_DATA_INTERFACE
,
1762 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1763 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1764 .driver_info
= IGNORE_DEVICE
,
1766 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1767 .driver_info
= IGNORE_DEVICE
,
1771 /* control interfaces without any protocol set */
1772 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1773 USB_CDC_PROTO_NONE
) },
1775 /* control interfaces with various AT-command sets */
1776 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1777 USB_CDC_ACM_PROTO_AT_V25TER
) },
1778 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1779 USB_CDC_ACM_PROTO_AT_PCCA101
) },
1780 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1781 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE
) },
1782 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1783 USB_CDC_ACM_PROTO_AT_GSM
) },
1784 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1785 USB_CDC_ACM_PROTO_AT_3G
) },
1786 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1787 USB_CDC_ACM_PROTO_AT_CDMA
) },
1792 MODULE_DEVICE_TABLE(usb
, acm_ids
);
1794 static struct usb_driver acm_driver
= {
1797 .disconnect
= acm_disconnect
,
1799 .suspend
= acm_suspend
,
1800 .resume
= acm_resume
,
1801 .reset_resume
= acm_reset_resume
,
1803 .id_table
= acm_ids
,
1805 .supports_autosuspend
= 1,
1807 .disable_hub_initiated_lpm
= 1,
1811 * TTY driver structures.
1814 static const struct tty_operations acm_ops
= {
1815 .install
= acm_tty_install
,
1816 .open
= acm_tty_open
,
1817 .close
= acm_tty_close
,
1818 .cleanup
= acm_tty_cleanup
,
1819 .hangup
= acm_tty_hangup
,
1820 .write
= acm_tty_write
,
1821 .write_room
= acm_tty_write_room
,
1822 .ioctl
= acm_tty_ioctl
,
1823 .throttle
= acm_tty_throttle
,
1824 .unthrottle
= acm_tty_unthrottle
,
1825 .chars_in_buffer
= acm_tty_chars_in_buffer
,
1826 .break_ctl
= acm_tty_break_ctl
,
1827 .set_termios
= acm_tty_set_termios
,
1828 .tiocmget
= acm_tty_tiocmget
,
1829 .tiocmset
= acm_tty_tiocmset
,
1836 static int __init
acm_init(void)
1839 acm_tty_driver
= alloc_tty_driver(ACM_TTY_MINORS
);
1840 if (!acm_tty_driver
)
1842 acm_tty_driver
->driver_name
= "acm",
1843 acm_tty_driver
->name
= "ttyACM",
1844 acm_tty_driver
->major
= ACM_TTY_MAJOR
,
1845 acm_tty_driver
->minor_start
= 0,
1846 acm_tty_driver
->type
= TTY_DRIVER_TYPE_SERIAL
,
1847 acm_tty_driver
->subtype
= SERIAL_TYPE_NORMAL
,
1848 acm_tty_driver
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
1849 acm_tty_driver
->init_termios
= tty_std_termios
;
1850 acm_tty_driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
|
1852 tty_set_operations(acm_tty_driver
, &acm_ops
);
1854 retval
= tty_register_driver(acm_tty_driver
);
1856 put_tty_driver(acm_tty_driver
);
1860 retval
= usb_register(&acm_driver
);
1862 tty_unregister_driver(acm_tty_driver
);
1863 put_tty_driver(acm_tty_driver
);
1867 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1872 static void __exit
acm_exit(void)
1874 usb_deregister(&acm_driver
);
1875 tty_unregister_driver(acm_tty_driver
);
1876 put_tty_driver(acm_tty_driver
);
1879 module_init(acm_init
);
1880 module_exit(acm_exit
);
1882 MODULE_AUTHOR(DRIVER_AUTHOR
);
1883 MODULE_DESCRIPTION(DRIVER_DESC
);
1884 MODULE_LICENSE("GPL");
1885 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR
);