[mirror_qemu.git] / target / riscv / cpu.h

/*
 * QEMU RISC-V CPU
 *
 * Copyright (c) 2016-2017 Sagar Karandikar, sagark@eecs.berkeley.edu
 * Copyright (c) 2017-2018 SiFive, Inc.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2 or later, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope 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 RISCV_CPU_H
#define RISCV_CPU_H

#include "hw/core/cpu.h"
#include "hw/registerfields.h"
#include "exec/cpu-defs.h"
#include "fpu/softfloat-types.h"
#include "qom/object.h"

#define TCG_GUEST_DEFAULT_MO 0

#define TYPE_RISCV_CPU "riscv-cpu"

#define RISCV_CPU_TYPE_SUFFIX "-" TYPE_RISCV_CPU
#define RISCV_CPU_TYPE_NAME(name) (name RISCV_CPU_TYPE_SUFFIX)
#define CPU_RESOLVING_TYPE TYPE_RISCV_CPU

#define TYPE_RISCV_CPU_ANY              RISCV_CPU_TYPE_NAME("any")
#define TYPE_RISCV_CPU_BASE32           RISCV_CPU_TYPE_NAME("rv32")
#define TYPE_RISCV_CPU_BASE64           RISCV_CPU_TYPE_NAME("rv64")
#define TYPE_RISCV_CPU_IBEX             RISCV_CPU_TYPE_NAME("lowrisc-ibex")
#define TYPE_RISCV_CPU_SHAKTI_C         RISCV_CPU_TYPE_NAME("shakti-c")
#define TYPE_RISCV_CPU_SIFIVE_E31       RISCV_CPU_TYPE_NAME("sifive-e31")
#define TYPE_RISCV_CPU_SIFIVE_E34       RISCV_CPU_TYPE_NAME("sifive-e34")
#define TYPE_RISCV_CPU_SIFIVE_E51       RISCV_CPU_TYPE_NAME("sifive-e51")
#define TYPE_RISCV_CPU_SIFIVE_U34       RISCV_CPU_TYPE_NAME("sifive-u34")
#define TYPE_RISCV_CPU_SIFIVE_U54       RISCV_CPU_TYPE_NAME("sifive-u54")

#if defined(TARGET_RISCV32)
# define TYPE_RISCV_CPU_BASE            TYPE_RISCV_CPU_BASE32
#elif defined(TARGET_RISCV64)
# define TYPE_RISCV_CPU_BASE            TYPE_RISCV_CPU_BASE64
#endif

#define RV32 ((target_ulong)1 << (TARGET_LONG_BITS - 2))
#define RV64 ((target_ulong)2 << (TARGET_LONG_BITS - 2))

#define RV(x) ((target_ulong)1 << (x - 'A'))

#define RVI RV('I')
#define RVE RV('E') /* E and I are mutually exclusive */
#define RVM RV('M')
#define RVA RV('A')
#define RVF RV('F')
#define RVD RV('D')
#define RVV RV('V')
#define RVC RV('C')
#define RVS RV('S')
#define RVU RV('U')
#define RVH RV('H')

/* S extension denotes that Supervisor mode exists, however it is possible
   to have a core that support S mode but does not have an MMU and there
   is currently no bit in misa to indicate whether an MMU exists or not
   so a cpu features bitfield is required, likewise for optional PMP support */
enum {
    RISCV_FEATURE_MMU,
    RISCV_FEATURE_PMP,
    RISCV_FEATURE_EPMP,
    RISCV_FEATURE_MISA
};

#define PRIV_VERSION_1_10_0 0x00011000
#define PRIV_VERSION_1_11_0 0x00011100

#define VEXT_VERSION_0_07_1 0x00000701

enum {
    TRANSLATE_SUCCESS,
    TRANSLATE_FAIL,
    TRANSLATE_PMP_FAIL,
    TRANSLATE_G_STAGE_FAIL
};

#define MMU_USER_IDX 3

#define MAX_RISCV_PMPS (16)

typedef struct CPURISCVState CPURISCVState;

#if !defined(CONFIG_USER_ONLY)
#include "pmp.h"
#endif

#define RV_VLEN_MAX 256

FIELD(VTYPE, VLMUL, 0, 2)
FIELD(VTYPE, VSEW, 2, 3)
FIELD(VTYPE, VEDIV, 5, 2)
FIELD(VTYPE, RESERVED, 7, sizeof(target_ulong) * 8 - 9)
FIELD(VTYPE, VILL, sizeof(target_ulong) * 8 - 1, 1)

struct CPURISCVState {
    target_ulong gpr[32];
    uint64_t fpr[32]; /* assume both F and D extensions */

    /* vector coprocessor state. */
    uint64_t vreg[32 * RV_VLEN_MAX / 64] QEMU_ALIGNED(16);
    target_ulong vxrm;
    target_ulong vxsat;
    target_ulong vl;
    target_ulong vstart;
    target_ulong vtype;

    target_ulong pc;
    target_ulong load_res;
    target_ulong load_val;

    target_ulong frm;

    target_ulong badaddr;
    target_ulong guest_phys_fault_addr;

    target_ulong priv_ver;
    target_ulong bext_ver;
    target_ulong vext_ver;
    target_ulong misa;
    target_ulong misa_mask;

    uint32_t features;

#ifdef CONFIG_USER_ONLY
    uint32_t elf_flags;
#endif

#ifndef CONFIG_USER_ONLY
    target_ulong priv;
    /* This contains QEMU specific information about the virt state. */
    target_ulong virt;
    target_ulong resetvec;

    target_ulong mhartid;
    /*
     * For RV32 this is 32-bit mstatus and 32-bit mstatush.
     * For RV64 this is a 64-bit mstatus.
     */
    uint64_t mstatus;

