cdc-acm.c 37.3 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8
/*
 * cdc-acm.c
 *
 * Copyright (c) 1999 Armin Fuerst	<fuerst@in.tum.de>
 * Copyright (c) 1999 Pavel Machek	<pavel@suse.cz>
 * Copyright (c) 1999 Johannes Erdfelt	<johannes@erdfelt.com>
 * Copyright (c) 2000 Vojtech Pavlik	<vojtech@suse.cz>
 * Copyright (c) 2004 Oliver Neukum	<oliver@neukum.name>
9
 * Copyright (c) 2005 David Kubicek	<dave@awk.cz>
L
Linus Torvalds 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
 *
 * USB Abstract Control Model driver for USB modems and ISDN adapters
 *
 * Sponsored by SuSE
 *
 * ChangeLog:
 *	v0.9  - thorough cleaning, URBification, almost a rewrite
 *	v0.10 - some more cleanups
 *	v0.11 - fixed flow control, read error doesn't stop reads
 *	v0.12 - added TIOCM ioctls, added break handling, made struct acm kmalloced
 *	v0.13 - added termios, added hangup
 *	v0.14 - sized down struct acm
 *	v0.15 - fixed flow control again - characters could be lost
 *	v0.16 - added code for modems with swapped data and control interfaces
 *	v0.17 - added new style probing
 *	v0.18 - fixed new style probing for devices with more configurations
 *	v0.19 - fixed CLOCAL handling (thanks to Richard Shih-Ping Chan)
 *	v0.20 - switched to probing on interface (rather than device) class
 *	v0.21 - revert to probing on device for devices with multiple configs
 *	v0.22 - probe only the control interface. if usbcore doesn't choose the
 *		config we want, sysadmin changes bConfigurationValue in sysfs.
 *	v0.23 - use softirq for rx processing, as needed by tty layer
 *	v0.24 - change probe method to evaluate CDC union descriptor
33
 *	v0.25 - downstream tasks paralelized to maximize throughput
34
 *	v0.26 - multiple write urbs, writesize increased
L
Linus Torvalds 已提交
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
 */

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#undef DEBUG

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/tty.h>
#include <linux/tty_driver.h>
#include <linux/tty_flip.h>
#include <linux/module.h>
63
#include <linux/mutex.h>
L
Linus Torvalds 已提交
64 65
#include <asm/uaccess.h>
#include <linux/usb.h>
66
#include <linux/usb/cdc.h>
L
Linus Torvalds 已提交
67 68
#include <asm/byteorder.h>
#include <asm/unaligned.h>
69
#include <linux/list.h>
L
Linus Torvalds 已提交
70 71 72 73 74 75

#include "cdc-acm.h"

/*
 * Version Information
 */
76
#define DRIVER_VERSION "v0.26"
77
#define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek"
L
Linus Torvalds 已提交
78 79 80 81 82 83
#define DRIVER_DESC "USB Abstract Control Model driver for USB modems and ISDN adapters"

static struct usb_driver acm_driver;
static struct tty_driver *acm_tty_driver;
static struct acm *acm_table[ACM_TTY_MINORS];

84
static DEFINE_MUTEX(open_mutex);
L
Linus Torvalds 已提交
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111

#define ACM_READY(acm)	(acm && acm->dev && acm->used)

/*
 * Functions for ACM control messages.
 */

static int acm_ctrl_msg(struct acm *acm, int request, int value, void *buf, int len)
{
	int retval = usb_control_msg(acm->dev, usb_sndctrlpipe(acm->dev, 0),
		request, USB_RT_ACM, value,
		acm->control->altsetting[0].desc.bInterfaceNumber,
		buf, len, 5000);
	dbg("acm_control_msg: rq: 0x%02x val: %#x len: %#x result: %d", request, value, len, retval);
	return retval < 0 ? retval : 0;
}

/* devices aren't required to support these requests.
 * the cdc acm descriptor tells whether they do...
 */
#define acm_set_control(acm, control) \
	acm_ctrl_msg(acm, USB_CDC_REQ_SET_CONTROL_LINE_STATE, control, NULL, 0)
#define acm_set_line(acm, line) \
	acm_ctrl_msg(acm, USB_CDC_REQ_SET_LINE_CODING, 0, line, sizeof *(line))
#define acm_send_break(acm, ms) \
	acm_ctrl_msg(acm, USB_CDC_REQ_SEND_BREAK, ms, NULL, 0)

112 113 114 115 116 117 118 119 120 121
/*
 * Write buffer management.
 * All of these assume proper locks taken by the caller.
 */

static int acm_wb_alloc(struct acm *acm)
{
	int i, wbn;
	struct acm_wb *wb;

122
	wbn = 0;
123 124 125 126 127 128 129
	i = 0;
	for (;;) {
		wb = &acm->wb[wbn];
		if (!wb->use) {
			wb->use = 1;
			return wbn;
		}
130 131
		wbn = (wbn + 1) % ACM_NW;
		if (++i >= ACM_NW)
132 133 134 135 136 137 138 139
			return -1;
	}
}

static int acm_wb_is_avail(struct acm *acm)
{
	int i, n;

140 141 142
	n = ACM_NW;
	for (i = 0; i < ACM_NW; i++) {
		n -= acm->wb[i].use;
143 144 145 146 147 148 149
	}
	return n;
}

/*
 * Finish write.
 */
150
static void acm_write_done(struct acm *acm, struct acm_wb *wb)
151 152 153 154
{
	unsigned long flags;

	spin_lock_irqsave(&acm->write_lock, flags);
155
	wb->use = 0;
156
	acm->transmitting--;
157 158 159 160 161
	spin_unlock_irqrestore(&acm->write_lock, flags);
}

/*
 * Poke write.
162 163
 *
 * the caller is responsible for locking
164
 */
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183

static int acm_start_wb(struct acm *acm, struct acm_wb *wb)
{
	int rc;

	acm->transmitting++;

	wb->urb->transfer_buffer = wb->buf;
	wb->urb->transfer_dma = wb->dmah;
	wb->urb->transfer_buffer_length = wb->len;
	wb->urb->dev = acm->dev;

	if ((rc = usb_submit_urb(wb->urb, GFP_ATOMIC)) < 0) {
		dbg("usb_submit_urb(write bulk) failed: %d", rc);
		acm_write_done(acm, wb);
	}
	return rc;
}

184
static int acm_write_start(struct acm *acm, int wbn)
185 186
{
	unsigned long flags;
187
	struct acm_wb *wb = &acm->wb[wbn];
188 189 190 191
	int rc;

	spin_lock_irqsave(&acm->write_lock, flags);
	if (!acm->dev) {
192
		wb->use = 0;
193 194 195 196
		spin_unlock_irqrestore(&acm->write_lock, flags);
		return -ENODEV;
	}

197 198 199 200 201 202 203 204 205 206
	dbg("%s susp_count: %d", __func__, acm->susp_count);
	if (acm->susp_count) {
		acm->delayed_wb = wb;
		schedule_work(&acm->waker);
		spin_unlock_irqrestore(&acm->write_lock, flags);
		return 0;	/* A white lie */
	}
	usb_mark_last_busy(acm->dev);

	rc = acm_start_wb(acm, wb);
207 208 209
	spin_unlock_irqrestore(&acm->write_lock, flags);

	return rc;
210

211
}
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
/*
 * attributes exported through sysfs
 */
