Merge remote-tracking branch 'remotes/bonzini/tags/for-upstream' into staging
[qemu/qmp-unstable.git] / hw / ppc / spapr_vio.c
blob1360b97ab07416c482788951345173dde37204fa
1 /*
2 * QEMU sPAPR VIO code
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>
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.
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.
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/>.
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"
33 #include "hw/ppc/spapr.h"
34 #include "hw/ppc/spapr_vio.h"
35 #include "hw/ppc/xics.h"
37 #include <libfdt.h>
39 /* #define DEBUG_SPAPR */
41 #ifdef DEBUG_SPAPR
42 #define DPRINTF(fmt, ...) \
43 do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
44 #else
45 #define DPRINTF(fmt, ...) \
46 do { } while (0)
47 #endif
49 static Property spapr_vio_props[] = {
50 DEFINE_PROP_UINT32("irq", VIOsPAPRDevice, irq, 0), \
51 DEFINE_PROP_END_OF_LIST(),
54 static char *spapr_vio_get_dev_name(DeviceState *qdev)
56 VIOsPAPRDevice *dev = VIO_SPAPR_DEVICE(qdev);
57 VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
58 char *name;
60 /* Device tree style name device@reg */
61 name = g_strdup_printf("%s@%x", pc->dt_name, dev->reg);
63 return name;
66 static void spapr_vio_bus_class_init(ObjectClass *klass, void *data)
68 BusClass *k = BUS_CLASS(klass);
70 k->get_dev_path = spapr_vio_get_dev_name;
71 k->get_fw_dev_path = spapr_vio_get_dev_name;
74 static const TypeInfo spapr_vio_bus_info = {
75 .name = TYPE_SPAPR_VIO_BUS,
76 .parent = TYPE_BUS,
77 .class_init = spapr_vio_bus_class_init,
78 .instance_size = sizeof(VIOsPAPRBus),
81 VIOsPAPRDevice *spapr_vio_find_by_reg(VIOsPAPRBus *bus, uint32_t reg)
83 BusChild *kid;
84 VIOsPAPRDevice *dev = NULL;
86 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
87 dev = (VIOsPAPRDevice *)kid->child;
88 if (dev->reg == reg) {
89 return dev;
93 return NULL;
96 static int vio_make_devnode(VIOsPAPRDevice *dev,
97 void *fdt)
99 VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
100 int vdevice_off, node_off, ret;
101 char *dt_name;
103 vdevice_off = fdt_path_offset(fdt, "/vdevice");
104 if (vdevice_off < 0) {
105 return vdevice_off;
108 dt_name = spapr_vio_get_dev_name(DEVICE(dev));
109 node_off = fdt_add_subnode(fdt, vdevice_off, dt_name);
110 g_free(dt_name);
111 if (node_off < 0) {
112 return node_off;
115 ret = fdt_setprop_cell(fdt, node_off, "reg", dev->reg);
116 if (ret < 0) {
117 return ret;
120 if (pc->dt_type) {
121 ret = fdt_setprop_string(fdt, node_off, "device_type",
122 pc->dt_type);
123 if (ret < 0) {
124 return ret;
128 if (pc->dt_compatible) {
129 ret = fdt_setprop_string(fdt, node_off, "compatible",
130 pc->dt_compatible);
131 if (ret < 0) {
132 return ret;
136 if (dev->irq) {
137 uint32_t ints_prop[] = {cpu_to_be32(dev->irq), 0};
139 ret = fdt_setprop(fdt, node_off, "interrupts", ints_prop,
140 sizeof(ints_prop));
141 if (ret < 0) {
142 return ret;
146 ret = spapr_tcet_dma_dt(fdt, node_off, "ibm,my-dma-window", dev->tcet);
147 if (ret < 0) {
148 return ret;
151 if (pc->devnode) {
152 ret = (pc->devnode)(dev, fdt, node_off);
153 if (ret < 0) {
154 return ret;
158 return node_off;
162 * CRQ handling
164 static target_ulong h_reg_crq(PowerPCCPU *cpu, sPAPREnvironment *spapr,
165 target_ulong opcode, target_ulong *args)
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);
172 if (!dev) {
173 hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
174 return H_PARAMETER;
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;
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;
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;
196 /* Already a queue ? */
197 if (dev->crq.qsize) {
198 hcall_dprintf("CRQ already registered\n");
199 return H_RESOURCE;
201 dev->crq.qladdr = queue_addr;
202 dev->crq.qsize = queue_len;
203 dev->crq.qnext = 0;
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;
211 static target_ulong free_crq(VIOsPAPRDevice *dev)
213 dev->crq.qladdr = 0;
214 dev->crq.qsize = 0;
215 dev->crq.qnext = 0;
217 DPRINTF("CRQ for dev 0x%" PRIx32 " freed\n", dev->reg);
219 return H_SUCCESS;
222 static target_ulong h_free_crq(PowerPCCPU *cpu, sPAPREnvironment *spapr,
223 target_ulong opcode, target_ulong *args)
225 target_ulong reg = args[0];
226 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
228 if (!dev) {
229 hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
230 return H_PARAMETER;
233 return free_crq(dev);
236 static target_ulong h_send_crq(PowerPCCPU *cpu, sPAPREnvironment *spapr,
237 target_ulong opcode, target_ulong *args)
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];
245 if (!dev) {
246 hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
247 return H_PARAMETER;
249 crq_mangle[0] = cpu_to_be64(msg_hi);
250 crq_mangle[1] = cpu_to_be64(msg_lo);
252 if (dev->crq.SendFunc) {
253 return dev->crq.SendFunc(dev, (uint8_t *)crq_mangle);
256 return H_HARDWARE;
259 static target_ulong h_enable_crq(PowerPCCPU *cpu, sPAPREnvironment *spapr,
260 target_ulong opcode, target_ulong *args)
262 target_ulong reg = args[0];
263 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
265 if (!dev) {
266 hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
267 return H_PARAMETER;
270 return 0;
273 /* Returns negative error, 0 success, or positive: queue full */
274 int spapr_vio_send_crq(VIOsPAPRDevice *dev, uint8_t *crq)
276 int rc;
277 uint8_t byte;
279 if (!dev->crq.qsize) {
280 fprintf(stderr, "spapr_vio_send_creq on uninitialized queue\n");
281 return -1;
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;
289 if (byte != 0) {
290 return 1;
293 rc = spapr_vio_dma_write(dev, dev->crq.qladdr + dev->crq.qnext + 8,
294 &crq[8], 8);
295 if (rc) {
296 return rc;
299 kvmppc_eieio();
301 rc = spapr_vio_dma_write(dev, dev->crq.qladdr + dev->crq.qnext, crq, 8);
302 if (rc) {
303 return rc;
306 dev->crq.qnext = (dev->crq.qnext + 16) % dev->crq.qsize;
308 if (dev->signal_state & 1) {
309 qemu_irq_pulse(spapr_vio_qirq(dev));
312 return 0;
315 /* "quiesce" handling */
317 static void spapr_vio_quiesce_one(VIOsPAPRDevice *dev)
319 if (dev->tcet) {
320 device_reset(DEVICE(dev->tcet));
322 free_crq(dev);
325 void spapr_vio_set_bypass(VIOsPAPRDevice *dev, bool bypass)
327 if (!dev->tcet) {
328 return;
331 memory_region_set_enabled(&dev->mrbypass, bypass);
332 memory_region_set_enabled(spapr_tce_get_iommu(dev->tcet), !bypass);
334 dev->tcet->bypass = bypass;
337 static void rtas_set_tce_bypass(PowerPCCPU *cpu, sPAPREnvironment *spapr,
338 uint32_t token,
339 uint32_t nargs, target_ulong args,
340 uint32_t nret, target_ulong rets)
342 VIOsPAPRBus *bus = spapr->vio_bus;
343 VIOsPAPRDevice *dev;
344 uint32_t unit, enable;
346 if (nargs != 2) {
347 rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
348 return;
350 unit = rtas_ld(args, 0);
351 enable = rtas_ld(args, 1);
352 dev = spapr_vio_find_by_reg(bus, unit);
353 if (!dev) {
354 rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
355 return;
358 if (!dev->tcet) {
359 rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
360 return;
363 spapr_vio_set_bypass(dev, !!enable);
365 rtas_st(rets, 0, RTAS_OUT_SUCCESS);
368 static void rtas_quiesce(PowerPCCPU *cpu, sPAPREnvironment *spapr,
369 uint32_t token,
370 uint32_t nargs, target_ulong args,
371 uint32_t nret, target_ulong rets)
373 VIOsPAPRBus *bus = spapr->vio_bus;
374 BusChild *kid;
375 VIOsPAPRDevice *dev = NULL;
377 if (nargs != 0) {
378 rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
379 return;
382 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
383 dev = (VIOsPAPRDevice *)kid->child;
384 spapr_vio_quiesce_one(dev);
387 rtas_st(rets, 0, RTAS_OUT_SUCCESS);
390 static VIOsPAPRDevice *reg_conflict(VIOsPAPRDevice *dev)
392 VIOsPAPRBus *bus = DO_UPCAST(VIOsPAPRBus, bus, dev->qdev.parent_bus);
393 BusChild *kid;
394 VIOsPAPRDevice *other;
397 * Check for a device other than the given one which is already
398 * using the requested address. We have to open code this because
399 * the given dev might already be in the list.
401 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
402 other = VIO_SPAPR_DEVICE(kid->child);
404 if (other != dev && other->reg == dev->reg) {
405 return other;
409 return 0;
412 static void spapr_vio_busdev_reset(DeviceState *qdev)
414 VIOsPAPRDevice *dev = VIO_SPAPR_DEVICE(qdev);
415 VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
417 /* Shut down the request queue and TCEs if necessary */
418 spapr_vio_quiesce_one(dev);
420 dev->signal_state = 0;
422 spapr_vio_set_bypass(dev, false);
423 if (pc->reset) {
424 pc->reset(dev);
428 static void spapr_vio_busdev_realize(DeviceState *qdev, Error **errp)
430 VIOsPAPRDevice *dev = (VIOsPAPRDevice *)qdev;
431 VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
432 char *id;
434 if (dev->reg != -1) {
436 * Explicitly assigned address, just verify that no-one else
437 * is using it. other mechanism). We have to open code this
438 * rather than using spapr_vio_find_by_reg() because sdev
439 * itself is already in the list.
441 VIOsPAPRDevice *other = reg_conflict(dev);
443 if (other) {
444 error_setg(errp, "%s and %s devices conflict at address %#x",
445 object_get_typename(OBJECT(qdev)),
446 object_get_typename(OBJECT(&other->qdev)),
447 dev->reg);
448 return;
450 } else {
451 /* Need to assign an address */
452 VIOsPAPRBus *bus = DO_UPCAST(VIOsPAPRBus, bus, dev->qdev.parent_bus);
454 do {
455 dev->reg = bus->next_reg++;
456 } while (reg_conflict(dev));
459 /* Don't overwrite ids assigned on the command line */
460 if (!dev->qdev.id) {
461 id = spapr_vio_get_dev_name(DEVICE(dev));
462 dev->qdev.id = id;
465 dev->irq = xics_alloc(spapr->icp, 0, dev->irq, false);
466 if (!dev->irq) {
467 error_setg(errp, "can't allocate IRQ");
468 return;
471 if (pc->rtce_window_size) {
472 uint32_t liobn = SPAPR_VIO_BASE_LIOBN | dev->reg;
474 memory_region_init(&dev->mrroot, OBJECT(dev), "iommu-spapr-root",
475 ram_size);
476 memory_region_init_alias(&dev->mrbypass, OBJECT(dev),
477 "iommu-spapr-bypass", get_system_memory(),
478 0, ram_size);
479 memory_region_add_subregion_overlap(&dev->mrroot, 0, &dev->mrbypass, 1);
480 address_space_init(&dev->as, &dev->mrroot, qdev->id);
482 dev->tcet = spapr_tce_new_table(qdev, liobn,
484 SPAPR_TCE_PAGE_SHIFT,
485 pc->rtce_window_size >>
486 SPAPR_TCE_PAGE_SHIFT, false);
487 dev->tcet->vdev = dev;
488 memory_region_add_subregion_overlap(&dev->mrroot, 0,
489 spapr_tce_get_iommu(dev->tcet), 2);
492 pc->realize(dev, errp);
495 static target_ulong h_vio_signal(PowerPCCPU *cpu, sPAPREnvironment *spapr,
496 target_ulong opcode,
497 target_ulong *args)
499 target_ulong reg = args[0];
500 target_ulong mode = args[1];
501 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
502 VIOsPAPRDeviceClass *pc;
504 if (!dev) {
505 return H_PARAMETER;
508 pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
510 if (mode & ~pc->signal_mask) {
511 return H_PARAMETER;
514 dev->signal_state = mode;
516 return H_SUCCESS;
519 VIOsPAPRBus *spapr_vio_bus_init(void)
521 VIOsPAPRBus *bus;
522 BusState *qbus;
523 DeviceState *dev;
525 /* Create bridge device */
526 dev = qdev_create(NULL, "spapr-vio-bridge");
527 qdev_init_nofail(dev);
529 /* Create bus on bridge device */
531 qbus = qbus_create(TYPE_SPAPR_VIO_BUS, dev, "spapr-vio");
532 bus = DO_UPCAST(VIOsPAPRBus, bus, qbus);
533 bus->next_reg = 0x71000000;
535 /* hcall-vio */
536 spapr_register_hypercall(H_VIO_SIGNAL, h_vio_signal);
538 /* hcall-crq */
539 spapr_register_hypercall(H_REG_CRQ, h_reg_crq);
540 spapr_register_hypercall(H_FREE_CRQ, h_free_crq);
541 spapr_register_hypercall(H_SEND_CRQ, h_send_crq);
542 spapr_register_hypercall(H_ENABLE_CRQ, h_enable_crq);
544 /* RTAS calls */
545 spapr_rtas_register(RTAS_IBM_SET_TCE_BYPASS, "ibm,set-tce-bypass",
546 rtas_set_tce_bypass);
547 spapr_rtas_register(RTAS_QUIESCE, "quiesce", rtas_quiesce);
549 return bus;
552 /* Represents sPAPR hcall VIO devices */
554 static int spapr_vio_bridge_init(SysBusDevice *dev)
556 /* nothing */
557 return 0;
560 static void spapr_vio_bridge_class_init(ObjectClass *klass, void *data)
562 SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
563 DeviceClass *dc = DEVICE_CLASS(klass);
565 dc->fw_name = "vdevice";
566 k->init = spapr_vio_bridge_init;
569 static const TypeInfo spapr_vio_bridge_info = {
570 .name = "spapr-vio-bridge",
571 .parent = TYPE_SYS_BUS_DEVICE,
572 .instance_size = sizeof(SysBusDevice),
573 .class_init = spapr_vio_bridge_class_init,
576 const VMStateDescription vmstate_spapr_vio = {
577 .name = "spapr_vio",
578 .version_id = 1,
579 .minimum_version_id = 1,
580 .fields = (VMStateField[]) {
581 /* Sanity check */
582 VMSTATE_UINT32_EQUAL(reg, VIOsPAPRDevice),
583 VMSTATE_UINT32_EQUAL(irq, VIOsPAPRDevice),
585 /* General VIO device state */
586 VMSTATE_UINTTL(signal_state, VIOsPAPRDevice),
587 VMSTATE_UINT64(crq.qladdr, VIOsPAPRDevice),
588 VMSTATE_UINT32(crq.qsize, VIOsPAPRDevice),
589 VMSTATE_UINT32(crq.qnext, VIOsPAPRDevice),
591 VMSTATE_END_OF_LIST()
595 static void vio_spapr_device_class_init(ObjectClass *klass, void *data)
597 DeviceClass *k = DEVICE_CLASS(klass);
598 k->realize = spapr_vio_busdev_realize;
599 k->reset = spapr_vio_busdev_reset;
600 k->bus_type = TYPE_SPAPR_VIO_BUS;
601 k->props = spapr_vio_props;
604 static const TypeInfo spapr_vio_type_info = {
605 .name = TYPE_VIO_SPAPR_DEVICE,
606 .parent = TYPE_DEVICE,
607 .instance_size = sizeof(VIOsPAPRDevice),
608 .abstract = true,
609 .class_size = sizeof(VIOsPAPRDeviceClass),
610 .class_init = vio_spapr_device_class_init,
613 static void spapr_vio_register_types(void)
615 type_register_static(&spapr_vio_bus_info);
616 type_register_static(&spapr_vio_bridge_info);
617 type_register_static(&spapr_vio_type_info);
620 type_init(spapr_vio_register_types)
622 static int compare_reg(const void *p1, const void *p2)
624 VIOsPAPRDevice const *dev1, *dev2;
626 dev1 = (VIOsPAPRDevice *)*(DeviceState **)p1;
627 dev2 = (VIOsPAPRDevice *)*(DeviceState **)p2;
629 if (dev1->reg < dev2->reg) {
630 return -1;
632 if (dev1->reg == dev2->reg) {
633 return 0;
636 /* dev1->reg > dev2->reg */
637 return 1;
640 int spapr_populate_vdevice(VIOsPAPRBus *bus, void *fdt)
642 DeviceState *qdev, **qdevs;
643 BusChild *kid;
644 int i, num, ret = 0;
646 /* Count qdevs on the bus list */
647 num = 0;
648 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
649 num++;
652 /* Copy out into an array of pointers */
653 qdevs = g_malloc(sizeof(qdev) * num);
654 num = 0;
655 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
656 qdevs[num++] = kid->child;
659 /* Sort the array */
660 qsort(qdevs, num, sizeof(qdev), compare_reg);
662 /* Hack alert. Give the devices to libfdt in reverse order, we happen
663 * to know that will mean they are in forward order in the tree. */
664 for (i = num - 1; i >= 0; i--) {
665 VIOsPAPRDevice *dev = (VIOsPAPRDevice *)(qdevs[i]);
667 ret = vio_make_devnode(dev, fdt);
669 if (ret < 0) {
670 goto out;
674 ret = 0;
675 out:
676 g_free(qdevs);
678 return ret;
681 int spapr_populate_chosen_stdout(void *fdt, VIOsPAPRBus *bus)
683 VIOsPAPRDevice *dev;
684 char *name, *path;
685 int ret, offset;
687 dev = spapr_vty_get_default(bus);
688 if (!dev)
689 return 0;
691 offset = fdt_path_offset(fdt, "/chosen");
692 if (offset < 0) {
693 return offset;
696 name = spapr_vio_get_dev_name(DEVICE(dev));
697 path = g_strdup_printf("/vdevice/%s", name);
699 ret = fdt_setprop_string(fdt, offset, "linux,stdout-path", path);
701 g_free(name);
702 g_free(path);
704 return ret;