    target_ulong mip;

    uint32_t miclaim;

    target_ulong mie;
    target_ulong mideleg;

    target_ulong satp;   /* since: priv-1.10.0 */
    target_ulong stval;
    target_ulong medeleg;

    target_ulong stvec;
    target_ulong sepc;
    target_ulong scause;

    target_ulong mtvec;
    target_ulong mepc;
    target_ulong mcause;
    target_ulong mtval;  /* since: priv-1.10.0 */

    /* Hypervisor CSRs */
    target_ulong hstatus;
    target_ulong hedeleg;
    target_ulong hideleg;
    target_ulong hcounteren;
    target_ulong htval;
    target_ulong htinst;
    target_ulong hgatp;
    uint64_t htimedelta;

    /* Virtual CSRs */
    /*
     * For RV32 this is 32-bit vsstatus and 32-bit vsstatush.
     * For RV64 this is a 64-bit vsstatus.
     */
    uint64_t vsstatus;
    target_ulong vstvec;
    target_ulong vsscratch;
    target_ulong vsepc;
    target_ulong vscause;
    target_ulong vstval;
    target_ulong vsatp;

    target_ulong mtval2;
    target_ulong mtinst;

    /* HS Backup CSRs */
    target_ulong stvec_hs;
    target_ulong sscratch_hs;
    target_ulong sepc_hs;
    target_ulong scause_hs;
    target_ulong stval_hs;
    target_ulong satp_hs;
    uint64_t mstatus_hs;

    /* Signals whether the current exception occurred with two-stage address
       translation active. */
    bool two_stage_lookup;

    target_ulong scounteren;
    target_ulong mcounteren;

    target_ulong sscratch;
    target_ulong mscratch;

    /* temporary htif regs */
    uint64_t mfromhost;
    uint64_t mtohost;
    uint64_t timecmp;

    /* physical memory protection */
    pmp_table_t pmp_state;
    target_ulong mseccfg;

    /* machine specific rdtime callback */
    uint64_t (*rdtime_fn)(uint32_t);
    uint32_t rdtime_fn_arg;

    /* True if in debugger mode.  */
    bool debugger;
#endif

    float_status fp_status;

    /* Fields from here on are preserved across CPU reset. */
    QEMUTimer *timer; /* Internal timer */
};

OBJECT_DECLARE_TYPE(RISCVCPU, RISCVCPUClass,
                    RISCV_CPU)

/**
 * RISCVCPUClass:
 * @parent_realize: The parent class' realize handler.
 * @parent_reset: The parent class' reset handler.
 *
 * A RISCV CPU model.
 */
struct RISCVCPUClass {
    /*< private >*/
    CPUClass parent_class;
    /*< public >*/
    DeviceRealize parent_realize;
    DeviceReset parent_reset;
};

/**
 * RISCVCPU:
 * @env: #CPURISCVState
 *
 * A RISCV CPU.
 */
struct RISCVCPU {
    /*< private >*/
    CPUState parent_obj;
    /*< public >*/
    CPUNegativeOffsetState neg;
    CPURISCVState env;

    char *dyn_csr_xml;

    /* Configuration Settings */
    struct {
        bool ext_i;
        bool ext_e;
        bool ext_g;
        bool ext_m;
        bool ext_a;
        bool ext_f;
        bool ext_d;
        bool ext_c;
        bool ext_s;
        bool ext_u;
        bool ext_h;
        bool ext_v;
        bool ext_zba;
        bool ext_zbb;
        bool ext_zbc;
        bool ext_zbs;
        bool ext_counters;
        bool ext_ifencei;
        bool ext_icsr;

        char *priv_spec;
        char *user_spec;
        char *bext_spec;
        char *vext_spec;
        uint16_t vlen;
        uint16_t elen;
        bool mmu;
        bool pmp;
        bool epmp;
        uint64_t resetvec;
    } cfg;
};

static inline int riscv_has_ext(CPURISCVState *env, target_ulong ext)
{
    return (env->misa & ext) != 0;
}

static inline bool riscv_feature(CPURISCVState *env, int feature)
{
    return env->features & (1ULL << feature);
}

#include "cpu_user.h"
#include "cpu_bits.h"

extern const char * const riscv_int_regnames[];
extern const char * const riscv_fpr_regnames[];

const char *riscv_cpu_get_trap_name(target_ulong cause, bool async);
void riscv_cpu_do_interrupt(CPUState *cpu);
int riscv_cpu_write_elf64_note(WriteCoreDumpFunction f, CPUState *cs,
                               int cpuid, void *opaque);
int riscv_cpu_write_elf32_note(WriteCoreDumpFunction f, CPUState *cs,
                               int cpuid, void *opaque);
int riscv_cpu_gdb_read_register(CPUState *cpu, GByteArray *buf, int reg);
int riscv_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg);
bool riscv_cpu_fp_enabled(CPURISCVState *env);
bool riscv_cpu_virt_enabled(CPURISCVState *env);
void riscv_cpu_set_virt_enabled(CPURISCVState *env, bool enable);
bool riscv_cpu_force_hs_excep_enabled(CPURISCVState *env);
void riscv_cpu_set_force_hs_excep(CPURISCVState *env, bool enable);
bool riscv_cpu_two_stage_lookup(int mmu_idx);
int riscv_cpu_mmu_index(CPURISCVState *env, bool ifetch);
hwaddr riscv_cpu_get_phys_page_debug(CPUState *cpu, vaddr addr);
void  riscv_cpu_do_unaligned_access(CPUState *cs, vaddr addr,
                                    MMUAccessType access_type, int mmu_idx,
                                    uintptr_t retaddr) QEMU_NORETURN;
