blob: acf111ba75ec41e69b3cdc890b848471b15951c9 [file] [log] [blame]
Achin Gupta9ac63c52014-01-16 12:08:03 +00001/*
Jayanth Dodderi Chidanand8c56a782024-01-09 11:28:21 +00002 * Copyright (c) 2013-2024, Arm Limited and Contributors. All rights reserved.
Achin Gupta9ac63c52014-01-16 12:08:03 +00003 *
dp-arm82cb2c12017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Achin Gupta9ac63c52014-01-16 12:08:03 +00005 */
6
Antonio Nino Diaza0fee742018-10-31 15:25:35 +00007#ifndef CONTEXT_H
8#define CONTEXT_H
Achin Gupta9ac63c52014-01-16 12:08:03 +00009
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +000010#include <lib/el3_runtime/context_el2.h>
Elizabeth Ho461c0a52023-07-18 14:10:25 +010011#include <lib/el3_runtime/cpu_data.h>
Antonio Nino Diaz09d40e02018-12-14 00:18:21 +000012#include <lib/utils_def.h>
Jeenu Viswambharan76454ab2017-11-30 12:54:15 +000013
Achin Gupta9ac63c52014-01-16 12:08:03 +000014/*******************************************************************************
Achin Gupta07f4e072014-02-02 12:02:23 +000015 * Constants that allow assembler code to access members of and the 'gp_regs'
16 * structure at their correct offsets.
17 ******************************************************************************/
Varun Wadekar030567e2017-05-25 18:04:48 -070018#define CTX_GPREGS_OFFSET U(0x0)
19#define CTX_GPREG_X0 U(0x0)
20#define CTX_GPREG_X1 U(0x8)
21#define CTX_GPREG_X2 U(0x10)
22#define CTX_GPREG_X3 U(0x18)
23#define CTX_GPREG_X4 U(0x20)
24#define CTX_GPREG_X5 U(0x28)
25#define CTX_GPREG_X6 U(0x30)
26#define CTX_GPREG_X7 U(0x38)
27#define CTX_GPREG_X8 U(0x40)
28#define CTX_GPREG_X9 U(0x48)
29#define CTX_GPREG_X10 U(0x50)
30#define CTX_GPREG_X11 U(0x58)
31#define CTX_GPREG_X12 U(0x60)
32#define CTX_GPREG_X13 U(0x68)
33#define CTX_GPREG_X14 U(0x70)
34#define CTX_GPREG_X15 U(0x78)
35#define CTX_GPREG_X16 U(0x80)
36#define CTX_GPREG_X17 U(0x88)
37#define CTX_GPREG_X18 U(0x90)
38#define CTX_GPREG_X19 U(0x98)
39#define CTX_GPREG_X20 U(0xa0)
40#define CTX_GPREG_X21 U(0xa8)
41#define CTX_GPREG_X22 U(0xb0)
42#define CTX_GPREG_X23 U(0xb8)
43#define CTX_GPREG_X24 U(0xc0)
44#define CTX_GPREG_X25 U(0xc8)
45#define CTX_GPREG_X26 U(0xd0)
46#define CTX_GPREG_X27 U(0xd8)
47#define CTX_GPREG_X28 U(0xe0)
48#define CTX_GPREG_X29 U(0xe8)
49#define CTX_GPREG_LR U(0xf0)
50#define CTX_GPREG_SP_EL0 U(0xf8)
51#define CTX_GPREGS_END U(0x100)
Achin Gupta07f4e072014-02-02 12:02:23 +000052
53/*******************************************************************************
Achin Gupta9ac63c52014-01-16 12:08:03 +000054 * Constants that allow assembler code to access members of and the 'el3_state'
55 * structure at their correct offsets. Note that some of the registers are only
56 * 32-bits wide but are stored as 64-bit values for convenience
57 ******************************************************************************/
Dimitris Papastamosd9bd6562018-01-11 15:29:36 +000058#define CTX_EL3STATE_OFFSET (CTX_GPREGS_OFFSET + CTX_GPREGS_END)
Varun Wadekar030567e2017-05-25 18:04:48 -070059#define CTX_SCR_EL3 U(0x0)
Jeenu Viswambharan76454ab2017-11-30 12:54:15 +000060#define CTX_ESR_EL3 U(0x8)
61#define CTX_RUNTIME_SP U(0x10)
62#define CTX_SPSR_EL3 U(0x18)
63#define CTX_ELR_EL3 U(0x20)
Alexei Fedorove290a8fc2019-08-13 15:17:53 +010064#define CTX_PMCR_EL0 U(0x28)
Madhukar Pappireddyc2d32a52020-07-24 03:27:12 -050065#define CTX_IS_IN_EL3 U(0x30)
Jayanth Dodderi Chidanand123002f2024-06-18 15:22:54 +010066#define CTX_MDCR_EL3 U(0x38)
Manish Pandeyd04c04a2023-05-25 13:46:14 +010067/* Constants required in supporting nested exception in EL3 */
Jayanth Dodderi Chidanand123002f2024-06-18 15:22:54 +010068#define CTX_SAVED_ELR_EL3 U(0x40)
Manish Pandeyd04c04a2023-05-25 13:46:14 +010069/*
70 * General purpose flag, to save various EL3 states
71 * FFH mode : Used to identify if handling nested exception
72 * KFH mode : Used as counter value
73 */
Jayanth Dodderi Chidanand123002f2024-06-18 15:22:54 +010074#define CTX_NESTED_EA_FLAG U(0x48)
Manish Pandeyf87e54f2023-10-10 15:42:19 +010075#if FFH_SUPPORT
Jayanth Dodderi Chidanand123002f2024-06-18 15:22:54 +010076 #define CTX_SAVED_ESR_EL3 U(0x50)
77 #define CTX_SAVED_SPSR_EL3 U(0x58)
78 #define CTX_SAVED_GPREG_LR U(0x60)
79 #define CTX_EL3STATE_END U(0x70) /* Align to the next 16 byte boundary */
Manish Pandeyd04c04a2023-05-25 13:46:14 +010080#else
81 #define CTX_EL3STATE_END U(0x50) /* Align to the next 16 byte boundary */
Arvind Ram Prakashac4f6aa2023-11-08 12:28:30 -060082#endif /* FFH_SUPPORT */
Achin Gupta9ac63c52014-01-16 12:08:03 +000083
84/*******************************************************************************
85 * Constants that allow assembler code to access members of and the
86 * 'el1_sys_regs' structure at their correct offsets. Note that some of the
87 * registers are only 32-bits wide but are stored as 64-bit values for
88 * convenience
89 ******************************************************************************/
Max Shvetsov28259462020-02-17 16:15:47 +000090#define CTX_EL1_SYSREGS_OFFSET (CTX_EL3STATE_OFFSET + CTX_EL3STATE_END)
Varun Wadekar030567e2017-05-25 18:04:48 -070091#define CTX_SPSR_EL1 U(0x0)
92#define CTX_ELR_EL1 U(0x8)
93#define CTX_SCTLR_EL1 U(0x10)
Manish V Badarkhecb556152020-07-28 07:22:30 +010094#define CTX_TCR_EL1 U(0x18)
Varun Wadekar030567e2017-05-25 18:04:48 -070095#define CTX_CPACR_EL1 U(0x20)
96#define CTX_CSSELR_EL1 U(0x28)
97#define CTX_SP_EL1 U(0x30)
98#define CTX_ESR_EL1 U(0x38)
99#define CTX_TTBR0_EL1 U(0x40)
100#define CTX_TTBR1_EL1 U(0x48)
101#define CTX_MAIR_EL1 U(0x50)
102#define CTX_AMAIR_EL1 U(0x58)
Manish V Badarkhecb556152020-07-28 07:22:30 +0100103#define CTX_ACTLR_EL1 U(0x60)
Varun Wadekar030567e2017-05-25 18:04:48 -0700104#define CTX_TPIDR_EL1 U(0x68)
105#define CTX_TPIDR_EL0 U(0x70)
106#define CTX_TPIDRRO_EL0 U(0x78)
107#define CTX_PAR_EL1 U(0x80)
108#define CTX_FAR_EL1 U(0x88)
109#define CTX_AFSR0_EL1 U(0x90)
110#define CTX_AFSR1_EL1 U(0x98)
111#define CTX_CONTEXTIDR_EL1 U(0xa0)
112#define CTX_VBAR_EL1 U(0xa8)
Madhukar Pappireddyed9bb822024-03-25 17:49:00 -0500113#define CTX_MDCCINT_EL1 U(0xb0)
114#define CTX_MDSCR_EL1 U(0xb8)
115
116#define CTX_AARCH64_END U(0xc0) /* Align to the next 16 byte boundary */
Soby Mathew8cd16e62016-05-17 14:01:32 +0100117
118/*
119 * If the platform is AArch64-only, there is no need to save and restore these
120 * AArch32 registers.
121 */
122#if CTX_INCLUDE_AARCH32_REGS
Madhukar Pappireddyed9bb822024-03-25 17:49:00 -0500123#define CTX_SPSR_ABT (CTX_AARCH64_END + U(0x0))
124#define CTX_SPSR_UND (CTX_AARCH64_END + U(0x8))
125#define CTX_SPSR_IRQ (CTX_AARCH64_END + U(0x10))
126#define CTX_SPSR_FIQ (CTX_AARCH64_END + U(0x18))
127#define CTX_DACR32_EL2 (CTX_AARCH64_END + U(0x20))
128#define CTX_IFSR32_EL2 (CTX_AARCH64_END + U(0x28))
129#define CTX_AARCH32_END (CTX_AARCH64_END + U(0x30)) /* Align to the next 16 byte boundary */
Soby Mathew8cd16e62016-05-17 14:01:32 +0100130#else
Madhukar Pappireddyed9bb822024-03-25 17:49:00 -0500131#define CTX_AARCH32_END CTX_AARCH64_END
Antonio Nino Diaz4d1ccf02019-01-30 20:41:31 +0000132#endif /* CTX_INCLUDE_AARCH32_REGS */
Soby Mathew8cd16e62016-05-17 14:01:32 +0100133
Jeenu Viswambharan2da8d8b2014-05-12 15:28:47 +0100134/*
135 * If the timer registers aren't saved and restored, we don't have to reserve
136 * space for them in the context
137 */
138#if NS_TIMER_SWITCH
Antonio Nino Diaz4d1ccf02019-01-30 20:41:31 +0000139#define CTX_CNTP_CTL_EL0 (CTX_AARCH32_END + U(0x0))
140#define CTX_CNTP_CVAL_EL0 (CTX_AARCH32_END + U(0x8))
141#define CTX_CNTV_CTL_EL0 (CTX_AARCH32_END + U(0x10))
142#define CTX_CNTV_CVAL_EL0 (CTX_AARCH32_END + U(0x18))
143#define CTX_CNTKCTL_EL1 (CTX_AARCH32_END + U(0x20))
144#define CTX_TIMER_SYSREGS_END (CTX_AARCH32_END + U(0x30)) /* Align to the next 16 byte boundary */
Jeenu Viswambharan2da8d8b2014-05-12 15:28:47 +0100145#else
Antonio Nino Diaz4d1ccf02019-01-30 20:41:31 +0000146#define CTX_TIMER_SYSREGS_END CTX_AARCH32_END
147#endif /* NS_TIMER_SWITCH */
148
Govindraj Rajac2823842024-03-07 14:42:20 -0600149#if ENABLE_FEAT_MTE2
Justin Chadwell9dd94382019-07-18 14:25:33 +0100150#define CTX_TFSRE0_EL1 (CTX_TIMER_SYSREGS_END + U(0x0))
151#define CTX_TFSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x8))
152#define CTX_RGSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x10))
153#define CTX_GCR_EL1 (CTX_TIMER_SYSREGS_END + U(0x18))
Madhukar Pappireddyed9bb822024-03-25 17:49:00 -0500154#define CTX_MTE_REGS_END (CTX_TIMER_SYSREGS_END + U(0x20)) /* Align to the next 16 byte boundary */
Justin Chadwell9dd94382019-07-18 14:25:33 +0100155#else
156#define CTX_MTE_REGS_END CTX_TIMER_SYSREGS_END
Govindraj Rajac2823842024-03-07 14:42:20 -0600157#endif /* ENABLE_FEAT_MTE2 */
Justin Chadwell9dd94382019-07-18 14:25:33 +0100158
Madhukar Pappireddyed9bb822024-03-25 17:49:00 -0500159#if ENABLE_FEAT_RAS
160#define CTX_DISR_EL1 (CTX_MTE_REGS_END + U(0x0))
161#define CTX_RAS_REGS_END (CTX_MTE_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
162#else
163#define CTX_RAS_REGS_END CTX_MTE_REGS_END
164#endif /* ENABLE_FEAT_RAS */
165
166#if ENABLE_FEAT_S1PIE
167#define CTX_PIRE0_EL1 (CTX_RAS_REGS_END + U(0x0))
168#define CTX_PIR_EL1 (CTX_RAS_REGS_END + U(0x8))
169#define CTX_S1PIE_REGS_END (CTX_RAS_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
170#else
171#define CTX_S1PIE_REGS_END CTX_RAS_REGS_END
172#endif /* ENABLE_FEAT_S1PIE */
173
174#if ENABLE_FEAT_S1POE
175#define CTX_POR_EL1 (CTX_S1PIE_REGS_END + U(0x0))
176#define CTX_S1POE_REGS_END (CTX_S1PIE_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
177#else
178#define CTX_S1POE_REGS_END CTX_S1PIE_REGS_END
179#endif /* ENABLE_FEAT_S1POE */
180
181#if ENABLE_FEAT_S2POE
182#define CTX_S2POR_EL1 (CTX_S1POE_REGS_END + U(0x0))
183#define CTX_S2POE_REGS_END (CTX_S1POE_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
184#else
185#define CTX_S2POE_REGS_END CTX_S1POE_REGS_END
186#endif /* ENABLE_FEAT_S2POE */
187
188#if ENABLE_FEAT_TCR2
189#define CTX_TCR2_EL1 (CTX_S2POE_REGS_END + U(0x0))
190#define CTX_TCR2_REGS_END (CTX_S2POE_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
191#else
192#define CTX_TCR2_REGS_END CTX_S2POE_REGS_END
193#endif /* ENABLE_FEAT_TCR2 */
194
Madhukar Pappireddyd6c76e62024-04-17 17:07:13 -0500195#if ENABLE_TRF_FOR_NS
196#define CTX_TRFCR_EL1 (CTX_TCR2_REGS_END + U(0x0))
197#define CTX_TRF_REGS_END (CTX_TCR2_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
198#else
199#define CTX_TRF_REGS_END CTX_TCR2_REGS_END
200#endif /* ENABLE_TRF_FOR_NS */
201
202#if ENABLE_FEAT_CSV2_2
203#define CTX_SCXTNUM_EL0 (CTX_TRF_REGS_END + U(0x0))
204#define CTX_SCXTNUM_EL1 (CTX_TRF_REGS_END + U(0x8))
205#define CTX_CSV2_2_REGS_END (CTX_TRF_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
206#else
207#define CTX_CSV2_2_REGS_END CTX_TRF_REGS_END
208#endif /* ENABLE_FEAT_CSV2_2 */
209
210#if ENABLE_FEAT_GCS
211#define CTX_GCSCR_EL1 (CTX_CSV2_2_REGS_END + U(0x0))
212#define CTX_GCSCRE0_EL1 (CTX_CSV2_2_REGS_END + U(0x8))
213#define CTX_GCSPR_EL1 (CTX_CSV2_2_REGS_END + U(0x10))
214#define CTX_GCSPR_EL0 (CTX_CSV2_2_REGS_END + U(0x18))
215#define CTX_GCS_REGS_END (CTX_CSV2_2_REGS_END + U(0x20)) /* Align to the next 16 byte boundary */
216#else
217#define CTX_GCS_REGS_END CTX_CSV2_2_REGS_END
218#endif /* ENABLE_FEAT_GCS */
219
Antonio Nino Diaz4d1ccf02019-01-30 20:41:31 +0000220/*
Madhukar Pappireddyd6c76e62024-04-17 17:07:13 -0500221 * End of EL1 system registers.
Max Shvetsov28259462020-02-17 16:15:47 +0000222 */
Madhukar Pappireddyd6c76e62024-04-17 17:07:13 -0500223#define CTX_EL1_SYSREGS_END CTX_GCS_REGS_END
Max Shvetsov28259462020-02-17 16:15:47 +0000224
Achin Gupta9ac63c52014-01-16 12:08:03 +0000225/*******************************************************************************
226 * Constants that allow assembler code to access members of and the 'fp_regs'
227 * structure at their correct offsets.
228 ******************************************************************************/
Max Shvetsov28259462020-02-17 16:15:47 +0000229# define CTX_FPREGS_OFFSET (CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100230#if CTX_INCLUDE_FPREGS
Varun Wadekar030567e2017-05-25 18:04:48 -0700231#define CTX_FP_Q0 U(0x0)
232#define CTX_FP_Q1 U(0x10)
233#define CTX_FP_Q2 U(0x20)
234#define CTX_FP_Q3 U(0x30)
235#define CTX_FP_Q4 U(0x40)
236#define CTX_FP_Q5 U(0x50)
237#define CTX_FP_Q6 U(0x60)
238#define CTX_FP_Q7 U(0x70)
239#define CTX_FP_Q8 U(0x80)
240#define CTX_FP_Q9 U(0x90)
241#define CTX_FP_Q10 U(0xa0)
242#define CTX_FP_Q11 U(0xb0)
243#define CTX_FP_Q12 U(0xc0)
244#define CTX_FP_Q13 U(0xd0)
245#define CTX_FP_Q14 U(0xe0)
246#define CTX_FP_Q15 U(0xf0)
247#define CTX_FP_Q16 U(0x100)
248#define CTX_FP_Q17 U(0x110)
249#define CTX_FP_Q18 U(0x120)
250#define CTX_FP_Q19 U(0x130)
251#define CTX_FP_Q20 U(0x140)
252#define CTX_FP_Q21 U(0x150)
253#define CTX_FP_Q22 U(0x160)
254#define CTX_FP_Q23 U(0x170)
255#define CTX_FP_Q24 U(0x180)
256#define CTX_FP_Q25 U(0x190)
257#define CTX_FP_Q26 U(0x1a0)
258#define CTX_FP_Q27 U(0x1b0)
259#define CTX_FP_Q28 U(0x1c0)
260#define CTX_FP_Q29 U(0x1d0)
261#define CTX_FP_Q30 U(0x1e0)
262#define CTX_FP_Q31 U(0x1f0)
263#define CTX_FP_FPSR U(0x200)
264#define CTX_FP_FPCR U(0x208)
David Cunado91089f32017-10-20 11:30:57 +0100265#if CTX_INCLUDE_AARCH32_REGS
266#define CTX_FP_FPEXC32_EL2 U(0x210)
267#define CTX_FPREGS_END U(0x220) /* Align to the next 16 byte boundary */
268#else
269#define CTX_FPREGS_END U(0x210) /* Align to the next 16 byte boundary */
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000270#endif /* CTX_INCLUDE_AARCH32_REGS */
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100271#else
272#define CTX_FPREGS_END U(0)
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000273#endif /* CTX_INCLUDE_FPREGS */
Achin Gupta9ac63c52014-01-16 12:08:03 +0000274
Antonio Nino Diaz4d1ccf02019-01-30 20:41:31 +0000275/*******************************************************************************
276 * Registers related to CVE-2018-3639
277 ******************************************************************************/
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100278#define CTX_CVE_2018_3639_OFFSET (CTX_FPREGS_OFFSET + CTX_FPREGS_END)
279#define CTX_CVE_2018_3639_DISABLE U(0)
280#define CTX_CVE_2018_3639_END U(0x10) /* Align to the next 16 byte boundary */
281
Antonio Nino Diaz52839622019-01-31 11:58:00 +0000282/*******************************************************************************
283 * Registers related to ARMv8.3-PAuth.
284 ******************************************************************************/
285#define CTX_PAUTH_REGS_OFFSET (CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
286#if CTX_INCLUDE_PAUTH_REGS
287#define CTX_PACIAKEY_LO U(0x0)
288#define CTX_PACIAKEY_HI U(0x8)
289#define CTX_PACIBKEY_LO U(0x10)
290#define CTX_PACIBKEY_HI U(0x18)
291#define CTX_PACDAKEY_LO U(0x20)
292#define CTX_PACDAKEY_HI U(0x28)
293#define CTX_PACDBKEY_LO U(0x30)
294#define CTX_PACDBKEY_HI U(0x38)
295#define CTX_PACGAKEY_LO U(0x40)
296#define CTX_PACGAKEY_HI U(0x48)
Alexei Fedoroved108b52019-09-13 14:11:59 +0100297#define CTX_PAUTH_REGS_END U(0x50) /* Align to the next 16 byte boundary */
Antonio Nino Diaz52839622019-01-31 11:58:00 +0000298#else
299#define CTX_PAUTH_REGS_END U(0)
300#endif /* CTX_INCLUDE_PAUTH_REGS */
301
Elizabeth Ho461c0a52023-07-18 14:10:25 +0100302/*******************************************************************************
303 * Registers initialised in a per-world context.
304 ******************************************************************************/
Jayanth Dodderi Chidanand4087ed62023-12-11 11:22:02 +0000305#define CTX_CPTR_EL3 U(0x0)
306#define CTX_ZCR_EL3 U(0x8)
Arvind Ram Prakashac4f6aa2023-11-08 12:28:30 -0600307#define CTX_MPAM3_EL3 U(0x10)
308#define CTX_PERWORLD_EL3STATE_END U(0x18)
Elizabeth Ho461c0a52023-07-18 14:10:25 +0100309
Julius Wernerd5dfdeb2019-07-09 13:49:11 -0700310#ifndef __ASSEMBLER__
Achin Gupta9ac63c52014-01-16 12:08:03 +0000311
Dan Handley97043ac2014-04-09 13:14:54 +0100312#include <stdint.h>
313
Antonio Nino Diaz09d40e02018-12-14 00:18:21 +0000314#include <lib/cassert.h>
315
Achin Gupta9ac63c52014-01-16 12:08:03 +0000316/*
317 * Common constants to help define the 'cpu_context' structure and its
318 * members below.
319 */
Varun Wadekar030567e2017-05-25 18:04:48 -0700320#define DWORD_SHIFT U(3)
Achin Gupta9ac63c52014-01-16 12:08:03 +0000321#define DEFINE_REG_STRUCT(name, num_regs) \
Dan Handleyfb037bf2014-04-10 15:37:22 +0100322 typedef struct name { \
Zelalem2fe75a22020-02-12 10:37:03 -0600323 uint64_t ctx_regs[num_regs]; \
Dan Handleyfb037bf2014-04-10 15:37:22 +0100324 } __aligned(16) name##_t
Achin Gupta9ac63c52014-01-16 12:08:03 +0000325
326/* Constants to determine the size of individual context structures */
Achin Gupta07f4e072014-02-02 12:02:23 +0000327#define CTX_GPREG_ALL (CTX_GPREGS_END >> DWORD_SHIFT)
Max Shvetsov28259462020-02-17 16:15:47 +0000328#define CTX_EL1_SYSREGS_ALL (CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000329
Juan Castillo0f21c542014-06-25 17:26:36 +0100330#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz4d1ccf02019-01-30 20:41:31 +0000331# define CTX_FPREG_ALL (CTX_FPREGS_END >> DWORD_SHIFT)
Juan Castillo0f21c542014-06-25 17:26:36 +0100332#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000333#define CTX_EL3STATE_ALL (CTX_EL3STATE_END >> DWORD_SHIFT)
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100334#define CTX_CVE_2018_3639_ALL (CTX_CVE_2018_3639_END >> DWORD_SHIFT)
Antonio Nino Diaz52839622019-01-31 11:58:00 +0000335#if CTX_INCLUDE_PAUTH_REGS
336# define CTX_PAUTH_REGS_ALL (CTX_PAUTH_REGS_END >> DWORD_SHIFT)
337#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000338
339/*
Soby Mathewc3260f92014-04-30 15:36:37 +0100340 * AArch64 general purpose register context structure. Usually x0-x18,
341 * lr are saved as the compiler is expected to preserve the remaining
Achin Gupta07f4e072014-02-02 12:02:23 +0000342 * callee saved registers if used by the C runtime and the assembler
Soby Mathewc3260f92014-04-30 15:36:37 +0100343 * does not touch the remaining. But in case of world switch during
344 * exception handling, we need to save the callee registers too.
Achin Gupta07f4e072014-02-02 12:02:23 +0000345 */
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000346DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
Achin Gupta07f4e072014-02-02 12:02:23 +0000347
348/*
Max Shvetsov28259462020-02-17 16:15:47 +0000349 * AArch64 EL1 system register context structure for preserving the
Max Shvetsov28f39f02020-02-25 13:56:19 +0000350 * architectural state during world switches.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000351 */
Max Shvetsov28259462020-02-17 16:15:47 +0000352DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
353
Achin Gupta9ac63c52014-01-16 12:08:03 +0000354/*
355 * AArch64 floating point register context structure for preserving
356 * the floating point state during switches from one security state to
357 * another.
358 */
Juan Castillo0f21c542014-06-25 17:26:36 +0100359#if CTX_INCLUDE_FPREGS
Achin Gupta9ac63c52014-01-16 12:08:03 +0000360DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
Juan Castillo0f21c542014-06-25 17:26:36 +0100361#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000362
363/*
364 * Miscellaneous registers used by EL3 firmware to maintain its state
365 * across exception entries and exits
366 */
367DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
368
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100369/* Function pointer used by CVE-2018-3639 dynamic mitigation */
370DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
371
Antonio Nino Diaz52839622019-01-31 11:58:00 +0000372/* Registers associated to ARMv8.3-PAuth */
373#if CTX_INCLUDE_PAUTH_REGS
374DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
375#endif
376
Achin Gupta9ac63c52014-01-16 12:08:03 +0000377/*
378 * Macros to access members of any of the above structures using their
379 * offsets
380 */
Zelalem2fe75a22020-02-12 10:37:03 -0600381#define read_ctx_reg(ctx, offset) ((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
382#define write_ctx_reg(ctx, offset, val) (((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
Jeenu Viswambharanba6e5ca2018-08-02 10:14:12 +0100383 = (uint64_t) (val))
Achin Gupta9ac63c52014-01-16 12:08:03 +0000384
385/*
Zelalem Awekec5ea4f82021-07-09 17:54:30 -0500386 * Top-level context structure which is used by EL3 firmware to preserve
387 * the state of a core at the next lower EL in a given security state and
388 * save enough EL3 meta data to be able to return to that EL and security
389 * state. The context management library will be used to ensure that
390 * SP_EL3 always points to an instance of this structure at exception
391 * entry and exit.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000392 */
Dan Handleyfb037bf2014-04-10 15:37:22 +0100393typedef struct cpu_context {
394 gp_regs_t gpregs_ctx;
395 el3_state_t el3state_ctx;
Max Shvetsov28259462020-02-17 16:15:47 +0000396 el1_sysregs_t el1_sysregs_ctx;
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000397
Juan Castillo0f21c542014-06-25 17:26:36 +0100398#if CTX_INCLUDE_FPREGS
Dan Handleyfb037bf2014-04-10 15:37:22 +0100399 fp_regs_t fpregs_ctx;
Juan Castillo0f21c542014-06-25 17:26:36 +0100400#endif
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100401 cve_2018_3639_t cve_2018_3639_ctx;
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000402
Antonio Nino Diaz52839622019-01-31 11:58:00 +0000403#if CTX_INCLUDE_PAUTH_REGS
404 pauth_t pauth_ctx;
405#endif
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000406
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000407#if CTX_INCLUDE_EL2_REGS
408 el2_sysregs_t el2_sysregs_ctx;
409#endif
410
Dan Handleyfb037bf2014-04-10 15:37:22 +0100411} cpu_context_t;
Achin Gupta9ac63c52014-01-16 12:08:03 +0000412
Elizabeth Ho461c0a52023-07-18 14:10:25 +0100413/*
414 * Per-World Context.
415 * It stores registers whose values can be shared across CPUs.
416 */
417typedef struct per_world_context {
418 uint64_t ctx_cptr_el3;
419 uint64_t ctx_zcr_el3;
Arvind Ram Prakashac4f6aa2023-11-08 12:28:30 -0600420 uint64_t ctx_mpam3_el3;
Elizabeth Ho461c0a52023-07-18 14:10:25 +0100421} per_world_context_t;
422
423extern per_world_context_t per_world_context[CPU_DATA_CONTEXT_NUM];
424
Dan Handleyfb037bf2014-04-10 15:37:22 +0100425/* Macros to access members of the 'cpu_context_t' structure */
426#define get_el3state_ctx(h) (&((cpu_context_t *) h)->el3state_ctx)
Juan Castillo0f21c542014-06-25 17:26:36 +0100427#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz4d1ccf02019-01-30 20:41:31 +0000428# define get_fpregs_ctx(h) (&((cpu_context_t *) h)->fpregs_ctx)
Juan Castillo0f21c542014-06-25 17:26:36 +0100429#endif
Max Shvetsov28259462020-02-17 16:15:47 +0000430#define get_el1_sysregs_ctx(h) (&((cpu_context_t *) h)->el1_sysregs_ctx)
431#if CTX_INCLUDE_EL2_REGS
432# define get_el2_sysregs_ctx(h) (&((cpu_context_t *) h)->el2_sysregs_ctx)
433#endif
Dan Handleyfb037bf2014-04-10 15:37:22 +0100434#define get_gpregs_ctx(h) (&((cpu_context_t *) h)->gpregs_ctx)
Dimitris Papastamos6f03bc72018-06-07 11:29:15 +0100435#define get_cve_2018_3639_ctx(h) (&((cpu_context_t *) h)->cve_2018_3639_ctx)
Antonio Nino Diaz52839622019-01-31 11:58:00 +0000436#if CTX_INCLUDE_PAUTH_REGS
437# define get_pauth_ctx(h) (&((cpu_context_t *) h)->pauth_ctx)
438#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000439
440/*
441 * Compile time assertions related to the 'cpu_context' structure to
442 * ensure that the assembler and the compiler view of the offsets of
443 * the structure members is the same.
444 */
Elyes Haouas9a90d722023-02-13 10:05:41 +0100445CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx),
Achin Gupta07f4e072014-02-02 12:02:23 +0000446 assert_core_context_gp_offset_mismatch);
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000447
448CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx),
449 assert_core_context_el3state_offset_mismatch);
450
Elyes Haouas9a90d722023-02-13 10:05:41 +0100451CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx),
Max Shvetsov28259462020-02-17 16:15:47 +0000452 assert_core_context_el1_sys_offset_mismatch);
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000453
Juan Castillo0f21c542014-06-25 17:26:36 +0100454#if CTX_INCLUDE_FPREGS
Elyes Haouas9a90d722023-02-13 10:05:41 +0100455CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx),
Achin Gupta9ac63c52014-01-16 12:08:03 +0000456 assert_core_context_fp_offset_mismatch);
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000457#endif /* CTX_INCLUDE_FPREGS */
458
Elyes Haouas9a90d722023-02-13 10:05:41 +0100459CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx),
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100460 assert_core_context_cve_2018_3639_offset_mismatch);
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000461
Antonio Nino Diaz52839622019-01-31 11:58:00 +0000462#if CTX_INCLUDE_PAUTH_REGS
Elyes Haouas9a90d722023-02-13 10:05:41 +0100463CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx),
Antonio Nino Diaz52839622019-01-31 11:58:00 +0000464 assert_core_context_pauth_offset_mismatch);
Jayanth Dodderi Chidanandd6af2342024-01-24 20:05:07 +0000465#endif /* CTX_INCLUDE_PAUTH_REGS */
466
Achin Gupta607084e2014-02-09 18:24:19 +0000467/*
468 * Helper macro to set the general purpose registers that correspond to
469 * parameters in an aapcs_64 call i.e. x0-x7
470 */
471#define set_aapcs_args0(ctx, x0) do { \
472 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0); \
Soby Mathewda554d72016-05-03 17:11:42 +0100473 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000474#define set_aapcs_args1(ctx, x0, x1) do { \
475 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1); \
476 set_aapcs_args0(ctx, x0); \
Soby Mathewda554d72016-05-03 17:11:42 +0100477 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000478#define set_aapcs_args2(ctx, x0, x1, x2) do { \
479 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2); \
480 set_aapcs_args1(ctx, x0, x1); \
Soby Mathewda554d72016-05-03 17:11:42 +0100481 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000482#define set_aapcs_args3(ctx, x0, x1, x2, x3) do { \
483 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3); \
484 set_aapcs_args2(ctx, x0, x1, x2); \
Soby Mathewda554d72016-05-03 17:11:42 +0100485 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000486#define set_aapcs_args4(ctx, x0, x1, x2, x3, x4) do { \
487 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4); \
488 set_aapcs_args3(ctx, x0, x1, x2, x3); \
Soby Mathewda554d72016-05-03 17:11:42 +0100489 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000490#define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5) do { \
491 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5); \
492 set_aapcs_args4(ctx, x0, x1, x2, x3, x4); \
Soby Mathewda554d72016-05-03 17:11:42 +0100493 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000494#define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6) do { \
495 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6); \
496 set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5); \
Soby Mathewda554d72016-05-03 17:11:42 +0100497 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000498#define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7) do { \
499 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7); \
500 set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6); \
Soby Mathewda554d72016-05-03 17:11:42 +0100501 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000502
Achin Gupta9ac63c52014-01-16 12:08:03 +0000503/*******************************************************************************
504 * Function prototypes
505 ******************************************************************************/
Juan Castillo0f21c542014-06-25 17:26:36 +0100506#if CTX_INCLUDE_FPREGS
Dan Handleyfb037bf2014-04-10 15:37:22 +0100507void fpregs_context_save(fp_regs_t *regs);
508void fpregs_context_restore(fp_regs_t *regs);
Juan Castillo0f21c542014-06-25 17:26:36 +0100509#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000510
Julius Wernerd5dfdeb2019-07-09 13:49:11 -0700511#endif /* __ASSEMBLER__ */
Achin Gupta9ac63c52014-01-16 12:08:03 +0000512
Antonio Nino Diaza0fee742018-10-31 15:25:35 +0000513#endif /* CONTEXT_H */