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 23 #include "hw/core/cpu.h" 24 #include "exec/cpu-defs.h" 25 #include "fpu/softfloat-types.h" 26 27 #define TCG_GUEST_DEFAULT_MO 0 28 29 #define TYPE_RISCV_CPU "riscv-cpu" 30 31 #define RISCV_CPU_TYPE_SUFFIX "-" TYPE_RISCV_CPU 32 #define RISCV_CPU_TYPE_NAME(name) (name RISCV_CPU_TYPE_SUFFIX) 33 #define CPU_RESOLVING_TYPE TYPE_RISCV_CPU 34 35 #define TYPE_RISCV_CPU_ANY RISCV_CPU_TYPE_NAME("any") 36 #define TYPE_RISCV_CPU_BASE32 RISCV_CPU_TYPE_NAME("rv32") 37 #define TYPE_RISCV_CPU_BASE64 RISCV_CPU_TYPE_NAME("rv64") 38 #define TYPE_RISCV_CPU_SIFIVE_E31 RISCV_CPU_TYPE_NAME("sifive-e31") 39 #define TYPE_RISCV_CPU_SIFIVE_E51 RISCV_CPU_TYPE_NAME("sifive-e51") 40 #define TYPE_RISCV_CPU_SIFIVE_U34 RISCV_CPU_TYPE_NAME("sifive-u34") 41 #define TYPE_RISCV_CPU_SIFIVE_U54 RISCV_CPU_TYPE_NAME("sifive-u54") 42 /* Deprecated */ 43 #define TYPE_RISCV_CPU_RV32IMACU_NOMMU RISCV_CPU_TYPE_NAME("rv32imacu-nommu") 44 #define TYPE_RISCV_CPU_RV32GCSU_V1_09_1 RISCV_CPU_TYPE_NAME("rv32gcsu-v1.9.1") 45 #define TYPE_RISCV_CPU_RV32GCSU_V1_10_0 RISCV_CPU_TYPE_NAME("rv32gcsu-v1.10.0") 46 #define TYPE_RISCV_CPU_RV64IMACU_NOMMU RISCV_CPU_TYPE_NAME("rv64imacu-nommu") 47 #define TYPE_RISCV_CPU_RV64GCSU_V1_09_1 RISCV_CPU_TYPE_NAME("rv64gcsu-v1.9.1") 48 #define TYPE_RISCV_CPU_RV64GCSU_V1_10_0 RISCV_CPU_TYPE_NAME("rv64gcsu-v1.10.0") 49 50 #define RV32 ((target_ulong)1 << (TARGET_LONG_BITS - 2)) 51 #define RV64 ((target_ulong)2 << (TARGET_LONG_BITS - 2)) 52 53 #if defined(TARGET_RISCV32) 54 #define RVXLEN RV32 55 #elif defined(TARGET_RISCV64) 56 #define RVXLEN RV64 57 #endif 58 59 #define RV(x) ((target_ulong)1 << (x - 'A')) 60 61 #define RVI RV('I') 62 #define RVE RV('E') /* E and I are mutually exclusive */ 63 #define RVM RV('M') 64 #define RVA RV('A') 65 #define RVF RV('F') 66 #define RVD RV('D') 67 #define RVC RV('C') 68 #define RVS RV('S') 69 #define RVU RV('U') 70 #define RVH RV('H') 71 72 /* S extension denotes that Supervisor mode exists, however it is possible 73 to have a core that support S mode but does not have an MMU and there 74 is currently no bit in misa to indicate whether an MMU exists or not 75 so a cpu features bitfield is required, likewise for optional PMP support */ 76 enum { 77 RISCV_FEATURE_MMU, 78 RISCV_FEATURE_PMP, 79 RISCV_FEATURE_MISA 80 }; 81 82 #define PRIV_VERSION_1_09_1 0x00010901 83 #define PRIV_VERSION_1_10_0 0x00011000 84 #define PRIV_VERSION_1_11_0 0x00011100 85 86 #define TRANSLATE_PMP_FAIL 2 87 #define TRANSLATE_FAIL 1 88 #define TRANSLATE_SUCCESS 0 89 #define MMU_USER_IDX 3 90 91 #define MAX_RISCV_PMPS (16) 92 93 typedef struct CPURISCVState CPURISCVState; 94 95 #include "pmp.h" 96 97 struct CPURISCVState { 98 target_ulong gpr[32]; 99 uint64_t fpr[32]; /* assume both F and D extensions */ 100 target_ulong pc; 101 target_ulong load_res; 102 target_ulong load_val; 103 104 target_ulong frm; 105 106 target_ulong badaddr; 107 target_ulong guest_phys_fault_addr; 108 109 target_ulong priv_ver; 110 target_ulong misa; 111 target_ulong misa_mask; 112 113 uint32_t features; 114 115 #ifdef CONFIG_USER_ONLY 116 uint32_t elf_flags; 117 #endif 118 119 #ifndef CONFIG_USER_ONLY 120 target_ulong priv; 121 /* This contains QEMU specific information about the virt state. */ 122 target_ulong virt; 123 target_ulong resetvec; 124 125 target_ulong mhartid; 126 target_ulong mstatus; 127 128 target_ulong mip; 129 130 #ifdef TARGET_RISCV32 131 target_ulong mstatush; 132 #endif 133 134 uint32_t miclaim; 135 136 target_ulong mie; 137 target_ulong mideleg; 138 139 target_ulong sptbr; /* until: priv-1.9.1 */ 140 target_ulong satp; /* since: priv-1.10.0 */ 141 target_ulong sbadaddr; 142 target_ulong mbadaddr; 143 target_ulong medeleg; 144 145 target_ulong stvec; 146 target_ulong sepc; 147 target_ulong scause; 148 149 target_ulong mtvec; 150 target_ulong mepc; 151 target_ulong mcause; 152 target_ulong mtval; /* since: priv-1.10.0 */ 153 154 /* Hypervisor CSRs */ 155 target_ulong hstatus; 156 target_ulong hedeleg; 157 target_ulong hideleg; 158 target_ulong hcounteren; 159 target_ulong htval; 160 target_ulong htinst; 161 target_ulong hgatp; 162 163 /* Virtual CSRs */ 164 target_ulong vsstatus; 165 target_ulong vstvec; 166 target_ulong vsscratch; 167 target_ulong vsepc; 168 target_ulong vscause; 169 target_ulong vstval; 170 target_ulong vsatp; 171 #ifdef TARGET_RISCV32 172 target_ulong vsstatush; 173 #endif 174 175 target_ulong mtval2; 176 target_ulong mtinst; 177 178 /* HS Backup CSRs */ 179 target_ulong stvec_hs; 180 target_ulong sscratch_hs; 181 target_ulong sepc_hs; 182 target_ulong scause_hs; 183 target_ulong stval_hs; 184 target_ulong satp_hs; 185 target_ulong mstatus_hs; 186 #ifdef TARGET_RISCV32 187 target_ulong mstatush_hs; 188 #endif 189 190 target_ulong scounteren; 191 target_ulong mcounteren; 192 193 target_ulong sscratch; 194 target_ulong mscratch; 195 196 /* temporary htif regs */ 197 uint64_t mfromhost; 198 uint64_t mtohost; 199 uint64_t timecmp; 200 201 /* physical memory protection */ 202 pmp_table_t pmp_state; 203 204 /* True if in debugger mode. */ 205 bool debugger; 206 #endif 207 208 float_status fp_status; 209 210 /* Fields from here on are preserved across CPU reset. */ 211 QEMUTimer *timer; /* Internal timer */ 212 }; 213 214 #define RISCV_CPU_CLASS(klass) \ 215 OBJECT_CLASS_CHECK(RISCVCPUClass, (klass), TYPE_RISCV_CPU) 216 #define RISCV_CPU(obj) \ 217 OBJECT_CHECK(RISCVCPU, (obj), TYPE_RISCV_CPU) 218 #define RISCV_CPU_GET_CLASS(obj) \ 219 OBJECT_GET_CLASS(RISCVCPUClass, (obj), TYPE_RISCV_CPU) 220 221 /** 222 * RISCVCPUClass: 223 * @parent_realize: The parent class' realize handler. 224 * @parent_reset: The parent class' reset handler. 225 * 226 * A RISCV CPU model. 227 */ 228 typedef struct RISCVCPUClass { 229 /*< private >*/ 230 CPUClass parent_class; 231 /*< public >*/ 232 DeviceRealize parent_realize; 233 void (*parent_reset)(CPUState *cpu); 234 } RISCVCPUClass; 235 236 /** 237 * RISCVCPU: 238 * @env: #CPURISCVState 239 * 240 * A RISCV CPU. 241 */ 242 typedef struct RISCVCPU { 243 /*< private >*/ 244 CPUState parent_obj; 245 /*< public >*/ 246 CPUNegativeOffsetState neg; 247 CPURISCVState env; 248 249 /* Configuration Settings */ 250 struct { 251 bool ext_i; 252 bool ext_e; 253 bool ext_g; 254 bool ext_m; 255 bool ext_a; 256 bool ext_f; 257 bool ext_d; 258 bool ext_c; 259 bool ext_s; 260 bool ext_u; 261 bool ext_counters; 262 bool ext_ifencei; 263 bool ext_icsr; 264 265 char *priv_spec; 266 char *user_spec; 267 bool mmu; 268 bool pmp; 269 } cfg; 270 } RISCVCPU; 271 272 static inline int riscv_has_ext(CPURISCVState *env, target_ulong ext) 273 { 274 return (env->misa & ext) != 0; 275 } 276 277 static inline bool riscv_feature(CPURISCVState *env, int feature) 278 { 279 return env->features & (1ULL << feature); 280 } 281 282 #include "cpu_user.h" 283 #include "cpu_bits.h" 284 285 extern const char * const riscv_int_regnames[]; 286 extern const char * const riscv_fpr_regnames[]; 287 extern const char * const riscv_excp_names[]; 288 extern const char * const riscv_intr_names[]; 289 290 void riscv_cpu_do_interrupt(CPUState *cpu); 291 int riscv_cpu_gdb_read_register(CPUState *cpu, uint8_t *buf, int reg); 292 int riscv_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg); 293 bool riscv_cpu_exec_interrupt(CPUState *cs, int interrupt_request); 294 bool riscv_cpu_fp_enabled(CPURISCVState *env); 295 bool riscv_cpu_virt_enabled(CPURISCVState *env); 296 void riscv_cpu_set_virt_enabled(CPURISCVState *env, bool enable); 297 bool riscv_cpu_force_hs_excep_enabled(CPURISCVState *env); 298 void riscv_cpu_set_force_hs_excep(CPURISCVState *env, bool enable); 299 int riscv_cpu_mmu_index(CPURISCVState *env, bool ifetch); 300 hwaddr riscv_cpu_get_phys_page_debug(CPUState *cpu, vaddr addr); 301 void riscv_cpu_do_unaligned_access(CPUState *cs, vaddr addr, 302 MMUAccessType access_type, int mmu_idx, 303 uintptr_t retaddr); 304 bool riscv_cpu_tlb_fill(CPUState *cs, vaddr address, int size, 305 MMUAccessType access_type, int mmu_idx, 306 bool probe, uintptr_t retaddr); 307 void riscv_cpu_do_transaction_failed(CPUState *cs, hwaddr physaddr, 308 vaddr addr, unsigned size, 309 MMUAccessType access_type, 310 int mmu_idx, MemTxAttrs attrs, 311 MemTxResult response, uintptr_t retaddr); 312 char *riscv_isa_string(RISCVCPU *cpu); 313 void riscv_cpu_list(void); 314 315 #define cpu_signal_handler riscv_cpu_signal_handler 316 #define cpu_list riscv_cpu_list 317 #define cpu_mmu_index riscv_cpu_mmu_index 318 319 #ifndef CONFIG_USER_ONLY 320 void riscv_cpu_swap_hypervisor_regs(CPURISCVState *env); 321 int riscv_cpu_claim_interrupts(RISCVCPU *cpu, uint32_t interrupts); 322 uint32_t riscv_cpu_update_mip(RISCVCPU *cpu, uint32_t mask, uint32_t value); 323 #define BOOL_TO_MASK(x) (-!!(x)) /* helper for riscv_cpu_update_mip value */ 324 #endif 325 void riscv_cpu_set_mode(CPURISCVState *env, target_ulong newpriv); 326 327 void riscv_translate_init(void); 328 int riscv_cpu_signal_handler(int host_signum, void *pinfo, void *puc); 329 void QEMU_NORETURN riscv_raise_exception(CPURISCVState *env, 330 uint32_t exception, uintptr_t pc); 331 332 target_ulong riscv_cpu_get_fflags(CPURISCVState *env); 333 void riscv_cpu_set_fflags(CPURISCVState *env, target_ulong); 334 335 #define TB_FLAGS_MMU_MASK 3 336 #define TB_FLAGS_MSTATUS_FS MSTATUS_FS 337 338 static inline void cpu_get_tb_cpu_state(CPURISCVState *env, target_ulong *pc, 339 target_ulong *cs_base, uint32_t *flags) 340 { 341 *pc = env->pc; 342 *cs_base = 0; 343 #ifdef CONFIG_USER_ONLY 344 *flags = TB_FLAGS_MSTATUS_FS; 345 #else 346 *flags = cpu_mmu_index(env, 0); 347 if (riscv_cpu_fp_enabled(env)) { 348 *flags |= env->mstatus & MSTATUS_FS; 349 } 350 #endif 351 } 352 353 int riscv_csrrw(CPURISCVState *env, int csrno, target_ulong *ret_value, 354 target_ulong new_value, target_ulong write_mask); 355 int riscv_csrrw_debug(CPURISCVState *env, int csrno, target_ulong *ret_value, 356 target_ulong new_value, target_ulong write_mask); 357 358 static inline void riscv_csr_write(CPURISCVState *env, int csrno, 359 target_ulong val) 360 { 361 riscv_csrrw(env, csrno, NULL, val, MAKE_64BIT_MASK(0, TARGET_LONG_BITS)); 362 } 363 364 static inline target_ulong riscv_csr_read(CPURISCVState *env, int csrno) 365 { 366 target_ulong val = 0; 367 riscv_csrrw(env, csrno, &val, 0, 0); 368 return val; 369 } 370 371 typedef int (*riscv_csr_predicate_fn)(CPURISCVState *env, int csrno); 372 typedef int (*riscv_csr_read_fn)(CPURISCVState *env, int csrno, 373 target_ulong *ret_value); 374 typedef int (*riscv_csr_write_fn)(CPURISCVState *env, int csrno, 375 target_ulong new_value); 376 typedef int (*riscv_csr_op_fn)(CPURISCVState *env, int csrno, 377 target_ulong *ret_value, target_ulong new_value, target_ulong write_mask); 378 379 typedef struct { 380 riscv_csr_predicate_fn predicate; 381 riscv_csr_read_fn read; 382 riscv_csr_write_fn write; 383 riscv_csr_op_fn op; 384 } riscv_csr_operations; 385 386 void riscv_get_csr_ops(int csrno, riscv_csr_operations *ops); 387 void riscv_set_csr_ops(int csrno, riscv_csr_operations *ops); 388 389 void riscv_cpu_register_gdb_regs_for_features(CPUState *cs); 390 391 typedef CPURISCVState CPUArchState; 392 typedef RISCVCPU ArchCPU; 393 394 #include "exec/cpu-all.h" 395 396 #endif /* RISCV_CPU_H */ 397