drivers/usb/gadget/u_serial.c

   1 /*
   2  * u_serial.c - utilities for USB gadget "serial port"/TTY support
   3  *
   4  * Copyright (C) 2003 Al Borchers (alborchers@steinerpoint.com)
   5  * Copyright (C) 2008 David Brownell
   6  * Copyright (C) 2008 by Nokia Corporation
   7  *
   8  * This code also borrows from usbserial.c, which is
   9  * Copyright (C) 1999 - 2002 Greg Kroah-Hartman (greg@kroah.com)
  10  * Copyright (C) 2000 Peter Berger (pberger@brimson.com)
  11  * Copyright (C) 2000 Al Borchers (alborchers@steinerpoint.com)
  12  *
  13  * This software is distributed under the terms of the GNU General
  14  * Public License ("GPL") as published by the Free Software Foundation,
  15  * either version 2 of that License or (at your option) any later version.
  16  */
  17
  18 /* #define VERBOSE_DEBUG */
  19
  20 #include <linux/kernel.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/device.h>
  23 #include <linux/delay.h>
  24 #include <linux/tty.h>
  25 #include <linux/tty_flip.h>
  26
  27 #include "u_serial.h"
  28
  29
  30 /*
  31  * This component encapsulates the TTY layer glue needed to provide basic
  32  * "serial port" functionality through the USB gadget stack.  Each such
  33  * port is exposed through a /dev/ttyGS* node.
  34  *
  35  * After initialization (gserial_setup), these TTY port devices stay
  36  * available until they are removed (gserial_cleanup).  Each one may be
  37  * connected to a USB function (gserial_connect), or disconnected (with
  38  * gserial_disconnect) when the USB host issues a config change event.
  39  * Data can only flow when the port is connected to the host.
  40  *
  41  * A given TTY port can be made available in multiple configurations.
  42  * For example, each one might expose a ttyGS0 node which provides a
  43  * login application.  In one case that might use CDC ACM interface 0,
  44  * while another configuration might use interface 3 for that.  The
  45  * work to handle that (including descriptor management) is not part
  46  * of this component.
  47  *
  48  * Configurations may expose more than one TTY port.  For example, if
  49  * ttyGS0 provides login service, then ttyGS1 might provide dialer access
  50  * for a telephone or fax link.  And ttyGS2 might be something that just
  51  * needs a simple byte stream interface for some messaging protocol that
  52  * is managed in userspace ... OBEX, PTP, and MTP have been mentioned.
  53  */
  54
  55 #define PREFIX  "ttyGS"
  56
  57 /*
  58  * gserial is the lifecycle interface, used by USB functions
  59  * gs_port is the I/O nexus, used by the tty driver
  60  * tty_struct links to the tty/filesystem framework
  61  *
  62  * gserial <---> gs_port ... links will be null when the USB link is
  63  * inactive; managed by gserial_{connect,disconnect}().  each gserial
  64  * instance can wrap its own USB control protocol.
  65  *      gserial->ioport == usb_ep->driver_data ... gs_port
  66  *      gs_port->port_usb ... gserial
  67  *
  68  * gs_port <---> tty_struct ... links will be null when the TTY file
  69  * isn't opened; managed by gs_open()/gs_close()
  70  *      gserial->port_tty ... tty_struct
  71  *      tty_struct->driver_data ... gserial
  72  */
  73
  74 /* RX and TX queues can buffer QUEUE_SIZE packets before they hit the
  75  * next layer of buffering.  For TX that's a circular buffer; for RX
  76  * consider it a NOP.  A third layer is provided by the TTY code.
  77  */
  78 #define QUEUE_SIZE              16
  79 #define WRITE_BUF_SIZE          8192            /* TX only */
  80
  81 /* circular buffer */
  82 struct gs_buf {
  83         unsigned                buf_size;
  84         char                    *buf_buf;
  85         char                    *buf_get;
  86         char                    *buf_put;
  87 };
  88
  89 /*
  90  * The port structure holds info for each port, one for each minor number
  91  * (and thus for each /dev/ node).
  92  */
  93 struct gs_port {
  94         spinlock_t              port_lock;      /* guard port_* access */
  95
  96         struct gserial          *port_usb;
  97         struct tty_struct       *port_tty;
  98
  99         unsigned                open_count;
 100         bool                    openclose;      /* open/close in progress */
 101         u8                      port_num;
 102
 103         wait_queue_head_t       close_wait;     /* wait for last close */
 104
 105         struct list_head        read_pool;
 106         struct list_head        read_queue;
 107         unsigned                n_read;
 108         struct tasklet_struct   push;
 109
 110         struct list_head        write_pool;
 111         struct gs_buf           port_write_buf;
 112         wait_queue_head_t       drain_wait;     /* wait while writes drain */
 113
 114         /* REVISIT this state ... */
 115         struct usb_cdc_line_coding port_line_coding;    /* 8-N-1 etc */
 116 };
 117
 118 /* increase N_PORTS if you need more */
 119 #define N_PORTS         4
 120 static struct portmaster {
 121         struct mutex    lock;                   /* protect open/close */
 122         struct gs_port  *port;
 123 } ports[N_PORTS];
 124 static unsigned n_ports;
 125
 126 #define GS_CLOSE_TIMEOUT                15              /* seconds */
 127
 128
 129
 130 #ifdef VERBOSE_DEBUG
 131 #define pr_vdebug(fmt, arg...) \
 132         pr_debug(fmt, ##arg)
 133 #else
 134 #define pr_vdebug(fmt, arg...) \
 135         ({ if (0) pr_debug(fmt, ##arg); })
 136 #endif
 137
 138 /*-------------------------------------------------------------------------*/
 139
 140 /* Circular Buffer */
 141
 142 /*
 143  * gs_buf_alloc
 144  *
 145  * Allocate a circular buffer and all associated memory.
 146  */
 147 static int gs_buf_alloc(struct gs_buf *gb, unsigned size)
 148 {
 149         gb->buf_buf = kmalloc(size, GFP_KERNEL);
 150         if (gb->buf_buf == NULL)
 151                 return -ENOMEM;
 152
 153         gb->buf_size = size;
 154         gb->buf_put = gb->buf_buf;
 155         gb->buf_get = gb->buf_buf;
 156
 157         return 0;
 158 }
 159
 160 /*
 161  * gs_buf_free
 162  *
 163  * Free the buffer and all associated memory.
 164  */
 165 static void gs_buf_free(struct gs_buf *gb)
 166 {
 167         kfree(gb->buf_buf);
 168         gb->buf_buf = NULL;
 169 }
 170
 171 /*
 172  * gs_buf_clear
 173  *
 174  * Clear out all data in the circular buffer.
 175  */
 176 static void gs_buf_clear(struct gs_buf *gb)
 177 {
 178         gb->buf_get = gb->buf_put;
 179         /* equivalent to a get of all data available */
 180 }
 181
 182 /*
 183  * gs_buf_data_avail
 184  *
 185  * Return the number of bytes of data written into the circular
 186  * buffer.
 187  */
 188 static unsigned gs_buf_data_avail(struct gs_buf *gb)
 189 {
 190         return (gb->buf_size + gb->buf_put - gb->buf_get) % gb->buf_size;
 191 }
 192
 193 /*
 194  * gs_buf_space_avail
 195  *
 196  * Return the number of bytes of space available in the circular
 197  * buffer.
 198  */
 199 static unsigned gs_buf_space_avail(struct gs_buf *gb)
 200 {
 201         return (gb->buf_size + gb->buf_get - gb->buf_put - 1) % gb->buf_size;
 202 }
 203
 204 /*
 205  * gs_buf_put
 206  *
 207  * Copy data data from a user buffer and put it into the circular buffer.
 208  * Restrict to the amount of space available.
 209  *
 210  * Return the number of bytes copied.
 211  */
 212 static unsigned
 213 gs_buf_put(struct gs_buf *gb, const char *buf, unsigned count)
 214 {
 215         unsigned len;
 216
 217         len  = gs_buf_space_avail(gb);
 218         if (count > len)
 219                 count = len;
 220
 221         if (count == 0)
 222                 return 0;
 223
 224         len = gb->buf_buf + gb->buf_size - gb->buf_put;
 225         if (count > len) {
 226                 memcpy(gb->buf_put, buf, len);
 227                 memcpy(gb->buf_buf, buf+len, count - len);
 228                 gb->buf_put = gb->buf_buf + count - len;
 229         } else {
 230                 memcpy(gb->buf_put, buf, count);
 231                 if (count < len)
 232                         gb->buf_put += count;
 233                 else /* count == len */
 234                         gb->buf_put = gb->buf_buf;
 235         }
 236
 237         return count;
 238 }
 239
 240 /*
 241  * gs_buf_get
 242  *
 243  * Get data from the circular buffer and copy to the given buffer.
 244  * Restrict to the amount of data available.
 245  *
 246  * Return the number of bytes copied.
 247  */
 248 static unsigned
 249 gs_buf_get(struct gs_buf *gb, char *buf, unsigned count)
 250 {
 251         unsigned len;
 252
 253         len = gs_buf_data_avail(gb);
 254         if (count > len)
 255                 count = len;
 256
 257         if (count == 0)
 258                 return 0;
 259
 260         len = gb->buf_buf + gb->buf_size - gb->buf_get;
 261         if (count > len) {
 262                 memcpy(buf, gb->buf_get, len);
 263                 memcpy(buf+len, gb->buf_buf, count - len);
 264                 gb->buf_get = gb->buf_buf + count - len;
 265         } else {
 266                 memcpy(buf, gb->buf_get, count);
 267                 if (count < len)
 268                         gb->buf_get += count;
 269                 else /* count == len */
 270                         gb->buf_get = gb->buf_buf;
 271         }
 272
 273         return count;
 274 }
 275
 276 /*-------------------------------------------------------------------------*/
 277
 278 /* I/O glue between TTY (upper) and USB function (lower) driver layers */
 279
 280 /*
 281  * gs_alloc_req
 282  *
 283  * Allocate a usb_request and its buffer.  Returns a pointer to the
 284  * usb_request or NULL if there is an error.
 285  */
 286 struct usb_request *
 287 gs_alloc_req(struct usb_ep *ep, unsigned len, gfp_t kmalloc_flags)
 288 {
 289         struct usb_request *req;
 290
 291         req = usb_ep_alloc_request(ep, kmalloc_flags);
 292
 293         if (req != NULL) {
 294                 req->length = len;
 295                 req->buf = kmalloc(len, kmalloc_flags);
 296                 if (req->buf == NULL) {
 297                         usb_ep_free_request(ep, req);
 298                         return NULL;
 299                 }
 300         }
 301
 302         return req;
 303 }
 304
 305 /*
 306  * gs_free_req
 307  *
 308  * Free a usb_request and its buffer.
 309  */
 310 void gs_free_req(struct usb_ep *ep, struct usb_request *req)
 311 {
 312         kfree(req->buf);
 313         usb_ep_free_request(ep, req);
 314 }
 315
 316 /*
 317  * gs_send_packet
 318  *
 319  * If there is data to send, a packet is built in the given
 320  * buffer and the size is returned.  If there is no data to
 321  * send, 0 is returned.
 322  *
 323  * Called with port_lock held.
 324  */
 325 static unsigned
 326 gs_send_packet(struct gs_port *port, char *packet, unsigned size)
 327 {
 328         unsigned len;
 329
 330         len = gs_buf_data_avail(&port->port_write_buf);
 331         if (len < size)
 332                 size = len;
 333         if (size != 0)
 334                 size = gs_buf_get(&port->port_write_buf, packet, size);
 335         return size;
 336 }
 337
 338 /*
 339  * gs_start_tx
 340  *
 341  * This function finds available write requests, calls
 342  * gs_send_packet to fill these packets with data, and
 343  * continues until either there are no more write requests
 344  * available or no more data to send.  This function is
 345  * run whenever data arrives or write requests are available.
 346  *
 347  * Context: caller owns port_lock; port_usb is non-null.
 348  */
 349 static int gs_start_tx(struct gs_port *port)
 350 /*
 351 __releases(&port->port_lock)
 352 __acquires(&port->port_lock)
 353 */
 354 {
 355         struct list_head        *pool = &port->write_pool;
 356         struct usb_ep           *in = port->port_usb->in;
 357         int                     status = 0;
 358         bool                    do_tty_wake = false;
 359
 360         while (!list_empty(pool)) {
 361                 struct usb_request      *req;
 362                 int                     len;
 363
 364                 req = list_entry(pool->next, struct usb_request, list);
 365                 len = gs_send_packet(port, req->buf, in->maxpacket);
 366                 if (len == 0) {
 367                         wake_up_interruptible(&port->drain_wait);
 368                         break;
 369                 }
 370                 do_tty_wake = true;
 371
 372                 req->length = len;
 373                 list_del(&req->list);
 374                 req->zero = (gs_buf_data_avail(&port->port_write_buf) == 0);
 375
 376                 pr_vdebug(PREFIX "%d: tx len=%d, 0x%02x 0x%02x 0x%02x ...\n",
 377                                 port->port_num, len, *((u8 *)req->buf),
 378                                 *((u8 *)req->buf+1), *((u8 *)req->buf+2));
 379
 380                 /* Drop lock while we call out of driver; completions
 381                  * could be issued while we do so.  Disconnection may
 382                  * happen too; maybe immediately before we queue this!
 383                  *
 384                  * NOTE that we may keep sending data for a while after
 385                  * the TTY closed (dev->ioport->port_tty is NULL).
 386                  */
 387                 spin_unlock(&port->port_lock);
 388                 status = usb_ep_queue(in, req, GFP_ATOMIC);
 389                 spin_lock(&port->port_lock);
 390
 391                 if (status) {
 392                         pr_debug("%s: %s %s err %d\n",
 393                                         __func__, "queue", in->name, status);
 394                         list_add(&req->list, pool);
 395                         break;
 396                 }
 397
 398                 /* abort immediately after disconnect */
 399                 if (!port->port_usb)
 400                         break;
 401         }
 402
 403         if (do_tty_wake && port->port_tty)
 404                 tty_wakeup(port->port_tty);
 405         return status;
 406 }
 407
 408 /*
 409  * Context: caller owns port_lock, and port_usb is set
 410  */
 411 static unsigned gs_start_rx(struct gs_port *port)
 412 /*
 413 __releases(&port->port_lock)
 414 __acquires(&port->port_lock)
 415 */
 416 {
 417         struct list_head        *pool = &port->read_pool;
 418         struct usb_ep           *out = port->port_usb->out;
 419         unsigned                started = 0;
 420
 421         while (!list_empty(pool)) {
 422                 struct usb_request      *req;
 423                 int                     status;
 424                 struct tty_struct       *tty;
 425
 426                 /* no more rx if closed */
 427                 tty = port->port_tty;
 428                 if (!tty)
 429                         break;
 430
 431                 req = list_entry(pool->next, struct usb_request, list);
 432                 list_del(&req->list);
 433                 req->length = out->maxpacket;
 434
 435                 /* drop lock while we call out; the controller driver
 436                  * may need to call us back (e.g. for disconnect)
 437                  */
 438                 spin_unlock(&port->port_lock);
 439                 status = usb_ep_queue(out, req, GFP_ATOMIC);
 440                 spin_lock(&port->port_lock);
 441
 442                 if (status) {
 443                         pr_debug("%s: %s %s err %d\n",
 444                                         __func__, "queue", out->name, status);
 445                         list_add(&req->list, pool);
 446                         break;
 447                 }
 448                 started++;
 449
 450                 /* abort immediately after disconnect */
 451                 if (!port->port_usb)
 452                         break;
 453         }
 454         return started;
 455 }
 456
 457 /*
 458  * RX tasklet takes data out of the RX queue and hands it up to the TTY
 459  * layer until it refuses to take any more data (or is throttled back).
 460  * Then it issues reads for any further data.
 461  *
 462  * If the RX queue becomes full enough that no usb_request is queued,
 463  * the OUT endpoint may begin NAKing as soon as its FIFO fills up.
 464  * So QUEUE_SIZE packets plus however many the FIFO holds (usually two)
 465  * can be buffered before the TTY layer's buffers (currently 64 KB).
 466  */
 467 static void gs_rx_push(unsigned long _port)
 468 {
 469         struct gs_port          *port = (void *)_port;
 470         struct tty_struct       *tty;
 471         struct list_head        *queue = &port->read_queue;
 472         bool                    disconnect = false;
 473         bool                    do_push = false;
 474
 475         /* hand any queued data to the tty */
 476         spin_lock_irq(&port->port_lock);
 477         tty = port->port_tty;
 478         while (!list_empty(queue)) {
 479                 struct usb_request      *req;
 480
 481                 req = list_first_entry(queue, struct usb_request, list);
 482
 483                 /* discard data if tty was closed */
 484                 if (!tty)
 485                         goto recycle;
 486
 487                 /* leave data queued if tty was rx throttled */
 488                 if (test_bit(TTY_THROTTLED, &tty->flags))
 489                         break;
 490
 491                 switch (req->status) {
 492                 case -ESHUTDOWN:
 493                         disconnect = true;
 494                         pr_vdebug(PREFIX "%d: shutdown\n", port->port_num);
 495                         break;
 496
 497                 default:
 498                         /* presumably a transient fault */
 499                         pr_warning(PREFIX "%d: unexpected RX status %d\n",
 500                                         port->port_num, req->status);
 501                         /* FALLTHROUGH */
 502                 case 0:
 503                         /* normal completion */
 504                         break;
 505                 }
 506
 507                 /* push data to (open) tty */
 508                 if (req->actual) {
 509                         char            *packet = req->buf;
 510                         unsigned        size = req->actual;
 511                         unsigned        n;
 512                         int             count;
 513
 514                         /* we may have pushed part of this packet already... */
 515                         n = port->n_read;
 516                         if (n) {
 517                                 packet += n;
 518                                 size -= n;
 519                         }
 520
 521                         count = tty_insert_flip_string(tty, packet, size);
 522                         if (count)
 523                                 do_push = true;
 524                         if (count != size) {
 525                                 /* stop pushing; TTY layer can't handle more */
 526                                 port->n_read += count;
 527                                 pr_vdebug(PREFIX "%d: rx block %d/%d\n",
 528                                                 port->port_num,
 529                                                 count, req->actual);
 530                                 break;
 531                         }
 532                         port->n_read = 0;
 533                 }
 534 recycle:
 535                 list_move(&req->list, &port->read_pool);
 536         }
 537
 538         /* Push from tty to ldisc; without low_latency set this is handled by
 539          * a workqueue, so we won't get callbacks and can hold port_lock
 540          */
 541         if (tty && do_push) {
 542                 tty_flip_buffer_push(tty);
 543         }
 544
 545
 546         /* We want our data queue to become empty ASAP, keeping data
 547          * in the tty and ldisc (not here).  If we couldn't push any
 548          * this time around, there may be trouble unless there's an
 549          * implicit tty_unthrottle() call on its way...
 550          *
 551          * REVISIT we should probably add a timer to keep the tasklet
 552          * from starving ... but it's not clear that case ever happens.
 553          */
 554         if (!list_empty(queue) && tty) {
 555                 if (!test_bit(TTY_THROTTLED, &tty->flags)) {
 556                         if (do_push)
 557                                 tasklet_schedule(&port->push);
 558                         else
 559                                 pr_warning(PREFIX "%d: RX not scheduled?\n",
 560                                         port->port_num);
 561                 }
 562         }
 563
 564         /* If we're still connected, refill the USB RX queue. */
 565         if (!disconnect && port->port_usb)
 566                 gs_start_rx(port);
 567
 568         spin_unlock_irq(&port->port_lock);
 569 }
 570
 571 static void gs_read_complete(struct usb_ep *ep, struct usb_request *req)
 572 {
 573         struct gs_port  *port = ep->driver_data;
 574
 575         /* Queue all received data until the tty layer is ready for it. */
 576         spin_lock(&port->port_lock);
 577         list_add_tail(&req->list, &port->read_queue);
 578         tasklet_schedule(&port->push);
 579         spin_unlock(&port->port_lock);
 580 }
 581
 582 static void gs_write_complete(struct usb_ep *ep, struct usb_request *req)
 583 {
 584         struct gs_port  *port = ep->driver_data;
 585
 586         spin_lock(&port->port_lock);
 587         list_add(&req->list, &port->write_pool);
 588
 589         switch (req->status) {
 590         default:
 591                 /* presumably a transient fault */
 592                 pr_warning("%s: unexpected %s status %d\n",
 593                                 __func__, ep->name, req->status);
 594                 /* FALL THROUGH */
 595         case 0:
 596                 /* normal completion */
 597                 gs_start_tx(port);
 598                 break;
 599
 600         case -ESHUTDOWN:
 601                 /* disconnect */
 602                 pr_vdebug("%s: %s shutdown\n", __func__, ep->name);
 603                 break;
 604         }
 605
 606         spin_unlock(&port->port_lock);
 607 }
 608
 609 static void gs_free_requests(struct usb_ep *ep, struct list_head *head)
 610 {
 611         struct usb_request      *req;
 612
 613         while (!list_empty(head)) {
 614                 req = list_entry(head->next, struct usb_request, list);
 615                 list_del(&req->list);
 616                 gs_free_req(ep, req);
 617         }
 618 }
 619
 620 static int gs_alloc_requests(struct usb_ep *ep, struct list_head *head,
 621                 void (*fn)(struct usb_ep *, struct usb_request *))
 622 {
 623         int                     i;
 624         struct usb_request      *req;
 625
 626         /* Pre-allocate up to QUEUE_SIZE transfers, but if we can't
 627          * do quite that many this time, don't fail ... we just won't
 628          * be as speedy as we might otherwise be.
 629          */
 630         for (i = 0; i < QUEUE_SIZE; i++) {
 631                 req = gs_alloc_req(ep, ep->maxpacket, GFP_ATOMIC);
 632                 if (!req)
 633                         return list_empty(head) ? -ENOMEM : 0;
 634                 req->complete = fn;
 635                 list_add_tail(&req->list, head);
 636         }
 637         return 0;
 638 }
 639
 640 /**
 641  * gs_start_io - start USB I/O streams
 642  * @dev: encapsulates endpoints to use
 643  * Context: holding port_lock; port_tty and port_usb are non-null
 644  *
 645  * We only start I/O when something is connected to both sides of
 646  * this port.  If nothing is listening on the host side, we may
 647  * be pointlessly filling up our TX buffers and FIFO.
 648  */
 649 static int gs_start_io(struct gs_port *port)
 650 {
 651         struct list_head        *head = &port->read_pool;
 652         struct usb_ep           *ep = port->port_usb->out;
 653         int                     status;
 654         unsigned                started;
 655
 656         /* Allocate RX and TX I/O buffers.  We can't easily do this much
 657          * earlier (with GFP_KERNEL) because the requests are coupled to
 658          * endpoints, as are the packet sizes we'll be using.  Different
 659          * configurations may use different endpoints with a given port;
 660          * and high speed vs full speed changes packet sizes too.
 661          */
 662         status = gs_alloc_requests(ep, head, gs_read_complete);
 663         if (status)
 664                 return status;
 665
 666         status = gs_alloc_requests(port->port_usb->in, &port->write_pool,
 667                         gs_write_complete);
 668         if (status) {
 669                 gs_free_requests(ep, head);
 670                 return status;
 671         }
 672
 673         /* queue read requests */
 674         port->n_read = 0;
 675         started = gs_start_rx(port);
 676
 677         /* unblock any pending writes into our circular buffer */
 678         if (started) {
 679                 tty_wakeup(port->port_tty);
 680         } else {
 681                 gs_free_requests(ep, head);
 682                 gs_free_requests(port->port_usb->in, &port->write_pool);
 683                 status = -EIO;
 684         }
 685
 686         return status;
 687 }
 688
 689 /*-------------------------------------------------------------------------*/
 690
 691 /* TTY Driver */
 692
 693 /*
 694  * gs_open sets up the link between a gs_port and its associated TTY.
 695  * That link is broken *only* by TTY close(), and all driver methods
 696  * know that.
 697  */
 698 static int gs_open(struct tty_struct *tty, struct file *file)
 699 {
 700         int             port_num = tty->index;
 701         struct gs_port  *port;
 702         int             status;
 703
 704         if (port_num < 0 || port_num >= n_ports)
 705                 return -ENXIO;
 706
 707         do {
 708                 mutex_lock(&ports[port_num].lock);
 709                 port = ports[port_num].port;
 710                 if (!port)
 711                         status = -ENODEV;
 712                 else {
 713                         spin_lock_irq(&port->port_lock);
 714
 715                         /* already open?  Great. */
 716                         if (port->open_count) {
 717                                 status = 0;
 718                                 port->open_count++;
 719
 720                         /* currently opening/closing? wait ... */
 721                         } else if (port->openclose) {
 722                                 status = -EBUSY;
 723
 724                         /* ... else we do the work */
 725                         } else {
 726                                 status = -EAGAIN;
 727                                 port->openclose = true;
 728                         }
 729                         spin_unlock_irq(&port->port_lock);
 730                 }
 731                 mutex_unlock(&ports[port_num].lock);
 732
 733                 switch (status) {
 734                 default:
 735                         /* fully handled */
 736                         return status;
 737                 case -EAGAIN:
 738                         /* must do the work */
 739                         break;
 740                 case -EBUSY:
 741                         /* wait for EAGAIN task to finish */
 742                         msleep(1);
 743                         /* REVISIT could have a waitchannel here, if
 744                          * concurrent open performance is important
 745                          */
 746                         break;
 747                 }
 748         } while (status != -EAGAIN);
 749
 750         /* Do the "real open" */
 751         spin_lock_irq(&port->port_lock);
 752
 753         /* allocate circular buffer on first open */
 754         if (port->port_write_buf.buf_buf == NULL) {
 755
 756                 spin_unlock_irq(&port->port_lock);
 757                 status = gs_buf_alloc(&port->port_write_buf, WRITE_BUF_SIZE);
 758                 spin_lock_irq(&port->port_lock);
 759
 760                 if (status) {
 761                         pr_debug("gs_open: ttyGS%d (%p,%p) no buffer\n",
 762                                 port->port_num, tty, file);
 763                         port->openclose = false;
 764                         goto exit_unlock_port;
 765                 }
 766         }
 767
 768         /* REVISIT if REMOVED (ports[].port NULL), abort the open
 769          * to let rmmod work faster (but this way isn't wrong).
 770          */
 771
 772         /* REVISIT maybe wait for "carrier detect" */
 773
 774         tty->driver_data = port;
 775         port->port_tty = tty;
 776
 777         port->open_count = 1;
 778         port->openclose = false;
 779
 780         /* if connected, start the I/O stream */
 781         if (port->port_usb) {
 782                 struct gserial  *gser = port->port_usb;
 783
 784                 pr_debug("gs_open: start ttyGS%d\n", port->port_num);
 785                 gs_start_io(port);
 786
 787                 if (gser->connect)
 788                         gser->connect(gser);
 789         }
 790
 791         pr_debug("gs_open: ttyGS%d (%p,%p)\n", port->port_num, tty, file);
 792
 793         status = 0;
 794
 795 exit_unlock_port:
 796         spin_unlock_irq(&port->port_lock);
 797         return status;
 798 }
 799
 800 static int gs_writes_finished(struct gs_port *p)
 801 {
 802         int cond;
 803
 804         /* return true on disconnect or empty buffer */
 805         spin_lock_irq(&p->port_lock);
 806         cond = (p->port_usb == NULL) || !gs_buf_data_avail(&p->port_write_buf);
 807         spin_unlock_irq(&p->port_lock);
 808
 809         return cond;
 810 }
 811
 812 static void gs_close(struct tty_struct *tty, struct file *file)
 813 {
 814         struct gs_port *port = tty->driver_data;
 815         struct gserial  *gser;
 816
 817         spin_lock_irq(&port->port_lock);
 818
 819         if (port->open_count != 1) {
 820                 if (port->open_count == 0)
 821                         WARN_ON(1);
 822                 else
 823                         --port->open_count;
 824                 goto exit;
 825         }
 826
 827         pr_debug("gs_close: ttyGS%d (%p,%p) ...\n", port->port_num, tty, file);
 828
 829         /* mark port as closing but in use; we can drop port lock
 830          * and sleep if necessary
 831          */
 832         port->openclose = true;
 833         port->open_count = 0;
 834
 835         gser = port->port_usb;
 836         if (gser && gser->disconnect)
 837                 gser->disconnect(gser);
 838
 839         /* wait for circular write buffer to drain, disconnect, or at
 840          * most GS_CLOSE_TIMEOUT seconds; then discard the rest
 841          */
 842         if (gs_buf_data_avail(&port->port_write_buf) > 0 && gser) {
 843                 spin_unlock_irq(&port->port_lock);
 844                 wait_event_interruptible_timeout(port->drain_wait,
 845                                         gs_writes_finished(port),
 846                                         GS_CLOSE_TIMEOUT * HZ);
 847                 spin_lock_irq(&port->port_lock);
 848                 gser = port->port_usb;
 849         }
 850
 851         /* Iff we're disconnected, there can be no I/O in flight so it's
 852          * ok to free the circular buffer; else just scrub it.  And don't
 853          * let the push tasklet fire again until we're re-opened.
 854          */
 855         if (gser == NULL)
 856                 gs_buf_free(&port->port_write_buf);
 857         else
 858                 gs_buf_clear(&port->port_write_buf);
 859
 860         tty->driver_data = NULL;
 861         port->port_tty = NULL;
 862
 863         port->openclose = false;
 864
 865         pr_debug("gs_close: ttyGS%d (%p,%p) done!\n",
 866                         port->port_num, tty, file);
 867
 868         wake_up_interruptible(&port->close_wait);
 869 exit:
 870         spin_unlock_irq(&port->port_lock);
 871 }
 872
 873 static int gs_write(struct tty_struct *tty, const unsigned char *buf, int count)
 874 {
 875         struct gs_port  *port = tty->driver_data;
 876         unsigned long   flags;
 877         int             status;
 878
 879         pr_vdebug("gs_write: ttyGS%d (%p) writing %d bytes\n",
 880                         port->port_num, tty, count);
 881
 882         spin_lock_irqsave(&port->port_lock, flags);
 883         if (count)
 884                 count = gs_buf_put(&port->port_write_buf, buf, count);
 885         /* treat count == 0 as flush_chars() */
 886         if (port->port_usb)
 887                 status = gs_start_tx(port);
 888         spin_unlock_irqrestore(&port->port_lock, flags);
 889
 890         return count;
 891 }
 892
 893 static int gs_put_char(struct tty_struct *tty, unsigned char ch)
 894 {
 895         struct gs_port  *port = tty->driver_data;
 896         unsigned long   flags;
 897         int             status;
 898
 899         pr_vdebug("gs_put_char: (%d,%p) char=0x%x, called from %p\n",
 900                 port->port_num, tty, ch, __builtin_return_address(0));
 901
 902         spin_lock_irqsave(&port->port_lock, flags);
 903         status = gs_buf_put(&port->port_write_buf, &ch, 1);
 904         spin_unlock_irqrestore(&port->port_lock, flags);
 905
 906         return status;
 907 }
 908
 909 static void gs_flush_chars(struct tty_struct *tty)
 910 {
 911         struct gs_port  *port = tty->driver_data;
 912         unsigned long   flags;
 913
 914         pr_vdebug("gs_flush_chars: (%d,%p)\n", port->port_num, tty);
 915
 916         spin_lock_irqsave(&port->port_lock, flags);
 917         if (port->port_usb)
 918                 gs_start_tx(port);
 919         spin_unlock_irqrestore(&port->port_lock, flags);
 920 }
 921
 922 static int gs_write_room(struct tty_struct *tty)
 923 {
 924         struct gs_port  *port = tty->driver_data;
 925         unsigned long   flags;
 926         int             room = 0;
 927
 928         spin_lock_irqsave(&port->port_lock, flags);
 929         if (port->port_usb)
 930                 room = gs_buf_space_avail(&port->port_write_buf);
 931         spin_unlock_irqrestore(&port->port_lock, flags);
 932
 933         pr_vdebug("gs_write_room: (%d,%p) room=%d\n",
 934                 port->port_num, tty, room);
 935
 936         return room;
 937 }
 938
 939 static int gs_chars_in_buffer(struct tty_struct *tty)
 940 {
 941         struct gs_port  *port = tty->driver_data;
 942         unsigned long   flags;
 943         int             chars = 0;
 944
 945         spin_lock_irqsave(&port->port_lock, flags);
 946         chars = gs_buf_data_avail(&port->port_write_buf);
 947         spin_unlock_irqrestore(&port->port_lock, flags);
 948
 949         pr_vdebug("gs_chars_in_buffer: (%d,%p) chars=%d\n",
 950                 port->port_num, tty, chars);
 951
 952         return chars;
 953 }
 954
 955 /* undo side effects of setting TTY_THROTTLED */
 956 static void gs_unthrottle(struct tty_struct *tty)
 957 {
 958         struct gs_port          *port = tty->driver_data;
 959         unsigned long           flags;
 960
 961         spin_lock_irqsave(&port->port_lock, flags);
 962         if (port->port_usb) {
 963                 /* Kickstart read queue processing.  We don't do xon/xoff,
 964                  * rts/cts, or other handshaking with the host, but if the
 965                  * read queue backs up enough we'll be NAKing OUT packets.
 966                  */
 967                 tasklet_schedule(&port->push);
 968                 pr_vdebug(PREFIX "%d: unthrottle\n", port->port_num);
 969         }
 970         spin_unlock_irqrestore(&port->port_lock, flags);
 971 }
 972
 973 static int gs_break_ctl(struct tty_struct *tty, int duration)
 974 {
 975         struct gs_port  *port = tty->driver_data;
 976         int             status = 0;
 977         struct gserial  *gser;
 978
 979         pr_vdebug("gs_break_ctl: ttyGS%d, send break (%d) \n",
 980                         port->port_num, duration);
 981
 982         spin_lock_irq(&port->port_lock);
 983         gser = port->port_usb;
 984         if (gser && gser->send_break)
 985                 status = gser->send_break(gser, duration);
 986         spin_unlock_irq(&port->port_lock);
 987
 988         return status;
 989 }
 990
 991 static const struct tty_operations gs_tty_ops = {
 992         .open =                 gs_open,
 993         .close =                gs_close,
 994         .write =                gs_write,
 995         .put_char =             gs_put_char,
 996         .flush_chars =          gs_flush_chars,
 997         .write_room =           gs_write_room,
 998         .chars_in_buffer =      gs_chars_in_buffer,
 999         .unthrottle =           gs_unthrottle,
1000         .break_ctl =            gs_break_ctl,
1001 };
1002
1003 /*-------------------------------------------------------------------------*/
1004
1005 static struct tty_driver *gs_tty_driver;
1006
1007 static int __init
1008 gs_port_alloc(unsigned port_num, struct usb_cdc_line_coding *coding)
1009 {
1010         struct gs_port  *port;
1011
1012         port = kzalloc(sizeof(struct gs_port), GFP_KERNEL);
1013         if (port == NULL)
1014                 return -ENOMEM;
1015
1016         spin_lock_init(&port->port_lock);
1017         init_waitqueue_head(&port->close_wait);
1018         init_waitqueue_head(&port->drain_wait);
1019
1020         tasklet_init(&port->push, gs_rx_push, (unsigned long) port);
1021
1022         INIT_LIST_HEAD(&port->read_pool);
1023         INIT_LIST_HEAD(&port->read_queue);
1024         INIT_LIST_HEAD(&port->write_pool);
1025
1026         port->port_num = port_num;
1027         port->port_line_coding = *coding;
1028
1029         ports[port_num].port = port;
1030
1031         return 0;
1032 }
1033
1034 /**
1035  * gserial_setup - initialize TTY driver for one or more ports
1036  * @g: gadget to associate with these ports
1037  * @count: how many ports to support
1038  * Context: may sleep
1039  *
1040  * The TTY stack needs to know in advance how many devices it should
1041  * plan to manage.  Use this call to set up the ports you will be
1042  * exporting through USB.  Later, connect them to functions based
1043  * on what configuration is activated by the USB host; and disconnect
1044  * them as appropriate.
1045  *
1046  * An example would be a two-configuration device in which both
1047  * configurations expose port 0, but through different functions.
1048  * One configuration could even expose port 1 while the other
1049  * one doesn't.
1050  *
1051  * Returns negative errno or zero.
1052  */
1053 int __init gserial_setup(struct usb_gadget *g, unsigned count)
1054 {
1055         unsigned                        i;
1056         struct usb_cdc_line_coding      coding;
1057         int                             status;
1058
1059         if (count == 0 || count > N_PORTS)
1060                 return -EINVAL;
1061
1062         gs_tty_driver = alloc_tty_driver(count);
1063         if (!gs_tty_driver)
1064                 return -ENOMEM;
1065
1066         gs_tty_driver->owner = THIS_MODULE;
1067         gs_tty_driver->driver_name = "g_serial";
1068         gs_tty_driver->name = PREFIX;
1069         /* uses dynamically assigned dev_t values */
1070
1071         gs_tty_driver->type = TTY_DRIVER_TYPE_SERIAL;
1072         gs_tty_driver->subtype = SERIAL_TYPE_NORMAL;
1073         gs_tty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
1074         gs_tty_driver->init_termios = tty_std_termios;
1075
1076         /* 9600-8-N-1 ... matches defaults expected by "usbser.sys" on
1077          * MS-Windows.  Otherwise, most of these flags shouldn't affect
1078          * anything unless we were to actually hook up to a serial line.
1079          */
1080         gs_tty_driver->init_termios.c_cflag =
1081                         B9600 | CS8 | CREAD | HUPCL | CLOCAL;
1082         gs_tty_driver->init_termios.c_ispeed = 9600;
1083         gs_tty_driver->init_termios.c_ospeed = 9600;
1084
1085         coding.dwDTERate = cpu_to_le32(9600);
1086         coding.bCharFormat = 8;
1087         coding.bParityType = USB_CDC_NO_PARITY;
1088         coding.bDataBits = USB_CDC_1_STOP_BITS;
1089
1090         tty_set_operations(gs_tty_driver, &gs_tty_ops);
1091
1092         /* make devices be openable */
1093         for (i = 0; i < count; i++) {
1094                 mutex_init(&ports[i].lock);
1095                 status = gs_port_alloc(i, &coding);
1096                 if (status) {
1097                         count = i;
1098                         goto fail;
1099                 }
1100         }
1101         n_ports = count;
1102
1103         /* export the driver ... */
1104         status = tty_register_driver(gs_tty_driver);
1105         if (status) {
1106                 pr_err("%s: cannot register, err %d\n",
1107                                 __func__, status);
1108                 goto fail;
1109         }
1110
1111         /* ... and sysfs class devices, so mdev/udev make /dev/ttyGS* */
1112         for (i = 0; i < count; i++) {
1113                 struct device   *tty_dev;
1114
1115                 tty_dev = tty_register_device(gs_tty_driver, i, &g->dev);
1116                 if (IS_ERR(tty_dev))
1117                         pr_warning("%s: no classdev for port %d, err %ld\n",
1118                                 __func__, i, PTR_ERR(tty_dev));
1119         }
1120
1121         pr_debug("%s: registered %d ttyGS* device%s\n", __func__,
1122                         count, (count == 1) ? "" : "s");
1123
1124         return status;
1125 fail:
1126         while (count--)
1127                 kfree(ports[count].port);
1128         put_tty_driver(gs_tty_driver);
1129         gs_tty_driver = NULL;
1130         return status;
1131 }
1132
1133 static int gs_closed(struct gs_port *port)
1134 {
1135         int cond;
1136
1137         spin_lock_irq(&port->port_lock);
1138         cond = (port->open_count == 0) && !port->openclose;
1139         spin_unlock_irq(&port->port_lock);
1140         return cond;
1141 }
1142
1143 /**
1144  * gserial_cleanup - remove TTY-over-USB driver and devices
1145  * Context: may sleep
1146  *
1147  * This is called to free all resources allocated by @gserial_setup().
1148  * Accordingly, it may need to wait until some open /dev/ files have
1149  * closed.
1150  *
1151  * The caller must have issued @gserial_disconnect() for any ports
1152  * that had previously been connected, so that there is never any
1153  * I/O pending when it's called.
1154  */
1155 void gserial_cleanup(void)
1156 {
1157         unsigned        i;
1158         struct gs_port  *port;
1159
1160         if (!gs_tty_driver)
1161                 return;
1162
1163         /* start sysfs and /dev/ttyGS* node removal */
1164         for (i = 0; i < n_ports; i++)
1165                 tty_unregister_device(gs_tty_driver, i);
1166
1167         for (i = 0; i < n_ports; i++) {
1168                 /* prevent new opens */
1169                 mutex_lock(&ports[i].lock);
1170                 port = ports[i].port;
1171                 ports[i].port = NULL;
1172                 mutex_unlock(&ports[i].lock);
1173
1174                 tasklet_kill(&port->push);
1175
1176                 /* wait for old opens to finish */
1177                 wait_event(port->close_wait, gs_closed(port));
1178
1179                 WARN_ON(port->port_usb != NULL);
1180
1181                 kfree(port);
1182         }
1183         n_ports = 0;
1184
1185         tty_unregister_driver(gs_tty_driver);
1186         gs_tty_driver = NULL;
1187
1188         pr_debug("%s: cleaned up ttyGS* support\n", __func__);
1189 }
1190
1191 /**
1192  * gserial_connect - notify TTY I/O glue that USB link is active
1193  * @gser: the function, set up with endpoints and descriptors
1194  * @port_num: which port is active
1195  * Context: any (usually from irq)
1196  *
1197  * This is called activate endpoints and let the TTY layer know that
1198  * the connection is active ... not unlike "carrier detect".  It won't
1199  * necessarily start I/O queues; unless the TTY is held open by any
1200  * task, there would be no point.  However, the endpoints will be
1201  * activated so the USB host can perform I/O, subject to basic USB
1202  * hardware flow control.
1203  *
1204  * Caller needs to have set up the endpoints and USB function in @dev
1205  * before calling this, as well as the appropriate (speed-specific)
1206  * endpoint descriptors, and also have set up the TTY driver by calling
1207  * @gserial_setup().
1208  *
1209  * Returns negative errno or zero.
1210  * On success, ep->driver_data will be overwritten.
1211  */
1212 int gserial_connect(struct gserial *gser, u8 port_num)
1213 {
1214         struct gs_port  *port;
1215         unsigned long   flags;
1216         int             status;
1217
1218         if (!gs_tty_driver || port_num >= n_ports)
1219                 return -ENXIO;
1220
1221         /* we "know" gserial_cleanup() hasn't been called */
1222         port = ports[port_num].port;
1223
1224         /* activate the endpoints */
1225         status = usb_ep_enable(gser->in, gser->in_desc);
1226         if (status < 0)
1227                 return status;
1228         gser->in->driver_data = port;
1229
1230         status = usb_ep_enable(gser->out, gser->out_desc);
1231         if (status < 0)
1232                 goto fail_out;
1233         gser->out->driver_data = port;
1234
1235         /* then tell the tty glue that I/O can work */
1236         spin_lock_irqsave(&port->port_lock, flags);
1237         gser->ioport = port;
1238         port->port_usb = gser;
1239
1240         /* REVISIT unclear how best to handle this state...
1241          * we don't really couple it with the Linux TTY.
1242          */
1243         gser->port_line_coding = port->port_line_coding;
1244
1245         /* REVISIT if waiting on "carrier detect", signal. */
1246
1247         /* if it's already open, start I/O ... and notify the serial
1248          * protocol about open/close status (connect/disconnect).
1249          */
1250         if (port->open_count) {
1251                 pr_debug("gserial_connect: start ttyGS%d\n", port->port_num);
1252                 gs_start_io(port);
1253                 if (gser->connect)
1254                         gser->connect(gser);
1255         } else {
1256                 if (gser->disconnect)
1257                         gser->disconnect(gser);
1258         }
1259
1260         spin_unlock_irqrestore(&port->port_lock, flags);
1261
1262         return status;
1263
1264 fail_out:
1265         usb_ep_disable(gser->in);
1266         gser->in->driver_data = NULL;
1267         return status;
1268 }
1269
1270 /**
1271  * gserial_disconnect - notify TTY I/O glue that USB link is inactive
1272  * @gser: the function, on which gserial_connect() was called
1273  * Context: any (usually from irq)
1274  *
1275  * This is called to deactivate endpoints and let the TTY layer know
1276  * that the connection went inactive ... not unlike "hangup".
1277  *
1278  * On return, the state is as if gserial_connect() had never been called;
1279  * there is no active USB I/O on these endpoints.
1280  */
1281 void gserial_disconnect(struct gserial *gser)
1282 {
1283         struct gs_port  *port = gser->ioport;
1284         unsigned long   flags;
1285
1286         if (!port)
1287                 return;
1288
1289         /* tell the TTY glue not to do I/O here any more */
1290         spin_lock_irqsave(&port->port_lock, flags);
1291
1292         /* REVISIT as above: how best to track this? */
1293         port->port_line_coding = gser->port_line_coding;
1294
1295         port->port_usb = NULL;
1296         gser->ioport = NULL;
1297         if (port->open_count > 0 || port->openclose) {
1298                 wake_up_interruptible(&port->drain_wait);
1299                 if (port->port_tty)
1300                         tty_hangup(port->port_tty);
1301         }
1302         spin_unlock_irqrestore(&port->port_lock, flags);
1303
1304         /* disable endpoints, aborting down any active I/O */
1305         usb_ep_disable(gser->out);
1306         gser->out->driver_data = NULL;
1307
1308         usb_ep_disable(gser->in);
1309         gser->in->driver_data = NULL;
1310
1311         /* finally, free any unused/unusable I/O buffers */
1312         spin_lock_irqsave(&port->port_lock, flags);
1313         if (port->open_count == 0 && !port->openclose)
1314                 gs_buf_free(&port->port_write_buf);
1315         gs_free_requests(gser->out, &port->read_pool);
1316         gs_free_requests(gser->out, &port->read_queue);
1317         gs_free_requests(gser->in, &port->write_pool);
1318         spin_unlock_irqrestore(&port->port_lock, flags);
1319 }