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/debugfs.h>
  21 #include <linux/device.h>
  22 #include <linux/err.h>
  23 #include <linux/fs.h>
  24 #include <linux/init.h>
  25 #include <linux/list.h>
  26 #include <linux/poll.h>
  27 #include <linux/sched.h>
  28 #include <linux/slab.h>
  29 #include <linux/spinlock.h>
  30 #include <linux/virtio.h>
  31 #include <linux/virtio_console.h>
  32 #include <linux/wait.h>
  33 #include <linux/workqueue.h>
  34 #include "hvc_console.h"
  35
  36 /*
  37  * This is a global struct for storing common data for all the devices
  38  * this driver handles.
  39  *
  40  * Mainly, it has a linked list for all the consoles in one place so
  41  * that callbacks from hvc for get_chars(), put_chars() work properly
  42  * across multiple devices and multiple ports per device.
  43  */
  44 struct ports_driver_data {
  45         /* Used for registering chardevs */
  46         struct class *class;
  47
  48         /* Used for exporting per-port information to debugfs */
  49         struct dentry *debugfs_dir;
  50
  51         /* Number of devices this driver is handling */
  52         unsigned int index;
  53
  54         /*
  55          * This is used to keep track of the number of hvc consoles
  56          * spawned by this driver.  This number is given as the first
  57          * argument to hvc_alloc().  To correctly map an initial
  58          * console spawned via hvc_instantiate to the console being
  59          * hooked up via hvc_alloc, we need to pass the same vtermno.
  60          *
  61          * We also just assume the first console being initialised was
  62          * the first one that got used as the initial console.
  63          */
  64         unsigned int next_vtermno;
  65
  66         /* All the console devices handled by this driver */
  67         struct list_head consoles;
  68 };
  69 static struct ports_driver_data pdrvdata;
  70
  71 DEFINE_SPINLOCK(pdrvdata_lock);
  72
  73 /* This struct holds information that's relevant only for console ports */
  74 struct console {
  75         /* We'll place all consoles in a list in the pdrvdata struct */
  76         struct list_head list;
  77
  78         /* The hvc device associated with this console port */
  79         struct hvc_struct *hvc;
  80
  81         /* The size of the console */
  82         struct winsize ws;
  83
  84         /*
  85          * This number identifies the number that we used to register
  86          * with hvc in hvc_instantiate() and hvc_alloc(); this is the
  87          * number passed on by the hvc callbacks to us to
  88          * differentiate between the other console ports handled by
  89          * this driver
  90          */
  91         u32 vtermno;
  92 };
  93
  94 struct port_buffer {
  95         char *buf;
  96
  97         /* size of the buffer in *buf above */
  98         size_t size;
  99
 100         /* used length of the buffer */
 101         size_t len;
 102         /* offset in the buf from which to consume data */
 103         size_t offset;
 104 };
 105
 106 /*
 107  * This is a per-device struct that stores data common to all the
 108  * ports for that device (vdev->priv).
 109  */
 110 struct ports_device {
 111         /*
 112          * Workqueue handlers where we process deferred work after
 113          * notification
 114          */
 115         struct work_struct control_work;
 116
 117         struct list_head ports;
 118
 119         /* To protect the list of ports */
 120         spinlock_t ports_lock;
 121
 122         /* To protect the vq operations for the control channel */
 123         spinlock_t cvq_lock;
 124
 125         /* The current config space is stored here */
 126         struct virtio_console_config config;
 127
 128         /* The virtio device we're associated with */
 129         struct virtio_device *vdev;
 130
 131         /*
 132          * A couple of virtqueues for the control channel: one for
 133          * guest->host transfers, one for host->guest transfers
 134          */
 135         struct virtqueue *c_ivq, *c_ovq;
 136
 137         /* Array of per-port IO virtqueues */
 138         struct virtqueue **in_vqs, **out_vqs;
 139
 140         /* Used for numbering devices for sysfs and debugfs */
 141         unsigned int drv_index;
 142
 143         /* Major number for this device.  Ports will be created as minors. */
 144         int chr_major;
 145 };
 146
 147 /* This struct holds the per-port data */
 148 struct port {
 149         /* Next port in the list, head is in the ports_device */
 150         struct list_head list;
 151
 152         /* Pointer to the parent virtio_console device */
 153         struct ports_device *portdev;
 154
 155         /* The current buffer from which data has to be fed to readers */
 156         struct port_buffer *inbuf;
 157
 158         /*
 159          * To protect the operations on the in_vq associated with this
 160          * port.  Has to be a spinlock because it can be called from
 161          * interrupt context (get_char()).
 162          */
 163         spinlock_t inbuf_lock;
 164
 165         /* Protect the operations on the out_vq. */
 166         spinlock_t outvq_lock;
 167
 168         /* The IO vqs for this port */
 169         struct virtqueue *in_vq, *out_vq;
 170
 171         /* File in the debugfs directory that exposes this port's information */
 172         struct dentry *debugfs_file;
 173
 174         /*
 175          * The entries in this struct will be valid if this port is
 176          * hooked up to an hvc console
 177          */
 178         struct console cons;
 179
 180         /* Each port associates with a separate char device */
 181         struct cdev cdev;
 182         struct device *dev;
 183
 184         /* A waitqueue for poll() or blocking read operations */
 185         wait_queue_head_t waitqueue;
 186
 187         /* The 'name' of the port that we expose via sysfs properties */
 188         char *name;
 189
 190         /* The 'id' to identify the port with the Host */
 191         u32 id;
 192
 193         bool outvq_full;
 194
 195         /* Is the host device open */
 196         bool host_connected;
 197
 198         /* We should allow only one process to open a port */
 199         bool guest_connected;
 200 };
 201
 202 /* This is the very early arch-specified put chars function. */
 203 static int (*early_put_chars)(u32, const char *, int);
 204
 205 static struct port *find_port_by_vtermno(u32 vtermno)
 206 {
 207         struct port *port;
 208         struct console *cons;
 209         unsigned long flags;
 210
 211         spin_lock_irqsave(&pdrvdata_lock, flags);
 212         list_for_each_entry(cons, &pdrvdata.consoles, list) {
 213                 if (cons->vtermno == vtermno) {
 214                         port = container_of(cons, struct port, cons);
 215                         goto out;
 216                 }
 217         }
 218         port = NULL;
 219 out:
 220         spin_unlock_irqrestore(&pdrvdata_lock, flags);
 221         return port;
 222 }
 223
 224 static struct port *find_port_by_id(struct ports_device *portdev, u32 id)
 225 {
 226         struct port *port;
 227         unsigned long flags;
 228
 229         spin_lock_irqsave(&portdev->ports_lock, flags);
 230         list_for_each_entry(port, &portdev->ports, list)
 231                 if (port->id == id)
 232                         goto out;
 233         port = NULL;
 234 out:
 235         spin_unlock_irqrestore(&portdev->ports_lock, flags);
 236
 237         return port;
 238 }
 239
 240 static struct port *find_port_by_vq(struct ports_device *portdev,
 241                                     struct virtqueue *vq)
 242 {
 243         struct port *port;
 244         unsigned long flags;
 245
 246         spin_lock_irqsave(&portdev->ports_lock, flags);
 247         list_for_each_entry(port, &portdev->ports, list)
 248                 if (port->in_vq == vq || port->out_vq == vq)
 249                         goto out;
 250         port = NULL;
 251 out:
 252         spin_unlock_irqrestore(&portdev->ports_lock, flags);
 253         return port;
 254 }
 255
 256 static bool is_console_port(struct port *port)
 257 {
 258         if (port->cons.hvc)
 259                 return true;
 260         return false;
 261 }
 262
 263 static inline bool use_multiport(struct ports_device *portdev)
 264 {
 265         /*
 266          * This condition can be true when put_chars is called from
 267          * early_init
 268          */
 269         if (!portdev->vdev)
 270                 return 0;
 271         return portdev->vdev->features[0] & (1 << VIRTIO_CONSOLE_F_MULTIPORT);
 272 }
 273
 274 static void free_buf(struct port_buffer *buf)
 275 {
 276         kfree(buf->buf);
 277         kfree(buf);
 278 }
 279
 280 static struct port_buffer *alloc_buf(size_t buf_size)
 281 {
 282         struct port_buffer *buf;
 283
 284         buf = kmalloc(sizeof(*buf), GFP_KERNEL);
 285         if (!buf)
 286                 goto fail;
 287         buf->buf = kzalloc(buf_size, GFP_KERNEL);
 288         if (!buf->buf)
 289                 goto free_buf;
 290         buf->len = 0;
 291         buf->offset = 0;
 292         buf->size = buf_size;
 293         return buf;
 294
 295 free_buf:
 296         kfree(buf);
 297 fail:
 298         return NULL;
 299 }
 300
 301 /* Callers should take appropriate locks */
 302 static void *get_inbuf(struct port *port)
 303 {
 304         struct port_buffer *buf;
 305         struct virtqueue *vq;
 306         unsigned int len;
 307
 308         vq = port->in_vq;
 309         buf = virtqueue_get_buf(vq, &len);
 310         if (buf) {
 311                 buf->len = len;
 312                 buf->offset = 0;
 313         }
 314         return buf;
 315 }
 316
 317 /*
 318  * Create a scatter-gather list representing our input buffer and put
 319  * it in the queue.
 320  *
 321  * Callers should take appropriate locks.
 322  */
 323 static int add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
 324 {
 325         struct scatterlist sg[1];
 326         int ret;
 327
 328         sg_init_one(sg, buf->buf, buf->size);
 329
 330         ret = virtqueue_add_buf(vq, sg, 0, 1, buf);
 331         virtqueue_kick(vq);
 332         return ret;
 333 }
 334
 335 /* Discard any unread data this port has. Callers lockers. */
 336 static void discard_port_data(struct port *port)
 337 {
 338         struct port_buffer *buf;
 339         struct virtqueue *vq;
 340         unsigned int len;
 341         int ret;
 342
 343         vq = port->in_vq;
 344         if (port->inbuf)
 345                 buf = port->inbuf;
 346         else
 347                 buf = virtqueue_get_buf(vq, &len);
 348
 349         ret = 0;
 350         while (buf) {
 351                 if (add_inbuf(vq, buf) < 0) {
 352                         ret++;
 353                         free_buf(buf);
 354                 }
 355                 buf = virtqueue_get_buf(vq, &len);
 356         }
 357         port->inbuf = NULL;
 358         if (ret)
 359                 dev_warn(port->dev, "Errors adding %d buffers back to vq\n",
 360                          ret);
 361 }
 362
 363 static bool port_has_data(struct port *port)
 364 {
 365         unsigned long flags;
 366         bool ret;
 367
 368         spin_lock_irqsave(&port->inbuf_lock, flags);
 369         if (port->inbuf) {
 370                 ret = true;
 371                 goto out;
 372         }
 373         port->inbuf = get_inbuf(port);
 374         if (port->inbuf) {
 375                 ret = true;
 376                 goto out;
 377         }
 378         ret = false;
 379 out:
 380         spin_unlock_irqrestore(&port->inbuf_lock, flags);
 381         return ret;
 382 }
 383
 384 static ssize_t __send_control_msg(struct ports_device *portdev, u32 port_id,
 385                                   unsigned int event, unsigned int value)
 386 {
 387         struct scatterlist sg[1];
 388         struct virtio_console_control cpkt;
 389         struct virtqueue *vq;
 390         unsigned int len;
 391
 392         if (!use_multiport(portdev))
 393                 return 0;
 394
 395         cpkt.id = port_id;
 396         cpkt.event = event;
 397         cpkt.value = value;
 398
 399         vq = portdev->c_ovq;
 400
 401         sg_init_one(sg, &cpkt, sizeof(cpkt));
 402         if (virtqueue_add_buf(vq, sg, 1, 0, &cpkt) >= 0) {
 403                 virtqueue_kick(vq);
 404                 while (!virtqueue_get_buf(vq, &len))
 405                         cpu_relax();
 406         }
 407         return 0;
 408 }
 409
 410 static ssize_t send_control_msg(struct port *port, unsigned int event,
 411                                 unsigned int value)
 412 {
 413         return __send_control_msg(port->portdev, port->id, event, value);
 414 }
 415
 416 /* Callers must take the port->outvq_lock */
 417 static void reclaim_consumed_buffers(struct port *port)
 418 {
 419         void *buf;
 420         unsigned int len;
 421
 422         while ((buf = virtqueue_get_buf(port->out_vq, &len))) {
 423                 kfree(buf);
 424                 port->outvq_full = false;
 425         }
 426 }
 427
 428 static ssize_t send_buf(struct port *port, void *in_buf, size_t in_count,
 429                         bool nonblock)
 430 {
 431         struct scatterlist sg[1];
 432         struct virtqueue *out_vq;
 433         ssize_t ret;
 434         unsigned long flags;
 435         unsigned int len;
 436
 437         out_vq = port->out_vq;
 438
 439         spin_lock_irqsave(&port->outvq_lock, flags);
 440
 441         reclaim_consumed_buffers(port);
 442
 443         sg_init_one(sg, in_buf, in_count);
 444         ret = virtqueue_add_buf(out_vq, sg, 1, 0, in_buf);
 445
 446         /* Tell Host to go! */
 447         virtqueue_kick(out_vq);
 448
 449         if (ret < 0) {
 450                 in_count = 0;
 451                 goto done;
 452         }
 453
 454         if (ret == 0)
 455                 port->outvq_full = true;
 456
 457         if (nonblock)
 458                 goto done;
 459
 460         /*
 461          * Wait till the host acknowledges it pushed out the data we
 462          * sent.  This is done for ports in blocking mode or for data
 463          * from the hvc_console; the tty operations are performed with
 464          * spinlocks held so we can't sleep here.
 465          */
 466         while (!virtqueue_get_buf(out_vq, &len))
 467                 cpu_relax();
 468 done:
 469         spin_unlock_irqrestore(&port->outvq_lock, flags);
 470         /*
 471          * We're expected to return the amount of data we wrote -- all
 472          * of it
 473          */
 474         return in_count;
 475 }
 476
 477 /*
 478  * Give out the data that's requested from the buffer that we have
 479  * queued up.
 480  */
 481 static ssize_t fill_readbuf(struct port *port, char *out_buf, size_t out_count,
 482                             bool to_user)
 483 {
 484         struct port_buffer *buf;
 485         unsigned long flags;
 486
 487         if (!out_count || !port_has_data(port))
 488                 return 0;
 489
 490         buf = port->inbuf;
 491         out_count = min(out_count, buf->len - buf->offset);
 492
 493         if (to_user) {
 494                 ssize_t ret;
 495
 496                 ret = copy_to_user(out_buf, buf->buf + buf->offset, out_count);
 497                 if (ret)
 498                         return -EFAULT;
 499         } else {
 500                 memcpy(out_buf, buf->buf + buf->offset, out_count);
 501         }
 502
 503         buf->offset += out_count;
 504
 505         if (buf->offset == buf->len) {
 506                 /*
 507                  * We're done using all the data in this buffer.
 508                  * Re-queue so that the Host can send us more data.
 509                  */
 510                 spin_lock_irqsave(&port->inbuf_lock, flags);
 511                 port->inbuf = NULL;
 512
 513                 if (add_inbuf(port->in_vq, buf) < 0)
 514                         dev_warn(port->dev, "failed add_buf\n");
 515
 516                 spin_unlock_irqrestore(&port->inbuf_lock, flags);
 517         }
 518         /* Return the number of bytes actually copied */
 519         return out_count;
 520 }
 521
 522 /* The condition that must be true for polling to end */
 523 static bool will_read_block(struct port *port)
 524 {
 525         return !port_has_data(port) && port->host_connected;
 526 }
 527
 528 static bool will_write_block(struct port *port)
 529 {
 530         bool ret;
 531
 532         if (!port->guest_connected) {
 533                 /* Port got hot-unplugged. Let's exit. */
 534                 return false;
 535         }
 536         if (!port->host_connected)
 537                 return true;
 538
 539         spin_lock_irq(&port->outvq_lock);
 540         /*
 541          * Check if the Host has consumed any buffers since we last
 542          * sent data (this is only applicable for nonblocking ports).
 543          */
 544         reclaim_consumed_buffers(port);
 545         ret = port->outvq_full;
 546         spin_unlock_irq(&port->outvq_lock);
 547
 548         return ret;
 549 }
 550
 551 static ssize_t port_fops_read(struct file *filp, char __user *ubuf,
 552                               size_t count, loff_t *offp)
 553 {
 554         struct port *port;
 555         ssize_t ret;
 556
 557         port = filp->private_data;
 558
 559         if (!port_has_data(port)) {
 560                 /*
 561                  * If nothing's connected on the host just return 0 in
 562                  * case of list_empty; this tells the userspace app
 563                  * that there's no connection
 564                  */
 565                 if (!port->host_connected)
 566                         return 0;
 567                 if (filp->f_flags & O_NONBLOCK)
 568                         return -EAGAIN;
 569
 570                 ret = wait_event_interruptible(port->waitqueue,
 571                                                !will_read_block(port));
 572                 if (ret < 0)
 573                         return ret;
 574         }
 575         /*
 576          * We could've received a disconnection message while we were
 577          * waiting for more data.
 578          *
 579          * This check is not clubbed in the if() statement above as we
 580          * might receive some data as well as the host could get
 581          * disconnected after we got woken up from our wait.  So we
 582          * really want to give off whatever data we have and only then
 583          * check for host_connected.
 584          */
 585         if (!port_has_data(port) && !port->host_connected)
 586                 return 0;
 587
 588         return fill_readbuf(port, ubuf, count, true);
 589 }
 590
 591 static ssize_t port_fops_write(struct file *filp, const char __user *ubuf,
 592                                size_t count, loff_t *offp)
 593 {
 594         struct port *port;
 595         char *buf;
 596         ssize_t ret;
 597         bool nonblock;
 598
 599         port = filp->private_data;
 600
 601         nonblock = filp->f_flags & O_NONBLOCK;
 602
 603         if (will_write_block(port)) {
 604                 if (nonblock)
 605                         return -EAGAIN;
 606
 607                 ret = wait_event_interruptible(port->waitqueue,
 608                                                !will_write_block(port));
 609                 if (ret < 0)
 610                         return ret;
 611         }
 612
 613         count = min((size_t)(32 * 1024), count);
 614
 615         buf = kmalloc(count, GFP_KERNEL);
 616         if (!buf)
 617                 return -ENOMEM;
 618
 619         ret = copy_from_user(buf, ubuf, count);
 620         if (ret) {
 621                 ret = -EFAULT;
 622                 goto free_buf;
 623         }
 624
 625         ret = send_buf(port, buf, count, nonblock);
 626
 627         if (nonblock && ret > 0)
 628                 goto out;
 629
 630 free_buf:
 631         kfree(buf);
 632 out:
 633         return ret;
 634 }
 635
 636 static unsigned int port_fops_poll(struct file *filp, poll_table *wait)
 637 {
 638         struct port *port;
 639         unsigned int ret;
 640
 641         port = filp->private_data;
 642         poll_wait(filp, &port->waitqueue, wait);
 643
 644         ret = 0;
 645         if (port->inbuf)
 646                 ret |= POLLIN | POLLRDNORM;
 647         if (!will_write_block(port))
 648                 ret |= POLLOUT;
 649         if (!port->host_connected)
 650                 ret |= POLLHUP;
 651
 652         return ret;
 653 }
 654
 655 static int port_fops_release(struct inode *inode, struct file *filp)
 656 {
 657         struct port *port;
 658
 659         port = filp->private_data;
 660
 661         /* Notify host of port being closed */
 662         send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 0);
 663
 664         spin_lock_irq(&port->inbuf_lock);
 665         port->guest_connected = false;
 666
 667         discard_port_data(port);
 668
 669         spin_unlock_irq(&port->inbuf_lock);
 670
 671         spin_lock_irq(&port->outvq_lock);
 672         reclaim_consumed_buffers(port);
 673         spin_unlock_irq(&port->outvq_lock);
 674
 675         return 0;
 676 }
 677
 678 static int port_fops_open(struct inode *inode, struct file *filp)
 679 {
 680         struct cdev *cdev = inode->i_cdev;
 681         struct port *port;
 682
 683         port = container_of(cdev, struct port, cdev);
 684         filp->private_data = port;
 685
 686         /*
 687          * Don't allow opening of console port devices -- that's done
 688          * via /dev/hvc
 689          */
 690         if (is_console_port(port))
 691                 return -ENXIO;
 692
 693         /* Allow only one process to open a particular port at a time */
 694         spin_lock_irq(&port->inbuf_lock);
 695         if (port->guest_connected) {
 696                 spin_unlock_irq(&port->inbuf_lock);
 697                 return -EMFILE;
 698         }
 699
 700         port->guest_connected = true;
 701         spin_unlock_irq(&port->inbuf_lock);
 702
 703         spin_lock_irq(&port->outvq_lock);
 704         /*
 705          * There might be a chance that we missed reclaiming a few
 706          * buffers in the window of the port getting previously closed
 707          * and opening now.
 708          */
 709         reclaim_consumed_buffers(port);
 710         spin_unlock_irq(&port->outvq_lock);
 711
 712         /* Notify host of port being opened */
 713         send_control_msg(filp->private_data, VIRTIO_CONSOLE_PORT_OPEN, 1);
 714
 715         return 0;
 716 }
 717
 718 /*
 719  * The file operations that we support: programs in the guest can open
 720  * a console device, read from it, write to it, poll for data and
 721  * close it.  The devices are at
 722  *   /dev/vport<device number>p<port number>
 723  */
 724 static const struct file_operations port_fops = {
 725         .owner = THIS_MODULE,
 726         .open  = port_fops_open,
 727         .read  = port_fops_read,
 728         .write = port_fops_write,
 729         .poll  = port_fops_poll,
 730         .release = port_fops_release,
 731 };
 732
 733 /*
 734  * The put_chars() callback is pretty straightforward.
 735  *
 736  * We turn the characters into a scatter-gather list, add it to the
 737  * output queue and then kick the Host.  Then we sit here waiting for
 738  * it to finish: inefficient in theory, but in practice
 739  * implementations will do it immediately (lguest's Launcher does).
 740  */
 741 static int put_chars(u32 vtermno, const char *buf, int count)
 742 {
 743         struct port *port;
 744
 745         if (unlikely(early_put_chars))
 746                 return early_put_chars(vtermno, buf, count);
 747
 748         port = find_port_by_vtermno(vtermno);
 749         if (!port)
 750                 return -EPIPE;
 751
 752         return send_buf(port, (void *)buf, count, false);
 753 }
 754
 755 /*
 756  * get_chars() is the callback from the hvc_console infrastructure
 757  * when an interrupt is received.
 758  *
 759  * We call out to fill_readbuf that gets us the required data from the
 760  * buffers that are queued up.
 761  */
 762 static int get_chars(u32 vtermno, char *buf, int count)
 763 {
 764         struct port *port;
 765
 766         /* If we've not set up the port yet, we have no input to give. */
 767         if (unlikely(early_put_chars))
 768                 return 0;
 769
 770         port = find_port_by_vtermno(vtermno);
 771         if (!port)
 772                 return -EPIPE;
 773
 774         /* If we don't have an input queue yet, we can't get input. */
 775         BUG_ON(!port->in_vq);
 776
 777         return fill_readbuf(port, buf, count, false);
 778 }
 779
 780 static void resize_console(struct port *port)
 781 {
 782         struct virtio_device *vdev;
 783
 784         /* The port could have been hot-unplugged */
 785         if (!port || !is_console_port(port))
 786                 return;
 787
 788         vdev = port->portdev->vdev;
 789         if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE))
 790                 hvc_resize(port->cons.hvc, port->cons.ws);
 791 }
 792
 793 /* We set the configuration at this point, since we now have a tty */
 794 static int notifier_add_vio(struct hvc_struct *hp, int data)
 795 {
 796         struct port *port;
 797
 798         port = find_port_by_vtermno(hp->vtermno);
 799         if (!port)
 800                 return -EINVAL;
 801
 802         hp->irq_requested = 1;
 803         resize_console(port);
 804
 805         return 0;
 806 }
 807
 808 static void notifier_del_vio(struct hvc_struct *hp, int data)
 809 {
 810         hp->irq_requested = 0;
 811 }
 812
 813 /* The operations for console ports. */
 814 static const struct hv_ops hv_ops = {
 815         .get_chars = get_chars,
 816         .put_chars = put_chars,
 817         .notifier_add = notifier_add_vio,
 818         .notifier_del = notifier_del_vio,
 819         .notifier_hangup = notifier_del_vio,
 820 };
 821
 822 /*
 823  * Console drivers are initialized very early so boot messages can go
 824  * out, so we do things slightly differently from the generic virtio
 825  * initialization of the net and block drivers.
 826  *
 827  * At this stage, the console is output-only.  It's too early to set
 828  * up a virtqueue, so we let the drivers do some boutique early-output
 829  * thing.
 830  */
 831 int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
 832 {
 833         early_put_chars = put_chars;
 834         return hvc_instantiate(0, 0, &hv_ops);
 835 }
 836
 837 int init_port_console(struct port *port)
 838 {
 839         int ret;
 840
 841         /*
 842          * The Host's telling us this port is a console port.  Hook it
 843          * up with an hvc console.
 844          *
 845          * To set up and manage our virtual console, we call
 846          * hvc_alloc().
 847          *
 848          * The first argument of hvc_alloc() is the virtual console
 849          * number.  The second argument is the parameter for the
 850          * notification mechanism (like irq number).  We currently
 851          * leave this as zero, virtqueues have implicit notifications.
 852          *
 853          * The third argument is a "struct hv_ops" containing the
 854          * put_chars() get_chars(), notifier_add() and notifier_del()
 855          * pointers.  The final argument is the output buffer size: we
 856          * can do any size, so we put PAGE_SIZE here.
 857          */
 858         port->cons.vtermno = pdrvdata.next_vtermno;
 859
 860         port->cons.hvc = hvc_alloc(port->cons.vtermno, 0, &hv_ops, PAGE_SIZE);
 861         if (IS_ERR(port->cons.hvc)) {
 862                 ret = PTR_ERR(port->cons.hvc);
 863                 dev_err(port->dev,
 864                         "error %d allocating hvc for port\n", ret);
 865                 port->cons.hvc = NULL;
 866                 return ret;
 867         }
 868         spin_lock_irq(&pdrvdata_lock);
 869         pdrvdata.next_vtermno++;
 870         list_add_tail(&port->cons.list, &pdrvdata.consoles);
 871         spin_unlock_irq(&pdrvdata_lock);
 872         port->guest_connected = true;
 873
 874         /*
 875          * Start using the new console output if this is the first
 876          * console to come up.
 877          */
 878         if (early_put_chars)
 879                 early_put_chars = NULL;
 880
 881         /* Notify host of port being opened */
 882         send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 1);
 883
 884         return 0;
 885 }
 886
 887 static ssize_t show_port_name(struct device *dev,
 888                               struct device_attribute *attr, char *buffer)
 889 {
 890         struct port *port;
 891
 892         port = dev_get_drvdata(dev);
 893
 894         return sprintf(buffer, "%s\n", port->name);
 895 }
 896
 897 static DEVICE_ATTR(name, S_IRUGO, show_port_name, NULL);
 898
 899 static struct attribute *port_sysfs_entries[] = {
 900         &dev_attr_name.attr,
 901         NULL
 902 };
 903
 904 static struct attribute_group port_attribute_group = {
 905         .name = NULL,           /* put in device directory */
 906         .attrs = port_sysfs_entries,
 907 };
 908
 909 static int debugfs_open(struct inode *inode, struct file *filp)
 910 {
 911         filp->private_data = inode->i_private;
 912         return 0;
 913 }
 914
 915 static ssize_t debugfs_read(struct file *filp, char __user *ubuf,
 916                             size_t count, loff_t *offp)
 917 {
 918         struct port *port;
 919         char *buf;
 920         ssize_t ret, out_offset, out_count;
 921
 922         out_count = 1024;
 923         buf = kmalloc(out_count, GFP_KERNEL);
 924         if (!buf)
 925                 return -ENOMEM;
 926
 927         port = filp->private_data;
 928         out_offset = 0;
 929         out_offset += snprintf(buf + out_offset, out_count,
 930                                "name: %s\n", port->name ? port->name : "");
 931         out_offset += snprintf(buf + out_offset, out_count - out_offset,
 932                                "guest_connected: %d\n", port->guest_connected);
 933         out_offset += snprintf(buf + out_offset, out_count - out_offset,
 934                                "host_connected: %d\n", port->host_connected);
 935         out_offset += snprintf(buf + out_offset, out_count - out_offset,
 936                                "outvq_full: %d\n", port->outvq_full);
 937         out_offset += snprintf(buf + out_offset, out_count - out_offset,
 938                                "is_console: %s\n",
 939                                is_console_port(port) ? "yes" : "no");
 940         out_offset += snprintf(buf + out_offset, out_count - out_offset,
 941                                "console_vtermno: %u\n", port->cons.vtermno);
 942
 943         ret = simple_read_from_buffer(ubuf, count, offp, buf, out_offset);
 944         kfree(buf);
 945         return ret;
 946 }
 947
 948 static const struct file_operations port_debugfs_ops = {
 949         .owner = THIS_MODULE,
 950         .open  = debugfs_open,
 951         .read  = debugfs_read,
 952 };
 953
 954 static void set_console_size(struct port *port, u16 rows, u16 cols)
 955 {
 956         if (!port || !is_console_port(port))
 957                 return;
 958
 959         port->cons.ws.ws_row = rows;
 960         port->cons.ws.ws_col = cols;
 961 }
 962
 963 static unsigned int fill_queue(struct virtqueue *vq, spinlock_t *lock)
 964 {
 965         struct port_buffer *buf;
 966         unsigned int nr_added_bufs;
 967         int ret;
 968
 969         nr_added_bufs = 0;
 970         do {
 971                 buf = alloc_buf(PAGE_SIZE);
 972                 if (!buf)
 973                         break;
 974
 975                 spin_lock_irq(lock);
 976                 ret = add_inbuf(vq, buf);
 977                 if (ret < 0) {
 978                         spin_unlock_irq(lock);
 979                         free_buf(buf);
 980                         break;
 981                 }
 982                 nr_added_bufs++;
 983                 spin_unlock_irq(lock);
 984         } while (ret > 0);
 985
 986         return nr_added_bufs;
 987 }
 988
 989 static int add_port(struct ports_device *portdev, u32 id)
 990 {
 991         char debugfs_name[16];
 992         struct port *port;
 993         struct port_buffer *buf;
 994         dev_t devt;
 995         unsigned int nr_added_bufs;
 996         int err;
 997
 998         port = kmalloc(sizeof(*port), GFP_KERNEL);
 999         if (!port) {
1000                 err = -ENOMEM;
1001                 goto fail;
1002         }
1003
1004         port->portdev = portdev;
1005         port->id = id;
1006
1007         port->name = NULL;
1008         port->inbuf = NULL;
1009         port->cons.hvc = NULL;
1010
1011         port->cons.ws.ws_row = port->cons.ws.ws_col = 0;
1012
1013         port->host_connected = port->guest_connected = false;
1014
1015         port->outvq_full = false;
1016
1017         port->in_vq = portdev->in_vqs[port->id];
1018         port->out_vq = portdev->out_vqs[port->id];
1019
1020         cdev_init(&port->cdev, &port_fops);
1021
1022         devt = MKDEV(portdev->chr_major, id);
1023         err = cdev_add(&port->cdev, devt, 1);
1024         if (err < 0) {
1025                 dev_err(&port->portdev->vdev->dev,
1026                         "Error %d adding cdev for port %u\n", err, id);
1027                 goto free_port;
1028         }
1029         port->dev = device_create(pdrvdata.class, &port->portdev->vdev->dev,
1030                                   devt, port, "vport%up%u",
1031                                   port->portdev->drv_index, id);
1032         if (IS_ERR(port->dev)) {
1033                 err = PTR_ERR(port->dev);
1034                 dev_err(&port->portdev->vdev->dev,
1035                         "Error %d creating device for port %u\n",
1036                         err, id);
1037                 goto free_cdev;
1038         }
1039
1040         spin_lock_init(&port->inbuf_lock);
1041         spin_lock_init(&port->outvq_lock);
1042         init_waitqueue_head(&port->waitqueue);
1043
1044         /* Fill the in_vq with buffers so the host can send us data. */
1045         nr_added_bufs = fill_queue(port->in_vq, &port->inbuf_lock);
1046         if (!nr_added_bufs) {
1047                 dev_err(port->dev, "Error allocating inbufs\n");
1048                 err = -ENOMEM;
1049                 goto free_device;
1050         }
1051
1052         /*
1053          * If we're not using multiport support, this has to be a console port
1054          */
1055         if (!use_multiport(port->portdev)) {
1056                 err = init_port_console(port);
1057                 if (err)
1058                         goto free_inbufs;
1059         }
1060
1061         spin_lock_irq(&portdev->ports_lock);
1062         list_add_tail(&port->list, &port->portdev->ports);
1063         spin_unlock_irq(&portdev->ports_lock);
1064
1065         /*
1066          * Tell the Host we're set so that it can send us various
1067          * configuration parameters for this port (eg, port name,
1068          * caching, whether this is a console port, etc.)
1069          */
1070         send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1071
1072         if (pdrvdata.debugfs_dir) {
1073                 /*
1074                  * Finally, create the debugfs file that we can use to
1075                  * inspect a port's state at any time
1076                  */
1077                 sprintf(debugfs_name, "vport%up%u",
1078                         port->portdev->drv_index, id);
1079                 port->debugfs_file = debugfs_create_file(debugfs_name, 0444,
1080                                                          pdrvdata.debugfs_dir,
1081                                                          port,
1082                                                          &port_debugfs_ops);
1083         }
1084         return 0;
1085
1086 free_inbufs:
1087         while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
1088                 free_buf(buf);
1089 free_device:
1090         device_destroy(pdrvdata.class, port->dev->devt);
1091 free_cdev:
1092         cdev_del(&port->cdev);
1093 free_port:
1094         kfree(port);
1095 fail:
1096         /* The host might want to notify management sw about port add failure */
1097         __send_control_msg(portdev, id, VIRTIO_CONSOLE_PORT_READY, 0);
1098         return err;
1099 }
1100
1101 /* Remove all port-specific data. */
1102 static int remove_port(struct port *port)
1103 {
1104         struct port_buffer *buf;
1105
1106         if (port->guest_connected) {
1107                 port->guest_connected = false;
1108                 port->host_connected = false;
1109                 wake_up_interruptible(&port->waitqueue);
1110                 send_control_msg(port, VIRTIO_CONSOLE_PORT_OPEN, 0);
1111         }
1112
1113         spin_lock_irq(&port->portdev->ports_lock);
1114         list_del(&port->list);
1115         spin_unlock_irq(&port->portdev->ports_lock);
1116
1117         if (is_console_port(port)) {
1118                 spin_lock_irq(&pdrvdata_lock);
1119                 list_del(&port->cons.list);
1120                 spin_unlock_irq(&pdrvdata_lock);
1121 #if 0
1122                 /*
1123                  * hvc_remove() not called as removing one hvc port
1124                  * results in other hvc ports getting frozen.
1125                  *
1126                  * Once this is resolved in hvc, this functionality
1127                  * will be enabled.  Till that is done, the -EPIPE
1128                  * return from get_chars() above will help
1129                  * hvc_console.c to clean up on ports we remove here.
1130                  */
1131                 hvc_remove(port->cons.hvc);
1132 #endif
1133         }
1134         sysfs_remove_group(&port->dev->kobj, &port_attribute_group);
1135         device_destroy(pdrvdata.class, port->dev->devt);
1136         cdev_del(&port->cdev);
1137
1138         /* Remove unused data this port might have received. */
1139         discard_port_data(port);
1140
1141         reclaim_consumed_buffers(port);
1142
1143         /* Remove buffers we queued up for the Host to send us data in. */
1144         while ((buf = virtqueue_detach_unused_buf(port->in_vq)))
1145                 free_buf(buf);
1146
1147         kfree(port->name);
1148
1149         debugfs_remove(port->debugfs_file);
1150
1151         kfree(port);
1152         return 0;
1153 }
1154
1155 /* Any private messages that the Host and Guest want to share */
1156 static void handle_control_message(struct ports_device *portdev,
1157                                    struct port_buffer *buf)
1158 {
1159         struct virtio_console_control *cpkt;
1160         struct port *port;
1161         size_t name_size;
1162         int err;
1163
1164         cpkt = (struct virtio_console_control *)(buf->buf + buf->offset);
1165
1166         port = find_port_by_id(portdev, cpkt->id);
1167         if (!port && cpkt->event != VIRTIO_CONSOLE_PORT_ADD) {
1168                 /* No valid header at start of buffer.  Drop it. */
1169                 dev_dbg(&portdev->vdev->dev,
1170                         "Invalid index %u in control packet\n", cpkt->id);
1171                 return;
1172         }
1173
1174         switch (cpkt->event) {
1175         case VIRTIO_CONSOLE_PORT_ADD:
1176                 if (port) {
1177                         dev_dbg(&portdev->vdev->dev,
1178                                 "Port %u already added\n", port->id);
1179                         send_control_msg(port, VIRTIO_CONSOLE_PORT_READY, 1);
1180                         break;
1181                 }
1182                 if (cpkt->id >= portdev->config.max_nr_ports) {
1183                         dev_warn(&portdev->vdev->dev,
1184                                 "Request for adding port with out-of-bound id %u, max. supported id: %u\n",
1185                                 cpkt->id, portdev->config.max_nr_ports - 1);
1186                         break;
1187                 }
1188                 add_port(portdev, cpkt->id);
1189                 break;
1190         case VIRTIO_CONSOLE_PORT_REMOVE:
1191                 remove_port(port);
1192                 break;
1193         case VIRTIO_CONSOLE_CONSOLE_PORT:
1194                 if (!cpkt->value)
1195                         break;
1196                 if (is_console_port(port))
1197                         break;
1198
1199                 init_port_console(port);
1200                 /*
1201                  * Could remove the port here in case init fails - but
1202                  * have to notify the host first.
1203                  */
1204                 break;
1205         case VIRTIO_CONSOLE_RESIZE: {
1206                 struct {
1207                         __u16 rows;
1208                         __u16 cols;
1209                 } size;
1210
1211                 if (!is_console_port(port))
1212                         break;
1213
1214                 memcpy(&size, buf->buf + buf->offset + sizeof(*cpkt),
1215                        sizeof(size));
1216                 set_console_size(port, size.rows, size.cols);
1217
1218                 port->cons.hvc->irq_requested = 1;
1219                 resize_console(port);
1220                 break;
1221         }
1222         case VIRTIO_CONSOLE_PORT_OPEN:
1223                 port->host_connected = cpkt->value;
1224                 wake_up_interruptible(&port->waitqueue);
1225                 /*
1226                  * If the host port got closed and the host had any
1227                  * unconsumed buffers, we'll be able to reclaim them
1228                  * now.
1229                  */
1230                 spin_lock_irq(&port->outvq_lock);
1231                 reclaim_consumed_buffers(port);
1232                 spin_unlock_irq(&port->outvq_lock);
1233                 break;
1234         case VIRTIO_CONSOLE_PORT_NAME:
1235                 /*
1236                  * Skip the size of the header and the cpkt to get the size
1237                  * of the name that was sent
1238                  */
1239                 name_size = buf->len - buf->offset - sizeof(*cpkt) + 1;
1240
1241                 port->name = kmalloc(name_size, GFP_KERNEL);
1242                 if (!port->name) {
1243                         dev_err(port->dev,
1244                                 "Not enough space to store port name\n");
1245                         break;
1246                 }
1247                 strncpy(port->name, buf->buf + buf->offset + sizeof(*cpkt),
1248                         name_size - 1);
1249                 port->name[name_size - 1] = 0;
1250
1251                 /*
1252                  * Since we only have one sysfs attribute, 'name',
1253                  * create it only if we have a name for the port.
1254                  */
1255                 err = sysfs_create_group(&port->dev->kobj,
1256                                          &port_attribute_group);
1257                 if (err) {
1258                         dev_err(port->dev,
1259                                 "Error %d creating sysfs device attributes\n",
1260                                 err);
1261                 } else {
1262                         /*
1263                          * Generate a udev event so that appropriate
1264                          * symlinks can be created based on udev
1265                          * rules.
1266                          */
1267                         kobject_uevent(&port->dev->kobj, KOBJ_CHANGE);
1268                 }
1269                 break;
1270         }
1271 }
1272
1273 static void control_work_handler(struct work_struct *work)
1274 {
1275         struct ports_device *portdev;
1276         struct virtqueue *vq;
1277         struct port_buffer *buf;
1278         unsigned int len;
1279
1280         portdev = container_of(work, struct ports_device, control_work);
1281         vq = portdev->c_ivq;
1282
1283         spin_lock(&portdev->cvq_lock);
1284         while ((buf = virtqueue_get_buf(vq, &len))) {
1285                 spin_unlock(&portdev->cvq_lock);
1286
1287                 buf->len = len;
1288                 buf->offset = 0;
1289
1290                 handle_control_message(portdev, buf);
1291
1292                 spin_lock(&portdev->cvq_lock);
1293                 if (add_inbuf(portdev->c_ivq, buf) < 0) {
1294                         dev_warn(&portdev->vdev->dev,
1295                                  "Error adding buffer to queue\n");
1296                         free_buf(buf);
1297                 }
1298         }
1299         spin_unlock(&portdev->cvq_lock);
1300 }
1301
1302 static void in_intr(struct virtqueue *vq)
1303 {
1304         struct port *port;
1305         unsigned long flags;
1306
1307         port = find_port_by_vq(vq->vdev->priv, vq);
1308         if (!port)
1309                 return;
1310
1311         spin_lock_irqsave(&port->inbuf_lock, flags);
1312         if (!port->inbuf)
1313                 port->inbuf = get_inbuf(port);
1314
1315         /*
1316          * Don't queue up data when port is closed.  This condition
1317          * can be reached when a console port is not yet connected (no
1318          * tty is spawned) and the host sends out data to console
1319          * ports.  For generic serial ports, the host won't
1320          * (shouldn't) send data till the guest is connected.
1321          */
1322         if (!port->guest_connected)
1323                 discard_port_data(port);
1324
1325         spin_unlock_irqrestore(&port->inbuf_lock, flags);
1326
1327         wake_up_interruptible(&port->waitqueue);
1328
1329         if (is_console_port(port) && hvc_poll(port->cons.hvc))
1330                 hvc_kick();
1331 }
1332
1333 static void control_intr(struct virtqueue *vq)
1334 {
1335         struct ports_device *portdev;
1336
1337         portdev = vq->vdev->priv;
1338         schedule_work(&portdev->control_work);
1339 }
1340
1341 static void config_intr(struct virtio_device *vdev)
1342 {
1343         struct ports_device *portdev;
1344
1345         portdev = vdev->priv;
1346
1347         if (!use_multiport(portdev)) {
1348                 struct port *port;
1349                 u16 rows, cols;
1350
1351                 vdev->config->get(vdev,
1352                                   offsetof(struct virtio_console_config, cols),
1353                                   &cols, sizeof(u16));
1354                 vdev->config->get(vdev,
1355                                   offsetof(struct virtio_console_config, rows),
1356                                   &rows, sizeof(u16));
1357
1358                 port = find_port_by_id(portdev, 0);
1359                 set_console_size(port, rows, cols);
1360
1361                 /*
1362                  * We'll use this way of resizing only for legacy
1363                  * support.  For newer userspace
1364                  * (VIRTIO_CONSOLE_F_MULTPORT+), use control messages
1365                  * to indicate console size changes so that it can be
1366                  * done per-port.
1367                  */
1368                 resize_console(port);
1369         }
1370 }
1371
1372 static int init_vqs(struct ports_device *portdev)
1373 {
1374         vq_callback_t **io_callbacks;
1375         char **io_names;
1376         struct virtqueue **vqs;
1377         u32 i, j, nr_ports, nr_queues;
1378         int err;
1379
1380         nr_ports = portdev->config.max_nr_ports;
1381         nr_queues = use_multiport(portdev) ? (nr_ports + 1) * 2 : 2;
1382
1383         vqs = kmalloc(nr_queues * sizeof(struct virtqueue *), GFP_KERNEL);
1384         if (!vqs) {
1385                 err = -ENOMEM;
1386                 goto fail;
1387         }
1388         io_callbacks = kmalloc(nr_queues * sizeof(vq_callback_t *), GFP_KERNEL);
1389         if (!io_callbacks) {
1390                 err = -ENOMEM;
1391                 goto free_vqs;
1392         }
1393         io_names = kmalloc(nr_queues * sizeof(char *), GFP_KERNEL);
1394         if (!io_names) {
1395                 err = -ENOMEM;
1396                 goto free_callbacks;
1397         }
1398         portdev->in_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1399                                   GFP_KERNEL);
1400         if (!portdev->in_vqs) {
1401                 err = -ENOMEM;
1402                 goto free_names;
1403         }
1404         portdev->out_vqs = kmalloc(nr_ports * sizeof(struct virtqueue *),
1405                                    GFP_KERNEL);
1406         if (!portdev->out_vqs) {
1407                 err = -ENOMEM;
1408                 goto free_invqs;
1409         }
1410
1411         /*
1412          * For backward compat (newer host but older guest), the host
1413          * spawns a console port first and also inits the vqs for port
1414          * 0 before others.
1415          */
1416         j = 0;
1417         io_callbacks[j] = in_intr;
1418         io_callbacks[j + 1] = NULL;
1419         io_names[j] = "input";
1420         io_names[j + 1] = "output";
1421         j += 2;
1422
1423         if (use_multiport(portdev)) {
1424                 io_callbacks[j] = control_intr;
1425                 io_callbacks[j + 1] = NULL;
1426                 io_names[j] = "control-i";
1427                 io_names[j + 1] = "control-o";
1428
1429                 for (i = 1; i < nr_ports; i++) {
1430                         j += 2;
1431                         io_callbacks[j] = in_intr;
1432                         io_callbacks[j + 1] = NULL;
1433                         io_names[j] = "input";
1434                         io_names[j + 1] = "output";
1435                 }
1436         }
1437         /* Find the queues. */
1438         err = portdev->vdev->config->find_vqs(portdev->vdev, nr_queues, vqs,
1439                                               io_callbacks,
1440                                               (const char **)io_names);
1441         if (err)
1442                 goto free_outvqs;
1443
1444         j = 0;
1445         portdev->in_vqs[0] = vqs[0];
1446         portdev->out_vqs[0] = vqs[1];
1447         j += 2;
1448         if (use_multiport(portdev)) {
1449                 portdev->c_ivq = vqs[j];
1450                 portdev->c_ovq = vqs[j + 1];
1451
1452                 for (i = 1; i < nr_ports; i++) {
1453                         j += 2;
1454                         portdev->in_vqs[i] = vqs[j];
1455                         portdev->out_vqs[i] = vqs[j + 1];
1456                 }
1457         }
1458         kfree(io_callbacks);
1459         kfree(io_names);
1460         kfree(vqs);
1461
1462         return 0;
1463
1464 free_names:
1465         kfree(io_names);
1466 free_callbacks:
1467         kfree(io_callbacks);
1468 free_outvqs:
1469         kfree(portdev->out_vqs);
1470 free_invqs:
1471         kfree(portdev->in_vqs);
1472 free_vqs:
1473         kfree(vqs);
1474 fail:
1475         return err;
1476 }
1477
1478 static const struct file_operations portdev_fops = {
1479         .owner = THIS_MODULE,
1480 };
1481
1482 /*
1483  * Once we're further in boot, we get probed like any other virtio
1484  * device.
1485  *
1486  * If the host also supports multiple console ports, we check the
1487  * config space to see how many ports the host has spawned.  We
1488  * initialize each port found.
1489  */
1490 static int __devinit virtcons_probe(struct virtio_device *vdev)
1491 {
1492         struct ports_device *portdev;
1493         int err;
1494         bool multiport;
1495
1496         portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
1497         if (!portdev) {
1498                 err = -ENOMEM;
1499                 goto fail;
1500         }
1501
1502         /* Attach this portdev to this virtio_device, and vice-versa. */
1503         portdev->vdev = vdev;
1504         vdev->priv = portdev;
1505
1506         spin_lock_irq(&pdrvdata_lock);
1507         portdev->drv_index = pdrvdata.index++;
1508         spin_unlock_irq(&pdrvdata_lock);
1509
1510         portdev->chr_major = register_chrdev(0, "virtio-portsdev",
1511                                              &portdev_fops);
1512         if (portdev->chr_major < 0) {
1513                 dev_err(&vdev->dev,
1514                         "Error %d registering chrdev for device %u\n",
1515                         portdev->chr_major, portdev->drv_index);
1516                 err = portdev->chr_major;
1517                 goto free;
1518         }
1519
1520         multiport = false;
1521         portdev->config.max_nr_ports = 1;
1522         if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_MULTIPORT)) {
1523                 multiport = true;
1524                 vdev->features[0] |= 1 << VIRTIO_CONSOLE_F_MULTIPORT;
1525
1526                 vdev->config->get(vdev, offsetof(struct virtio_console_config,
1527                                                  max_nr_ports),
1528                                   &portdev->config.max_nr_ports,
1529                                   sizeof(portdev->config.max_nr_ports));
1530         }
1531
1532         /* Let the Host know we support multiple ports.*/
1533         vdev->config->finalize_features(vdev);
1534
1535         err = init_vqs(portdev);
1536         if (err < 0) {
1537                 dev_err(&vdev->dev, "Error %d initializing vqs\n", err);
1538                 goto free_chrdev;
1539         }
1540
1541         spin_lock_init(&portdev->ports_lock);
1542         INIT_LIST_HEAD(&portdev->ports);
1543
1544         if (multiport) {
1545                 unsigned int nr_added_bufs;
1546
1547                 spin_lock_init(&portdev->cvq_lock);
1548                 INIT_WORK(&portdev->control_work, &control_work_handler);
1549
1550                 nr_added_bufs = fill_queue(portdev->c_ivq, &portdev->cvq_lock);
1551                 if (!nr_added_bufs) {
1552                         dev_err(&vdev->dev,
1553                                 "Error allocating buffers for control queue\n");
1554                         err = -ENOMEM;
1555                         goto free_vqs;
1556                 }
1557         } else {
1558                 /*
1559                  * For backward compatibility: Create a console port
1560                  * if we're running on older host.
1561                  */
1562                 add_port(portdev, 0);
1563         }
1564
1565         __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1566                            VIRTIO_CONSOLE_DEVICE_READY, 1);
1567         return 0;
1568
1569 free_vqs:
1570         /* The host might want to notify mgmt sw about device add failure */
1571         __send_control_msg(portdev, VIRTIO_CONSOLE_BAD_ID,
1572                            VIRTIO_CONSOLE_DEVICE_READY, 0);
1573         vdev->config->del_vqs(vdev);
1574         kfree(portdev->in_vqs);
1575         kfree(portdev->out_vqs);
1576 free_chrdev:
1577         unregister_chrdev(portdev->chr_major, "virtio-portsdev");
1578 free:
1579         kfree(portdev);
1580 fail:
1581         return err;
1582 }
1583
1584 static void virtcons_remove(struct virtio_device *vdev)
1585 {
1586         struct ports_device *portdev;
1587         struct port *port, *port2;
1588         struct port_buffer *buf;
1589         unsigned int len;
1590
1591         portdev = vdev->priv;
1592
1593         cancel_work_sync(&portdev->control_work);
1594
1595         list_for_each_entry_safe(port, port2, &portdev->ports, list)
1596                 remove_port(port);
1597
1598         unregister_chrdev(portdev->chr_major, "virtio-portsdev");
1599
1600         while ((buf = virtqueue_get_buf(portdev->c_ivq, &len)))
1601                 free_buf(buf);
1602
1603         while ((buf = virtqueue_detach_unused_buf(portdev->c_ivq)))
1604                 free_buf(buf);
1605
1606         vdev->config->del_vqs(vdev);
1607         kfree(portdev->in_vqs);
1608         kfree(portdev->out_vqs);
1609
1610         kfree(portdev);
1611 }
1612
1613 static struct virtio_device_id id_table[] = {
1614         { VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
1615         { 0 },
1616 };
1617
1618 static unsigned int features[] = {
1619         VIRTIO_CONSOLE_F_SIZE,
1620         VIRTIO_CONSOLE_F_MULTIPORT,
1621 };
1622
1623 static struct virtio_driver virtio_console = {
1624         .feature_table = features,
1625         .feature_table_size = ARRAY_SIZE(features),
1626         .driver.name =  KBUILD_MODNAME,
1627         .driver.owner = THIS_MODULE,
1628         .id_table =     id_table,
1629         .probe =        virtcons_probe,
1630         .remove =       virtcons_remove,
1631         .config_changed = config_intr,
1632 };
1633
1634 static int __init init(void)
1635 {
1636         int err;
1637
1638         pdrvdata.class = class_create(THIS_MODULE, "virtio-ports");
1639         if (IS_ERR(pdrvdata.class)) {
1640                 err = PTR_ERR(pdrvdata.class);
1641                 pr_err("Error %d creating virtio-ports class\n", err);
1642                 return err;
1643         }
1644
1645         pdrvdata.debugfs_dir = debugfs_create_dir("virtio-ports", NULL);
1646         if (!pdrvdata.debugfs_dir) {
1647                 pr_warning("Error %ld creating debugfs dir for virtio-ports\n",
1648                            PTR_ERR(pdrvdata.debugfs_dir));
1649         }
1650         INIT_LIST_HEAD(&pdrvdata.consoles);
1651
1652         return register_virtio_driver(&virtio_console);
1653 }
1654
1655 static void __exit fini(void)
1656 {
1657         unregister_virtio_driver(&virtio_console);
1658
1659         class_destroy(pdrvdata.class);
1660         if (pdrvdata.debugfs_dir)
1661                 debugfs_remove_recursive(pdrvdata.debugfs_dir);
1662 }
1663 module_init(init);
1664 module_exit(fini);
1665
1666 MODULE_DEVICE_TABLE(virtio, id_table);
1667 MODULE_DESCRIPTION("Virtio console driver");
1668 MODULE_LICENSE("GPL");