Update version for v1.0-rc1
[qemu.git] / hw / spapr_vio.c
blob25cfc9d912691e4feee06b41975bd556aa6d073d
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.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"
33 #include "hw/spapr.h"
34 #include "hw/spapr_vio.h"
35 #include "hw/xics.h"
37 #ifdef CONFIG_FDT
38 #include <libfdt.h>
39 #endif /* CONFIG_FDT */
41 /* #define DEBUG_SPAPR */
42 /* #define DEBUG_TCE */
44 #ifdef DEBUG_SPAPR
45 #define dprintf(fmt, ...) \
46 do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
47 #else
48 #define dprintf(fmt, ...) \
49 do { } while (0)
50 #endif
52 static struct BusInfo spapr_vio_bus_info = {
53 .name = "spapr-vio",
54 .size = sizeof(VIOsPAPRBus),
55 .props = (Property[]) {
56 DEFINE_PROP_UINT32("irq", VIOsPAPRDevice, vio_irq_num, 0), \
57 DEFINE_PROP_END_OF_LIST(),
61 VIOsPAPRDevice *spapr_vio_find_by_reg(VIOsPAPRBus *bus, uint32_t reg)
63 DeviceState *qdev;
64 VIOsPAPRDevice *dev = NULL;
66 QTAILQ_FOREACH(qdev, &bus->bus.children, sibling) {
67 dev = (VIOsPAPRDevice *)qdev;
68 if (dev->reg == reg) {
69 break;
73 return dev;
76 #ifdef CONFIG_FDT
77 static int vio_make_devnode(VIOsPAPRDevice *dev,
78 void *fdt)
80 VIOsPAPRDeviceInfo *info = (VIOsPAPRDeviceInfo *)dev->qdev.info;
81 int vdevice_off, node_off;
82 int ret;
84 vdevice_off = fdt_path_offset(fdt, "/vdevice");
85 if (vdevice_off < 0) {
86 return vdevice_off;
89 node_off = fdt_add_subnode(fdt, vdevice_off, dev->qdev.id);
90 if (node_off < 0) {
91 return node_off;
94 ret = fdt_setprop_cell(fdt, node_off, "reg", dev->reg);
95 if (ret < 0) {
96 return ret;
99 if (info->dt_type) {
100 ret = fdt_setprop_string(fdt, node_off, "device_type",
101 info->dt_type);
102 if (ret < 0) {
103 return ret;
107 if (info->dt_compatible) {
108 ret = fdt_setprop_string(fdt, node_off, "compatible",
109 info->dt_compatible);
110 if (ret < 0) {
111 return ret;
115 if (dev->qirq) {
116 uint32_t ints_prop[] = {cpu_to_be32(dev->vio_irq_num), 0};
118 ret = fdt_setprop(fdt, node_off, "interrupts", ints_prop,
119 sizeof(ints_prop));
120 if (ret < 0) {
121 return ret;
125 if (dev->rtce_window_size) {
126 uint32_t dma_prop[] = {cpu_to_be32(dev->reg),
127 0, 0,
128 0, cpu_to_be32(dev->rtce_window_size)};
130 ret = fdt_setprop_cell(fdt, node_off, "ibm,#dma-address-cells", 2);
131 if (ret < 0) {
132 return ret;
135 ret = fdt_setprop_cell(fdt, node_off, "ibm,#dma-size-cells", 2);
136 if (ret < 0) {
137 return ret;
140 ret = fdt_setprop(fdt, node_off, "ibm,my-dma-window", dma_prop,
141 sizeof(dma_prop));
142 if (ret < 0) {
143 return ret;
147 if (info->devnode) {
148 ret = (info->devnode)(dev, fdt, node_off);
149 if (ret < 0) {
150 return ret;
154 return node_off;
156 #endif /* CONFIG_FDT */
159 * RTCE handling
162 static void rtce_init(VIOsPAPRDevice *dev)
164 size_t size = (dev->rtce_window_size >> SPAPR_VIO_TCE_PAGE_SHIFT)
165 * sizeof(VIOsPAPR_RTCE);
167 if (size) {
168 dev->rtce_table = kvmppc_create_spapr_tce(dev->reg,
169 dev->rtce_window_size,
170 &dev->kvmtce_fd);
172 if (!dev->rtce_table) {
173 dev->rtce_table = g_malloc0(size);
178 static target_ulong h_put_tce(CPUState *env, sPAPREnvironment *spapr,
179 target_ulong opcode, target_ulong *args)
181 target_ulong liobn = args[0];
182 target_ulong ioba = args[1];
183 target_ulong tce = args[2];
184 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, liobn);
185 VIOsPAPR_RTCE *rtce;
187 if (!dev) {
188 hcall_dprintf("spapr_vio_put_tce on non-existent LIOBN "
189 TARGET_FMT_lx "\n", liobn);
190 return H_PARAMETER;
193 ioba &= ~(SPAPR_VIO_TCE_PAGE_SIZE - 1);
195 #ifdef DEBUG_TCE
196 fprintf(stderr, "spapr_vio_put_tce on %s ioba 0x" TARGET_FMT_lx
197 " TCE 0x" TARGET_FMT_lx "\n", dev->qdev.id, ioba, tce);
198 #endif
200 if (ioba >= dev->rtce_window_size) {
201 hcall_dprintf("spapr_vio_put_tce on out-of-boards IOBA 0x"
202 TARGET_FMT_lx "\n", ioba);
203 return H_PARAMETER;
206 rtce = dev->rtce_table + (ioba >> SPAPR_VIO_TCE_PAGE_SHIFT);
207 rtce->tce = tce;
209 return H_SUCCESS;
212 int spapr_vio_check_tces(VIOsPAPRDevice *dev, target_ulong ioba,
213 target_ulong len, enum VIOsPAPR_TCEAccess access)
215 int start, end, i;
217 start = ioba >> SPAPR_VIO_TCE_PAGE_SHIFT;
218 end = (ioba + len - 1) >> SPAPR_VIO_TCE_PAGE_SHIFT;
220 for (i = start; i <= end; i++) {
221 if ((dev->rtce_table[i].tce & access) != access) {
222 #ifdef DEBUG_TCE
223 fprintf(stderr, "FAIL on %d\n", i);
224 #endif
225 return -1;
229 return 0;
232 int spapr_tce_dma_write(VIOsPAPRDevice *dev, uint64_t taddr, const void *buf,
233 uint32_t size)
235 #ifdef DEBUG_TCE
236 fprintf(stderr, "spapr_tce_dma_write taddr=0x%llx size=0x%x\n",
237 (unsigned long long)taddr, size);
238 #endif
240 /* Check for bypass */
241 if (dev->flags & VIO_PAPR_FLAG_DMA_BYPASS) {
242 cpu_physical_memory_write(taddr, buf, size);
243 return 0;
246 while (size) {
247 uint64_t tce;
248 uint32_t lsize;
249 uint64_t txaddr;
251 /* Check if we are in bound */
252 if (taddr >= dev->rtce_window_size) {
253 #ifdef DEBUG_TCE
254 fprintf(stderr, "spapr_tce_dma_write out of bounds\n");
255 #endif
256 return H_DEST_PARM;
258 tce = dev->rtce_table[taddr >> SPAPR_VIO_TCE_PAGE_SHIFT].tce;
260 /* How much til end of page ? */
261 lsize = MIN(size, ((~taddr) & SPAPR_VIO_TCE_PAGE_MASK) + 1);
263 /* Check TCE */
264 if (!(tce & 2)) {
265 return H_DEST_PARM;
268 /* Translate */
269 txaddr = (tce & ~SPAPR_VIO_TCE_PAGE_MASK) |
270 (taddr & SPAPR_VIO_TCE_PAGE_MASK);
272 #ifdef DEBUG_TCE
273 fprintf(stderr, " -> write to txaddr=0x%llx, size=0x%x\n",
274 (unsigned long long)txaddr, lsize);
275 #endif
277 /* Do it */
278 cpu_physical_memory_write(txaddr, buf, lsize);
279 buf += lsize;
280 taddr += lsize;
281 size -= lsize;
283 return 0;
286 int spapr_tce_dma_zero(VIOsPAPRDevice *dev, uint64_t taddr, uint32_t size)
288 /* FIXME: allocating a temp buffer is nasty, but just stepping
289 * through writing zeroes is awkward. This will do for now. */
290 uint8_t zeroes[size];
292 #ifdef DEBUG_TCE
293 fprintf(stderr, "spapr_tce_dma_zero taddr=0x%llx size=0x%x\n",
294 (unsigned long long)taddr, size);
295 #endif
297 memset(zeroes, 0, size);
298 return spapr_tce_dma_write(dev, taddr, zeroes, size);
301 void stb_tce(VIOsPAPRDevice *dev, uint64_t taddr, uint8_t val)
303 spapr_tce_dma_write(dev, taddr, &val, sizeof(val));
306 void sth_tce(VIOsPAPRDevice *dev, uint64_t taddr, uint16_t val)
308 val = tswap16(val);
309 spapr_tce_dma_write(dev, taddr, &val, sizeof(val));
313 void stw_tce(VIOsPAPRDevice *dev, uint64_t taddr, uint32_t val)
315 val = tswap32(val);
316 spapr_tce_dma_write(dev, taddr, &val, sizeof(val));
319 void stq_tce(VIOsPAPRDevice *dev, uint64_t taddr, uint64_t val)
321 val = tswap64(val);
322 spapr_tce_dma_write(dev, taddr, &val, sizeof(val));
325 int spapr_tce_dma_read(VIOsPAPRDevice *dev, uint64_t taddr, void *buf,
326 uint32_t size)
328 #ifdef DEBUG_TCE
329 fprintf(stderr, "spapr_tce_dma_write taddr=0x%llx size=0x%x\n",
330 (unsigned long long)taddr, size);
331 #endif
333 /* Check for bypass */
334 if (dev->flags & VIO_PAPR_FLAG_DMA_BYPASS) {
335 cpu_physical_memory_read(taddr, buf, size);
336 return 0;
339 while (size) {
340 uint64_t tce;
341 uint32_t lsize;
342 uint64_t txaddr;
344 /* Check if we are in bound */
345 if (taddr >= dev->rtce_window_size) {
346 #ifdef DEBUG_TCE
347 fprintf(stderr, "spapr_tce_dma_read out of bounds\n");
348 #endif
349 return H_DEST_PARM;
351 tce = dev->rtce_table[taddr >> SPAPR_VIO_TCE_PAGE_SHIFT].tce;
353 /* How much til end of page ? */
354 lsize = MIN(size, ((~taddr) & SPAPR_VIO_TCE_PAGE_MASK) + 1);
356 /* Check TCE */
357 if (!(tce & 1)) {
358 return H_DEST_PARM;
361 /* Translate */
362 txaddr = (tce & ~SPAPR_VIO_TCE_PAGE_MASK) |
363 (taddr & SPAPR_VIO_TCE_PAGE_MASK);
365 #ifdef DEBUG_TCE
366 fprintf(stderr, " -> write to txaddr=0x%llx, size=0x%x\n",
367 (unsigned long long)txaddr, lsize);
368 #endif
369 /* Do it */
370 cpu_physical_memory_read(txaddr, buf, lsize);
371 buf += lsize;
372 taddr += lsize;
373 size -= lsize;
375 return H_SUCCESS;
378 uint64_t ldq_tce(VIOsPAPRDevice *dev, uint64_t taddr)
380 uint64_t val;
382 spapr_tce_dma_read(dev, taddr, &val, sizeof(val));
383 return tswap64(val);
387 * CRQ handling
389 static target_ulong h_reg_crq(CPUState *env, sPAPREnvironment *spapr,
390 target_ulong opcode, target_ulong *args)
392 target_ulong reg = args[0];
393 target_ulong queue_addr = args[1];
394 target_ulong queue_len = args[2];
395 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
397 if (!dev) {
398 hcall_dprintf("h_reg_crq on non-existent unit 0x"
399 TARGET_FMT_lx "\n", reg);
400 return H_PARAMETER;
403 /* We can't grok a queue size bigger than 256M for now */
404 if (queue_len < 0x1000 || queue_len > 0x10000000) {
405 hcall_dprintf("h_reg_crq, queue size too small or too big (0x%llx)\n",
406 (unsigned long long)queue_len);
407 return H_PARAMETER;
410 /* Check queue alignment */
411 if (queue_addr & 0xfff) {
412 hcall_dprintf("h_reg_crq, queue not aligned (0x%llx)\n",
413 (unsigned long long)queue_addr);
414 return H_PARAMETER;
417 /* Check if device supports CRQs */
418 if (!dev->crq.SendFunc) {
419 return H_NOT_FOUND;
423 /* Already a queue ? */
424 if (dev->crq.qsize) {
425 return H_RESOURCE;
427 dev->crq.qladdr = queue_addr;
428 dev->crq.qsize = queue_len;
429 dev->crq.qnext = 0;
431 dprintf("CRQ for dev 0x" TARGET_FMT_lx " registered at 0x"
432 TARGET_FMT_lx "/0x" TARGET_FMT_lx "\n",
433 reg, queue_addr, queue_len);
434 return H_SUCCESS;
437 static target_ulong h_free_crq(CPUState *env, sPAPREnvironment *spapr,
438 target_ulong opcode, target_ulong *args)
440 target_ulong reg = args[0];
441 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
443 if (!dev) {
444 hcall_dprintf("h_free_crq on non-existent unit 0x"
445 TARGET_FMT_lx "\n", reg);
446 return H_PARAMETER;
449 dev->crq.qladdr = 0;
450 dev->crq.qsize = 0;
451 dev->crq.qnext = 0;
453 dprintf("CRQ for dev 0x" TARGET_FMT_lx " freed\n", reg);
455 return H_SUCCESS;
458 static target_ulong h_send_crq(CPUState *env, sPAPREnvironment *spapr,
459 target_ulong opcode, target_ulong *args)
461 target_ulong reg = args[0];
462 target_ulong msg_hi = args[1];
463 target_ulong msg_lo = args[2];
464 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
465 uint64_t crq_mangle[2];
467 if (!dev) {
468 hcall_dprintf("h_send_crq on non-existent unit 0x"
469 TARGET_FMT_lx "\n", reg);
470 return H_PARAMETER;
472 crq_mangle[0] = cpu_to_be64(msg_hi);
473 crq_mangle[1] = cpu_to_be64(msg_lo);
475 if (dev->crq.SendFunc) {
476 return dev->crq.SendFunc(dev, (uint8_t *)crq_mangle);
479 return H_HARDWARE;
482 static target_ulong h_enable_crq(CPUState *env, sPAPREnvironment *spapr,
483 target_ulong opcode, target_ulong *args)
485 target_ulong reg = args[0];
486 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
488 if (!dev) {
489 hcall_dprintf("h_enable_crq on non-existent unit 0x"
490 TARGET_FMT_lx "\n", reg);
491 return H_PARAMETER;
494 return 0;
497 /* Returns negative error, 0 success, or positive: queue full */
498 int spapr_vio_send_crq(VIOsPAPRDevice *dev, uint8_t *crq)
500 int rc;
501 uint8_t byte;
503 if (!dev->crq.qsize) {
504 fprintf(stderr, "spapr_vio_send_creq on uninitialized queue\n");
505 return -1;
508 /* Maybe do a fast path for KVM just writing to the pages */
509 rc = spapr_tce_dma_read(dev, dev->crq.qladdr + dev->crq.qnext, &byte, 1);
510 if (rc) {
511 return rc;
513 if (byte != 0) {
514 return 1;
517 rc = spapr_tce_dma_write(dev, dev->crq.qladdr + dev->crq.qnext + 8,
518 &crq[8], 8);
519 if (rc) {
520 return rc;
523 kvmppc_eieio();
525 rc = spapr_tce_dma_write(dev, dev->crq.qladdr + dev->crq.qnext, crq, 8);
526 if (rc) {
527 return rc;
530 dev->crq.qnext = (dev->crq.qnext + 16) % dev->crq.qsize;
532 if (dev->signal_state & 1) {
533 qemu_irq_pulse(dev->qirq);
536 return 0;
539 /* "quiesce" handling */
541 static void spapr_vio_quiesce_one(VIOsPAPRDevice *dev)
543 dev->flags &= ~VIO_PAPR_FLAG_DMA_BYPASS;
545 if (dev->rtce_table) {
546 size_t size = (dev->rtce_window_size >> SPAPR_VIO_TCE_PAGE_SHIFT)
547 * sizeof(VIOsPAPR_RTCE);
548 memset(dev->rtce_table, 0, size);
551 dev->crq.qladdr = 0;
552 dev->crq.qsize = 0;
553 dev->crq.qnext = 0;
556 static void rtas_set_tce_bypass(sPAPREnvironment *spapr, uint32_t token,
557 uint32_t nargs, target_ulong args,
558 uint32_t nret, target_ulong rets)
560 VIOsPAPRBus *bus = spapr->vio_bus;
561 VIOsPAPRDevice *dev;
562 uint32_t unit, enable;
564 if (nargs != 2) {
565 rtas_st(rets, 0, -3);
566 return;
568 unit = rtas_ld(args, 0);
569 enable = rtas_ld(args, 1);
570 dev = spapr_vio_find_by_reg(bus, unit);
571 if (!dev) {
572 rtas_st(rets, 0, -3);
573 return;
575 if (enable) {
576 dev->flags |= VIO_PAPR_FLAG_DMA_BYPASS;
577 } else {
578 dev->flags &= ~VIO_PAPR_FLAG_DMA_BYPASS;
581 rtas_st(rets, 0, 0);
584 static void rtas_quiesce(sPAPREnvironment *spapr, uint32_t token,
585 uint32_t nargs, target_ulong args,
586 uint32_t nret, target_ulong rets)
588 VIOsPAPRBus *bus = spapr->vio_bus;
589 DeviceState *qdev;
590 VIOsPAPRDevice *dev = NULL;
592 if (nargs != 0) {
593 rtas_st(rets, 0, -3);
594 return;
597 QTAILQ_FOREACH(qdev, &bus->bus.children, sibling) {
598 dev = (VIOsPAPRDevice *)qdev;
599 spapr_vio_quiesce_one(dev);
602 rtas_st(rets, 0, 0);
605 static int spapr_vio_busdev_init(DeviceState *qdev, DeviceInfo *qinfo)
607 VIOsPAPRDeviceInfo *info = (VIOsPAPRDeviceInfo *)qinfo;
608 VIOsPAPRDevice *dev = (VIOsPAPRDevice *)qdev;
609 char *id;
611 if (asprintf(&id, "%s@%x", info->dt_name, dev->reg) < 0) {
612 return -1;
615 dev->qdev.id = id;
617 dev->qirq = spapr_allocate_irq(dev->vio_irq_num, &dev->vio_irq_num);
618 if (!dev->qirq) {
619 return -1;
622 rtce_init(dev);
624 return info->init(dev);
627 void spapr_vio_bus_register_withprop(VIOsPAPRDeviceInfo *info)
629 info->qdev.init = spapr_vio_busdev_init;
630 info->qdev.bus_info = &spapr_vio_bus_info;
632 assert(info->qdev.size >= sizeof(VIOsPAPRDevice));
633 qdev_register(&info->qdev);
636 static target_ulong h_vio_signal(CPUState *env, sPAPREnvironment *spapr,
637 target_ulong opcode,
638 target_ulong *args)
640 target_ulong reg = args[0];
641 target_ulong mode = args[1];
642 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
643 VIOsPAPRDeviceInfo *info;
645 if (!dev) {
646 return H_PARAMETER;
649 info = (VIOsPAPRDeviceInfo *)dev->qdev.info;
651 if (mode & ~info->signal_mask) {
652 return H_PARAMETER;
655 dev->signal_state = mode;
657 return H_SUCCESS;
660 VIOsPAPRBus *spapr_vio_bus_init(void)
662 VIOsPAPRBus *bus;
663 BusState *qbus;
664 DeviceState *dev;
665 DeviceInfo *qinfo;
667 /* Create bridge device */
668 dev = qdev_create(NULL, "spapr-vio-bridge");
669 qdev_init_nofail(dev);
671 /* Create bus on bridge device */
673 qbus = qbus_create(&spapr_vio_bus_info, dev, "spapr-vio");
674 bus = DO_UPCAST(VIOsPAPRBus, bus, qbus);
676 /* hcall-vio */
677 spapr_register_hypercall(H_VIO_SIGNAL, h_vio_signal);
679 /* hcall-tce */
680 spapr_register_hypercall(H_PUT_TCE, h_put_tce);
682 /* hcall-crq */
683 spapr_register_hypercall(H_REG_CRQ, h_reg_crq);
684 spapr_register_hypercall(H_FREE_CRQ, h_free_crq);
685 spapr_register_hypercall(H_SEND_CRQ, h_send_crq);
686 spapr_register_hypercall(H_ENABLE_CRQ, h_enable_crq);
688 /* RTAS calls */
689 spapr_rtas_register("ibm,set-tce-bypass", rtas_set_tce_bypass);
690 spapr_rtas_register("quiesce", rtas_quiesce);
692 for (qinfo = device_info_list; qinfo; qinfo = qinfo->next) {
693 VIOsPAPRDeviceInfo *info = (VIOsPAPRDeviceInfo *)qinfo;
695 if (qinfo->bus_info != &spapr_vio_bus_info) {
696 continue;
699 if (info->hcalls) {
700 info->hcalls(bus);
704 return bus;
707 /* Represents sPAPR hcall VIO devices */
709 static int spapr_vio_bridge_init(SysBusDevice *dev)
711 /* nothing */
712 return 0;
715 static SysBusDeviceInfo spapr_vio_bridge_info = {
716 .init = spapr_vio_bridge_init,
717 .qdev.name = "spapr-vio-bridge",
718 .qdev.size = sizeof(SysBusDevice),
719 .qdev.no_user = 1,
722 static void spapr_vio_register_devices(void)
724 sysbus_register_withprop(&spapr_vio_bridge_info);
727 device_init(spapr_vio_register_devices)
729 #ifdef CONFIG_FDT
730 int spapr_populate_vdevice(VIOsPAPRBus *bus, void *fdt)
732 DeviceState *qdev;
733 int ret = 0;
735 QTAILQ_FOREACH(qdev, &bus->bus.children, sibling) {
736 VIOsPAPRDevice *dev = (VIOsPAPRDevice *)qdev;
738 ret = vio_make_devnode(dev, fdt);
740 if (ret < 0) {
741 return ret;
745 return 0;
747 #endif /* CONFIG_FDT */