vhost-user: Introduce a new protocol feature REPLY_ACK.
[qemu/cris-port.git] / hw / ppc / spapr_vio.c
blobf93244d7c1828c6a99b08c158a69c9058b25cf28
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 "qemu/osdep.h"
23 #include "qapi/error.h"
24 #include "hw/hw.h"
25 #include "qemu/log.h"
26 #include "sysemu/sysemu.h"
27 #include "hw/boards.h"
28 #include "hw/loader.h"
29 #include "elf.h"
30 #include "hw/sysbus.h"
31 #include "sysemu/kvm.h"
32 #include "sysemu/device_tree.h"
33 #include "kvm_ppc.h"
35 #include "hw/ppc/spapr.h"
36 #include "hw/ppc/spapr_vio.h"
37 #include "hw/ppc/xics.h"
39 #include <libfdt.h>
41 /* #define DEBUG_SPAPR */
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
51 static Property spapr_vio_props[] = {
52 DEFINE_PROP_UINT32("irq", VIOsPAPRDevice, irq, 0), \
53 DEFINE_PROP_END_OF_LIST(),
56 static char *spapr_vio_get_dev_name(DeviceState *qdev)
58 VIOsPAPRDevice *dev = VIO_SPAPR_DEVICE(qdev);
59 VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
61 /* Device tree style name device@reg */
62 return g_strdup_printf("%s@%x", pc->dt_name, dev->reg);
65 static void spapr_vio_bus_class_init(ObjectClass *klass, void *data)
67 BusClass *k = BUS_CLASS(klass);
69 k->get_dev_path = spapr_vio_get_dev_name;
70 k->get_fw_dev_path = spapr_vio_get_dev_name;
73 static const TypeInfo spapr_vio_bus_info = {
74 .name = TYPE_SPAPR_VIO_BUS,
75 .parent = TYPE_BUS,
76 .class_init = spapr_vio_bus_class_init,
77 .instance_size = sizeof(VIOsPAPRBus),
80 VIOsPAPRDevice *spapr_vio_find_by_reg(VIOsPAPRBus *bus, uint32_t reg)
82 BusChild *kid;
83 VIOsPAPRDevice *dev = NULL;
85 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
86 dev = (VIOsPAPRDevice *)kid->child;
87 if (dev->reg == reg) {
88 return dev;
92 return NULL;
95 static int vio_make_devnode(VIOsPAPRDevice *dev,
96 void *fdt)
98 VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
99 int vdevice_off, node_off, ret;
100 char *dt_name;
102 vdevice_off = fdt_path_offset(fdt, "/vdevice");
103 if (vdevice_off < 0) {
104 return vdevice_off;
107 dt_name = spapr_vio_get_dev_name(DEVICE(dev));
108 node_off = fdt_add_subnode(fdt, vdevice_off, dt_name);
109 g_free(dt_name);
110 if (node_off < 0) {
111 return node_off;
114 ret = fdt_setprop_cell(fdt, node_off, "reg", dev->reg);
115 if (ret < 0) {
116 return ret;
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;
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;
135 if (dev->irq) {
136 uint32_t ints_prop[] = {cpu_to_be32(dev->irq), 0};
138 ret = fdt_setprop(fdt, node_off, "interrupts", ints_prop,
139 sizeof(ints_prop));
140 if (ret < 0) {
141 return ret;
145 ret = spapr_tcet_dma_dt(fdt, node_off, "ibm,my-dma-window", dev->tcet);
146 if (ret < 0) {
147 return ret;
150 if (pc->devnode) {
151 ret = (pc->devnode)(dev, fdt, node_off);
152 if (ret < 0) {
153 return ret;
157 return node_off;
161 * CRQ handling
163 static target_ulong h_reg_crq(PowerPCCPU *cpu, sPAPRMachineState *spapr,
164 target_ulong opcode, target_ulong *args)
166 target_ulong reg = args[0];
167 target_ulong queue_addr = args[1];
168 target_ulong queue_len = args[2];
169 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
171 if (!dev) {
172 hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
173 return H_PARAMETER;
176 /* We can't grok a queue size bigger than 256M for now */
177 if (queue_len < 0x1000 || queue_len > 0x10000000) {
178 hcall_dprintf("Queue size too small or too big (0x" TARGET_FMT_lx
179 ")\n", queue_len);
180 return H_PARAMETER;
183 /* Check queue alignment */
184 if (queue_addr & 0xfff) {
185 hcall_dprintf("Queue not aligned (0x" TARGET_FMT_lx ")\n", queue_addr);
186 return H_PARAMETER;
189 /* Check if device supports CRQs */
190 if (!dev->crq.SendFunc) {
191 hcall_dprintf("Device does not support CRQ\n");
192 return H_NOT_FOUND;
195 /* Already a queue ? */
196 if (dev->crq.qsize) {
197 hcall_dprintf("CRQ already registered\n");
198 return H_RESOURCE;
200 dev->crq.qladdr = queue_addr;
201 dev->crq.qsize = queue_len;
202 dev->crq.qnext = 0;
204 DPRINTF("CRQ for dev 0x" TARGET_FMT_lx " registered at 0x"
205 TARGET_FMT_lx "/0x" TARGET_FMT_lx "\n",
206 reg, queue_addr, queue_len);
207 return H_SUCCESS;
210 static target_ulong free_crq(VIOsPAPRDevice *dev)
212 dev->crq.qladdr = 0;
213 dev->crq.qsize = 0;
214 dev->crq.qnext = 0;
216 DPRINTF("CRQ for dev 0x%" PRIx32 " freed\n", dev->reg);
218 return H_SUCCESS;
221 static target_ulong h_free_crq(PowerPCCPU *cpu, sPAPRMachineState *spapr,
222 target_ulong opcode, target_ulong *args)
224 target_ulong reg = args[0];
225 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
227 if (!dev) {
228 hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
229 return H_PARAMETER;
232 return free_crq(dev);
235 static target_ulong h_send_crq(PowerPCCPU *cpu, sPAPRMachineState *spapr,
236 target_ulong opcode, target_ulong *args)
238 target_ulong reg = args[0];
239 target_ulong msg_hi = args[1];
240 target_ulong msg_lo = args[2];
241 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
242 uint64_t crq_mangle[2];
244 if (!dev) {
245 hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
246 return H_PARAMETER;
248 crq_mangle[0] = cpu_to_be64(msg_hi);
249 crq_mangle[1] = cpu_to_be64(msg_lo);
251 if (dev->crq.SendFunc) {
252 return dev->crq.SendFunc(dev, (uint8_t *)crq_mangle);
255 return H_HARDWARE;
258 static target_ulong h_enable_crq(PowerPCCPU *cpu, sPAPRMachineState *spapr,
259 target_ulong opcode, target_ulong *args)
261 target_ulong reg = args[0];
262 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
264 if (!dev) {
265 hcall_dprintf("Unit 0x" TARGET_FMT_lx " does not exist\n", reg);
266 return H_PARAMETER;
269 return 0;
272 /* Returns negative error, 0 success, or positive: queue full */
273 int spapr_vio_send_crq(VIOsPAPRDevice *dev, uint8_t *crq)
275 int rc;
276 uint8_t byte;
278 if (!dev->crq.qsize) {
279 fprintf(stderr, "spapr_vio_send_creq on uninitialized queue\n");
280 return -1;
283 /* Maybe do a fast path for KVM just writing to the pages */
284 rc = spapr_vio_dma_read(dev, dev->crq.qladdr + dev->crq.qnext, &byte, 1);
285 if (rc) {
286 return rc;
288 if (byte != 0) {
289 return 1;
292 rc = spapr_vio_dma_write(dev, dev->crq.qladdr + dev->crq.qnext + 8,
293 &crq[8], 8);
294 if (rc) {
295 return rc;
298 kvmppc_eieio();
300 rc = spapr_vio_dma_write(dev, dev->crq.qladdr + dev->crq.qnext, crq, 8);
301 if (rc) {
302 return rc;
305 dev->crq.qnext = (dev->crq.qnext + 16) % dev->crq.qsize;
307 if (dev->signal_state & 1) {
308 qemu_irq_pulse(spapr_vio_qirq(dev));
311 return 0;
314 /* "quiesce" handling */
316 static void spapr_vio_quiesce_one(VIOsPAPRDevice *dev)
318 if (dev->tcet) {
319 device_reset(DEVICE(dev->tcet));
321 free_crq(dev);
324 void spapr_vio_set_bypass(VIOsPAPRDevice *dev, bool bypass)
326 if (!dev->tcet) {
327 return;
330 memory_region_set_enabled(&dev->mrbypass, bypass);
331 memory_region_set_enabled(spapr_tce_get_iommu(dev->tcet), !bypass);
333 dev->tcet->bypass = bypass;
336 static void rtas_set_tce_bypass(PowerPCCPU *cpu, sPAPRMachineState *spapr,
337 uint32_t token,
338 uint32_t nargs, target_ulong args,
339 uint32_t nret, target_ulong rets)
341 VIOsPAPRBus *bus = spapr->vio_bus;
342 VIOsPAPRDevice *dev;
343 uint32_t unit, enable;
345 if (nargs != 2) {
346 rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
347 return;
349 unit = rtas_ld(args, 0);
350 enable = rtas_ld(args, 1);
351 dev = spapr_vio_find_by_reg(bus, unit);
352 if (!dev) {
353 rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
354 return;
357 if (!dev->tcet) {
358 rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
359 return;
362 spapr_vio_set_bypass(dev, !!enable);
364 rtas_st(rets, 0, RTAS_OUT_SUCCESS);
367 static void rtas_quiesce(PowerPCCPU *cpu, sPAPRMachineState *spapr,
368 uint32_t token,
369 uint32_t nargs, target_ulong args,
370 uint32_t nret, target_ulong rets)
372 VIOsPAPRBus *bus = spapr->vio_bus;
373 BusChild *kid;
374 VIOsPAPRDevice *dev = NULL;
376 if (nargs != 0) {
377 rtas_st(rets, 0, RTAS_OUT_PARAM_ERROR);
378 return;
381 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
382 dev = (VIOsPAPRDevice *)kid->child;
383 spapr_vio_quiesce_one(dev);
386 rtas_st(rets, 0, RTAS_OUT_SUCCESS);
389 static VIOsPAPRDevice *reg_conflict(VIOsPAPRDevice *dev)
391 VIOsPAPRBus *bus = SPAPR_VIO_BUS(dev->qdev.parent_bus);
392 BusChild *kid;
393 VIOsPAPRDevice *other;
396 * Check for a device other than the given one which is already
397 * using the requested address. We have to open code this because
398 * the given dev might already be in the list.
400 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
401 other = VIO_SPAPR_DEVICE(kid->child);
403 if (other != dev && other->reg == dev->reg) {
404 return other;
408 return 0;
411 static void spapr_vio_busdev_reset(DeviceState *qdev)
413 VIOsPAPRDevice *dev = VIO_SPAPR_DEVICE(qdev);
414 VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
416 /* Shut down the request queue and TCEs if necessary */
417 spapr_vio_quiesce_one(dev);
419 dev->signal_state = 0;
421 spapr_vio_set_bypass(dev, false);
422 if (pc->reset) {
423 pc->reset(dev);
427 static void spapr_vio_busdev_realize(DeviceState *qdev, Error **errp)
429 sPAPRMachineState *spapr = SPAPR_MACHINE(qdev_get_machine());
430 VIOsPAPRDevice *dev = (VIOsPAPRDevice *)qdev;
431 VIOsPAPRDeviceClass *pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
432 char *id;
433 Error *local_err = NULL;
435 if (dev->reg != -1) {
437 * Explicitly assigned address, just verify that no-one else
438 * is using it. other mechanism). We have to open code this
439 * rather than using spapr_vio_find_by_reg() because sdev
440 * itself is already in the list.
442 VIOsPAPRDevice *other = reg_conflict(dev);
444 if (other) {
445 error_setg(errp, "%s and %s devices conflict at address %#x",
446 object_get_typename(OBJECT(qdev)),
447 object_get_typename(OBJECT(&other->qdev)),
448 dev->reg);
449 return;
451 } else {
452 /* Need to assign an address */
453 VIOsPAPRBus *bus = SPAPR_VIO_BUS(dev->qdev.parent_bus);
455 do {
456 dev->reg = bus->next_reg++;
457 } while (reg_conflict(dev));
460 /* Don't overwrite ids assigned on the command line */
461 if (!dev->qdev.id) {
462 id = spapr_vio_get_dev_name(DEVICE(dev));
463 dev->qdev.id = id;
466 dev->irq = xics_spapr_alloc(spapr->xics, 0, dev->irq, false, &local_err);
467 if (local_err) {
468 error_propagate(errp, local_err);
469 return;
472 if (pc->rtce_window_size) {
473 uint32_t liobn = SPAPR_VIO_LIOBN(dev->reg);
475 memory_region_init(&dev->mrroot, OBJECT(dev), "iommu-spapr-root",
476 ram_size);
477 memory_region_init_alias(&dev->mrbypass, OBJECT(dev),
478 "iommu-spapr-bypass", get_system_memory(),
479 0, ram_size);
480 memory_region_add_subregion_overlap(&dev->mrroot, 0, &dev->mrbypass, 1);
481 address_space_init(&dev->as, &dev->mrroot, qdev->id);
483 dev->tcet = spapr_tce_new_table(qdev, liobn);
484 spapr_tce_table_enable(dev->tcet, SPAPR_TCE_PAGE_SHIFT, 0,
485 pc->rtce_window_size >> SPAPR_TCE_PAGE_SHIFT);
486 dev->tcet->vdev = dev;
487 memory_region_add_subregion_overlap(&dev->mrroot, 0,
488 spapr_tce_get_iommu(dev->tcet), 2);
491 pc->realize(dev, errp);
494 static target_ulong h_vio_signal(PowerPCCPU *cpu, sPAPRMachineState *spapr,
495 target_ulong opcode,
496 target_ulong *args)
498 target_ulong reg = args[0];
499 target_ulong mode = args[1];
500 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
501 VIOsPAPRDeviceClass *pc;
503 if (!dev) {
504 return H_PARAMETER;
507 pc = VIO_SPAPR_DEVICE_GET_CLASS(dev);
509 if (mode & ~pc->signal_mask) {
510 return H_PARAMETER;
513 dev->signal_state = mode;
515 return H_SUCCESS;
518 VIOsPAPRBus *spapr_vio_bus_init(void)
520 VIOsPAPRBus *bus;
521 BusState *qbus;
522 DeviceState *dev;
524 /* Create bridge device */
525 dev = qdev_create(NULL, TYPE_SPAPR_VIO_BRIDGE);
526 qdev_init_nofail(dev);
528 /* Create bus on bridge device */
529 qbus = qbus_create(TYPE_SPAPR_VIO_BUS, dev, "spapr-vio");
530 bus = SPAPR_VIO_BUS(qbus);
531 bus->next_reg = 0x71000000;
533 /* hcall-vio */
534 spapr_register_hypercall(H_VIO_SIGNAL, h_vio_signal);
536 /* hcall-crq */
537 spapr_register_hypercall(H_REG_CRQ, h_reg_crq);
538 spapr_register_hypercall(H_FREE_CRQ, h_free_crq);
539 spapr_register_hypercall(H_SEND_CRQ, h_send_crq);
540 spapr_register_hypercall(H_ENABLE_CRQ, h_enable_crq);
542 /* RTAS calls */
543 spapr_rtas_register(RTAS_IBM_SET_TCE_BYPASS, "ibm,set-tce-bypass",
544 rtas_set_tce_bypass);
545 spapr_rtas_register(RTAS_QUIESCE, "quiesce", rtas_quiesce);
547 return bus;
550 /* Represents sPAPR hcall VIO devices */
552 static int spapr_vio_bridge_init(SysBusDevice *dev)
554 /* nothing */
555 return 0;
558 static void spapr_vio_bridge_class_init(ObjectClass *klass, void *data)
560 SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
561 DeviceClass *dc = DEVICE_CLASS(klass);
563 dc->fw_name = "vdevice";
564 k->init = spapr_vio_bridge_init;
567 static const TypeInfo spapr_vio_bridge_info = {
568 .name = TYPE_SPAPR_VIO_BRIDGE,
569 .parent = TYPE_SYS_BUS_DEVICE,
570 .class_init = spapr_vio_bridge_class_init,
573 const VMStateDescription vmstate_spapr_vio = {
574 .name = "spapr_vio",
575 .version_id = 1,
576 .minimum_version_id = 1,
577 .fields = (VMStateField[]) {
578 /* Sanity check */
579 VMSTATE_UINT32_EQUAL(reg, VIOsPAPRDevice),
580 VMSTATE_UINT32_EQUAL(irq, VIOsPAPRDevice),
582 /* General VIO device state */
583 VMSTATE_UINT64(signal_state, VIOsPAPRDevice),
584 VMSTATE_UINT64(crq.qladdr, VIOsPAPRDevice),
585 VMSTATE_UINT32(crq.qsize, VIOsPAPRDevice),
586 VMSTATE_UINT32(crq.qnext, VIOsPAPRDevice),
588 VMSTATE_END_OF_LIST()
592 static void vio_spapr_device_class_init(ObjectClass *klass, void *data)
594 DeviceClass *k = DEVICE_CLASS(klass);
595 k->realize = spapr_vio_busdev_realize;
596 k->reset = spapr_vio_busdev_reset;
597 k->bus_type = TYPE_SPAPR_VIO_BUS;
598 k->props = spapr_vio_props;
601 static const TypeInfo spapr_vio_type_info = {
602 .name = TYPE_VIO_SPAPR_DEVICE,
603 .parent = TYPE_DEVICE,
604 .instance_size = sizeof(VIOsPAPRDevice),
605 .abstract = true,
606 .class_size = sizeof(VIOsPAPRDeviceClass),
607 .class_init = vio_spapr_device_class_init,
610 static void spapr_vio_register_types(void)
612 type_register_static(&spapr_vio_bus_info);
613 type_register_static(&spapr_vio_bridge_info);
614 type_register_static(&spapr_vio_type_info);
617 type_init(spapr_vio_register_types)
619 static int compare_reg(const void *p1, const void *p2)
621 VIOsPAPRDevice const *dev1, *dev2;
623 dev1 = (VIOsPAPRDevice *)*(DeviceState **)p1;
624 dev2 = (VIOsPAPRDevice *)*(DeviceState **)p2;
626 if (dev1->reg < dev2->reg) {
627 return -1;
629 if (dev1->reg == dev2->reg) {
630 return 0;
633 /* dev1->reg > dev2->reg */
634 return 1;
637 int spapr_populate_vdevice(VIOsPAPRBus *bus, void *fdt)
639 DeviceState *qdev, **qdevs;
640 BusChild *kid;
641 int i, num, ret = 0;
643 /* Count qdevs on the bus list */
644 num = 0;
645 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
646 num++;
649 /* Copy out into an array of pointers */
650 qdevs = g_malloc(sizeof(qdev) * num);
651 num = 0;
652 QTAILQ_FOREACH(kid, &bus->bus.children, sibling) {
653 qdevs[num++] = kid->child;
656 /* Sort the array */
657 qsort(qdevs, num, sizeof(qdev), compare_reg);
659 /* Hack alert. Give the devices to libfdt in reverse order, we happen
660 * to know that will mean they are in forward order in the tree. */
661 for (i = num - 1; i >= 0; i--) {
662 VIOsPAPRDevice *dev = (VIOsPAPRDevice *)(qdevs[i]);
664 ret = vio_make_devnode(dev, fdt);
666 if (ret < 0) {
667 goto out;
671 ret = 0;
672 out:
673 g_free(qdevs);
675 return ret;
678 int spapr_populate_chosen_stdout(void *fdt, VIOsPAPRBus *bus)
680 VIOsPAPRDevice *dev;
681 char *name, *path;
682 int ret, offset;
684 dev = spapr_vty_get_default(bus);
685 if (!dev)
686 return 0;
688 offset = fdt_path_offset(fdt, "/chosen");
689 if (offset < 0) {
690 return offset;
693 name = spapr_vio_get_dev_name(DEVICE(dev));
694 path = g_strdup_printf("/vdevice/%s", name);
696 ret = fdt_setprop_string(fdt, offset, "linux,stdout-path", path);
698 g_free(name);
699 g_free(path);
701 return ret;