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/virtio.h>
  21 #include <linux/virtio_console.h>
  22 #include "hvc_console.h"
  23
  24 struct port_buffer {
  25         char *buf;
  26
  27         /* size of the buffer in *buf above */
  28         size_t size;
  29
  30         /* used length of the buffer */
  31         size_t len;
  32         /* offset in the buf from which to consume data */
  33         size_t offset;
  34 };
  35
  36 struct port {
  37         struct virtqueue *in_vq, *out_vq;
  38         struct virtio_device *vdev;
  39
  40         /* The current buffer from which data has to be fed to readers */
  41         struct port_buffer *inbuf;
  42
  43         /* The hvc device */
  44         struct hvc_struct *hvc;
  45 };
  46
  47 /* We have one port ready to go immediately, for a console. */
  48 static struct port console;
  49
  50 /* This is the very early arch-specified put chars function. */
  51 static int (*early_put_chars)(u32, const char *, int);
  52
  53 static void free_buf(struct port_buffer *buf)
  54 {
  55         kfree(buf->buf);
  56         kfree(buf);
  57 }
  58
  59 static struct port_buffer *alloc_buf(size_t buf_size)
  60 {
  61         struct port_buffer *buf;
  62
  63         buf = kmalloc(sizeof(*buf), GFP_KERNEL);
  64         if (!buf)
  65                 goto fail;
  66         buf->buf = kzalloc(buf_size, GFP_KERNEL);
  67         if (!buf->buf)
  68                 goto free_buf;
  69         buf->len = 0;
  70         buf->offset = 0;
  71         buf->size = buf_size;
  72         return buf;
  73
  74 free_buf:
  75         kfree(buf);
  76 fail:
  77         return NULL;
  78 }
  79
  80 /* Callers should take appropriate locks */
  81 static void *get_inbuf(struct port *port)
  82 {
  83         struct port_buffer *buf;
  84         struct virtqueue *vq;
  85         unsigned int len;
  86
  87         vq = port->in_vq;
  88         buf = vq->vq_ops->get_buf(vq, &len);
  89         if (buf) {
  90                 buf->len = len;
  91                 buf->offset = 0;
  92         }
  93         return buf;
  94 }
  95
  96 /*
  97  * Create a scatter-gather list representing our input buffer and put
  98  * it in the queue.
  99  *
 100  * Callers should take appropriate locks.
 101  */
 102 static void add_inbuf(struct virtqueue *vq, struct port_buffer *buf)
 103 {
 104         struct scatterlist sg[1];
 105         sg_init_one(sg, buf->buf, buf->size);
 106
 107         if (vq->vq_ops->add_buf(vq, sg, 0, 1, buf) < 0)
 108                 BUG();
 109         vq->vq_ops->kick(vq);
 110 }
 111
 112 /*
 113  * The put_chars() callback is pretty straightforward.
 114  *
 115  * We turn the characters into a scatter-gather list, add it to the
 116  * output queue and then kick the Host.  Then we sit here waiting for
 117  * it to finish: inefficient in theory, but in practice
 118  * implementations will do it immediately (lguest's Launcher does).
 119  */
 120 static int put_chars(u32 vtermno, const char *buf, int count)
 121 {
 122         struct scatterlist sg[1];
 123         unsigned int len;
 124         struct port *port;
 125
 126         if (unlikely(early_put_chars))
 127                 return early_put_chars(vtermno, buf, count);
 128
 129         port = &console;
 130
 131         /* This is a convenient routine to initialize a single-elem sg list */
 132         sg_init_one(sg, buf, count);
 133
 134         /* This shouldn't fail: if it does, we lose chars. */
 135         if (port->out_vq->vq_ops->add_buf(port->out_vq, sg, 1, 0, port) >= 0) {
 136                 /* Tell Host to go! */
 137                 port->out_vq->vq_ops->kick(port->out_vq);
 138                 while (!port->out_vq->vq_ops->get_buf(port->out_vq, &len))
 139                         cpu_relax();
 140         }
 141
 142         /* We're expected to return the amount of data we wrote: all of it. */
 143         return count;
 144 }
 145
 146 /*
 147  * get_chars() is the callback from the hvc_console infrastructure
 148  * when an interrupt is received.
 149  *
 150  * Most of the code deals with the fact that the hvc_console()
 151  * infrastructure only asks us for 16 bytes at a time.  We keep
 152  * in_offset and in_used fields for partially-filled buffers.
 153  */
 154 static int get_chars(u32 vtermno, char *buf, int count)
 155 {
 156         struct port *port;
 157
 158         port = &console;
 159
 160         /* If we don't have an input queue yet, we can't get input. */
 161         BUG_ON(!port->in_vq);
 162
 163         /* No more in buffer?  See if they've (re)used it. */
 164         if (port->inbuf->offset == port->inbuf->len) {
 165                 if (!get_inbuf(port))
 166                         return 0;
 167         }
 168
 169         /* You want more than we have to give?  Well, try wanting less! */
 170         if (port->inbuf->offset + count > port->inbuf->len)
 171                 count = port->inbuf->len - port->inbuf->offset;
 172
 173         /* Copy across to their buffer and increment offset. */
 174         memcpy(buf, port->inbuf->buf + port->inbuf->offset, count);
 175         port->inbuf->offset += count;
 176
 177         /* Finished?  Re-register buffer so Host will use it again. */
 178         if (port->inbuf->offset == port->inbuf->len)
 179                 add_inbuf(port->in_vq, port->inbuf);
 180
 181         return count;
 182 }
 183
 184 /*
 185  * virtio console configuration. This supports:
 186  * - console resize
 187  */
 188 static void virtcons_apply_config(struct virtio_device *dev)
 189 {
 190         struct port *port = dev->priv;
 191         struct winsize ws;
 192
 193         if (virtio_has_feature(dev, VIRTIO_CONSOLE_F_SIZE)) {
 194                 dev->config->get(dev,
 195                                  offsetof(struct virtio_console_config, cols),
 196                                  &ws.ws_col, sizeof(u16));
 197                 dev->config->get(dev,
 198                                  offsetof(struct virtio_console_config, rows),
 199                                  &ws.ws_row, sizeof(u16));
 200                 hvc_resize(port->hvc, ws);
 201         }
 202 }
 203
 204 /*
 205  * we support only one console, the hvc struct is a global var We set
 206  * the configuration at this point, since we now have a tty
 207  */
 208 static int notifier_add_vio(struct hvc_struct *hp, int data)
 209 {
 210         hp->irq_requested = 1;
 211         virtcons_apply_config(console.vdev);
 212
 213         return 0;
 214 }
 215
 216 static void notifier_del_vio(struct hvc_struct *hp, int data)
 217 {
 218         hp->irq_requested = 0;
 219 }
 220
 221 static void hvc_handle_input(struct virtqueue *vq)
 222 {
 223         struct port *port = vq->vdev->priv;
 224
 225         if (hvc_poll(port->hvc))
 226                 hvc_kick();
 227 }
 228
 229 /* The operations for the console. */
 230 static const struct hv_ops hv_ops = {
 231         .get_chars = get_chars,
 232         .put_chars = put_chars,
 233         .notifier_add = notifier_add_vio,
 234         .notifier_del = notifier_del_vio,
 235         .notifier_hangup = notifier_del_vio,
 236 };
 237
 238 /*
 239  * Console drivers are initialized very early so boot messages can go
 240  * out, so we do things slightly differently from the generic virtio
 241  * initialization of the net and block drivers.
 242  *
 243  * At this stage, the console is output-only.  It's too early to set
 244  * up a virtqueue, so we let the drivers do some boutique early-output
 245  * thing.
 246  */
 247 int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int))
 248 {
 249         early_put_chars = put_chars;
 250         return hvc_instantiate(0, 0, &hv_ops);
 251 }
 252
 253 /*
 254  * Once we're further in boot, we get probed like any other virtio
 255  * device.  At this stage we set up the output virtqueue.
 256  *
 257  * To set up and manage our virtual console, we call hvc_alloc().
 258  * Since we never remove the console device we never need this pointer
 259  * again.
 260  *
 261  * Finally we put our input buffer in the input queue, ready to
 262  * receive.
 263  */
 264 static int __devinit virtcons_probe(struct virtio_device *vdev)
 265 {
 266         vq_callback_t *callbacks[] = { hvc_handle_input, NULL};
 267         const char *names[] = { "input", "output" };
 268         struct virtqueue *vqs[2];
 269         struct port *port;
 270         int err;
 271
 272         port = &console;
 273         if (port->vdev) {
 274                 dev_warn(&port->vdev->dev,
 275                          "Multiple virtio-console devices not supported yet\n");
 276                 return -EEXIST;
 277         }
 278
 279         /* Attach this port to this virtio_device, and vice-versa. */
 280         port->vdev = vdev;
 281         vdev->priv = port;
 282
 283         /* This is the scratch page we use to receive console input */
 284         port->inbuf = alloc_buf(PAGE_SIZE);
 285         if (!port->inbuf) {
 286                 err = -ENOMEM;
 287                 goto fail;
 288         }
 289
 290         /* Find the queues. */
 291         err = vdev->config->find_vqs(vdev, 2, vqs, callbacks, names);
 292         if (err)
 293                 goto free;
 294
 295         port->in_vq = vqs[0];
 296         port->out_vq = vqs[1];
 297
 298         /*
 299          * The first argument of hvc_alloc() is the virtual console
 300          * number, so we use zero.  The second argument is the
 301          * parameter for the notification mechanism (like irq
 302          * number). We currently leave this as zero, virtqueues have
 303          * implicit notifications.
 304          *
 305          * The third argument is a "struct hv_ops" containing the
 306          * put_chars(), get_chars(), notifier_add() and notifier_del()
 307          * pointers.  The final argument is the output buffer size: we
 308          * can do any size, so we put PAGE_SIZE here.
 309          */
 310         port->hvc = hvc_alloc(0, 0, &hv_ops, PAGE_SIZE);
 311         if (IS_ERR(port->hvc)) {
 312                 err = PTR_ERR(port->hvc);
 313                 goto free_vqs;
 314         }
 315
 316         /* Register the input buffer the first time. */
 317         add_inbuf(port->in_vq, port->inbuf);
 318
 319         /* Start using the new console output. */
 320         early_put_chars = NULL;
 321         return 0;
 322
 323 free_vqs:
 324         vdev->config->del_vqs(vdev);
 325 free:
 326         free_buf(port->inbuf);
 327 fail:
 328         return err;
 329 }
 330
 331 static struct virtio_device_id id_table[] = {
 332         { VIRTIO_ID_CONSOLE, VIRTIO_DEV_ANY_ID },
 333         { 0 },
 334 };
 335
 336 static unsigned int features[] = {
 337         VIRTIO_CONSOLE_F_SIZE,
 338 };
 339
 340 static struct virtio_driver virtio_console = {
 341         .feature_table = features,
 342         .feature_table_size = ARRAY_SIZE(features),
 343         .driver.name =  KBUILD_MODNAME,
 344         .driver.owner = THIS_MODULE,
 345         .id_table =     id_table,
 346         .probe =        virtcons_probe,
 347         .config_changed = virtcons_apply_config,
 348 };
 349
 350 static int __init init(void)
 351 {
 352         return register_virtio_driver(&virtio_console);
 353 }
 354 module_init(init);
 355
 356 MODULE_DEVICE_TABLE(virtio, id_table);
 357 MODULE_DESCRIPTION("Virtio console driver");
 358 MODULE_LICENSE("GPL");