drivers/s390/virtio/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 u64 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 int 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         /* Make sure we don't have any features > 32 bits! */
 107         BUG_ON((u32)vdev->features != vdev->features);
 108
 109         memset(out_features, 0, desc->feature_len);
 110         bits = min_t(unsigned, desc->feature_len, sizeof(vdev->features)) * 8;
 111         for (i = 0; i < bits; i++) {
 112                 if (__virtio_test_bit(vdev, i))
 113                         out_features[i / 8] |= (1 << (i % 8));
 114         }
 115
 116         return 0;
 117 }
 118
 119 /*
 120  * Reading and writing elements in config space
 121  */
 122 static void kvm_get(struct virtio_device *vdev, unsigned int offset,
 123                    void *buf, unsigned len)
 124 {
 125         struct kvm_device_desc *desc = to_kvmdev(vdev)->desc;
 126
 127         BUG_ON(offset + len > desc->config_len);
 128         memcpy(buf, kvm_vq_configspace(desc) + offset, len);
 129 }
 130
 131 static void kvm_set(struct virtio_device *vdev, unsigned int offset,
 132                    const void *buf, unsigned len)
 133 {
 134         struct kvm_device_desc *desc = to_kvmdev(vdev)->desc;
 135
 136         BUG_ON(offset + len > desc->config_len);
 137         memcpy(kvm_vq_configspace(desc) + offset, buf, len);
 138 }
 139
 140 /*
 141  * The operations to get and set the status word just access
 142  * the status field of the device descriptor. set_status will also
 143  * make a hypercall to the host, to tell about status changes
 144  */
 145 static u8 kvm_get_status(struct virtio_device *vdev)
 146 {
 147         return to_kvmdev(vdev)->desc->status;
 148 }
 149
 150 static void kvm_set_status(struct virtio_device *vdev, u8 status)
 151 {
 152         BUG_ON(!status);
 153         to_kvmdev(vdev)->desc->status = status;
 154         kvm_hypercall1(KVM_S390_VIRTIO_SET_STATUS,
 155                        (unsigned long) to_kvmdev(vdev)->desc);
 156 }
 157
 158 /*
 159  * To reset the device, we use the KVM_VIRTIO_RESET hypercall, using the
 160  * descriptor address. The Host will zero the status and all the
 161  * features.
 162  */
 163 static void kvm_reset(struct virtio_device *vdev)
 164 {
 165         kvm_hypercall1(KVM_S390_VIRTIO_RESET,
 166                        (unsigned long) to_kvmdev(vdev)->desc);
 167 }
 168
 169 /*
 170  * When the virtio_ring code wants to notify the Host, it calls us here and we
 171  * make a hypercall.  We hand the address  of the virtqueue so the Host
 172  * knows which virtqueue we're talking about.
 173  */
 174 static bool kvm_notify(struct virtqueue *vq)
 175 {
 176         long rc;
 177         struct kvm_vqconfig *config = vq->priv;
 178
 179         rc = kvm_hypercall1(KVM_S390_VIRTIO_NOTIFY, config->address);
 180         if (rc < 0)
 181                 return false;
 182         return true;
 183 }
 184
 185 /*
 186  * This routine finds the first virtqueue described in the configuration of
 187  * this device and sets it up.
 188  */
 189 static struct virtqueue *kvm_find_vq(struct virtio_device *vdev,
 190                                      unsigned index,
 191                                      void (*callback)(struct virtqueue *vq),
 192                                      const char *name)
 193 {
 194         struct kvm_device *kdev = to_kvmdev(vdev);
 195         struct kvm_vqconfig *config;
 196         struct virtqueue *vq;
 197         int err;
 198
 199         if (index >= kdev->desc->num_vq)
 200                 return ERR_PTR(-ENOENT);
 201
 202         if (!name)
 203                 return NULL;
 204
 205         config = kvm_vq_config(kdev->desc)+index;
 206
 207         err = vmem_add_mapping(config->address,
 208                                vring_size(config->num,
 209                                           KVM_S390_VIRTIO_RING_ALIGN));
 210         if (err)
 211                 goto out;
 212
 213         vq = vring_new_virtqueue(index, config->num, KVM_S390_VIRTIO_RING_ALIGN,
 214                                  vdev, true, (void *) config->address,
 215                                  kvm_notify, callback, name);
 216         if (!vq) {
 217                 err = -ENOMEM;
 218                 goto unmap;
 219         }
 220
 221         /*
 222          * register a callback token
 223          * The host will sent this via the external interrupt parameter
 224          */
 225         config->token = (u64) vq;
 226
 227         vq->priv = config;
 228         return vq;
 229 unmap:
 230         vmem_remove_mapping(config->address,
 231                             vring_size(config->num,
 232                                        KVM_S390_VIRTIO_RING_ALIGN));
 233 out:
 234         return ERR_PTR(err);
 235 }
 236
 237 static void kvm_del_vq(struct virtqueue *vq)
 238 {
 239         struct kvm_vqconfig *config = vq->priv;
 240
 241         vring_del_virtqueue(vq);
 242         vmem_remove_mapping(config->address,
 243                             vring_size(config->num,
 244                                        KVM_S390_VIRTIO_RING_ALIGN));
 245 }
 246
 247 static void kvm_del_vqs(struct virtio_device *vdev)
 248 {
 249         struct virtqueue *vq, *n;
 250
 251         list_for_each_entry_safe(vq, n, &vdev->vqs, list)
 252                 kvm_del_vq(vq);
 253 }
 254
 255 static int kvm_find_vqs(struct virtio_device *vdev, unsigned nvqs,
 256                         struct virtqueue *vqs[],
 257                         vq_callback_t *callbacks[],
 258                         const char * const names[],
 259                         struct irq_affinity *desc)
 260 {
 261         struct kvm_device *kdev = to_kvmdev(vdev);
 262         int i;
 263
 264         /* We must have this many virtqueues. */
 265         if (nvqs > kdev->desc->num_vq)
 266                 return -ENOENT;
 267
 268         for (i = 0; i < nvqs; ++i) {
 269                 vqs[i] = kvm_find_vq(vdev, i, callbacks[i], names[i]);
 270                 if (IS_ERR(vqs[i]))
 271                         goto error;
 272         }
 273         return 0;
 274
 275 error:
 276         kvm_del_vqs(vdev);
 277         return PTR_ERR(vqs[i]);
 278 }
 279
 280 static const char *kvm_bus_name(struct virtio_device *vdev)
 281 {
 282         return "";
 283 }
 284
 285 /*
 286  * The config ops structure as defined by virtio config
 287  */
 288 static const struct virtio_config_ops kvm_vq_configspace_ops = {
 289         .get_features = kvm_get_features,
 290         .finalize_features = kvm_finalize_features,
 291         .get = kvm_get,
 292         .set = kvm_set,
 293         .get_status = kvm_get_status,
 294         .set_status = kvm_set_status,
 295         .reset = kvm_reset,
 296         .find_vqs = kvm_find_vqs,
 297         .del_vqs = kvm_del_vqs,
 298         .bus_name = kvm_bus_name,
 299 };
 300
 301 /*
 302  * The root device for the kvm virtio devices.
 303  * This makes them appear as /sys/devices/kvm_s390/0,1,2 not /sys/devices/0,1,2.
 304  */
 305 static struct device *kvm_root;
 306
 307 /*
 308  * adds a new device and register it with virtio
 309  * appropriate drivers are loaded by the device model
 310  */
 311 static void add_kvm_device(struct kvm_device_desc *d, unsigned int offset)
 312 {
 313         struct kvm_device *kdev;
 314
 315         kdev = kzalloc(sizeof(*kdev), GFP_KERNEL);
 316         if (!kdev) {
 317                 printk(KERN_EMERG "Cannot allocate kvm dev %u type %u\n",
 318                        offset, d->type);
 319                 return;
 320         }
 321
 322         kdev->vdev.dev.parent = kvm_root;
 323         kdev->vdev.id.device = d->type;
 324         kdev->vdev.config = &kvm_vq_configspace_ops;
 325         kdev->desc = d;
 326
 327         if (register_virtio_device(&kdev->vdev) != 0) {
 328                 printk(KERN_ERR "Failed to register kvm device %u type %u\n",
 329                        offset, d->type);
 330                 kfree(kdev);
 331         }
 332 }
 333
 334 /*
 335  * scan_devices() simply iterates through the device page.
 336  * The type 0 is reserved to mean "end of devices".
 337  */
 338 static void scan_devices(void)
 339 {
 340         unsigned int i;
 341         struct kvm_device_desc *d;
 342
 343         for (i = 0; i < PAGE_SIZE; i += desc_size(d)) {
 344                 d = kvm_devices + i;
 345
 346                 if (d->type == 0)
 347                         break;
 348
 349                 add_kvm_device(d, i);
 350         }
 351 }
 352
 353 /*
 354  * match for a kvm device with a specific desc pointer
 355  */
 356 static int match_desc(struct device *dev, void *data)
 357 {
 358         struct virtio_device *vdev = dev_to_virtio(dev);
 359         struct kvm_device *kdev = to_kvmdev(vdev);
 360
 361         return kdev->desc == data;
 362 }
 363
 364 /*
 365  * hotplug_device tries to find changes in the device page.
 366  */
 367 static void hotplug_devices(struct work_struct *dummy)
 368 {
 369         unsigned int i;
 370         struct kvm_device_desc *d;
 371         struct device *dev;
 372
 373         for (i = 0; i < PAGE_SIZE; i += desc_size(d)) {
 374                 d = kvm_devices + i;
 375
 376                 /* end of list */
 377                 if (d->type == 0)
 378                         break;
 379
 380                 /* device already exists */
 381                 dev = device_find_child(kvm_root, d, match_desc);
 382                 if (dev) {
 383                         /* XXX check for hotplug remove */
 384                         put_device(dev);
 385                         continue;
 386                 }
 387
 388                 /* new device */
 389                 printk(KERN_INFO "Adding new virtio device %p\n", d);
 390                 add_kvm_device(d, i);
 391         }
 392 }
 393
 394 /*
 395  * we emulate the request_irq behaviour on top of s390 extints
 396  */
 397 static void kvm_extint_handler(struct ext_code ext_code,
 398                                unsigned int param32, unsigned long param64)
 399 {
 400         struct virtqueue *vq;
 401         u32 param;
 402
 403         if ((ext_code.subcode & 0xff00) != VIRTIO_SUBCODE_64)
 404                 return;
 405         inc_irq_stat(IRQEXT_VRT);
 406
 407         /* The LSB might be overloaded, we have to mask it */
 408         vq = (struct virtqueue *)(param64 & ~1UL);
 409
 410         /* We use ext_params to decide what this interrupt means */
 411         param = param32 & VIRTIO_PARAM_MASK;
 412
 413         switch (param) {
 414         case VIRTIO_PARAM_CONFIG_CHANGED:
 415                 virtio_config_changed(vq->vdev);
 416                 break;
 417         case VIRTIO_PARAM_DEV_ADD:
 418                 schedule_work(&hotplug_work);
 419                 break;
 420         case VIRTIO_PARAM_VRING_INTERRUPT:
 421         default:
 422                 vring_interrupt(0, vq);
 423                 break;
 424         }
 425 }
 426
 427 /*
 428  * For s390-virtio, we expect a page above main storage containing
 429  * the virtio configuration. Try to actually load from this area
 430  * in order to figure out if the host provides this page.
 431  */
 432 static int __init test_devices_support(unsigned long addr)
 433 {
 434         int ret = -EIO;
 435
 436         asm volatile(
 437                 "0:     lura    0,%1\n"
 438                 "1:     xgr     %0,%0\n"
 439                 "2:\n"
 440                 EX_TABLE(0b,2b)
 441                 EX_TABLE(1b,2b)
 442                 : "+d" (ret)
 443                 : "a" (addr)
 444                 : "0", "cc");
 445         return ret;
 446 }
 447 /*
 448  * Init function for virtio
 449  * devices are in a single page above top of "normal" + standby mem
 450  */
 451 static int __init kvm_devices_init(void)
 452 {
 453         int rc;
 454         unsigned long total_memory_size = sclp.rzm * sclp.rnmax;
 455
 456         if (!MACHINE_IS_KVM)
 457                 return -ENODEV;
 458
 459         if (test_devices_support(total_memory_size) < 0)
 460                 return -ENODEV;
 461
 462         pr_warn("The s390-virtio transport is deprecated. Please switch to a modern host providing virtio-ccw.\n");
 463
 464         rc = vmem_add_mapping(total_memory_size, PAGE_SIZE);
 465         if (rc)
 466                 return rc;
 467
 468         kvm_devices = (void *) total_memory_size;
 469
 470         kvm_root = root_device_register("kvm_s390");
 471         if (IS_ERR(kvm_root)) {
 472                 rc = PTR_ERR(kvm_root);
 473                 printk(KERN_ERR "Could not register kvm_s390 root device");
 474                 vmem_remove_mapping(total_memory_size, PAGE_SIZE);
 475                 return rc;
 476         }
 477
 478         INIT_WORK(&hotplug_work, hotplug_devices);
 479
 480         irq_subclass_register(IRQ_SUBCLASS_SERVICE_SIGNAL);
 481         register_external_irq(EXT_IRQ_CP_SERVICE, kvm_extint_handler);
 482
 483         scan_devices();
 484         return 0;
 485 }
 486
 487 /* code for early console output with virtio_console */
 488 static int early_put_chars(u32 vtermno, const char *buf, int count)
 489 {
 490         char scratch[17];
 491         unsigned int len = count;
 492
 493         if (len > sizeof(scratch) - 1)
 494                 len = sizeof(scratch) - 1;
 495         scratch[len] = '\0';
 496         memcpy(scratch, buf, len);
 497         kvm_hypercall1(KVM_S390_VIRTIO_NOTIFY, __pa(scratch));
 498         return len;
 499 }
 500
 501 static int __init s390_virtio_console_init(void)
 502 {
 503         if (sclp.has_vt220 || sclp.has_linemode)
 504                 return -ENODEV;
 505         return virtio_cons_early_init(early_put_chars);
 506 }
 507 console_initcall(s390_virtio_console_init);
 508
 509
 510 /*
 511  * We do this after core stuff, but before the drivers.
 512  */
 513 postcore_initcall(kvm_devices_init);