cdc-acm.c 38.2 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 161 162
	return n;
}

/*
 * Finish write.
 */
163
static void acm_write_done(struct acm *acm, struct acm_wb *wb)
164 165 166 167
{
	unsigned long flags;

	spin_lock_irqsave(&acm->write_lock, flags);
168
	wb->use = 0;
169
	acm->transmitting--;
170 171 172 173 174
	spin_unlock_irqrestore(&acm->write_lock, flags);
}

/*
 * Poke write.
175 176
 *
 * the caller is responsible for locking
177
 */
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196

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

197
static int acm_write_start(struct acm *acm, int wbn)
198 199
{
	unsigned long flags;
200
	struct acm_wb *wb = &acm->wb[wbn];
201 202 203 204
	int rc;

	spin_lock_irqsave(&acm->write_lock, flags);
	if (!acm->dev) {
205
		wb->use = 0;
206 207 208 209
		spin_unlock_irqrestore(&acm->write_lock, flags);
		return -ENODEV;
	}

210 211 212 213 214 215 216 217 218 219
	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);
220 221 222
	spin_unlock_irqrestore(&acm->write_lock, flags);

	return rc;
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 254 255 256 257
/*
 * 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);
}
258

259
static DEVICE_ATTR(iCountryCodeRelDate, S_IRUGO, show_country_rel_date, NULL);
L
Linus Torvalds 已提交
260 261 262 263 264
/*
 * Interrupt handlers for various ACM device responses
 */

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

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

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

			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:
326
	usb_mark_last_busy(acm->dev);
327 328
	retval = usb_submit_urb (urb, GFP_ATOMIC);
	if (retval)
L
Linus Torvalds 已提交
329
		err ("%s - usb_submit_urb failed with result %d",
330
		     __func__, retval);
L
Linus Torvalds 已提交
331 332 333
}

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

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

343 344
	if (!ACM_READY(acm)) {
		dev_dbg(&acm->data->dev, "Aborting, acm not ready");
L
Linus Torvalds 已提交
345
		return;
346 347
	}
	usb_mark_last_busy(acm->dev);
L
Linus Torvalds 已提交
348

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

352 353 354
	buf = rcv->buffer;
	buf->size = urb->actual_length;

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

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

L
Linus Torvalds 已提交
383 384
	dbg("Entering acm_rx_tasklet");

385
	if (!ACM_READY(acm))
386 387
	{
		dbg("acm_rx_tasklet: ACM not ready");
388
		return;
389
	}
390

391
	spin_lock_irqsave(&acm->throttle_lock, flags);
392
	throttled = acm->throttle;
393
	spin_unlock_irqrestore(&acm->throttle_lock, flags);
394
	if (throttled)
395 396
	{
		dbg("acm_rx_tasklet: throttled");
397
		return;
398
	}
399 400

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

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

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

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

429
	spin_lock_irqsave(&acm->read_lock, flags);
430
	list_add(&buf->list, &acm->spare_read_bufs);
431
	spin_unlock_irqrestore(&acm->read_lock, flags);
432 433 434 435
	goto next_buffer;

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

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

/* data interface wrote those outgoing bytes */
481
static void acm_write_bulk(struct urb *urb)
L
Linus Torvalds 已提交
482
{
483
	struct acm_wb *wb = urb->context;
484
	struct acm *acm = wb->instance;
L
Linus Torvalds 已提交
485

486 487 488 489 490 491
	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 已提交
492

493
	acm_write_done(acm, wb);
494 495
	if (ACM_READY(acm))
		schedule_work(&acm->work);
496 497
	else
		wake_up_interruptible(&acm->drain_wait);
L
Linus Torvalds 已提交
498 499
}

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

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

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
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 已提交
527 528 529 530 531 532 533 534
/*
 * TTY handlers
 */

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

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

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

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

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

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

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

O
Oliver Neukum 已提交
565

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

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

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

587 588
	acm->throttle = 0;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A
Alan Cox 已提交
738
static int acm_tty_break_ctl(struct tty_struct *tty, int state)
L
Linus Torvalds 已提交
739 740
{
	struct acm *acm = tty->driver_data;
A
Alan Cox 已提交
741
	int retval;
L
Linus Torvalds 已提交
742
	if (!ACM_READY(acm))
A
Alan Cox 已提交
743 744 745
		return -EINVAL;
	retval = acm_send_break(acm, state ? 0xffff : 0);
	if (retval < 0)
L
Linus Torvalds 已提交
746
		dbg("send break failed");
A
Alan Cox 已提交
747
	return retval;
L
Linus Torvalds 已提交
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 794
}

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

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

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

A
Alan Cox 已提交
807
static void acm_tty_set_termios(struct tty_struct *tty, struct ktermios *termios_old)
L
Linus Torvalds 已提交
808 809
{
	struct acm *acm = tty->driver_data;
A
Alan Cox 已提交
810
	struct ktermios *termios = tty->termios;
L
Linus Torvalds 已提交
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 846
	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.
 */

847
/* Little helpers: write/read buffers free */
848 849 850 851 852
static void acm_write_buffers_free(struct acm *acm)
{
	int i;
	struct acm_wb *wb;

853
	for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
854 855 856 857
		usb_buffer_free(acm->dev, acm->writesize, wb->buf, wb->dmah);
	}
}

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
		err("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 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
			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;
957 958 959
			case USB_CDC_COUNTRY_TYPE: /* export through sysfs*/
				cfd = (struct usb_cdc_country_functional_desc *)buffer;
				break;
L
Linus Torvalds 已提交
960 961 962 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)
					err("This device cannot do calls on its own. It is no modem.");
				break;
			default:
