hw/spapr_vio.c

   1 /*
   2  * QEMU sPAPR VIO code
   3  *
   4  * Copyright (c) 2010 David Gibson, IBM Corporation <dwg@au1.ibm.com>
   5  * Based on the s390 virtio bus code:
   6  * Copyright (c) 2009 Alexander Graf <agraf@suse.de>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include "hw.h"
  23 #include "sysemu.h"
  24 #include "boards.h"
  25 #include "monitor.h"
  26 #include "loader.h"
  27 #include "elf.h"
  28 #include "hw/sysbus.h"
  29 #include "kvm.h"
  30 #include "device_tree.h"
  31 #include "kvm_ppc.h"
  32
  33 #include "hw/spapr.h"
  34 #include "hw/spapr_vio.h"
  35 #include "hw/xics.h"
  36
  37 #ifdef CONFIG_FDT
  38 #include <libfdt.h>
  39 #endif /* CONFIG_FDT */
  40
  41 /* #define DEBUG_SPAPR */
  42
  43 #ifdef DEBUG_SPAPR
  44 #define dprintf(fmt, ...) \
  45     do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
  46 #else
  47 #define dprintf(fmt, ...) \
  48     do { } while (0)
  49 #endif
  50
  51 static Property spapr_vio_props[] = {
  52     DEFINE_PROP_UINT32("irq", VIOsPAPRDevice, irq, 0), \
  53     DEFINE_PROP_END_OF_LIST(),
  54 };
  55
  56 static const TypeInfo spapr_vio_bus_info = {
  57     .name = TYPE_SPAPR_VIO_BUS,
  58     .parent = TYPE_BUS,
  59     .instance_size = sizeof(VIOsPAPRBus),
  60 };
  61
  62 VIOsPAPRDevice *spapr_vio_find_by_reg(VIOsPAPRBus *bus, uint32_t reg)
  63 {
  64     BusChild *kid;
  65     VIOsPAPRDevice *dev = NULL;
  66
  67     QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
  68         dev = (VIOsPAPRDevice *)kid->child;
  69         if (dev->reg == reg) {
  70             return dev;
  71         }
  72     }
  73
  74     return NULL;
  75 }
  76
  77 static char *vio_format_dev_name(VIOsPAPRDevice *dev)
  78 {
  79     VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
  80     char *name;
  81
  82     /* Device tree style name device@reg */
  83     if (asprintf(&name, "%s@%x", pc->dt_name, dev->reg) < 0) {
  84         return NULL;
  85     }
  86
  87     return name;
  88 }
  89
  90 #ifdef CONFIG_FDT
  91 static int vio_make_devnode(VIOsPAPRDevice *dev,
  92                             void *fdt)
  93 {
  94     VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
  95     int vdevice_off, node_off, ret;
  96     char *dt_name;
  97
  98     vdevice_off = fdt_path_offset(fdt, "/vdevice");
  99     if (vdevice_off < 0) {
 100         return vdevice_off;
 101     }
 102
 103     dt_name = vio_format_dev_name(dev);
 104     if (!dt_name) {
 105         return -ENOMEM;
 106     }
 107
 108     node_off = fdt_add_subnode(fdt, vdevice_off, dt_name);
 109     free(dt_name);
 110     if (node_off < 0) {
 111         return node_off;
 112     }
 113
 114     ret = fdt_setprop_cell(fdt, node_off, "reg", dev->reg);
 115     if (ret < 0) {
 116         return ret;
 117     }
 118
 119     if (pc->dt_type) {
 120         ret = fdt_setprop_string(fdt, node_off, "device_type",
 121                                  pc->dt_type);
 122         if (ret < 0) {
 123             return ret;
 124         }
 125     }
 126
 127     if (pc->dt_compatible) {
 128         ret = fdt_setprop_string(fdt, node_off, "compatible",
 129                                  pc->dt_compatible);
 130         if (ret < 0) {
 131             return ret;
 132         }
 133     }
 134
 135     if (dev->irq) {
 136         uint32_t ints_prop[] = {cpu_to_be32(dev->irq), 0};
 137
 138         ret = fdt_setprop(fdt, node_off, "interrupts", ints_prop,
 139                           sizeof(ints_prop));
 140         if (ret < 0) {
 141             return ret;
 142         }
 143     }
 144
 145     ret = spapr_tcet_dma_dt(fdt, node_off, "ibm,my-dma-window", dev->dma);
 146     if (ret < 0) {
 147         return ret;
 148     }
 149
 150     if (pc->devnode) {
 151         ret = (pc->devnode)(dev, fdt, node_off);
 152         if (ret < 0) {
 153             return ret;
 154         }
 155     }
 156
 157     return node_off;
 158 }
 159 #endif /* CONFIG_FDT */
 160
 161 /*
 162  * CRQ handling
 163  */
 164 static target_ulong h_reg_crq(CPUPPCState *env, sPAPREnvironment *spapr,
 165                               target_ulong opcode, target_ulong *args)
 166 {
 167     target_ulong reg = args[0];
 168     target_ulong queue_addr = args[1];
 169     target_ulong queue_len = args[2];
 170     VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
 171
 172     if (!dev) {
 173         hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
 174         return H_PARAMETER;
 175     }
 176
 177     /* We can't grok a queue size bigger than 256M for now */
 178     if (queue_len < 0x1000 || queue_len > 0x10000000) {
 179         hcall_dprintf("Queue size too small or too big (0x" TARGET_FMT_lx
 180                       ")\n", queue_len);
 181         return H_PARAMETER;
 182     }
 183
 184     /* Check queue alignment */
 185     if (queue_addr & 0xfff) {
 186         hcall_dprintf("Queue not aligned (0x" TARGET_FMT_lx ")\n", queue_addr);
 187         return H_PARAMETER;
 188     }
 189
 190     /* Check if device supports CRQs */
 191     if (!dev->crq.SendFunc) {
 192         hcall_dprintf("Device does not support CRQ\n");
 193         return H_NOT_FOUND;
 194     }
 195
 196     /* Already a queue ? */
 197     if (dev->crq.qsize) {
 198         hcall_dprintf("CRQ already registered\n");
 199         return H_RESOURCE;
 200     }
 201     dev->crq.qladdr = queue_addr;
 202     dev->crq.qsize = queue_len;
 203     dev->crq.qnext = 0;
 204
 205     dprintf("CRQ for dev 0x" TARGET_FMT_lx " registered at 0x"
 206             TARGET_FMT_lx "/0x" TARGET_FMT_lx "\n",
 207             reg, queue_addr, queue_len);
 208     return H_SUCCESS;
 209 }
 210
 211 static target_ulong free_crq(VIOsPAPRDevice *dev)
 212 {
 213     dev->crq.qladdr = 0;
 214     dev->crq.qsize = 0;
 215     dev->crq.qnext = 0;
 216
 217     dprintf("CRQ for dev 0x%" PRIx32 " freed\n", dev->reg);
 218
 219     return H_SUCCESS;
 220 }
 221
 222 static target_ulong h_free_crq(CPUPPCState *env, sPAPREnvironment *spapr,
 223                                target_ulong opcode, target_ulong *args)
 224 {
 225     target_ulong reg = args[0];
 226     VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
 227
 228     if (!dev) {
 229         hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
 230         return H_PARAMETER;
 231     }
 232
 233     return free_crq(dev);
 234 }
 235
 236 static target_ulong h_send_crq(CPUPPCState *env, sPAPREnvironment *spapr,
 237                                target_ulong opcode, target_ulong *args)
 238 {
 239     target_ulong reg = args[0];
 240     target_ulong msg_hi = args[1];
 241     target_ulong msg_lo = args[2];
 242     VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
 243     uint64_t crq_mangle[2];
 244
 245     if (!dev) {
 246         hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
 247         return H_PARAMETER;
 248     }
 249     crq_mangle[0] = cpu_to_be64(msg_hi);
 250     crq_mangle[1] = cpu_to_be64(msg_lo);
 251
 252     if (dev->crq.SendFunc) {
 253         return dev->crq.SendFunc(dev, (uint8_t *)crq_mangle);
 254     }
 255
 256     return H_HARDWARE;
 257 }
 258
 259 static target_ulong h_enable_crq(CPUPPCState *env, sPAPREnvironment *spapr,
 260                                  target_ulong opcode, target_ulong *args)
 261 {
 262     target_ulong reg = args[0];
 263     VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
 264
 265     if (!dev) {
 266         hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
 267         return H_PARAMETER;
 268     }
 269
 270     return 0;
 271 }
 272
 273 /* Returns negative error, 0 success, or positive: queue full */
 274 int spapr_vio_send_crq(VIOsPAPRDevice *dev, uint8_t *crq)
 275 {
 276     int rc;
 277     uint8_t byte;
 278
 279     if (!dev->crq.qsize) {
 280         fprintf(stderr, "spapr_vio_send_creq on uninitialized queue\n");
 281         return -1;
 282     }
 283
 284     /* Maybe do a fast path for KVM just writing to the pages */
 285     rc = spapr_vio_dma_read(dev, dev->crq.qladdr + dev->crq.qnext, &byte, 1);
 286     if (rc) {
 287         return rc;
 288     }
 289     if (byte != 0) {
 290         return 1;
 291     }
 292
 293     rc = spapr_vio_dma_write(dev, dev->crq.qladdr + dev->crq.qnext + 8,
 294                              &crq[8], 8);
 295     if (rc) {
 296         return rc;
 297     }
 298
 299     kvmppc_eieio();
 300
 301     rc = spapr_vio_dma_write(dev, dev->crq.qladdr + dev->crq.qnext, crq, 8);
 302     if (rc) {
 303         return rc;
 304     }
 305
 306     dev->crq.qnext = (dev->crq.qnext + 16) % dev->crq.qsize;
 307
 308     if (dev->signal_state & 1) {
 309         qemu_irq_pulse(spapr_vio_qirq(dev));
 310     }
 311
 312     return 0;
 313 }
 314
 315 /* "quiesce" handling */
 316
 317 static void spapr_vio_quiesce_one(VIOsPAPRDevice *dev)
 318 {
 319     if (dev->dma) {
 320         spapr_tce_reset(dev->dma);
 321     }
 322     free_crq(dev);
 323 }
 324
 325 static void rtas_set_tce_bypass(sPAPREnvironment *spapr, uint32_t token,
 326                                 uint32_t nargs, target_ulong args,
 327                                 uint32_t nret, target_ulong rets)
 328 {
 329     VIOsPAPRBus *bus = spapr->vio_bus;
 330     VIOsPAPRDevice *dev;
 331     uint32_t unit, enable;
 332
 333     if (nargs != 2) {
 334         rtas_st(rets, 0, -3);
 335         return;
 336     }
 337     unit = rtas_ld(args, 0);
 338     enable = rtas_ld(args, 1);
 339     dev = spapr_vio_find_by_reg(bus, unit);
 340     if (!dev) {
 341         rtas_st(rets, 0, -3);
 342         return;
 343     }
 344
 345     if (!dev->dma) {
 346         rtas_st(rets, 0, -3);
 347         return;
 348     }
 349
 350     spapr_tce_set_bypass(dev->dma, !!enable);
 351
 352     rtas_st(rets, 0, 0);
 353 }
 354
 355 static void rtas_quiesce(sPAPREnvironment *spapr, uint32_t token,
 356                          uint32_t nargs, target_ulong args,
 357                          uint32_t nret, target_ulong rets)
 358 {
 359     VIOsPAPRBus *bus = spapr->vio_bus;
 360     BusChild *kid;
 361     VIOsPAPRDevice *dev = NULL;
 362
 363     if (nargs != 0) {
 364         rtas_st(rets, 0, -3);
 365         return;
 366     }
 367
 368     QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
 369         dev = (VIOsPAPRDevice *)kid->child;
 370         spapr_vio_quiesce_one(dev);
 371     }
 372
 373     rtas_st(rets, 0, 0);
 374 }
 375
 376 static VIOsPAPRDevice *reg_conflict(VIOsPAPRDevice *dev)
 377 {
 378     VIOsPAPRBus *bus = DO_UPCAST(VIOsPAPRBus, bus, dev->qdev.parent_bus);
 379     BusChild *kid;
 380     VIOsPAPRDevice *other;
 381
 382     /*
 383      * Check for a device other than the given one which is already
 384      * using the requested address. We have to open code this because
 385      * the given dev might already be in the list.
 386      */
 387     QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
 388         other = DO_UPCAST(VIOsPAPRDevice, qdev, kid->child);
 389
 390         if (other != dev && other->reg == dev->reg) {
 391             return other;
 392         }
 393     }
 394
 395     return 0;
 396 }
 397
 398 static void spapr_vio_busdev_reset(DeviceState *qdev)
 399 {
 400     VIOsPAPRDevice *dev = DO_UPCAST(VIOsPAPRDevice, qdev, qdev);
 401     VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
 402
 403     /* Shut down the request queue and TCEs if necessary */
 404     spapr_vio_quiesce_one(dev);
 405
 406     dev->signal_state = 0;
 407
 408     if (pc->reset) {
 409         pc->reset(dev);
 410     }
 411 }
 412
 413 static int spapr_vio_busdev_init(DeviceState *qdev)
 414 {
 415     VIOsPAPRDevice *dev = (VIOsPAPRDevice *)qdev;
 416     VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
 417     char *id;
 418
 419     if (dev->reg != -1) {
 420         /*
 421          * Explicitly assigned address, just verify that no-one else
 422          * is using it.  other mechanism). We have to open code this
 423          * rather than using spapr_vio_find_by_reg() because sdev
 424          * itself is already in the list.
 425          */
 426         VIOsPAPRDevice *other = reg_conflict(dev);
 427
 428         if (other) {
 429             fprintf(stderr, "vio: %s and %s devices conflict at address %#x\n",
 430                     object_get_typename(OBJECT(qdev)),
 431                     object_get_typename(OBJECT(&other->qdev)),
 432                     dev->reg);
 433             return -1;
 434         }
 435     } else {
 436         /* Need to assign an address */
 437         VIOsPAPRBus *bus = DO_UPCAST(VIOsPAPRBus, bus, dev->qdev.parent_bus);
 438
 439         do {
 440             dev->reg = bus->next_reg++;
 441         } while (reg_conflict(dev));
 442     }
 443
 444     /* Don't overwrite ids assigned on the command line */
 445     if (!dev->qdev.id) {
 446         id = vio_format_dev_name(dev);
 447         if (!id) {
 448             return -1;
 449         }
 450         dev->qdev.id = id;
 451     }
 452
 453     dev->irq = spapr_allocate_msi(dev->irq);
 454     if (!dev->irq) {
 455         return -1;
 456     }
 457
 458     if (pc->rtce_window_size) {
 459         uint32_t liobn = SPAPR_VIO_BASE_LIOBN | dev->reg;
 460         dev->dma = spapr_tce_new_dma_context(liobn, pc->rtce_window_size);
 461     }
 462
 463     return pc->init(dev);
 464 }
 465
 466 static target_ulong h_vio_signal(CPUPPCState *env, sPAPREnvironment *spapr,
 467                                  target_ulong opcode,
 468                                  target_ulong *args)
 469 {
 470     target_ulong reg = args[0];
 471     target_ulong mode = args[1];
 472     VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
 473     VIOsPAPRDeviceClass *pc;
 474
 475     if (!dev) {
 476         return H_PARAMETER;
 477     }
 478
 479     pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
 480
 481     if (mode & ~pc->signal_mask) {
 482         return H_PARAMETER;
 483     }
 484
 485     dev->signal_state = mode;
 486
 487     return H_SUCCESS;
 488 }
 489
 490 VIOsPAPRBus *spapr_vio_bus_init(void)
 491 {
 492     VIOsPAPRBus *bus;
 493     BusState *qbus;
 494     DeviceState *dev;
 495
 496     /* Create bridge device */
 497     dev = qdev_create(NULL, "spapr-vio-bridge");
 498     qdev_init_nofail(dev);
 499
 500     /* Create bus on bridge device */
 501
 502     qbus = qbus_create(TYPE_SPAPR_VIO_BUS, dev, "spapr-vio");
 503     bus = DO_UPCAST(VIOsPAPRBus, bus, qbus);
 504     bus->next_reg = 0x1000;
 505
 506     /* hcall-vio */
 507     spapr_register_hypercall(H_VIO_SIGNAL, h_vio_signal);
 508
 509     /* hcall-crq */
 510     spapr_register_hypercall(H_REG_CRQ, h_reg_crq);
 511     spapr_register_hypercall(H_FREE_CRQ, h_free_crq);
 512     spapr_register_hypercall(H_SEND_CRQ, h_send_crq);
 513     spapr_register_hypercall(H_ENABLE_CRQ, h_enable_crq);
 514
 515     /* RTAS calls */
 516     spapr_rtas_register("ibm,set-tce-bypass", rtas_set_tce_bypass);
 517     spapr_rtas_register("quiesce", rtas_quiesce);
 518
 519     return bus;
 520 }
 521
 522 /* Represents sPAPR hcall VIO devices */
 523
 524 static int spapr_vio_bridge_init(SysBusDevice *dev)
 525 {
 526     /* nothing */
 527     return 0;
 528 }
 529
 530 static void spapr_vio_bridge_class_init(ObjectClass *klass, void *data)
 531 {
 532     DeviceClass *dc = DEVICE_CLASS(klass);
 533     SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
 534
 535     k->init = spapr_vio_bridge_init;
 536     dc->no_user = 1;
 537 }
 538
 539 static TypeInfo spapr_vio_bridge_info = {
 540     .name          = "spapr-vio-bridge",
 541     .parent        = TYPE_SYS_BUS_DEVICE,
 542     .instance_size = sizeof(SysBusDevice),
 543     .class_init    = spapr_vio_bridge_class_init,
 544 };
 545
 546 static void vio_spapr_device_class_init(ObjectClass *klass, void *data)
 547 {
 548     DeviceClass *k = DEVICE_CLASS(klass);
 549     k->init = spapr_vio_busdev_init;
 550     k->reset = spapr_vio_busdev_reset;
 551     k->bus_type = TYPE_SPAPR_VIO_BUS;
 552     k->props = spapr_vio_props;
 553 }
 554
 555 static TypeInfo spapr_vio_type_info = {
 556     .name = TYPE_VIO_SPAPR_DEVICE,
 557     .parent = TYPE_DEVICE,
 558     .instance_size = sizeof(VIOsPAPRDevice),
 559     .abstract = true,
 560     .class_size = sizeof(VIOsPAPRDeviceClass),
 561     .class_init = vio_spapr_device_class_init,
 562 };
 563
 564 static void spapr_vio_register_types(void)
 565 {
 566     type_register_static(&spapr_vio_bus_info);
 567     type_register_static(&spapr_vio_bridge_info);
 568     type_register_static(&spapr_vio_type_info);
 569 }
 570
 571 type_init(spapr_vio_register_types)
 572
 573 #ifdef CONFIG_FDT
 574 static int compare_reg(const void *p1, const void *p2)
 575 {
 576     VIOsPAPRDevice const *dev1, *dev2;
 577
 578     dev1 = (VIOsPAPRDevice *)*(DeviceState **)p1;
 579     dev2 = (VIOsPAPRDevice *)*(DeviceState **)p2;
 580
 581     if (dev1->reg < dev2->reg) {
 582         return -1;
 583     }
 584     if (dev1->reg == dev2->reg) {
 585         return 0;
 586     }
 587
 588     /* dev1->reg > dev2->reg */
 589     return 1;
 590 }
 591
 592 int spapr_populate_vdevice(VIOsPAPRBus *bus, void *fdt)
 593 {
 594     DeviceState *qdev, **qdevs;
 595     BusChild *kid;
 596     int i, num, ret = 0;
 597
 598     /* Count qdevs on the bus list */
 599     num = 0;
 600     QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
 601         num++;
 602     }
 603
 604     /* Copy out into an array of pointers */
 605     qdevs = g_malloc(sizeof(qdev) * num);
 606     num = 0;
 607     QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
 608         qdevs[num++] = kid->child;
 609     }
 610
 611     /* Sort the array */
 612     qsort(qdevs, num, sizeof(qdev), compare_reg);
 613
 614     /* Hack alert. Give the devices to libfdt in reverse order, we happen
 615      * to know that will mean they are in forward order in the tree. */
 616     for (i = num - 1; i >= 0; i--) {
 617         VIOsPAPRDevice *dev = (VIOsPAPRDevice *)(qdevs[i]);
 618
 619         ret = vio_make_devnode(dev, fdt);
 620
 621         if (ret < 0) {
 622             goto out;
 623         }
 624     }
 625
 626     ret = 0;
 627 out:
 628     free(qdevs);
 629
 630     return ret;
 631 }
 632
 633 int spapr_populate_chosen_stdout(void *fdt, VIOsPAPRBus *bus)
 634 {
 635     VIOsPAPRDevice *dev;
 636     char *name, *path;
 637     int ret, offset;
 638
 639     dev = spapr_vty_get_default(bus);
 640     if (!dev)
 641         return 0;
 642
 643     offset = fdt_path_offset(fdt, "/chosen");
 644     if (offset < 0) {
 645         return offset;
 646     }
 647
 648     name = vio_format_dev_name(dev);
 649     if (!name) {
 650         return -ENOMEM;
 651     }
 652
 653     if (asprintf(&path, "/vdevice/%s", name) < 0) {
 654         path = NULL;
 655         ret = -ENOMEM;
 656         goto out;
 657     }
 658
 659     ret = fdt_setprop_string(fdt, offset, "linux,stdout-path", path);
 660 out:
 661     free(name);
 662     free(path);
 663
 664     return ret;
 665 }
 666 #endif /* CONFIG_FDT */