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