bool riscv_cpu_tlb_fill(CPUState *cs, vaddr address, int size,
                        MMUAccessType access_type, int mmu_idx,
                        bool probe, uintptr_t retaddr);
void riscv_cpu_do_transaction_failed(CPUState *cs, hwaddr physaddr,
                                     vaddr addr, unsigned size,
                                     MMUAccessType access_type,
                                     int mmu_idx, MemTxAttrs attrs,
                                     MemTxResult response, uintptr_t retaddr);
char *riscv_isa_string(RISCVCPU *cpu);
void riscv_cpu_list(void);

#define cpu_list riscv_cpu_list
#define cpu_mmu_index riscv_cpu_mmu_index

#ifndef CONFIG_USER_ONLY
bool riscv_cpu_exec_interrupt(CPUState *cs, int interrupt_request);
void riscv_cpu_swap_hypervisor_regs(CPURISCVState *env);
int riscv_cpu_claim_interrupts(RISCVCPU *cpu, uint32_t interrupts);
uint32_t riscv_cpu_update_mip(RISCVCPU *cpu, uint32_t mask, uint32_t value);
#define BOOL_TO_MASK(x) (-!!(x)) /* helper for riscv_cpu_update_mip value */
void riscv_cpu_set_rdtime_fn(CPURISCVState *env, uint64_t (*fn)(uint32_t),
                             uint32_t arg);
#endif
void riscv_cpu_set_mode(CPURISCVState *env, target_ulong newpriv);

void riscv_translate_init(void);
void QEMU_NORETURN riscv_raise_exception(CPURISCVState *env,
                                         uint32_t exception, uintptr_t pc);

target_ulong riscv_cpu_get_fflags(CPURISCVState *env);
void riscv_cpu_set_fflags(CPURISCVState *env, target_ulong);

#define TB_FLAGS_MMU_MASK   7
#define TB_FLAGS_PRIV_MMU_MASK                3
#define TB_FLAGS_PRIV_HYP_ACCESS_MASK   (1 << 2)
#define TB_FLAGS_MSTATUS_FS MSTATUS_FS

typedef CPURISCVState CPUArchState;
typedef RISCVCPU ArchCPU;
#include "exec/cpu-all.h"

FIELD(TB_FLAGS, VL_EQ_VLMAX, 2, 1)
FIELD(TB_FLAGS, LMUL, 3, 2)
FIELD(TB_FLAGS, SEW, 5, 3)
FIELD(TB_FLAGS, VILL, 8, 1)
/* Is a Hypervisor instruction load/store allowed? */
FIELD(TB_FLAGS, HLSX, 9, 1)
FIELD(TB_FLAGS, MSTATUS_HS_FS, 10, 2)

bool riscv_cpu_is_32bit(CPURISCVState *env);

/*
 * A simplification for VLMAX
 * = (1 << LMUL) * VLEN / (8 * (1 << SEW))
 * = (VLEN << LMUL) / (8 << SEW)
 * = (VLEN << LMUL) >> (SEW + 3)
 * = VLEN >> (SEW + 3 - LMUL)
 */
static inline uint32_t vext_get_vlmax(RISCVCPU *cpu, target_ulong vtype)
{
    uint8_t sew, lmul;

    sew = FIELD_EX64(vtype, VTYPE, VSEW);
    lmul = FIELD_EX64(vtype, VTYPE, VLMUL);
    return cpu->cfg.vlen >> (sew + 3 - lmul);
}

static inline void cpu_get_tb_cpu_state(CPURISCVState *env, target_ulong *pc,
                                        target_ulong *cs_base, uint32_t *pflags)
{
    uint32_t flags = 0;

    *pc = env->pc;
    *cs_base = 0;

    if (riscv_has_ext(env, RVV)) {
        uint32_t vlmax = vext_get_vlmax(env_archcpu(env), env->vtype);
        bool vl_eq_vlmax = (env->vstart == 0) && (vlmax == env->vl);
        flags = FIELD_DP32(flags, TB_FLAGS, VILL,
                    FIELD_EX64(env->vtype, VTYPE, VILL));
        flags = FIELD_DP32(flags, TB_FLAGS, SEW,
                    FIELD_EX64(env->vtype, VTYPE, VSEW));
        flags = FIELD_DP32(flags, TB_FLAGS, LMUL,
                    FIELD_EX64(env->vtype, VTYPE, VLMUL));
        flags = FIELD_DP32(flags, TB_FLAGS, VL_EQ_VLMAX, vl_eq_vlmax);
    } else {
        flags = FIELD_DP32(flags, TB_FLAGS, VILL, 1);
    }

#ifdef CONFIG_USER_ONLY
    flags |= TB_FLAGS_MSTATUS_FS;
#else
    flags |= cpu_mmu_index(env, 0);
    if (riscv_cpu_fp_enabled(env)) {
        flags |= env->mstatus & MSTATUS_FS;
    }

    if (riscv_has_ext(env, RVH)) {
        if (env->priv == PRV_M ||
            (env->priv == PRV_S && !riscv_cpu_virt_enabled(env)) ||
            (env->priv == PRV_U && !riscv_cpu_virt_enabled(env) &&
                get_field(env->hstatus, HSTATUS_HU))) {
            flags = FIELD_DP32(flags, TB_FLAGS, HLSX, 1);
        }

        flags = FIELD_DP32(flags, TB_FLAGS, MSTATUS_HS_FS,
                           get_field(env->mstatus_hs, MSTATUS_FS));
    }
#endif

    *pflags = flags;
}

RISCVException riscv_csrrw(CPURISCVState *env, int csrno,
                           target_ulong *ret_value,
                           target_ulong new_value, target_ulong write_mask);
