xref: /openbmc/linux/arch/riscv/include/asm/csr.h (revision 8bdc2a19)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2015 Regents of the University of California
4  */
5 
6 #ifndef _ASM_RISCV_CSR_H
7 #define _ASM_RISCV_CSR_H
8 
9 #include <asm/asm.h>
10 #include <linux/const.h>
11 
12 /* Status register flags */
13 #define SR_SIE		_AC(0x00000002, UL) /* Supervisor Interrupt Enable */
14 #define SR_MIE		_AC(0x00000008, UL) /* Machine Interrupt Enable */
15 #define SR_SPIE		_AC(0x00000020, UL) /* Previous Supervisor IE */
16 #define SR_MPIE		_AC(0x00000080, UL) /* Previous Machine IE */
17 #define SR_SPP		_AC(0x00000100, UL) /* Previously Supervisor */
18 #define SR_MPP		_AC(0x00001800, UL) /* Previously Machine */
19 #define SR_SUM		_AC(0x00040000, UL) /* Supervisor User Memory Access */
20 
21 #define SR_FS		_AC(0x00006000, UL) /* Floating-point Status */
22 #define SR_FS_OFF	_AC(0x00000000, UL)
23 #define SR_FS_INITIAL	_AC(0x00002000, UL)
24 #define SR_FS_CLEAN	_AC(0x00004000, UL)
25 #define SR_FS_DIRTY	_AC(0x00006000, UL)
26 
27 #define SR_XS		_AC(0x00018000, UL) /* Extension Status */
28 #define SR_XS_OFF	_AC(0x00000000, UL)
29 #define SR_XS_INITIAL	_AC(0x00008000, UL)
30 #define SR_XS_CLEAN	_AC(0x00010000, UL)
31 #define SR_XS_DIRTY	_AC(0x00018000, UL)
32 
33 #ifndef CONFIG_64BIT
34 #define SR_SD		_AC(0x80000000, UL) /* FS/XS dirty */
35 #else
36 #define SR_SD		_AC(0x8000000000000000, UL) /* FS/XS dirty */
37 #endif
38 
39 /* SATP flags */
40 #ifndef CONFIG_64BIT
41 #define SATP_PPN	_AC(0x003FFFFF, UL)
42 #define SATP_MODE_32	_AC(0x80000000, UL)
43 #define SATP_ASID_BITS	9
44 #define SATP_ASID_SHIFT	22
45 #define SATP_ASID_MASK	_AC(0x1FF, UL)
46 #else
47 #define SATP_PPN	_AC(0x00000FFFFFFFFFFF, UL)
48 #define SATP_MODE_39	_AC(0x8000000000000000, UL)
49 #define SATP_MODE_48	_AC(0x9000000000000000, UL)
50 #define SATP_MODE_57	_AC(0xa000000000000000, UL)
51 #define SATP_ASID_BITS	16
52 #define SATP_ASID_SHIFT	44
53 #define SATP_ASID_MASK	_AC(0xFFFF, UL)
54 #endif
55 
56 /* Exception cause high bit - is an interrupt if set */
57 #define CAUSE_IRQ_FLAG		(_AC(1, UL) << (__riscv_xlen - 1))
58 
59 /* Interrupt causes (minus the high bit) */
60 #define IRQ_S_SOFT		1
61 #define IRQ_VS_SOFT		2
62 #define IRQ_M_SOFT		3
63 #define IRQ_S_TIMER		5
64 #define IRQ_VS_TIMER		6
65 #define IRQ_M_TIMER		7
66 #define IRQ_S_EXT		9
67 #define IRQ_VS_EXT		10
68 #define IRQ_M_EXT		11
69 #define IRQ_PMU_OVF		13
70 
71 /* Exception causes */
72 #define EXC_INST_MISALIGNED	0
73 #define EXC_INST_ACCESS		1
74 #define EXC_INST_ILLEGAL	2
75 #define EXC_BREAKPOINT		3
76 #define EXC_LOAD_ACCESS		5
77 #define EXC_STORE_ACCESS	7
78 #define EXC_SYSCALL		8
79 #define EXC_HYPERVISOR_SYSCALL	9
80 #define EXC_SUPERVISOR_SYSCALL	10
81 #define EXC_INST_PAGE_FAULT	12
82 #define EXC_LOAD_PAGE_FAULT	13
83 #define EXC_STORE_PAGE_FAULT	15
84 #define EXC_INST_GUEST_PAGE_FAULT	20
85 #define EXC_LOAD_GUEST_PAGE_FAULT	21
86 #define EXC_VIRTUAL_INST_FAULT		22
87 #define EXC_STORE_GUEST_PAGE_FAULT	23
88 
89 /* PMP configuration */
90 #define PMP_R			0x01
91 #define PMP_W			0x02
92 #define PMP_X			0x04
93 #define PMP_A			0x18
94 #define PMP_A_TOR		0x08
95 #define PMP_A_NA4		0x10
96 #define PMP_A_NAPOT		0x18
97 #define PMP_L			0x80
98 
99 /* HSTATUS flags */
100 #ifdef CONFIG_64BIT
101 #define HSTATUS_VSXL		_AC(0x300000000, UL)
102 #define HSTATUS_VSXL_SHIFT	32
103 #endif
104 #define HSTATUS_VTSR		_AC(0x00400000, UL)
105 #define HSTATUS_VTW		_AC(0x00200000, UL)
106 #define HSTATUS_VTVM		_AC(0x00100000, UL)
107 #define HSTATUS_VGEIN		_AC(0x0003f000, UL)
108 #define HSTATUS_VGEIN_SHIFT	12
109 #define HSTATUS_HU		_AC(0x00000200, UL)
110 #define HSTATUS_SPVP		_AC(0x00000100, UL)
111 #define HSTATUS_SPV		_AC(0x00000080, UL)
112 #define HSTATUS_GVA		_AC(0x00000040, UL)
113 #define HSTATUS_VSBE		_AC(0x00000020, UL)
114 
115 /* HGATP flags */
116 #define HGATP_MODE_OFF		_AC(0, UL)
117 #define HGATP_MODE_SV32X4	_AC(1, UL)
118 #define HGATP_MODE_SV39X4	_AC(8, UL)
119 #define HGATP_MODE_SV48X4	_AC(9, UL)
120 #define HGATP_MODE_SV57X4	_AC(10, UL)
121 
122 #define HGATP32_MODE_SHIFT	31
123 #define HGATP32_VMID_SHIFT	22
124 #define HGATP32_VMID_MASK	_AC(0x1FC00000, UL)
125 #define HGATP32_PPN		_AC(0x003FFFFF, UL)
126 
127 #define HGATP64_MODE_SHIFT	60
128 #define HGATP64_VMID_SHIFT	44
129 #define HGATP64_VMID_MASK	_AC(0x03FFF00000000000, UL)
130 #define HGATP64_PPN		_AC(0x00000FFFFFFFFFFF, UL)
131 
132 #define HGATP_PAGE_SHIFT	12
133 
134 #ifdef CONFIG_64BIT
135 #define HGATP_PPN		HGATP64_PPN
136 #define HGATP_VMID_SHIFT	HGATP64_VMID_SHIFT
137 #define HGATP_VMID_MASK		HGATP64_VMID_MASK
138 #define HGATP_MODE_SHIFT	HGATP64_MODE_SHIFT
139 #else
140 #define HGATP_PPN		HGATP32_PPN
141 #define HGATP_VMID_SHIFT	HGATP32_VMID_SHIFT
142 #define HGATP_VMID_MASK		HGATP32_VMID_MASK
143 #define HGATP_MODE_SHIFT	HGATP32_MODE_SHIFT
144 #endif
145 
146 /* VSIP & HVIP relation */
147 #define VSIP_TO_HVIP_SHIFT	(IRQ_VS_SOFT - IRQ_S_SOFT)
148 #define VSIP_VALID_MASK		((_AC(1, UL) << IRQ_S_SOFT) | \
149 				 (_AC(1, UL) << IRQ_S_TIMER) | \
150 				 (_AC(1, UL) << IRQ_S_EXT))
151 
152 /* symbolic CSR names: */
153 #define CSR_CYCLE		0xc00
154 #define CSR_TIME		0xc01
155 #define CSR_INSTRET		0xc02
156 #define CSR_HPMCOUNTER3		0xc03
157 #define CSR_HPMCOUNTER4		0xc04
158 #define CSR_HPMCOUNTER5		0xc05
159 #define CSR_HPMCOUNTER6		0xc06
160 #define CSR_HPMCOUNTER7		0xc07
161 #define CSR_HPMCOUNTER8		0xc08
162 #define CSR_HPMCOUNTER9		0xc09
163 #define CSR_HPMCOUNTER10	0xc0a
164 #define CSR_HPMCOUNTER11	0xc0b
165 #define CSR_HPMCOUNTER12	0xc0c
166 #define CSR_HPMCOUNTER13	0xc0d
167 #define CSR_HPMCOUNTER14	0xc0e
168 #define CSR_HPMCOUNTER15	0xc0f
169 #define CSR_HPMCOUNTER16	0xc10
170 #define CSR_HPMCOUNTER17	0xc11
171 #define CSR_HPMCOUNTER18	0xc12
172 #define CSR_HPMCOUNTER19	0xc13
173 #define CSR_HPMCOUNTER20	0xc14
174 #define CSR_HPMCOUNTER21	0xc15
175 #define CSR_HPMCOUNTER22	0xc16
176 #define CSR_HPMCOUNTER23	0xc17
177 #define CSR_HPMCOUNTER24	0xc18
178 #define CSR_HPMCOUNTER25	0xc19
179 #define CSR_HPMCOUNTER26	0xc1a
180 #define CSR_HPMCOUNTER27	0xc1b
181 #define CSR_HPMCOUNTER28	0xc1c
182 #define CSR_HPMCOUNTER29	0xc1d
183 #define CSR_HPMCOUNTER30	0xc1e
184 #define CSR_HPMCOUNTER31	0xc1f
185 #define CSR_CYCLEH		0xc80
186 #define CSR_TIMEH		0xc81
187 #define CSR_INSTRETH		0xc82
188 #define CSR_HPMCOUNTER3H	0xc83
189 #define CSR_HPMCOUNTER4H	0xc84
190 #define CSR_HPMCOUNTER5H	0xc85
191 #define CSR_HPMCOUNTER6H	0xc86
192 #define CSR_HPMCOUNTER7H	0xc87
193 #define CSR_HPMCOUNTER8H	0xc88
194 #define CSR_HPMCOUNTER9H	0xc89
195 #define CSR_HPMCOUNTER10H	0xc8a
196 #define CSR_HPMCOUNTER11H	0xc8b
197 #define CSR_HPMCOUNTER12H	0xc8c
198 #define CSR_HPMCOUNTER13H	0xc8d
199 #define CSR_HPMCOUNTER14H	0xc8e
200 #define CSR_HPMCOUNTER15H	0xc8f
201 #define CSR_HPMCOUNTER16H	0xc90
202 #define CSR_HPMCOUNTER17H	0xc91
203 #define CSR_HPMCOUNTER18H	0xc92
204 #define CSR_HPMCOUNTER19H	0xc93
205 #define CSR_HPMCOUNTER20H	0xc94
206 #define CSR_HPMCOUNTER21H	0xc95
207 #define CSR_HPMCOUNTER22H	0xc96
208 #define CSR_HPMCOUNTER23H	0xc97
209 #define CSR_HPMCOUNTER24H	0xc98
210 #define CSR_HPMCOUNTER25H	0xc99
211 #define CSR_HPMCOUNTER26H	0xc9a
212 #define CSR_HPMCOUNTER27H	0xc9b
213 #define CSR_HPMCOUNTER28H	0xc9c
214 #define CSR_HPMCOUNTER29H	0xc9d
215 #define CSR_HPMCOUNTER30H	0xc9e
216 #define CSR_HPMCOUNTER31H	0xc9f
217 
218 #define CSR_SSCOUNTOVF		0xda0
219 
220 #define CSR_SSTATUS		0x100
221 #define CSR_SIE			0x104
222 #define CSR_STVEC		0x105
223 #define CSR_SCOUNTEREN		0x106
224 #define CSR_SSCRATCH		0x140
225 #define CSR_SEPC		0x141
226 #define CSR_SCAUSE		0x142
227 #define CSR_STVAL		0x143
228 #define CSR_SIP			0x144
229 #define CSR_SATP		0x180
230 
231 #define CSR_VSSTATUS		0x200
232 #define CSR_VSIE		0x204
233 #define CSR_VSTVEC		0x205
234 #define CSR_VSSCRATCH		0x240
235 #define CSR_VSEPC		0x241
236 #define CSR_VSCAUSE		0x242
237 #define CSR_VSTVAL		0x243
238 #define CSR_VSIP		0x244
239 #define CSR_VSATP		0x280
240 
241 #define CSR_HSTATUS		0x600
242 #define CSR_HEDELEG		0x602
243 #define CSR_HIDELEG		0x603
244 #define CSR_HIE			0x604
245 #define CSR_HTIMEDELTA		0x605
246 #define CSR_HCOUNTEREN		0x606
247 #define CSR_HGEIE		0x607
248 #define CSR_HTIMEDELTAH		0x615
249 #define CSR_HTVAL		0x643
250 #define CSR_HIP			0x644
251 #define CSR_HVIP		0x645
252 #define CSR_HTINST		0x64a
253 #define CSR_HGATP		0x680
254 #define CSR_HGEIP		0xe12
255 
256 #define CSR_MSTATUS		0x300
257 #define CSR_MISA		0x301
258 #define CSR_MIE			0x304
259 #define CSR_MTVEC		0x305
260 #define CSR_MSCRATCH		0x340
261 #define CSR_MEPC		0x341
262 #define CSR_MCAUSE		0x342
263 #define CSR_MTVAL		0x343
264 #define CSR_MIP			0x344
265 #define CSR_PMPCFG0		0x3a0
266 #define CSR_PMPADDR0		0x3b0
267 #define CSR_MVENDORID		0xf11
268 #define CSR_MARCHID		0xf12
269 #define CSR_MIMPID		0xf13
270 #define CSR_MHARTID		0xf14
271 
272 #ifdef CONFIG_RISCV_M_MODE
273 # define CSR_STATUS	CSR_MSTATUS
274 # define CSR_IE		CSR_MIE
275 # define CSR_TVEC	CSR_MTVEC
276 # define CSR_SCRATCH	CSR_MSCRATCH
277 # define CSR_EPC	CSR_MEPC
278 # define CSR_CAUSE	CSR_MCAUSE
279 # define CSR_TVAL	CSR_MTVAL
280 # define CSR_IP		CSR_MIP
281 
282 # define SR_IE		SR_MIE
283 # define SR_PIE		SR_MPIE
284 # define SR_PP		SR_MPP
285 
286 # define RV_IRQ_SOFT		IRQ_M_SOFT
287 # define RV_IRQ_TIMER	IRQ_M_TIMER
288 # define RV_IRQ_EXT		IRQ_M_EXT
289 #else /* CONFIG_RISCV_M_MODE */
290 # define CSR_STATUS	CSR_SSTATUS
291 # define CSR_IE		CSR_SIE
292 # define CSR_TVEC	CSR_STVEC
293 # define CSR_SCRATCH	CSR_SSCRATCH
294 # define CSR_EPC	CSR_SEPC
295 # define CSR_CAUSE	CSR_SCAUSE
296 # define CSR_TVAL	CSR_STVAL
297 # define CSR_IP		CSR_SIP
298 
299 # define SR_IE		SR_SIE
300 # define SR_PIE		SR_SPIE
301 # define SR_PP		SR_SPP
302 
303 # define RV_IRQ_SOFT		IRQ_S_SOFT
304 # define RV_IRQ_TIMER	IRQ_S_TIMER
305 # define RV_IRQ_EXT		IRQ_S_EXT
306 # define RV_IRQ_PMU	IRQ_PMU_OVF
307 # define SIP_LCOFIP     (_AC(0x1, UL) << IRQ_PMU_OVF)
308 
309 #endif /* !CONFIG_RISCV_M_MODE */
310 
311 /* IE/IP (Supervisor/Machine Interrupt Enable/Pending) flags */
312 #define IE_SIE		(_AC(0x1, UL) << RV_IRQ_SOFT)
313 #define IE_TIE		(_AC(0x1, UL) << RV_IRQ_TIMER)
314 #define IE_EIE		(_AC(0x1, UL) << RV_IRQ_EXT)
315 
316 #ifndef __ASSEMBLY__
317 
318 #define csr_swap(csr, val)					\
319 ({								\
320 	unsigned long __v = (unsigned long)(val);		\
321 	__asm__ __volatile__ ("csrrw %0, " __ASM_STR(csr) ", %1"\
322 			      : "=r" (__v) : "rK" (__v)		\
323 			      : "memory");			\
324 	__v;							\
325 })
326 
327 #define csr_read(csr)						\
328 ({								\
329 	register unsigned long __v;				\
330 	__asm__ __volatile__ ("csrr %0, " __ASM_STR(csr)	\
331 			      : "=r" (__v) :			\
332 			      : "memory");			\
333 	__v;							\
334 })
335 
336 #define csr_write(csr, val)					\
337 ({								\
338 	unsigned long __v = (unsigned long)(val);		\
339 	__asm__ __volatile__ ("csrw " __ASM_STR(csr) ", %0"	\
340 			      : : "rK" (__v)			\
341 			      : "memory");			\
342 })
343 
344 #define csr_read_set(csr, val)					\
345 ({								\
346 	unsigned long __v = (unsigned long)(val);		\
347 	__asm__ __volatile__ ("csrrs %0, " __ASM_STR(csr) ", %1"\
348 			      : "=r" (__v) : "rK" (__v)		\
349 			      : "memory");			\
350 	__v;							\
351 })
352 
353 #define csr_set(csr, val)					\
354 ({								\
355 	unsigned long __v = (unsigned long)(val);		\
356 	__asm__ __volatile__ ("csrs " __ASM_STR(csr) ", %0"	\
357 			      : : "rK" (__v)			\
358 			      : "memory");			\
359 })
360 
361 #define csr_read_clear(csr, val)				\
362 ({								\
363 	unsigned long __v = (unsigned long)(val);		\
364 	__asm__ __volatile__ ("csrrc %0, " __ASM_STR(csr) ", %1"\
365 			      : "=r" (__v) : "rK" (__v)		\
366 			      : "memory");			\
367 	__v;							\
368 })
369 
370 #define csr_clear(csr, val)					\
371 ({								\
372 	unsigned long __v = (unsigned long)(val);		\
373 	__asm__ __volatile__ ("csrc " __ASM_STR(csr) ", %0"	\
374 			      : : "rK" (__v)			\
375 			      : "memory");			\
376 })
377 
378 #endif /* __ASSEMBLY__ */
379 
380 #endif /* _ASM_RISCV_CSR_H */
381