[thirdparty/qemu.git] / hw / dma / sun4m_iommu.c

/*
 * QEMU Sun4m iommu emulation
 *
 * Copyright (c) 2003-2005 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "qemu/osdep.h"
#include "hw/sparc/sun4m.h"
#include "hw/sysbus.h"
#include "exec/address-spaces.h"
#include "trace.h"

/*
 * I/O MMU used by Sun4m systems
 *
 * Chipset docs:
 * "Sun-4M System Architecture (revision 2.0) by Chuck Narad", 950-1373-01,
 * http://mediacast.sun.com/users/Barton808/media/Sun4M_SystemArchitecture_edited2.pdf
 */

#define IOMMU_NREGS         (4*4096/4)
#define IOMMU_CTRL          (0x0000 >> 2)
#define IOMMU_CTRL_IMPL     0xf0000000 /* Implementation */
#define IOMMU_CTRL_VERS     0x0f000000 /* Version */
#define IOMMU_CTRL_RNGE     0x0000001c /* Mapping RANGE */
#define IOMMU_RNGE_16MB     0x00000000 /* 0xff000000 -> 0xffffffff */
#define IOMMU_RNGE_32MB     0x00000004 /* 0xfe000000 -> 0xffffffff */
#define IOMMU_RNGE_64MB     0x00000008 /* 0xfc000000 -> 0xffffffff */
#define IOMMU_RNGE_128MB    0x0000000c /* 0xf8000000 -> 0xffffffff */
#define IOMMU_RNGE_256MB    0x00000010 /* 0xf0000000 -> 0xffffffff */
#define IOMMU_RNGE_512MB    0x00000014 /* 0xe0000000 -> 0xffffffff */
#define IOMMU_RNGE_1GB      0x00000018 /* 0xc0000000 -> 0xffffffff */
#define IOMMU_RNGE_2GB      0x0000001c /* 0x80000000 -> 0xffffffff */
#define IOMMU_CTRL_ENAB     0x00000001 /* IOMMU Enable */
#define IOMMU_CTRL_MASK     0x0000001d

#define IOMMU_BASE          (0x0004 >> 2)
#define IOMMU_BASE_MASK     0x07fffc00

#define IOMMU_TLBFLUSH      (0x0014 >> 2)
#define IOMMU_TLBFLUSH_MASK 0xffffffff

#define IOMMU_PGFLUSH       (0x0018 >> 2)
#define IOMMU_PGFLUSH_MASK  0xffffffff

#define IOMMU_AFSR          (0x1000 >> 2)
#define IOMMU_AFSR_ERR      0x80000000 /* LE, TO, or BE asserted */
#define IOMMU_AFSR_LE       0x40000000 /* SBUS reports error after
                                          transaction */
#define IOMMU_AFSR_TO       0x20000000 /* Write access took more than
                                          12.8 us. */
#define IOMMU_AFSR_BE       0x10000000 /* Write access received error
                                          acknowledge */
#define IOMMU_AFSR_SIZE     0x0e000000 /* Size of transaction causing error */
#define IOMMU_AFSR_S        0x01000000 /* Sparc was in supervisor mode */
#define IOMMU_AFSR_RESV     0x00800000 /* Reserved, forced to 0x8 by
                                          hardware */
#define IOMMU_AFSR_ME       0x00080000 /* Multiple errors occurred */
#define IOMMU_AFSR_RD       0x00040000 /* A read operation was in progress */
#define IOMMU_AFSR_FAV      0x00020000 /* IOMMU afar has valid contents */
#define IOMMU_AFSR_MASK     0xff0fffff

#define IOMMU_AFAR          (0x1004 >> 2)

#define IOMMU_AER           (0x1008 >> 2) /* Arbiter Enable Register */
#define IOMMU_AER_EN_P0_ARB 0x00000001    /* MBus master 0x8 (Always 1) */
#define IOMMU_AER_EN_P1_ARB 0x00000002    /* MBus master 0x9 */
#define IOMMU_AER_EN_P2_ARB 0x00000004    /* MBus master 0xa */
#define IOMMU_AER_EN_P3_ARB 0x00000008    /* MBus master 0xb */
#define IOMMU_AER_EN_0      0x00010000    /* SBus slot 0 */
#define IOMMU_AER_EN_1      0x00020000    /* SBus slot 1 */
#define IOMMU_AER_EN_2      0x00040000    /* SBus slot 2 */
#define IOMMU_AER_EN_3      0x00080000    /* SBus slot 3 */
#define IOMMU_AER_EN_F      0x00100000    /* SBus on-board */
#define IOMMU_AER_SBW       0x80000000    /* S-to-M asynchronous writes */
#define IOMMU_AER_MASK      0x801f000f