RISCVException riscv_csrrw_debug(CPURISCVState *env, int csrno,
                                 target_ulong *ret_value,
                                 target_ulong new_value,
                                 target_ulong write_mask);

static inline void riscv_csr_write(CPURISCVState *env, int csrno,
                                   target_ulong val)
{
    riscv_csrrw(env, csrno, NULL, val, MAKE_64BIT_MASK(0, TARGET_LONG_BITS));
}

static inline target_ulong riscv_csr_read(CPURISCVState *env, int csrno)
{
    target_ulong val = 0;
    riscv_csrrw(env, csrno, &val, 0, 0);
    return val;
}

typedef RISCVException (*riscv_csr_predicate_fn)(CPURISCVState *env,
                                                 int csrno);
typedef RISCVException (*riscv_csr_read_fn)(CPURISCVState *env, int csrno,
                                            target_ulong *ret_value);
typedef RISCVException (*riscv_csr_write_fn)(CPURISCVState *env, int csrno,
                                             target_ulong new_value);
typedef RISCVException (*riscv_csr_op_fn)(CPURISCVState *env, int csrno,
                                          target_ulong *ret_value,
                                          target_ulong new_value,
                                          target_ulong write_mask);

typedef struct {
    const char *name;
    riscv_csr_predicate_fn predicate;
    riscv_csr_read_fn read;
    riscv_csr_write_fn write;
    riscv_csr_op_fn op;
} riscv_csr_operations;

/* CSR function table constants */
enum {
    CSR_TABLE_SIZE = 0x1000
};

/* CSR function table */
extern riscv_csr_operations csr_ops[CSR_TABLE_SIZE];

void riscv_get_csr_ops(int csrno, riscv_csr_operations *ops);
void riscv_set_csr_ops(int csrno, riscv_csr_operations *ops);

void riscv_cpu_register_gdb_regs_for_features(CPUState *cs);

#endif /* RISCV_CPU_H */
Commit	Line	Data
dc5bd18f MC	1	/*
	2	* QEMU RISC-V CPU
	3	*
	4	* Copyright (c) 2016-2017 Sagar Karandikar, sagark@eecs.berkeley.edu
	5	* Copyright (c) 2017-2018 SiFive, Inc.
	6	*
	7	* This program is free software; you can redistribute it and/or modify it
	8	* under the terms and conditions of the GNU General Public License,
	9	* version 2 or later, as published by the Free Software Foundation.
	10	*
	11	* This program is distributed in the hope it will be useful, but WITHOUT
	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	14	* more details.
	15	*
	16	* You should have received a copy of the GNU General Public License along with
	17	* this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#ifndef RISCV_CPU_H
	21	#define RISCV_CPU_H
	22
2e5b09fd	23	#include "hw/core/cpu.h"
2b7168fc	24	#include "hw/registerfields.h"
dc5bd18f	25	#include "exec/cpu-defs.h"
135b03cb	26	#include "fpu/softfloat-types.h"
db1015e9	27	#include "qom/object.h"
dc5bd18f	28
74433bf0 RH	29	#define TCG_GUEST_DEFAULT_MO 0
74433bf0 RH	30
dc5bd18f MC	31	#define TYPE_RISCV_CPU "riscv-cpu"
	32
	33	#define RISCV_CPU_TYPE_SUFFIX "-" TYPE_RISCV_CPU
	34	#define RISCV_CPU_TYPE_NAME(name) (name RISCV_CPU_TYPE_SUFFIX)
0dacec87	35	#define CPU_RESOLVING_TYPE TYPE_RISCV_CPU
dc5bd18f MC	36
dc5bd18f MC	37	#define TYPE_RISCV_CPU_ANY RISCV_CPU_TYPE_NAME("any")
8903bf6e AF	38	#define TYPE_RISCV_CPU_BASE32 RISCV_CPU_TYPE_NAME("rv32")
8903bf6e AF	39	#define TYPE_RISCV_CPU_BASE64 RISCV_CPU_TYPE_NAME("rv64")
36b80ad9	40	#define TYPE_RISCV_CPU_IBEX RISCV_CPU_TYPE_NAME("lowrisc-ibex")
6ddc7069	41	#define TYPE_RISCV_CPU_SHAKTI_C RISCV_CPU_TYPE_NAME("shakti-c")
dc5bd18f	42	#define TYPE_RISCV_CPU_SIFIVE_E31 RISCV_CPU_TYPE_NAME("sifive-e31")
d784733b	43	#define TYPE_RISCV_CPU_SIFIVE_E34 RISCV_CPU_TYPE_NAME("sifive-e34")
dc5bd18f MC	44	#define TYPE_RISCV_CPU_SIFIVE_E51 RISCV_CPU_TYPE_NAME("sifive-e51")
	45	#define TYPE_RISCV_CPU_SIFIVE_U34 RISCV_CPU_TYPE_NAME("sifive-u34")
	46	#define TYPE_RISCV_CPU_SIFIVE_U54 RISCV_CPU_TYPE_NAME("sifive-u54")
	47
c0a635f3 AF	48	#if defined(TARGET_RISCV32)
	49	# define TYPE_RISCV_CPU_BASE TYPE_RISCV_CPU_BASE32
	50	#elif defined(TARGET_RISCV64)
	51	# define TYPE_RISCV_CPU_BASE TYPE_RISCV_CPU_BASE64
	52	#endif
	53
dc5bd18f MC	54	#define RV32 ((target_ulong)1 << (TARGET_LONG_BITS - 2))
	55	#define RV64 ((target_ulong)2 << (TARGET_LONG_BITS - 2))
	56
dc5bd18f MC	57	#define RV(x) ((target_ulong)1 << (x - 'A'))
	58
	59	#define RVI RV('I')
79f86934	60	#define RVE RV('E') /* E and I are mutually exclusive */
dc5bd18f MC	61	#define RVM RV('M')
	62	#define RVA RV('A')
	63	#define RVF RV('F')
	64	#define RVD RV('D')
