cdc-acm.c 38.8 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
 */

/*
 * 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
54
#undef VERBOSE_DEBUG
L
Linus Torvalds 已提交
55 56 57 58 59 60 61 62 63

#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>
64
#include <linux/mutex.h>
L
Linus Torvalds 已提交
65 66
#include <asm/uaccess.h>
#include <linux/usb.h>
67
#include <linux/usb/cdc.h>
L
Linus Torvalds 已提交
68 69
#include <asm/byteorder.h>
#include <asm/unaligned.h>
70
#include <linux/list.h>
L
Linus Torvalds 已提交
71 72 73

#include "cdc-acm.h"

74 75 76

#define ACM_CLOSE_TIMEOUT	15	/* seconds to let writes drain */

L
Linus Torvalds 已提交
77 78 79
/*
 * Version Information
 */
80
#define DRIVER_VERSION "v0.26"
81
#define DRIVER_AUTHOR "Armin Fuerst, Pavel Machek, Johannes Erdfelt, Vojtech Pavlik, David Kubicek"
L
Linus Torvalds 已提交
82 83 84 85 86 87
#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];

88
static DEFINE_MUTEX(open_mutex);
L
Linus Torvalds 已提交
89 90 91

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

92 93 94 95 96 97
#ifdef VERBOSE_DEBUG
#define verbose	1
#else
#define verbose	0
#endif

L
Linus Torvalds 已提交
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
/*
 * 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)

122 123 124 125 126 127 128 129 130 131
/*
 * 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;

132
	wbn = 0;
133 134 135 136 137 138 139
	i = 0;
	for (;;) {
		wb = &acm->wb[wbn];
		if (!wb->use) {
			wb->use = 1;
			return wbn;
		}
140 141
		wbn = (wbn + 1) % ACM_NW;
		if (++i >= ACM_NW)
142 143 144 145 146 147 148
			return -1;
	}
}

static int acm_wb_is_avail(struct acm *acm)
{
	int i, n;
149
	unsigned long flags;
150

151
	n = ACM_NW;
152
	spin_lock_irqsave(&acm->write_lock, flags);
153 154
	for (i = 0; i < ACM_NW; i++) {
		n -= acm->wb[i].use;
155
	}
156
	spin_unlock_irqrestore(&acm->write_lock, flags);
157 158 159 160
	return n;
}

/*
161
 * Finish write. Caller must hold acm->write_lock
162
 */
163
static void acm_write_done(struct acm *acm, struct acm_wb *wb)
164
{
165
	wb->use = 0;
166
	acm->transmitting--;
167 168 169 170
}

/*
 * Poke write.
171 172
 *
 * the caller is responsible for locking
173
 */
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192

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;
}

193
static int acm_write_start(struct acm *acm, int wbn)
194 195
{
	unsigned long flags;
196
	struct acm_wb *wb = &acm->wb[wbn];
197 198 199 200
	int rc;

	spin_lock_irqsave(&acm->write_lock, flags);
	if (!acm->dev) {
201
		wb->use = 0;
202 203 204 205
		spin_unlock_irqrestore(&acm->write_lock, flags);
		return -ENODEV;
	}

206 207 208 209 210 211 212 213 214 215
	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);
216 217 218
	spin_unlock_irqrestore(&acm->write_lock, flags);

	return rc;
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 245 246 247 248 249 250 251 252 253
/*
 * 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);
}
254

255
static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
L
Linus Torvalds 已提交
256 257 258 259 260
/*
 * Interrupt handlers for various ACM device responses
 */