D
David Brownell 已提交
972 973 974 975 976 977
				/* 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 已提交
978 979 980 981 982 983 984 985 986
				break;
			}
next_desc:
		buflen -= buffer[0];
		buffer += buffer[0];
	}

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

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;
1012
			dev_dbg(&intf->dev,"Your device has switched interfaces.\n");
L
Linus Torvalds 已提交
1013 1014 1015 1016 1017 1018 1019 1020

			t = control_interface;
			control_interface = data_interface;
			data_interface = t;
		} else {
			return -EINVAL;
		}
	}
1021 1022 1023 1024

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

1058
	if (!(acm = kzalloc(sizeof(struct acm), GFP_KERNEL))) {
1059
		dev_dbg(&intf->dev, "out of memory (acm kzalloc)\n");
L
Linus Torvalds 已提交
1060 1061 1062 1063
		goto alloc_fail;
	}

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

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

1092
	if (acm_write_buffers_alloc(acm) < 0) {
1093
		dev_dbg(&intf->dev, "out of memory (write buffer alloc)\n");
L
Linus Torvalds 已提交
1094 1095 1096 1097 1098
		goto alloc_fail4;
	}

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

		if (!(rcv->urb = usb_alloc_urb(0, GFP_KERNEL))) {
1106
			dev_dbg(&intf->dev, "out of memory (read urbs usb_alloc_urb)\n");
1107 1108 1109 1110 1111 1112
			goto alloc_fail7;
		}

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

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

1138 1139 1140 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
	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 已提交
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
	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 已提交
1180
	usb_set_intfdata(data_interface, acm);
L
Linus Torvalds 已提交
1181

1182 1183
	usb_get_intf(control_interface);
	tty_register_device(acm_tty_driver, minor, &control_interface->dev);
L
Linus Torvalds 已提交
1184 1185 1186

	acm_table[minor] = acm;

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

	tasklet_disable(&acm->urb_task);

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

L
Linus Torvalds 已提交
1225 1226
static void acm_disconnect(struct usb_interface *intf)
{
1227
	struct acm *acm = usb_get_intfdata(intf);
L
Linus Torvalds 已提交
1228 1229
	struct usb_device *usb_dev = interface_to_usbdev(intf);

D
David Brownell 已提交
1230 1231
	/* sibling interface is already cleaning up */
	if (!acm)
1232
		return;
D
David Brownell 已提交
1233 1234

	mutex_lock(&open_mutex);
1235
	if (acm->country_codes){
1236 1237 1238 1239
		device_remove_file(&acm->control->dev,
				&dev_attr_wCountryCodes);
		device_remove_file(&acm->control->dev,
				&dev_attr_iCountryCodeRelDate);
1240
	}
1241
	device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
L
Linus Torvalds 已提交
1242
	acm->dev = NULL;
1243 1244
	usb_set_intfdata(acm->control, NULL);
	usb_set_intfdata(acm->data, NULL);
L
Linus Torvalds 已提交
1245

O
Oliver Neukum 已提交
1246
	stop_data_traffic(acm);
L
Linus Torvalds 已提交
1247

1248
	acm_write_buffers_free(acm);
L
Linus Torvalds 已提交
1249
	usb_buffer_free(usb_dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1250
	acm_read_buffers_free(acm);
L
Linus Torvalds 已提交
1251

1252 1253
	usb_driver_release_interface(&acm_driver, intf == acm->control ?
					acm->data : acm->control);
L
Linus Torvalds 已提交
1254 1255

	if (!acm->used) {
1256
		acm_tty_unregister(acm);
1257
		mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
1258 1259 1260
		return;
	}

1261
	mutex_unlock(&open_mutex);
L
Linus Torvalds 已提交
1262 1263 1264 1265 1266

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

1267
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
1268 1269 1270
static int acm_suspend(struct usb_interface *intf, pm_message_t message)
{
	struct acm *acm = usb_get_intfdata(intf);
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
	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 已提交
1290

1291
	if (cnt)
O
Oliver Neukum 已提交
1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
		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;
1310
	int cnt;
O
Oliver Neukum 已提交
1311

1312 1313 1314 1315 1316 1317
	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 已提交
1318 1319 1320 1321 1322 1323
		return 0;

	mutex_lock(&acm->mutex);
	if (acm->used) {
		rv = usb_submit_urb(acm->ctrlurb, GFP_NOIO);
		if (rv < 0)
1324
			goto err_out;
O
Oliver Neukum 已提交
1325 1326 1327 1328 1329 1330 1331 1332

		tasklet_schedule(&acm->urb_task);
	}

err_out:
	mutex_unlock(&acm->mutex);
	return rv;
}
1333 1334

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

L
Linus Torvalds 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392
	/* 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,
1393
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
1394 1395
	.suspend =	acm_suspend,
	.resume =	acm_resume,
1396
#endif
L
Linus Torvalds 已提交
1397
	.id_table =	acm_ids,
1398
#ifdef CONFIG_PM
O
Oliver Neukum 已提交
1399
	.supports_autosuspend = 1,
1400
#endif
L
Linus Torvalds 已提交
1401 1402 1403 1404 1405 1406
};

/*
 * TTY driver structures.
 */

J
Jeff Dike 已提交
1407
static const struct tty_operations acm_ops = {
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
	.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,
1439
	acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
L
Linus Torvalds 已提交
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
	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;
	}

1457 1458
	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
	       DRIVER_DESC "\n");
L
Linus Torvalds 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476

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