ad9e5aa2	65	#define RVV RV('V')
dc5bd18f MC	66	#define RVC RV('C')
	67	#define RVS RV('S')
	68	#define RVU RV('U')
af1fa003	69	#define RVH RV('H')
dc5bd18f MC	70
	71	/* S extension denotes that Supervisor mode exists, however it is possible
	72	to have a core that support S mode but does not have an MMU and there
	73	is currently no bit in misa to indicate whether an MMU exists or not
a88365c1	74	so a cpu features bitfield is required, likewise for optional PMP support */
dc5bd18f	75	enum {
a88365c1	76	RISCV_FEATURE_MMU,
f18637cd	77	RISCV_FEATURE_PMP,
4a345b2a	78	RISCV_FEATURE_EPMP,
f18637cd	79	RISCV_FEATURE_MISA
dc5bd18f MC	80	};
dc5bd18f MC	81
dc5bd18f	82	#define PRIV_VERSION_1_10_0 0x00011000
6729dbbd	83	#define PRIV_VERSION_1_11_0 0x00011100
dc5bd18f	84
32931383 LZ	85	#define VEXT_VERSION_0_07_1 0x00000701
32931383 LZ	86
33a9a57d YJ	87	enum {
	88	TRANSLATE_SUCCESS,
	89	TRANSLATE_FAIL,
	90	TRANSLATE_PMP_FAIL,
	91	TRANSLATE_G_STAGE_FAIL
	92	};
	93
dc5bd18f MC	94	#define MMU_USER_IDX 3
	95
	96	#define MAX_RISCV_PMPS (16)
	97
	98	typedef struct CPURISCVState CPURISCVState;
	99
bbf3d1b4	100	#if !defined(CONFIG_USER_ONLY)
dc5bd18f	101	#include "pmp.h"
bbf3d1b4	102	#endif
dc5bd18f	103
6bf91617	104	#define RV_VLEN_MAX 256
ad9e5aa2	105
2b7168fc LZ	106	FIELD(VTYPE, VLMUL, 0, 2)
	107	FIELD(VTYPE, VSEW, 2, 3)
	108	FIELD(VTYPE, VEDIV, 5, 2)
	109	FIELD(VTYPE, RESERVED, 7, sizeof(target_ulong) * 8 - 9)
fbcbafa2	110	FIELD(VTYPE, VILL, sizeof(target_ulong) * 8 - 1, 1)
2b7168fc	111
dc5bd18f MC	112	struct CPURISCVState {
	113	target_ulong gpr[32];
	114	uint64_t fpr[32]; /* assume both F and D extensions */
ad9e5aa2 LZ	115
	116	/* vector coprocessor state. */
	117	uint64_t vreg[32 * RV_VLEN_MAX / 64] QEMU_ALIGNED(16);
	118	target_ulong vxrm;
	119	target_ulong vxsat;
	120	target_ulong vl;
	121	target_ulong vstart;
	122	target_ulong vtype;
	123
dc5bd18f MC	124	target_ulong pc;
	125	target_ulong load_res;
	126	target_ulong load_val;
	127
	128	target_ulong frm;
	129
	130	target_ulong badaddr;
36a18664	131	target_ulong guest_phys_fault_addr;
dc5bd18f	132
dc5bd18f	133	target_ulong priv_ver;
d2c1a177	134	target_ulong bext_ver;
32931383	135	target_ulong vext_ver;
dc5bd18f	136	target_ulong misa;
f18637cd	137	target_ulong misa_mask;
dc5bd18f MC	138
	139	uint32_t features;
	140
5836c3ec KC	141	#ifdef CONFIG_USER_ONLY
	142	uint32_t elf_flags;
	143	#endif
	144
dc5bd18f MC	145	#ifndef CONFIG_USER_ONLY
dc5bd18f MC	146	target_ulong priv;
ef6bb7b6 AF	147	/* This contains QEMU specific information about the virt state. */
ef6bb7b6 AF	148	target_ulong virt;
dc5bd18f MC	149	target_ulong resetvec;
	150
	151	target_ulong mhartid;
284d697c YJ	152	/*
	153	* For RV32 this is 32-bit mstatus and 32-bit mstatush.
	154	* For RV64 this is a 64-bit mstatus.
	155	*/
	156	uint64_t mstatus;
85ba724f	157
02861613	158	target_ulong mip;
66e594f2	159
e3e7039c	160	uint32_t miclaim;
85ba724f	161
dc5bd18f MC	162	target_ulong mie;
	163	target_ulong mideleg;
	164
dc5bd18f	165	target_ulong satp; /* since: priv-1.10.0 */
ac12b601	166	target_ulong stval;
dc5bd18f MC	167	target_ulong medeleg;
	168
	169	target_ulong stvec;
	170	target_ulong sepc;
	171	target_ulong scause;
	172
	173	target_ulong mtvec;
	174	target_ulong mepc;
	175	target_ulong mcause;
	176	target_ulong mtval; /* since: priv-1.10.0 */
	177
bd023ce3 AF	178	/* Hypervisor CSRs */
	179	target_ulong hstatus;
	180	target_ulong hedeleg;
	181	target_ulong hideleg;
	182	target_ulong hcounteren;
	183	target_ulong htval;
	184	target_ulong htinst;
	185	target_ulong hgatp;
c6957248	186	uint64_t htimedelta;
bd023ce3 AF	187
bd023ce3 AF	188	/* Virtual CSRs */
284d697c YJ	189	/*
	190	* For RV32 this is 32-bit vsstatus and 32-bit vsstatush.
	191	* For RV64 this is a 64-bit vsstatus.
	192	*/
	193	uint64_t vsstatus;
bd023ce3 AF	194	target_ulong vstvec;
	195	target_ulong vsscratch;
	196	target_ulong vsepc;
	197	target_ulong vscause;
	198	target_ulong vstval;
	199	target_ulong vsatp;
	200
	201	target_ulong mtval2;
	202	target_ulong mtinst;
	203
66e594f2 AF	204	/* HS Backup CSRs */
	205	target_ulong stvec_hs;
	206	target_ulong sscratch_hs;
	207	target_ulong sepc_hs;
	208	target_ulong scause_hs;
	209	target_ulong stval_hs;
	210	target_ulong satp_hs;
284d697c	211	uint64_t mstatus_hs;
66e594f2	212
ec352d0c GK	213	/* Signals whether the current exception occurred with two-stage address
	214	translation active. */
	215	bool two_stage_lookup;
	216
8c59f5c1 MC	217	target_ulong scounteren;
8c59f5c1 MC	218	target_ulong mcounteren;
dc5bd18f MC	219
	220	target_ulong sscratch;
	221	target_ulong mscratch;
	222
	223	/* temporary htif regs */
	224	uint64_t mfromhost;
	225	uint64_t mtohost;
	226	uint64_t timecmp;
	227
	228	/* physical memory protection */
	229	pmp_table_t pmp_state;
2582a95c	230	target_ulong mseccfg;
753e3fe2	231
c6957248	232	/* machine specific rdtime callback */
a47ef6e9 BM	233	uint64_t (*rdtime_fn)(uint32_t);
a47ef6e9 BM	234	uint32_t rdtime_fn_arg;
c6957248	235
753e3fe2 JW	236	/* True if in debugger mode. */
753e3fe2 JW	237	bool debugger;
dc5bd18f MC	238	#endif
	239
	240	float_status fp_status;
	241
dc5bd18f MC	242	/* Fields from here on are preserved across CPU reset. */
	243	QEMUTimer timer; / Internal timer */
	244	};
	245