static ssize_t show_caps
(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct usb_interface *intf = to_usb_interface(dev);
	struct acm *acm = usb_get_intfdata(intf);

	return sprintf(buf, "%d", acm->ctrl_caps);
}
static DEVICE_ATTR(bmCapabilities, S_IRUGO, show_caps, NULL);

static ssize_t show_country_codes
(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct usb_interface *intf = to_usb_interface(dev);
	struct acm *acm = usb_get_intfdata(intf);

	memcpy(buf, acm->country_codes, acm->country_code_size);
	return acm->country_code_size;
}

static DEVICE_ATTR(wCountryCodes, S_IRUGO, show_country_codes, NULL);

static ssize_t show_country_rel_date
(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct usb_interface *intf = to_usb_interface(dev);
	struct acm *acm = usb_get_intfdata(intf);

	return sprintf(buf, "%d", acm->country_rel_date);
}
245

246
static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
L
Linus Torvalds 已提交
247 248 249 250 251
/*
 * Interrupt handlers for various ACM device responses
 */

/* control interface reports status changes with "interrupt" transfers */
252
static void acm_ctrl_irq(struct urb *urb)
L
Linus Torvalds 已提交
253 254 255 256 257
{
	struct acm *acm = urb->context;
	struct usb_cdc_notification *dr = urb->transfer_buffer;
	unsigned char *data;
	int newctrl;
258 259
	int retval;
	int status = urb->status;
L
Linus Torvalds 已提交
260

261
	switch (status) {
L
Linus Torvalds 已提交
262 263 264 265 266 267 268
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
269
		dbg("%s - urb shutting down with status: %d", __func__, status);
L
Linus Torvalds 已提交
270 271
		return;
	default:
272
		dbg("%s - nonzero urb status received: %d", __func__, status);
L
Linus Torvalds 已提交
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
		goto exit;
	}

	if (!ACM_READY(acm))
		goto exit;

	data = (unsigned char *)(dr + 1);
	switch (dr->bNotificationType) {

		case USB_CDC_NOTIFY_NETWORK_CONNECTION:

			dbg("%s network", dr->wValue ? "connected to" : "disconnected from");
			break;

		case USB_CDC_NOTIFY_SERIAL_STATE:

289
			newctrl = get_unaligned_le16(data);
L
Linus Torvalds 已提交
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312

			if (acm->tty && !acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
				dbg("calling hangup");
				tty_hangup(acm->tty);
			}

			acm->ctrlin = newctrl;

			dbg("input control lines: dcd%c dsr%c break%c ring%c framing%c parity%c overrun%c",
				acm->ctrlin & ACM_CTRL_DCD ? '+' : '-',	acm->ctrlin & ACM_CTRL_DSR ? '+' : '-',
				acm->ctrlin & ACM_CTRL_BRK ? '+' : '-',	acm->ctrlin & ACM_CTRL_RI  ? '+' : '-',
				acm->ctrlin & ACM_CTRL_FRAMING ? '+' : '-',	acm->ctrlin & ACM_CTRL_PARITY ? '+' : '-',
				acm->ctrlin & ACM_CTRL_OVERRUN ? '+' : '-');

			break;

		default:
			dbg("unknown notification %d received: index %d len %d data0 %d data1 %d",
				dr->bNotificationType, dr->wIndex,
				dr->wLength, data[0], data[1]);
			break;
	}
exit:
313
	usb_mark_last_busy(acm->dev);
314 315
	retval = usb_submit_urb (urb, GFP_ATOMIC);
	if (retval)
L
Linus Torvalds 已提交
316
		err ("%s - usb_submit_urb failed with result %d",
317
		     __func__, retval);
L
Linus Torvalds 已提交
318 319 320
}

/* data interface returns incoming bytes, or we got unthrottled */
321
static void acm_read_bulk(struct urb *urb)
L
Linus Torvalds 已提交
322
{
323 324 325
	struct acm_rb *buf;
	struct acm_ru *rcv = urb->context;
	struct acm *acm = rcv->instance;
326
	int status = urb->status;
327 328

	dbg("Entering acm_read_bulk with status %d", status);
L
Linus Torvalds 已提交
329

330 331
	if (!ACM_READY(acm)) {
		dev_dbg(&acm->data->dev, "Aborting, acm not ready");
L
Linus Torvalds 已提交
332
		return;
333 334
	}
	usb_mark_last_busy(acm->dev);
L
Linus Torvalds 已提交
335

336
	if (status)
337
		dev_dbg(&acm->data->dev, "bulk rx status %d\n", status);
L
Linus Torvalds 已提交
338

339 340 341
	buf = rcv->buffer;
	buf->size = urb->actual_length;

342 343
	if (likely(status == 0)) {
		spin_lock(&acm->read_lock);
344
		acm->processing++;
345 346 347 348 349 350 351 352 353 354 355 356
		list_add_tail(&rcv->list, &acm->spare_read_urbs);
		list_add_tail(&buf->list, &acm->filled_read_bufs);
		spin_unlock(&acm->read_lock);
	} else {
		/* we drop the buffer due to an error */
		spin_lock(&acm->read_lock);
		list_add_tail(&rcv->list, &acm->spare_read_urbs);
		list_add(&buf->list, &acm->spare_read_bufs);
		spin_unlock(&acm->read_lock);
		/* nevertheless the tasklet must be kicked unconditionally
		so the queue cannot dry up */
	}
357 358
	if (likely(!acm->susp_count))
		tasklet_schedule(&acm->urb_task);
L
Linus Torvalds 已提交
359 360 361 362 363
}