#define IOMMU_SBCFG0        (0x1010 >> 2) /* SBUS configration per-slot */
#define IOMMU_SBCFG1        (0x1014 >> 2) /* SBUS configration per-slot */
#define IOMMU_SBCFG2        (0x1018 >> 2) /* SBUS configration per-slot */
#define IOMMU_SBCFG3        (0x101c >> 2) /* SBUS configration per-slot */
#define IOMMU_SBCFG_SAB30   0x00010000 /* Phys-address bit 30 when
                                          bypass enabled */
#define IOMMU_SBCFG_BA16    0x00000004 /* Slave supports 16 byte bursts */
#define IOMMU_SBCFG_BA8     0x00000002 /* Slave supports 8 byte bursts */
#define IOMMU_SBCFG_BYPASS  0x00000001 /* Bypass IOMMU, treat all addresses
                                          produced by this device as pure
                                          physical. */
#define IOMMU_SBCFG_MASK    0x00010003

#define IOMMU_ARBEN         (0x2000 >> 2) /* SBUS arbitration enable */
#define IOMMU_ARBEN_MASK    0x001f0000
#define IOMMU_MID           0x00000008

#define IOMMU_MASK_ID       (0x3018 >> 2) /* Mask ID */
#define IOMMU_MASK_ID_MASK  0x00ffffff

#define IOMMU_MSII_MASK     0x26000000 /* microSPARC II mask number */
#define IOMMU_TS_MASK       0x23000000 /* turboSPARC mask number */

/* The format of an iopte in the page tables */
#define IOPTE_PAGE          0xffffff00 /* Physical page number (PA[35:12]) */
#define IOPTE_CACHE         0x00000080 /* Cached (in vme IOCACHE or
                                          Viking/MXCC) */
#define IOPTE_WRITE         0x00000004 /* Writable */
#define IOPTE_VALID         0x00000002 /* IOPTE is valid */
#define IOPTE_WAZ           0x00000001 /* Write as zeros */

#define IOMMU_PAGE_SHIFT    12
#define IOMMU_PAGE_SIZE     (1 << IOMMU_PAGE_SHIFT)
#define IOMMU_PAGE_MASK     ~(IOMMU_PAGE_SIZE - 1)

#define TYPE_SUN4M_IOMMU "iommu"
#define SUN4M_IOMMU(obj) OBJECT_CHECK(IOMMUState, (obj), TYPE_SUN4M_IOMMU)

typedef struct IOMMUState {
    SysBusDevice parent_obj;

    MemoryRegion iomem;
    uint32_t regs[IOMMU_NREGS];
    hwaddr iostart;
    qemu_irq irq;
    uint32_t version;
} IOMMUState;

static uint64_t iommu_mem_read(void *opaque, hwaddr addr,
                               unsigned size)
{
    IOMMUState *s = opaque;
    hwaddr saddr;
    uint32_t ret;

    saddr = addr >> 2;
    switch (saddr) {
    default:
        ret = s->regs[saddr];
        break;
    case IOMMU_AFAR:
    case IOMMU_AFSR:
        ret = s->regs[saddr];
        qemu_irq_lower(s->irq);
        break;
    }
    trace_sun4m_iommu_mem_readl(saddr, ret);
    return ret;
}

static void iommu_mem_write(void *opaque, hwaddr addr,
                            uint64_t val, unsigned size)
{
    IOMMUState *s = opaque;
    hwaddr saddr;

    saddr = addr >> 2;
    trace_sun4m_iommu_mem_writel(saddr, val);
    switch (saddr) {
    case IOMMU_CTRL:
        switch (val & IOMMU_CTRL_RNGE) {
        case IOMMU_RNGE_16MB:
            s->iostart = 0xffffffffff000000ULL;
            break;
        case IOMMU_RNGE_32MB:
            s->iostart = 0xfffffffffe000000ULL;
            break;
        case IOMMU_RNGE_64MB:
            s->iostart = 0xfffffffffc000000ULL;
            break;
        case IOMMU_RNGE_128MB:
            s->iostart = 0xfffffffff8000000ULL;
            break;
        case IOMMU_RNGE_256MB:
            s->iostart = 0xfffffffff0000000ULL;
            break;
        case IOMMU_RNGE_512MB:
            s->iostart = 0xffffffffe0000000ULL;
            break;
        case IOMMU_RNGE_1GB:
            s->iostart = 0xffffffffc0000000ULL;
            break;
        default:
        case IOMMU_RNGE_2GB:
            s->iostart = 0xffffffff80000000ULL;
            break;
        }
        trace_sun4m_iommu_mem_writel_ctrl(s->iostart);
        s->regs[saddr] = ((val & IOMMU_CTRL_MASK) | s->version);
        break;
    case IOMMU_BASE:
        s->regs[saddr] = val & IOMMU_BASE_MASK;
        break;
    case IOMMU_TLBFLUSH:
        trace_sun4m_iommu_mem_writel_tlbflush(val);
        s->regs[saddr] = val & IOMMU_TLBFLUSH_MASK;
        break;
    case IOMMU_PGFLUSH:
        trace_sun4m_iommu_mem_writel_pgflush(val);
        s->regs[saddr] = val & IOMMU_PGFLUSH_MASK;
        break;
    case IOMMU_AFAR:
        s->regs[saddr] = val;
        qemu_irq_lower(s->irq);
        break;
    case IOMMU_AER:
        s->regs[saddr] = (val & IOMMU_AER_MASK) | IOMMU_AER_EN_P0_ARB;
        break;
    case IOMMU_AFSR:
        s->regs[saddr] = (val & IOMMU_AFSR_MASK) | IOMMU_AFSR_RESV;
        qemu_irq_lower(s->irq);
        break;
    case IOMMU_SBCFG0:
    case IOMMU_SBCFG1:
    case IOMMU_SBCFG2:
    case IOMMU_SBCFG3:
        s->regs[saddr] = val & IOMMU_SBCFG_MASK;
        break;
    case IOMMU_ARBEN:
        // XXX implement SBus probing: fault when reading unmapped
        // addresses, fault cause and address stored to MMU/IOMMU
        s->regs[saddr] = (val & IOMMU_ARBEN_MASK) | IOMMU_MID;
        break;
    case IOMMU_MASK_ID:
        s->regs[saddr] |= val & IOMMU_MASK_ID_MASK;
        break;
    default:
        s->regs[saddr] = val;
        break;
    }
}