/* control interface reports status changes with "interrupt" transfers */
261
static void acm_ctrl_irq(struct urb *urb)
L
Linus Torvalds 已提交
262 263 264 265 266
{
	struct acm *acm = urb->context;
	struct usb_cdc_notification *dr = urb->transfer_buffer;
	unsigned char *data;
	int newctrl;
267 268
	int retval;
	int status = urb->status;
L
Linus Torvalds 已提交
269

270
	switch (status) {
L
Linus Torvalds 已提交
271 272 273 274 275 276 277
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
278
		dbg("%s - urb shutting down with status: %d", __func__, status);
L
Linus Torvalds 已提交
279 280
		return;
	default:
281
		dbg("%s - nonzero urb status received: %d", __func__, status);
L
Linus Torvalds 已提交
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
		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:

298
			newctrl = get_unaligned_le16(data);
L
Linus Torvalds 已提交
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321

			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:
322
	usb_mark_last_busy(acm->dev);
323 324
	retval = usb_submit_urb (urb, GFP_ATOMIC);
	if (retval)
325 326
		dev_err(&urb->dev->dev, "%s - usb_submit_urb failed with "
			"result %d", __func__, retval);
L
Linus Torvalds 已提交
327 328 329
}

/* data interface returns incoming bytes, or we got unthrottled */
330
static void acm_read_bulk(struct urb *urb)
L
Linus Torvalds 已提交
331
{
332 333 334
	struct acm_rb *buf;
	struct acm_ru *rcv = urb->context;
	struct acm *acm = rcv->instance;
335
	int status = urb->status;
336 337

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

339 340
	if (!ACM_READY(acm)) {
		dev_dbg(&acm->data->dev, "Aborting, acm not ready");
L
Linus Torvalds 已提交
341
		return;
342 343
	}
	usb_mark_last_busy(acm->dev);
L
Linus Torvalds 已提交
344

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

348 349 350
	buf = rcv->buffer;
	buf->size = urb->actual_length;

351 352
	if (likely(status == 0)) {
		spin_lock(&acm->read_lock);
353
		acm->processing++;
354 355 356 357 358 359 360 361 362 363 364 365
		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 */
	}
366 367
	if (likely(!acm->susp_count))
		tasklet_schedule(&acm->urb_task);
L
Linus Torvalds 已提交
368 369 370 371 372
}

static void acm_rx_tasklet(unsigned long _acm)
{
	struct acm *acm = (void *)_acm;
373
	struct acm_rb *buf;
L
Linus Torvalds 已提交
374
	struct tty_struct *tty = acm->tty;
375
	struct acm_ru *rcv;
376
	unsigned long flags;
377
	unsigned char throttled;
378

L
Linus Torvalds 已提交
379 380
	dbg("Entering acm_rx_tasklet");

381
	if (!ACM_READY(acm))
382 383
	{
		dbg("acm_rx_tasklet: ACM not ready");
384
		return;
385
	}
386

387
	spin_lock_irqsave(&acm->throttle_lock, flags);
388
	throttled = acm->throttle;
389
	spin_unlock_irqrestore(&acm->throttle_lock, flags);
390
	if (throttled)
391 392
	{
		dbg("acm_rx_tasklet: throttled");
393
		return;
394
	}
395 396

next_buffer:
397
	spin_lock_irqsave(&acm->read_lock, flags);
398
	if (list_empty(&acm->filled_read_bufs)) {
399
		spin_unlock_irqrestore(&acm->read_lock, flags);
400
		goto urbs;
L
Linus Torvalds 已提交
401
	}
402 403 404
	buf = list_entry(acm->filled_read_bufs.next,
			 struct acm_rb, list);
	list_del(&buf->list);
405
	spin_unlock_irqrestore(&acm->read_lock, flags);
406

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

A
Alan Cox 已提交
409
	tty_buffer_request_room(tty, buf->size);
410
	spin_lock_irqsave(&acm->throttle_lock, flags);
411
	throttled = acm->throttle;
412
	spin_unlock_irqrestore(&acm->throttle_lock, flags);
413
	if (!throttled)
A
Alan Cox 已提交
414
		tty_insert_flip_string(tty, buf->base, buf->size);
415
	tty_flip_buffer_push(tty);
L
Linus Torvalds 已提交
416

417 418
	if (throttled) {
		dbg("Throttling noticed");
419
		spin_lock_irqsave(&acm->read_lock, flags);
420
		list_add(&buf->list, &acm->filled_read_bufs);
421
		spin_unlock_irqrestore(&acm->read_lock, flags);
L
Linus Torvalds 已提交
422 423 424
		return;
	}

425
	spin_lock_irqsave(&acm->read_lock, flags);
426
	list_add(&buf->list, &acm->spare_read_bufs);
427
	spin_unlock_irqrestore(&acm->read_lock, flags);
428 429 430 431
	goto next_buffer;

urbs:
	while (!list_empty(&acm->spare_read_bufs)) {
432
		spin_lock_irqsave(&acm->read_lock, flags);
433
		if (list_empty(&acm->spare_read_urbs)) {
434
			acm->processing = 0;
435
			spin_unlock_irqrestore(&acm->read_lock, flags);
436 437 438 439 440
			return;
		}
		rcv = list_entry(acm->spare_read_urbs.next,
				 struct acm_ru, list);
		list_del(&rcv->list);
441
		spin_unlock_irqrestore(&acm->read_lock, flags);
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458

		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 */
459 460
		spin_lock_irqsave(&acm->read_lock, flags);
		if (acm->susp_count || usb_submit_urb(rcv->urb, GFP_ATOMIC) < 0) {
461 462
			list_add(&buf->list, &acm->spare_read_bufs);
			list_add(&rcv->list, &acm->spare_read_urbs);
463
			acm->processing = 0;
464
			spin_unlock_irqrestore(&acm->read_lock, flags);
465
			return;
466 467 468
		} 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);
469 470
		}
	}