static void acm_rx_tasklet(unsigned long _acm)
{
	struct acm *acm = (void *)_acm;
364
	struct acm_rb *buf;
L
Linus Torvalds 已提交
365
	struct tty_struct *tty = acm->tty;
366
	struct acm_ru *rcv;
367
	unsigned long flags;
368
	unsigned char throttled;
369

L
Linus Torvalds 已提交
370 371
	dbg("Entering acm_rx_tasklet");

372
	if (!ACM_READY(acm))
373 374
	{
		dbg("acm_rx_tasklet: ACM not ready");
375
		return;
376
	}
377

378
	spin_lock_irqsave(&acm->throttle_lock, flags);
379
	throttled = acm->throttle;
380
	spin_unlock_irqrestore(&acm->throttle_lock, flags);
381
	if (throttled)
382 383
	{
		dbg("acm_rx_tasklet: throttled");
384
		return;
385
	}
386 387

next_buffer:
388
	spin_lock_irqsave(&acm->read_lock, flags);
389
	if (list_empty(&acm->filled_read_bufs)) {
390
		spin_unlock_irqrestore(&acm->read_lock, flags);
391
		goto urbs;
L
Linus Torvalds 已提交
392
	}
393 394 395
	buf = list_entry(acm->filled_read_bufs.next,
			 struct acm_rb, list);
	list_del(&buf->list);
396
	spin_unlock_irqrestore(&acm->read_lock, flags);
397

398
	dbg("acm_rx_tasklet: procesing buf 0x%p, size = %d", buf, buf->size);
399

A
Alan Cox 已提交
400
	tty_buffer_request_room(tty, buf->size);
401
	spin_lock_irqsave(&acm->throttle_lock, flags);
402
	throttled = acm->throttle;
403
	spin_unlock_irqrestore(&acm->throttle_lock, flags);
404
	if (!throttled)
A
Alan Cox 已提交
405
		tty_insert_flip_string(tty, buf->base, buf->size);
406
	tty_flip_buffer_push(tty);
L
Linus Torvalds 已提交
407

408 409
	if (throttled) {
		dbg("Throttling noticed");
410
		spin_lock_irqsave(&acm->read_lock, flags);
411
		list_add(&buf->list, &acm->filled_read_bufs);
412
		spin_unlock_irqrestore(&acm->read_lock, flags);
L
Linus Torvalds 已提交
413 414 415
		return;
	}

416
	spin_lock_irqsave(&acm->read_lock, flags);
417
	list_add(&buf->list, &acm->spare_read_bufs);
418
	spin_unlock_irqrestore(&acm->read_lock, flags);
419 420 421 422
	goto next_buffer;

urbs:
	while (!list_empty(&acm->spare_read_bufs)) {
423
		spin_lock_irqsave(&acm->read_lock, flags);
424
		if (list_empty(&acm->spare_read_urbs)) {
425
			acm->processing = 0;
426
			spin_unlock_irqrestore(&acm->read_lock, flags);
427 428 429 430 431
			return;
		}
		rcv = list_entry(acm->spare_read_urbs.next,
				 struct acm_ru, list);
		list_del(&rcv->list);
432
		spin_unlock_irqrestore(&acm->read_lock, flags);
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449

		buf = list_entry(acm->spare_read_bufs.next,
				 struct acm_rb, list);
		list_del(&buf->list);

		rcv->buffer = buf;

		usb_fill_bulk_urb(rcv->urb, acm->dev,
				  acm->rx_endpoint,
				  buf->base,
				  acm->readsize,
				  acm_read_bulk, rcv);
		rcv->urb->transfer_dma = buf->dma;
		rcv->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

		/* This shouldn't kill the driver as unsuccessful URBs are returned to the
		   free-urbs-pool and resubmited ASAP */
450 451
		spin_lock_irqsave(&acm->read_lock, flags);
		if (acm->susp_count || usb_submit_urb(rcv->urb, GFP_ATOMIC) < 0) {
452 453
			list_add(&buf->list, &acm->spare_read_bufs);
			list_add(&rcv->list, &acm->spare_read_urbs);
454
			acm->processing = 0;
455
			spin_unlock_irqrestore(&acm->read_lock, flags);
456
			return;
457 458 459
		} else {
			spin_unlock_irqrestore(&acm->read_lock, flags);
			dbg("acm_rx_tasklet: sending urb 0x%p, rcv 0x%p, buf 0x%p", rcv->urb, rcv, buf);
460 461
		}
	}
462 463 464
	spin_lock_irqsave(&acm->read_lock, flags);
	acm->processing = 0;
	spin_unlock_irqrestore(&acm->read_lock, flags);
L
Linus Torvalds 已提交
465 466 467
}

/* data interface wrote those outgoing bytes */
468
static void acm_write_bulk(struct urb *urb)
L
Linus Torvalds 已提交
469
{
470
	struct acm *acm;
471
	struct acm_wb *wb = urb->context;
L
Linus Torvalds 已提交
472

473
	dbg("Entering acm_write_bulk with status %d", urb->status);
L
Linus Torvalds 已提交
474

475 476
	acm = wb->instance;
	acm_write_done(acm, wb);
477 478
	if (ACM_READY(acm))
		schedule_work(&acm->work);
L
Linus Torvalds 已提交
479 480
}

D
David Howells 已提交
481
static void acm_softint(struct work_struct *work)
L
Linus Torvalds 已提交
482
{
D
David Howells 已提交
483
	struct acm *acm = container_of(work, struct acm, work);
484
	dbg("Entering acm_softint.");
L
Linus Torvalds 已提交
485 486 487 488 489 490
	
	if (!ACM_READY(acm))
		return;
	tty_wakeup(acm->tty);
}

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
static void acm_waker(struct work_struct *waker)
{
	struct acm *acm = container_of(waker, struct acm, waker);
	int rv;

	rv = usb_autopm_get_interface(acm->control);
	if (rv < 0) {
		err("Autopm failure in %s", __func__);
		return;
	}
	if (acm->delayed_wb) {
		acm_start_wb(acm, acm->delayed_wb);
		acm->delayed_wb = NULL;
	}
	usb_autopm_put_interface(acm->control);
}

L
Linus Torvalds 已提交
508 509 510 511 512 513 514 515
/*
 * TTY handlers
 */

static int acm_tty_open(struct tty_struct *tty, struct file *filp)
{
	struct acm *acm;
	int rv = -EINVAL;
516
	int i;
517
	dbg("Entering acm_tty_open.");
518 519

	mutex_lock(&open_mutex);
L
Linus Torvalds 已提交
520 521 522 523 524 525 526

	acm = acm_table[tty->index];
	if (!acm || !acm->dev)
		goto err_out;
	else
		rv = 0;

527
	set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
L
Linus Torvalds 已提交
528 529 530
	tty->driver_data = acm;
	acm->tty = tty;

531 532 533
	/* force low_latency on so that our tty_push actually forces the data through,
	   otherwise it is scheduled, and with high data rates data can get lost. */
	tty->low_latency = 1;
L
Linus Torvalds 已提交
534

535 536
	if (usb_autopm_get_interface(acm->control) < 0)
		goto early_bail;
537 538
	else
		acm->control->needs_remote_wakeup = 1;
O
Oliver Neukum 已提交
539 540

	mutex_lock(&acm->mutex);
L
Linus Torvalds 已提交
541
	if (acm->used++) {
O
Oliver Neukum 已提交
542
		usb_autopm_put_interface(acm->control);
L
Linus Torvalds 已提交
543 544 545
		goto done;
        }

O
Oliver Neukum 已提交
546

L
Linus Torvalds 已提交
547 548 549 550 551 552
	acm->ctrlurb->dev = acm->dev;
	if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
		dbg("usb_submit_urb(ctrl irq) failed");
		goto bail_out;
	}

