4 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
5 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
6 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
9 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
10 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 * USB Abstract Control Model driver for USB modems and ISDN adapters
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/serial.h>
40 #include <linux/tty_driver.h>
41 #include <linux/tty_flip.h>
42 #include <linux/module.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/usb/cdc.h>
47 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
49 #include <linux/idr.h>
50 #include <linux/list.h>
55 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
56 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
58 static struct usb_driver acm_driver
;
59 static struct tty_driver
*acm_tty_driver
;
61 static DEFINE_IDR(acm_minors
);
62 static DEFINE_MUTEX(acm_minors_lock
);
64 static void acm_tty_set_termios(struct tty_struct
*tty
,
65 struct ktermios
*termios_old
);
68 * acm_minors accessors
72 * Look up an ACM structure by minor. If found and not disconnected, increment
73 * its refcount and return it with its mutex held.
75 static struct acm
*acm_get_by_minor(unsigned int minor
)
79 mutex_lock(&acm_minors_lock
);
80 acm
= idr_find(&acm_minors
, minor
);
82 mutex_lock(&acm
->mutex
);
83 if (acm
->disconnected
) {
84 mutex_unlock(&acm
->mutex
);
87 tty_port_get(&acm
->port
);
88 mutex_unlock(&acm
->mutex
);
91 mutex_unlock(&acm_minors_lock
);
96 * Try to find an available minor number and if found, associate it with 'acm'.
98 static int acm_alloc_minor(struct acm
*acm
)
102 mutex_lock(&acm_minors_lock
);
103 minor
= idr_alloc(&acm_minors
, acm
, 0, ACM_TTY_MINORS
, GFP_KERNEL
);
104 mutex_unlock(&acm_minors_lock
);
109 /* Release the minor number associated with 'acm'. */
110 static void acm_release_minor(struct acm
*acm
)
112 mutex_lock(&acm_minors_lock
);
113 idr_remove(&acm_minors
, acm
->minor
);
114 mutex_unlock(&acm_minors_lock
);
118 * Functions for ACM control messages.
121 static int acm_ctrl_msg(struct acm
*acm
, int request
, int value
,
126 retval
= usb_autopm_get_interface(acm
->control
);
130 retval
= usb_control_msg(acm
->dev
, usb_sndctrlpipe(acm
->dev
, 0),
131 request
, USB_RT_ACM
, value
,
132 acm
->control
->altsetting
[0].desc
.bInterfaceNumber
,
135 dev_dbg(&acm
->control
->dev
,
136 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
137 __func__
, request
, value
, len
, retval
);
139 usb_autopm_put_interface(acm
->control
);
141 return retval
< 0 ? retval
: 0;
144 /* devices aren't required to support these requests.
145 * the cdc acm descriptor tells whether they do...
147 static inline int acm_set_control(struct acm
*acm
, int control
)
149 if (acm
->quirks
& QUIRK_CONTROL_LINE_STATE
)
152 return acm_ctrl_msg(acm
, USB_CDC_REQ_SET_CONTROL_LINE_STATE
,
156 #define acm_set_line(acm, line) \
157 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
158 #define acm_send_break(acm, ms) \
159 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
161 static void acm_kill_urbs(struct acm
*acm
)
165 usb_kill_urb(acm
->ctrlurb
);
166 for (i
= 0; i
< ACM_NW
; i
++)
167 usb_kill_urb(acm
->wb
[i
].urb
);
168 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
169 usb_kill_urb(acm
->read_urbs
[i
]);
173 * Write buffer management.
174 * All of these assume proper locks taken by the caller.
177 static int acm_wb_alloc(struct acm
*acm
)
190 wbn
= (wbn
+ 1) % ACM_NW
;
196 static int acm_wb_is_avail(struct acm
*acm
)
202 spin_lock_irqsave(&acm
->write_lock
, flags
);
203 for (i
= 0; i
< ACM_NW
; i
++)
205 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
210 * Finish write. Caller must hold acm->write_lock
212 static void acm_write_done(struct acm
*acm
, struct acm_wb
*wb
)
216 usb_autopm_put_interface_async(acm
->control
);
222 * the caller is responsible for locking
225 static int acm_start_wb(struct acm
*acm
, struct acm_wb
*wb
)
231 wb
->urb
->transfer_buffer
= wb
->buf
;
232 wb
->urb
->transfer_dma
= wb
->dmah
;
233 wb
->urb
->transfer_buffer_length
= wb
->len
;
234 wb
->urb
->dev
= acm
->dev
;
236 rc
= usb_submit_urb(wb
->urb
, GFP_ATOMIC
);
238 dev_err(&acm
->data
->dev
,
239 "%s - usb_submit_urb(write bulk) failed: %d\n",
241 acm_write_done(acm
, wb
);
247 * attributes exported through sysfs
249 static ssize_t show_caps
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 return sprintf(buf
, "%d", acm
->ctrl_caps
);
257 static DEVICE_ATTR(bmCapabilities
, S_IRUGO
, show_caps
, NULL
);
259 static ssize_t show_country_codes
260 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
262 struct usb_interface
*intf
= to_usb_interface(dev
);
263 struct acm
*acm
= usb_get_intfdata(intf
);
265 memcpy(buf
, acm
->country_codes
, acm
->country_code_size
);
266 return acm
->country_code_size
;
269 static DEVICE_ATTR(wCountryCodes
, S_IRUGO
, show_country_codes
, NULL
);
271 static ssize_t show_country_rel_date
272 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
274 struct usb_interface
*intf
= to_usb_interface(dev
);
275 struct acm
*acm
= usb_get_intfdata(intf
);
277 return sprintf(buf
, "%d", acm
->country_rel_date
);
280 static DEVICE_ATTR(iCountryCodeRelDate
, S_IRUGO
, show_country_rel_date
, NULL
);
282 * Interrupt handlers for various ACM device responses
285 /* control interface reports status changes with "interrupt" transfers */
286 static void acm_ctrl_irq(struct urb
*urb
)
288 struct acm
*acm
= urb
->context
;
289 struct usb_cdc_notification
*dr
= urb
->transfer_buffer
;
294 int status
= urb
->status
;
303 /* this urb is terminated, clean up */
304 dev_dbg(&acm
->control
->dev
,
305 "%s - urb shutting down with status: %d\n",
309 dev_dbg(&acm
->control
->dev
,
310 "%s - nonzero urb status received: %d\n",
315 usb_mark_last_busy(acm
->dev
);
317 data
= (unsigned char *)(dr
+ 1);
318 switch (dr
->bNotificationType
) {
319 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
320 dev_dbg(&acm
->control
->dev
,
321 "%s - network connection: %d\n", __func__
, dr
->wValue
);
324 case USB_CDC_NOTIFY_SERIAL_STATE
:
325 newctrl
= get_unaligned_le16(data
);
327 if (!acm
->clocal
&& (acm
->ctrlin
& ~newctrl
& ACM_CTRL_DCD
)) {
328 dev_dbg(&acm
->control
->dev
,
329 "%s - calling hangup\n", __func__
);
330 tty_port_tty_hangup(&acm
->port
, false);
333 difference
= acm
->ctrlin
^ newctrl
;
334 spin_lock(&acm
->read_lock
);
335 acm
->ctrlin
= newctrl
;
336 acm
->oldcount
= acm
->iocount
;
338 if (difference
& ACM_CTRL_DSR
)
340 if (difference
& ACM_CTRL_BRK
)
342 if (difference
& ACM_CTRL_RI
)
344 if (difference
& ACM_CTRL_DCD
)
346 if (difference
& ACM_CTRL_FRAMING
)
347 acm
->iocount
.frame
++;
348 if (difference
& ACM_CTRL_PARITY
)
349 acm
->iocount
.parity
++;
350 if (difference
& ACM_CTRL_OVERRUN
)
351 acm
->iocount
.overrun
++;
352 spin_unlock(&acm
->read_lock
);
355 wake_up_all(&acm
->wioctl
);
360 dev_dbg(&acm
->control
->dev
,
361 "%s - unknown notification %d received: index %d "
362 "len %d data0 %d data1 %d\n",
364 dr
->bNotificationType
, dr
->wIndex
,
365 dr
->wLength
, data
[0], data
[1]);
369 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
370 if (retval
&& retval
!= -EPERM
)
371 dev_err(&acm
->control
->dev
,
372 "%s - usb_submit_urb failed: %d\n", __func__
, retval
);
375 static int acm_submit_read_urb(struct acm
*acm
, int index
, gfp_t mem_flags
)
379 if (!test_and_clear_bit(index
, &acm
->read_urbs_free
))
382 res
= usb_submit_urb(acm
->read_urbs
[index
], mem_flags
);
385 dev_err(&acm
->data
->dev
,
386 "urb %d failed submission with %d\n",
389 set_bit(index
, &acm
->read_urbs_free
);
392 dev_vdbg(&acm
->data
->dev
, "submitted urb %d\n", index
);
398 static int acm_submit_read_urbs(struct acm
*acm
, gfp_t mem_flags
)
403 for (i
= 0; i
< acm
->rx_buflimit
; ++i
) {
404 res
= acm_submit_read_urb(acm
, i
, mem_flags
);
412 static void acm_process_read_urb(struct acm
*acm
, struct urb
*urb
)
414 if (!urb
->actual_length
)
417 tty_insert_flip_string(&acm
->port
, urb
->transfer_buffer
,
419 tty_flip_buffer_push(&acm
->port
);
422 static void acm_read_bulk_callback(struct urb
*urb
)
424 struct acm_rb
*rb
= urb
->context
;
425 struct acm
*acm
= rb
->instance
;
427 int status
= urb
->status
;
429 dev_vdbg(&acm
->data
->dev
, "got urb %d, len %d, status %d\n",
430 rb
->index
, urb
->actual_length
, status
);
432 set_bit(rb
->index
, &acm
->read_urbs_free
);
435 dev_dbg(&acm
->data
->dev
, "%s - disconnected\n", __func__
);
441 usb_mark_last_busy(acm
->dev
);
442 acm_process_read_urb(acm
, urb
);
445 set_bit(EVENT_RX_STALL
, &acm
->flags
);
446 schedule_work(&acm
->work
);
451 dev_dbg(&acm
->data
->dev
,
452 "%s - urb shutting down with status: %d\n",
456 dev_dbg(&acm
->data
->dev
,
457 "%s - nonzero urb status received: %d\n",
463 * Unthrottle may run on another CPU which needs to see events
464 * in the same order. Submission has an implict barrier
466 smp_mb__before_atomic();
468 /* throttle device if requested by tty */
469 spin_lock_irqsave(&acm
->read_lock
, flags
);
470 acm
->throttled
= acm
->throttle_req
;
471 if (!acm
->throttled
) {
472 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
473 acm_submit_read_urb(acm
, rb
->index
, GFP_ATOMIC
);
475 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
479 /* data interface wrote those outgoing bytes */
480 static void acm_write_bulk(struct urb
*urb
)
482 struct acm_wb
*wb
= urb
->context
;
483 struct acm
*acm
= wb
->instance
;
485 int status
= urb
->status
;
487 if (status
|| (urb
->actual_length
!= urb
->transfer_buffer_length
))
488 dev_vdbg(&acm
->data
->dev
, "wrote len %d/%d, status %d\n",
490 urb
->transfer_buffer_length
,
493 spin_lock_irqsave(&acm
->write_lock
, flags
);
494 acm_write_done(acm
, wb
);
495 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
496 set_bit(EVENT_TTY_WAKEUP
, &acm
->flags
);
497 schedule_work(&acm
->work
);
500 static void acm_softint(struct work_struct
*work
)
503 struct acm
*acm
= container_of(work
, struct acm
, work
);
505 if (test_bit(EVENT_RX_STALL
, &acm
->flags
)) {
506 if (!(usb_autopm_get_interface(acm
->data
))) {
507 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
508 usb_kill_urb(acm
->read_urbs
[i
]);
509 usb_clear_halt(acm
->dev
, acm
->in
);
510 acm_submit_read_urbs(acm
, GFP_KERNEL
);
511 usb_autopm_put_interface(acm
->data
);
513 clear_bit(EVENT_RX_STALL
, &acm
->flags
);
516 if (test_bit(EVENT_TTY_WAKEUP
, &acm
->flags
)) {
517 tty_port_tty_wakeup(&acm
->port
);
518 clear_bit(EVENT_TTY_WAKEUP
, &acm
->flags
);
526 static int acm_tty_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
531 acm
= acm_get_by_minor(tty
->index
);
535 retval
= tty_standard_install(driver
, tty
);
537 goto error_init_termios
;
539 tty
->driver_data
= acm
;
544 tty_port_put(&acm
->port
);
548 static int acm_tty_open(struct tty_struct
*tty
, struct file
*filp
)
550 struct acm
*acm
= tty
->driver_data
;
552 return tty_port_open(&acm
->port
, tty
, filp
);
555 static void acm_port_dtr_rts(struct tty_port
*port
, int raise
)
557 struct acm
*acm
= container_of(port
, struct acm
, port
);
562 val
= ACM_CTRL_DTR
| ACM_CTRL_RTS
;
566 /* FIXME: add missing ctrlout locking throughout driver */
569 res
= acm_set_control(acm
, val
);
570 if (res
&& (acm
->ctrl_caps
& USB_CDC_CAP_LINE
))
571 dev_err(&acm
->control
->dev
, "failed to set dtr/rts\n");
574 static int acm_port_activate(struct tty_port
*port
, struct tty_struct
*tty
)
576 struct acm
*acm
= container_of(port
, struct acm
, port
);
577 int retval
= -ENODEV
;
580 mutex_lock(&acm
->mutex
);
581 if (acm
->disconnected
)
584 retval
= usb_autopm_get_interface(acm
->control
);
586 goto error_get_interface
;
589 * FIXME: Why do we need this? Allocating 64K of physically contiguous
590 * memory is really nasty...
592 set_bit(TTY_NO_WRITE_SPLIT
, &tty
->flags
);
593 acm
->control
->needs_remote_wakeup
= 1;
595 acm
->ctrlurb
->dev
= acm
->dev
;
596 retval
= usb_submit_urb(acm
->ctrlurb
, GFP_KERNEL
);
598 dev_err(&acm
->control
->dev
,
599 "%s - usb_submit_urb(ctrl irq) failed\n", __func__
);
600 goto error_submit_urb
;
603 acm_tty_set_termios(tty
, NULL
);
606 * Unthrottle device in case the TTY was closed while throttled.
608 spin_lock_irq(&acm
->read_lock
);
610 acm
->throttle_req
= 0;
611 spin_unlock_irq(&acm
->read_lock
);
613 retval
= acm_submit_read_urbs(acm
, GFP_KERNEL
);
615 goto error_submit_read_urbs
;
617 usb_autopm_put_interface(acm
->control
);
619 mutex_unlock(&acm
->mutex
);
623 error_submit_read_urbs
:
624 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
625 usb_kill_urb(acm
->read_urbs
[i
]);
626 usb_kill_urb(acm
->ctrlurb
);
628 usb_autopm_put_interface(acm
->control
);
631 mutex_unlock(&acm
->mutex
);
633 return usb_translate_errors(retval
);
636 static void acm_port_destruct(struct tty_port
*port
)
638 struct acm
*acm
= container_of(port
, struct acm
, port
);
640 acm_release_minor(acm
);
641 usb_put_intf(acm
->control
);
642 kfree(acm
->country_codes
);
646 static void acm_port_shutdown(struct tty_port
*port
)
648 struct acm
*acm
= container_of(port
, struct acm
, port
);
653 * Need to grab write_lock to prevent race with resume, but no need to
654 * hold it due to the tty-port initialised flag.
656 spin_lock_irq(&acm
->write_lock
);
657 spin_unlock_irq(&acm
->write_lock
);
659 usb_autopm_get_interface_no_resume(acm
->control
);
660 acm
->control
->needs_remote_wakeup
= 0;
661 usb_autopm_put_interface(acm
->control
);
664 urb
= usb_get_from_anchor(&acm
->delayed
);
669 usb_autopm_put_interface_async(acm
->control
);
675 static void acm_tty_cleanup(struct tty_struct
*tty
)
677 struct acm
*acm
= tty
->driver_data
;
679 tty_port_put(&acm
->port
);
682 static void acm_tty_hangup(struct tty_struct
*tty
)
684 struct acm
*acm
= tty
->driver_data
;
686 tty_port_hangup(&acm
->port
);
689 static void acm_tty_close(struct tty_struct
*tty
, struct file
*filp
)
691 struct acm
*acm
= tty
->driver_data
;
693 tty_port_close(&acm
->port
, tty
, filp
);
696 static int acm_tty_write(struct tty_struct
*tty
,
697 const unsigned char *buf
, int count
)
699 struct acm
*acm
= tty
->driver_data
;
708 dev_vdbg(&acm
->data
->dev
, "%d bytes from tty layer\n", count
);
710 spin_lock_irqsave(&acm
->write_lock
, flags
);
711 wbn
= acm_wb_alloc(acm
);
713 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
720 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
724 count
= (count
> acm
->writesize
) ? acm
->writesize
: count
;
725 dev_vdbg(&acm
->data
->dev
, "writing %d bytes\n", count
);
726 memcpy(wb
->buf
, buf
, count
);
729 stat
= usb_autopm_get_interface_async(acm
->control
);
732 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
736 if (acm
->susp_count
) {
737 if (acm
->putbuffer
) {
738 /* now to preserve order */
739 usb_anchor_urb(acm
->putbuffer
->urb
, &acm
->delayed
);
740 acm
->putbuffer
= NULL
;
742 usb_anchor_urb(wb
->urb
, &acm
->delayed
);
743 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
746 if (acm
->putbuffer
) {
747 /* at this point there is no good way to handle errors */
748 acm_start_wb(acm
, acm
->putbuffer
);
749 acm
->putbuffer
= NULL
;
753 stat
= acm_start_wb(acm
, wb
);
754 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
761 static void acm_tty_flush_chars(struct tty_struct
*tty
)
763 struct acm
*acm
= tty
->driver_data
;
764 struct acm_wb
*cur
= acm
->putbuffer
;
768 if (!cur
) /* nothing to do */
771 acm
->putbuffer
= NULL
;
772 err
= usb_autopm_get_interface_async(acm
->control
);
773 spin_lock_irqsave(&acm
->write_lock
, flags
);
776 acm
->putbuffer
= cur
;
781 usb_anchor_urb(cur
->urb
, &acm
->delayed
);
783 acm_start_wb(acm
, cur
);
785 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
789 static int acm_tty_put_char(struct tty_struct
*tty
, unsigned char ch
)
791 struct acm
*acm
= tty
->driver_data
;
797 cur
= acm
->putbuffer
;
799 spin_lock_irqsave(&acm
->write_lock
, flags
);
800 wbn
= acm_wb_alloc(acm
);
803 acm
->putbuffer
= cur
;
805 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
810 if (cur
->len
== acm
->writesize
) {
811 acm_tty_flush_chars(tty
);
815 cur
->buf
[cur
->len
++] = ch
;
819 static int acm_tty_write_room(struct tty_struct
*tty
)
821 struct acm
*acm
= tty
->driver_data
;
823 * Do not let the line discipline to know that we have a reserve,
824 * or it might get too enthusiastic.
826 return acm_wb_is_avail(acm
) ? acm
->writesize
: 0;
829 static int acm_tty_chars_in_buffer(struct tty_struct
*tty
)
831 struct acm
*acm
= tty
->driver_data
;
833 * if the device was unplugged then any remaining characters fell out
834 * of the connector ;)
836 if (acm
->disconnected
)
839 * This is inaccurate (overcounts), but it works.
841 return (ACM_NW
- acm_wb_is_avail(acm
)) * acm
->writesize
;
844 static void acm_tty_throttle(struct tty_struct
*tty
)
846 struct acm
*acm
= tty
->driver_data
;
848 spin_lock_irq(&acm
->read_lock
);
849 acm
->throttle_req
= 1;
850 spin_unlock_irq(&acm
->read_lock
);
853 static void acm_tty_unthrottle(struct tty_struct
*tty
)
855 struct acm
*acm
= tty
->driver_data
;
856 unsigned int was_throttled
;
858 spin_lock_irq(&acm
->read_lock
);
859 was_throttled
= acm
->throttled
;
861 acm
->throttle_req
= 0;
862 spin_unlock_irq(&acm
->read_lock
);
865 acm_submit_read_urbs(acm
, GFP_KERNEL
);
868 static int acm_tty_break_ctl(struct tty_struct
*tty
, int state
)
870 struct acm
*acm
= tty
->driver_data
;
873 retval
= acm_send_break(acm
, state
? 0xffff : 0);
875 dev_dbg(&acm
->control
->dev
,
876 "%s - send break failed\n", __func__
);
880 static int acm_tty_tiocmget(struct tty_struct
*tty
)
882 struct acm
*acm
= tty
->driver_data
;
884 return (acm
->ctrlout
& ACM_CTRL_DTR
? TIOCM_DTR
: 0) |
885 (acm
->ctrlout
& ACM_CTRL_RTS
? TIOCM_RTS
: 0) |
886 (acm
->ctrlin
& ACM_CTRL_DSR
? TIOCM_DSR
: 0) |
887 (acm
->ctrlin
& ACM_CTRL_RI
? TIOCM_RI
: 0) |
888 (acm
->ctrlin
& ACM_CTRL_DCD
? TIOCM_CD
: 0) |
892 static int acm_tty_tiocmset(struct tty_struct
*tty
,
893 unsigned int set
, unsigned int clear
)
895 struct acm
*acm
= tty
->driver_data
;
896 unsigned int newctrl
;
898 newctrl
= acm
->ctrlout
;
899 set
= (set
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
900 (set
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
901 clear
= (clear
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
902 (clear
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
904 newctrl
= (newctrl
& ~clear
) | set
;
906 if (acm
->ctrlout
== newctrl
)
908 return acm_set_control(acm
, acm
->ctrlout
= newctrl
);
911 static int get_serial_info(struct acm
*acm
, struct serial_struct __user
*info
)
913 struct serial_struct tmp
;
915 memset(&tmp
, 0, sizeof(tmp
));
916 tmp
.xmit_fifo_size
= acm
->writesize
;
917 tmp
.baud_base
= le32_to_cpu(acm
->line
.dwDTERate
);
918 tmp
.close_delay
= acm
->port
.close_delay
/ 10;
919 tmp
.closing_wait
= acm
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
920 ASYNC_CLOSING_WAIT_NONE
:
921 acm
->port
.closing_wait
/ 10;
923 if (copy_to_user(info
, &tmp
, sizeof(tmp
)))
929 static int set_serial_info(struct acm
*acm
,
930 struct serial_struct __user
*newinfo
)
932 struct serial_struct new_serial
;
933 unsigned int closing_wait
, close_delay
;
936 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
939 close_delay
= new_serial
.close_delay
* 10;
940 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
941 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
943 mutex_lock(&acm
->port
.mutex
);
945 if (!capable(CAP_SYS_ADMIN
)) {
946 if ((close_delay
!= acm
->port
.close_delay
) ||
947 (closing_wait
!= acm
->port
.closing_wait
))
950 retval
= -EOPNOTSUPP
;
952 acm
->port
.close_delay
= close_delay
;
953 acm
->port
.closing_wait
= closing_wait
;
956 mutex_unlock(&acm
->port
.mutex
);
960 static int wait_serial_change(struct acm
*acm
, unsigned long arg
)
963 DECLARE_WAITQUEUE(wait
, current
);
964 struct async_icount old
, new;
967 spin_lock_irq(&acm
->read_lock
);
971 spin_unlock_irq(&acm
->read_lock
);
973 if ((arg
& TIOCM_DSR
) &&
976 if ((arg
& TIOCM_CD
) &&
979 if ((arg
& TIOCM_RI
) &&
983 add_wait_queue(&acm
->wioctl
, &wait
);
984 set_current_state(TASK_INTERRUPTIBLE
);
986 remove_wait_queue(&acm
->wioctl
, &wait
);
987 if (acm
->disconnected
) {
993 if (signal_pending(current
))
1003 static int acm_tty_get_icount(struct tty_struct
*tty
,
1004 struct serial_icounter_struct
*icount
)
1006 struct acm
*acm
= tty
->driver_data
;
1008 icount
->dsr
= acm
->iocount
.dsr
;
1009 icount
->rng
= acm
->iocount
.rng
;
1010 icount
->dcd
= acm
->iocount
.dcd
;
1011 icount
->frame
= acm
->iocount
.frame
;
1012 icount
->overrun
= acm
->iocount
.overrun
;
1013 icount
->parity
= acm
->iocount
.parity
;
1014 icount
->brk
= acm
->iocount
.brk
;
1019 static int acm_tty_ioctl(struct tty_struct
*tty
,
1020 unsigned int cmd
, unsigned long arg
)
1022 struct acm
*acm
= tty
->driver_data
;
1023 int rv
= -ENOIOCTLCMD
;
1026 case TIOCGSERIAL
: /* gets serial port data */
1027 rv
= get_serial_info(acm
, (struct serial_struct __user
*) arg
);
1030 rv
= set_serial_info(acm
, (struct serial_struct __user
*) arg
);
1033 rv
= usb_autopm_get_interface(acm
->control
);
1038 rv
= wait_serial_change(acm
, arg
);
1039 usb_autopm_put_interface(acm
->control
);
1046 static void acm_tty_set_termios(struct tty_struct
*tty
,
1047 struct ktermios
*termios_old
)
1049 struct acm
*acm
= tty
->driver_data
;
1050 struct ktermios
*termios
= &tty
->termios
;
1051 struct usb_cdc_line_coding newline
;
1052 int newctrl
= acm
->ctrlout
;
1054 newline
.dwDTERate
= cpu_to_le32(tty_get_baud_rate(tty
));
1055 newline
.bCharFormat
= termios
->c_cflag
& CSTOPB
? 2 : 0;
1056 newline
.bParityType
= termios
->c_cflag
& PARENB
?
1057 (termios
->c_cflag
& PARODD
? 1 : 2) +
1058 (termios
->c_cflag
& CMSPAR
? 2 : 0) : 0;
1059 switch (termios
->c_cflag
& CSIZE
) {
1061 newline
.bDataBits
= 5;
1064 newline
.bDataBits
= 6;
1067 newline
.bDataBits
= 7;
1071 newline
.bDataBits
= 8;
1074 /* FIXME: Needs to clear unsupported bits in the termios */
1075 acm
->clocal
= ((termios
->c_cflag
& CLOCAL
) != 0);
1077 if (C_BAUD(tty
) == B0
) {
1078 newline
.dwDTERate
= acm
->line
.dwDTERate
;
1079 newctrl
&= ~ACM_CTRL_DTR
;
1080 } else if (termios_old
&& (termios_old
->c_cflag
& CBAUD
) == B0
) {
1081 newctrl
|= ACM_CTRL_DTR
;
1084 if (newctrl
!= acm
->ctrlout
)
1085 acm_set_control(acm
, acm
->ctrlout
= newctrl
);
1087 if (memcmp(&acm
->line
, &newline
, sizeof newline
)) {
1088 memcpy(&acm
->line
, &newline
, sizeof newline
);
1089 dev_dbg(&acm
->control
->dev
, "%s - set line: %d %d %d %d\n",
1091 le32_to_cpu(newline
.dwDTERate
),
1092 newline
.bCharFormat
, newline
.bParityType
,
1094 acm_set_line(acm
, &acm
->line
);
1098 static const struct tty_port_operations acm_port_ops
= {
1099 .dtr_rts
= acm_port_dtr_rts
,
1100 .shutdown
= acm_port_shutdown
,
1101 .activate
= acm_port_activate
,
1102 .destruct
= acm_port_destruct
,
1106 * USB probe and disconnect routines.
1109 /* Little helpers: write/read buffers free */
1110 static void acm_write_buffers_free(struct acm
*acm
)
1115 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++)
1116 usb_free_coherent(acm
->dev
, acm
->writesize
, wb
->buf
, wb
->dmah
);
1119 static void acm_read_buffers_free(struct acm
*acm
)
1123 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1124 usb_free_coherent(acm
->dev
, acm
->readsize
,
1125 acm
->read_buffers
[i
].base
, acm
->read_buffers
[i
].dma
);
1128 /* Little helper: write buffers allocate */
1129 static int acm_write_buffers_alloc(struct acm
*acm
)
1134 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++) {
1135 wb
->buf
= usb_alloc_coherent(acm
->dev
, acm
->writesize
, GFP_KERNEL
,
1141 usb_free_coherent(acm
->dev
, acm
->writesize
,
1150 static int acm_probe(struct usb_interface
*intf
,
1151 const struct usb_device_id
*id
)
1153 struct usb_cdc_union_desc
*union_header
= NULL
;
1154 struct usb_cdc_call_mgmt_descriptor
*cmgmd
= NULL
;
1155 unsigned char *buffer
= intf
->altsetting
->extra
;
1156 int buflen
= intf
->altsetting
->extralen
;
1157 struct usb_interface
*control_interface
;
1158 struct usb_interface
*data_interface
;
1159 struct usb_endpoint_descriptor
*epctrl
= NULL
;
1160 struct usb_endpoint_descriptor
*epread
= NULL
;
1161 struct usb_endpoint_descriptor
*epwrite
= NULL
;
1162 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1163 struct usb_cdc_parsed_header h
;
1166 int ctrlsize
, readsize
;
1168 int call_intf_num
= -1;
1169 int data_intf_num
= -1;
1170 unsigned long quirks
;
1173 int combined_interfaces
= 0;
1174 struct device
*tty_dev
;
1178 quirks
= (unsigned long)id
->driver_info
;
1180 if (quirks
== IGNORE_DEVICE
)
1183 memset(&h
, 0x00, sizeof(struct usb_cdc_parsed_header
));
1185 num_rx_buf
= (quirks
== SINGLE_RX_URB
) ? 1 : ACM_NR
;
1187 /* handle quirks deadly to normal probing*/
1188 if (quirks
== NO_UNION_NORMAL
) {
1189 data_interface
= usb_ifnum_to_if(usb_dev
, 1);
1190 control_interface
= usb_ifnum_to_if(usb_dev
, 0);
1191 /* we would crash */
1192 if (!data_interface
|| !control_interface
)
1194 goto skip_normal_probe
;
1199 dev_err(&intf
->dev
, "Weird descriptor references\n");
1203 if (!intf
->cur_altsetting
)
1207 if (intf
->cur_altsetting
->endpoint
&&
1208 intf
->cur_altsetting
->endpoint
->extralen
&&
1209 intf
->cur_altsetting
->endpoint
->extra
) {
1211 "Seeking extra descriptors on endpoint\n");
1212 buflen
= intf
->cur_altsetting
->endpoint
->extralen
;
1213 buffer
= intf
->cur_altsetting
->endpoint
->extra
;
1216 "Zero length descriptor references\n");
1221 cdc_parse_cdc_header(&h
, intf
, buffer
, buflen
);
1222 union_header
= h
.usb_cdc_union_desc
;
1223 cmgmd
= h
.usb_cdc_call_mgmt_descriptor
;
1225 call_intf_num
= cmgmd
->bDataInterface
;
1227 if (!union_header
) {
1228 if (call_intf_num
> 0) {
1229 dev_dbg(&intf
->dev
, "No union descriptor, using call management descriptor\n");
1230 /* quirks for Droids MuIn LCD */
1231 if (quirks
& NO_DATA_INTERFACE
) {
1232 data_interface
= usb_ifnum_to_if(usb_dev
, 0);
1234 data_intf_num
= call_intf_num
;
1235 data_interface
= usb_ifnum_to_if(usb_dev
, data_intf_num
);
1237 control_interface
= intf
;
1239 if (intf
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1240 dev_dbg(&intf
->dev
,"No union descriptor, giving up\n");
1243 dev_warn(&intf
->dev
,"No union descriptor, testing for castrated device\n");
1244 combined_interfaces
= 1;
1245 control_interface
= data_interface
= intf
;
1246 goto look_for_collapsed_interface
;
1250 data_intf_num
= union_header
->bSlaveInterface0
;
1251 control_interface
= usb_ifnum_to_if(usb_dev
, union_header
->bMasterInterface0
);
1252 data_interface
= usb_ifnum_to_if(usb_dev
, data_intf_num
);
1255 if (!control_interface
|| !data_interface
) {
1256 dev_dbg(&intf
->dev
, "no interfaces\n");
1259 if (!data_interface
->cur_altsetting
|| !control_interface
->cur_altsetting
)
1262 if (data_intf_num
!= call_intf_num
)
1263 dev_dbg(&intf
->dev
, "Separate call control interface. That is not fully supported.\n");
1265 if (control_interface
== data_interface
) {
1266 /* some broken devices designed for windows work this way */
1267 dev_warn(&intf
->dev
,"Control and data interfaces are not separated!\n");
1268 combined_interfaces
= 1;
1269 /* a popular other OS doesn't use it */
1270 quirks
|= NO_CAP_LINE
;
1271 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1272 dev_err(&intf
->dev
, "This needs exactly 3 endpoints\n");
1275 look_for_collapsed_interface
:
1276 for (i
= 0; i
< 3; i
++) {
1277 struct usb_endpoint_descriptor
*ep
;
1278 ep
= &data_interface
->cur_altsetting
->endpoint
[i
].desc
;
1280 if (usb_endpoint_is_int_in(ep
))
1282 else if (usb_endpoint_is_bulk_out(ep
))
1284 else if (usb_endpoint_is_bulk_in(ep
))
1289 if (!epctrl
|| !epread
|| !epwrite
)
1292 goto made_compressed_probe
;
1297 /*workaround for switched interfaces */
1298 if (data_interface
->cur_altsetting
->desc
.bInterfaceClass
1299 != CDC_DATA_INTERFACE_TYPE
) {
1300 if (control_interface
->cur_altsetting
->desc
.bInterfaceClass
1301 == CDC_DATA_INTERFACE_TYPE
) {
1303 "Your device has switched interfaces.\n");
1304 swap(control_interface
, data_interface
);
1310 /* Accept probe requests only for the control interface */
1311 if (!combined_interfaces
&& intf
!= control_interface
)
1314 if (!combined_interfaces
&& usb_interface_claimed(data_interface
)) {
1315 /* valid in this context */
1316 dev_dbg(&intf
->dev
, "The data interface isn't available\n");
1321 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
< 2 ||
1322 control_interface
->cur_altsetting
->desc
.bNumEndpoints
== 0)
1325 epctrl
= &control_interface
->cur_altsetting
->endpoint
[0].desc
;
1326 epread
= &data_interface
->cur_altsetting
->endpoint
[0].desc
;
1327 epwrite
= &data_interface
->cur_altsetting
->endpoint
[1].desc
;
1330 /* workaround for switched endpoints */
1331 if (!usb_endpoint_dir_in(epread
)) {
1332 /* descriptors are swapped */
1334 "The data interface has switched endpoints\n");
1335 swap(epread
, epwrite
);
1337 made_compressed_probe
:
1338 dev_dbg(&intf
->dev
, "interfaces are valid\n");
1340 acm
= kzalloc(sizeof(struct acm
), GFP_KERNEL
);
1344 minor
= acm_alloc_minor(acm
);
1348 ctrlsize
= usb_endpoint_maxp(epctrl
);
1349 readsize
= usb_endpoint_maxp(epread
) *
1350 (quirks
== SINGLE_RX_URB
? 1 : 2);
1351 acm
->combined_interfaces
= combined_interfaces
;
1352 acm
->writesize
= usb_endpoint_maxp(epwrite
) * 20;
1353 acm
->control
= control_interface
;
1354 acm
->data
= data_interface
;
1357 if (h
.usb_cdc_acm_descriptor
)
1358 acm
->ctrl_caps
= h
.usb_cdc_acm_descriptor
->bmCapabilities
;
1359 if (quirks
& NO_CAP_LINE
)
1360 acm
->ctrl_caps
&= ~USB_CDC_CAP_LINE
;
1361 acm
->ctrlsize
= ctrlsize
;
1362 acm
->readsize
= readsize
;
1363 acm
->rx_buflimit
= num_rx_buf
;
1364 INIT_WORK(&acm
->work
, acm_softint
);
1365 init_waitqueue_head(&acm
->wioctl
);
1366 spin_lock_init(&acm
->write_lock
);
1367 spin_lock_init(&acm
->read_lock
);
1368 mutex_init(&acm
->mutex
);
1369 if (usb_endpoint_xfer_int(epread
)) {
1370 acm
->bInterval
= epread
->bInterval
;
1371 acm
->in
= usb_rcvintpipe(usb_dev
, epread
->bEndpointAddress
);
1373 acm
->in
= usb_rcvbulkpipe(usb_dev
, epread
->bEndpointAddress
);
1375 if (usb_endpoint_xfer_int(epwrite
))
1376 acm
->out
= usb_sndintpipe(usb_dev
, epwrite
->bEndpointAddress
);
1378 acm
->out
= usb_sndbulkpipe(usb_dev
, epwrite
->bEndpointAddress
);
1379 tty_port_init(&acm
->port
);
1380 acm
->port
.ops
= &acm_port_ops
;
1381 init_usb_anchor(&acm
->delayed
);
1382 acm
->quirks
= quirks
;
1384 buf
= usb_alloc_coherent(usb_dev
, ctrlsize
, GFP_KERNEL
, &acm
->ctrl_dma
);
1387 acm
->ctrl_buffer
= buf
;
1389 if (acm_write_buffers_alloc(acm
) < 0)
1392 acm
->ctrlurb
= usb_alloc_urb(0, GFP_KERNEL
);
1396 for (i
= 0; i
< num_rx_buf
; i
++) {
1397 struct acm_rb
*rb
= &(acm
->read_buffers
[i
]);
1400 rb
->base
= usb_alloc_coherent(acm
->dev
, readsize
, GFP_KERNEL
,
1407 urb
= usb_alloc_urb(0, GFP_KERNEL
);
1411 urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1412 urb
->transfer_dma
= rb
->dma
;
1413 if (usb_endpoint_xfer_int(epread
))
1414 usb_fill_int_urb(urb
, acm
->dev
, acm
->in
, rb
->base
,
1416 acm_read_bulk_callback
, rb
,
1419 usb_fill_bulk_urb(urb
, acm
->dev
, acm
->in
, rb
->base
,
1421 acm_read_bulk_callback
, rb
);
1423 acm
->read_urbs
[i
] = urb
;
1424 __set_bit(i
, &acm
->read_urbs_free
);
1426 for (i
= 0; i
< ACM_NW
; i
++) {
1427 struct acm_wb
*snd
= &(acm
->wb
[i
]);
1429 snd
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1430 if (snd
->urb
== NULL
)
1433 if (usb_endpoint_xfer_int(epwrite
))
1434 usb_fill_int_urb(snd
->urb
, usb_dev
, acm
->out
,
1435 NULL
, acm
->writesize
, acm_write_bulk
, snd
, epwrite
->bInterval
);
1437 usb_fill_bulk_urb(snd
->urb
, usb_dev
, acm
->out
,
1438 NULL
, acm
->writesize
, acm_write_bulk
, snd
);
1439 snd
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1440 if (quirks
& SEND_ZERO_PACKET
)
1441 snd
->urb
->transfer_flags
|= URB_ZERO_PACKET
;
1442 snd
->instance
= acm
;
1445 usb_set_intfdata(intf
, acm
);
1447 i
= device_create_file(&intf
->dev
, &dev_attr_bmCapabilities
);
1451 if (h
.usb_cdc_country_functional_desc
) { /* export the country data */
1452 struct usb_cdc_country_functional_desc
* cfd
=
1453 h
.usb_cdc_country_functional_desc
;
1455 acm
->country_codes
= kmalloc(cfd
->bLength
- 4, GFP_KERNEL
);
1456 if (!acm
->country_codes
)
1457 goto skip_countries
;
1458 acm
->country_code_size
= cfd
->bLength
- 4;
1459 memcpy(acm
->country_codes
, (u8
*)&cfd
->wCountyCode0
,
1461 acm
->country_rel_date
= cfd
->iCountryCodeRelDate
;
1463 i
= device_create_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1465 kfree(acm
->country_codes
);
1466 acm
->country_codes
= NULL
;
1467 acm
->country_code_size
= 0;
1468 goto skip_countries
;
1471 i
= device_create_file(&intf
->dev
,
1472 &dev_attr_iCountryCodeRelDate
);
1474 device_remove_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1475 kfree(acm
->country_codes
);
1476 acm
->country_codes
= NULL
;
1477 acm
->country_code_size
= 0;
1478 goto skip_countries
;
1483 usb_fill_int_urb(acm
->ctrlurb
, usb_dev
,
1484 usb_rcvintpipe(usb_dev
, epctrl
->bEndpointAddress
),
1485 acm
->ctrl_buffer
, ctrlsize
, acm_ctrl_irq
, acm
,
1486 /* works around buggy devices */
1487 epctrl
->bInterval
? epctrl
->bInterval
: 16);
1488 acm
->ctrlurb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1489 acm
->ctrlurb
->transfer_dma
= acm
->ctrl_dma
;
1491 dev_info(&intf
->dev
, "ttyACM%d: USB ACM device\n", minor
);
1493 acm
->line
.dwDTERate
= cpu_to_le32(9600);
1494 acm
->line
.bDataBits
= 8;
1495 acm_set_line(acm
, &acm
->line
);
1497 usb_driver_claim_interface(&acm_driver
, data_interface
, acm
);
1498 usb_set_intfdata(data_interface
, acm
);
1500 usb_get_intf(control_interface
);
1501 tty_dev
= tty_port_register_device(&acm
->port
, acm_tty_driver
, minor
,
1502 &control_interface
->dev
);
1503 if (IS_ERR(tty_dev
)) {
1504 rv
= PTR_ERR(tty_dev
);
1508 if (quirks
& CLEAR_HALT_CONDITIONS
) {
1509 usb_clear_halt(usb_dev
, acm
->in
);
1510 usb_clear_halt(usb_dev
, acm
->out
);
1515 if (acm
->country_codes
) {
1516 device_remove_file(&acm
->control
->dev
,
1517 &dev_attr_wCountryCodes
);
1518 device_remove_file(&acm
->control
->dev
,
1519 &dev_attr_iCountryCodeRelDate
);
1520 kfree(acm
->country_codes
);
1522 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1524 usb_set_intfdata(intf
, NULL
);
1525 for (i
= 0; i
< ACM_NW
; i
++)
1526 usb_free_urb(acm
->wb
[i
].urb
);
1528 for (i
= 0; i
< num_rx_buf
; i
++)
1529 usb_free_urb(acm
->read_urbs
[i
]);
1530 acm_read_buffers_free(acm
);
1531 usb_free_urb(acm
->ctrlurb
);
1533 acm_write_buffers_free(acm
);
1535 usb_free_coherent(usb_dev
, ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1537 acm_release_minor(acm
);
1544 static void acm_disconnect(struct usb_interface
*intf
)
1546 struct acm
*acm
= usb_get_intfdata(intf
);
1547 struct tty_struct
*tty
;
1549 /* sibling interface is already cleaning up */
1553 mutex_lock(&acm
->mutex
);
1554 acm
->disconnected
= true;
1555 if (acm
->country_codes
) {
1556 device_remove_file(&acm
->control
->dev
,
1557 &dev_attr_wCountryCodes
);
1558 device_remove_file(&acm
->control
->dev
,
1559 &dev_attr_iCountryCodeRelDate
);
1561 wake_up_all(&acm
->wioctl
);
1562 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1563 usb_set_intfdata(acm
->control
, NULL
);
1564 usb_set_intfdata(acm
->data
, NULL
);
1565 mutex_unlock(&acm
->mutex
);
1567 tty
= tty_port_tty_get(&acm
->port
);
1574 cancel_work_sync(&acm
->work
);
1576 tty_unregister_device(acm_tty_driver
, acm
->minor
);
1578 acm_write_buffers_free(acm
);
1579 usb_free_coherent(acm
->dev
, acm
->ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1580 acm_read_buffers_free(acm
);
1582 if (!acm
->combined_interfaces
)
1583 usb_driver_release_interface(&acm_driver
, intf
== acm
->control
?
1584 acm
->data
: acm
->control
);
1586 tty_port_put(&acm
->port
);
1590 static int acm_suspend(struct usb_interface
*intf
, pm_message_t message
)
1592 struct acm
*acm
= usb_get_intfdata(intf
);
1595 spin_lock_irq(&acm
->write_lock
);
1596 if (PMSG_IS_AUTO(message
)) {
1597 if (acm
->transmitting
) {
1598 spin_unlock_irq(&acm
->write_lock
);
1602 cnt
= acm
->susp_count
++;
1603 spin_unlock_irq(&acm
->write_lock
);
1609 cancel_work_sync(&acm
->work
);
1614 static int acm_resume(struct usb_interface
*intf
)
1616 struct acm
*acm
= usb_get_intfdata(intf
);
1620 spin_lock_irq(&acm
->write_lock
);
1622 if (--acm
->susp_count
)
1625 if (tty_port_initialized(&acm
->port
)) {
1626 rv
= usb_submit_urb(acm
->ctrlurb
, GFP_ATOMIC
);
1629 urb
= usb_get_from_anchor(&acm
->delayed
);
1633 acm_start_wb(acm
, urb
->context
);
1637 * delayed error checking because we must
1638 * do the write path at all cost
1643 rv
= acm_submit_read_urbs(acm
, GFP_ATOMIC
);
1646 spin_unlock_irq(&acm
->write_lock
);
1651 static int acm_reset_resume(struct usb_interface
*intf
)
1653 struct acm
*acm
= usb_get_intfdata(intf
);
1655 if (tty_port_initialized(&acm
->port
))
1656 tty_port_tty_hangup(&acm
->port
, false);
1658 return acm_resume(intf
);
1661 #endif /* CONFIG_PM */
1663 static int acm_pre_reset(struct usb_interface
*intf
)
1665 struct acm
*acm
= usb_get_intfdata(intf
);
1667 clear_bit(EVENT_RX_STALL
, &acm
->flags
);
1672 #define NOKIA_PCSUITE_ACM_INFO(x) \
1673 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1674 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1675 USB_CDC_ACM_PROTO_VENDOR)
1677 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1678 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1679 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1680 USB_CDC_ACM_PROTO_VENDOR)
1683 * USB driver structure.
1686 static const struct usb_device_id acm_ids
[] = {
1687 /* quirky and broken devices */
1688 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1689 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1690 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1691 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1692 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1693 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1695 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1696 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1698 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1699 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1701 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1702 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1704 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1705 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1707 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1708 .driver_info
= SINGLE_RX_URB
,
1710 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1711 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1713 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1714 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1716 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1717 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1719 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1720 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1722 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1723 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1725 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1726 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1728 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1729 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1731 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1732 .driver_info
= QUIRK_CONTROL_LINE_STATE
, },
1733 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1734 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1735 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1737 /* Motorola H24 HSPA module: */
1738 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1739 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1740 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1742 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1743 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1745 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1746 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1748 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1749 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1751 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1752 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1754 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1755 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1757 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1758 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1761 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1762 .driver_info
= NO_UNION_NORMAL
, /* union descriptor misplaced on
1763 data interface instead of
1764 communications interface.
1765 Maybe we should define a new
1768 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1769 .driver_info
= NO_UNION_NORMAL
,
1771 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1772 .driver_info
= NO_UNION_NORMAL
,
1774 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1775 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1777 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1778 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1781 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1782 .driver_info
= CLEAR_HALT_CONDITIONS
,
1785 /* Nokia S60 phones expose two ACM channels. The first is
1786 * a modem and is picked up by the standard AT-command
1787 * information below. The second is 'vendor-specific' but
1788 * is treated as a serial device at the S60 end, so we want
1789 * to expose it on Linux too. */
1790 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1791 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1792 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1793 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1794 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1795 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1796 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1797 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1798 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1799 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1800 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1801 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1802 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1803 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1804 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1805 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1806 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1807 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1808 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1809 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1810 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1811 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1812 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1813 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1814 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1815 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1816 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1817 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1818 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1819 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1820 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1821 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1822 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1823 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1824 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1825 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1826 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1827 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1828 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1829 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1830 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1831 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1832 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1833 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1834 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1835 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1836 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1837 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1838 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1839 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1840 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1841 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1842 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1843 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1844 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1845 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1846 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1847 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1849 /* Support for Owen devices */
1850 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1852 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1854 /* Support for Droids MuIn LCD */
1855 { USB_DEVICE(0x04d8, 0x000b),
1856 .driver_info
= NO_DATA_INTERFACE
,
1859 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1860 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1861 .driver_info
= IGNORE_DEVICE
,
1863 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1864 .driver_info
= IGNORE_DEVICE
,
1868 /*Samsung phone in firmware update mode */
1869 { USB_DEVICE(0x04e8, 0x685d),
1870 .driver_info
= IGNORE_DEVICE
,
1873 /* Exclude Infineon Flash Loader utility */
1874 { USB_DEVICE(0x058b, 0x0041),
1875 .driver_info
= IGNORE_DEVICE
,
1878 /* control interfaces without any protocol set */
1879 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1880 USB_CDC_PROTO_NONE
) },
1882 /* control interfaces with various AT-command sets */
1883 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1884 USB_CDC_ACM_PROTO_AT_V25TER
) },
1885 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1886 USB_CDC_ACM_PROTO_AT_PCCA101
) },
1887 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1888 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE
) },
1889 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1890 USB_CDC_ACM_PROTO_AT_GSM
) },
1891 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1892 USB_CDC_ACM_PROTO_AT_3G
) },
1893 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1894 USB_CDC_ACM_PROTO_AT_CDMA
) },
1896 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1897 .driver_info
= SEND_ZERO_PACKET
,
1903 MODULE_DEVICE_TABLE(usb
, acm_ids
);
1905 static struct usb_driver acm_driver
= {
1908 .disconnect
= acm_disconnect
,
1910 .suspend
= acm_suspend
,
1911 .resume
= acm_resume
,
1912 .reset_resume
= acm_reset_resume
,
1914 .pre_reset
= acm_pre_reset
,
1915 .id_table
= acm_ids
,
1917 .supports_autosuspend
= 1,
1919 .disable_hub_initiated_lpm
= 1,
1923 * TTY driver structures.
1926 static const struct tty_operations acm_ops
= {
1927 .install
= acm_tty_install
,
1928 .open
= acm_tty_open
,
1929 .close
= acm_tty_close
,
1930 .cleanup
= acm_tty_cleanup
,
1931 .hangup
= acm_tty_hangup
,
1932 .write
= acm_tty_write
,
1933 .put_char
= acm_tty_put_char
,
1934 .flush_chars
= acm_tty_flush_chars
,
1935 .write_room
= acm_tty_write_room
,
1936 .ioctl
= acm_tty_ioctl
,
1937 .throttle
= acm_tty_throttle
,
1938 .unthrottle
= acm_tty_unthrottle
,
1939 .chars_in_buffer
= acm_tty_chars_in_buffer
,
1940 .break_ctl
= acm_tty_break_ctl
,
1941 .set_termios
= acm_tty_set_termios
,
1942 .tiocmget
= acm_tty_tiocmget
,
1943 .tiocmset
= acm_tty_tiocmset
,
1944 .get_icount
= acm_tty_get_icount
,
1951 static int __init
acm_init(void)
1954 acm_tty_driver
= alloc_tty_driver(ACM_TTY_MINORS
);
1955 if (!acm_tty_driver
)
1957 acm_tty_driver
->driver_name
= "acm",
1958 acm_tty_driver
->name
= "ttyACM",
1959 acm_tty_driver
->major
= ACM_TTY_MAJOR
,
1960 acm_tty_driver
->minor_start
= 0,
1961 acm_tty_driver
->type
= TTY_DRIVER_TYPE_SERIAL
,
1962 acm_tty_driver
->subtype
= SERIAL_TYPE_NORMAL
,
1963 acm_tty_driver
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
1964 acm_tty_driver
->init_termios
= tty_std_termios
;
1965 acm_tty_driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
|
1967 tty_set_operations(acm_tty_driver
, &acm_ops
);
1969 retval
= tty_register_driver(acm_tty_driver
);
1971 put_tty_driver(acm_tty_driver
);
1975 retval
= usb_register(&acm_driver
);
1977 tty_unregister_driver(acm_tty_driver
);
1978 put_tty_driver(acm_tty_driver
);
1982 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1987 static void __exit
acm_exit(void)
1989 usb_deregister(&acm_driver
);
1990 tty_unregister_driver(acm_tty_driver
);
1991 put_tty_driver(acm_tty_driver
);
1992 idr_destroy(&acm_minors
);
1995 module_init(acm_init
);
1996 module_exit(acm_exit
);
1998 MODULE_AUTHOR(DRIVER_AUTHOR
);
1999 MODULE_DESCRIPTION(DRIVER_DESC
);
2000 MODULE_LICENSE("GPL");
2001 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR
);