1 /*- 2 * Copyright (c) 2015-2026 Ruslan Bukin <br@bsdpad.com> 3 * All rights reserved. 4 * 5 * Portions of this software were developed by SRI International and the 6 * University of Cambridge Computer Laboratory under DARPA/AFRL contract 7 * FA8750-10-C-0237 ("CTSRD"), as part of the DARPA CRASH research programme. 8 * 9 * Portions of this software were developed by the University of Cambridge 10 * Computer Laboratory as part of the CTSRD Project, with support from the 11 * UK Higher Education Innovation Fund (HEIF). 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 */ 34 35 #ifndef _MACHINE_RISCVREG_H_ 36 #define _MACHINE_RISCVREG_H_ 37 38 #define SCAUSE_INTR (1ul << 63) 39 #define SCAUSE_CODE (~SCAUSE_INTR) 40 #define SCAUSE_INST_MISALIGNED 0 41 #define SCAUSE_INST_ACCESS_FAULT 1 42 #define SCAUSE_ILLEGAL_INSTRUCTION 2 43 #define SCAUSE_BREAKPOINT 3 44 #define SCAUSE_LOAD_MISALIGNED 4 45 #define SCAUSE_LOAD_ACCESS_FAULT 5 46 #define SCAUSE_STORE_MISALIGNED 6 47 #define SCAUSE_STORE_ACCESS_FAULT 7 48 #define SCAUSE_ECALL_USER 8 49 #define SCAUSE_ECALL_SUPERVISOR 9 50 #define SCAUSE_VIRTUAL_SUPERVISOR_ECALL 10 51 #define SCAUSE_MACHINE_ECALL 11 52 #define SCAUSE_INST_PAGE_FAULT 12 53 #define SCAUSE_LOAD_PAGE_FAULT 13 54 #define SCAUSE_STORE_PAGE_FAULT 15 55 #define SCAUSE_FETCH_GUEST_PAGE_FAULT 20 56 #define SCAUSE_LOAD_GUEST_PAGE_FAULT 21 57 #define SCAUSE_VIRTUAL_INSTRUCTION 22 58 #define SCAUSE_STORE_GUEST_PAGE_FAULT 23 59 60 #define SSTATUS_UIE (1 << 0) 61 #define SSTATUS_SIE (1 << 1) 62 #define SSTATUS_UPIE (1 << 4) 63 #define SSTATUS_SPIE (1 << 5) 64 #define SSTATUS_SPIE_SHIFT 5 65 #define SSTATUS_SPP (1 << 8) 66 #define SSTATUS_SPP_SHIFT 8 67 #define SSTATUS_VS_SHIFT 9 68 #define SSTATUS_VS_OFF (0x0 << SSTATUS_VS_SHIFT) 69 #define SSTATUS_VS_INITIAL (0x1 << SSTATUS_VS_SHIFT) 70 #define SSTATUS_VS_CLEAN (0x2 << SSTATUS_VS_SHIFT) 71 #define SSTATUS_VS_DIRTY (0x3 << SSTATUS_VS_SHIFT) 72 #define SSTATUS_VS_MASK (0x3 << SSTATUS_VS_SHIFT) 73 #define SSTATUS_FS_SHIFT 13 74 #define SSTATUS_FS_OFF (0x0 << SSTATUS_FS_SHIFT) 75 #define SSTATUS_FS_INITIAL (0x1 << SSTATUS_FS_SHIFT) 76 #define SSTATUS_FS_CLEAN (0x2 << SSTATUS_FS_SHIFT) 77 #define SSTATUS_FS_DIRTY (0x3 << SSTATUS_FS_SHIFT) 78 #define SSTATUS_FS_MASK (0x3 << SSTATUS_FS_SHIFT) 79 #define SSTATUS_XS_SHIFT 15 80 #define SSTATUS_XS_MASK (0x3 << SSTATUS_XS_SHIFT) 81 #define SSTATUS_SUM (1 << 18) 82 #if __riscv_xlen == 64 83 #define SSTATUS_SD (1ul << 63) 84 #else 85 #define SSTATUS_SD (1 << 31) 86 #endif 87 88 #define MSTATUS_UIE (1 << 0) 89 #define MSTATUS_SIE (1 << 1) 90 #define MSTATUS_HIE (1 << 2) 91 #define MSTATUS_MIE (1 << 3) 92 #define MSTATUS_UPIE (1 << 4) 93 #define MSTATUS_SPIE (1 << 5) 94 #define MSTATUS_SPIE_SHIFT 5 95 #define MSTATUS_HPIE (1 << 6) 96 #define MSTATUS_MPIE (1 << 7) 97 #define MSTATUS_MPIE_SHIFT 7 98 #define MSTATUS_SPP (1 << 8) 99 #define MSTATUS_SPP_SHIFT 8 100 #define MSTATUS_HPP_MASK 0x3 101 #define MSTATUS_HPP_SHIFT 9 102 #define MSTATUS_MPP_MASK 0x3 103 #define MSTATUS_MPP_SHIFT 11 104 #define MSTATUS_FS_MASK 0x3 105 #define MSTATUS_FS_SHIFT 13 106 #define MSTATUS_XS_MASK 0x3 107 #define MSTATUS_XS_SHIFT 15 108 #define MSTATUS_MPRV (1 << 17) 109 #define MSTATUS_PUM (1 << 18) 110 #define MSTATUS_VM_MASK 0x1f 111 #define MSTATUS_VM_SHIFT 24 112 #define MSTATUS_VM_MBARE 0 113 #define MSTATUS_VM_MBB 1 114 #define MSTATUS_VM_MBBID 2 115 #define MSTATUS_VM_SV32 8 116 #define MSTATUS_VM_SV39 9 117 #define MSTATUS_VM_SV48 10 118 #define MSTATUS_VM_SV57 11 119 #define MSTATUS_VM_SV64 12 120 #if __riscv_xlen == 64 121 #define MSTATUS_SD (1ul << 63) 122 #else 123 #define MSTATUS_SD (1 << 31) 124 #endif 125 126 #define MSTATUS_PRV_U 0 /* user */ 127 #define MSTATUS_PRV_S 1 /* supervisor */ 128 #define MSTATUS_PRV_H 2 /* hypervisor */ 129 #define MSTATUS_PRV_M 3 /* machine */ 130 131 #define HSTATUS_VSBE (1 << 5) 132 #define HSTATUS_GVA (1 << 6) 133 #define HSTATUS_SPV (1 << 7) 134 #define HSTATUS_SPVP (1 << 8) 135 #define HSTATUS_HU (1 << 9) 136 #define HSTATUS_VGEIN_S 12 137 #define HSTATUS_VGEIN_M (0xf << HSTATUS_VGEIN_S) 138 #define HSTATUS_VTVM (1 << 20) 139 #define HSTATUS_VTW (1 << 21) 140 #define HSTATUS_VTSR (1 << 22) 141 142 #define MIE_USIE (1 << 0) 143 #define MIE_SSIE (1 << 1) 144 #define MIE_HSIE (1 << 2) 145 #define MIE_MSIE (1 << 3) 146 #define MIE_UTIE (1 << 4) 147 #define MIE_STIE (1 << 5) 148 #define MIE_HTIE (1 << 6) 149 #define MIE_MTIE (1 << 7) 150 151 #define MIP_USIP (1 << 0) 152 #define MIP_SSIP (1 << 1) 153 #define MIP_HSIP (1 << 2) 154 #define MIP_MSIP (1 << 3) 155 #define MIP_UTIP (1 << 4) 156 #define MIP_STIP (1 << 5) 157 #define MIP_HTIP (1 << 6) 158 #define MIP_MTIP (1 << 7) 159 160 #define SIE_USIE (1 << 0) 161 #define SIE_SSIE (1 << 1) 162 #define SIE_UTIE (1 << 4) 163 #define SIE_STIE (1 << 5) 164 #define SIE_UEIE (1 << 8) 165 #define SIE_SEIE (1 << 9) 166 167 #define MIP_SEIP (1 << 9) 168 169 #define HVIP_VSSIP (1 << 2) 170 #define HVIP_VSTIP (1 << 6) 171 #define HVIP_VSEIP (1 << 10) 172 173 #define HIE_VSSIE (1 << 2) 174 #define HIE_VSTIE (1 << 6) 175 #define HIE_VSEIE (1 << 10) 176 #define HIE_SGEIE (1 << 12) 177 178 /* Note: sip register has no SIP_STIP bit in Spike simulator */ 179 #define SIP_SSIP (1 << 1) 180 #define SIP_STIP (1 << 5) 181 182 #define HENVCFG_STCE (1UL << 63) 183 #define HENVCFG_PBMTE (1UL << 62) 184 #define HENVCFG_CBZE (1UL << 7) 185 #define HENVCFG_CBCFE (1UL << 6) 186 #define HENVCFG_CBIE_S 4 187 #define HENVCFG_CBIE_M (0x3 << HENVCFG_CBIE_S) 188 #define HENVCFG_FIOM (1UL << 0) 189 190 #define HCOUNTEREN_CY (1UL << 0) /* Cycle */ 191 #define HCOUNTEREN_TM (1UL << 1) /* Time */ 192 #define HCOUNTEREN_IR (1UL << 2) /* Instret */ 193 194 #define SATP_PPN_S 0 195 #define SATP_PPN_M (0xfffffffffffUL << SATP_PPN_S) 196 #define SATP_ASID_S 44 197 #define SATP_ASID_M (0xffffUL << SATP_ASID_S) 198 #define SATP_MODE_S 60 199 #define SATP_MODE_M (0xfUL << SATP_MODE_S) 200 #define SATP_MODE_SV39 (8ULL << SATP_MODE_S) 201 #define SATP_MODE_SV48 (9ULL << SATP_MODE_S) 202 203 #define XLEN __riscv_xlen 204 #define XLEN_BYTES (XLEN / 8) 205 #define INSN_SIZE 4 206 #define INSN_C_SIZE 2 207 208 #define X_RA 1 209 #define X_SP 2 210 #define X_GP 3 211 #define X_TP 4 212 #define X_T0 5 213 #define X_T1 6 214 #define X_T2 7 215 #define X_T3 28 216 217 #define RD_SHIFT 7 218 #define RD_MASK (0x1f << RD_SHIFT) 219 #define RS1_SHIFT 15 220 #define RS1_MASK (0x1f << RS1_SHIFT) 221 #define RS1_SP (X_SP << RS1_SHIFT) 222 #define RS2_SHIFT 20 223 #define RS2_MASK (0x1f << RS2_SHIFT) 224 #define RS2_RA (X_RA << RS2_SHIFT) 225 #define IMM_SHIFT 20 226 #define IMM_MASK (0xfff << IMM_SHIFT) 227 228 #define RS2_C_SHIFT 2 229 #define RS2_C_MASK (0x1f << RS2_C_SHIFT) 230 #define RS2_C_RA (X_RA << RS2_C_SHIFT) 231 232 #define CSR_ZIMM(val) \ 233 (__builtin_constant_p(val) && ((u_long)(val) < 32)) 234 235 #define csr_swap(csr, val) \ 236 ({ u_long ret; \ 237 if (CSR_ZIMM(val)) \ 238 __asm __volatile("csrrwi %0, " #csr ", %1" \ 239 : "=r" (ret) : "i" (val)); \ 240 else \ 241 __asm __volatile("csrrw %0, " #csr ", %1" \ 242 : "=r" (ret) : "r" (val)); \ 243 ret; \ 244 }) 245 246 #define csr_write(csr, val) \ 247 ({ if (CSR_ZIMM(val)) \ 248 __asm __volatile("csrwi " #csr ", %0" :: "i" (val)); \ 249 else \ 250 __asm __volatile("csrw " #csr ", %0" :: "r" (val)); \ 251 }) 252 253 #define csr_set(csr, val) \ 254 ({ if (CSR_ZIMM(val)) \ 255 __asm __volatile("csrsi " #csr ", %0" :: "i" (val)); \ 256 else \ 257 __asm __volatile("csrs " #csr ", %0" :: "r" (val)); \ 258 }) 259 260 #define csr_clear(csr, val) \ 261 ({ if (CSR_ZIMM(val)) \ 262 __asm __volatile("csrci " #csr ", %0" :: "i" (val)); \ 263 else \ 264 __asm __volatile("csrc " #csr ", %0" :: "r" (val)); \ 265 }) 266 267 #define csr_read(csr) \ 268 ({ u_long val; \ 269 __asm __volatile("csrr %0, " #csr : "=r" (val)); \ 270 val; \ 271 }) 272 273 #if __riscv_xlen == 32 274 #define csr_read64(csr) \ 275 ({ uint64_t val; \ 276 uint32_t high, low; \ 277 __asm __volatile("1: " \ 278 "csrr t0, " #csr "h\n" \ 279 "csrr %0, " #csr "\n" \ 280 "csrr %1, " #csr "h\n" \ 281 "bne t0, %1, 1b" \ 282 : "=r" (low), "=r" (high) \ 283 : \ 284 : "t0"); \ 285 val = (low | ((uint64_t)high << 32)); \ 286 val; \ 287 }) 288 #else 289 #define csr_read64(csr) ((uint64_t)csr_read(csr)) 290 #endif 291 292 #endif /* !_MACHINE_RISCVREG_H_ */ 293