553 554
	if (0 > acm_set_control(acm, acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS) &&
	    (acm->ctrl_caps & USB_CDC_CAP_LINE))
L
Linus Torvalds 已提交
555
		goto full_bailout;
556
	usb_autopm_put_interface(acm->control);
L
Linus Torvalds 已提交
557

558 559 560
	INIT_LIST_HEAD(&acm->spare_read_urbs);
	INIT_LIST_HEAD(&acm->spare_read_bufs);
	INIT_LIST_HEAD(&acm->filled_read_bufs);
561
	for (i = 0; i < acm->rx_buflimit; i++) {
562 563
		list_add(&(acm->ru[i].list), &acm->spare_read_urbs);
	}
564
	for (i = 0; i < acm->rx_buflimit; i++) {
565 566 567
		list_add(&(acm->rb[i].list), &acm->spare_read_bufs);
	}

568 569
	acm->throttle = 0;

570
	tasklet_schedule(&acm->urb_task);
L
Linus Torvalds 已提交
571 572 573

done:
err_out:
O
Oliver Neukum 已提交
574
	mutex_unlock(&acm->mutex);
575
	mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
576 577 578 579 580
	return rv;

full_bailout:
	usb_kill_urb(acm->ctrlurb);
bail_out:
O
Oliver Neukum 已提交
581
	usb_autopm_put_interface(acm->control);
L
Linus Torvalds 已提交
582
	acm->used--;
O
Oliver Neukum 已提交
583
	mutex_unlock(&acm->mutex);
584 585
early_bail:
	mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
586 587 588
	return -EIO;
}

589 590
static void acm_tty_unregister(struct acm *acm)
{
591
	int i,nr;
592

593
	nr = acm->rx_buflimit;
594 595 596 597
	tty_unregister_device(acm_tty_driver, acm->minor);
	usb_put_intf(acm->control);
	acm_table[acm->minor] = NULL;
	usb_free_urb(acm->ctrlurb);
598 599
	for (i = 0; i < ACM_NW; i++)
		usb_free_urb(acm->wb[i].urb);
600
	for (i = 0; i < nr; i++)
601
		usb_free_urb(acm->ru[i].urb);
602
	kfree(acm->country_codes);
603 604 605
	kfree(acm);
}

L
Linus Torvalds 已提交
606 607 608
static void acm_tty_close(struct tty_struct *tty, struct file *filp)
{
	struct acm *acm = tty->driver_data;
609
	int i,nr;
L
Linus Torvalds 已提交
610 611 612 613

	if (!acm || !acm->used)
		return;

614
	nr = acm->rx_buflimit;
615
	mutex_lock(&open_mutex);
L
Linus Torvalds 已提交
616 617
	if (!--acm->used) {
		if (acm->dev) {
618
			usb_autopm_get_interface(acm->control);
L
Linus Torvalds 已提交
619 620
			acm_set_control(acm, acm->ctrlout = 0);
			usb_kill_urb(acm->ctrlurb);
621 622
			for (i = 0; i < ACM_NW; i++)
				usb_kill_urb(acm->wb[i].urb);
623
			for (i = 0; i < nr; i++)
624
				usb_kill_urb(acm->ru[i].urb);
625
			acm->control->needs_remote_wakeup = 0;
O
Oliver Neukum 已提交
626
			usb_autopm_put_interface(acm->control);
627 628
		} else
			acm_tty_unregister(acm);
L
Linus Torvalds 已提交
629
	}
630
	mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
631 632 633 634 635 636
}

static int acm_tty_write(struct tty_struct *tty, const unsigned char *buf, int count)
{
	struct acm *acm = tty->driver_data;
	int stat;
637 638 639 640
	unsigned long flags;
	int wbn;
	struct acm_wb *wb;

641
	dbg("Entering acm_tty_write to write %d bytes,", count);
L
Linus Torvalds 已提交
642 643 644 645 646 647

	if (!ACM_READY(acm))
		return -EINVAL;
	if (!count)
		return 0;

648 649 650 651 652 653
	spin_lock_irqsave(&acm->write_lock, flags);
	if ((wbn = acm_wb_alloc(acm)) < 0) {
		spin_unlock_irqrestore(&acm->write_lock, flags);
		return 0;
	}
	wb = &acm->wb[wbn];
L
Linus Torvalds 已提交
654

655
	count = (count > acm->writesize) ? acm->writesize : count;
L
Linus Torvalds 已提交
656
	dbg("Get %d bytes...", count);
657 658 659
	memcpy(wb->buf, buf, count);
	wb->len = count;
	spin_unlock_irqrestore(&acm->write_lock, flags);
L
Linus Torvalds 已提交
660

661
	if ((stat = acm_write_start(acm, wbn)) < 0)
L
Linus Torvalds 已提交
662 663 664 665 666 667 668 669 670
		return stat;
	return count;
}

static int acm_tty_write_room(struct tty_struct *tty)
{
	struct acm *acm = tty->driver_data;
	if (!ACM_READY(acm))
		return -EINVAL;
671 672 673 674
	/*
	 * Do not let the line discipline to know that we have a reserve,
	 * or it might get too enthusiastic.
	 */
675
	return acm_wb_is_avail(acm) ? acm->writesize : 0;
L
Linus Torvalds 已提交
676 677 678 679 680 681 682
}

static int acm_tty_chars_in_buffer(struct tty_struct *tty)
{
	struct acm *acm = tty->driver_data;
	if (!ACM_READY(acm))
		return -EINVAL;
683 684 685
	/*
	 * This is inaccurate (overcounts), but it works.
	 */
686
	return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
L
Linus Torvalds 已提交
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
}

static void acm_tty_throttle(struct tty_struct *tty)
{
	struct acm *acm = tty->driver_data;
	if (!ACM_READY(acm))
		return;
	spin_lock_bh(&acm->throttle_lock);
	acm->throttle = 1;
	spin_unlock_bh(&acm->throttle_lock);
}

static void acm_tty_unthrottle(struct tty_struct *tty)
{
	struct acm *acm = tty->driver_data;
	if (!ACM_READY(acm))
		return;
	spin_lock_bh(&acm->throttle_lock);
	acm->throttle = 0;
	spin_unlock_bh(&acm->throttle_lock);
707
	tasklet_schedule(&acm->urb_task);
L
Linus Torvalds 已提交
708 709
}

A
Alan Cox 已提交
710
static int acm_tty_break_ctl(struct tty_struct *tty, int state)
L
Linus Torvalds 已提交
711 712
{
	struct acm *acm = tty->driver_data;
A
Alan Cox 已提交
713
	int retval;
L
Linus Torvalds 已提交
714
	if (!ACM_READY(acm))
A
Alan Cox 已提交
715 716 717
		return -EINVAL;
	retval = acm_send_break(acm, state ? 0xffff : 0);
	if (retval < 0)
L
Linus Torvalds 已提交
718
		dbg("send break failed");
A
Alan Cox 已提交
719
	return retval;
L
Linus Torvalds 已提交
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
}

