Linux Audio

Check our new training course

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