471 472 473
	spin_lock_irqsave(&acm->read_lock, flags);
	acm->processing = 0;
	spin_unlock_irqrestore(&acm->read_lock, flags);
L
Linus Torvalds 已提交
474 475 476
}

/* data interface wrote those outgoing bytes */
477
static void acm_write_bulk(struct urb *urb)
L
Linus Torvalds 已提交
478
{
479
	struct acm_wb *wb = urb->context;
480
	struct acm *acm = wb->instance;
481
	unsigned long flags;
L
Linus Torvalds 已提交
482

483 484 485 486 487 488
	if (verbose || urb->status
			|| (urb->actual_length != urb->transfer_buffer_length))
		dev_dbg(&acm->data->dev, "tx %d/%d bytes -- > %d\n",
			urb->actual_length,
			urb->transfer_buffer_length,
			urb->status);
L
Linus Torvalds 已提交
489

490
	spin_lock_irqsave(&acm->write_lock, flags);
491
	acm_write_done(acm, wb);
492
	spin_unlock_irqrestore(&acm->write_lock, flags);
493 494
	if (ACM_READY(acm))
		schedule_work(&acm->work);
495 496
	else
		wake_up_interruptible(&acm->drain_wait);
L
Linus Torvalds 已提交
497 498
}

D
David Howells 已提交
499
static void acm_softint(struct work_struct *work)
L
Linus Torvalds 已提交
500
{
D
David Howells 已提交
501
	struct acm *acm = container_of(work, struct acm, work);
502 503

	dev_vdbg(&acm->data->dev, "tx work\n");
L
Linus Torvalds 已提交
504 505 506 507 508
	if (!ACM_READY(acm))
		return;
	tty_wakeup(acm->tty);
}