static int acm_tty_tiocmget(struct tty_struct *tty, struct file *file)
{
	struct acm *acm = tty->driver_data;

	if (!ACM_READY(acm))
		return -EINVAL;

	return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
	       (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
	       (acm->ctrlin  & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
	       (acm->ctrlin  & ACM_CTRL_RI  ? TIOCM_RI  : 0) |
	       (acm->ctrlin  & ACM_CTRL_DCD ? TIOCM_CD  : 0) |
	       TIOCM_CTS;
}

static int acm_tty_tiocmset(struct tty_struct *tty, struct file *file,
			    unsigned int set, unsigned int clear)
{
	struct acm *acm = tty->driver_data;
	unsigned int newctrl;

	if (!ACM_READY(acm))
		return -EINVAL;

	newctrl = acm->ctrlout;
	set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) | (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
	clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) | (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);

	newctrl = (newctrl & ~clear) | set;

	if (acm->ctrlout == newctrl)
		return 0;
	return acm_set_control(acm, acm->ctrlout = newctrl);
}

static int acm_tty_ioctl(struct tty_struct *tty, struct file *file, unsigned int cmd, unsigned long arg)
{
	struct acm *acm = tty->driver_data;

	if (!ACM_READY(acm))
		return -EINVAL;

	return -ENOIOCTLCMD;
}

767
static const __u32 acm_tty_speed[] = {
L
Linus Torvalds 已提交
768 769 770 771 772 773 774
	0, 50, 75, 110, 134, 150, 200, 300, 600,
	1200, 1800, 2400, 4800, 9600, 19200, 38400,
	57600, 115200, 230400, 460800, 500000, 576000,
	921600, 1000000, 1152000, 1500000, 2000000,
	2500000, 3000000, 3500000, 4000000
};

775
static const __u8 acm_tty_size[] = {
L
Linus Torvalds 已提交
776 777 778
	5, 6, 7, 8
};

A
Alan Cox 已提交
779
static void acm_tty_set_termios(struct tty_struct *tty, struct ktermios *termios_old)
L
Linus Torvalds 已提交
780 781
{
	struct acm *acm = tty->driver_data;
A
Alan Cox 已提交
782
	struct ktermios *termios = tty->termios;
L
Linus Torvalds 已提交
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
	struct usb_cdc_line_coding newline;
	int newctrl = acm->ctrlout;

	if (!ACM_READY(acm))
		return;

	newline.dwDTERate = cpu_to_le32p(acm_tty_speed +
		(termios->c_cflag & CBAUD & ~CBAUDEX) + (termios->c_cflag & CBAUDEX ? 15 : 0));
	newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
	newline.bParityType = termios->c_cflag & PARENB ?
		(termios->c_cflag & PARODD ? 1 : 2) + (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
	newline.bDataBits = acm_tty_size[(termios->c_cflag & CSIZE) >> 4];

	acm->clocal = ((termios->c_cflag & CLOCAL) != 0);

	if (!newline.dwDTERate) {
		newline.dwDTERate = acm->line.dwDTERate;
		newctrl &= ~ACM_CTRL_DTR;
	} else  newctrl |=  ACM_CTRL_DTR;

	if (newctrl != acm->ctrlout)
		acm_set_control(acm, acm->ctrlout = newctrl);

	if (memcmp(&acm->line, &newline, sizeof newline)) {
		memcpy(&acm->line, &newline, sizeof newline);
		dbg("set line: %d %d %d %d", le32_to_cpu(newline.dwDTERate),
			newline.bCharFormat, newline.bParityType,
			newline.bDataBits);
		acm_set_line(acm, &acm->line);
	}
}

/*
 * USB probe and disconnect routines.
 */

819
/* Little helpers: write/read buffers free */
820 821 822 823 824
static void acm_write_buffers_free(struct acm *acm)
{
	int i;
	struct acm_wb *wb;

825
	for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
826 827 828 829
		usb_buffer_free(acm->dev, acm->writesize, wb->buf, wb->dmah);
	}
}

830 831 832 833 834 835 836 837 838
static void acm_read_buffers_free(struct acm *acm)
{
	struct usb_device *usb_dev = interface_to_usbdev(acm->control);
	int i, n = acm->rx_buflimit;

	for (i = 0; i < n; i++)
		usb_buffer_free(usb_dev, acm->readsize, acm->rb[i].base, acm->rb[i].dma);
}

839 840 841 842 843 844
/* Little helper: write buffers allocate */
static int acm_write_buffers_alloc(struct acm *acm)
{
	int i;
	struct acm_wb *wb;

845
	for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
		wb->buf = usb_buffer_alloc(acm->dev, acm->writesize, GFP_KERNEL,
		    &wb->dmah);
		if (!wb->buf) {
			while (i != 0) {
				--i;
				--wb;
				usb_buffer_free(acm->dev, acm->writesize,
				    wb->buf, wb->dmah);
			}
			return -ENOMEM;
		}
	}
	return 0;
}

