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