static const MemoryRegionOps iommu_mem_ops = {
    .read = iommu_mem_read,
    .write = iommu_mem_write,
    .endianness = DEVICE_NATIVE_ENDIAN,
    .valid = {
        .min_access_size = 4,
        .max_access_size = 4,
    },
};

static uint32_t iommu_page_get_flags(IOMMUState *s, hwaddr addr)
{
    uint32_t ret;
    hwaddr iopte;
    hwaddr pa = addr;

    iopte = s->regs[IOMMU_BASE] << 4;
    addr &= ~s->iostart;
    iopte += (addr >> (IOMMU_PAGE_SHIFT - 2)) & ~3;
    ret = address_space_ldl_be(&address_space_memory, iopte,
                               MEMTXATTRS_UNSPECIFIED, NULL);
    trace_sun4m_iommu_page_get_flags(pa, iopte, ret);
    return ret;
}

static hwaddr iommu_translate_pa(hwaddr addr,
                                             uint32_t pte)
{
    hwaddr pa;

    pa = ((pte & IOPTE_PAGE) << 4) + (addr & ~IOMMU_PAGE_MASK);
    trace_sun4m_iommu_translate_pa(addr, pa, pte);
    return pa;
}

static void iommu_bad_addr(IOMMUState *s, hwaddr addr,
                           int is_write)
{
    trace_sun4m_iommu_bad_addr(addr);
    s->regs[IOMMU_AFSR] = IOMMU_AFSR_ERR | IOMMU_AFSR_LE | IOMMU_AFSR_RESV |
        IOMMU_AFSR_FAV;
    if (!is_write)
        s->regs[IOMMU_AFSR] |= IOMMU_AFSR_RD;
    s->regs[IOMMU_AFAR] = addr;
    qemu_irq_raise(s->irq);
}

void sparc_iommu_memory_rw(void *opaque, hwaddr addr,
                           uint8_t *buf, int len, int is_write)
{
    int l;
    uint32_t flags;
    hwaddr page, phys_addr;

    while (len > 0) {
        page = addr & IOMMU_PAGE_MASK;
        l = (page + IOMMU_PAGE_SIZE) - addr;
        if (l > len)
            l = len;
        flags = iommu_page_get_flags(opaque, page);
        if (!(flags & IOPTE_VALID)) {
            iommu_bad_addr(opaque, page, is_write);
            return;
        }
        phys_addr = iommu_translate_pa(addr, flags);
        if (is_write) {
            if (!(flags & IOPTE_WRITE)) {
                iommu_bad_addr(opaque, page, is_write);
                return;
            }
            cpu_physical_memory_write(phys_addr, buf, l);
        } else {
            cpu_physical_memory_read(phys_addr, buf, l);
        }
        len -= l;
        buf += l;
        addr += l;
    }
}

static const VMStateDescription vmstate_iommu = {
    .name ="iommu",
    .version_id = 2,
    .minimum_version_id = 2,
    .fields = (VMStateField[]) {
        VMSTATE_UINT32_ARRAY(regs, IOMMUState, IOMMU_NREGS),
        VMSTATE_UINT64(iostart, IOMMUState),
        VMSTATE_END_OF_LIST()
    }
};