L
Linus Torvalds 已提交
861 862 863 864
static int acm_probe (struct usb_interface *intf,
		      const struct usb_device_id *id)
{
	struct usb_cdc_union_desc *union_header = NULL;
865
	struct usb_cdc_country_functional_desc *cfd = NULL;
D
David Brownell 已提交
866
	unsigned char *buffer = intf->altsetting->extra;
L
Linus Torvalds 已提交
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
	int buflen = intf->altsetting->extralen;
	struct usb_interface *control_interface;
	struct usb_interface *data_interface;
	struct usb_endpoint_descriptor *epctrl;
	struct usb_endpoint_descriptor *epread;
	struct usb_endpoint_descriptor *epwrite;
	struct usb_device *usb_dev = interface_to_usbdev(intf);
	struct acm *acm;
	int minor;
	int ctrlsize,readsize;
	u8 *buf;
	u8 ac_management_function = 0;
	u8 call_management_function = 0;
	int call_interface_num = -1;
	int data_interface_num;
	unsigned long quirks;
883
	int num_rx_buf;
884
	int i;
L
Linus Torvalds 已提交
885

886
	/* normal quirks */
L
Linus Torvalds 已提交
887
	quirks = (unsigned long)id->driver_info;
888 889 890
	num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;

	/* handle quirks deadly to normal probing*/
L
Linus Torvalds 已提交
891 892 893 894 895 896 897 898
	if (quirks == NO_UNION_NORMAL) {
		data_interface = usb_ifnum_to_if(usb_dev, 1);
		control_interface = usb_ifnum_to_if(usb_dev, 0);
		goto skip_normal_probe;
	}
	
	/* normal probing*/
	if (!buffer) {
899
		err("Weird descriptor references\n");
L
Linus Torvalds 已提交
900 901 902 903 904
		return -EINVAL;
	}

	if (!buflen) {
		if (intf->cur_altsetting->endpoint->extralen && intf->cur_altsetting->endpoint->extra) {
905
			dev_dbg(&intf->dev,"Seeking extra descriptors on endpoint\n");
L
Linus Torvalds 已提交
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
			buflen = intf->cur_altsetting->endpoint->extralen;
			buffer = intf->cur_altsetting->endpoint->extra;
		} else {
			err("Zero length descriptor references\n");
			return -EINVAL;
		}
	}

	while (buflen > 0) {
		if (buffer [1] != USB_DT_CS_INTERFACE) {
			err("skipping garbage\n");
			goto next_desc;
		}

		switch (buffer [2]) {
			case USB_CDC_UNION_TYPE: /* we've found it */
				if (union_header) {
					err("More than one union descriptor, skipping ...");
					goto next_desc;
				}
				union_header = (struct usb_cdc_union_desc *)
							buffer;
				break;
929 930 931
			case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
				cfd = (struct usb_cdc_country_functional_desc *)buffer;
				break;
L
Linus Torvalds 已提交
932 933 934 935 936 937 938 939 940 941 942 943
			case USB_CDC_HEADER_TYPE: /* maybe check version */ 
				break; /* for now we ignore it */ 
			case USB_CDC_ACM_TYPE:
				ac_management_function = buffer[3];
				break;
			case USB_CDC_CALL_MANAGEMENT_TYPE:
				call_management_function = buffer[3];
				call_interface_num = buffer[4];
				if ((call_management_function & 3) != 3)
					err("This device cannot do calls on its own. It is no modem.");
				break;
			default:
D
David Brownell 已提交
944 945 946 947 948 949
				/* there are LOTS more CDC descriptors that
				 * could legitimately be found here.
				 */
				dev_dbg(&intf->dev, "Ignoring descriptor: "
						"type %02x, length %d\n",
						buffer[2], buffer[0]);
L
Linus Torvalds 已提交
950 951 952 953 954 955 956 957 958
				break;
			}
next_desc:
		buflen -= buffer[0];
		buffer += buffer[0];
	}

	if (!union_header) {
		if (call_interface_num > 0) {
959
			dev_dbg(&intf->dev,"No union descriptor, using call management descriptor\n");
L
Linus Torvalds 已提交
960 961 962
			data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
			control_interface = intf;
		} else {
963
			dev_dbg(&intf->dev,"No union descriptor, giving up\n");
L
Linus Torvalds 已提交
964 965 966 967 968 969
			return -ENODEV;
		}
	} else {
		control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
		data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = union_header->bSlaveInterface0));
		if (!control_interface || !data_interface) {
970
			dev_dbg(&intf->dev,"no interfaces\n");
L
Linus Torvalds 已提交
971 972 973 974 975
			return -ENODEV;
		}
	}
	
	if (data_interface_num != call_interface_num)
J
Joe Perches 已提交
976
		dev_dbg(&intf->dev,"Separate call control interface. That is not fully supported.\n");
L
Linus Torvalds 已提交
977 978 979 980 981 982 983

skip_normal_probe:

	/*workaround for switched interfaces */
	if (data_interface->cur_altsetting->desc.bInterfaceClass != CDC_DATA_INTERFACE_TYPE) {
		if (control_interface->cur_altsetting->desc.bInterfaceClass == CDC_DATA_INTERFACE_TYPE) {
			struct usb_interface *t;
984
			dev_dbg(&intf->dev,"Your device has switched interfaces.\n");
L
Linus Torvalds 已提交
985 986 987 988 989 990 991 992

			t = control_interface;
			control_interface = data_interface;
			data_interface = t;
		} else {
			return -EINVAL;
		}
	}
993 994 995 996

	/* Accept probe requests only for the control interface */
	if (intf != control_interface)
		return -ENODEV;
L
Linus Torvalds 已提交
997 998
	
	if (usb_interface_claimed(data_interface)) { /* valid in this context */
999
		dev_dbg(&intf->dev,"The data interface isn't available\n");
L
Linus Torvalds 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
		return -EBUSY;
	}


	if (data_interface->cur_altsetting->desc.bNumEndpoints < 2)
		return -EINVAL;

	epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
	epread = &data_interface->cur_altsetting->endpoint[0].desc;
	epwrite = &data_interface->cur_altsetting->endpoint[1].desc;


	/* workaround for switched endpoints */
1013
	if (!usb_endpoint_dir_in(epread)) {
L
Linus Torvalds 已提交
1014 1015
		/* descriptors are swapped */
		struct usb_endpoint_descriptor *t;
1016
		dev_dbg(&intf->dev,"The data interface has switched endpoints\n");
L
Linus Torvalds 已提交
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
		
		t = epread;
		epread = epwrite;
		epwrite = t;
	}
	dbg("interfaces are valid");
	for (minor = 0; minor < ACM_TTY_MINORS && acm_table[minor]; minor++);

	if (minor == ACM_TTY_MINORS) {
		err("no more free acm devices");
		return -ENODEV;
	}

1030
	if (!(acm = kzalloc(sizeof(struct acm), GFP_KERNEL))) {
1031
		dev_dbg(&intf->dev, "out of memory (acm kzalloc)\n");
L
Linus Torvalds 已提交
1032 1033 1034 1035
		goto alloc_fail;
	}

	ctrlsize = le16_to_cpu(epctrl->wMaxPacketSize);
1036
	readsize = le16_to_cpu(epread->wMaxPacketSize)* ( quirks == SINGLE_RX_URB ? 1 : 2);
1037
	acm->writesize = le16_to_cpu(epwrite->wMaxPacketSize) * 20;
L
Linus Torvalds 已提交
1038 1039 1040 1041 1042 1043 1044
	acm->control = control_interface;
	acm->data = data_interface;
	acm->minor = minor;
	acm->dev = usb_dev;
	acm->ctrl_caps = ac_management_function;
	acm->ctrlsize = ctrlsize;
	acm->readsize = readsize;
1045
	acm->rx_buflimit = num_rx_buf;
1046 1047
	acm->urb_task.func = acm_rx_tasklet;
	acm->urb_task.data = (unsigned long) acm;
D
David Howells 已提交
1048
	INIT_WORK(&acm->work, acm_softint);
1049
	INIT_WORK(&acm->waker, acm_waker);
L
Linus Torvalds 已提交
1050
	spin_lock_init(&acm->throttle_lock);
1051
	spin_lock_init(&acm->write_lock);
1052
	spin_lock_init(&acm->read_lock);
O
Oliver Neukum 已提交
1053
	mutex_init(&acm->mutex);
1054
	acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
