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/sched/signal.h>
36 #include <linux/errno.h>
37 #include <linux/init.h>
38 #include <linux/slab.h>
39 #include <linux/log2.h>
40 #include <linux/tty.h>
41 #include <linux/serial.h>
42 #include <linux/tty_driver.h>
43 #include <linux/tty_flip.h>
44 #include <linux/module.h>
45 #include <linux/mutex.h>
46 #include <linux/uaccess.h>
47 #include <linux/usb.h>
48 #include <linux/usb/cdc.h>
49 #include <asm/byteorder.h>
50 #include <asm/unaligned.h>
51 #include <linux/idr.h>
52 #include <linux/list.h>
57 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
58 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
60 static struct usb_driver acm_driver
;
61 static struct tty_driver
*acm_tty_driver
;
63 static DEFINE_IDR(acm_minors
);
64 static DEFINE_MUTEX(acm_minors_lock
);
66 static void acm_tty_set_termios(struct tty_struct
*tty
,
67 struct ktermios
*termios_old
);
70 * acm_minors accessors
74 * Look up an ACM structure by minor. If found and not disconnected, increment
75 * its refcount and return it with its mutex held.
77 static struct acm
*acm_get_by_minor(unsigned int minor
)
81 mutex_lock(&acm_minors_lock
);
82 acm
= idr_find(&acm_minors
, minor
);
84 mutex_lock(&acm
->mutex
);
85 if (acm
->disconnected
) {
86 mutex_unlock(&acm
->mutex
);
89 tty_port_get(&acm
->port
);
90 mutex_unlock(&acm
->mutex
);
93 mutex_unlock(&acm_minors_lock
);
98 * Try to find an available minor number and if found, associate it with 'acm'.
100 static int acm_alloc_minor(struct acm
*acm
)
104 mutex_lock(&acm_minors_lock
);
105 minor
= idr_alloc(&acm_minors
, acm
, 0, ACM_TTY_MINORS
, GFP_KERNEL
);
106 mutex_unlock(&acm_minors_lock
);
111 /* Release the minor number associated with 'acm'. */
112 static void acm_release_minor(struct acm
*acm
)
114 mutex_lock(&acm_minors_lock
);
115 idr_remove(&acm_minors
, acm
->minor
);
116 mutex_unlock(&acm_minors_lock
);
120 * Functions for ACM control messages.
123 static int acm_ctrl_msg(struct acm
*acm
, int request
, int value
,
128 retval
= usb_autopm_get_interface(acm
->control
);
132 retval
= usb_control_msg(acm
->dev
, usb_sndctrlpipe(acm
->dev
, 0),
133 request
, USB_RT_ACM
, value
,
134 acm
->control
->altsetting
[0].desc
.bInterfaceNumber
,
137 dev_dbg(&acm
->control
->dev
,
138 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
139 __func__
, request
, value
, len
, retval
);
141 usb_autopm_put_interface(acm
->control
);
143 return retval
< 0 ? retval
: 0;
146 /* devices aren't required to support these requests.
147 * the cdc acm descriptor tells whether they do...
149 static inline int acm_set_control(struct acm
*acm
, int control
)
151 if (acm
->quirks
& QUIRK_CONTROL_LINE_STATE
)
154 return acm_ctrl_msg(acm
, USB_CDC_REQ_SET_CONTROL_LINE_STATE
,
158 #define acm_set_line(acm, line) \
159 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
160 #define acm_send_break(acm, ms) \
161 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
163 static void acm_kill_urbs(struct acm
*acm
)
167 usb_kill_urb(acm
->ctrlurb
);
168 for (i
= 0; i
< ACM_NW
; i
++)
169 usb_kill_urb(acm
->wb
[i
].urb
);
170 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
171 usb_kill_urb(acm
->read_urbs
[i
]);
175 * Write buffer management.
176 * All of these assume proper locks taken by the caller.
179 static int acm_wb_alloc(struct acm
*acm
)
192 wbn
= (wbn
+ 1) % ACM_NW
;
198 static int acm_wb_is_avail(struct acm
*acm
)
204 spin_lock_irqsave(&acm
->write_lock
, flags
);
205 for (i
= 0; i
< ACM_NW
; i
++)
207 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
212 * Finish write. Caller must hold acm->write_lock
214 static void acm_write_done(struct acm
*acm
, struct acm_wb
*wb
)
218 usb_autopm_put_interface_async(acm
->control
);
224 * the caller is responsible for locking
227 static int acm_start_wb(struct acm
*acm
, struct acm_wb
*wb
)
233 wb
->urb
->transfer_buffer
= wb
->buf
;
234 wb
->urb
->transfer_dma
= wb
->dmah
;
235 wb
->urb
->transfer_buffer_length
= wb
->len
;
236 wb
->urb
->dev
= acm
->dev
;
238 rc
= usb_submit_urb(wb
->urb
, GFP_ATOMIC
);
240 dev_err(&acm
->data
->dev
,
241 "%s - usb_submit_urb(write bulk) failed: %d\n",
243 acm_write_done(acm
, wb
);
249 * attributes exported through sysfs
251 static ssize_t show_caps
252 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
254 struct usb_interface
*intf
= to_usb_interface(dev
);
255 struct acm
*acm
= usb_get_intfdata(intf
);
257 return sprintf(buf
, "%d", acm
->ctrl_caps
);
259 static DEVICE_ATTR(bmCapabilities
, S_IRUGO
, show_caps
, NULL
);
261 static ssize_t show_country_codes
262 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
264 struct usb_interface
*intf
= to_usb_interface(dev
);
265 struct acm
*acm
= usb_get_intfdata(intf
);
267 memcpy(buf
, acm
->country_codes
, acm
->country_code_size
);
268 return acm
->country_code_size
;
271 static DEVICE_ATTR(wCountryCodes
, S_IRUGO
, show_country_codes
, NULL
);
273 static ssize_t show_country_rel_date
274 (struct device
*dev
, struct device_attribute
*attr
, char *buf
)
276 struct usb_interface
*intf
= to_usb_interface(dev
);
277 struct acm
*acm
= usb_get_intfdata(intf
);
279 return sprintf(buf
, "%d", acm
->country_rel_date
);
282 static DEVICE_ATTR(iCountryCodeRelDate
, S_IRUGO
, show_country_rel_date
, NULL
);
284 * Interrupt handlers for various ACM device responses
287 static void acm_process_notification(struct acm
*acm
, unsigned char *buf
)
291 struct usb_cdc_notification
*dr
= (struct usb_cdc_notification
*)buf
;
292 unsigned char *data
= buf
+ sizeof(struct usb_cdc_notification
);
294 switch (dr
->bNotificationType
) {
295 case USB_CDC_NOTIFY_NETWORK_CONNECTION
:
296 dev_dbg(&acm
->control
->dev
,
297 "%s - network connection: %d\n", __func__
, dr
->wValue
);
300 case USB_CDC_NOTIFY_SERIAL_STATE
:
301 if (le16_to_cpu(dr
->wLength
) != 2) {
302 dev_dbg(&acm
->control
->dev
,
303 "%s - malformed serial state\n", __func__
);
307 newctrl
= get_unaligned_le16(data
);
308 dev_dbg(&acm
->control
->dev
,
309 "%s - serial state: 0x%x\n", __func__
, newctrl
);
311 if (!acm
->clocal
&& (acm
->ctrlin
& ~newctrl
& ACM_CTRL_DCD
)) {
312 dev_dbg(&acm
->control
->dev
,
313 "%s - calling hangup\n", __func__
);
314 tty_port_tty_hangup(&acm
->port
, false);
317 difference
= acm
->ctrlin
^ newctrl
;
318 spin_lock(&acm
->read_lock
);
319 acm
->ctrlin
= newctrl
;
320 acm
->oldcount
= acm
->iocount
;
322 if (difference
& ACM_CTRL_DSR
)
324 if (difference
& ACM_CTRL_BRK
)
326 if (difference
& ACM_CTRL_RI
)
328 if (difference
& ACM_CTRL_DCD
)
330 if (difference
& ACM_CTRL_FRAMING
)
331 acm
->iocount
.frame
++;
332 if (difference
& ACM_CTRL_PARITY
)
333 acm
->iocount
.parity
++;
334 if (difference
& ACM_CTRL_OVERRUN
)
335 acm
->iocount
.overrun
++;
336 spin_unlock(&acm
->read_lock
);
339 wake_up_all(&acm
->wioctl
);
344 dev_dbg(&acm
->control
->dev
,
345 "%s - unknown notification %d received: index %d len %d\n",
347 dr
->bNotificationType
, dr
->wIndex
, dr
->wLength
);
351 /* control interface reports status changes with "interrupt" transfers */
352 static void acm_ctrl_irq(struct urb
*urb
)
354 struct acm
*acm
= urb
->context
;
355 struct usb_cdc_notification
*dr
= urb
->transfer_buffer
;
356 unsigned int current_size
= urb
->actual_length
;
357 unsigned int expected_size
, copy_size
, alloc_size
;
359 int status
= urb
->status
;
368 /* this urb is terminated, clean up */
370 dev_dbg(&acm
->control
->dev
,
371 "%s - urb shutting down with status: %d\n",
375 dev_dbg(&acm
->control
->dev
,
376 "%s - nonzero urb status received: %d\n",
381 usb_mark_last_busy(acm
->dev
);
384 dr
= (struct usb_cdc_notification
*)acm
->notification_buffer
;
386 /* size = notification-header + (optional) data */
387 expected_size
= sizeof(struct usb_cdc_notification
) +
388 le16_to_cpu(dr
->wLength
);
390 if (current_size
< expected_size
) {
391 /* notification is transmitted fragmented, reassemble */
392 if (acm
->nb_size
< expected_size
) {
394 kfree(acm
->notification_buffer
);
397 alloc_size
= roundup_pow_of_two(expected_size
);
399 * kmalloc ensures a valid notification_buffer after a
400 * use of kfree in case the previous allocation was too
401 * small. Final freeing is done on disconnect.
403 acm
->notification_buffer
=
404 kmalloc(alloc_size
, GFP_ATOMIC
);
405 if (!acm
->notification_buffer
)
407 acm
->nb_size
= alloc_size
;
410 copy_size
= min(current_size
,
411 expected_size
- acm
->nb_index
);
413 memcpy(&acm
->notification_buffer
[acm
->nb_index
],
414 urb
->transfer_buffer
, copy_size
);
415 acm
->nb_index
+= copy_size
;
416 current_size
= acm
->nb_index
;
419 if (current_size
>= expected_size
) {
420 /* notification complete */
421 acm_process_notification(acm
, (unsigned char *)dr
);
426 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
427 if (retval
&& retval
!= -EPERM
)
428 dev_err(&acm
->control
->dev
,
429 "%s - usb_submit_urb failed: %d\n", __func__
, retval
);
432 static int acm_submit_read_urb(struct acm
*acm
, int index
, gfp_t mem_flags
)
436 if (!test_and_clear_bit(index
, &acm
->read_urbs_free
))
439 res
= usb_submit_urb(acm
->read_urbs
[index
], mem_flags
);
442 dev_err(&acm
->data
->dev
,
443 "urb %d failed submission with %d\n",
446 set_bit(index
, &acm
->read_urbs_free
);
449 dev_vdbg(&acm
->data
->dev
, "submitted urb %d\n", index
);
455 static int acm_submit_read_urbs(struct acm
*acm
, gfp_t mem_flags
)
460 for (i
= 0; i
< acm
->rx_buflimit
; ++i
) {
461 res
= acm_submit_read_urb(acm
, i
, mem_flags
);
469 static void acm_process_read_urb(struct acm
*acm
, struct urb
*urb
)
471 if (!urb
->actual_length
)
474 tty_insert_flip_string(&acm
->port
, urb
->transfer_buffer
,
476 tty_flip_buffer_push(&acm
->port
);
479 static void acm_read_bulk_callback(struct urb
*urb
)
481 struct acm_rb
*rb
= urb
->context
;
482 struct acm
*acm
= rb
->instance
;
484 int status
= urb
->status
;
486 dev_vdbg(&acm
->data
->dev
, "got urb %d, len %d, status %d\n",
487 rb
->index
, urb
->actual_length
, status
);
489 set_bit(rb
->index
, &acm
->read_urbs_free
);
492 dev_dbg(&acm
->data
->dev
, "%s - disconnected\n", __func__
);
498 usb_mark_last_busy(acm
->dev
);
499 acm_process_read_urb(acm
, urb
);
502 set_bit(EVENT_RX_STALL
, &acm
->flags
);
503 schedule_work(&acm
->work
);
508 dev_dbg(&acm
->data
->dev
,
509 "%s - urb shutting down with status: %d\n",
513 dev_dbg(&acm
->data
->dev
,
514 "%s - nonzero urb status received: %d\n",
520 * Unthrottle may run on another CPU which needs to see events
521 * in the same order. Submission has an implict barrier
523 smp_mb__before_atomic();
525 /* throttle device if requested by tty */
526 spin_lock_irqsave(&acm
->read_lock
, flags
);
527 acm
->throttled
= acm
->throttle_req
;
528 if (!acm
->throttled
) {
529 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
530 acm_submit_read_urb(acm
, rb
->index
, GFP_ATOMIC
);
532 spin_unlock_irqrestore(&acm
->read_lock
, flags
);
536 /* data interface wrote those outgoing bytes */
537 static void acm_write_bulk(struct urb
*urb
)
539 struct acm_wb
*wb
= urb
->context
;
540 struct acm
*acm
= wb
->instance
;
542 int status
= urb
->status
;
544 if (status
|| (urb
->actual_length
!= urb
->transfer_buffer_length
))
545 dev_vdbg(&acm
->data
->dev
, "wrote len %d/%d, status %d\n",
547 urb
->transfer_buffer_length
,
550 spin_lock_irqsave(&acm
->write_lock
, flags
);
551 acm_write_done(acm
, wb
);
552 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
553 set_bit(EVENT_TTY_WAKEUP
, &acm
->flags
);
554 schedule_work(&acm
->work
);
557 static void acm_softint(struct work_struct
*work
)
560 struct acm
*acm
= container_of(work
, struct acm
, work
);
562 if (test_bit(EVENT_RX_STALL
, &acm
->flags
)) {
563 if (!(usb_autopm_get_interface(acm
->data
))) {
564 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
565 usb_kill_urb(acm
->read_urbs
[i
]);
566 usb_clear_halt(acm
->dev
, acm
->in
);
567 acm_submit_read_urbs(acm
, GFP_KERNEL
);
568 usb_autopm_put_interface(acm
->data
);
570 clear_bit(EVENT_RX_STALL
, &acm
->flags
);
573 if (test_bit(EVENT_TTY_WAKEUP
, &acm
->flags
)) {
574 tty_port_tty_wakeup(&acm
->port
);
575 clear_bit(EVENT_TTY_WAKEUP
, &acm
->flags
);
583 static int acm_tty_install(struct tty_driver
*driver
, struct tty_struct
*tty
)
588 acm
= acm_get_by_minor(tty
->index
);
592 retval
= tty_standard_install(driver
, tty
);
594 goto error_init_termios
;
596 tty
->driver_data
= acm
;
601 tty_port_put(&acm
->port
);
605 static int acm_tty_open(struct tty_struct
*tty
, struct file
*filp
)
607 struct acm
*acm
= tty
->driver_data
;
609 return tty_port_open(&acm
->port
, tty
, filp
);
612 static void acm_port_dtr_rts(struct tty_port
*port
, int raise
)
614 struct acm
*acm
= container_of(port
, struct acm
, port
);
619 val
= ACM_CTRL_DTR
| ACM_CTRL_RTS
;
623 /* FIXME: add missing ctrlout locking throughout driver */
626 res
= acm_set_control(acm
, val
);
627 if (res
&& (acm
->ctrl_caps
& USB_CDC_CAP_LINE
))
628 dev_err(&acm
->control
->dev
, "failed to set dtr/rts\n");
631 static int acm_port_activate(struct tty_port
*port
, struct tty_struct
*tty
)
633 struct acm
*acm
= container_of(port
, struct acm
, port
);
634 int retval
= -ENODEV
;
637 mutex_lock(&acm
->mutex
);
638 if (acm
->disconnected
)
641 retval
= usb_autopm_get_interface(acm
->control
);
643 goto error_get_interface
;
646 * FIXME: Why do we need this? Allocating 64K of physically contiguous
647 * memory is really nasty...
649 set_bit(TTY_NO_WRITE_SPLIT
, &tty
->flags
);
650 acm
->control
->needs_remote_wakeup
= 1;
652 acm
->ctrlurb
->dev
= acm
->dev
;
653 retval
= usb_submit_urb(acm
->ctrlurb
, GFP_KERNEL
);
655 dev_err(&acm
->control
->dev
,
656 "%s - usb_submit_urb(ctrl irq) failed\n", __func__
);
657 goto error_submit_urb
;
660 acm_tty_set_termios(tty
, NULL
);
663 * Unthrottle device in case the TTY was closed while throttled.
665 spin_lock_irq(&acm
->read_lock
);
667 acm
->throttle_req
= 0;
668 spin_unlock_irq(&acm
->read_lock
);
670 retval
= acm_submit_read_urbs(acm
, GFP_KERNEL
);
672 goto error_submit_read_urbs
;
674 usb_autopm_put_interface(acm
->control
);
676 mutex_unlock(&acm
->mutex
);
680 error_submit_read_urbs
:
681 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
682 usb_kill_urb(acm
->read_urbs
[i
]);
683 usb_kill_urb(acm
->ctrlurb
);
685 usb_autopm_put_interface(acm
->control
);
688 mutex_unlock(&acm
->mutex
);
690 return usb_translate_errors(retval
);
693 static void acm_port_destruct(struct tty_port
*port
)
695 struct acm
*acm
= container_of(port
, struct acm
, port
);
697 acm_release_minor(acm
);
698 usb_put_intf(acm
->control
);
699 kfree(acm
->country_codes
);
703 static void acm_port_shutdown(struct tty_port
*port
)
705 struct acm
*acm
= container_of(port
, struct acm
, port
);
710 * Need to grab write_lock to prevent race with resume, but no need to
711 * hold it due to the tty-port initialised flag.
713 spin_lock_irq(&acm
->write_lock
);
714 spin_unlock_irq(&acm
->write_lock
);
716 usb_autopm_get_interface_no_resume(acm
->control
);
717 acm
->control
->needs_remote_wakeup
= 0;
718 usb_autopm_put_interface(acm
->control
);
721 urb
= usb_get_from_anchor(&acm
->delayed
);
726 usb_autopm_put_interface_async(acm
->control
);
732 static void acm_tty_cleanup(struct tty_struct
*tty
)
734 struct acm
*acm
= tty
->driver_data
;
736 tty_port_put(&acm
->port
);
739 static void acm_tty_hangup(struct tty_struct
*tty
)
741 struct acm
*acm
= tty
->driver_data
;
743 tty_port_hangup(&acm
->port
);
746 static void acm_tty_close(struct tty_struct
*tty
, struct file
*filp
)
748 struct acm
*acm
= tty
->driver_data
;
750 tty_port_close(&acm
->port
, tty
, filp
);
753 static int acm_tty_write(struct tty_struct
*tty
,
754 const unsigned char *buf
, int count
)
756 struct acm
*acm
= tty
->driver_data
;
765 dev_vdbg(&acm
->data
->dev
, "%d bytes from tty layer\n", count
);
767 spin_lock_irqsave(&acm
->write_lock
, flags
);
768 wbn
= acm_wb_alloc(acm
);
770 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
777 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
781 count
= (count
> acm
->writesize
) ? acm
->writesize
: count
;
782 dev_vdbg(&acm
->data
->dev
, "writing %d bytes\n", count
);
783 memcpy(wb
->buf
, buf
, count
);
786 stat
= usb_autopm_get_interface_async(acm
->control
);
789 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
793 if (acm
->susp_count
) {
794 if (acm
->putbuffer
) {
795 /* now to preserve order */
796 usb_anchor_urb(acm
->putbuffer
->urb
, &acm
->delayed
);
797 acm
->putbuffer
= NULL
;
799 usb_anchor_urb(wb
->urb
, &acm
->delayed
);
800 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
803 if (acm
->putbuffer
) {
804 /* at this point there is no good way to handle errors */
805 acm_start_wb(acm
, acm
->putbuffer
);
806 acm
->putbuffer
= NULL
;
810 stat
= acm_start_wb(acm
, wb
);
811 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
818 static void acm_tty_flush_chars(struct tty_struct
*tty
)
820 struct acm
*acm
= tty
->driver_data
;
821 struct acm_wb
*cur
= acm
->putbuffer
;
825 if (!cur
) /* nothing to do */
828 acm
->putbuffer
= NULL
;
829 err
= usb_autopm_get_interface_async(acm
->control
);
830 spin_lock_irqsave(&acm
->write_lock
, flags
);
833 acm
->putbuffer
= cur
;
838 usb_anchor_urb(cur
->urb
, &acm
->delayed
);
840 acm_start_wb(acm
, cur
);
842 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
846 static int acm_tty_put_char(struct tty_struct
*tty
, unsigned char ch
)
848 struct acm
*acm
= tty
->driver_data
;
854 cur
= acm
->putbuffer
;
856 spin_lock_irqsave(&acm
->write_lock
, flags
);
857 wbn
= acm_wb_alloc(acm
);
860 acm
->putbuffer
= cur
;
862 spin_unlock_irqrestore(&acm
->write_lock
, flags
);
867 if (cur
->len
== acm
->writesize
) {
868 acm_tty_flush_chars(tty
);
872 cur
->buf
[cur
->len
++] = ch
;
876 static int acm_tty_write_room(struct tty_struct
*tty
)
878 struct acm
*acm
= tty
->driver_data
;
880 * Do not let the line discipline to know that we have a reserve,
881 * or it might get too enthusiastic.
883 return acm_wb_is_avail(acm
) ? acm
->writesize
: 0;
886 static int acm_tty_chars_in_buffer(struct tty_struct
*tty
)
888 struct acm
*acm
= tty
->driver_data
;
890 * if the device was unplugged then any remaining characters fell out
891 * of the connector ;)
893 if (acm
->disconnected
)
896 * This is inaccurate (overcounts), but it works.
898 return (ACM_NW
- acm_wb_is_avail(acm
)) * acm
->writesize
;
901 static void acm_tty_throttle(struct tty_struct
*tty
)
903 struct acm
*acm
= tty
->driver_data
;
905 spin_lock_irq(&acm
->read_lock
);
906 acm
->throttle_req
= 1;
907 spin_unlock_irq(&acm
->read_lock
);
910 static void acm_tty_unthrottle(struct tty_struct
*tty
)
912 struct acm
*acm
= tty
->driver_data
;
913 unsigned int was_throttled
;
915 spin_lock_irq(&acm
->read_lock
);
916 was_throttled
= acm
->throttled
;
918 acm
->throttle_req
= 0;
919 spin_unlock_irq(&acm
->read_lock
);
922 acm_submit_read_urbs(acm
, GFP_KERNEL
);
925 static int acm_tty_break_ctl(struct tty_struct
*tty
, int state
)
927 struct acm
*acm
= tty
->driver_data
;
930 retval
= acm_send_break(acm
, state
? 0xffff : 0);
932 dev_dbg(&acm
->control
->dev
,
933 "%s - send break failed\n", __func__
);
937 static int acm_tty_tiocmget(struct tty_struct
*tty
)
939 struct acm
*acm
= tty
->driver_data
;
941 return (acm
->ctrlout
& ACM_CTRL_DTR
? TIOCM_DTR
: 0) |
942 (acm
->ctrlout
& ACM_CTRL_RTS
? TIOCM_RTS
: 0) |
943 (acm
->ctrlin
& ACM_CTRL_DSR
? TIOCM_DSR
: 0) |
944 (acm
->ctrlin
& ACM_CTRL_RI
? TIOCM_RI
: 0) |
945 (acm
->ctrlin
& ACM_CTRL_DCD
? TIOCM_CD
: 0) |
949 static int acm_tty_tiocmset(struct tty_struct
*tty
,
950 unsigned int set
, unsigned int clear
)
952 struct acm
*acm
= tty
->driver_data
;
953 unsigned int newctrl
;
955 newctrl
= acm
->ctrlout
;
956 set
= (set
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
957 (set
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
958 clear
= (clear
& TIOCM_DTR
? ACM_CTRL_DTR
: 0) |
959 (clear
& TIOCM_RTS
? ACM_CTRL_RTS
: 0);
961 newctrl
= (newctrl
& ~clear
) | set
;
963 if (acm
->ctrlout
== newctrl
)
965 return acm_set_control(acm
, acm
->ctrlout
= newctrl
);
968 static int get_serial_info(struct acm
*acm
, struct serial_struct __user
*info
)
970 struct serial_struct tmp
;
972 memset(&tmp
, 0, sizeof(tmp
));
973 tmp
.xmit_fifo_size
= acm
->writesize
;
974 tmp
.baud_base
= le32_to_cpu(acm
->line
.dwDTERate
);
975 tmp
.close_delay
= acm
->port
.close_delay
/ 10;
976 tmp
.closing_wait
= acm
->port
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
977 ASYNC_CLOSING_WAIT_NONE
:
978 acm
->port
.closing_wait
/ 10;
980 if (copy_to_user(info
, &tmp
, sizeof(tmp
)))
986 static int set_serial_info(struct acm
*acm
,
987 struct serial_struct __user
*newinfo
)
989 struct serial_struct new_serial
;
990 unsigned int closing_wait
, close_delay
;
993 if (copy_from_user(&new_serial
, newinfo
, sizeof(new_serial
)))
996 close_delay
= new_serial
.close_delay
* 10;
997 closing_wait
= new_serial
.closing_wait
== ASYNC_CLOSING_WAIT_NONE
?
998 ASYNC_CLOSING_WAIT_NONE
: new_serial
.closing_wait
* 10;
1000 mutex_lock(&acm
->port
.mutex
);
1002 if (!capable(CAP_SYS_ADMIN
)) {
1003 if ((close_delay
!= acm
->port
.close_delay
) ||
1004 (closing_wait
!= acm
->port
.closing_wait
))
1007 retval
= -EOPNOTSUPP
;
1009 acm
->port
.close_delay
= close_delay
;
1010 acm
->port
.closing_wait
= closing_wait
;
1013 mutex_unlock(&acm
->port
.mutex
);
1017 static int wait_serial_change(struct acm
*acm
, unsigned long arg
)
1020 DECLARE_WAITQUEUE(wait
, current
);
1021 struct async_icount old
, new;
1024 spin_lock_irq(&acm
->read_lock
);
1025 old
= acm
->oldcount
;
1027 acm
->oldcount
= new;
1028 spin_unlock_irq(&acm
->read_lock
);
1030 if ((arg
& TIOCM_DSR
) &&
1033 if ((arg
& TIOCM_CD
) &&
1036 if ((arg
& TIOCM_RI
) &&
1040 add_wait_queue(&acm
->wioctl
, &wait
);
1041 set_current_state(TASK_INTERRUPTIBLE
);
1043 remove_wait_queue(&acm
->wioctl
, &wait
);
1044 if (acm
->disconnected
) {
1050 if (signal_pending(current
))
1060 static int acm_tty_get_icount(struct tty_struct
*tty
,
1061 struct serial_icounter_struct
*icount
)
1063 struct acm
*acm
= tty
->driver_data
;
1065 icount
->dsr
= acm
->iocount
.dsr
;
1066 icount
->rng
= acm
->iocount
.rng
;
1067 icount
->dcd
= acm
->iocount
.dcd
;
1068 icount
->frame
= acm
->iocount
.frame
;
1069 icount
->overrun
= acm
->iocount
.overrun
;
1070 icount
->parity
= acm
->iocount
.parity
;
1071 icount
->brk
= acm
->iocount
.brk
;
1076 static int acm_tty_ioctl(struct tty_struct
*tty
,
1077 unsigned int cmd
, unsigned long arg
)
1079 struct acm
*acm
= tty
->driver_data
;
1080 int rv
= -ENOIOCTLCMD
;
1083 case TIOCGSERIAL
: /* gets serial port data */
1084 rv
= get_serial_info(acm
, (struct serial_struct __user
*) arg
);
1087 rv
= set_serial_info(acm
, (struct serial_struct __user
*) arg
);
1090 rv
= usb_autopm_get_interface(acm
->control
);
1095 rv
= wait_serial_change(acm
, arg
);
1096 usb_autopm_put_interface(acm
->control
);
1103 static void acm_tty_set_termios(struct tty_struct
*tty
,
1104 struct ktermios
*termios_old
)
1106 struct acm
*acm
= tty
->driver_data
;
1107 struct ktermios
*termios
= &tty
->termios
;
1108 struct usb_cdc_line_coding newline
;
1109 int newctrl
= acm
->ctrlout
;
1111 newline
.dwDTERate
= cpu_to_le32(tty_get_baud_rate(tty
));
1112 newline
.bCharFormat
= termios
->c_cflag
& CSTOPB
? 2 : 0;
1113 newline
.bParityType
= termios
->c_cflag
& PARENB
?
1114 (termios
->c_cflag
& PARODD
? 1 : 2) +
1115 (termios
->c_cflag
& CMSPAR
? 2 : 0) : 0;
1116 switch (termios
->c_cflag
& CSIZE
) {
1118 newline
.bDataBits
= 5;
1121 newline
.bDataBits
= 6;
1124 newline
.bDataBits
= 7;
1128 newline
.bDataBits
= 8;
1131 /* FIXME: Needs to clear unsupported bits in the termios */
1132 acm
->clocal
= ((termios
->c_cflag
& CLOCAL
) != 0);
1134 if (C_BAUD(tty
) == B0
) {
1135 newline
.dwDTERate
= acm
->line
.dwDTERate
;
1136 newctrl
&= ~ACM_CTRL_DTR
;
1137 } else if (termios_old
&& (termios_old
->c_cflag
& CBAUD
) == B0
) {
1138 newctrl
|= ACM_CTRL_DTR
;
1141 if (newctrl
!= acm
->ctrlout
)
1142 acm_set_control(acm
, acm
->ctrlout
= newctrl
);
1144 if (memcmp(&acm
->line
, &newline
, sizeof newline
)) {
1145 memcpy(&acm
->line
, &newline
, sizeof newline
);
1146 dev_dbg(&acm
->control
->dev
, "%s - set line: %d %d %d %d\n",
1148 le32_to_cpu(newline
.dwDTERate
),
1149 newline
.bCharFormat
, newline
.bParityType
,
1151 acm_set_line(acm
, &acm
->line
);
1155 static const struct tty_port_operations acm_port_ops
= {
1156 .dtr_rts
= acm_port_dtr_rts
,
1157 .shutdown
= acm_port_shutdown
,
1158 .activate
= acm_port_activate
,
1159 .destruct
= acm_port_destruct
,
1163 * USB probe and disconnect routines.
1166 /* Little helpers: write/read buffers free */
1167 static void acm_write_buffers_free(struct acm
*acm
)
1172 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++)
1173 usb_free_coherent(acm
->dev
, acm
->writesize
, wb
->buf
, wb
->dmah
);
1176 static void acm_read_buffers_free(struct acm
*acm
)
1180 for (i
= 0; i
< acm
->rx_buflimit
; i
++)
1181 usb_free_coherent(acm
->dev
, acm
->readsize
,
1182 acm
->read_buffers
[i
].base
, acm
->read_buffers
[i
].dma
);
1185 /* Little helper: write buffers allocate */
1186 static int acm_write_buffers_alloc(struct acm
*acm
)
1191 for (wb
= &acm
->wb
[0], i
= 0; i
< ACM_NW
; i
++, wb
++) {
1192 wb
->buf
= usb_alloc_coherent(acm
->dev
, acm
->writesize
, GFP_KERNEL
,
1198 usb_free_coherent(acm
->dev
, acm
->writesize
,
1207 static int acm_probe(struct usb_interface
*intf
,
1208 const struct usb_device_id
*id
)
1210 struct usb_cdc_union_desc
*union_header
= NULL
;
1211 struct usb_cdc_call_mgmt_descriptor
*cmgmd
= NULL
;
1212 unsigned char *buffer
= intf
->altsetting
->extra
;
1213 int buflen
= intf
->altsetting
->extralen
;
1214 struct usb_interface
*control_interface
;
1215 struct usb_interface
*data_interface
;
1216 struct usb_endpoint_descriptor
*epctrl
= NULL
;
1217 struct usb_endpoint_descriptor
*epread
= NULL
;
1218 struct usb_endpoint_descriptor
*epwrite
= NULL
;
1219 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1220 struct usb_cdc_parsed_header h
;
1223 int ctrlsize
, readsize
;
1225 int call_intf_num
= -1;
1226 int data_intf_num
= -1;
1227 unsigned long quirks
;
1230 int combined_interfaces
= 0;
1231 struct device
*tty_dev
;
1236 quirks
= (unsigned long)id
->driver_info
;
1238 if (quirks
== IGNORE_DEVICE
)
1241 memset(&h
, 0x00, sizeof(struct usb_cdc_parsed_header
));
1243 num_rx_buf
= (quirks
== SINGLE_RX_URB
) ? 1 : ACM_NR
;
1245 /* handle quirks deadly to normal probing*/
1246 if (quirks
== NO_UNION_NORMAL
) {
1247 data_interface
= usb_ifnum_to_if(usb_dev
, 1);
1248 control_interface
= usb_ifnum_to_if(usb_dev
, 0);
1249 /* we would crash */
1250 if (!data_interface
|| !control_interface
)
1252 goto skip_normal_probe
;
1257 dev_err(&intf
->dev
, "Weird descriptor references\n");
1261 if (!intf
->cur_altsetting
)
1265 if (intf
->cur_altsetting
->endpoint
&&
1266 intf
->cur_altsetting
->endpoint
->extralen
&&
1267 intf
->cur_altsetting
->endpoint
->extra
) {
1269 "Seeking extra descriptors on endpoint\n");
1270 buflen
= intf
->cur_altsetting
->endpoint
->extralen
;
1271 buffer
= intf
->cur_altsetting
->endpoint
->extra
;
1274 "Zero length descriptor references\n");
1279 cdc_parse_cdc_header(&h
, intf
, buffer
, buflen
);
1280 union_header
= h
.usb_cdc_union_desc
;
1281 cmgmd
= h
.usb_cdc_call_mgmt_descriptor
;
1283 call_intf_num
= cmgmd
->bDataInterface
;
1285 if (!union_header
) {
1286 if (call_intf_num
> 0) {
1287 dev_dbg(&intf
->dev
, "No union descriptor, using call management descriptor\n");
1288 /* quirks for Droids MuIn LCD */
1289 if (quirks
& NO_DATA_INTERFACE
) {
1290 data_interface
= usb_ifnum_to_if(usb_dev
, 0);
1292 data_intf_num
= call_intf_num
;
1293 data_interface
= usb_ifnum_to_if(usb_dev
, data_intf_num
);
1295 control_interface
= intf
;
1297 if (intf
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1298 dev_dbg(&intf
->dev
,"No union descriptor, giving up\n");
1301 dev_warn(&intf
->dev
,"No union descriptor, testing for castrated device\n");
1302 combined_interfaces
= 1;
1303 control_interface
= data_interface
= intf
;
1304 goto look_for_collapsed_interface
;
1308 data_intf_num
= union_header
->bSlaveInterface0
;
1309 control_interface
= usb_ifnum_to_if(usb_dev
, union_header
->bMasterInterface0
);
1310 data_interface
= usb_ifnum_to_if(usb_dev
, data_intf_num
);
1313 if (!control_interface
|| !data_interface
) {
1314 dev_dbg(&intf
->dev
, "no interfaces\n");
1317 if (!data_interface
->cur_altsetting
|| !control_interface
->cur_altsetting
)
1320 if (data_intf_num
!= call_intf_num
)
1321 dev_dbg(&intf
->dev
, "Separate call control interface. That is not fully supported.\n");
1323 if (control_interface
== data_interface
) {
1324 /* some broken devices designed for windows work this way */
1325 dev_warn(&intf
->dev
,"Control and data interfaces are not separated!\n");
1326 combined_interfaces
= 1;
1327 /* a popular other OS doesn't use it */
1328 quirks
|= NO_CAP_LINE
;
1329 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
!= 3) {
1330 dev_err(&intf
->dev
, "This needs exactly 3 endpoints\n");
1333 look_for_collapsed_interface
:
1334 res
= usb_find_common_endpoints(data_interface
->cur_altsetting
,
1335 &epread
, &epwrite
, &epctrl
, NULL
);
1339 goto made_compressed_probe
;
1344 /*workaround for switched interfaces */
1345 if (data_interface
->cur_altsetting
->desc
.bInterfaceClass
1346 != CDC_DATA_INTERFACE_TYPE
) {
1347 if (control_interface
->cur_altsetting
->desc
.bInterfaceClass
1348 == CDC_DATA_INTERFACE_TYPE
) {
1350 "Your device has switched interfaces.\n");
1351 swap(control_interface
, data_interface
);
1357 /* Accept probe requests only for the control interface */
1358 if (!combined_interfaces
&& intf
!= control_interface
)
1361 if (!combined_interfaces
&& usb_interface_claimed(data_interface
)) {
1362 /* valid in this context */
1363 dev_dbg(&intf
->dev
, "The data interface isn't available\n");
1368 if (data_interface
->cur_altsetting
->desc
.bNumEndpoints
< 2 ||
1369 control_interface
->cur_altsetting
->desc
.bNumEndpoints
== 0)
1372 epctrl
= &control_interface
->cur_altsetting
->endpoint
[0].desc
;
1373 epread
= &data_interface
->cur_altsetting
->endpoint
[0].desc
;
1374 epwrite
= &data_interface
->cur_altsetting
->endpoint
[1].desc
;
1377 /* workaround for switched endpoints */
1378 if (!usb_endpoint_dir_in(epread
)) {
1379 /* descriptors are swapped */
1381 "The data interface has switched endpoints\n");
1382 swap(epread
, epwrite
);
1384 made_compressed_probe
:
1385 dev_dbg(&intf
->dev
, "interfaces are valid\n");
1387 acm
= kzalloc(sizeof(struct acm
), GFP_KERNEL
);
1391 minor
= acm_alloc_minor(acm
);
1395 ctrlsize
= usb_endpoint_maxp(epctrl
);
1396 readsize
= usb_endpoint_maxp(epread
) *
1397 (quirks
== SINGLE_RX_URB
? 1 : 2);
1398 acm
->combined_interfaces
= combined_interfaces
;
1399 acm
->writesize
= usb_endpoint_maxp(epwrite
) * 20;
1400 acm
->control
= control_interface
;
1401 acm
->data
= data_interface
;
1404 if (h
.usb_cdc_acm_descriptor
)
1405 acm
->ctrl_caps
= h
.usb_cdc_acm_descriptor
->bmCapabilities
;
1406 if (quirks
& NO_CAP_LINE
)
1407 acm
->ctrl_caps
&= ~USB_CDC_CAP_LINE
;
1408 acm
->ctrlsize
= ctrlsize
;
1409 acm
->readsize
= readsize
;
1410 acm
->rx_buflimit
= num_rx_buf
;
1411 INIT_WORK(&acm
->work
, acm_softint
);
1412 init_waitqueue_head(&acm
->wioctl
);
1413 spin_lock_init(&acm
->write_lock
);
1414 spin_lock_init(&acm
->read_lock
);
1415 mutex_init(&acm
->mutex
);
1416 if (usb_endpoint_xfer_int(epread
)) {
1417 acm
->bInterval
= epread
->bInterval
;
1418 acm
->in
= usb_rcvintpipe(usb_dev
, epread
->bEndpointAddress
);
1420 acm
->in
= usb_rcvbulkpipe(usb_dev
, epread
->bEndpointAddress
);
1422 if (usb_endpoint_xfer_int(epwrite
))
1423 acm
->out
= usb_sndintpipe(usb_dev
, epwrite
->bEndpointAddress
);
1425 acm
->out
= usb_sndbulkpipe(usb_dev
, epwrite
->bEndpointAddress
);
1426 tty_port_init(&acm
->port
);
1427 acm
->port
.ops
= &acm_port_ops
;
1428 init_usb_anchor(&acm
->delayed
);
1429 acm
->quirks
= quirks
;
1431 buf
= usb_alloc_coherent(usb_dev
, ctrlsize
, GFP_KERNEL
, &acm
->ctrl_dma
);
1434 acm
->ctrl_buffer
= buf
;
1436 if (acm_write_buffers_alloc(acm
) < 0)
1439 acm
->ctrlurb
= usb_alloc_urb(0, GFP_KERNEL
);
1443 for (i
= 0; i
< num_rx_buf
; i
++) {
1444 struct acm_rb
*rb
= &(acm
->read_buffers
[i
]);
1447 rb
->base
= usb_alloc_coherent(acm
->dev
, readsize
, GFP_KERNEL
,
1454 urb
= usb_alloc_urb(0, GFP_KERNEL
);
1458 urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1459 urb
->transfer_dma
= rb
->dma
;
1460 if (usb_endpoint_xfer_int(epread
))
1461 usb_fill_int_urb(urb
, acm
->dev
, acm
->in
, rb
->base
,
1463 acm_read_bulk_callback
, rb
,
1466 usb_fill_bulk_urb(urb
, acm
->dev
, acm
->in
, rb
->base
,
1468 acm_read_bulk_callback
, rb
);
1470 acm
->read_urbs
[i
] = urb
;
1471 __set_bit(i
, &acm
->read_urbs_free
);
1473 for (i
= 0; i
< ACM_NW
; i
++) {
1474 struct acm_wb
*snd
= &(acm
->wb
[i
]);
1476 snd
->urb
= usb_alloc_urb(0, GFP_KERNEL
);
1477 if (snd
->urb
== NULL
)
1480 if (usb_endpoint_xfer_int(epwrite
))
1481 usb_fill_int_urb(snd
->urb
, usb_dev
, acm
->out
,
1482 NULL
, acm
->writesize
, acm_write_bulk
, snd
, epwrite
->bInterval
);
1484 usb_fill_bulk_urb(snd
->urb
, usb_dev
, acm
->out
,
1485 NULL
, acm
->writesize
, acm_write_bulk
, snd
);
1486 snd
->urb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1487 if (quirks
& SEND_ZERO_PACKET
)
1488 snd
->urb
->transfer_flags
|= URB_ZERO_PACKET
;
1489 snd
->instance
= acm
;
1492 usb_set_intfdata(intf
, acm
);
1494 i
= device_create_file(&intf
->dev
, &dev_attr_bmCapabilities
);
1498 if (h
.usb_cdc_country_functional_desc
) { /* export the country data */
1499 struct usb_cdc_country_functional_desc
* cfd
=
1500 h
.usb_cdc_country_functional_desc
;
1502 acm
->country_codes
= kmalloc(cfd
->bLength
- 4, GFP_KERNEL
);
1503 if (!acm
->country_codes
)
1504 goto skip_countries
;
1505 acm
->country_code_size
= cfd
->bLength
- 4;
1506 memcpy(acm
->country_codes
, (u8
*)&cfd
->wCountyCode0
,
1508 acm
->country_rel_date
= cfd
->iCountryCodeRelDate
;
1510 i
= device_create_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1512 kfree(acm
->country_codes
);
1513 acm
->country_codes
= NULL
;
1514 acm
->country_code_size
= 0;
1515 goto skip_countries
;
1518 i
= device_create_file(&intf
->dev
,
1519 &dev_attr_iCountryCodeRelDate
);
1521 device_remove_file(&intf
->dev
, &dev_attr_wCountryCodes
);
1522 kfree(acm
->country_codes
);
1523 acm
->country_codes
= NULL
;
1524 acm
->country_code_size
= 0;
1525 goto skip_countries
;
1530 usb_fill_int_urb(acm
->ctrlurb
, usb_dev
,
1531 usb_rcvintpipe(usb_dev
, epctrl
->bEndpointAddress
),
1532 acm
->ctrl_buffer
, ctrlsize
, acm_ctrl_irq
, acm
,
1533 /* works around buggy devices */
1534 epctrl
->bInterval
? epctrl
->bInterval
: 16);
1535 acm
->ctrlurb
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1536 acm
->ctrlurb
->transfer_dma
= acm
->ctrl_dma
;
1537 acm
->notification_buffer
= NULL
;
1541 dev_info(&intf
->dev
, "ttyACM%d: USB ACM device\n", minor
);
1543 acm
->line
.dwDTERate
= cpu_to_le32(9600);
1544 acm
->line
.bDataBits
= 8;
1545 acm_set_line(acm
, &acm
->line
);
1547 usb_driver_claim_interface(&acm_driver
, data_interface
, acm
);
1548 usb_set_intfdata(data_interface
, acm
);
1550 usb_get_intf(control_interface
);
1551 tty_dev
= tty_port_register_device(&acm
->port
, acm_tty_driver
, minor
,
1552 &control_interface
->dev
);
1553 if (IS_ERR(tty_dev
)) {
1554 rv
= PTR_ERR(tty_dev
);
1558 if (quirks
& CLEAR_HALT_CONDITIONS
) {
1559 usb_clear_halt(usb_dev
, acm
->in
);
1560 usb_clear_halt(usb_dev
, acm
->out
);
1565 if (acm
->country_codes
) {
1566 device_remove_file(&acm
->control
->dev
,
1567 &dev_attr_wCountryCodes
);
1568 device_remove_file(&acm
->control
->dev
,
1569 &dev_attr_iCountryCodeRelDate
);
1570 kfree(acm
->country_codes
);
1572 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1574 usb_set_intfdata(intf
, NULL
);
1575 for (i
= 0; i
< ACM_NW
; i
++)
1576 usb_free_urb(acm
->wb
[i
].urb
);
1578 for (i
= 0; i
< num_rx_buf
; i
++)
1579 usb_free_urb(acm
->read_urbs
[i
]);
1580 acm_read_buffers_free(acm
);
1581 usb_free_urb(acm
->ctrlurb
);
1583 acm_write_buffers_free(acm
);
1585 usb_free_coherent(usb_dev
, ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1587 acm_release_minor(acm
);
1594 static void acm_disconnect(struct usb_interface
*intf
)
1596 struct acm
*acm
= usb_get_intfdata(intf
);
1597 struct tty_struct
*tty
;
1599 /* sibling interface is already cleaning up */
1603 mutex_lock(&acm
->mutex
);
1604 acm
->disconnected
= true;
1605 if (acm
->country_codes
) {
1606 device_remove_file(&acm
->control
->dev
,
1607 &dev_attr_wCountryCodes
);
1608 device_remove_file(&acm
->control
->dev
,
1609 &dev_attr_iCountryCodeRelDate
);
1611 wake_up_all(&acm
->wioctl
);
1612 device_remove_file(&acm
->control
->dev
, &dev_attr_bmCapabilities
);
1613 usb_set_intfdata(acm
->control
, NULL
);
1614 usb_set_intfdata(acm
->data
, NULL
);
1615 mutex_unlock(&acm
->mutex
);
1617 tty
= tty_port_tty_get(&acm
->port
);
1624 cancel_work_sync(&acm
->work
);
1626 tty_unregister_device(acm_tty_driver
, acm
->minor
);
1628 acm_write_buffers_free(acm
);
1629 usb_free_coherent(acm
->dev
, acm
->ctrlsize
, acm
->ctrl_buffer
, acm
->ctrl_dma
);
1630 acm_read_buffers_free(acm
);
1632 kfree(acm
->notification_buffer
);
1634 if (!acm
->combined_interfaces
)
1635 usb_driver_release_interface(&acm_driver
, intf
== acm
->control
?
1636 acm
->data
: acm
->control
);
1638 tty_port_put(&acm
->port
);
1642 static int acm_suspend(struct usb_interface
*intf
, pm_message_t message
)
1644 struct acm
*acm
= usb_get_intfdata(intf
);
1647 spin_lock_irq(&acm
->write_lock
);
1648 if (PMSG_IS_AUTO(message
)) {
1649 if (acm
->transmitting
) {
1650 spin_unlock_irq(&acm
->write_lock
);
1654 cnt
= acm
->susp_count
++;
1655 spin_unlock_irq(&acm
->write_lock
);
1661 cancel_work_sync(&acm
->work
);
1666 static int acm_resume(struct usb_interface
*intf
)
1668 struct acm
*acm
= usb_get_intfdata(intf
);
1672 spin_lock_irq(&acm
->write_lock
);
1674 if (--acm
->susp_count
)
1677 if (tty_port_initialized(&acm
->port
)) {
1678 rv
= usb_submit_urb(acm
->ctrlurb
, GFP_ATOMIC
);
1681 urb
= usb_get_from_anchor(&acm
->delayed
);
1685 acm_start_wb(acm
, urb
->context
);
1689 * delayed error checking because we must
1690 * do the write path at all cost
1695 rv
= acm_submit_read_urbs(acm
, GFP_ATOMIC
);
1698 spin_unlock_irq(&acm
->write_lock
);
1703 static int acm_reset_resume(struct usb_interface
*intf
)
1705 struct acm
*acm
= usb_get_intfdata(intf
);
1707 if (tty_port_initialized(&acm
->port
))
1708 tty_port_tty_hangup(&acm
->port
, false);
1710 return acm_resume(intf
);
1713 #endif /* CONFIG_PM */
1715 static int acm_pre_reset(struct usb_interface
*intf
)
1717 struct acm
*acm
= usb_get_intfdata(intf
);
1719 clear_bit(EVENT_RX_STALL
, &acm
->flags
);
1724 #define NOKIA_PCSUITE_ACM_INFO(x) \
1725 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1726 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1727 USB_CDC_ACM_PROTO_VENDOR)
1729 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1730 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1731 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1732 USB_CDC_ACM_PROTO_VENDOR)
1735 * USB driver structure.
1738 static const struct usb_device_id acm_ids
[] = {
1739 /* quirky and broken devices */
1740 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1741 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1742 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1743 .driver_info
= NO_UNION_NORMAL
, },/* has no union descriptor */
1744 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1745 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1747 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1748 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1750 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1751 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1753 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1754 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1756 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1757 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1759 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1760 .driver_info
= SINGLE_RX_URB
,
1762 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1763 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1765 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1766 .driver_info
= SINGLE_RX_URB
, /* firmware bug */
1768 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1769 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1771 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1772 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1774 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1775 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1777 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1778 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1780 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1781 .driver_info
= NO_UNION_NORMAL
, /* has no union descriptor */
1783 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1784 .driver_info
= QUIRK_CONTROL_LINE_STATE
, },
1785 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1786 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1787 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1789 /* Motorola H24 HSPA module: */
1790 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1791 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1792 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1794 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1795 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1797 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1798 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1800 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1801 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1803 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1804 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1806 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1807 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1809 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1810 .driver_info
= NO_UNION_NORMAL
, /* handle only modem interface */
1813 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1814 .driver_info
= NO_UNION_NORMAL
, /* union descriptor misplaced on
1815 data interface instead of
1816 communications interface.
1817 Maybe we should define a new
1820 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1821 .driver_info
= NO_UNION_NORMAL
,
1823 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1824 .driver_info
= NO_UNION_NORMAL
,
1826 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1827 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1829 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1830 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1832 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1833 .driver_info
= NO_UNION_NORMAL
, /* reports zero length descriptor */
1836 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1837 .driver_info
= CLEAR_HALT_CONDITIONS
,
1840 /* Nokia S60 phones expose two ACM channels. The first is
1841 * a modem and is picked up by the standard AT-command
1842 * information below. The second is 'vendor-specific' but
1843 * is treated as a serial device at the S60 end, so we want
1844 * to expose it on Linux too. */
1845 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1846 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1847 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1848 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1849 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1850 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1851 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1852 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1853 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1854 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1855 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1856 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1857 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1858 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1859 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1860 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1861 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1862 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1863 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1864 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1865 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1866 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1867 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1868 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1869 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1870 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1871 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1872 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1873 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1874 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1875 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1876 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1877 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1878 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1879 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1880 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1881 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1882 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1883 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1884 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1885 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1886 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1887 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1888 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1889 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1890 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1891 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1892 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1893 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1894 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1895 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1896 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1897 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1898 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1899 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1900 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1901 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1902 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1904 /* Support for Owen devices */
1905 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1907 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1909 /* Support for Droids MuIn LCD */
1910 { USB_DEVICE(0x04d8, 0x000b),
1911 .driver_info
= NO_DATA_INTERFACE
,
1914 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1915 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1916 .driver_info
= IGNORE_DEVICE
,
1918 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1919 .driver_info
= IGNORE_DEVICE
,
1923 /*Samsung phone in firmware update mode */
1924 { USB_DEVICE(0x04e8, 0x685d),
1925 .driver_info
= IGNORE_DEVICE
,
1928 /* Exclude Infineon Flash Loader utility */
1929 { USB_DEVICE(0x058b, 0x0041),
1930 .driver_info
= IGNORE_DEVICE
,
1933 /* control interfaces without any protocol set */
1934 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1935 USB_CDC_PROTO_NONE
) },
1937 /* control interfaces with various AT-command sets */
1938 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1939 USB_CDC_ACM_PROTO_AT_V25TER
) },
1940 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1941 USB_CDC_ACM_PROTO_AT_PCCA101
) },
1942 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1943 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE
) },
1944 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1945 USB_CDC_ACM_PROTO_AT_GSM
) },
1946 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1947 USB_CDC_ACM_PROTO_AT_3G
) },
1948 { USB_INTERFACE_INFO(USB_CLASS_COMM
, USB_CDC_SUBCLASS_ACM
,
1949 USB_CDC_ACM_PROTO_AT_CDMA
) },
1951 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1952 .driver_info
= SEND_ZERO_PACKET
,
1958 MODULE_DEVICE_TABLE(usb
, acm_ids
);
1960 static struct usb_driver acm_driver
= {
1963 .disconnect
= acm_disconnect
,
1965 .suspend
= acm_suspend
,
1966 .resume
= acm_resume
,
1967 .reset_resume
= acm_reset_resume
,
1969 .pre_reset
= acm_pre_reset
,
1970 .id_table
= acm_ids
,
1972 .supports_autosuspend
= 1,
1974 .disable_hub_initiated_lpm
= 1,
1978 * TTY driver structures.
1981 static const struct tty_operations acm_ops
= {
1982 .install
= acm_tty_install
,
1983 .open
= acm_tty_open
,
1984 .close
= acm_tty_close
,
1985 .cleanup
= acm_tty_cleanup
,
1986 .hangup
= acm_tty_hangup
,
1987 .write
= acm_tty_write
,
1988 .put_char
= acm_tty_put_char
,
1989 .flush_chars
= acm_tty_flush_chars
,
1990 .write_room
= acm_tty_write_room
,
1991 .ioctl
= acm_tty_ioctl
,
1992 .throttle
= acm_tty_throttle
,
1993 .unthrottle
= acm_tty_unthrottle
,
1994 .chars_in_buffer
= acm_tty_chars_in_buffer
,
1995 .break_ctl
= acm_tty_break_ctl
,
1996 .set_termios
= acm_tty_set_termios
,
1997 .tiocmget
= acm_tty_tiocmget
,
1998 .tiocmset
= acm_tty_tiocmset
,
1999 .get_icount
= acm_tty_get_icount
,
2006 static int __init
acm_init(void)
2009 acm_tty_driver
= alloc_tty_driver(ACM_TTY_MINORS
);
2010 if (!acm_tty_driver
)
2012 acm_tty_driver
->driver_name
= "acm",
2013 acm_tty_driver
->name
= "ttyACM",
2014 acm_tty_driver
->major
= ACM_TTY_MAJOR
,
2015 acm_tty_driver
->minor_start
= 0,
2016 acm_tty_driver
->type
= TTY_DRIVER_TYPE_SERIAL
,
2017 acm_tty_driver
->subtype
= SERIAL_TYPE_NORMAL
,
2018 acm_tty_driver
->flags
= TTY_DRIVER_REAL_RAW
| TTY_DRIVER_DYNAMIC_DEV
;
2019 acm_tty_driver
->init_termios
= tty_std_termios
;
2020 acm_tty_driver
->init_termios
.c_cflag
= B9600
| CS8
| CREAD
|
2022 tty_set_operations(acm_tty_driver
, &acm_ops
);
2024 retval
= tty_register_driver(acm_tty_driver
);
2026 put_tty_driver(acm_tty_driver
);
2030 retval
= usb_register(&acm_driver
);
2032 tty_unregister_driver(acm_tty_driver
);
2033 put_tty_driver(acm_tty_driver
);
2037 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_DESC
"\n");
2042 static void __exit
acm_exit(void)
2044 usb_deregister(&acm_driver
);
2045 tty_unregister_driver(acm_tty_driver
);
2046 put_tty_driver(acm_tty_driver
);
2047 idr_destroy(&acm_minors
);
2050 module_init(acm_init
);
2051 module_exit(acm_exit
);
2053 MODULE_AUTHOR(DRIVER_AUTHOR
);
2054 MODULE_DESCRIPTION(DRIVER_DESC
);
2055 MODULE_LICENSE("GPL");
2056 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR
);