[qemu.git] / hw / arm / smmuv3-internal.h

/*
 * ARM SMMUv3 support - Internal API
 *
 * Copyright (C) 2014-2016 Broadcom Corporation
 * Copyright (c) 2017 Red Hat, Inc.
 * Written by Prem Mallappa, Eric Auger
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef HW_ARM_SMMUV3_INTERNAL_H
#define HW_ARM_SMMUV3_INTERNAL_H

#include "hw/arm/smmu-common.h"

typedef enum SMMUTranslationStatus {
    SMMU_TRANS_DISABLE,
    SMMU_TRANS_ABORT,
    SMMU_TRANS_BYPASS,
    SMMU_TRANS_ERROR,
    SMMU_TRANS_SUCCESS,
} SMMUTranslationStatus;

/* MMIO Registers */

REG32(IDR0,                0x0)
    FIELD(IDR0, S1P,         1 , 1)
    FIELD(IDR0, TTF,         2 , 2)
    FIELD(IDR0, COHACC,      4 , 1)
    FIELD(IDR0, ASID16,      12, 1)
    FIELD(IDR0, TTENDIAN,    21, 2)
    FIELD(IDR0, STALL_MODEL, 24, 2)
    FIELD(IDR0, TERM_MODEL,  26, 1)
    FIELD(IDR0, STLEVEL,     27, 2)

REG32(IDR1,                0x4)
    FIELD(IDR1, SIDSIZE,      0 , 6)
    FIELD(IDR1, EVENTQS,      16, 5)
    FIELD(IDR1, CMDQS,        21, 5)

#define SMMU_IDR1_SIDSIZE 16
#define SMMU_CMDQS   19
#define SMMU_EVENTQS 19

REG32(IDR2,                0x8)
REG32(IDR3,                0xc)
REG32(IDR4,                0x10)
REG32(IDR5,                0x14)
     FIELD(IDR5, OAS,         0, 3);
     FIELD(IDR5, GRAN4K,      4, 1);
     FIELD(IDR5, GRAN16K,     5, 1);
     FIELD(IDR5, GRAN64K,     6, 1);

#define SMMU_IDR5_OAS 4

REG32(IIDR,                0x1c)
REG32(CR0,                 0x20)
    FIELD(CR0, SMMU_ENABLE,   0, 1)
    FIELD(CR0, EVENTQEN,      2, 1)
    FIELD(CR0, CMDQEN,        3, 1)

#define SMMU_CR0_RESERVED 0xFFFFFC20

REG32(CR0ACK,              0x24)
REG32(CR1,                 0x28)
REG32(CR2,                 0x2c)
REG32(STATUSR,             0x40)
REG32(IRQ_CTRL,            0x50)
    FIELD(IRQ_CTRL, GERROR_IRQEN,        0, 1)
    FIELD(IRQ_CTRL, PRI_IRQEN,           1, 1)
    FIELD(IRQ_CTRL, EVENTQ_IRQEN,        2, 1)

REG32(IRQ_CTRL_ACK,        0x54)
REG32(GERROR,              0x60)
    FIELD(GERROR, CMDQ_ERR,           0, 1)
    FIELD(GERROR, EVENTQ_ABT_ERR,     2, 1)
    FIELD(GERROR, PRIQ_ABT_ERR,       3, 1)
    FIELD(GERROR, MSI_CMDQ_ABT_ERR,   4, 1)
    FIELD(GERROR, MSI_EVENTQ_ABT_ERR, 5, 1)
    FIELD(GERROR, MSI_PRIQ_ABT_ERR,   6, 1)
    FIELD(GERROR, MSI_GERROR_ABT_ERR, 7, 1)
    FIELD(GERROR, MSI_SFM_ERR,        8, 1)

REG32(GERRORN,             0x64)

#define A_GERROR_IRQ_CFG0  0x68 /* 64b */
REG32(GERROR_IRQ_CFG1, 0x70)
REG32(GERROR_IRQ_CFG2, 0x74)

#define A_STRTAB_BASE      0x80 /* 64b */

#define SMMU_BASE_ADDR_MASK 0xffffffffffe0

REG32(STRTAB_BASE_CFG,     0x88)
    FIELD(STRTAB_BASE_CFG, FMT,      16, 2)
    FIELD(STRTAB_BASE_CFG, SPLIT,    6 , 5)
    FIELD(STRTAB_BASE_CFG, LOG2SIZE, 0 , 6)

#define A_CMDQ_BASE        0x90 /* 64b */
REG32(CMDQ_PROD,           0x98)
REG32(CMDQ_CONS,           0x9c)
    FIELD(CMDQ_CONS, ERR, 24, 7)

#define A_EVENTQ_BASE      0xa0 /* 64b */
REG32(EVENTQ_PROD,         0xa8)
REG32(EVENTQ_CONS,         0xac)

#define A_EVENTQ_IRQ_CFG0  0xb0 /* 64b */
REG32(EVENTQ_IRQ_CFG1,     0xb8)
REG32(EVENTQ_IRQ_CFG2,     0xbc)

#define A_IDREGS           0xfd0

static inline int smmu_enabled(SMMUv3State *s)
{
    return FIELD_EX32(s->cr[0], CR0, SMMU_ENABLE);
}

/* Command Queue Entry */
typedef struct Cmd {
    uint32_t word[4];
} Cmd;

/* Event Queue Entry */
typedef struct Evt  {
    uint32_t word[8];
} Evt;

static inline uint32_t smmuv3_idreg(int regoffset)
{
    /*
     * Return the value of the Primecell/Corelink ID registers at the
     * specified offset from the first ID register.
     * These value indicate an ARM implementation of MMU600 p1
     */
    static const uint8_t smmuv3_ids[] = {
        0x04, 0, 0, 0, 0x84, 0xB4, 0xF0, 0x10, 0x0D, 0xF0, 0x05, 0xB1
    };
    return smmuv3_ids[regoffset / 4];
}

static inline bool smmuv3_eventq_irq_enabled(SMMUv3State *s)
{
    return FIELD_EX32(s->irq_ctrl, IRQ_CTRL, EVENTQ_IRQEN);
}

static inline bool smmuv3_gerror_irq_enabled(SMMUv3State *s)
{
    return FIELD_EX32(s->irq_ctrl, IRQ_CTRL, GERROR_IRQEN);
}

/* Queue Handling */

#define Q_BASE(q)          ((q)->base & SMMU_BASE_ADDR_MASK)
#define WRAP_MASK(q)       (1 << (q)->log2size)
#define INDEX_MASK(q)      (((1 << (q)->log2size)) - 1)
#define WRAP_INDEX_MASK(q) ((1 << ((q)->log2size + 1)) - 1)

#define Q_CONS(q) ((q)->cons & INDEX_MASK(q))
#define Q_PROD(q) ((q)->prod & INDEX_MASK(q))

#define Q_CONS_ENTRY(q)  (Q_BASE(q) + (q)->entry_size * Q_CONS(q))
#define Q_PROD_ENTRY(q)  (Q_BASE(q) + (q)->entry_size * Q_PROD(q))

#define Q_CONS_WRAP(q) (((q)->cons & WRAP_MASK(q)) >> (q)->log2size)
#define Q_PROD_WRAP(q) (((q)->prod & WRAP_MASK(q)) >> (q)->log2size)

static inline bool smmuv3_q_full(SMMUQueue *q)
{
    return ((q->cons ^ q->prod) & WRAP_INDEX_MASK(q)) == WRAP_MASK(q);
}