L
Linus Torvalds 已提交
1055 1056 1057

	buf = usb_buffer_alloc(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
	if (!buf) {
1058
		dev_dbg(&intf->dev, "out of memory (ctrl buffer alloc)\n");
L
Linus Torvalds 已提交
1059 1060 1061 1062
		goto alloc_fail2;
	}
	acm->ctrl_buffer = buf;

1063
	if (acm_write_buffers_alloc(acm) < 0) {
1064
		dev_dbg(&intf->dev, "out of memory (write buffer alloc)\n");
L
Linus Torvalds 已提交
1065 1066 1067 1068 1069
		goto alloc_fail4;
	}

	acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
	if (!acm->ctrlurb) {
1070
		dev_dbg(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
L
Linus Torvalds 已提交
1071 1072
		goto alloc_fail5;
	}
1073
	for (i = 0; i < num_rx_buf; i++) {
1074 1075 1076
		struct acm_ru *rcv = &(acm->ru[i]);

		if (!(rcv->urb = usb_alloc_urb(0, GFP_KERNEL))) {
1077
			dev_dbg(&intf->dev, "out of memory (read urbs usb_alloc_urb)\n");
1078 1079 1080 1081 1082 1083
			goto alloc_fail7;
		}

		rcv->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
		rcv->instance = acm;
	}
1084
	for (i = 0; i < num_rx_buf; i++) {
D
David Brownell 已提交
1085
		struct acm_rb *rb = &(acm->rb[i]);
1086

D
David Brownell 已提交
1087 1088 1089
		rb->base = usb_buffer_alloc(acm->dev, readsize,
				GFP_KERNEL, &rb->dma);
		if (!rb->base) {
1090
			dev_dbg(&intf->dev, "out of memory (read bufs usb_buffer_alloc)\n");
1091 1092
			goto alloc_fail7;
		}
L
Linus Torvalds 已提交
1093
	}
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
	for(i = 0; i < ACM_NW; i++)
	{
		struct acm_wb *snd = &(acm->wb[i]);

		if (!(snd->urb = usb_alloc_urb(0, GFP_KERNEL))) {
			dev_dbg(&intf->dev, "out of memory (write urbs usb_alloc_urb)");
			goto alloc_fail7;
		}

		usb_fill_bulk_urb(snd->urb, usb_dev, usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress),
				NULL, acm->writesize, acm_write_bulk, snd);
		snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
		snd->instance = acm;
L
Linus Torvalds 已提交
1107 1108
	}

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
	usb_set_intfdata (intf, acm);

	i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
	if (i < 0)
		goto alloc_fail8;

	if (cfd) { /* export the country data */
		acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
		if (!acm->country_codes)
			goto skip_countries;
		acm->country_code_size = cfd->bLength - 4;
		memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0, cfd->bLength - 4);
		acm->country_rel_date = cfd->iCountryCodeRelDate;

		i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
		if (i < 0) {
			kfree(acm->country_codes);
			goto skip_countries;
		}

		i = device_create_file(&intf->dev, &dev_attr_iCountryCodeRelDate);
		if (i < 0) {
			kfree(acm->country_codes);
			goto skip_countries;
		}
	}

skip_countries:
L
Linus Torvalds 已提交
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
	usb_fill_int_urb(acm->ctrlurb, usb_dev, usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
			 acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm, epctrl->bInterval);
	acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
	acm->ctrlurb->transfer_dma = acm->ctrl_dma;

	dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);

	acm_set_control(acm, acm->ctrlout);

	acm->line.dwDTERate = cpu_to_le32(9600);
	acm->line.bDataBits = 8;
	acm_set_line(acm, &acm->line);

	usb_driver_claim_interface(&acm_driver, data_interface, acm);
D
David Brownell 已提交
1151
	usb_set_intfdata(data_interface, acm);
L
Linus Torvalds 已提交
1152

1153 1154
	usb_get_intf(control_interface);
	tty_register_device(acm_tty_driver, minor, &control_interface->dev);
L
Linus Torvalds 已提交
1155 1156 1157

	acm_table[minor] = acm;

1158 1159
	return 0;
alloc_fail8:
1160 1161
	for (i = 0; i < ACM_NW; i++)
		usb_free_urb(acm->wb[i].urb);
L
Linus Torvalds 已提交
1162
alloc_fail7:
1163
	acm_read_buffers_free(acm);
1164
	for (i = 0; i < num_rx_buf; i++)
1165
		usb_free_urb(acm->ru[i].urb);
L
Linus Torvalds 已提交
1166 1167
	usb_free_urb(acm->ctrlurb);
alloc_fail5:
1168
	acm_write_buffers_free(acm);
L
Linus Torvalds 已提交
1169 1170 1171 1172 1173 1174 1175 1176
alloc_fail4:
	usb_buffer_free(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
alloc_fail2:
	kfree(acm);
alloc_fail:
	return -ENOMEM;
}

O
Oliver Neukum 已提交
1177 1178 1179
static void stop_data_traffic(struct acm *acm)
{
	int i;
1180
	dbg("Entering stop_data_traffic");
O
Oliver Neukum 已提交
1181 1182 1183 1184

	tasklet_disable(&acm->urb_task);

	usb_kill_urb(acm->ctrlurb);
1185 1186
	for(i = 0; i < ACM_NW; i++)
		usb_kill_urb(acm->wb[i].urb);
O
Oliver Neukum 已提交
1187 1188 1189 1190 1191 1192
	for (i = 0; i < acm->rx_buflimit; i++)
		usb_kill_urb(acm->ru[i].urb);

	tasklet_enable(&acm->urb_task);

	cancel_work_sync(&acm->work);
1193
	cancel_work_sync(&acm->waker);
O
Oliver Neukum 已提交
1194 1195
}

