drivers/char/virtio_console.c

   1 /*
   2  * Copyright (C) 2006, 2007, 2009 Rusty Russell, IBM Corporation
   3  * Copyright (C) 2009, 2010 Red Hat, Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  */
  19 #include <linux/cdev.h>
  20 #include <linux/device.h>
  21 #include <linux/err.h>
  22 #include <linux/fs.h>
  23 #include <linux/init.h>
  24 #include <linux/list.h>
  25 #include <linux/poll.h>
  26 #include <linux/sched.h>
  27 #include <linux/spinlock.h>
  28 #include <linux/virtio.h>
  29 #include <linux/virtio_console.h>
  30 #include <linux/wait.h>
  31 #include <linux/workqueue.h>
  32 #include "hvc_console.h"
  33
  34 /*
  35  * This is a global struct for storing common data for all the devices
  36  * this driver handles.
  37  *
  38  * Mainly, it has a linked list for all the consoles in one place so
  39  * that callbacks from hvc for get_chars(), put_chars() work properly
  40  * across multiple devices and multiple ports per device.
  41  */
  42 struct ports_driver_data {
  43         /* Used for registering chardevs */
  44         struct class *class;
  45
  46         /* Number of devices this driver is handling */
  47         unsigned int index;
  48
  49         /*
  50          * This is used to keep track of the number of hvc consoles
  51          * spawned by this driver.  This number is given as the first
  52          * argument to hvc_alloc().  To correctly map an initial
  53          * console spawned via hvc_instantiate to the console being
  54          * hooked up via hvc_alloc, we need to pass the same vtermno.
  55          *
  56          * We also just assume the first console being initialised was
  57          * the first one that got used as the initial console.
  58          */
  59         unsigned int next_vtermno;
  60
  61         /* All the console devices handled by this driver */
  62         struct list_head consoles;
  63 };
  64 static struct ports_driver_data pdrvdata;
  65
  66 DEFINE_SPINLOCK(pdrvdata_lock);
  67
  68 /* This struct holds information that's relevant only for console ports */
  69 struct console {
  70         /* We'll place all consoles in a list in the pdrvdata struct */
  71         struct list_head list;
  72
  73         /* The hvc device associated with this console port */
  74         struct hvc_struct *hvc;
  75
  76         /*
  77          * This number identifies the number that we used to register
  78          * with hvc in hvc_instantiate() and hvc_alloc(); this is the
  79          * number passed on by the hvc callbacks to us to
  80          * differentiate between the other console ports handled by
  81          * this driver
  82          */
  83         u32 vtermno;
  84 };
  85
  86 struct port_buffer {
  87         char *buf;
  88
  89         /* size of the buffer in *buf above */
  90         size_t size;
  91
  92         /* used length of the buffer */
  93         size_t len;
  94         /* offset in the buf from which to consume data */
  95         size_t offset;
  96 };
  97
  98 /*
  99  * This is a per-device struct that stores data common to all the
 100  * ports for that device (vdev->priv).
 101  */
 102 struct ports_device {
 103         /*
 104          * Workqueue handlers where we process deferred work after
 105          * notification
 106          */
 107         struct work_struct control_work;
 108         struct work_struct config_work;
 109
 110         struct list_head ports;
 111
 112         /* To protect the list of ports */
 113         spinlock_t ports_lock;
 114
 115         /* To protect the vq operations for the control channel */
 116         spinlock_t cvq_lock;
 117
 118         /* The current config space is stored here */
 119         struct virtio_console_config config;
 120
 121         /* The virtio device we're associated with */
 122         struct virtio_device *vdev;
 123
 124         /*
 125          * A couple of virtqueues for the control channel: one for
 126          * guest->host transfers, one for host->guest transfers
 127          */
 128         struct virtqueue *c_ivq, *c_ovq;
 129
 130         /* Array of per-port IO virtqueues */
 131         struct virtqueue **in_vqs, **out_vqs;
 132
 133         /* Used for numbering devices for sysfs and debugfs */
 134         unsigned int drv_index;
 135
 136         /* Major number for this device.  Ports will be created as minors. */
 137         int chr_major;
 138 };
 139
 140 /* This struct holds the per-port data */
 141 struct port {
 142         /* Next port in the list, head is in the ports_device */
 143         struct list_head list;
 144
 145         /* Pointer to the parent virtio_console device */
 146         struct ports_device *portdev;
 147
 148         /* The current buffer from which data has to be fed to readers */
 149         struct port_buffer *inbuf;
 150
 151         /*
 152          * To protect the operations on the in_vq associated with this
 153          * port.  Has to be a spinlock because it can be called from
 154          * interrupt context (get_char()).
 155          */
 156         spinlock_t inbuf_lock;
 157
 158         /* The IO vqs for this port */
 159         struct virtqueue *in_vq, *out_vq;
 160
 161         /*
 162          * The entries in this struct will be valid if this port is
 163          * hooked up to an hvc console
 164          */
 165         struct console cons;
 166
 167         /* Each port associates with a separate char device */
 168         struct cdev cdev;
 169         struct device *dev;
 170
 171         /* A waitqueue for poll() or blocking read operations */
 172         wait_queue_head_t waitqueue;
 173
 174         /* The 'name' of the port that we expose via sysfs properties */
 175         char *name;
 176
 177         /* The 'id' to identify the port with the Host */
 178         u32 id;
 179
 180         /* Is the host device open */
 181         bool host_connected;
 182
 183         /* We should allow only one process to open a port */
 184         bool guest_connected;
 185 };
 186
 187 /* This is the very early arch-specified put chars function. */
 188 static int (*early_put_chars)(u32, const char *, int);
 189
 190 static struct port *find_port_by_vtermno(u32 vtermno)
 191 {
 192         struct port *port;
 193         struct console *cons;
 194         unsigned long flags;
 195
 196         spin_lock_irqsave(&pdrvdata_lock, flags);
 197         list_for_each_entry(cons, &pdrvdata.consoles, list) {
 198                 if (cons->vtermno == vtermno) {
 199                         port = container_of(cons, struct port, cons);
 200                         goto out;
 201                 }
 202         }
 203         port = NULL;
 204 out:
 205         spin_unlock_irqrestore(&pdrvdata_lock, flags);
 206         return port;
 207 }
 208
 209 static struct port *find_port_by_id(struct ports_device *portdev, u32 id)
 210 {
 211         struct port *port;
 212         unsigned long flags;
 213
 214         spin_lock_irqsave(&portdev->ports_lock, flags);
 215         list_for_each_entry(port, &portdev->ports, list)
 216                 if (port->id == id)
 217                         goto out;
 218         port = NULL;
 219 out:
 220         spin_unlock_irqrestore(&portdev->ports_lock, flags);
 221
 222         return port;
 223 }
 224
 225 static struct port *find_port_by_vq(struct ports_device *portdev,
 226                                     struct virtqueue *vq)
 227 {
 228         struct port *port;
 229         unsigned long flags;
 230
 231         spin_lock_irqsave(&portdev->ports_lock, flags);
 232         list_for_each_entry(port, &portdev->ports, list)
 233                 if (port->in_vq == vq || port->out_vq == vq)
 234                         goto out;
 235         port = NULL;
 236 out:
 237         spin_unlock_irqrestore(&portdev->ports_lock, flags);
 238         return port;
 239 }
 240
 241 static bool is_console_port(struct port *port)
 242 {
 243         if (port->cons.hvc)
 244                 return true;
 245         return false;
 246 }
 247
 248 static inline bool use_multiport(struct ports_device *portdev)
 249 {
 250         /*
 251          * This condition can be true when put_chars is called from
 252          * early_init
 253          */
 254         if (!portdev->vdev)
 255                 return 0;
 256         return portdev->vdev->features[0] & (1 << VIRTIO_CONSOLE_F_MULTIPORT);
 257 }
 258
 259 static void free_buf(struct port_buffer *buf)
 260 {
 261         kfree(buf->buf);
 262         kfree(buf);
 263 }
 264
 265 static struct port_buffer *alloc_buf(size_t buf_size)
 266 {
 267         struct port_buffer *buf;
 268
 269         buf = kmalloc(sizeof(*buf), GFP_KERNEL);
 270         if (!buf)
 271                 goto fail;
 272         buf->buf = kzalloc(buf_size, GFP_KERNEL);
 273         if (!buf->buf)
 274                 goto free_buf;
 275         buf->len = 0;
 276         buf->offset = 0;
 277         buf->size = buf_size;
 278         return buf;
 279
 280 free_buf:
 281         kfree(buf);
 282 fail:
 283         return NULL;
 284 }
 285
 286 /* Callers should take appropriate locks */
 287 static void *get_inbuf(struct port *port)
 288 {
 289         struct port_buffer *buf;
 290         struct virtqueue *vq;
 291         unsigned int len;
 292
 293         vq = port->in_vq;
 294         buf = vq->vq_ops->get_buf(vq, &len);
 295         if (buf) {
 296                 buf->len = len;
 297                 buf->offset = 0;
 298         }
 299         return buf;
 300 }
 301
 302 /*
 303  * Create a scatter-gather list representing our input buffer and put
 304  * it in the queue.
 305  *
 306  * Callers should take appropriate locks.
 307  */
 308 static int add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
 309 {
 310         struct scatterlist sg[1];
 311         int ret;
 312
 313         sg_init_one(sg, buf->buf, buf->size);
 314
 315         ret = vq->vq_ops->add_buf(vq, sg, 0, 1, buf);
 316         vq->vq_ops->kick(vq);
 317         return ret;
 318 }
 319
 320 /* Discard any unread data this port has. Callers lockers. */
 321 static void discard_port_data(struct port *port)
 322 {
 323         struct port_buffer *buf;
 324         struct virtqueue *vq;
 325         unsigned int len;
 326
 327         vq = port->in_vq;
 328         if (port->inbuf)
 329                 buf = port->inbuf;
 330         else
 331                 buf = vq->vq_ops->get_buf(vq, &len);
 332
 333         if (!buf)
 334                 return;
 335
 336         if (add_inbuf(vq, buf) < 0) {
 337                 buf->len = buf->offset = 0;
 338                 dev_warn(port->dev, "Error adding buffer back to vq\n");
 339                 return;
 340         }
 341
 342         port->inbuf = NULL;
 343 }
 344
 345 static bool port_has_data(struct port *port)
 346 {
 347         unsigned long flags;
 348         bool ret;
 349
 350         ret = false;
 351         spin_lock_irqsave(&port->inbuf_lock, flags);
 352         if (port->inbuf)
 353                 ret = true;
 354         spin_unlock_irqrestore(&port->inbuf_lock, flags);
 355
 356         return ret;
 357 }
 358
 359 static ssize_t send_control_msg(struct port *port, unsigned int event,
 360                                 unsigned int value)
 361 {
 362         struct scatterlist sg[1];
 363         struct virtio_console_control cpkt;
 364         struct virtqueue *vq;
 365         int len;
 366
 367         if (!use_multiport(port->portdev))
 368                 return 0;
 369
 370         cpkt.id = port->id;
 371         cpkt.event = event;
 372         cpkt.value = value;
 373
 374         vq = port->portdev->c_ovq;
 375
 376         sg_init_one(sg, &cpkt, sizeof(cpkt));
 377         if (vq->vq_ops->add_buf(vq, sg, 1, 0, &cpkt) >= 0) {
 378                 vq->vq_ops->kick(vq);
 379                 while (!vq->vq_ops->get_buf(vq, &len))
 380                         cpu_relax();
 381         }
 382         return 0;
 383 }
 384
 385 static ssize_t send_buf(struct port *port, void *in_buf, size_t in_count)
 386 {
 387         struct scatterlist sg[1];
 388         struct virtqueue *out_vq;
 389         ssize_t ret;
 390         unsigned int len;
 391
 392         out_vq = port->out_vq;
 393
 394         sg_init_one(sg, in_buf, in_count);
 395         ret = out_vq->vq_ops->add_buf(out_vq, sg, 1, 0, in_buf);
 396
 397         /* Tell Host to go! */
 398         out_vq->vq_ops->kick(out_vq);
 399
 400         if (ret < 0) {
 401                 len = 0;
 402                 goto fail;
 403         }
 404
 405         /*
 406          * Wait till the host acknowledges it pushed out the data we
 407          * sent. Also ensure we return to userspace the number of
 408          * bytes that were successfully consumed by the host.
 409          */
 410         while (!out_vq->vq_ops->get_buf(out_vq, &len))
 411                 cpu_relax();
 412 fail:
 413         /* We're expected to return the amount of data we wrote */
 414         return len;
 415 }
 416
 417 /*
 418  * Give out the data that's requested from the buffer that we have
 419  * queued up.
 420  */
 421 static ssize_t fill_readbuf(struct port *port, char *out_buf, size_t out_count,
 422                             bool to_user)
 423 {
 424         struct port_buffer *buf;
 425         unsigned long flags;
 426
 427         if (!out_count || !port_has_data(port))
 428                 return 0;
 429
 430         buf = port->inbuf;
 431         out_count = min(out_count, buf->len - buf->offset);
 432
 433         if (to_user) {
 434                 ssize_t ret;
 435
 436                 ret = copy_to_user(out_buf, buf->buf + buf->offset, out_count);
 437                 if (ret)
 438                         return -EFAULT;
 439         } else {
 440                 memcpy(out_buf, buf->buf + buf->offset, out_count);
 441         }
 442
 443         buf->offset += out_count;
 444
 445         if (buf->offset == buf->len) {
 446                 /*
 447                  * We're done using all the data in this buffer.
 448                  * Re-queue so that the Host can send us more data.
 449                  */
 450                 spin_lock_irqsave(&port->inbuf_lock, flags);
 451                 port->inbuf = NULL;
 452
 453                 if (add_inbuf(port->in_vq, buf) < 0)
 454                         dev_warn(port->dev, "failed add_buf\n");
 455
 456                 spin_unlock_irqrestore(&port->inbuf_lock, flags);
 457         }
 458         /* Return the number of bytes actually copied */
 459         return out_count;
 460 }
 461
 462 /* The condition that must be true for polling to end */
 463 static bool wait_is_over(struct port *port)
 464 {
 465         return port_has_data(port) || !port->host_connected;
 466 }
 467
 468 static ssize_t port_fops_read(struct file *filp, char __user *ubuf,
 469                               size_t count, loff_t *offp)
 470 {
 471         struct port *port;
 472         ssize_t ret;
 473
 474         port = filp->private_data;
 475
 476         if (!port_has_data(port)) {
 477                 /*
 478                  * If nothing's connected on the host just return 0 in
 479                  * case of list_empty; this tells the userspace app
 480                  * that there's no connection
 481                  */
 482                 if (!port->host_connected)
 483                         return 0;
 484                 if (filp->f_flags & O_NONBLOCK)
 485                         return -EAGAIN;
 486
 487                 ret = wait_event_interruptible(port->waitqueue,
 488                                                wait_is_over(port));
 489                 if (ret < 0)
 490                         return ret;
 491         }
 492         /*
 493          * We could've received a disconnection message while we were
 494          * waiting for more data.
 495          *
 496          * This check is not clubbed in the if() statement above as we
 497          * might receive some data as well as the host could get
 498          * disconnected after we got woken up from our wait.  So we
 499          * really want to give off whatever data we have and only then
 500          * check for host_connected.
 501          */
 502         if (!port_has_data(port) && !port->host_connected)
 503                 return 0;
 504
 505         return fill_readbuf(port, ubuf, count, true);
 506 }
 507
 508 static ssize_t port_fops_write(struct file *filp, const char __user *ubuf,
 509                                size_t count, loff_t *offp)
 510 {
 511         struct port *port;
 512         char *buf;
 513         ssize_t ret;
 514
 515         port = filp->private_data;
 516
 517         count = min((size_t)(32 * 1024), count);
 518
 519         buf = kmalloc(count, GFP_KERNEL);
 520         if (!buf)
 521                 return -ENOMEM;
 522
 523         ret = copy_from_user(buf, ubuf, count);
 524         if (ret) {
 525                 ret = -EFAULT;
 526                 goto free_buf;
 527         }
 528
 529         ret = send_buf(port, buf, count);
 530 free_buf:
 531         kfree(buf);
 532         return ret;
 533 }
 534
 535 static unsigned int port_fops_poll(struct file *filp, poll_table *wait)
 536 {
 537         struct port *port;
 538         unsigned int ret;
 539
 540         port = filp->private_data;
 541         poll_wait(filp, &port->waitqueue, wait);
 542
 543         ret = 0;
 544         if (port->inbuf)
 545                 ret |= POLLIN | POLLRDNORM;
 546         if (port->host_connected)
 547                 ret |= POLLOUT;
 548         if (!port->host_connected)
 549                 ret |= POLLHUP;
 550
 551         return ret;
 552 }
 553
 554 static int port_fops_release(struct inode *inode, struct file *filp)
 555 {
 556         struct port *port;
 557
 558         port = filp->private_data;
 559
 560         /* Notify host of port being closed */
 561         send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 0);
 562
 563         spin_lock_irq(&port->inbuf_lock);
 564         port->guest_connected = false;
 565
 566         discard_port_data(port);
 567
 568         spin_unlock_irq(&port->inbuf_lock);
 569
 570         return 0;
 571 }
 572
 573 static int port_fops_open(struct inode *inode, struct file *filp)
 574 {
 575         struct cdev *cdev = inode->i_cdev;
 576         struct port *port;
 577
 578         port = container_of(cdev, struct port, cdev);
 579         filp->private_data = port;
 580
 581         /*
 582          * Don't allow opening of console port devices -- that's done
 583          * via /dev/hvc
 584          */
 585         if (is_console_port(port))
 586                 return -ENXIO;
 587
 588         /* Allow only one process to open a particular port at a time */
 589         spin_lock_irq(&port->inbuf_lock);
 590         if (port->guest_connected) {
 591                 spin_unlock_irq(&port->inbuf_lock);
 592                 return -EMFILE;
 593         }
 594
 595         port->guest_connected = true;
 596         spin_unlock_irq(&port->inbuf_lock);
 597
 598         /* Notify host of port being opened */
 599         send_control_msg(filp->private_data, VIRTIO_CONSOLE_PORT_OPEN, 1);
 600
 601         return 0;
 602 }
 603
 604 /*
 605  * The file operations that we support: programs in the guest can open
 606  * a console device, read from it, write to it, poll for data and
 607  * close it.  The devices are at
 608  *   /dev/vport<device number>p<port number>
 609  */
 610 static const struct file_operations port_fops = {
 611         .owner = THIS_MODULE,
 612         .open  = port_fops_open,
 613         .read  = port_fops_read,
 614         .write = port_fops_write,
 615         .poll  = port_fops_poll,
 616         .release = port_fops_release,
 617 };
 618
 619 /*
 620  * The put_chars() callback is pretty straightforward.
 621  *
 622  * We turn the characters into a scatter-gather list, add it to the
 623  * output queue and then kick the Host.  Then we sit here waiting for
 624  * it to finish: inefficient in theory, but in practice
 625  * implementations will do it immediately (lguest's Launcher does).
 626  */
 627 static int put_chars(u32 vtermno, const char *buf, int count)
 628 {
 629         struct port *port;
 630
 631         port = find_port_by_vtermno(vtermno);
 632         if (!port)
 633                 return 0;
 634
 635         if (unlikely(early_put_chars))
 636                 return early_put_chars(vtermno, buf, count);
 637
 638         return send_buf(port, (void *)buf, count);
 639 }
 640
 641 /*
 642  * get_chars() is the callback from the hvc_console infrastructure
 643  * when an interrupt is received.
 644  *
 645  * We call out to fill_readbuf that gets us the required data from the
 646  * buffers that are queued up.
 647  */
 648 static int get_chars(u32 vtermno, char *buf, int count)
 649 {
 650         struct port *port;
 651
 652         port = find_port_by_vtermno(vtermno);
 653         if (!port)
 654                 return 0;
 655
 656         /* If we don't have an input queue yet, we can't get input. */
 657         BUG_ON(!port->in_vq);
 658
 659         return fill_readbuf(port, buf, count, false);
 660 }
 661
 662 static void resize_console(struct port *port)
 663 {
 664         struct virtio_device *vdev;
 665         struct winsize ws;
 666
 667         vdev = port->portdev->vdev;
 668         if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE)) {
 669                 vdev->config->get(vdev,
 670                                   offsetof(struct virtio_console_config, cols),
 671                                   &ws.ws_col, sizeof(u16));
 672                 vdev->config->get(vdev,
 673                                   offsetof(struct virtio_console_config, rows),
 674                                   &ws.ws_row, sizeof(u16));
 675                 hvc_resize(port->cons.hvc, ws);
 676         }
 677 }
 678
 679 /* We set the configuration at this point, since we now have a tty */
 680 static int notifier_add_vio(struct hvc_struct *hp, int data)
 681 {
 682         struct port *port;
 683
 684         port = find_port_by_vtermno(hp->vtermno);
 685         if (!port)
 686                 return -EINVAL;
 687
 688         hp->irq_requested = 1;
 689         resize_console(port);
 690
 691         return 0;
 692 }
 693
 694 static void notifier_del_vio(struct hvc_struct *hp, int data)
 695 {
 696         hp->irq_requested = 0;
 697 }
 698
 699 /* The operations for console ports. */
 700 static const struct hv_ops hv_ops = {
 701         .get_chars = get_chars,
 702         .put_chars = put_chars,
 703         .notifier_add = notifier_add_vio,
 704         .notifier_del = notifier_del_vio,
 705         .notifier_hangup = notifier_del_vio,
 706 };
 707
 708 /*
 709  * Console drivers are initialized very early so boot messages can go
 710  * out, so we do things slightly differently from the generic virtio
 711  * initialization of the net and block drivers.
 712  *
 713  * At this stage, the console is output-only.  It's too early to set
 714  * up a virtqueue, so we let the drivers do some boutique early-output
 715  * thing.
 716  */
 717 int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
 718 {
 719         early_put_chars = put_chars;
 720         return hvc_instantiate(0, 0, &hv_ops);
 721 }
 722
 723 int init_port_console(struct port *port)
 724 {
 725         int ret;
 726
 727         /*
 728          * The Host's telling us this port is a console port.  Hook it
 729          * up with an hvc console.
 730          *
 731          * To set up and manage our virtual console, we call
 732          * hvc_alloc().
 733          *
 734          * The first argument of hvc_alloc() is the virtual console
 735          * number.  The second argument is the parameter for the
 736          * notification mechanism (like irq number).  We currently
 737          * leave this as zero, virtqueues have implicit notifications.
 738          *
 739          * The third argument is a "struct hv_ops" containing the
 740          * put_chars() get_chars(), notifier_add() and notifier_del()
 741          * pointers.  The final argument is the output buffer size: we
 742          * can do any size, so we put PAGE_SIZE here.
 743          */
 744         port->cons.vtermno = pdrvdata.next_vtermno;
 745
 746         port->cons.hvc = hvc_alloc(port->cons.vtermno, 0, &hv_ops, PAGE_SIZE);
 747         if (IS_ERR(port->cons.hvc)) {
 748                 ret = PTR_ERR(port->cons.hvc);
 749                 port->cons.hvc = NULL;
 750                 return ret;
 751         }
 752         spin_lock_irq(&pdrvdata_lock);
 753         pdrvdata.next_vtermno++;
 754         list_add_tail(&port->cons.list, &pdrvdata.consoles);
 755         spin_unlock_irq(&pdrvdata_lock);
 756         port->guest_connected = true;
 757
 758         /* Notify host of port being opened */
 759         send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
 760
 761         return 0;
 762 }
 763
 764 static ssize_t show_port_name(struct device *dev,
 765                               struct device_attribute *attr, char *buffer)
 766 {
 767         struct port *port;
 768
 769         port = dev_get_drvdata(dev);
 770
 771         return sprintf(buffer, "%s\n", port->name);
 772 }
 773
 774 static DEVICE_ATTR(name, S_IRUGO, show_port_name, NULL);
 775
 776 static struct attribute *port_sysfs_entries[] = {
 777         &dev_attr_name.attr,
 778         NULL
 779 };
 780
 781 static struct attribute_group port_attribute_group = {
 782         .name = NULL,           /* put in device directory */
 783         .attrs = port_sysfs_entries,
 784 };
 785
 786 /* Any private messages that the Host and Guest want to share */
 787 static void handle_control_message(struct ports_device *portdev,
 788                                    struct port_buffer *buf)
 789 {
 790         struct virtio_console_control *cpkt;
 791         struct port *port;
 792         size_t name_size;
 793         int err;
 794
 795         cpkt = (struct virtio_console_control *)(buf->buf + buf->offset);
 796
 797         port = find_port_by_id(portdev, cpkt->id);
 798         if (!port) {
 799                 /* No valid header at start of buffer.  Drop it. */
 800                 dev_dbg(&portdev->vdev->dev,
 801                         "Invalid index %u in control packet\n", cpkt->id);
 802                 return;
 803         }
 804
 805         switch (cpkt->event) {
 806         case VIRTIO_CONSOLE_CONSOLE_PORT:
 807                 if (!cpkt->value)
 808                         break;
 809                 if (is_console_port(port))
 810                         break;
 811
 812                 init_port_console(port);
 813                 /*
 814                  * Could remove the port here in case init fails - but
 815                  * have to notify the host first.
 816                  */
 817                 break;
 818         case VIRTIO_CONSOLE_RESIZE:
 819                 if (!is_console_port(port))
 820                         break;
 821                 port->cons.hvc->irq_requested = 1;
 822                 resize_console(port);
 823                 break;
 824         case VIRTIO_CONSOLE_PORT_OPEN:
 825                 port->host_connected = cpkt->value;
 826                 wake_up_interruptible(&port->waitqueue);
 827                 break;
 828         case VIRTIO_CONSOLE_PORT_NAME:
 829                 /*
 830                  * Skip the size of the header and the cpkt to get the size
 831                  * of the name that was sent
 832                  */
 833                 name_size = buf->len - buf->offset - sizeof(*cpkt) + 1;
 834
 835                 port->name = kmalloc(name_size, GFP_KERNEL);
 836                 if (!port->name) {
 837                         dev_err(port->dev,
 838                                 "Not enough space to store port name\n");
 839                         break;
 840                 }
 841                 strncpy(port->name, buf->buf + buf->offset + sizeof(*cpkt),
 842                         name_size - 1);
 843                 port->name[name_size - 1] = 0;
 844
 845                 /*
 846                  * Since we only have one sysfs attribute, 'name',
 847                  * create it only if we have a name for the port.
 848                  */
 849                 err = sysfs_create_group(&port->dev->kobj,
 850                                          &port_attribute_group);
 851                 if (err)
 852                         dev_err(port->dev,
 853                                 "Error %d creating sysfs device attributes\n",
 854                                 err);
 855
 856                 break;
 857         }
 858 }
 859
 860 static void control_work_handler(struct work_struct *work)
 861 {
 862         struct ports_device *portdev;
 863         struct virtqueue *vq;
 864         struct port_buffer *buf;
 865         unsigned int len;
 866
 867         portdev = container_of(work, struct ports_device, control_work);
 868         vq = portdev->c_ivq;
 869
 870         spin_lock(&portdev->cvq_lock);
 871         while ((buf = vq->vq_ops->get_buf(vq, &len))) {
 872                 spin_unlock(&portdev->cvq_lock);
 873
 874                 buf->len = len;
 875                 buf->offset = 0;
 876
 877                 handle_control_message(portdev, buf);
 878
 879                 spin_lock(&portdev->cvq_lock);
 880                 if (add_inbuf(portdev->c_ivq, buf) < 0) {
 881                         dev_warn(&portdev->vdev->dev,
 882                                  "Error adding buffer to queue\n");
 883                         free_buf(buf);
 884                 }
 885         }
 886         spin_unlock(&portdev->cvq_lock);
 887 }
 888
 889 static void in_intr(struct virtqueue *vq)
 890 {
 891         struct port *port;
 892         unsigned long flags;
 893
 894         port = find_port_by_vq(vq->vdev->priv, vq);
 895         if (!port)
 896                 return;
 897
 898         spin_lock_irqsave(&port->inbuf_lock, flags);
 899         port->inbuf = get_inbuf(port);
 900
 901         /*
 902          * Don't queue up data when port is closed.  This condition
 903          * can be reached when a console port is not yet connected (no
 904          * tty is spawned) and the host sends out data to console
 905          * ports.  For generic serial ports, the host won't
 906          * (shouldn't) send data till the guest is connected.
 907          */
 908         if (!port->guest_connected)
 909                 discard_port_data(port);
 910
 911         spin_unlock_irqrestore(&port->inbuf_lock, flags);
 912
 913         wake_up_interruptible(&port->waitqueue);
 914
 915         if (is_console_port(port) && hvc_poll(port->cons.hvc))
 916                 hvc_kick();
 917 }
 918
 919 static void control_intr(struct virtqueue *vq)
 920 {
 921         struct ports_device *portdev;
 922
 923         portdev = vq->vdev->priv;
 924         schedule_work(&portdev->control_work);
 925 }
 926
 927 static void config_intr(struct virtio_device *vdev)
 928 {
 929         struct ports_device *portdev;
 930
 931         portdev = vdev->priv;
 932         if (use_multiport(portdev)) {
 933                 /* Handle port hot-add */
 934                 schedule_work(&portdev->config_work);
 935         }
 936         /*
 937          * We'll use this way of resizing only for legacy support.
 938          * For newer userspace (VIRTIO_CONSOLE_F_MULTPORT+), use
 939          * control messages to indicate console size changes so that
 940          * it can be done per-port
 941          */
 942         resize_console(find_port_by_id(portdev, 0));
 943 }
 944
 945 static void fill_queue(struct virtqueue *vq, spinlock_t *lock)
 946 {
 947         struct port_buffer *buf;
 948         int ret;
 949
 950         do {
 951                 buf = alloc_buf(PAGE_SIZE);
 952                 if (!buf)
 953                         break;
 954
 955                 spin_lock_irq(lock);
 956                 ret = add_inbuf(vq, buf);
 957                 if (ret < 0) {
 958                         spin_unlock_irq(lock);
 959                         free_buf(buf);
 960                         break;
 961                 }
 962                 spin_unlock_irq(lock);
 963         } while (ret > 0);
 964 }
 965
 966 static int add_port(struct ports_device *portdev, u32 id)
 967 {
 968         struct port *port;
 969         struct port_buffer *inbuf;
 970         dev_t devt;
 971         int err;
 972
 973         port = kmalloc(sizeof(*port), GFP_KERNEL);
 974         if (!port) {
 975                 err = -ENOMEM;
 976                 goto fail;
 977         }
 978
 979         port->portdev = portdev;
 980         port->id = id;
 981
 982         port->name = NULL;
 983         port->inbuf = NULL;
 984         port->cons.hvc = NULL;
 985
 986         port->host_connected = port->guest_connected = false;
 987
 988         port->in_vq = portdev->in_vqs[port->id];
 989         port->out_vq = portdev->out_vqs[port->id];
 990
 991         cdev_init(&port->cdev, &port_fops);
 992
 993         devt = MKDEV(portdev->chr_major, id);
 994         err = cdev_add(&port->cdev, devt, 1);
 995         if (err < 0) {
 996                 dev_err(&port->portdev->vdev->dev,
 997                         "Error %d adding cdev for port %u\n", err, id);
 998                 goto free_port;
 999         }
1000         port->dev = device_create(pdrvdata.class, &port->portdev->vdev->dev,
1001                                   devt, port, "vport%up%u",
1002                                   port->portdev->drv_index, id);
1003         if (IS_ERR(port->dev)) {
1004                 err = PTR_ERR(port->dev);
1005                 dev_err(&port->portdev->vdev->dev,
1006                         "Error %d creating device for port %u\n",
1007                         err, id);
1008                 goto free_cdev;
1009         }
1010
1011         spin_lock_init(&port->inbuf_lock);
1012         init_waitqueue_head(&port->waitqueue);
1013
1014         inbuf = alloc_buf(PAGE_SIZE);
1015         if (!inbuf) {
1016                 err = -ENOMEM;
1017                 goto free_device;
1018         }
1019
1020         /* Register the input buffer the first time. */
1021         add_inbuf(port->in_vq, inbuf);
1022
1023         /*
1024          * If we're not using multiport support, this has to be a console port
1025          */
1026         if (!use_multiport(port->portdev)) {
1027                 err = init_port_console(port);
1028                 if (err)
1029                         goto free_inbuf;
1030         }
1031
1032         spin_lock_irq(&portdev->ports_lock);
1033         list_add_tail(&port->list, &port->portdev->ports);
1034         spin_unlock_irq(&portdev->ports_lock);
1035
1036         /*
1037          * Tell the Host we're set so that it can send us various
1038          * configuration parameters for this port (eg, port name,
1039          * caching, whether this is a console port, etc.)
1040          */
1041         send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1042
1043         return 0;
1044
1045 free_inbuf:
1046         free_buf(inbuf);
1047 free_device:
1048         device_destroy(pdrvdata.class, port->dev->devt);
1049 free_cdev:
1050         cdev_del(&port->cdev);
1051 free_port:
1052         kfree(port);
1053 fail:
1054         return err;
1055 }
1056
1057 /*
1058  * The workhandler for config-space updates.
1059  *
1060  * This is called when ports are hot-added.
1061  */
1062 static void config_work_handler(struct work_struct *work)
1063 {
1064         struct virtio_console_config virtconconf;
1065         struct ports_device *portdev;
1066         struct virtio_device *vdev;
1067         int err;
1068
1069         portdev = container_of(work, struct ports_device, config_work);
1070
1071         vdev = portdev->vdev;
1072         vdev->config->get(vdev,
1073                           offsetof(struct virtio_console_config, nr_ports),
1074                           &virtconconf.nr_ports,
1075                           sizeof(virtconconf.nr_ports));
1076
1077         if (portdev->config.nr_ports == virtconconf.nr_ports) {
1078                 /*
1079                  * Port 0 got hot-added.  Since we already did all the
1080                  * other initialisation for it, just tell the Host
1081                  * that the port is ready.
1082                  */
1083                 struct port *port;
1084
1085                 port = find_port_by_id(portdev, 0);
1086                 send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1087                 return;
1088         }
1089         if (virtconconf.nr_ports > portdev->config.max_nr_ports) {
1090                 dev_warn(&vdev->dev,
1091                          "More ports specified (%u) than allowed (%u)",
1092                          portdev->config.nr_ports + 1,
1093                          portdev->config.max_nr_ports);
1094                 return;
1095         }
1096         if (virtconconf.nr_ports < portdev->config.nr_ports)
1097                 return;
1098
1099         /* Hot-add ports */
1100         while (virtconconf.nr_ports - portdev->config.nr_ports) {
1101                 err = add_port(portdev, portdev->config.nr_ports);
1102                 if (err)
1103                         break;
1104                 portdev->config.nr_ports++;
1105         }
1106 }
1107
1108 static int init_vqs(struct ports_device *portdev)
1109 {
1110         vq_callback_t **io_callbacks;
1111         char **io_names;
1112         struct virtqueue **vqs;
1113         u32 i, j, nr_ports, nr_queues;
1114         int err;
1115
1116         nr_ports = portdev->config.max_nr_ports;
1117         nr_queues = use_multiport(portdev) ? (nr_ports + 1) * 2 : 2;
1118
1119         vqs = kmalloc(nr_queues * sizeof(struct virtqueue *), GFP_KERNEL);
1120         if (!vqs) {
1121                 err = -ENOMEM;
1122                 goto fail;
1123         }
1124         io_callbacks = kmalloc(nr_queues * sizeof(vq_callback_t *), GFP_KERNEL);
1125         if (!io_callbacks) {
1126                 err = -ENOMEM;
1127                 goto free_vqs;
1128         }
1129         io_names = kmalloc(nr_queues * sizeof(char *), GFP_KERNEL);
1130         if (!io_names) {
1131                 err = -ENOMEM;
1132                 goto free_callbacks;
1133         }
1134         portdev->in_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1135                                   GFP_KERNEL);
1136         if (!portdev->in_vqs) {
1137                 err = -ENOMEM;
1138                 goto free_names;
1139         }
1140         portdev->out_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1141                                    GFP_KERNEL);
1142         if (!portdev->out_vqs) {
1143                 err = -ENOMEM;
1144                 goto free_invqs;
1145         }
1146
1147         /*
1148          * For backward compat (newer host but older guest), the host
1149          * spawns a console port first and also inits the vqs for port
1150          * 0 before others.
1151          */
1152         j = 0;
1153         io_callbacks[j] = in_intr;
1154         io_callbacks[j + 1] = NULL;
1155         io_names[j] = "input";
1156         io_names[j + 1] = "output";
1157         j += 2;
1158
1159         if (use_multiport(portdev)) {
1160                 io_callbacks[j] = control_intr;
1161                 io_callbacks[j + 1] = NULL;
1162                 io_names[j] = "control-i";
1163                 io_names[j + 1] = "control-o";
1164
1165                 for (i = 1; i < nr_ports; i++) {
1166                         j += 2;
1167                         io_callbacks[j] = in_intr;
1168                         io_callbacks[j + 1] = NULL;
1169                         io_names[j] = "input";
1170                         io_names[j + 1] = "output";
1171                 }
1172         }
1173         /* Find the queues. */
1174         err = portdev->vdev->config->find_vqs(portdev->vdev, nr_queues, vqs,
1175                                               io_callbacks,
1176                                               (const char **)io_names);
1177         if (err)
1178                 goto free_outvqs;
1179
1180         j = 0;
1181         portdev->in_vqs[0] = vqs[0];
1182         portdev->out_vqs[0] = vqs[1];
1183         j += 2;
1184         if (use_multiport(portdev)) {
1185                 portdev->c_ivq = vqs[j];
1186                 portdev->c_ovq = vqs[j + 1];
1187
1188                 for (i = 1; i < nr_ports; i++) {
1189                         j += 2;
1190                         portdev->in_vqs[i] = vqs[j];
1191                         portdev->out_vqs[i] = vqs[j + 1];
1192                 }
1193         }
1194         kfree(io_callbacks);
1195         kfree(io_names);
1196         kfree(vqs);
1197
1198         return 0;
1199
1200 free_names:
1201         kfree(io_names);
1202 free_callbacks:
1203         kfree(io_callbacks);
1204 free_outvqs:
1205         kfree(portdev->out_vqs);
1206 free_invqs:
1207         kfree(portdev->in_vqs);
1208 free_vqs:
1209         kfree(vqs);
1210 fail:
1211         return err;
1212 }
1213
1214 static const struct file_operations portdev_fops = {
1215         .owner = THIS_MODULE,
1216 };
1217
1218 /*
1219  * Once we're further in boot, we get probed like any other virtio
1220  * device.
1221  *
1222  * If the host also supports multiple console ports, we check the
1223  * config space to see how many ports the host has spawned.  We
1224  * initialize each port found.
1225  */
1226 static int __devinit virtcons_probe(struct virtio_device *vdev)
1227 {
1228         struct ports_device *portdev;
1229         u32 i;
1230         int err;
1231         bool multiport;
1232
1233         portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
1234         if (!portdev) {
1235                 err = -ENOMEM;
1236                 goto fail;
1237         }
1238
1239         /* Attach this portdev to this virtio_device, and vice-versa. */
1240         portdev->vdev = vdev;
1241         vdev->priv = portdev;
1242
1243         spin_lock_irq(&pdrvdata_lock);
1244         portdev->drv_index = pdrvdata.index++;
1245         spin_unlock_irq(&pdrvdata_lock);
1246
1247         portdev->chr_major = register_chrdev(0, "virtio-portsdev",
1248                                              &portdev_fops);
1249         if (portdev->chr_major < 0) {
1250                 dev_err(&vdev->dev,
1251                         "Error %d registering chrdev for device %u\n",
1252                         portdev->chr_major, portdev->drv_index);
1253                 err = portdev->chr_major;
1254                 goto free;
1255         }
1256
1257         multiport = false;
1258         portdev->config.nr_ports = 1;
1259         portdev->config.max_nr_ports = 1;
1260         if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT)) {
1261                 multiport = true;
1262                 vdev->features[0] |= 1 << VIRTIO_CONSOLE_F_MULTIPORT;
1263
1264                 vdev->config->get(vdev, offsetof(struct virtio_console_config,
1265                                                  nr_ports),
1266                                   &portdev->config.nr_ports,
1267                                   sizeof(portdev->config.nr_ports));
1268                 vdev->config->get(vdev, offsetof(struct virtio_console_config,
1269                                                  max_nr_ports),
1270                                   &portdev->config.max_nr_ports,
1271                                   sizeof(portdev->config.max_nr_ports));
1272                 if (portdev->config.nr_ports > portdev->config.max_nr_ports) {
1273                         dev_warn(&vdev->dev,
1274                                  "More ports (%u) specified than allowed (%u). Will init %u ports.",
1275                                  portdev->config.nr_ports,
1276                                  portdev->config.max_nr_ports,
1277                                  portdev->config.max_nr_ports);
1278
1279                         portdev->config.nr_ports = portdev->config.max_nr_ports;
1280                 }
1281         }
1282
1283         /* Let the Host know we support multiple ports.*/
1284         vdev->config->finalize_features(vdev);
1285
1286         err = init_vqs(portdev);
1287         if (err < 0) {
1288                 dev_err(&vdev->dev, "Error %d initializing vqs\n", err);
1289                 goto free_chrdev;
1290         }
1291
1292         spin_lock_init(&portdev->ports_lock);
1293         INIT_LIST_HEAD(&portdev->ports);
1294
1295         if (multiport) {
1296                 spin_lock_init(&portdev->cvq_lock);
1297                 INIT_WORK(&portdev->control_work, &control_work_handler);
1298                 INIT_WORK(&portdev->config_work, &config_work_handler);
1299
1300                 fill_queue(portdev->c_ivq, &portdev->cvq_lock);
1301         }
1302
1303         for (i = 0; i < portdev->config.nr_ports; i++)
1304                 add_port(portdev, i);
1305
1306         /* Start using the new console output. */
1307         early_put_chars = NULL;
1308         return 0;
1309
1310 free_chrdev:
1311         unregister_chrdev(portdev->chr_major, "virtio-portsdev");
1312 free:
1313         kfree(portdev);
1314 fail:
1315         return err;
1316 }
1317
1318 static struct virtio_device_id id_table[] = {
1319         { VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
1320         { 0 },
1321 };
1322
1323 static unsigned int features[] = {
1324         VIRTIO_CONSOLE_F_SIZE,
1325         VIRTIO_CONSOLE_F_MULTIPORT,
1326 };
1327
1328 static struct virtio_driver virtio_console = {
1329         .feature_table = features,
1330         .feature_table_size = ARRAY_SIZE(features),
1331         .driver.name =  KBUILD_MODNAME,
1332         .driver.owner = THIS_MODULE,
1333         .id_table =     id_table,
1334         .probe =        virtcons_probe,
1335         .config_changed = config_intr,
1336 };
1337
1338 static int __init init(void)
1339 {
1340         int err;
1341
1342         pdrvdata.class = class_create(THIS_MODULE, "virtio-ports");
1343         if (IS_ERR(pdrvdata.class)) {
1344                 err = PTR_ERR(pdrvdata.class);
1345                 pr_err("Error %d creating virtio-ports class\n", err);
1346                 return err;
1347         }
1348         INIT_LIST_HEAD(&pdrvdata.consoles);
1349
1350         return register_virtio_driver(&virtio_console);
1351 }
1352 module_init(init);
1353
1354 MODULE_DEVICE_TABLE(virtio, id_table);
1355 MODULE_DESCRIPTION("Virtio console driver");
1356 MODULE_LICENSE("GPL");