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