static inline bool smmuv3_q_empty(SMMUQueue *q)
{
    return (q->cons & WRAP_INDEX_MASK(q)) == (q->prod & WRAP_INDEX_MASK(q));
}

static inline void queue_prod_incr(SMMUQueue *q)
{
    q->prod = (q->prod + 1) & WRAP_INDEX_MASK(q);
}

static inline void queue_cons_incr(SMMUQueue *q)
{
    /*
     * We have to use deposit for the CONS registers to preserve
     * the ERR field in the high bits.
     */
    q->cons = deposit32(q->cons, 0, q->log2size + 1, q->cons + 1);
}

static inline bool smmuv3_cmdq_enabled(SMMUv3State *s)
{
    return FIELD_EX32(s->cr[0], CR0, CMDQEN);
}

static inline bool smmuv3_eventq_enabled(SMMUv3State *s)
{
    return FIELD_EX32(s->cr[0], CR0, EVENTQEN);
}

static inline void smmu_write_cmdq_err(SMMUv3State *s, uint32_t err_type)
{
    s->cmdq.cons = FIELD_DP32(s->cmdq.cons, CMDQ_CONS, ERR, err_type);
}

/* Commands */

typedef enum SMMUCommandType {
    SMMU_CMD_NONE            = 0x00,
    SMMU_CMD_PREFETCH_CONFIG       ,
    SMMU_CMD_PREFETCH_ADDR,
    SMMU_CMD_CFGI_STE,
    SMMU_CMD_CFGI_STE_RANGE,
    SMMU_CMD_CFGI_CD,
    SMMU_CMD_CFGI_CD_ALL,
    SMMU_CMD_CFGI_ALL,
    SMMU_CMD_TLBI_NH_ALL     = 0x10,
    SMMU_CMD_TLBI_NH_ASID,
    SMMU_CMD_TLBI_NH_VA,
    SMMU_CMD_TLBI_NH_VAA,
    SMMU_CMD_TLBI_EL3_ALL    = 0x18,
    SMMU_CMD_TLBI_EL3_VA     = 0x1a,
    SMMU_CMD_TLBI_EL2_ALL    = 0x20,
    SMMU_CMD_TLBI_EL2_ASID,
    SMMU_CMD_TLBI_EL2_VA,
    SMMU_CMD_TLBI_EL2_VAA,
    SMMU_CMD_TLBI_S12_VMALL  = 0x28,
    SMMU_CMD_TLBI_S2_IPA     = 0x2a,
    SMMU_CMD_TLBI_NSNH_ALL   = 0x30,
    SMMU_CMD_ATC_INV         = 0x40,
    SMMU_CMD_PRI_RESP,
    SMMU_CMD_RESUME          = 0x44,
    SMMU_CMD_STALL_TERM,
    SMMU_CMD_SYNC,
} SMMUCommandType;

static const char *cmd_stringify[] = {
    [SMMU_CMD_PREFETCH_CONFIG] = "SMMU_CMD_PREFETCH_CONFIG",
    [SMMU_CMD_PREFETCH_ADDR]   = "SMMU_CMD_PREFETCH_ADDR",
    [SMMU_CMD_CFGI_STE]        = "SMMU_CMD_CFGI_STE",
    [SMMU_CMD_CFGI_STE_RANGE]  = "SMMU_CMD_CFGI_STE_RANGE",
    [SMMU_CMD_CFGI_CD]         = "SMMU_CMD_CFGI_CD",
    [SMMU_CMD_CFGI_CD_ALL]     = "SMMU_CMD_CFGI_CD_ALL",
    [SMMU_CMD_CFGI_ALL]        = "SMMU_CMD_CFGI_ALL",
    [SMMU_CMD_TLBI_NH_ALL]     = "SMMU_CMD_TLBI_NH_ALL",
    [SMMU_CMD_TLBI_NH_ASID]    = "SMMU_CMD_TLBI_NH_ASID",
    [SMMU_CMD_TLBI_NH_VA]      = "SMMU_CMD_TLBI_NH_VA",
    [SMMU_CMD_TLBI_NH_VAA]     = "SMMU_CMD_TLBI_NH_VAA",
    [SMMU_CMD_TLBI_EL3_ALL]    = "SMMU_CMD_TLBI_EL3_ALL",
    [SMMU_CMD_TLBI_EL3_VA]     = "SMMU_CMD_TLBI_EL3_VA",
    [SMMU_CMD_TLBI_EL2_ALL]    = "SMMU_CMD_TLBI_EL2_ALL",
    [SMMU_CMD_TLBI_EL2_ASID]   = "SMMU_CMD_TLBI_EL2_ASID",
    [SMMU_CMD_TLBI_EL2_VA]     = "SMMU_CMD_TLBI_EL2_VA",
    [SMMU_CMD_TLBI_EL2_VAA]    = "SMMU_CMD_TLBI_EL2_VAA",
    [SMMU_CMD_TLBI_S12_VMALL]  = "SMMU_CMD_TLBI_S12_VMALL",
    [SMMU_CMD_TLBI_S2_IPA]     = "SMMU_CMD_TLBI_S2_IPA",
    [SMMU_CMD_TLBI_NSNH_ALL]   = "SMMU_CMD_TLBI_NSNH_ALL",
    [SMMU_CMD_ATC_INV]         = "SMMU_CMD_ATC_INV",
    [SMMU_CMD_PRI_RESP]        = "SMMU_CMD_PRI_RESP",
    [SMMU_CMD_RESUME]          = "SMMU_CMD_RESUME",
    [SMMU_CMD_STALL_TERM]      = "SMMU_CMD_STALL_TERM",
    [SMMU_CMD_SYNC]            = "SMMU_CMD_SYNC",
};

static inline const char *smmu_cmd_string(SMMUCommandType type)
{
    if (type > SMMU_CMD_NONE && type < ARRAY_SIZE(cmd_stringify)) {
        return cmd_stringify[type] ? cmd_stringify[type] : "UNKNOWN";
    } else {
        return "INVALID";
    }
}

/* CMDQ fields */

typedef enum {
    SMMU_CERROR_NONE = 0,
    SMMU_CERROR_ILL,
    SMMU_CERROR_ABT,
    SMMU_CERROR_ATC_INV_SYNC,
} SMMUCmdError;

enum { /* Command completion notification */
    CMD_SYNC_SIG_NONE,
    CMD_SYNC_SIG_IRQ,
    CMD_SYNC_SIG_SEV,
};

#define CMD_TYPE(x)         extract32((x)->word[0], 0 , 8)
#define CMD_SSEC(x)         extract32((x)->word[0], 10, 1)
#define CMD_SSV(x)          extract32((x)->word[0], 11, 1)
#define CMD_RESUME_AC(x)    extract32((x)->word[0], 12, 1)
#define CMD_RESUME_AB(x)    extract32((x)->word[0], 13, 1)
#define CMD_SYNC_CS(x)      extract32((x)->word[0], 12, 2)
#define CMD_SSID(x)         extract32((x)->word[0], 12, 20)
#define CMD_SID(x)          ((x)->word[1])
#define CMD_VMID(x)         extract32((x)->word[1], 0 , 16)
#define CMD_ASID(x)         extract32((x)->word[1], 16, 16)
#define CMD_RESUME_STAG(x)  extract32((x)->word[2], 0 , 16)
#define CMD_RESP(x)         extract32((x)->word[2], 11, 2)
#define CMD_LEAF(x)         extract32((x)->word[2], 0 , 1)
#define CMD_STE_RANGE(x)    extract32((x)->word[2], 0 , 5)
#define CMD_ADDR(x) ({                                        \
            uint64_t high = (uint64_t)(x)->word[3];           \
            uint64_t low = extract32((x)->word[2], 12, 20);    \
            uint64_t addr = high << 32 | (low << 12);         \
            addr;                                             \
        })