static void iommu_reset(DeviceState *d)
{
    IOMMUState *s = SUN4M_IOMMU(d);

    memset(s->regs, 0, IOMMU_NREGS * 4);
    s->iostart = 0;
    s->regs[IOMMU_CTRL] = s->version;
    s->regs[IOMMU_ARBEN] = IOMMU_MID;
    s->regs[IOMMU_AFSR] = IOMMU_AFSR_RESV;
    s->regs[IOMMU_AER] = IOMMU_AER_EN_P0_ARB | IOMMU_AER_EN_P1_ARB;
    s->regs[IOMMU_MASK_ID] = IOMMU_TS_MASK;
}

static int iommu_init1(SysBusDevice *dev)
{
    IOMMUState *s = SUN4M_IOMMU(dev);

    sysbus_init_irq(dev, &s->irq);

    memory_region_init_io(&s->iomem, OBJECT(s), &iommu_mem_ops, s, "iommu",
                          IOMMU_NREGS * sizeof(uint32_t));
    sysbus_init_mmio(dev, &s->iomem);

    return 0;
}

static Property iommu_properties[] = {
    DEFINE_PROP_UINT32("version", IOMMUState, version, 0),
    DEFINE_PROP_END_OF_LIST(),
};

static void iommu_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);

    k->init = iommu_init1;
    dc->reset = iommu_reset;
    dc->vmsd = &vmstate_iommu;
    dc->props = iommu_properties;
}

static const TypeInfo iommu_info = {
    .name          = TYPE_SUN4M_IOMMU,
    .parent        = TYPE_SYS_BUS_DEVICE,
    .instance_size = sizeof(IOMMUState),
    .class_init    = iommu_class_init,
};

static void iommu_register_types(void)
{
    type_register_static(&iommu_info);
}

type_init(iommu_register_types)
Commit	Line	Data
420557e8	1	/*
93c5a32f	2	* QEMU Sun4m iommu emulation
420557e8	3	*
66321a11	4	* Copyright (c) 2003-2005 Fabrice Bellard
5fafdf24	5	*
420557e8 FB	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	19	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
5f750b2e	24
0430891c	25	#include "qemu/osdep.h"
0d09e41a	26	#include "hw/sparc/sun4m.h"
83c9f4ca	27	#include "hw/sysbus.h"
fdfba1a2	28	#include "exec/address-spaces.h"
97bf4851	29	#include "trace.h"
420557e8	30
93c5a32f BS	31	/*
	32	* I/O MMU used by Sun4m systems
	33	*
	34	* Chipset docs:
	35	* "Sun-4M System Architecture (revision 2.0) by Chuck Narad", 950-1373-01,
	36	* http://mediacast.sun.com/users/Barton808/media/Sun4M_SystemArchitecture_edited2.pdf
	37	*/
	38
e5e38121	39	#define IOMMU_NREGS (4*4096/4)
4e3b1ea1	40	#define IOMMU_CTRL (0x0000 >> 2)
420557e8 FB	41	#define IOMMU_CTRL_IMPL 0xf0000000 /* Implementation */
	42	#define IOMMU_CTRL_VERS 0x0f000000 /* Version */
	43	#define IOMMU_CTRL_RNGE 0x0000001c /* Mapping RANGE */
	44	#define IOMMU_RNGE_16MB 0x00000000 /* 0xff000000 -> 0xffffffff */
	45	#define IOMMU_RNGE_32MB 0x00000004 /* 0xfe000000 -> 0xffffffff */
	46	#define IOMMU_RNGE_64MB 0x00000008 /* 0xfc000000 -> 0xffffffff */
	47	#define IOMMU_RNGE_128MB 0x0000000c /* 0xf8000000 -> 0xffffffff */
	48	#define IOMMU_RNGE_256MB 0x00000010 /* 0xf0000000 -> 0xffffffff */
	49	#define IOMMU_RNGE_512MB 0x00000014 /* 0xe0000000 -> 0xffffffff */
	50	#define IOMMU_RNGE_1GB 0x00000018 /* 0xc0000000 -> 0xffffffff */
	51	#define IOMMU_RNGE_2GB 0x0000001c /* 0x80000000 -> 0xffffffff */
	52	#define IOMMU_CTRL_ENAB 0x00000001 /* IOMMU Enable */
4e3b1ea1 FB	53	#define IOMMU_CTRL_MASK 0x0000001d
	54
	55	#define IOMMU_BASE (0x0004 >> 2)
	56	#define IOMMU_BASE_MASK 0x07fffc00
	57
	58	#define IOMMU_TLBFLUSH (0x0014 >> 2)
	59	#define IOMMU_TLBFLUSH_MASK 0xffffffff
	60
	61	#define IOMMU_PGFLUSH (0x0018 >> 2)
	62	#define IOMMU_PGFLUSH_MASK 0xffffffff
	63
