1 // SPDX-License-Identifier: GPL-2.0+
13 * USB Abstract Control Model driver for USB modems and ISDN adapters
21 #include <linux/kernel.h>
22 #include <linux/sched/signal.h>
23 #include <linux/errno.h>
24 #include <linux/init.h>
25 #include <linux/slab.h>
26 #include <linux/log2.h>
27 #include <linux/tty.h>
28 #include <linux/serial.h>
29 #include <linux/tty_driver.h>
30 #include <linux/tty_flip.h>
31 #include <linux/module.h>
32 #include <linux/mutex.h>
33 #include <linux/uaccess.h>
34 #include <linux/usb.h>
35 #include <linux/usb/cdc.h>
36 #include <asm/byteorder.h>
37 #include <asm/unaligned.h>
38 #include <linux/idr.h>
39 #include <linux/list.h>
44 #define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek, Johan Hovold"
45 #define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"
47 static struct usb_driver acm_driver;
48 static struct tty_driver *acm_tty_driver;
50 static DEFINE_IDR(acm_minors);
51 static DEFINE_MUTEX(acm_minors_lock);
53 static void acm_tty_set_termios(struct tty_struct *tty,
54 struct ktermios *termios_old);
57 * acm_minors accessors
61 * Look up an ACM structure by minor. If found and not disconnected, increment
62 * its refcount and return it with its mutex held.
64 static struct acm *acm_get_by_minor(unsigned int minor)
68 mutex_lock(&acm_minors_lock);
69 acm = idr_find(&acm_minors, minor);
71 mutex_lock(&acm->mutex);
72 if (acm->disconnected) {
73 mutex_unlock(&acm->mutex);
76 tty_port_get(&acm->port);
77 mutex_unlock(&acm->mutex);
80 mutex_unlock(&acm_minors_lock);
85 * Try to find an available minor number and if found, associate it with 'acm'.
87 static int acm_alloc_minor(struct acm *acm)
91 mutex_lock(&acm_minors_lock);
92 minor = idr_alloc(&acm_minors, acm, 0, ACM_TTY_MINORS, GFP_KERNEL);
93 mutex_unlock(&acm_minors_lock);
98 /* Release the minor number associated with 'acm'. */
99 static void acm_release_minor(struct acm *acm)
101 mutex_lock(&acm_minors_lock);
102 idr_remove(&acm_minors, acm->minor);
103 mutex_unlock(&acm_minors_lock);
107 * Functions for ACM control messages.
110 static int acm_ctrl_msg(struct acm *acm, int request, int value,
115 retval = usb_autopm_get_interface(acm->control);
119 retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
120 request, USB_RT_ACM, value,
121 acm->control->altsetting[0].desc.bInterfaceNumber,
124 dev_dbg(&acm->control->dev,
125 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
126 __func__, request, value, len, retval);
128 usb_autopm_put_interface(acm->control);
130 return retval < 0 ? retval : 0;
133 /* devices aren't required to support these requests.
134 * the cdc acm descriptor tells whether they do...
136 static inline int acm_set_control(struct acm *acm, int control)
138 if (acm->quirks & QUIRK_CONTROL_LINE_STATE)
141 return acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE,
145 #define acm_set_line(acm, line) \
146 acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
147 #define acm_send_break(acm, ms) \
148 acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)
150 static void acm_kill_urbs(struct acm *acm)
154 usb_kill_urb(acm->ctrlurb);
155 for (i = 0; i < ACM_NW; i++)
156 usb_kill_urb(acm->wb[i].urb);
157 for (i = 0; i < acm->rx_buflimit; i++)
158 usb_kill_urb(acm->read_urbs[i]);
162 * Write buffer management.
163 * All of these assume proper locks taken by the caller.
166 static int acm_wb_alloc(struct acm *acm)
180 wbn = (wbn + 1) % ACM_NW;
186 static int acm_wb_is_avail(struct acm *acm)
192 spin_lock_irqsave(&acm->write_lock, flags);
193 for (i = 0; i < ACM_NW; i++)
195 spin_unlock_irqrestore(&acm->write_lock, flags);
200 * Finish write. Caller must hold acm->write_lock
202 static void acm_write_done(struct acm *acm, struct acm_wb *wb)
206 usb_autopm_put_interface_async(acm->control);
212 * the caller is responsible for locking
215 static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
221 wb->urb->transfer_buffer = wb->buf;
222 wb->urb->transfer_dma = wb->dmah;
223 wb->urb->transfer_buffer_length = wb->len;
224 wb->urb->dev = acm->dev;
226 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
228 dev_err(&acm->data->dev,
229 "%s - usb_submit_urb(write bulk) failed: %d\n",
231 acm_write_done(acm, wb);
237 * attributes exported through sysfs
239 static ssize_t bmCapabilities_show
240 (struct device *dev, struct device_attribute *attr, char *buf)
242 struct usb_interface *intf = to_usb_interface(dev);
243 struct acm *acm = usb_get_intfdata(intf);
245 return sprintf(buf, "%d", acm->ctrl_caps);
247 static DEVICE_ATTR_RO(bmCapabilities);
249 static ssize_t wCountryCodes_show
250 (struct device *dev, struct device_attribute *attr, char *buf)
252 struct usb_interface *intf = to_usb_interface(dev);
253 struct acm *acm = usb_get_intfdata(intf);
255 memcpy(buf, acm->country_codes, acm->country_code_size);
256 return acm->country_code_size;
259 static DEVICE_ATTR_RO(wCountryCodes);
261 static ssize_t iCountryCodeRelDate_show
262 (struct device *dev, struct device_attribute *attr, char *buf)
264 struct usb_interface *intf = to_usb_interface(dev);
265 struct acm *acm = usb_get_intfdata(intf);
267 return sprintf(buf, "%d", acm->country_rel_date);
270 static DEVICE_ATTR_RO(iCountryCodeRelDate);
272 * Interrupt handlers for various ACM device responses
275 static void acm_process_notification(struct acm *acm, unsigned char *buf)
279 struct usb_cdc_notification *dr = (struct usb_cdc_notification *)buf;
280 unsigned char *data = buf + sizeof(struct usb_cdc_notification);
282 switch (dr->bNotificationType) {
283 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
284 dev_dbg(&acm->control->dev,
285 "%s - network connection: %d\n", __func__, dr->wValue);
288 case USB_CDC_NOTIFY_SERIAL_STATE:
289 if (le16_to_cpu(dr->wLength) != 2) {
290 dev_dbg(&acm->control->dev,
291 "%s - malformed serial state\n", __func__);
295 newctrl = get_unaligned_le16(data);
296 dev_dbg(&acm->control->dev,
297 "%s - serial state: 0x%x\n", __func__, newctrl);
299 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
300 dev_dbg(&acm->control->dev,
301 "%s - calling hangup\n", __func__);
302 tty_port_tty_hangup(&acm->port, false);
305 difference = acm->ctrlin ^ newctrl;
306 spin_lock(&acm->read_lock);
307 acm->ctrlin = newctrl;
308 acm->oldcount = acm->iocount;
310 if (difference & ACM_CTRL_DSR)
312 if (difference & ACM_CTRL_BRK)
314 if (difference & ACM_CTRL_RI)
316 if (difference & ACM_CTRL_DCD)
318 if (difference & ACM_CTRL_FRAMING)
319 acm->iocount.frame++;
320 if (difference & ACM_CTRL_PARITY)
321 acm->iocount.parity++;
322 if (difference & ACM_CTRL_OVERRUN)
323 acm->iocount.overrun++;
324 spin_unlock(&acm->read_lock);
327 wake_up_all(&acm->wioctl);
332 dev_dbg(&acm->control->dev,
333 "%s - unknown notification %d received: index %d len %d\n",
335 dr->bNotificationType, dr->wIndex, dr->wLength);
339 /* control interface reports status changes with "interrupt" transfers */
340 static void acm_ctrl_irq(struct urb *urb)
342 struct acm *acm = urb->context;
343 struct usb_cdc_notification *dr = urb->transfer_buffer;
344 unsigned int current_size = urb->actual_length;
345 unsigned int expected_size, copy_size, alloc_size;
347 int status = urb->status;
356 /* this urb is terminated, clean up */
358 dev_dbg(&acm->control->dev,
359 "%s - urb shutting down with status: %d\n",
363 dev_dbg(&acm->control->dev,
364 "%s - nonzero urb status received: %d\n",
369 usb_mark_last_busy(acm->dev);
372 dr = (struct usb_cdc_notification *)acm->notification_buffer;
374 /* size = notification-header + (optional) data */
375 expected_size = sizeof(struct usb_cdc_notification) +
376 le16_to_cpu(dr->wLength);
378 if (current_size < expected_size) {
379 /* notification is transmitted fragmented, reassemble */
380 if (acm->nb_size < expected_size) {
382 kfree(acm->notification_buffer);
385 alloc_size = roundup_pow_of_two(expected_size);
387 * kmalloc ensures a valid notification_buffer after a
388 * use of kfree in case the previous allocation was too
389 * small. Final freeing is done on disconnect.
391 acm->notification_buffer =
392 kmalloc(alloc_size, GFP_ATOMIC);
393 if (!acm->notification_buffer)
395 acm->nb_size = alloc_size;
398 copy_size = min(current_size,
399 expected_size - acm->nb_index);
401 memcpy(&acm->notification_buffer[acm->nb_index],
402 urb->transfer_buffer, copy_size);
403 acm->nb_index += copy_size;
404 current_size = acm->nb_index;
407 if (current_size >= expected_size) {
408 /* notification complete */
409 acm_process_notification(acm, (unsigned char *)dr);
414 retval = usb_submit_urb(urb, GFP_ATOMIC);
415 if (retval && retval != -EPERM)
416 dev_err(&acm->control->dev,
417 "%s - usb_submit_urb failed: %d\n", __func__, retval);
420 static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
424 if (!test_and_clear_bit(index, &acm->read_urbs_free))
427 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
429 if (res != -EPERM && res != -ENODEV) {
430 dev_err(&acm->data->dev,
431 "urb %d failed submission with %d\n",
434 set_bit(index, &acm->read_urbs_free);
437 dev_vdbg(&acm->data->dev, "submitted urb %d\n", index);
443 static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
448 for (i = 0; i < acm->rx_buflimit; ++i) {
449 res = acm_submit_read_urb(acm, i, mem_flags);
457 static void acm_process_read_urb(struct acm *acm, struct urb *urb)
459 if (!urb->actual_length)
462 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
464 tty_flip_buffer_push(&acm->port);
467 static void acm_read_bulk_callback(struct urb *urb)
469 struct acm_rb *rb = urb->context;
470 struct acm *acm = rb->instance;
472 int status = urb->status;
474 dev_vdbg(&acm->data->dev, "got urb %d, len %d, status %d\n",
475 rb->index, urb->actual_length, status);
477 set_bit(rb->index, &acm->read_urbs_free);
480 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
486 usb_mark_last_busy(acm->dev);
487 acm_process_read_urb(acm, urb);
490 set_bit(EVENT_RX_STALL, &acm->flags);
491 schedule_work(&acm->work);
496 dev_dbg(&acm->data->dev,
497 "%s - urb shutting down with status: %d\n",
501 dev_dbg(&acm->data->dev,
502 "%s - nonzero urb status received: %d\n",
508 * Unthrottle may run on another CPU which needs to see events
509 * in the same order. Submission has an implict barrier
511 smp_mb__before_atomic();
513 /* throttle device if requested by tty */
514 spin_lock_irqsave(&acm->read_lock, flags);
515 acm->throttled = acm->throttle_req;
516 if (!acm->throttled) {
517 spin_unlock_irqrestore(&acm->read_lock, flags);
518 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
520 spin_unlock_irqrestore(&acm->read_lock, flags);
524 /* data interface wrote those outgoing bytes */
525 static void acm_write_bulk(struct urb *urb)
527 struct acm_wb *wb = urb->context;
528 struct acm *acm = wb->instance;
530 int status = urb->status;
532 if (status || (urb->actual_length != urb->transfer_buffer_length))
533 dev_vdbg(&acm->data->dev, "wrote len %d/%d, status %d\n",
535 urb->transfer_buffer_length,
538 spin_lock_irqsave(&acm->write_lock, flags);
539 acm_write_done(acm, wb);
540 spin_unlock_irqrestore(&acm->write_lock, flags);
541 set_bit(EVENT_TTY_WAKEUP, &acm->flags);
542 schedule_work(&acm->work);
545 static void acm_softint(struct work_struct *work)
548 struct acm *acm = container_of(work, struct acm, work);
550 if (test_bit(EVENT_RX_STALL, &acm->flags)) {
551 if (!(usb_autopm_get_interface(acm->data))) {
552 for (i = 0; i < acm->rx_buflimit; i++)
553 usb_kill_urb(acm->read_urbs[i]);
554 usb_clear_halt(acm->dev, acm->in);
555 acm_submit_read_urbs(acm, GFP_KERNEL);
556 usb_autopm_put_interface(acm->data);
558 clear_bit(EVENT_RX_STALL, &acm->flags);
561 if (test_bit(EVENT_TTY_WAKEUP, &acm->flags)) {
562 tty_port_tty_wakeup(&acm->port);
563 clear_bit(EVENT_TTY_WAKEUP, &acm->flags);
571 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
576 acm = acm_get_by_minor(tty->index);
580 retval = tty_standard_install(driver, tty);
582 goto error_init_termios;
584 tty->driver_data = acm;
589 tty_port_put(&acm->port);
593 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
595 struct acm *acm = tty->driver_data;
597 return tty_port_open(&acm->port, tty, filp);
600 static void acm_port_dtr_rts(struct tty_port *port, int raise)
602 struct acm *acm = container_of(port, struct acm, port);
607 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
611 /* FIXME: add missing ctrlout locking throughout driver */
614 res = acm_set_control(acm, val);
615 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
616 dev_err(&acm->control->dev, "failed to set dtr/rts\n");
619 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
621 struct acm *acm = container_of(port, struct acm, port);
622 int retval = -ENODEV;
625 mutex_lock(&acm->mutex);
626 if (acm->disconnected)
629 retval = usb_autopm_get_interface(acm->control);
631 goto error_get_interface;
634 * FIXME: Why do we need this? Allocating 64K of physically contiguous
635 * memory is really nasty...
637 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
638 acm->control->needs_remote_wakeup = 1;
640 acm->ctrlurb->dev = acm->dev;
641 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
643 dev_err(&acm->control->dev,
644 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
645 goto error_submit_urb;
648 acm_tty_set_termios(tty, NULL);
651 * Unthrottle device in case the TTY was closed while throttled.
653 spin_lock_irq(&acm->read_lock);
655 acm->throttle_req = 0;
656 spin_unlock_irq(&acm->read_lock);
658 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
660 goto error_submit_read_urbs;
662 usb_autopm_put_interface(acm->control);
664 mutex_unlock(&acm->mutex);
668 error_submit_read_urbs:
669 for (i = 0; i < acm->rx_buflimit; i++)
670 usb_kill_urb(acm->read_urbs[i]);
671 usb_kill_urb(acm->ctrlurb);
673 usb_autopm_put_interface(acm->control);
676 mutex_unlock(&acm->mutex);
678 return usb_translate_errors(retval);
681 static void acm_port_destruct(struct tty_port *port)
683 struct acm *acm = container_of(port, struct acm, port);
685 acm_release_minor(acm);
686 usb_put_intf(acm->control);
687 kfree(acm->country_codes);
691 static void acm_port_shutdown(struct tty_port *port)
693 struct acm *acm = container_of(port, struct acm, port);
698 * Need to grab write_lock to prevent race with resume, but no need to
699 * hold it due to the tty-port initialised flag.
701 spin_lock_irq(&acm->write_lock);
702 spin_unlock_irq(&acm->write_lock);
704 usb_autopm_get_interface_no_resume(acm->control);
705 acm->control->needs_remote_wakeup = 0;
706 usb_autopm_put_interface(acm->control);
709 urb = usb_get_from_anchor(&acm->delayed);
714 usb_autopm_put_interface_async(acm->control);
720 static void acm_tty_cleanup(struct tty_struct *tty)
722 struct acm *acm = tty->driver_data;
724 tty_port_put(&acm->port);
727 static void acm_tty_hangup(struct tty_struct *tty)
729 struct acm *acm = tty->driver_data;
731 tty_port_hangup(&acm->port);
734 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
736 struct acm *acm = tty->driver_data;
738 tty_port_close(&acm->port, tty, filp);
741 static int acm_tty_write(struct tty_struct *tty,
742 const unsigned char *buf, int count)
744 struct acm *acm = tty->driver_data;
753 dev_vdbg(&acm->data->dev, "%d bytes from tty layer\n", count);
755 spin_lock_irqsave(&acm->write_lock, flags);
756 wbn = acm_wb_alloc(acm);
758 spin_unlock_irqrestore(&acm->write_lock, flags);
765 spin_unlock_irqrestore(&acm->write_lock, flags);
769 count = (count > acm->writesize) ? acm->writesize : count;
770 dev_vdbg(&acm->data->dev, "writing %d bytes\n", count);
771 memcpy(wb->buf, buf, count);
774 stat = usb_autopm_get_interface_async(acm->control);
777 spin_unlock_irqrestore(&acm->write_lock, flags);
781 if (acm->susp_count) {
782 if (acm->putbuffer) {
783 /* now to preserve order */
784 usb_anchor_urb(acm->putbuffer->urb, &acm->delayed);
785 acm->putbuffer = NULL;
787 usb_anchor_urb(wb->urb, &acm->delayed);
788 spin_unlock_irqrestore(&acm->write_lock, flags);
791 if (acm->putbuffer) {
792 /* at this point there is no good way to handle errors */
793 acm_start_wb(acm, acm->putbuffer);
794 acm->putbuffer = NULL;
798 stat = acm_start_wb(acm, wb);
799 spin_unlock_irqrestore(&acm->write_lock, flags);
806 static void acm_tty_flush_chars(struct tty_struct *tty)
808 struct acm *acm = tty->driver_data;
813 spin_lock_irqsave(&acm->write_lock, flags);
815 cur = acm->putbuffer;
816 if (!cur) /* nothing to do */
819 acm->putbuffer = NULL;
820 err = usb_autopm_get_interface_async(acm->control);
823 acm->putbuffer = cur;
828 usb_anchor_urb(cur->urb, &acm->delayed);
830 acm_start_wb(acm, cur);
832 spin_unlock_irqrestore(&acm->write_lock, flags);
836 static int acm_tty_put_char(struct tty_struct *tty, unsigned char ch)
838 struct acm *acm = tty->driver_data;
844 cur = acm->putbuffer;
846 spin_lock_irqsave(&acm->write_lock, flags);
847 wbn = acm_wb_alloc(acm);
850 acm->putbuffer = cur;
852 spin_unlock_irqrestore(&acm->write_lock, flags);
857 if (cur->len == acm->writesize) {
858 acm_tty_flush_chars(tty);
862 cur->buf[cur->len++] = ch;
866 static int acm_tty_write_room(struct tty_struct *tty)
868 struct acm *acm = tty->driver_data;
870 * Do not let the line discipline to know that we have a reserve,
871 * or it might get too enthusiastic.
873 return acm_wb_is_avail(acm) ? acm->writesize : 0;
876 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
878 struct acm *acm = tty->driver_data;
880 * if the device was unplugged then any remaining characters fell out
881 * of the connector ;)
883 if (acm->disconnected)
886 * This is inaccurate (overcounts), but it works.
888 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
891 static void acm_tty_throttle(struct tty_struct *tty)
893 struct acm *acm = tty->driver_data;
895 spin_lock_irq(&acm->read_lock);
896 acm->throttle_req = 1;
897 spin_unlock_irq(&acm->read_lock);
900 static void acm_tty_unthrottle(struct tty_struct *tty)
902 struct acm *acm = tty->driver_data;
903 unsigned int was_throttled;
905 spin_lock_irq(&acm->read_lock);
906 was_throttled = acm->throttled;
908 acm->throttle_req = 0;
909 spin_unlock_irq(&acm->read_lock);
912 acm_submit_read_urbs(acm, GFP_KERNEL);
915 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
917 struct acm *acm = tty->driver_data;
920 retval = acm_send_break(acm, state ? 0xffff : 0);
922 dev_dbg(&acm->control->dev,
923 "%s - send break failed\n", __func__);
927 static int acm_tty_tiocmget(struct tty_struct *tty)
929 struct acm *acm = tty->driver_data;
931 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
932 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
933 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
934 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
935 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
939 static int acm_tty_tiocmset(struct tty_struct *tty,
940 unsigned int set, unsigned int clear)
942 struct acm *acm = tty->driver_data;
943 unsigned int newctrl;
945 newctrl = acm->ctrlout;
946 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
947 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
948 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
949 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
951 newctrl = (newctrl & ~clear) | set;
953 if (acm->ctrlout == newctrl)
955 return acm_set_control(acm, acm->ctrlout = newctrl);
958 static int get_serial_info(struct acm *acm, struct serial_struct __user *info)
960 struct serial_struct tmp;
962 memset(&tmp, 0, sizeof(tmp));
963 tmp.xmit_fifo_size = acm->writesize;
964 tmp.baud_base = le32_to_cpu(acm->line.dwDTERate);
965 tmp.close_delay = acm->port.close_delay / 10;
966 tmp.closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
967 ASYNC_CLOSING_WAIT_NONE :
968 acm->port.closing_wait / 10;
970 if (copy_to_user(info, &tmp, sizeof(tmp)))
976 static int set_serial_info(struct acm *acm,
977 struct serial_struct __user *newinfo)
979 struct serial_struct new_serial;
980 unsigned int closing_wait, close_delay;
983 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
986 close_delay = new_serial.close_delay * 10;
987 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
988 ASYNC_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
990 mutex_lock(&acm->port.mutex);
992 if (!capable(CAP_SYS_ADMIN)) {
993 if ((close_delay != acm->port.close_delay) ||
994 (closing_wait != acm->port.closing_wait))
997 retval = -EOPNOTSUPP;
999 acm->port.close_delay = close_delay;
1000 acm->port.closing_wait = closing_wait;
1003 mutex_unlock(&acm->port.mutex);
1007 static int wait_serial_change(struct acm *acm, unsigned long arg)
1010 DECLARE_WAITQUEUE(wait, current);
1011 struct async_icount old, new;
1014 spin_lock_irq(&acm->read_lock);
1015 old = acm->oldcount;
1017 acm->oldcount = new;
1018 spin_unlock_irq(&acm->read_lock);
1020 if ((arg & TIOCM_DSR) &&
1023 if ((arg & TIOCM_CD) &&
1026 if ((arg & TIOCM_RI) &&
1030 add_wait_queue(&acm->wioctl, &wait);
1031 set_current_state(TASK_INTERRUPTIBLE);
1033 remove_wait_queue(&acm->wioctl, &wait);
1034 if (acm->disconnected) {
1040 if (signal_pending(current))
1050 static int acm_tty_get_icount(struct tty_struct *tty,
1051 struct serial_icounter_struct *icount)
1053 struct acm *acm = tty->driver_data;
1055 icount->dsr = acm->iocount.dsr;
1056 icount->rng = acm->iocount.rng;
1057 icount->dcd = acm->iocount.dcd;
1058 icount->frame = acm->iocount.frame;
1059 icount->overrun = acm->iocount.overrun;
1060 icount->parity = acm->iocount.parity;
1061 icount->brk = acm->iocount.brk;
1066 static int acm_tty_ioctl(struct tty_struct *tty,
1067 unsigned int cmd, unsigned long arg)
1069 struct acm *acm = tty->driver_data;
1070 int rv = -ENOIOCTLCMD;
1073 case TIOCGSERIAL: /* gets serial port data */
1074 rv = get_serial_info(acm, (struct serial_struct __user *) arg);
1077 rv = set_serial_info(acm, (struct serial_struct __user *) arg);
1080 rv = usb_autopm_get_interface(acm->control);
1085 rv = wait_serial_change(acm, arg);
1086 usb_autopm_put_interface(acm->control);
1093 static void acm_tty_set_termios(struct tty_struct *tty,
1094 struct ktermios *termios_old)
1096 struct acm *acm = tty->driver_data;
1097 struct ktermios *termios = &tty->termios;
1098 struct usb_cdc_line_coding newline;
1099 int newctrl = acm->ctrlout;
1101 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
1102 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1103 newline.bParityType = termios->c_cflag & PARENB ?
1104 (termios->c_cflag & PARODD ? 1 : 2) +
1105 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1106 switch (termios->c_cflag & CSIZE) {
1108 newline.bDataBits = 5;
1111 newline.bDataBits = 6;
1114 newline.bDataBits = 7;
1118 newline.bDataBits = 8;
1121 /* FIXME: Needs to clear unsupported bits in the termios */
1122 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1124 if (C_BAUD(tty) == B0) {
1125 newline.dwDTERate = acm->line.dwDTERate;
1126 newctrl &= ~ACM_CTRL_DTR;
1127 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1128 newctrl |= ACM_CTRL_DTR;
1131 if (newctrl != acm->ctrlout)
1132 acm_set_control(acm, acm->ctrlout = newctrl);
1134 if (memcmp(&acm->line, &newline, sizeof newline)) {
1135 memcpy(&acm->line, &newline, sizeof newline);
1136 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1138 le32_to_cpu(newline.dwDTERate),
1139 newline.bCharFormat, newline.bParityType,
1141 acm_set_line(acm, &acm->line);
1145 static const struct tty_port_operations acm_port_ops = {
1146 .dtr_rts = acm_port_dtr_rts,
1147 .shutdown = acm_port_shutdown,
1148 .activate = acm_port_activate,
1149 .destruct = acm_port_destruct,
1153 * USB probe and disconnect routines.
1156 /* Little helpers: write/read buffers free */
1157 static void acm_write_buffers_free(struct acm *acm)
1162 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1163 usb_free_coherent(acm->dev, acm->writesize, wb->buf, wb->dmah);
1166 static void acm_read_buffers_free(struct acm *acm)
1170 for (i = 0; i < acm->rx_buflimit; i++)
1171 usb_free_coherent(acm->dev, acm->readsize,
1172 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1175 /* Little helper: write buffers allocate */
1176 static int acm_write_buffers_alloc(struct acm *acm)
1181 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1182 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1188 usb_free_coherent(acm->dev, acm->writesize,
1197 static int acm_probe(struct usb_interface *intf,
1198 const struct usb_device_id *id)
1200 struct usb_cdc_union_desc *union_header = NULL;
1201 struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
1202 unsigned char *buffer = intf->altsetting->extra;
1203 int buflen = intf->altsetting->extralen;
1204 struct usb_interface *control_interface;
1205 struct usb_interface *data_interface;
1206 struct usb_endpoint_descriptor *epctrl = NULL;
1207 struct usb_endpoint_descriptor *epread = NULL;
1208 struct usb_endpoint_descriptor *epwrite = NULL;
1209 struct usb_device *usb_dev = interface_to_usbdev(intf);
1210 struct usb_cdc_parsed_header h;
1213 int ctrlsize, readsize;
1215 int call_intf_num = -1;
1216 int data_intf_num = -1;
1217 unsigned long quirks;
1220 int combined_interfaces = 0;
1221 struct device *tty_dev;
1226 quirks = (unsigned long)id->driver_info;
1228 if (quirks == IGNORE_DEVICE)
1231 memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1233 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1235 /* handle quirks deadly to normal probing*/
1236 if (quirks == NO_UNION_NORMAL) {
1237 data_interface = usb_ifnum_to_if(usb_dev, 1);
1238 control_interface = usb_ifnum_to_if(usb_dev, 0);
1239 /* we would crash */
1240 if (!data_interface || !control_interface)
1242 goto skip_normal_probe;
1247 dev_err(&intf->dev, "Weird descriptor references\n");
1251 if (!intf->cur_altsetting)
1255 if (intf->cur_altsetting->endpoint &&
1256 intf->cur_altsetting->endpoint->extralen &&
1257 intf->cur_altsetting->endpoint->extra) {
1259 "Seeking extra descriptors on endpoint\n");
1260 buflen = intf->cur_altsetting->endpoint->extralen;
1261 buffer = intf->cur_altsetting->endpoint->extra;
1264 "Zero length descriptor references\n");
1269 cdc_parse_cdc_header(&h, intf, buffer, buflen);
1270 union_header = h.usb_cdc_union_desc;
1271 cmgmd = h.usb_cdc_call_mgmt_descriptor;
1273 call_intf_num = cmgmd->bDataInterface;
1275 if (!union_header) {
1276 if (call_intf_num > 0) {
1277 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1278 /* quirks for Droids MuIn LCD */
1279 if (quirks & NO_DATA_INTERFACE) {
1280 data_interface = usb_ifnum_to_if(usb_dev, 0);
1282 data_intf_num = call_intf_num;
1283 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1285 control_interface = intf;
1287 if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1288 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1291 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1292 combined_interfaces = 1;
1293 control_interface = data_interface = intf;
1294 goto look_for_collapsed_interface;
1298 data_intf_num = union_header->bSlaveInterface0;
1299 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1300 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1303 if (!control_interface || !data_interface) {
1304 dev_dbg(&intf->dev, "no interfaces\n");
1307 if (!data_interface->cur_altsetting || !control_interface->cur_altsetting)
1310 if (data_intf_num != call_intf_num)
1311 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1313 if (control_interface == data_interface) {
1314 /* some broken devices designed for windows work this way */
1315 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1316 combined_interfaces = 1;
1317 /* a popular other OS doesn't use it */
1318 quirks |= NO_CAP_LINE;
1319 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1320 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1323 look_for_collapsed_interface:
1324 res = usb_find_common_endpoints(data_interface->cur_altsetting,
1325 &epread, &epwrite, &epctrl, NULL);
1329 goto made_compressed_probe;
1334 /*workaround for switched interfaces */
1335 if (data_interface->cur_altsetting->desc.bInterfaceClass
1336 != CDC_DATA_INTERFACE_TYPE) {
1337 if (control_interface->cur_altsetting->desc.bInterfaceClass
1338 == CDC_DATA_INTERFACE_TYPE) {
1340 "Your device has switched interfaces.\n");
1341 swap(control_interface, data_interface);
1347 /* Accept probe requests only for the control interface */
1348 if (!combined_interfaces && intf != control_interface)
1351 if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1352 /* valid in this context */
1353 dev_dbg(&intf->dev, "The data interface isn't available\n");
1358 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1359 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1362 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1363 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1364 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1367 /* workaround for switched endpoints */
1368 if (!usb_endpoint_dir_in(epread)) {
1369 /* descriptors are swapped */
1371 "The data interface has switched endpoints\n");
1372 swap(epread, epwrite);
1374 made_compressed_probe:
1375 dev_dbg(&intf->dev, "interfaces are valid\n");
1377 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1381 minor = acm_alloc_minor(acm);
1385 ctrlsize = usb_endpoint_maxp(epctrl);
1386 readsize = usb_endpoint_maxp(epread) *
1387 (quirks == SINGLE_RX_URB ? 1 : 2);
1388 acm->combined_interfaces = combined_interfaces;
1389 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1390 acm->control = control_interface;
1391 acm->data = data_interface;
1394 if (h.usb_cdc_acm_descriptor)
1395 acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
1396 if (quirks & NO_CAP_LINE)
1397 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1398 acm->ctrlsize = ctrlsize;
1399 acm->readsize = readsize;
1400 acm->rx_buflimit = num_rx_buf;
1401 INIT_WORK(&acm->work, acm_softint);
1402 init_waitqueue_head(&acm->wioctl);
1403 spin_lock_init(&acm->write_lock);
1404 spin_lock_init(&acm->read_lock);
1405 mutex_init(&acm->mutex);
1406 if (usb_endpoint_xfer_int(epread)) {
1407 acm->bInterval = epread->bInterval;
1408 acm->in = usb_rcvintpipe(usb_dev, epread->bEndpointAddress);
1410 acm->in = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1412 if (usb_endpoint_xfer_int(epwrite))
1413 acm->out = usb_sndintpipe(usb_dev, epwrite->bEndpointAddress);
1415 acm->out = usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress);
1416 tty_port_init(&acm->port);
1417 acm->port.ops = &acm_port_ops;
1418 init_usb_anchor(&acm->delayed);
1419 acm->quirks = quirks;
1421 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1424 acm->ctrl_buffer = buf;
1426 if (acm_write_buffers_alloc(acm) < 0)
1429 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1433 for (i = 0; i < num_rx_buf; i++) {
1434 struct acm_rb *rb = &(acm->read_buffers[i]);
1437 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1444 urb = usb_alloc_urb(0, GFP_KERNEL);
1448 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1449 urb->transfer_dma = rb->dma;
1450 if (usb_endpoint_xfer_int(epread))
1451 usb_fill_int_urb(urb, acm->dev, acm->in, rb->base,
1453 acm_read_bulk_callback, rb,
1456 usb_fill_bulk_urb(urb, acm->dev, acm->in, rb->base,
1458 acm_read_bulk_callback, rb);
1460 acm->read_urbs[i] = urb;
1461 __set_bit(i, &acm->read_urbs_free);
1463 for (i = 0; i < ACM_NW; i++) {
1464 struct acm_wb *snd = &(acm->wb[i]);
1466 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1467 if (snd->urb == NULL)
1470 if (usb_endpoint_xfer_int(epwrite))
1471 usb_fill_int_urb(snd->urb, usb_dev, acm->out,
1472 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1474 usb_fill_bulk_urb(snd->urb, usb_dev, acm->out,
1475 NULL, acm->writesize, acm_write_bulk, snd);
1476 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1477 if (quirks & SEND_ZERO_PACKET)
1478 snd->urb->transfer_flags |= URB_ZERO_PACKET;
1479 snd->instance = acm;
1482 usb_set_intfdata(intf, acm);
1484 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1488 if (h.usb_cdc_country_functional_desc) { /* export the country data */
1489 struct usb_cdc_country_functional_desc * cfd =
1490 h.usb_cdc_country_functional_desc;
1492 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1493 if (!acm->country_codes)
1494 goto skip_countries;
1495 acm->country_code_size = cfd->bLength - 4;
1496 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1498 acm->country_rel_date = cfd->iCountryCodeRelDate;
1500 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1502 kfree(acm->country_codes);
1503 acm->country_codes = NULL;
1504 acm->country_code_size = 0;
1505 goto skip_countries;
1508 i = device_create_file(&intf->dev,
1509 &dev_attr_iCountryCodeRelDate);
1511 device_remove_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;
1520 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1521 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1522 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1523 /* works around buggy devices */
1524 epctrl->bInterval ? epctrl->bInterval : 16);
1525 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1526 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1527 acm->notification_buffer = NULL;
1531 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1533 acm->line.dwDTERate = cpu_to_le32(9600);
1534 acm->line.bDataBits = 8;
1535 acm_set_line(acm, &acm->line);
1537 usb_driver_claim_interface(&acm_driver, data_interface, acm);
1538 usb_set_intfdata(data_interface, acm);
1540 usb_get_intf(control_interface);
1541 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1542 &control_interface->dev);
1543 if (IS_ERR(tty_dev)) {
1544 rv = PTR_ERR(tty_dev);
1548 if (quirks & CLEAR_HALT_CONDITIONS) {
1549 usb_clear_halt(usb_dev, acm->in);
1550 usb_clear_halt(usb_dev, acm->out);
1555 if (acm->country_codes) {
1556 device_remove_file(&acm->control->dev,
1557 &dev_attr_wCountryCodes);
1558 device_remove_file(&acm->control->dev,
1559 &dev_attr_iCountryCodeRelDate);
1560 kfree(acm->country_codes);
1562 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1564 usb_set_intfdata(intf, NULL);
1565 for (i = 0; i < ACM_NW; i++)
1566 usb_free_urb(acm->wb[i].urb);
1568 for (i = 0; i < num_rx_buf; i++)
1569 usb_free_urb(acm->read_urbs[i]);
1570 acm_read_buffers_free(acm);
1571 usb_free_urb(acm->ctrlurb);
1573 acm_write_buffers_free(acm);
1575 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1577 acm_release_minor(acm);
1584 static void acm_disconnect(struct usb_interface *intf)
1586 struct acm *acm = usb_get_intfdata(intf);
1587 struct tty_struct *tty;
1589 /* sibling interface is already cleaning up */
1593 mutex_lock(&acm->mutex);
1594 acm->disconnected = true;
1595 if (acm->country_codes) {
1596 device_remove_file(&acm->control->dev,
1597 &dev_attr_wCountryCodes);
1598 device_remove_file(&acm->control->dev,
1599 &dev_attr_iCountryCodeRelDate);
1601 wake_up_all(&acm->wioctl);
1602 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1603 usb_set_intfdata(acm->control, NULL);
1604 usb_set_intfdata(acm->data, NULL);
1605 mutex_unlock(&acm->mutex);
1607 tty = tty_port_tty_get(&acm->port);
1614 cancel_work_sync(&acm->work);
1616 tty_unregister_device(acm_tty_driver, acm->minor);
1618 acm_write_buffers_free(acm);
1619 usb_free_coherent(acm->dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1620 acm_read_buffers_free(acm);
1622 kfree(acm->notification_buffer);
1624 if (!acm->combined_interfaces)
1625 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1626 acm->data : acm->control);
1628 tty_port_put(&acm->port);
1632 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1634 struct acm *acm = usb_get_intfdata(intf);
1637 spin_lock_irq(&acm->write_lock);
1638 if (PMSG_IS_AUTO(message)) {
1639 if (acm->transmitting) {
1640 spin_unlock_irq(&acm->write_lock);
1644 cnt = acm->susp_count++;
1645 spin_unlock_irq(&acm->write_lock);
1651 cancel_work_sync(&acm->work);
1656 static int acm_resume(struct usb_interface *intf)
1658 struct acm *acm = usb_get_intfdata(intf);
1662 spin_lock_irq(&acm->write_lock);
1664 if (--acm->susp_count)
1667 if (tty_port_initialized(&acm->port)) {
1668 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1671 urb = usb_get_from_anchor(&acm->delayed);
1675 acm_start_wb(acm, urb->context);
1679 * delayed error checking because we must
1680 * do the write path at all cost
1685 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1688 spin_unlock_irq(&acm->write_lock);
1693 static int acm_reset_resume(struct usb_interface *intf)
1695 struct acm *acm = usb_get_intfdata(intf);
1697 if (tty_port_initialized(&acm->port))
1698 tty_port_tty_hangup(&acm->port, false);
1700 return acm_resume(intf);
1703 #endif /* CONFIG_PM */
1705 static int acm_pre_reset(struct usb_interface *intf)
1707 struct acm *acm = usb_get_intfdata(intf);
1709 clear_bit(EVENT_RX_STALL, &acm->flags);
1714 #define NOKIA_PCSUITE_ACM_INFO(x) \
1715 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1716 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1717 USB_CDC_ACM_PROTO_VENDOR)
1719 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1720 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1721 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1722 USB_CDC_ACM_PROTO_VENDOR)
1725 * USB driver structure.
1728 static const struct usb_device_id acm_ids[] = {
1729 /* quirky and broken devices */
1730 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1731 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1732 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1733 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1734 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1735 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1738 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1740 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1741 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1743 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1744 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1746 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1747 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1749 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1750 .driver_info = SINGLE_RX_URB,
1752 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1753 .driver_info = SINGLE_RX_URB, /* firmware bug */
1755 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1756 .driver_info = SINGLE_RX_URB, /* firmware bug */
1758 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1759 .driver_info = SINGLE_RX_URB,
1761 { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1762 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1764 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1765 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1767 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1768 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1770 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1771 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1773 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1774 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1776 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1777 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1779 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1780 .driver_info = QUIRK_CONTROL_LINE_STATE, },
1781 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1782 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1783 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1785 /* Motorola H24 HSPA module: */
1786 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1787 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1788 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1790 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1791 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1793 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1794 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1796 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1797 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1799 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1800 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1802 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1803 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1805 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1806 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1809 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1810 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1811 data interface instead of
1812 communications interface.
1813 Maybe we should define a new
1816 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1817 .driver_info = NO_UNION_NORMAL,
1819 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1820 .driver_info = NO_UNION_NORMAL,
1822 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1823 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1825 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1826 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1828 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1829 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1831 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1832 .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1835 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1836 .driver_info = CLEAR_HALT_CONDITIONS,
1839 /* Nokia S60 phones expose two ACM channels. The first is
1840 * a modem and is picked up by the standard AT-command
1841 * information below. The second is 'vendor-specific' but
1842 * is treated as a serial device at the S60 end, so we want
1843 * to expose it on Linux too. */
1844 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1845 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1846 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1847 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1848 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1849 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1850 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1851 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1852 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1853 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1854 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1855 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1856 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1857 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1858 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1859 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1860 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1861 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1862 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1863 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1864 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1865 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1866 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1867 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1868 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1869 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1870 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1871 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1872 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1873 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1874 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1875 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1876 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1877 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1878 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1879 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1880 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1881 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1882 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1883 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1884 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1885 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1886 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1887 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1888 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1889 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1890 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1891 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1892 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1893 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1894 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1895 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1896 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1897 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1898 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1899 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1900 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1901 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1903 /* Support for Owen devices */
1904 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1906 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1908 /* Support for Droids MuIn LCD */
1909 { USB_DEVICE(0x04d8, 0x000b),
1910 .driver_info = NO_DATA_INTERFACE,
1913 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1914 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1915 .driver_info = IGNORE_DEVICE,
1917 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1918 .driver_info = IGNORE_DEVICE,
1922 /*Samsung phone in firmware update mode */
1923 { USB_DEVICE(0x04e8, 0x685d),
1924 .driver_info = IGNORE_DEVICE,
1927 /* Exclude Infineon Flash Loader utility */
1928 { USB_DEVICE(0x058b, 0x0041),
1929 .driver_info = IGNORE_DEVICE,
1932 /* control interfaces without any protocol set */
1933 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1934 USB_CDC_PROTO_NONE) },
1936 /* control interfaces with various AT-command sets */
1937 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1938 USB_CDC_ACM_PROTO_AT_V25TER) },
1939 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1940 USB_CDC_ACM_PROTO_AT_PCCA101) },
1941 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1942 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1943 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1944 USB_CDC_ACM_PROTO_AT_GSM) },
1945 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1946 USB_CDC_ACM_PROTO_AT_3G) },
1947 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1948 USB_CDC_ACM_PROTO_AT_CDMA) },
1950 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1951 .driver_info = SEND_ZERO_PACKET,
1957 MODULE_DEVICE_TABLE(usb, acm_ids);
1959 static struct usb_driver acm_driver = {
1962 .disconnect = acm_disconnect,
1964 .suspend = acm_suspend,
1965 .resume = acm_resume,
1966 .reset_resume = acm_reset_resume,
1968 .pre_reset = acm_pre_reset,
1969 .id_table = acm_ids,
1971 .supports_autosuspend = 1,
1973 .disable_hub_initiated_lpm = 1,
1977 * TTY driver structures.
1980 static const struct tty_operations acm_ops = {
1981 .install = acm_tty_install,
1982 .open = acm_tty_open,
1983 .close = acm_tty_close,
1984 .cleanup = acm_tty_cleanup,
1985 .hangup = acm_tty_hangup,
1986 .write = acm_tty_write,
1987 .put_char = acm_tty_put_char,
1988 .flush_chars = acm_tty_flush_chars,
1989 .write_room = acm_tty_write_room,
1990 .ioctl = acm_tty_ioctl,
1991 .throttle = acm_tty_throttle,
1992 .unthrottle = acm_tty_unthrottle,
1993 .chars_in_buffer = acm_tty_chars_in_buffer,
1994 .break_ctl = acm_tty_break_ctl,
1995 .set_termios = acm_tty_set_termios,
1996 .tiocmget = acm_tty_tiocmget,
1997 .tiocmset = acm_tty_tiocmset,
1998 .get_icount = acm_tty_get_icount,
2005 static int __init acm_init(void)
2008 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
2009 if (!acm_tty_driver)
2011 acm_tty_driver->driver_name = "acm",
2012 acm_tty_driver->name = "ttyACM",
2013 acm_tty_driver->major = ACM_TTY_MAJOR,
2014 acm_tty_driver->minor_start = 0,
2015 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2016 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
2017 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2018 acm_tty_driver->init_termios = tty_std_termios;
2019 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2021 tty_set_operations(acm_tty_driver, &acm_ops);
2023 retval = tty_register_driver(acm_tty_driver);
2025 put_tty_driver(acm_tty_driver);
2029 retval = usb_register(&acm_driver);
2031 tty_unregister_driver(acm_tty_driver);
2032 put_tty_driver(acm_tty_driver);
2036 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2041 static void __exit acm_exit(void)
2043 usb_deregister(&acm_driver);
2044 tty_unregister_driver(acm_tty_driver);
2045 put_tty_driver(acm_tty_driver);
2046 idr_destroy(&acm_minors);
2049 module_init(acm_init);
2050 module_exit(acm_exit);
2052 MODULE_AUTHOR(DRIVER_AUTHOR);
2053 MODULE_DESCRIPTION(DRIVER_DESC);
2054 MODULE_LICENSE("GPL");
2055 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);