#define SMMU_FEATURE_2LVL_STE (1 << 0)

/* Events */

typedef enum SMMUEventType {
    SMMU_EVT_NONE               = 0x00,
    SMMU_EVT_F_UUT                    ,
    SMMU_EVT_C_BAD_STREAMID           ,
    SMMU_EVT_F_STE_FETCH              ,
    SMMU_EVT_C_BAD_STE                ,
    SMMU_EVT_F_BAD_ATS_TREQ           ,
    SMMU_EVT_F_STREAM_DISABLED        ,
    SMMU_EVT_F_TRANS_FORBIDDEN        ,
    SMMU_EVT_C_BAD_SUBSTREAMID        ,
    SMMU_EVT_F_CD_FETCH               ,
    SMMU_EVT_C_BAD_CD                 ,
    SMMU_EVT_F_WALK_EABT              ,
    SMMU_EVT_F_TRANSLATION      = 0x10,
    SMMU_EVT_F_ADDR_SIZE              ,
    SMMU_EVT_F_ACCESS                 ,
    SMMU_EVT_F_PERMISSION             ,
    SMMU_EVT_F_TLB_CONFLICT     = 0x20,
    SMMU_EVT_F_CFG_CONFLICT           ,
    SMMU_EVT_E_PAGE_REQ         = 0x24,
} SMMUEventType;

static const char *event_stringify[] = {
    [SMMU_EVT_NONE]                     = "no recorded event",
    [SMMU_EVT_F_UUT]                    = "SMMU_EVT_F_UUT",
    [SMMU_EVT_C_BAD_STREAMID]           = "SMMU_EVT_C_BAD_STREAMID",
    [SMMU_EVT_F_STE_FETCH]              = "SMMU_EVT_F_STE_FETCH",
    [SMMU_EVT_C_BAD_STE]                = "SMMU_EVT_C_BAD_STE",
    [SMMU_EVT_F_BAD_ATS_TREQ]           = "SMMU_EVT_F_BAD_ATS_TREQ",
    [SMMU_EVT_F_STREAM_DISABLED]        = "SMMU_EVT_F_STREAM_DISABLED",
    [SMMU_EVT_F_TRANS_FORBIDDEN]        = "SMMU_EVT_F_TRANS_FORBIDDEN",
    [SMMU_EVT_C_BAD_SUBSTREAMID]        = "SMMU_EVT_C_BAD_SUBSTREAMID",
    [SMMU_EVT_F_CD_FETCH]               = "SMMU_EVT_F_CD_FETCH",
    [SMMU_EVT_C_BAD_CD]                 = "SMMU_EVT_C_BAD_CD",
    [SMMU_EVT_F_WALK_EABT]              = "SMMU_EVT_F_WALK_EABT",
    [SMMU_EVT_F_TRANSLATION]            = "SMMU_EVT_F_TRANSLATION",
    [SMMU_EVT_F_ADDR_SIZE]              = "SMMU_EVT_F_ADDR_SIZE",
    [SMMU_EVT_F_ACCESS]                 = "SMMU_EVT_F_ACCESS",
    [SMMU_EVT_F_PERMISSION]             = "SMMU_EVT_F_PERMISSION",
    [SMMU_EVT_F_TLB_CONFLICT]           = "SMMU_EVT_F_TLB_CONFLICT",
    [SMMU_EVT_F_CFG_CONFLICT]           = "SMMU_EVT_F_CFG_CONFLICT",
    [SMMU_EVT_E_PAGE_REQ]               = "SMMU_EVT_E_PAGE_REQ",
};

static inline const char *smmu_event_string(SMMUEventType type)
{
    if (type < ARRAY_SIZE(event_stringify)) {
        return event_stringify[type] ? event_stringify[type] : "UNKNOWN";
    } else {
        return "INVALID";
    }
}

/*  Encode an event record */
typedef struct SMMUEventInfo {
    SMMUEventType type;
    uint32_t sid;
    bool recorded;
    bool record_trans_faults;
    union {
        struct {
            uint32_t ssid;
            bool ssv;
            dma_addr_t addr;
            bool rnw;
            bool pnu;
            bool ind;
       } f_uut;
       struct SSIDInfo {
            uint32_t ssid;
            bool ssv;
       } c_bad_streamid;
       struct SSIDAddrInfo {
            uint32_t ssid;
            bool ssv;
            dma_addr_t addr;
       } f_ste_fetch;
       struct SSIDInfo c_bad_ste;
       struct {
            dma_addr_t addr;
            bool rnw;
       } f_transl_forbidden;
       struct {
            uint32_t ssid;
       } c_bad_substream;
       struct SSIDAddrInfo f_cd_fetch;
       struct SSIDInfo c_bad_cd;
       struct FullInfo {
            bool stall;
            uint16_t stag;
            uint32_t ssid;
            bool ssv;
            bool s2;
            dma_addr_t addr;
            bool rnw;
            bool pnu;
            bool ind;
            uint8_t class;
            dma_addr_t addr2;
       } f_walk_eabt;
       struct FullInfo f_translation;
       struct FullInfo f_addr_size;
       struct FullInfo f_access;
       struct FullInfo f_permission;
       struct SSIDInfo f_cfg_conflict;
       /**
        * not supported yet:
        * F_BAD_ATS_TREQ
        * F_BAD_ATS_TREQ
        * F_TLB_CONFLICT
        * E_PAGE_REQUEST
        * IMPDEF_EVENTn
        */
    } u;
} SMMUEventInfo;

/* EVTQ fields */

#define EVT_Q_OVERFLOW        (1 << 31)

#define EVT_SET_TYPE(x, v)  ((x)->word[0] = deposit32((x)->word[0], 0 , 8 , v))
#define EVT_SET_SSV(x, v)   ((x)->word[0] = deposit32((x)->word[0], 11, 1 , v))
#define EVT_SET_SSID(x, v)  ((x)->word[0] = deposit32((x)->word[0], 12, 20, v))
#define EVT_SET_SID(x, v)   ((x)->word[1] = v)
#define EVT_SET_STAG(x, v)  ((x)->word[2] = deposit32((x)->word[2], 0 , 16, v))
#define EVT_SET_STALL(x, v) ((x)->word[2] = deposit32((x)->word[2], 31, 1 , v))
#define EVT_SET_PNU(x, v)   ((x)->word[3] = deposit32((x)->word[3], 1 , 1 , v))
#define EVT_SET_IND(x, v)   ((x)->word[3] = deposit32((x)->word[3], 2 , 1 , v))
#define EVT_SET_RNW(x, v)   ((x)->word[3] = deposit32((x)->word[3], 3 , 1 , v))
#define EVT_SET_S2(x, v)    ((x)->word[3] = deposit32((x)->word[3], 7 , 1 , v))
#define EVT_SET_CLASS(x, v) ((x)->word[3] = deposit32((x)->word[3], 8 , 2 , v))
#define EVT_SET_ADDR(x, addr)                             \
    do {                                                  \
            (x)->word[5] = (uint32_t)(addr >> 32);        \
            (x)->word[4] = (uint32_t)(addr & 0xffffffff); \
    } while (0)
#define EVT_SET_ADDR2(x, addr)                            \
    do {                                                  \
            (x)->word[7] = deposit32((x)->word[7], 3, 29, addr >> 16);   \
            (x)->word[7] = deposit32((x)->word[7], 0, 16, addr & 0xffff);\
    } while (0)

