1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2012,2013 - ARM Ltd
4  * Author: Marc Zyngier <marc.zyngier@arm.com>
5  */
6 
7 #ifndef __ARM64_KVM_ARM_H__
8 #define __ARM64_KVM_ARM_H__
9 
10 #include <asm/esr.h>
11 #include <asm/memory.h>
12 #include <asm/types.h>
13 
14 /* Hyp Configuration Register (HCR) bits */
15 
16 #define HCR_TID5	(UL(1) << 58)
17 #define HCR_DCT		(UL(1) << 57)
18 #define HCR_ATA_SHIFT	56
19 #define HCR_ATA		(UL(1) << HCR_ATA_SHIFT)
20 #define HCR_AMVOFFEN	(UL(1) << 51)
21 #define HCR_FIEN	(UL(1) << 47)
22 #define HCR_FWB		(UL(1) << 46)
23 #define HCR_API		(UL(1) << 41)
24 #define HCR_APK		(UL(1) << 40)
25 #define HCR_TEA		(UL(1) << 37)
26 #define HCR_TERR	(UL(1) << 36)
27 #define HCR_TLOR	(UL(1) << 35)
28 #define HCR_E2H		(UL(1) << 34)
29 #define HCR_ID		(UL(1) << 33)
30 #define HCR_CD		(UL(1) << 32)
31 #define HCR_RW_SHIFT	31
32 #define HCR_RW		(UL(1) << HCR_RW_SHIFT)
33 #define HCR_TRVM	(UL(1) << 30)
34 #define HCR_HCD		(UL(1) << 29)
35 #define HCR_TDZ		(UL(1) << 28)
36 #define HCR_TGE		(UL(1) << 27)
37 #define HCR_TVM		(UL(1) << 26)
38 #define HCR_TTLB	(UL(1) << 25)
39 #define HCR_TPU		(UL(1) << 24)
40 #define HCR_TPC		(UL(1) << 23) /* HCR_TPCP if FEAT_DPB */
41 #define HCR_TSW		(UL(1) << 22)
42 #define HCR_TACR	(UL(1) << 21)
43 #define HCR_TIDCP	(UL(1) << 20)
44 #define HCR_TSC		(UL(1) << 19)
45 #define HCR_TID3	(UL(1) << 18)
46 #define HCR_TID2	(UL(1) << 17)
47 #define HCR_TID1	(UL(1) << 16)
48 #define HCR_TID0	(UL(1) << 15)
49 #define HCR_TWE		(UL(1) << 14)
50 #define HCR_TWI		(UL(1) << 13)
51 #define HCR_DC		(UL(1) << 12)
52 #define HCR_BSU		(3 << 10)
53 #define HCR_BSU_IS	(UL(1) << 10)
54 #define HCR_FB		(UL(1) << 9)
55 #define HCR_VSE		(UL(1) << 8)
56 #define HCR_VI		(UL(1) << 7)
57 #define HCR_VF		(UL(1) << 6)
58 #define HCR_AMO		(UL(1) << 5)
59 #define HCR_IMO		(UL(1) << 4)
60 #define HCR_FMO		(UL(1) << 3)
61 #define HCR_PTW		(UL(1) << 2)
62 #define HCR_SWIO	(UL(1) << 1)
63 #define HCR_VM		(UL(1) << 0)
64 #define HCR_RES0	((UL(1) << 48) | (UL(1) << 39))
65 
66 /*
67  * The bits we set in HCR:
68  * TLOR:	Trap LORegion register accesses
69  * RW:		64bit by default, can be overridden for 32bit VMs
70  * TACR:	Trap ACTLR
71  * TSC:		Trap SMC
72  * TSW:		Trap cache operations by set/way
73  * TWE:		Trap WFE
74  * TWI:		Trap WFI
75  * TIDCP:	Trap L2CTLR/L2ECTLR
76  * BSU_IS:	Upgrade barriers to the inner shareable domain
77  * FB:		Force broadcast of all maintenance operations
78  * AMO:		Override CPSR.A and enable signaling with VA
79  * IMO:		Override CPSR.I and enable signaling with VI
80  * FMO:		Override CPSR.F and enable signaling with VF
81  * SWIO:	Turn set/way invalidates into set/way clean+invalidate
82  * PTW:		Take a stage2 fault if a stage1 walk steps in device memory
83  * TID3:	Trap EL1 reads of group 3 ID registers
84  * TID2:	Trap CTR_EL0, CCSIDR2_EL1, CLIDR_EL1, and CSSELR_EL1
85  */
86 #define HCR_GUEST_FLAGS (HCR_TSC | HCR_TSW | HCR_TWE | HCR_TWI | HCR_VM | \
87 			 HCR_BSU_IS | HCR_FB | HCR_TACR | \
88 			 HCR_AMO | HCR_SWIO | HCR_TIDCP | HCR_RW | HCR_TLOR | \
89 			 HCR_FMO | HCR_IMO | HCR_PTW | HCR_TID3 | HCR_TID2)
90 #define HCR_VIRT_EXCP_MASK (HCR_VSE | HCR_VI | HCR_VF)
91 #define HCR_HOST_NVHE_FLAGS (HCR_RW | HCR_API | HCR_APK | HCR_ATA)
92 #define HCR_HOST_NVHE_PROTECTED_FLAGS (HCR_HOST_NVHE_FLAGS | HCR_TSC)
93 #define HCR_HOST_VHE_FLAGS (HCR_RW | HCR_TGE | HCR_E2H)
94 
95 /* TCR_EL2 Registers bits */
96 #define TCR_EL2_RES1		((1U << 31) | (1 << 23))
97 #define TCR_EL2_TBI		(1 << 20)
98 #define TCR_EL2_PS_SHIFT	16
99 #define TCR_EL2_PS_MASK		(7 << TCR_EL2_PS_SHIFT)
100 #define TCR_EL2_PS_40B		(2 << TCR_EL2_PS_SHIFT)
101 #define TCR_EL2_TG0_MASK	TCR_TG0_MASK
102 #define TCR_EL2_SH0_MASK	TCR_SH0_MASK
103 #define TCR_EL2_ORGN0_MASK	TCR_ORGN0_MASK
104 #define TCR_EL2_IRGN0_MASK	TCR_IRGN0_MASK
105 #define TCR_EL2_T0SZ_MASK	0x3f
106 #define TCR_EL2_MASK	(TCR_EL2_TG0_MASK | TCR_EL2_SH0_MASK | \
107 			 TCR_EL2_ORGN0_MASK | TCR_EL2_IRGN0_MASK | TCR_EL2_T0SZ_MASK)
108 
109 /* VTCR_EL2 Registers bits */
110 #define VTCR_EL2_RES1		(1U << 31)
111 #define VTCR_EL2_HD		(1 << 22)
112 #define VTCR_EL2_HA		(1 << 21)
113 #define VTCR_EL2_PS_SHIFT	TCR_EL2_PS_SHIFT
114 #define VTCR_EL2_PS_MASK	TCR_EL2_PS_MASK
115 #define VTCR_EL2_TG0_MASK	TCR_TG0_MASK
116 #define VTCR_EL2_TG0_4K		TCR_TG0_4K
117 #define VTCR_EL2_TG0_16K	TCR_TG0_16K
118 #define VTCR_EL2_TG0_64K	TCR_TG0_64K
119 #define VTCR_EL2_SH0_MASK	TCR_SH0_MASK
120 #define VTCR_EL2_SH0_INNER	TCR_SH0_INNER
121 #define VTCR_EL2_ORGN0_MASK	TCR_ORGN0_MASK
122 #define VTCR_EL2_ORGN0_WBWA	TCR_ORGN0_WBWA
123 #define VTCR_EL2_IRGN0_MASK	TCR_IRGN0_MASK
124 #define VTCR_EL2_IRGN0_WBWA	TCR_IRGN0_WBWA
125 #define VTCR_EL2_SL0_SHIFT	6
126 #define VTCR_EL2_SL0_MASK	(3 << VTCR_EL2_SL0_SHIFT)
127 #define VTCR_EL2_T0SZ_MASK	0x3f
128 #define VTCR_EL2_VS_SHIFT	19
129 #define VTCR_EL2_VS_8BIT	(0 << VTCR_EL2_VS_SHIFT)
130 #define VTCR_EL2_VS_16BIT	(1 << VTCR_EL2_VS_SHIFT)
131 
132 #define VTCR_EL2_T0SZ(x)	TCR_T0SZ(x)
133 
134 /*
135  * We configure the Stage-2 page tables to always restrict the IPA space to be
136  * 40 bits wide (T0SZ = 24).  Systems with a PARange smaller than 40 bits are
137  * not known to exist and will break with this configuration.
138  *
139  * The VTCR_EL2 is configured per VM and is initialised in kvm_init_stage2_mmu.
140  *
141  * Note that when using 4K pages, we concatenate two first level page tables
142  * together. With 16K pages, we concatenate 16 first level page tables.
143  *
144  */
145 
146 #define VTCR_EL2_COMMON_BITS	(VTCR_EL2_SH0_INNER | VTCR_EL2_ORGN0_WBWA | \
147 				 VTCR_EL2_IRGN0_WBWA | VTCR_EL2_RES1)
148 
149 /*
150  * VTCR_EL2:SL0 indicates the entry level for Stage2 translation.
151  * Interestingly, it depends on the page size.
152  * See D.10.2.121, VTCR_EL2, in ARM DDI 0487C.a
153  *
154  *	-----------------------------------------
155  *	| Entry level		|  4K  | 16K/64K |
156  *	------------------------------------------
157  *	| Level: 0		|  2   |   -     |
158  *	------------------------------------------
159  *	| Level: 1		|  1   |   2     |
160  *	------------------------------------------
161  *	| Level: 2		|  0   |   1     |
162  *	------------------------------------------
163  *	| Level: 3		|  -   |   0     |
164  *	------------------------------------------
165  *
166  * The table roughly translates to :
167  *
168  *	SL0(PAGE_SIZE, Entry_level) = TGRAN_SL0_BASE - Entry_Level
169  *
170  * Where TGRAN_SL0_BASE is a magic number depending on the page size:
171  * 	TGRAN_SL0_BASE(4K) = 2
172  *	TGRAN_SL0_BASE(16K) = 3
173  *	TGRAN_SL0_BASE(64K) = 3
174  * provided we take care of ruling out the unsupported cases and
175  * Entry_Level = 4 - Number_of_levels.
176  *
177  */
178 #ifdef CONFIG_ARM64_64K_PAGES
179 
180 #define VTCR_EL2_TGRAN			VTCR_EL2_TG0_64K
181 #define VTCR_EL2_TGRAN_SL0_BASE		3UL
182 
183 #elif defined(CONFIG_ARM64_16K_PAGES)
184 
185 #define VTCR_EL2_TGRAN			VTCR_EL2_TG0_16K
186 #define VTCR_EL2_TGRAN_SL0_BASE		3UL
187 
188 #else	/* 4K */
189 
190 #define VTCR_EL2_TGRAN			VTCR_EL2_TG0_4K
191 #define VTCR_EL2_TGRAN_SL0_BASE		2UL
192 
193 #endif
194 
195 #define VTCR_EL2_LVLS_TO_SL0(levels)	\
196 	((VTCR_EL2_TGRAN_SL0_BASE - (4 - (levels))) << VTCR_EL2_SL0_SHIFT)
197 #define VTCR_EL2_SL0_TO_LVLS(sl0)	\
198 	((sl0) + 4 - VTCR_EL2_TGRAN_SL0_BASE)
199 #define VTCR_EL2_LVLS(vtcr)		\
200 	VTCR_EL2_SL0_TO_LVLS(((vtcr) & VTCR_EL2_SL0_MASK) >> VTCR_EL2_SL0_SHIFT)
201 
202 #define VTCR_EL2_FLAGS			(VTCR_EL2_COMMON_BITS | VTCR_EL2_TGRAN)
203 #define VTCR_EL2_IPA(vtcr)		(64 - ((vtcr) & VTCR_EL2_T0SZ_MASK))
204 
205 /*
206  * ARM VMSAv8-64 defines an algorithm for finding the translation table
207  * descriptors in section D4.2.8 in ARM DDI 0487C.a.
208  *
209  * The algorithm defines the expectations on the translation table
210  * addresses for each level, based on PAGE_SIZE, entry level
211  * and the translation table size (T0SZ). The variable "x" in the
212  * algorithm determines the alignment of a table base address at a given
213  * level and thus determines the alignment of VTTBR:BADDR for stage2
214  * page table entry level.
215  * Since the number of bits resolved at the entry level could vary
216  * depending on the T0SZ, the value of "x" is defined based on a
217  * Magic constant for a given PAGE_SIZE and Entry Level. The
218  * intermediate levels must be always aligned to the PAGE_SIZE (i.e,
219  * x = PAGE_SHIFT).
220  *
221  * The value of "x" for entry level is calculated as :
222  *    x = Magic_N - T0SZ
223  *
224  * where Magic_N is an integer depending on the page size and the entry
225  * level of the page table as below:
226  *
227  *	--------------------------------------------
228  *	| Entry level		|  4K    16K   64K |
229  *	--------------------------------------------
230  *	| Level: 0 (4 levels)	| 28   |  -  |  -  |
231  *	--------------------------------------------
232  *	| Level: 1 (3 levels)	| 37   | 31  | 25  |
233  *	--------------------------------------------
234  *	| Level: 2 (2 levels)	| 46   | 42  | 38  |
235  *	--------------------------------------------
236  *	| Level: 3 (1 level)	| -    | 53  | 51  |
237  *	--------------------------------------------
238  *
239  * We have a magic formula for the Magic_N below:
240  *
241  *  Magic_N(PAGE_SIZE, Level) = 64 - ((PAGE_SHIFT - 3) * Number_of_levels)
242  *
243  * where Number_of_levels = (4 - Level). We are only interested in the
244  * value for Entry_Level for the stage2 page table.
245  *
246  * So, given that T0SZ = (64 - IPA_SHIFT), we can compute 'x' as follows:
247  *
248  *	x = (64 - ((PAGE_SHIFT - 3) * Number_of_levels)) - (64 - IPA_SHIFT)
249  *	  = IPA_SHIFT - ((PAGE_SHIFT - 3) * Number of levels)
250  *
251  * Here is one way to explain the Magic Formula:
252  *
253  *  x = log2(Size_of_Entry_Level_Table)
254  *
255  * Since, we can resolve (PAGE_SHIFT - 3) bits at each level, and another
256  * PAGE_SHIFT bits in the PTE, we have :
257  *
258  *  Bits_Entry_level = IPA_SHIFT - ((PAGE_SHIFT - 3) * (n - 1) + PAGE_SHIFT)
259  *		     = IPA_SHIFT - (PAGE_SHIFT - 3) * n - 3
260  *  where n = number of levels, and since each pointer is 8bytes, we have:
261  *
262  *  x = Bits_Entry_Level + 3
263  *    = IPA_SHIFT - (PAGE_SHIFT - 3) * n
264  *
265  * The only constraint here is that, we have to find the number of page table
266  * levels for a given IPA size (which we do, see stage2_pt_levels())
267  */
268 #define ARM64_VTTBR_X(ipa, levels)	((ipa) - ((levels) * (PAGE_SHIFT - 3)))
269 
270 #define VTTBR_CNP_BIT     (UL(1))
271 #define VTTBR_VMID_SHIFT  (UL(48))
272 #define VTTBR_VMID_MASK(size) (_AT(u64, (1 << size) - 1) << VTTBR_VMID_SHIFT)
273 
274 /* Hyp System Trap Register */
275 #define HSTR_EL2_T(x)	(1 << x)
276 
277 /* Hyp Coprocessor Trap Register Shifts */
278 #define CPTR_EL2_TFP_SHIFT 10
279 
280 /* Hyp Coprocessor Trap Register */
281 #define CPTR_EL2_TCPAC	(1U << 31)
282 #define CPTR_EL2_TAM	(1 << 30)
283 #define CPTR_EL2_TTA	(1 << 20)
284 #define CPTR_EL2_TSM	(1 << 12)
285 #define CPTR_EL2_TFP	(1 << CPTR_EL2_TFP_SHIFT)
286 #define CPTR_EL2_TZ	(1 << 8)
287 #define CPTR_NVHE_EL2_RES1	0x000032ff /* known RES1 bits in CPTR_EL2 (nVHE) */
288 #define CPTR_EL2_DEFAULT	CPTR_NVHE_EL2_RES1
289 #define CPTR_NVHE_EL2_RES0	(GENMASK(63, 32) |	\
290 				 GENMASK(29, 21) |	\
291 				 GENMASK(19, 14) |	\
292 				 BIT(11))
293 
294 /* Hyp Debug Configuration Register bits */
295 #define MDCR_EL2_E2TB_MASK	(UL(0x3))
296 #define MDCR_EL2_E2TB_SHIFT	(UL(24))
297 #define MDCR_EL2_HPMFZS		(UL(1) << 36)
298 #define MDCR_EL2_HPMFZO		(UL(1) << 29)
299 #define MDCR_EL2_MTPME		(UL(1) << 28)
300 #define MDCR_EL2_TDCC		(UL(1) << 27)
301 #define MDCR_EL2_HLP		(UL(1) << 26)
302 #define MDCR_EL2_HCCD		(UL(1) << 23)
303 #define MDCR_EL2_TTRF		(UL(1) << 19)
304 #define MDCR_EL2_HPMD		(UL(1) << 17)
305 #define MDCR_EL2_TPMS		(UL(1) << 14)
306 #define MDCR_EL2_E2PB_MASK	(UL(0x3))
307 #define MDCR_EL2_E2PB_SHIFT	(UL(12))
308 #define MDCR_EL2_TDRA		(UL(1) << 11)
309 #define MDCR_EL2_TDOSA		(UL(1) << 10)
310 #define MDCR_EL2_TDA		(UL(1) << 9)
311 #define MDCR_EL2_TDE		(UL(1) << 8)
312 #define MDCR_EL2_HPME		(UL(1) << 7)
313 #define MDCR_EL2_TPM		(UL(1) << 6)
314 #define MDCR_EL2_TPMCR		(UL(1) << 5)
315 #define MDCR_EL2_HPMN_MASK	(UL(0x1F))
316 #define MDCR_EL2_RES0		(GENMASK(63, 37) |	\
317 				 GENMASK(35, 30) |	\
318 				 GENMASK(25, 24) |	\
319 				 GENMASK(22, 20) |	\
320 				 BIT(18) |		\
321 				 GENMASK(16, 15))
322 
323 /* Hyp Prefetch Fault Address Register (HPFAR/HDFAR) */
324 #define HPFAR_MASK	(~UL(0xf))
325 /*
326  * We have
327  *	PAR	[PA_Shift - 1	: 12] = PA	[PA_Shift - 1 : 12]
328  *	HPFAR	[PA_Shift - 9	: 4]  = FIPA	[PA_Shift - 1 : 12]
329  *
330  * Always assume 52 bit PA since at this point, we don't know how many PA bits
331  * the page table has been set up for. This should be safe since unused address
332  * bits in PAR are res0.
333  */
334 #define PAR_TO_HPFAR(par)		\
335 	(((par) & GENMASK_ULL(52 - 1, 12)) >> 8)
336 
337 #define ECN(x) { ESR_ELx_EC_##x, #x }
338 
339 #define kvm_arm_exception_class \
340 	ECN(UNKNOWN), ECN(WFx), ECN(CP15_32), ECN(CP15_64), ECN(CP14_MR), \
341 	ECN(CP14_LS), ECN(FP_ASIMD), ECN(CP10_ID), ECN(PAC), ECN(CP14_64), \
342 	ECN(SVC64), ECN(HVC64), ECN(SMC64), ECN(SYS64), ECN(SVE), \
343 	ECN(IMP_DEF), ECN(IABT_LOW), ECN(IABT_CUR), \
344 	ECN(PC_ALIGN), ECN(DABT_LOW), ECN(DABT_CUR), \
345 	ECN(SP_ALIGN), ECN(FP_EXC32), ECN(FP_EXC64), ECN(SERROR), \
346 	ECN(BREAKPT_LOW), ECN(BREAKPT_CUR), ECN(SOFTSTP_LOW), \
347 	ECN(SOFTSTP_CUR), ECN(WATCHPT_LOW), ECN(WATCHPT_CUR), \
348 	ECN(BKPT32), ECN(VECTOR32), ECN(BRK64), ECN(ERET)
349 
350 #define CPACR_EL1_DEFAULT	(CPACR_EL1_FPEN_EL0EN | CPACR_EL1_FPEN_EL1EN |\
351 				 CPACR_EL1_ZEN_EL1EN)
352 
353 #define kvm_mode_names				\
354 	{ PSR_MODE_EL0t,	"EL0t" },	\
355 	{ PSR_MODE_EL1t,	"EL1t" },	\
356 	{ PSR_MODE_EL1h,	"EL1h" },	\
357 	{ PSR_MODE_EL2t,	"EL2t" },	\
358 	{ PSR_MODE_EL2h,	"EL2h" },	\
359 	{ PSR_MODE_EL3t,	"EL3t" },	\
360 	{ PSR_MODE_EL3h,	"EL3h" },	\
361 	{ PSR_AA32_MODE_USR,	"32-bit USR" },	\
362 	{ PSR_AA32_MODE_FIQ,	"32-bit FIQ" },	\
363 	{ PSR_AA32_MODE_IRQ,	"32-bit IRQ" },	\
364 	{ PSR_AA32_MODE_SVC,	"32-bit SVC" },	\
365 	{ PSR_AA32_MODE_ABT,	"32-bit ABT" },	\
366 	{ PSR_AA32_MODE_HYP,	"32-bit HYP" },	\
367 	{ PSR_AA32_MODE_UND,	"32-bit UND" },	\
368 	{ PSR_AA32_MODE_SYS,	"32-bit SYS" }
369 
370 #endif /* __ARM64_KVM_ARM_H__ */
371