drivers/s390/kvm/kvm_virtio.c

   1 /*
   2  * virtio for kvm on s390
   3  *
   4  * Copyright IBM Corp. 2008
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License (version 2 only)
   8  * as published by the Free Software Foundation.
   9  *
  10  *    Author(s): Christian Borntraeger <borntraeger@de.ibm.com>
  11  */
  12
  13 #include <linux/kernel_stat.h>
  14 #include <linux/init.h>
  15 #include <linux/bootmem.h>
  16 #include <linux/err.h>
  17 #include <linux/virtio.h>
  18 #include <linux/virtio_config.h>
  19 #include <linux/slab.h>
  20 #include <linux/virtio_console.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/virtio_ring.h>
  23 #include <linux/export.h>
  24 #include <linux/pfn.h>
  25 #include <asm/io.h>
  26 #include <asm/kvm_para.h>
  27 #include <asm/kvm_virtio.h>
  28 #include <asm/sclp.h>
  29 #include <asm/setup.h>
  30 #include <asm/irq.h>
  31
  32 #define VIRTIO_SUBCODE_64 0x0D00
  33
  34 /*
  35  * The pointer to our (page) of device descriptions.
  36  */
  37 static void *kvm_devices;
  38 static struct work_struct hotplug_work;
  39
  40 struct kvm_device {
  41         struct virtio_device vdev;
  42         struct kvm_device_desc *desc;
  43 };
  44
  45 #define to_kvmdev(vd) container_of(vd, struct kvm_device, vdev)
  46
  47 /*
  48  * memory layout:
  49  * - kvm_device_descriptor
  50  *        struct kvm_device_desc
  51  * - configuration
  52  *        struct kvm_vqconfig
  53  * - feature bits
  54  * - config space
  55  */
  56 static struct kvm_vqconfig *kvm_vq_config(const struct kvm_device_desc *desc)
  57 {
  58         return (struct kvm_vqconfig *)(desc + 1);
  59 }
  60
  61 static u8 *kvm_vq_features(const struct kvm_device_desc *desc)
  62 {
  63         return (u8 *)(kvm_vq_config(desc) + desc->num_vq);
  64 }
  65
  66 static u8 *kvm_vq_configspace(const struct kvm_device_desc *desc)
  67 {
  68         return kvm_vq_features(desc) + desc->feature_len * 2;
  69 }
  70
  71 /*
  72  * The total size of the config page used by this device (incl. desc)
  73  */
  74 static unsigned desc_size(const struct kvm_device_desc *desc)
  75 {
  76         return sizeof(*desc)
  77                 + desc->num_vq * sizeof(struct kvm_vqconfig)
  78                 + desc->feature_len * 2
  79                 + desc->config_len;
  80 }
  81
  82 /* This gets the device's feature bits. */
  83 static u32 kvm_get_features(struct virtio_device *vdev)
  84 {
  85         unsigned int i;
  86         u32 features = 0;
  87         struct kvm_device_desc *desc = to_kvmdev(vdev)->desc;
  88         u8 *in_features = kvm_vq_features(desc);
  89
  90         for (i = 0; i < min(desc->feature_len * 8, 32); i++)
  91                 if (in_features[i / 8] & (1 << (i % 8)))
  92                         features |= (1 << i);
  93         return features;
  94 }
  95
  96 static void kvm_finalize_features(struct virtio_device *vdev)
  97 {
  98         unsigned int i, bits;
  99         struct kvm_device_desc *desc = to_kvmdev(vdev)->desc;
 100         /* Second half of bitmap is features we accept. */
 101         u8 *out_features = kvm_vq_features(desc) + desc->feature_len;
 102
 103         /* Give virtio_ring a chance to accept features. */
 104         vring_transport_features(vdev);
 105
 106         memset(out_features, 0, desc->feature_len);
 107         bits = min_t(unsigned, desc->feature_len, sizeof(vdev->features)) * 8;
 108         for (i = 0; i < bits; i++) {
 109                 if (test_bit(i, vdev->features))
 110                         out_features[i / 8] |= (1 << (i % 8));
 111         }
 112 }
 113
 114 /*
 115  * Reading and writing elements in config space
 116  */
 117 static void kvm_get(struct virtio_device *vdev, unsigned int offset,
 118                    void *buf, unsigned len)
 119 {
 120         struct kvm_device_desc *desc = to_kvmdev(vdev)->desc;
 121
 122         BUG_ON(offset + len > desc->config_len);
 123         memcpy(buf, kvm_vq_configspace(desc) + offset, len);
 124 }
 125
 126 static void kvm_set(struct virtio_device *vdev, unsigned int offset,
 127                    const void *buf, unsigned len)
 128 {
 129         struct kvm_device_desc *desc = to_kvmdev(vdev)->desc;
 130
 131         BUG_ON(offset + len > desc->config_len);
 132         memcpy(kvm_vq_configspace(desc) + offset, buf, len);
 133 }
 134
 135 /*
 136  * The operations to get and set the status word just access
 137  * the status field of the device descriptor. set_status will also
 138  * make a hypercall to the host, to tell about status changes
 139  */
 140 static u8 kvm_get_status(struct virtio_device *vdev)
 141 {
 142         return to_kvmdev(vdev)->desc->status;
 143 }
 144
 145 static void kvm_set_status(struct virtio_device *vdev, u8 status)
 146 {
 147         BUG_ON(!status);
 148         to_kvmdev(vdev)->desc->status = status;
 149         kvm_hypercall1(KVM_S390_VIRTIO_SET_STATUS,
 150                        (unsigned long) to_kvmdev(vdev)->desc);
 151 }
 152
 153 /*
 154  * To reset the device, we use the KVM_VIRTIO_RESET hypercall, using the
 155  * descriptor address. The Host will zero the status and all the
 156  * features.
 157  */
 158 static void kvm_reset(struct virtio_device *vdev)
 159 {
 160         kvm_hypercall1(KVM_S390_VIRTIO_RESET,
 161                        (unsigned long) to_kvmdev(vdev)->desc);
 162 }
 163
 164 /*
 165  * When the virtio_ring code wants to notify the Host, it calls us here and we
 166  * make a hypercall.  We hand the address  of the virtqueue so the Host
 167  * knows which virtqueue we're talking about.
 168  */
 169 static void kvm_notify(struct virtqueue *vq)
 170 {
 171         struct kvm_vqconfig *config = vq->priv;
 172
 173         kvm_hypercall1(KVM_S390_VIRTIO_NOTIFY, config->address);
 174 }
 175
 176 /*
 177  * This routine finds the first virtqueue described in the configuration of
 178  * this device and sets it up.
 179  */
 180 static struct virtqueue *kvm_find_vq(struct virtio_device *vdev,
 181                                      unsigned index,
 182                                      void (*callback)(struct virtqueue *vq),
 183                                      const char *name)
 184 {
 185         struct kvm_device *kdev = to_kvmdev(vdev);
 186         struct kvm_vqconfig *config;
 187         struct virtqueue *vq;
 188         int err;
 189
 190         if (index >= kdev->desc->num_vq)
 191                 return ERR_PTR(-ENOENT);
 192
 193         if (!name)
 194                 return NULL;
 195
 196         config = kvm_vq_config(kdev->desc)+index;
 197
 198         err = vmem_add_mapping(config->address,
 199                                vring_size(config->num,
 200                                           KVM_S390_VIRTIO_RING_ALIGN));
 201         if (err)
 202                 goto out;
 203
 204         vq = vring_new_virtqueue(index, config->num, KVM_S390_VIRTIO_RING_ALIGN,
 205                                  vdev, true, (void *) config->address,
 206                                  kvm_notify, callback, name);
 207         if (!vq) {
 208                 err = -ENOMEM;
 209                 goto unmap;
 210         }
 211
 212         /*
 213          * register a callback token
 214          * The host will sent this via the external interrupt parameter
 215          */
 216         config->token = (u64) vq;
 217
 218         vq->priv = config;
 219         return vq;
 220 unmap:
 221         vmem_remove_mapping(config->address,
 222                             vring_size(config->num,
 223                                        KVM_S390_VIRTIO_RING_ALIGN));
 224 out:
 225         return ERR_PTR(err);
 226 }
 227
 228 static void kvm_del_vq(struct virtqueue *vq)
 229 {
 230         struct kvm_vqconfig *config = vq->priv;
 231
 232         vring_del_virtqueue(vq);
 233         vmem_remove_mapping(config->address,
 234                             vring_size(config->num,
 235                                        KVM_S390_VIRTIO_RING_ALIGN));
 236 }
 237
 238 static void kvm_del_vqs(struct virtio_device *vdev)
 239 {
 240         struct virtqueue *vq, *n;
 241
 242         list_for_each_entry_safe(vq, n, &vdev->vqs, list)
 243                 kvm_del_vq(vq);
 244 }
 245
 246 static int kvm_find_vqs(struct virtio_device *vdev, unsigned nvqs,
 247                         struct virtqueue *vqs[],
 248                         vq_callback_t *callbacks[],
 249                         const char *names[])
 250 {
 251         struct kvm_device *kdev = to_kvmdev(vdev);
 252         int i;
 253
 254         /* We must have this many virtqueues. */
 255         if (nvqs > kdev->desc->num_vq)
 256                 return -ENOENT;
 257
 258         for (i = 0; i < nvqs; ++i) {
 259                 vqs[i] = kvm_find_vq(vdev, i, callbacks[i], names[i]);
 260                 if (IS_ERR(vqs[i]))
 261                         goto error;
 262         }
 263         return 0;
 264
 265 error:
 266         kvm_del_vqs(vdev);
 267         return PTR_ERR(vqs[i]);
 268 }
 269
 270 static const char *kvm_bus_name(struct virtio_device *vdev)
 271 {
 272         return "";
 273 }
 274
 275 /*
 276  * The config ops structure as defined by virtio config
 277  */
 278 static struct virtio_config_ops kvm_vq_configspace_ops = {
 279         .get_features = kvm_get_features,
 280         .finalize_features = kvm_finalize_features,
 281         .get = kvm_get,
 282         .set = kvm_set,
 283         .get_status = kvm_get_status,
 284         .set_status = kvm_set_status,
 285         .reset = kvm_reset,
 286         .find_vqs = kvm_find_vqs,
 287         .del_vqs = kvm_del_vqs,
 288         .bus_name = kvm_bus_name,
 289 };
 290
 291 /*
 292  * The root device for the kvm virtio devices.
 293  * This makes them appear as /sys/devices/kvm_s390/0,1,2 not /sys/devices/0,1,2.
 294  */
 295 static struct device *kvm_root;
 296
 297 /*
 298  * adds a new device and register it with virtio
 299  * appropriate drivers are loaded by the device model
 300  */
 301 static void add_kvm_device(struct kvm_device_desc *d, unsigned int offset)
 302 {
 303         struct kvm_device *kdev;
 304
 305         kdev = kzalloc(sizeof(*kdev), GFP_KERNEL);
 306         if (!kdev) {
 307                 printk(KERN_EMERG "Cannot allocate kvm dev %u type %u\n",
 308                        offset, d->type);
 309                 return;
 310         }
 311
 312         kdev->vdev.dev.parent = kvm_root;
 313         kdev->vdev.id.device = d->type;
 314         kdev->vdev.config = &kvm_vq_configspace_ops;
 315         kdev->desc = d;
 316
 317         if (register_virtio_device(&kdev->vdev) != 0) {
 318                 printk(KERN_ERR "Failed to register kvm device %u type %u\n",
 319                        offset, d->type);
 320                 kfree(kdev);
 321         }
 322 }
 323
 324 /*
 325  * scan_devices() simply iterates through the device page.
 326  * The type 0 is reserved to mean "end of devices".
 327  */
 328 static void scan_devices(void)
 329 {
 330         unsigned int i;
 331         struct kvm_device_desc *d;
 332
 333         for (i = 0; i < PAGE_SIZE; i += desc_size(d)) {
 334                 d = kvm_devices + i;
 335
 336                 if (d->type == 0)
 337                         break;
 338
 339                 add_kvm_device(d, i);
 340         }
 341 }
 342
 343 /*
 344  * match for a kvm device with a specific desc pointer
 345  */
 346 static int match_desc(struct device *dev, void *data)
 347 {
 348         struct virtio_device *vdev = dev_to_virtio(dev);
 349         struct kvm_device *kdev = to_kvmdev(vdev);
 350
 351         return kdev->desc == data;
 352 }
 353
 354 /*
 355  * hotplug_device tries to find changes in the device page.
 356  */
 357 static void hotplug_devices(struct work_struct *dummy)
 358 {
 359         unsigned int i;
 360         struct kvm_device_desc *d;
 361         struct device *dev;
 362
 363         for (i = 0; i < PAGE_SIZE; i += desc_size(d)) {
 364                 d = kvm_devices + i;
 365
 366                 /* end of list */
 367                 if (d->type == 0)
 368                         break;
 369
 370                 /* device already exists */
 371                 dev = device_find_child(kvm_root, d, match_desc);
 372                 if (dev) {
 373                         /* XXX check for hotplug remove */
 374                         put_device(dev);
 375                         continue;
 376                 }
 377
 378                 /* new device */
 379                 printk(KERN_INFO "Adding new virtio device %p\n", d);
 380                 add_kvm_device(d, i);
 381         }
 382 }
 383
 384 /*
 385  * we emulate the request_irq behaviour on top of s390 extints
 386  */
 387 static void kvm_extint_handler(struct ext_code ext_code,
 388                                unsigned int param32, unsigned long param64)
 389 {
 390         struct virtqueue *vq;
 391         u32 param;
 392
 393         if ((ext_code.subcode & 0xff00) != VIRTIO_SUBCODE_64)
 394                 return;
 395         inc_irq_stat(IRQEXT_VRT);
 396
 397         /* The LSB might be overloaded, we have to mask it */
 398         vq = (struct virtqueue *)(param64 & ~1UL);
 399
 400         /* We use ext_params to decide what this interrupt means */
 401         param = param32 & VIRTIO_PARAM_MASK;
 402
 403         switch (param) {
 404         case VIRTIO_PARAM_CONFIG_CHANGED:
 405         {
 406                 struct virtio_driver *drv;
 407                 drv = container_of(vq->vdev->dev.driver,
 408                                    struct virtio_driver, driver);
 409                 if (drv->config_changed)
 410                         drv->config_changed(vq->vdev);
 411
 412                 break;
 413         }
 414         case VIRTIO_PARAM_DEV_ADD:
 415                 schedule_work(&hotplug_work);
 416                 break;
 417         case VIRTIO_PARAM_VRING_INTERRUPT:
 418         default:
 419                 vring_interrupt(0, vq);
 420                 break;
 421         }
 422 }
 423
 424 /*
 425  * For s390-virtio, we expect a page above main storage containing
 426  * the virtio configuration. Try to actually load from this area
 427  * in order to figure out if the host provides this page.
 428  */
 429 static int __init test_devices_support(unsigned long addr)
 430 {
 431         int ret = -EIO;
 432
 433         asm volatile(
 434                 "0:     lura    0,%1\n"
 435                 "1:     xgr     %0,%0\n"
 436                 "2:\n"
 437                 EX_TABLE(0b,2b)
 438                 EX_TABLE(1b,2b)
 439                 : "+d" (ret)
 440                 : "a" (addr)
 441                 : "0", "cc");
 442         return ret;
 443 }
 444 /*
 445  * Init function for virtio
 446  * devices are in a single page above top of "normal" mem
 447  */
 448 static int __init kvm_devices_init(void)
 449 {
 450         int rc;
 451
 452         if (!MACHINE_IS_KVM)
 453                 return -ENODEV;
 454
 455         if (test_devices_support(real_memory_size) < 0)
 456                 return -ENODEV;
 457
 458         rc = vmem_add_mapping(real_memory_size, PAGE_SIZE);
 459         if (rc)
 460                 return rc;
 461
 462         kvm_devices = (void *) real_memory_size;
 463
 464         kvm_root = root_device_register("kvm_s390");
 465         if (IS_ERR(kvm_root)) {
 466                 rc = PTR_ERR(kvm_root);
 467                 printk(KERN_ERR "Could not register kvm_s390 root device");
 468                 vmem_remove_mapping(real_memory_size, PAGE_SIZE);
 469                 return rc;
 470         }
 471
 472         INIT_WORK(&hotplug_work, hotplug_devices);
 473
 474         service_subclass_irq_register();
 475         register_external_interrupt(0x2603, kvm_extint_handler);
 476
 477         scan_devices();
 478         return 0;
 479 }
 480
 481 /* code for early console output with virtio_console */
 482 static __init int early_put_chars(u32 vtermno, const char *buf, int count)
 483 {
 484         char scratch[17];
 485         unsigned int len = count;
 486
 487         if (len > sizeof(scratch) - 1)
 488                 len = sizeof(scratch) - 1;
 489         scratch[len] = '\0';
 490         memcpy(scratch, buf, len);
 491         kvm_hypercall1(KVM_S390_VIRTIO_NOTIFY, __pa(scratch));
 492         return len;
 493 }
 494
 495 static int __init s390_virtio_console_init(void)
 496 {
 497         if (sclp_has_vt220() || sclp_has_linemode())
 498                 return -ENODEV;
 499         return virtio_cons_early_init(early_put_chars);
 500 }
 501 console_initcall(s390_virtio_console_init);
 502
 503
 504 /*
 505  * We do this after core stuff, but before the drivers.
 506  */
 507 postcore_initcall(kvm_devices_init);