void smmuv3_record_event(SMMUv3State *s, SMMUEventInfo *event);

/* Configuration Data */

/* STE Level 1 Descriptor */
typedef struct STEDesc {
    uint32_t word[2];
} STEDesc;

/* CD Level 1 Descriptor */
typedef struct CDDesc {
    uint32_t word[2];
} CDDesc;

/* Stream Table Entry(STE) */
typedef struct STE {
    uint32_t word[16];
} STE;

/* Context Descriptor(CD) */
typedef struct CD {
    uint32_t word[16];
} CD;

/* STE fields */

#define STE_VALID(x)   extract32((x)->word[0], 0, 1)

#define STE_CONFIG(x)  extract32((x)->word[0], 1, 3)
#define STE_CFG_S1_ENABLED(config) (config & 0x1)
#define STE_CFG_S2_ENABLED(config) (config & 0x2)
#define STE_CFG_ABORT(config)      (!(config & 0x4))
#define STE_CFG_BYPASS(config)     (config == 0x4)

#define STE_S1FMT(x)       extract32((x)->word[0], 4 , 2)
#define STE_S1CDMAX(x)     extract32((x)->word[1], 27, 5)
#define STE_S1STALLD(x)    extract32((x)->word[2], 27, 1)
#define STE_EATS(x)        extract32((x)->word[2], 28, 2)
#define STE_STRW(x)        extract32((x)->word[2], 30, 2)
#define STE_S2VMID(x)      extract32((x)->word[4], 0 , 16)
#define STE_S2T0SZ(x)      extract32((x)->word[5], 0 , 6)
#define STE_S2SL0(x)       extract32((x)->word[5], 6 , 2)
#define STE_S2TG(x)        extract32((x)->word[5], 14, 2)
#define STE_S2PS(x)        extract32((x)->word[5], 16, 3)
#define STE_S2AA64(x)      extract32((x)->word[5], 19, 1)
#define STE_S2HD(x)        extract32((x)->word[5], 24, 1)
#define STE_S2HA(x)        extract32((x)->word[5], 25, 1)
#define STE_S2S(x)         extract32((x)->word[5], 26, 1)
#define STE_CTXPTR(x)                                           \
    ({                                                          \
        unsigned long addr;                                     \
        addr = (uint64_t)extract32((x)->word[1], 0, 16) << 32;  \
        addr |= (uint64_t)((x)->word[0] & 0xffffffc0);          \
        addr;                                                   \
    })

#define STE_S2TTB(x)                                            \
    ({                                                          \
        unsigned long addr;                                     \
        addr = (uint64_t)extract32((x)->word[7], 0, 16) << 32;  \
        addr |= (uint64_t)((x)->word[6] & 0xfffffff0);          \
        addr;                                                   \
    })

static inline int oas2bits(int oas_field)
{
    switch (oas_field) {
    case 0:
        return 32;
    case 1:
        return 36;
    case 2:
        return 40;
    case 3:
        return 42;
    case 4:
        return 44;
    case 5:
        return 48;
    }
    return -1;
}

static inline int pa_range(STE *ste)
{
    int oas_field = MIN(STE_S2PS(ste), SMMU_IDR5_OAS);

    if (!STE_S2AA64(ste)) {
        return 40;
    }

    return oas2bits(oas_field);
}

#define MAX_PA(ste) ((1 << pa_range(ste)) - 1)

/* CD fields */

#define CD_VALID(x)   extract32((x)->word[0], 30, 1)
#define CD_ASID(x)    extract32((x)->word[1], 16, 16)
#define CD_TTB(x, sel)                                      \
    ({                                                      \
        uint64_t hi, lo;                                    \
        hi = extract32((x)->word[(sel) * 2 + 3], 0, 19);    \
        hi <<= 32;                                          \
        lo = (x)->word[(sel) * 2 + 2] & ~0xfULL;            \
        hi | lo;                                            \
    })

#define CD_TSZ(x, sel)   extract32((x)->word[0], (16 * (sel)) + 0, 6)
#define CD_TG(x, sel)    extract32((x)->word[0], (16 * (sel)) + 6, 2)
#define CD_EPD(x, sel)   extract32((x)->word[0], (16 * (sel)) + 14, 1)
#define CD_ENDI(x)       extract32((x)->word[0], 15, 1)
#define CD_IPS(x)        extract32((x)->word[1], 0 , 3)
#define CD_TBI(x)        extract32((x)->word[1], 6 , 2)
#define CD_HD(x)         extract32((x)->word[1], 10 , 1)
#define CD_HA(x)         extract32((x)->word[1], 11 , 1)
#define CD_S(x)          extract32((x)->word[1], 12, 1)
#define CD_R(x)          extract32((x)->word[1], 13, 1)
#define CD_A(x)          extract32((x)->word[1], 14, 1)
#define CD_AARCH64(x)    extract32((x)->word[1], 9 , 1)

#define CDM_VALID(x)    ((x)->word[0] & 0x1)

static inline int is_cd_valid(SMMUv3State *s, STE *ste, CD *cd)
{
    return CD_VALID(cd);
}

/**
 * tg2granule - Decodes the CD translation granule size field according
 * to the ttbr in use
 * @bits: TG0/1 fields
 * @ttbr: ttbr index in use
 */
static inline int tg2granule(int bits, int ttbr)
{
    switch (bits) {
    case 0:
        return ttbr ? 0  : 12;
    case 1:
        return ttbr ? 14 : 16;
    case 2:
        return ttbr ? 12 : 14;
    case 3:
        return ttbr ? 16 :  0;
    default:
        return 0;
    }
}

static inline uint64_t l1std_l2ptr(STEDesc *desc)
{
    uint64_t hi, lo;

    hi = desc->word[1];
    lo = desc->word[0] & ~0x1fULL;
    return hi << 32 | lo;
}

#define L1STD_SPAN(stm) (extract32((stm)->word[0], 0, 4))

#endif
Commit	Line	Data
10a83cb9 PM	1	/*
	2	* ARM SMMUv3 support - Internal API
	3	*
	4	* Copyright (C) 2014-2016 Broadcom Corporation
	5	* Copyright (c) 2017 Red Hat, Inc.
	6	* Written by Prem Mallappa, Eric Auger
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License along
	18	* with this program; if not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
58ea30f5 MA	21	#ifndef HW_ARM_SMMUV3_INTERNAL_H
58ea30f5 MA	22	#define HW_ARM_SMMUV3_INTERNAL_H
10a83cb9 PM	23
	24	#include "hw/arm/smmu-common.h"
	25
9122bea9 JH	26	typedef enum SMMUTranslationStatus {
	27	SMMU_TRANS_DISABLE,
	28	SMMU_TRANS_ABORT,
	29	SMMU_TRANS_BYPASS,
	30	SMMU_TRANS_ERROR,
	31	SMMU_TRANS_SUCCESS,
	32	} SMMUTranslationStatus;
	33
10a83cb9 PM	34	/* MMIO Registers */
	35
	36	REG32(IDR0, 0x0)
	37	FIELD(IDR0, S1P, 1 , 1)
	38	FIELD(IDR0, TTF, 2 , 2)
	39	FIELD(IDR0, COHACC, 4 , 1)
	40	FIELD(IDR0, ASID16, 12, 1)
	41	FIELD(IDR0, TTENDIAN, 21, 2)
	42	FIELD(IDR0, STALL_MODEL, 24, 2)
	43	FIELD(IDR0, TERM_MODEL, 26, 1)
	44	FIELD(IDR0, STLEVEL, 27, 2)
	45
	46	REG32(IDR1, 0x4)
	47	FIELD(IDR1, SIDSIZE, 0 , 6)
	48	FIELD(IDR1, EVENTQS, 16, 5)
	49	FIELD(IDR1, CMDQS, 21, 5)
	50
	51	#define SMMU_IDR1_SIDSIZE 16
	52	#define SMMU_CMDQS 19
	53	#define SMMU_EVENTQS 19
	54
	55	REG32(IDR2, 0x8)
	56	REG32(IDR3, 0xc)
	57	REG32(IDR4, 0x10)
	58	REG32(IDR5, 0x14)
	59	FIELD(IDR5, OAS, 0, 3);
	60	FIELD(IDR5, GRAN4K, 4, 1);
	61	FIELD(IDR5, GRAN16K, 5, 1);
	62	FIELD(IDR5, GRAN64K, 6, 1);
	63
	64	#define SMMU_IDR5_OAS 4
	65
	66	REG32(IIDR, 0x1c)
	67	REG32(CR0, 0x20)
	68	FIELD(CR0, SMMU_ENABLE, 0, 1)
	69	FIELD(CR0, EVENTQEN, 2, 1)
	70	FIELD(CR0, CMDQEN, 3, 1)
	71
