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