L
Linus Torvalds 已提交
1196 1197
static void acm_disconnect(struct usb_interface *intf)
{
1198
	struct acm *acm = usb_get_intfdata(intf);
L
Linus Torvalds 已提交
1199 1200
	struct usb_device *usb_dev = interface_to_usbdev(intf);

D
David Brownell 已提交
1201 1202
	/* sibling interface is already cleaning up */
	if (!acm)
1203
		return;
D
David Brownell 已提交
1204 1205

	mutex_lock(&open_mutex);
1206
	if (acm->country_codes){
1207 1208 1209 1210
		device_remove_file(&acm->control->dev,
				&dev_attr_wCountryCodes);
		device_remove_file(&acm->control->dev,
				&dev_attr_iCountryCodeRelDate);
1211
	}
1212
	device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
L
Linus Torvalds 已提交
1213
	acm->dev = NULL;
1214 1215
	usb_set_intfdata(acm->control, NULL);
	usb_set_intfdata(acm->data, NULL);
L
Linus Torvalds 已提交
1216

O
Oliver Neukum 已提交
1217
	stop_data_traffic(acm);
L
Linus Torvalds 已提交
1218

1219
	acm_write_buffers_free(acm);
L
Linus Torvalds 已提交
1220
	usb_buffer_free(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1221
	acm_read_buffers_free(acm);
L
Linus Torvalds 已提交
1222

1223 1224
	usb_driver_release_interface(&acm_driver, intf == acm->control ?
					acm->data : acm->control);
L
Linus Torvalds 已提交
1225 1226

	if (!acm->used) {
1227
		acm_tty_unregister(acm);
1228
		mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
1229 1230 1231
		return;
	}

1232
	mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
1233 1234 1235 1236 1237

	if (acm->tty)
		tty_hangup(acm->tty);
}

1238
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
1239 1240 1241
static int acm_suspend(struct usb_interface *intf, pm_message_t message)
{
	struct acm *acm = usb_get_intfdata(intf);
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
	int cnt;

	if (acm->dev->auto_pm) {
		int b;

		spin_lock_irq(&acm->read_lock);
		spin_lock(&acm->write_lock);
		b = acm->processing + acm->transmitting;
		spin_unlock(&acm->write_lock);
		spin_unlock_irq(&acm->read_lock);
		if (b)
			return -EBUSY;
	}

	spin_lock_irq(&acm->read_lock);
	spin_lock(&acm->write_lock);
	cnt = acm->susp_count++;
	spin_unlock(&acm->write_lock);
	spin_unlock_irq(&acm->read_lock);
O
Oliver Neukum 已提交
1261

1262
	if (cnt)
O
Oliver Neukum 已提交
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
		return 0;
	/*
	we treat opened interfaces differently,
	we must guard against open
	*/
	mutex_lock(&acm->mutex);

	if (acm->used)
		stop_data_traffic(acm);

	mutex_unlock(&acm->mutex);
	return 0;
}

static int acm_resume(struct usb_interface *intf)
{
	struct acm *acm = usb_get_intfdata(intf);
	int rv = 0;
1281
	int cnt;
O
Oliver Neukum 已提交
1282

1283 1284 1285 1286 1287 1288
	spin_lock_irq(&acm->read_lock);
	acm->susp_count -= 1;
	cnt = acm->susp_count;
	spin_unlock_irq(&acm->read_lock);

	if (cnt)
O
Oliver Neukum 已提交
1289 1290 1291 1292 1293 1294
		return 0;

	mutex_lock(&acm->mutex);
	if (acm->used) {
		rv = usb_submit_urb(acm->ctrlurb, GFP_NOIO);
		if (rv < 0)
1295
			goto err_out;
O
Oliver Neukum 已提交
1296 1297 1298 1299 1300 1301 1302 1303

		tasklet_schedule(&acm->urb_task);
	}

err_out:
	mutex_unlock(&acm->mutex);
	return rv;
}
1304 1305

#endif /* CONFIG_PM */
L
Linus Torvalds 已提交
1306 1307 1308 1309 1310 1311 1312 1313 1314
/*
 * USB driver structure.
 */

static struct usb_device_id acm_ids[] = {
	/* quirky and broken devices */
	{ USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1315 1316 1317
	{ USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1318 1319 1320
	{ USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1321 1322 1323
	{ USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1324 1325 1326
	{ USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
	.driver_info = SINGLE_RX_URB, /* firmware bug */
	},
1327 1328 1329
	{ USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
	.driver_info = SINGLE_RX_URB, /* firmware bug */
	},
O
Oliver Neukum 已提交
1330 1331 1332
	{ USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1333 1334 1335
	{ USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
O
Oliver Neukum 已提交
1336

L
Linus Torvalds 已提交
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
	/* control interfaces with various AT-command sets */
	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
		USB_CDC_ACM_PROTO_AT_V25TER) },
	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
		USB_CDC_ACM_PROTO_AT_PCCA101) },
	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
		USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
		USB_CDC_ACM_PROTO_AT_GSM) },
	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
		USB_CDC_ACM_PROTO_AT_3G	) },
	{ USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
		USB_CDC_ACM_PROTO_AT_CDMA) },

	/* NOTE:  COMM/ACM/0xff is likely MSFT RNDIS ... NOT a modem!! */
	{ }
};

MODULE_DEVICE_TABLE (usb, acm_ids);

static struct usb_driver acm_driver = {
	.name =		"cdc_acm",
	.probe =	acm_probe,
	.disconnect =	acm_disconnect,
1361
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
1362 1363
	.suspend =	acm_suspend,
	.resume =	acm_resume,
1364
#endif
L
Linus Torvalds 已提交
1365
	.id_table =	acm_ids,
1366
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
1367
	.supports_autosuspend = 1,
1368
#endif
L
Linus Torvalds 已提交
1369 1370 1371 1372 1373 1374
};

/*
 * TTY driver structures.
 */

J
Jeff Dike 已提交
1375
static const struct tty_operations acm_ops = {
L
Linus Torvalds 已提交
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406
	.open =			acm_tty_open,
	.close =		acm_tty_close,
	.write =		acm_tty_write,
	.write_room =		acm_tty_write_room,
	.ioctl =		acm_tty_ioctl,
	.throttle =		acm_tty_throttle,
	.unthrottle =		acm_tty_unthrottle,
	.chars_in_buffer =	acm_tty_chars_in_buffer,
	.break_ctl =		acm_tty_break_ctl,
	.set_termios =		acm_tty_set_termios,
	.tiocmget =		acm_tty_tiocmget,
	.tiocmset =		acm_tty_tiocmset,
};

/*
 * Init / exit.
 */

static int __init acm_init(void)
{
	int retval;
	acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
	if (!acm_tty_driver)
		return -ENOMEM;
	acm_tty_driver->owner = THIS_MODULE,
	acm_tty_driver->driver_name = "acm",
	acm_tty_driver->name = "ttyACM",
	acm_tty_driver->major = ACM_TTY_MAJOR,
	acm_tty_driver->minor_start = 0,
	acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
	acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1407
	acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
L
Linus Torvalds 已提交
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
	acm_tty_driver->init_termios = tty_std_termios;
	acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
	tty_set_operations(acm_tty_driver, &acm_ops);

	retval = tty_register_driver(acm_tty_driver);
	if (retval) {
		put_tty_driver(acm_tty_driver);
		return retval;
	}

	retval = usb_register(&acm_driver);
	if (retval) {
		tty_unregister_driver(acm_tty_driver);
		put_tty_driver(acm_tty_driver);
		return retval;
	}

	info(DRIVER_VERSION ":" DRIVER_DESC);

	return 0;
}

static void __exit acm_exit(void)
{
	usb_deregister(&acm_driver);
	tty_unregister_driver(acm_tty_driver);
	put_tty_driver(acm_tty_driver);
}

module_init(acm_init);
module_exit(acm_exit);

MODULE_AUTHOR( DRIVER_AUTHOR );
MODULE_DESCRIPTION( DRIVER_DESC );
MODULE_LICENSE("GPL");