509 510 511 512 513 514 515
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) {
516
		dev_err(&acm->dev->dev, "Autopm failure in %s\n", __func__);
517 518 519 520 521 522 523 524 525
		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 已提交
526 527 528 529 530 531 532 533
/*
 * TTY handlers
 */

static int acm_tty_open(struct tty_struct *tty, struct file *filp)
{
	struct acm *acm;
	int rv = -EINVAL;
534
	int i;
535
	dbg("Entering acm_tty_open.");
536 537

	mutex_lock(&open_mutex);
L
Linus Torvalds 已提交
538 539 540 541 542 543 544

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

545
	set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
L
Linus Torvalds 已提交
546 547 548
	tty->driver_data = acm;
	acm->tty = tty;

549 550 551
	/* 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 已提交
552

553 554
	if (usb_autopm_get_interface(acm->control) < 0)
		goto early_bail;
555 556
	else
		acm->control->needs_remote_wakeup = 1;
O
Oliver Neukum 已提交
557 558

	mutex_lock(&acm->mutex);
L
Linus Torvalds 已提交
559
	if (acm->used++) {
O
Oliver Neukum 已提交
560
		usb_autopm_put_interface(acm->control);
L
Linus Torvalds 已提交
561 562 563
		goto done;
        }

O
Oliver Neukum 已提交
564

L
Linus Torvalds 已提交
565 566 567 568 569 570
	acm->ctrlurb->dev = acm->dev;
	if (usb_submit_urb(acm->ctrlurb, GFP_KERNEL)) {
		dbg("usb_submit_urb(ctrl irq) failed");
		goto bail_out;
	}

571 572
	if (0 > acm_set_control(acm, acm->ctrlout = ACM_CTRL_DTR | ACM_CTRL_RTS) &&
	    (acm->ctrl_caps & USB_CDC_CAP_LINE))
L
Linus Torvalds 已提交
573
		goto full_bailout;
574
	usb_autopm_put_interface(acm->control);
L
Linus Torvalds 已提交
575

576 577 578
	INIT_LIST_HEAD(&acm->spare_read_urbs);
	INIT_LIST_HEAD(&acm->spare_read_bufs);
	INIT_LIST_HEAD(&acm->filled_read_bufs);
579
	for (i = 0; i < acm->rx_buflimit; i++) {
580 581
		list_add(&(acm->ru[i].list), &acm->spare_read_urbs);
	}
582
	for (i = 0; i < acm->rx_buflimit; i++) {
583 584 585
		list_add(&(acm->rb[i].list), &acm->spare_read_bufs);
	}

586 587
	acm->throttle = 0;

588
	tasklet_schedule(&acm->urb_task);
L
Linus Torvalds 已提交
589 590

done:
O
Oliver Neukum 已提交
591
	mutex_unlock(&acm->mutex);
592
err_out:
593
	mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
594 595 596 597 598
	return rv;

full_bailout:
	usb_kill_urb(acm->ctrlurb);
bail_out:
O
Oliver Neukum 已提交
599
	usb_autopm_put_interface(acm->control);
L
Linus Torvalds 已提交
600
	acm->used--;
O
Oliver Neukum 已提交
601
	mutex_unlock(&acm->mutex);
602 603
early_bail:
	mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
604 605 606
	return -EIO;
}

607 608
static void acm_tty_unregister(struct acm *acm)
{
609
	int i,nr;
610

611
	nr = acm->rx_buflimit;
612 613 614 615
	tty_unregister_device(acm_tty_driver, acm->minor);
	usb_put_intf(acm->control);
	acm_table[acm->minor] = NULL;
	usb_free_urb(acm->ctrlurb);
616 617
	for (i = 0; i < ACM_NW; i++)
		usb_free_urb(acm->wb[i].urb);
618
	for (i = 0; i < nr; i++)
619
		usb_free_urb(acm->ru[i].urb);
620
	kfree(acm->country_codes);
621 622 623
	kfree(acm);
}

624 625
static int acm_tty_chars_in_buffer(struct tty_struct *tty);

L
Linus Torvalds 已提交
626 627 628
static void acm_tty_close(struct tty_struct *tty, struct file *filp)
{
	struct acm *acm = tty->driver_data;
629
	int i,nr;
L
Linus Torvalds 已提交
630 631 632 633

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

634
	nr = acm->rx_buflimit;
635
	mutex_lock(&open_mutex);
L
Linus Torvalds 已提交
636 637
	if (!--acm->used) {
		if (acm->dev) {
638
			usb_autopm_get_interface(acm->control);
L
Linus Torvalds 已提交
639
			acm_set_control(acm, acm->ctrlout = 0);
640 641 642 643 644 645 646

			/* try letting the last writes drain naturally */
			wait_event_interruptible_timeout(acm->drain_wait,
					(ACM_NW == acm_wb_is_avail(acm))
						|| !acm->dev,
					ACM_CLOSE_TIMEOUT * HZ);

L
Linus Torvalds 已提交
647
			usb_kill_urb(acm->ctrlurb);
648 649
			for (i = 0; i < ACM_NW; i++)
				usb_kill_urb(acm->wb[i].urb);
650
			for (i = 0; i < nr; i++)
651
				usb_kill_urb(acm->ru[i].urb);
652
			acm->control->needs_remote_wakeup = 0;
O
Oliver Neukum 已提交
653
			usb_autopm_put_interface(acm->control);
654 655
		} else
			acm_tty_unregister(acm);
L
Linus Torvalds 已提交
656
	}
657
	mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
658 659 660 661 662 663
}

static int acm_tty_write(struct tty_struct *tty, const unsigned char *buf, int count)
{
	struct acm *acm = tty->driver_data;
	int stat;
664 665 666 667
	unsigned long flags;
	int wbn;
	struct acm_wb *wb;

668
	dbg("Entering acm_tty_write to write %d bytes,", count);
L
Linus Torvalds 已提交
669 670 671 672 673 674

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

675 676 677 678 679 680
	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 已提交
681

682
	count = (count > acm->writesize) ? acm->writesize : count;
L
Linus Torvalds 已提交
683
	dbg("Get %d bytes...", count);
684 685 686
	memcpy(wb->buf, buf, count);
	wb->len = count;
	spin_unlock_irqrestore(&acm->write_lock, flags);
L
Linus Torvalds 已提交
687

688
	if ((stat = acm_write_start(acm, wbn)) < 0)
L
Linus Torvalds 已提交
689 690 691 692 693 694 695 696 697
		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;
698 699 700 701
	/*
	 * Do not let the line discipline to know that we have a reserve,
	 * or it might get too enthusiastic.
	 */
702
	return acm_wb_is_avail(acm) ? acm->writesize : 0;
L
Linus Torvalds 已提交
703 704 705 706 707 708 709
}

