virtio-ccw: remove stale comments on endianness
[qemu.git] / hw / ppc / spapr_iommu.c
blobfa8b9698401856d20ba8c7ed05b7258f6e17fa19
1 /*
2 * QEMU sPAPR IOMMU (TCE) code
4 * Copyright (c) 2010 David Gibson, IBM Corporation <dwg@au1.ibm.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 #include "qemu/osdep.h"
20 #include "qemu/error-report.h"
21 #include "hw/hw.h"
22 #include "qemu/log.h"
23 #include "sysemu/kvm.h"
24 #include "hw/qdev.h"
25 #include "kvm_ppc.h"
26 #include "sysemu/dma.h"
27 #include "exec/address-spaces.h"
28 #include "trace.h"
30 #include "hw/ppc/spapr.h"
31 #include "hw/ppc/spapr_vio.h"
33 #include <libfdt.h>
35 enum sPAPRTCEAccess {
36 SPAPR_TCE_FAULT = 0,
37 SPAPR_TCE_RO = 1,
38 SPAPR_TCE_WO = 2,
39 SPAPR_TCE_RW = 3,
42 #define IOMMU_PAGE_SIZE(shift) (1ULL << (shift))
43 #define IOMMU_PAGE_MASK(shift) (~(IOMMU_PAGE_SIZE(shift) - 1))
45 static QLIST_HEAD(spapr_tce_tables, sPAPRTCETable) spapr_tce_tables;
47 sPAPRTCETable *spapr_tce_find_by_liobn(target_ulong liobn)
49 sPAPRTCETable *tcet;
51 if (liobn & 0xFFFFFFFF00000000ULL) {
52 hcall_dprintf("Request for out-of-bounds LIOBN 0x" TARGET_FMT_lx "\n",
53 liobn);
54 return NULL;
57 QLIST_FOREACH(tcet, &spapr_tce_tables, list) {
58 if (tcet->liobn == (uint32_t)liobn) {
59 return tcet;
63 return NULL;
66 static IOMMUAccessFlags spapr_tce_iommu_access_flags(uint64_t tce)
68 switch (tce & SPAPR_TCE_RW) {
69 case SPAPR_TCE_FAULT:
70 return IOMMU_NONE;
71 case SPAPR_TCE_RO:
72 return IOMMU_RO;
73 case SPAPR_TCE_WO:
74 return IOMMU_WO;
75 default: /* SPAPR_TCE_RW */
76 return IOMMU_RW;
80 static uint64_t *spapr_tce_alloc_table(uint32_t liobn,
81 uint32_t page_shift,
82 uint64_t bus_offset,
83 uint32_t nb_table,
84 int *fd,
85 bool need_vfio)
87 uint64_t *table = NULL;
89 if (kvm_enabled()) {
90 table = kvmppc_create_spapr_tce(liobn, page_shift, bus_offset, nb_table,
91 fd, need_vfio);
94 if (!table) {
95 *fd = -1;
96 table = g_malloc0(nb_table * sizeof(uint64_t));
99 trace_spapr_iommu_new_table(liobn, table, *fd);
101 return table;
104 static void spapr_tce_free_table(uint64_t *table, int fd, uint32_t nb_table)
106 if (!kvm_enabled() ||
107 (kvmppc_remove_spapr_tce(table, fd, nb_table) != 0)) {
108 g_free(table);
112 /* Called from RCU critical section */
113 static IOMMUTLBEntry spapr_tce_translate_iommu(IOMMUMemoryRegion *iommu,
114 hwaddr addr,
115 IOMMUAccessFlags flag)
117 sPAPRTCETable *tcet = container_of(iommu, sPAPRTCETable, iommu);
118 uint64_t tce;
119 IOMMUTLBEntry ret = {
120 .target_as = &address_space_memory,
121 .iova = 0,
122 .translated_addr = 0,
123 .addr_mask = ~(hwaddr)0,
124 .perm = IOMMU_NONE,
127 if ((addr >> tcet->page_shift) < tcet->nb_table) {
128 /* Check if we are in bound */
129 hwaddr page_mask = IOMMU_PAGE_MASK(tcet->page_shift);
131 tce = tcet->table[addr >> tcet->page_shift];
132 ret.iova = addr & page_mask;
133 ret.translated_addr = tce & page_mask;
134 ret.addr_mask = ~page_mask;
135 ret.perm = spapr_tce_iommu_access_flags(tce);
137 trace_spapr_iommu_xlate(tcet->liobn, addr, ret.iova, ret.perm,
138 ret.addr_mask);
140 return ret;
143 static void spapr_tce_table_pre_save(void *opaque)
145 sPAPRTCETable *tcet = SPAPR_TCE_TABLE(opaque);
147 tcet->mig_table = tcet->table;
148 tcet->mig_nb_table = tcet->nb_table;
150 trace_spapr_iommu_pre_save(tcet->liobn, tcet->mig_nb_table,
151 tcet->bus_offset, tcet->page_shift);
154 static uint64_t spapr_tce_get_min_page_size(IOMMUMemoryRegion *iommu)
156 sPAPRTCETable *tcet = container_of(iommu, sPAPRTCETable, iommu);
158 return 1ULL << tcet->page_shift;
161 static void spapr_tce_notify_flag_changed(IOMMUMemoryRegion *iommu,
162 IOMMUNotifierFlag old,
163 IOMMUNotifierFlag new)
165 struct sPAPRTCETable *tbl = container_of(iommu, sPAPRTCETable, iommu);
167 if (old == IOMMU_NOTIFIER_NONE && new != IOMMU_NOTIFIER_NONE) {
168 spapr_tce_set_need_vfio(tbl, true);
169 } else if (old != IOMMU_NOTIFIER_NONE && new == IOMMU_NOTIFIER_NONE) {
170 spapr_tce_set_need_vfio(tbl, false);
174 static int spapr_tce_table_post_load(void *opaque, int version_id)
176 sPAPRTCETable *tcet = SPAPR_TCE_TABLE(opaque);
177 uint32_t old_nb_table = tcet->nb_table;
178 uint64_t old_bus_offset = tcet->bus_offset;
179 uint32_t old_page_shift = tcet->page_shift;
181 if (tcet->vdev) {
182 spapr_vio_set_bypass(tcet->vdev, tcet->bypass);
185 if (tcet->mig_nb_table != tcet->nb_table) {
186 spapr_tce_table_disable(tcet);
189 if (tcet->mig_nb_table) {
190 if (!tcet->nb_table) {
191 spapr_tce_table_enable(tcet, old_page_shift, old_bus_offset,
192 tcet->mig_nb_table);
195 memcpy(tcet->table, tcet->mig_table,
196 tcet->nb_table * sizeof(tcet->table[0]));
198 free(tcet->mig_table);
199 tcet->mig_table = NULL;
202 trace_spapr_iommu_post_load(tcet->liobn, old_nb_table, tcet->nb_table,
203 tcet->bus_offset, tcet->page_shift);
205 return 0;
208 static bool spapr_tce_table_ex_needed(void *opaque)
210 sPAPRTCETable *tcet = opaque;
212 return tcet->bus_offset || tcet->page_shift != 0xC;
215 static const VMStateDescription vmstate_spapr_tce_table_ex = {
216 .name = "spapr_iommu_ex",
217 .version_id = 1,
218 .minimum_version_id = 1,
219 .needed = spapr_tce_table_ex_needed,
220 .fields = (VMStateField[]) {
221 VMSTATE_UINT64(bus_offset, sPAPRTCETable),
222 VMSTATE_UINT32(page_shift, sPAPRTCETable),
223 VMSTATE_END_OF_LIST()
227 static const VMStateDescription vmstate_spapr_tce_table = {
228 .name = "spapr_iommu",
229 .version_id = 2,
230 .minimum_version_id = 2,
231 .pre_save = spapr_tce_table_pre_save,
232 .post_load = spapr_tce_table_post_load,
233 .fields = (VMStateField []) {
234 /* Sanity check */
235 VMSTATE_UINT32_EQUAL(liobn, sPAPRTCETable, NULL),
237 /* IOMMU state */
238 VMSTATE_UINT32(mig_nb_table, sPAPRTCETable),
239 VMSTATE_BOOL(bypass, sPAPRTCETable),
240 VMSTATE_VARRAY_UINT32_ALLOC(mig_table, sPAPRTCETable, mig_nb_table, 0,
241 vmstate_info_uint64, uint64_t),
243 VMSTATE_END_OF_LIST()
245 .subsections = (const VMStateDescription*[]) {
246 &vmstate_spapr_tce_table_ex,
247 NULL
251 static void spapr_tce_table_realize(DeviceState *dev, Error **errp)
253 sPAPRTCETable *tcet = SPAPR_TCE_TABLE(dev);
254 Object *tcetobj = OBJECT(tcet);
255 gchar *tmp;
257 tcet->fd = -1;
258 tcet->need_vfio = false;
259 tmp = g_strdup_printf("tce-root-%x", tcet->liobn);
260 memory_region_init(&tcet->root, tcetobj, tmp, UINT64_MAX);
261 g_free(tmp);
263 tmp = g_strdup_printf("tce-iommu-%x", tcet->liobn);
264 memory_region_init_iommu(&tcet->iommu, sizeof(tcet->iommu),
265 TYPE_SPAPR_IOMMU_MEMORY_REGION,
266 tcetobj, tmp, 0);
267 g_free(tmp);
269 QLIST_INSERT_HEAD(&spapr_tce_tables, tcet, list);
271 vmstate_register(DEVICE(tcet), tcet->liobn, &vmstate_spapr_tce_table,
272 tcet);
275 void spapr_tce_set_need_vfio(sPAPRTCETable *tcet, bool need_vfio)
277 size_t table_size = tcet->nb_table * sizeof(uint64_t);
278 uint64_t *oldtable;
279 int newfd = -1;
281 g_assert(need_vfio != tcet->need_vfio);
283 tcet->need_vfio = need_vfio;
285 oldtable = tcet->table;
287 tcet->table = spapr_tce_alloc_table(tcet->liobn,
288 tcet->page_shift,
289 tcet->bus_offset,
290 tcet->nb_table,
291 &newfd,
292 need_vfio);
293 memcpy(tcet->table, oldtable, table_size);
295 spapr_tce_free_table(oldtable, tcet->fd, tcet->nb_table);
297 tcet->fd = newfd;
300 sPAPRTCETable *spapr_tce_new_table(DeviceState *owner, uint32_t liobn)
302 sPAPRTCETable *tcet;
303 gchar *tmp;
305 if (spapr_tce_find_by_liobn(liobn)) {
306 error_report("Attempted to create TCE table with duplicate"
307 " LIOBN 0x%x", liobn);
308 return NULL;
311 tcet = SPAPR_TCE_TABLE(object_new(TYPE_SPAPR_TCE_TABLE));
312 tcet->liobn = liobn;
314 tmp = g_strdup_printf("tce-table-%x", liobn);
315 object_property_add_child(OBJECT(owner), tmp, OBJECT(tcet), NULL);
316 g_free(tmp);
317 object_unref(OBJECT(tcet));
319 object_property_set_bool(OBJECT(tcet), true, "realized", NULL);
321 return tcet;
324 void spapr_tce_table_enable(sPAPRTCETable *tcet,
325 uint32_t page_shift, uint64_t bus_offset,
326 uint32_t nb_table)
328 if (tcet->nb_table) {
329 warn_report("trying to enable already enabled TCE table");
330 return;
333 tcet->bus_offset = bus_offset;
334 tcet->page_shift = page_shift;
335 tcet->nb_table = nb_table;
336 tcet->table = spapr_tce_alloc_table(tcet->liobn,
337 tcet->page_shift,
338 tcet->bus_offset,
339 tcet->nb_table,
340 &tcet->fd,
341 tcet->need_vfio);
343 memory_region_set_size(MEMORY_REGION(&tcet->iommu),
344 (uint64_t)tcet->nb_table << tcet->page_shift);
345 memory_region_add_subregion(&tcet->root, tcet->bus_offset,
346 MEMORY_REGION(&tcet->iommu));
349 void spapr_tce_table_disable(sPAPRTCETable *tcet)
351 if (!tcet->nb_table) {
352 return;
355 memory_region_del_subregion(&tcet->root, MEMORY_REGION(&tcet->iommu));
356 memory_region_set_size(MEMORY_REGION(&tcet->iommu), 0);
358 spapr_tce_free_table(tcet->table, tcet->fd, tcet->nb_table);
359 tcet->fd = -1;
360 tcet->table = NULL;
361 tcet->bus_offset = 0;
362 tcet->page_shift = 0;
363 tcet->nb_table = 0;
366 static void spapr_tce_table_unrealize(DeviceState *dev, Error **errp)
368 sPAPRTCETable *tcet = SPAPR_TCE_TABLE(dev);
370 vmstate_unregister(DEVICE(tcet), &vmstate_spapr_tce_table, tcet);
372 QLIST_REMOVE(tcet, list);
374 spapr_tce_table_disable(tcet);
377 MemoryRegion *spapr_tce_get_iommu(sPAPRTCETable *tcet)
379 return &tcet->root;
382 static void spapr_tce_reset(DeviceState *dev)
384 sPAPRTCETable *tcet = SPAPR_TCE_TABLE(dev);
385 size_t table_size = tcet->nb_table * sizeof(uint64_t);
387 if (tcet->nb_table) {
388 memset(tcet->table, 0, table_size);
392 static target_ulong put_tce_emu(sPAPRTCETable *tcet, target_ulong ioba,
393 target_ulong tce)
395 IOMMUTLBEntry entry;
396 hwaddr page_mask = IOMMU_PAGE_MASK(tcet->page_shift);
397 unsigned long index = (ioba - tcet->bus_offset) >> tcet->page_shift;
399 if (index >= tcet->nb_table) {
400 hcall_dprintf("spapr_vio_put_tce on out-of-bounds IOBA 0x"
401 TARGET_FMT_lx "\n", ioba);
402 return H_PARAMETER;
405 tcet->table[index] = tce;
407 entry.target_as = &address_space_memory,
408 entry.iova = (ioba - tcet->bus_offset) & page_mask;
409 entry.translated_addr = tce & page_mask;
410 entry.addr_mask = ~page_mask;
411 entry.perm = spapr_tce_iommu_access_flags(tce);
412 memory_region_notify_iommu(&tcet->iommu, entry);
414 return H_SUCCESS;
417 static target_ulong h_put_tce_indirect(PowerPCCPU *cpu,
418 sPAPRMachineState *spapr,
419 target_ulong opcode, target_ulong *args)
421 int i;
422 target_ulong liobn = args[0];
423 target_ulong ioba = args[1];
424 target_ulong ioba1 = ioba;
425 target_ulong tce_list = args[2];
426 target_ulong npages = args[3];
427 target_ulong ret = H_PARAMETER, tce = 0;
428 sPAPRTCETable *tcet = spapr_tce_find_by_liobn(liobn);
429 CPUState *cs = CPU(cpu);
430 hwaddr page_mask, page_size;
432 if (!tcet) {
433 return H_PARAMETER;
436 if ((npages > 512) || (tce_list & SPAPR_TCE_PAGE_MASK)) {
437 return H_PARAMETER;
440 page_mask = IOMMU_PAGE_MASK(tcet->page_shift);
441 page_size = IOMMU_PAGE_SIZE(tcet->page_shift);
442 ioba &= page_mask;
444 for (i = 0; i < npages; ++i, ioba += page_size) {
445 tce = ldq_be_phys(cs->as, tce_list + i * sizeof(target_ulong));
447 ret = put_tce_emu(tcet, ioba, tce);
448 if (ret) {
449 break;
453 /* Trace last successful or the first problematic entry */
454 i = i ? (i - 1) : 0;
455 if (SPAPR_IS_PCI_LIOBN(liobn)) {
456 trace_spapr_iommu_pci_indirect(liobn, ioba1, tce_list, i, tce, ret);
457 } else {
458 trace_spapr_iommu_indirect(liobn, ioba1, tce_list, i, tce, ret);
460 return ret;
463 static target_ulong h_stuff_tce(PowerPCCPU *cpu, sPAPRMachineState *spapr,
464 target_ulong opcode, target_ulong *args)
466 int i;
467 target_ulong liobn = args[0];
468 target_ulong ioba = args[1];
469 target_ulong tce_value = args[2];
470 target_ulong npages = args[3];
471 target_ulong ret = H_PARAMETER;
472 sPAPRTCETable *tcet = spapr_tce_find_by_liobn(liobn);
473 hwaddr page_mask, page_size;
475 if (!tcet) {
476 return H_PARAMETER;
479 if (npages > tcet->nb_table) {
480 return H_PARAMETER;
483 page_mask = IOMMU_PAGE_MASK(tcet->page_shift);
484 page_size = IOMMU_PAGE_SIZE(tcet->page_shift);
485 ioba &= page_mask;
487 for (i = 0; i < npages; ++i, ioba += page_size) {
488 ret = put_tce_emu(tcet, ioba, tce_value);
489 if (ret) {
490 break;
493 if (SPAPR_IS_PCI_LIOBN(liobn)) {
494 trace_spapr_iommu_pci_stuff(liobn, ioba, tce_value, npages, ret);
495 } else {
496 trace_spapr_iommu_stuff(liobn, ioba, tce_value, npages, ret);
499 return ret;
502 static target_ulong h_put_tce(PowerPCCPU *cpu, sPAPRMachineState *spapr,
503 target_ulong opcode, target_ulong *args)
505 target_ulong liobn = args[0];
506 target_ulong ioba = args[1];
507 target_ulong tce = args[2];
508 target_ulong ret = H_PARAMETER;
509 sPAPRTCETable *tcet = spapr_tce_find_by_liobn(liobn);
511 if (tcet) {
512 hwaddr page_mask = IOMMU_PAGE_MASK(tcet->page_shift);
514 ioba &= page_mask;
516 ret = put_tce_emu(tcet, ioba, tce);
518 if (SPAPR_IS_PCI_LIOBN(liobn)) {
519 trace_spapr_iommu_pci_put(liobn, ioba, tce, ret);
520 } else {
521 trace_spapr_iommu_put(liobn, ioba, tce, ret);
524 return ret;
527 static target_ulong get_tce_emu(sPAPRTCETable *tcet, target_ulong ioba,
528 target_ulong *tce)
530 unsigned long index = (ioba - tcet->bus_offset) >> tcet->page_shift;
532 if (index >= tcet->nb_table) {
533 hcall_dprintf("spapr_iommu_get_tce on out-of-bounds IOBA 0x"
534 TARGET_FMT_lx "\n", ioba);
535 return H_PARAMETER;
538 *tce = tcet->table[index];
540 return H_SUCCESS;
543 static target_ulong h_get_tce(PowerPCCPU *cpu, sPAPRMachineState *spapr,
544 target_ulong opcode, target_ulong *args)
546 target_ulong liobn = args[0];
547 target_ulong ioba = args[1];
548 target_ulong tce = 0;
549 target_ulong ret = H_PARAMETER;
550 sPAPRTCETable *tcet = spapr_tce_find_by_liobn(liobn);
552 if (tcet) {
553 hwaddr page_mask = IOMMU_PAGE_MASK(tcet->page_shift);
555 ioba &= page_mask;
557 ret = get_tce_emu(tcet, ioba, &tce);
558 if (!ret) {
559 args[0] = tce;
562 if (SPAPR_IS_PCI_LIOBN(liobn)) {
563 trace_spapr_iommu_pci_get(liobn, ioba, ret, tce);
564 } else {
565 trace_spapr_iommu_get(liobn, ioba, ret, tce);
568 return ret;
571 int spapr_dma_dt(void *fdt, int node_off, const char *propname,
572 uint32_t liobn, uint64_t window, uint32_t size)
574 uint32_t dma_prop[5];
575 int ret;
577 dma_prop[0] = cpu_to_be32(liobn);
578 dma_prop[1] = cpu_to_be32(window >> 32);
579 dma_prop[2] = cpu_to_be32(window & 0xFFFFFFFF);
580 dma_prop[3] = 0; /* window size is 32 bits */
581 dma_prop[4] = cpu_to_be32(size);
583 ret = fdt_setprop_cell(fdt, node_off, "ibm,#dma-address-cells", 2);
584 if (ret < 0) {
585 return ret;
588 ret = fdt_setprop_cell(fdt, node_off, "ibm,#dma-size-cells", 2);
589 if (ret < 0) {
590 return ret;
593 ret = fdt_setprop(fdt, node_off, propname, dma_prop, sizeof(dma_prop));
594 if (ret < 0) {
595 return ret;
598 return 0;
601 int spapr_tcet_dma_dt(void *fdt, int node_off, const char *propname,
602 sPAPRTCETable *tcet)
604 if (!tcet) {
605 return 0;
608 return spapr_dma_dt(fdt, node_off, propname,
609 tcet->liobn, 0, tcet->nb_table << tcet->page_shift);
612 static void spapr_tce_table_class_init(ObjectClass *klass, void *data)
614 DeviceClass *dc = DEVICE_CLASS(klass);
615 dc->realize = spapr_tce_table_realize;
616 dc->reset = spapr_tce_reset;
617 dc->unrealize = spapr_tce_table_unrealize;
618 /* Reason: This is just an internal device for handling the hypercalls */
619 dc->user_creatable = false;
621 QLIST_INIT(&spapr_tce_tables);
623 /* hcall-tce */
624 spapr_register_hypercall(H_PUT_TCE, h_put_tce);
625 spapr_register_hypercall(H_GET_TCE, h_get_tce);
626 spapr_register_hypercall(H_PUT_TCE_INDIRECT, h_put_tce_indirect);
627 spapr_register_hypercall(H_STUFF_TCE, h_stuff_tce);
630 static TypeInfo spapr_tce_table_info = {
631 .name = TYPE_SPAPR_TCE_TABLE,
632 .parent = TYPE_DEVICE,
633 .instance_size = sizeof(sPAPRTCETable),
634 .class_init = spapr_tce_table_class_init,
637 static void spapr_iommu_memory_region_class_init(ObjectClass *klass, void *data)
639 IOMMUMemoryRegionClass *imrc = IOMMU_MEMORY_REGION_CLASS(klass);
641 imrc->translate = spapr_tce_translate_iommu;
642 imrc->get_min_page_size = spapr_tce_get_min_page_size;
643 imrc->notify_flag_changed = spapr_tce_notify_flag_changed;
646 static const TypeInfo spapr_iommu_memory_region_info = {
647 .parent = TYPE_IOMMU_MEMORY_REGION,
648 .name = TYPE_SPAPR_IOMMU_MEMORY_REGION,
649 .class_init = spapr_iommu_memory_region_class_init,
652 static void register_types(void)
654 type_register_static(&spapr_tce_table_info);
655 type_register_static(&spapr_iommu_memory_region_info);
658 type_init(register_types);