fae4be38 EA	72	#define SMMU_CR0_RESERVED 0xFFFFFC20
fae4be38 EA	73
10a83cb9 PM	74	REG32(CR0ACK, 0x24)
	75	REG32(CR1, 0x28)
	76	REG32(CR2, 0x2c)
	77	REG32(STATUSR, 0x40)
	78	REG32(IRQ_CTRL, 0x50)
	79	FIELD(IRQ_CTRL, GERROR_IRQEN, 0, 1)
	80	FIELD(IRQ_CTRL, PRI_IRQEN, 1, 1)
	81	FIELD(IRQ_CTRL, EVENTQ_IRQEN, 2, 1)
	82
	83	REG32(IRQ_CTRL_ACK, 0x54)
	84	REG32(GERROR, 0x60)
	85	FIELD(GERROR, CMDQ_ERR, 0, 1)
	86	FIELD(GERROR, EVENTQ_ABT_ERR, 2, 1)
	87	FIELD(GERROR, PRIQ_ABT_ERR, 3, 1)
	88	FIELD(GERROR, MSI_CMDQ_ABT_ERR, 4, 1)
	89	FIELD(GERROR, MSI_EVENTQ_ABT_ERR, 5, 1)
	90	FIELD(GERROR, MSI_PRIQ_ABT_ERR, 6, 1)
	91	FIELD(GERROR, MSI_GERROR_ABT_ERR, 7, 1)
	92	FIELD(GERROR, MSI_SFM_ERR, 8, 1)
	93
	94	REG32(GERRORN, 0x64)
	95
	96	#define A_GERROR_IRQ_CFG0 0x68 /* 64b */
	97	REG32(GERROR_IRQ_CFG1, 0x70)
	98	REG32(GERROR_IRQ_CFG2, 0x74)
	99
	100	#define A_STRTAB_BASE 0x80 /* 64b */
	101
	102	#define SMMU_BASE_ADDR_MASK 0xffffffffffe0
	103
	104	REG32(STRTAB_BASE_CFG, 0x88)
	105	FIELD(STRTAB_BASE_CFG, FMT, 16, 2)
	106	FIELD(STRTAB_BASE_CFG, SPLIT, 6 , 5)
	107	FIELD(STRTAB_BASE_CFG, LOG2SIZE, 0 , 6)
	108
	109	#define A_CMDQ_BASE 0x90 /* 64b */
	110	REG32(CMDQ_PROD, 0x98)
	111	REG32(CMDQ_CONS, 0x9c)
	112	FIELD(CMDQ_CONS, ERR, 24, 7)
	113
	114	#define A_EVENTQ_BASE 0xa0 /* 64b */
	115	REG32(EVENTQ_PROD, 0xa8)
	116	REG32(EVENTQ_CONS, 0xac)
	117
	118	#define A_EVENTQ_IRQ_CFG0 0xb0 /* 64b */
	119	REG32(EVENTQ_IRQ_CFG1, 0xb8)
	120	REG32(EVENTQ_IRQ_CFG2, 0xbc)
	121
	122	#define A_IDREGS 0xfd0
	123
	124	static inline int smmu_enabled(SMMUv3State *s)
	125	{
	126	return FIELD_EX32(s->cr[0], CR0, SMMU_ENABLE);
	127	}
	128
	129	/* Command Queue Entry */
	130	typedef struct Cmd {
	131	uint32_t word[4];
	132	} Cmd;
	133
	134	/* Event Queue Entry */
	135	typedef struct Evt {
	136	uint32_t word[8];
	137	} Evt;
138
139	static inline uint32_t smmuv3_idreg(int regoffset)
140	{
141	/*
142	* Return the value of the Primecell/Corelink ID registers at the
143	* specified offset from the first ID register.
144	* These value indicate an ARM implementation of MMU600 p1
145	*/
146	static const uint8_t smmuv3_ids[] = {
147	0x04, 0, 0, 0, 0x84, 0xB4, 0xF0, 0x10, 0x0D, 0xF0, 0x05, 0xB1
148	};
149	return smmuv3_ids[regoffset / 4];
150	}
151
6a736033 EA	152	static inline bool smmuv3_eventq_irq_enabled(SMMUv3State *s)
	153	{
	154	return FIELD_EX32(s->irq_ctrl, IRQ_CTRL, EVENTQ_IRQEN);
	155	}
	156
	157	static inline bool smmuv3_gerror_irq_enabled(SMMUv3State *s)
	158	{
	159	return FIELD_EX32(s->irq_ctrl, IRQ_CTRL, GERROR_IRQEN);
	160	}
	161
dadd1a08 EA	162	/* Queue Handling */
	163
	164	#define Q_BASE(q) ((q)->base & SMMU_BASE_ADDR_MASK)
	165	#define WRAP_MASK(q) (1 << (q)->log2size)
	166	#define INDEX_MASK(q) (((1 << (q)->log2size)) - 1)
	167	#define WRAP_INDEX_MASK(q) ((1 << ((q)->log2size + 1)) - 1)
	168
	169	#define Q_CONS(q) ((q)->cons & INDEX_MASK(q))
	170	#define Q_PROD(q) ((q)->prod & INDEX_MASK(q))
	171
	172	#define Q_CONS_ENTRY(q) (Q_BASE(q) + (q)->entry_size * Q_CONS(q))
	173	#define Q_PROD_ENTRY(q) (Q_BASE(q) + (q)->entry_size * Q_PROD(q))
	174
	175	#define Q_CONS_WRAP(q) (((q)->cons & WRAP_MASK(q)) >> (q)->log2size)
	176	#define Q_PROD_WRAP(q) (((q)->prod & WRAP_MASK(q)) >> (q)->log2size)
	177
	178	static inline bool smmuv3_q_full(SMMUQueue *q)
	179	{
	180	return ((q->cons ^ q->prod) & WRAP_INDEX_MASK(q)) == WRAP_MASK(q);
	181	}
	182
	183	static inline bool smmuv3_q_empty(SMMUQueue *q)
	184	{
	185	return (q->cons & WRAP_INDEX_MASK(q)) == (q->prod & WRAP_INDEX_MASK(q));
	186	}
	187
	188	static inline void queue_prod_incr(SMMUQueue *q)
	189	{
	190	q->prod = (q->prod + 1) & WRAP_INDEX_MASK(q);
	191	}
	192
	193	static inline void queue_cons_incr(SMMUQueue *q)
	194	{
	195	/*
	196	* We have to use deposit for the CONS registers to preserve
	197	* the ERR field in the high bits.
	198	*/
	199	q->cons = deposit32(q->cons, 0, q->log2size + 1, q->cons + 1);
	200	}
	201
	202	static inline bool smmuv3_cmdq_enabled(SMMUv3State *s)
	203	{
	204	return FIELD_EX32(s->cr[0], CR0, CMDQEN);
	205	}
	206
	207	static inline bool smmuv3_eventq_enabled(SMMUv3State *s)
	208	{
	209	return FIELD_EX32(s->cr[0], CR0, EVENTQEN);
	210	}
	211
	212	static inline void smmu_write_cmdq_err(SMMUv3State *s, uint32_t err_type)
	213	{
	214	s->cmdq.cons = FIELD_DP32(s->cmdq.cons, CMDQ_CONS, ERR, err_type);
	215	}
	216