c821774a	246	OBJECT_DECLARE_TYPE(RISCVCPU, RISCVCPUClass,
30b5707c	247	RISCV_CPU)
dc5bd18f MC	248
	249	/**
	250	* RISCVCPUClass:
	251	* @parent_realize: The parent class' realize handler.
	252	* @parent_reset: The parent class' reset handler.
	253	*
	254	* A RISCV CPU model.
	255	*/
db1015e9	256	struct RISCVCPUClass {
dc5bd18f MC	257	/< private >/
	258	CPUClass parent_class;
	259	/< public >/
	260	DeviceRealize parent_realize;
781c67ca	261	DeviceReset parent_reset;
db1015e9	262	};
dc5bd18f MC	263
	264	/**
	265	* RISCVCPU:
	266	* @env: #CPURISCVState
	267	*
	268	* A RISCV CPU.
	269	*/
db1015e9	270	struct RISCVCPU {
dc5bd18f MC	271	/< private >/
	272	CPUState parent_obj;
	273	/< public >/
5b146dc7	274	CPUNegativeOffsetState neg;
dc5bd18f	275	CPURISCVState env;
c4e95030	276
b93777e1 BM	277	char *dyn_csr_xml;
b93777e1 BM	278
c4e95030 AF	279	/* Configuration Settings */
c4e95030 AF	280	struct {
b55d7d34 AF	281	bool ext_i;
	282	bool ext_e;
	283	bool ext_g;
	284	bool ext_m;
	285	bool ext_a;
	286	bool ext_f;
	287	bool ext_d;
	288	bool ext_c;
	289	bool ext_s;
	290	bool ext_u;
c9eefe05	291	bool ext_h;
6bf91617	292	bool ext_v;
878dd0e9 PT	293	bool ext_zba;
	294	bool ext_zbb;
	295	bool ext_zbc;
	296	bool ext_zbs;
0a13a5b8	297	bool ext_counters;
50fba816	298	bool ext_ifencei;
591bddea	299	bool ext_icsr;
b55d7d34	300
c4e95030 AF	301	char *priv_spec;
c4e95030 AF	302	char *user_spec;
d2c1a177	303	char *bext_spec;
6bf91617	304	char *vext_spec;
32931383 LZ	305	uint16_t vlen;
32931383 LZ	306	uint16_t elen;
c4e95030 AF	307	bool mmu;
c4e95030 AF	308	bool pmp;
5da9514e	309	bool epmp;
9b4c9b2b	310	uint64_t resetvec;
c4e95030	311	} cfg;
db1015e9	312	};
dc5bd18f	313
dc5bd18f MC	314	static inline int riscv_has_ext(CPURISCVState *env, target_ulong ext)
	315	{
	316	return (env->misa & ext) != 0;
	317	}
	318
	319	static inline bool riscv_feature(CPURISCVState *env, int feature)
	320	{
	321	return env->features & (1ULL << feature);
	322	}
	323
	324	#include "cpu_user.h"
	325	#include "cpu_bits.h"
	326
	327	extern const char * const riscv_int_regnames[];
	328	extern const char * const riscv_fpr_regnames[];
dc5bd18f	329
c51a3f5d	330	const char *riscv_cpu_get_trap_name(target_ulong cause, bool async);
dc5bd18f	331	void riscv_cpu_do_interrupt(CPUState *cpu);
43a96588 YJ	332	int riscv_cpu_write_elf64_note(WriteCoreDumpFunction f, CPUState *cs,
	333	int cpuid, void *opaque);
	334	int riscv_cpu_write_elf32_note(WriteCoreDumpFunction f, CPUState *cs,
	335	int cpuid, void *opaque);
