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
)
179 wbn
= (wbn
+ 1) % ACM_NW
;
185 static int acm_wb_is_avail(struct acm
*acm
)
191 spin_lock_irqsave(&acm
->write_lock
, flags
);
192 for (i
= 0; i
< ACM_NW
; i
++)
194 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
199 * Finish write. Caller must hold acm->write_lock
201 static void acm_write_done(struct acm
*acm
, struct acm_wb
*wb
)
205 usb_autopm_put_interface_async(acm
->control
);
211 * the caller is responsible for locking
214 static int acm_start_wb(struct acm
*acm
, struct acm_wb
*wb
)
220 wb
->urb
->transfer_buffer
= wb
->buf
;
221 wb
->urb
->transfer_dma
= wb
->dmah
;
222 wb
->urb
->transfer_buffer_length
= wb
->len
;
223 wb
->urb
->dev
= acm
->dev
;
225 rc
= usb_submit_urb(wb
->urb
, GFP_ATOMIC
);
227 dev_err(&acm
->data
->dev
,
228 "%s - usb_submit_urb(write bulk) failed: %d\n",
230 acm_write_done(acm
, wb
);
236 * attributes exported through sysfs
238 static ssize_t bmCapabilities_show
239 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
241 struct usb_interface
*intf
= to_usb_interface(dev
);
242 struct acm
*acm
= usb_get_intfdata(intf
);
244 return sprintf(buf
, "%d", acm
->ctrl_caps
);
246 static DEVICE_ATTR_RO(bmCapabilities
);
248 static ssize_t wCountryCodes_show
249 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
251 struct usb_interface
*intf
= to_usb_interface(dev
);
252 struct acm
*acm
= usb_get_intfdata(intf
);
254 memcpy(buf
, acm
->country_codes
, acm
->country_code_size
);
255 return acm
->country_code_size
;
258 static DEVICE_ATTR_RO(wCountryCodes
);
260 static ssize_t iCountryCodeRelDate_show
261 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
263 struct usb_interface
*intf
= to_usb_interface(dev
);
264 struct acm
*acm
= usb_get_intfdata(intf
);
266 return sprintf(buf
, "%d", acm
->country_rel_date
);
269 static DEVICE_ATTR_RO(iCountryCodeRelDate
);
271 * Interrupt handlers for various ACM device responses
274 static void acm_process_notification(struct acm
*acm
, unsigned char *buf
)
278 struct usb_cdc_notification
*dr
= (struct usb_cdc_notification
*)buf
;
279 unsigned char *data
= buf
+ sizeof(struct usb_cdc_notification
);
281 switch (dr
->bNotificationType
) {
282 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
283 dev_dbg(&acm
->control
->dev
,
284 "%s - network connection: %d\n", __func__
, dr
->wValue
);
287 case USB_CDC_NOTIFY_SERIAL_STATE
:
288 if (le16_to_cpu(dr
->wLength
) != 2) {
289 dev_dbg(&acm
->control
->dev
,
290 "%s - malformed serial state\n", __func__
);
294 newctrl
= get_unaligned_le16(data
);
295 dev_dbg(&acm
->control
->dev
,
296 "%s - serial state: 0x%x\n", __func__
, newctrl
);
298 if (!acm
->clocal
&& (acm
->ctrlin
& ~newctrl
& ACM_CTRL_DCD
)) {
299 dev_dbg(&acm
->control
->dev
,
300 "%s - calling hangup\n", __func__
);
301 tty_port_tty_hangup(&acm
->port
, false);
304 difference
= acm
->ctrlin
^ newctrl
;
305 spin_lock(&acm
->read_lock
);
306 acm
->ctrlin
= newctrl
;
307 acm
->oldcount
= acm
->iocount
;
309 if (difference
& ACM_CTRL_DSR
)
311 if (difference
& ACM_CTRL_BRK
)
313 if (difference
& ACM_CTRL_RI
)
315 if (difference
& ACM_CTRL_DCD
)
317 if (difference
& ACM_CTRL_FRAMING
)
318 acm
->iocount
.frame
++;
319 if (difference
& ACM_CTRL_PARITY
)
320 acm
->iocount
.parity
++;
321 if (difference
& ACM_CTRL_OVERRUN
)
322 acm
->iocount
.overrun
++;
323 spin_unlock(&acm
->read_lock
);
326 wake_up_all(&acm
->wioctl
);
331 dev_dbg(&acm
->control
->dev
,
332 "%s - unknown notification %d received: index %d len %d\n",
334 dr
->bNotificationType
, dr
->wIndex
, dr
->wLength
);
338 /* control interface reports status changes with "interrupt" transfers */
339 static void acm_ctrl_irq(struct urb
*urb
)
341 struct acm
*acm
= urb
->context
;
342 struct usb_cdc_notification
*dr
= urb
->transfer_buffer
;
343 unsigned int current_size
= urb
->actual_length
;
344 unsigned int expected_size
, copy_size
, alloc_size
;
346 int status
= urb
->status
;
355 /* this urb is terminated, clean up */
357 dev_dbg(&acm
->control
->dev
,
358 "%s - urb shutting down with status: %d\n",
362 dev_dbg(&acm
->control
->dev
,
363 "%s - nonzero urb status received: %d\n",
368 usb_mark_last_busy(acm
->dev
);
371 dr
= (struct usb_cdc_notification
*)acm
->notification_buffer
;
373 /* size = notification-header + (optional) data */
374 expected_size
= sizeof(struct usb_cdc_notification
) +
375 le16_to_cpu(dr
->wLength
);
377 if (current_size
< expected_size
) {
378 /* notification is transmitted fragmented, reassemble */
379 if (acm
->nb_size
< expected_size
) {
381 kfree(acm
->notification_buffer
);
384 alloc_size
= roundup_pow_of_two(expected_size
);
386 * kmalloc ensures a valid notification_buffer after a
387 * use of kfree in case the previous allocation was too
388 * small. Final freeing is done on disconnect.
390 acm
->notification_buffer
=
391 kmalloc(alloc_size
, GFP_ATOMIC
);
392 if (!acm
->notification_buffer
)
394 acm
->nb_size
= alloc_size
;
397 copy_size
= min(current_size
,
398 expected_size
- acm
->nb_index
);
400 memcpy(&acm
->notification_buffer
[acm
->nb_index
],
401 urb
->transfer_buffer
, copy_size
);
402 acm
->nb_index
+= copy_size
;
403 current_size
= acm
->nb_index
;
406 if (current_size
>= expected_size
) {
407 /* notification complete */
408 acm_process_notification(acm
, (unsigned char *)dr
);
413 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
414 if (retval
&& retval
!= -EPERM
)
415 dev_err(&acm
->control
->dev
,
416 "%s - usb_submit_urb failed: %d\n", __func__
, retval
);
419 static int acm_submit_read_urb(struct acm
*acm
, int index
, gfp_t mem_flags
)
423 if (!test_and_clear_bit(index
, &acm
->read_urbs_free
))
426 res
= usb_submit_urb(acm
->read_urbs
[index
], mem_flags
);
428 if (res
!= -EPERM
&& res
!= -ENODEV
) {
429 dev_err(&acm
->data
->dev
,
430 "urb %d failed submission with %d\n",
433 set_bit(index
, &acm
->read_urbs_free
);
436 dev_vdbg(&acm
->data
->dev
, "submitted urb %d\n", index
);
442 static int acm_submit_read_urbs(struct acm
*acm
, gfp_t mem_flags
)
447 for (i
= 0; i
< acm
->rx_buflimit
; ++i
) {
448 res
= acm_submit_read_urb(acm
, i
, mem_flags
);
456 static void acm_process_read_urb(struct acm
*acm
, struct urb
*urb
)
458 if (!urb
->actual_length
)
461 tty_insert_flip_string(&acm
->port
, urb
->transfer_buffer
,
463 tty_flip_buffer_push(&acm
->port
);
466 static void acm_read_bulk_callback(struct urb
*urb
)
468 struct acm_rb
*rb
= urb
->context
;
469 struct acm
*acm
= rb
->instance
;
471 int status
= urb
->status
;
473 dev_vdbg(&acm
->data
->dev
, "got urb %d, len %d, status %d\n",
474 rb
->index
, urb
->actual_length
, status
);
476 set_bit(rb
->index
, &acm
->read_urbs_free
);
479 dev_dbg(&acm
->data
->dev
, "%s - disconnected\n", __func__
);
485 usb_mark_last_busy(acm
->dev
);
486 acm_process_read_urb(acm
, urb
);
489 set_bit(EVENT_RX_STALL
, &acm
->flags
);
490 schedule_work(&acm
->work
);
495 dev_dbg(&acm
->data
->dev
,
496 "%s - urb shutting down with status: %d\n",
500 dev_dbg(&acm
->data
->dev
,
501 "%s - nonzero urb status received: %d\n",
507 * Unthrottle may run on another CPU which needs to see events
508 * in the same order. Submission has an implict barrier
510 smp_mb__before_atomic();
512 /* throttle device if requested by tty */
513 spin_lock_irqsave(&acm
->read_lock
, flags
);
514 acm
->throttled
= acm
->throttle_req
;
515 if (!acm
->throttled
) {
516 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
517 acm_submit_read_urb(acm
, rb
->index
, GFP_ATOMIC
);
519 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
523 /* data interface wrote those outgoing bytes */
524 static void acm_write_bulk(struct urb
*urb
)
526 struct acm_wb
*wb
= urb
->context
;
527 struct acm
*acm
= wb
->instance
;
529 int status
= urb
->status
;
531 if (status
|| (urb
->actual_length
!= urb
->transfer_buffer_length
))
532 dev_vdbg(&acm
->data
->dev
, "wrote len %d/%d, status %d\n",
534 urb
->transfer_buffer_length
,
537 spin_lock_irqsave(&acm
->write_lock
, flags
);
538 acm_write_done(acm
, wb
);
539 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
540 set_bit(EVENT_TTY_WAKEUP
, &acm
->flags
);
541 schedule_work(&acm
->work
);
544 static void acm_softint(struct work_struct
*work
)
547 struct acm
*acm
= container_of(work
, struct acm
, work
);
549 if (test_bit(EVENT_RX_STALL
, &acm
->flags
)) {
550 if (!(usb_autopm_get_interface(acm
->data
))) {
551 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
552 usb_kill_urb(acm
->read_urbs
[i
]);
553 usb_clear_halt(acm
->dev
, acm
->in
);
554 acm_submit_read_urbs(acm
, GFP_KERNEL
);
555 usb_autopm_put_interface(acm
->data
);
557 clear_bit(EVENT_RX_STALL
, &acm
->flags
);
560 if (test_bit(EVENT_TTY_WAKEUP
, &acm
->flags
)) {
561 tty_port_tty_wakeup(&acm
->port
);
562 clear_bit(EVENT_TTY_WAKEUP
, &acm
->flags
);
570 static int acm_tty_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
575 acm
= acm_get_by_minor(tty
->index
);
579 retval
= tty_standard_install(driver
, tty
);
581 goto error_init_termios
;
583 tty
->driver_data
= acm
;
588 tty_port_put(&acm
->port
);
592 static int acm_tty_open(struct tty_struct
*tty
, struct file
*filp
)
594 struct acm
*acm
= tty
->driver_data
;
596 return tty_port_open(&acm
->port
, tty
, filp
);
599 static void acm_port_dtr_rts(struct tty_port
*port
, int raise
)
601 struct acm
*acm
= container_of(port
, struct acm
, port
);
606 val
= ACM_CTRL_DTR
| ACM_CTRL_RTS
;
610 /* FIXME: add missing ctrlout locking throughout driver */
613 res
= acm_set_control(acm
, val
);
614 if (res
&& (acm
->ctrl_caps
& USB_CDC_CAP_LINE
))
615 dev_err(&acm
->control
->dev
, "failed to set dtr/rts\n");
618 static int acm_port_activate(struct tty_port
*port
, struct tty_struct
*tty
)
620 struct acm
*acm
= container_of(port
, struct acm
, port
);
621 int retval
= -ENODEV
;
624 mutex_lock(&acm
->mutex
);
625 if (acm
->disconnected
)
628 retval
= usb_autopm_get_interface(acm
->control
);
630 goto error_get_interface
;
633 * FIXME: Why do we need this? Allocating 64K of physically contiguous
634 * memory is really nasty...
636 set_bit(TTY_NO_WRITE_SPLIT
, &tty
->flags
);
637 acm
->control
->needs_remote_wakeup
= 1;
639 acm
->ctrlurb
->dev
= acm
->dev
;
640 retval
= usb_submit_urb(acm
->ctrlurb
, GFP_KERNEL
);
642 dev_err(&acm
->control
->dev
,
643 "%s - usb_submit_urb(ctrl irq) failed\n", __func__
);
644 goto error_submit_urb
;
647 acm_tty_set_termios(tty
, NULL
);
650 * Unthrottle device in case the TTY was closed while throttled.
652 spin_lock_irq(&acm
->read_lock
);
654 acm
->throttle_req
= 0;
655 spin_unlock_irq(&acm
->read_lock
);
657 retval
= acm_submit_read_urbs(acm
, GFP_KERNEL
);
659 goto error_submit_read_urbs
;
661 usb_autopm_put_interface(acm
->control
);
663 mutex_unlock(&acm
->mutex
);
667 error_submit_read_urbs
:
668 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
669 usb_kill_urb(acm
->read_urbs
[i
]);
670 usb_kill_urb(acm
->ctrlurb
);
672 usb_autopm_put_interface(acm
->control
);
675 mutex_unlock(&acm
->mutex
);
677 return usb_translate_errors(retval
);
680 static void acm_port_destruct(struct tty_port
*port
)
682 struct acm
*acm
= container_of(port
, struct acm
, port
);
684 acm_release_minor(acm
);
685 usb_put_intf(acm
->control
);
686 kfree(acm
->country_codes
);
690 static void acm_port_shutdown(struct tty_port
*port
)
692 struct acm
*acm
= container_of(port
, struct acm
, port
);
697 * Need to grab write_lock to prevent race with resume, but no need to
698 * hold it due to the tty-port initialised flag.
700 spin_lock_irq(&acm
->write_lock
);
701 spin_unlock_irq(&acm
->write_lock
);
703 usb_autopm_get_interface_no_resume(acm
->control
);
704 acm
->control
->needs_remote_wakeup
= 0;
705 usb_autopm_put_interface(acm
->control
);
708 urb
= usb_get_from_anchor(&acm
->delayed
);
713 usb_autopm_put_interface_async(acm
->control
);
719 static void acm_tty_cleanup(struct tty_struct
*tty
)
721 struct acm
*acm
= tty
->driver_data
;
723 tty_port_put(&acm
->port
);
726 static void acm_tty_hangup(struct tty_struct
*tty
)
728 struct acm
*acm
= tty
->driver_data
;
730 tty_port_hangup(&acm
->port
);
733 static void acm_tty_close(struct tty_struct
*tty
, struct file
*filp
)
735 struct acm
*acm
= tty
->driver_data
;
737 tty_port_close(&acm
->port
, tty
, filp
);
740 static int acm_tty_write(struct tty_struct
*tty
,
741 const unsigned char *buf
, int count
)
743 struct acm
*acm
= tty
->driver_data
;
752 dev_vdbg(&acm
->data
->dev
, "%d bytes from tty layer\n", count
);
754 spin_lock_irqsave(&acm
->write_lock
, flags
);
755 wbn
= acm_wb_alloc(acm
);
757 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
764 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
768 count
= (count
> acm
->writesize
) ? acm
->writesize
: count
;
769 dev_vdbg(&acm
->data
->dev
, "writing %d bytes\n", count
);
770 memcpy(wb
->buf
, buf
, count
);
773 stat
= usb_autopm_get_interface_async(acm
->control
);
776 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
780 if (acm
->susp_count
) {
781 if (acm
->putbuffer
) {
782 /* now to preserve order */
783 usb_anchor_urb(acm
->putbuffer
->urb
, &acm
->delayed
);
784 acm
->putbuffer
= NULL
;
786 usb_anchor_urb(wb
->urb
, &acm
->delayed
);
787 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
790 if (acm
->putbuffer
) {
791 /* at this point there is no good way to handle errors */
792 acm_start_wb(acm
, acm
->putbuffer
);
793 acm
->putbuffer
= NULL
;
797 stat
= acm_start_wb(acm
, wb
);
798 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
805 static void acm_tty_flush_chars(struct tty_struct
*tty
)
807 struct acm
*acm
= tty
->driver_data
;
808 struct acm_wb
*cur
= acm
->putbuffer
;
812 if (!cur
) /* nothing to do */
815 acm
->putbuffer
= NULL
;
816 err
= usb_autopm_get_interface_async(acm
->control
);
817 spin_lock_irqsave(&acm
->write_lock
, flags
);
820 acm
->putbuffer
= cur
;
825 usb_anchor_urb(cur
->urb
, &acm
->delayed
);
827 acm_start_wb(acm
, cur
);
829 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
833 static int acm_tty_put_char(struct tty_struct
*tty
, unsigned char ch
)
835 struct acm
*acm
= tty
->driver_data
;
841 cur
= acm
->putbuffer
;
843 spin_lock_irqsave(&acm
->write_lock
, flags
);
844 wbn
= acm_wb_alloc(acm
);
847 acm
->putbuffer
= cur
;
849 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
854 if (cur
->len
== acm
->writesize
) {
855 acm_tty_flush_chars(tty
);
859 cur
->buf
[cur
->len
++] = ch
;
863 static int acm_tty_write_room(struct tty_struct
*tty
)
865 struct acm
*acm
= tty
->driver_data
;
867 * Do not let the line discipline to know that we have a reserve,
868 * or it might get too enthusiastic.
870 return acm_wb_is_avail(acm
) ? acm
->writesize
: 0;
873 static int acm_tty_chars_in_buffer(struct tty_struct
*tty
)
875 struct acm
*acm
= tty
->driver_data
;
877 * if the device was unplugged then any remaining characters fell out
878 * of the connector ;)
880 if (acm
->disconnected
)
883 * This is inaccurate (overcounts), but it works.
885 return (ACM_NW
- acm_wb_is_avail(acm
)) * acm
->writesize
;
888 static void acm_tty_throttle(struct tty_struct
*tty
)
890 struct acm
*acm
= tty
->driver_data
;
892 spin_lock_irq(&acm
->read_lock
);
893 acm
->throttle_req
= 1;
894 spin_unlock_irq(&acm
->read_lock
);
897 static void acm_tty_unthrottle(struct tty_struct
*tty
)
899 struct acm
*acm
= tty
->driver_data
;
900 unsigned int was_throttled
;
902 spin_lock_irq(&acm
->read_lock
);
903 was_throttled
= acm
->throttled
;
905 acm
->throttle_req
= 0;
906 spin_unlock_irq(&acm
->read_lock
);
909 acm_submit_read_urbs(acm
, GFP_KERNEL
);
912 static int acm_tty_break_ctl(struct tty_struct
*tty
, int state
)
914 struct acm
*acm
= tty
->driver_data
;
917 retval
= acm_send_break(acm
, state
? 0xffff : 0);
919 dev_dbg(&acm
->control
->dev
,
920 "%s - send break failed\n", __func__
);
924 static int acm_tty_tiocmget(struct tty_struct
*tty
)
926 struct acm
*acm
= tty
->driver_data
;
928 return (acm
->ctrlout
& ACM_CTRL_DTR
? TIOCM_DTR
: 0) |
929 (acm
->ctrlout
& ACM_CTRL_RTS
? TIOCM_RTS
: 0) |
930 (acm
->ctrlin
& ACM_CTRL_DSR
? TIOCM_DSR
: 0) |
931 (acm
->ctrlin
& ACM_CTRL_RI
? TIOCM_RI
: 0) |
932 (acm
->ctrlin
& ACM_CTRL_DCD
? TIOCM_CD
: 0) |
936 static int acm_tty_tiocmset(struct tty_struct
*tty
,
937 unsigned int set
, unsigned int clear
)
939 struct acm
*acm
= tty
->driver_data
;
940 unsigned int newctrl
;
942 newctrl
= acm
->ctrlout
;
943 set
= (set
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
944 (set
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
945 clear
= (clear
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
946 (clear
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
948 newctrl
= (newctrl
& ~clear
) | set
;
950 if (acm
->ctrlout
== newctrl
)
952 return acm_set_control(acm
, acm
->ctrlout
= newctrl
);
955 static int get_serial_info(struct acm
*acm
, struct serial_struct __user
*info
)
957 struct serial_struct tmp
;
959 memset(&tmp
, 0, sizeof(tmp
));
960 tmp
.xmit_fifo_size
= acm
->writesize
;
961 tmp
.baud_base
= le32_to_cpu(acm
->line
.dwDTERate
);
962 tmp
.close_delay
= acm
->port
.close_delay
/ 10;
963 tmp
.closing_wait
= acm
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
964 ASYNC_CLOSING_WAIT_NONE
:
965 acm
->port
.closing_wait
/ 10;
967 if (copy_to_user(info
, &tmp
, sizeof(tmp
)))
973 static int set_serial_info(struct acm
*acm
,
974 struct serial_struct __user
*newinfo
)
976 struct serial_struct new_serial
;
977 unsigned int closing_wait
, close_delay
;
980 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
983 close_delay
= new_serial
.close_delay
* 10;
984 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
985 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
987 mutex_lock(&acm
->port
.mutex
);
989 if (!capable(CAP_SYS_ADMIN
)) {
990 if ((close_delay
!= acm
->port
.close_delay
) ||
991 (closing_wait
!= acm
->port
.closing_wait
))
994 retval
= -EOPNOTSUPP
;
996 acm
->port
.close_delay
= close_delay
;
997 acm
->port
.closing_wait
= closing_wait
;
1000 mutex_unlock(&acm
->port
.mutex
);
1004 static int wait_serial_change(struct acm
*acm
, unsigned long arg
)
1007 DECLARE_WAITQUEUE(wait
, current
);
1008 struct async_icount old
, new;
1011 spin_lock_irq(&acm
->read_lock
);
1012 old
= acm
->oldcount
;
1014 acm
->oldcount
= new;
1015 spin_unlock_irq(&acm
->read_lock
);
1017 if ((arg
& TIOCM_DSR
) &&
1020 if ((arg
& TIOCM_CD
) &&
1023 if ((arg
& TIOCM_RI
) &&
1027 add_wait_queue(&acm
->wioctl
, &wait
);
1028 set_current_state(TASK_INTERRUPTIBLE
);
1030 remove_wait_queue(&acm
->wioctl
, &wait
);
1031 if (acm
->disconnected
) {
1037 if (signal_pending(current
))
1047 static int acm_tty_get_icount(struct tty_struct
*tty
,
1048 struct serial_icounter_struct
*icount
)
1050 struct acm
*acm
= tty
->driver_data
;
1052 icount
->dsr
= acm
->iocount
.dsr
;
1053 icount
->rng
= acm
->iocount
.rng
;
1054 icount
->dcd
= acm
->iocount
.dcd
;
1055 icount
->frame
= acm
->iocount
.frame
;
1056 icount
->overrun
= acm
->iocount
.overrun
;
1057 icount
->parity
= acm
->iocount
.parity
;
1058 icount
->brk
= acm
->iocount
.brk
;
1063 static int acm_tty_ioctl(struct tty_struct
*tty
,
1064 unsigned int cmd
, unsigned long arg
)
1066 struct acm
*acm
= tty
->driver_data
;
1067 int rv
= -ENOIOCTLCMD
;
1070 case TIOCGSERIAL
: /* gets serial port data */
1071 rv
= get_serial_info(acm
, (struct serial_struct __user
*) arg
);
1074 rv
= set_serial_info(acm
, (struct serial_struct __user
*) arg
);
1077 rv
= usb_autopm_get_interface(acm
->control
);
1082 rv
= wait_serial_change(acm
, arg
);
1083 usb_autopm_put_interface(acm
->control
);
1090 static void acm_tty_set_termios(struct tty_struct
*tty
,
1091 struct ktermios
*termios_old
)
1093 struct acm
*acm
= tty
->driver_data
;
1094 struct ktermios
*termios
= &tty
->termios
;
1095 struct usb_cdc_line_coding newline
;
1096 int newctrl
= acm
->ctrlout
;
1098 newline
.dwDTERate
= cpu_to_le32(tty_get_baud_rate(tty
));
1099 newline
.bCharFormat
= termios
->c_cflag
& CSTOPB
? 2 : 0;
1100 newline
.bParityType
= termios
->c_cflag
& PARENB
?
1101 (termios
->c_cflag
& PARODD
? 1 : 2) +
1102 (termios
->c_cflag
& CMSPAR
? 2 : 0) : 0;
1103 switch (termios
->c_cflag
& CSIZE
) {
1105 newline
.bDataBits
= 5;
1108 newline
.bDataBits
= 6;
1111 newline
.bDataBits
= 7;
1115 newline
.bDataBits
= 8;
1118 /* FIXME: Needs to clear unsupported bits in the termios */
1119 acm
->clocal
= ((termios
->c_cflag
& CLOCAL
) != 0);
1121 if (C_BAUD(tty
) == B0
) {
1122 newline
.dwDTERate
= acm
->line
.dwDTERate
;
1123 newctrl
&= ~ACM_CTRL_DTR
;
1124 } else if (termios_old
&& (termios_old
->c_cflag
& CBAUD
) == B0
) {
1125 newctrl
|= ACM_CTRL_DTR
;
1128 if (newctrl
!= acm
->ctrlout
)
1129 acm_set_control(acm
, acm
->ctrlout
= newctrl
);
1131 if (memcmp(&acm
->line
, &newline
, sizeof newline
)) {
1132 memcpy(&acm
->line
, &newline
, sizeof newline
);
1133 dev_dbg(&acm
->control
->dev
, "%s - set line: %d %d %d %d\n",
1135 le32_to_cpu(newline
.dwDTERate
),
1136 newline
.bCharFormat
, newline
.bParityType
,
1138 acm_set_line(acm
, &acm
->line
);
1142 static const struct tty_port_operations acm_port_ops
= {
1143 .dtr_rts
= acm_port_dtr_rts
,
1144 .shutdown
= acm_port_shutdown
,
1145 .activate
= acm_port_activate
,
1146 .destruct
= acm_port_destruct
,
1150 * USB probe and disconnect routines.
1153 /* Little helpers: write/read buffers free */
1154 static void acm_write_buffers_free(struct acm
*acm
)
1159 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++)
1160 usb_free_coherent(acm
->dev
, acm
->writesize
, wb
->buf
, wb
->dmah
);
1163 static void acm_read_buffers_free(struct acm
*acm
)
1167 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1168 usb_free_coherent(acm
->dev
, acm
->readsize
,
1169 acm
->read_buffers
[i
].base
, acm
->read_buffers
[i
].dma
);
1172 /* Little helper: write buffers allocate */
1173 static int acm_write_buffers_alloc(struct acm
*acm
)
1178 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++) {
1179 wb
->buf
= usb_alloc_coherent(acm
->dev
, acm
->writesize
, GFP_KERNEL
,
1185 usb_free_coherent(acm
->dev
, acm
->writesize
,
1194 static int acm_probe(struct usb_interface
*intf
,
1195 const struct usb_device_id
*id
)
1197 struct usb_cdc_union_desc
*union_header
= NULL
;
1198 struct usb_cdc_call_mgmt_descriptor
*cmgmd
= NULL
;
1199 unsigned char *buffer
= intf
->altsetting
->extra
;
1200 int buflen
= intf
->altsetting
->extralen
;
1201 struct usb_interface
*control_interface
;
1202 struct usb_interface
*data_interface
;
1203 struct usb_endpoint_descriptor
*epctrl
= NULL
;
1204 struct usb_endpoint_descriptor
*epread
= NULL
;
1205 struct usb_endpoint_descriptor
*epwrite
= NULL
;
1206 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1207 struct usb_cdc_parsed_header h
;
1210 int ctrlsize
, readsize
;
1212 int call_intf_num
= -1;
1213 int data_intf_num
= -1;
1214 unsigned long quirks
;
1217 int combined_interfaces
= 0;
1218 struct device
*tty_dev
;
1223 quirks
= (unsigned long)id
->driver_info
;
1225 if (quirks
== IGNORE_DEVICE
)
1228 memset(&h
, 0x00, sizeof(struct usb_cdc_parsed_header
));
1230 num_rx_buf
= (quirks
== SINGLE_RX_URB
) ? 1 : ACM_NR
;
1232 /* handle quirks deadly to normal probing*/
1233 if (quirks
== NO_UNION_NORMAL
) {
1234 data_interface
= usb_ifnum_to_if(usb_dev
, 1);
1235 control_interface
= usb_ifnum_to_if(usb_dev
, 0);
1236 /* we would crash */
1237 if (!data_interface
|| !control_interface
)
1239 goto skip_normal_probe
;
1244 dev_err(&intf
->dev
, "Weird descriptor references\n");
1248 if (!intf
->cur_altsetting
)
1252 if (intf
->cur_altsetting
->endpoint
&&
1253 intf
->cur_altsetting
->endpoint
->extralen
&&
1254 intf
->cur_altsetting
->endpoint
->extra
) {
1256 "Seeking extra descriptors on endpoint\n");
1257 buflen
= intf
->cur_altsetting
->endpoint
->extralen
;
1258 buffer
= intf
->cur_altsetting
->endpoint
->extra
;
1261 "Zero length descriptor references\n");
1266 cdc_parse_cdc_header(&h
, intf
, buffer
, buflen
);
1267 union_header
= h
.usb_cdc_union_desc
;
1268 cmgmd
= h
.usb_cdc_call_mgmt_descriptor
;
1270 call_intf_num
= cmgmd
->bDataInterface
;
1272 if (!union_header
) {
1273 if (call_intf_num
> 0) {
1274 dev_dbg(&intf
->dev
, "No union descriptor, using call management descriptor\n");
1275 /* quirks for Droids MuIn LCD */
1276 if (quirks
& NO_DATA_INTERFACE
) {
1277 data_interface
= usb_ifnum_to_if(usb_dev
, 0);
1279 data_intf_num
= call_intf_num
;
1280 data_interface
= usb_ifnum_to_if(usb_dev
, data_intf_num
);
1282 control_interface
= intf
;
1284 if (intf
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1285 dev_dbg(&intf
->dev
,"No union descriptor, giving up\n");
1288 dev_warn(&intf
->dev
,"No union descriptor, testing for castrated device\n");
1289 combined_interfaces
= 1;
1290 control_interface
= data_interface
= intf
;
1291 goto look_for_collapsed_interface
;
1295 data_intf_num
= union_header
->bSlaveInterface0
;
1296 control_interface
= usb_ifnum_to_if(usb_dev
, union_header
->bMasterInterface0
);
1297 data_interface
= usb_ifnum_to_if(usb_dev
, data_intf_num
);
1300 if (!control_interface
|| !data_interface
) {
1301 dev_dbg(&intf
->dev
, "no interfaces\n");
1304 if (!data_interface
->cur_altsetting
|| !control_interface
->cur_altsetting
)
1307 if (data_intf_num
!= call_intf_num
)
1308 dev_dbg(&intf
->dev
, "Separate call control interface. That is not fully supported.\n");
1310 if (control_interface
== data_interface
) {
1311 /* some broken devices designed for windows work this way */
1312 dev_warn(&intf
->dev
,"Control and data interfaces are not separated!\n");
1313 combined_interfaces
= 1;
1314 /* a popular other OS doesn't use it */
1315 quirks
|= NO_CAP_LINE
;
1316 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1317 dev_err(&intf
->dev
, "This needs exactly 3 endpoints\n");
1320 look_for_collapsed_interface
:
1321 res
= usb_find_common_endpoints(data_interface
->cur_altsetting
,
1322 &epread
, &epwrite
, &epctrl
, NULL
);
1326 goto made_compressed_probe
;
1331 /*workaround for switched interfaces */
1332 if (data_interface
->cur_altsetting
->desc
.bInterfaceClass
1333 != CDC_DATA_INTERFACE_TYPE
) {
1334 if (control_interface
->cur_altsetting
->desc
.bInterfaceClass
1335 == CDC_DATA_INTERFACE_TYPE
) {
1337 "Your device has switched interfaces.\n");
1338 swap(control_interface
, data_interface
);
1344 /* Accept probe requests only for the control interface */
1345 if (!combined_interfaces
&& intf
!= control_interface
)
1348 if (!combined_interfaces
&& usb_interface_claimed(data_interface
)) {
1349 /* valid in this context */
1350 dev_dbg(&intf
->dev
, "The data interface isn't available\n");
1355 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
< 2 ||
1356 control_interface
->cur_altsetting
->desc
.bNumEndpoints
== 0)
1359 epctrl
= &control_interface
->cur_altsetting
->endpoint
[0].desc
;
1360 epread
= &data_interface
->cur_altsetting
->endpoint
[0].desc
;
1361 epwrite
= &data_interface
->cur_altsetting
->endpoint
[1].desc
;
1364 /* workaround for switched endpoints */
1365 if (!usb_endpoint_dir_in(epread
)) {
1366 /* descriptors are swapped */
1368 "The data interface has switched endpoints\n");
1369 swap(epread
, epwrite
);
1371 made_compressed_probe
:
1372 dev_dbg(&intf
->dev
, "interfaces are valid\n");
1374 acm
= kzalloc(sizeof(struct acm
), GFP_KERNEL
);
1378 minor
= acm_alloc_minor(acm
);
1382 ctrlsize
= usb_endpoint_maxp(epctrl
);
1383 readsize
= usb_endpoint_maxp(epread
) *
1384 (quirks
== SINGLE_RX_URB
? 1 : 2);
1385 acm
->combined_interfaces
= combined_interfaces
;
1386 acm
->writesize
= usb_endpoint_maxp(epwrite
) * 20;
1387 acm
->control
= control_interface
;
1388 acm
->data
= data_interface
;
1391 if (h
.usb_cdc_acm_descriptor
)
1392 acm
->ctrl_caps
= h
.usb_cdc_acm_descriptor
->bmCapabilities
;
1393 if (quirks
& NO_CAP_LINE
)
1394 acm
->ctrl_caps
&= ~USB_CDC_CAP_LINE
;
1395 acm
->ctrlsize
= ctrlsize
;
1396 acm
->readsize
= readsize
;
1397 acm
->rx_buflimit
= num_rx_buf
;
1398 INIT_WORK(&acm
->work
, acm_softint
);
1399 init_waitqueue_head(&acm
->wioctl
);
1400 spin_lock_init(&acm
->write_lock
);
1401 spin_lock_init(&acm
->read_lock
);
1402 mutex_init(&acm
->mutex
);
1403 if (usb_endpoint_xfer_int(epread
)) {
1404 acm
->bInterval
= epread
->bInterval
;
1405 acm
->in
= usb_rcvintpipe(usb_dev
, epread
->bEndpointAddress
);
1407 acm
->in
= usb_rcvbulkpipe(usb_dev
, epread
->bEndpointAddress
);
1409 if (usb_endpoint_xfer_int(epwrite
))
1410 acm
->out
= usb_sndintpipe(usb_dev
, epwrite
->bEndpointAddress
);
1412 acm
->out
= usb_sndbulkpipe(usb_dev
, epwrite
->bEndpointAddress
);
1413 tty_port_init(&acm
->port
);
1414 acm
->port
.ops
= &acm_port_ops
;
1415 init_usb_anchor(&acm
->delayed
);
1416 acm
->quirks
= quirks
;
1418 buf
= usb_alloc_coherent(usb_dev
, ctrlsize
, GFP_KERNEL
, &acm
->ctrl_dma
);
1421 acm
->ctrl_buffer
= buf
;
1423 if (acm_write_buffers_alloc(acm
) < 0)
1426 acm
->ctrlurb
= usb_alloc_urb(0, GFP_KERNEL
);
1430 for (i
= 0; i
< num_rx_buf
; i
++) {
1431 struct acm_rb
*rb
= &(acm
->read_buffers
[i
]);
1434 rb
->base
= usb_alloc_coherent(acm
->dev
, readsize
, GFP_KERNEL
,
1441 urb
= usb_alloc_urb(0, GFP_KERNEL
);
1445 urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1446 urb
->transfer_dma
= rb
->dma
;
1447 if (usb_endpoint_xfer_int(epread
))
1448 usb_fill_int_urb(urb
, acm
->dev
, acm
->in
, rb
->base
,
1450 acm_read_bulk_callback
, rb
,
1453 usb_fill_bulk_urb(urb
, acm
->dev
, acm
->in
, rb
->base
,
1455 acm_read_bulk_callback
, rb
);
1457 acm
->read_urbs
[i
] = urb
;
1458 __set_bit(i
, &acm
->read_urbs_free
);
1460 for (i
= 0; i
< ACM_NW
; i
++) {
1461 struct acm_wb
*snd
= &(acm
->wb
[i
]);
1463 snd
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1464 if (snd
->urb
== NULL
)
1467 if (usb_endpoint_xfer_int(epwrite
))
1468 usb_fill_int_urb(snd
->urb
, usb_dev
, acm
->out
,
1469 NULL
, acm
->writesize
, acm_write_bulk
, snd
, epwrite
->bInterval
);
1471 usb_fill_bulk_urb(snd
->urb
, usb_dev
, acm
->out
,
1472 NULL
, acm
->writesize
, acm_write_bulk
, snd
);
1473 snd
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1474 if (quirks
& SEND_ZERO_PACKET
)
1475 snd
->urb
->transfer_flags
|= URB_ZERO_PACKET
;
1476 snd
->instance
= acm
;
1479 usb_set_intfdata(intf
, acm
);
1481 i
= device_create_file(&intf
->dev
, &dev_attr_bmCapabilities
);
1485 if (h
.usb_cdc_country_functional_desc
) { /* export the country data */
1486 struct usb_cdc_country_functional_desc
* cfd
=
1487 h
.usb_cdc_country_functional_desc
;
1489 acm
->country_codes
= kmalloc(cfd
->bLength
- 4, GFP_KERNEL
);
1490 if (!acm
->country_codes
)
1491 goto skip_countries
;
1492 acm
->country_code_size
= cfd
->bLength
- 4;
1493 memcpy(acm
->country_codes
, (u8
*)&cfd
->wCountyCode0
,
1495 acm
->country_rel_date
= cfd
->iCountryCodeRelDate
;
1497 i
= device_create_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1499 kfree(acm
->country_codes
);
1500 acm
->country_codes
= NULL
;
1501 acm
->country_code_size
= 0;
1502 goto skip_countries
;
1505 i
= device_create_file(&intf
->dev
,
1506 &dev_attr_iCountryCodeRelDate
);
1508 device_remove_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1509 kfree(acm
->country_codes
);
1510 acm
->country_codes
= NULL
;
1511 acm
->country_code_size
= 0;
1512 goto skip_countries
;
1517 usb_fill_int_urb(acm
->ctrlurb
, usb_dev
,
1518 usb_rcvintpipe(usb_dev
, epctrl
->bEndpointAddress
),
1519 acm
->ctrl_buffer
, ctrlsize
, acm_ctrl_irq
, acm
,
1520 /* works around buggy devices */
1521 epctrl
->bInterval
? epctrl
->bInterval
: 16);
1522 acm
->ctrlurb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1523 acm
->ctrlurb
->transfer_dma
= acm
->ctrl_dma
;
1524 acm
->notification_buffer
= NULL
;
1528 dev_info(&intf
->dev
, "ttyACM%d: USB ACM device\n", minor
);
1530 acm
->line
.dwDTERate
= cpu_to_le32(9600);
1531 acm
->line
.bDataBits
= 8;
1532 acm_set_line(acm
, &acm
->line
);
1534 usb_driver_claim_interface(&acm_driver
, data_interface
, acm
);
1535 usb_set_intfdata(data_interface
, acm
);
1537 usb_get_intf(control_interface
);
1538 tty_dev
= tty_port_register_device(&acm
->port
, acm_tty_driver
, minor
,
1539 &control_interface
->dev
);
1540 if (IS_ERR(tty_dev
)) {
1541 rv
= PTR_ERR(tty_dev
);
1545 if (quirks
& CLEAR_HALT_CONDITIONS
) {
1546 usb_clear_halt(usb_dev
, acm
->in
);
1547 usb_clear_halt(usb_dev
, acm
->out
);
1552 if (acm
->country_codes
) {
1553 device_remove_file(&acm
->control
->dev
,
1554 &dev_attr_wCountryCodes
);
1555 device_remove_file(&acm
->control
->dev
,
1556 &dev_attr_iCountryCodeRelDate
);
1557 kfree(acm
->country_codes
);
1559 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1561 usb_set_intfdata(intf
, NULL
);
1562 for (i
= 0; i
< ACM_NW
; i
++)
1563 usb_free_urb(acm
->wb
[i
].urb
);
1565 for (i
= 0; i
< num_rx_buf
; i
++)
1566 usb_free_urb(acm
->read_urbs
[i
]);
1567 acm_read_buffers_free(acm
);
1568 usb_free_urb(acm
->ctrlurb
);
1570 acm_write_buffers_free(acm
);
1572 usb_free_coherent(usb_dev
, ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1574 acm_release_minor(acm
);
1581 static void acm_disconnect(struct usb_interface
*intf
)
1583 struct acm
*acm
= usb_get_intfdata(intf
);
1584 struct tty_struct
*tty
;
1586 /* sibling interface is already cleaning up */
1590 mutex_lock(&acm
->mutex
);
1591 acm
->disconnected
= true;
1592 if (acm
->country_codes
) {
1593 device_remove_file(&acm
->control
->dev
,
1594 &dev_attr_wCountryCodes
);
1595 device_remove_file(&acm
->control
->dev
,
1596 &dev_attr_iCountryCodeRelDate
);
1598 wake_up_all(&acm
->wioctl
);
1599 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1600 usb_set_intfdata(acm
->control
, NULL
);
1601 usb_set_intfdata(acm
->data
, NULL
);
1602 mutex_unlock(&acm
->mutex
);
1604 tty
= tty_port_tty_get(&acm
->port
);
1611 cancel_work_sync(&acm
->work
);
1613 tty_unregister_device(acm_tty_driver
, acm
->minor
);
1615 acm_write_buffers_free(acm
);
1616 usb_free_coherent(acm
->dev
, acm
->ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1617 acm_read_buffers_free(acm
);
1619 kfree(acm
->notification_buffer
);
1621 if (!acm
->combined_interfaces
)
1622 usb_driver_release_interface(&acm_driver
, intf
== acm
->control
?
1623 acm
->data
: acm
->control
);
1625 tty_port_put(&acm
->port
);
1629 static int acm_suspend(struct usb_interface
*intf
, pm_message_t message
)
1631 struct acm
*acm
= usb_get_intfdata(intf
);
1634 spin_lock_irq(&acm
->write_lock
);
1635 if (PMSG_IS_AUTO(message
)) {
1636 if (acm
->transmitting
) {
1637 spin_unlock_irq(&acm
->write_lock
);
1641 cnt
= acm
->susp_count
++;
1642 spin_unlock_irq(&acm
->write_lock
);
1648 cancel_work_sync(&acm
->work
);
1653 static int acm_resume(struct usb_interface
*intf
)
1655 struct acm
*acm
= usb_get_intfdata(intf
);
1659 spin_lock_irq(&acm
->write_lock
);
1661 if (--acm
->susp_count
)
1664 if (tty_port_initialized(&acm
->port
)) {
1665 rv
= usb_submit_urb(acm
->ctrlurb
, GFP_ATOMIC
);
1668 urb
= usb_get_from_anchor(&acm
->delayed
);
1672 acm_start_wb(acm
, urb
->context
);
1676 * delayed error checking because we must
1677 * do the write path at all cost
1682 rv
= acm_submit_read_urbs(acm
, GFP_ATOMIC
);
1685 spin_unlock_irq(&acm
->write_lock
);
1690 static int acm_reset_resume(struct usb_interface
*intf
)
1692 struct acm
*acm
= usb_get_intfdata(intf
);
1694 if (tty_port_initialized(&acm
->port
))
1695 tty_port_tty_hangup(&acm
->port
, false);
1697 return acm_resume(intf
);
1700 #endif /* CONFIG_PM */
1702 static int acm_pre_reset(struct usb_interface
*intf
)
1704 struct acm
*acm
= usb_get_intfdata(intf
);
1706 clear_bit(EVENT_RX_STALL
, &acm
->flags
);
1711 #define NOKIA_PCSUITE_ACM_INFO(x) \
1712 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1713 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1714 USB_CDC_ACM_PROTO_VENDOR)
1716 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1717 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1718 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1719 USB_CDC_ACM_PROTO_VENDOR)
1722 * USB driver structure.
1725 static const struct usb_device_id acm_ids
[] = {
1726 /* quirky and broken devices */
1727 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1728 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1729 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1730 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1731 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1732 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1734 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1735 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1737 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1738 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1740 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1741 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1743 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1744 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1746 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1747 .driver_info
= SINGLE_RX_URB
,
1749 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1750 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1752 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1753 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1755 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1756 .driver_info
= SINGLE_RX_URB
,
1758 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1759 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1761 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1762 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1764 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1765 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1767 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1768 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1770 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1771 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1773 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1774 .driver_info
= QUIRK_CONTROL_LINE_STATE
, },
1775 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1776 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1777 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1779 /* Motorola H24 HSPA module: */
1780 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1781 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1782 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1784 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1785 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1787 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1788 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1790 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1791 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1793 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1794 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1796 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1797 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1799 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1800 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1803 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1804 .driver_info
= NO_UNION_NORMAL
, /* union descriptor misplaced on
1805 data interface instead of
1806 communications interface.
1807 Maybe we should define a new
1810 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1811 .driver_info
= NO_UNION_NORMAL
,
1813 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1814 .driver_info
= NO_UNION_NORMAL
,
1816 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1817 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1819 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1820 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1822 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1823 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1825 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1826 .driver_info
= NO_UNION_NORMAL
, /* has misplaced union descriptor */
1829 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1830 .driver_info
= CLEAR_HALT_CONDITIONS
,
1833 /* Nokia S60 phones expose two ACM channels. The first is
1834 * a modem and is picked up by the standard AT-command
1835 * information below. The second is 'vendor-specific' but
1836 * is treated as a serial device at the S60 end, so we want
1837 * to expose it on Linux too. */
1838 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1839 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1840 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1841 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1842 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1843 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1844 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1845 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1846 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1847 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1848 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1849 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1850 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1851 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1852 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1853 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1854 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1855 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1856 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1857 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1858 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1859 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1860 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1861 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1862 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1863 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1864 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1865 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1866 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1867 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1868 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1869 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1870 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1871 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1872 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1873 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1874 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1875 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1876 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1877 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1878 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1879 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1880 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1881 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1882 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1883 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1884 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1885 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1886 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1887 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1888 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1889 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1890 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1891 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1892 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1893 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1894 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1895 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1897 /* Support for Owen devices */
1898 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1900 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1902 /* Support for Droids MuIn LCD */
1903 { USB_DEVICE(0x04d8, 0x000b),
1904 .driver_info
= NO_DATA_INTERFACE
,
1907 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1908 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1909 .driver_info
= IGNORE_DEVICE
,
1911 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1912 .driver_info
= IGNORE_DEVICE
,
1916 /*Samsung phone in firmware update mode */
1917 { USB_DEVICE(0x04e8, 0x685d),
1918 .driver_info
= IGNORE_DEVICE
,
1921 /* Exclude Infineon Flash Loader utility */
1922 { USB_DEVICE(0x058b, 0x0041),
1923 .driver_info
= IGNORE_DEVICE
,
1926 /* control interfaces without any protocol set */
1927 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1928 USB_CDC_PROTO_NONE
) },
1930 /* control interfaces with various AT-command sets */
1931 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1932 USB_CDC_ACM_PROTO_AT_V25TER
) },
1933 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1934 USB_CDC_ACM_PROTO_AT_PCCA101
) },
1935 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1936 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE
) },
1937 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1938 USB_CDC_ACM_PROTO_AT_GSM
) },
1939 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1940 USB_CDC_ACM_PROTO_AT_3G
) },
1941 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1942 USB_CDC_ACM_PROTO_AT_CDMA
) },
1944 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1945 .driver_info
= SEND_ZERO_PACKET
,
1951 MODULE_DEVICE_TABLE(usb
, acm_ids
);
1953 static struct usb_driver acm_driver
= {
1956 .disconnect
= acm_disconnect
,
1958 .suspend
= acm_suspend
,
1959 .resume
= acm_resume
,
1960 .reset_resume
= acm_reset_resume
,
1962 .pre_reset
= acm_pre_reset
,
1963 .id_table
= acm_ids
,
1965 .supports_autosuspend
= 1,
1967 .disable_hub_initiated_lpm
= 1,
1971 * TTY driver structures.
1974 static const struct tty_operations acm_ops
= {
1975 .install
= acm_tty_install
,
1976 .open
= acm_tty_open
,
1977 .close
= acm_tty_close
,
1978 .cleanup
= acm_tty_cleanup
,
1979 .hangup
= acm_tty_hangup
,
1980 .write
= acm_tty_write
,
1981 .put_char
= acm_tty_put_char
,
1982 .flush_chars
= acm_tty_flush_chars
,
1983 .write_room
= acm_tty_write_room
,
1984 .ioctl
= acm_tty_ioctl
,
1985 .throttle
= acm_tty_throttle
,
1986 .unthrottle
= acm_tty_unthrottle
,
1987 .chars_in_buffer
= acm_tty_chars_in_buffer
,
1988 .break_ctl
= acm_tty_break_ctl
,
1989 .set_termios
= acm_tty_set_termios
,
1990 .tiocmget
= acm_tty_tiocmget
,
1991 .tiocmset
= acm_tty_tiocmset
,
1992 .get_icount
= acm_tty_get_icount
,
1999 static int __init
acm_init(void)
2002 acm_tty_driver
= alloc_tty_driver(ACM_TTY_MINORS
);
2003 if (!acm_tty_driver
)
2005 acm_tty_driver
->driver_name
= "acm",
2006 acm_tty_driver
->name
= "ttyACM",
2007 acm_tty_driver
->major
= ACM_TTY_MAJOR
,
2008 acm_tty_driver
->minor_start
= 0,
2009 acm_tty_driver
->type
= TTY_DRIVER_TYPE_SERIAL
,
2010 acm_tty_driver
->subtype
= SERIAL_TYPE_NORMAL
,
2011 acm_tty_driver
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
2012 acm_tty_driver
->init_termios
= tty_std_termios
;
2013 acm_tty_driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
|
2015 tty_set_operations(acm_tty_driver
, &acm_ops
);
2017 retval
= tty_register_driver(acm_tty_driver
);
2019 put_tty_driver(acm_tty_driver
);
2023 retval
= usb_register(&acm_driver
);
2025 tty_unregister_driver(acm_tty_driver
);
2026 put_tty_driver(acm_tty_driver
);
2030 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
2035 static void __exit
acm_exit(void)
2037 usb_deregister(&acm_driver
);
2038 tty_unregister_driver(acm_tty_driver
);
2039 put_tty_driver(acm_tty_driver
);
2040 idr_destroy(&acm_minors
);
2043 module_init(acm_init
);
2044 module_exit(acm_exit
);
2046 MODULE_AUTHOR(DRIVER_AUTHOR
);
2047 MODULE_DESCRIPTION(DRIVER_DESC
);
2048 MODULE_LICENSE("GPL");
2049 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR
);