dadd1a08 EA	217	/* Commands */
	218
	219	typedef enum SMMUCommandType {
	220	SMMU_CMD_NONE = 0x00,
	221	SMMU_CMD_PREFETCH_CONFIG ,
	222	SMMU_CMD_PREFETCH_ADDR,
	223	SMMU_CMD_CFGI_STE,
	224	SMMU_CMD_CFGI_STE_RANGE,
	225	SMMU_CMD_CFGI_CD,
	226	SMMU_CMD_CFGI_CD_ALL,
	227	SMMU_CMD_CFGI_ALL,
	228	SMMU_CMD_TLBI_NH_ALL = 0x10,
	229	SMMU_CMD_TLBI_NH_ASID,
	230	SMMU_CMD_TLBI_NH_VA,
	231	SMMU_CMD_TLBI_NH_VAA,
	232	SMMU_CMD_TLBI_EL3_ALL = 0x18,
	233	SMMU_CMD_TLBI_EL3_VA = 0x1a,
	234	SMMU_CMD_TLBI_EL2_ALL = 0x20,
	235	SMMU_CMD_TLBI_EL2_ASID,
	236	SMMU_CMD_TLBI_EL2_VA,
	237	SMMU_CMD_TLBI_EL2_VAA,
	238	SMMU_CMD_TLBI_S12_VMALL = 0x28,
	239	SMMU_CMD_TLBI_S2_IPA = 0x2a,
	240	SMMU_CMD_TLBI_NSNH_ALL = 0x30,
	241	SMMU_CMD_ATC_INV = 0x40,
	242	SMMU_CMD_PRI_RESP,
	243	SMMU_CMD_RESUME = 0x44,
	244	SMMU_CMD_STALL_TERM,
	245	SMMU_CMD_SYNC,
	246	} SMMUCommandType;
	247
	248	static const char *cmd_stringify[] = {
	249	[SMMU_CMD_PREFETCH_CONFIG] = "SMMU_CMD_PREFETCH_CONFIG",
	250	[SMMU_CMD_PREFETCH_ADDR] = "SMMU_CMD_PREFETCH_ADDR",
	251	[SMMU_CMD_CFGI_STE] = "SMMU_CMD_CFGI_STE",
	252	[SMMU_CMD_CFGI_STE_RANGE] = "SMMU_CMD_CFGI_STE_RANGE",
	253	[SMMU_CMD_CFGI_CD] = "SMMU_CMD_CFGI_CD",
	254	[SMMU_CMD_CFGI_CD_ALL] = "SMMU_CMD_CFGI_CD_ALL",
	255	[SMMU_CMD_CFGI_ALL] = "SMMU_CMD_CFGI_ALL",
	256	[SMMU_CMD_TLBI_NH_ALL] = "SMMU_CMD_TLBI_NH_ALL",
	257	[SMMU_CMD_TLBI_NH_ASID] = "SMMU_CMD_TLBI_NH_ASID",
	258	[SMMU_CMD_TLBI_NH_VA] = "SMMU_CMD_TLBI_NH_VA",
	259	[SMMU_CMD_TLBI_NH_VAA] = "SMMU_CMD_TLBI_NH_VAA",
	260	[SMMU_CMD_TLBI_EL3_ALL] = "SMMU_CMD_TLBI_EL3_ALL",
	261	[SMMU_CMD_TLBI_EL3_VA] = "SMMU_CMD_TLBI_EL3_VA",
	262	[SMMU_CMD_TLBI_EL2_ALL] = "SMMU_CMD_TLBI_EL2_ALL",
	263	[SMMU_CMD_TLBI_EL2_ASID] = "SMMU_CMD_TLBI_EL2_ASID",
	264	[SMMU_CMD_TLBI_EL2_VA] = "SMMU_CMD_TLBI_EL2_VA",
	265	[SMMU_CMD_TLBI_EL2_VAA] = "SMMU_CMD_TLBI_EL2_VAA",
	266	[SMMU_CMD_TLBI_S12_VMALL] = "SMMU_CMD_TLBI_S12_VMALL",
	267	[SMMU_CMD_TLBI_S2_IPA] = "SMMU_CMD_TLBI_S2_IPA",
	268	[SMMU_CMD_TLBI_NSNH_ALL] = "SMMU_CMD_TLBI_NSNH_ALL",
	269	[SMMU_CMD_ATC_INV] = "SMMU_CMD_ATC_INV",
	270	[SMMU_CMD_PRI_RESP] = "SMMU_CMD_PRI_RESP",
	271	[SMMU_CMD_RESUME] = "SMMU_CMD_RESUME",
	272	[SMMU_CMD_STALL_TERM] = "SMMU_CMD_STALL_TERM",
	273	[SMMU_CMD_SYNC] = "SMMU_CMD_SYNC",
	274	};
	275
	276	static inline const char *smmu_cmd_string(SMMUCommandType type)
	277	{
	278	if (type > SMMU_CMD_NONE && type < ARRAY_SIZE(cmd_stringify)) {
	279	return cmd_stringify[type] ? cmd_stringify[type] : "UNKNOWN";
	280	} else {
281	return "INVALID";
282	}
283	}
284
285	/* CMDQ fields */
286
287	typedef enum {
288	SMMU_CERROR_NONE = 0,
289	SMMU_CERROR_ILL,
290	SMMU_CERROR_ABT,
291	SMMU_CERROR_ATC_INV_SYNC,
292	} SMMUCmdError;
293
294	enum { /* Command completion notification */
295	CMD_SYNC_SIG_NONE,
296	CMD_SYNC_SIG_IRQ,
297	CMD_SYNC_SIG_SEV,
298	};
299
300	#define CMD_TYPE(x) extract32((x)->word[0], 0 , 8)
301	#define CMD_SSEC(x) extract32((x)->word[0], 10, 1)
302	#define CMD_SSV(x) extract32((x)->word[0], 11, 1)
303	#define CMD_RESUME_AC(x) extract32((x)->word[0], 12, 1)
304	#define CMD_RESUME_AB(x) extract32((x)->word[0], 13, 1)
305	#define CMD_SYNC_CS(x) extract32((x)->word[0], 12, 2)
306	#define CMD_SSID(x) extract32((x)->word[0], 12, 20)
307	#define CMD_SID(x) ((x)->word[1])
308	#define CMD_VMID(x) extract32((x)->word[1], 0 , 16)
309	#define CMD_ASID(x) extract32((x)->word[1], 16, 16)
310	#define CMD_RESUME_STAG(x) extract32((x)->word[2], 0 , 16)
311	#define CMD_RESP(x) extract32((x)->word[2], 11, 2)
312	#define CMD_LEAF(x) extract32((x)->word[2], 0 , 1)
313	#define CMD_STE_RANGE(x) extract32((x)->word[2], 0 , 5)
314	#define CMD_ADDR(x) ({ \
315	uint64_t high = (uint64_t)(x)->word[3]; \
316	uint64_t low = extract32((x)->word[2], 12, 20); \
317	uint64_t addr = high << 32 \| (low << 12); \
318	addr; \
319	})
320
fae4be38	321	#define SMMU_FEATURE_2LVL_STE (1 << 0)
dadd1a08	322
bb981004 EA	323	/* Events */
	324
	325	typedef enum SMMUEventType {
9122bea9	326	SMMU_EVT_NONE = 0x00,
bb981004 EA	327	SMMU_EVT_F_UUT ,
	328	SMMU_EVT_C_BAD_STREAMID ,
	329	SMMU_EVT_F_STE_FETCH ,
	330	SMMU_EVT_C_BAD_STE ,
	331	SMMU_EVT_F_BAD_ATS_TREQ ,
	332	SMMU_EVT_F_STREAM_DISABLED ,
	333	SMMU_EVT_F_TRANS_FORBIDDEN ,
	334	SMMU_EVT_C_BAD_SUBSTREAMID ,
	335	SMMU_EVT_F_CD_FETCH ,
	336	SMMU_EVT_C_BAD_CD ,
	337	SMMU_EVT_F_WALK_EABT ,
	338	SMMU_EVT_F_TRANSLATION = 0x10,
	339	SMMU_EVT_F_ADDR_SIZE ,
	340	SMMU_EVT_F_ACCESS ,
	341	SMMU_EVT_F_PERMISSION ,
	342	SMMU_EVT_F_TLB_CONFLICT = 0x20,
	343	SMMU_EVT_F_CFG_CONFLICT ,
	344	SMMU_EVT_E_PAGE_REQ = 0x24,
	345	} SMMUEventType;
	346
	347	static const char *event_stringify[] = {
9122bea9	348	[SMMU_EVT_NONE] = "no recorded event",
bb981004 EA	349	[SMMU_EVT_F_UUT] = "SMMU_EVT_F_UUT",
	350	[SMMU_EVT_C_BAD_STREAMID] = "SMMU_EVT_C_BAD_STREAMID",
	351	[SMMU_EVT_F_STE_FETCH] = "SMMU_EVT_F_STE_FETCH",
	352	[SMMU_EVT_C_BAD_STE] = "SMMU_EVT_C_BAD_STE",
	353	[SMMU_EVT_F_BAD_ATS_TREQ] = "SMMU_EVT_F_BAD_ATS_TREQ",
	354	[SMMU_EVT_F_STREAM_DISABLED] = "SMMU_EVT_F_STREAM_DISABLED",
	355	[SMMU_EVT_F_TRANS_FORBIDDEN] = "SMMU_EVT_F_TRANS_FORBIDDEN",
	356	[SMMU_EVT_C_BAD_SUBSTREAMID] = "SMMU_EVT_C_BAD_SUBSTREAMID",
	357	[SMMU_EVT_F_CD_FETCH] = "SMMU_EVT_F_CD_FETCH",
	358	[SMMU_EVT_C_BAD_CD] = "SMMU_EVT_C_BAD_CD",
	359	[SMMU_EVT_F_WALK_EABT] = "SMMU_EVT_F_WALK_EABT",
	360	[SMMU_EVT_F_TRANSLATION] = "SMMU_EVT_F_TRANSLATION",
	361	[SMMU_EVT_F_ADDR_SIZE] = "SMMU_EVT_F_ADDR_SIZE",
	362	[SMMU_EVT_F_ACCESS] = "SMMU_EVT_F_ACCESS",
	363	[SMMU_EVT_F_PERMISSION] = "SMMU_EVT_F_PERMISSION",
	364	[SMMU_EVT_F_TLB_CONFLICT] = "SMMU_EVT_F_TLB_CONFLICT",
	365	[SMMU_EVT_F_CFG_CONFLICT] = "SMMU_EVT_F_CFG_CONFLICT",
	366	[SMMU_EVT_E_PAGE_REQ] = "SMMU_EVT_E_PAGE_REQ",
	367	};
	368
	369	static inline const char *smmu_event_string(SMMUEventType type)
	370	{
	371	if (type < ARRAY_SIZE(event_stringify)) {
	372	return event_stringify[type] ? event_stringify[type] : "UNKNOWN";
	373	} else {
	374	return "INVALID";
	375	}
	376	}
	377
	378	/* Encode an event record */
	379	typedef struct SMMUEventInfo {
	380	SMMUEventType type;
	381	uint32_t sid;
	382	bool recorded;
	383	bool record_trans_faults;
	384	union {
	385	struct {
	386	uint32_t ssid;
	387	bool ssv;
	388	dma_addr_t addr;
	389	bool rnw;
	390	bool pnu;
	391	bool ind;
	392	} f_uut;
	393	struct SSIDInfo {
	394	uint32_t ssid;
	395	bool ssv;
	396	} c_bad_streamid;
	397	struct SSIDAddrInfo {
	398	uint32_t ssid;
	399	bool ssv;
	400	dma_addr_t addr;
	401	} f_ste_fetch;
	402	struct SSIDInfo c_bad_ste;
	403	struct {
	404	dma_addr_t addr;
	405	bool rnw;
	406	} f_transl_forbidden;
	407	struct {
	408	uint32_t ssid;
	409	} c_bad_substream;
	410	struct SSIDAddrInfo f_cd_fetch;
	411	struct SSIDInfo c_bad_cd;
	412	struct FullInfo {
413	bool stall;
414	uint16_t stag;
415	uint32_t ssid;
416	bool ssv;
417	bool s2;
418	dma_addr_t addr;
419	bool rnw;
420	bool pnu;
421	bool ind;
422	uint8_t class;
423	dma_addr_t addr2;
424	} f_walk_eabt;
425	struct FullInfo f_translation;
426	struct FullInfo f_addr_size;
427	struct FullInfo f_access;
428	struct FullInfo f_permission;
429	struct SSIDInfo f_cfg_conflict;
430	/**
431	* not supported yet:
432	* F_BAD_ATS_TREQ
433	* F_BAD_ATS_TREQ
434	* F_TLB_CONFLICT
435	* E_PAGE_REQUEST
436	* IMPDEF_EVENTn
437	*/
438	} u;
439	} SMMUEventInfo;
440
441	/* EVTQ fields */
442
443	#define EVT_Q_OVERFLOW (1 << 31)
444
9f4d2a13 EA	445	#define EVT_SET_TYPE(x, v) ((x)->word[0] = deposit32((x)->word[0], 0 , 8 , v))
	446	#define EVT_SET_SSV(x, v) ((x)->word[0] = deposit32((x)->word[0], 11, 1 , v))
	447	#define EVT_SET_SSID(x, v) ((x)->word[0] = deposit32((x)->word[0], 12, 20, v))
	448	#define EVT_SET_SID(x, v) ((x)->word[1] = v)
	449	#define EVT_SET_STAG(x, v) ((x)->word[2] = deposit32((x)->word[2], 0 , 16, v))
	450	#define EVT_SET_STALL(x, v) ((x)->word[2] = deposit32((x)->word[2], 31, 1 , v))
	451	#define EVT_SET_PNU(x, v) ((x)->word[3] = deposit32((x)->word[3], 1 , 1 , v))
	452	#define EVT_SET_IND(x, v) ((x)->word[3] = deposit32((x)->word[3], 2 , 1 , v))
	453	#define EVT_SET_RNW(x, v) ((x)->word[3] = deposit32((x)->word[3], 3 , 1 , v))
	454	#define EVT_SET_S2(x, v) ((x)->word[3] = deposit32((x)->word[3], 7 , 1 , v))
	455	#define EVT_SET_CLASS(x, v) ((x)->word[3] = deposit32((x)->word[3], 8 , 2 , v))