a010bdbe	336	int riscv_cpu_gdb_read_register(CPUState cpu, GByteArray buf, int reg);
dc5bd18f	337	int riscv_cpu_gdb_write_register(CPUState cpu, uint8_t buf, int reg);
b345b480	338	bool riscv_cpu_fp_enabled(CPURISCVState *env);
ef6bb7b6 AF	339	bool riscv_cpu_virt_enabled(CPURISCVState *env);
ef6bb7b6 AF	340	void riscv_cpu_set_virt_enabled(CPURISCVState *env, bool enable);
c7b1bbc8 AF	341	bool riscv_cpu_force_hs_excep_enabled(CPURISCVState *env);
c7b1bbc8 AF	342	void riscv_cpu_set_force_hs_excep(CPURISCVState *env, bool enable);
1c1c060a	343	bool riscv_cpu_two_stage_lookup(int mmu_idx);
dc5bd18f MC	344	int riscv_cpu_mmu_index(CPURISCVState *env, bool ifetch);
	345	hwaddr riscv_cpu_get_phys_page_debug(CPUState *cpu, vaddr addr);
	346	void riscv_cpu_do_unaligned_access(CPUState *cs, vaddr addr,
	347	MMUAccessType access_type, int mmu_idx,
fa947a66	348	uintptr_t retaddr) QEMU_NORETURN;
8a4ca3c1 RH	349	bool riscv_cpu_tlb_fill(CPUState *cs, vaddr address, int size,
	350	MMUAccessType access_type, int mmu_idx,
	351	bool probe, uintptr_t retaddr);
37207e12 PD	352	void riscv_cpu_do_transaction_failed(CPUState *cs, hwaddr physaddr,
	353	vaddr addr, unsigned size,
	354	MMUAccessType access_type,
	355	int mmu_idx, MemTxAttrs attrs,
	356	MemTxResult response, uintptr_t retaddr);
dc5bd18f	357	char riscv_isa_string(RISCVCPU cpu);
0442428a	358	void riscv_cpu_list(void);
dc5bd18f	359
dc5bd18f MC	360	#define cpu_list riscv_cpu_list
	361	#define cpu_mmu_index riscv_cpu_mmu_index
	362
85ba724f	363	#ifndef CONFIG_USER_ONLY
17b3c353	364	bool riscv_cpu_exec_interrupt(CPUState *cs, int interrupt_request);
66e594f2	365	void riscv_cpu_swap_hypervisor_regs(CPURISCVState *env);
e3e7039c	366	int riscv_cpu_claim_interrupts(RISCVCPU *cpu, uint32_t interrupts);
85ba724f MC	367	uint32_t riscv_cpu_update_mip(RISCVCPU *cpu, uint32_t mask, uint32_t value);
85ba724f MC	368	#define BOOL_TO_MASK(x) (-!!(x)) /* helper for riscv_cpu_update_mip value */
a47ef6e9 BM	369	void riscv_cpu_set_rdtime_fn(CPURISCVState env, uint64_t (fn)(uint32_t),
a47ef6e9 BM	370	uint32_t arg);
85ba724f	371	#endif
fb738839	372	void riscv_cpu_set_mode(CPURISCVState *env, target_ulong newpriv);
dc5bd18f MC	373
dc5bd18f MC	374	void riscv_translate_init(void);
fb738839 MC	375	void QEMU_NORETURN riscv_raise_exception(CPURISCVState *env,
fb738839 MC	376	uint32_t exception, uintptr_t pc);
dc5bd18f	377
fb738839 MC	378	target_ulong riscv_cpu_get_fflags(CPURISCVState *env);
fb738839 MC	379	void riscv_cpu_set_fflags(CPURISCVState *env, target_ulong);
dc5bd18f	380
c445593d AF	381	#define TB_FLAGS_MMU_MASK 7
	382	#define TB_FLAGS_PRIV_MMU_MASK 3
	383	#define TB_FLAGS_PRIV_HYP_ACCESS_MASK (1 << 2)
83a71719	384	#define TB_FLAGS_MSTATUS_FS MSTATUS_FS
dc5bd18f	385
2b7168fc LZ	386	typedef CPURISCVState CPUArchState;
	387	typedef RISCVCPU ArchCPU;
	388	#include "exec/cpu-all.h"
	389
	390	FIELD(TB_FLAGS, VL_EQ_VLMAX, 2, 1)
	391	FIELD(TB_FLAGS, LMUL, 3, 2)
	392	FIELD(TB_FLAGS, SEW, 5, 3)
	393	FIELD(TB_FLAGS, VILL, 8, 1)
743077b3 AF	394	/* Is a Hypervisor instruction load/store allowed? */
743077b3 AF	395	FIELD(TB_FLAGS, HLSX, 9, 1)
a88f0402	396	FIELD(TB_FLAGS, MSTATUS_HS_FS, 10, 2)
2b7168fc	397
51ae0cab AF	398	bool riscv_cpu_is_32bit(CPURISCVState *env);
51ae0cab AF	399
2b7168fc LZ	400	/*
	401	* A simplification for VLMAX
	402	* = (1 << LMUL) * VLEN / (8 * (1 << SEW))
	403	* = (VLEN << LMUL) / (8 << SEW)
	404	* = (VLEN << LMUL) >> (SEW + 3)
	405	* = VLEN >> (SEW + 3 - LMUL)
	406	*/
	407	static inline uint32_t vext_get_vlmax(RISCVCPU *cpu, target_ulong vtype)
	408	{
	409	uint8_t sew, lmul;
	410
	411	sew = FIELD_EX64(vtype, VTYPE, VSEW);
	412	lmul = FIELD_EX64(vtype, VTYPE, VLMUL);
	413	return cpu->cfg.vlen >> (sew + 3 - lmul);
	414	}
	415
