drivers/usb/class/cdc-acm.c

   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
  47 static struct usb_driver acm_driver;
  48 static struct tty_driver *acm_tty_driver;
  49
  50 static DEFINE_IDR(acm_minors);
  51 static DEFINE_MUTEX(acm_minors_lock);
  52
  53 static 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  */
  64 static 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  */
  87 static 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'.  */
  99 static 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
 110 static 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  */
 136 static 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
 150 static 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
 166 static 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
 186 static 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  */
 202 static 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
 215 static 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  */
 239 static 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 }
 247 static DEVICE_ATTR_RO(bmCapabilities);
 248
 249 static 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
 259 static DEVICE_ATTR_RO(wCountryCodes);
 260
 261 static 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
 270 static DEVICE_ATTR_RO(iCountryCodeRelDate);
 271 /*
 272  * Interrupt handlers for various ACM device responses
 273  */
 274
 275 static void acm_process_notification(struct acm *acm, unsigned char *buf)
 276 {
 277         int newctrl;
 278         int difference;
 279         unsigned long flags;
 280         struct usb_cdc_notification *dr = (struct usb_cdc_notification *)buf;
 281         unsigned char *data = buf + sizeof(struct usb_cdc_notification);
 282
 283         switch (dr->bNotificationType) {
 284         case USB_CDC_NOTIFY_NETWORK_CONNECTION:
 285                 dev_dbg(&acm->control->dev,
 286                         "%s - network connection: %d\n", __func__, dr->wValue);
 287                 break;
 288
 289         case USB_CDC_NOTIFY_SERIAL_STATE:
 290                 if (le16_to_cpu(dr->wLength) != 2) {
 291                         dev_dbg(&acm->control->dev,
 292                                 "%s - malformed serial state\n", __func__);
 293                         break;
 294                 }
 295
 296                 newctrl = get_unaligned_le16(data);
 297                 dev_dbg(&acm->control->dev,
 298                         "%s - serial state: 0x%x\n", __func__, newctrl);
 299
 300                 if (!acm->clocal && (acm->ctrlin & ~newctrl & ACM_CTRL_DCD)) {
 301                         dev_dbg(&acm->control->dev,
 302                                 "%s - calling hangup\n", __func__);
 303                         tty_port_tty_hangup(&acm->port, false);
 304                 }
 305
 306                 difference = acm->ctrlin ^ newctrl;
 307                 spin_lock_irqsave(&acm->read_lock, flags);
 308                 acm->ctrlin = newctrl;
 309                 acm->oldcount = acm->iocount;
 310
 311                 if (difference & ACM_CTRL_DSR)
 312                         acm->iocount.dsr++;
 313                 if (difference & ACM_CTRL_DCD)
 314                         acm->iocount.dcd++;
 315                 if (newctrl & ACM_CTRL_BRK)
 316                         acm->iocount.brk++;
 317                 if (newctrl & ACM_CTRL_RI)
 318                         acm->iocount.rng++;
 319                 if (newctrl & ACM_CTRL_FRAMING)
 320                         acm->iocount.frame++;
 321                 if (newctrl & ACM_CTRL_PARITY)
 322                         acm->iocount.parity++;
 323                 if (newctrl & ACM_CTRL_OVERRUN)
 324                         acm->iocount.overrun++;
 325                 spin_unlock_irqrestore(&acm->read_lock, flags);
 326
 327                 if (difference)
 328                         wake_up_all(&acm->wioctl);
 329
 330                 break;
 331
 332         default:
 333                 dev_dbg(&acm->control->dev,
 334                         "%s - unknown notification %d received: index %d len %d\n",
 335                         __func__,
 336                         dr->bNotificationType, dr->wIndex, dr->wLength);
 337         }
 338 }
 339
 340 /* control interface reports status changes with "interrupt" transfers */
 341 static void acm_ctrl_irq(struct urb *urb)
 342 {
 343         struct acm *acm = urb->context;
 344         struct usb_cdc_notification *dr = urb->transfer_buffer;
 345         unsigned int current_size = urb->actual_length;
 346         unsigned int expected_size, copy_size, alloc_size;
 347         int retval;
 348         int status = urb->status;
 349
 350         switch (status) {
 351         case 0:
 352                 /* success */
 353                 break;
 354         case -ECONNRESET:
 355         case -ENOENT:
 356         case -ESHUTDOWN:
 357                 /* this urb is terminated, clean up */
 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
 413 exit:
 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
 420 static 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
 443 static 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
 457 static 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
 467 static void acm_read_bulk_callback(struct urb *urb)
 468 {
 469         struct acm_rb *rb = urb->context;
 470         struct acm *acm = rb->instance;
 471         int status = urb->status;
 472         bool stopped = false;
 473         bool stalled = false;
 474
 475         dev_vdbg(&acm->data->dev, "got urb %d, len %d, status %d\n",
 476                 rb->index, urb->actual_length, status);
 477
 478         if (!acm->dev) {
 479                 dev_dbg(&acm->data->dev, "%s - disconnected\n", __func__);
 480                 return;
 481         }
 482
 483         switch (status) {
 484         case 0:
 485                 usb_mark_last_busy(acm->dev);
 486                 acm_process_read_urb(acm, urb);
 487                 break;
 488         case -EPIPE:
 489                 set_bit(EVENT_RX_STALL, &acm->flags);
 490                 stalled = true;
 491                 break;
 492         case -ENOENT:
 493         case -ECONNRESET:
 494         case -ESHUTDOWN:
 495                 dev_dbg(&acm->data->dev,
 496                         "%s - urb shutting down with status: %d\n",
 497                         __func__, status);
 498                 stopped = true;
 499                 break;
 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          * Make sure URB processing is done before marking as free to avoid
 509          * racing with unthrottle() on another CPU. Matches the barriers
 510          * implied by the test_and_clear_bit() in acm_submit_read_urb().
 511          */
 512         smp_mb__before_atomic();
 513         set_bit(rb->index, &acm->read_urbs_free);
 514         /*
 515          * Make sure URB is marked as free before checking the throttled flag
 516          * to avoid racing with unthrottle() on another CPU. Matches the
 517          * smp_mb() in unthrottle().
 518          */
 519         smp_mb__after_atomic();
 520
 521         if (stopped || stalled) {
 522                 if (stalled)
 523                         schedule_work(&acm->work);
 524                 return;
 525         }
 526
 527         if (test_bit(ACM_THROTTLED, &acm->flags))
 528                 return;
 529
 530         acm_submit_read_urb(acm, rb->index, GFP_ATOMIC);
 531 }
 532
 533 /* data interface wrote those outgoing bytes */
 534 static void acm_write_bulk(struct urb *urb)
 535 {
 536         struct acm_wb *wb = urb->context;
 537         struct acm *acm = wb->instance;
 538         unsigned long flags;
 539         int status = urb->status;
 540
 541         if (status || (urb->actual_length != urb->transfer_buffer_length))
 542                 dev_vdbg(&acm->data->dev, "wrote len %d/%d, status %d\n",
 543                         urb->actual_length,
 544                         urb->transfer_buffer_length,
 545                         status);
 546
 547         spin_lock_irqsave(&acm->write_lock, flags);
 548         acm_write_done(acm, wb);
 549         spin_unlock_irqrestore(&acm->write_lock, flags);
 550         set_bit(EVENT_TTY_WAKEUP, &acm->flags);
 551         schedule_work(&acm->work);
 552 }
 553
 554 static void acm_softint(struct work_struct *work)
 555 {
 556         int i;
 557         struct acm *acm = container_of(work, struct acm, work);
 558
 559         if (test_bit(EVENT_RX_STALL, &acm->flags)) {
 560                 if (!(usb_autopm_get_interface(acm->data))) {
 561                         for (i = 0; i < acm->rx_buflimit; i++)
 562                                 usb_kill_urb(acm->read_urbs[i]);
 563                         usb_clear_halt(acm->dev, acm->in);
 564                         acm_submit_read_urbs(acm, GFP_KERNEL);
 565                         usb_autopm_put_interface(acm->data);
 566                 }
 567                 clear_bit(EVENT_RX_STALL, &acm->flags);
 568         }
 569
 570         if (test_and_clear_bit(EVENT_TTY_WAKEUP, &acm->flags))
 571                 tty_port_tty_wakeup(&acm->port);
 572 }
 573
 574 /*
 575  * TTY handlers
 576  */
 577
 578 static int acm_tty_install(struct tty_driver *driver, struct tty_struct *tty)
 579 {
 580         struct acm *acm;
 581         int retval;
 582
 583         acm = acm_get_by_minor(tty->index);
 584         if (!acm)
 585                 return -ENODEV;
 586
 587         retval = tty_standard_install(driver, tty);
 588         if (retval)
 589                 goto error_init_termios;
 590
 591         /*
 592          * Suppress initial echoing for some devices which might send data
 593          * immediately after acm driver has been installed.
 594          */
 595         if (acm->quirks & DISABLE_ECHO)
 596                 tty->termios.c_lflag &= ~ECHO;
 597
 598         tty->driver_data = acm;
 599
 600         return 0;
 601
 602 error_init_termios:
 603         tty_port_put(&acm->port);
 604         return retval;
 605 }
 606
 607 static int acm_tty_open(struct tty_struct *tty, struct file *filp)
 608 {
 609         struct acm *acm = tty->driver_data;
 610
 611         return tty_port_open(&acm->port, tty, filp);
 612 }
 613
 614 static void acm_port_dtr_rts(struct tty_port *port, int raise)
 615 {
 616         struct acm *acm = container_of(port, struct acm, port);
 617         int val;
 618         int res;
 619
 620         if (raise)
 621                 val = ACM_CTRL_DTR | ACM_CTRL_RTS;
 622         else
 623                 val = 0;
 624
 625         /* FIXME: add missing ctrlout locking throughout driver */
 626         acm->ctrlout = val;
 627
 628         res = acm_set_control(acm, val);
 629         if (res && (acm->ctrl_caps & USB_CDC_CAP_LINE))
 630                 dev_err(&acm->control->dev, "failed to set dtr/rts\n");
 631 }
 632
 633 static int acm_port_activate(struct tty_port *port, struct tty_struct *tty)
 634 {
 635         struct acm *acm = container_of(port, struct acm, port);
 636         int retval = -ENODEV;
 637         int i;
 638
 639         mutex_lock(&acm->mutex);
 640         if (acm->disconnected)
 641                 goto disconnected;
 642
 643         retval = usb_autopm_get_interface(acm->control);
 644         if (retval)
 645                 goto error_get_interface;
 646
 647         /*
 648          * FIXME: Why do we need this? Allocating 64K of physically contiguous
 649          * memory is really nasty...
 650          */
 651         set_bit(TTY_NO_WRITE_SPLIT, &tty->flags);
 652         acm->control->needs_remote_wakeup = 1;
 653
 654         acm->ctrlurb->dev = acm->dev;
 655         retval = usb_submit_urb(acm->ctrlurb, GFP_KERNEL);
 656         if (retval) {
 657                 dev_err(&acm->control->dev,
 658                         "%s - usb_submit_urb(ctrl irq) failed\n", __func__);
 659                 goto error_submit_urb;
 660         }
 661
 662         acm_tty_set_termios(tty, NULL);
 663
 664         /*
 665          * Unthrottle device in case the TTY was closed while throttled.
 666          */
 667         clear_bit(ACM_THROTTLED, &acm->flags);
 668
 669         retval = acm_submit_read_urbs(acm, GFP_KERNEL);
 670         if (retval)
 671                 goto error_submit_read_urbs;
 672
 673         usb_autopm_put_interface(acm->control);
 674
 675         mutex_unlock(&acm->mutex);
 676
 677         return 0;
 678
 679 error_submit_read_urbs:
 680         for (i = 0; i < acm->rx_buflimit; i++)
 681                 usb_kill_urb(acm->read_urbs[i]);
 682         usb_kill_urb(acm->ctrlurb);
 683 error_submit_urb:
 684         usb_autopm_put_interface(acm->control);
 685 error_get_interface:
 686 disconnected:
 687         mutex_unlock(&acm->mutex);
 688
 689         return usb_translate_errors(retval);
 690 }
 691
 692 static void acm_port_destruct(struct tty_port *port)
 693 {
 694         struct acm *acm = container_of(port, struct acm, port);
 695
 696         acm_release_minor(acm);
 697         usb_put_intf(acm->control);
 698         kfree(acm->country_codes);
 699         kfree(acm);
 700 }
 701
 702 static void acm_port_shutdown(struct tty_port *port)
 703 {
 704         struct acm *acm = container_of(port, struct acm, port);
 705         struct urb *urb;
 706         struct acm_wb *wb;
 707
 708         /*
 709          * Need to grab write_lock to prevent race with resume, but no need to
 710          * hold it due to the tty-port initialised flag.
 711          */
 712         spin_lock_irq(&acm->write_lock);
 713         spin_unlock_irq(&acm->write_lock);
 714
 715         usb_autopm_get_interface_no_resume(acm->control);
 716         acm->control->needs_remote_wakeup = 0;
 717         usb_autopm_put_interface(acm->control);
 718
 719         for (;;) {
 720                 urb = usb_get_from_anchor(&acm->delayed);
 721                 if (!urb)
 722                         break;
 723                 wb = urb->context;
 724                 wb->use = 0;
 725                 usb_autopm_put_interface_async(acm->control);
 726         }
 727
 728         acm_kill_urbs(acm);
 729 }
 730
 731 static void acm_tty_cleanup(struct tty_struct *tty)
 732 {
 733         struct acm *acm = tty->driver_data;
 734
 735         tty_port_put(&acm->port);
 736 }
 737
 738 static void acm_tty_hangup(struct tty_struct *tty)
 739 {
 740         struct acm *acm = tty->driver_data;
 741
 742         tty_port_hangup(&acm->port);
 743 }
 744
 745 static void acm_tty_close(struct tty_struct *tty, struct file *filp)
 746 {
 747         struct acm *acm = tty->driver_data;
 748
 749         tty_port_close(&acm->port, tty, filp);
 750 }
 751
 752 static int acm_tty_write(struct tty_struct *tty,
 753                                         const unsigned char *buf, int count)
 754 {
 755         struct acm *acm = tty->driver_data;
 756         int stat;
 757         unsigned long flags;
 758         int wbn;
 759         struct acm_wb *wb;
 760
 761         if (!count)
 762                 return 0;
 763
 764         dev_vdbg(&acm->data->dev, "%d bytes from tty layer\n", count);
 765
 766         spin_lock_irqsave(&acm->write_lock, flags);
 767         wbn = acm_wb_alloc(acm);
 768         if (wbn < 0) {
 769                 spin_unlock_irqrestore(&acm->write_lock, flags);
 770                 return 0;
 771         }
 772         wb = &acm->wb[wbn];
 773
 774         if (!acm->dev) {
 775                 wb->use = 0;
 776                 spin_unlock_irqrestore(&acm->write_lock, flags);
 777                 return -ENODEV;
 778         }
 779
 780         count = (count > acm->writesize) ? acm->writesize : count;
 781         dev_vdbg(&acm->data->dev, "writing %d bytes\n", count);
 782         memcpy(wb->buf, buf, count);
 783         wb->len = count;
 784
 785         stat = usb_autopm_get_interface_async(acm->control);
 786         if (stat) {
 787                 wb->use = 0;
 788                 spin_unlock_irqrestore(&acm->write_lock, flags);
 789                 return stat;
 790         }
 791
 792         if (acm->susp_count) {
 793                 usb_anchor_urb(wb->urb, &acm->delayed);
 794                 spin_unlock_irqrestore(&acm->write_lock, flags);
 795                 return count;
 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
 806 static int acm_tty_write_room(struct tty_struct *tty)
 807 {
 808         struct acm *acm = tty->driver_data;
 809         /*
 810          * Do not let the line discipline to know that we have a reserve,
 811          * or it might get too enthusiastic.
 812          */
 813         return acm_wb_is_avail(acm) ? acm->writesize : 0;
 814 }
 815
 816 static int acm_tty_chars_in_buffer(struct tty_struct *tty)
 817 {
 818         struct acm *acm = tty->driver_data;
 819         /*
 820          * if the device was unplugged then any remaining characters fell out
 821          * of the connector ;)
 822          */
 823         if (acm->disconnected)
 824                 return 0;
 825         /*
 826          * This is inaccurate (overcounts), but it works.
 827          */
 828         return (ACM_NW - acm_wb_is_avail(acm)) * acm->writesize;
 829 }
 830
 831 static void acm_tty_throttle(struct tty_struct *tty)
 832 {
 833         struct acm *acm = tty->driver_data;
 834
 835         set_bit(ACM_THROTTLED, &acm->flags);
 836 }
 837
 838 static void acm_tty_unthrottle(struct tty_struct *tty)
 839 {
 840         struct acm *acm = tty->driver_data;
 841
 842         clear_bit(ACM_THROTTLED, &acm->flags);
 843
 844         /* Matches the smp_mb__after_atomic() in acm_read_bulk_callback(). */
 845         smp_mb();
 846
 847         acm_submit_read_urbs(acm, GFP_KERNEL);
 848 }
 849
 850 static int acm_tty_break_ctl(struct tty_struct *tty, int state)
 851 {
 852         struct acm *acm = tty->driver_data;
 853         int retval;
 854
 855         retval = acm_send_break(acm, state ? 0xffff : 0);
 856         if (retval < 0)
 857                 dev_dbg(&acm->control->dev,
 858                         "%s - send break failed\n", __func__);
 859         return retval;
 860 }
 861
 862 static int acm_tty_tiocmget(struct tty_struct *tty)
 863 {
 864         struct acm *acm = tty->driver_data;
 865
 866         return (acm->ctrlout & ACM_CTRL_DTR ? TIOCM_DTR : 0) |
 867                (acm->ctrlout & ACM_CTRL_RTS ? TIOCM_RTS : 0) |
 868                (acm->ctrlin  & ACM_CTRL_DSR ? TIOCM_DSR : 0) |
 869                (acm->ctrlin  & ACM_CTRL_RI  ? TIOCM_RI  : 0) |
 870                (acm->ctrlin  & ACM_CTRL_DCD ? TIOCM_CD  : 0) |
 871                TIOCM_CTS;
 872 }
 873
 874 static int acm_tty_tiocmset(struct tty_struct *tty,
 875                             unsigned int set, unsigned int clear)
 876 {
 877         struct acm *acm = tty->driver_data;
 878         unsigned int newctrl;
 879
 880         newctrl = acm->ctrlout;
 881         set = (set & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
 882                                         (set & TIOCM_RTS ? ACM_CTRL_RTS : 0);
 883         clear = (clear & TIOCM_DTR ? ACM_CTRL_DTR : 0) |
 884                                         (clear & TIOCM_RTS ? ACM_CTRL_RTS : 0);
 885
 886         newctrl = (newctrl & ~clear) | set;
 887
 888         if (acm->ctrlout == newctrl)
 889                 return 0;
 890         return acm_set_control(acm, acm->ctrlout = newctrl);
 891 }
 892
 893 static int get_serial_info(struct tty_struct *tty, struct serial_struct *ss)
 894 {
 895         struct acm *acm = tty->driver_data;
 896
 897         ss->xmit_fifo_size = acm->writesize;
 898         ss->baud_base = le32_to_cpu(acm->line.dwDTERate);
 899         ss->close_delay = jiffies_to_msecs(acm->port.close_delay) / 10;
 900         ss->closing_wait = acm->port.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
 901                                 ASYNC_CLOSING_WAIT_NONE :
 902                                 jiffies_to_msecs(acm->port.closing_wait) / 10;
 903         return 0;
 904 }
 905
 906 static int set_serial_info(struct tty_struct *tty, struct serial_struct *ss)
 907 {
 908         struct acm *acm = tty->driver_data;
 909         unsigned int closing_wait, close_delay;
 910         int retval = 0;
 911
 912         close_delay = msecs_to_jiffies(ss->close_delay * 10);
 913         closing_wait = ss->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
 914                         ASYNC_CLOSING_WAIT_NONE :
 915                         msecs_to_jiffies(ss->closing_wait * 10);
 916
 917         mutex_lock(&acm->port.mutex);
 918
 919         if (!capable(CAP_SYS_ADMIN)) {
 920                 if ((close_delay != acm->port.close_delay) ||
 921                     (closing_wait != acm->port.closing_wait))
 922                         retval = -EPERM;
 923                 else
 924                         retval = -EOPNOTSUPP;
 925         } else {
 926                 acm->port.close_delay  = close_delay;
 927                 acm->port.closing_wait = closing_wait;
 928         }
 929
 930         mutex_unlock(&acm->port.mutex);
 931         return retval;
 932 }
 933
 934 static int wait_serial_change(struct acm *acm, unsigned long arg)
 935 {
 936         int rv = 0;
 937         DECLARE_WAITQUEUE(wait, current);
 938         struct async_icount old, new;
 939
 940         do {
 941                 spin_lock_irq(&acm->read_lock);
 942                 old = acm->oldcount;
 943                 new = acm->iocount;
 944                 acm->oldcount = new;
 945                 spin_unlock_irq(&acm->read_lock);
 946
 947                 if ((arg & TIOCM_DSR) &&
 948                         old.dsr != new.dsr)
 949                         break;
 950                 if ((arg & TIOCM_CD)  &&
 951                         old.dcd != new.dcd)
 952                         break;
 953                 if ((arg & TIOCM_RI) &&
 954                         old.rng != new.rng)
 955                         break;
 956
 957                 add_wait_queue(&acm->wioctl, &wait);
 958                 set_current_state(TASK_INTERRUPTIBLE);
 959                 schedule();
 960                 remove_wait_queue(&acm->wioctl, &wait);
 961                 if (acm->disconnected) {
 962                         if (arg & TIOCM_CD)
 963                                 break;
 964                         else
 965                                 rv = -ENODEV;
 966                 } else {
 967                         if (signal_pending(current))
 968                                 rv = -ERESTARTSYS;
 969                 }
 970         } while (!rv);
 971
 972
 973
 974         return rv;
 975 }
 976
 977 static int acm_tty_get_icount(struct tty_struct *tty,
 978                                         struct serial_icounter_struct *icount)
 979 {
 980         struct acm *acm = tty->driver_data;
 981
 982         icount->dsr = acm->iocount.dsr;
 983         icount->rng = acm->iocount.rng;
 984         icount->dcd = acm->iocount.dcd;
 985         icount->frame = acm->iocount.frame;
 986         icount->overrun = acm->iocount.overrun;
 987         icount->parity = acm->iocount.parity;
 988         icount->brk = acm->iocount.brk;
 989
 990         return 0;
 991 }
 992
 993 static int acm_tty_ioctl(struct tty_struct *tty,
 994                                         unsigned int cmd, unsigned long arg)
 995 {
 996         struct acm *acm = tty->driver_data;
 997         int rv = -ENOIOCTLCMD;
 998
 999         switch (cmd) {
1000         case TIOCMIWAIT:
1001                 rv = usb_autopm_get_interface(acm->control);
1002                 if (rv < 0) {
1003                         rv = -EIO;
1004                         break;
1005                 }
1006                 rv = wait_serial_change(acm, arg);
1007                 usb_autopm_put_interface(acm->control);
1008                 break;
1009         }
1010
1011         return rv;
1012 }
1013
1014 static void acm_tty_set_termios(struct tty_struct *tty,
1015                                                 struct ktermios *termios_old)
1016 {
1017         struct acm *acm = tty->driver_data;
1018         struct ktermios *termios = &tty->termios;
1019         struct usb_cdc_line_coding newline;
1020         int newctrl = acm->ctrlout;
1021
1022         newline.dwDTERate = cpu_to_le32(tty_get_baud_rate(tty));
1023         newline.bCharFormat = termios->c_cflag & CSTOPB ? 2 : 0;
1024         newline.bParityType = termios->c_cflag & PARENB ?
1025                                 (termios->c_cflag & PARODD ? 1 : 2) +
1026                                 (termios->c_cflag & CMSPAR ? 2 : 0) : 0;
1027         switch (termios->c_cflag & CSIZE) {
1028         case CS5:
1029                 newline.bDataBits = 5;
1030                 break;
1031         case CS6:
1032                 newline.bDataBits = 6;
1033                 break;
1034         case CS7:
1035                 newline.bDataBits = 7;
1036                 break;
1037         case CS8:
1038         default:
1039                 newline.bDataBits = 8;
1040                 break;
1041         }
1042         /* FIXME: Needs to clear unsupported bits in the termios */
1043         acm->clocal = ((termios->c_cflag & CLOCAL) != 0);
1044
1045         if (C_BAUD(tty) == B0) {
1046                 newline.dwDTERate = acm->line.dwDTERate;
1047                 newctrl &= ~ACM_CTRL_DTR;
1048         } else if (termios_old && (termios_old->c_cflag & CBAUD) == B0) {
1049                 newctrl |=  ACM_CTRL_DTR;
1050         }
1051
1052         if (newctrl != acm->ctrlout)
1053                 acm_set_control(acm, acm->ctrlout = newctrl);
1054
1055         if (memcmp(&acm->line, &newline, sizeof newline)) {
1056                 memcpy(&acm->line, &newline, sizeof newline);
1057                 dev_dbg(&acm->control->dev, "%s - set line: %d %d %d %d\n",
1058                         __func__,
1059                         le32_to_cpu(newline.dwDTERate),
1060                         newline.bCharFormat, newline.bParityType,
1061                         newline.bDataBits);
1062                 acm_set_line(acm, &acm->line);
1063         }
1064 }
1065
1066 static const struct tty_port_operations acm_port_ops = {
1067         .dtr_rts = acm_port_dtr_rts,
1068         .shutdown = acm_port_shutdown,
1069         .activate = acm_port_activate,
1070         .destruct = acm_port_destruct,
1071 };
1072
1073 /*
1074  * USB probe and disconnect routines.
1075  */
1076
1077 /* Little helpers: write/read buffers free */
1078 static void acm_write_buffers_free(struct acm *acm)
1079 {
1080         int i;
1081         struct acm_wb *wb;
1082
1083         for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++)
1084                 usb_free_coherent(acm->dev, acm->writesize, wb->buf, wb->dmah);
1085 }
1086
1087 static void acm_read_buffers_free(struct acm *acm)
1088 {
1089         int i;
1090
1091         for (i = 0; i < acm->rx_buflimit; i++)
1092                 usb_free_coherent(acm->dev, acm->readsize,
1093                           acm->read_buffers[i].base, acm->read_buffers[i].dma);
1094 }
1095
1096 /* Little helper: write buffers allocate */
1097 static int acm_write_buffers_alloc(struct acm *acm)
1098 {
1099         int i;
1100         struct acm_wb *wb;
1101
1102         for (wb = &acm->wb[0], i = 0; i < ACM_NW; i++, wb++) {
1103                 wb->buf = usb_alloc_coherent(acm->dev, acm->writesize, GFP_KERNEL,
1104                     &wb->dmah);
1105                 if (!wb->buf) {
1106                         while (i != 0) {
1107                                 --i;
1108                                 --wb;
1109                                 usb_free_coherent(acm->dev, acm->writesize,
1110                                     wb->buf, wb->dmah);
1111                         }
1112                         return -ENOMEM;
1113                 }
1114         }
1115         return 0;
1116 }
1117
1118 static int acm_probe(struct usb_interface *intf,
1119                      const struct usb_device_id *id)
1120 {
1121         struct usb_cdc_union_desc *union_header = NULL;
1122         struct usb_cdc_call_mgmt_descriptor *cmgmd = NULL;
1123         unsigned char *buffer = intf->altsetting->extra;
1124         int buflen = intf->altsetting->extralen;
1125         struct usb_interface *control_interface;
1126         struct usb_interface *data_interface;
1127         struct usb_endpoint_descriptor *epctrl = NULL;
1128         struct usb_endpoint_descriptor *epread = NULL;
1129         struct usb_endpoint_descriptor *epwrite = NULL;
1130         struct usb_device *usb_dev = interface_to_usbdev(intf);
1131         struct usb_cdc_parsed_header h;
1132         struct acm *acm;
1133         int minor;
1134         int ctrlsize, readsize;
1135         u8 *buf;
1136         int call_intf_num = -1;
1137         int data_intf_num = -1;
1138         unsigned long quirks;
1139         int num_rx_buf;
1140         int i;
1141         int combined_interfaces = 0;
1142         struct device *tty_dev;
1143         int rv = -ENOMEM;
1144         int res;
1145
1146         /* normal quirks */
1147         quirks = (unsigned long)id->driver_info;
1148
1149         if (quirks == IGNORE_DEVICE)
1150                 return -ENODEV;
1151
1152         memset(&h, 0x00, sizeof(struct usb_cdc_parsed_header));
1153
1154         num_rx_buf = (quirks == SINGLE_RX_URB) ? 1 : ACM_NR;
1155
1156         /* handle quirks deadly to normal probing*/
1157         if (quirks == NO_UNION_NORMAL) {
1158                 data_interface = usb_ifnum_to_if(usb_dev, 1);
1159                 control_interface = usb_ifnum_to_if(usb_dev, 0);
1160                 /* we would crash */
1161                 if (!data_interface || !control_interface)
1162                         return -ENODEV;
1163                 goto skip_normal_probe;
1164         }
1165
1166         /* normal probing*/
1167         if (!buffer) {
1168                 dev_err(&intf->dev, "Weird descriptor references\n");
1169                 return -EINVAL;
1170         }
1171
1172         if (!intf->cur_altsetting)
1173                 return -EINVAL;
1174
1175         if (!buflen) {
1176                 if (intf->cur_altsetting->endpoint &&
1177                                 intf->cur_altsetting->endpoint->extralen &&
1178                                 intf->cur_altsetting->endpoint->extra) {
1179                         dev_dbg(&intf->dev,
1180                                 "Seeking extra descriptors on endpoint\n");
1181                         buflen = intf->cur_altsetting->endpoint->extralen;
1182                         buffer = intf->cur_altsetting->endpoint->extra;
1183                 } else {
1184                         dev_err(&intf->dev,
1185                                 "Zero length descriptor references\n");
1186                         return -EINVAL;
1187                 }
1188         }
1189
1190         cdc_parse_cdc_header(&h, intf, buffer, buflen);
1191         union_header = h.usb_cdc_union_desc;
1192         cmgmd = h.usb_cdc_call_mgmt_descriptor;
1193         if (cmgmd)
1194                 call_intf_num = cmgmd->bDataInterface;
1195
1196         if (!union_header) {
1197                 if (call_intf_num > 0) {
1198                         dev_dbg(&intf->dev, "No union descriptor, using call management descriptor\n");
1199                         /* quirks for Droids MuIn LCD */
1200                         if (quirks & NO_DATA_INTERFACE) {
1201                                 data_interface = usb_ifnum_to_if(usb_dev, 0);
1202                         } else {
1203                                 data_intf_num = call_intf_num;
1204                                 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1205                         }
1206                         control_interface = intf;
1207                 } else {
1208                         if (intf->cur_altsetting->desc.bNumEndpoints != 3) {
1209                                 dev_dbg(&intf->dev,"No union descriptor, giving up\n");
1210                                 return -ENODEV;
1211                         } else {
1212                                 dev_warn(&intf->dev,"No union descriptor, testing for castrated device\n");
1213                                 combined_interfaces = 1;
1214                                 control_interface = data_interface = intf;
1215                                 goto look_for_collapsed_interface;
1216                         }
1217                 }
1218         } else {
1219                 data_intf_num = union_header->bSlaveInterface0;
1220                 control_interface = usb_ifnum_to_if(usb_dev, union_header->bMasterInterface0);
1221                 data_interface = usb_ifnum_to_if(usb_dev, data_intf_num);
1222         }
1223
1224         if (!control_interface || !data_interface) {
1225                 dev_dbg(&intf->dev, "no interfaces\n");
1226                 return -ENODEV;
1227         }
1228         if (!data_interface->cur_altsetting || !control_interface->cur_altsetting)
1229                 return -ENODEV;
1230
1231         if (data_intf_num != call_intf_num)
1232                 dev_dbg(&intf->dev, "Separate call control interface. That is not fully supported.\n");
1233
1234         if (control_interface == data_interface) {
1235                 /* some broken devices designed for windows work this way */
1236                 dev_warn(&intf->dev,"Control and data interfaces are not separated!\n");
1237                 combined_interfaces = 1;
1238                 /* a popular other OS doesn't use it */
1239                 quirks |= NO_CAP_LINE;
1240                 if (data_interface->cur_altsetting->desc.bNumEndpoints != 3) {
1241                         dev_err(&intf->dev, "This needs exactly 3 endpoints\n");
1242                         return -EINVAL;
1243                 }
1244 look_for_collapsed_interface:
1245                 res = usb_find_common_endpoints(data_interface->cur_altsetting,
1246                                 &epread, &epwrite, &epctrl, NULL);
1247                 if (res)
1248                         return res;
1249
1250                 goto made_compressed_probe;
1251         }
1252
1253 skip_normal_probe:
1254
1255         /*workaround for switched interfaces */
1256         if (data_interface->cur_altsetting->desc.bInterfaceClass
1257                                                 != CDC_DATA_INTERFACE_TYPE) {
1258                 if (control_interface->cur_altsetting->desc.bInterfaceClass
1259                                                 == CDC_DATA_INTERFACE_TYPE) {
1260                         dev_dbg(&intf->dev,
1261                                 "Your device has switched interfaces.\n");
1262                         swap(control_interface, data_interface);
1263                 } else {
1264                         return -EINVAL;
1265                 }
1266         }
1267
1268         /* Accept probe requests only for the control interface */
1269         if (!combined_interfaces && intf != control_interface)
1270                 return -ENODEV;
1271
1272         if (!combined_interfaces && usb_interface_claimed(data_interface)) {
1273                 /* valid in this context */
1274                 dev_dbg(&intf->dev, "The data interface isn't available\n");
1275                 return -EBUSY;
1276         }
1277
1278
1279         if (data_interface->cur_altsetting->desc.bNumEndpoints < 2 ||
1280             control_interface->cur_altsetting->desc.bNumEndpoints == 0)
1281                 return -EINVAL;
1282
1283         epctrl = &control_interface->cur_altsetting->endpoint[0].desc;
1284         epread = &data_interface->cur_altsetting->endpoint[0].desc;
1285         epwrite = &data_interface->cur_altsetting->endpoint[1].desc;
1286
1287
1288         /* workaround for switched endpoints */
1289         if (!usb_endpoint_dir_in(epread)) {
1290                 /* descriptors are swapped */
1291                 dev_dbg(&intf->dev,
1292                         "The data interface has switched endpoints\n");
1293                 swap(epread, epwrite);
1294         }
1295 made_compressed_probe:
1296         dev_dbg(&intf->dev, "interfaces are valid\n");
1297
1298         acm = kzalloc(sizeof(struct acm), GFP_KERNEL);
1299         if (acm == NULL)
1300                 goto alloc_fail;
1301
1302         tty_port_init(&acm->port);
1303         acm->port.ops = &acm_port_ops;
1304
1305         ctrlsize = usb_endpoint_maxp(epctrl);
1306         readsize = usb_endpoint_maxp(epread) *
1307                                 (quirks == SINGLE_RX_URB ? 1 : 2);
1308         acm->combined_interfaces = combined_interfaces;
1309         acm->writesize = usb_endpoint_maxp(epwrite) * 20;
1310         acm->control = control_interface;
1311         acm->data = data_interface;
1312
1313         usb_get_intf(acm->control); /* undone in destruct() */
1314
1315         minor = acm_alloc_minor(acm);
1316         if (minor < 0)
1317                 goto alloc_fail1;
1318
1319         acm->minor = minor;
1320         acm->dev = usb_dev;
1321         if (h.usb_cdc_acm_descriptor)
1322                 acm->ctrl_caps = h.usb_cdc_acm_descriptor->bmCapabilities;
1323         if (quirks & NO_CAP_LINE)
1324                 acm->ctrl_caps &= ~USB_CDC_CAP_LINE;
1325         acm->ctrlsize = ctrlsize;
1326         acm->readsize = readsize;
1327         acm->rx_buflimit = num_rx_buf;
1328         INIT_WORK(&acm->work, acm_softint);
1329         init_waitqueue_head(&acm->wioctl);
1330         spin_lock_init(&acm->write_lock);
1331         spin_lock_init(&acm->read_lock);
1332         mutex_init(&acm->mutex);
1333         if (usb_endpoint_xfer_int(epread)) {
1334                 acm->bInterval = epread->bInterval;
1335                 acm->in = usb_rcvintpipe(usb_dev, epread->bEndpointAddress);
1336         } else {
1337                 acm->in = usb_rcvbulkpipe(usb_dev, epread->bEndpointAddress);
1338         }
1339         if (usb_endpoint_xfer_int(epwrite))
1340                 acm->out = usb_sndintpipe(usb_dev, epwrite->bEndpointAddress);
1341         else
1342                 acm->out = usb_sndbulkpipe(usb_dev, epwrite->bEndpointAddress);
1343         init_usb_anchor(&acm->delayed);
1344         acm->quirks = quirks;
1345
1346         buf = usb_alloc_coherent(usb_dev, ctrlsize, GFP_KERNEL, &acm->ctrl_dma);
1347         if (!buf)
1348                 goto alloc_fail1;
1349         acm->ctrl_buffer = buf;
1350
1351         if (acm_write_buffers_alloc(acm) < 0)
1352                 goto alloc_fail2;
1353
1354         acm->ctrlurb = usb_alloc_urb(0, GFP_KERNEL);
1355         if (!acm->ctrlurb)
1356                 goto alloc_fail3;
1357
1358         for (i = 0; i < num_rx_buf; i++) {
1359                 struct acm_rb *rb = &(acm->read_buffers[i]);
1360                 struct urb *urb;
1361
1362                 rb->base = usb_alloc_coherent(acm->dev, readsize, GFP_KERNEL,
1363                                                                 &rb->dma);
1364                 if (!rb->base)
1365                         goto alloc_fail4;
1366                 rb->index = i;
1367                 rb->instance = acm;
1368
1369                 urb = usb_alloc_urb(0, GFP_KERNEL);
1370                 if (!urb)
1371                         goto alloc_fail4;
1372
1373                 urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1374                 urb->transfer_dma = rb->dma;
1375                 if (usb_endpoint_xfer_int(epread))
1376                         usb_fill_int_urb(urb, acm->dev, acm->in, rb->base,
1377                                          acm->readsize,
1378                                          acm_read_bulk_callback, rb,
1379                                          acm->bInterval);
1380                 else
1381                         usb_fill_bulk_urb(urb, acm->dev, acm->in, rb->base,
1382                                           acm->readsize,
1383                                           acm_read_bulk_callback, rb);
1384
1385                 acm->read_urbs[i] = urb;
1386                 __set_bit(i, &acm->read_urbs_free);
1387         }
1388         for (i = 0; i < ACM_NW; i++) {
1389                 struct acm_wb *snd = &(acm->wb[i]);
1390
1391                 snd->urb = usb_alloc_urb(0, GFP_KERNEL);
1392                 if (snd->urb == NULL)
1393                         goto alloc_fail5;
1394
1395                 if (usb_endpoint_xfer_int(epwrite))
1396                         usb_fill_int_urb(snd->urb, usb_dev, acm->out,
1397                                 NULL, acm->writesize, acm_write_bulk, snd, epwrite->bInterval);
1398                 else
1399                         usb_fill_bulk_urb(snd->urb, usb_dev, acm->out,
1400                                 NULL, acm->writesize, acm_write_bulk, snd);
1401                 snd->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1402                 if (quirks & SEND_ZERO_PACKET)
1403                         snd->urb->transfer_flags |= URB_ZERO_PACKET;
1404                 snd->instance = acm;
1405         }
1406
1407         usb_set_intfdata(intf, acm);
1408
1409         i = device_create_file(&intf->dev, &dev_attr_bmCapabilities);
1410         if (i < 0)
1411                 goto alloc_fail5;
1412
1413         if (h.usb_cdc_country_functional_desc) { /* export the country data */
1414                 struct usb_cdc_country_functional_desc * cfd =
1415                                         h.usb_cdc_country_functional_desc;
1416
1417                 acm->country_codes = kmalloc(cfd->bLength - 4, GFP_KERNEL);
1418                 if (!acm->country_codes)
1419                         goto skip_countries;
1420                 acm->country_code_size = cfd->bLength - 4;
1421                 memcpy(acm->country_codes, (u8 *)&cfd->wCountyCode0,
1422                                                         cfd->bLength - 4);
1423                 acm->country_rel_date = cfd->iCountryCodeRelDate;
1424
1425                 i = device_create_file(&intf->dev, &dev_attr_wCountryCodes);
1426                 if (i < 0) {
1427                         kfree(acm->country_codes);
1428                         acm->country_codes = NULL;
1429                         acm->country_code_size = 0;
1430                         goto skip_countries;
1431                 }
1432
1433                 i = device_create_file(&intf->dev,
1434                                                 &dev_attr_iCountryCodeRelDate);
1435                 if (i < 0) {
1436                         device_remove_file(&intf->dev, &dev_attr_wCountryCodes);
1437                         kfree(acm->country_codes);
1438                         acm->country_codes = NULL;
1439                         acm->country_code_size = 0;
1440                         goto skip_countries;
1441                 }
1442         }
1443
1444 skip_countries:
1445         usb_fill_int_urb(acm->ctrlurb, usb_dev,
1446                          usb_rcvintpipe(usb_dev, epctrl->bEndpointAddress),
1447                          acm->ctrl_buffer, ctrlsize, acm_ctrl_irq, acm,
1448                          /* works around buggy devices */
1449                          epctrl->bInterval ? epctrl->bInterval : 16);
1450         acm->ctrlurb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1451         acm->ctrlurb->transfer_dma = acm->ctrl_dma;
1452         acm->notification_buffer = NULL;
1453         acm->nb_index = 0;
1454         acm->nb_size = 0;
1455
1456         dev_info(&intf->dev, "ttyACM%d: USB ACM device\n", minor);
1457
1458         acm->line.dwDTERate = cpu_to_le32(9600);
1459         acm->line.bDataBits = 8;
1460         acm_set_line(acm, &acm->line);
1461
1462         usb_driver_claim_interface(&acm_driver, data_interface, acm);
1463         usb_set_intfdata(data_interface, acm);
1464
1465         tty_dev = tty_port_register_device(&acm->port, acm_tty_driver, minor,
1466                         &control_interface->dev);
1467         if (IS_ERR(tty_dev)) {
1468                 rv = PTR_ERR(tty_dev);
1469                 goto alloc_fail6;
1470         }
1471
1472         if (quirks & CLEAR_HALT_CONDITIONS) {
1473                 usb_clear_halt(usb_dev, acm->in);
1474                 usb_clear_halt(usb_dev, acm->out);
1475         }
1476
1477         return 0;
1478 alloc_fail6:
1479         if (acm->country_codes) {
1480                 device_remove_file(&acm->control->dev,
1481                                 &dev_attr_wCountryCodes);
1482                 device_remove_file(&acm->control->dev,
1483                                 &dev_attr_iCountryCodeRelDate);
1484                 kfree(acm->country_codes);
1485         }
1486         device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1487 alloc_fail5:
1488         usb_set_intfdata(intf, NULL);
1489         for (i = 0; i < ACM_NW; i++)
1490                 usb_free_urb(acm->wb[i].urb);
1491 alloc_fail4:
1492         for (i = 0; i < num_rx_buf; i++)
1493                 usb_free_urb(acm->read_urbs[i]);
1494         acm_read_buffers_free(acm);
1495         usb_free_urb(acm->ctrlurb);
1496 alloc_fail3:
1497         acm_write_buffers_free(acm);
1498 alloc_fail2:
1499         usb_free_coherent(usb_dev, ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1500 alloc_fail1:
1501         tty_port_put(&acm->port);
1502 alloc_fail:
1503         return rv;
1504 }
1505
1506 static void acm_disconnect(struct usb_interface *intf)
1507 {
1508         struct acm *acm = usb_get_intfdata(intf);
1509         struct tty_struct *tty;
1510         int i;
1511
1512         /* sibling interface is already cleaning up */
1513         if (!acm)
1514                 return;
1515
1516         mutex_lock(&acm->mutex);
1517         acm->disconnected = true;
1518         if (acm->country_codes) {
1519                 device_remove_file(&acm->control->dev,
1520                                 &dev_attr_wCountryCodes);
1521                 device_remove_file(&acm->control->dev,
1522                                 &dev_attr_iCountryCodeRelDate);
1523         }
1524         wake_up_all(&acm->wioctl);
1525         device_remove_file(&acm->control->dev, &dev_attr_bmCapabilities);
1526         usb_set_intfdata(acm->control, NULL);
1527         usb_set_intfdata(acm->data, NULL);
1528         mutex_unlock(&acm->mutex);
1529
1530         tty = tty_port_tty_get(&acm->port);
1531         if (tty) {
1532                 tty_vhangup(tty);
1533                 tty_kref_put(tty);
1534         }
1535
1536         acm_kill_urbs(acm);
1537         cancel_work_sync(&acm->work);
1538
1539         tty_unregister_device(acm_tty_driver, acm->minor);
1540
1541         usb_free_urb(acm->ctrlurb);
1542         for (i = 0; i < ACM_NW; i++)
1543                 usb_free_urb(acm->wb[i].urb);
1544         for (i = 0; i < acm->rx_buflimit; i++)
1545                 usb_free_urb(acm->read_urbs[i]);
1546         acm_write_buffers_free(acm);
1547         usb_free_coherent(acm->dev, acm->ctrlsize, acm->ctrl_buffer, acm->ctrl_dma);
1548         acm_read_buffers_free(acm);
1549
1550         kfree(acm->notification_buffer);
1551
1552         if (!acm->combined_interfaces)
1553                 usb_driver_release_interface(&acm_driver, intf == acm->control ?
1554                                         acm->data : acm->control);
1555
1556         tty_port_put(&acm->port);
1557 }
1558
1559 #ifdef CONFIG_PM
1560 static int acm_suspend(struct usb_interface *intf, pm_message_t message)
1561 {
1562         struct acm *acm = usb_get_intfdata(intf);
1563         int cnt;
1564
1565         spin_lock_irq(&acm->write_lock);
1566         if (PMSG_IS_AUTO(message)) {
1567                 if (acm->transmitting) {
1568                         spin_unlock_irq(&acm->write_lock);
1569                         return -EBUSY;
1570                 }
1571         }
1572         cnt = acm->susp_count++;
1573         spin_unlock_irq(&acm->write_lock);
1574
1575         if (cnt)
1576                 return 0;
1577
1578         acm_kill_urbs(acm);
1579         cancel_work_sync(&acm->work);
1580
1581         return 0;
1582 }
1583
1584 static int acm_resume(struct usb_interface *intf)
1585 {
1586         struct acm *acm = usb_get_intfdata(intf);
1587         struct urb *urb;
1588         int rv = 0;
1589
1590         spin_lock_irq(&acm->write_lock);
1591
1592         if (--acm->susp_count)
1593                 goto out;
1594
1595         if (tty_port_initialized(&acm->port)) {
1596                 rv = usb_submit_urb(acm->ctrlurb, GFP_ATOMIC);
1597
1598                 for (;;) {
1599                         urb = usb_get_from_anchor(&acm->delayed);
1600                         if (!urb)
1601                                 break;
1602
1603                         acm_start_wb(acm, urb->context);
1604                 }
1605
1606                 /*
1607                  * delayed error checking because we must
1608                  * do the write path at all cost
1609                  */
1610                 if (rv < 0)
1611                         goto out;
1612
1613                 rv = acm_submit_read_urbs(acm, GFP_ATOMIC);
1614         }
1615 out:
1616         spin_unlock_irq(&acm->write_lock);
1617
1618         return rv;
1619 }
1620
1621 static int acm_reset_resume(struct usb_interface *intf)
1622 {
1623         struct acm *acm = usb_get_intfdata(intf);
1624
1625         if (tty_port_initialized(&acm->port))
1626                 tty_port_tty_hangup(&acm->port, false);
1627
1628         return acm_resume(intf);
1629 }
1630
1631 #endif /* CONFIG_PM */
1632
1633 static int acm_pre_reset(struct usb_interface *intf)
1634 {
1635         struct acm *acm = usb_get_intfdata(intf);
1636
1637         clear_bit(EVENT_RX_STALL, &acm->flags);
1638         acm->nb_index = 0; /* pending control transfers are lost */
1639
1640         return 0;
1641 }
1642
1643 #define NOKIA_PCSUITE_ACM_INFO(x) \
1644                 USB_DEVICE_AND_INTERFACE_INFO(0x0421, x, \
1645                 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1646                 USB_CDC_ACM_PROTO_VENDOR)
1647
1648 #define SAMSUNG_PCSUITE_ACM_INFO(x) \
1649                 USB_DEVICE_AND_INTERFACE_INFO(0x04e7, x, \
1650                 USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM, \
1651                 USB_CDC_ACM_PROTO_VENDOR)
1652
1653 /*
1654  * USB driver structure.
1655  */
1656
1657 static const struct usb_device_id acm_ids[] = {
1658         /* quirky and broken devices */
1659         { USB_DEVICE(0x076d, 0x0006), /* Denso Cradle CU-321 */
1660         .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1661         { USB_DEVICE(0x17ef, 0x7000), /* Lenovo USB modem */
1662         .driver_info = NO_UNION_NORMAL, },/* has no union descriptor */
1663         { USB_DEVICE(0x0870, 0x0001), /* Metricom GS Modem */
1664         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1665         },
1666         { USB_DEVICE(0x0e8d, 0x0003), /* FIREFLY, MediaTek Inc; andrey.arapov@gmail.com */
1667         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1668         },
1669         { USB_DEVICE(0x0e8d, 0x2000), /* MediaTek Inc Preloader */
1670         .driver_info = DISABLE_ECHO, /* DISABLE ECHO in termios flag */
1671         },
1672         { USB_DEVICE(0x0e8d, 0x3329), /* MediaTek Inc GPS */
1673         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1674         },
1675         { USB_DEVICE(0x0482, 0x0203), /* KYOCERA AH-K3001V */
1676         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1677         },
1678         { USB_DEVICE(0x079b, 0x000f), /* BT On-Air USB MODEM */
1679         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1680         },
1681         { USB_DEVICE(0x0ace, 0x1602), /* ZyDAS 56K USB MODEM */
1682         .driver_info = SINGLE_RX_URB,
1683         },
1684         { USB_DEVICE(0x0ace, 0x1608), /* ZyDAS 56K USB MODEM */
1685         .driver_info = SINGLE_RX_URB, /* firmware bug */
1686         },
1687         { USB_DEVICE(0x0ace, 0x1611), /* ZyDAS 56K USB MODEM - new version */
1688         .driver_info = SINGLE_RX_URB, /* firmware bug */
1689         },
1690         { USB_DEVICE(0x11ca, 0x0201), /* VeriFone Mx870 Gadget Serial */
1691         .driver_info = SINGLE_RX_URB,
1692         },
1693         { USB_DEVICE(0x1965, 0x0018), /* Uniden UBC125XLT */
1694         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1695         },
1696         { USB_DEVICE(0x22b8, 0x7000), /* Motorola Q Phone */
1697         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1698         },
1699         { USB_DEVICE(0x0803, 0x3095), /* Zoom Telephonics Model 3095F USB MODEM */
1700         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1701         },
1702         { USB_DEVICE(0x0572, 0x1321), /* Conexant USB MODEM CX93010 */
1703         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1704         },
1705         { USB_DEVICE(0x0572, 0x1324), /* Conexant USB MODEM RD02-D400 */
1706         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1707         },
1708         { USB_DEVICE(0x0572, 0x1328), /* Shiro / Aztech USB MODEM UM-3100 */
1709         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1710         },
1711         { USB_DEVICE(0x0572, 0x1349), /* Hiro (Conexant) USB MODEM H50228 */
1712         .driver_info = NO_UNION_NORMAL, /* has no union descriptor */
1713         },
1714         { USB_DEVICE(0x20df, 0x0001), /* Simtec Electronics Entropy Key */
1715         .driver_info = QUIRK_CONTROL_LINE_STATE, },
1716         { USB_DEVICE(0x2184, 0x001c) }, /* GW Instek AFG-2225 */
1717         { USB_DEVICE(0x2184, 0x0036) }, /* GW Instek AFG-125 */
1718         { USB_DEVICE(0x22b8, 0x6425), /* Motorola MOTOMAGX phones */
1719         },
1720         /* Motorola H24 HSPA module: */
1721         { USB_DEVICE(0x22b8, 0x2d91) }, /* modem                                */
1722         { USB_DEVICE(0x22b8, 0x2d92),   /* modem           + diagnostics        */
1723         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1724         },
1725         { USB_DEVICE(0x22b8, 0x2d93),   /* modem + AT port                      */
1726         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1727         },
1728         { USB_DEVICE(0x22b8, 0x2d95),   /* modem + AT port + diagnostics        */
1729         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1730         },
1731         { USB_DEVICE(0x22b8, 0x2d96),   /* modem                         + NMEA */
1732         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1733         },
1734         { USB_DEVICE(0x22b8, 0x2d97),   /* modem           + diagnostics + NMEA */
1735         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1736         },
1737         { USB_DEVICE(0x22b8, 0x2d99),   /* modem + AT port               + NMEA */
1738         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1739         },
1740         { USB_DEVICE(0x22b8, 0x2d9a),   /* modem + AT port + diagnostics + NMEA */
1741         .driver_info = NO_UNION_NORMAL, /* handle only modem interface          */
1742         },
1743
1744         { USB_DEVICE(0x0572, 0x1329), /* Hummingbird huc56s (Conexant) */
1745         .driver_info = NO_UNION_NORMAL, /* union descriptor misplaced on
1746                                            data interface instead of
1747                                            communications interface.
1748                                            Maybe we should define a new
1749                                            quirk for this. */
1750         },
1751         { USB_DEVICE(0x0572, 0x1340), /* Conexant CX93010-2x UCMxx */
1752         .driver_info = NO_UNION_NORMAL,
1753         },
1754         { USB_DEVICE(0x05f9, 0x4002), /* PSC Scanning, Magellan 800i */
1755         .driver_info = NO_UNION_NORMAL,
1756         },
1757         { USB_DEVICE(0x1bbb, 0x0003), /* Alcatel OT-I650 */
1758         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1759         },
1760         { USB_DEVICE(0x1576, 0x03b1), /* Maretron USB100 */
1761         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1762         },
1763         { USB_DEVICE(0xfff0, 0x0100), /* DATECS FP-2000 */
1764         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1765         },
1766         { USB_DEVICE(0x09d8, 0x0320), /* Elatec GmbH TWN3 */
1767         .driver_info = NO_UNION_NORMAL, /* has misplaced union descriptor */
1768         },
1769         { USB_DEVICE(0x0ca6, 0xa050), /* Castles VEGA3000 */
1770         .driver_info = NO_UNION_NORMAL, /* reports zero length descriptor */
1771         },
1772
1773         { USB_DEVICE(0x2912, 0x0001), /* ATOL FPrint */
1774         .driver_info = CLEAR_HALT_CONDITIONS,
1775         },
1776
1777         /* Nokia S60 phones expose two ACM channels. The first is
1778          * a modem and is picked up by the standard AT-command
1779          * information below. The second is 'vendor-specific' but
1780          * is treated as a serial device at the S60 end, so we want
1781          * to expose it on Linux too. */
1782         { NOKIA_PCSUITE_ACM_INFO(0x042D), }, /* Nokia 3250 */
1783         { NOKIA_PCSUITE_ACM_INFO(0x04D8), }, /* Nokia 5500 Sport */
1784         { NOKIA_PCSUITE_ACM_INFO(0x04C9), }, /* Nokia E50 */
1785         { NOKIA_PCSUITE_ACM_INFO(0x0419), }, /* Nokia E60 */
1786         { NOKIA_PCSUITE_ACM_INFO(0x044D), }, /* Nokia E61 */
1787         { NOKIA_PCSUITE_ACM_INFO(0x0001), }, /* Nokia E61i */
1788         { NOKIA_PCSUITE_ACM_INFO(0x0475), }, /* Nokia E62 */
1789         { NOKIA_PCSUITE_ACM_INFO(0x0508), }, /* Nokia E65 */
1790         { NOKIA_PCSUITE_ACM_INFO(0x0418), }, /* Nokia E70 */
1791         { NOKIA_PCSUITE_ACM_INFO(0x0425), }, /* Nokia N71 */
1792         { NOKIA_PCSUITE_ACM_INFO(0x0486), }, /* Nokia N73 */
1793         { NOKIA_PCSUITE_ACM_INFO(0x04DF), }, /* Nokia N75 */
1794         { NOKIA_PCSUITE_ACM_INFO(0x000e), }, /* Nokia N77 */
1795         { NOKIA_PCSUITE_ACM_INFO(0x0445), }, /* Nokia N80 */
1796         { NOKIA_PCSUITE_ACM_INFO(0x042F), }, /* Nokia N91 & N91 8GB */
1797         { NOKIA_PCSUITE_ACM_INFO(0x048E), }, /* Nokia N92 */
1798         { NOKIA_PCSUITE_ACM_INFO(0x0420), }, /* Nokia N93 */
1799         { NOKIA_PCSUITE_ACM_INFO(0x04E6), }, /* Nokia N93i  */
1800         { NOKIA_PCSUITE_ACM_INFO(0x04B2), }, /* Nokia 5700 XpressMusic */
1801         { NOKIA_PCSUITE_ACM_INFO(0x0134), }, /* Nokia 6110 Navigator (China) */
1802         { NOKIA_PCSUITE_ACM_INFO(0x046E), }, /* Nokia 6110 Navigator */
1803         { NOKIA_PCSUITE_ACM_INFO(0x002f), }, /* Nokia 6120 classic &  */
1804         { NOKIA_PCSUITE_ACM_INFO(0x0088), }, /* Nokia 6121 classic */
1805         { NOKIA_PCSUITE_ACM_INFO(0x00fc), }, /* Nokia 6124 classic */
1806         { NOKIA_PCSUITE_ACM_INFO(0x0042), }, /* Nokia E51 */
1807         { NOKIA_PCSUITE_ACM_INFO(0x00b0), }, /* Nokia E66 */
1808         { NOKIA_PCSUITE_ACM_INFO(0x00ab), }, /* Nokia E71 */
1809         { NOKIA_PCSUITE_ACM_INFO(0x0481), }, /* Nokia N76 */
1810         { NOKIA_PCSUITE_ACM_INFO(0x0007), }, /* Nokia N81 & N81 8GB */
1811         { NOKIA_PCSUITE_ACM_INFO(0x0071), }, /* Nokia N82 */
1812         { NOKIA_PCSUITE_ACM_INFO(0x04F0), }, /* Nokia N95 & N95-3 NAM */
1813         { NOKIA_PCSUITE_ACM_INFO(0x0070), }, /* Nokia N95 8GB  */
1814         { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1815         { NOKIA_PCSUITE_ACM_INFO(0x0099), }, /* Nokia 6210 Navigator, RM-367 */
1816         { NOKIA_PCSUITE_ACM_INFO(0x0128), }, /* Nokia 6210 Navigator, RM-419 */
1817         { NOKIA_PCSUITE_ACM_INFO(0x008f), }, /* Nokia 6220 Classic */
1818         { NOKIA_PCSUITE_ACM_INFO(0x00a0), }, /* Nokia 6650 */
1819         { NOKIA_PCSUITE_ACM_INFO(0x007b), }, /* Nokia N78 */
1820         { NOKIA_PCSUITE_ACM_INFO(0x0094), }, /* Nokia N85 */
1821         { NOKIA_PCSUITE_ACM_INFO(0x003a), }, /* Nokia N96 & N96-3  */
1822         { NOKIA_PCSUITE_ACM_INFO(0x00e9), }, /* Nokia 5320 XpressMusic */
1823         { NOKIA_PCSUITE_ACM_INFO(0x0108), }, /* Nokia 5320 XpressMusic 2G */
1824         { NOKIA_PCSUITE_ACM_INFO(0x01f5), }, /* Nokia N97, RM-505 */
1825         { NOKIA_PCSUITE_ACM_INFO(0x02e3), }, /* Nokia 5230, RM-588 */
1826         { NOKIA_PCSUITE_ACM_INFO(0x0178), }, /* Nokia E63 */
1827         { NOKIA_PCSUITE_ACM_INFO(0x010e), }, /* Nokia E75 */
1828         { NOKIA_PCSUITE_ACM_INFO(0x02d9), }, /* Nokia 6760 Slide */
1829         { NOKIA_PCSUITE_ACM_INFO(0x01d0), }, /* Nokia E52 */
1830         { NOKIA_PCSUITE_ACM_INFO(0x0223), }, /* Nokia E72 */
1831         { NOKIA_PCSUITE_ACM_INFO(0x0275), }, /* Nokia X6 */
1832         { NOKIA_PCSUITE_ACM_INFO(0x026c), }, /* Nokia N97 Mini */
1833         { NOKIA_PCSUITE_ACM_INFO(0x0154), }, /* Nokia 5800 XpressMusic */
1834         { NOKIA_PCSUITE_ACM_INFO(0x04ce), }, /* Nokia E90 */
1835         { NOKIA_PCSUITE_ACM_INFO(0x01d4), }, /* Nokia E55 */
1836         { NOKIA_PCSUITE_ACM_INFO(0x0302), }, /* Nokia N8 */
1837         { NOKIA_PCSUITE_ACM_INFO(0x0335), }, /* Nokia E7 */
1838         { NOKIA_PCSUITE_ACM_INFO(0x03cd), }, /* Nokia C7 */
1839         { SAMSUNG_PCSUITE_ACM_INFO(0x6651), }, /* Samsung GTi8510 (INNOV8) */
1840
1841         /* Support for Owen devices */
1842         { USB_DEVICE(0x03eb, 0x0030), }, /* Owen SI30 */
1843
1844         /* NOTE: non-Nokia COMM/ACM/0xff is likely MSFT RNDIS... NOT a modem! */
1845
1846         /* Support for Droids MuIn LCD */
1847         { USB_DEVICE(0x04d8, 0x000b),
1848         .driver_info = NO_DATA_INTERFACE,
1849         },
1850
1851 #if IS_ENABLED(CONFIG_INPUT_IMS_PCU)
1852         { USB_DEVICE(0x04d8, 0x0082),   /* Application mode */
1853         .driver_info = IGNORE_DEVICE,
1854         },
1855         { USB_DEVICE(0x04d8, 0x0083),   /* Bootloader mode */
1856         .driver_info = IGNORE_DEVICE,
1857         },
1858 #endif
1859
1860         /*Samsung phone in firmware update mode */
1861         { USB_DEVICE(0x04e8, 0x685d),
1862         .driver_info = IGNORE_DEVICE,
1863         },
1864
1865         /* Exclude Infineon Flash Loader utility */
1866         { USB_DEVICE(0x058b, 0x0041),
1867         .driver_info = IGNORE_DEVICE,
1868         },
1869
1870         { USB_DEVICE(0x1bc7, 0x0021), /* Telit 3G ACM only composition */
1871         .driver_info = SEND_ZERO_PACKET,
1872         },
1873         { USB_DEVICE(0x1bc7, 0x0023), /* Telit 3G ACM + ECM composition */
1874         .driver_info = SEND_ZERO_PACKET,
1875         },
1876
1877         /* control interfaces without any protocol set */
1878         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1879                 USB_CDC_PROTO_NONE) },
1880
1881         /* control interfaces with various AT-command sets */
1882         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1883                 USB_CDC_ACM_PROTO_AT_V25TER) },
1884         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1885                 USB_CDC_ACM_PROTO_AT_PCCA101) },
1886         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1887                 USB_CDC_ACM_PROTO_AT_PCCA101_WAKE) },
1888         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1889                 USB_CDC_ACM_PROTO_AT_GSM) },
1890         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1891                 USB_CDC_ACM_PROTO_AT_3G) },
1892         { USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_ACM,
1893                 USB_CDC_ACM_PROTO_AT_CDMA) },
1894
1895         { USB_DEVICE(0x1519, 0x0452), /* Intel 7260 modem */
1896         .driver_info = SEND_ZERO_PACKET,
1897         },
1898
1899         { }
1900 };
1901
1902 MODULE_DEVICE_TABLE(usb, acm_ids);
1903
1904 static struct usb_driver acm_driver = {
1905         .name =         "cdc_acm",
1906         .probe =        acm_probe,
1907         .disconnect =   acm_disconnect,
1908 #ifdef CONFIG_PM
1909         .suspend =      acm_suspend,
1910         .resume =       acm_resume,
1911         .reset_resume = acm_reset_resume,
1912 #endif
1913         .pre_reset =    acm_pre_reset,
1914         .id_table =     acm_ids,
1915 #ifdef CONFIG_PM
1916         .supports_autosuspend = 1,
1917 #endif
1918         .disable_hub_initiated_lpm = 1,
1919 };
1920
1921 /*
1922  * TTY driver structures.
1923  */
1924
1925 static const struct tty_operations acm_ops = {
1926         .install =              acm_tty_install,
1927         .open =                 acm_tty_open,
1928         .close =                acm_tty_close,
1929         .cleanup =              acm_tty_cleanup,
1930         .hangup =               acm_tty_hangup,
1931         .write =                acm_tty_write,
1932         .write_room =           acm_tty_write_room,
1933         .ioctl =                acm_tty_ioctl,
1934         .throttle =             acm_tty_throttle,
1935         .unthrottle =           acm_tty_unthrottle,
1936         .chars_in_buffer =      acm_tty_chars_in_buffer,
1937         .break_ctl =            acm_tty_break_ctl,
1938         .set_termios =          acm_tty_set_termios,
1939         .tiocmget =             acm_tty_tiocmget,
1940         .tiocmset =             acm_tty_tiocmset,
1941         .get_serial =           get_serial_info,
1942         .set_serial =           set_serial_info,
1943         .get_icount =           acm_tty_get_icount,
1944 };
1945
1946 /*
1947  * Init / exit.
1948  */
1949
1950 static int __init acm_init(void)
1951 {
1952         int retval;
1953         acm_tty_driver = alloc_tty_driver(ACM_TTY_MINORS);
1954         if (!acm_tty_driver)
1955                 return -ENOMEM;
1956         acm_tty_driver->driver_name = "acm",
1957         acm_tty_driver->name = "ttyACM",
1958         acm_tty_driver->major = ACM_TTY_MAJOR,
1959         acm_tty_driver->minor_start = 0,
1960         acm_tty_driver->type = TTY_DRIVER_TYPE_SERIAL,
1961         acm_tty_driver->subtype = SERIAL_TYPE_NORMAL,
1962         acm_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1963         acm_tty_driver->init_termios = tty_std_termios;
1964         acm_tty_driver->init_termios.c_cflag = B9600 | CS8 | CREAD |
1965                                                                 HUPCL | CLOCAL;
1966         tty_set_operations(acm_tty_driver, &acm_ops);
1967
1968         retval = tty_register_driver(acm_tty_driver);
1969         if (retval) {
1970                 put_tty_driver(acm_tty_driver);
1971                 return retval;
1972         }
1973
1974         retval = usb_register(&acm_driver);
1975         if (retval) {
1976                 tty_unregister_driver(acm_tty_driver);
1977                 put_tty_driver(acm_tty_driver);
1978                 return retval;
1979         }
1980
1981         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
1982
1983         return 0;
1984 }
1985
1986 static void __exit acm_exit(void)
1987 {
1988         usb_deregister(&acm_driver);
1989         tty_unregister_driver(acm_tty_driver);
1990         put_tty_driver(acm_tty_driver);
1991         idr_destroy(&acm_minors);
1992 }
1993
1994 module_init(acm_init);
1995 module_exit(acm_exit);
1996
1997 MODULE_AUTHOR(DRIVER_AUTHOR);
1998 MODULE_DESCRIPTION(DRIVER_DESC);
1999 MODULE_LICENSE("GPL");
2000 MODULE_ALIAS_CHARDEV_MAJOR(ACM_TTY_MAJOR);