4 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
5 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
6 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
9 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
10 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 * USB Abstract Control Model driver for USB modems and ISDN adapters
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include <linux/kernel.h>
35 #include <linux/errno.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/tty.h>
39 #include <linux/serial.h>
40 #include <linux/tty_driver.h>
41 #include <linux/tty_flip.h>
42 #include <linux/module.h>
43 #include <linux/mutex.h>
44 #include <linux/uaccess.h>
45 #include <linux/usb.h>
46 #include <linux/usb/cdc.h>
47 #include <asm/byteorder.h>
48 #include <asm/unaligned.h>
49 #include <linux/list.h>
54 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
55 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
57 static struct usb_driver acm_driver
;
58 static struct tty_driver
*acm_tty_driver
;
59 static struct acm
*acm_table
[ACM_TTY_MINORS
];
61 static DEFINE_MUTEX(acm_table_lock
);
68 * Look up an ACM structure by index. If found and not disconnected, increment
69 * its refcount and return it with its mutex held.
71 static struct acm
*acm_get_by_index(unsigned index
)
75 mutex_lock(&acm_table_lock
);
76 acm
= acm_table
[index
];
78 mutex_lock(&acm
->mutex
);
79 if (acm
->disconnected
) {
80 mutex_unlock(&acm
->mutex
);
83 tty_port_get(&acm
->port
);
84 mutex_unlock(&acm
->mutex
);
87 mutex_unlock(&acm_table_lock
);
92 * Try to find an available minor number and if found, associate it with 'acm'.
94 static int acm_alloc_minor(struct acm
*acm
)
98 mutex_lock(&acm_table_lock
);
99 for (minor
= 0; minor
< ACM_TTY_MINORS
; minor
++) {
100 if (!acm_table
[minor
]) {
101 acm_table
[minor
] = acm
;
105 mutex_unlock(&acm_table_lock
);
110 /* Release the minor number associated with 'acm'. */
111 static void acm_release_minor(struct acm
*acm
)
113 mutex_lock(&acm_table_lock
);
114 acm_table
[acm
->minor
] = NULL
;
115 mutex_unlock(&acm_table_lock
);
119 * Functions for ACM control messages.
122 static int acm_ctrl_msg(struct acm
*acm
, int request
, int value
,
127 retval
= usb_autopm_get_interface(acm
->control
);
131 retval
= usb_control_msg(acm
->dev
, usb_sndctrlpipe(acm
->dev
, 0),
132 request
, USB_RT_ACM
, value
,
133 acm
->control
->altsetting
[0].desc
.bInterfaceNumber
,
136 dev_dbg(&acm
->control
->dev
,
137 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
138 __func__
, request
, value
, len
, retval
);
140 usb_autopm_put_interface(acm
->control
);
142 return retval
< 0 ? retval
: 0;
145 /* devices aren't required to support these requests.
146 * the cdc acm descriptor tells whether they do...
148 #define acm_set_control(acm, control) \
149 acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
150 #define acm_set_line(acm, line) \
151 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
152 #define acm_send_break(acm, ms) \
153 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
156 * Write buffer management.
157 * All of these assume proper locks taken by the caller.
160 static int acm_wb_alloc(struct acm
*acm
)
173 wbn
= (wbn
+ 1) % ACM_NW
;
179 static int acm_wb_is_avail(struct acm
*acm
)
185 spin_lock_irqsave(&acm
->write_lock
, flags
);
186 for (i
= 0; i
< ACM_NW
; i
++)
188 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
193 * Finish write. Caller must hold acm->write_lock
195 static void acm_write_done(struct acm
*acm
, struct acm_wb
*wb
)
199 usb_autopm_put_interface_async(acm
->control
);
205 * the caller is responsible for locking
208 static int acm_start_wb(struct acm
*acm
, struct acm_wb
*wb
)
214 wb
->urb
->transfer_buffer
= wb
->buf
;
215 wb
->urb
->transfer_dma
= wb
->dmah
;
216 wb
->urb
->transfer_buffer_length
= wb
->len
;
217 wb
->urb
->dev
= acm
->dev
;
219 rc
= usb_submit_urb(wb
->urb
, GFP_ATOMIC
);
221 dev_err(&acm
->data
->dev
,
222 "%s - usb_submit_urb(write bulk) failed: %d\n",
224 acm_write_done(acm
, wb
);
230 * attributes exported through sysfs
232 static ssize_t show_caps
233 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
235 struct usb_interface
*intf
= to_usb_interface(dev
);
236 struct acm
*acm
= usb_get_intfdata(intf
);
238 return sprintf(buf
, "%d", acm
->ctrl_caps
);
240 static DEVICE_ATTR(bmCapabilities
, S_IRUGO
, show_caps
, NULL
);
242 static ssize_t show_country_codes
243 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
245 struct usb_interface
*intf
= to_usb_interface(dev
);
246 struct acm
*acm
= usb_get_intfdata(intf
);
248 memcpy(buf
, acm
->country_codes
, acm
->country_code_size
);
249 return acm
->country_code_size
;
252 static DEVICE_ATTR(wCountryCodes
, S_IRUGO
, show_country_codes
, NULL
);
254 static ssize_t show_country_rel_date
255 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
257 struct usb_interface
*intf
= to_usb_interface(dev
);
258 struct acm
*acm
= usb_get_intfdata(intf
);
260 return sprintf(buf
, "%d", acm
->country_rel_date
);
263 static DEVICE_ATTR(iCountryCodeRelDate
, S_IRUGO
, show_country_rel_date
, NULL
);
265 * Interrupt handlers for various ACM device responses
268 /* control interface reports status changes with "interrupt" transfers */
269 static void acm_ctrl_irq(struct urb
*urb
)
271 struct acm
*acm
= urb
->context
;
272 struct usb_cdc_notification
*dr
= urb
->transfer_buffer
;
277 int status
= urb
->status
;
286 /* this urb is terminated, clean up */
287 dev_dbg(&acm
->control
->dev
,
288 "%s - urb shutting down with status: %d\n",
292 dev_dbg(&acm
->control
->dev
,
293 "%s - nonzero urb status received: %d\n",
298 usb_mark_last_busy(acm
->dev
);
300 data
= (unsigned char *)(dr
+ 1);
301 switch (dr
->bNotificationType
) {
302 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
303 dev_dbg(&acm
->control
->dev
, "%s - network connection: %d\n",
304 __func__
, dr
->wValue
);
307 case USB_CDC_NOTIFY_SERIAL_STATE
:
308 newctrl
= get_unaligned_le16(data
);
310 if (!acm
->clocal
&& (acm
->ctrlin
& ~newctrl
& ACM_CTRL_DCD
)) {
311 dev_dbg(&acm
->control
->dev
, "%s - calling hangup\n",
313 tty_port_tty_hangup(&acm
->port
, false);
316 difference
= acm
->ctrlin
^ newctrl
;
317 spin_lock(&acm
->read_lock
);
318 acm
->ctrlin
= newctrl
;
319 acm
->oldcount
= acm
->iocount
;
321 if (difference
& ACM_CTRL_DSR
)
323 if (difference
& ACM_CTRL_BRK
)
325 if (difference
& ACM_CTRL_RI
)
327 if (difference
& ACM_CTRL_DCD
)
329 if (difference
& ACM_CTRL_FRAMING
)
330 acm
->iocount
.frame
++;
331 if (difference
& ACM_CTRL_PARITY
)
332 acm
->iocount
.parity
++;
333 if (difference
& ACM_CTRL_OVERRUN
)
334 acm
->iocount
.overrun
++;
335 spin_unlock(&acm
->read_lock
);
338 wake_up_all(&acm
->wioctl
);
343 dev_dbg(&acm
->control
->dev
,
344 "%s - unknown notification %d received: index %d "
345 "len %d data0 %d data1 %d\n",
347 dr
->bNotificationType
, dr
->wIndex
,
348 dr
->wLength
, data
[0], data
[1]);
352 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
354 dev_err(&acm
->control
->dev
, "%s - usb_submit_urb failed: %d\n",
358 static int acm_submit_read_urb(struct acm
*acm
, int index
, gfp_t mem_flags
)
362 if (!test_and_clear_bit(index
, &acm
->read_urbs_free
))
365 dev_vdbg(&acm
->data
->dev
, "%s - urb %d\n", __func__
, index
);
367 res
= usb_submit_urb(acm
->read_urbs
[index
], mem_flags
);
370 dev_err(&acm
->data
->dev
,
371 "%s - usb_submit_urb failed: %d\n",
374 set_bit(index
, &acm
->read_urbs_free
);
381 static int acm_submit_read_urbs(struct acm
*acm
, gfp_t mem_flags
)
386 for (i
= 0; i
< acm
->rx_buflimit
; ++i
) {
387 res
= acm_submit_read_urb(acm
, i
, mem_flags
);
395 static void acm_process_read_urb(struct acm
*acm
, struct urb
*urb
)
397 if (!urb
->actual_length
)
400 tty_insert_flip_string(&acm
->port
, urb
->transfer_buffer
,
402 tty_flip_buffer_push(&acm
->port
);
405 static void acm_read_bulk_callback(struct urb
*urb
)
407 struct acm_rb
*rb
= urb
->context
;
408 struct acm
*acm
= rb
->instance
;
411 dev_vdbg(&acm
->data
->dev
, "%s - urb %d, len %d\n", __func__
,
412 rb
->index
, urb
->actual_length
);
413 set_bit(rb
->index
, &acm
->read_urbs_free
);
416 dev_dbg(&acm
->data
->dev
, "%s - disconnected\n", __func__
);
421 dev_dbg(&acm
->data
->dev
, "%s - non-zero urb status: %d\n",
422 __func__
, urb
->status
);
426 usb_mark_last_busy(acm
->dev
);
428 acm_process_read_urb(acm
, urb
);
430 /* throttle device if requested by tty */
431 spin_lock_irqsave(&acm
->read_lock
, flags
);
432 acm
->throttled
= acm
->throttle_req
;
433 if (!acm
->throttled
) {
434 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
435 acm_submit_read_urb(acm
, rb
->index
, GFP_ATOMIC
);
437 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
441 /* data interface wrote those outgoing bytes */
442 static void acm_write_bulk(struct urb
*urb
)
444 struct acm_wb
*wb
= urb
->context
;
445 struct acm
*acm
= wb
->instance
;
448 if (urb
->status
|| (urb
->actual_length
!= urb
->transfer_buffer_length
))
449 dev_vdbg(&acm
->data
->dev
, "%s - len %d/%d, status %d\n",
452 urb
->transfer_buffer_length
,
455 spin_lock_irqsave(&acm
->write_lock
, flags
);
456 acm_write_done(acm
, wb
);
457 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
458 schedule_work(&acm
->work
);
461 static void acm_softint(struct work_struct
*work
)
463 struct acm
*acm
= container_of(work
, struct acm
, work
);
465 dev_vdbg(&acm
->data
->dev
, "%s\n", __func__
);
467 tty_port_tty_wakeup(&acm
->port
);
474 static int acm_tty_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
479 dev_dbg(tty
->dev
, "%s\n", __func__
);
481 acm
= acm_get_by_index(tty
->index
);
485 retval
= tty_standard_install(driver
, tty
);
487 goto error_init_termios
;
489 tty
->driver_data
= acm
;
494 tty_port_put(&acm
->port
);
498 static int acm_tty_open(struct tty_struct
*tty
, struct file
*filp
)
500 struct acm
*acm
= tty
->driver_data
;
502 dev_dbg(tty
->dev
, "%s\n", __func__
);
504 return tty_port_open(&acm
->port
, tty
, filp
);
507 static void acm_port_dtr_rts(struct tty_port
*port
, int raise
)
509 struct acm
*acm
= container_of(port
, struct acm
, port
);
514 val
= ACM_CTRL_DTR
| ACM_CTRL_RTS
;
518 /* FIXME: add missing ctrlout locking throughout driver */
521 res
= acm_set_control(acm
, val
);
522 if (res
&& (acm
->ctrl_caps
& USB_CDC_CAP_LINE
))
523 dev_err(&acm
->control
->dev
, "failed to set dtr/rts\n");
526 static int acm_port_activate(struct tty_port
*port
, struct tty_struct
*tty
)
528 struct acm
*acm
= container_of(port
, struct acm
, port
);
529 int retval
= -ENODEV
;
532 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
534 mutex_lock(&acm
->mutex
);
535 if (acm
->disconnected
)
538 retval
= usb_autopm_get_interface(acm
->control
);
540 goto error_get_interface
;
543 * FIXME: Why do we need this? Allocating 64K of physically contiguous
544 * memory is really nasty...
546 set_bit(TTY_NO_WRITE_SPLIT
, &tty
->flags
);
547 acm
->control
->needs_remote_wakeup
= 1;
549 acm
->ctrlurb
->dev
= acm
->dev
;
550 retval
= usb_submit_urb(acm
->ctrlurb
, GFP_KERNEL
);
552 dev_err(&acm
->control
->dev
,
553 "%s - usb_submit_urb(ctrl irq) failed\n", __func__
);
554 goto error_submit_urb
;
558 * Unthrottle device in case the TTY was closed while throttled.
560 spin_lock_irq(&acm
->read_lock
);
562 acm
->throttle_req
= 0;
563 spin_unlock_irq(&acm
->read_lock
);
565 retval
= acm_submit_read_urbs(acm
, GFP_KERNEL
);
567 goto error_submit_read_urbs
;
569 usb_autopm_put_interface(acm
->control
);
571 mutex_unlock(&acm
->mutex
);
575 error_submit_read_urbs
:
576 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
577 usb_kill_urb(acm
->read_urbs
[i
]);
578 usb_kill_urb(acm
->ctrlurb
);
580 usb_autopm_put_interface(acm
->control
);
583 mutex_unlock(&acm
->mutex
);
585 return usb_translate_errors(retval
);
588 static void acm_port_destruct(struct tty_port
*port
)
590 struct acm
*acm
= container_of(port
, struct acm
, port
);
592 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
594 acm_release_minor(acm
);
595 usb_put_intf(acm
->control
);
596 kfree(acm
->country_codes
);
600 static void acm_port_shutdown(struct tty_port
*port
)
602 struct acm
*acm
= container_of(port
, struct acm
, port
);
607 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
610 * Need to grab write_lock to prevent race with resume, but no need to
611 * hold it due to the tty-port initialised flag.
613 spin_lock_irq(&acm
->write_lock
);
614 spin_unlock_irq(&acm
->write_lock
);
616 usb_autopm_get_interface_no_resume(acm
->control
);
617 acm
->control
->needs_remote_wakeup
= 0;
618 usb_autopm_put_interface(acm
->control
);
621 urb
= usb_get_from_anchor(&acm
->delayed
);
626 usb_autopm_put_interface_async(acm
->control
);
629 usb_kill_urb(acm
->ctrlurb
);
630 for (i
= 0; i
< ACM_NW
; i
++)
631 usb_kill_urb(acm
->wb
[i
].urb
);
632 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
633 usb_kill_urb(acm
->read_urbs
[i
]);
636 static void acm_tty_cleanup(struct tty_struct
*tty
)
638 struct acm
*acm
= tty
->driver_data
;
639 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
640 tty_port_put(&acm
->port
);
643 static void acm_tty_hangup(struct tty_struct
*tty
)
645 struct acm
*acm
= tty
->driver_data
;
646 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
647 tty_port_hangup(&acm
->port
);
650 static void acm_tty_close(struct tty_struct
*tty
, struct file
*filp
)
652 struct acm
*acm
= tty
->driver_data
;
653 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
654 tty_port_close(&acm
->port
, tty
, filp
);
657 static int acm_tty_write(struct tty_struct
*tty
,
658 const unsigned char *buf
, int count
)
660 struct acm
*acm
= tty
->driver_data
;
669 dev_vdbg(&acm
->data
->dev
, "%s - count %d\n", __func__
, count
);
671 spin_lock_irqsave(&acm
->write_lock
, flags
);
672 wbn
= acm_wb_alloc(acm
);
674 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
681 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
685 count
= (count
> acm
->writesize
) ? acm
->writesize
: count
;
686 dev_vdbg(&acm
->data
->dev
, "%s - write %d\n", __func__
, count
);
687 memcpy(wb
->buf
, buf
, count
);
690 stat
= usb_autopm_get_interface_async(acm
->control
);
693 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
697 if (acm
->susp_count
) {
698 usb_anchor_urb(wb
->urb
, &acm
->delayed
);
699 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
703 stat
= acm_start_wb(acm
, wb
);
704 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
711 static int acm_tty_write_room(struct tty_struct
*tty
)
713 struct acm
*acm
= tty
->driver_data
;
715 * Do not let the line discipline to know that we have a reserve,
716 * or it might get too enthusiastic.
718 return acm_wb_is_avail(acm
) ? acm
->writesize
: 0;
721 static int acm_tty_chars_in_buffer(struct tty_struct
*tty
)
723 struct acm
*acm
= tty
->driver_data
;
725 * if the device was unplugged then any remaining characters fell out
726 * of the connector ;)
728 if (acm
->disconnected
)
731 * This is inaccurate (overcounts), but it works.
733 return (ACM_NW
- acm_wb_is_avail(acm
)) * acm
->writesize
;
736 static void acm_tty_throttle(struct tty_struct
*tty
)
738 struct acm
*acm
= tty
->driver_data
;
740 spin_lock_irq(&acm
->read_lock
);
741 acm
->throttle_req
= 1;
742 spin_unlock_irq(&acm
->read_lock
);
745 static void acm_tty_unthrottle(struct tty_struct
*tty
)
747 struct acm
*acm
= tty
->driver_data
;
748 unsigned int was_throttled
;
750 spin_lock_irq(&acm
->read_lock
);
751 was_throttled
= acm
->throttled
;
753 acm
->throttle_req
= 0;
754 spin_unlock_irq(&acm
->read_lock
);
757 acm_submit_read_urbs(acm
, GFP_KERNEL
);
760 static int acm_tty_break_ctl(struct tty_struct
*tty
, int state
)
762 struct acm
*acm
= tty
->driver_data
;
765 retval
= acm_send_break(acm
, state
? 0xffff : 0);
767 dev_dbg(&acm
->control
->dev
, "%s - send break failed\n",
772 static int acm_tty_tiocmget(struct tty_struct
*tty
)
774 struct acm
*acm
= tty
->driver_data
;
776 return (acm
->ctrlout
& ACM_CTRL_DTR
? TIOCM_DTR
: 0) |
777 (acm
->ctrlout
& ACM_CTRL_RTS
? TIOCM_RTS
: 0) |
778 (acm
->ctrlin
& ACM_CTRL_DSR
? TIOCM_DSR
: 0) |
779 (acm
->ctrlin
& ACM_CTRL_RI
? TIOCM_RI
: 0) |
780 (acm
->ctrlin
& ACM_CTRL_DCD
? TIOCM_CD
: 0) |
784 static int acm_tty_tiocmset(struct tty_struct
*tty
,
785 unsigned int set
, unsigned int clear
)
787 struct acm
*acm
= tty
->driver_data
;
788 unsigned int newctrl
;
790 newctrl
= acm
->ctrlout
;
791 set
= (set
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
792 (set
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
793 clear
= (clear
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
794 (clear
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
796 newctrl
= (newctrl
& ~clear
) | set
;
798 if (acm
->ctrlout
== newctrl
)
800 return acm_set_control(acm
, acm
->ctrlout
= newctrl
);
803 static int get_serial_info(struct acm
*acm
, struct serial_struct __user
*info
)
805 struct serial_struct tmp
;
810 memset(&tmp
, 0, sizeof(tmp
));
811 tmp
.flags
= ASYNC_LOW_LATENCY
;
812 tmp
.xmit_fifo_size
= acm
->writesize
;
813 tmp
.baud_base
= le32_to_cpu(acm
->line
.dwDTERate
);
814 tmp
.close_delay
= acm
->port
.close_delay
/ 10;
815 tmp
.closing_wait
= acm
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
816 ASYNC_CLOSING_WAIT_NONE
:
817 acm
->port
.closing_wait
/ 10;
819 if (copy_to_user(info
, &tmp
, sizeof(tmp
)))
825 static int set_serial_info(struct acm
*acm
,
826 struct serial_struct __user
*newinfo
)
828 struct serial_struct new_serial
;
829 unsigned int closing_wait
, close_delay
;
832 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
835 close_delay
= new_serial
.close_delay
* 10;
836 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
837 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
839 mutex_lock(&acm
->port
.mutex
);
841 if (!capable(CAP_SYS_ADMIN
)) {
842 if ((close_delay
!= acm
->port
.close_delay
) ||
843 (closing_wait
!= acm
->port
.closing_wait
))
846 retval
= -EOPNOTSUPP
;
848 acm
->port
.close_delay
= close_delay
;
849 acm
->port
.closing_wait
= closing_wait
;
852 mutex_unlock(&acm
->port
.mutex
);
856 static int wait_serial_change(struct acm
*acm
, unsigned long arg
)
859 DECLARE_WAITQUEUE(wait
, current
);
860 struct async_icount old
, new;
862 if (arg
& (TIOCM_DSR
| TIOCM_RI
| TIOCM_CD
))
865 spin_lock_irq(&acm
->read_lock
);
869 spin_unlock_irq(&acm
->read_lock
);
871 if ((arg
& TIOCM_DSR
) &&
874 if ((arg
& TIOCM_CD
) &&
877 if ((arg
& TIOCM_RI
) &&
881 add_wait_queue(&acm
->wioctl
, &wait
);
882 set_current_state(TASK_INTERRUPTIBLE
);
884 remove_wait_queue(&acm
->wioctl
, &wait
);
885 if (acm
->disconnected
) {
891 if (signal_pending(current
))
901 static int get_serial_usage(struct acm
*acm
,
902 struct serial_icounter_struct __user
*count
)
904 struct serial_icounter_struct icount
;
907 memset(&icount
, 0, sizeof(icount
));
908 icount
.dsr
= acm
->iocount
.dsr
;
909 icount
.rng
= acm
->iocount
.rng
;
910 icount
.dcd
= acm
->iocount
.dcd
;
911 icount
.frame
= acm
->iocount
.frame
;
912 icount
.overrun
= acm
->iocount
.overrun
;
913 icount
.parity
= acm
->iocount
.parity
;
914 icount
.brk
= acm
->iocount
.brk
;
916 if (copy_to_user(count
, &icount
, sizeof(icount
)) > 0)
922 static int acm_tty_ioctl(struct tty_struct
*tty
,
923 unsigned int cmd
, unsigned long arg
)
925 struct acm
*acm
= tty
->driver_data
;
926 int rv
= -ENOIOCTLCMD
;
929 case TIOCGSERIAL
: /* gets serial port data */
930 rv
= get_serial_info(acm
, (struct serial_struct __user
*) arg
);
933 rv
= set_serial_info(acm
, (struct serial_struct __user
*) arg
);
936 rv
= usb_autopm_get_interface(acm
->control
);
941 rv
= wait_serial_change(acm
, arg
);
942 usb_autopm_put_interface(acm
->control
);
945 rv
= get_serial_usage(acm
, (struct serial_icounter_struct __user
*) arg
);
952 static void acm_tty_set_termios(struct tty_struct
*tty
,
953 struct ktermios
*termios_old
)
955 struct acm
*acm
= tty
->driver_data
;
956 struct ktermios
*termios
= &tty
->termios
;
957 struct usb_cdc_line_coding newline
;
958 int newctrl
= acm
->ctrlout
;
960 newline
.dwDTERate
= cpu_to_le32(tty_get_baud_rate(tty
));
961 newline
.bCharFormat
= termios
->c_cflag
& CSTOPB
? 2 : 0;
962 newline
.bParityType
= termios
->c_cflag
& PARENB
?
963 (termios
->c_cflag
& PARODD
? 1 : 2) +
964 (termios
->c_cflag
& CMSPAR
? 2 : 0) : 0;
965 switch (termios
->c_cflag
& CSIZE
) {
967 newline
.bDataBits
= 5;
970 newline
.bDataBits
= 6;
973 newline
.bDataBits
= 7;
977 newline
.bDataBits
= 8;
980 /* FIXME: Needs to clear unsupported bits in the termios */
981 acm
->clocal
= ((termios
->c_cflag
& CLOCAL
) != 0);
983 if (!newline
.dwDTERate
) {
984 newline
.dwDTERate
= acm
->line
.dwDTERate
;
985 newctrl
&= ~ACM_CTRL_DTR
;
987 newctrl
|= ACM_CTRL_DTR
;
989 if (newctrl
!= acm
->ctrlout
)
990 acm_set_control(acm
, acm
->ctrlout
= newctrl
);
992 if (memcmp(&acm
->line
, &newline
, sizeof newline
)) {
993 memcpy(&acm
->line
, &newline
, sizeof newline
);
994 dev_dbg(&acm
->control
->dev
, "%s - set line: %d %d %d %d\n",
996 le32_to_cpu(newline
.dwDTERate
),
997 newline
.bCharFormat
, newline
.bParityType
,
999 acm_set_line(acm
, &acm
->line
);
1003 static const struct tty_port_operations acm_port_ops
= {
1004 .dtr_rts
= acm_port_dtr_rts
,
1005 .shutdown
= acm_port_shutdown
,
1006 .activate
= acm_port_activate
,
1007 .destruct
= acm_port_destruct
,
1011 * USB probe and disconnect routines.
1014 /* Little helpers: write/read buffers free */
1015 static void acm_write_buffers_free(struct acm
*acm
)
1019 struct usb_device
*usb_dev
= interface_to_usbdev(acm
->control
);
1021 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++)
1022 usb_free_coherent(usb_dev
, acm
->writesize
, wb
->buf
, wb
->dmah
);
1025 static void acm_read_buffers_free(struct acm
*acm
)
1027 struct usb_device
*usb_dev
= interface_to_usbdev(acm
->control
);
1030 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1031 usb_free_coherent(usb_dev
, acm
->readsize
,
1032 acm
->read_buffers
[i
].base
, acm
->read_buffers
[i
].dma
);
1035 /* Little helper: write buffers allocate */
1036 static int acm_write_buffers_alloc(struct acm
*acm
)
1041 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++) {
1042 wb
->buf
= usb_alloc_coherent(acm
->dev
, acm
->writesize
, GFP_KERNEL
,
1048 usb_free_coherent(acm
->dev
, acm
->writesize
,
1057 static int acm_probe(struct usb_interface
*intf
,
1058 const struct usb_device_id
*id
)
1060 struct usb_cdc_union_desc
*union_header
= NULL
;
1061 struct usb_cdc_country_functional_desc
*cfd
= NULL
;
1062 unsigned char *buffer
= intf
->altsetting
->extra
;
1063 int buflen
= intf
->altsetting
->extralen
;
1064 struct usb_interface
*control_interface
;
1065 struct usb_interface
*data_interface
;
1066 struct usb_endpoint_descriptor
*epctrl
= NULL
;
1067 struct usb_endpoint_descriptor
*epread
= NULL
;
1068 struct usb_endpoint_descriptor
*epwrite
= NULL
;
1069 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1072 int ctrlsize
, readsize
;
1074 u8 ac_management_function
= 0;
1075 u8 call_management_function
= 0;
1076 int call_interface_num
= -1;
1077 int data_interface_num
= -1;
1078 unsigned long quirks
;
1081 int combined_interfaces
= 0;
1082 struct device
*tty_dev
;
1086 quirks
= (unsigned long)id
->driver_info
;
1088 if (quirks
== IGNORE_DEVICE
)
1091 num_rx_buf
= (quirks
== SINGLE_RX_URB
) ? 1 : ACM_NR
;
1093 /* handle quirks deadly to normal probing*/
1094 if (quirks
== NO_UNION_NORMAL
) {
1095 data_interface
= usb_ifnum_to_if(usb_dev
, 1);
1096 control_interface
= usb_ifnum_to_if(usb_dev
, 0);
1097 goto skip_normal_probe
;
1102 dev_err(&intf
->dev
, "Weird descriptor references\n");
1107 if (intf
->cur_altsetting
->endpoint
&&
1108 intf
->cur_altsetting
->endpoint
->extralen
&&
1109 intf
->cur_altsetting
->endpoint
->extra
) {
1111 "Seeking extra descriptors on endpoint\n");
1112 buflen
= intf
->cur_altsetting
->endpoint
->extralen
;
1113 buffer
= intf
->cur_altsetting
->endpoint
->extra
;
1116 "Zero length descriptor references\n");
1121 while (buflen
> 0) {
1122 if (buffer
[1] != USB_DT_CS_INTERFACE
) {
1123 dev_err(&intf
->dev
, "skipping garbage\n");
1127 switch (buffer
[2]) {
1128 case USB_CDC_UNION_TYPE
: /* we've found it */
1130 dev_err(&intf
->dev
, "More than one "
1131 "union descriptor, skipping ...\n");
1134 union_header
= (struct usb_cdc_union_desc
*)buffer
;
1136 case USB_CDC_COUNTRY_TYPE
: /* export through sysfs*/
1137 cfd
= (struct usb_cdc_country_functional_desc
*)buffer
;
1139 case USB_CDC_HEADER_TYPE
: /* maybe check version */
1140 break; /* for now we ignore it */
1141 case USB_CDC_ACM_TYPE
:
1142 ac_management_function
= buffer
[3];
1144 case USB_CDC_CALL_MANAGEMENT_TYPE
:
1145 call_management_function
= buffer
[3];
1146 call_interface_num
= buffer
[4];
1147 if ((quirks
& NOT_A_MODEM
) == 0 && (call_management_function
& 3) != 3)
1148 dev_err(&intf
->dev
, "This device cannot do calls on its own. It is not a modem.\n");
1151 /* there are LOTS more CDC descriptors that
1152 * could legitimately be found here.
1154 dev_dbg(&intf
->dev
, "Ignoring descriptor: "
1155 "type %02x, length %d\n",
1156 buffer
[2], buffer
[0]);
1160 buflen
-= buffer
[0];
1161 buffer
+= buffer
[0];
1164 if (!union_header
) {
1165 if (call_interface_num
> 0) {
1166 dev_dbg(&intf
->dev
, "No union descriptor, using call management descriptor\n");
1167 /* quirks for Droids MuIn LCD */
1168 if (quirks
& NO_DATA_INTERFACE
)
1169 data_interface
= usb_ifnum_to_if(usb_dev
, 0);
1171 data_interface
= usb_ifnum_to_if(usb_dev
, (data_interface_num
= call_interface_num
));
1172 control_interface
= intf
;
1174 if (intf
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1175 dev_dbg(&intf
->dev
,"No union descriptor, giving up\n");
1178 dev_warn(&intf
->dev
,"No union descriptor, testing for castrated device\n");
1179 combined_interfaces
= 1;
1180 control_interface
= data_interface
= intf
;
1181 goto look_for_collapsed_interface
;
1185 control_interface
= usb_ifnum_to_if(usb_dev
, union_header
->bMasterInterface0
);
1186 data_interface
= usb_ifnum_to_if(usb_dev
, (data_interface_num
= union_header
->bSlaveInterface0
));
1187 if (!control_interface
|| !data_interface
) {
1188 dev_dbg(&intf
->dev
, "no interfaces\n");
1193 if (data_interface_num
!= call_interface_num
)
1194 dev_dbg(&intf
->dev
, "Separate call control interface. That is not fully supported.\n");
1196 if (control_interface
== data_interface
) {
1197 /* some broken devices designed for windows work this way */
1198 dev_warn(&intf
->dev
,"Control and data interfaces are not separated!\n");
1199 combined_interfaces
= 1;
1200 /* a popular other OS doesn't use it */
1201 quirks
|= NO_CAP_LINE
;
1202 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1203 dev_err(&intf
->dev
, "This needs exactly 3 endpoints\n");
1206 look_for_collapsed_interface
:
1207 for (i
= 0; i
< 3; i
++) {
1208 struct usb_endpoint_descriptor
*ep
;
1209 ep
= &data_interface
->cur_altsetting
->endpoint
[i
].desc
;
1211 if (usb_endpoint_is_int_in(ep
))
1213 else if (usb_endpoint_is_bulk_out(ep
))
1215 else if (usb_endpoint_is_bulk_in(ep
))
1220 if (!epctrl
|| !epread
|| !epwrite
)
1223 goto made_compressed_probe
;
1228 /*workaround for switched interfaces */
1229 if (data_interface
->cur_altsetting
->desc
.bInterfaceClass
1230 != CDC_DATA_INTERFACE_TYPE
) {
1231 if (control_interface
->cur_altsetting
->desc
.bInterfaceClass
1232 == CDC_DATA_INTERFACE_TYPE
) {
1233 struct usb_interface
*t
;
1235 "Your device has switched interfaces.\n");
1236 t
= control_interface
;
1237 control_interface
= data_interface
;
1244 /* Accept probe requests only for the control interface */
1245 if (!combined_interfaces
&& intf
!= control_interface
)
1248 if (!combined_interfaces
&& usb_interface_claimed(data_interface
)) {
1249 /* valid in this context */
1250 dev_dbg(&intf
->dev
, "The data interface isn't available\n");
1255 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
< 2 ||
1256 control_interface
->cur_altsetting
->desc
.bNumEndpoints
== 0)
1259 epctrl
= &control_interface
->cur_altsetting
->endpoint
[0].desc
;
1260 epread
= &data_interface
->cur_altsetting
->endpoint
[0].desc
;
1261 epwrite
= &data_interface
->cur_altsetting
->endpoint
[1].desc
;
1264 /* workaround for switched endpoints */
1265 if (!usb_endpoint_dir_in(epread
)) {
1266 /* descriptors are swapped */
1267 struct usb_endpoint_descriptor
*t
;
1269 "The data interface has switched endpoints\n");
1274 made_compressed_probe
:
1275 dev_dbg(&intf
->dev
, "interfaces are valid\n");
1277 acm
= kzalloc(sizeof(struct acm
), GFP_KERNEL
);
1279 dev_err(&intf
->dev
, "out of memory (acm kzalloc)\n");
1283 minor
= acm_alloc_minor(acm
);
1284 if (minor
== ACM_TTY_MINORS
) {
1285 dev_err(&intf
->dev
, "no more free acm devices\n");
1290 ctrlsize
= usb_endpoint_maxp(epctrl
);
1291 readsize
= usb_endpoint_maxp(epread
) *
1292 (quirks
== SINGLE_RX_URB
? 1 : 2);
1293 acm
->combined_interfaces
= combined_interfaces
;
1294 acm
->writesize
= usb_endpoint_maxp(epwrite
) * 20;
1295 acm
->control
= control_interface
;
1296 acm
->data
= data_interface
;
1299 acm
->ctrl_caps
= ac_management_function
;
1300 if (quirks
& NO_CAP_LINE
)
1301 acm
->ctrl_caps
&= ~USB_CDC_CAP_LINE
;
1302 acm
->ctrlsize
= ctrlsize
;
1303 acm
->readsize
= readsize
;
1304 acm
->rx_buflimit
= num_rx_buf
;
1305 INIT_WORK(&acm
->work
, acm_softint
);
1306 init_waitqueue_head(&acm
->wioctl
);
1307 spin_lock_init(&acm
->write_lock
);
1308 spin_lock_init(&acm
->read_lock
);
1309 mutex_init(&acm
->mutex
);
1310 acm
->rx_endpoint
= usb_rcvbulkpipe(usb_dev
, epread
->bEndpointAddress
);
1311 acm
->is_int_ep
= usb_endpoint_xfer_int(epread
);
1313 acm
->bInterval
= epread
->bInterval
;
1314 tty_port_init(&acm
->port
);
1315 acm
->port
.ops
= &acm_port_ops
;
1316 init_usb_anchor(&acm
->delayed
);
1318 buf
= usb_alloc_coherent(usb_dev
, ctrlsize
, GFP_KERNEL
, &acm
->ctrl_dma
);
1320 dev_err(&intf
->dev
, "out of memory (ctrl buffer alloc)\n");
1323 acm
->ctrl_buffer
= buf
;
1325 if (acm_write_buffers_alloc(acm
) < 0) {
1326 dev_err(&intf
->dev
, "out of memory (write buffer alloc)\n");
1330 acm
->ctrlurb
= usb_alloc_urb(0, GFP_KERNEL
);
1331 if (!acm
->ctrlurb
) {
1332 dev_err(&intf
->dev
, "out of memory (ctrlurb kmalloc)\n");
1335 for (i
= 0; i
< num_rx_buf
; i
++) {
1336 struct acm_rb
*rb
= &(acm
->read_buffers
[i
]);
1339 rb
->base
= usb_alloc_coherent(acm
->dev
, readsize
, GFP_KERNEL
,
1342 dev_err(&intf
->dev
, "out of memory "
1343 "(read bufs usb_alloc_coherent)\n");
1349 urb
= usb_alloc_urb(0, GFP_KERNEL
);
1352 "out of memory (read urbs usb_alloc_urb)\n");
1355 urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1356 urb
->transfer_dma
= rb
->dma
;
1357 if (acm
->is_int_ep
) {
1358 usb_fill_int_urb(urb
, acm
->dev
,
1362 acm_read_bulk_callback
, rb
,
1365 usb_fill_bulk_urb(urb
, acm
->dev
,
1369 acm_read_bulk_callback
, rb
);
1372 acm
->read_urbs
[i
] = urb
;
1373 __set_bit(i
, &acm
->read_urbs_free
);
1375 for (i
= 0; i
< ACM_NW
; i
++) {
1376 struct acm_wb
*snd
= &(acm
->wb
[i
]);
1378 snd
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1379 if (snd
->urb
== NULL
) {
1381 "out of memory (write urbs usb_alloc_urb)\n");
1385 if (usb_endpoint_xfer_int(epwrite
))
1386 usb_fill_int_urb(snd
->urb
, usb_dev
,
1387 usb_sndintpipe(usb_dev
, epwrite
->bEndpointAddress
),
1388 NULL
, acm
->writesize
, acm_write_bulk
, snd
, epwrite
->bInterval
);
1390 usb_fill_bulk_urb(snd
->urb
, usb_dev
,
1391 usb_sndbulkpipe(usb_dev
, epwrite
->bEndpointAddress
),
1392 NULL
, acm
->writesize
, acm_write_bulk
, snd
);
1393 snd
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1394 snd
->instance
= acm
;
1397 usb_set_intfdata(intf
, acm
);
1399 i
= device_create_file(&intf
->dev
, &dev_attr_bmCapabilities
);
1403 if (cfd
) { /* export the country data */
1404 acm
->country_codes
= kmalloc(cfd
->bLength
- 4, GFP_KERNEL
);
1405 if (!acm
->country_codes
)
1406 goto skip_countries
;
1407 acm
->country_code_size
= cfd
->bLength
- 4;
1408 memcpy(acm
->country_codes
, (u8
*)&cfd
->wCountyCode0
,
1410 acm
->country_rel_date
= cfd
->iCountryCodeRelDate
;
1412 i
= device_create_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1414 kfree(acm
->country_codes
);
1415 acm
->country_codes
= NULL
;
1416 acm
->country_code_size
= 0;
1417 goto skip_countries
;
1420 i
= device_create_file(&intf
->dev
,
1421 &dev_attr_iCountryCodeRelDate
);
1423 device_remove_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1424 kfree(acm
->country_codes
);
1425 acm
->country_codes
= NULL
;
1426 acm
->country_code_size
= 0;
1427 goto skip_countries
;
1432 usb_fill_int_urb(acm
->ctrlurb
, usb_dev
,
1433 usb_rcvintpipe(usb_dev
, epctrl
->bEndpointAddress
),
1434 acm
->ctrl_buffer
, ctrlsize
, acm_ctrl_irq
, acm
,
1435 /* works around buggy devices */
1436 epctrl
->bInterval
? epctrl
->bInterval
: 16);
1437 acm
->ctrlurb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1438 acm
->ctrlurb
->transfer_dma
= acm
->ctrl_dma
;
1440 dev_info(&intf
->dev
, "ttyACM%d: USB ACM device\n", minor
);
1442 acm
->line
.dwDTERate
= cpu_to_le32(9600);
1443 acm
->line
.bDataBits
= 8;
1444 acm_set_line(acm
, &acm
->line
);
1446 usb_driver_claim_interface(&acm_driver
, data_interface
, acm
);
1447 usb_set_intfdata(data_interface
, acm
);
1449 usb_get_intf(control_interface
);
1450 tty_dev
= tty_port_register_device(&acm
->port
, acm_tty_driver
, minor
,
1451 &control_interface
->dev
);
1452 if (IS_ERR(tty_dev
)) {
1453 rv
= PTR_ERR(tty_dev
);
1459 if (acm
->country_codes
) {
1460 device_remove_file(&acm
->control
->dev
,
1461 &dev_attr_wCountryCodes
);
1462 device_remove_file(&acm
->control
->dev
,
1463 &dev_attr_iCountryCodeRelDate
);
1465 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1467 usb_set_intfdata(intf
, NULL
);
1468 for (i
= 0; i
< ACM_NW
; i
++)
1469 usb_free_urb(acm
->wb
[i
].urb
);
1471 for (i
= 0; i
< num_rx_buf
; i
++)
1472 usb_free_urb(acm
->read_urbs
[i
]);
1473 acm_read_buffers_free(acm
);
1474 usb_free_urb(acm
->ctrlurb
);
1476 acm_write_buffers_free(acm
);
1478 usb_free_coherent(usb_dev
, ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1480 acm_release_minor(acm
);
1486 static void stop_data_traffic(struct acm
*acm
)
1490 dev_dbg(&acm
->control
->dev
, "%s\n", __func__
);
1492 usb_kill_urb(acm
->ctrlurb
);
1493 for (i
= 0; i
< ACM_NW
; i
++)
1494 usb_kill_urb(acm
->wb
[i
].urb
);
1495 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1496 usb_kill_urb(acm
->read_urbs
[i
]);
1498 cancel_work_sync(&acm
->work
);
1501 static void acm_disconnect(struct usb_interface
*intf
)
1503 struct acm
*acm
= usb_get_intfdata(intf
);
1504 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1505 struct tty_struct
*tty
;
1508 dev_dbg(&intf
->dev
, "%s\n", __func__
);
1510 /* sibling interface is already cleaning up */
1514 mutex_lock(&acm
->mutex
);
1515 acm
->disconnected
= true;
1516 if (acm
->country_codes
) {
1517 device_remove_file(&acm
->control
->dev
,
1518 &dev_attr_wCountryCodes
);
1519 device_remove_file(&acm
->control
->dev
,
1520 &dev_attr_iCountryCodeRelDate
);
1522 wake_up_all(&acm
->wioctl
);
1523 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1524 usb_set_intfdata(acm
->control
, NULL
);
1525 usb_set_intfdata(acm
->data
, NULL
);
1526 mutex_unlock(&acm
->mutex
);
1528 tty
= tty_port_tty_get(&acm
->port
);
1534 stop_data_traffic(acm
);
1536 tty_unregister_device(acm_tty_driver
, acm
->minor
);
1538 usb_free_urb(acm
->ctrlurb
);
1539 for (i
= 0; i
< ACM_NW
; i
++)
1540 usb_free_urb(acm
->wb
[i
].urb
);
1541 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1542 usb_free_urb(acm
->read_urbs
[i
]);
1543 acm_write_buffers_free(acm
);
1544 usb_free_coherent(usb_dev
, acm
->ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1545 acm_read_buffers_free(acm
);
1547 if (!acm
->combined_interfaces
)
1548 usb_driver_release_interface(&acm_driver
, intf
== acm
->control
?
1549 acm
->data
: acm
->control
);
1551 tty_port_put(&acm
->port
);
1555 static int acm_suspend(struct usb_interface
*intf
, pm_message_t message
)
1557 struct acm
*acm
= usb_get_intfdata(intf
);
1560 spin_lock_irq(&acm
->write_lock
);
1561 if (PMSG_IS_AUTO(message
)) {
1562 if (acm
->transmitting
) {
1563 spin_unlock_irq(&acm
->write_lock
);
1567 cnt
= acm
->susp_count
++;
1568 spin_unlock_irq(&acm
->write_lock
);
1573 stop_data_traffic(acm
);
1578 static int acm_resume(struct usb_interface
*intf
)
1580 struct acm
*acm
= usb_get_intfdata(intf
);
1584 spin_lock_irq(&acm
->write_lock
);
1586 if (--acm
->susp_count
)
1589 if (test_bit(ASYNCB_INITIALIZED
, &acm
->port
.flags
)) {
1590 rv
= usb_submit_urb(acm
->ctrlurb
, GFP_ATOMIC
);
1593 urb
= usb_get_from_anchor(&acm
->delayed
);
1597 acm_start_wb(acm
, urb
->context
);
1601 * delayed error checking because we must
1602 * do the write path at all cost
1607 rv
= acm_submit_read_urbs(acm
, GFP_ATOMIC
);
1610 spin_unlock_irq(&acm
->write_lock
);
1615 static int acm_reset_resume(struct usb_interface
*intf
)
1617 struct acm
*acm
= usb_get_intfdata(intf
);
1619 if (test_bit(ASYNCB_INITIALIZED
, &acm
->port
.flags
))
1620 tty_port_tty_hangup(&acm
->port
, false);
1622 return acm_resume(intf
);
1625 #endif /* CONFIG_PM */
1627 #define NOKIA_PCSUITE_ACM_INFO(x) \
1628 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1629 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1630 USB_CDC_ACM_PROTO_VENDOR)
1632 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1633 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1634 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1635 USB_CDC_ACM_PROTO_VENDOR)
1638 * USB driver structure.
1641 static const struct usb_device_id acm_ids
[] = {
1642 /* quirky and broken devices */
1643 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1644 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1645 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1646 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1648 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1649 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1651 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1652 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1654 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1655 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1657 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1658 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1660 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1661 .driver_info
= SINGLE_RX_URB
,
1663 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1664 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1666 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1667 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1669 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1670 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1672 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1673 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1675 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1676 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1678 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1679 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1681 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1682 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1684 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1686 /* Motorola H24 HSPA module: */
1687 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1688 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1689 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1691 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1692 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1694 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1695 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1697 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1698 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1700 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1701 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1703 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1704 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1706 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1707 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1710 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1711 .driver_info
= NO_UNION_NORMAL
, /* union descriptor misplaced on
1712 data interface instead of
1713 communications interface.
1714 Maybe we should define a new
1717 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1718 .driver_info
= NO_UNION_NORMAL
,
1720 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1721 .driver_info
= NO_UNION_NORMAL
,
1723 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1724 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1726 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1727 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1730 /* Nokia S60 phones expose two ACM channels. The first is
1731 * a modem and is picked up by the standard AT-command
1732 * information below. The second is 'vendor-specific' but
1733 * is treated as a serial device at the S60 end, so we want
1734 * to expose it on Linux too. */
1735 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1736 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1737 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1738 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1739 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1740 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1741 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1742 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1743 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1744 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1745 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1746 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1747 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1748 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1749 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1750 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1751 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1752 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1753 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1754 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1755 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1756 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1757 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1758 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1759 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1760 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1761 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1762 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1763 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1764 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1765 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1766 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1767 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1768 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1769 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1770 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1771 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1772 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1773 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1774 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1775 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1776 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1777 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1778 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1779 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1780 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1781 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1782 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1783 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1784 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1785 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1786 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1787 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1788 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1789 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1790 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1791 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1792 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1794 /* Support for Owen devices */
1795 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1797 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1799 /* Support Lego NXT using pbLua firmware */
1800 { USB_DEVICE(0x0694, 0xff00),
1801 .driver_info
= NOT_A_MODEM
,
1804 /* Support for Droids MuIn LCD */
1805 { USB_DEVICE(0x04d8, 0x000b),
1806 .driver_info
= NO_DATA_INTERFACE
,
1809 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1810 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1811 .driver_info
= IGNORE_DEVICE
,
1813 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1814 .driver_info
= IGNORE_DEVICE
,
1818 /* control interfaces without any protocol set */
1819 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1820 USB_CDC_PROTO_NONE
) },
1822 /* control interfaces with various AT-command sets */
1823 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1824 USB_CDC_ACM_PROTO_AT_V25TER
) },
1825 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1826 USB_CDC_ACM_PROTO_AT_PCCA101
) },
1827 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1828 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE
) },
1829 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1830 USB_CDC_ACM_PROTO_AT_GSM
) },
1831 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1832 USB_CDC_ACM_PROTO_AT_3G
) },
1833 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1834 USB_CDC_ACM_PROTO_AT_CDMA
) },
1839 MODULE_DEVICE_TABLE(usb
, acm_ids
);
1841 static struct usb_driver acm_driver
= {
1844 .disconnect
= acm_disconnect
,
1846 .suspend
= acm_suspend
,
1847 .resume
= acm_resume
,
1848 .reset_resume
= acm_reset_resume
,
1850 .id_table
= acm_ids
,
1852 .supports_autosuspend
= 1,
1854 .disable_hub_initiated_lpm
= 1,
1858 * TTY driver structures.
1861 static const struct tty_operations acm_ops
= {
1862 .install
= acm_tty_install
,
1863 .open
= acm_tty_open
,
1864 .close
= acm_tty_close
,
1865 .cleanup
= acm_tty_cleanup
,
1866 .hangup
= acm_tty_hangup
,
1867 .write
= acm_tty_write
,
1868 .write_room
= acm_tty_write_room
,
1869 .ioctl
= acm_tty_ioctl
,
1870 .throttle
= acm_tty_throttle
,
1871 .unthrottle
= acm_tty_unthrottle
,
1872 .chars_in_buffer
= acm_tty_chars_in_buffer
,
1873 .break_ctl
= acm_tty_break_ctl
,
1874 .set_termios
= acm_tty_set_termios
,
1875 .tiocmget
= acm_tty_tiocmget
,
1876 .tiocmset
= acm_tty_tiocmset
,
1883 static int __init
acm_init(void)
1886 acm_tty_driver
= alloc_tty_driver(ACM_TTY_MINORS
);
1887 if (!acm_tty_driver
)
1889 acm_tty_driver
->driver_name
= "acm",
1890 acm_tty_driver
->name
= "ttyACM",
1891 acm_tty_driver
->major
= ACM_TTY_MAJOR
,
1892 acm_tty_driver
->minor_start
= 0,
1893 acm_tty_driver
->type
= TTY_DRIVER_TYPE_SERIAL
,
1894 acm_tty_driver
->subtype
= SERIAL_TYPE_NORMAL
,
1895 acm_tty_driver
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
1896 acm_tty_driver
->init_termios
= tty_std_termios
;
1897 acm_tty_driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
|
1899 tty_set_operations(acm_tty_driver
, &acm_ops
);
1901 retval
= tty_register_driver(acm_tty_driver
);
1903 put_tty_driver(acm_tty_driver
);
1907 retval
= usb_register(&acm_driver
);
1909 tty_unregister_driver(acm_tty_driver
);
1910 put_tty_driver(acm_tty_driver
);
1914 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
1919 static void __exit
acm_exit(void)
1921 usb_deregister(&acm_driver
);
1922 tty_unregister_driver(acm_tty_driver
);
1923 put_tty_driver(acm_tty_driver
);
1926 module_init(acm_init
);
1927 module_exit(acm_exit
);
1929 MODULE_AUTHOR(DRIVER_AUTHOR
);
1930 MODULE_DESCRIPTION(DRIVER_DESC
);
1931 MODULE_LICENSE("GPL");
1932 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR
);