xref: /openbmc/linux/drivers/usb/class/cdc-acm.c (revision fe7498ef)
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  */
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  */
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'.  */
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 
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  */
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 
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 
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 
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 
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  */
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 
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  */
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 
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 
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 
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 */
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 
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 
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 
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 
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 */
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 
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 
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 
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 
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 
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 
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 
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 
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 
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 
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 
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 
850 static unsigned 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 
860 static unsigned 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 
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 
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 
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 	retval = acm_send_break(acm, state ? 0xffff : 0);
900 	if (retval < 0)
901 		dev_dbg(&acm->control->dev,
902 			"%s - send break failed\n", __func__);
903 	return retval;
904 }
905 
906 static int acm_tty_tiocmget(struct tty_struct *tty)
907 {
908 	struct acm *acm = tty->driver_data;
909 
910 	return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
911 	       (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
912 	       (acm->ctrlin  & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
913 	       (acm->ctrlin  & ACM_CTRL_RI  ? TIOCM_RI  : 0) |
914 	       (acm->ctrlin  & ACM_CTRL_DCD ? TIOCM_CD  : 0) |
915 	       TIOCM_CTS;
916 }
917 
918 static int acm_tty_tiocmset(struct tty_struct *tty,
919 			    unsigned int set, unsigned int clear)
920 {
921 	struct acm *acm = tty->driver_data;
922 	unsigned int newctrl;
923 
924 	newctrl = acm->ctrlout;
925 	set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
926 					(set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
927 	clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
928 					(clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
929 
930 	newctrl = (newctrl & ~clear) | set;
931 
932 	if (acm->ctrlout == newctrl)
933 		return 0;
934 	return acm_set_control(acm, acm->ctrlout = newctrl);
935 }
936 
937 static int get_serial_info(struct tty_struct *tty, struct serial_struct *ss)
938 {
939 	struct acm *acm = tty->driver_data;
940 
941 	ss->line = acm->minor;
942 	ss->close_delay	= jiffies_to_msecs(acm->port.close_delay) / 10;
943 	ss->closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
944 				ASYNC_CLOSING_WAIT_NONE :
945 				jiffies_to_msecs(acm->port.closing_wait) / 10;
946 	return 0;
947 }
948 
949 static int set_serial_info(struct tty_struct *tty, struct serial_struct *ss)
950 {
951 	struct acm *acm = tty->driver_data;
952 	unsigned int closing_wait, close_delay;
953 	int retval = 0;
954 
955 	close_delay = msecs_to_jiffies(ss->close_delay * 10);
956 	closing_wait = ss->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
957 			ASYNC_CLOSING_WAIT_NONE :
958 			msecs_to_jiffies(ss->closing_wait * 10);
959 
960 	mutex_lock(&acm->port.mutex);
961 
962 	if (!capable(CAP_SYS_ADMIN)) {
963 		if ((close_delay != acm->port.close_delay) ||
964 		    (closing_wait != acm->port.closing_wait))
965 			retval = -EPERM;
966 	} else {
967 		acm->port.close_delay  = close_delay;
968 		acm->port.closing_wait = closing_wait;
969 	}
970 
971 	mutex_unlock(&acm->port.mutex);
972 	return retval;
973 }
974 
975 static int wait_serial_change(struct acm *acm, unsigned long arg)
976 {
977 	int rv = 0;
978 	DECLARE_WAITQUEUE(wait, current);
979 	struct async_icount old, new;
980 
981 	do {
982 		spin_lock_irq(&acm->read_lock);
983 		old = acm->oldcount;
984 		new = acm->iocount;
985 		acm->oldcount = new;
986 		spin_unlock_irq(&acm->read_lock);
987 
988 		if ((arg & TIOCM_DSR) &&
989 			old.dsr != new.dsr)
990 			break;
991 		if ((arg & TIOCM_CD)  &&
992 			old.dcd != new.dcd)
993 			break;
994 		if ((arg & TIOCM_RI) &&
995 			old.rng != new.rng)
996 			break;
997 
998 		add_wait_queue(&acm->wioctl, &wait);
999 		set_current_state(TASK_INTERRUPTIBLE);
1000 		schedule();
1001 		remove_wait_queue(&acm->wioctl, &wait);
1002 		if (acm->disconnected) {
1003 			if (arg & TIOCM_CD)
1004 				break;
1005 			else
1006 				rv = -ENODEV;
1007 		} else {
1008 			if (signal_pending(current))
1009 				rv = -ERESTARTSYS;
1010 		}
1011 	} while (!rv);
1012 
1013 
1014 
1015 	return rv;
1016 }
1017 
1018 static int acm_tty_get_icount(struct tty_struct *tty,
1019 					struct serial_icounter_struct *icount)
1020 {
1021 	struct acm *acm = tty->driver_data;
1022 
1023 	icount->dsr = acm->iocount.dsr;
1024 	icount->rng = acm->iocount.rng;
1025 	icount->dcd = acm->iocount.dcd;
1026 	icount->frame = acm->iocount.frame;
1027 	icount->overrun = acm->iocount.overrun;
1028 	icount->parity = acm->iocount.parity;
1029 	icount->brk = acm->iocount.brk;
1030 
1031 	return 0;
1032 }
1033 
1034 static int acm_tty_ioctl(struct tty_struct *tty,
1035 					unsigned int cmd, unsigned long arg)
1036 {
1037 	struct acm *acm = tty->driver_data;
1038 	int rv = -ENOIOCTLCMD;
1039 
1040 	switch (cmd) {
1041 	case TIOCMIWAIT:
1042 		rv = usb_autopm_get_interface(acm->control);
1043 		if (rv < 0) {
1044 			rv = -EIO;
1045 			break;
1046 		}
1047 		rv = wait_serial_change(acm, arg);
1048 		usb_autopm_put_interface(acm->control);
1049 		break;
1050 	}
1051 
1052 	return rv;
1053 }
1054 
1055 static void acm_tty_set_termios(struct tty_struct *tty,
1056 						struct ktermios *termios_old)
1057 {
1058 	struct acm *acm = tty->driver_data;
1059 	struct ktermios *termios = &tty->termios;
1060 	struct usb_cdc_line_coding newline;
1061 	int newctrl = acm->ctrlout;
1062 
1063 	newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
1064 	newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1065 	newline.bParityType = termios->c_cflag & PARENB ?
1066 				(termios->c_cflag & PARODD ? 1 : 2) +
1067 				(termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1068 	newline.bDataBits = tty_get_char_size(termios->c_cflag);
1069 
1070 	/* FIXME: Needs to clear unsupported bits in the termios */
1071 	acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1072 
1073 	if (C_BAUD(tty) == B0) {
1074 		newline.dwDTERate = acm->line.dwDTERate;
1075 		newctrl &= ~ACM_CTRL_DTR;
1076 	} else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1077 		newctrl |=  ACM_CTRL_DTR;
1078 	}
1079 
1080 	if (newctrl != acm->ctrlout)
1081 		acm_set_control(acm, acm->ctrlout = newctrl);
1082 
1083 	if (memcmp(&acm->line, &newline, sizeof newline)) {
1084 		memcpy(&acm->line, &newline, sizeof newline);
1085 		dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1086 			__func__,
1087 			le32_to_cpu(newline.dwDTERate),
1088 			newline.bCharFormat, newline.bParityType,
1089 			newline.bDataBits);
1090 		acm_set_line(acm, &acm->line);
1091 	}
1092 }
1093 
1094 static const struct tty_port_operations acm_port_ops = {
1095 	.dtr_rts = acm_port_dtr_rts,
1096 	.shutdown = acm_port_shutdown,
1097 	.activate = acm_port_activate,
1098 	.destruct = acm_port_destruct,
1099 };
1100 
1101 /*
1102  * USB probe and disconnect routines.
1103  */
1104 
1105 /* Little helpers: write/read buffers free */
1106 static void acm_write_buffers_free(struct acm *acm)
1107 {
1108 	int i;
1109 	struct acm_wb *wb;
1110 
1111 	for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1112 		usb_free_coherent(acm->dev, acm->writesize, wb->buf, wb->dmah);
1113 }
1114 
1115 static void acm_read_buffers_free(struct acm *acm)
1116 {
1117 	int i;
1118 
1119 	for (i = 0; i < acm->rx_buflimit; i++)
1120 		usb_free_coherent(acm->dev, acm->readsize,
1121 			  acm->read_buffers[i].base, acm->read_buffers[i].dma);
1122 }
1123 
1124 /* Little helper: write buffers allocate */
1125 static int acm_write_buffers_alloc(struct acm *acm)
1126 {
1127 	int i;
1128 	struct acm_wb *wb;
1129 
1130 	for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1131 		wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1132 		    &wb->dmah);
1133 		if (!wb->buf) {
1134 			while (i != 0) {
1135 				--i;
1136 				--wb;
1137 				usb_free_coherent(acm->dev, acm->writesize,
1138 				    wb->buf, wb->dmah);
1139 			}
1140 			return -ENOMEM;
1141 		}
1142 	}
1143 	return 0;
1144 }
1145 
1146 static int acm_probe(struct usb_interface *intf,
1147 		     const struct usb_device_id *id)
1148 {
1149 	struct usb_cdc_union_desc *union_header = NULL;
1150 	struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
1151 	unsigned char *buffer = intf->altsetting->extra;
1152 	int buflen = intf->altsetting->extralen;
1153 	struct usb_interface *control_interface;
1154 	struct usb_interface *data_interface;
1155 	struct usb_endpoint_descriptor *epctrl = NULL;
1156 	struct usb_endpoint_descriptor *epread = NULL;
1157 	struct usb_endpoint_descriptor *epwrite = NULL;
1158 	struct usb_device *usb_dev = interface_to_usbdev(intf);
1159 	struct usb_cdc_parsed_header h;
1160 	struct acm *acm;
1161 	int minor;
1162 	int ctrlsize, readsize;
1163 	u8 *buf;
1164 	int call_intf_num = -1;
1165 	int data_intf_num = -1;
1166 	unsigned long quirks;
1167 	int num_rx_buf;
1168 	int i;
1169 	int combined_interfaces = 0;
1170 	struct device *tty_dev;
1171 	int rv = -ENOMEM;
1172 	int res;
1173 
1174 	/* normal quirks */
1175 	quirks = (unsigned long)id->driver_info;
1176 
1177 	if (quirks == IGNORE_DEVICE)
1178 		return -ENODEV;
1179 
1180 	memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1181 
1182 	num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1183 
1184 	/* handle quirks deadly to normal probing*/
1185 	if (quirks == NO_UNION_NORMAL) {
1186 		data_interface = usb_ifnum_to_if(usb_dev, 1);
1187 		control_interface = usb_ifnum_to_if(usb_dev, 0);
1188 		/* we would crash */
1189 		if (!data_interface || !control_interface)
1190 			return -ENODEV;
1191 		goto skip_normal_probe;
1192 	}
1193 
1194 	/* normal probing*/
1195 	if (!buffer) {
1196 		dev_err(&intf->dev, "Weird descriptor references\n");
1197 		return -EINVAL;
1198 	}
1199 
1200 	if (!buflen) {
1201 		if (intf->cur_altsetting->endpoint &&
1202 				intf->cur_altsetting->endpoint->extralen &&
1203 				intf->cur_altsetting->endpoint->extra) {
1204 			dev_dbg(&intf->dev,
1205 				"Seeking extra descriptors on endpoint\n");
1206 			buflen = intf->cur_altsetting->endpoint->extralen;
1207 			buffer = intf->cur_altsetting->endpoint->extra;
1208 		} else {
1209 			dev_err(&intf->dev,
1210 				"Zero length descriptor references\n");
1211 			return -EINVAL;
1212 		}
1213 	}
1214 
1215 	cdc_parse_cdc_header(&h, intf, buffer, buflen);
1216 	union_header = h.usb_cdc_union_desc;
1217 	cmgmd = h.usb_cdc_call_mgmt_descriptor;
1218 	if (cmgmd)
1219 		call_intf_num = cmgmd->bDataInterface;
1220 
1221 	if (!union_header) {
1222 		if (intf->cur_altsetting->desc.bNumEndpoints == 3) {
1223 			dev_dbg(&intf->dev, "No union descriptor, assuming single interface\n");
1224 			combined_interfaces = 1;
1225 			control_interface = data_interface = intf;
1226 			goto look_for_collapsed_interface;
1227 		} else if (call_intf_num > 0) {
1228 			dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1229 			data_intf_num = call_intf_num;
1230 			data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1231 			control_interface = intf;
1232 		} else {
1233 			dev_dbg(&intf->dev, "No union descriptor, giving up\n");
1234 			return -ENODEV;
1235 		}
1236 	} else {
1237 		int class = -1;
1238 
1239 		data_intf_num = union_header->bSlaveInterface0;
1240 		control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1241 		data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1242 
1243 		if (control_interface)
1244 			class = control_interface->cur_altsetting->desc.bInterfaceClass;
1245 
1246 		if (class != USB_CLASS_COMM && class != USB_CLASS_CDC_DATA) {
1247 			dev_dbg(&intf->dev, "Broken union descriptor, assuming single interface\n");
1248 			combined_interfaces = 1;
1249 			control_interface = data_interface = intf;
1250 			goto look_for_collapsed_interface;
1251 		}
1252 	}
1253 
1254 	if (!control_interface || !data_interface) {
1255 		dev_dbg(&intf->dev, "no interfaces\n");
1256 		return -ENODEV;
1257 	}
1258 
1259 	if (data_intf_num != call_intf_num)
1260 		dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1261 
1262 	if (control_interface == data_interface) {
1263 		/* some broken devices designed for windows work this way */
1264 		dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1265 		combined_interfaces = 1;
1266 		/* a popular other OS doesn't use it */
1267 		quirks |= NO_CAP_LINE;
1268 		if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1269 			dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1270 			return -EINVAL;
1271 		}
1272 look_for_collapsed_interface:
1273 		res = usb_find_common_endpoints(data_interface->cur_altsetting,
1274 				&epread, &epwrite, &epctrl, NULL);
1275 		if (res)
1276 			return res;
1277 
1278 		goto made_compressed_probe;
1279 	}
1280 
1281 skip_normal_probe:
1282 
1283 	/*workaround for switched interfaces */
1284 	if (data_interface->cur_altsetting->desc.bInterfaceClass != USB_CLASS_CDC_DATA) {
1285 		if (control_interface->cur_altsetting->desc.bInterfaceClass == USB_CLASS_CDC_DATA) {
1286 			dev_dbg(&intf->dev,
1287 				"Your device has switched interfaces.\n");
1288 			swap(control_interface, data_interface);
1289 		} else {
1290 			return -EINVAL;
1291 		}
1292 	}
1293 
1294 	/* Accept probe requests only for the control interface */
1295 	if (!combined_interfaces && intf != control_interface)
1296 		return -ENODEV;
1297 
1298 	if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1299 	    control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1300 		return -EINVAL;
1301 
1302 	epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1303 	epread = &data_interface->cur_altsetting->endpoint[0].desc;
1304 	epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1305 
1306 
1307 	/* workaround for switched endpoints */
1308 	if (!usb_endpoint_dir_in(epread)) {
1309 		/* descriptors are swapped */
1310 		dev_dbg(&intf->dev,
1311 			"The data interface has switched endpoints\n");
1312 		swap(epread, epwrite);
1313 	}
1314 made_compressed_probe:
1315 	dev_dbg(&intf->dev, "interfaces are valid\n");
1316 
1317 	acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1318 	if (!acm)
1319 		return -ENOMEM;
1320 
1321 	tty_port_init(&acm->port);
1322 	acm->port.ops = &acm_port_ops;
1323 
1324 	ctrlsize = usb_endpoint_maxp(epctrl);
1325 	readsize = usb_endpoint_maxp(epread) *
1326 				(quirks == SINGLE_RX_URB ? 1 : 2);
1327 	acm->combined_interfaces = combined_interfaces;
1328 	acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1329 	acm->control = control_interface;
1330 	acm->data = data_interface;
1331 
1332 	usb_get_intf(acm->control); /* undone in destruct() */
1333 
1334 	minor = acm_alloc_minor(acm);
1335 	if (minor < 0) {
1336 		acm->minor = ACM_MINOR_INVALID;
1337 		goto err_put_port;
1338 	}
1339 
1340 	acm->minor = minor;
1341 	acm->dev = usb_dev;
1342 	if (h.usb_cdc_acm_descriptor)
1343 		acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
1344 	if (quirks & NO_CAP_LINE)
1345 		acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1346 	acm->ctrlsize = ctrlsize;
1347 	acm->readsize = readsize;
1348 	acm->rx_buflimit = num_rx_buf;
1349 	INIT_DELAYED_WORK(&acm->dwork, acm_softint);
1350 	init_waitqueue_head(&acm->wioctl);
1351 	spin_lock_init(&acm->write_lock);
1352 	spin_lock_init(&acm->read_lock);
1353 	mutex_init(&acm->mutex);
1354 	if (usb_endpoint_xfer_int(epread)) {
1355 		acm->bInterval = epread->bInterval;
1356 		acm->in = usb_rcvintpipe(usb_dev, epread->bEndpointAddress);
1357 	} else {
1358 		acm->in = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1359 	}
1360 	if (usb_endpoint_xfer_int(epwrite))
1361 		acm->out = usb_sndintpipe(usb_dev, epwrite->bEndpointAddress);
1362 	else
1363 		acm->out = usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress);
1364 	init_usb_anchor(&acm->delayed);
1365 	acm->quirks = quirks;
1366 
1367 	buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1368 	if (!buf)
1369 		goto err_put_port;
1370 	acm->ctrl_buffer = buf;
1371 
1372 	if (acm_write_buffers_alloc(acm) < 0)
1373 		goto err_free_ctrl_buffer;
1374 
1375 	acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1376 	if (!acm->ctrlurb)
1377 		goto err_free_write_buffers;
1378 
1379 	for (i = 0; i < num_rx_buf; i++) {
1380 		struct acm_rb *rb = &(acm->read_buffers[i]);
1381 		struct urb *urb;
1382 
1383 		rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1384 								&rb->dma);
1385 		if (!rb->base)
1386 			goto err_free_read_urbs;
1387 		rb->index = i;
1388 		rb->instance = acm;
1389 
1390 		urb = usb_alloc_urb(0, GFP_KERNEL);
1391 		if (!urb)
1392 			goto err_free_read_urbs;
1393 
1394 		urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1395 		urb->transfer_dma = rb->dma;
1396 		if (usb_endpoint_xfer_int(epread))
1397 			usb_fill_int_urb(urb, acm->dev, acm->in, rb->base,
1398 					 acm->readsize,
1399 					 acm_read_bulk_callback, rb,
1400 					 acm->bInterval);
1401 		else
1402 			usb_fill_bulk_urb(urb, acm->dev, acm->in, rb->base,
1403 					  acm->readsize,
1404 					  acm_read_bulk_callback, rb);
1405 
1406 		acm->read_urbs[i] = urb;
1407 		__set_bit(i, &acm->read_urbs_free);
1408 	}
1409 	for (i = 0; i < ACM_NW; i++) {
1410 		struct acm_wb *snd = &(acm->wb[i]);
1411 
1412 		snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1413 		if (!snd->urb)
1414 			goto err_free_write_urbs;
1415 
1416 		if (usb_endpoint_xfer_int(epwrite))
1417 			usb_fill_int_urb(snd->urb, usb_dev, acm->out,
1418 				NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1419 		else
1420 			usb_fill_bulk_urb(snd->urb, usb_dev, acm->out,
1421 				NULL, acm->writesize, acm_write_bulk, snd);
1422 		snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1423 		if (quirks & SEND_ZERO_PACKET)
1424 			snd->urb->transfer_flags |= URB_ZERO_PACKET;
1425 		snd->instance = acm;
1426 	}
1427 
1428 	usb_set_intfdata(intf, acm);
1429 
1430 	i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1431 	if (i < 0)
1432 		goto err_free_write_urbs;
1433 
1434 	if (h.usb_cdc_country_functional_desc) { /* export the country data */
1435 		struct usb_cdc_country_functional_desc * cfd =
1436 					h.usb_cdc_country_functional_desc;
1437 
1438 		acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1439 		if (!acm->country_codes)
1440 			goto skip_countries;
1441 		acm->country_code_size = cfd->bLength - 4;
1442 		memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1443 							cfd->bLength - 4);
1444 		acm->country_rel_date = cfd->iCountryCodeRelDate;
1445 
1446 		i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1447 		if (i < 0) {
1448 			kfree(acm->country_codes);
1449 			acm->country_codes = NULL;
1450 			acm->country_code_size = 0;
1451 			goto skip_countries;
1452 		}
1453 
1454 		i = device_create_file(&intf->dev,
1455 						&dev_attr_iCountryCodeRelDate);
1456 		if (i < 0) {
1457 			device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1458 			kfree(acm->country_codes);
1459 			acm->country_codes = NULL;
1460 			acm->country_code_size = 0;
1461 			goto skip_countries;
1462 		}
1463 	}
1464 
1465 skip_countries:
1466 	usb_fill_int_urb(acm->ctrlurb, usb_dev,
1467 			 usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1468 			 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1469 			 /* works around buggy devices */
1470 			 epctrl->bInterval ? epctrl->bInterval : 16);
1471 	acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1472 	acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1473 	acm->notification_buffer = NULL;
1474 	acm->nb_index = 0;
1475 	acm->nb_size = 0;
1476 
1477 	acm->line.dwDTERate = cpu_to_le32(9600);
1478 	acm->line.bDataBits = 8;
1479 	acm_set_line(acm, &acm->line);
1480 
1481 	if (!acm->combined_interfaces) {
1482 		rv = usb_driver_claim_interface(&acm_driver, data_interface, acm);
1483 		if (rv)
1484 			goto err_remove_files;
1485 	}
1486 
1487 	tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1488 			&control_interface->dev);
1489 	if (IS_ERR(tty_dev)) {
1490 		rv = PTR_ERR(tty_dev);
1491 		goto err_release_data_interface;
1492 	}
1493 
1494 	if (quirks & CLEAR_HALT_CONDITIONS) {
1495 		usb_clear_halt(usb_dev, acm->in);
1496 		usb_clear_halt(usb_dev, acm->out);
1497 	}
1498 
1499 	dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1500 
1501 	return 0;
1502 
1503 err_release_data_interface:
1504 	if (!acm->combined_interfaces) {
1505 		/* Clear driver data so that disconnect() returns early. */
1506 		usb_set_intfdata(data_interface, NULL);
1507 		usb_driver_release_interface(&acm_driver, data_interface);
1508 	}
1509 err_remove_files:
1510 	if (acm->country_codes) {
1511 		device_remove_file(&acm->control->dev,
1512 				&dev_attr_wCountryCodes);
1513 		device_remove_file(&acm->control->dev,
1514 				&dev_attr_iCountryCodeRelDate);
1515 	}
1516 	device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1517 err_free_write_urbs:
1518 	for (i = 0; i < ACM_NW; i++)
1519 		usb_free_urb(acm->wb[i].urb);
1520 err_free_read_urbs:
1521 	for (i = 0; i < num_rx_buf; i++)
1522 		usb_free_urb(acm->read_urbs[i]);
1523 	acm_read_buffers_free(acm);
1524 	usb_free_urb(acm->ctrlurb);
1525 err_free_write_buffers:
1526 	acm_write_buffers_free(acm);
1527 err_free_ctrl_buffer:
1528 	usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1529 err_put_port:
1530 	tty_port_put(&acm->port);
1531 
1532 	return rv;
1533 }
1534 
1535 static void acm_disconnect(struct usb_interface *intf)
1536 {
1537 	struct acm *acm = usb_get_intfdata(intf);
1538 	struct tty_struct *tty;
1539 	int i;
1540 
1541 	/* sibling interface is already cleaning up */
1542 	if (!acm)
1543 		return;
1544 
1545 	acm->disconnected = true;
1546 	/*
1547 	 * there is a circular dependency. acm_softint() can resubmit
1548 	 * the URBs in error handling so we need to block any
1549 	 * submission right away
1550 	 */
1551 	acm_poison_urbs(acm);
1552 	mutex_lock(&acm->mutex);
1553 	if (acm->country_codes) {
1554 		device_remove_file(&acm->control->dev,
1555 				&dev_attr_wCountryCodes);
1556 		device_remove_file(&acm->control->dev,
1557 				&dev_attr_iCountryCodeRelDate);
1558 	}
1559 	wake_up_all(&acm->wioctl);
1560 	device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1561 	usb_set_intfdata(acm->control, NULL);
1562 	usb_set_intfdata(acm->data, NULL);
1563 	mutex_unlock(&acm->mutex);
1564 
1565 	tty = tty_port_tty_get(&acm->port);
1566 	if (tty) {
1567 		tty_vhangup(tty);
1568 		tty_kref_put(tty);
1569 	}
1570 
1571 	cancel_delayed_work_sync(&acm->dwork);
1572 
1573 	tty_unregister_device(acm_tty_driver, acm->minor);
1574 
1575 	usb_free_urb(acm->ctrlurb);
1576 	for (i = 0; i < ACM_NW; i++)
1577 		usb_free_urb(acm->wb[i].urb);
1578 	for (i = 0; i < acm->rx_buflimit; i++)
1579 		usb_free_urb(acm->read_urbs[i]);
1580 	acm_write_buffers_free(acm);
1581 	usb_free_coherent(acm->dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1582 	acm_read_buffers_free(acm);
1583 
1584 	kfree(acm->notification_buffer);
1585 
1586 	if (!acm->combined_interfaces)
1587 		usb_driver_release_interface(&acm_driver, intf == acm->control ?
1588 					acm->data : acm->control);
1589 
1590 	tty_port_put(&acm->port);
1591 }
1592 
1593 #ifdef CONFIG_PM
1594 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1595 {
1596 	struct acm *acm = usb_get_intfdata(intf);
1597 	int cnt;
1598 
1599 	spin_lock_irq(&acm->write_lock);
1600 	if (PMSG_IS_AUTO(message)) {
1601 		if (acm->transmitting) {
1602 			spin_unlock_irq(&acm->write_lock);
1603 			return -EBUSY;
1604 		}
1605 	}
1606 	cnt = acm->susp_count++;
1607 	spin_unlock_irq(&acm->write_lock);
1608 
1609 	if (cnt)
1610 		return 0;
1611 
1612 	acm_poison_urbs(acm);
1613 	cancel_delayed_work_sync(&acm->dwork);
1614 	acm->urbs_in_error_delay = 0;
1615 
1616 	return 0;
1617 }
1618 
1619 static int acm_resume(struct usb_interface *intf)
1620 {
1621 	struct acm *acm = usb_get_intfdata(intf);
1622 	struct urb *urb;
1623 	int rv = 0;
1624 
1625 	spin_lock_irq(&acm->write_lock);
1626 
1627 	if (--acm->susp_count)
1628 		goto out;
1629 
1630 	acm_unpoison_urbs(acm);
1631 
1632 	if (tty_port_initialized(&acm->port)) {
1633 		rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1634 
1635 		for (;;) {
1636 			urb = usb_get_from_anchor(&acm->delayed);
1637 			if (!urb)
1638 				break;
1639 
1640 			acm_start_wb(acm, urb->context);
1641 		}
1642 
1643 		/*
1644 		 * delayed error checking because we must
1645 		 * do the write path at all cost
1646 		 */
1647 		if (rv < 0)
1648 			goto out;
1649 
1650 		rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1651 	}
1652 out:
1653 	spin_unlock_irq(&acm->write_lock);
1654 
1655 	return rv;
1656 }
1657 
1658 static int acm_reset_resume(struct usb_interface *intf)
1659 {
1660 	struct acm *acm = usb_get_intfdata(intf);
1661 
1662 	if (tty_port_initialized(&acm->port))
1663 		tty_port_tty_hangup(&acm->port, false);
1664 
1665 	return acm_resume(intf);
1666 }
1667 
1668 #endif /* CONFIG_PM */
1669 
1670 static int acm_pre_reset(struct usb_interface *intf)
1671 {
1672 	struct acm *acm = usb_get_intfdata(intf);
1673 
1674 	clear_bit(EVENT_RX_STALL, &acm->flags);
1675 	acm->nb_index = 0; /* pending control transfers are lost */
1676 
1677 	return 0;
1678 }
1679 
1680 #define NOKIA_PCSUITE_ACM_INFO(x) \
1681 		USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1682 		USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1683 		USB_CDC_ACM_PROTO_VENDOR)
1684 
1685 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1686 		USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1687 		USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1688 		USB_CDC_ACM_PROTO_VENDOR)
1689 
1690 /*
1691  * USB driver structure.
1692  */
1693 
1694 static const struct usb_device_id acm_ids[] = {
1695 	/* quirky and broken devices */
1696 	{ USB_DEVICE(0x0424, 0x274e), /* Microchip Technology, Inc. (formerly SMSC) */
1697 	  .driver_info = DISABLE_ECHO, }, /* DISABLE ECHO in termios flag */
1698 	{ USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1699 	.driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1700 	{ USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1701 	.driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1702 	{ USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1703 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1704 	},
1705 	{ USB_DEVICE(0x045b, 0x023c),	/* Renesas USB Download mode */
1706 	.driver_info = DISABLE_ECHO,	/* Don't echo banner */
1707 	},
1708 	{ USB_DEVICE(0x045b, 0x0248),	/* Renesas USB Download mode */
1709 	.driver_info = DISABLE_ECHO,	/* Don't echo banner */
1710 	},
1711 	{ USB_DEVICE(0x045b, 0x024D),	/* Renesas USB Download mode */
1712 	.driver_info = DISABLE_ECHO,	/* Don't echo banner */
1713 	},
1714 	{ USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1715 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1716 	},
1717 	{ USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1718 	.driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1719 	},
1720 	{ USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1721 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1722 	},
1723 	{ USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1724 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1725 	},
1726 	{ USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1727 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1728 	},
1729 	{ USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1730 	.driver_info = SINGLE_RX_URB,
1731 	},
1732 	{ USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1733 	.driver_info = SINGLE_RX_URB, /* firmware bug */
1734 	},
1735 	{ USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1736 	.driver_info = SINGLE_RX_URB, /* firmware bug */
1737 	},
1738 	{ USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1739 	.driver_info = SINGLE_RX_URB,
1740 	},
1741 	{ USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1742 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1743 	},
1744 	{ USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1745 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1746 	},
1747 	{ USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1748 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1749 	},
1750 	{ USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1751 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1752 	},
1753 	{ USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1754 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1755 	},
1756 	{ USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1757 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1758 	},
1759 	{ USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1760 	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1761 	},
1762 	{ USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1763 	.driver_info = QUIRK_CONTROL_LINE_STATE, },
1764 	{ USB_DEVICE(0x2184, 0x001c) },	/* GW Instek AFG-2225 */
1765 	{ USB_DEVICE(0x2184, 0x0036) },	/* GW Instek AFG-125 */
1766 	{ USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1767 	},
1768 	/* Motorola H24 HSPA module: */
1769 	{ USB_DEVICE(0x22b8, 0x2d91) }, /* modem                                */
1770 	{ USB_DEVICE(0x22b8, 0x2d92),   /* modem           + diagnostics        */
1771 	.driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1772 	},
1773 	{ USB_DEVICE(0x22b8, 0x2d93),   /* modem + AT port                      */
1774 	.driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1775 	},
1776 	{ USB_DEVICE(0x22b8, 0x2d95),   /* modem + AT port + diagnostics        */
1777 	.driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1778 	},
1779 	{ USB_DEVICE(0x22b8, 0x2d96),   /* modem                         + NMEA */
1780 	.driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1781 	},
1782 	{ USB_DEVICE(0x22b8, 0x2d97),   /* modem           + diagnostics + NMEA */
1783 	.driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1784 	},
1785 	{ USB_DEVICE(0x22b8, 0x2d99),   /* modem + AT port               + NMEA */
1786 	.driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1787 	},
1788 	{ USB_DEVICE(0x22b8, 0x2d9a),   /* modem + AT port + diagnostics + NMEA */
1789 	.driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1790 	},
1791 
1792 	{ USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1793 	.driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1794 					   data interface instead of
1795 					   communications interface.
1796 					   Maybe we should define a new
1797 					   quirk for this. */
1798 	},
1799 	{ USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1800 	.driver_info = NO_UNION_NORMAL,
1801 	},
1802 	{ USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1803 	.driver_info = NO_UNION_NORMAL,
1804 	},
1805 	{ USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1806 	.driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1807 	},
1808 	{ USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1809 	.driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1810 	},
1811 	{ USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1812 	.driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1813 	},
1814 	{ USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1815 	.driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1816 	},
1817 	{ USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1818 	.driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1819 	},
1820 
1821 	{ USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1822 	.driver_info = CLEAR_HALT_CONDITIONS,
1823 	},
1824 
1825 	/* Nokia S60 phones expose two ACM channels. The first is
1826 	 * a modem and is picked up by the standard AT-command
1827 	 * information below. The second is 'vendor-specific' but
1828 	 * is treated as a serial device at the S60 end, so we want
1829 	 * to expose it on Linux too. */
1830 	{ NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1831 	{ NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1832 	{ NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1833 	{ NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1834 	{ NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1835 	{ NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1836 	{ NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1837 	{ NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1838 	{ NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1839 	{ NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1840 	{ NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1841 	{ NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1842 	{ NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1843 	{ NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1844 	{ NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1845 	{ NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1846 	{ NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1847 	{ NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i  */
1848 	{ NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1849 	{ NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1850 	{ NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1851 	{ NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic &  */
1852 	{ NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1853 	{ NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1854 	{ NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1855 	{ NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1856 	{ NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1857 	{ NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1858 	{ NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1859 	{ NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1860 	{ NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1861 	{ NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB  */
1862 	{ NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1863 	{ NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1864 	{ NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1865 	{ NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1866 	{ NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1867 	{ NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1868 	{ NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3  */
1869 	{ NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1870 	{ NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1871 	{ NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1872 	{ NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1873 	{ NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1874 	{ NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1875 	{ NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1876 	{ NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1877 	{ NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1878 	{ NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1879 	{ NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1880 	{ NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1881 	{ NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1882 	{ NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1883 	{ NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1884 	{ NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1885 	{ NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1886 	{ SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1887 
1888 	/* Support for Owen devices */
1889 	{ USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1890 
1891 	/* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1892 
1893 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1894 	{ USB_DEVICE(0x04d8, 0x0082),	/* Application mode */
1895 	.driver_info = IGNORE_DEVICE,
1896 	},
1897 	{ USB_DEVICE(0x04d8, 0x0083),	/* Bootloader mode */
1898 	.driver_info = IGNORE_DEVICE,
1899 	},
1900 #endif
1901 
1902 #if IS_ENABLED(CONFIG_IR_TOY)
1903 	{ USB_DEVICE(0x04d8, 0xfd08),
1904 	.driver_info = IGNORE_DEVICE,
1905 	},
1906 
1907 	{ USB_DEVICE(0x04d8, 0xf58b),
1908 	.driver_info = IGNORE_DEVICE,
1909 	},
1910 #endif
1911 
1912 #if IS_ENABLED(CONFIG_USB_SERIAL_XR)
1913 	{ USB_DEVICE(0x04e2, 0x1400), .driver_info = IGNORE_DEVICE },
1914 	{ USB_DEVICE(0x04e2, 0x1401), .driver_info = IGNORE_DEVICE },
1915 	{ USB_DEVICE(0x04e2, 0x1402), .driver_info = IGNORE_DEVICE },
1916 	{ USB_DEVICE(0x04e2, 0x1403), .driver_info = IGNORE_DEVICE },
1917 	{ USB_DEVICE(0x04e2, 0x1410), .driver_info = IGNORE_DEVICE },
1918 	{ USB_DEVICE(0x04e2, 0x1411), .driver_info = IGNORE_DEVICE },
1919 	{ USB_DEVICE(0x04e2, 0x1412), .driver_info = IGNORE_DEVICE },
1920 	{ USB_DEVICE(0x04e2, 0x1414), .driver_info = IGNORE_DEVICE },
1921 	{ USB_DEVICE(0x04e2, 0x1420), .driver_info = IGNORE_DEVICE },
1922 	{ USB_DEVICE(0x04e2, 0x1422), .driver_info = IGNORE_DEVICE },
1923 	{ USB_DEVICE(0x04e2, 0x1424), .driver_info = IGNORE_DEVICE },
1924 #endif
1925 
1926 	/*Samsung phone in firmware update mode */
1927 	{ USB_DEVICE(0x04e8, 0x685d),
1928 	.driver_info = IGNORE_DEVICE,
1929 	},
1930 
1931 	/* Exclude Infineon Flash Loader utility */
1932 	{ USB_DEVICE(0x058b, 0x0041),
1933 	.driver_info = IGNORE_DEVICE,
1934 	},
1935 
1936 	/* Exclude ETAS ES58x */
1937 	{ USB_DEVICE(0x108c, 0x0159), /* ES581.4 */
1938 	.driver_info = IGNORE_DEVICE,
1939 	},
1940 	{ USB_DEVICE(0x108c, 0x0168), /* ES582.1 */
1941 	.driver_info = IGNORE_DEVICE,
1942 	},
1943 	{ USB_DEVICE(0x108c, 0x0169), /* ES584.1 */
1944 	.driver_info = IGNORE_DEVICE,
1945 	},
1946 
1947 	{ USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1948 	.driver_info = SEND_ZERO_PACKET,
1949 	},
1950 	{ USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1951 	.driver_info = SEND_ZERO_PACKET,
1952 	},
1953 
1954 	/* Exclude Goodix Fingerprint Reader */
1955 	{ USB_DEVICE(0x27c6, 0x5395),
1956 	.driver_info = IGNORE_DEVICE,
1957 	},
1958 
1959 	/* Exclude Heimann Sensor GmbH USB appset demo */
1960 	{ USB_DEVICE(0x32a7, 0x0000),
1961 	.driver_info = IGNORE_DEVICE,
1962 	},
1963 
1964 	/* control interfaces without any protocol set */
1965 	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1966 		USB_CDC_PROTO_NONE) },
1967 
1968 	/* control interfaces with various AT-command sets */
1969 	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1970 		USB_CDC_ACM_PROTO_AT_V25TER) },
1971 	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1972 		USB_CDC_ACM_PROTO_AT_PCCA101) },
1973 	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1974 		USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1975 	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1976 		USB_CDC_ACM_PROTO_AT_GSM) },
1977 	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1978 		USB_CDC_ACM_PROTO_AT_3G) },
1979 	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1980 		USB_CDC_ACM_PROTO_AT_CDMA) },
1981 
1982 	{ USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1983 	.driver_info = SEND_ZERO_PACKET,
1984 	},
1985 
1986 	{ }
1987 };
1988 
1989 MODULE_DEVICE_TABLE(usb, acm_ids);
1990 
1991 static struct usb_driver acm_driver = {
1992 	.name =		"cdc_acm",
1993 	.probe =	acm_probe,
1994 	.disconnect =	acm_disconnect,
1995 #ifdef CONFIG_PM
1996 	.suspend =	acm_suspend,
1997 	.resume =	acm_resume,
1998 	.reset_resume =	acm_reset_resume,
1999 #endif
2000 	.pre_reset =	acm_pre_reset,
2001 	.id_table =	acm_ids,
2002 #ifdef CONFIG_PM
2003 	.supports_autosuspend = 1,
2004 #endif
2005 	.disable_hub_initiated_lpm = 1,
2006 };
2007 
2008 /*
2009  * TTY driver structures.
2010  */
2011 
2012 static const struct tty_operations acm_ops = {
2013 	.install =		acm_tty_install,
2014 	.open =			acm_tty_open,
2015 	.close =		acm_tty_close,
2016 	.cleanup =		acm_tty_cleanup,
2017 	.hangup =		acm_tty_hangup,
2018 	.write =		acm_tty_write,
2019 	.write_room =		acm_tty_write_room,
2020 	.ioctl =		acm_tty_ioctl,
2021 	.throttle =		acm_tty_throttle,
2022 	.unthrottle =		acm_tty_unthrottle,
2023 	.chars_in_buffer =	acm_tty_chars_in_buffer,
2024 	.break_ctl =		acm_tty_break_ctl,
2025 	.set_termios =		acm_tty_set_termios,
2026 	.tiocmget =		acm_tty_tiocmget,
2027 	.tiocmset =		acm_tty_tiocmset,
2028 	.get_serial =		get_serial_info,
2029 	.set_serial =		set_serial_info,
2030 	.get_icount =		acm_tty_get_icount,
2031 };
2032 
2033 /*
2034  * Init / exit.
2035  */
2036 
2037 static int __init acm_init(void)
2038 {
2039 	int retval;
2040 	acm_tty_driver = tty_alloc_driver(ACM_TTY_MINORS, TTY_DRIVER_REAL_RAW |
2041 			TTY_DRIVER_DYNAMIC_DEV);
2042 	if (IS_ERR(acm_tty_driver))
2043 		return PTR_ERR(acm_tty_driver);
2044 	acm_tty_driver->driver_name = "acm",
2045 	acm_tty_driver->name = "ttyACM",
2046 	acm_tty_driver->major = ACM_TTY_MAJOR,
2047 	acm_tty_driver->minor_start = 0,
2048 	acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
2049 	acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
2050 	acm_tty_driver->init_termios = tty_std_termios;
2051 	acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
2052 								HUPCL | CLOCAL;
2053 	tty_set_operations(acm_tty_driver, &acm_ops);
2054 
2055 	retval = tty_register_driver(acm_tty_driver);
2056 	if (retval) {
2057 		tty_driver_kref_put(acm_tty_driver);
2058 		return retval;
2059 	}
2060 
2061 	retval = usb_register(&acm_driver);
2062 	if (retval) {
2063 		tty_unregister_driver(acm_tty_driver);
2064 		tty_driver_kref_put(acm_tty_driver);
2065 		return retval;
2066 	}
2067 
2068 	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
2069 
2070 	return 0;
2071 }
2072 
2073 static void __exit acm_exit(void)
2074 {
2075 	usb_deregister(&acm_driver);
2076 	tty_unregister_driver(acm_tty_driver);
2077 	tty_driver_kref_put(acm_tty_driver);
2078 	idr_destroy(&acm_minors);
2079 }
2080 
2081 module_init(acm_init);
2082 module_exit(acm_exit);
2083 
2084 MODULE_AUTHOR(DRIVER_AUTHOR);
2085 MODULE_DESCRIPTION(DRIVER_DESC);
2086 MODULE_LICENSE("GPL");
2087 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);
2088