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