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