xref: /openbmc/qemu/target/riscv/cpu_bits.h (revision e4082063)
1 /* RISC-V ISA constants */
2 
3 #ifndef TARGET_RISCV_CPU_BITS_H
4 #define TARGET_RISCV_CPU_BITS_H
5 
6 #define get_field(reg, mask) (((reg) & \
7                  (uint64_t)(mask)) / ((mask) & ~((mask) << 1)))
8 #define set_field(reg, mask, val) (((reg) & ~(uint64_t)(mask)) | \
9                  (((uint64_t)(val) * ((mask) & ~((mask) << 1))) & \
10                  (uint64_t)(mask)))
11 
12 /* Floating point round mode */
13 #define FSR_RD_SHIFT        5
14 #define FSR_RD              (0x7 << FSR_RD_SHIFT)
15 
16 /* Floating point accrued exception flags */
17 #define FPEXC_NX            0x01
18 #define FPEXC_UF            0x02
19 #define FPEXC_OF            0x04
20 #define FPEXC_DZ            0x08
21 #define FPEXC_NV            0x10
22 
23 /* Floating point status register bits */
24 #define FSR_AEXC_SHIFT      0
25 #define FSR_NVA             (FPEXC_NV << FSR_AEXC_SHIFT)
26 #define FSR_OFA             (FPEXC_OF << FSR_AEXC_SHIFT)
27 #define FSR_UFA             (FPEXC_UF << FSR_AEXC_SHIFT)
28 #define FSR_DZA             (FPEXC_DZ << FSR_AEXC_SHIFT)
29 #define FSR_NXA             (FPEXC_NX << FSR_AEXC_SHIFT)
30 #define FSR_AEXC            (FSR_NVA | FSR_OFA | FSR_UFA | FSR_DZA | FSR_NXA)
31 
32 /* Vector Fixed-Point round model */
33 #define FSR_VXRM_SHIFT      9
34 #define FSR_VXRM            (0x3 << FSR_VXRM_SHIFT)
35 
36 /* Vector Fixed-Point saturation flag */
37 #define FSR_VXSAT_SHIFT     8
38 #define FSR_VXSAT           (0x1 << FSR_VXSAT_SHIFT)
39 
40 /* Control and Status Registers */
41 
42 /* User Trap Setup */
43 #define CSR_USTATUS         0x000
44 #define CSR_UIE             0x004
45 #define CSR_UTVEC           0x005
46 
47 /* User Trap Handling */
48 #define CSR_USCRATCH        0x040
49 #define CSR_UEPC            0x041
50 #define CSR_UCAUSE          0x042
51 #define CSR_UTVAL           0x043
52 #define CSR_UIP             0x044
53 
54 /* User Floating-Point CSRs */
55 #define CSR_FFLAGS          0x001
56 #define CSR_FRM             0x002
57 #define CSR_FCSR            0x003
58 
59 /* User Vector CSRs */
60 #define CSR_VSTART          0x008
61 #define CSR_VXSAT           0x009
62 #define CSR_VXRM            0x00a
63 #define CSR_VCSR            0x00f
64 #define CSR_VL              0xc20
65 #define CSR_VTYPE           0xc21
66 #define CSR_VLENB           0xc22
67 
68 /* VCSR fields */
69 #define VCSR_VXSAT_SHIFT    0
70 #define VCSR_VXSAT          (0x1 << VCSR_VXSAT_SHIFT)
71 #define VCSR_VXRM_SHIFT     1
72 #define VCSR_VXRM           (0x3 << VCSR_VXRM_SHIFT)
73 
74 /* User Timers and Counters */
75 #define CSR_CYCLE           0xc00
76 #define CSR_TIME            0xc01
77 #define CSR_INSTRET         0xc02
78 #define CSR_HPMCOUNTER3     0xc03
79 #define CSR_HPMCOUNTER4     0xc04
80 #define CSR_HPMCOUNTER5     0xc05
81 #define CSR_HPMCOUNTER6     0xc06
82 #define CSR_HPMCOUNTER7     0xc07
83 #define CSR_HPMCOUNTER8     0xc08
84 #define CSR_HPMCOUNTER9     0xc09
85 #define CSR_HPMCOUNTER10    0xc0a
86 #define CSR_HPMCOUNTER11    0xc0b
87 #define CSR_HPMCOUNTER12    0xc0c
88 #define CSR_HPMCOUNTER13    0xc0d
89 #define CSR_HPMCOUNTER14    0xc0e
90 #define CSR_HPMCOUNTER15    0xc0f
91 #define CSR_HPMCOUNTER16    0xc10
92 #define CSR_HPMCOUNTER17    0xc11
93 #define CSR_HPMCOUNTER18    0xc12
94 #define CSR_HPMCOUNTER19    0xc13
95 #define CSR_HPMCOUNTER20    0xc14
96 #define CSR_HPMCOUNTER21    0xc15
97 #define CSR_HPMCOUNTER22    0xc16
98 #define CSR_HPMCOUNTER23    0xc17
99 #define CSR_HPMCOUNTER24    0xc18
100 #define CSR_HPMCOUNTER25    0xc19
101 #define CSR_HPMCOUNTER26    0xc1a
102 #define CSR_HPMCOUNTER27    0xc1b
103 #define CSR_HPMCOUNTER28    0xc1c
104 #define CSR_HPMCOUNTER29    0xc1d
105 #define CSR_HPMCOUNTER30    0xc1e
106 #define CSR_HPMCOUNTER31    0xc1f
107 #define CSR_CYCLEH          0xc80
108 #define CSR_TIMEH           0xc81
109 #define CSR_INSTRETH        0xc82
110 #define CSR_HPMCOUNTER3H    0xc83
111 #define CSR_HPMCOUNTER4H    0xc84
112 #define CSR_HPMCOUNTER5H    0xc85
113 #define CSR_HPMCOUNTER6H    0xc86
114 #define CSR_HPMCOUNTER7H    0xc87
115 #define CSR_HPMCOUNTER8H    0xc88
116 #define CSR_HPMCOUNTER9H    0xc89
117 #define CSR_HPMCOUNTER10H   0xc8a
118 #define CSR_HPMCOUNTER11H   0xc8b
119 #define CSR_HPMCOUNTER12H   0xc8c
120 #define CSR_HPMCOUNTER13H   0xc8d
121 #define CSR_HPMCOUNTER14H   0xc8e
122 #define CSR_HPMCOUNTER15H   0xc8f
123 #define CSR_HPMCOUNTER16H   0xc90
124 #define CSR_HPMCOUNTER17H   0xc91
125 #define CSR_HPMCOUNTER18H   0xc92
126 #define CSR_HPMCOUNTER19H   0xc93
127 #define CSR_HPMCOUNTER20H   0xc94
128 #define CSR_HPMCOUNTER21H   0xc95
129 #define CSR_HPMCOUNTER22H   0xc96
130 #define CSR_HPMCOUNTER23H   0xc97
131 #define CSR_HPMCOUNTER24H   0xc98
132 #define CSR_HPMCOUNTER25H   0xc99
133 #define CSR_HPMCOUNTER26H   0xc9a
134 #define CSR_HPMCOUNTER27H   0xc9b
135 #define CSR_HPMCOUNTER28H   0xc9c
136 #define CSR_HPMCOUNTER29H   0xc9d
137 #define CSR_HPMCOUNTER30H   0xc9e
138 #define CSR_HPMCOUNTER31H   0xc9f
139 
140 /* Machine Timers and Counters */
141 #define CSR_MCYCLE          0xb00
142 #define CSR_MINSTRET        0xb02
143 #define CSR_MCYCLEH         0xb80
144 #define CSR_MINSTRETH       0xb82
145 
146 /* Machine Information Registers */
147 #define CSR_MVENDORID       0xf11
148 #define CSR_MARCHID         0xf12
149 #define CSR_MIMPID          0xf13
150 #define CSR_MHARTID         0xf14
151 #define CSR_MCONFIGPTR      0xf15
152 
153 /* Machine Trap Setup */
154 #define CSR_MSTATUS         0x300
155 #define CSR_MISA            0x301
156 #define CSR_MEDELEG         0x302
157 #define CSR_MIDELEG         0x303
158 #define CSR_MIE             0x304
159 #define CSR_MTVEC           0x305
160 #define CSR_MCOUNTEREN      0x306
161 
162 /* 32-bit only */
163 #define CSR_MSTATUSH        0x310
164 
165 /* Machine Trap Handling */
166 #define CSR_MSCRATCH        0x340
167 #define CSR_MEPC            0x341
168 #define CSR_MCAUSE          0x342
169 #define CSR_MTVAL           0x343
170 #define CSR_MIP             0x344
171 
172 /* Machine-Level Window to Indirectly Accessed Registers (AIA) */
173 #define CSR_MISELECT        0x350
174 #define CSR_MIREG           0x351
175 
176 /* Machine-Level Interrupts (AIA) */
177 #define CSR_MTOPI           0xfb0
178 
179 /* Machine-Level IMSIC Interface (AIA) */
180 #define CSR_MSETEIPNUM      0x358
181 #define CSR_MCLREIPNUM      0x359
182 #define CSR_MSETEIENUM      0x35a
183 #define CSR_MCLREIENUM      0x35b
184 #define CSR_MTOPEI          0x35c
185 
186 /* Virtual Interrupts for Supervisor Level (AIA) */
187 #define CSR_MVIEN           0x308
188 #define CSR_MVIP            0x309
189 
190 /* Machine-Level High-Half CSRs (AIA) */
191 #define CSR_MIDELEGH        0x313
192 #define CSR_MIEH            0x314
193 #define CSR_MVIENH          0x318
194 #define CSR_MVIPH           0x319
195 #define CSR_MIPH            0x354
196 
197 /* Supervisor Trap Setup */
198 #define CSR_SSTATUS         0x100
199 #define CSR_SEDELEG         0x102
200 #define CSR_SIDELEG         0x103
201 #define CSR_SIE             0x104
202 #define CSR_STVEC           0x105
203 #define CSR_SCOUNTEREN      0x106
204 
205 /* Supervisor Configuration CSRs */
206 #define CSR_SENVCFG         0x10A
207 
208 /* Supervisor Trap Handling */
209 #define CSR_SSCRATCH        0x140
210 #define CSR_SEPC            0x141
211 #define CSR_SCAUSE          0x142
212 #define CSR_STVAL           0x143
213 #define CSR_SIP             0x144
214 
215 /* Supervisor Protection and Translation */
216 #define CSR_SPTBR           0x180
217 #define CSR_SATP            0x180
218 
219 /* Supervisor-Level Window to Indirectly Accessed Registers (AIA) */
220 #define CSR_SISELECT        0x150
221 #define CSR_SIREG           0x151
222 
223 /* Supervisor-Level Interrupts (AIA) */
224 #define CSR_STOPI           0xdb0
225 
226 /* Supervisor-Level IMSIC Interface (AIA) */
227 #define CSR_SSETEIPNUM      0x158
228 #define CSR_SCLREIPNUM      0x159
229 #define CSR_SSETEIENUM      0x15a
230 #define CSR_SCLREIENUM      0x15b
231 #define CSR_STOPEI          0x15c
232 
233 /* Supervisor-Level High-Half CSRs (AIA) */
234 #define CSR_SIEH            0x114
235 #define CSR_SIPH            0x154
236 
237 /* Hpervisor CSRs */
238 #define CSR_HSTATUS         0x600
239 #define CSR_HEDELEG         0x602
240 #define CSR_HIDELEG         0x603
241 #define CSR_HIE             0x604
242 #define CSR_HCOUNTEREN      0x606
243 #define CSR_HGEIE           0x607
244 #define CSR_HTVAL           0x643
245 #define CSR_HVIP            0x645
246 #define CSR_HIP             0x644
247 #define CSR_HTINST          0x64A
248 #define CSR_HGEIP           0xE12
249 #define CSR_HGATP           0x680
250 #define CSR_HTIMEDELTA      0x605
251 #define CSR_HTIMEDELTAH     0x615
252 
253 /* Hypervisor Configuration CSRs */
254 #define CSR_HENVCFG         0x60A
255 #define CSR_HENVCFGH        0x61A
256 
257 /* Virtual CSRs */
258 #define CSR_VSSTATUS        0x200
259 #define CSR_VSIE            0x204
260 #define CSR_VSTVEC          0x205
261 #define CSR_VSSCRATCH       0x240
262 #define CSR_VSEPC           0x241
263 #define CSR_VSCAUSE         0x242
264 #define CSR_VSTVAL          0x243
265 #define CSR_VSIP            0x244
266 #define CSR_VSATP           0x280
267 
268 #define CSR_MTINST          0x34a
269 #define CSR_MTVAL2          0x34b
270 
271 /* Virtual Interrupts and Interrupt Priorities (H-extension with AIA) */
272 #define CSR_HVIEN           0x608
273 #define CSR_HVICTL          0x609
274 #define CSR_HVIPRIO1        0x646
275 #define CSR_HVIPRIO2        0x647
276 
277 /* VS-Level Window to Indirectly Accessed Registers (H-extension with AIA) */
278 #define CSR_VSISELECT       0x250
279 #define CSR_VSIREG          0x251
280 
281 /* VS-Level Interrupts (H-extension with AIA) */
282 #define CSR_VSTOPI          0xeb0
283 
284 /* VS-Level IMSIC Interface (H-extension with AIA) */
285 #define CSR_VSSETEIPNUM     0x258
286 #define CSR_VSCLREIPNUM     0x259
287 #define CSR_VSSETEIENUM     0x25a
288 #define CSR_VSCLREIENUM     0x25b
289 #define CSR_VSTOPEI         0x25c
290 
291 /* Hypervisor and VS-Level High-Half CSRs (H-extension with AIA) */
292 #define CSR_HIDELEGH        0x613
293 #define CSR_HVIENH          0x618
294 #define CSR_HVIPH           0x655
295 #define CSR_HVIPRIO1H       0x656
296 #define CSR_HVIPRIO2H       0x657
297 #define CSR_VSIEH           0x214
298 #define CSR_VSIPH           0x254
299 
300 /* Machine Configuration CSRs */
301 #define CSR_MENVCFG         0x30A
302 #define CSR_MENVCFGH        0x31A
303 
304 /* Enhanced Physical Memory Protection (ePMP) */
305 #define CSR_MSECCFG         0x747
306 #define CSR_MSECCFGH        0x757
307 /* Physical Memory Protection */
308 #define CSR_PMPCFG0         0x3a0
309 #define CSR_PMPCFG1         0x3a1
310 #define CSR_PMPCFG2         0x3a2
311 #define CSR_PMPCFG3         0x3a3
312 #define CSR_PMPADDR0        0x3b0
313 #define CSR_PMPADDR1        0x3b1
314 #define CSR_PMPADDR2        0x3b2
315 #define CSR_PMPADDR3        0x3b3
316 #define CSR_PMPADDR4        0x3b4
317 #define CSR_PMPADDR5        0x3b5
318 #define CSR_PMPADDR6        0x3b6
319 #define CSR_PMPADDR7        0x3b7
320 #define CSR_PMPADDR8        0x3b8
321 #define CSR_PMPADDR9        0x3b9
322 #define CSR_PMPADDR10       0x3ba
323 #define CSR_PMPADDR11       0x3bb
324 #define CSR_PMPADDR12       0x3bc
325 #define CSR_PMPADDR13       0x3bd
326 #define CSR_PMPADDR14       0x3be
327 #define CSR_PMPADDR15       0x3bf
328 
329 /* Debug/Trace Registers (shared with Debug Mode) */
330 #define CSR_TSELECT         0x7a0
331 #define CSR_TDATA1          0x7a1
332 #define CSR_TDATA2          0x7a2
333 #define CSR_TDATA3          0x7a3
334 
335 /* Debug Mode Registers */
336 #define CSR_DCSR            0x7b0
337 #define CSR_DPC             0x7b1
338 #define CSR_DSCRATCH        0x7b2
339 
340 /* Performance Counters */
341 #define CSR_MHPMCOUNTER3    0xb03
342 #define CSR_MHPMCOUNTER4    0xb04
343 #define CSR_MHPMCOUNTER5    0xb05
344 #define CSR_MHPMCOUNTER6    0xb06
345 #define CSR_MHPMCOUNTER7    0xb07
346 #define CSR_MHPMCOUNTER8    0xb08
347 #define CSR_MHPMCOUNTER9    0xb09
348 #define CSR_MHPMCOUNTER10   0xb0a
349 #define CSR_MHPMCOUNTER11   0xb0b
350 #define CSR_MHPMCOUNTER12   0xb0c
351 #define CSR_MHPMCOUNTER13   0xb0d
352 #define CSR_MHPMCOUNTER14   0xb0e
353 #define CSR_MHPMCOUNTER15   0xb0f
354 #define CSR_MHPMCOUNTER16   0xb10
355 #define CSR_MHPMCOUNTER17   0xb11
356 #define CSR_MHPMCOUNTER18   0xb12
357 #define CSR_MHPMCOUNTER19   0xb13
358 #define CSR_MHPMCOUNTER20   0xb14
359 #define CSR_MHPMCOUNTER21   0xb15
360 #define CSR_MHPMCOUNTER22   0xb16
361 #define CSR_MHPMCOUNTER23   0xb17
362 #define CSR_MHPMCOUNTER24   0xb18
363 #define CSR_MHPMCOUNTER25   0xb19
364 #define CSR_MHPMCOUNTER26   0xb1a
365 #define CSR_MHPMCOUNTER27   0xb1b
366 #define CSR_MHPMCOUNTER28   0xb1c
367 #define CSR_MHPMCOUNTER29   0xb1d
368 #define CSR_MHPMCOUNTER30   0xb1e
369 #define CSR_MHPMCOUNTER31   0xb1f
370 #define CSR_MHPMEVENT3      0x323
371 #define CSR_MHPMEVENT4      0x324
372 #define CSR_MHPMEVENT5      0x325
373 #define CSR_MHPMEVENT6      0x326
374 #define CSR_MHPMEVENT7      0x327
375 #define CSR_MHPMEVENT8      0x328
376 #define CSR_MHPMEVENT9      0x329
377 #define CSR_MHPMEVENT10     0x32a
378 #define CSR_MHPMEVENT11     0x32b
379 #define CSR_MHPMEVENT12     0x32c
380 #define CSR_MHPMEVENT13     0x32d
381 #define CSR_MHPMEVENT14     0x32e
382 #define CSR_MHPMEVENT15     0x32f
383 #define CSR_MHPMEVENT16     0x330
384 #define CSR_MHPMEVENT17     0x331
385 #define CSR_MHPMEVENT18     0x332
386 #define CSR_MHPMEVENT19     0x333
387 #define CSR_MHPMEVENT20     0x334
388 #define CSR_MHPMEVENT21     0x335
389 #define CSR_MHPMEVENT22     0x336
390 #define CSR_MHPMEVENT23     0x337
391 #define CSR_MHPMEVENT24     0x338
392 #define CSR_MHPMEVENT25     0x339
393 #define CSR_MHPMEVENT26     0x33a
394 #define CSR_MHPMEVENT27     0x33b
395 #define CSR_MHPMEVENT28     0x33c
396 #define CSR_MHPMEVENT29     0x33d
397 #define CSR_MHPMEVENT30     0x33e
398 #define CSR_MHPMEVENT31     0x33f
399 #define CSR_MHPMCOUNTER3H   0xb83
400 #define CSR_MHPMCOUNTER4H   0xb84
401 #define CSR_MHPMCOUNTER5H   0xb85
402 #define CSR_MHPMCOUNTER6H   0xb86
403 #define CSR_MHPMCOUNTER7H   0xb87
404 #define CSR_MHPMCOUNTER8H   0xb88
405 #define CSR_MHPMCOUNTER9H   0xb89
406 #define CSR_MHPMCOUNTER10H  0xb8a
407 #define CSR_MHPMCOUNTER11H  0xb8b
408 #define CSR_MHPMCOUNTER12H  0xb8c
409 #define CSR_MHPMCOUNTER13H  0xb8d
410 #define CSR_MHPMCOUNTER14H  0xb8e
411 #define CSR_MHPMCOUNTER15H  0xb8f
412 #define CSR_MHPMCOUNTER16H  0xb90
413 #define CSR_MHPMCOUNTER17H  0xb91
414 #define CSR_MHPMCOUNTER18H  0xb92
415 #define CSR_MHPMCOUNTER19H  0xb93
416 #define CSR_MHPMCOUNTER20H  0xb94
417 #define CSR_MHPMCOUNTER21H  0xb95
418 #define CSR_MHPMCOUNTER22H  0xb96
419 #define CSR_MHPMCOUNTER23H  0xb97
420 #define CSR_MHPMCOUNTER24H  0xb98
421 #define CSR_MHPMCOUNTER25H  0xb99
422 #define CSR_MHPMCOUNTER26H  0xb9a
423 #define CSR_MHPMCOUNTER27H  0xb9b
424 #define CSR_MHPMCOUNTER28H  0xb9c
425 #define CSR_MHPMCOUNTER29H  0xb9d
426 #define CSR_MHPMCOUNTER30H  0xb9e
427 #define CSR_MHPMCOUNTER31H  0xb9f
428 
429 /*
430  * User PointerMasking registers
431  * NB: actual CSR numbers might be changed in future
432  */
433 #define CSR_UMTE            0x4c0
434 #define CSR_UPMMASK         0x4c1
435 #define CSR_UPMBASE         0x4c2
436 
437 /*
438  * Machine PointerMasking registers
439  * NB: actual CSR numbers might be changed in future
440  */
441 #define CSR_MMTE            0x3c0
442 #define CSR_MPMMASK         0x3c1
443 #define CSR_MPMBASE         0x3c2
444 
445 /*
446  * Supervisor PointerMaster registers
447  * NB: actual CSR numbers might be changed in future
448  */
449 #define CSR_SMTE            0x1c0
450 #define CSR_SPMMASK         0x1c1
451 #define CSR_SPMBASE         0x1c2
452 
453 /*
454  * Hypervisor PointerMaster registers
455  * NB: actual CSR numbers might be changed in future
456  */
457 #define CSR_VSMTE           0x2c0
458 #define CSR_VSPMMASK        0x2c1
459 #define CSR_VSPMBASE        0x2c2
460 
461 /* Crypto Extension */
462 #define CSR_SEED            0x015
463 
464 /* mstatus CSR bits */
465 #define MSTATUS_UIE         0x00000001
466 #define MSTATUS_SIE         0x00000002
467 #define MSTATUS_MIE         0x00000008
468 #define MSTATUS_UPIE        0x00000010
469 #define MSTATUS_SPIE        0x00000020
470 #define MSTATUS_UBE         0x00000040
471 #define MSTATUS_MPIE        0x00000080
472 #define MSTATUS_SPP         0x00000100
473 #define MSTATUS_VS          0x00000600
474 #define MSTATUS_MPP         0x00001800
475 #define MSTATUS_FS          0x00006000
476 #define MSTATUS_XS          0x00018000
477 #define MSTATUS_MPRV        0x00020000
478 #define MSTATUS_SUM         0x00040000 /* since: priv-1.10 */
479 #define MSTATUS_MXR         0x00080000
480 #define MSTATUS_TVM         0x00100000 /* since: priv-1.10 */
481 #define MSTATUS_TW          0x00200000 /* since: priv-1.10 */
482 #define MSTATUS_TSR         0x00400000 /* since: priv-1.10 */
483 #define MSTATUS_GVA         0x4000000000ULL
484 #define MSTATUS_MPV         0x8000000000ULL
485 
486 #define MSTATUS64_UXL       0x0000000300000000ULL
487 #define MSTATUS64_SXL       0x0000000C00000000ULL
488 
489 #define MSTATUS32_SD        0x80000000
490 #define MSTATUS64_SD        0x8000000000000000ULL
491 #define MSTATUSH128_SD      0x8000000000000000ULL
492 
493 #define MISA32_MXL          0xC0000000
494 #define MISA64_MXL          0xC000000000000000ULL
495 
496 typedef enum {
497     MXL_RV32  = 1,
498     MXL_RV64  = 2,
499     MXL_RV128 = 3,
500 } RISCVMXL;
501 
502 /* sstatus CSR bits */
503 #define SSTATUS_UIE         0x00000001
504 #define SSTATUS_SIE         0x00000002
505 #define SSTATUS_UPIE        0x00000010
506 #define SSTATUS_SPIE        0x00000020
507 #define SSTATUS_SPP         0x00000100
508 #define SSTATUS_VS          0x00000600
509 #define SSTATUS_FS          0x00006000
510 #define SSTATUS_XS          0x00018000
511 #define SSTATUS_SUM         0x00040000 /* since: priv-1.10 */
512 #define SSTATUS_MXR         0x00080000
513 
514 #define SSTATUS64_UXL       0x0000000300000000ULL
515 
516 #define SSTATUS32_SD        0x80000000
517 #define SSTATUS64_SD        0x8000000000000000ULL
518 
519 /* hstatus CSR bits */
520 #define HSTATUS_VSBE         0x00000020
521 #define HSTATUS_GVA          0x00000040
522 #define HSTATUS_SPV          0x00000080
523 #define HSTATUS_SPVP         0x00000100
524 #define HSTATUS_HU           0x00000200
525 #define HSTATUS_VGEIN        0x0003F000
526 #define HSTATUS_VTVM         0x00100000
527 #define HSTATUS_VTW          0x00200000
528 #define HSTATUS_VTSR         0x00400000
529 #define HSTATUS_VSXL         0x300000000
530 
531 #define HSTATUS32_WPRI       0xFF8FF87E
532 #define HSTATUS64_WPRI       0xFFFFFFFFFF8FF87EULL
533 
534 #define COUNTEREN_CY         (1 << 0)
535 #define COUNTEREN_TM         (1 << 1)
536 #define COUNTEREN_IR         (1 << 2)
537 #define COUNTEREN_HPM3       (1 << 3)
538 
539 /* vsstatus CSR bits */
540 #define VSSTATUS64_UXL       0x0000000300000000ULL
541 
542 /* Privilege modes */
543 #define PRV_U 0
544 #define PRV_S 1
545 #define PRV_H 2 /* Reserved */
546 #define PRV_M 3
547 
548 /* Virtulisation Register Fields */
549 #define VIRT_ONOFF          1
550 
551 /* RV32 satp CSR field masks */
552 #define SATP32_MODE         0x80000000
553 #define SATP32_ASID         0x7fc00000
554 #define SATP32_PPN          0x003fffff
555 
556 /* RV64 satp CSR field masks */
557 #define SATP64_MODE         0xF000000000000000ULL
558 #define SATP64_ASID         0x0FFFF00000000000ULL
559 #define SATP64_PPN          0x00000FFFFFFFFFFFULL
560 
561 /* VM modes (satp.mode) privileged ISA 1.10 */
562 #define VM_1_10_MBARE       0
563 #define VM_1_10_SV32        1
564 #define VM_1_10_SV39        8
565 #define VM_1_10_SV48        9
566 #define VM_1_10_SV57        10
567 #define VM_1_10_SV64        11
568 
569 /* Page table entry (PTE) fields */
570 #define PTE_V               0x001 /* Valid */
571 #define PTE_R               0x002 /* Read */
572 #define PTE_W               0x004 /* Write */
573 #define PTE_X               0x008 /* Execute */
574 #define PTE_U               0x010 /* User */
575 #define PTE_G               0x020 /* Global */
576 #define PTE_A               0x040 /* Accessed */
577 #define PTE_D               0x080 /* Dirty */
578 #define PTE_SOFT            0x300 /* Reserved for Software */
579 #define PTE_PBMT            0x6000000000000000ULL /* Page-based memory types */
580 #define PTE_N               0x8000000000000000ULL /* NAPOT translation */
581 #define PTE_ATTR            (PTE_N | PTE_PBMT) /* All attributes bits */
582 
583 /* Page table PPN shift amount */
584 #define PTE_PPN_SHIFT       10
585 
586 /* Page table PPN mask */
587 #define PTE_PPN_MASK        0x3FFFFFFFFFFC00ULL
588 
589 /* Leaf page shift amount */
590 #define PGSHIFT             12
591 
592 /* Default Reset Vector adress */
593 #define DEFAULT_RSTVEC      0x1000
594 
595 /* Exception causes */
596 typedef enum RISCVException {
597     RISCV_EXCP_NONE = -1, /* sentinel value */
598     RISCV_EXCP_INST_ADDR_MIS = 0x0,
599     RISCV_EXCP_INST_ACCESS_FAULT = 0x1,
600     RISCV_EXCP_ILLEGAL_INST = 0x2,
601     RISCV_EXCP_BREAKPOINT = 0x3,
602     RISCV_EXCP_LOAD_ADDR_MIS = 0x4,
603     RISCV_EXCP_LOAD_ACCESS_FAULT = 0x5,
604     RISCV_EXCP_STORE_AMO_ADDR_MIS = 0x6,
605     RISCV_EXCP_STORE_AMO_ACCESS_FAULT = 0x7,
606     RISCV_EXCP_U_ECALL = 0x8,
607     RISCV_EXCP_S_ECALL = 0x9,
608     RISCV_EXCP_VS_ECALL = 0xa,
609     RISCV_EXCP_M_ECALL = 0xb,
610     RISCV_EXCP_INST_PAGE_FAULT = 0xc, /* since: priv-1.10.0 */
611     RISCV_EXCP_LOAD_PAGE_FAULT = 0xd, /* since: priv-1.10.0 */
612     RISCV_EXCP_STORE_PAGE_FAULT = 0xf, /* since: priv-1.10.0 */
613     RISCV_EXCP_SEMIHOST = 0x10,
614     RISCV_EXCP_INST_GUEST_PAGE_FAULT = 0x14,
615     RISCV_EXCP_LOAD_GUEST_ACCESS_FAULT = 0x15,
616     RISCV_EXCP_VIRT_INSTRUCTION_FAULT = 0x16,
617     RISCV_EXCP_STORE_GUEST_AMO_ACCESS_FAULT = 0x17,
618 } RISCVException;
619 
620 #define RISCV_EXCP_INT_FLAG                0x80000000
621 #define RISCV_EXCP_INT_MASK                0x7fffffff
622 
623 /* Interrupt causes */
624 #define IRQ_U_SOFT                         0
625 #define IRQ_S_SOFT                         1
626 #define IRQ_VS_SOFT                        2
627 #define IRQ_M_SOFT                         3
628 #define IRQ_U_TIMER                        4
629 #define IRQ_S_TIMER                        5
630 #define IRQ_VS_TIMER                       6
631 #define IRQ_M_TIMER                        7
632 #define IRQ_U_EXT                          8
633 #define IRQ_S_EXT                          9
634 #define IRQ_VS_EXT                         10
635 #define IRQ_M_EXT                          11
636 #define IRQ_S_GEXT                         12
637 #define IRQ_LOCAL_MAX                      16
638 #define IRQ_LOCAL_GUEST_MAX                (TARGET_LONG_BITS - 1)
639 
640 /* mip masks */
641 #define MIP_USIP                           (1 << IRQ_U_SOFT)
642 #define MIP_SSIP                           (1 << IRQ_S_SOFT)
643 #define MIP_VSSIP                          (1 << IRQ_VS_SOFT)
644 #define MIP_MSIP                           (1 << IRQ_M_SOFT)
645 #define MIP_UTIP                           (1 << IRQ_U_TIMER)
646 #define MIP_STIP                           (1 << IRQ_S_TIMER)
647 #define MIP_VSTIP                          (1 << IRQ_VS_TIMER)
648 #define MIP_MTIP                           (1 << IRQ_M_TIMER)
649 #define MIP_UEIP                           (1 << IRQ_U_EXT)
650 #define MIP_SEIP                           (1 << IRQ_S_EXT)
651 #define MIP_VSEIP                          (1 << IRQ_VS_EXT)
652 #define MIP_MEIP                           (1 << IRQ_M_EXT)
653 #define MIP_SGEIP                          (1 << IRQ_S_GEXT)
654 
655 /* sip masks */
656 #define SIP_SSIP                           MIP_SSIP
657 #define SIP_STIP                           MIP_STIP
658 #define SIP_SEIP                           MIP_SEIP
659 
660 /* MIE masks */
661 #define MIE_SEIE                           (1 << IRQ_S_EXT)
662 #define MIE_UEIE                           (1 << IRQ_U_EXT)
663 #define MIE_STIE                           (1 << IRQ_S_TIMER)
664 #define MIE_UTIE                           (1 << IRQ_U_TIMER)
665 #define MIE_SSIE                           (1 << IRQ_S_SOFT)
666 #define MIE_USIE                           (1 << IRQ_U_SOFT)
667 
668 /* General PointerMasking CSR bits*/
669 #define PM_ENABLE       0x00000001ULL
670 #define PM_CURRENT      0x00000002ULL
671 #define PM_INSN         0x00000004ULL
672 #define PM_XS_MASK      0x00000003ULL
673 
674 /* PointerMasking XS bits values */
675 #define PM_EXT_DISABLE  0x00000000ULL
676 #define PM_EXT_INITIAL  0x00000001ULL
677 #define PM_EXT_CLEAN    0x00000002ULL
678 #define PM_EXT_DIRTY    0x00000003ULL
679 
680 /* Execution enviornment configuration bits */
681 #define MENVCFG_FIOM                       BIT(0)
682 #define MENVCFG_CBIE                       (3UL << 4)
683 #define MENVCFG_CBCFE                      BIT(6)
684 #define MENVCFG_CBZE                       BIT(7)
685 #define MENVCFG_PBMTE                      (1ULL << 62)
686 #define MENVCFG_STCE                       (1ULL << 63)
687 
688 /* For RV32 */
689 #define MENVCFGH_PBMTE                     BIT(30)
690 #define MENVCFGH_STCE                      BIT(31)
691 
692 #define SENVCFG_FIOM                       MENVCFG_FIOM
693 #define SENVCFG_CBIE                       MENVCFG_CBIE
694 #define SENVCFG_CBCFE                      MENVCFG_CBCFE
695 #define SENVCFG_CBZE                       MENVCFG_CBZE
696 
697 #define HENVCFG_FIOM                       MENVCFG_FIOM
698 #define HENVCFG_CBIE                       MENVCFG_CBIE
699 #define HENVCFG_CBCFE                      MENVCFG_CBCFE
700 #define HENVCFG_CBZE                       MENVCFG_CBZE
701 #define HENVCFG_PBMTE                      MENVCFG_PBMTE
702 #define HENVCFG_STCE                       MENVCFG_STCE
703 
704 /* For RV32 */
705 #define HENVCFGH_PBMTE                      MENVCFGH_PBMTE
706 #define HENVCFGH_STCE                       MENVCFGH_STCE
707 
708 /* Offsets for every pair of control bits per each priv level */
709 #define XS_OFFSET    0ULL
710 #define U_OFFSET     2ULL
711 #define S_OFFSET     5ULL
712 #define M_OFFSET     8ULL
713 
714 #define PM_XS_BITS   (PM_XS_MASK << XS_OFFSET)
715 #define U_PM_ENABLE  (PM_ENABLE  << U_OFFSET)
716 #define U_PM_CURRENT (PM_CURRENT << U_OFFSET)
717 #define U_PM_INSN    (PM_INSN    << U_OFFSET)
718 #define S_PM_ENABLE  (PM_ENABLE  << S_OFFSET)
719 #define S_PM_CURRENT (PM_CURRENT << S_OFFSET)
720 #define S_PM_INSN    (PM_INSN    << S_OFFSET)
721 #define M_PM_ENABLE  (PM_ENABLE  << M_OFFSET)
722 #define M_PM_CURRENT (PM_CURRENT << M_OFFSET)
723 #define M_PM_INSN    (PM_INSN    << M_OFFSET)
724 
725 /* mmte CSR bits */
726 #define MMTE_PM_XS_BITS     PM_XS_BITS
727 #define MMTE_U_PM_ENABLE    U_PM_ENABLE
728 #define MMTE_U_PM_CURRENT   U_PM_CURRENT
729 #define MMTE_U_PM_INSN      U_PM_INSN
730 #define MMTE_S_PM_ENABLE    S_PM_ENABLE
731 #define MMTE_S_PM_CURRENT   S_PM_CURRENT
732 #define MMTE_S_PM_INSN      S_PM_INSN
733 #define MMTE_M_PM_ENABLE    M_PM_ENABLE
734 #define MMTE_M_PM_CURRENT   M_PM_CURRENT
735 #define MMTE_M_PM_INSN      M_PM_INSN
736 #define MMTE_MASK    (MMTE_U_PM_ENABLE | MMTE_U_PM_CURRENT | MMTE_U_PM_INSN | \
737                       MMTE_S_PM_ENABLE | MMTE_S_PM_CURRENT | MMTE_S_PM_INSN | \
738                       MMTE_M_PM_ENABLE | MMTE_M_PM_CURRENT | MMTE_M_PM_INSN | \
739                       MMTE_PM_XS_BITS)
740 
741 /* (v)smte CSR bits */
742 #define SMTE_PM_XS_BITS     PM_XS_BITS
743 #define SMTE_U_PM_ENABLE    U_PM_ENABLE
744 #define SMTE_U_PM_CURRENT   U_PM_CURRENT
745 #define SMTE_U_PM_INSN      U_PM_INSN
746 #define SMTE_S_PM_ENABLE    S_PM_ENABLE
747 #define SMTE_S_PM_CURRENT   S_PM_CURRENT
748 #define SMTE_S_PM_INSN      S_PM_INSN
749 #define SMTE_MASK    (SMTE_U_PM_ENABLE | SMTE_U_PM_CURRENT | SMTE_U_PM_INSN | \
750                       SMTE_S_PM_ENABLE | SMTE_S_PM_CURRENT | SMTE_S_PM_INSN | \
751                       SMTE_PM_XS_BITS)
752 
753 /* umte CSR bits */
754 #define UMTE_U_PM_ENABLE    U_PM_ENABLE
755 #define UMTE_U_PM_CURRENT   U_PM_CURRENT
756 #define UMTE_U_PM_INSN      U_PM_INSN
757 #define UMTE_MASK     (UMTE_U_PM_ENABLE | MMTE_U_PM_CURRENT | UMTE_U_PM_INSN)
758 
759 /* MISELECT, SISELECT, and VSISELECT bits (AIA) */
760 #define ISELECT_IPRIO0                     0x30
761 #define ISELECT_IPRIO15                    0x3f
762 #define ISELECT_IMSIC_EIDELIVERY           0x70
763 #define ISELECT_IMSIC_EITHRESHOLD          0x72
764 #define ISELECT_IMSIC_EIP0                 0x80
765 #define ISELECT_IMSIC_EIP63                0xbf
766 #define ISELECT_IMSIC_EIE0                 0xc0
767 #define ISELECT_IMSIC_EIE63                0xff
768 #define ISELECT_IMSIC_FIRST                ISELECT_IMSIC_EIDELIVERY
769 #define ISELECT_IMSIC_LAST                 ISELECT_IMSIC_EIE63
770 #define ISELECT_MASK                       0x1ff
771 
772 /* Dummy [M|S|VS]ISELECT value for emulating [M|S|VS]TOPEI CSRs */
773 #define ISELECT_IMSIC_TOPEI                (ISELECT_MASK + 1)
774 
775 /* IMSIC bits (AIA) */
776 #define IMSIC_TOPEI_IID_SHIFT              16
777 #define IMSIC_TOPEI_IID_MASK               0x7ff
778 #define IMSIC_TOPEI_IPRIO_MASK             0x7ff
779 #define IMSIC_EIPx_BITS                    32
780 #define IMSIC_EIEx_BITS                    32
781 
782 /* MTOPI and STOPI bits (AIA) */
783 #define TOPI_IID_SHIFT                     16
784 #define TOPI_IID_MASK                      0xfff
785 #define TOPI_IPRIO_MASK                    0xff
786 
787 /* Interrupt priority bits (AIA) */
788 #define IPRIO_IRQ_BITS                     8
789 #define IPRIO_MMAXIPRIO                    255
790 #define IPRIO_DEFAULT_UPPER                4
791 #define IPRIO_DEFAULT_MIDDLE               (IPRIO_DEFAULT_UPPER + 24)
792 #define IPRIO_DEFAULT_M                    IPRIO_DEFAULT_MIDDLE
793 #define IPRIO_DEFAULT_S                    (IPRIO_DEFAULT_M + 3)
794 #define IPRIO_DEFAULT_SGEXT                (IPRIO_DEFAULT_S + 3)
795 #define IPRIO_DEFAULT_VS                   (IPRIO_DEFAULT_SGEXT + 1)
796 #define IPRIO_DEFAULT_LOWER                (IPRIO_DEFAULT_VS + 3)
797 
798 /* HVICTL bits (AIA) */
799 #define HVICTL_VTI                         0x40000000
800 #define HVICTL_IID                         0x0fff0000
801 #define HVICTL_IPRIOM                      0x00000100
802 #define HVICTL_IPRIO                       0x000000ff
803 #define HVICTL_VALID_MASK                  \
804     (HVICTL_VTI | HVICTL_IID | HVICTL_IPRIOM | HVICTL_IPRIO)
805 
806 /* seed CSR bits */
807 #define SEED_OPST                        (0b11 << 30)
808 #define SEED_OPST_BIST                   (0b00 << 30)
809 #define SEED_OPST_WAIT                   (0b01 << 30)
810 #define SEED_OPST_ES16                   (0b10 << 30)
811 #define SEED_OPST_DEAD                   (0b11 << 30)
812 #endif
813