drivers/char/virtio_console.c

   1 /*
   2  * Copyright (C) 2006, 2007, 2009 Rusty Russell, IBM Corporation
   3  * Copyright (C) 2009, 2010, 2011 Red Hat, Inc.
   4  * Copyright (C) 2009, 2010, 2011 Amit Shah <amit.shah@redhat.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20 #include <linux/cdev.h>
  21 #include <linux/debugfs.h>
  22 #include <linux/completion.h>
  23 #include <linux/device.h>
  24 #include <linux/err.h>
  25 #include <linux/freezer.h>
  26 #include <linux/fs.h>
  27 #include <linux/splice.h>
  28 #include <linux/pagemap.h>
  29 #include <linux/init.h>
  30 #include <linux/list.h>
  31 #include <linux/poll.h>
  32 #include <linux/sched.h>
  33 #include <linux/slab.h>
  34 #include <linux/spinlock.h>
  35 #include <linux/virtio.h>
  36 #include <linux/virtio_console.h>
  37 #include <linux/wait.h>
  38 #include <linux/workqueue.h>
  39 #include <linux/module.h>
  40 #include <linux/dma-mapping.h>
  41 #include "../tty/hvc/hvc_console.h"
  42
  43 #define is_rproc_enabled IS_ENABLED(CONFIG_REMOTEPROC)
  44
  45 /*
  46  * This is a global struct for storing common data for all the devices
  47  * this driver handles.
  48  *
  49  * Mainly, it has a linked list for all the consoles in one place so
  50  * that callbacks from hvc for get_chars(), put_chars() work properly
  51  * across multiple devices and multiple ports per device.
  52  */
  53 struct ports_driver_data {
  54         /* Used for registering chardevs */
  55         struct class *class;
  56
  57         /* Used for exporting per-port information to debugfs */
  58         struct dentry *debugfs_dir;
  59
  60         /* List of all the devices we're handling */
  61         struct list_head portdevs;
  62
  63         /*
  64          * This is used to keep track of the number of hvc consoles
  65          * spawned by this driver.  This number is given as the first
  66          * argument to hvc_alloc().  To correctly map an initial
  67          * console spawned via hvc_instantiate to the console being
  68          * hooked up via hvc_alloc, we need to pass the same vtermno.
  69          *
  70          * We also just assume the first console being initialised was
  71          * the first one that got used as the initial console.
  72          */
  73         unsigned int next_vtermno;
  74
  75         /* All the console devices handled by this driver */
  76         struct list_head consoles;
  77 };
  78 static struct ports_driver_data pdrvdata;
  79
  80 static DEFINE_SPINLOCK(pdrvdata_lock);
  81 static DECLARE_COMPLETION(early_console_added);
  82
  83 /* This struct holds information that's relevant only for console ports */
  84 struct console {
  85         /* We'll place all consoles in a list in the pdrvdata struct */
  86         struct list_head list;
  87
  88         /* The hvc device associated with this console port */
  89         struct hvc_struct *hvc;
  90
  91         /* The size of the console */
  92         struct winsize ws;
  93
  94         /*
  95          * This number identifies the number that we used to register
  96          * with hvc in hvc_instantiate() and hvc_alloc(); this is the
  97          * number passed on by the hvc callbacks to us to
  98          * differentiate between the other console ports handled by
  99          * this driver
 100          */
 101         u32 vtermno;
 102 };
 103
 104 struct port_buffer {
 105         char *buf;
 106
 107         /* size of the buffer in *buf above */
 108         size_t size;
 109
 110         /* used length of the buffer */
 111         size_t len;
 112         /* offset in the buf from which to consume data */
 113         size_t offset;
 114
 115         /* DMA address of buffer */
 116         dma_addr_t dma;
 117
 118         /* Device we got DMA memory from */
 119         struct device *dev;
 120
 121         /* List of pending dma buffers to free */
 122         struct list_head list;
 123
 124         /* If sgpages == 0 then buf is used */
 125         unsigned int sgpages;
 126
 127         /* sg is used if spages > 0. sg must be the last in is struct */
 128         struct scatterlist sg[0];
 129 };
 130
 131 /*
 132  * This is a per-device struct that stores data common to all the
 133  * ports for that device (vdev->priv).
 134  */
 135 struct ports_device {
 136         /* Next portdev in the list, head is in the pdrvdata struct */
 137         struct list_head list;
 138
 139         /*
 140          * Workqueue handlers where we process deferred work after
 141          * notification
 142          */
 143         struct work_struct control_work;
 144         struct work_struct config_work;
 145
 146         struct list_head ports;
 147
 148         /* To protect the list of ports */
 149         spinlock_t ports_lock;
 150
 151         /* To protect the vq operations for the control channel */
 152         spinlock_t c_ivq_lock;
 153         spinlock_t c_ovq_lock;
 154
 155         /* max. number of ports this device can hold */
 156         u32 max_nr_ports;
 157
 158         /* The virtio device we're associated with */
 159         struct virtio_device *vdev;
 160
 161         /*
 162          * A couple of virtqueues for the control channel: one for
 163          * guest->host transfers, one for host->guest transfers
 164          */
 165         struct virtqueue *c_ivq, *c_ovq;
 166
 167         /*
 168          * A control packet buffer for guest->host requests, protected
 169          * by c_ovq_lock.
 170          */
 171         struct virtio_console_control cpkt;
 172
 173         /* Array of per-port IO virtqueues */
 174         struct virtqueue **in_vqs, **out_vqs;
 175
 176         /* Major number for this device.  Ports will be created as minors. */
 177         int chr_major;
 178 };
 179
 180 struct port_stats {
 181         unsigned long bytes_sent, bytes_received, bytes_discarded;
 182 };
 183
 184 /* This struct holds the per-port data */
 185 struct port {
 186         /* Next port in the list, head is in the ports_device */
 187         struct list_head list;
 188
 189         /* Pointer to the parent virtio_console device */
 190         struct ports_device *portdev;
 191
 192         /* The current buffer from which data has to be fed to readers */
 193         struct port_buffer *inbuf;
 194
 195         /*
 196          * To protect the operations on the in_vq associated with this
 197          * port.  Has to be a spinlock because it can be called from
 198          * interrupt context (get_char()).
 199          */
 200         spinlock_t inbuf_lock;
 201
 202         /* Protect the operations on the out_vq. */
 203         spinlock_t outvq_lock;
 204
 205         /* The IO vqs for this port */
 206         struct virtqueue *in_vq, *out_vq;
 207
 208         /* File in the debugfs directory that exposes this port's information */
 209         struct dentry *debugfs_file;
 210
 211         /*
 212          * Keep count of the bytes sent, received and discarded for
 213          * this port for accounting and debugging purposes.  These
 214          * counts are not reset across port open / close events.
 215          */
 216         struct port_stats stats;
 217
 218         /*
 219          * The entries in this struct will be valid if this port is
 220          * hooked up to an hvc console
 221          */
 222         struct console cons;
 223
 224         /* Each port associates with a separate char device */
 225         struct cdev *cdev;
 226         struct device *dev;
 227
 228         /* Reference-counting to handle port hot-unplugs and file operations */
 229         struct kref kref;
 230
 231         /* A waitqueue for poll() or blocking read operations */
 232         wait_queue_head_t waitqueue;
 233
 234         /* The 'name' of the port that we expose via sysfs properties */
 235         char *name;
 236
 237         /* We can notify apps of host connect / disconnect events via SIGIO */
 238         struct fasync_struct *async_queue;
 239
 240         /* The 'id' to identify the port with the Host */
 241         u32 id;
 242
 243         bool outvq_full;
 244
 245         /* Is the host device open */
 246         bool host_connected;
 247
 248         /* We should allow only one process to open a port */
 249         bool guest_connected;
 250 };
 251
 252 /* This is the very early arch-specified put chars function. */
 253 static int (*early_put_chars)(u32, const char *, int);
 254
 255 static struct port *find_port_by_vtermno(u32 vtermno)
 256 {
 257         struct port *port;
 258         struct console *cons;
 259         unsigned long flags;
 260
 261         spin_lock_irqsave(&pdrvdata_lock, flags);
 262         list_for_each_entry(cons, &pdrvdata.consoles, list) {
 263                 if (cons->vtermno == vtermno) {
 264                         port = container_of(cons, struct port, cons);
 265                         goto out;
 266                 }
 267         }
 268         port = NULL;
 269 out:
 270         spin_unlock_irqrestore(&pdrvdata_lock, flags);
 271         return port;
 272 }
 273
 274 static struct port *find_port_by_devt_in_portdev(struct ports_device *portdev,
 275                                                  dev_t dev)
 276 {
 277         struct port *port;
 278         unsigned long flags;
 279
 280         spin_lock_irqsave(&portdev->ports_lock, flags);
 281         list_for_each_entry(port, &portdev->ports, list) {
 282                 if (port->cdev->dev == dev) {
 283                         kref_get(&port->kref);
 284                         goto out;
 285                 }
 286         }
 287         port = NULL;
 288 out:
 289         spin_unlock_irqrestore(&portdev->ports_lock, flags);
 290
 291         return port;
 292 }
 293
 294 static struct port *find_port_by_devt(dev_t dev)
 295 {
 296         struct ports_device *portdev;
 297         struct port *port;
 298         unsigned long flags;
 299
 300         spin_lock_irqsave(&pdrvdata_lock, flags);
 301         list_for_each_entry(portdev, &pdrvdata.portdevs, list) {
 302                 port = find_port_by_devt_in_portdev(portdev, dev);
 303                 if (port)
 304                         goto out;
 305         }
 306         port = NULL;
 307 out:
 308         spin_unlock_irqrestore(&pdrvdata_lock, flags);
 309         return port;
 310 }
 311
 312 static struct port *find_port_by_id(struct ports_device *portdev, u32 id)
 313 {
 314         struct port *port;
 315         unsigned long flags;
 316
 317         spin_lock_irqsave(&portdev->ports_lock, flags);
 318         list_for_each_entry(port, &portdev->ports, list)
 319                 if (port->id == id)
 320                         goto out;
 321         port = NULL;
 322 out:
 323         spin_unlock_irqrestore(&portdev->ports_lock, flags);
 324
 325         return port;
 326 }
 327
 328 static struct port *find_port_by_vq(struct ports_device *portdev,
 329                                     struct virtqueue *vq)
 330 {
 331         struct port *port;
 332         unsigned long flags;
 333
 334         spin_lock_irqsave(&portdev->ports_lock, flags);
 335         list_for_each_entry(port, &portdev->ports, list)
 336                 if (port->in_vq == vq || port->out_vq == vq)
 337                         goto out;
 338         port = NULL;
 339 out:
 340         spin_unlock_irqrestore(&portdev->ports_lock, flags);
 341         return port;
 342 }
 343
 344 static bool is_console_port(struct port *port)
 345 {
 346         if (port->cons.hvc)
 347                 return true;
 348         return false;
 349 }
 350
 351 static bool is_rproc_serial(const struct virtio_device *vdev)
 352 {
 353         return is_rproc_enabled && vdev->id.device == VIRTIO_ID_RPROC_SERIAL;
 354 }
 355
 356 static inline bool use_multiport(struct ports_device *portdev)
 357 {
 358         /*
 359          * This condition can be true when put_chars is called from
 360          * early_init
 361          */
 362         if (!portdev->vdev)
 363                 return false;
 364         return __virtio_test_bit(portdev->vdev, VIRTIO_CONSOLE_F_MULTIPORT);
 365 }
 366
 367 static DEFINE_SPINLOCK(dma_bufs_lock);
 368 static LIST_HEAD(pending_free_dma_bufs);
 369
 370 static void free_buf(struct port_buffer *buf, bool can_sleep)
 371 {
 372         unsigned int i;
 373
 374         for (i = 0; i < buf->sgpages; i++) {
 375                 struct page *page = sg_page(&buf->sg[i]);
 376                 if (!page)
 377                         break;
 378                 put_page(page);
 379         }
 380
 381         if (!buf->dev) {
 382                 kfree(buf->buf);
 383         } else if (is_rproc_enabled) {
 384                 unsigned long flags;
 385
 386                 /* dma_free_coherent requires interrupts to be enabled. */
 387                 if (!can_sleep) {
 388                         /* queue up dma-buffers to be freed later */
 389                         spin_lock_irqsave(&dma_bufs_lock, flags);
 390                         list_add_tail(&buf->list, &pending_free_dma_bufs);
 391                         spin_unlock_irqrestore(&dma_bufs_lock, flags);
 392                         return;
 393                 }
 394                 dma_free_coherent(buf->dev, buf->size, buf->buf, buf->dma);
 395
 396                 /* Release device refcnt and allow it to be freed */
 397                 put_device(buf->dev);
 398         }
 399
 400         kfree(buf);
 401 }
 402
 403 static void reclaim_dma_bufs(void)
 404 {
 405         unsigned long flags;
 406         struct port_buffer *buf, *tmp;
 407         LIST_HEAD(tmp_list);
 408
 409         if (list_empty(&pending_free_dma_bufs))
 410                 return;
 411
 412         /* Create a copy of the pending_free_dma_bufs while holding the lock */
 413         spin_lock_irqsave(&dma_bufs_lock, flags);
 414         list_cut_position(&tmp_list, &pending_free_dma_bufs,
 415                           pending_free_dma_bufs.prev);
 416         spin_unlock_irqrestore(&dma_bufs_lock, flags);
 417
 418         /* Release the dma buffers, without irqs enabled */
 419         list_for_each_entry_safe(buf, tmp, &tmp_list, list) {
 420                 list_del(&buf->list);
 421                 free_buf(buf, true);
 422         }
 423 }
 424
 425 static struct port_buffer *alloc_buf(struct virtqueue *vq, size_t buf_size,
 426                                      int pages)
 427 {
 428         struct port_buffer *buf;
 429
 430         reclaim_dma_bufs();
 431
 432         /*
 433          * Allocate buffer and the sg list. The sg list array is allocated
 434          * directly after the port_buffer struct.
 435          */
 436         buf = kmalloc(sizeof(*buf) + sizeof(struct scatterlist) * pages,
 437                       GFP_KERNEL);
 438         if (!buf)
 439                 goto fail;
 440
 441         buf->sgpages = pages;
 442         if (pages > 0) {
 443                 buf->dev = NULL;
 444                 buf->buf = NULL;
 445                 return buf;
 446         }
 447
 448         if (is_rproc_serial(vq->vdev)) {
 449                 /*
 450                  * Allocate DMA memory from ancestor. When a virtio
 451                  * device is created by remoteproc, the DMA memory is
 452                  * associated with the grandparent device:
 453                  * vdev => rproc => platform-dev.
 454                  */
 455                 if (!vq->vdev->dev.parent || !vq->vdev->dev.parent->parent)
 456                         goto free_buf;
 457                 buf->dev = vq->vdev->dev.parent->parent;
 458
 459                 /* Increase device refcnt to avoid freeing it */
 460                 get_device(buf->dev);
 461                 buf->buf = dma_alloc_coherent(buf->dev, buf_size, &buf->dma,
 462                                               GFP_KERNEL);
 463         } else {
 464                 buf->dev = NULL;
 465                 buf->buf = kmalloc(buf_size, GFP_KERNEL);
 466         }
 467
 468         if (!buf->buf)
 469                 goto free_buf;
 470         buf->len = 0;
 471         buf->offset = 0;
 472         buf->size = buf_size;
 473         return buf;
 474
 475 free_buf:
 476         kfree(buf);
 477 fail:
 478         return NULL;
 479 }
 480
 481 /* Callers should take appropriate locks */
 482 static struct port_buffer *get_inbuf(struct port *port)
 483 {
 484         struct port_buffer *buf;
 485         unsigned int len;
 486
 487         if (port->inbuf)
 488                 return port->inbuf;
 489
 490         buf = virtqueue_get_buf(port->in_vq, &len);
 491         if (buf) {
 492                 buf->len = len;
 493                 buf->offset = 0;
 494                 port->stats.bytes_received += len;
 495         }
 496         return buf;
 497 }
 498
 499 /*
 500  * Create a scatter-gather list representing our input buffer and put
 501  * it in the queue.
 502  *
 503  * Callers should take appropriate locks.
 504  */
 505 static int add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
 506 {
 507         struct scatterlist sg[1];
 508         int ret;
 509
 510         sg_init_one(sg, buf->buf, buf->size);
 511
 512         ret = virtqueue_add_inbuf(vq, sg, 1, buf, GFP_ATOMIC);
 513         virtqueue_kick(vq);
 514         if (!ret)
 515                 ret = vq->num_free;
 516         return ret;
 517 }
 518
 519 /* Discard any unread data this port has. Callers lockers. */
 520 static void discard_port_data(struct port *port)
 521 {
 522         struct port_buffer *buf;
 523         unsigned int err;
 524
 525         if (!port->portdev) {
 526                 /* Device has been unplugged.  vqs are already gone. */
 527                 return;
 528         }
 529         buf = get_inbuf(port);
 530
 531         err = 0;
 532         while (buf) {
 533                 port->stats.bytes_discarded += buf->len - buf->offset;
 534                 if (add_inbuf(port->in_vq, buf) < 0) {
 535                         err++;
 536                         free_buf(buf, false);
 537                 }
 538                 port->inbuf = NULL;
 539                 buf = get_inbuf(port);
 540         }
 541         if (err)
 542                 dev_warn(port->dev, "Errors adding %d buffers back to vq\n",
 543                          err);
 544 }
 545
 546 static bool port_has_data(struct port *port)
 547 {
 548         unsigned long flags;
 549         bool ret;
 550
 551         ret = false;
 552         spin_lock_irqsave(&port->inbuf_lock, flags);
 553         port->inbuf = get_inbuf(port);
 554         if (port->inbuf)
 555                 ret = true;
 556
 557         spin_unlock_irqrestore(&port->inbuf_lock, flags);
 558         return ret;
 559 }
 560
 561 static ssize_t __send_control_msg(struct ports_device *portdev, u32 port_id,
 562                                   unsigned int event, unsigned int value)
 563 {
 564         struct scatterlist sg[1];
 565         struct virtqueue *vq;
 566         unsigned int len;
 567
 568         if (!use_multiport(portdev))
 569                 return 0;
 570
 571         vq = portdev->c_ovq;
 572
 573         spin_lock(&portdev->c_ovq_lock);
 574
 575         portdev->cpkt.id = cpu_to_virtio32(portdev->vdev, port_id);
 576         portdev->cpkt.event = cpu_to_virtio16(portdev->vdev, event);
 577         portdev->cpkt.value = cpu_to_virtio16(portdev->vdev, value);
 578
 579         sg_init_one(sg, &portdev->cpkt, sizeof(struct virtio_console_control));
 580
 581         if (virtqueue_add_outbuf(vq, sg, 1, &portdev->cpkt, GFP_ATOMIC) == 0) {
 582                 virtqueue_kick(vq);
 583                 while (!virtqueue_get_buf(vq, &len)
 584                         && !virtqueue_is_broken(vq))
 585                         cpu_relax();
 586         }
 587
 588         spin_unlock(&portdev->c_ovq_lock);
 589         return 0;
 590 }
 591
 592 static ssize_t send_control_msg(struct port *port, unsigned int event,
 593                                 unsigned int value)
 594 {
 595         /* Did the port get unplugged before userspace closed it? */
 596         if (port->portdev)
 597                 return __send_control_msg(port->portdev, port->id, event, value);
 598         return 0;
 599 }
 600
 601
 602 /* Callers must take the port->outvq_lock */
 603 static void reclaim_consumed_buffers(struct port *port)
 604 {
 605         struct port_buffer *buf;
 606         unsigned int len;
 607
 608         if (!port->portdev) {
 609                 /* Device has been unplugged.  vqs are already gone. */
 610                 return;
 611         }
 612         while ((buf = virtqueue_get_buf(port->out_vq, &len))) {
 613                 free_buf(buf, false);
 614                 port->outvq_full = false;
 615         }
 616 }
 617
 618 static ssize_t __send_to_port(struct port *port, struct scatterlist *sg,
 619                               int nents, size_t in_count,
 620                               void *data, bool nonblock)
 621 {
 622         struct virtqueue *out_vq;
 623         int err;
 624         unsigned long flags;
 625         unsigned int len;
 626
 627         out_vq = port->out_vq;
 628
 629         spin_lock_irqsave(&port->outvq_lock, flags);
 630
 631         reclaim_consumed_buffers(port);
 632
 633         err = virtqueue_add_outbuf(out_vq, sg, nents, data, GFP_ATOMIC);
 634
 635         /* Tell Host to go! */
 636         virtqueue_kick(out_vq);
 637
 638         if (err) {
 639                 in_count = 0;
 640                 goto done;
 641         }
 642
 643         if (out_vq->num_free == 0)
 644                 port->outvq_full = true;
 645
 646         if (nonblock)
 647                 goto done;
 648
 649         /*
 650          * Wait till the host acknowledges it pushed out the data we
 651          * sent.  This is done for data from the hvc_console; the tty
 652          * operations are performed with spinlocks held so we can't
 653          * sleep here.  An alternative would be to copy the data to a
 654          * buffer and relax the spinning requirement.  The downside is
 655          * we need to kmalloc a GFP_ATOMIC buffer each time the
 656          * console driver writes something out.
 657          */
 658         while (!virtqueue_get_buf(out_vq, &len)
 659                 && !virtqueue_is_broken(out_vq))
 660                 cpu_relax();
 661 done:
 662         spin_unlock_irqrestore(&port->outvq_lock, flags);
 663
 664         port->stats.bytes_sent += in_count;
 665         /*
 666          * We're expected to return the amount of data we wrote -- all
 667          * of it
 668          */
 669         return in_count;
 670 }
 671
 672 /*
 673  * Give out the data that's requested from the buffer that we have
 674  * queued up.
 675  */
 676 static ssize_t fill_readbuf(struct port *port, char __user *out_buf,
 677                             size_t out_count, bool to_user)
 678 {
 679         struct port_buffer *buf;
 680         unsigned long flags;
 681
 682         if (!out_count || !port_has_data(port))
 683                 return 0;
 684
 685         buf = port->inbuf;
 686         out_count = min(out_count, buf->len - buf->offset);
 687
 688         if (to_user) {
 689                 ssize_t ret;
 690
 691                 ret = copy_to_user(out_buf, buf->buf + buf->offset, out_count);
 692                 if (ret)
 693                         return -EFAULT;
 694         } else {
 695                 memcpy((__force char *)out_buf, buf->buf + buf->offset,
 696                        out_count);
 697         }
 698
 699         buf->offset += out_count;
 700
 701         if (buf->offset == buf->len) {
 702                 /*
 703                  * We're done using all the data in this buffer.
 704                  * Re-queue so that the Host can send us more data.
 705                  */
 706                 spin_lock_irqsave(&port->inbuf_lock, flags);
 707                 port->inbuf = NULL;
 708
 709                 if (add_inbuf(port->in_vq, buf) < 0)
 710                         dev_warn(port->dev, "failed add_buf\n");
 711
 712                 spin_unlock_irqrestore(&port->inbuf_lock, flags);
 713         }
 714         /* Return the number of bytes actually copied */
 715         return out_count;
 716 }
 717
 718 /* The condition that must be true for polling to end */
 719 static bool will_read_block(struct port *port)
 720 {
 721         if (!port->guest_connected) {
 722                 /* Port got hot-unplugged. Let's exit. */
 723                 return false;
 724         }
 725         return !port_has_data(port) && port->host_connected;
 726 }
 727
 728 static bool will_write_block(struct port *port)
 729 {
 730         bool ret;
 731
 732         if (!port->guest_connected) {
 733                 /* Port got hot-unplugged. Let's exit. */
 734                 return false;
 735         }
 736         if (!port->host_connected)
 737                 return true;
 738
 739         spin_lock_irq(&port->outvq_lock);
 740         /*
 741          * Check if the Host has consumed any buffers since we last
 742          * sent data (this is only applicable for nonblocking ports).
 743          */
 744         reclaim_consumed_buffers(port);
 745         ret = port->outvq_full;
 746         spin_unlock_irq(&port->outvq_lock);
 747
 748         return ret;
 749 }
 750
 751 static ssize_t port_fops_read(struct file *filp, char __user *ubuf,
 752                               size_t count, loff_t *offp)
 753 {
 754         struct port *port;
 755         ssize_t ret;
 756
 757         port = filp->private_data;
 758
 759         /* Port is hot-unplugged. */
 760         if (!port->guest_connected)
 761                 return -ENODEV;
 762
 763         if (!port_has_data(port)) {
 764                 /*
 765                  * If nothing's connected on the host just return 0 in
 766                  * case of list_empty; this tells the userspace app
 767                  * that there's no connection
 768                  */
 769                 if (!port->host_connected)
 770                         return 0;
 771                 if (filp->f_flags & O_NONBLOCK)
 772                         return -EAGAIN;
 773
 774                 ret = wait_event_freezable(port->waitqueue,
 775                                            !will_read_block(port));
 776                 if (ret < 0)
 777                         return ret;
 778         }
 779         /* Port got hot-unplugged while we were waiting above. */
 780         if (!port->guest_connected)
 781                 return -ENODEV;
 782         /*
 783          * We could've received a disconnection message while we were
 784          * waiting for more data.
 785          *
 786          * This check is not clubbed in the if() statement above as we
 787          * might receive some data as well as the host could get
 788          * disconnected after we got woken up from our wait.  So we
 789          * really want to give off whatever data we have and only then
 790          * check for host_connected.
 791          */
 792         if (!port_has_data(port) && !port->host_connected)
 793                 return 0;
 794
 795         return fill_readbuf(port, ubuf, count, true);
 796 }
 797
 798 static int wait_port_writable(struct port *port, bool nonblock)
 799 {
 800         int ret;
 801
 802         if (will_write_block(port)) {
 803                 if (nonblock)
 804                         return -EAGAIN;
 805
 806                 ret = wait_event_freezable(port->waitqueue,
 807                                            !will_write_block(port));
 808                 if (ret < 0)
 809                         return ret;
 810         }
 811         /* Port got hot-unplugged. */
 812         if (!port->guest_connected)
 813                 return -ENODEV;
 814
 815         return 0;
 816 }
 817
 818 static ssize_t port_fops_write(struct file *filp, const char __user *ubuf,
 819                                size_t count, loff_t *offp)
 820 {
 821         struct port *port;
 822         struct port_buffer *buf;
 823         ssize_t ret;
 824         bool nonblock;
 825         struct scatterlist sg[1];
 826
 827         /* Userspace could be out to fool us */
 828         if (!count)
 829                 return 0;
 830
 831         port = filp->private_data;
 832
 833         nonblock = filp->f_flags & O_NONBLOCK;
 834
 835         ret = wait_port_writable(port, nonblock);
 836         if (ret < 0)
 837                 return ret;
 838
 839         count = min((size_t)(32 * 1024), count);
 840
 841         buf = alloc_buf(port->out_vq, count, 0);
 842         if (!buf)
 843                 return -ENOMEM;
 844
 845         ret = copy_from_user(buf->buf, ubuf, count);
 846         if (ret) {
 847                 ret = -EFAULT;
 848                 goto free_buf;
 849         }
 850
 851         /*
 852          * We now ask send_buf() to not spin for generic ports -- we
 853          * can re-use the same code path that non-blocking file
 854          * descriptors take for blocking file descriptors since the
 855          * wait is already done and we're certain the write will go
 856          * through to the host.
 857          */
 858         nonblock = true;
 859         sg_init_one(sg, buf->buf, count);
 860         ret = __send_to_port(port, sg, 1, count, buf, nonblock);
 861
 862         if (nonblock && ret > 0)
 863                 goto out;
 864
 865 free_buf:
 866         free_buf(buf, true);
 867 out:
 868         return ret;
 869 }
 870
 871 struct sg_list {
 872         unsigned int n;
 873         unsigned int size;
 874         size_t len;
 875         struct scatterlist *sg;
 876 };
 877
 878 static int pipe_to_sg(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
 879                         struct splice_desc *sd)
 880 {
 881         struct sg_list *sgl = sd->u.data;
 882         unsigned int offset, len;
 883
 884         if (sgl->n == sgl->size)
 885                 return 0;
 886
 887         /* Try lock this page */
 888         if (pipe_buf_steal(pipe, buf) == 0) {
 889                 /* Get reference and unlock page for moving */
 890                 get_page(buf->page);
 891                 unlock_page(buf->page);
 892
 893                 len = min(buf->len, sd->len);
 894                 sg_set_page(&(sgl->sg[sgl->n]), buf->page, len, buf->offset);
 895         } else {
 896                 /* Failback to copying a page */
 897                 struct page *page = alloc_page(GFP_KERNEL);
 898                 char *src;
 899
 900                 if (!page)
 901                         return -ENOMEM;
 902
 903                 offset = sd->pos & ~PAGE_MASK;
 904
 905                 len = sd->len;
 906                 if (len + offset > PAGE_SIZE)
 907                         len = PAGE_SIZE - offset;
 908
 909                 src = kmap_atomic(buf->page);
 910                 memcpy(page_address(page) + offset, src + buf->offset, len);
 911                 kunmap_atomic(src);
 912
 913                 sg_set_page(&(sgl->sg[sgl->n]), page, len, offset);
 914         }
 915         sgl->n++;
 916         sgl->len += len;
 917
 918         return len;
 919 }
 920
 921 /* Faster zero-copy write by splicing */
 922 static ssize_t port_fops_splice_write(struct pipe_inode_info *pipe,
 923                                       struct file *filp, loff_t *ppos,
 924                                       size_t len, unsigned int flags)
 925 {
 926         struct port *port = filp->private_data;
 927         struct sg_list sgl;
 928         ssize_t ret;
 929         struct port_buffer *buf;
 930         struct splice_desc sd = {
 931                 .total_len = len,
 932                 .flags = flags,
 933                 .pos = *ppos,
 934                 .u.data = &sgl,
 935         };
 936
 937         /*
 938          * Rproc_serial does not yet support splice. To support splice
 939          * pipe_to_sg() must allocate dma-buffers and copy content from
 940          * regular pages to dma pages. And alloc_buf and free_buf must
 941          * support allocating and freeing such a list of dma-buffers.
 942          */
 943         if (is_rproc_serial(port->out_vq->vdev))
 944                 return -EINVAL;
 945
 946         /*
 947          * pipe->nrbufs == 0 means there are no data to transfer,
 948          * so this returns just 0 for no data.
 949          */
 950         pipe_lock(pipe);
 951         if (!pipe->nrbufs) {
 952                 ret = 0;
 953                 goto error_out;
 954         }
 955
 956         ret = wait_port_writable(port, filp->f_flags & O_NONBLOCK);
 957         if (ret < 0)
 958                 goto error_out;
 959
 960         buf = alloc_buf(port->out_vq, 0, pipe->nrbufs);
 961         if (!buf) {
 962                 ret = -ENOMEM;
 963                 goto error_out;
 964         }
 965
 966         sgl.n = 0;
 967         sgl.len = 0;
 968         sgl.size = pipe->nrbufs;
 969         sgl.sg = buf->sg;
 970         sg_init_table(sgl.sg, sgl.size);
 971         ret = __splice_from_pipe(pipe, &sd, pipe_to_sg);
 972         pipe_unlock(pipe);
 973         if (likely(ret > 0))
 974                 ret = __send_to_port(port, buf->sg, sgl.n, sgl.len, buf, true);
 975
 976         if (unlikely(ret <= 0))
 977                 free_buf(buf, true);
 978         return ret;
 979
 980 error_out:
 981         pipe_unlock(pipe);
 982         return ret;
 983 }
 984
 985 static __poll_t port_fops_poll(struct file *filp, poll_table *wait)
 986 {
 987         struct port *port;
 988         __poll_t ret;
 989
 990         port = filp->private_data;
 991         poll_wait(filp, &port->waitqueue, wait);
 992
 993         if (!port->guest_connected) {
 994                 /* Port got unplugged */
 995                 return EPOLLHUP;
 996         }
 997         ret = 0;
 998         if (!will_read_block(port))
 999                 ret |= EPOLLIN | EPOLLRDNORM;
1000         if (!will_write_block(port))
1001                 ret |= EPOLLOUT;
1002         if (!port->host_connected)
1003                 ret |= EPOLLHUP;
1004
1005         return ret;
1006 }
1007
1008 static void remove_port(struct kref *kref);
1009
1010 static int port_fops_release(struct inode *inode, struct file *filp)
1011 {
1012         struct port *port;
1013
1014         port = filp->private_data;
1015
1016         /* Notify host of port being closed */
1017         send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 0);
1018
1019         spin_lock_irq(&port->inbuf_lock);
1020         port->guest_connected = false;
1021
1022         discard_port_data(port);
1023
1024         spin_unlock_irq(&port->inbuf_lock);
1025
1026         spin_lock_irq(&port->outvq_lock);
1027         reclaim_consumed_buffers(port);
1028         spin_unlock_irq(&port->outvq_lock);
1029
1030         reclaim_dma_bufs();
1031         /*
1032          * Locks aren't necessary here as a port can't be opened after
1033          * unplug, and if a port isn't unplugged, a kref would already
1034          * exist for the port.  Plus, taking ports_lock here would
1035          * create a dependency on other locks taken by functions
1036          * inside remove_port if we're the last holder of the port,
1037          * creating many problems.
1038          */
1039         kref_put(&port->kref, remove_port);
1040
1041         return 0;
1042 }
1043
1044 static int port_fops_open(struct inode *inode, struct file *filp)
1045 {
1046         struct cdev *cdev = inode->i_cdev;
1047         struct port *port;
1048         int ret;
1049
1050         /* We get the port with a kref here */
1051         port = find_port_by_devt(cdev->dev);
1052         if (!port) {
1053                 /* Port was unplugged before we could proceed */
1054                 return -ENXIO;
1055         }
1056         filp->private_data = port;
1057
1058         /*
1059          * Don't allow opening of console port devices -- that's done
1060          * via /dev/hvc
1061          */
1062         if (is_console_port(port)) {
1063                 ret = -ENXIO;
1064                 goto out;
1065         }
1066
1067         /* Allow only one process to open a particular port at a time */
1068         spin_lock_irq(&port->inbuf_lock);
1069         if (port->guest_connected) {
1070                 spin_unlock_irq(&port->inbuf_lock);
1071                 ret = -EBUSY;
1072                 goto out;
1073         }
1074
1075         port->guest_connected = true;
1076         spin_unlock_irq(&port->inbuf_lock);
1077
1078         spin_lock_irq(&port->outvq_lock);
1079         /*
1080          * There might be a chance that we missed reclaiming a few
1081          * buffers in the window of the port getting previously closed
1082          * and opening now.
1083          */
1084         reclaim_consumed_buffers(port);
1085         spin_unlock_irq(&port->outvq_lock);
1086
1087         nonseekable_open(inode, filp);
1088
1089         /* Notify host of port being opened */
1090         send_control_msg(filp->private_data, VIRTIO_CONSOLE_PORT_OPEN, 1);
1091
1092         return 0;
1093 out:
1094         kref_put(&port->kref, remove_port);
1095         return ret;
1096 }
1097
1098 static int port_fops_fasync(int fd, struct file *filp, int mode)
1099 {
1100         struct port *port;
1101
1102         port = filp->private_data;
1103         return fasync_helper(fd, filp, mode, &port->async_queue);
1104 }
1105
1106 /*
1107  * The file operations that we support: programs in the guest can open
1108  * a console device, read from it, write to it, poll for data and
1109  * close it.  The devices are at
1110  *   /dev/vport<device number>p<port number>
1111  */
1112 static const struct file_operations port_fops = {
1113         .owner = THIS_MODULE,
1114         .open  = port_fops_open,
1115         .read  = port_fops_read,
1116         .write = port_fops_write,
1117         .splice_write = port_fops_splice_write,
1118         .poll  = port_fops_poll,
1119         .release = port_fops_release,
1120         .fasync = port_fops_fasync,
1121         .llseek = no_llseek,
1122 };
1123
1124 /*
1125  * The put_chars() callback is pretty straightforward.
1126  *
1127  * We turn the characters into a scatter-gather list, add it to the
1128  * output queue and then kick the Host.  Then we sit here waiting for
1129  * it to finish: inefficient in theory, but in practice
1130  * implementations will do it immediately.
1131  */
1132 static int put_chars(u32 vtermno, const char *buf, int count)
1133 {
1134         struct port *port;
1135         struct scatterlist sg[1];
1136         void *data;
1137         int ret;
1138
1139         if (unlikely(early_put_chars))
1140                 return early_put_chars(vtermno, buf, count);
1141
1142         port = find_port_by_vtermno(vtermno);
1143         if (!port)
1144                 return -EPIPE;
1145
1146         data = kmemdup(buf, count, GFP_ATOMIC);
1147         if (!data)
1148                 return -ENOMEM;
1149
1150         sg_init_one(sg, data, count);
1151         ret = __send_to_port(port, sg, 1, count, data, false);
1152         kfree(data);
1153         return ret;
1154 }
1155
1156 /*
1157  * get_chars() is the callback from the hvc_console infrastructure
1158  * when an interrupt is received.
1159  *
1160  * We call out to fill_readbuf that gets us the required data from the
1161  * buffers that are queued up.
1162  */
1163 static int get_chars(u32 vtermno, char *buf, int count)
1164 {
1165         struct port *port;
1166
1167         /* If we've not set up the port yet, we have no input to give. */
1168         if (unlikely(early_put_chars))
1169                 return 0;
1170
1171         port = find_port_by_vtermno(vtermno);
1172         if (!port)
1173                 return -EPIPE;
1174
1175         /* If we don't have an input queue yet, we can't get input. */
1176         BUG_ON(!port->in_vq);
1177
1178         return fill_readbuf(port, (__force char __user *)buf, count, false);
1179 }
1180
1181 static void resize_console(struct port *port)
1182 {
1183         struct virtio_device *vdev;
1184
1185         /* The port could have been hot-unplugged */
1186         if (!port || !is_console_port(port))
1187                 return;
1188
1189         vdev = port->portdev->vdev;
1190
1191         /* Don't test F_SIZE at all if we're rproc: not a valid feature! */
1192         if (!is_rproc_serial(vdev) &&
1193             virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE))
1194                 hvc_resize(port->cons.hvc, port->cons.ws);
1195 }
1196
1197 /* We set the configuration at this point, since we now have a tty */
1198 static int notifier_add_vio(struct hvc_struct *hp, int data)
1199 {
1200         struct port *port;
1201
1202         port = find_port_by_vtermno(hp->vtermno);
1203         if (!port)
1204                 return -EINVAL;
1205
1206         hp->irq_requested = 1;
1207         resize_console(port);
1208
1209         return 0;
1210 }
1211
1212 static void notifier_del_vio(struct hvc_struct *hp, int data)
1213 {
1214         hp->irq_requested = 0;
1215 }
1216
1217 /* The operations for console ports. */
1218 static const struct hv_ops hv_ops = {
1219         .get_chars = get_chars,
1220         .put_chars = put_chars,
1221         .notifier_add = notifier_add_vio,
1222         .notifier_del = notifier_del_vio,
1223         .notifier_hangup = notifier_del_vio,
1224 };
1225
1226 /*
1227  * Console drivers are initialized very early so boot messages can go
1228  * out, so we do things slightly differently from the generic virtio
1229  * initialization of the net and block drivers.
1230  *
1231  * At this stage, the console is output-only.  It's too early to set
1232  * up a virtqueue, so we let the drivers do some boutique early-output
1233  * thing.
1234  */
1235 int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
1236 {
1237         early_put_chars = put_chars;
1238         return hvc_instantiate(0, 0, &hv_ops);
1239 }
1240
1241 static int init_port_console(struct port *port)
1242 {
1243         int ret;
1244
1245         /*
1246          * The Host's telling us this port is a console port.  Hook it
1247          * up with an hvc console.
1248          *
1249          * To set up and manage our virtual console, we call
1250          * hvc_alloc().
1251          *
1252          * The first argument of hvc_alloc() is the virtual console
1253          * number.  The second argument is the parameter for the
1254          * notification mechanism (like irq number).  We currently
1255          * leave this as zero, virtqueues have implicit notifications.
1256          *
1257          * The third argument is a "struct hv_ops" containing the
1258          * put_chars() get_chars(), notifier_add() and notifier_del()
1259          * pointers.  The final argument is the output buffer size: we
1260          * can do any size, so we put PAGE_SIZE here.
1261          */
1262         port->cons.vtermno = pdrvdata.next_vtermno;
1263
1264         port->cons.hvc = hvc_alloc(port->cons.vtermno, 0, &hv_ops, PAGE_SIZE);
1265         if (IS_ERR(port->cons.hvc)) {
1266                 ret = PTR_ERR(port->cons.hvc);
1267                 dev_err(port->dev,
1268                         "error %d allocating hvc for port\n", ret);
1269                 port->cons.hvc = NULL;
1270                 return ret;
1271         }
1272         spin_lock_irq(&pdrvdata_lock);
1273         pdrvdata.next_vtermno++;
1274         list_add_tail(&port->cons.list, &pdrvdata.consoles);
1275         spin_unlock_irq(&pdrvdata_lock);
1276         port->guest_connected = true;
1277
1278         /*
1279          * Start using the new console output if this is the first
1280          * console to come up.
1281          */
1282         if (early_put_chars)
1283                 early_put_chars = NULL;
1284
1285         /* Notify host of port being opened */
1286         send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
1287
1288         return 0;
1289 }
1290
1291 static ssize_t show_port_name(struct device *dev,
1292                               struct device_attribute *attr, char *buffer)
1293 {
1294         struct port *port;
1295
1296         port = dev_get_drvdata(dev);
1297
1298         return sprintf(buffer, "%s\n", port->name);
1299 }
1300
1301 static DEVICE_ATTR(name, S_IRUGO, show_port_name, NULL);
1302
1303 static struct attribute *port_sysfs_entries[] = {
1304         &dev_attr_name.attr,
1305         NULL
1306 };
1307
1308 static const struct attribute_group port_attribute_group = {
1309         .name = NULL,           /* put in device directory */
1310         .attrs = port_sysfs_entries,
1311 };
1312
1313 static ssize_t debugfs_read(struct file *filp, char __user *ubuf,
1314                             size_t count, loff_t *offp)
1315 {
1316         struct port *port;
1317         char *buf;
1318         ssize_t ret, out_offset, out_count;
1319
1320         out_count = 1024;
1321         buf = kmalloc(out_count, GFP_KERNEL);
1322         if (!buf)
1323                 return -ENOMEM;
1324
1325         port = filp->private_data;
1326         out_offset = 0;
1327         out_offset += snprintf(buf + out_offset, out_count,
1328                                "name: %s\n", port->name ? port->name : "");
1329         out_offset += snprintf(buf + out_offset, out_count - out_offset,
1330                                "guest_connected: %d\n", port->guest_connected);
1331         out_offset += snprintf(buf + out_offset, out_count - out_offset,
1332                                "host_connected: %d\n", port->host_connected);
1333         out_offset += snprintf(buf + out_offset, out_count - out_offset,
1334                                "outvq_full: %d\n", port->outvq_full);
1335         out_offset += snprintf(buf + out_offset, out_count - out_offset,
1336                                "bytes_sent: %lu\n", port->stats.bytes_sent);
1337         out_offset += snprintf(buf + out_offset, out_count - out_offset,
1338                                "bytes_received: %lu\n",
1339                                port->stats.bytes_received);
1340         out_offset += snprintf(buf + out_offset, out_count - out_offset,
1341                                "bytes_discarded: %lu\n",
1342                                port->stats.bytes_discarded);
1343         out_offset += snprintf(buf + out_offset, out_count - out_offset,
1344                                "is_console: %s\n",
1345                                is_console_port(port) ? "yes" : "no");
1346         out_offset += snprintf(buf + out_offset, out_count - out_offset,
1347                                "console_vtermno: %u\n", port->cons.vtermno);
1348
1349         ret = simple_read_from_buffer(ubuf, count, offp, buf, out_offset);
1350         kfree(buf);
1351         return ret;
1352 }
1353
1354 static const struct file_operations port_debugfs_ops = {
1355         .owner = THIS_MODULE,
1356         .open  = simple_open,
1357         .read  = debugfs_read,
1358 };
1359
1360 static void set_console_size(struct port *port, u16 rows, u16 cols)
1361 {
1362         if (!port || !is_console_port(port))
1363                 return;
1364
1365         port->cons.ws.ws_row = rows;
1366         port->cons.ws.ws_col = cols;
1367 }
1368
1369 static unsigned int fill_queue(struct virtqueue *vq, spinlock_t *lock)
1370 {
1371         struct port_buffer *buf;
1372         unsigned int nr_added_bufs;
1373         int ret;
1374
1375         nr_added_bufs = 0;
1376         do {
1377                 buf = alloc_buf(vq, PAGE_SIZE, 0);
1378                 if (!buf)
1379                         break;
1380
1381                 spin_lock_irq(lock);
1382                 ret = add_inbuf(vq, buf);
1383                 if (ret < 0) {
1384                         spin_unlock_irq(lock);
1385                         free_buf(buf, true);
1386                         break;
1387                 }
1388                 nr_added_bufs++;
1389                 spin_unlock_irq(lock);
1390         } while (ret > 0);
1391
1392         return nr_added_bufs;
1393 }
1394
1395 static void send_sigio_to_port(struct port *port)
1396 {
1397         if (port->async_queue && port->guest_connected)
1398                 kill_fasync(&port->async_queue, SIGIO, POLL_OUT);
1399 }
1400
1401 static int add_port(struct ports_device *portdev, u32 id)
1402 {
1403         char debugfs_name[16];
1404         struct port *port;
1405         struct port_buffer *buf;
1406         dev_t devt;
1407         unsigned int nr_added_bufs;
1408         int err;
1409
1410         port = kmalloc(sizeof(*port), GFP_KERNEL);
1411         if (!port) {
1412                 err = -ENOMEM;
1413                 goto fail;
1414         }
1415         kref_init(&port->kref);
1416
1417         port->portdev = portdev;
1418         port->id = id;
1419
1420         port->name = NULL;
1421         port->inbuf = NULL;
1422         port->cons.hvc = NULL;
1423         port->async_queue = NULL;
1424
1425         port->cons.ws.ws_row = port->cons.ws.ws_col = 0;
1426
1427         port->host_connected = port->guest_connected = false;
1428         port->stats = (struct port_stats) { 0 };
1429
1430         port->outvq_full = false;
1431
1432         port->in_vq = portdev->in_vqs[port->id];
1433         port->out_vq = portdev->out_vqs[port->id];
1434
1435         port->cdev = cdev_alloc();
1436         if (!port->cdev) {
1437                 dev_err(&port->portdev->vdev->dev, "Error allocating cdev\n");
1438                 err = -ENOMEM;
1439                 goto free_port;
1440         }
1441         port->cdev->ops = &port_fops;
1442
1443         devt = MKDEV(portdev->chr_major, id);
1444         err = cdev_add(port->cdev, devt, 1);
1445         if (err < 0) {
1446                 dev_err(&port->portdev->vdev->dev,
1447                         "Error %d adding cdev for port %u\n", err, id);
1448                 goto free_cdev;
1449         }
1450         port->dev = device_create(pdrvdata.class, &port->portdev->vdev->dev,
1451                                   devt, port, "vport%up%u",
1452                                   port->portdev->vdev->index, id);
1453         if (IS_ERR(port->dev)) {
1454                 err = PTR_ERR(port->dev);
1455                 dev_err(&port->portdev->vdev->dev,
1456                         "Error %d creating device for port %u\n",
1457                         err, id);
1458                 goto free_cdev;
1459         }
1460
1461         spin_lock_init(&port->inbuf_lock);
1462         spin_lock_init(&port->outvq_lock);
1463         init_waitqueue_head(&port->waitqueue);
1464
1465         /* Fill the in_vq with buffers so the host can send us data. */
1466         nr_added_bufs = fill_queue(port->in_vq, &port->inbuf_lock);
1467         if (!nr_added_bufs) {
1468                 dev_err(port->dev, "Error allocating inbufs\n");
1469                 err = -ENOMEM;
1470                 goto free_device;
1471         }
1472
1473         if (is_rproc_serial(port->portdev->vdev))
1474                 /*
1475                  * For rproc_serial assume remote processor is connected.
1476                  * rproc_serial does not want the console port, only
1477                  * the generic port implementation.
1478                  */
1479                 port->host_connected = true;
1480         else if (!use_multiport(port->portdev)) {
1481                 /*
1482                  * If we're not using multiport support,
1483                  * this has to be a console port.
1484                  */
1485                 err = init_port_console(port);
1486                 if (err)
1487                         goto free_inbufs;
1488         }
1489
1490         spin_lock_irq(&portdev->ports_lock);
1491         list_add_tail(&port->list, &port->portdev->ports);
1492         spin_unlock_irq(&portdev->ports_lock);
1493
1494         /*
1495          * Tell the Host we're set so that it can send us various
1496          * configuration parameters for this port (eg, port name,
1497          * caching, whether this is a console port, etc.)
1498          */
1499         send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1500
1501         if (pdrvdata.debugfs_dir) {
1502                 /*
1503                  * Finally, create the debugfs file that we can use to
1504                  * inspect a port's state at any time
1505                  */
1506                 snprintf(debugfs_name, sizeof(debugfs_name), "vport%up%u",
1507                          port->portdev->vdev->index, id);
1508                 port->debugfs_file = debugfs_create_file(debugfs_name, 0444,
1509                                                          pdrvdata.debugfs_dir,
1510                                                          port,
1511                                                          &port_debugfs_ops);
1512         }
1513         return 0;
1514
1515 free_inbufs:
1516         while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
1517                 free_buf(buf, true);
1518 free_device:
1519         device_destroy(pdrvdata.class, port->dev->devt);
1520 free_cdev:
1521         cdev_del(port->cdev);
1522 free_port:
1523         kfree(port);
1524 fail:
1525         /* The host might want to notify management sw about port add failure */
1526         __send_control_msg(portdev, id, VIRTIO_CONSOLE_PORT_READY, 0);
1527         return err;
1528 }
1529
1530 /* No users remain, remove all port-specific data. */
1531 static void remove_port(struct kref *kref)
1532 {
1533         struct port *port;
1534
1535         port = container_of(kref, struct port, kref);
1536
1537         kfree(port);
1538 }
1539
1540 static void remove_port_data(struct port *port)
1541 {
1542         struct port_buffer *buf;
1543
1544         spin_lock_irq(&port->inbuf_lock);
1545         /* Remove unused data this port might have received. */
1546         discard_port_data(port);
1547         spin_unlock_irq(&port->inbuf_lock);
1548
1549         /* Remove buffers we queued up for the Host to send us data in. */
1550         do {
1551                 spin_lock_irq(&port->inbuf_lock);
1552                 buf = virtqueue_detach_unused_buf(port->in_vq);
1553                 spin_unlock_irq(&port->inbuf_lock);
1554                 if (buf)
1555                         free_buf(buf, true);
1556         } while (buf);
1557
1558         spin_lock_irq(&port->outvq_lock);
1559         reclaim_consumed_buffers(port);
1560         spin_unlock_irq(&port->outvq_lock);
1561
1562         /* Free pending buffers from the out-queue. */
1563         do {
1564                 spin_lock_irq(&port->outvq_lock);
1565                 buf = virtqueue_detach_unused_buf(port->out_vq);
1566                 spin_unlock_irq(&port->outvq_lock);
1567                 if (buf)
1568                         free_buf(buf, true);
1569         } while (buf);
1570 }
1571
1572 /*
1573  * Port got unplugged.  Remove port from portdev's list and drop the
1574  * kref reference.  If no userspace has this port opened, it will
1575  * result in immediate removal the port.
1576  */
1577 static void unplug_port(struct port *port)
1578 {
1579         spin_lock_irq(&port->portdev->ports_lock);
1580         list_del(&port->list);
1581         spin_unlock_irq(&port->portdev->ports_lock);
1582
1583         spin_lock_irq(&port->inbuf_lock);
1584         if (port->guest_connected) {
1585                 /* Let the app know the port is going down. */
1586                 send_sigio_to_port(port);
1587
1588                 /* Do this after sigio is actually sent */
1589                 port->guest_connected = false;
1590                 port->host_connected = false;
1591
1592                 wake_up_interruptible(&port->waitqueue);
1593         }
1594         spin_unlock_irq(&port->inbuf_lock);
1595
1596         if (is_console_port(port)) {
1597                 spin_lock_irq(&pdrvdata_lock);
1598                 list_del(&port->cons.list);
1599                 spin_unlock_irq(&pdrvdata_lock);
1600                 hvc_remove(port->cons.hvc);
1601         }
1602
1603         remove_port_data(port);
1604
1605         /*
1606          * We should just assume the device itself has gone off --
1607          * else a close on an open port later will try to send out a
1608          * control message.
1609          */
1610         port->portdev = NULL;
1611
1612         sysfs_remove_group(&port->dev->kobj, &port_attribute_group);
1613         device_destroy(pdrvdata.class, port->dev->devt);
1614         cdev_del(port->cdev);
1615
1616         debugfs_remove(port->debugfs_file);
1617         kfree(port->name);
1618
1619         /*
1620          * Locks around here are not necessary - a port can't be
1621          * opened after we removed the port struct from ports_list
1622          * above.
1623          */
1624         kref_put(&port->kref, remove_port);
1625 }
1626
1627 /* Any private messages that the Host and Guest want to share */
1628 static void handle_control_message(struct virtio_device *vdev,
1629                                    struct ports_device *portdev,
1630                                    struct port_buffer *buf)
1631 {
1632         struct virtio_console_control *cpkt;
1633         struct port *port;
1634         size_t name_size;
1635         int err;
1636
1637         cpkt = (struct virtio_console_control *)(buf->buf + buf->offset);
1638
1639         port = find_port_by_id(portdev, virtio32_to_cpu(vdev, cpkt->id));
1640         if (!port &&
1641             cpkt->event != cpu_to_virtio16(vdev, VIRTIO_CONSOLE_PORT_ADD)) {
1642                 /* No valid header at start of buffer.  Drop it. */
1643                 dev_dbg(&portdev->vdev->dev,
1644                         "Invalid index %u in control packet\n", cpkt->id);
1645                 return;
1646         }
1647
1648         switch (virtio16_to_cpu(vdev, cpkt->event)) {
1649         case VIRTIO_CONSOLE_PORT_ADD:
1650                 if (port) {
1651                         dev_dbg(&portdev->vdev->dev,
1652                                 "Port %u already added\n", port->id);
1653                         send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1654                         break;
1655                 }
1656                 if (virtio32_to_cpu(vdev, cpkt->id) >=
1657                     portdev->max_nr_ports) {
1658                         dev_warn(&portdev->vdev->dev,
1659                                 "Request for adding port with "
1660                                 "out-of-bound id %u, max. supported id: %u\n",
1661                                 cpkt->id, portdev->max_nr_ports - 1);
1662                         break;
1663                 }
1664                 add_port(portdev, virtio32_to_cpu(vdev, cpkt->id));
1665                 break;
1666         case VIRTIO_CONSOLE_PORT_REMOVE:
1667                 unplug_port(port);
1668                 break;
1669         case VIRTIO_CONSOLE_CONSOLE_PORT:
1670                 if (!cpkt->value)
1671                         break;
1672                 if (is_console_port(port))
1673                         break;
1674
1675                 init_port_console(port);
1676                 complete(&early_console_added);
1677                 /*
1678                  * Could remove the port here in case init fails - but
1679                  * have to notify the host first.
1680                  */
1681                 break;
1682         case VIRTIO_CONSOLE_RESIZE: {
1683                 struct {
1684                         __u16 rows;
1685                         __u16 cols;
1686                 } size;
1687
1688                 if (!is_console_port(port))
1689                         break;
1690
1691                 memcpy(&size, buf->buf + buf->offset + sizeof(*cpkt),
1692                        sizeof(size));
1693                 set_console_size(port, size.rows, size.cols);
1694
1695                 port->cons.hvc->irq_requested = 1;
1696                 resize_console(port);
1697                 break;
1698         }
1699         case VIRTIO_CONSOLE_PORT_OPEN:
1700                 port->host_connected = virtio16_to_cpu(vdev, cpkt->value);
1701                 wake_up_interruptible(&port->waitqueue);
1702                 /*
1703                  * If the host port got closed and the host had any
1704                  * unconsumed buffers, we'll be able to reclaim them
1705                  * now.
1706                  */
1707                 spin_lock_irq(&port->outvq_lock);
1708                 reclaim_consumed_buffers(port);
1709                 spin_unlock_irq(&port->outvq_lock);
1710
1711                 /*
1712                  * If the guest is connected, it'll be interested in
1713                  * knowing the host connection state changed.
1714                  */
1715                 spin_lock_irq(&port->inbuf_lock);
1716                 send_sigio_to_port(port);
1717                 spin_unlock_irq(&port->inbuf_lock);
1718                 break;
1719         case VIRTIO_CONSOLE_PORT_NAME:
1720                 /*
1721                  * If we woke up after hibernation, we can get this
1722                  * again.  Skip it in that case.
1723                  */
1724                 if (port->name)
1725                         break;
1726
1727                 /*
1728                  * Skip the size of the header and the cpkt to get the size
1729                  * of the name that was sent
1730                  */
1731                 name_size = buf->len - buf->offset - sizeof(*cpkt) + 1;
1732
1733                 port->name = kmalloc(name_size, GFP_KERNEL);
1734                 if (!port->name) {
1735                         dev_err(port->dev,
1736                                 "Not enough space to store port name\n");
1737                         break;
1738                 }
1739                 strncpy(port->name, buf->buf + buf->offset + sizeof(*cpkt),
1740                         name_size - 1);
1741                 port->name[name_size - 1] = 0;
1742
1743                 /*
1744                  * Since we only have one sysfs attribute, 'name',
1745                  * create it only if we have a name for the port.
1746                  */
1747                 err = sysfs_create_group(&port->dev->kobj,
1748                                          &port_attribute_group);
1749                 if (err) {
1750                         dev_err(port->dev,
1751                                 "Error %d creating sysfs device attributes\n",
1752                                 err);
1753                 } else {
1754                         /*
1755                          * Generate a udev event so that appropriate
1756                          * symlinks can be created based on udev
1757                          * rules.
1758                          */
1759                         kobject_uevent(&port->dev->kobj, KOBJ_CHANGE);
1760                 }
1761                 break;
1762         }
1763 }
1764
1765 static void control_work_handler(struct work_struct *work)
1766 {
1767         struct ports_device *portdev;
1768         struct virtqueue *vq;
1769         struct port_buffer *buf;
1770         unsigned int len;
1771
1772         portdev = container_of(work, struct ports_device, control_work);
1773         vq = portdev->c_ivq;
1774
1775         spin_lock(&portdev->c_ivq_lock);
1776         while ((buf = virtqueue_get_buf(vq, &len))) {
1777                 spin_unlock(&portdev->c_ivq_lock);
1778
1779                 buf->len = len;
1780                 buf->offset = 0;
1781
1782                 handle_control_message(vq->vdev, portdev, buf);
1783
1784                 spin_lock(&portdev->c_ivq_lock);
1785                 if (add_inbuf(portdev->c_ivq, buf) < 0) {
1786                         dev_warn(&portdev->vdev->dev,
1787                                  "Error adding buffer to queue\n");
1788                         free_buf(buf, false);
1789                 }
1790         }
1791         spin_unlock(&portdev->c_ivq_lock);
1792 }
1793
1794 static void out_intr(struct virtqueue *vq)
1795 {
1796         struct port *port;
1797
1798         port = find_port_by_vq(vq->vdev->priv, vq);
1799         if (!port)
1800                 return;
1801
1802         wake_up_interruptible(&port->waitqueue);
1803 }
1804
1805 static void in_intr(struct virtqueue *vq)
1806 {
1807         struct port *port;
1808         unsigned long flags;
1809
1810         port = find_port_by_vq(vq->vdev->priv, vq);
1811         if (!port)
1812                 return;
1813
1814         spin_lock_irqsave(&port->inbuf_lock, flags);
1815         port->inbuf = get_inbuf(port);
1816
1817         /*
1818          * Normally the port should not accept data when the port is
1819          * closed. For generic serial ports, the host won't (shouldn't)
1820          * send data till the guest is connected. But this condition
1821          * can be reached when a console port is not yet connected (no
1822          * tty is spawned) and the other side sends out data over the
1823          * vring, or when a remote devices start sending data before
1824          * the ports are opened.
1825          *
1826          * A generic serial port will discard data if not connected,
1827          * while console ports and rproc-serial ports accepts data at
1828          * any time. rproc-serial is initiated with guest_connected to
1829          * false because port_fops_open expects this. Console ports are
1830          * hooked up with an HVC console and is initialized with
1831          * guest_connected to true.
1832          */
1833
1834         if (!port->guest_connected && !is_rproc_serial(port->portdev->vdev))
1835                 discard_port_data(port);
1836
1837         /* Send a SIGIO indicating new data in case the process asked for it */
1838         send_sigio_to_port(port);
1839
1840         spin_unlock_irqrestore(&port->inbuf_lock, flags);
1841
1842         wake_up_interruptible(&port->waitqueue);
1843
1844         if (is_console_port(port) && hvc_poll(port->cons.hvc))
1845                 hvc_kick();
1846 }
1847
1848 static void control_intr(struct virtqueue *vq)
1849 {
1850         struct ports_device *portdev;
1851
1852         portdev = vq->vdev->priv;
1853         schedule_work(&portdev->control_work);
1854 }
1855
1856 static void config_intr(struct virtio_device *vdev)
1857 {
1858         struct ports_device *portdev;
1859
1860         portdev = vdev->priv;
1861
1862         if (!use_multiport(portdev))
1863                 schedule_work(&portdev->config_work);
1864 }
1865
1866 static void config_work_handler(struct work_struct *work)
1867 {
1868         struct ports_device *portdev;
1869
1870         portdev = container_of(work, struct ports_device, config_work);
1871         if (!use_multiport(portdev)) {
1872                 struct virtio_device *vdev;
1873                 struct port *port;
1874                 u16 rows, cols;
1875
1876                 vdev = portdev->vdev;
1877                 virtio_cread(vdev, struct virtio_console_config, cols, &cols);
1878                 virtio_cread(vdev, struct virtio_console_config, rows, &rows);
1879
1880                 port = find_port_by_id(portdev, 0);
1881                 set_console_size(port, rows, cols);
1882
1883                 /*
1884                  * We'll use this way of resizing only for legacy
1885                  * support.  For newer userspace
1886                  * (VIRTIO_CONSOLE_F_MULTPORT+), use control messages
1887                  * to indicate console size changes so that it can be
1888                  * done per-port.
1889                  */
1890                 resize_console(port);
1891         }
1892 }
1893
1894 static int init_vqs(struct ports_device *portdev)
1895 {
1896         vq_callback_t **io_callbacks;
1897         char **io_names;
1898         struct virtqueue **vqs;
1899         u32 i, j, nr_ports, nr_queues;
1900         int err;
1901
1902         nr_ports = portdev->max_nr_ports;
1903         nr_queues = use_multiport(portdev) ? (nr_ports + 1) * 2 : 2;
1904
1905         vqs = kmalloc(nr_queues * sizeof(struct virtqueue *), GFP_KERNEL);
1906         io_callbacks = kmalloc(nr_queues * sizeof(vq_callback_t *), GFP_KERNEL);
1907         io_names = kmalloc(nr_queues * sizeof(char *), GFP_KERNEL);
1908         portdev->in_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1909                                   GFP_KERNEL);
1910         portdev->out_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1911                                    GFP_KERNEL);
1912         if (!vqs || !io_callbacks || !io_names || !portdev->in_vqs ||
1913             !portdev->out_vqs) {
1914                 err = -ENOMEM;
1915                 goto free;
1916         }
1917
1918         /*
1919          * For backward compat (newer host but older guest), the host
1920          * spawns a console port first and also inits the vqs for port
1921          * 0 before others.
1922          */
1923         j = 0;
1924         io_callbacks[j] = in_intr;
1925         io_callbacks[j + 1] = out_intr;
1926         io_names[j] = "input";
1927         io_names[j + 1] = "output";
1928         j += 2;
1929
1930         if (use_multiport(portdev)) {
1931                 io_callbacks[j] = control_intr;
1932                 io_callbacks[j + 1] = NULL;
1933                 io_names[j] = "control-i";
1934                 io_names[j + 1] = "control-o";
1935
1936                 for (i = 1; i < nr_ports; i++) {
1937                         j += 2;
1938                         io_callbacks[j] = in_intr;
1939                         io_callbacks[j + 1] = out_intr;
1940                         io_names[j] = "input";
1941                         io_names[j + 1] = "output";
1942                 }
1943         }
1944         /* Find the queues. */
1945         err = virtio_find_vqs(portdev->vdev, nr_queues, vqs,
1946                               io_callbacks,
1947                               (const char **)io_names, NULL);
1948         if (err)
1949                 goto free;
1950
1951         j = 0;
1952         portdev->in_vqs[0] = vqs[0];
1953         portdev->out_vqs[0] = vqs[1];
1954         j += 2;
1955         if (use_multiport(portdev)) {
1956                 portdev->c_ivq = vqs[j];
1957                 portdev->c_ovq = vqs[j + 1];
1958
1959                 for (i = 1; i < nr_ports; i++) {
1960                         j += 2;
1961                         portdev->in_vqs[i] = vqs[j];
1962                         portdev->out_vqs[i] = vqs[j + 1];
1963                 }
1964         }
1965         kfree(io_names);
1966         kfree(io_callbacks);
1967         kfree(vqs);
1968
1969         return 0;
1970
1971 free:
1972         kfree(portdev->out_vqs);
1973         kfree(portdev->in_vqs);
1974         kfree(io_names);
1975         kfree(io_callbacks);
1976         kfree(vqs);
1977
1978         return err;
1979 }
1980
1981 static const struct file_operations portdev_fops = {
1982         .owner = THIS_MODULE,
1983 };
1984
1985 static void remove_vqs(struct ports_device *portdev)
1986 {
1987         portdev->vdev->config->del_vqs(portdev->vdev);
1988         kfree(portdev->in_vqs);
1989         kfree(portdev->out_vqs);
1990 }
1991
1992 static void remove_controlq_data(struct ports_device *portdev)
1993 {
1994         struct port_buffer *buf;
1995         unsigned int len;
1996
1997         if (!use_multiport(portdev))
1998                 return;
1999
2000         while ((buf = virtqueue_get_buf(portdev->c_ivq, &len)))
2001                 free_buf(buf, true);
2002
2003         while ((buf = virtqueue_detach_unused_buf(portdev->c_ivq)))
2004                 free_buf(buf, true);
2005 }
2006
2007 /*
2008  * Once we're further in boot, we get probed like any other virtio
2009  * device.
2010  *
2011  * If the host also supports multiple console ports, we check the
2012  * config space to see how many ports the host has spawned.  We
2013  * initialize each port found.
2014  */
2015 static int virtcons_probe(struct virtio_device *vdev)
2016 {
2017         struct ports_device *portdev;
2018         int err;
2019         bool multiport;
2020         bool early = early_put_chars != NULL;
2021
2022         /* We only need a config space if features are offered */
2023         if (!vdev->config->get &&
2024             (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE)
2025              || virtio_has_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT))) {
2026                 dev_err(&vdev->dev, "%s failure: config access disabled\n",
2027                         __func__);
2028                 return -EINVAL;
2029         }
2030
2031         /* Ensure to read early_put_chars now */
2032         barrier();
2033
2034         portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
2035         if (!portdev) {
2036                 err = -ENOMEM;
2037                 goto fail;
2038         }
2039
2040         /* Attach this portdev to this virtio_device, and vice-versa. */
2041         portdev->vdev = vdev;
2042         vdev->priv = portdev;
2043
2044         portdev->chr_major = register_chrdev(0, "virtio-portsdev",
2045                                              &portdev_fops);
2046         if (portdev->chr_major < 0) {
2047                 dev_err(&vdev->dev,
2048                         "Error %d registering chrdev for device %u\n",
2049                         portdev->chr_major, vdev->index);
2050                 err = portdev->chr_major;
2051                 goto free;
2052         }
2053
2054         multiport = false;
2055         portdev->max_nr_ports = 1;
2056
2057         /* Don't test MULTIPORT at all if we're rproc: not a valid feature! */
2058         if (!is_rproc_serial(vdev) &&
2059             virtio_cread_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT,
2060                                  struct virtio_console_config, max_nr_ports,
2061                                  &portdev->max_nr_ports) == 0) {
2062                 multiport = true;
2063         }
2064
2065         err = init_vqs(portdev);
2066         if (err < 0) {
2067                 dev_err(&vdev->dev, "Error %d initializing vqs\n", err);
2068                 goto free_chrdev;
2069         }
2070
2071         spin_lock_init(&portdev->ports_lock);
2072         INIT_LIST_HEAD(&portdev->ports);
2073
2074         virtio_device_ready(portdev->vdev);
2075
2076         INIT_WORK(&portdev->config_work, &config_work_handler);
2077         INIT_WORK(&portdev->control_work, &control_work_handler);
2078
2079         if (multiport) {
2080                 unsigned int nr_added_bufs;
2081
2082                 spin_lock_init(&portdev->c_ivq_lock);
2083                 spin_lock_init(&portdev->c_ovq_lock);
2084
2085                 nr_added_bufs = fill_queue(portdev->c_ivq,
2086                                            &portdev->c_ivq_lock);
2087                 if (!nr_added_bufs) {
2088                         dev_err(&vdev->dev,
2089                                 "Error allocating buffers for control queue\n");
2090                         err = -ENOMEM;
2091                         goto free_vqs;
2092                 }
2093         } else {
2094                 /*
2095                  * For backward compatibility: Create a console port
2096                  * if we're running on older host.
2097                  */
2098                 add_port(portdev, 0);
2099         }
2100
2101         spin_lock_irq(&pdrvdata_lock);
2102         list_add_tail(&portdev->list, &pdrvdata.portdevs);
2103         spin_unlock_irq(&pdrvdata_lock);
2104
2105         __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
2106                            VIRTIO_CONSOLE_DEVICE_READY, 1);
2107
2108         /*
2109          * If there was an early virtio console, assume that there are no
2110          * other consoles. We need to wait until the hvc_alloc matches the
2111          * hvc_instantiate, otherwise tty_open will complain, resulting in
2112          * a "Warning: unable to open an initial console" boot failure.
2113          * Without multiport this is done in add_port above. With multiport
2114          * this might take some host<->guest communication - thus we have to
2115          * wait.
2116          */
2117         if (multiport && early)
2118                 wait_for_completion(&early_console_added);
2119
2120         return 0;
2121
2122 free_vqs:
2123         /* The host might want to notify mgmt sw about device add failure */
2124         __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
2125                            VIRTIO_CONSOLE_DEVICE_READY, 0);
2126         remove_vqs(portdev);
2127 free_chrdev:
2128         unregister_chrdev(portdev->chr_major, "virtio-portsdev");
2129 free:
2130         kfree(portdev);
2131 fail:
2132         return err;
2133 }
2134
2135 static void virtcons_remove(struct virtio_device *vdev)
2136 {
2137         struct ports_device *portdev;
2138         struct port *port, *port2;
2139
2140         portdev = vdev->priv;
2141
2142         spin_lock_irq(&pdrvdata_lock);
2143         list_del(&portdev->list);
2144         spin_unlock_irq(&pdrvdata_lock);
2145
2146         /* Disable interrupts for vqs */
2147         vdev->config->reset(vdev);
2148         /* Finish up work that's lined up */
2149         if (use_multiport(portdev))
2150                 cancel_work_sync(&portdev->control_work);
2151         else
2152                 cancel_work_sync(&portdev->config_work);
2153
2154         list_for_each_entry_safe(port, port2, &portdev->ports, list)
2155                 unplug_port(port);
2156
2157         unregister_chrdev(portdev->chr_major, "virtio-portsdev");
2158
2159         /*
2160          * When yanking out a device, we immediately lose the
2161          * (device-side) queues.  So there's no point in keeping the
2162          * guest side around till we drop our final reference.  This
2163          * also means that any ports which are in an open state will
2164          * have to just stop using the port, as the vqs are going
2165          * away.
2166          */
2167         remove_controlq_data(portdev);
2168         remove_vqs(portdev);
2169         kfree(portdev);
2170 }
2171
2172 static struct virtio_device_id id_table[] = {
2173         { VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
2174         { 0 },
2175 };
2176
2177 static unsigned int features[] = {
2178         VIRTIO_CONSOLE_F_SIZE,
2179         VIRTIO_CONSOLE_F_MULTIPORT,
2180 };
2181
2182 static struct virtio_device_id rproc_serial_id_table[] = {
2183 #if IS_ENABLED(CONFIG_REMOTEPROC)
2184         { VIRTIO_ID_RPROC_SERIAL, VIRTIO_DEV_ANY_ID },
2185 #endif
2186         { 0 },
2187 };
2188
2189 static unsigned int rproc_serial_features[] = {
2190 };
2191
2192 #ifdef CONFIG_PM_SLEEP
2193 static int virtcons_freeze(struct virtio_device *vdev)
2194 {
2195         struct ports_device *portdev;
2196         struct port *port;
2197
2198         portdev = vdev->priv;
2199
2200         vdev->config->reset(vdev);
2201
2202         if (use_multiport(portdev))
2203                 virtqueue_disable_cb(portdev->c_ivq);
2204         cancel_work_sync(&portdev->control_work);
2205         cancel_work_sync(&portdev->config_work);
2206         /*
2207          * Once more: if control_work_handler() was running, it would
2208          * enable the cb as the last step.
2209          */
2210         if (use_multiport(portdev))
2211                 virtqueue_disable_cb(portdev->c_ivq);
2212         remove_controlq_data(portdev);
2213
2214         list_for_each_entry(port, &portdev->ports, list) {
2215                 virtqueue_disable_cb(port->in_vq);
2216                 virtqueue_disable_cb(port->out_vq);
2217                 /*
2218                  * We'll ask the host later if the new invocation has
2219                  * the port opened or closed.
2220                  */
2221                 port->host_connected = false;
2222                 remove_port_data(port);
2223         }
2224         remove_vqs(portdev);
2225
2226         return 0;
2227 }
2228
2229 static int virtcons_restore(struct virtio_device *vdev)
2230 {
2231         struct ports_device *portdev;
2232         struct port *port;
2233         int ret;
2234
2235         portdev = vdev->priv;
2236
2237         ret = init_vqs(portdev);
2238         if (ret)
2239                 return ret;
2240
2241         virtio_device_ready(portdev->vdev);
2242
2243         if (use_multiport(portdev))
2244                 fill_queue(portdev->c_ivq, &portdev->c_ivq_lock);
2245
2246         list_for_each_entry(port, &portdev->ports, list) {
2247                 port->in_vq = portdev->in_vqs[port->id];
2248                 port->out_vq = portdev->out_vqs[port->id];
2249
2250                 fill_queue(port->in_vq, &port->inbuf_lock);
2251
2252                 /* Get port open/close status on the host */
2253                 send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
2254
2255                 /*
2256                  * If a port was open at the time of suspending, we
2257                  * have to let the host know that it's still open.
2258                  */
2259                 if (port->guest_connected)
2260                         send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
2261         }
2262         return 0;
2263 }
2264 #endif
2265
2266 static struct virtio_driver virtio_console = {
2267         .feature_table = features,
2268         .feature_table_size = ARRAY_SIZE(features),
2269         .driver.name =  KBUILD_MODNAME,
2270         .driver.owner = THIS_MODULE,
2271         .id_table =     id_table,
2272         .probe =        virtcons_probe,
2273         .remove =       virtcons_remove,
2274         .config_changed = config_intr,
2275 #ifdef CONFIG_PM_SLEEP
2276         .freeze =       virtcons_freeze,
2277         .restore =      virtcons_restore,
2278 #endif
2279 };
2280
2281 static struct virtio_driver virtio_rproc_serial = {
2282         .feature_table = rproc_serial_features,
2283         .feature_table_size = ARRAY_SIZE(rproc_serial_features),
2284         .driver.name =  "virtio_rproc_serial",
2285         .driver.owner = THIS_MODULE,
2286         .id_table =     rproc_serial_id_table,
2287         .probe =        virtcons_probe,
2288         .remove =       virtcons_remove,
2289 };
2290
2291 static int __init init(void)
2292 {
2293         int err;
2294
2295         pdrvdata.class = class_create(THIS_MODULE, "virtio-ports");
2296         if (IS_ERR(pdrvdata.class)) {
2297                 err = PTR_ERR(pdrvdata.class);
2298                 pr_err("Error %d creating virtio-ports class\n", err);
2299                 return err;
2300         }
2301
2302         pdrvdata.debugfs_dir = debugfs_create_dir("virtio-ports", NULL);
2303         if (!pdrvdata.debugfs_dir)
2304                 pr_warn("Error creating debugfs dir for virtio-ports\n");
2305         INIT_LIST_HEAD(&pdrvdata.consoles);
2306         INIT_LIST_HEAD(&pdrvdata.portdevs);
2307
2308         err = register_virtio_driver(&virtio_console);
2309         if (err < 0) {
2310                 pr_err("Error %d registering virtio driver\n", err);
2311                 goto free;
2312         }
2313         err = register_virtio_driver(&virtio_rproc_serial);
2314         if (err < 0) {
2315                 pr_err("Error %d registering virtio rproc serial driver\n",
2316                        err);
2317                 goto unregister;
2318         }
2319         return 0;
2320 unregister:
2321         unregister_virtio_driver(&virtio_console);
2322 free:
2323         debugfs_remove_recursive(pdrvdata.debugfs_dir);
2324         class_destroy(pdrvdata.class);
2325         return err;
2326 }
2327
2328 static void __exit fini(void)
2329 {
2330         reclaim_dma_bufs();
2331
2332         unregister_virtio_driver(&virtio_console);
2333         unregister_virtio_driver(&virtio_rproc_serial);
2334
2335         class_destroy(pdrvdata.class);
2336         debugfs_remove_recursive(pdrvdata.debugfs_dir);
2337 }
2338 module_init(init);
2339 module_exit(fini);
2340
2341 MODULE_DEVICE_TABLE(virtio, id_table);
2342 MODULE_DESCRIPTION("Virtio console driver");
2343 MODULE_LICENSE("GPL");