1 // SPDX-License-Identifier: GPL-2.0+
5 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
6 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
7 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
8 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
9 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
10 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
11 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
13 * USB Abstract Control Model driver for USB modems and ISDN adapters
21 #include <linux/kernel.h>
22 #include <linux/sched/signal.h>
23 #include <linux/errno.h>
24 #include <linux/init.h>
25 #include <linux/slab.h>
26 #include <linux/log2.h>
27 #include <linux/tty.h>
28 #include <linux/serial.h>
29 #include <linux/tty_driver.h>
30 #include <linux/tty_flip.h>
31 #include <linux/module.h>
32 #include <linux/mutex.h>
33 #include <linux/uaccess.h>
34 #include <linux/usb.h>
35 #include <linux/usb/cdc.h>
36 #include <asm/byteorder.h>
37 #include <asm/unaligned.h>
38 #include <linux/idr.h>
39 #include <linux/list.h>
44 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
45 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
47 static struct usb_driver acm_driver
;
48 static struct tty_driver
*acm_tty_driver
;
50 static DEFINE_IDR(acm_minors
);
51 static DEFINE_MUTEX(acm_minors_lock
);
53 static void acm_tty_set_termios(struct tty_struct
*tty
,
54 struct ktermios
*termios_old
);
57 * acm_minors accessors
61 * Look up an ACM structure by minor. If found and not disconnected, increment
62 * its refcount and return it with its mutex held.
64 static struct acm
*acm_get_by_minor(unsigned int minor
)
68 mutex_lock(&acm_minors_lock
);
69 acm
= idr_find(&acm_minors
, minor
);
71 mutex_lock(&acm
->mutex
);
72 if (acm
->disconnected
) {
73 mutex_unlock(&acm
->mutex
);
76 tty_port_get(&acm
->port
);
77 mutex_unlock(&acm
->mutex
);
80 mutex_unlock(&acm_minors_lock
);
85 * Try to find an available minor number and if found, associate it with 'acm'.
87 static int acm_alloc_minor(struct acm
*acm
)
91 mutex_lock(&acm_minors_lock
);
92 minor
= idr_alloc(&acm_minors
, acm
, 0, ACM_TTY_MINORS
, GFP_KERNEL
);
93 mutex_unlock(&acm_minors_lock
);
98 /* Release the minor number associated with 'acm'. */
99 static void acm_release_minor(struct acm
*acm
)
101 mutex_lock(&acm_minors_lock
);
102 idr_remove(&acm_minors
, acm
->minor
);
103 mutex_unlock(&acm_minors_lock
);
107 * Functions for ACM control messages.
110 static int acm_ctrl_msg(struct acm
*acm
, int request
, int value
,
115 retval
= usb_autopm_get_interface(acm
->control
);
119 retval
= usb_control_msg(acm
->dev
, usb_sndctrlpipe(acm
->dev
, 0),
120 request
, USB_RT_ACM
, value
,
121 acm
->control
->altsetting
[0].desc
.bInterfaceNumber
,
124 dev_dbg(&acm
->control
->dev
,
125 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
126 __func__
, request
, value
, len
, retval
);
128 usb_autopm_put_interface(acm
->control
);
130 return retval
< 0 ? retval
: 0;
133 /* devices aren't required to support these requests.
134 * the cdc acm descriptor tells whether they do...
136 static inline int acm_set_control(struct acm
*acm
, int control
)
138 if (acm
->quirks
& QUIRK_CONTROL_LINE_STATE
)
141 return acm_ctrl_msg(acm
, USB_CDC_REQ_SET_CONTROL_LINE_STATE
,
145 #define acm_set_line(acm, line) \
146 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
147 #define acm_send_break(acm, ms) \
148 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
150 static void acm_kill_urbs(struct acm
*acm
)
154 usb_kill_urb(acm
->ctrlurb
);
155 for (i
= 0; i
< ACM_NW
; i
++)
156 usb_kill_urb(acm
->wb
[i
].urb
);
157 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
158 usb_kill_urb(acm
->read_urbs
[i
]);
162 * Write buffer management.
163 * All of these assume proper locks taken by the caller.
166 static int acm_wb_alloc(struct acm
*acm
)
180 wbn
= (wbn
+ 1) % ACM_NW
;
186 static int acm_wb_is_avail(struct acm
*acm
)
192 spin_lock_irqsave(&acm
->write_lock
, flags
);
193 for (i
= 0; i
< ACM_NW
; i
++)
195 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
200 * Finish write. Caller must hold acm->write_lock
202 static void acm_write_done(struct acm
*acm
, struct acm_wb
*wb
)
206 usb_autopm_put_interface_async(acm
->control
);
212 * the caller is responsible for locking
215 static int acm_start_wb(struct acm
*acm
, struct acm_wb
*wb
)
221 wb
->urb
->transfer_buffer
= wb
->buf
;
222 wb
->urb
->transfer_dma
= wb
->dmah
;
223 wb
->urb
->transfer_buffer_length
= wb
->len
;
224 wb
->urb
->dev
= acm
->dev
;
226 rc
= usb_submit_urb(wb
->urb
, GFP_ATOMIC
);
228 dev_err(&acm
->data
->dev
,
229 "%s - usb_submit_urb(write bulk) failed: %d\n",
231 acm_write_done(acm
, wb
);
237 * attributes exported through sysfs
239 static ssize_t bmCapabilities_show
240 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
242 struct usb_interface
*intf
= to_usb_interface(dev
);
243 struct acm
*acm
= usb_get_intfdata(intf
);
245 return sprintf(buf
, "%d", acm
->ctrl_caps
);
247 static DEVICE_ATTR_RO(bmCapabilities
);
249 static ssize_t wCountryCodes_show
250 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
252 struct usb_interface
*intf
= to_usb_interface(dev
);
253 struct acm
*acm
= usb_get_intfdata(intf
);
255 memcpy(buf
, acm
->country_codes
, acm
->country_code_size
);
256 return acm
->country_code_size
;
259 static DEVICE_ATTR_RO(wCountryCodes
);
261 static ssize_t iCountryCodeRelDate_show
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
->country_rel_date
);
270 static DEVICE_ATTR_RO(iCountryCodeRelDate
);
272 * Interrupt handlers for various ACM device responses
275 static void acm_process_notification(struct acm
*acm
, unsigned char *buf
)
280 struct usb_cdc_notification
*dr
= (struct usb_cdc_notification
*)buf
;
281 unsigned char *data
= buf
+ sizeof(struct usb_cdc_notification
);
283 switch (dr
->bNotificationType
) {
284 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
285 dev_dbg(&acm
->control
->dev
,
286 "%s - network connection: %d\n", __func__
, dr
->wValue
);
289 case USB_CDC_NOTIFY_SERIAL_STATE
:
290 if (le16_to_cpu(dr
->wLength
) != 2) {
291 dev_dbg(&acm
->control
->dev
,
292 "%s - malformed serial state\n", __func__
);
296 newctrl
= get_unaligned_le16(data
);
297 dev_dbg(&acm
->control
->dev
,
298 "%s - serial state: 0x%x\n", __func__
, newctrl
);
300 if (!acm
->clocal
&& (acm
->ctrlin
& ~newctrl
& ACM_CTRL_DCD
)) {
301 dev_dbg(&acm
->control
->dev
,
302 "%s - calling hangup\n", __func__
);
303 tty_port_tty_hangup(&acm
->port
, false);
306 difference
= acm
->ctrlin
^ newctrl
;
307 spin_lock_irqsave(&acm
->read_lock
, flags
);
308 acm
->ctrlin
= newctrl
;
309 acm
->oldcount
= acm
->iocount
;
311 if (difference
& ACM_CTRL_DSR
)
313 if (difference
& ACM_CTRL_DCD
)
315 if (newctrl
& ACM_CTRL_BRK
)
317 if (newctrl
& ACM_CTRL_RI
)
319 if (newctrl
& ACM_CTRL_FRAMING
)
320 acm
->iocount
.frame
++;
321 if (newctrl
& ACM_CTRL_PARITY
)
322 acm
->iocount
.parity
++;
323 if (newctrl
& ACM_CTRL_OVERRUN
)
324 acm
->iocount
.overrun
++;
325 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
328 wake_up_all(&acm
->wioctl
);
333 dev_dbg(&acm
->control
->dev
,
334 "%s - unknown notification %d received: index %d len %d\n",
336 dr
->bNotificationType
, dr
->wIndex
, dr
->wLength
);
340 /* control interface reports status changes with "interrupt" transfers */
341 static void acm_ctrl_irq(struct urb
*urb
)
343 struct acm
*acm
= urb
->context
;
344 struct usb_cdc_notification
*dr
= urb
->transfer_buffer
;
345 unsigned int current_size
= urb
->actual_length
;
346 unsigned int expected_size
, copy_size
, alloc_size
;
348 int status
= urb
->status
;
357 /* this urb is terminated, clean up */
358 dev_dbg(&acm
->control
->dev
,
359 "%s - urb shutting down with status: %d\n",
363 dev_dbg(&acm
->control
->dev
,
364 "%s - nonzero urb status received: %d\n",
369 usb_mark_last_busy(acm
->dev
);
372 dr
= (struct usb_cdc_notification
*)acm
->notification_buffer
;
374 /* size = notification-header + (optional) data */
375 expected_size
= sizeof(struct usb_cdc_notification
) +
376 le16_to_cpu(dr
->wLength
);
378 if (current_size
< expected_size
) {
379 /* notification is transmitted fragmented, reassemble */
380 if (acm
->nb_size
< expected_size
) {
382 kfree(acm
->notification_buffer
);
385 alloc_size
= roundup_pow_of_two(expected_size
);
387 * kmalloc ensures a valid notification_buffer after a
388 * use of kfree in case the previous allocation was too
389 * small. Final freeing is done on disconnect.
391 acm
->notification_buffer
=
392 kmalloc(alloc_size
, GFP_ATOMIC
);
393 if (!acm
->notification_buffer
)
395 acm
->nb_size
= alloc_size
;
398 copy_size
= min(current_size
,
399 expected_size
- acm
->nb_index
);
401 memcpy(&acm
->notification_buffer
[acm
->nb_index
],
402 urb
->transfer_buffer
, copy_size
);
403 acm
->nb_index
+= copy_size
;
404 current_size
= acm
->nb_index
;
407 if (current_size
>= expected_size
) {
408 /* notification complete */
409 acm_process_notification(acm
, (unsigned char *)dr
);
414 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
415 if (retval
&& retval
!= -EPERM
)
416 dev_err(&acm
->control
->dev
,
417 "%s - usb_submit_urb failed: %d\n", __func__
, retval
);
420 static int acm_submit_read_urb(struct acm
*acm
, int index
, gfp_t mem_flags
)
424 if (!test_and_clear_bit(index
, &acm
->read_urbs_free
))
427 res
= usb_submit_urb(acm
->read_urbs
[index
], mem_flags
);
429 if (res
!= -EPERM
&& res
!= -ENODEV
) {
430 dev_err(&acm
->data
->dev
,
431 "urb %d failed submission with %d\n",
434 set_bit(index
, &acm
->read_urbs_free
);
437 dev_vdbg(&acm
->data
->dev
, "submitted urb %d\n", index
);
443 static int acm_submit_read_urbs(struct acm
*acm
, gfp_t mem_flags
)
448 for (i
= 0; i
< acm
->rx_buflimit
; ++i
) {
449 res
= acm_submit_read_urb(acm
, i
, mem_flags
);
457 static void acm_process_read_urb(struct acm
*acm
, struct urb
*urb
)
459 if (!urb
->actual_length
)
462 tty_insert_flip_string(&acm
->port
, urb
->transfer_buffer
,
464 tty_flip_buffer_push(&acm
->port
);
467 static void acm_read_bulk_callback(struct urb
*urb
)
469 struct acm_rb
*rb
= urb
->context
;
470 struct acm
*acm
= rb
->instance
;
472 int status
= urb
->status
;
474 dev_vdbg(&acm
->data
->dev
, "got urb %d, len %d, status %d\n",
475 rb
->index
, urb
->actual_length
, status
);
477 set_bit(rb
->index
, &acm
->read_urbs_free
);
480 dev_dbg(&acm
->data
->dev
, "%s - disconnected\n", __func__
);
486 usb_mark_last_busy(acm
->dev
);
487 acm_process_read_urb(acm
, urb
);
490 set_bit(EVENT_RX_STALL
, &acm
->flags
);
491 schedule_work(&acm
->work
);
496 dev_dbg(&acm
->data
->dev
,
497 "%s - urb shutting down with status: %d\n",
501 dev_dbg(&acm
->data
->dev
,
502 "%s - nonzero urb status received: %d\n",
508 * Unthrottle may run on another CPU which needs to see events
509 * in the same order. Submission has an implict barrier
511 smp_mb__before_atomic();
513 /* throttle device if requested by tty */
514 spin_lock_irqsave(&acm
->read_lock
, flags
);
515 acm
->throttled
= acm
->throttle_req
;
516 if (!acm
->throttled
) {
517 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
518 acm_submit_read_urb(acm
, rb
->index
, GFP_ATOMIC
);
520 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
524 /* data interface wrote those outgoing bytes */
525 static void acm_write_bulk(struct urb
*urb
)
527 struct acm_wb
*wb
= urb
->context
;
528 struct acm
*acm
= wb
->instance
;
530 int status
= urb
->status
;
532 if (status
|| (urb
->actual_length
!= urb
->transfer_buffer_length
))
533 dev_vdbg(&acm
->data
->dev
, "wrote len %d/%d, status %d\n",
535 urb
->transfer_buffer_length
,
538 spin_lock_irqsave(&acm
->write_lock
, flags
);
539 acm_write_done(acm
, wb
);
540 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
541 set_bit(EVENT_TTY_WAKEUP
, &acm
->flags
);
542 schedule_work(&acm
->work
);
545 static void acm_softint(struct work_struct
*work
)
548 struct acm
*acm
= container_of(work
, struct acm
, work
);
550 if (test_bit(EVENT_RX_STALL
, &acm
->flags
)) {
551 if (!(usb_autopm_get_interface(acm
->data
))) {
552 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
553 usb_kill_urb(acm
->read_urbs
[i
]);
554 usb_clear_halt(acm
->dev
, acm
->in
);
555 acm_submit_read_urbs(acm
, GFP_KERNEL
);
556 usb_autopm_put_interface(acm
->data
);
558 clear_bit(EVENT_RX_STALL
, &acm
->flags
);
561 if (test_bit(EVENT_TTY_WAKEUP
, &acm
->flags
)) {
562 tty_port_tty_wakeup(&acm
->port
);
563 clear_bit(EVENT_TTY_WAKEUP
, &acm
->flags
);
571 static int acm_tty_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
576 acm
= acm_get_by_minor(tty
->index
);
580 retval
= tty_standard_install(driver
, tty
);
582 goto error_init_termios
;
585 * Suppress initial echoing for some devices which might send data
586 * immediately after acm driver has been installed.
588 if (acm
->quirks
& DISABLE_ECHO
)
589 tty
->termios
.c_lflag
&= ~ECHO
;
591 tty
->driver_data
= acm
;
596 tty_port_put(&acm
->port
);
600 static int acm_tty_open(struct tty_struct
*tty
, struct file
*filp
)
602 struct acm
*acm
= tty
->driver_data
;
604 return tty_port_open(&acm
->port
, tty
, filp
);
607 static void acm_port_dtr_rts(struct tty_port
*port
, int raise
)
609 struct acm
*acm
= container_of(port
, struct acm
, port
);
614 val
= ACM_CTRL_DTR
| ACM_CTRL_RTS
;
618 /* FIXME: add missing ctrlout locking throughout driver */
621 res
= acm_set_control(acm
, val
);
622 if (res
&& (acm
->ctrl_caps
& USB_CDC_CAP_LINE
))
623 dev_err(&acm
->control
->dev
, "failed to set dtr/rts\n");
626 static int acm_port_activate(struct tty_port
*port
, struct tty_struct
*tty
)
628 struct acm
*acm
= container_of(port
, struct acm
, port
);
629 int retval
= -ENODEV
;
632 mutex_lock(&acm
->mutex
);
633 if (acm
->disconnected
)
636 retval
= usb_autopm_get_interface(acm
->control
);
638 goto error_get_interface
;
641 * FIXME: Why do we need this? Allocating 64K of physically contiguous
642 * memory is really nasty...
644 set_bit(TTY_NO_WRITE_SPLIT
, &tty
->flags
);
645 acm
->control
->needs_remote_wakeup
= 1;
647 acm
->ctrlurb
->dev
= acm
->dev
;
648 retval
= usb_submit_urb(acm
->ctrlurb
, GFP_KERNEL
);
650 dev_err(&acm
->control
->dev
,
651 "%s - usb_submit_urb(ctrl irq) failed\n", __func__
);
652 goto error_submit_urb
;
655 acm_tty_set_termios(tty
, NULL
);
658 * Unthrottle device in case the TTY was closed while throttled.
660 spin_lock_irq(&acm
->read_lock
);
662 acm
->throttle_req
= 0;
663 spin_unlock_irq(&acm
->read_lock
);
665 retval
= acm_submit_read_urbs(acm
, GFP_KERNEL
);
667 goto error_submit_read_urbs
;
669 usb_autopm_put_interface(acm
->control
);
671 mutex_unlock(&acm
->mutex
);
675 error_submit_read_urbs
:
676 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
677 usb_kill_urb(acm
->read_urbs
[i
]);
678 usb_kill_urb(acm
->ctrlurb
);
680 usb_autopm_put_interface(acm
->control
);
683 mutex_unlock(&acm
->mutex
);
685 return usb_translate_errors(retval
);
688 static void acm_port_destruct(struct tty_port
*port
)
690 struct acm
*acm
= container_of(port
, struct acm
, port
);
692 acm_release_minor(acm
);
693 usb_put_intf(acm
->control
);
694 kfree(acm
->country_codes
);
698 static void acm_port_shutdown(struct tty_port
*port
)
700 struct acm
*acm
= container_of(port
, struct acm
, port
);
705 * Need to grab write_lock to prevent race with resume, but no need to
706 * hold it due to the tty-port initialised flag.
708 spin_lock_irq(&acm
->write_lock
);
709 spin_unlock_irq(&acm
->write_lock
);
711 usb_autopm_get_interface_no_resume(acm
->control
);
712 acm
->control
->needs_remote_wakeup
= 0;
713 usb_autopm_put_interface(acm
->control
);
716 urb
= usb_get_from_anchor(&acm
->delayed
);
721 usb_autopm_put_interface_async(acm
->control
);
727 static void acm_tty_cleanup(struct tty_struct
*tty
)
729 struct acm
*acm
= tty
->driver_data
;
731 tty_port_put(&acm
->port
);
734 static void acm_tty_hangup(struct tty_struct
*tty
)
736 struct acm
*acm
= tty
->driver_data
;
738 tty_port_hangup(&acm
->port
);
741 static void acm_tty_close(struct tty_struct
*tty
, struct file
*filp
)
743 struct acm
*acm
= tty
->driver_data
;
745 tty_port_close(&acm
->port
, tty
, filp
);
748 static int acm_tty_write(struct tty_struct
*tty
,
749 const unsigned char *buf
, int count
)
751 struct acm
*acm
= tty
->driver_data
;
760 dev_vdbg(&acm
->data
->dev
, "%d bytes from tty layer\n", count
);
762 spin_lock_irqsave(&acm
->write_lock
, flags
);
763 wbn
= acm_wb_alloc(acm
);
765 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
772 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
776 count
= (count
> acm
->writesize
) ? acm
->writesize
: count
;
777 dev_vdbg(&acm
->data
->dev
, "writing %d bytes\n", count
);
778 memcpy(wb
->buf
, buf
, count
);
781 stat
= usb_autopm_get_interface_async(acm
->control
);
784 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
788 if (acm
->susp_count
) {
789 usb_anchor_urb(wb
->urb
, &acm
->delayed
);
790 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
794 stat
= acm_start_wb(acm
, wb
);
795 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
802 static int acm_tty_write_room(struct tty_struct
*tty
)
804 struct acm
*acm
= tty
->driver_data
;
806 * Do not let the line discipline to know that we have a reserve,
807 * or it might get too enthusiastic.
809 return acm_wb_is_avail(acm
) ? acm
->writesize
: 0;
812 static int acm_tty_chars_in_buffer(struct tty_struct
*tty
)
814 struct acm
*acm
= tty
->driver_data
;
816 * if the device was unplugged then any remaining characters fell out
817 * of the connector ;)
819 if (acm
->disconnected
)
822 * This is inaccurate (overcounts), but it works.
824 return (ACM_NW
- acm_wb_is_avail(acm
)) * acm
->writesize
;
827 static void acm_tty_throttle(struct tty_struct
*tty
)
829 struct acm
*acm
= tty
->driver_data
;
831 spin_lock_irq(&acm
->read_lock
);
832 acm
->throttle_req
= 1;
833 spin_unlock_irq(&acm
->read_lock
);
836 static void acm_tty_unthrottle(struct tty_struct
*tty
)
838 struct acm
*acm
= tty
->driver_data
;
839 unsigned int was_throttled
;
841 spin_lock_irq(&acm
->read_lock
);
842 was_throttled
= acm
->throttled
;
844 acm
->throttle_req
= 0;
845 spin_unlock_irq(&acm
->read_lock
);
848 acm_submit_read_urbs(acm
, GFP_KERNEL
);
851 static int acm_tty_break_ctl(struct tty_struct
*tty
, int state
)
853 struct acm
*acm
= tty
->driver_data
;
856 retval
= acm_send_break(acm
, state
? 0xffff : 0);
858 dev_dbg(&acm
->control
->dev
,
859 "%s - send break failed\n", __func__
);
863 static int acm_tty_tiocmget(struct tty_struct
*tty
)
865 struct acm
*acm
= tty
->driver_data
;
867 return (acm
->ctrlout
& ACM_CTRL_DTR
? TIOCM_DTR
: 0) |
868 (acm
->ctrlout
& ACM_CTRL_RTS
? TIOCM_RTS
: 0) |
869 (acm
->ctrlin
& ACM_CTRL_DSR
? TIOCM_DSR
: 0) |
870 (acm
->ctrlin
& ACM_CTRL_RI
? TIOCM_RI
: 0) |
871 (acm
->ctrlin
& ACM_CTRL_DCD
? TIOCM_CD
: 0) |
875 static int acm_tty_tiocmset(struct tty_struct
*tty
,
876 unsigned int set
, unsigned int clear
)
878 struct acm
*acm
= tty
->driver_data
;
879 unsigned int newctrl
;
881 newctrl
= acm
->ctrlout
;
882 set
= (set
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
883 (set
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
884 clear
= (clear
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
885 (clear
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
887 newctrl
= (newctrl
& ~clear
) | set
;
889 if (acm
->ctrlout
== newctrl
)
891 return acm_set_control(acm
, acm
->ctrlout
= newctrl
);
894 static int get_serial_info(struct tty_struct
*tty
, struct serial_struct
*ss
)
896 struct acm
*acm
= tty
->driver_data
;
898 ss
->xmit_fifo_size
= acm
->writesize
;
899 ss
->baud_base
= le32_to_cpu(acm
->line
.dwDTERate
);
900 ss
->close_delay
= acm
->port
.close_delay
/ 10;
901 ss
->closing_wait
= acm
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
902 ASYNC_CLOSING_WAIT_NONE
:
903 acm
->port
.closing_wait
/ 10;
907 static int set_serial_info(struct tty_struct
*tty
, struct serial_struct
*ss
)
909 struct acm
*acm
= tty
->driver_data
;
910 unsigned int closing_wait
, close_delay
;
913 close_delay
= ss
->close_delay
* 10;
914 closing_wait
= ss
->closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
915 ASYNC_CLOSING_WAIT_NONE
: ss
->closing_wait
* 10;
917 mutex_lock(&acm
->port
.mutex
);
919 if (!capable(CAP_SYS_ADMIN
)) {
920 if ((close_delay
!= acm
->port
.close_delay
) ||
921 (closing_wait
!= acm
->port
.closing_wait
))
924 retval
= -EOPNOTSUPP
;
926 acm
->port
.close_delay
= close_delay
;
927 acm
->port
.closing_wait
= closing_wait
;
930 mutex_unlock(&acm
->port
.mutex
);
934 static int wait_serial_change(struct acm
*acm
, unsigned long arg
)
937 DECLARE_WAITQUEUE(wait
, current
);
938 struct async_icount old
, new;
941 spin_lock_irq(&acm
->read_lock
);
945 spin_unlock_irq(&acm
->read_lock
);
947 if ((arg
& TIOCM_DSR
) &&
950 if ((arg
& TIOCM_CD
) &&
953 if ((arg
& TIOCM_RI
) &&
957 add_wait_queue(&acm
->wioctl
, &wait
);
958 set_current_state(TASK_INTERRUPTIBLE
);
960 remove_wait_queue(&acm
->wioctl
, &wait
);
961 if (acm
->disconnected
) {
967 if (signal_pending(current
))
977 static int acm_tty_get_icount(struct tty_struct
*tty
,
978 struct serial_icounter_struct
*icount
)
980 struct acm
*acm
= tty
->driver_data
;
982 icount
->dsr
= acm
->iocount
.dsr
;
983 icount
->rng
= acm
->iocount
.rng
;
984 icount
->dcd
= acm
->iocount
.dcd
;
985 icount
->frame
= acm
->iocount
.frame
;
986 icount
->overrun
= acm
->iocount
.overrun
;
987 icount
->parity
= acm
->iocount
.parity
;
988 icount
->brk
= acm
->iocount
.brk
;
993 static int acm_tty_ioctl(struct tty_struct
*tty
,
994 unsigned int cmd
, unsigned long arg
)
996 struct acm
*acm
= tty
->driver_data
;
997 int rv
= -ENOIOCTLCMD
;
1001 rv
= usb_autopm_get_interface(acm
->control
);
1006 rv
= wait_serial_change(acm
, arg
);
1007 usb_autopm_put_interface(acm
->control
);
1014 static void acm_tty_set_termios(struct tty_struct
*tty
,
1015 struct ktermios
*termios_old
)
1017 struct acm
*acm
= tty
->driver_data
;
1018 struct ktermios
*termios
= &tty
->termios
;
1019 struct usb_cdc_line_coding newline
;
1020 int newctrl
= acm
->ctrlout
;
1022 newline
.dwDTERate
= cpu_to_le32(tty_get_baud_rate(tty
));
1023 newline
.bCharFormat
= termios
->c_cflag
& CSTOPB
? 2 : 0;
1024 newline
.bParityType
= termios
->c_cflag
& PARENB
?
1025 (termios
->c_cflag
& PARODD
? 1 : 2) +
1026 (termios
->c_cflag
& CMSPAR
? 2 : 0) : 0;
1027 switch (termios
->c_cflag
& CSIZE
) {
1029 newline
.bDataBits
= 5;
1032 newline
.bDataBits
= 6;
1035 newline
.bDataBits
= 7;
1039 newline
.bDataBits
= 8;
1042 /* FIXME: Needs to clear unsupported bits in the termios */
1043 acm
->clocal
= ((termios
->c_cflag
& CLOCAL
) != 0);
1045 if (C_BAUD(tty
) == B0
) {
1046 newline
.dwDTERate
= acm
->line
.dwDTERate
;
1047 newctrl
&= ~ACM_CTRL_DTR
;
1048 } else if (termios_old
&& (termios_old
->c_cflag
& CBAUD
) == B0
) {
1049 newctrl
|= ACM_CTRL_DTR
;
1052 if (newctrl
!= acm
->ctrlout
)
1053 acm_set_control(acm
, acm
->ctrlout
= newctrl
);
1055 if (memcmp(&acm
->line
, &newline
, sizeof newline
)) {
1056 memcpy(&acm
->line
, &newline
, sizeof newline
);
1057 dev_dbg(&acm
->control
->dev
, "%s - set line: %d %d %d %d\n",
1059 le32_to_cpu(newline
.dwDTERate
),
1060 newline
.bCharFormat
, newline
.bParityType
,
1062 acm_set_line(acm
, &acm
->line
);
1066 static const struct tty_port_operations acm_port_ops
= {
1067 .dtr_rts
= acm_port_dtr_rts
,
1068 .shutdown
= acm_port_shutdown
,
1069 .activate
= acm_port_activate
,
1070 .destruct
= acm_port_destruct
,
1074 * USB probe and disconnect routines.
1077 /* Little helpers: write/read buffers free */
1078 static void acm_write_buffers_free(struct acm
*acm
)
1083 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++)
1084 usb_free_coherent(acm
->dev
, acm
->writesize
, wb
->buf
, wb
->dmah
);
1087 static void acm_read_buffers_free(struct acm
*acm
)
1091 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1092 usb_free_coherent(acm
->dev
, acm
->readsize
,
1093 acm
->read_buffers
[i
].base
, acm
->read_buffers
[i
].dma
);
1096 /* Little helper: write buffers allocate */
1097 static int acm_write_buffers_alloc(struct acm
*acm
)
1102 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++) {
1103 wb
->buf
= usb_alloc_coherent(acm
->dev
, acm
->writesize
, GFP_KERNEL
,
1109 usb_free_coherent(acm
->dev
, acm
->writesize
,
1118 static int acm_probe(struct usb_interface
*intf
,
1119 const struct usb_device_id
*id
)
1121 struct usb_cdc_union_desc
*union_header
= NULL
;
1122 struct usb_cdc_call_mgmt_descriptor
*cmgmd
= NULL
;
1123 unsigned char *buffer
= intf
->altsetting
->extra
;
1124 int buflen
= intf
->altsetting
->extralen
;
1125 struct usb_interface
*control_interface
;
1126 struct usb_interface
*data_interface
;
1127 struct usb_endpoint_descriptor
*epctrl
= NULL
;
1128 struct usb_endpoint_descriptor
*epread
= NULL
;
1129 struct usb_endpoint_descriptor
*epwrite
= NULL
;
1130 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1131 struct usb_cdc_parsed_header h
;
1134 int ctrlsize
, readsize
;
1136 int call_intf_num
= -1;
1137 int data_intf_num
= -1;
1138 unsigned long quirks
;
1141 int combined_interfaces
= 0;
1142 struct device
*tty_dev
;
1147 quirks
= (unsigned long)id
->driver_info
;
1149 if (quirks
== IGNORE_DEVICE
)
1152 memset(&h
, 0x00, sizeof(struct usb_cdc_parsed_header
));
1154 num_rx_buf
= (quirks
== SINGLE_RX_URB
) ? 1 : ACM_NR
;
1156 /* handle quirks deadly to normal probing*/
1157 if (quirks
== NO_UNION_NORMAL
) {
1158 data_interface
= usb_ifnum_to_if(usb_dev
, 1);
1159 control_interface
= usb_ifnum_to_if(usb_dev
, 0);
1160 /* we would crash */
1161 if (!data_interface
|| !control_interface
)
1163 goto skip_normal_probe
;
1168 dev_err(&intf
->dev
, "Weird descriptor references\n");
1172 if (!intf
->cur_altsetting
)
1176 if (intf
->cur_altsetting
->endpoint
&&
1177 intf
->cur_altsetting
->endpoint
->extralen
&&
1178 intf
->cur_altsetting
->endpoint
->extra
) {
1180 "Seeking extra descriptors on endpoint\n");
1181 buflen
= intf
->cur_altsetting
->endpoint
->extralen
;
1182 buffer
= intf
->cur_altsetting
->endpoint
->extra
;
1185 "Zero length descriptor references\n");
1190 cdc_parse_cdc_header(&h
, intf
, buffer
, buflen
);
1191 union_header
= h
.usb_cdc_union_desc
;
1192 cmgmd
= h
.usb_cdc_call_mgmt_descriptor
;
1194 call_intf_num
= cmgmd
->bDataInterface
;
1196 if (!union_header
) {
1197 if (call_intf_num
> 0) {
1198 dev_dbg(&intf
->dev
, "No union descriptor, using call management descriptor\n");
1199 /* quirks for Droids MuIn LCD */
1200 if (quirks
& NO_DATA_INTERFACE
) {
1201 data_interface
= usb_ifnum_to_if(usb_dev
, 0);
1203 data_intf_num
= call_intf_num
;
1204 data_interface
= usb_ifnum_to_if(usb_dev
, data_intf_num
);
1206 control_interface
= intf
;
1208 if (intf
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1209 dev_dbg(&intf
->dev
,"No union descriptor, giving up\n");
1212 dev_warn(&intf
->dev
,"No union descriptor, testing for castrated device\n");
1213 combined_interfaces
= 1;
1214 control_interface
= data_interface
= intf
;
1215 goto look_for_collapsed_interface
;
1219 data_intf_num
= union_header
->bSlaveInterface0
;
1220 control_interface
= usb_ifnum_to_if(usb_dev
, union_header
->bMasterInterface0
);
1221 data_interface
= usb_ifnum_to_if(usb_dev
, data_intf_num
);
1224 if (!control_interface
|| !data_interface
) {
1225 dev_dbg(&intf
->dev
, "no interfaces\n");
1228 if (!data_interface
->cur_altsetting
|| !control_interface
->cur_altsetting
)
1231 if (data_intf_num
!= call_intf_num
)
1232 dev_dbg(&intf
->dev
, "Separate call control interface. That is not fully supported.\n");
1234 if (control_interface
== data_interface
) {
1235 /* some broken devices designed for windows work this way */
1236 dev_warn(&intf
->dev
,"Control and data interfaces are not separated!\n");
1237 combined_interfaces
= 1;
1238 /* a popular other OS doesn't use it */
1239 quirks
|= NO_CAP_LINE
;
1240 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1241 dev_err(&intf
->dev
, "This needs exactly 3 endpoints\n");
1244 look_for_collapsed_interface
:
1245 res
= usb_find_common_endpoints(data_interface
->cur_altsetting
,
1246 &epread
, &epwrite
, &epctrl
, NULL
);
1250 goto made_compressed_probe
;
1255 /*workaround for switched interfaces */
1256 if (data_interface
->cur_altsetting
->desc
.bInterfaceClass
1257 != CDC_DATA_INTERFACE_TYPE
) {
1258 if (control_interface
->cur_altsetting
->desc
.bInterfaceClass
1259 == CDC_DATA_INTERFACE_TYPE
) {
1261 "Your device has switched interfaces.\n");
1262 swap(control_interface
, data_interface
);
1268 /* Accept probe requests only for the control interface */
1269 if (!combined_interfaces
&& intf
!= control_interface
)
1272 if (!combined_interfaces
&& usb_interface_claimed(data_interface
)) {
1273 /* valid in this context */
1274 dev_dbg(&intf
->dev
, "The data interface isn't available\n");
1279 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
< 2 ||
1280 control_interface
->cur_altsetting
->desc
.bNumEndpoints
== 0)
1283 epctrl
= &control_interface
->cur_altsetting
->endpoint
[0].desc
;
1284 epread
= &data_interface
->cur_altsetting
->endpoint
[0].desc
;
1285 epwrite
= &data_interface
->cur_altsetting
->endpoint
[1].desc
;
1288 /* workaround for switched endpoints */
1289 if (!usb_endpoint_dir_in(epread
)) {
1290 /* descriptors are swapped */
1292 "The data interface has switched endpoints\n");
1293 swap(epread
, epwrite
);
1295 made_compressed_probe
:
1296 dev_dbg(&intf
->dev
, "interfaces are valid\n");
1298 acm
= kzalloc(sizeof(struct acm
), GFP_KERNEL
);
1302 tty_port_init(&acm
->port
);
1303 acm
->port
.ops
= &acm_port_ops
;
1305 minor
= acm_alloc_minor(acm
);
1309 ctrlsize
= usb_endpoint_maxp(epctrl
);
1310 readsize
= usb_endpoint_maxp(epread
) *
1311 (quirks
== SINGLE_RX_URB
? 1 : 2);
1312 acm
->combined_interfaces
= combined_interfaces
;
1313 acm
->writesize
= usb_endpoint_maxp(epwrite
) * 20;
1314 acm
->control
= control_interface
;
1315 acm
->data
= data_interface
;
1318 if (h
.usb_cdc_acm_descriptor
)
1319 acm
->ctrl_caps
= h
.usb_cdc_acm_descriptor
->bmCapabilities
;
1320 if (quirks
& NO_CAP_LINE
)
1321 acm
->ctrl_caps
&= ~USB_CDC_CAP_LINE
;
1322 acm
->ctrlsize
= ctrlsize
;
1323 acm
->readsize
= readsize
;
1324 acm
->rx_buflimit
= num_rx_buf
;
1325 INIT_WORK(&acm
->work
, acm_softint
);
1326 init_waitqueue_head(&acm
->wioctl
);
1327 spin_lock_init(&acm
->write_lock
);
1328 spin_lock_init(&acm
->read_lock
);
1329 mutex_init(&acm
->mutex
);
1330 if (usb_endpoint_xfer_int(epread
)) {
1331 acm
->bInterval
= epread
->bInterval
;
1332 acm
->in
= usb_rcvintpipe(usb_dev
, epread
->bEndpointAddress
);
1334 acm
->in
= usb_rcvbulkpipe(usb_dev
, epread
->bEndpointAddress
);
1336 if (usb_endpoint_xfer_int(epwrite
))
1337 acm
->out
= usb_sndintpipe(usb_dev
, epwrite
->bEndpointAddress
);
1339 acm
->out
= usb_sndbulkpipe(usb_dev
, epwrite
->bEndpointAddress
);
1340 init_usb_anchor(&acm
->delayed
);
1341 acm
->quirks
= quirks
;
1343 buf
= usb_alloc_coherent(usb_dev
, ctrlsize
, GFP_KERNEL
, &acm
->ctrl_dma
);
1346 acm
->ctrl_buffer
= buf
;
1348 if (acm_write_buffers_alloc(acm
) < 0)
1351 acm
->ctrlurb
= usb_alloc_urb(0, GFP_KERNEL
);
1355 for (i
= 0; i
< num_rx_buf
; i
++) {
1356 struct acm_rb
*rb
= &(acm
->read_buffers
[i
]);
1359 rb
->base
= usb_alloc_coherent(acm
->dev
, readsize
, GFP_KERNEL
,
1366 urb
= usb_alloc_urb(0, GFP_KERNEL
);
1370 urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1371 urb
->transfer_dma
= rb
->dma
;
1372 if (usb_endpoint_xfer_int(epread
))
1373 usb_fill_int_urb(urb
, acm
->dev
, acm
->in
, rb
->base
,
1375 acm_read_bulk_callback
, rb
,
1378 usb_fill_bulk_urb(urb
, acm
->dev
, acm
->in
, rb
->base
,
1380 acm_read_bulk_callback
, rb
);
1382 acm
->read_urbs
[i
] = urb
;
1383 __set_bit(i
, &acm
->read_urbs_free
);
1385 for (i
= 0; i
< ACM_NW
; i
++) {
1386 struct acm_wb
*snd
= &(acm
->wb
[i
]);
1388 snd
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1389 if (snd
->urb
== NULL
)
1392 if (usb_endpoint_xfer_int(epwrite
))
1393 usb_fill_int_urb(snd
->urb
, usb_dev
, acm
->out
,
1394 NULL
, acm
->writesize
, acm_write_bulk
, snd
, epwrite
->bInterval
);
1396 usb_fill_bulk_urb(snd
->urb
, usb_dev
, acm
->out
,
1397 NULL
, acm
->writesize
, acm_write_bulk
, snd
);
1398 snd
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1399 if (quirks
& SEND_ZERO_PACKET
)
1400 snd
->urb
->transfer_flags
|= URB_ZERO_PACKET
;
1401 snd
->instance
= acm
;
1404 usb_set_intfdata(intf
, acm
);
1406 i
= device_create_file(&intf
->dev
, &dev_attr_bmCapabilities
);
1410 if (h
.usb_cdc_country_functional_desc
) { /* export the country data */
1411 struct usb_cdc_country_functional_desc
* cfd
=
1412 h
.usb_cdc_country_functional_desc
;
1414 acm
->country_codes
= kmalloc(cfd
->bLength
- 4, GFP_KERNEL
);
1415 if (!acm
->country_codes
)
1416 goto skip_countries
;
1417 acm
->country_code_size
= cfd
->bLength
- 4;
1418 memcpy(acm
->country_codes
, (u8
*)&cfd
->wCountyCode0
,
1420 acm
->country_rel_date
= cfd
->iCountryCodeRelDate
;
1422 i
= device_create_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1424 kfree(acm
->country_codes
);
1425 acm
->country_codes
= NULL
;
1426 acm
->country_code_size
= 0;
1427 goto skip_countries
;
1430 i
= device_create_file(&intf
->dev
,
1431 &dev_attr_iCountryCodeRelDate
);
1433 device_remove_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1434 kfree(acm
->country_codes
);
1435 acm
->country_codes
= NULL
;
1436 acm
->country_code_size
= 0;
1437 goto skip_countries
;
1442 usb_fill_int_urb(acm
->ctrlurb
, usb_dev
,
1443 usb_rcvintpipe(usb_dev
, epctrl
->bEndpointAddress
),
1444 acm
->ctrl_buffer
, ctrlsize
, acm_ctrl_irq
, acm
,
1445 /* works around buggy devices */
1446 epctrl
->bInterval
? epctrl
->bInterval
: 16);
1447 acm
->ctrlurb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1448 acm
->ctrlurb
->transfer_dma
= acm
->ctrl_dma
;
1449 acm
->notification_buffer
= NULL
;
1453 dev_info(&intf
->dev
, "ttyACM%d: USB ACM device\n", minor
);
1455 acm
->line
.dwDTERate
= cpu_to_le32(9600);
1456 acm
->line
.bDataBits
= 8;
1457 acm_set_line(acm
, &acm
->line
);
1459 usb_driver_claim_interface(&acm_driver
, data_interface
, acm
);
1460 usb_set_intfdata(data_interface
, acm
);
1462 usb_get_intf(control_interface
);
1463 tty_dev
= tty_port_register_device(&acm
->port
, acm_tty_driver
, minor
,
1464 &control_interface
->dev
);
1465 if (IS_ERR(tty_dev
)) {
1466 rv
= PTR_ERR(tty_dev
);
1470 if (quirks
& CLEAR_HALT_CONDITIONS
) {
1471 usb_clear_halt(usb_dev
, acm
->in
);
1472 usb_clear_halt(usb_dev
, acm
->out
);
1477 if (acm
->country_codes
) {
1478 device_remove_file(&acm
->control
->dev
,
1479 &dev_attr_wCountryCodes
);
1480 device_remove_file(&acm
->control
->dev
,
1481 &dev_attr_iCountryCodeRelDate
);
1482 kfree(acm
->country_codes
);
1484 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1486 usb_set_intfdata(intf
, NULL
);
1487 for (i
= 0; i
< ACM_NW
; i
++)
1488 usb_free_urb(acm
->wb
[i
].urb
);
1490 for (i
= 0; i
< num_rx_buf
; i
++)
1491 usb_free_urb(acm
->read_urbs
[i
]);
1492 acm_read_buffers_free(acm
);
1493 usb_free_urb(acm
->ctrlurb
);
1495 acm_write_buffers_free(acm
);
1497 usb_free_coherent(usb_dev
, ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1499 tty_port_put(&acm
->port
);
1504 static void acm_disconnect(struct usb_interface
*intf
)
1506 struct acm
*acm
= usb_get_intfdata(intf
);
1507 struct tty_struct
*tty
;
1510 /* sibling interface is already cleaning up */
1514 mutex_lock(&acm
->mutex
);
1515 acm
->disconnected
= true;
1516 if (acm
->country_codes
) {
1517 device_remove_file(&acm
->control
->dev
,
1518 &dev_attr_wCountryCodes
);
1519 device_remove_file(&acm
->control
->dev
,
1520 &dev_attr_iCountryCodeRelDate
);
1522 wake_up_all(&acm
->wioctl
);
1523 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1524 usb_set_intfdata(acm
->control
, NULL
);
1525 usb_set_intfdata(acm
->data
, NULL
);
1526 mutex_unlock(&acm
->mutex
);
1528 tty
= tty_port_tty_get(&acm
->port
);
1535 cancel_work_sync(&acm
->work
);
1537 tty_unregister_device(acm_tty_driver
, acm
->minor
);
1539 usb_free_urb(acm
->ctrlurb
);
1540 for (i
= 0; i
< ACM_NW
; i
++)
1541 usb_free_urb(acm
->wb
[i
].urb
);
1542 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1543 usb_free_urb(acm
->read_urbs
[i
]);
1544 acm_write_buffers_free(acm
);
1545 usb_free_coherent(acm
->dev
, acm
->ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1546 acm_read_buffers_free(acm
);
1548 kfree(acm
->notification_buffer
);
1550 if (!acm
->combined_interfaces
)
1551 usb_driver_release_interface(&acm_driver
, intf
== acm
->control
?
1552 acm
->data
: acm
->control
);
1554 tty_port_put(&acm
->port
);
1558 static int acm_suspend(struct usb_interface
*intf
, pm_message_t message
)
1560 struct acm
*acm
= usb_get_intfdata(intf
);
1563 spin_lock_irq(&acm
->write_lock
);
1564 if (PMSG_IS_AUTO(message
)) {
1565 if (acm
->transmitting
) {
1566 spin_unlock_irq(&acm
->write_lock
);
1570 cnt
= acm
->susp_count
++;
1571 spin_unlock_irq(&acm
->write_lock
);
1577 cancel_work_sync(&acm
->work
);
1582 static int acm_resume(struct usb_interface
*intf
)
1584 struct acm
*acm
= usb_get_intfdata(intf
);
1588 spin_lock_irq(&acm
->write_lock
);
1590 if (--acm
->susp_count
)
1593 if (tty_port_initialized(&acm
->port
)) {
1594 rv
= usb_submit_urb(acm
->ctrlurb
, GFP_ATOMIC
);
1597 urb
= usb_get_from_anchor(&acm
->delayed
);
1601 acm_start_wb(acm
, urb
->context
);
1605 * delayed error checking because we must
1606 * do the write path at all cost
1611 rv
= acm_submit_read_urbs(acm
, GFP_ATOMIC
);
1614 spin_unlock_irq(&acm
->write_lock
);
1619 static int acm_reset_resume(struct usb_interface
*intf
)
1621 struct acm
*acm
= usb_get_intfdata(intf
);
1623 if (tty_port_initialized(&acm
->port
))
1624 tty_port_tty_hangup(&acm
->port
, false);
1626 return acm_resume(intf
);
1629 #endif /* CONFIG_PM */
1631 static int acm_pre_reset(struct usb_interface
*intf
)
1633 struct acm
*acm
= usb_get_intfdata(intf
);
1635 clear_bit(EVENT_RX_STALL
, &acm
->flags
);
1636 acm
->nb_index
= 0; /* pending control transfers are lost */
1641 #define NOKIA_PCSUITE_ACM_INFO(x) \
1642 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1643 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1644 USB_CDC_ACM_PROTO_VENDOR)
1646 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1647 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1648 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1649 USB_CDC_ACM_PROTO_VENDOR)
1652 * USB driver structure.
1655 static const struct usb_device_id acm_ids
[] = {
1656 /* quirky and broken devices */
1657 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1658 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1659 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1660 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1661 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1662 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1664 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1665 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1667 { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1668 .driver_info
= DISABLE_ECHO
, /* DISABLE ECHO in termios flag */
1670 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1671 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1673 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1674 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1676 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1677 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1679 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1680 .driver_info
= SINGLE_RX_URB
,
1682 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1683 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1685 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1686 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1688 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1689 .driver_info
= SINGLE_RX_URB
,
1691 { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1692 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1694 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1695 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1697 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1698 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1700 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1701 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1703 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1704 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1706 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1707 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1709 { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1710 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1712 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1713 .driver_info
= QUIRK_CONTROL_LINE_STATE
, },
1714 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1715 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1716 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1718 /* Motorola H24 HSPA module: */
1719 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1720 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1721 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1723 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1724 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1726 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1727 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1729 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1730 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1732 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1733 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1735 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1736 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1738 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1739 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1742 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1743 .driver_info
= NO_UNION_NORMAL
, /* union descriptor misplaced on
1744 data interface instead of
1745 communications interface.
1746 Maybe we should define a new
1749 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1750 .driver_info
= NO_UNION_NORMAL
,
1752 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1753 .driver_info
= NO_UNION_NORMAL
,
1755 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1756 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1758 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1759 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1761 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1762 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1764 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1765 .driver_info
= NO_UNION_NORMAL
, /* has misplaced union descriptor */
1767 { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1768 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1771 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1772 .driver_info
= CLEAR_HALT_CONDITIONS
,
1775 /* Nokia S60 phones expose two ACM channels. The first is
1776 * a modem and is picked up by the standard AT-command
1777 * information below. The second is 'vendor-specific' but
1778 * is treated as a serial device at the S60 end, so we want
1779 * to expose it on Linux too. */
1780 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1781 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1782 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1783 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1784 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1785 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1786 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1787 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1788 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1789 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1790 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1791 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1792 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1793 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1794 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1795 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1796 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1797 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1798 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1799 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1800 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1801 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1802 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1803 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1804 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1805 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1806 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1807 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1808 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1809 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1810 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1811 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1812 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1813 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1814 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1815 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1816 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1817 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1818 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1819 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1820 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1821 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1822 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1823 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1824 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1825 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1826 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1827 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1828 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1829 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1830 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1831 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1832 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1833 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1834 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1835 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1836 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1837 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1839 /* Support for Owen devices */
1840 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1842 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1844 /* Support for Droids MuIn LCD */
1845 { USB_DEVICE(0x04d8, 0x000b),
1846 .driver_info
= NO_DATA_INTERFACE
,
1849 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1850 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1851 .driver_info
= IGNORE_DEVICE
,
1853 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1854 .driver_info
= IGNORE_DEVICE
,
1858 /*Samsung phone in firmware update mode */
1859 { USB_DEVICE(0x04e8, 0x685d),
1860 .driver_info
= IGNORE_DEVICE
,
1863 /* Exclude Infineon Flash Loader utility */
1864 { USB_DEVICE(0x058b, 0x0041),
1865 .driver_info
= IGNORE_DEVICE
,
1868 { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1869 .driver_info
= SEND_ZERO_PACKET
,
1871 { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1872 .driver_info
= SEND_ZERO_PACKET
,
1875 /* control interfaces without any protocol set */
1876 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1877 USB_CDC_PROTO_NONE
) },
1879 /* control interfaces with various AT-command sets */
1880 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1881 USB_CDC_ACM_PROTO_AT_V25TER
) },
1882 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1883 USB_CDC_ACM_PROTO_AT_PCCA101
) },
1884 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1885 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE
) },
1886 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1887 USB_CDC_ACM_PROTO_AT_GSM
) },
1888 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1889 USB_CDC_ACM_PROTO_AT_3G
) },
1890 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1891 USB_CDC_ACM_PROTO_AT_CDMA
) },
1893 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1894 .driver_info
= SEND_ZERO_PACKET
,
1900 MODULE_DEVICE_TABLE(usb
, acm_ids
);
1902 static struct usb_driver acm_driver
= {
1905 .disconnect
= acm_disconnect
,
1907 .suspend
= acm_suspend
,
1908 .resume
= acm_resume
,
1909 .reset_resume
= acm_reset_resume
,
1911 .pre_reset
= acm_pre_reset
,
1912 .id_table
= acm_ids
,
1914 .supports_autosuspend
= 1,
1916 .disable_hub_initiated_lpm
= 1,
1920 * TTY driver structures.
1923 static const struct tty_operations acm_ops
= {
1924 .install
= acm_tty_install
,
1925 .open
= acm_tty_open
,
1926 .close
= acm_tty_close
,
1927 .cleanup
= acm_tty_cleanup
,
1928 .hangup
= acm_tty_hangup
,
1929 .write
= acm_tty_write
,
1930 .write_room
= acm_tty_write_room
,
1931 .ioctl
= acm_tty_ioctl
,
1932 .throttle
= acm_tty_throttle
,
1933 .unthrottle
= acm_tty_unthrottle
,
1934 .chars_in_buffer
= acm_tty_chars_in_buffer
,
1935 .break_ctl
= acm_tty_break_ctl
,
1936 .set_termios
= acm_tty_set_termios
,
1937 .tiocmget
= acm_tty_tiocmget
,
1938 .tiocmset
= acm_tty_tiocmset
,
1939 .get_serial
= get_serial_info
,
1940 .set_serial
= set_serial_info
,
1941 .get_icount
= acm_tty_get_icount
,
1948 static int __init
acm_init(void)
1951 acm_tty_driver
= alloc_tty_driver(ACM_TTY_MINORS
);
1952 if (!acm_tty_driver
)
1954 acm_tty_driver
->driver_name
= "acm",
1955 acm_tty_driver
->name
= "ttyACM",
1956 acm_tty_driver
->major
= ACM_TTY_MAJOR
,
1957 acm_tty_driver
->minor_start
= 0,
1958 acm_tty_driver
->type
= TTY_DRIVER_TYPE_SERIAL
,
1959 acm_tty_driver
->subtype
= SERIAL_TYPE_NORMAL
,
1960 acm_tty_driver
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
1961 acm_tty_driver
->init_termios
= tty_std_termios
;
1962 acm_tty_driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
|
1964 tty_set_operations(acm_tty_driver
, &acm_ops
);
1966 retval
= tty_register_driver(acm_tty_driver
);
1968 put_tty_driver(acm_tty_driver
);
1972 retval
= usb_register(&acm_driver
);
1974 tty_unregister_driver(acm_tty_driver
);
1975 put_tty_driver(acm_tty_driver
);
1979 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1984 static void __exit
acm_exit(void)
1986 usb_deregister(&acm_driver
);
1987 tty_unregister_driver(acm_tty_driver
);
1988 put_tty_driver(acm_tty_driver
);
1989 idr_destroy(&acm_minors
);
1992 module_init(acm_init
);
1993 module_exit(acm_exit
);
1995 MODULE_AUTHOR(DRIVER_AUTHOR
);
1996 MODULE_DESCRIPTION(DRIVER_DESC
);
1997 MODULE_LICENSE("GPL");
1998 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR
);