blob: 470d1130078f1e9ebb79e401e34a32e74458852b [file] [log] [blame]
Achin Gupta9ac63c52014-01-16 12:08:03 +00001/*
Elizabeth Ho4fc00d22023-07-18 14:10:25 +01002 * Copyright (c) 2013-2023, Arm Limited and Contributors. All rights reserved.
Achin Gupta9ac63c52014-01-16 12:08:03 +00003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Achin Gupta9ac63c52014-01-16 12:08:03 +00005 */
6
Antonio Nino Diaz864ca6f2018-10-31 15:25:35 +00007#ifndef CONTEXT_H
8#define CONTEXT_H
Achin Gupta9ac63c52014-01-16 12:08:03 +00009
Elizabeth Ho4fc00d22023-07-18 14:10:25 +010010#include <lib/el3_runtime/cpu_data.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000011#include <lib/utils_def.h>
Jeenu Viswambharan96c7df02017-11-30 12:54:15 +000012
Achin Gupta9ac63c52014-01-16 12:08:03 +000013/*******************************************************************************
Achin Gupta07f4e072014-02-02 12:02:23 +000014 * Constants that allow assembler code to access members of and the 'gp_regs'
15 * structure at their correct offsets.
16 ******************************************************************************/
Varun Wadekarc6a11f62017-05-25 18:04:48 -070017#define CTX_GPREGS_OFFSET U(0x0)
18#define CTX_GPREG_X0 U(0x0)
19#define CTX_GPREG_X1 U(0x8)
20#define CTX_GPREG_X2 U(0x10)
21#define CTX_GPREG_X3 U(0x18)
22#define CTX_GPREG_X4 U(0x20)
23#define CTX_GPREG_X5 U(0x28)
24#define CTX_GPREG_X6 U(0x30)
25#define CTX_GPREG_X7 U(0x38)
26#define CTX_GPREG_X8 U(0x40)
27#define CTX_GPREG_X9 U(0x48)
28#define CTX_GPREG_X10 U(0x50)
29#define CTX_GPREG_X11 U(0x58)
30#define CTX_GPREG_X12 U(0x60)
31#define CTX_GPREG_X13 U(0x68)
32#define CTX_GPREG_X14 U(0x70)
33#define CTX_GPREG_X15 U(0x78)
34#define CTX_GPREG_X16 U(0x80)
35#define CTX_GPREG_X17 U(0x88)
36#define CTX_GPREG_X18 U(0x90)
37#define CTX_GPREG_X19 U(0x98)
38#define CTX_GPREG_X20 U(0xa0)
39#define CTX_GPREG_X21 U(0xa8)
40#define CTX_GPREG_X22 U(0xb0)
41#define CTX_GPREG_X23 U(0xb8)
42#define CTX_GPREG_X24 U(0xc0)
43#define CTX_GPREG_X25 U(0xc8)
44#define CTX_GPREG_X26 U(0xd0)
45#define CTX_GPREG_X27 U(0xd8)
46#define CTX_GPREG_X28 U(0xe0)
47#define CTX_GPREG_X29 U(0xe8)
48#define CTX_GPREG_LR U(0xf0)
49#define CTX_GPREG_SP_EL0 U(0xf8)
50#define CTX_GPREGS_END U(0x100)
Achin Gupta07f4e072014-02-02 12:02:23 +000051
52/*******************************************************************************
Achin Gupta9ac63c52014-01-16 12:08:03 +000053 * Constants that allow assembler code to access members of and the 'el3_state'
54 * structure at their correct offsets. Note that some of the registers are only
55 * 32-bits wide but are stored as 64-bit values for convenience
56 ******************************************************************************/
Dimitris Papastamosb63c6f12018-01-11 15:29:36 +000057#define CTX_EL3STATE_OFFSET (CTX_GPREGS_OFFSET + CTX_GPREGS_END)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070058#define CTX_SCR_EL3 U(0x0)
Jeenu Viswambharan96c7df02017-11-30 12:54:15 +000059#define CTX_ESR_EL3 U(0x8)
60#define CTX_RUNTIME_SP U(0x10)
61#define CTX_SPSR_EL3 U(0x18)
62#define CTX_ELR_EL3 U(0x20)
Alexei Fedorov503bbf32019-08-13 15:17:53 +010063#define CTX_PMCR_EL0 U(0x28)
Madhukar Pappireddyfba25722020-07-24 03:27:12 -050064#define CTX_IS_IN_EL3 U(0x30)
Elizabeth Ho4fc00d22023-07-18 14:10:25 +010065#define CTX_MPAM3_EL3 U(0x38)
66#define CTX_EL3STATE_END U(0x40) /* Align to the next 16 byte boundary */
Achin Gupta9ac63c52014-01-16 12:08:03 +000067
68/*******************************************************************************
69 * Constants that allow assembler code to access members of and the
70 * 'el1_sys_regs' structure at their correct offsets. Note that some of the
71 * registers are only 32-bits wide but are stored as 64-bit values for
72 * convenience
73 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +000074#define CTX_EL1_SYSREGS_OFFSET (CTX_EL3STATE_OFFSET + CTX_EL3STATE_END)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070075#define CTX_SPSR_EL1 U(0x0)
76#define CTX_ELR_EL1 U(0x8)
77#define CTX_SCTLR_EL1 U(0x10)
Manish V Badarkhe2b0ee972020-07-28 07:22:30 +010078#define CTX_TCR_EL1 U(0x18)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070079#define CTX_CPACR_EL1 U(0x20)
80#define CTX_CSSELR_EL1 U(0x28)
81#define CTX_SP_EL1 U(0x30)
82#define CTX_ESR_EL1 U(0x38)
83#define CTX_TTBR0_EL1 U(0x40)
84#define CTX_TTBR1_EL1 U(0x48)
85#define CTX_MAIR_EL1 U(0x50)
86#define CTX_AMAIR_EL1 U(0x58)
Manish V Badarkhe2b0ee972020-07-28 07:22:30 +010087#define CTX_ACTLR_EL1 U(0x60)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070088#define CTX_TPIDR_EL1 U(0x68)
89#define CTX_TPIDR_EL0 U(0x70)
90#define CTX_TPIDRRO_EL0 U(0x78)
91#define CTX_PAR_EL1 U(0x80)
92#define CTX_FAR_EL1 U(0x88)
93#define CTX_AFSR0_EL1 U(0x90)
94#define CTX_AFSR1_EL1 U(0x98)
95#define CTX_CONTEXTIDR_EL1 U(0xa0)
96#define CTX_VBAR_EL1 U(0xa8)
Soby Mathewd75d2ba2016-05-17 14:01:32 +010097
98/*
99 * If the platform is AArch64-only, there is no need to save and restore these
100 * AArch32 registers.
101 */
102#if CTX_INCLUDE_AARCH32_REGS
Alexei Fedorov503bbf32019-08-13 15:17:53 +0100103#define CTX_SPSR_ABT U(0xb0) /* Align to the next 16 byte boundary */
104#define CTX_SPSR_UND U(0xb8)
105#define CTX_SPSR_IRQ U(0xc0)
106#define CTX_SPSR_FIQ U(0xc8)
107#define CTX_DACR32_EL2 U(0xd0)
108#define CTX_IFSR32_EL2 U(0xd8)
109#define CTX_AARCH32_END U(0xe0) /* Align to the next 16 byte boundary */
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100110#else
Alexei Fedorov503bbf32019-08-13 15:17:53 +0100111#define CTX_AARCH32_END U(0xb0) /* Align to the next 16 byte boundary */
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000112#endif /* CTX_INCLUDE_AARCH32_REGS */
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100113
Jeenu Viswambharand1b60152014-05-12 15:28:47 +0100114/*
115 * If the timer registers aren't saved and restored, we don't have to reserve
116 * space for them in the context
117 */
118#if NS_TIMER_SWITCH
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000119#define CTX_CNTP_CTL_EL0 (CTX_AARCH32_END + U(0x0))
120#define CTX_CNTP_CVAL_EL0 (CTX_AARCH32_END + U(0x8))
121#define CTX_CNTV_CTL_EL0 (CTX_AARCH32_END + U(0x10))
122#define CTX_CNTV_CVAL_EL0 (CTX_AARCH32_END + U(0x18))
123#define CTX_CNTKCTL_EL1 (CTX_AARCH32_END + U(0x20))
124#define CTX_TIMER_SYSREGS_END (CTX_AARCH32_END + U(0x30)) /* Align to the next 16 byte boundary */
Jeenu Viswambharand1b60152014-05-12 15:28:47 +0100125#else
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000126#define CTX_TIMER_SYSREGS_END CTX_AARCH32_END
127#endif /* NS_TIMER_SWITCH */
128
Justin Chadwell1c7c13a2019-07-18 14:25:33 +0100129#if CTX_INCLUDE_MTE_REGS
130#define CTX_TFSRE0_EL1 (CTX_TIMER_SYSREGS_END + U(0x0))
131#define CTX_TFSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x8))
132#define CTX_RGSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x10))
133#define CTX_GCR_EL1 (CTX_TIMER_SYSREGS_END + U(0x18))
134
135/* Align to the next 16 byte boundary */
136#define CTX_MTE_REGS_END (CTX_TIMER_SYSREGS_END + U(0x20))
137#else
138#define CTX_MTE_REGS_END CTX_TIMER_SYSREGS_END
139#endif /* CTX_INCLUDE_MTE_REGS */
140
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000141/*
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000142 * End of system registers.
143 */
144#define CTX_EL1_SYSREGS_END CTX_MTE_REGS_END
145
146/*
147 * EL2 register set
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000148 */
149
150#if CTX_INCLUDE_EL2_REGS
151/* For later discussion
152 * ICH_AP0R<n>_EL2
153 * ICH_AP1R<n>_EL2
154 * AMEVCNTVOFF0<n>_EL2
155 * AMEVCNTVOFF1<n>_EL2
156 * ICH_LR<n>_EL2
157 */
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000158#define CTX_EL2_SYSREGS_OFFSET (CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
159
160#define CTX_ACTLR_EL2 U(0x0)
161#define CTX_AFSR0_EL2 U(0x8)
162#define CTX_AFSR1_EL2 U(0x10)
163#define CTX_AMAIR_EL2 U(0x18)
164#define CTX_CNTHCTL_EL2 U(0x20)
Max Shvetsovcf784f72021-03-31 19:00:38 +0100165#define CTX_CNTVOFF_EL2 U(0x28)
166#define CTX_CPTR_EL2 U(0x30)
167#define CTX_DBGVCR32_EL2 U(0x38)
168#define CTX_ELR_EL2 U(0x40)
169#define CTX_ESR_EL2 U(0x48)
170#define CTX_FAR_EL2 U(0x50)
171#define CTX_HACR_EL2 U(0x58)
172#define CTX_HCR_EL2 U(0x60)
173#define CTX_HPFAR_EL2 U(0x68)
174#define CTX_HSTR_EL2 U(0x70)
175#define CTX_ICC_SRE_EL2 U(0x78)
176#define CTX_ICH_HCR_EL2 U(0x80)
177#define CTX_ICH_VMCR_EL2 U(0x88)
178#define CTX_MAIR_EL2 U(0x90)
179#define CTX_MDCR_EL2 U(0x98)
180#define CTX_PMSCR_EL2 U(0xa0)
181#define CTX_SCTLR_EL2 U(0xa8)
182#define CTX_SPSR_EL2 U(0xb0)
183#define CTX_SP_EL2 U(0xb8)
184#define CTX_TCR_EL2 U(0xc0)
185#define CTX_TPIDR_EL2 U(0xc8)
186#define CTX_TTBR0_EL2 U(0xd0)
187#define CTX_VBAR_EL2 U(0xd8)
188#define CTX_VMPIDR_EL2 U(0xe0)
189#define CTX_VPIDR_EL2 U(0xe8)
190#define CTX_VTCR_EL2 U(0xf0)
191#define CTX_VTTBR_EL2 U(0xf8)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000192
193// Only if MTE registers in use
Max Shvetsovcf784f72021-03-31 19:00:38 +0100194#define CTX_TFSR_EL2 U(0x100)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000195
Max Shvetsovcf784f72021-03-31 19:00:38 +0100196#define CTX_MPAM2_EL2 U(0x108)
197#define CTX_MPAMHCR_EL2 U(0x110)
198#define CTX_MPAMVPM0_EL2 U(0x118)
199#define CTX_MPAMVPM1_EL2 U(0x120)
200#define CTX_MPAMVPM2_EL2 U(0x128)
201#define CTX_MPAMVPM3_EL2 U(0x130)
202#define CTX_MPAMVPM4_EL2 U(0x138)
203#define CTX_MPAMVPM5_EL2 U(0x140)
204#define CTX_MPAMVPM6_EL2 U(0x148)
205#define CTX_MPAMVPM7_EL2 U(0x150)
206#define CTX_MPAMVPMV_EL2 U(0x158)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000207
208// Starting with Armv8.6
Jayanth Dodderi Chidanand13ae0f42021-11-25 14:59:30 +0000209#define CTX_HDFGRTR_EL2 U(0x160)
210#define CTX_HAFGRTR_EL2 U(0x168)
Max Shvetsovcf784f72021-03-31 19:00:38 +0100211#define CTX_HDFGWTR_EL2 U(0x170)
212#define CTX_HFGITR_EL2 U(0x178)
213#define CTX_HFGRTR_EL2 U(0x180)
214#define CTX_HFGWTR_EL2 U(0x188)
215#define CTX_CNTPOFF_EL2 U(0x190)
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000216
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000217// Starting with Armv8.4
Max Shvetsovcf784f72021-03-31 19:00:38 +0100218#define CTX_CONTEXTIDR_EL2 U(0x198)
Jayanth Dodderi Chidanand72b69b82022-01-26 17:14:43 +0000219#define CTX_TTBR1_EL2 U(0x1a0)
220#define CTX_VDISR_EL2 U(0x1a8)
221#define CTX_VSESR_EL2 U(0x1b0)
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500222#define CTX_VNCR_EL2 U(0x1b8)
223#define CTX_TRFCR_EL2 U(0x1c0)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000224
225// Starting with Armv8.5
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500226#define CTX_SCXTNUM_EL2 U(0x1c8)
johpow01f91e59f2021-08-04 19:38:18 -0500227
228// Register for FEAT_HCX
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500229#define CTX_HCRX_EL2 U(0x1d0)
johpow01f91e59f2021-08-04 19:38:18 -0500230
Mark Brownc37eee72023-03-14 20:13:03 +0000231// Starting with Armv8.9
232#define CTX_TCR2_EL2 U(0x1d8)
Mark Brown293a6612023-03-14 20:48:43 +0000233#define CTX_POR_EL2 U(0x1e0)
234#define CTX_PIRE0_EL2 U(0x1e8)
235#define CTX_PIR_EL2 U(0x1f0)
236#define CTX_S2PIR_EL2 U(0x1f8)
Mark Brown326f2952023-03-14 21:33:04 +0000237#define CTX_GCSCR_EL2 U(0x200)
238#define CTX_GCSPR_EL2 U(0x208)
Mark Brownc37eee72023-03-14 20:13:03 +0000239
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000240/* Align to the next 16 byte boundary */
Mark Brown326f2952023-03-14 21:33:04 +0000241#define CTX_EL2_SYSREGS_END U(0x210)
Olivier Deprez19628912020-03-20 14:22:05 +0100242
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000243#endif /* CTX_INCLUDE_EL2_REGS */
244
Achin Gupta9ac63c52014-01-16 12:08:03 +0000245/*******************************************************************************
246 * Constants that allow assembler code to access members of and the 'fp_regs'
247 * structure at their correct offsets.
248 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000249#if CTX_INCLUDE_EL2_REGS
250# define CTX_FPREGS_OFFSET (CTX_EL2_SYSREGS_OFFSET + CTX_EL2_SYSREGS_END)
251#else
252# define CTX_FPREGS_OFFSET (CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
253#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100254#if CTX_INCLUDE_FPREGS
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700255#define CTX_FP_Q0 U(0x0)
256#define CTX_FP_Q1 U(0x10)
257#define CTX_FP_Q2 U(0x20)
258#define CTX_FP_Q3 U(0x30)
259#define CTX_FP_Q4 U(0x40)
260#define CTX_FP_Q5 U(0x50)
261#define CTX_FP_Q6 U(0x60)
262#define CTX_FP_Q7 U(0x70)
263#define CTX_FP_Q8 U(0x80)
264#define CTX_FP_Q9 U(0x90)
265#define CTX_FP_Q10 U(0xa0)
266#define CTX_FP_Q11 U(0xb0)
267#define CTX_FP_Q12 U(0xc0)
268#define CTX_FP_Q13 U(0xd0)
269#define CTX_FP_Q14 U(0xe0)
270#define CTX_FP_Q15 U(0xf0)
271#define CTX_FP_Q16 U(0x100)
272#define CTX_FP_Q17 U(0x110)
273#define CTX_FP_Q18 U(0x120)
274#define CTX_FP_Q19 U(0x130)
275#define CTX_FP_Q20 U(0x140)
276#define CTX_FP_Q21 U(0x150)
277#define CTX_FP_Q22 U(0x160)
278#define CTX_FP_Q23 U(0x170)
279#define CTX_FP_Q24 U(0x180)
280#define CTX_FP_Q25 U(0x190)
281#define CTX_FP_Q26 U(0x1a0)
282#define CTX_FP_Q27 U(0x1b0)
283#define CTX_FP_Q28 U(0x1c0)
284#define CTX_FP_Q29 U(0x1d0)
285#define CTX_FP_Q30 U(0x1e0)
286#define CTX_FP_Q31 U(0x1f0)
287#define CTX_FP_FPSR U(0x200)
288#define CTX_FP_FPCR U(0x208)
David Cunadod1a1fd42017-10-20 11:30:57 +0100289#if CTX_INCLUDE_AARCH32_REGS
290#define CTX_FP_FPEXC32_EL2 U(0x210)
291#define CTX_FPREGS_END U(0x220) /* Align to the next 16 byte boundary */
292#else
293#define CTX_FPREGS_END U(0x210) /* Align to the next 16 byte boundary */
294#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100295#else
296#define CTX_FPREGS_END U(0)
Juan Castillo258e94f2014-06-25 17:26:36 +0100297#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000298
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000299/*******************************************************************************
300 * Registers related to CVE-2018-3639
301 ******************************************************************************/
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100302#define CTX_CVE_2018_3639_OFFSET (CTX_FPREGS_OFFSET + CTX_FPREGS_END)
303#define CTX_CVE_2018_3639_DISABLE U(0)
304#define CTX_CVE_2018_3639_END U(0x10) /* Align to the next 16 byte boundary */
305
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000306/*******************************************************************************
307 * Registers related to ARMv8.3-PAuth.
308 ******************************************************************************/
309#define CTX_PAUTH_REGS_OFFSET (CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
310#if CTX_INCLUDE_PAUTH_REGS
311#define CTX_PACIAKEY_LO U(0x0)
312#define CTX_PACIAKEY_HI U(0x8)
313#define CTX_PACIBKEY_LO U(0x10)
314#define CTX_PACIBKEY_HI U(0x18)
315#define CTX_PACDAKEY_LO U(0x20)
316#define CTX_PACDAKEY_HI U(0x28)
317#define CTX_PACDBKEY_LO U(0x30)
318#define CTX_PACDBKEY_HI U(0x38)
319#define CTX_PACGAKEY_LO U(0x40)
320#define CTX_PACGAKEY_HI U(0x48)
Alexei Fedorovf41355c2019-09-13 14:11:59 +0100321#define CTX_PAUTH_REGS_END U(0x50) /* Align to the next 16 byte boundary */
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000322#else
323#define CTX_PAUTH_REGS_END U(0)
324#endif /* CTX_INCLUDE_PAUTH_REGS */
325
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100326/*******************************************************************************
327 * Registers initialised in a per-world context.
328 ******************************************************************************/
329#define CTX_CPTR_EL3 U(0x0)
330#define CTX_ZCR_EL3 U(0x8)
331#define CTX_GLOBAL_EL3STATE_END U(0x10)
332
Julius Werner53456fc2019-07-09 13:49:11 -0700333#ifndef __ASSEMBLER__
Achin Gupta9ac63c52014-01-16 12:08:03 +0000334
Dan Handley2bd4ef22014-04-09 13:14:54 +0100335#include <stdint.h>
336
Antonio Nino Diaze0f90632018-12-14 00:18:21 +0000337#include <lib/cassert.h>
338
Achin Gupta9ac63c52014-01-16 12:08:03 +0000339/*
340 * Common constants to help define the 'cpu_context' structure and its
341 * members below.
342 */
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700343#define DWORD_SHIFT U(3)
Achin Gupta9ac63c52014-01-16 12:08:03 +0000344#define DEFINE_REG_STRUCT(name, num_regs) \
Dan Handleye2712bc2014-04-10 15:37:22 +0100345 typedef struct name { \
Zelalem91d80612020-02-12 10:37:03 -0600346 uint64_t ctx_regs[num_regs]; \
Dan Handleye2712bc2014-04-10 15:37:22 +0100347 } __aligned(16) name##_t
Achin Gupta9ac63c52014-01-16 12:08:03 +0000348
349/* Constants to determine the size of individual context structures */
Achin Gupta07f4e072014-02-02 12:02:23 +0000350#define CTX_GPREG_ALL (CTX_GPREGS_END >> DWORD_SHIFT)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000351#define CTX_EL1_SYSREGS_ALL (CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
352#if CTX_INCLUDE_EL2_REGS
353# define CTX_EL2_SYSREGS_ALL (CTX_EL2_SYSREGS_END >> DWORD_SHIFT)
354#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100355#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000356# define CTX_FPREG_ALL (CTX_FPREGS_END >> DWORD_SHIFT)
Juan Castillo258e94f2014-06-25 17:26:36 +0100357#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000358#define CTX_EL3STATE_ALL (CTX_EL3STATE_END >> DWORD_SHIFT)
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100359#define CTX_CVE_2018_3639_ALL (CTX_CVE_2018_3639_END >> DWORD_SHIFT)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000360#if CTX_INCLUDE_PAUTH_REGS
361# define CTX_PAUTH_REGS_ALL (CTX_PAUTH_REGS_END >> DWORD_SHIFT)
362#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000363
364/*
Soby Mathew6c5192a2014-04-30 15:36:37 +0100365 * AArch64 general purpose register context structure. Usually x0-x18,
366 * lr are saved as the compiler is expected to preserve the remaining
Achin Gupta07f4e072014-02-02 12:02:23 +0000367 * callee saved registers if used by the C runtime and the assembler
Soby Mathew6c5192a2014-04-30 15:36:37 +0100368 * does not touch the remaining. But in case of world switch during
369 * exception handling, we need to save the callee registers too.
Achin Gupta07f4e072014-02-02 12:02:23 +0000370 */
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000371DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
Achin Gupta07f4e072014-02-02 12:02:23 +0000372
373/*
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000374 * AArch64 EL1 system register context structure for preserving the
375 * architectural state during world switches.
376 */
377DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
378
379
380/*
381 * AArch64 EL2 system register context structure for preserving the
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000382 * architectural state during world switches.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000383 */
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000384#if CTX_INCLUDE_EL2_REGS
385DEFINE_REG_STRUCT(el2_sysregs, CTX_EL2_SYSREGS_ALL);
386#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000387
388/*
389 * AArch64 floating point register context structure for preserving
390 * the floating point state during switches from one security state to
391 * another.
392 */
Juan Castillo258e94f2014-06-25 17:26:36 +0100393#if CTX_INCLUDE_FPREGS
Achin Gupta9ac63c52014-01-16 12:08:03 +0000394DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
Juan Castillo258e94f2014-06-25 17:26:36 +0100395#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000396
397/*
398 * Miscellaneous registers used by EL3 firmware to maintain its state
399 * across exception entries and exits
400 */
401DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
402
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100403/* Function pointer used by CVE-2018-3639 dynamic mitigation */
404DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
405
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000406/* Registers associated to ARMv8.3-PAuth */
407#if CTX_INCLUDE_PAUTH_REGS
408DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
409#endif
410
Achin Gupta9ac63c52014-01-16 12:08:03 +0000411/*
412 * Macros to access members of any of the above structures using their
413 * offsets
414 */
Zelalem91d80612020-02-12 10:37:03 -0600415#define read_ctx_reg(ctx, offset) ((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
416#define write_ctx_reg(ctx, offset, val) (((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100417 = (uint64_t) (val))
Achin Gupta9ac63c52014-01-16 12:08:03 +0000418
419/*
Zelalem Awekeb6301e62021-07-09 17:54:30 -0500420 * Top-level context structure which is used by EL3 firmware to preserve
421 * the state of a core at the next lower EL in a given security state and
422 * save enough EL3 meta data to be able to return to that EL and security
423 * state. The context management library will be used to ensure that
424 * SP_EL3 always points to an instance of this structure at exception
425 * entry and exit.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000426 */
Dan Handleye2712bc2014-04-10 15:37:22 +0100427typedef struct cpu_context {
428 gp_regs_t gpregs_ctx;
429 el3_state_t el3state_ctx;
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000430 el1_sysregs_t el1_sysregs_ctx;
431#if CTX_INCLUDE_EL2_REGS
432 el2_sysregs_t el2_sysregs_ctx;
433#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100434#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100435 fp_regs_t fpregs_ctx;
Juan Castillo258e94f2014-06-25 17:26:36 +0100436#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100437 cve_2018_3639_t cve_2018_3639_ctx;
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000438#if CTX_INCLUDE_PAUTH_REGS
439 pauth_t pauth_ctx;
440#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100441} cpu_context_t;
Achin Gupta9ac63c52014-01-16 12:08:03 +0000442
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100443/*
444 * Per-World Context.
445 * It stores registers whose values can be shared across CPUs.
446 */
447typedef struct per_world_context {
448 uint64_t ctx_cptr_el3;
449 uint64_t ctx_zcr_el3;
450} per_world_context_t;
451
452extern per_world_context_t per_world_context[CPU_DATA_CONTEXT_NUM];
453
Dan Handleye2712bc2014-04-10 15:37:22 +0100454/* Macros to access members of the 'cpu_context_t' structure */
455#define get_el3state_ctx(h) (&((cpu_context_t *) h)->el3state_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100456#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000457# define get_fpregs_ctx(h) (&((cpu_context_t *) h)->fpregs_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100458#endif
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000459#define get_el1_sysregs_ctx(h) (&((cpu_context_t *) h)->el1_sysregs_ctx)
460#if CTX_INCLUDE_EL2_REGS
461# define get_el2_sysregs_ctx(h) (&((cpu_context_t *) h)->el2_sysregs_ctx)
462#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100463#define get_gpregs_ctx(h) (&((cpu_context_t *) h)->gpregs_ctx)
Dimitris Papastamosbb1fd5b2018-06-07 11:29:15 +0100464#define get_cve_2018_3639_ctx(h) (&((cpu_context_t *) h)->cve_2018_3639_ctx)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000465#if CTX_INCLUDE_PAUTH_REGS
466# define get_pauth_ctx(h) (&((cpu_context_t *) h)->pauth_ctx)
467#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000468
469/*
470 * Compile time assertions related to the 'cpu_context' structure to
471 * ensure that the assembler and the compiler view of the offsets of
472 * the structure members is the same.
473 */
Elyes Haouas183638f2023-02-13 10:05:41 +0100474CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx),
Achin Gupta07f4e072014-02-02 12:02:23 +0000475 assert_core_context_gp_offset_mismatch);
Elyes Haouas183638f2023-02-13 10:05:41 +0100476CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx),
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000477 assert_core_context_el1_sys_offset_mismatch);
478#if CTX_INCLUDE_EL2_REGS
Elyes Haouas183638f2023-02-13 10:05:41 +0100479CASSERT(CTX_EL2_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el2_sysregs_ctx),
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000480 assert_core_context_el2_sys_offset_mismatch);
481#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100482#if CTX_INCLUDE_FPREGS
Elyes Haouas183638f2023-02-13 10:05:41 +0100483CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx),
Achin Gupta9ac63c52014-01-16 12:08:03 +0000484 assert_core_context_fp_offset_mismatch);
Juan Castillo258e94f2014-06-25 17:26:36 +0100485#endif
Elyes Haouas183638f2023-02-13 10:05:41 +0100486CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx),
Achin Gupta9ac63c52014-01-16 12:08:03 +0000487 assert_core_context_el3state_offset_mismatch);
Elyes Haouas183638f2023-02-13 10:05:41 +0100488CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx),
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100489 assert_core_context_cve_2018_3639_offset_mismatch);
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000490#if CTX_INCLUDE_PAUTH_REGS
Elyes Haouas183638f2023-02-13 10:05:41 +0100491CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx),
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000492 assert_core_context_pauth_offset_mismatch);
493#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000494
Achin Gupta607084e2014-02-09 18:24:19 +0000495/*
496 * Helper macro to set the general purpose registers that correspond to
497 * parameters in an aapcs_64 call i.e. x0-x7
498 */
499#define set_aapcs_args0(ctx, x0) do { \
500 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100501 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000502#define set_aapcs_args1(ctx, x0, x1) do { \
503 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1); \
504 set_aapcs_args0(ctx, x0); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100505 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000506#define set_aapcs_args2(ctx, x0, x1, x2) do { \
507 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2); \
508 set_aapcs_args1(ctx, x0, x1); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100509 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000510#define set_aapcs_args3(ctx, x0, x1, x2, x3) do { \
511 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3); \
512 set_aapcs_args2(ctx, x0, x1, x2); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100513 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000514#define set_aapcs_args4(ctx, x0, x1, x2, x3, x4) do { \
515 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4); \
516 set_aapcs_args3(ctx, x0, x1, x2, x3); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100517 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000518#define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5) do { \
519 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5); \
520 set_aapcs_args4(ctx, x0, x1, x2, x3, x4); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100521 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000522#define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6) do { \
523 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6); \
524 set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100525 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000526#define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7) do { \
527 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7); \
528 set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100529 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000530
Achin Gupta9ac63c52014-01-16 12:08:03 +0000531/*******************************************************************************
532 * Function prototypes
533 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000534void el1_sysregs_context_save(el1_sysregs_t *regs);
535void el1_sysregs_context_restore(el1_sysregs_t *regs);
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000536
Juan Castillo258e94f2014-06-25 17:26:36 +0100537#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100538void fpregs_context_save(fp_regs_t *regs);
539void fpregs_context_restore(fp_regs_t *regs);
Juan Castillo258e94f2014-06-25 17:26:36 +0100540#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000541
Julius Werner53456fc2019-07-09 13:49:11 -0700542#endif /* __ASSEMBLER__ */
Achin Gupta9ac63c52014-01-16 12:08:03 +0000543
Antonio Nino Diaz864ca6f2018-10-31 15:25:35 +0000544#endif /* CONTEXT_H */