static int acm_tty_chars_in_buffer(struct tty_struct *tty)
{
	struct acm *acm = tty->driver_data;
	if (!ACM_READY(acm))
		return -EINVAL;
710 711 712
	/*
	 * This is inaccurate (overcounts), but it works.
	 */
713
	return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
L
Linus Torvalds 已提交
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
}

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);
734
	tasklet_schedule(&acm->urb_task);
L
Linus Torvalds 已提交
735 736
}

A
Alan Cox 已提交
737
static int acm_tty_break_ctl(struct tty_struct *tty, int state)
L
Linus Torvalds 已提交
738 739
{
	struct acm *acm = tty->driver_data;
A
Alan Cox 已提交
740
	int retval;
L
Linus Torvalds 已提交
741
	if (!ACM_READY(acm))
A
Alan Cox 已提交
742 743 744
		return -EINVAL;
	retval = acm_send_break(acm, state ? 0xffff : 0);
	if (retval < 0)
L
Linus Torvalds 已提交
745
		dbg("send break failed");
A
Alan Cox 已提交
746
	return retval;
L
Linus Torvalds 已提交
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
}

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;
}

794
static const __u32 acm_tty_speed[] = {
L
Linus Torvalds 已提交
795 796 797 798 799 800 801
	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
};

802
static const __u8 acm_tty_size[] = {
L
Linus Torvalds 已提交
803 804 805
	5, 6, 7, 8
};

A
Alan Cox 已提交
806
static void acm_tty_set_termios(struct tty_struct *tty, struct ktermios *termios_old)
L
Linus Torvalds 已提交
807 808
{
	struct acm *acm = tty->driver_data;
A
Alan Cox 已提交
809
	struct ktermios *termios = tty->termios;
L
Linus Torvalds 已提交
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
	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.
 */

846
/* Little helpers: write/read buffers free */
847 848 849 850
static void acm_write_buffers_free(struct acm *acm)
{
	int i;
	struct acm_wb *wb;
O
Oliver Neukum 已提交
851
	struct usb_device *usb_dev = interface_to_usbdev(acm->control);
852

853
	for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
O
Oliver Neukum 已提交
854
		usb_buffer_free(usb_dev, acm->writesize, wb->buf, wb->dmah);
855 856 857
	}
}

858 859 860 861 862 863 864 865 866
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);
}