225d4be7 BS	64	#define IOMMU_AFSR (0x1000 >> 2)
225d4be7 BS	65	#define IOMMU_AFSR_ERR 0x80000000 /* LE, TO, or BE asserted */
5ad6bb97 BS	66	#define IOMMU_AFSR_LE 0x40000000 /* SBUS reports error after
	67	transaction */
	68	#define IOMMU_AFSR_TO 0x20000000 /* Write access took more than
	69	12.8 us. */
	70	#define IOMMU_AFSR_BE 0x10000000 /* Write access received error
	71	acknowledge */
225d4be7 BS	72	#define IOMMU_AFSR_SIZE 0x0e000000 /* Size of transaction causing error */
225d4be7 BS	73	#define IOMMU_AFSR_S 0x01000000 /* Sparc was in supervisor mode */
5ad6bb97 BS	74	#define IOMMU_AFSR_RESV 0x00800000 /* Reserved, forced to 0x8 by
5ad6bb97 BS	75	hardware */
225d4be7 BS	76	#define IOMMU_AFSR_ME 0x00080000 /* Multiple errors occurred */
	77	#define IOMMU_AFSR_RD 0x00040000 /* A read operation was in progress */
	78	#define IOMMU_AFSR_FAV 0x00020000 /* IOMMU afar has valid contents */
c52428fc	79	#define IOMMU_AFSR_MASK 0xff0fffff
225d4be7 BS	80
	81	#define IOMMU_AFAR (0x1004 >> 2)
	82
7b169687 BS	83	#define IOMMU_AER (0x1008 >> 2) /* Arbiter Enable Register */
	84	#define IOMMU_AER_EN_P0_ARB 0x00000001 /* MBus master 0x8 (Always 1) */
	85	#define IOMMU_AER_EN_P1_ARB 0x00000002 /* MBus master 0x9 */
	86	#define IOMMU_AER_EN_P2_ARB 0x00000004 /* MBus master 0xa */
	87	#define IOMMU_AER_EN_P3_ARB 0x00000008 /* MBus master 0xb */
	88	#define IOMMU_AER_EN_0 0x00010000 /* SBus slot 0 */
	89	#define IOMMU_AER_EN_1 0x00020000 /* SBus slot 1 */
	90	#define IOMMU_AER_EN_2 0x00040000 /* SBus slot 2 */
	91	#define IOMMU_AER_EN_3 0x00080000 /* SBus slot 3 */
	92	#define IOMMU_AER_EN_F 0x00100000 /* SBus on-board */
	93	#define IOMMU_AER_SBW 0x80000000 /* S-to-M asynchronous writes */
	94	#define IOMMU_AER_MASK 0x801f000f
	95
4e3b1ea1 FB	96	#define IOMMU_SBCFG0 (0x1010 >> 2) /* SBUS configration per-slot */
	97	#define IOMMU_SBCFG1 (0x1014 >> 2) /* SBUS configration per-slot */
	98	#define IOMMU_SBCFG2 (0x1018 >> 2) /* SBUS configration per-slot */
	99	#define IOMMU_SBCFG3 (0x101c >> 2) /* SBUS configration per-slot */
5ad6bb97 BS	100	#define IOMMU_SBCFG_SAB30 0x00010000 /* Phys-address bit 30 when
5ad6bb97 BS	101	bypass enabled */
4e3b1ea1 FB	102	#define IOMMU_SBCFG_BA16 0x00000004 /* Slave supports 16 byte bursts */
	103	#define IOMMU_SBCFG_BA8 0x00000002 /* Slave supports 8 byte bursts */
	104	#define IOMMU_SBCFG_BYPASS 0x00000001 /* Bypass IOMMU, treat all addresses
f930d07e	105	produced by this device as pure
4e3b1ea1 FB	106	physical. */
	107	#define IOMMU_SBCFG_MASK 0x00010003
	108
	109	#define IOMMU_ARBEN (0x2000 >> 2) /* SBUS arbitration enable */
	110	#define IOMMU_ARBEN_MASK 0x001f0000
	111	#define IOMMU_MID 0x00000008
420557e8	112
e5e38121 BS	113	#define IOMMU_MASK_ID (0x3018 >> 2) /* Mask ID */
	114	#define IOMMU_MASK_ID_MASK 0x00ffffff
	115
	116	#define IOMMU_MSII_MASK 0x26000000 /* microSPARC II mask number */
	117	#define IOMMU_TS_MASK 0x23000000 /* turboSPARC mask number */
	118
