xref: /openbmc/qemu/target/riscv/cpu.h (revision 427d8e7d)
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 "hw/registerfields.h"
25 #include "exec/cpu-defs.h"
26 #include "qemu/cpu-float.h"
27 #include "qom/object.h"
28 #include "qemu/int128.h"
29 #include "cpu_bits.h"
30 #include "qapi/qapi-types-common.h"
31 
32 #define TCG_GUEST_DEFAULT_MO 0
33 
34 /*
35  * RISC-V-specific extra insn start words:
36  * 1: Original instruction opcode
37  */
38 #define TARGET_INSN_START_EXTRA_WORDS 1
39 
40 #define TYPE_RISCV_CPU "riscv-cpu"
41 
42 #define RISCV_CPU_TYPE_SUFFIX "-" TYPE_RISCV_CPU
43 #define RISCV_CPU_TYPE_NAME(name) (name RISCV_CPU_TYPE_SUFFIX)
44 #define CPU_RESOLVING_TYPE TYPE_RISCV_CPU
45 
46 #define TYPE_RISCV_CPU_ANY              RISCV_CPU_TYPE_NAME("any")
47 #define TYPE_RISCV_CPU_BASE32           RISCV_CPU_TYPE_NAME("rv32")
48 #define TYPE_RISCV_CPU_BASE64           RISCV_CPU_TYPE_NAME("rv64")
49 #define TYPE_RISCV_CPU_BASE128          RISCV_CPU_TYPE_NAME("x-rv128")
50 #define TYPE_RISCV_CPU_IBEX             RISCV_CPU_TYPE_NAME("lowrisc-ibex")
51 #define TYPE_RISCV_CPU_SHAKTI_C         RISCV_CPU_TYPE_NAME("shakti-c")
52 #define TYPE_RISCV_CPU_SIFIVE_E31       RISCV_CPU_TYPE_NAME("sifive-e31")
53 #define TYPE_RISCV_CPU_SIFIVE_E34       RISCV_CPU_TYPE_NAME("sifive-e34")
54 #define TYPE_RISCV_CPU_SIFIVE_E51       RISCV_CPU_TYPE_NAME("sifive-e51")
55 #define TYPE_RISCV_CPU_SIFIVE_U34       RISCV_CPU_TYPE_NAME("sifive-u34")
56 #define TYPE_RISCV_CPU_SIFIVE_U54       RISCV_CPU_TYPE_NAME("sifive-u54")
57 #define TYPE_RISCV_CPU_THEAD_C906       RISCV_CPU_TYPE_NAME("thead-c906")
58 #define TYPE_RISCV_CPU_HOST             RISCV_CPU_TYPE_NAME("host")
59 
60 #if defined(TARGET_RISCV32)
61 # define TYPE_RISCV_CPU_BASE            TYPE_RISCV_CPU_BASE32
62 #elif defined(TARGET_RISCV64)
63 # define TYPE_RISCV_CPU_BASE            TYPE_RISCV_CPU_BASE64
64 #endif
65 
66 #define RV(x) ((target_ulong)1 << (x - 'A'))
67 
68 /*
69  * Consider updating register_cpu_props() when adding
70  * new MISA bits here.
71  */
72 #define RVI RV('I')
73 #define RVE RV('E') /* E and I are mutually exclusive */
74 #define RVM RV('M')
75 #define RVA RV('A')
76 #define RVF RV('F')
77 #define RVD RV('D')
78 #define RVV RV('V')
79 #define RVC RV('C')
80 #define RVS RV('S')
81 #define RVU RV('U')
82 #define RVH RV('H')
83 #define RVJ RV('J')
84 
85 
86 /* Privileged specification version */
87 enum {
88     PRIV_VERSION_1_10_0 = 0,
89     PRIV_VERSION_1_11_0,
90     PRIV_VERSION_1_12_0,
91 };
92 
93 #define VEXT_VERSION_1_00_0 0x00010000
94 
95 enum {
96     TRANSLATE_SUCCESS,
97     TRANSLATE_FAIL,
98     TRANSLATE_PMP_FAIL,
99     TRANSLATE_G_STAGE_FAIL
100 };
101 
102 #define MMU_USER_IDX 3
103 
104 #define MAX_RISCV_PMPS (16)
105 
106 typedef struct CPUArchState CPURISCVState;
107 
108 #if !defined(CONFIG_USER_ONLY)
109 #include "pmp.h"
110 #include "debug.h"
111 #endif
112 
113 #define RV_VLEN_MAX 1024
114 #define RV_MAX_MHPMEVENTS 32
115 #define RV_MAX_MHPMCOUNTERS 32
116 
117 FIELD(VTYPE, VLMUL, 0, 3)
118 FIELD(VTYPE, VSEW, 3, 3)
119 FIELD(VTYPE, VTA, 6, 1)
120 FIELD(VTYPE, VMA, 7, 1)
121 FIELD(VTYPE, VEDIV, 8, 2)
122 FIELD(VTYPE, RESERVED, 10, sizeof(target_ulong) * 8 - 11)
123 
124 typedef struct PMUCTRState {
125     /* Current value of a counter */
126     target_ulong mhpmcounter_val;
127     /* Current value of a counter in RV32 */
128     target_ulong mhpmcounterh_val;
129     /* Snapshot values of counter */
130     target_ulong mhpmcounter_prev;
131     /* Snapshort value of a counter in RV32 */
132     target_ulong mhpmcounterh_prev;
133     bool started;
134     /* Value beyond UINT32_MAX/UINT64_MAX before overflow interrupt trigger */
135     target_ulong irq_overflow_left;
136 } PMUCTRState;
137 
138 struct CPUArchState {
139     target_ulong gpr[32];
140     target_ulong gprh[32]; /* 64 top bits of the 128-bit registers */
141 
142     /* vector coprocessor state. */
143     uint64_t vreg[32 * RV_VLEN_MAX / 64] QEMU_ALIGNED(16);
144     target_ulong vxrm;
145     target_ulong vxsat;
146     target_ulong vl;
147     target_ulong vstart;
148     target_ulong vtype;
149     bool vill;
150 
151     target_ulong pc;
152     target_ulong load_res;
153     target_ulong load_val;
154 
155     /* Floating-Point state */
156     uint64_t fpr[32]; /* assume both F and D extensions */
157     target_ulong frm;
158     float_status fp_status;
159 
160     target_ulong badaddr;
161     target_ulong bins;
162 
163     target_ulong guest_phys_fault_addr;
164 
165     target_ulong priv_ver;
166     target_ulong bext_ver;
167     target_ulong vext_ver;
168 
169     /* RISCVMXL, but uint32_t for vmstate migration */
170     uint32_t misa_mxl;      /* current mxl */
171     uint32_t misa_mxl_max;  /* max mxl for this cpu */
172     uint32_t misa_ext;      /* current extensions */
173     uint32_t misa_ext_mask; /* max ext for this cpu */
174     uint32_t xl;            /* current xlen */
175 
176     /* 128-bit helpers upper part return value */
177     target_ulong retxh;
178 
179     target_ulong jvt;
180 
181 #ifdef CONFIG_USER_ONLY
182     uint32_t elf_flags;
183 #endif
184 
185 #ifndef CONFIG_USER_ONLY
186     target_ulong priv;
187     /* This contains QEMU specific information about the virt state. */
188     bool virt_enabled;
189     target_ulong geilen;
190     uint64_t resetvec;
191 
192     target_ulong mhartid;
193     /*
194      * For RV32 this is 32-bit mstatus and 32-bit mstatush.
195      * For RV64 this is a 64-bit mstatus.
196      */
197     uint64_t mstatus;
198 
199     uint64_t mip;
200     /*
201      * MIP contains the software writable version of SEIP ORed with the
202      * external interrupt value. The MIP register is always up-to-date.
203      * To keep track of the current source, we also save booleans of the values
204      * here.
205      */
206     bool external_seip;
207     bool software_seip;
208 
209     uint64_t miclaim;
210 
211     uint64_t mie;
212     uint64_t mideleg;
213 
214     target_ulong satp;   /* since: priv-1.10.0 */
215     target_ulong stval;
216     target_ulong medeleg;
217 
218     target_ulong stvec;
219     target_ulong sepc;
220     target_ulong scause;
221 
222     target_ulong mtvec;
223     target_ulong mepc;
224     target_ulong mcause;
225     target_ulong mtval;  /* since: priv-1.10.0 */
226 
227     /* Machine and Supervisor interrupt priorities */
228     uint8_t miprio[64];
229     uint8_t siprio[64];
230 
231     /* AIA CSRs */
232     target_ulong miselect;
233     target_ulong siselect;
234 
235     /* Hypervisor CSRs */
236     target_ulong hstatus;
237     target_ulong hedeleg;
238     uint64_t hideleg;
239     target_ulong hcounteren;
240     target_ulong htval;
241     target_ulong htinst;
242     target_ulong hgatp;
243     target_ulong hgeie;
244     target_ulong hgeip;
245     uint64_t htimedelta;
246 
247     /* Hypervisor controlled virtual interrupt priorities */
248     target_ulong hvictl;
249     uint8_t hviprio[64];
250 
251     /* Upper 64-bits of 128-bit CSRs */
252     uint64_t mscratchh;
253     uint64_t sscratchh;
254 
255     /* Virtual CSRs */
256     /*
257      * For RV32 this is 32-bit vsstatus and 32-bit vsstatush.
258      * For RV64 this is a 64-bit vsstatus.
259      */
260     uint64_t vsstatus;
261     target_ulong vstvec;
262     target_ulong vsscratch;
263     target_ulong vsepc;
264     target_ulong vscause;
265     target_ulong vstval;
266     target_ulong vsatp;
267 
268     /* AIA VS-mode CSRs */
269     target_ulong vsiselect;
270 
271     target_ulong mtval2;
272     target_ulong mtinst;
273 
274     /* HS Backup CSRs */
275     target_ulong stvec_hs;
276     target_ulong sscratch_hs;
277     target_ulong sepc_hs;
278     target_ulong scause_hs;
279     target_ulong stval_hs;
280     target_ulong satp_hs;
281     uint64_t mstatus_hs;
282 
283     /*
284      * Signals whether the current exception occurred with two-stage address
285      * translation active.
286      */
287     bool two_stage_lookup;
288     /*
289      * Signals whether the current exception occurred while doing two-stage
290      * address translation for the VS-stage page table walk.
291      */
292     bool two_stage_indirect_lookup;
293 
294     target_ulong scounteren;
295     target_ulong mcounteren;
296 
297     target_ulong mcountinhibit;
298 
299     /* PMU counter state */
300     PMUCTRState pmu_ctrs[RV_MAX_MHPMCOUNTERS];
301 
302     /* PMU event selector configured values. First three are unused */
303     target_ulong mhpmevent_val[RV_MAX_MHPMEVENTS];
304 
305     /* PMU event selector configured values for RV32 */
306     target_ulong mhpmeventh_val[RV_MAX_MHPMEVENTS];
307 
308     target_ulong sscratch;
309     target_ulong mscratch;
310 
311     /* Sstc CSRs */
312     uint64_t stimecmp;
313 
314     uint64_t vstimecmp;
315 
316     /* physical memory protection */
317     pmp_table_t pmp_state;
318     target_ulong mseccfg;
319 
320     /* trigger module */
321     target_ulong trigger_cur;
322     target_ulong tdata1[RV_MAX_TRIGGERS];
323     target_ulong tdata2[RV_MAX_TRIGGERS];
324     target_ulong tdata3[RV_MAX_TRIGGERS];
325     struct CPUBreakpoint *cpu_breakpoint[RV_MAX_TRIGGERS];
326     struct CPUWatchpoint *cpu_watchpoint[RV_MAX_TRIGGERS];
327     QEMUTimer *itrigger_timer[RV_MAX_TRIGGERS];
328     int64_t last_icount;
329     bool itrigger_enabled;
330 
331     /* machine specific rdtime callback */
332     uint64_t (*rdtime_fn)(void *);
333     void *rdtime_fn_arg;
334 
335     /* machine specific AIA ireg read-modify-write callback */
336 #define AIA_MAKE_IREG(__isel, __priv, __virt, __vgein, __xlen) \
337     ((((__xlen) & 0xff) << 24) | \
338      (((__vgein) & 0x3f) << 20) | \
339      (((__virt) & 0x1) << 18) | \
340      (((__priv) & 0x3) << 16) | \
341      (__isel & 0xffff))
342 #define AIA_IREG_ISEL(__ireg)                  ((__ireg) & 0xffff)
343 #define AIA_IREG_PRIV(__ireg)                  (((__ireg) >> 16) & 0x3)
344 #define AIA_IREG_VIRT(__ireg)                  (((__ireg) >> 18) & 0x1)
345 #define AIA_IREG_VGEIN(__ireg)                 (((__ireg) >> 20) & 0x3f)
346 #define AIA_IREG_XLEN(__ireg)                  (((__ireg) >> 24) & 0xff)
347     int (*aia_ireg_rmw_fn[4])(void *arg, target_ulong reg,
348         target_ulong *val, target_ulong new_val, target_ulong write_mask);
349     void *aia_ireg_rmw_fn_arg[4];
350 
351     /* True if in debugger mode.  */
352     bool debugger;
353 
354     /*
355      * CSRs for PointerMasking extension
356      */
357     target_ulong mmte;
358     target_ulong mpmmask;
359     target_ulong mpmbase;
360     target_ulong spmmask;
361     target_ulong spmbase;
362     target_ulong upmmask;
363     target_ulong upmbase;
364 
365     /* CSRs for execution enviornment configuration */
366     uint64_t menvcfg;
367     uint64_t mstateen[SMSTATEEN_MAX_COUNT];
368     uint64_t hstateen[SMSTATEEN_MAX_COUNT];
369     uint64_t sstateen[SMSTATEEN_MAX_COUNT];
370     target_ulong senvcfg;
371     uint64_t henvcfg;
372 #endif
373     target_ulong cur_pmmask;
374     target_ulong cur_pmbase;
375 
376     /* Fields from here on are preserved across CPU reset. */
377     QEMUTimer *stimer; /* Internal timer for S-mode interrupt */
378     QEMUTimer *vstimer; /* Internal timer for VS-mode interrupt */
379     bool vstime_irq;
380 
381     hwaddr kernel_addr;
382     hwaddr fdt_addr;
383 
384     /* kvm timer */
385     bool kvm_timer_dirty;
386     uint64_t kvm_timer_time;
387     uint64_t kvm_timer_compare;
388     uint64_t kvm_timer_state;
389     uint64_t kvm_timer_frequency;
390 };
391 
392 OBJECT_DECLARE_CPU_TYPE(RISCVCPU, RISCVCPUClass, RISCV_CPU)
393 
394 /*
395  * RISCVCPUClass:
396  * @parent_realize: The parent class' realize handler.
397  * @parent_phases: The parent class' reset phase handlers.
398  *
399  * A RISCV CPU model.
400  */
401 struct RISCVCPUClass {
402     /* < private > */
403     CPUClass parent_class;
404     /* < public > */
405     DeviceRealize parent_realize;
406     ResettablePhases parent_phases;
407 };
408 
409 /*
410  * map is a 16-bit bitmap: the most significant set bit in map is the maximum
411  * satp mode that is supported. It may be chosen by the user and must respect
412  * what qemu implements (valid_1_10_32/64) and what the hw is capable of
413  * (supported bitmap below).
414  *
415  * init is a 16-bit bitmap used to make sure the user selected a correct
416  * configuration as per the specification.
417  *
418  * supported is a 16-bit bitmap used to reflect the hw capabilities.
419  */
420 typedef struct {
421     uint16_t map, init, supported;
422 } RISCVSATPMap;
423 
424 struct RISCVCPUConfig {
425     bool ext_g;
426     bool ext_m;
427     bool ext_s;
428     bool ext_u;
429     bool ext_h;
430     bool ext_j;
431     bool ext_v;
432     bool ext_zba;
433     bool ext_zbb;
434     bool ext_zbc;
435     bool ext_zbkb;
436     bool ext_zbkc;
437     bool ext_zbkx;
438     bool ext_zbs;
439     bool ext_zca;
440     bool ext_zcb;
441     bool ext_zcd;
442     bool ext_zce;
443     bool ext_zcf;
444     bool ext_zcmp;
445     bool ext_zcmt;
446     bool ext_zk;
447     bool ext_zkn;
448     bool ext_zknd;
449     bool ext_zkne;
450     bool ext_zknh;
451     bool ext_zkr;
452     bool ext_zks;
453     bool ext_zksed;
454     bool ext_zksh;
455     bool ext_zkt;
456     bool ext_ifencei;
457     bool ext_icsr;
458     bool ext_icbom;
459     bool ext_icboz;
460     bool ext_zicond;
461     bool ext_zihintpause;
462     bool ext_smstateen;
463     bool ext_sstc;
464     bool ext_svadu;
465     bool ext_svinval;
466     bool ext_svnapot;
467     bool ext_svpbmt;
468     bool ext_zdinx;
469     bool ext_zawrs;
470     bool ext_zfh;
471     bool ext_zfhmin;
472     bool ext_zfinx;
473     bool ext_zhinx;
474     bool ext_zhinxmin;
475     bool ext_zve32f;
476     bool ext_zve64f;
477     bool ext_zve64d;
478     bool ext_zmmul;
479     bool ext_zvfh;
480     bool ext_zvfhmin;
481     bool ext_smaia;
482     bool ext_ssaia;
483     bool ext_sscofpmf;
484     bool rvv_ta_all_1s;
485     bool rvv_ma_all_1s;
486 
487     uint32_t mvendorid;
488     uint64_t marchid;
489     uint64_t mimpid;
490 
491     /* Vendor-specific custom extensions */
492     bool ext_xtheadba;
493     bool ext_xtheadbb;
494     bool ext_xtheadbs;
495     bool ext_xtheadcmo;
496     bool ext_xtheadcondmov;
497     bool ext_xtheadfmemidx;
498     bool ext_xtheadfmv;
499     bool ext_xtheadmac;
500     bool ext_xtheadmemidx;
501     bool ext_xtheadmempair;
502     bool ext_xtheadsync;
503     bool ext_XVentanaCondOps;
504 
505     uint8_t pmu_num;
506     char *priv_spec;
507     char *user_spec;
508     char *bext_spec;
509     char *vext_spec;
510     uint16_t vlen;
511     uint16_t elen;
512     uint16_t cbom_blocksize;
513     uint16_t cboz_blocksize;
514     bool mmu;
515     bool pmp;
516     bool epmp;
517     bool debug;
518     bool misa_w;
519 
520     bool short_isa_string;
521 
522 #ifndef CONFIG_USER_ONLY
523     RISCVSATPMap satp_mode;
524 #endif
525 };
526 
527 typedef struct RISCVCPUConfig RISCVCPUConfig;
528 
529 /*
530  * RISCVCPU:
531  * @env: #CPURISCVState
532  *
533  * A RISCV CPU.
534  */
535 struct ArchCPU {
536     /* < private > */
537     CPUState parent_obj;
538     /* < public > */
539     CPUNegativeOffsetState neg;
540     CPURISCVState env;
541 
542     char *dyn_csr_xml;
543     char *dyn_vreg_xml;
544 
545     /* Configuration Settings */
546     RISCVCPUConfig cfg;
547 
548     QEMUTimer *pmu_timer;
549     /* A bitmask of Available programmable counters */
550     uint32_t pmu_avail_ctrs;
551     /* Mapping of events to counters */
552     GHashTable *pmu_event_ctr_map;
553 };
554 
555 static inline int riscv_has_ext(CPURISCVState *env, target_ulong ext)
556 {
557     return (env->misa_ext & ext) != 0;
558 }
559 
560 #include "cpu_user.h"
561 
562 extern const char * const riscv_int_regnames[];
563 extern const char * const riscv_int_regnamesh[];
564 extern const char * const riscv_fpr_regnames[];
565 
566 const char *riscv_cpu_get_trap_name(target_ulong cause, bool async);
567 void riscv_cpu_do_interrupt(CPUState *cpu);
568 int riscv_cpu_write_elf64_note(WriteCoreDumpFunction f, CPUState *cs,
569                                int cpuid, DumpState *s);
570 int riscv_cpu_write_elf32_note(WriteCoreDumpFunction f, CPUState *cs,
571                                int cpuid, DumpState *s);
572 int riscv_cpu_gdb_read_register(CPUState *cpu, GByteArray *buf, int reg);
573 int riscv_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg);
574 int riscv_cpu_hviprio_index2irq(int index, int *out_irq, int *out_rdzero);
575 uint8_t riscv_cpu_default_priority(int irq);
576 uint64_t riscv_cpu_all_pending(CPURISCVState *env);
577 int riscv_cpu_mirq_pending(CPURISCVState *env);
578 int riscv_cpu_sirq_pending(CPURISCVState *env);
579 int riscv_cpu_vsirq_pending(CPURISCVState *env);
580 bool riscv_cpu_fp_enabled(CPURISCVState *env);
581 target_ulong riscv_cpu_get_geilen(CPURISCVState *env);
582 void riscv_cpu_set_geilen(CPURISCVState *env, target_ulong geilen);
583 bool riscv_cpu_vector_enabled(CPURISCVState *env);
584 void riscv_cpu_set_virt_enabled(CPURISCVState *env, bool enable);
585 bool riscv_cpu_two_stage_lookup(int mmu_idx);
586 int riscv_cpu_mmu_index(CPURISCVState *env, bool ifetch);
587 G_NORETURN void  riscv_cpu_do_unaligned_access(CPUState *cs, vaddr addr,
588                                                MMUAccessType access_type,
589                                                int mmu_idx, uintptr_t retaddr);
590 bool riscv_cpu_tlb_fill(CPUState *cs, vaddr address, int size,
591                         MMUAccessType access_type, int mmu_idx,
592                         bool probe, uintptr_t retaddr);
593 char *riscv_isa_string(RISCVCPU *cpu);
594 void riscv_cpu_list(void);
595 
596 #define cpu_list riscv_cpu_list
597 #define cpu_mmu_index riscv_cpu_mmu_index
598 
599 #ifndef CONFIG_USER_ONLY
600 void riscv_cpu_do_transaction_failed(CPUState *cs, hwaddr physaddr,
601                                      vaddr addr, unsigned size,
602                                      MMUAccessType access_type,
603                                      int mmu_idx, MemTxAttrs attrs,
604                                      MemTxResult response, uintptr_t retaddr);
605 hwaddr riscv_cpu_get_phys_page_debug(CPUState *cpu, vaddr addr);
606 bool riscv_cpu_exec_interrupt(CPUState *cs, int interrupt_request);
607 void riscv_cpu_swap_hypervisor_regs(CPURISCVState *env);
608 int riscv_cpu_claim_interrupts(RISCVCPU *cpu, uint64_t interrupts);
609 uint64_t riscv_cpu_update_mip(CPURISCVState *env, uint64_t mask,
610                               uint64_t value);
611 #define BOOL_TO_MASK(x) (-!!(x)) /* helper for riscv_cpu_update_mip value */
612 void riscv_cpu_set_rdtime_fn(CPURISCVState *env, uint64_t (*fn)(void *),
613                              void *arg);
614 void riscv_cpu_set_aia_ireg_rmw_fn(CPURISCVState *env, uint32_t priv,
615                                    int (*rmw_fn)(void *arg,
616                                                  target_ulong reg,
617                                                  target_ulong *val,
618                                                  target_ulong new_val,
619                                                  target_ulong write_mask),
620                                    void *rmw_fn_arg);
621 
622 RISCVException smstateen_acc_ok(CPURISCVState *env, int index, uint64_t bit);
623 #endif
624 void riscv_cpu_set_mode(CPURISCVState *env, target_ulong newpriv);
625 
626 void riscv_translate_init(void);
627 G_NORETURN void riscv_raise_exception(CPURISCVState *env,
628                                       uint32_t exception, uintptr_t pc);
629 
630 target_ulong riscv_cpu_get_fflags(CPURISCVState *env);
631 void riscv_cpu_set_fflags(CPURISCVState *env, target_ulong);
632 
633 #define TB_FLAGS_PRIV_MMU_MASK                3
634 #define TB_FLAGS_PRIV_HYP_ACCESS_MASK   (1 << 2)
635 #define TB_FLAGS_MSTATUS_FS MSTATUS_FS
636 #define TB_FLAGS_MSTATUS_VS MSTATUS_VS
637 
638 #include "exec/cpu-all.h"
639 
640 FIELD(TB_FLAGS, MEM_IDX, 0, 3)
641 FIELD(TB_FLAGS, LMUL, 3, 3)
642 FIELD(TB_FLAGS, SEW, 6, 3)
643 /* Skip MSTATUS_VS (0x600) bits */
644 FIELD(TB_FLAGS, VL_EQ_VLMAX, 11, 1)
645 FIELD(TB_FLAGS, VILL, 12, 1)
646 /* Skip MSTATUS_FS (0x6000) bits */
647 /* Is a Hypervisor instruction load/store allowed? */
648 FIELD(TB_FLAGS, HLSX, 15, 1)
649 FIELD(TB_FLAGS, MSTATUS_HS_FS, 16, 2)
650 FIELD(TB_FLAGS, MSTATUS_HS_VS, 18, 2)
651 /* The combination of MXL/SXL/UXL that applies to the current cpu mode. */
652 FIELD(TB_FLAGS, XL, 20, 2)
653 /* If PointerMasking should be applied */
654 FIELD(TB_FLAGS, PM_MASK_ENABLED, 22, 1)
655 FIELD(TB_FLAGS, PM_BASE_ENABLED, 23, 1)
656 FIELD(TB_FLAGS, VTA, 24, 1)
657 FIELD(TB_FLAGS, VMA, 25, 1)
658 /* Native debug itrigger */
659 FIELD(TB_FLAGS, ITRIGGER, 26, 1)
660 
661 #ifdef TARGET_RISCV32
662 #define riscv_cpu_mxl(env)  ((void)(env), MXL_RV32)
663 #else
664 static inline RISCVMXL riscv_cpu_mxl(CPURISCVState *env)
665 {
666     return env->misa_mxl;
667 }
668 #endif
669 #define riscv_cpu_mxl_bits(env) (1UL << (4 + riscv_cpu_mxl(env)))
670 
671 static inline const RISCVCPUConfig *riscv_cpu_cfg(CPURISCVState *env)
672 {
673     return &env_archcpu(env)->cfg;
674 }
675 
676 #if defined(TARGET_RISCV32)
677 #define cpu_recompute_xl(env)  ((void)(env), MXL_RV32)
678 #else
679 static inline RISCVMXL cpu_recompute_xl(CPURISCVState *env)
680 {
681     RISCVMXL xl = env->misa_mxl;
682 #if !defined(CONFIG_USER_ONLY)
683     /*
684      * When emulating a 32-bit-only cpu, use RV32.
685      * When emulating a 64-bit cpu, and MXL has been reduced to RV32,
686      * MSTATUSH doesn't have UXL/SXL, therefore XLEN cannot be widened
687      * back to RV64 for lower privs.
688      */
689     if (xl != MXL_RV32) {
690         switch (env->priv) {
691         case PRV_M:
692             break;
693         case PRV_U:
694             xl = get_field(env->mstatus, MSTATUS64_UXL);
695             break;
696         default: /* PRV_S | PRV_H */
697             xl = get_field(env->mstatus, MSTATUS64_SXL);
698             break;
699         }
700     }
701 #endif
702     return xl;
703 }
704 #endif
705 
706 static inline int riscv_cpu_xlen(CPURISCVState *env)
707 {
708     return 16 << env->xl;
709 }
710 
711 #ifdef TARGET_RISCV32
712 #define riscv_cpu_sxl(env)  ((void)(env), MXL_RV32)
713 #else
714 static inline RISCVMXL riscv_cpu_sxl(CPURISCVState *env)
715 {
716 #ifdef CONFIG_USER_ONLY
717     return env->misa_mxl;
718 #else
719     return get_field(env->mstatus, MSTATUS64_SXL);
720 #endif
721 }
722 #endif
723 
724 /*
725  * Encode LMUL to lmul as follows:
726  *     LMUL    vlmul    lmul
727  *      1       000       0
728  *      2       001       1
729  *      4       010       2
730  *      8       011       3
731  *      -       100       -
732  *     1/8      101      -3
733  *     1/4      110      -2
734  *     1/2      111      -1
735  *
736  * then, we can calculate VLMAX = vlen >> (vsew + 3 - lmul)
737  * e.g. vlen = 256 bits, SEW = 16, LMUL = 1/8
738  *      => VLMAX = vlen >> (1 + 3 - (-3))
739  *               = 256 >> 7
740  *               = 2
741  */
742 static inline uint32_t vext_get_vlmax(RISCVCPU *cpu, target_ulong vtype)
743 {
744     uint8_t sew = FIELD_EX64(vtype, VTYPE, VSEW);
745     int8_t lmul = sextract32(FIELD_EX64(vtype, VTYPE, VLMUL), 0, 3);
746     return cpu->cfg.vlen >> (sew + 3 - lmul);
747 }
748 
749 void cpu_get_tb_cpu_state(CPURISCVState *env, target_ulong *pc,
750                           target_ulong *cs_base, uint32_t *pflags);
751 
752 void riscv_cpu_update_mask(CPURISCVState *env);
753 
754 RISCVException riscv_csrrw(CPURISCVState *env, int csrno,
755                            target_ulong *ret_value,
756                            target_ulong new_value, target_ulong write_mask);
757 RISCVException riscv_csrrw_debug(CPURISCVState *env, int csrno,
758                                  target_ulong *ret_value,
759                                  target_ulong new_value,
760                                  target_ulong write_mask);
761 
762 static inline void riscv_csr_write(CPURISCVState *env, int csrno,
763                                    target_ulong val)
764 {
765     riscv_csrrw(env, csrno, NULL, val, MAKE_64BIT_MASK(0, TARGET_LONG_BITS));
766 }
767 
768 static inline target_ulong riscv_csr_read(CPURISCVState *env, int csrno)
769 {
770     target_ulong val = 0;
771     riscv_csrrw(env, csrno, &val, 0, 0);
772     return val;
773 }
774 
775 typedef RISCVException (*riscv_csr_predicate_fn)(CPURISCVState *env,
776                                                  int csrno);
777 typedef RISCVException (*riscv_csr_read_fn)(CPURISCVState *env, int csrno,
778                                             target_ulong *ret_value);
779 typedef RISCVException (*riscv_csr_write_fn)(CPURISCVState *env, int csrno,
780                                              target_ulong new_value);
781 typedef RISCVException (*riscv_csr_op_fn)(CPURISCVState *env, int csrno,
782                                           target_ulong *ret_value,
783                                           target_ulong new_value,
784                                           target_ulong write_mask);
785 
786 RISCVException riscv_csrrw_i128(CPURISCVState *env, int csrno,
787                                 Int128 *ret_value,
788                                 Int128 new_value, Int128 write_mask);
789 
790 typedef RISCVException (*riscv_csr_read128_fn)(CPURISCVState *env, int csrno,
791                                                Int128 *ret_value);
792 typedef RISCVException (*riscv_csr_write128_fn)(CPURISCVState *env, int csrno,
793                                              Int128 new_value);
794 
795 typedef struct {
796     const char *name;
797     riscv_csr_predicate_fn predicate;
798     riscv_csr_read_fn read;
799     riscv_csr_write_fn write;
800     riscv_csr_op_fn op;
801     riscv_csr_read128_fn read128;
802     riscv_csr_write128_fn write128;
803     /* The default priv spec version should be PRIV_VERSION_1_10_0 (i.e 0) */
804     uint32_t min_priv_ver;
805 } riscv_csr_operations;
806 
807 /* CSR function table constants */
808 enum {
809     CSR_TABLE_SIZE = 0x1000
810 };
811 
812 /*
813  * The event id are encoded based on the encoding specified in the
814  * SBI specification v0.3
815  */
816 
817 enum riscv_pmu_event_idx {
818     RISCV_PMU_EVENT_HW_CPU_CYCLES = 0x01,
819     RISCV_PMU_EVENT_HW_INSTRUCTIONS = 0x02,
820     RISCV_PMU_EVENT_CACHE_DTLB_READ_MISS = 0x10019,
821     RISCV_PMU_EVENT_CACHE_DTLB_WRITE_MISS = 0x1001B,
822     RISCV_PMU_EVENT_CACHE_ITLB_PREFETCH_MISS = 0x10021,
823 };
824 
825 /* CSR function table */
826 extern riscv_csr_operations csr_ops[CSR_TABLE_SIZE];
827 
828 extern const bool valid_vm_1_10_32[], valid_vm_1_10_64[];
829 
830 void riscv_get_csr_ops(int csrno, riscv_csr_operations *ops);
831 void riscv_set_csr_ops(int csrno, riscv_csr_operations *ops);
832 
833 void riscv_cpu_register_gdb_regs_for_features(CPUState *cs);
834 
835 uint8_t satp_mode_max_from_map(uint32_t map);
836 const char *satp_mode_str(uint8_t satp_mode, bool is_32_bit);
837 
838 #endif /* RISCV_CPU_H */
839