dc5bd18f	416	static inline void cpu_get_tb_cpu_state(CPURISCVState env, target_ulong pc,
2b7168fc	417	target_ulong cs_base, uint32_t pflags)
dc5bd18f	418	{
2b7168fc LZ	419	uint32_t flags = 0;
2b7168fc LZ	420
dc5bd18f MC	421	*pc = env->pc;
dc5bd18f MC	422	*cs_base = 0;
2b7168fc LZ	423
	424	if (riscv_has_ext(env, RVV)) {
	425	uint32_t vlmax = vext_get_vlmax(env_archcpu(env), env->vtype);
	426	bool vl_eq_vlmax = (env->vstart == 0) && (vlmax == env->vl);
	427	flags = FIELD_DP32(flags, TB_FLAGS, VILL,
	428	FIELD_EX64(env->vtype, VTYPE, VILL));
	429	flags = FIELD_DP32(flags, TB_FLAGS, SEW,
	430	FIELD_EX64(env->vtype, VTYPE, VSEW));
	431	flags = FIELD_DP32(flags, TB_FLAGS, LMUL,
	432	FIELD_EX64(env->vtype, VTYPE, VLMUL));
	433	flags = FIELD_DP32(flags, TB_FLAGS, VL_EQ_VLMAX, vl_eq_vlmax);
	434	} else {
	435	flags = FIELD_DP32(flags, TB_FLAGS, VILL, 1);
	436	}
	437
dc5bd18f	438	#ifdef CONFIG_USER_ONLY
2b7168fc	439	flags \|= TB_FLAGS_MSTATUS_FS;
dc5bd18f	440	#else
2b7168fc	441	flags \|= cpu_mmu_index(env, 0);
e28eaed8	442	if (riscv_cpu_fp_enabled(env)) {
2b7168fc	443	flags \|= env->mstatus & MSTATUS_FS;
e28eaed8	444	}
743077b3 AF	445
	446	if (riscv_has_ext(env, RVH)) {
	447	if (env->priv == PRV_M \|\|
	448	(env->priv == PRV_S && !riscv_cpu_virt_enabled(env)) \|\|
	449	(env->priv == PRV_U && !riscv_cpu_virt_enabled(env) &&
	450	get_field(env->hstatus, HSTATUS_HU))) {
	451	flags = FIELD_DP32(flags, TB_FLAGS, HLSX, 1);
	452	}
a88f0402 FC	453
	454	flags = FIELD_DP32(flags, TB_FLAGS, MSTATUS_HS_FS,
	455	get_field(env->mstatus_hs, MSTATUS_FS));
743077b3	456	}
dc5bd18f	457	#endif
743077b3	458
2b7168fc	459	*pflags = flags;
dc5bd18f MC	460	}
dc5bd18f MC	461
533c91e8 AF	462	RISCVException riscv_csrrw(CPURISCVState *env, int csrno,
	463	target_ulong *ret_value,
	464	target_ulong new_value, target_ulong write_mask);
	465	RISCVException riscv_csrrw_debug(CPURISCVState *env, int csrno,
	466	target_ulong *ret_value,
	467	target_ulong new_value,
	468	target_ulong write_mask);
c7b95171	469
fb738839 MC	470	static inline void riscv_csr_write(CPURISCVState *env, int csrno,
fb738839 MC	471	target_ulong val)
c7b95171 MC	472	{
	473	riscv_csrrw(env, csrno, NULL, val, MAKE_64BIT_MASK(0, TARGET_LONG_BITS));
	474	}
	475
fb738839	476	static inline target_ulong riscv_csr_read(CPURISCVState *env, int csrno)
c7b95171 MC	477	{
	478	target_ulong val = 0;
	479	riscv_csrrw(env, csrno, &val, 0, 0);
	480	return val;
	481	}
	482
0e62f92e AF	483	typedef RISCVException (riscv_csr_predicate_fn)(CPURISCVState env,
0e62f92e AF	484	int csrno);
605def6e AF	485	typedef RISCVException (riscv_csr_read_fn)(CPURISCVState env, int csrno,
	486	target_ulong *ret_value);
	487	typedef RISCVException (riscv_csr_write_fn)(CPURISCVState env, int csrno,
	488	target_ulong new_value);
	489	typedef RISCVException (riscv_csr_op_fn)(CPURISCVState env, int csrno,
	490	target_ulong *ret_value,
	491	target_ulong new_value,
	492	target_ulong write_mask);
c7b95171 MC	493
c7b95171 MC	494	typedef struct {
8ceac5dc	495	const char *name;
a88365c1	496	riscv_csr_predicate_fn predicate;
c7b95171 MC	497	riscv_csr_read_fn read;
	498	riscv_csr_write_fn write;
	499	riscv_csr_op_fn op;
	500	} riscv_csr_operations;
	501
56118ee8 BM	502	/* CSR function table constants */
	503	enum {
	504	CSR_TABLE_SIZE = 0x1000
	505	};
	506
	507	/* CSR function table */
6f03770d	508	extern riscv_csr_operations csr_ops[CSR_TABLE_SIZE];
56118ee8	509
c7b95171 MC	510	void riscv_get_csr_ops(int csrno, riscv_csr_operations *ops);
c7b95171 MC	511	void riscv_set_csr_ops(int csrno, riscv_csr_operations *ops);
dc5bd18f	512
5371f5cd JW	513	void riscv_cpu_register_gdb_regs_for_features(CPUState *cs);
5371f5cd JW	514
dc5bd18f	515	#endif /* RISCV_CPU_H */