420557e8	119	/* The format of an iopte in the page tables */
498fbd8a	120	#define IOPTE_PAGE 0xffffff00 /* Physical page number (PA[35:12]) */
5ad6bb97 BS	121	#define IOPTE_CACHE 0x00000080 /* Cached (in vme IOCACHE or
5ad6bb97 BS	122	Viking/MXCC) */
ebabb67a	123	#define IOPTE_WRITE 0x00000004 /* Writable */
420557e8 FB	124	#define IOPTE_VALID 0x00000002 /* IOPTE is valid */
	125	#define IOPTE_WAZ 0x00000001 /* Write as zeros */
	126
8b0de438 BS	127	#define IOMMU_PAGE_SHIFT 12
	128	#define IOMMU_PAGE_SIZE (1 << IOMMU_PAGE_SHIFT)
	129	#define IOMMU_PAGE_MASK ~(IOMMU_PAGE_SIZE - 1)
420557e8	130
049e7d22 AF	131	#define TYPE_SUN4M_IOMMU "iommu"
	132	#define SUN4M_IOMMU(obj) OBJECT_CHECK(IOMMUState, (obj), TYPE_SUN4M_IOMMU)
	133
420557e8	134	typedef struct IOMMUState {
049e7d22 AF	135	SysBusDevice parent_obj;
049e7d22 AF	136
d224136c	137	MemoryRegion iomem;
66321a11	138	uint32_t regs[IOMMU_NREGS];
a8170e5e	139	hwaddr iostart;
ff403da6	140	qemu_irq irq;
149e1ea1	141	uint32_t version;
420557e8 FB	142	} IOMMUState;
420557e8 FB	143
a8170e5e	144	static uint64_t iommu_mem_read(void *opaque, hwaddr addr,
d224136c	145	unsigned size)
420557e8 FB	146	{
420557e8 FB	147	IOMMUState *s = opaque;
a8170e5e	148	hwaddr saddr;
ff403da6	149	uint32_t ret;
420557e8	150
8da3ff18	151	saddr = addr >> 2;
420557e8 FB	152	switch (saddr) {
420557e8 FB	153	default:
ff403da6 BS	154	ret = s->regs[saddr];
	155	break;
	156	case IOMMU_AFAR:
	157	case IOMMU_AFSR:
	158	ret = s->regs[saddr];
	159	qemu_irq_lower(s->irq);
f930d07e	160	break;
420557e8	161	}
97bf4851	162	trace_sun4m_iommu_mem_readl(saddr, ret);
ff403da6	163	return ret;
420557e8 FB	164	}
420557e8 FB	165
a8170e5e	166	static void iommu_mem_write(void *opaque, hwaddr addr,
d224136c	167	uint64_t val, unsigned size)
420557e8 FB	168	{
420557e8 FB	169	IOMMUState *s = opaque;
a8170e5e	170	hwaddr saddr;
420557e8	171
8da3ff18	172	saddr = addr >> 2;
97bf4851	173	trace_sun4m_iommu_mem_writel(saddr, val);
420557e8	174	switch (saddr) {
4e3b1ea1	175	case IOMMU_CTRL:
f930d07e BS	176	switch (val & IOMMU_CTRL_RNGE) {
	177	case IOMMU_RNGE_16MB:
	178	s->iostart = 0xffffffffff000000ULL;
	179	break;
	180	case IOMMU_RNGE_32MB:
	181	s->iostart = 0xfffffffffe000000ULL;
	182	break;
	183	case IOMMU_RNGE_64MB:
	184	s->iostart = 0xfffffffffc000000ULL;
	185	break;
	186	case IOMMU_RNGE_128MB:
	187	s->iostart = 0xfffffffff8000000ULL;
	188	break;
	189	case IOMMU_RNGE_256MB:
	190	s->iostart = 0xfffffffff0000000ULL;
	191	break;
	192	case IOMMU_RNGE_512MB:
	193	s->iostart = 0xffffffffe0000000ULL;
	194	break;
	195	case IOMMU_RNGE_1GB:
	196	s->iostart = 0xffffffffc0000000ULL;
	197	break;
	198	default:
	199	case IOMMU_RNGE_2GB:
	200	s->iostart = 0xffffffff80000000ULL;
	201	break;
	202	}
97bf4851	203	trace_sun4m_iommu_mem_writel_ctrl(s->iostart);
7fbfb139	204	s->regs[saddr] = ((val & IOMMU_CTRL_MASK) \| s->version);
f930d07e	205	break;
4e3b1ea1	206	case IOMMU_BASE:
f930d07e BS	207	s->regs[saddr] = val & IOMMU_BASE_MASK;
f930d07e BS	208	break;
4e3b1ea1	209	case IOMMU_TLBFLUSH:
97bf4851	210	trace_sun4m_iommu_mem_writel_tlbflush(val);
f930d07e BS	211	s->regs[saddr] = val & IOMMU_TLBFLUSH_MASK;
f930d07e BS	212	break;
4e3b1ea1	213	case IOMMU_PGFLUSH:
97bf4851	214	trace_sun4m_iommu_mem_writel_pgflush(val);
f930d07e BS	215	s->regs[saddr] = val & IOMMU_PGFLUSH_MASK;
f930d07e BS	216	break;
ff403da6 BS	217	case IOMMU_AFAR:
	218	s->regs[saddr] = val;
	219	qemu_irq_lower(s->irq);
	220	break;
7b169687 BS	221	case IOMMU_AER:
	222	s->regs[saddr] = (val & IOMMU_AER_MASK) \| IOMMU_AER_EN_P0_ARB;
	223	break;
c52428fc BS	224	case IOMMU_AFSR:
c52428fc BS	225	s->regs[saddr] = (val & IOMMU_AFSR_MASK) \| IOMMU_AFSR_RESV;
ff403da6	226	qemu_irq_lower(s->irq);
c52428fc	227	break;
4e3b1ea1 FB	228	case IOMMU_SBCFG0:
	229	case IOMMU_SBCFG1:
	230	case IOMMU_SBCFG2:
	231	case IOMMU_SBCFG3:
f930d07e BS	232	s->regs[saddr] = val & IOMMU_SBCFG_MASK;
f930d07e BS	233	break;
4e3b1ea1 FB	234	case IOMMU_ARBEN:
	235	// XXX implement SBus probing: fault when reading unmapped
	236	// addresses, fault cause and address stored to MMU/IOMMU
f930d07e BS	237	s->regs[saddr] = (val & IOMMU_ARBEN_MASK) \| IOMMU_MID;
f930d07e BS	238	break;
e5e38121 BS	239	case IOMMU_MASK_ID:
	240	s->regs[saddr] \|= val & IOMMU_MASK_ID_MASK;
	241	break;
420557e8	242	default:
f930d07e BS	243	s->regs[saddr] = val;
f930d07e BS	244	break;
420557e8 FB	245	}
	246	}
	247