bb981004 EA	456	#define EVT_SET_ADDR(x, addr) \
	457	do { \
	458	(x)->word[5] = (uint32_t)(addr >> 32); \
	459	(x)->word[4] = (uint32_t)(addr & 0xffffffff); \
	460	} while (0)
	461	#define EVT_SET_ADDR2(x, addr) \
	462	do { \
9f4d2a13 EA	463	(x)->word[7] = deposit32((x)->word[7], 3, 29, addr >> 16); \
9f4d2a13 EA	464	(x)->word[7] = deposit32((x)->word[7], 0, 16, addr & 0xffff);\
bb981004 EA	465	} while (0)
	466
	467	void smmuv3_record_event(SMMUv3State s, SMMUEventInfo event);
	468
9bde7f06 EA	469	/* Configuration Data */
	470
	471	/* STE Level 1 Descriptor */
	472	typedef struct STEDesc {
	473	uint32_t word[2];
	474	} STEDesc;
	475
	476	/* CD Level 1 Descriptor */
	477	typedef struct CDDesc {
	478	uint32_t word[2];
	479	} CDDesc;
	480
	481	/* Stream Table Entry(STE) */
	482	typedef struct STE {
	483	uint32_t word[16];
	484	} STE;
	485
	486	/* Context Descriptor(CD) */
	487	typedef struct CD {
	488	uint32_t word[16];
	489	} CD;
	490
	491	/* STE fields */
	492
	493	#define STE_VALID(x) extract32((x)->word[0], 0, 1)
	494
	495	#define STE_CONFIG(x) extract32((x)->word[0], 1, 3)
	496	#define STE_CFG_S1_ENABLED(config) (config & 0x1)
	497	#define STE_CFG_S2_ENABLED(config) (config & 0x2)
	498	#define STE_CFG_ABORT(config) (!(config & 0x4))
	499	#define STE_CFG_BYPASS(config) (config == 0x4)
	500
	501	#define STE_S1FMT(x) extract32((x)->word[0], 4 , 2)
	502	#define STE_S1CDMAX(x) extract32((x)->word[1], 27, 5)
	503	#define STE_S1STALLD(x) extract32((x)->word[2], 27, 1)
	504	#define STE_EATS(x) extract32((x)->word[2], 28, 2)
	505	#define STE_STRW(x) extract32((x)->word[2], 30, 2)
	506	#define STE_S2VMID(x) extract32((x)->word[4], 0 , 16)
	507	#define STE_S2T0SZ(x) extract32((x)->word[5], 0 , 6)
	508	#define STE_S2SL0(x) extract32((x)->word[5], 6 , 2)
	509	#define STE_S2TG(x) extract32((x)->word[5], 14, 2)
	510	#define STE_S2PS(x) extract32((x)->word[5], 16, 3)
	511	#define STE_S2AA64(x) extract32((x)->word[5], 19, 1)
	512	#define STE_S2HD(x) extract32((x)->word[5], 24, 1)
	513	#define STE_S2HA(x) extract32((x)->word[5], 25, 1)
	514	#define STE_S2S(x) extract32((x)->word[5], 26, 1)
	515	#define STE_CTXPTR(x) \
	516	({ \
	517	unsigned long addr; \
	518	addr = (uint64_t)extract32((x)->word[1], 0, 16) << 32; \
	519	addr \|= (uint64_t)((x)->word[0] & 0xffffffc0); \
	520	addr; \
	521	})
	522
	523	#define STE_S2TTB(x) \
	524	({ \
	525	unsigned long addr; \
	526	addr = (uint64_t)extract32((x)->word[7], 0, 16) << 32; \
	527	addr \|= (uint64_t)((x)->word[6] & 0xfffffff0); \
	528	addr; \
	529	})
	530
	531	static inline int oas2bits(int oas_field)
	532	{
533	switch (oas_field) {
534	case 0:
535	return 32;
536	case 1:
537	return 36;
538	case 2:
539	return 40;
540	case 3:
541	return 42;
542	case 4:
543	return 44;
544	case 5:
545	return 48;
546	}
547	return -1;
548	}
549
550	static inline int pa_range(STE *ste)
551	{
552	int oas_field = MIN(STE_S2PS(ste), SMMU_IDR5_OAS);
553
554	if (!STE_S2AA64(ste)) {
555	return 40;
556	}
557
558	return oas2bits(oas_field);
559	}
560
561	#define MAX_PA(ste) ((1 << pa_range(ste)) - 1)
562
563	/* CD fields */
564
565	#define CD_VALID(x) extract32((x)->word[0], 30, 1)
566	#define CD_ASID(x) extract32((x)->word[1], 16, 16)
567	#define CD_TTB(x, sel) \
568	({ \
569	uint64_t hi, lo; \
570	hi = extract32((x)->word[(sel) * 2 + 3], 0, 19); \
571	hi <<= 32; \
572	lo = (x)->word[(sel) * 2 + 2] & ~0xfULL; \
573	hi \| lo; \
574	})
575
576	#define CD_TSZ(x, sel) extract32((x)->word[0], (16 * (sel)) + 0, 6)
577	#define CD_TG(x, sel) extract32((x)->word[0], (16 * (sel)) + 6, 2)
578	#define CD_EPD(x, sel) extract32((x)->word[0], (16 * (sel)) + 14, 1)
579	#define CD_ENDI(x) extract32((x)->word[0], 15, 1)
580	#define CD_IPS(x) extract32((x)->word[1], 0 , 3)
581	#define CD_TBI(x) extract32((x)->word[1], 6 , 2)
582	#define CD_HD(x) extract32((x)->word[1], 10 , 1)
583	#define CD_HA(x) extract32((x)->word[1], 11 , 1)
584	#define CD_S(x) extract32((x)->word[1], 12, 1)
585	#define CD_R(x) extract32((x)->word[1], 13, 1)
586	#define CD_A(x) extract32((x)->word[1], 14, 1)
587	#define CD_AARCH64(x) extract32((x)->word[1], 9 , 1)
588
589	#define CDM_VALID(x) ((x)->word[0] & 0x1)
590
591	static inline int is_cd_valid(SMMUv3State s, STE ste, CD *cd)
592	{
593	return CD_VALID(cd);
594	}
595
596	/**
597	* tg2granule - Decodes the CD translation granule size field according
598	* to the ttbr in use
599	* @bits: TG0/1 fields
600	* @ttbr: ttbr index in use
601	*/
602	static inline int tg2granule(int bits, int ttbr)
603	{
604	switch (bits) {
605	case 0:
606	return ttbr ? 0 : 12;
607	case 1:
608	return ttbr ? 14 : 16;
609	case 2:
610	return ttbr ? 12 : 14;
611	case 3:
612	return ttbr ? 16 : 0;
613	default:
614	return 0;
615	}
616	}
617
618	static inline uint64_t l1std_l2ptr(STEDesc *desc)
619	{
620	uint64_t hi, lo;
621
622	hi = desc->word[1];
623	lo = desc->word[0] & ~0x1fULL;
624	return hi << 32 \| lo;
625	}
626
627	#define L1STD_SPAN(stm) (extract32((stm)->word[0], 0, 4))
628
10a83cb9	629	#endif