blob: 215156bcbeba9ef0de8da7d3b7ef0bc1eae03053 [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)
Manish Pandey07952fb2023-05-25 13:46:14 +010065/* Constants required in supporting nested exception in EL3 */
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -060066#define CTX_SAVED_ELR_EL3 U(0x38)
Manish Pandey07952fb2023-05-25 13:46:14 +010067/*
68 * General purpose flag, to save various EL3 states
69 * FFH mode : Used to identify if handling nested exception
70 * KFH mode : Used as counter value
71 */
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -060072#define CTX_NESTED_EA_FLAG U(0x40)
Manish Pandeyf90a73c2023-10-10 15:42:19 +010073#if FFH_SUPPORT
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -060074 #define CTX_SAVED_ESR_EL3 U(0x48)
75 #define CTX_SAVED_SPSR_EL3 U(0x50)
76 #define CTX_SAVED_GPREG_LR U(0x58)
77 #define CTX_EL3STATE_END U(0x60) /* Align to the next 16 byte boundary */
Manish Pandey07952fb2023-05-25 13:46:14 +010078#else
79 #define CTX_EL3STATE_END U(0x50) /* Align to the next 16 byte boundary */
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -060080#endif /* FFH_SUPPORT */
Achin Gupta9ac63c52014-01-16 12:08:03 +000081
82/*******************************************************************************
83 * Constants that allow assembler code to access members of and the
84 * 'el1_sys_regs' structure at their correct offsets. Note that some of the
85 * registers are only 32-bits wide but are stored as 64-bit values for
86 * convenience
87 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +000088#define CTX_EL1_SYSREGS_OFFSET (CTX_EL3STATE_OFFSET + CTX_EL3STATE_END)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070089#define CTX_SPSR_EL1 U(0x0)
90#define CTX_ELR_EL1 U(0x8)
91#define CTX_SCTLR_EL1 U(0x10)
Manish V Badarkhe2b0ee972020-07-28 07:22:30 +010092#define CTX_TCR_EL1 U(0x18)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070093#define CTX_CPACR_EL1 U(0x20)
94#define CTX_CSSELR_EL1 U(0x28)
95#define CTX_SP_EL1 U(0x30)
96#define CTX_ESR_EL1 U(0x38)
97#define CTX_TTBR0_EL1 U(0x40)
98#define CTX_TTBR1_EL1 U(0x48)
99#define CTX_MAIR_EL1 U(0x50)
100#define CTX_AMAIR_EL1 U(0x58)
Manish V Badarkhe2b0ee972020-07-28 07:22:30 +0100101#define CTX_ACTLR_EL1 U(0x60)
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700102#define CTX_TPIDR_EL1 U(0x68)
103#define CTX_TPIDR_EL0 U(0x70)
104#define CTX_TPIDRRO_EL0 U(0x78)
105#define CTX_PAR_EL1 U(0x80)
106#define CTX_FAR_EL1 U(0x88)
107#define CTX_AFSR0_EL1 U(0x90)
108#define CTX_AFSR1_EL1 U(0x98)
109#define CTX_CONTEXTIDR_EL1 U(0xa0)
110#define CTX_VBAR_EL1 U(0xa8)
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100111
112/*
113 * If the platform is AArch64-only, there is no need to save and restore these
114 * AArch32 registers.
115 */
116#if CTX_INCLUDE_AARCH32_REGS
Alexei Fedorov503bbf32019-08-13 15:17:53 +0100117#define CTX_SPSR_ABT U(0xb0) /* Align to the next 16 byte boundary */
118#define CTX_SPSR_UND U(0xb8)
119#define CTX_SPSR_IRQ U(0xc0)
120#define CTX_SPSR_FIQ U(0xc8)
121#define CTX_DACR32_EL2 U(0xd0)
122#define CTX_IFSR32_EL2 U(0xd8)
123#define CTX_AARCH32_END U(0xe0) /* Align to the next 16 byte boundary */
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100124#else
Alexei Fedorov503bbf32019-08-13 15:17:53 +0100125#define CTX_AARCH32_END U(0xb0) /* Align to the next 16 byte boundary */
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000126#endif /* CTX_INCLUDE_AARCH32_REGS */
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100127
Jeenu Viswambharand1b60152014-05-12 15:28:47 +0100128/*
129 * If the timer registers aren't saved and restored, we don't have to reserve
130 * space for them in the context
131 */
132#if NS_TIMER_SWITCH
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000133#define CTX_CNTP_CTL_EL0 (CTX_AARCH32_END + U(0x0))
134#define CTX_CNTP_CVAL_EL0 (CTX_AARCH32_END + U(0x8))
135#define CTX_CNTV_CTL_EL0 (CTX_AARCH32_END + U(0x10))
136#define CTX_CNTV_CVAL_EL0 (CTX_AARCH32_END + U(0x18))
137#define CTX_CNTKCTL_EL1 (CTX_AARCH32_END + U(0x20))
138#define CTX_TIMER_SYSREGS_END (CTX_AARCH32_END + U(0x30)) /* Align to the next 16 byte boundary */
Jeenu Viswambharand1b60152014-05-12 15:28:47 +0100139#else
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000140#define CTX_TIMER_SYSREGS_END CTX_AARCH32_END
141#endif /* NS_TIMER_SWITCH */
142
Justin Chadwell1c7c13a2019-07-18 14:25:33 +0100143#if CTX_INCLUDE_MTE_REGS
144#define CTX_TFSRE0_EL1 (CTX_TIMER_SYSREGS_END + U(0x0))
145#define CTX_TFSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x8))
146#define CTX_RGSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x10))
147#define CTX_GCR_EL1 (CTX_TIMER_SYSREGS_END + U(0x18))
148
149/* Align to the next 16 byte boundary */
150#define CTX_MTE_REGS_END (CTX_TIMER_SYSREGS_END + U(0x20))
151#else
152#define CTX_MTE_REGS_END CTX_TIMER_SYSREGS_END
153#endif /* CTX_INCLUDE_MTE_REGS */
154
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000155/*
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000156 * End of system registers.
157 */
158#define CTX_EL1_SYSREGS_END CTX_MTE_REGS_END
159
160/*
161 * EL2 register set
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000162 */
163
164#if CTX_INCLUDE_EL2_REGS
165/* For later discussion
166 * ICH_AP0R<n>_EL2
167 * ICH_AP1R<n>_EL2
168 * AMEVCNTVOFF0<n>_EL2
169 * AMEVCNTVOFF1<n>_EL2
170 * ICH_LR<n>_EL2
171 */
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000172#define CTX_EL2_SYSREGS_OFFSET (CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
173
174#define CTX_ACTLR_EL2 U(0x0)
175#define CTX_AFSR0_EL2 U(0x8)
176#define CTX_AFSR1_EL2 U(0x10)
177#define CTX_AMAIR_EL2 U(0x18)
178#define CTX_CNTHCTL_EL2 U(0x20)
Max Shvetsovcf784f72021-03-31 19:00:38 +0100179#define CTX_CNTVOFF_EL2 U(0x28)
180#define CTX_CPTR_EL2 U(0x30)
181#define CTX_DBGVCR32_EL2 U(0x38)
182#define CTX_ELR_EL2 U(0x40)
183#define CTX_ESR_EL2 U(0x48)
184#define CTX_FAR_EL2 U(0x50)
185#define CTX_HACR_EL2 U(0x58)
186#define CTX_HCR_EL2 U(0x60)
187#define CTX_HPFAR_EL2 U(0x68)
188#define CTX_HSTR_EL2 U(0x70)
189#define CTX_ICC_SRE_EL2 U(0x78)
190#define CTX_ICH_HCR_EL2 U(0x80)
191#define CTX_ICH_VMCR_EL2 U(0x88)
192#define CTX_MAIR_EL2 U(0x90)
193#define CTX_MDCR_EL2 U(0x98)
194#define CTX_PMSCR_EL2 U(0xa0)
195#define CTX_SCTLR_EL2 U(0xa8)
196#define CTX_SPSR_EL2 U(0xb0)
197#define CTX_SP_EL2 U(0xb8)
198#define CTX_TCR_EL2 U(0xc0)
199#define CTX_TPIDR_EL2 U(0xc8)
200#define CTX_TTBR0_EL2 U(0xd0)
201#define CTX_VBAR_EL2 U(0xd8)
202#define CTX_VMPIDR_EL2 U(0xe0)
203#define CTX_VPIDR_EL2 U(0xe8)
204#define CTX_VTCR_EL2 U(0xf0)
205#define CTX_VTTBR_EL2 U(0xf8)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000206
207// Only if MTE registers in use
Max Shvetsovcf784f72021-03-31 19:00:38 +0100208#define CTX_TFSR_EL2 U(0x100)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000209
Max Shvetsovcf784f72021-03-31 19:00:38 +0100210#define CTX_MPAM2_EL2 U(0x108)
211#define CTX_MPAMHCR_EL2 U(0x110)
212#define CTX_MPAMVPM0_EL2 U(0x118)
213#define CTX_MPAMVPM1_EL2 U(0x120)
214#define CTX_MPAMVPM2_EL2 U(0x128)
215#define CTX_MPAMVPM3_EL2 U(0x130)
216#define CTX_MPAMVPM4_EL2 U(0x138)
217#define CTX_MPAMVPM5_EL2 U(0x140)
218#define CTX_MPAMVPM6_EL2 U(0x148)
219#define CTX_MPAMVPM7_EL2 U(0x150)
220#define CTX_MPAMVPMV_EL2 U(0x158)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000221
222// Starting with Armv8.6
Jayanth Dodderi Chidanand13ae0f42021-11-25 14:59:30 +0000223#define CTX_HDFGRTR_EL2 U(0x160)
224#define CTX_HAFGRTR_EL2 U(0x168)
Max Shvetsovcf784f72021-03-31 19:00:38 +0100225#define CTX_HDFGWTR_EL2 U(0x170)
226#define CTX_HFGITR_EL2 U(0x178)
227#define CTX_HFGRTR_EL2 U(0x180)
228#define CTX_HFGWTR_EL2 U(0x188)
229#define CTX_CNTPOFF_EL2 U(0x190)
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000230
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000231// Starting with Armv8.4
Max Shvetsovcf784f72021-03-31 19:00:38 +0100232#define CTX_CONTEXTIDR_EL2 U(0x198)
Jayanth Dodderi Chidanand72b69b82022-01-26 17:14:43 +0000233#define CTX_TTBR1_EL2 U(0x1a0)
234#define CTX_VDISR_EL2 U(0x1a8)
235#define CTX_VSESR_EL2 U(0x1b0)
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500236#define CTX_VNCR_EL2 U(0x1b8)
237#define CTX_TRFCR_EL2 U(0x1c0)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000238
239// Starting with Armv8.5
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500240#define CTX_SCXTNUM_EL2 U(0x1c8)
johpow01f91e59f2021-08-04 19:38:18 -0500241
242// Register for FEAT_HCX
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500243#define CTX_HCRX_EL2 U(0x1d0)
johpow01f91e59f2021-08-04 19:38:18 -0500244
Mark Brownc37eee72023-03-14 20:13:03 +0000245// Starting with Armv8.9
246#define CTX_TCR2_EL2 U(0x1d8)
Mark Brown293a6612023-03-14 20:48:43 +0000247#define CTX_POR_EL2 U(0x1e0)
248#define CTX_PIRE0_EL2 U(0x1e8)
249#define CTX_PIR_EL2 U(0x1f0)
250#define CTX_S2PIR_EL2 U(0x1f8)
Mark Brown326f2952023-03-14 21:33:04 +0000251#define CTX_GCSCR_EL2 U(0x200)
252#define CTX_GCSPR_EL2 U(0x208)
Mark Brownc37eee72023-03-14 20:13:03 +0000253
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000254/* Align to the next 16 byte boundary */
Mark Brown326f2952023-03-14 21:33:04 +0000255#define CTX_EL2_SYSREGS_END U(0x210)
Olivier Deprez19628912020-03-20 14:22:05 +0100256
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000257#endif /* CTX_INCLUDE_EL2_REGS */
258
Achin Gupta9ac63c52014-01-16 12:08:03 +0000259/*******************************************************************************
260 * Constants that allow assembler code to access members of and the 'fp_regs'
261 * structure at their correct offsets.
262 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000263#if CTX_INCLUDE_EL2_REGS
264# define CTX_FPREGS_OFFSET (CTX_EL2_SYSREGS_OFFSET + CTX_EL2_SYSREGS_END)
265#else
266# define CTX_FPREGS_OFFSET (CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
267#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100268#if CTX_INCLUDE_FPREGS
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700269#define CTX_FP_Q0 U(0x0)
270#define CTX_FP_Q1 U(0x10)
271#define CTX_FP_Q2 U(0x20)
272#define CTX_FP_Q3 U(0x30)
273#define CTX_FP_Q4 U(0x40)
274#define CTX_FP_Q5 U(0x50)
275#define CTX_FP_Q6 U(0x60)
276#define CTX_FP_Q7 U(0x70)
277#define CTX_FP_Q8 U(0x80)
278#define CTX_FP_Q9 U(0x90)
279#define CTX_FP_Q10 U(0xa0)
280#define CTX_FP_Q11 U(0xb0)
281#define CTX_FP_Q12 U(0xc0)
282#define CTX_FP_Q13 U(0xd0)
283#define CTX_FP_Q14 U(0xe0)
284#define CTX_FP_Q15 U(0xf0)
285#define CTX_FP_Q16 U(0x100)
286#define CTX_FP_Q17 U(0x110)
287#define CTX_FP_Q18 U(0x120)
288#define CTX_FP_Q19 U(0x130)
289#define CTX_FP_Q20 U(0x140)
290#define CTX_FP_Q21 U(0x150)
291#define CTX_FP_Q22 U(0x160)
292#define CTX_FP_Q23 U(0x170)
293#define CTX_FP_Q24 U(0x180)
294#define CTX_FP_Q25 U(0x190)
295#define CTX_FP_Q26 U(0x1a0)
296#define CTX_FP_Q27 U(0x1b0)
297#define CTX_FP_Q28 U(0x1c0)
298#define CTX_FP_Q29 U(0x1d0)
299#define CTX_FP_Q30 U(0x1e0)
300#define CTX_FP_Q31 U(0x1f0)
301#define CTX_FP_FPSR U(0x200)
302#define CTX_FP_FPCR U(0x208)
David Cunadod1a1fd42017-10-20 11:30:57 +0100303#if CTX_INCLUDE_AARCH32_REGS
304#define CTX_FP_FPEXC32_EL2 U(0x210)
305#define CTX_FPREGS_END U(0x220) /* Align to the next 16 byte boundary */
306#else
307#define CTX_FPREGS_END U(0x210) /* Align to the next 16 byte boundary */
308#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100309#else
310#define CTX_FPREGS_END U(0)
Juan Castillo258e94f2014-06-25 17:26:36 +0100311#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000312
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000313/*******************************************************************************
314 * Registers related to CVE-2018-3639
315 ******************************************************************************/
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100316#define CTX_CVE_2018_3639_OFFSET (CTX_FPREGS_OFFSET + CTX_FPREGS_END)
317#define CTX_CVE_2018_3639_DISABLE U(0)
318#define CTX_CVE_2018_3639_END U(0x10) /* Align to the next 16 byte boundary */
319
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000320/*******************************************************************************
321 * Registers related to ARMv8.3-PAuth.
322 ******************************************************************************/
323#define CTX_PAUTH_REGS_OFFSET (CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
324#if CTX_INCLUDE_PAUTH_REGS
325#define CTX_PACIAKEY_LO U(0x0)
326#define CTX_PACIAKEY_HI U(0x8)
327#define CTX_PACIBKEY_LO U(0x10)
328#define CTX_PACIBKEY_HI U(0x18)
329#define CTX_PACDAKEY_LO U(0x20)
330#define CTX_PACDAKEY_HI U(0x28)
331#define CTX_PACDBKEY_LO U(0x30)
332#define CTX_PACDBKEY_HI U(0x38)
333#define CTX_PACGAKEY_LO U(0x40)
334#define CTX_PACGAKEY_HI U(0x48)
Alexei Fedorovf41355c2019-09-13 14:11:59 +0100335#define CTX_PAUTH_REGS_END U(0x50) /* Align to the next 16 byte boundary */
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000336#else
337#define CTX_PAUTH_REGS_END U(0)
338#endif /* CTX_INCLUDE_PAUTH_REGS */
339
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100340/*******************************************************************************
341 * Registers initialised in a per-world context.
342 ******************************************************************************/
Jayanth Dodderi Chidanand56aa3822023-12-11 11:22:02 +0000343#define CTX_CPTR_EL3 U(0x0)
344#define CTX_ZCR_EL3 U(0x8)
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -0600345#define CTX_MPAM3_EL3 U(0x10)
346#define CTX_PERWORLD_EL3STATE_END U(0x18)
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100347
Julius Werner53456fc2019-07-09 13:49:11 -0700348#ifndef __ASSEMBLER__
Achin Gupta9ac63c52014-01-16 12:08:03 +0000349
Dan Handley2bd4ef22014-04-09 13:14:54 +0100350#include <stdint.h>
351
Antonio Nino Diaze0f90632018-12-14 00:18:21 +0000352#include <lib/cassert.h>
353
Achin Gupta9ac63c52014-01-16 12:08:03 +0000354/*
355 * Common constants to help define the 'cpu_context' structure and its
356 * members below.
357 */
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700358#define DWORD_SHIFT U(3)
Achin Gupta9ac63c52014-01-16 12:08:03 +0000359#define DEFINE_REG_STRUCT(name, num_regs) \
Dan Handleye2712bc2014-04-10 15:37:22 +0100360 typedef struct name { \
Zelalem91d80612020-02-12 10:37:03 -0600361 uint64_t ctx_regs[num_regs]; \
Dan Handleye2712bc2014-04-10 15:37:22 +0100362 } __aligned(16) name##_t
Achin Gupta9ac63c52014-01-16 12:08:03 +0000363
364/* Constants to determine the size of individual context structures */
Achin Gupta07f4e072014-02-02 12:02:23 +0000365#define CTX_GPREG_ALL (CTX_GPREGS_END >> DWORD_SHIFT)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000366#define CTX_EL1_SYSREGS_ALL (CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
367#if CTX_INCLUDE_EL2_REGS
368# define CTX_EL2_SYSREGS_ALL (CTX_EL2_SYSREGS_END >> DWORD_SHIFT)
369#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100370#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000371# define CTX_FPREG_ALL (CTX_FPREGS_END >> DWORD_SHIFT)
Juan Castillo258e94f2014-06-25 17:26:36 +0100372#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000373#define CTX_EL3STATE_ALL (CTX_EL3STATE_END >> DWORD_SHIFT)
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100374#define CTX_CVE_2018_3639_ALL (CTX_CVE_2018_3639_END >> DWORD_SHIFT)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000375#if CTX_INCLUDE_PAUTH_REGS
376# define CTX_PAUTH_REGS_ALL (CTX_PAUTH_REGS_END >> DWORD_SHIFT)
377#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000378
379/*
Soby Mathew6c5192a2014-04-30 15:36:37 +0100380 * AArch64 general purpose register context structure. Usually x0-x18,
381 * lr are saved as the compiler is expected to preserve the remaining
Achin Gupta07f4e072014-02-02 12:02:23 +0000382 * callee saved registers if used by the C runtime and the assembler
Soby Mathew6c5192a2014-04-30 15:36:37 +0100383 * does not touch the remaining. But in case of world switch during
384 * exception handling, we need to save the callee registers too.
Achin Gupta07f4e072014-02-02 12:02:23 +0000385 */
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000386DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
Achin Gupta07f4e072014-02-02 12:02:23 +0000387
388/*
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000389 * AArch64 EL1 system register context structure for preserving the
390 * architectural state during world switches.
391 */
392DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
393
394
395/*
396 * AArch64 EL2 system register context structure for preserving the
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000397 * architectural state during world switches.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000398 */
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000399#if CTX_INCLUDE_EL2_REGS
400DEFINE_REG_STRUCT(el2_sysregs, CTX_EL2_SYSREGS_ALL);
401#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000402
403/*
404 * AArch64 floating point register context structure for preserving
405 * the floating point state during switches from one security state to
406 * another.
407 */
Juan Castillo258e94f2014-06-25 17:26:36 +0100408#if CTX_INCLUDE_FPREGS
Achin Gupta9ac63c52014-01-16 12:08:03 +0000409DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
Juan Castillo258e94f2014-06-25 17:26:36 +0100410#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000411
412/*
413 * Miscellaneous registers used by EL3 firmware to maintain its state
414 * across exception entries and exits
415 */
416DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
417
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100418/* Function pointer used by CVE-2018-3639 dynamic mitigation */
419DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
420
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000421/* Registers associated to ARMv8.3-PAuth */
422#if CTX_INCLUDE_PAUTH_REGS
423DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
424#endif
425
Achin Gupta9ac63c52014-01-16 12:08:03 +0000426/*
427 * Macros to access members of any of the above structures using their
428 * offsets
429 */
Zelalem91d80612020-02-12 10:37:03 -0600430#define read_ctx_reg(ctx, offset) ((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
431#define write_ctx_reg(ctx, offset, val) (((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100432 = (uint64_t) (val))
Achin Gupta9ac63c52014-01-16 12:08:03 +0000433
434/*
Zelalem Awekeb6301e62021-07-09 17:54:30 -0500435 * Top-level context structure which is used by EL3 firmware to preserve
436 * the state of a core at the next lower EL in a given security state and
437 * save enough EL3 meta data to be able to return to that EL and security
438 * state. The context management library will be used to ensure that
439 * SP_EL3 always points to an instance of this structure at exception
440 * entry and exit.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000441 */
Dan Handleye2712bc2014-04-10 15:37:22 +0100442typedef struct cpu_context {
443 gp_regs_t gpregs_ctx;
444 el3_state_t el3state_ctx;
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000445 el1_sysregs_t el1_sysregs_ctx;
446#if CTX_INCLUDE_EL2_REGS
447 el2_sysregs_t el2_sysregs_ctx;
448#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100449#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100450 fp_regs_t fpregs_ctx;
Juan Castillo258e94f2014-06-25 17:26:36 +0100451#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100452 cve_2018_3639_t cve_2018_3639_ctx;
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000453#if CTX_INCLUDE_PAUTH_REGS
454 pauth_t pauth_ctx;
455#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100456} cpu_context_t;
Achin Gupta9ac63c52014-01-16 12:08:03 +0000457
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100458/*
459 * Per-World Context.
460 * It stores registers whose values can be shared across CPUs.
461 */
462typedef struct per_world_context {
463 uint64_t ctx_cptr_el3;
464 uint64_t ctx_zcr_el3;
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -0600465 uint64_t ctx_mpam3_el3;
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100466} per_world_context_t;
467
468extern per_world_context_t per_world_context[CPU_DATA_CONTEXT_NUM];
469
Dan Handleye2712bc2014-04-10 15:37:22 +0100470/* Macros to access members of the 'cpu_context_t' structure */
471#define get_el3state_ctx(h) (&((cpu_context_t *) h)->el3state_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100472#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000473# define get_fpregs_ctx(h) (&((cpu_context_t *) h)->fpregs_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100474#endif
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000475#define get_el1_sysregs_ctx(h) (&((cpu_context_t *) h)->el1_sysregs_ctx)
476#if CTX_INCLUDE_EL2_REGS
477# define get_el2_sysregs_ctx(h) (&((cpu_context_t *) h)->el2_sysregs_ctx)
478#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100479#define get_gpregs_ctx(h) (&((cpu_context_t *) h)->gpregs_ctx)
Dimitris Papastamosbb1fd5b2018-06-07 11:29:15 +0100480#define get_cve_2018_3639_ctx(h) (&((cpu_context_t *) h)->cve_2018_3639_ctx)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000481#if CTX_INCLUDE_PAUTH_REGS
482# define get_pauth_ctx(h) (&((cpu_context_t *) h)->pauth_ctx)
483#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000484
485/*
486 * Compile time assertions related to the 'cpu_context' structure to
487 * ensure that the assembler and the compiler view of the offsets of
488 * the structure members is the same.
489 */
Elyes Haouas183638f2023-02-13 10:05:41 +0100490CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx),
Achin Gupta07f4e072014-02-02 12:02:23 +0000491 assert_core_context_gp_offset_mismatch);
Elyes Haouas183638f2023-02-13 10:05:41 +0100492CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx),
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000493 assert_core_context_el1_sys_offset_mismatch);
494#if CTX_INCLUDE_EL2_REGS
Elyes Haouas183638f2023-02-13 10:05:41 +0100495CASSERT(CTX_EL2_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el2_sysregs_ctx),
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000496 assert_core_context_el2_sys_offset_mismatch);
497#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100498#if CTX_INCLUDE_FPREGS
Elyes Haouas183638f2023-02-13 10:05:41 +0100499CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx),
Achin Gupta9ac63c52014-01-16 12:08:03 +0000500 assert_core_context_fp_offset_mismatch);
Juan Castillo258e94f2014-06-25 17:26:36 +0100501#endif
Elyes Haouas183638f2023-02-13 10:05:41 +0100502CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx),
Achin Gupta9ac63c52014-01-16 12:08:03 +0000503 assert_core_context_el3state_offset_mismatch);
Elyes Haouas183638f2023-02-13 10:05:41 +0100504CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx),
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100505 assert_core_context_cve_2018_3639_offset_mismatch);
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000506#if CTX_INCLUDE_PAUTH_REGS
Elyes Haouas183638f2023-02-13 10:05:41 +0100507CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx),
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000508 assert_core_context_pauth_offset_mismatch);
509#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000510
Achin Gupta607084e2014-02-09 18:24:19 +0000511/*
512 * Helper macro to set the general purpose registers that correspond to
513 * parameters in an aapcs_64 call i.e. x0-x7
514 */
515#define set_aapcs_args0(ctx, x0) do { \
516 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100517 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000518#define set_aapcs_args1(ctx, x0, x1) do { \
519 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1); \
520 set_aapcs_args0(ctx, x0); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100521 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000522#define set_aapcs_args2(ctx, x0, x1, x2) do { \
523 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2); \
524 set_aapcs_args1(ctx, x0, x1); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100525 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000526#define set_aapcs_args3(ctx, x0, x1, x2, x3) do { \
527 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3); \
528 set_aapcs_args2(ctx, x0, x1, x2); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100529 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000530#define set_aapcs_args4(ctx, x0, x1, x2, x3, x4) do { \
531 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4); \
532 set_aapcs_args3(ctx, x0, x1, x2, x3); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100533 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000534#define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5) do { \
535 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5); \
536 set_aapcs_args4(ctx, x0, x1, x2, x3, x4); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100537 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000538#define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6) do { \
539 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6); \
540 set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100541 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000542#define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7) do { \
543 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7); \
544 set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100545 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000546
Achin Gupta9ac63c52014-01-16 12:08:03 +0000547/*******************************************************************************
548 * Function prototypes
549 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000550void el1_sysregs_context_save(el1_sysregs_t *regs);
551void el1_sysregs_context_restore(el1_sysregs_t *regs);
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000552
Juan Castillo258e94f2014-06-25 17:26:36 +0100553#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100554void fpregs_context_save(fp_regs_t *regs);
555void fpregs_context_restore(fp_regs_t *regs);
Juan Castillo258e94f2014-06-25 17:26:36 +0100556#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000557
Julius Werner53456fc2019-07-09 13:49:11 -0700558#endif /* __ASSEMBLER__ */
Achin Gupta9ac63c52014-01-16 12:08:03 +0000559
Antonio Nino Diaz864ca6f2018-10-31 15:25:35 +0000560#endif /* CONTEXT_H */