d224136c AK	248	static const MemoryRegionOps iommu_mem_ops = {
	249	.read = iommu_mem_read,
	250	.write = iommu_mem_write,
	251	.endianness = DEVICE_NATIVE_ENDIAN,
	252	.valid = {
	253	.min_access_size = 4,
	254	.max_access_size = 4,
	255	},
420557e8 FB	256	};
420557e8 FB	257
a8170e5e	258	static uint32_t iommu_page_get_flags(IOMMUState *s, hwaddr addr)
420557e8	259	{
5e3b100b	260	uint32_t ret;
a8170e5e AK	261	hwaddr iopte;
a8170e5e AK	262	hwaddr pa = addr;
420557e8	263
981a2e99	264	iopte = s->regs[IOMMU_BASE] << 4;
66321a11	265	addr &= ~s->iostart;
8b0de438	266	iopte += (addr >> (IOMMU_PAGE_SHIFT - 2)) & ~3;
42874d3a PM	267	ret = address_space_ldl_be(&address_space_memory, iopte,
42874d3a PM	268	MEMTXATTRS_UNSPECIFIED, NULL);
97bf4851	269	trace_sun4m_iommu_page_get_flags(pa, iopte, ret);
981a2e99	270	return ret;
a917d384 PB	271	}
a917d384 PB	272
a8170e5e	273	static hwaddr iommu_translate_pa(hwaddr addr,
5dcb6b91	274	uint32_t pte)
a917d384	275	{
a8170e5e	276	hwaddr pa;
5dcb6b91	277
8b0de438	278	pa = ((pte & IOPTE_PAGE) << 4) + (addr & ~IOMMU_PAGE_MASK);
97bf4851	279	trace_sun4m_iommu_translate_pa(addr, pa, pte);
66321a11	280	return pa;
420557e8 FB	281	}
420557e8 FB	282
a8170e5e	283	static void iommu_bad_addr(IOMMUState *s, hwaddr addr,
5ad6bb97	284	int is_write)
225d4be7	285	{
97bf4851	286	trace_sun4m_iommu_bad_addr(addr);
5ad6bb97	287	s->regs[IOMMU_AFSR] = IOMMU_AFSR_ERR \| IOMMU_AFSR_LE \| IOMMU_AFSR_RESV \|
225d4be7 BS	288	IOMMU_AFSR_FAV;
	289	if (!is_write)
	290	s->regs[IOMMU_AFSR] \|= IOMMU_AFSR_RD;
	291	s->regs[IOMMU_AFAR] = addr;
ff403da6	292	qemu_irq_raise(s->irq);
225d4be7 BS	293	}
225d4be7 BS	294
a8170e5e	295	void sparc_iommu_memory_rw(void *opaque, hwaddr addr,
67e999be	296	uint8_t *buf, int len, int is_write)
a917d384	297	{
5dcb6b91 BS	298	int l;
5dcb6b91 BS	299	uint32_t flags;
a8170e5e	300	hwaddr page, phys_addr;
a917d384 PB	301
a917d384 PB	302	while (len > 0) {
8b0de438 BS	303	page = addr & IOMMU_PAGE_MASK;
8b0de438 BS	304	l = (page + IOMMU_PAGE_SIZE) - addr;
a917d384 PB	305	if (l > len)
	306	l = len;
	307	flags = iommu_page_get_flags(opaque, page);
225d4be7 BS	308	if (!(flags & IOPTE_VALID)) {
225d4be7 BS	309	iommu_bad_addr(opaque, page, is_write);
a917d384	310	return;
225d4be7	311	}
22548760	312	phys_addr = iommu_translate_pa(addr, flags);
a917d384	313	if (is_write) {
225d4be7 BS	314	if (!(flags & IOPTE_WRITE)) {
225d4be7 BS	315	iommu_bad_addr(opaque, page, is_write);
a917d384	316	return;
225d4be7	317	}
a5cdf952	318	cpu_physical_memory_write(phys_addr, buf, l);
a917d384	319	} else {
a5cdf952	320	cpu_physical_memory_read(phys_addr, buf, l);
a917d384 PB	321	}
	322	len -= l;
	323	buf += l;
	324	addr += l;
	325	}
	326	}
	327
