hw/ppc/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/hw.h"
  23 #include "sysemu/sysemu.h"
  24 #include "hw/boards.h"
  25 #include "monitor/monitor.h"
  26 #include "hw/loader.h"
  27 #include "elf.h"
  28 #include "hw/sysbus.h"
  29 #include "sysemu/kvm.h"
  30 #include "sysemu/device_tree.h"
  31 #include "kvm_ppc.h"
  32
  33 #include "hw/ppc/spapr.h"
  34 #include "hw/ppc/spapr_vio.h"
  35 #include "hw/ppc/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 char *spapr_vio_get_dev_name(DeviceState *qdev)
  57 {
  58     VIOsPAPRDevice *dev = VIO_SPAPR_DEVICE(qdev);
  59     VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
  60     char *name;
  61
  62     /* Device tree style name device@reg */
  63     name = g_strdup_printf("%s@%x", pc->dt_name, dev->reg);
  64
  65     return name;
  66 }
  67
  68 static void spapr_vio_bus_class_init(ObjectClass *klass, void *data)
  69 {
  70     BusClass *k = BUS_CLASS(klass);
  71
  72     k->get_dev_path = spapr_vio_get_dev_name;
  73 }
  74
  75 static const TypeInfo spapr_vio_bus_info = {
  76     .name = TYPE_SPAPR_VIO_BUS,
  77     .parent = TYPE_BUS,
  78     .class_init = spapr_vio_bus_class_init,
  79     .instance_size = sizeof(VIOsPAPRBus),
  80 };
  81
  82 VIOsPAPRDevice *spapr_vio_find_by_reg(VIOsPAPRBus *bus, uint32_t reg)
  83 {
  84     BusChild *kid;
  85     VIOsPAPRDevice *dev = NULL;
  86
  87     QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
  88         dev = (VIOsPAPRDevice *)kid->child;
  89         if (dev->reg == reg) {
  90             return dev;
  91         }
  92     }
  93
  94     return NULL;
  95 }
  96
  97 #ifdef CONFIG_FDT
  98 static int vio_make_devnode(VIOsPAPRDevice *dev,
  99                             void *fdt)
 100 {
 101     VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
 102     int vdevice_off, node_off, ret;
 103     char *dt_name;
 104
 105     vdevice_off = fdt_path_offset(fdt, "/vdevice");
 106     if (vdevice_off < 0) {
 107         return vdevice_off;
 108     }
 109
 110     dt_name = spapr_vio_get_dev_name(DEVICE(dev));
 111     node_off = fdt_add_subnode(fdt, vdevice_off, dt_name);
 112     g_free(dt_name);
 113     if (node_off < 0) {
 114         return node_off;
 115     }
 116
 117     ret = fdt_setprop_cell(fdt, node_off, "reg", dev->reg);
 118     if (ret < 0) {
 119         return ret;
 120     }
 121
 122     if (pc->dt_type) {
 123         ret = fdt_setprop_string(fdt, node_off, "device_type",
 124                                  pc->dt_type);
 125         if (ret < 0) {
 126             return ret;
 127         }
 128     }
 129
 130     if (pc->dt_compatible) {
 131         ret = fdt_setprop_string(fdt, node_off, "compatible",
 132                                  pc->dt_compatible);
 133         if (ret < 0) {
 134             return ret;
 135         }
 136     }
 137
 138     if (dev->irq) {
 139         uint32_t ints_prop[] = {cpu_to_be32(dev->irq), 0};
 140
 141         ret = fdt_setprop(fdt, node_off, "interrupts", ints_prop,
 142                           sizeof(ints_prop));
 143         if (ret < 0) {
 144             return ret;
 145         }
 146     }
 147
 148     ret = spapr_tcet_dma_dt(fdt, node_off, "ibm,my-dma-window", dev->dma);
 149     if (ret < 0) {
 150         return ret;
 151     }
 152
 153     if (pc->devnode) {
 154         ret = (pc->devnode)(dev, fdt, node_off);
 155         if (ret < 0) {
 156             return ret;
 157         }
 158     }
 159
 160     return node_off;
 161 }
 162 #endif /* CONFIG_FDT */
 163
 164 /*
 165  * CRQ handling
 166  */
 167 static target_ulong h_reg_crq(PowerPCCPU *cpu, sPAPREnvironment *spapr,
 168                               target_ulong opcode, target_ulong *args)
 169 {
 170     target_ulong reg = args[0];
 171     target_ulong queue_addr = args[1];
 172     target_ulong queue_len = args[2];
 173     VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
 174
 175     if (!dev) {
 176         hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
 177         return H_PARAMETER;
 178     }
 179
 180     /* We can't grok a queue size bigger than 256M for now */
 181     if (queue_len < 0x1000 || queue_len > 0x10000000) {
 182         hcall_dprintf("Queue size too small or too big (0x" TARGET_FMT_lx
 183                       ")\n", queue_len);
 184         return H_PARAMETER;
 185     }
 186
 187     /* Check queue alignment */
 188     if (queue_addr & 0xfff) {
 189         hcall_dprintf("Queue not aligned (0x" TARGET_FMT_lx ")\n", queue_addr);
 190         return H_PARAMETER;
 191     }
 192
 193     /* Check if device supports CRQs */
 194     if (!dev->crq.SendFunc) {
 195         hcall_dprintf("Device does not support CRQ\n");
 196         return H_NOT_FOUND;
 197     }
 198
 199     /* Already a queue ? */
 200     if (dev->crq.qsize) {
 201         hcall_dprintf("CRQ already registered\n");
 202         return H_RESOURCE;
 203     }
 204     dev->crq.qladdr = queue_addr;
 205     dev->crq.qsize = queue_len;
 206     dev->crq.qnext = 0;
 207
 208     dprintf("CRQ for dev 0x" TARGET_FMT_lx " registered at 0x"
 209             TARGET_FMT_lx "/0x" TARGET_FMT_lx "\n",
 210             reg, queue_addr, queue_len);
 211     return H_SUCCESS;
 212 }
 213
 214 static target_ulong free_crq(VIOsPAPRDevice *dev)
 215 {
 216     dev->crq.qladdr = 0;
 217     dev->crq.qsize = 0;
 218     dev->crq.qnext = 0;
 219
 220     dprintf("CRQ for dev 0x%" PRIx32 " freed\n", dev->reg);
 221
 222     return H_SUCCESS;
 223 }
 224
 225 static target_ulong h_free_crq(PowerPCCPU *cpu, sPAPREnvironment *spapr,
 226                                target_ulong opcode, target_ulong *args)
 227 {
 228     target_ulong reg = args[0];
 229     VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
 230
 231     if (!dev) {
 232         hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
 233         return H_PARAMETER;
 234     }
 235
 236     return free_crq(dev);
 237 }
 238
 239 static target_ulong h_send_crq(PowerPCCPU *cpu, sPAPREnvironment *spapr,
 240                                target_ulong opcode, target_ulong *args)
 241 {
 242     target_ulong reg = args[0];
 243     target_ulong msg_hi = args[1];
 244     target_ulong msg_lo = args[2];
 245     VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
 246     uint64_t crq_mangle[2];
 247
 248     if (!dev) {
 249         hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
 250         return H_PARAMETER;
 251     }
 252     crq_mangle[0] = cpu_to_be64(msg_hi);
 253     crq_mangle[1] = cpu_to_be64(msg_lo);
 254
 255     if (dev->crq.SendFunc) {
 256         return dev->crq.SendFunc(dev, (uint8_t *)crq_mangle);
 257     }
 258
 259     return H_HARDWARE;
 260 }
 261
 262 static target_ulong h_enable_crq(PowerPCCPU *cpu, sPAPREnvironment *spapr,
 263                                  target_ulong opcode, target_ulong *args)
 264 {
 265     target_ulong reg = args[0];
 266     VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
 267
 268     if (!dev) {
 269         hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
 270         return H_PARAMETER;
 271     }
 272
 273     return 0;
 274 }
 275
 276 /* Returns negative error, 0 success, or positive: queue full */
 277 int spapr_vio_send_crq(VIOsPAPRDevice *dev, uint8_t *crq)
 278 {
 279     int rc;
 280     uint8_t byte;
 281
 282     if (!dev->crq.qsize) {
 283         fprintf(stderr, "spapr_vio_send_creq on uninitialized queue\n");
 284         return -1;
 285     }
 286
 287     /* Maybe do a fast path for KVM just writing to the pages */
 288     rc = spapr_vio_dma_read(dev, dev->crq.qladdr + dev->crq.qnext, &byte, 1);
 289     if (rc) {
 290         return rc;
 291     }
 292     if (byte != 0) {
 293         return 1;
 294     }
 295
 296     rc = spapr_vio_dma_write(dev, dev->crq.qladdr + dev->crq.qnext + 8,
 297                              &crq[8], 8);
 298     if (rc) {
 299         return rc;
 300     }
 301
 302     kvmppc_eieio();
 303
 304     rc = spapr_vio_dma_write(dev, dev->crq.qladdr + dev->crq.qnext, crq, 8);
 305     if (rc) {
 306         return rc;
 307     }
 308
 309     dev->crq.qnext = (dev->crq.qnext + 16) % dev->crq.qsize;
 310
 311     if (dev->signal_state & 1) {
 312         qemu_irq_pulse(spapr_vio_qirq(dev));
 313     }
 314
 315     return 0;
 316 }
 317
 318 /* "quiesce" handling */
 319
 320 static void spapr_vio_quiesce_one(VIOsPAPRDevice *dev)
 321 {
 322     if (dev->dma) {
 323         spapr_tce_reset(dev->dma);
 324     }
 325     free_crq(dev);
 326 }
 327
 328 static void rtas_set_tce_bypass(sPAPREnvironment *spapr, uint32_t token,
 329                                 uint32_t nargs, target_ulong args,
 330                                 uint32_t nret, target_ulong rets)
 331 {
 332     VIOsPAPRBus *bus = spapr->vio_bus;
 333     VIOsPAPRDevice *dev;
 334     uint32_t unit, enable;
 335
 336     if (nargs != 2) {
 337         rtas_st(rets, 0, -3);
 338         return;
 339     }
 340     unit = rtas_ld(args, 0);
 341     enable = rtas_ld(args, 1);
 342     dev = spapr_vio_find_by_reg(bus, unit);
 343     if (!dev) {
 344         rtas_st(rets, 0, -3);
 345         return;
 346     }
 347
 348     if (!dev->dma) {
 349         rtas_st(rets, 0, -3);
 350         return;
 351     }
 352
 353     spapr_tce_set_bypass(dev->dma, !!enable);
 354
 355     rtas_st(rets, 0, 0);
 356 }
 357
 358 static void rtas_quiesce(sPAPREnvironment *spapr, uint32_t token,
 359                          uint32_t nargs, target_ulong args,
 360                          uint32_t nret, target_ulong rets)
 361 {
 362     VIOsPAPRBus *bus = spapr->vio_bus;
 363     BusChild *kid;
 364     VIOsPAPRDevice *dev = NULL;
 365
 366     if (nargs != 0) {
 367         rtas_st(rets, 0, -3);
 368         return;
 369     }
 370
 371     QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
 372         dev = (VIOsPAPRDevice *)kid->child;
 373         spapr_vio_quiesce_one(dev);
 374     }
 375
 376     rtas_st(rets, 0, 0);
 377 }
 378
 379 static VIOsPAPRDevice *reg_conflict(VIOsPAPRDevice *dev)
 380 {
 381     VIOsPAPRBus *bus = DO_UPCAST(VIOsPAPRBus, bus, dev->qdev.parent_bus);
 382     BusChild *kid;
 383     VIOsPAPRDevice *other;
 384
 385     /*
 386      * Check for a device other than the given one which is already
 387      * using the requested address. We have to open code this because
 388      * the given dev might already be in the list.
 389      */
 390     QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
 391         other = VIO_SPAPR_DEVICE(kid->child);
 392
 393         if (other != dev && other->reg == dev->reg) {
 394             return other;
 395         }
 396     }
 397
 398     return 0;
 399 }
 400
 401 static void spapr_vio_busdev_reset(DeviceState *qdev)
 402 {
 403     VIOsPAPRDevice *dev = VIO_SPAPR_DEVICE(qdev);
 404     VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
 405
 406     /* Shut down the request queue and TCEs if necessary */
 407     spapr_vio_quiesce_one(dev);
 408
 409     dev->signal_state = 0;
 410
 411     if (pc->reset) {
 412         pc->reset(dev);
 413     }
 414 }
 415
 416 static int spapr_vio_busdev_init(DeviceState *qdev)
 417 {
 418     VIOsPAPRDevice *dev = (VIOsPAPRDevice *)qdev;
 419     VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
 420     char *id;
 421
 422     if (dev->reg != -1) {
 423         /*
 424          * Explicitly assigned address, just verify that no-one else
 425          * is using it.  other mechanism). We have to open code this
 426          * rather than using spapr_vio_find_by_reg() because sdev
 427          * itself is already in the list.
 428          */
 429         VIOsPAPRDevice *other = reg_conflict(dev);
 430
 431         if (other) {
 432             fprintf(stderr, "vio: %s and %s devices conflict at address %#x\n",
 433                     object_get_typename(OBJECT(qdev)),
 434                     object_get_typename(OBJECT(&other->qdev)),
 435                     dev->reg);
 436             return -1;
 437         }
 438     } else {
 439         /* Need to assign an address */
 440         VIOsPAPRBus *bus = DO_UPCAST(VIOsPAPRBus, bus, dev->qdev.parent_bus);
 441
 442         do {
 443             dev->reg = bus->next_reg++;
 444         } while (reg_conflict(dev));
 445     }
 446
 447     /* Don't overwrite ids assigned on the command line */
 448     if (!dev->qdev.id) {
 449         id = spapr_vio_get_dev_name(DEVICE(dev));
 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(PowerPCCPU *cpu, 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 = 0x71000000;
 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 const 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 const 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 = spapr_vio_get_dev_name(DEVICE(dev));
 649     path = g_strdup_printf("/vdevice/%s", name);
 650
 651     ret = fdt_setprop_string(fdt, offset, "linux,stdout-path", path);
 652
 653     g_free(name);
 654     g_free(path);
 655
 656     return ret;
 657 }
 658 #endif /* CONFIG_FDT */