drivers/char/virtio_console.c

   1 /*
   2  * Copyright (C) 2006, 2007, 2009 Rusty Russell, IBM Corporation
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18 #include <linux/err.h>
  19 #include <linux/init.h>
  20 #include <linux/list.h>
  21 #include <linux/spinlock.h>
  22 #include <linux/virtio.h>
  23 #include <linux/virtio_console.h>
  24 #include "hvc_console.h"
  25
  26 /*
  27  * This is a global struct for storing common data for all the devices
  28  * this driver handles.
  29  *
  30  * Mainly, it has a linked list for all the consoles in one place so
  31  * that callbacks from hvc for get_chars(), put_chars() work properly
  32  * across multiple devices and multiple ports per device.
  33  */
  34 struct ports_driver_data {
  35         /*
  36          * This is used to keep track of the number of hvc consoles
  37          * spawned by this driver.  This number is given as the first
  38          * argument to hvc_alloc().  To correctly map an initial
  39          * console spawned via hvc_instantiate to the console being
  40          * hooked up via hvc_alloc, we need to pass the same vtermno.
  41          *
  42          * We also just assume the first console being initialised was
  43          * the first one that got used as the initial console.
  44          */
  45         unsigned int next_vtermno;
  46
  47         /* All the console devices handled by this driver */
  48         struct list_head consoles;
  49 };
  50 static struct ports_driver_data pdrvdata;
  51
  52 DEFINE_SPINLOCK(pdrvdata_lock);
  53
  54 /* This struct holds information that's relevant only for console ports */
  55 struct console {
  56         /* We'll place all consoles in a list in the pdrvdata struct */
  57         struct list_head list;
  58
  59         /* The hvc device associated with this console port */
  60         struct hvc_struct *hvc;
  61
  62         /*
  63          * This number identifies the number that we used to register
  64          * with hvc in hvc_instantiate() and hvc_alloc(); this is the
  65          * number passed on by the hvc callbacks to us to
  66          * differentiate between the other console ports handled by
  67          * this driver
  68          */
  69         u32 vtermno;
  70 };
  71
  72 /*
  73  * This is a per-device struct that stores data common to all the
  74  * ports for that device (vdev->priv).
  75  */
  76 struct ports_device {
  77         struct virtqueue *in_vq, *out_vq;
  78         struct virtio_device *vdev;
  79 };
  80
  81 struct port_buffer {
  82         char *buf;
  83
  84         /* size of the buffer in *buf above */
  85         size_t size;
  86
  87         /* used length of the buffer */
  88         size_t len;
  89         /* offset in the buf from which to consume data */
  90         size_t offset;
  91 };
  92
  93 /* This struct holds the per-port data */
  94 struct port {
  95         /* Pointer to the parent virtio_console device */
  96         struct ports_device *portdev;
  97
  98         /* The current buffer from which data has to be fed to readers */
  99         struct port_buffer *inbuf;
 100
 101         /* The IO vqs for this port */
 102         struct virtqueue *in_vq, *out_vq;
 103
 104         /*
 105          * The entries in this struct will be valid if this port is
 106          * hooked up to an hvc console
 107          */
 108         struct console cons;
 109 };
 110
 111 /* This is the very early arch-specified put chars function. */
 112 static int (*early_put_chars)(u32, const char *, int);
 113
 114 static struct port *find_port_by_vtermno(u32 vtermno)
 115 {
 116         struct port *port;
 117         struct console *cons;
 118         unsigned long flags;
 119
 120         spin_lock_irqsave(&pdrvdata_lock, flags);
 121         list_for_each_entry(cons, &pdrvdata.consoles, list) {
 122                 if (cons->vtermno == vtermno) {
 123                         port = container_of(cons, struct port, cons);
 124                         goto out;
 125                 }
 126         }
 127         port = NULL;
 128 out:
 129         spin_unlock_irqrestore(&pdrvdata_lock, flags);
 130         return port;
 131 }
 132
 133 static void free_buf(struct port_buffer *buf)
 134 {
 135         kfree(buf->buf);
 136         kfree(buf);
 137 }
 138
 139 static struct port_buffer *alloc_buf(size_t buf_size)
 140 {
 141         struct port_buffer *buf;
 142
 143         buf = kmalloc(sizeof(*buf), GFP_KERNEL);
 144         if (!buf)
 145                 goto fail;
 146         buf->buf = kzalloc(buf_size, GFP_KERNEL);
 147         if (!buf->buf)
 148                 goto free_buf;
 149         buf->len = 0;
 150         buf->offset = 0;
 151         buf->size = buf_size;
 152         return buf;
 153
 154 free_buf:
 155         kfree(buf);
 156 fail:
 157         return NULL;
 158 }
 159
 160 /* Callers should take appropriate locks */
 161 static void *get_inbuf(struct port *port)
 162 {
 163         struct port_buffer *buf;
 164         struct virtqueue *vq;
 165         unsigned int len;
 166
 167         vq = port->in_vq;
 168         buf = vq->vq_ops->get_buf(vq, &len);
 169         if (buf) {
 170                 buf->len = len;
 171                 buf->offset = 0;
 172         }
 173         return buf;
 174 }
 175
 176 /*
 177  * Create a scatter-gather list representing our input buffer and put
 178  * it in the queue.
 179  *
 180  * Callers should take appropriate locks.
 181  */
 182 static void add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
 183 {
 184         struct scatterlist sg[1];
 185
 186         sg_init_one(sg, buf->buf, buf->size);
 187
 188         if (vq->vq_ops->add_buf(vq, sg, 0, 1, buf) < 0)
 189                 BUG();
 190         vq->vq_ops->kick(vq);
 191 }
 192
 193 /*
 194  * The put_chars() callback is pretty straightforward.
 195  *
 196  * We turn the characters into a scatter-gather list, add it to the
 197  * output queue and then kick the Host.  Then we sit here waiting for
 198  * it to finish: inefficient in theory, but in practice
 199  * implementations will do it immediately (lguest's Launcher does).
 200  */
 201 static int put_chars(u32 vtermno, const char *buf, int count)
 202 {
 203         struct scatterlist sg[1];
 204         struct port *port;
 205         struct virtqueue *out_vq;
 206         unsigned int len;
 207
 208         port = find_port_by_vtermno(vtermno);
 209         if (!port)
 210                 return 0;
 211
 212         if (unlikely(early_put_chars))
 213                 return early_put_chars(vtermno, buf, count);
 214
 215         out_vq = port->out_vq;
 216         /* This is a convenient routine to initialize a single-elem sg list */
 217         sg_init_one(sg, buf, count);
 218
 219         /* This shouldn't fail: if it does, we lose chars. */
 220         if (out_vq->vq_ops->add_buf(out_vq, sg, 1, 0, port) >= 0) {
 221                 /* Tell Host to go! */
 222                 out_vq->vq_ops->kick(out_vq);
 223                 while (!out_vq->vq_ops->get_buf(out_vq, &len))
 224                         cpu_relax();
 225         }
 226
 227         /* We're expected to return the amount of data we wrote: all of it. */
 228         return count;
 229 }
 230
 231 /*
 232  * get_chars() is the callback from the hvc_console infrastructure
 233  * when an interrupt is received.
 234  *
 235  * Most of the code deals with the fact that the hvc_console()
 236  * infrastructure only asks us for 16 bytes at a time.  We keep
 237  * in_offset and in_used fields for partially-filled buffers.
 238  */
 239 static int get_chars(u32 vtermno, char *buf, int count)
 240 {
 241         struct port *port;
 242
 243         port = find_port_by_vtermno(vtermno);
 244         if (!port)
 245                 return 0;
 246
 247         /* If we don't have an input queue yet, we can't get input. */
 248         BUG_ON(!port->in_vq);
 249
 250         /* No more in buffer?  See if they've (re)used it. */
 251         if (port->inbuf->offset == port->inbuf->len) {
 252                 if (!get_inbuf(port))
 253                         return 0;
 254         }
 255
 256         /* You want more than we have to give?  Well, try wanting less! */
 257         if (port->inbuf->offset + count > port->inbuf->len)
 258                 count = port->inbuf->len - port->inbuf->offset;
 259
 260         /* Copy across to their buffer and increment offset. */
 261         memcpy(buf, port->inbuf->buf + port->inbuf->offset, count);
 262         port->inbuf->offset += count;
 263
 264         /* Finished?  Re-register buffer so Host will use it again. */
 265         if (port->inbuf->offset == port->inbuf->len)
 266                 add_inbuf(port->in_vq, port->inbuf);
 267
 268         return count;
 269 }
 270
 271 static void resize_console(struct port *port)
 272 {
 273         struct virtio_device *vdev;
 274         struct winsize ws;
 275
 276         vdev = port->portdev->vdev;
 277         if (virtio_has_feature(vdev, VIRTIO_CONSOLE_F_SIZE)) {
 278                 vdev->config->get(vdev,
 279                                   offsetof(struct virtio_console_config, cols),
 280                                   &ws.ws_col, sizeof(u16));
 281                 vdev->config->get(vdev,
 282                                   offsetof(struct virtio_console_config, rows),
 283                                   &ws.ws_row, sizeof(u16));
 284                 hvc_resize(port->cons.hvc, ws);
 285         }
 286 }
 287
 288 static void virtcons_apply_config(struct virtio_device *vdev)
 289 {
 290         resize_console(find_port_by_vtermno(0));
 291 }
 292
 293 /* We set the configuration at this point, since we now have a tty */
 294 static int notifier_add_vio(struct hvc_struct *hp, int data)
 295 {
 296         struct port *port;
 297
 298         port = find_port_by_vtermno(hp->vtermno);
 299         if (!port)
 300                 return -EINVAL;
 301
 302         hp->irq_requested = 1;
 303         resize_console(port);
 304
 305         return 0;
 306 }
 307
 308 static void notifier_del_vio(struct hvc_struct *hp, int data)
 309 {
 310         hp->irq_requested = 0;
 311 }
 312
 313 static void hvc_handle_input(struct virtqueue *vq)
 314 {
 315         struct console *cons;
 316         bool activity = false;
 317
 318         list_for_each_entry(cons, &pdrvdata.consoles, list)
 319                 activity |= hvc_poll(cons->hvc);
 320
 321         if (activity)
 322                 hvc_kick();
 323 }
 324
 325 /* The operations for the console. */
 326 static const struct hv_ops hv_ops = {
 327         .get_chars = get_chars,
 328         .put_chars = put_chars,
 329         .notifier_add = notifier_add_vio,
 330         .notifier_del = notifier_del_vio,
 331         .notifier_hangup = notifier_del_vio,
 332 };
 333
 334 /*
 335  * Console drivers are initialized very early so boot messages can go
 336  * out, so we do things slightly differently from the generic virtio
 337  * initialization of the net and block drivers.
 338  *
 339  * At this stage, the console is output-only.  It's too early to set
 340  * up a virtqueue, so we let the drivers do some boutique early-output
 341  * thing.
 342  */
 343 int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
 344 {
 345         early_put_chars = put_chars;
 346         return hvc_instantiate(0, 0, &hv_ops);
 347 }
 348
 349 int __devinit init_port_console(struct port *port)
 350 {
 351         int ret;
 352
 353         /*
 354          * The Host's telling us this port is a console port.  Hook it
 355          * up with an hvc console.
 356          *
 357          * To set up and manage our virtual console, we call
 358          * hvc_alloc().
 359          *
 360          * The first argument of hvc_alloc() is the virtual console
 361          * number.  The second argument is the parameter for the
 362          * notification mechanism (like irq number).  We currently
 363          * leave this as zero, virtqueues have implicit notifications.
 364          *
 365          * The third argument is a "struct hv_ops" containing the
 366          * put_chars() get_chars(), notifier_add() and notifier_del()
 367          * pointers.  The final argument is the output buffer size: we
 368          * can do any size, so we put PAGE_SIZE here.
 369          */
 370         port->cons.vtermno = pdrvdata.next_vtermno;
 371
 372         port->cons.hvc = hvc_alloc(port->cons.vtermno, 0, &hv_ops, PAGE_SIZE);
 373         if (IS_ERR(port->cons.hvc)) {
 374                 ret = PTR_ERR(port->cons.hvc);
 375                 port->cons.hvc = NULL;
 376                 return ret;
 377         }
 378         spin_lock_irq(&pdrvdata_lock);
 379         pdrvdata.next_vtermno++;
 380         list_add_tail(&port->cons.list, &pdrvdata.consoles);
 381         spin_unlock_irq(&pdrvdata_lock);
 382
 383         return 0;
 384 }
 385
 386 static int __devinit add_port(struct ports_device *portdev)
 387 {
 388         struct port *port;
 389         int err;
 390
 391         port = kmalloc(sizeof(*port), GFP_KERNEL);
 392         if (!port) {
 393                 err = -ENOMEM;
 394                 goto fail;
 395         }
 396
 397         port->portdev = portdev;
 398         port->in_vq = portdev->in_vq;
 399         port->out_vq = portdev->out_vq;
 400
 401         port->inbuf = alloc_buf(PAGE_SIZE);
 402         if (!port->inbuf) {
 403                 err = -ENOMEM;
 404                 goto free_port;
 405         }
 406
 407         err = init_port_console(port);
 408         if (err)
 409                 goto free_inbuf;
 410
 411         /* Register the input buffer the first time. */
 412         add_inbuf(port->in_vq, port->inbuf);
 413
 414         return 0;
 415
 416 free_inbuf:
 417         free_buf(port->inbuf);
 418 free_port:
 419         kfree(port);
 420 fail:
 421         return err;
 422 }
 423
 424 /*
 425  * Once we're further in boot, we get probed like any other virtio
 426  * device.
 427  */
 428 static int __devinit virtcons_probe(struct virtio_device *vdev)
 429 {
 430         vq_callback_t *callbacks[] = { hvc_handle_input, NULL};
 431         const char *names[] = { "input", "output" };
 432         struct virtqueue *vqs[2];
 433         struct ports_device *portdev;
 434         int err;
 435
 436         portdev = kmalloc(sizeof(*portdev), GFP_KERNEL);
 437         if (!portdev) {
 438                 err = -ENOMEM;
 439                 goto fail;
 440         }
 441
 442         /* Attach this portdev to this virtio_device, and vice-versa. */
 443         portdev->vdev = vdev;
 444         vdev->priv = portdev;
 445
 446         /* Find the queues. */
 447         err = vdev->config->find_vqs(vdev, 2, vqs, callbacks, names);
 448         if (err)
 449                 goto free;
 450
 451         portdev->in_vq = vqs[0];
 452         portdev->out_vq = vqs[1];
 453
 454         /* We only have one port. */
 455         err = add_port(portdev);
 456         if (err)
 457                 goto free_vqs;
 458
 459         /* Start using the new console output. */
 460         early_put_chars = NULL;
 461         return 0;
 462
 463 free_vqs:
 464         vdev->config->del_vqs(vdev);
 465 free:
 466         kfree(portdev);
 467 fail:
 468         return err;
 469 }
 470
 471 static struct virtio_device_id id_table[] = {
 472         { VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
 473         { 0 },
 474 };
 475
 476 static unsigned int features[] = {
 477         VIRTIO_CONSOLE_F_SIZE,
 478 };
 479
 480 static struct virtio_driver virtio_console = {
 481         .feature_table = features,
 482         .feature_table_size = ARRAY_SIZE(features),
 483         .driver.name =  KBUILD_MODNAME,
 484         .driver.owner = THIS_MODULE,
 485         .id_table =     id_table,
 486         .probe =        virtcons_probe,
 487         .config_changed = virtcons_apply_config,
 488 };
 489
 490 static int __init init(void)
 491 {
 492         INIT_LIST_HEAD(&pdrvdata.consoles);
 493
 494         return register_virtio_driver(&virtio_console);
 495 }
 496 module_init(init);
 497
 498 MODULE_DEVICE_TABLE(virtio, id_table);
 499 MODULE_DESCRIPTION("Virtio console driver");
 500 MODULE_LICENSE("GPL");