db3c9e08 BS	328	static const VMStateDescription vmstate_iommu = {
	329	.name ="iommu",
	330	.version_id = 2,
	331	.minimum_version_id = 2,
35d08458	332	.fields = (VMStateField[]) {
db3c9e08 BS	333	VMSTATE_UINT32_ARRAY(regs, IOMMUState, IOMMU_NREGS),
	334	VMSTATE_UINT64(iostart, IOMMUState),
	335	VMSTATE_END_OF_LIST()
	336	}
	337	};
e80cfcfc	338
1a522e8a	339	static void iommu_reset(DeviceState *d)
e80cfcfc	340	{
049e7d22	341	IOMMUState *s = SUN4M_IOMMU(d);
e80cfcfc	342
66321a11	343	memset(s->regs, 0, IOMMU_NREGS * 4);
e80cfcfc	344	s->iostart = 0;
7fbfb139 BS	345	s->regs[IOMMU_CTRL] = s->version;
7fbfb139 BS	346	s->regs[IOMMU_ARBEN] = IOMMU_MID;
5ad6bb97	347	s->regs[IOMMU_AFSR] = IOMMU_AFSR_RESV;
7b169687	348	s->regs[IOMMU_AER] = IOMMU_AER_EN_P0_ARB \| IOMMU_AER_EN_P1_ARB;
e5e38121	349	s->regs[IOMMU_MASK_ID] = IOMMU_TS_MASK;
e80cfcfc FB	350	}
e80cfcfc FB	351
81a322d4	352	static int iommu_init1(SysBusDevice *dev)
5f750b2e	353	{
049e7d22	354	IOMMUState *s = SUN4M_IOMMU(dev);
420557e8	355
5f750b2e	356	sysbus_init_irq(dev, &s->irq);
420557e8	357
3eadad55	358	memory_region_init_io(&s->iomem, OBJECT(s), &iommu_mem_ops, s, "iommu",
d224136c	359	IOMMU_NREGS * sizeof(uint32_t));
750ecd44	360	sysbus_init_mmio(dev, &s->iomem);
3b46e624	361
81a322d4	362	return 0;
420557e8	363	}
5f750b2e	364
999e12bb	365	static Property iommu_properties[] = {
c7bcc85d	366	DEFINE_PROP_UINT32("version", IOMMUState, version, 0),
999e12bb AL	367	DEFINE_PROP_END_OF_LIST(),
	368	};
	369
	370	static void iommu_class_init(ObjectClass klass, void data)
	371	{
39bffca2	372	DeviceClass *dc = DEVICE_CLASS(klass);
999e12bb AL	373	SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
	374
	375	k->init = iommu_init1;
39bffca2 AL	376	dc->reset = iommu_reset;
	377	dc->vmsd = &vmstate_iommu;
	378	dc->props = iommu_properties;
999e12bb AL	379	}
999e12bb AL	380
8c43a6f0	381	static const TypeInfo iommu_info = {
049e7d22	382	.name = TYPE_SUN4M_IOMMU,
39bffca2 AL	383	.parent = TYPE_SYS_BUS_DEVICE,
	384	.instance_size = sizeof(IOMMUState),
	385	.class_init = iommu_class_init,
5f750b2e BS	386	};
5f750b2e BS	387
83f7d43a	388	static void iommu_register_types(void)
5f750b2e	389	{
39bffca2	390	type_register_static(&iommu_info);
5f750b2e BS	391	}
5f750b2e BS	392
83f7d43a	393	type_init(iommu_register_types)