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