867 868 869 870 871 872
/* Little helper: write buffers allocate */
static int acm_write_buffers_alloc(struct acm *acm)
{
	int i;
	struct acm_wb *wb;

873
	for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
		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 已提交
889 890 891 892
static int acm_probe (struct usb_interface *intf,
		      const struct usb_device_id *id)
{
	struct usb_cdc_union_desc *union_header = NULL;
893
	struct usb_cdc_country_functional_desc *cfd = NULL;
D
David Brownell 已提交
894
	unsigned char *buffer = intf->altsetting->extra;
L
Linus Torvalds 已提交
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
	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;
911
	int num_rx_buf;
912
	int i;
L
Linus Torvalds 已提交
913

914
	/* normal quirks */
L
Linus Torvalds 已提交
915
	quirks = (unsigned long)id->driver_info;
916 917 918
	num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;

	/* handle quirks deadly to normal probing*/
L
Linus Torvalds 已提交
919 920 921 922 923 924 925 926
	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) {
927
		dev_err(&intf->dev, "Weird descriptor references\n");
L
Linus Torvalds 已提交
928 929 930 931 932
		return -EINVAL;
	}

	if (!buflen) {
		if (intf->cur_altsetting->endpoint->extralen && intf->cur_altsetting->endpoint->extra) {
933
			dev_dbg(&intf->dev,"Seeking extra descriptors on endpoint\n");
L
Linus Torvalds 已提交
934 935 936
			buflen = intf->cur_altsetting->endpoint->extralen;
			buffer = intf->cur_altsetting->endpoint->extra;
		} else {
937 938
			dev_err(&intf->dev,
				"Zero length descriptor references\n");
L
Linus Torvalds 已提交
939 940 941 942 943 944
			return -EINVAL;
		}
	}

	while (buflen > 0) {
		if (buffer [1] != USB_DT_CS_INTERFACE) {
945
			dev_err(&intf->dev, "skipping garbage\n");
L
Linus Torvalds 已提交
946 947 948 949 950 951
			goto next_desc;
		}

		switch (buffer [2]) {
			case USB_CDC_UNION_TYPE: /* we've found it */
				if (union_header) {
952 953 954
					dev_err(&intf->dev, "More than one "
						"union descriptor, "
						"skipping ...\n");
L
Linus Torvalds 已提交
955 956 957 958 959
					goto next_desc;
				}
				union_header = (struct usb_cdc_union_desc *)
							buffer;
				break;
960 961 962
			case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
				cfd = (struct usb_cdc_country_functional_desc *)buffer;
				break;
L
Linus Torvalds 已提交
963 964 965 966 967 968 969 970 971
			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)
972 973 974
					dev_err(&intf->dev, "This device "
						"cannot do calls on its own. "
						"It is no modem.\n");
L
Linus Torvalds 已提交
975 976
				break;
			default:
D
David Brownell 已提交
977 978 979 980 981 982
				/* 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 已提交
983 984 985 986 987 988 989 990 991
				break;
			}
next_desc:
		buflen -= buffer[0];
		buffer += buffer[0];
	}

	if (!union_header) {
		if (call_interface_num > 0) {
992
			dev_dbg(&intf->dev,"No union descriptor, using call management descriptor\n");
L
Linus Torvalds 已提交
993 994 995
			data_interface = usb_ifnum_to_if(usb_dev, (data_interface_num = call_interface_num));
			control_interface = intf;
		} else {
996
			dev_dbg(&intf->dev,"No union descriptor, giving up\n");
L
Linus Torvalds 已提交
997 998 999 1000 1001 1002
			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) {
1003
			dev_dbg(&intf->dev,"no interfaces\n");
L
Linus Torvalds 已提交
1004 1005 1006 1007 1008
			return -ENODEV;
		}
	}
	
	if (data_interface_num != call_interface_num)
J
Joe Perches 已提交
1009
		dev_dbg(&intf->dev,"Separate call control interface. That is not fully supported.\n");
L
Linus Torvalds 已提交
1010 1011 1012 1013 1014 1015 1016

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;
1017
			dev_dbg(&intf->dev,"Your device has switched interfaces.\n");
L
Linus Torvalds 已提交
1018 1019 1020 1021 1022 1023 1024 1025

			t = control_interface;
			control_interface = data_interface;
			data_interface = t;
		} else {
			return -EINVAL;
		}
	}
1026 1027 1028 1029

	/* Accept probe requests only for the control interface */
	if (intf != control_interface)
		return -ENODEV;
L
Linus Torvalds 已提交
1030 1031
	
	if (usb_interface_claimed(data_interface)) { /* valid in this context */
1032
		dev_dbg(&intf->dev,"The data interface isn't available\n");
L
Linus Torvalds 已提交
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
		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 */
1046
	if (!usb_endpoint_dir_in(epread)) {
L
Linus Torvalds 已提交
1047 1048
		/* descriptors are swapped */
		struct usb_endpoint_descriptor *t;
1049
		dev_dbg(&intf->dev,"The data interface has switched endpoints\n");
L
Linus Torvalds 已提交
1050 1051 1052 1053 1054 1055 1056 1057 1058
		
		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) {
1059
		dev_err(&intf->dev, "no more free acm devices\n");
L
Linus Torvalds 已提交
1060 1061 1062
		return -ENODEV;
	}

1063
	if (!(acm = kzalloc(sizeof(struct acm), GFP_KERNEL))) {
1064
		dev_dbg(&intf->dev, "out of memory (acm kzalloc)\n");
L
Linus Torvalds 已提交
1065 1066 1067 1068
		goto alloc_fail;
	}

	ctrlsize = le16_to_cpu(epctrl->wMaxPacketSize);
1069
	readsize = le16_to_cpu(epread->wMaxPacketSize)* ( quirks == SINGLE_RX_URB ? 1 : 2);
1070
	acm->writesize = le16_to_cpu(epwrite->wMaxPacketSize) * 20;
L
Linus Torvalds 已提交
1071 1072 1073 1074 1075 1076 1077
	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;
1078
	acm->rx_buflimit = num_rx_buf;
1079 1080
	acm->urb_task.func = acm_rx_tasklet;
	acm->urb_task.data = (unsigned long) acm;
D
David Howells 已提交
1081
	INIT_WORK(&acm->work, acm_softint);
1082
	INIT_WORK(&acm->waker, acm_waker);
1083
	init_waitqueue_head(&acm->drain_wait);
L
Linus Torvalds 已提交
1084
	spin_lock_init(&acm->throttle_lock);
1085
	spin_lock_init(&acm->write_lock);
1086
	spin_lock_init(&acm->read_lock);
O
Oliver Neukum 已提交
1087
	mutex_init(&acm->mutex);
1088
	acm->rx_endpoint = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
L
Linus Torvalds 已提交
1089 1090 1091

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

1097
	if (acm_write_buffers_alloc(acm) < 0) {
1098
		dev_dbg(&intf->dev, "out of memory (write buffer alloc)\n");
L
Linus Torvalds 已提交
1099 1100 1101 1102 1103
		goto alloc_fail4;
	}

	acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
	if (!acm->ctrlurb) {
1104
		dev_dbg(&intf->dev, "out of memory (ctrlurb kmalloc)\n");
L
Linus Torvalds 已提交
1105 1106
		goto alloc_fail5;
	}
1107
	for (i = 0; i < num_rx_buf; i++) {
1108 1109 1110
		struct acm_ru *rcv = &(acm->ru[i]);

		if (!(rcv->urb = usb_alloc_urb(0, GFP_KERNEL))) {
1111
			dev_dbg(&intf->dev, "out of memory (read urbs usb_alloc_urb)\n");
1112 1113 1114 1115 1116 1117
			goto alloc_fail7;
		}

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

D
David Brownell 已提交
1121 1122 1123
		rb->base = usb_buffer_alloc(acm->dev, readsize,
				GFP_KERNEL, &rb->dma);
		if (!rb->base) {
1124
			dev_dbg(&intf->dev, "out of memory (read bufs usb_buffer_alloc)\n");
1125 1126
			goto alloc_fail7;
		}
L
Linus Torvalds 已提交
1127
	}
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
	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 已提交
1141 1142
	}

1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
	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 已提交
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
	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 已提交
1185
	usb_set_intfdata(data_interface, acm);
L
Linus Torvalds 已提交
1186

1187 1188
	usb_get_intf(control_interface);
	tty_register_device(acm_tty_driver, minor, &control_interface->dev);
L
Linus Torvalds 已提交
1189 1190 1191

	acm_table[minor] = acm;

1192 1193
	return 0;
alloc_fail8:
1194 1195
	for (i = 0; i < ACM_NW; i++)
		usb_free_urb(acm->wb[i].urb);
L
Linus Torvalds 已提交
1196
alloc_fail7:
1197
	acm_read_buffers_free(acm);
1198
	for (i = 0; i < num_rx_buf; i++)
1199
		usb_free_urb(acm->ru[i].urb);
L
Linus Torvalds 已提交
1200 1201
	usb_free_urb(acm->ctrlurb);
alloc_fail5:
1202
	acm_write_buffers_free(acm);
L
Linus Torvalds 已提交
1203 1204 1205 1206 1207 1208 1209 1210
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 已提交
1211 1212 1213
static void stop_data_traffic(struct acm *acm)
{
	int i;
1214
	dbg("Entering stop_data_traffic");
O
Oliver Neukum 已提交
1215 1216 1217 1218

	tasklet_disable(&acm->urb_task);

	usb_kill_urb(acm->ctrlurb);
1219 1220
	for(i = 0; i < ACM_NW; i++)
		usb_kill_urb(acm->wb[i].urb);
O
Oliver Neukum 已提交
1221 1222 1223 1224 1225 1226
	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);
1227
	cancel_work_sync(&acm->waker);
O
Oliver Neukum 已提交
1228 1229
}

L
Linus Torvalds 已提交
1230 1231
static void acm_disconnect(struct usb_interface *intf)
{
1232
	struct acm *acm = usb_get_intfdata(intf);
L
Linus Torvalds 已提交
1233 1234
	struct usb_device *usb_dev = interface_to_usbdev(intf);

D
David Brownell 已提交
1235 1236
	/* sibling interface is already cleaning up */
	if (!acm)
1237
		return;
D
David Brownell 已提交
1238 1239

	mutex_lock(&open_mutex);
1240
	if (acm->country_codes){
1241 1242 1243 1244
		device_remove_file(&acm->control->dev,
				&dev_attr_wCountryCodes);
		device_remove_file(&acm->control->dev,
				&dev_attr_iCountryCodeRelDate);
1245
	}
1246
	device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
L
Linus Torvalds 已提交
1247
	acm->dev = NULL;
1248 1249
	usb_set_intfdata(acm->control, NULL);
	usb_set_intfdata(acm->data, NULL);
L
Linus Torvalds 已提交
1250

O
Oliver Neukum 已提交
1251
	stop_data_traffic(acm);
L
Linus Torvalds 已提交
1252

1253
	acm_write_buffers_free(acm);
L
Linus Torvalds 已提交
1254
	usb_buffer_free(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1255
	acm_read_buffers_free(acm);
L
Linus Torvalds 已提交
1256

1257 1258
	usb_driver_release_interface(&acm_driver, intf == acm->control ?
					acm->data : acm->control);
L
Linus Torvalds 已提交
1259 1260

	if (!acm->used) {
1261
		acm_tty_unregister(acm);
1262
		mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
1263 1264 1265
		return;
	}

1266
	mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
1267 1268 1269 1270 1271

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

1272
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
1273 1274 1275
static int acm_suspend(struct usb_interface *intf, pm_message_t message)
{
	struct acm *acm = usb_get_intfdata(intf);
1276 1277
	int cnt;

A
Alan Stern 已提交
1278
	if (message.event & PM_EVENT_AUTO) {
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
		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 已提交
1295

1296
	if (cnt)
O
Oliver Neukum 已提交
1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
		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;
1315
	int cnt;
O
Oliver Neukum 已提交
1316

1317 1318 1319 1320 1321 1322
	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 已提交
1323 1324 1325 1326 1327 1328
		return 0;

	mutex_lock(&acm->mutex);
	if (acm->used) {
		rv = usb_submit_urb(acm->ctrlurb, GFP_NOIO);
		if (rv < 0)
1329
			goto err_out;
O
Oliver Neukum 已提交
1330 1331 1332 1333 1334 1335 1336 1337

		tasklet_schedule(&acm->urb_task);
	}

err_out:
	mutex_unlock(&acm->mutex);
	return rv;
}
1338 1339

#endif /* CONFIG_PM */
L
Linus Torvalds 已提交
1340 1341 1342 1343 1344 1345 1346 1347 1348
/*
 * 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 */
	},
1349 1350 1351
	{ USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1352 1353 1354
	{ USB_DEVICE(0x0e8d, 0x3329), /* i-blue 747, Qstarz BT-Q1000, Holux M-241 */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
A
Andrew Lunn 已提交
1355 1356 1357
	{ USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1358 1359 1360
	{ USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1361 1362 1363
	{ USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1364 1365 1366
	{ USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
	.driver_info = SINGLE_RX_URB, /* firmware bug */
	},
1367 1368 1369
	{ USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
	.driver_info = SINGLE_RX_URB, /* firmware bug */
	},
O
Oliver Neukum 已提交
1370 1371 1372
	{ USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1373 1374 1375
	{ USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
1376 1377 1378
	{ USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
	.driver_info = NO_UNION_NORMAL, /* has no union descriptor */
	},
O
Oliver Neukum 已提交
1379

L
Linus Torvalds 已提交
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
	/* 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,
1404
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
1405 1406
	.suspend =	acm_suspend,
	.resume =	acm_resume,
1407
#endif
L
Linus Torvalds 已提交
1408
	.id_table =	acm_ids,
1409
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
1410
	.supports_autosuspend = 1,
1411
#endif
L
Linus Torvalds 已提交
1412 1413 1414 1415 1416 1417
};

/*
 * TTY driver structures.
 */

J
Jeff Dike 已提交
1418
static const struct tty_operations acm_ops = {
L
Linus Torvalds 已提交
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 1444 1445 1446 1447 1448 1449
	.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,
1450
	acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
L
Linus Torvalds 已提交
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
	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;
	}

1468 1469
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
	       DRIVER_DESC "\n");
L
Linus Torvalds 已提交
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487

	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");