Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * cdc-acm.c
4 *
5 * Copyright (c) 1999 Armin Fuerst <fuerst@in.tum.de>
6 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
7 * Copyright (c) 1999 Johannes Erdfelt <johannes@erdfelt.com>
8 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
9 * Copyright (c) 2004 Oliver Neukum <oliver@neukum.name>
10 * Copyright (c) 2005 David Kubicek <dave@awk.cz>
11 * Copyright (c) 2011 Johan Hovold <jhovold@gmail.com>
12 *
13 * USB Abstract Control Model driver for USB modems and ISDN adapters
14 *
15 * Sponsored by SuSE
16 */
17
18#undef DEBUG
19#undef VERBOSE_DEBUG
20
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>
40
41#include "cdc-acm.h"
42
43
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"
46
47static struct usb_driver acm_driver;
48static struct tty_driver *acm_tty_driver;
49
50static DEFINE_IDR(acm_minors);
51static DEFINE_MUTEX(acm_minors_lock);
52
53static void acm_tty_set_termios(struct tty_struct *tty,
54 struct ktermios *termios_old);
55
56/*
57 * acm_minors accessors
58 */
59
60/*
61 * Look up an ACM structure by minor. If found and not disconnected, increment
62 * its refcount and return it with its mutex held.
63 */
64static struct acm *acm_get_by_minor(unsigned int minor)
65{
66 struct acm *acm;
67
68 mutex_lock(&acm_minors_lock);
69 acm = idr_find(&acm_minors, minor);
70 if (acm) {
71 mutex_lock(&acm->mutex);
72 if (acm->disconnected) {
73 mutex_unlock(&acm->mutex);
74 acm = NULL;
75 } else {
76 tty_port_get(&acm->port);
77 mutex_unlock(&acm->mutex);
78 }
79 }
80 mutex_unlock(&acm_minors_lock);
81 return acm;
82}
83
84/*
85 * Try to find an available minor number and if found, associate it with 'acm'.
86 */
87static int acm_alloc_minor(struct acm *acm)
88{
89 int minor;
90
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);
94
95 return minor;
96}
97
98/* Release the minor number associated with 'acm'. */
99static void acm_release_minor(struct acm *acm)
100{
101 mutex_lock(&acm_minors_lock);
102 idr_remove(&acm_minors, acm->minor);
103 mutex_unlock(&acm_minors_lock);
104}
105
106/*
107 * Functions for ACM control messages.
108 */
109
110static int acm_ctrl_msg(struct acm *acm, int request, int value,
111 void *buf, int len)
112{
113 int retval;
114
115 retval = usb_autopm_get_interface(acm->control);
116 if (retval)
117 return retval;
118
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,
122 buf, len, 5000);
123
124 dev_dbg(&acm->control->dev,
125 "%s - rq 0x%02x, val %#x, len %#x, result %d\n",
126 __func__, request, value, len, retval);
127
128 usb_autopm_put_interface(acm->control);
129
130 return retval < 0 ? retval : 0;
131}
132
133/* devices aren't required to support these requests.
134 * the cdc acm descriptor tells whether they do...
135 */
136static inline int acm_set_control(struct acm *acm, int control)
137{
138 if (acm->quirks & QUIRK_CONTROL_LINE_STATE)
139 return -EOPNOTSUPP;
140
141 return acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE,
142 control, NULL, 0);
143}
144
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)
149
150static void acm_poison_urbs(struct acm *acm)
151{
152 int i;
153
154 usb_poison_urb(acm->ctrlurb);
155 for (i = 0; i < ACM_NW; i++)
156 usb_poison_urb(acm->wb[i].urb);
157 for (i = 0; i < acm->rx_buflimit; i++)
158 usb_poison_urb(acm->read_urbs[i]);
159}
160
161static void acm_unpoison_urbs(struct acm *acm)
162{
163 int i;
164
165 for (i = 0; i < acm->rx_buflimit; i++)
166 usb_unpoison_urb(acm->read_urbs[i]);
167 for (i = 0; i < ACM_NW; i++)
168 usb_unpoison_urb(acm->wb[i].urb);
169 usb_unpoison_urb(acm->ctrlurb);
170}
171
172
173/*
174 * Write buffer management.
175 * All of these assume proper locks taken by the caller.
176 */
177
178static int acm_wb_alloc(struct acm *acm)
179{
180 int i, wbn;
181 struct acm_wb *wb;
182
183 wbn = 0;
184 i = 0;
185 for (;;) {
186 wb = &acm->wb[wbn];
187 if (!wb->use) {
188 wb->use = true;
189 wb->len = 0;
190 return wbn;
191 }
192 wbn = (wbn + 1) % ACM_NW;
193 if (++i >= ACM_NW)
194 return -1;
195 }
196}
197
198static int acm_wb_is_avail(struct acm *acm)
199{
200 int i, n;
201 unsigned long flags;
202
203 n = ACM_NW;
204 spin_lock_irqsave(&acm->write_lock, flags);
205 for (i = 0; i < ACM_NW; i++)
206 if(acm->wb[i].use)
207 n--;
208 spin_unlock_irqrestore(&acm->write_lock, flags);
209 return n;
210}
211
212/*
213 * Finish write. Caller must hold acm->write_lock
214 */
215static void acm_write_done(struct acm *acm, struct acm_wb *wb)
216{
217 wb->use = false;
218 acm->transmitting--;
219 usb_autopm_put_interface_async(acm->control);
220}
221
222/*
223 * Poke write.
224 *
225 * the caller is responsible for locking
226 */
227
228static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
229{
230 int rc;
231
232 acm->transmitting++;
233
234 wb->urb->transfer_buffer = wb->buf;
235 wb->urb->transfer_dma = wb->dmah;
236 wb->urb->transfer_buffer_length = wb->len;
237 wb->urb->dev = acm->dev;
238
239 rc = usb_submit_urb(wb->urb, GFP_ATOMIC);
240 if (rc < 0) {
241 if (rc != -EPERM)
242 dev_err(&acm->data->dev,
243 "%s - usb_submit_urb(write bulk) failed: %d\n",
244 __func__, rc);
245 acm_write_done(acm, wb);
246 }
247 return rc;
248}
249
250/*
251 * attributes exported through sysfs
252 */
253static ssize_t bmCapabilities_show
254(struct device *dev, struct device_attribute *attr, char *buf)
255{
256 struct usb_interface *intf = to_usb_interface(dev);
257 struct acm *acm = usb_get_intfdata(intf);
258
259 return sprintf(buf, "%d", acm->ctrl_caps);
260}
261static DEVICE_ATTR_RO(bmCapabilities);
262
263static ssize_t wCountryCodes_show
264(struct device *dev, struct device_attribute *attr, char *buf)
265{
266 struct usb_interface *intf = to_usb_interface(dev);
267 struct acm *acm = usb_get_intfdata(intf);
268
269 memcpy(buf, acm->country_codes, acm->country_code_size);
270 return acm->country_code_size;
271}
272
273static DEVICE_ATTR_RO(wCountryCodes);
274
275static ssize_t iCountryCodeRelDate_show
276(struct device *dev, struct device_attribute *attr, char *buf)
277{
278 struct usb_interface *intf = to_usb_interface(dev);
279 struct acm *acm = usb_get_intfdata(intf);
280
281 return sprintf(buf, "%d", acm->country_rel_date);
282}
283
284static DEVICE_ATTR_RO(iCountryCodeRelDate);
285/*
286 * Interrupt handlers for various ACM device responses
287 */
288
289static void acm_process_notification(struct acm *acm, unsigned char *buf)
290{
291 int newctrl;
292 int difference;
293 unsigned long flags;
294 struct usb_cdc_notification *dr = (struct usb_cdc_notification *)buf;
295 unsigned char *data = buf + sizeof(struct usb_cdc_notification);
296
297 switch (dr->bNotificationType) {
298 case USB_CDC_NOTIFY_NETWORK_CONNECTION:
299 dev_dbg(&acm->control->dev,
300 "%s - network connection: %d\n", __func__, dr->wValue);
301 break;
302
303 case USB_CDC_NOTIFY_SERIAL_STATE:
304 if (le16_to_cpu(dr->wLength) != 2) {
305 dev_dbg(&acm->control->dev,
306 "%s - malformed serial state\n", __func__);
307 break;
308 }
309
310 newctrl = get_unaligned_le16(data);
311 dev_dbg(&acm->control->dev,
312 "%s - serial state: 0x%x\n", __func__, newctrl);
313
314 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
315 dev_dbg(&acm->control->dev,
316 "%s - calling hangup\n", __func__);
317 tty_port_tty_hangup(&acm->port, false);
318 }
319
320 difference = acm->ctrlin ^ newctrl;
321 spin_lock_irqsave(&acm->read_lock, flags);
322 acm->ctrlin = newctrl;
323 acm->oldcount = acm->iocount;
324
325 if (difference & ACM_CTRL_DSR)
326 acm->iocount.dsr++;
327 if (difference & ACM_CTRL_DCD)
328 acm->iocount.dcd++;
329 if (newctrl & ACM_CTRL_BRK) {
330 acm->iocount.brk++;
331 tty_insert_flip_char(&acm->port, 0, TTY_BREAK);
332 }
333 if (newctrl & ACM_CTRL_RI)
334 acm->iocount.rng++;
335 if (newctrl & ACM_CTRL_FRAMING)
336 acm->iocount.frame++;
337 if (newctrl & ACM_CTRL_PARITY)
338 acm->iocount.parity++;
339 if (newctrl & ACM_CTRL_OVERRUN)
340 acm->iocount.overrun++;
341 spin_unlock_irqrestore(&acm->read_lock, flags);
342
343 if (difference)
344 wake_up_all(&acm->wioctl);
345
346 break;
347
348 default:
349 dev_dbg(&acm->control->dev,
350 "%s - unknown notification %d received: index %d len %d\n",
351 __func__,
352 dr->bNotificationType, dr->wIndex, dr->wLength);
353 }
354}
355
356/* control interface reports status changes with "interrupt" transfers */
357static void acm_ctrl_irq(struct urb *urb)
358{
359 struct acm *acm = urb->context;
360 struct usb_cdc_notification *dr = urb->transfer_buffer;
361 unsigned int current_size = urb->actual_length;
362 unsigned int expected_size, copy_size, alloc_size;
363 int retval;
364 int status = urb->status;
365
366 switch (status) {
367 case 0:
368 /* success */
369 break;
370 case -ECONNRESET:
371 case -ENOENT:
372 case -ESHUTDOWN:
373 /* this urb is terminated, clean up */
374 dev_dbg(&acm->control->dev,
375 "%s - urb shutting down with status: %d\n",
376 __func__, status);
377 return;
378 default:
379 dev_dbg(&acm->control->dev,
380 "%s - nonzero urb status received: %d\n",
381 __func__, status);
382 goto exit;
383 }
384
385 usb_mark_last_busy(acm->dev);
386
387 if (acm->nb_index)
388 dr = (struct usb_cdc_notification *)acm->notification_buffer;
389
390 /* size = notification-header + (optional) data */
391 expected_size = sizeof(struct usb_cdc_notification) +
392 le16_to_cpu(dr->wLength);
393
394 if (current_size < expected_size) {
395 /* notification is transmitted fragmented, reassemble */
396 if (acm->nb_size < expected_size) {
397 u8 *new_buffer;
398 alloc_size = roundup_pow_of_two(expected_size);
399 /* Final freeing is done on disconnect. */
400 new_buffer = krealloc(acm->notification_buffer,
401 alloc_size, GFP_ATOMIC);
402 if (!new_buffer) {
403 acm->nb_index = 0;
404 goto exit;
405 }
406
407 acm->notification_buffer = new_buffer;
408 acm->nb_size = alloc_size;
409 dr = (struct usb_cdc_notification *)acm->notification_buffer;
410 }
411
412 copy_size = min(current_size,
413 expected_size - acm->nb_index);
414
415 memcpy(&acm->notification_buffer[acm->nb_index],
416 urb->transfer_buffer, copy_size);
417 acm->nb_index += copy_size;
418 current_size = acm->nb_index;
419 }
420
421 if (current_size >= expected_size) {
422 /* notification complete */
423 acm_process_notification(acm, (unsigned char *)dr);
424 acm->nb_index = 0;
425 }
426
427exit:
428 retval = usb_submit_urb(urb, GFP_ATOMIC);
429 if (retval && retval != -EPERM && retval != -ENODEV)
430 dev_err(&acm->control->dev,
431 "%s - usb_submit_urb failed: %d\n", __func__, retval);
432 else
433 dev_vdbg(&acm->control->dev,
434 "control resubmission terminated %d\n", retval);
435}
436
437static int acm_submit_read_urb(struct acm *acm, int index, gfp_t mem_flags)
438{
439 int res;
440
441 if (!test_and_clear_bit(index, &acm->read_urbs_free))
442 return 0;
443
444 res = usb_submit_urb(acm->read_urbs[index], mem_flags);
445 if (res) {
446 if (res != -EPERM && res != -ENODEV) {
447 dev_err(&acm->data->dev,
448 "urb %d failed submission with %d\n",
449 index, res);
450 } else {
451 dev_vdbg(&acm->data->dev, "intended failure %d\n", res);
452 }
453 set_bit(index, &acm->read_urbs_free);
454 return res;
455 } else {
456 dev_vdbg(&acm->data->dev, "submitted urb %d\n", index);
457 }
458
459 return 0;
460}
461
462static int acm_submit_read_urbs(struct acm *acm, gfp_t mem_flags)
463{
464 int res;
465 int i;
466
467 for (i = 0; i < acm->rx_buflimit; ++i) {
468 res = acm_submit_read_urb(acm, i, mem_flags);
469 if (res)
470 return res;
471 }
472
473 return 0;
474}
475
476static void acm_process_read_urb(struct acm *acm, struct urb *urb)
477{
478 if (!urb->actual_length)
479 return;
480
481 tty_insert_flip_string(&acm->port, urb->transfer_buffer,
482 urb->actual_length);
483 tty_flip_buffer_push(&acm->port);
484}
485
486static void acm_read_bulk_callback(struct urb *urb)
487{
488 struct acm_rb *rb = urb->context;
489 struct acm *acm = rb->instance;
490 int status = urb->status;
491 bool stopped = false;
492 bool stalled = false;
493 bool cooldown = false;
494
495 dev_vdbg(&acm->data->dev, "got urb %d, len %d, status %d\n",
496 rb->index, urb->actual_length, status);
497
498 switch (status) {
499 case 0:
500 usb_mark_last_busy(acm->dev);
501 acm_process_read_urb(acm, urb);
502 break;
503 case -EPIPE:
504 set_bit(EVENT_RX_STALL, &acm->flags);
505 stalled = true;
506 break;
507 case -ENOENT:
508 case -ECONNRESET:
509 case -ESHUTDOWN:
510 dev_dbg(&acm->data->dev,
511 "%s - urb shutting down with status: %d\n",
512 __func__, status);
513 stopped = true;
514 break;
515 case -EOVERFLOW:
516 case -EPROTO:
517 dev_dbg(&acm->data->dev,
518 "%s - cooling babbling device\n", __func__);
519 usb_mark_last_busy(acm->dev);
520 set_bit(rb->index, &acm->urbs_in_error_delay);
521 set_bit(ACM_ERROR_DELAY, &acm->flags);
522 cooldown = true;
523 break;
524 default:
525 dev_dbg(&acm->data->dev,
526 "%s - nonzero urb status received: %d\n",
527 __func__, status);
528 break;
529 }
530
531 /*
532 * Make sure URB processing is done before marking as free to avoid
533 * racing with unthrottle() on another CPU. Matches the barriers
534 * implied by the test_and_clear_bit() in acm_submit_read_urb().
535 */
536 smp_mb__before_atomic();
537 set_bit(rb->index, &acm->read_urbs_free);
538 /*
539 * Make sure URB is marked as free before checking the throttled flag
540 * to avoid racing with unthrottle() on another CPU. Matches the
541 * smp_mb() in unthrottle().
542 */
543 smp_mb__after_atomic();
544
545 if (stopped || stalled || cooldown) {
546 if (stalled)
547 schedule_delayed_work(&acm->dwork, 0);
548 else if (cooldown)
549 schedule_delayed_work(&acm->dwork, HZ / 2);
550 return;
551 }
552
553 if (test_bit(ACM_THROTTLED, &acm->flags))
554 return;
555
556 acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
557}
558
559/* data interface wrote those outgoing bytes */
560static void acm_write_bulk(struct urb *urb)
561{
562 struct acm_wb *wb = urb->context;
563 struct acm *acm = wb->instance;
564 unsigned long flags;
565 int status = urb->status;
566
567 if (status || (urb->actual_length != urb->transfer_buffer_length))
568 dev_vdbg(&acm->data->dev, "wrote len %d/%d, status %d\n",
569 urb->actual_length,
570 urb->transfer_buffer_length,
571 status);
572
573 spin_lock_irqsave(&acm->write_lock, flags);
574 acm_write_done(acm, wb);
575 spin_unlock_irqrestore(&acm->write_lock, flags);
576 set_bit(EVENT_TTY_WAKEUP, &acm->flags);
577 schedule_delayed_work(&acm->dwork, 0);
578}
579
580static void acm_softint(struct work_struct *work)
581{
582 int i;
583 struct acm *acm = container_of(work, struct acm, dwork.work);
584
585 if (test_bit(EVENT_RX_STALL, &acm->flags)) {
586 smp_mb(); /* against acm_suspend() */
587 if (!acm->susp_count) {
588 for (i = 0; i < acm->rx_buflimit; i++)
589 usb_kill_urb(acm->read_urbs[i]);
590 usb_clear_halt(acm->dev, acm->in);
591 acm_submit_read_urbs(acm, GFP_KERNEL);
592 clear_bit(EVENT_RX_STALL, &acm->flags);
593 }
594 }
595
596 if (test_and_clear_bit(ACM_ERROR_DELAY, &acm->flags)) {
597 for (i = 0; i < acm->rx_buflimit; i++)
598 if (test_and_clear_bit(i, &acm->urbs_in_error_delay))
599 acm_submit_read_urb(acm, i, GFP_KERNEL);
600 }
601
602 if (test_and_clear_bit(EVENT_TTY_WAKEUP, &acm->flags))
603 tty_port_tty_wakeup(&acm->port);
604}
605
606/*
607 * TTY handlers
608 */
609
610static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
611{
612 struct acm *acm;
613 int retval;
614
615 acm = acm_get_by_minor(tty->index);
616 if (!acm)
617 return -ENODEV;
618
619 retval = tty_standard_install(driver, tty);
620 if (retval)
621 goto error_init_termios;
622
623 /*
624 * Suppress initial echoing for some devices which might send data
625 * immediately after acm driver has been installed.
626 */
627 if (acm->quirks & DISABLE_ECHO)
628 tty->termios.c_lflag &= ~ECHO;
629
630 tty->driver_data = acm;
631
632 return 0;
633
634error_init_termios:
635 tty_port_put(&acm->port);
636 return retval;
637}
638
639static int acm_tty_open(struct tty_struct *tty, struct file *filp)
640{
641 struct acm *acm = tty->driver_data;
642
643 return tty_port_open(&acm->port, tty, filp);
644}
645
646static void acm_port_dtr_rts(struct tty_port *port, int raise)
647{
648 struct acm *acm = container_of(port, struct acm, port);
649 int val;
650 int res;
651
652 if (raise)
653 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
654 else
655 val = 0;
656
657 /* FIXME: add missing ctrlout locking throughout driver */
658 acm->ctrlout = val;
659
660 res = acm_set_control(acm, val);
661 if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
662 /* This is broken in too many devices to spam the logs */
663 dev_dbg(&acm->control->dev, "failed to set dtr/rts\n");
664}
665
666static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
667{
668 struct acm *acm = container_of(port, struct acm, port);
669 int retval = -ENODEV;
670 int i;
671
672 mutex_lock(&acm->mutex);
673 if (acm->disconnected)
674 goto disconnected;
675
676 retval = usb_autopm_get_interface(acm->control);
677 if (retval)
678 goto error_get_interface;
679
680 /*
681 * FIXME: Why do we need this? Allocating 64K of physically contiguous
682 * memory is really nasty...
683 */
684 set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
685 acm->control->needs_remote_wakeup = 1;
686
687 acm->ctrlurb->dev = acm->dev;
688 retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
689 if (retval) {
690 dev_err(&acm->control->dev,
691 "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
692 goto error_submit_urb;
693 }
694
695 acm_tty_set_termios(tty, NULL);
696
697 /*
698 * Unthrottle device in case the TTY was closed while throttled.
699 */
700 clear_bit(ACM_THROTTLED, &acm->flags);
701
702 retval = acm_submit_read_urbs(acm, GFP_KERNEL);
703 if (retval)
704 goto error_submit_read_urbs;
705
706 usb_autopm_put_interface(acm->control);
707
708 mutex_unlock(&acm->mutex);
709
710 return 0;
711
712error_submit_read_urbs:
713 for (i = 0; i < acm->rx_buflimit; i++)
714 usb_kill_urb(acm->read_urbs[i]);
715 usb_kill_urb(acm->ctrlurb);
716error_submit_urb:
717 usb_autopm_put_interface(acm->control);
718error_get_interface:
719disconnected:
720 mutex_unlock(&acm->mutex);
721
722 return usb_translate_errors(retval);
723}
724
725static void acm_port_destruct(struct tty_port *port)
726{
727 struct acm *acm = container_of(port, struct acm, port);
728
729 acm_release_minor(acm);
730 usb_put_intf(acm->control);
731 kfree(acm->country_codes);
732 kfree(acm);
733}
734
735static void acm_port_shutdown(struct tty_port *port)
736{
737 struct acm *acm = container_of(port, struct acm, port);
738 struct urb *urb;
739 struct acm_wb *wb;
740
741 /*
742 * Need to grab write_lock to prevent race with resume, but no need to
743 * hold it due to the tty-port initialised flag.
744 */
745 acm_poison_urbs(acm);
746 spin_lock_irq(&acm->write_lock);
747 spin_unlock_irq(&acm->write_lock);
748
749 usb_autopm_get_interface_no_resume(acm->control);
750 acm->control->needs_remote_wakeup = 0;
751 usb_autopm_put_interface(acm->control);
752
753 for (;;) {
754 urb = usb_get_from_anchor(&acm->delayed);
755 if (!urb)
756 break;
757 wb = urb->context;
758 wb->use = false;
759 usb_autopm_put_interface_async(acm->control);
760 }
761
762 acm_unpoison_urbs(acm);
763
764}
765
766static void acm_tty_cleanup(struct tty_struct *tty)
767{
768 struct acm *acm = tty->driver_data;
769
770 tty_port_put(&acm->port);
771}
772
773static void acm_tty_hangup(struct tty_struct *tty)
774{
775 struct acm *acm = tty->driver_data;
776
777 tty_port_hangup(&acm->port);
778}
779
780static void acm_tty_close(struct tty_struct *tty, struct file *filp)
781{
782 struct acm *acm = tty->driver_data;
783
784 tty_port_close(&acm->port, tty, filp);
785}
786
787static int acm_tty_write(struct tty_struct *tty,
788 const unsigned char *buf, int count)
789{
790 struct acm *acm = tty->driver_data;
791 int stat;
792 unsigned long flags;
793 int wbn;
794 struct acm_wb *wb;
795
796 if (!count)
797 return 0;
798
799 dev_vdbg(&acm->data->dev, "%d bytes from tty layer\n", count);
800
801 spin_lock_irqsave(&acm->write_lock, flags);
802 wbn = acm_wb_alloc(acm);
803 if (wbn < 0) {
804 spin_unlock_irqrestore(&acm->write_lock, flags);
805 return 0;
806 }
807 wb = &acm->wb[wbn];
808
809 if (!acm->dev) {
810 wb->use = false;
811 spin_unlock_irqrestore(&acm->write_lock, flags);
812 return -ENODEV;
813 }
814
815 count = (count > acm->writesize) ? acm->writesize : count;
816 dev_vdbg(&acm->data->dev, "writing %d bytes\n", count);
817 memcpy(wb->buf, buf, count);
818 wb->len = count;
819
820 stat = usb_autopm_get_interface_async(acm->control);
821 if (stat) {
822 wb->use = false;
823 spin_unlock_irqrestore(&acm->write_lock, flags);
824 return stat;
825 }
826
827 if (acm->susp_count) {
828 usb_anchor_urb(wb->urb, &acm->delayed);
829 spin_unlock_irqrestore(&acm->write_lock, flags);
830 return count;
831 }
832
833 stat = acm_start_wb(acm, wb);
834 spin_unlock_irqrestore(&acm->write_lock, flags);
835
836 if (stat < 0)
837 return stat;
838 return count;
839}
840
841static int acm_tty_write_room(struct tty_struct *tty)
842{
843 struct acm *acm = tty->driver_data;
844 /*
845 * Do not let the line discipline to know that we have a reserve,
846 * or it might get too enthusiastic.
847 */
848 return acm_wb_is_avail(acm) ? acm->writesize : 0;
849}
850
851static int acm_tty_chars_in_buffer(struct tty_struct *tty)
852{
853 struct acm *acm = tty->driver_data;
854 /*
855 * if the device was unplugged then any remaining characters fell out
856 * of the connector ;)
857 */
858 if (acm->disconnected)
859 return 0;
860 /*
861 * This is inaccurate (overcounts), but it works.
862 */
863 return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
864}
865
866static void acm_tty_throttle(struct tty_struct *tty)
867{
868 struct acm *acm = tty->driver_data;
869
870 set_bit(ACM_THROTTLED, &acm->flags);
871}
872
873static void acm_tty_unthrottle(struct tty_struct *tty)
874{
875 struct acm *acm = tty->driver_data;
876
877 clear_bit(ACM_THROTTLED, &acm->flags);
878
879 /* Matches the smp_mb__after_atomic() in acm_read_bulk_callback(). */
880 smp_mb();
881
882 acm_submit_read_urbs(acm, GFP_KERNEL);
883}
884
885static int acm_tty_break_ctl(struct tty_struct *tty, int state)
886{
887 struct acm *acm = tty->driver_data;
888 int retval;
889
890 retval = acm_send_break(acm, state ? 0xffff : 0);
891 if (retval < 0)
892 dev_dbg(&acm->control->dev,
893 "%s - send break failed\n", __func__);
894 return retval;
895}
896
897static int acm_tty_tiocmget(struct tty_struct *tty)
898{
899 struct acm *acm = tty->driver_data;
900
901 return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
902 (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
903 (acm->ctrlin & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
904 (acm->ctrlin & ACM_CTRL_RI ? TIOCM_RI : 0) |
905 (acm->ctrlin & ACM_CTRL_DCD ? TIOCM_CD : 0) |
906 TIOCM_CTS;
907}
908
909static int acm_tty_tiocmset(struct tty_struct *tty,
910 unsigned int set, unsigned int clear)
911{
912 struct acm *acm = tty->driver_data;
913 unsigned int newctrl;
914
915 newctrl = acm->ctrlout;
916 set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
917 (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
918 clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
919 (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
920
921 newctrl = (newctrl & ~clear) | set;
922
923 if (acm->ctrlout == newctrl)
924 return 0;
925 return acm_set_control(acm, acm->ctrlout = newctrl);
926}
927
928static int get_serial_info(struct tty_struct *tty, struct serial_struct *ss)
929{
930 struct acm *acm = tty->driver_data;
931
932 ss->xmit_fifo_size = acm->writesize;
933 ss->baud_base = le32_to_cpu(acm->line.dwDTERate);
934 ss->close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
935 ss->closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
936 ASYNC_CLOSING_WAIT_NONE :
937 jiffies_to_msecs(acm->port.closing_wait) / 10;
938 return 0;
939}
940
941static int set_serial_info(struct tty_struct *tty, struct serial_struct *ss)
942{
943 struct acm *acm = tty->driver_data;
944 unsigned int closing_wait, close_delay;
945 unsigned int old_closing_wait, old_close_delay;
946 int retval = 0;
947
948 close_delay = msecs_to_jiffies(ss->close_delay * 10);
949 closing_wait = ss->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
950 ASYNC_CLOSING_WAIT_NONE :
951 msecs_to_jiffies(ss->closing_wait * 10);
952
953 /* we must redo the rounding here, so that the values match */
954 old_close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
955 old_closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
956 ASYNC_CLOSING_WAIT_NONE :
957 jiffies_to_msecs(acm->port.closing_wait) / 10;
958
959 mutex_lock(&acm->port.mutex);
960
961 if (!capable(CAP_SYS_ADMIN)) {
962 if ((ss->close_delay != old_close_delay) ||
963 (ss->closing_wait != old_closing_wait))
964 retval = -EPERM;
965 else
966 retval = -EOPNOTSUPP;
967 } else {
968 acm->port.close_delay = close_delay;
969 acm->port.closing_wait = closing_wait;
970 }
971
972 mutex_unlock(&acm->port.mutex);
973 return retval;
974}
975
976static int wait_serial_change(struct acm *acm, unsigned long arg)
977{
978 int rv = 0;
979 DECLARE_WAITQUEUE(wait, current);
980 struct async_icount old, new;
981
982 do {
983 spin_lock_irq(&acm->read_lock);
984 old = acm->oldcount;
985 new = acm->iocount;
986 acm->oldcount = new;
987 spin_unlock_irq(&acm->read_lock);
988
989 if ((arg & TIOCM_DSR) &&
990 old.dsr != new.dsr)
991 break;
992 if ((arg & TIOCM_CD) &&
993 old.dcd != new.dcd)
994 break;
995 if ((arg & TIOCM_RI) &&
996 old.rng != new.rng)
997 break;
998
999 add_wait_queue(&acm->wioctl, &wait);
1000 set_current_state(TASK_INTERRUPTIBLE);
1001 schedule();
1002 remove_wait_queue(&acm->wioctl, &wait);
1003 if (acm->disconnected) {
1004 if (arg & TIOCM_CD)
1005 break;
1006 else
1007 rv = -ENODEV;
1008 } else {
1009 if (signal_pending(current))
1010 rv = -ERESTARTSYS;
1011 }
1012 } while (!rv);
1013
1014
1015
1016 return rv;
1017}
1018
1019static int acm_tty_get_icount(struct tty_struct *tty,
1020 struct serial_icounter_struct *icount)
1021{
1022 struct acm *acm = tty->driver_data;
1023
1024 icount->dsr = acm->iocount.dsr;
1025 icount->rng = acm->iocount.rng;
1026 icount->dcd = acm->iocount.dcd;
1027 icount->frame = acm->iocount.frame;
1028 icount->overrun = acm->iocount.overrun;
1029 icount->parity = acm->iocount.parity;
1030 icount->brk = acm->iocount.brk;
1031
1032 return 0;
1033}
1034
1035static int acm_tty_ioctl(struct tty_struct *tty,
1036 unsigned int cmd, unsigned long arg)
1037{
1038 struct acm *acm = tty->driver_data;
1039 int rv = -ENOIOCTLCMD;
1040
1041 switch (cmd) {
1042 case TIOCMIWAIT:
1043 rv = usb_autopm_get_interface(acm->control);
1044 if (rv < 0) {
1045 rv = -EIO;
1046 break;
1047 }
1048 rv = wait_serial_change(acm, arg);
1049 usb_autopm_put_interface(acm->control);
1050 break;
1051 }
1052
1053 return rv;
1054}
1055
1056static void acm_tty_set_termios(struct tty_struct *tty,
1057 struct ktermios *termios_old)
1058{
1059 struct acm *acm = tty->driver_data;
1060 struct ktermios *termios = &tty->termios;
1061 struct usb_cdc_line_coding newline;
1062 int newctrl = acm->ctrlout;
1063
1064 newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
1065 newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1066 newline.bParityType = termios->c_cflag & PARENB ?
1067 (termios->c_cflag & PARODD ? 1 : 2) +
1068 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1069 switch (termios->c_cflag & CSIZE) {
1070 case CS5:
1071 newline.bDataBits = 5;
1072 break;
1073 case CS6:
1074 newline.bDataBits = 6;
1075 break;
1076 case CS7:
1077 newline.bDataBits = 7;
1078 break;
1079 case CS8:
1080 default:
1081 newline.bDataBits = 8;
1082 break;
1083 }
1084 /* FIXME: Needs to clear unsupported bits in the termios */
1085 acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1086
1087 if (C_BAUD(tty) == B0) {
1088 newline.dwDTERate = acm->line.dwDTERate;
1089 newctrl &= ~ACM_CTRL_DTR;
1090 } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1091 newctrl |= ACM_CTRL_DTR;
1092 }
1093
1094 if (newctrl != acm->ctrlout)
1095 acm_set_control(acm, acm->ctrlout = newctrl);
1096
1097 if (memcmp(&acm->line, &newline, sizeof newline)) {
1098 memcpy(&acm->line, &newline, sizeof newline);
1099 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1100 __func__,
1101 le32_to_cpu(newline.dwDTERate),
1102 newline.bCharFormat, newline.bParityType,
1103 newline.bDataBits);
1104 acm_set_line(acm, &acm->line);
1105 }
1106}
1107
1108static const struct tty_port_operations acm_port_ops = {
1109 .dtr_rts = acm_port_dtr_rts,
1110 .shutdown = acm_port_shutdown,
1111 .activate = acm_port_activate,
1112 .destruct = acm_port_destruct,
1113};
1114
1115/*
1116 * USB probe and disconnect routines.
1117 */
1118
1119/* Little helpers: write/read buffers free */
1120static void acm_write_buffers_free(struct acm *acm)
1121{
1122 int i;
1123 struct acm_wb *wb;
1124
1125 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1126 usb_free_coherent(acm->dev, acm->writesize, wb->buf, wb->dmah);
1127}
1128
1129static void acm_read_buffers_free(struct acm *acm)
1130{
1131 int i;
1132
1133 for (i = 0; i < acm->rx_buflimit; i++)
1134 usb_free_coherent(acm->dev, acm->readsize,
1135 acm->read_buffers[i].base, acm->read_buffers[i].dma);
1136}
1137
1138/* Little helper: write buffers allocate */
1139static int acm_write_buffers_alloc(struct acm *acm)
1140{
1141 int i;
1142 struct acm_wb *wb;
1143
1144 for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1145 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1146 &wb->dmah);
1147 if (!wb->buf) {
1148 while (i != 0) {
1149 --i;
1150 --wb;
1151 usb_free_coherent(acm->dev, acm->writesize,
1152 wb->buf, wb->dmah);
1153 }
1154 return -ENOMEM;
1155 }
1156 }
1157 return 0;
1158}
1159
1160static int acm_probe(struct usb_interface *intf,
1161 const struct usb_device_id *id)
1162{
1163 struct usb_cdc_union_desc *union_header = NULL;
1164 struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
1165 unsigned char *buffer = intf->altsetting->extra;
1166 int buflen = intf->altsetting->extralen;
1167 struct usb_interface *control_interface;
1168 struct usb_interface *data_interface;
1169 struct usb_endpoint_descriptor *epctrl = NULL;
1170 struct usb_endpoint_descriptor *epread = NULL;
1171 struct usb_endpoint_descriptor *epwrite = NULL;
1172 struct usb_device *usb_dev = interface_to_usbdev(intf);
1173 struct usb_cdc_parsed_header h;
1174 struct acm *acm;
1175 int minor;
1176 int ctrlsize, readsize;
1177 u8 *buf;
1178 int call_intf_num = -1;
1179 int data_intf_num = -1;
1180 unsigned long quirks;
1181 int num_rx_buf;
1182 int i;
1183 int combined_interfaces = 0;
1184 struct device *tty_dev;
1185 int rv = -ENOMEM;
1186 int res;
1187
1188 /* normal quirks */
1189 quirks = (unsigned long)id->driver_info;
1190
1191 if (quirks == IGNORE_DEVICE)
1192 return -ENODEV;
1193
1194 memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1195
1196 num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1197
1198 /* handle quirks deadly to normal probing*/
1199 if (quirks == NO_UNION_NORMAL) {
1200 data_interface = usb_ifnum_to_if(usb_dev, 1);
1201 control_interface = usb_ifnum_to_if(usb_dev, 0);
1202 /* we would crash */
1203 if (!data_interface || !control_interface)
1204 return -ENODEV;
1205 goto skip_normal_probe;
1206 }
1207
1208 /* normal probing*/
1209 if (!buffer) {
1210 dev_err(&intf->dev, "Weird descriptor references\n");
1211 return -EINVAL;
1212 }
1213
1214 if (!buflen) {
1215 if (intf->cur_altsetting->endpoint &&
1216 intf->cur_altsetting->endpoint->extralen &&
1217 intf->cur_altsetting->endpoint->extra) {
1218 dev_dbg(&intf->dev,
1219 "Seeking extra descriptors on endpoint\n");
1220 buflen = intf->cur_altsetting->endpoint->extralen;
1221 buffer = intf->cur_altsetting->endpoint->extra;
1222 } else {
1223 dev_err(&intf->dev,
1224 "Zero length descriptor references\n");
1225 return -EINVAL;
1226 }
1227 }
1228
1229 cdc_parse_cdc_header(&h, intf, buffer, buflen);
1230 union_header = h.usb_cdc_union_desc;
1231 cmgmd = h.usb_cdc_call_mgmt_descriptor;
1232 if (cmgmd)
1233 call_intf_num = cmgmd->bDataInterface;
1234
1235 if (!union_header) {
1236 if (intf->cur_altsetting->desc.bNumEndpoints == 3) {
1237 dev_dbg(&intf->dev, "No union descriptor, assuming single interface\n");
1238 combined_interfaces = 1;
1239 control_interface = data_interface = intf;
1240 goto look_for_collapsed_interface;
1241 } else if (call_intf_num > 0) {
1242 dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1243 data_intf_num = call_intf_num;
1244 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1245 control_interface = intf;
1246 } else {
1247 dev_dbg(&intf->dev, "No union descriptor, giving up\n");
1248 return -ENODEV;
1249 }
1250 } else {
1251 int class = -1;
1252
1253 data_intf_num = union_header->bSlaveInterface0;
1254 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1255 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1256
1257 if (control_interface)
1258 class = control_interface->cur_altsetting->desc.bInterfaceClass;
1259
1260 if (class != USB_CLASS_COMM && class != USB_CLASS_CDC_DATA) {
1261 dev_dbg(&intf->dev, "Broken union descriptor, assuming single interface\n");
1262 combined_interfaces = 1;
1263 control_interface = data_interface = intf;
1264 goto look_for_collapsed_interface;
1265 }
1266 }
1267
1268 if (!control_interface || !data_interface) {
1269 dev_dbg(&intf->dev, "no interfaces\n");
1270 return -ENODEV;
1271 }
1272
1273 if (data_intf_num != call_intf_num)
1274 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1275
1276 if (control_interface == data_interface) {
1277 /* some broken devices designed for windows work this way */
1278 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1279 combined_interfaces = 1;
1280 /* a popular other OS doesn't use it */
1281 quirks |= NO_CAP_LINE;
1282 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1283 dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1284 return -EINVAL;
1285 }
1286look_for_collapsed_interface:
1287 res = usb_find_common_endpoints(data_interface->cur_altsetting,
1288 &epread, &epwrite, &epctrl, NULL);
1289 if (res)
1290 return res;
1291
1292 goto made_compressed_probe;
1293 }
1294
1295skip_normal_probe:
1296
1297 /*workaround for switched interfaces */
1298 if (data_interface->cur_altsetting->desc.bInterfaceClass != USB_CLASS_CDC_DATA) {
1299 if (control_interface->cur_altsetting->desc.bInterfaceClass == USB_CLASS_CDC_DATA) {
1300 dev_dbg(&intf->dev,
1301 "Your device has switched interfaces.\n");
1302 swap(control_interface, data_interface);
1303 } else {
1304 return -EINVAL;
1305 }
1306 }
1307
1308 /* Accept probe requests only for the control interface */
1309 if (!combined_interfaces && intf != control_interface)
1310 return -ENODEV;
1311
1312 if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1313 control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1314 return -EINVAL;
1315
1316 epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1317 epread = &data_interface->cur_altsetting->endpoint[0].desc;
1318 epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1319
1320
1321 /* workaround for switched endpoints */
1322 if (!usb_endpoint_dir_in(epread)) {
1323 /* descriptors are swapped */
1324 dev_dbg(&intf->dev,
1325 "The data interface has switched endpoints\n");
1326 swap(epread, epwrite);
1327 }
1328made_compressed_probe:
1329 dev_dbg(&intf->dev, "interfaces are valid\n");
1330
1331 acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1332 if (!acm)
1333 return -ENOMEM;
1334
1335 tty_port_init(&acm->port);
1336 acm->port.ops = &acm_port_ops;
1337
1338 ctrlsize = usb_endpoint_maxp(epctrl);
1339 readsize = usb_endpoint_maxp(epread) *
1340 (quirks == SINGLE_RX_URB ? 1 : 2);
1341 acm->combined_interfaces = combined_interfaces;
1342 acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1343 acm->control = control_interface;
1344 acm->data = data_interface;
1345
1346 usb_get_intf(acm->control); /* undone in destruct() */
1347
1348 minor = acm_alloc_minor(acm);
1349 if (minor < 0)
1350 goto err_put_port;
1351
1352 acm->minor = minor;
1353 acm->dev = usb_dev;
1354 if (h.usb_cdc_acm_descriptor)
1355 acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
1356 if (quirks & NO_CAP_LINE)
1357 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1358 acm->ctrlsize = ctrlsize;
1359 acm->readsize = readsize;
1360 acm->rx_buflimit = num_rx_buf;
1361 INIT_DELAYED_WORK(&acm->dwork, acm_softint);
1362 init_waitqueue_head(&acm->wioctl);
1363 spin_lock_init(&acm->write_lock);
1364 spin_lock_init(&acm->read_lock);
1365 mutex_init(&acm->mutex);
1366 if (usb_endpoint_xfer_int(epread)) {
1367 acm->bInterval = epread->bInterval;
1368 acm->in = usb_rcvintpipe(usb_dev, epread->bEndpointAddress);
1369 } else {
1370 acm->in = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1371 }
1372 if (usb_endpoint_xfer_int(epwrite))
1373 acm->out = usb_sndintpipe(usb_dev, epwrite->bEndpointAddress);
1374 else
1375 acm->out = usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress);
1376 init_usb_anchor(&acm->delayed);
1377 acm->quirks = quirks;
1378
1379 buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1380 if (!buf)
1381 goto err_put_port;
1382 acm->ctrl_buffer = buf;
1383
1384 if (acm_write_buffers_alloc(acm) < 0)
1385 goto err_free_ctrl_buffer;
1386
1387 acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1388 if (!acm->ctrlurb)
1389 goto err_free_write_buffers;
1390
1391 for (i = 0; i < num_rx_buf; i++) {
1392 struct acm_rb *rb = &(acm->read_buffers[i]);
1393 struct urb *urb;
1394
1395 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1396 &rb->dma);
1397 if (!rb->base)
1398 goto err_free_read_urbs;
1399 rb->index = i;
1400 rb->instance = acm;
1401
1402 urb = usb_alloc_urb(0, GFP_KERNEL);
1403 if (!urb)
1404 goto err_free_read_urbs;
1405
1406 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1407 urb->transfer_dma = rb->dma;
1408 if (usb_endpoint_xfer_int(epread))
1409 usb_fill_int_urb(urb, acm->dev, acm->in, rb->base,
1410 acm->readsize,
1411 acm_read_bulk_callback, rb,
1412 acm->bInterval);
1413 else
1414 usb_fill_bulk_urb(urb, acm->dev, acm->in, rb->base,
1415 acm->readsize,
1416 acm_read_bulk_callback, rb);
1417
1418 acm->read_urbs[i] = urb;
1419 __set_bit(i, &acm->read_urbs_free);
1420 }
1421 for (i = 0; i < ACM_NW; i++) {
1422 struct acm_wb *snd = &(acm->wb[i]);
1423
1424 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1425 if (!snd->urb)
1426 goto err_free_write_urbs;
1427
1428 if (usb_endpoint_xfer_int(epwrite))
1429 usb_fill_int_urb(snd->urb, usb_dev, acm->out,
1430 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1431 else
1432 usb_fill_bulk_urb(snd->urb, usb_dev, acm->out,
1433 NULL, acm->writesize, acm_write_bulk, snd);
1434 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1435 if (quirks & SEND_ZERO_PACKET)
1436 snd->urb->transfer_flags |= URB_ZERO_PACKET;
1437 snd->instance = acm;
1438 }
1439
1440 usb_set_intfdata(intf, acm);
1441
1442 i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1443 if (i < 0)
1444 goto err_free_write_urbs;
1445
1446 if (h.usb_cdc_country_functional_desc) { /* export the country data */
1447 struct usb_cdc_country_functional_desc * cfd =
1448 h.usb_cdc_country_functional_desc;
1449
1450 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1451 if (!acm->country_codes)
1452 goto skip_countries;
1453 acm->country_code_size = cfd->bLength - 4;
1454 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1455 cfd->bLength - 4);
1456 acm->country_rel_date = cfd->iCountryCodeRelDate;
1457
1458 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1459 if (i < 0) {
1460 kfree(acm->country_codes);
1461 acm->country_codes = NULL;
1462 acm->country_code_size = 0;
1463 goto skip_countries;
1464 }
1465
1466 i = device_create_file(&intf->dev,
1467 &dev_attr_iCountryCodeRelDate);
1468 if (i < 0) {
1469 device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1470 kfree(acm->country_codes);
1471 acm->country_codes = NULL;
1472 acm->country_code_size = 0;
1473 goto skip_countries;
1474 }
1475 }
1476
1477skip_countries:
1478 usb_fill_int_urb(acm->ctrlurb, usb_dev,
1479 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1480 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1481 /* works around buggy devices */
1482 epctrl->bInterval ? epctrl->bInterval : 16);
1483 acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1484 acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1485 acm->notification_buffer = NULL;
1486 acm->nb_index = 0;
1487 acm->nb_size = 0;
1488
1489 acm->line.dwDTERate = cpu_to_le32(9600);
1490 acm->line.bDataBits = 8;
1491 acm_set_line(acm, &acm->line);
1492
1493 if (!acm->combined_interfaces) {
1494 rv = usb_driver_claim_interface(&acm_driver, data_interface, acm);
1495 if (rv)
1496 goto err_remove_files;
1497 }
1498
1499 tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1500 &control_interface->dev);
1501 if (IS_ERR(tty_dev)) {
1502 rv = PTR_ERR(tty_dev);
1503 goto err_release_data_interface;
1504 }
1505
1506 if (quirks & CLEAR_HALT_CONDITIONS) {
1507 usb_clear_halt(usb_dev, acm->in);
1508 usb_clear_halt(usb_dev, acm->out);
1509 }
1510
1511 dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1512
1513 return 0;
1514
1515err_release_data_interface:
1516 if (!acm->combined_interfaces) {
1517 /* Clear driver data so that disconnect() returns early. */
1518 usb_set_intfdata(data_interface, NULL);
1519 usb_driver_release_interface(&acm_driver, data_interface);
1520 }
1521err_remove_files:
1522 if (acm->country_codes) {
1523 device_remove_file(&acm->control->dev,
1524 &dev_attr_wCountryCodes);
1525 device_remove_file(&acm->control->dev,
1526 &dev_attr_iCountryCodeRelDate);
1527 }
1528 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1529err_free_write_urbs:
1530 for (i = 0; i < ACM_NW; i++)
1531 usb_free_urb(acm->wb[i].urb);
1532err_free_read_urbs:
1533 for (i = 0; i < num_rx_buf; i++)
1534 usb_free_urb(acm->read_urbs[i]);
1535 acm_read_buffers_free(acm);
1536 usb_free_urb(acm->ctrlurb);
1537err_free_write_buffers:
1538 acm_write_buffers_free(acm);
1539err_free_ctrl_buffer:
1540 usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1541err_put_port:
1542 tty_port_put(&acm->port);
1543
1544 return rv;
1545}
1546
1547static void acm_disconnect(struct usb_interface *intf)
1548{
1549 struct acm *acm = usb_get_intfdata(intf);
1550 struct tty_struct *tty;
1551 int i;
1552
1553 /* sibling interface is already cleaning up */
1554 if (!acm)
1555 return;
1556
1557 acm->disconnected = true;
1558 /*
1559 * there is a circular dependency. acm_softint() can resubmit
1560 * the URBs in error handling so we need to block any
1561 * submission right away
1562 */
1563 acm_poison_urbs(acm);
1564 mutex_lock(&acm->mutex);
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 }
1571 wake_up_all(&acm->wioctl);
1572 device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1573 usb_set_intfdata(acm->control, NULL);
1574 usb_set_intfdata(acm->data, NULL);
1575 mutex_unlock(&acm->mutex);
1576
1577 tty = tty_port_tty_get(&acm->port);
1578 if (tty) {
1579 tty_vhangup(tty);
1580 tty_kref_put(tty);
1581 }
1582
1583 cancel_delayed_work_sync(&acm->dwork);
1584
1585 tty_unregister_device(acm_tty_driver, acm->minor);
1586
1587 usb_free_urb(acm->ctrlurb);
1588 for (i = 0; i < ACM_NW; i++)
1589 usb_free_urb(acm->wb[i].urb);
1590 for (i = 0; i < acm->rx_buflimit; i++)
1591 usb_free_urb(acm->read_urbs[i]);
1592 acm_write_buffers_free(acm);
1593 usb_free_coherent(acm->dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1594 acm_read_buffers_free(acm);
1595
1596 kfree(acm->notification_buffer);
1597
1598 if (!acm->combined_interfaces)
1599 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1600 acm->data : acm->control);
1601
1602 tty_port_put(&acm->port);
1603}
1604
1605#ifdef CONFIG_PM
1606static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1607{
1608 struct acm *acm = usb_get_intfdata(intf);
1609 int cnt;
1610
1611 spin_lock_irq(&acm->write_lock);
1612 if (PMSG_IS_AUTO(message)) {
1613 if (acm->transmitting) {
1614 spin_unlock_irq(&acm->write_lock);
1615 return -EBUSY;
1616 }
1617 }
1618 cnt = acm->susp_count++;
1619 spin_unlock_irq(&acm->write_lock);
1620
1621 if (cnt)
1622 return 0;
1623
1624 acm_poison_urbs(acm);
1625 cancel_delayed_work_sync(&acm->dwork);
1626 acm->urbs_in_error_delay = 0;
1627
1628 return 0;
1629}
1630
1631static int acm_resume(struct usb_interface *intf)
1632{
1633 struct acm *acm = usb_get_intfdata(intf);
1634 struct urb *urb;
1635 int rv = 0;
1636
1637 acm_unpoison_urbs(acm);
1638 spin_lock_irq(&acm->write_lock);
1639
1640 if (--acm->susp_count)
1641 goto out;
1642
1643 if (tty_port_initialized(&acm->port)) {
1644 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1645
1646 for (;;) {
1647 urb = usb_get_from_anchor(&acm->delayed);
1648 if (!urb)
1649 break;
1650
1651 acm_start_wb(acm, urb->context);
1652 }
1653
1654 /*
1655 * delayed error checking because we must
1656 * do the write path at all cost
1657 */
1658 if (rv < 0)
1659 goto out;
1660
1661 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1662 }
1663out:
1664 spin_unlock_irq(&acm->write_lock);
1665
1666 return rv;
1667}
1668
1669static int acm_reset_resume(struct usb_interface *intf)
1670{
1671 struct acm *acm = usb_get_intfdata(intf);
1672
1673 if (tty_port_initialized(&acm->port))
1674 tty_port_tty_hangup(&acm->port, false);
1675
1676 return acm_resume(intf);
1677}
1678
1679#endif /* CONFIG_PM */
1680
1681static int acm_pre_reset(struct usb_interface *intf)
1682{
1683 struct acm *acm = usb_get_intfdata(intf);
1684
1685 clear_bit(EVENT_RX_STALL, &acm->flags);
1686 acm->nb_index = 0; /* pending control transfers are lost */
1687
1688 return 0;
1689}
1690
1691#define NOKIA_PCSUITE_ACM_INFO(x) \
1692 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1693 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1694 USB_CDC_ACM_PROTO_VENDOR)
1695
1696#define SAMSUNG_PCSUITE_ACM_INFO(x) \
1697 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1698 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1699 USB_CDC_ACM_PROTO_VENDOR)
1700
1701/*
1702 * USB driver structure.
1703 */
1704
1705static const struct usb_device_id acm_ids[] = {
1706 /* quirky and broken devices */
1707 { USB_DEVICE(0x0424, 0x274e), /* Microchip Technology, Inc. (formerly SMSC) */
1708 .driver_info = DISABLE_ECHO, }, /* DISABLE ECHO in termios flag */
1709 { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1710 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1711 { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1712 .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1713 { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1714 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1715 },
1716 { USB_DEVICE(0x045b, 0x023c), /* Renesas USB Download mode */
1717 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1718 },
1719 { USB_DEVICE(0x045b, 0x0248), /* Renesas USB Download mode */
1720 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1721 },
1722 { USB_DEVICE(0x045b, 0x024D), /* Renesas USB Download mode */
1723 .driver_info = DISABLE_ECHO, /* Don't echo banner */
1724 },
1725 { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1726 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1727 },
1728 { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1729 .driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1730 },
1731 { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1732 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1733 },
1734 { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1735 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1736 },
1737 { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1738 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1739 },
1740 { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1741 .driver_info = SINGLE_RX_URB,
1742 },
1743 { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1744 .driver_info = SINGLE_RX_URB, /* firmware bug */
1745 },
1746 { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1747 .driver_info = SINGLE_RX_URB, /* firmware bug */
1748 },
1749 { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1750 .driver_info = SINGLE_RX_URB,
1751 },
1752 { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1753 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1754 },
1755 { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1756 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1757 },
1758 { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1759 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1760 },
1761 { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1762 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1763 },
1764 { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1765 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1766 },
1767 { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1768 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1769 },
1770 { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1771 .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1772 },
1773 { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1774 .driver_info = QUIRK_CONTROL_LINE_STATE, },
1775 { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1776 { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1777 { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1778 },
1779 /* Motorola H24 HSPA module: */
1780 { USB_DEVICE(0x22b8, 0x2d91) }, /* modem */
1781 { USB_DEVICE(0x22b8, 0x2d92), /* modem + diagnostics */
1782 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1783 },
1784 { USB_DEVICE(0x22b8, 0x2d93), /* modem + AT port */
1785 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1786 },
1787 { USB_DEVICE(0x22b8, 0x2d95), /* modem + AT port + diagnostics */
1788 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1789 },
1790 { USB_DEVICE(0x22b8, 0x2d96), /* modem + NMEA */
1791 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1792 },
1793 { USB_DEVICE(0x22b8, 0x2d97), /* modem + diagnostics + NMEA */
1794 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1795 },
1796 { USB_DEVICE(0x22b8, 0x2d99), /* modem + AT port + NMEA */
1797 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1798 },
1799 { USB_DEVICE(0x22b8, 0x2d9a), /* modem + AT port + diagnostics + NMEA */
1800 .driver_info = NO_UNION_NORMAL, /* handle only modem interface */
1801 },
1802
1803 { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1804 .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1805 data interface instead of
1806 communications interface.
1807 Maybe we should define a new
1808 quirk for this. */
1809 },
1810 { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1811 .driver_info = NO_UNION_NORMAL,
1812 },
1813 { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1814 .driver_info = NO_UNION_NORMAL,
1815 },
1816 { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1817 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1818 },
1819 { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1820 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1821 },
1822 { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1823 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1824 },
1825 { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1826 .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1827 },
1828 { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1829 .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1830 },
1831
1832 { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1833 .driver_info = CLEAR_HALT_CONDITIONS,
1834 },
1835
1836 /* Nokia S60 phones expose two ACM channels. The first is
1837 * a modem and is picked up by the standard AT-command
1838 * information below. The second is 'vendor-specific' but
1839 * is treated as a serial device at the S60 end, so we want
1840 * to expose it on Linux too. */
1841 { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1842 { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1843 { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1844 { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1845 { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1846 { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1847 { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1848 { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1849 { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1850 { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1851 { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1852 { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1853 { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1854 { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1855 { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1856 { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1857 { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1858 { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i */
1859 { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1860 { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1861 { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1862 { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic & */
1863 { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1864 { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1865 { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1866 { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1867 { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1868 { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1869 { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1870 { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1871 { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1872 { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB */
1873 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1874 { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1875 { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1876 { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1877 { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1878 { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1879 { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1880 { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3 */
1881 { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1882 { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1883 { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1884 { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1885 { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1886 { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1887 { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1888 { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1889 { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1890 { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1891 { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1892 { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1893 { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1894 { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1895 { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1896 { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1897 { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1898 { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1899
1900 /* Support for Owen devices */
1901 { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1902
1903 /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1904
1905#if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1906 { USB_DEVICE(0x04d8, 0x0082), /* Application mode */
1907 .driver_info = IGNORE_DEVICE,
1908 },
1909 { USB_DEVICE(0x04d8, 0x0083), /* Bootloader mode */
1910 .driver_info = IGNORE_DEVICE,
1911 },
1912#endif
1913
1914#if IS_ENABLED(CONFIG_IR_TOY)
1915 { USB_DEVICE(0x04d8, 0xfd08),
1916 .driver_info = IGNORE_DEVICE,
1917 },
1918
1919 { USB_DEVICE(0x04d8, 0xf58b),
1920 .driver_info = IGNORE_DEVICE,
1921 },
1922#endif
1923
1924#if IS_ENABLED(CONFIG_USB_SERIAL_XR)
1925 { USB_DEVICE(0x04e2, 0x1410), /* Ignore XR21V141X USB to Serial converter */
1926 .driver_info = IGNORE_DEVICE,
1927 },
1928#endif
1929
1930 /*Samsung phone in firmware update mode */
1931 { USB_DEVICE(0x04e8, 0x685d),
1932 .driver_info = IGNORE_DEVICE,
1933 },
1934
1935 /* Exclude Infineon Flash Loader utility */
1936 { USB_DEVICE(0x058b, 0x0041),
1937 .driver_info = IGNORE_DEVICE,
1938 },
1939
1940 /* Exclude ETAS ES58x */
1941 { USB_DEVICE(0x108c, 0x0159), /* ES581.4 */
1942 .driver_info = IGNORE_DEVICE,
1943 },
1944 { USB_DEVICE(0x108c, 0x0168), /* ES582.1 */
1945 .driver_info = IGNORE_DEVICE,
1946 },
1947 { USB_DEVICE(0x108c, 0x0169), /* ES584.1 */
1948 .driver_info = IGNORE_DEVICE,
1949 },
1950
1951 { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1952 .driver_info = SEND_ZERO_PACKET,
1953 },
1954 { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1955 .driver_info = SEND_ZERO_PACKET,
1956 },
1957
1958 /* Exclude Goodix Fingerprint Reader */
1959 { USB_DEVICE(0x27c6, 0x5395),
1960 .driver_info = IGNORE_DEVICE,
1961 },
1962
1963 /* control interfaces without any protocol set */
1964 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1965 USB_CDC_PROTO_NONE) },
1966
1967 /* control interfaces with various AT-command sets */
1968 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1969 USB_CDC_ACM_PROTO_AT_V25TER) },
1970 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1971 USB_CDC_ACM_PROTO_AT_PCCA101) },
1972 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1973 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1974 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1975 USB_CDC_ACM_PROTO_AT_GSM) },
1976 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1977 USB_CDC_ACM_PROTO_AT_3G) },
1978 { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1979 USB_CDC_ACM_PROTO_AT_CDMA) },
1980
1981 { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1982 .driver_info = SEND_ZERO_PACKET,
1983 },
1984
1985 { }
1986};
1987
1988MODULE_DEVICE_TABLE(usb, acm_ids);
1989
1990static struct usb_driver acm_driver = {
1991 .name = "cdc_acm",
1992 .probe = acm_probe,
1993 .disconnect = acm_disconnect,
1994#ifdef CONFIG_PM
1995 .suspend = acm_suspend,
1996 .resume = acm_resume,
1997 .reset_resume = acm_reset_resume,
1998#endif
1999 .pre_reset = acm_pre_reset,
2000 .id_table = acm_ids,
2001#ifdef CONFIG_PM
2002 .supports_autosuspend = 1,
2003#endif
2004 .disable_hub_initiated_lpm = 1,
2005};
2006
2007/*
2008 * TTY driver structures.
2009 */
2010
2011static const struct tty_operations acm_ops = {
2012 .install = acm_tty_install,
2013 .open = acm_tty_open,
2014 .close = acm_tty_close,
2015 .cleanup = acm_tty_cleanup,
2016 .hangup = acm_tty_hangup,
2017 .write = acm_tty_write,
2018 .write_room = acm_tty_write_room,
2019 .ioctl = acm_tty_ioctl,
2020 .throttle = acm_tty_throttle,
2021 .unthrottle = acm_tty_unthrottle,
2022 .chars_in_buffer = acm_tty_chars_in_buffer,
2023 .break_ctl = acm_tty_break_ctl,
2024 .set_termios = acm_tty_set_termios,
2025 .tiocmget = acm_tty_tiocmget,
2026 .tiocmset = acm_tty_tiocmset,
2027 .get_serial = get_serial_info,
2028 .set_serial = set_serial_info,
2029 .get_icount = acm_tty_get_icount,
2030};
2031
2032/*
2033 * Init / exit.
2034 */
2035
2036static int __init acm_init(void)
2037{
2038 int retval;
2039 acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
2040 if (!acm_tty_driver)
2041 return -ENOMEM;
2042 acm_tty_driver->driver_name = "acm",
2043 acm_tty_driver->name = "ttyACM",
2044 acm_tty_driver->major = ACM_TTY_MAJOR,
2045 acm_tty_driver->minor_start = 0,
2046 acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2047 acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
2048 acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2049 acm_tty_driver->init_termios = tty_std_termios;
2050 acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2051 HUPCL | CLOCAL;
2052 tty_set_operations(acm_tty_driver, &acm_ops);
2053
2054 retval = tty_register_driver(acm_tty_driver);
2055 if (retval) {
2056 put_tty_driver(acm_tty_driver);
2057 return retval;
2058 }
2059
2060 retval = usb_register(&acm_driver);
2061 if (retval) {
2062 tty_unregister_driver(acm_tty_driver);
2063 put_tty_driver(acm_tty_driver);
2064 return retval;
2065 }
2066
2067 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2068
2069 return 0;
2070}
2071
2072static void __exit acm_exit(void)
2073{
2074 usb_deregister(&acm_driver);
2075 tty_unregister_driver(acm_tty_driver);
2076 put_tty_driver(acm_tty_driver);
2077 idr_destroy(&acm_minors);
2078}
2079
2080module_init(acm_init);
2081module_exit(acm_exit);
2082
2083MODULE_AUTHOR(DRIVER_AUTHOR);
2084MODULE_DESCRIPTION(DRIVER_DESC);
2085MODULE_LICENSE("GPL");
2086MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);