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