blob: 74790d1cfc76524a51a45487b6bee3445a2bfcd2 [file] [log] [blame]
Achin Gupta9ac63c52014-01-16 12:08:03 +00001/*
Jayanth Dodderi Chidanand4d5a8c52024-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-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
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +000010#include <lib/el3_runtime/context_el2.h>
Elizabeth Ho4fc00d22023-07-18 14:10:25 +010011#include <lib/el3_runtime/cpu_data.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000012#include <lib/utils_def.h>
Jeenu Viswambharan96c7df02017-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 Wadekarc6a11f62017-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 Papastamosb63c6f12018-01-11 15:29:36 +000058#define CTX_EL3STATE_OFFSET (CTX_GPREGS_OFFSET + CTX_GPREGS_END)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070059#define CTX_SCR_EL3 U(0x0)
Jeenu Viswambharan96c7df02017-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 Fedorov503bbf32019-08-13 15:17:53 +010064#define CTX_PMCR_EL0 U(0x28)
Madhukar Pappireddyfba25722020-07-24 03:27:12 -050065#define CTX_IS_IN_EL3 U(0x30)
Manish Pandey07952fb2023-05-25 13:46:14 +010066/* Constants required in supporting nested exception in EL3 */
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -060067#define CTX_SAVED_ELR_EL3 U(0x38)
Manish Pandey07952fb2023-05-25 13:46:14 +010068/*
69 * General purpose flag, to save various EL3 states
70 * FFH mode : Used to identify if handling nested exception
71 * KFH mode : Used as counter value
72 */
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -060073#define CTX_NESTED_EA_FLAG U(0x40)
Manish Pandeyf90a73c2023-10-10 15:42:19 +010074#if FFH_SUPPORT
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -060075 #define CTX_SAVED_ESR_EL3 U(0x48)
76 #define CTX_SAVED_SPSR_EL3 U(0x50)
77 #define CTX_SAVED_GPREG_LR U(0x58)
78 #define CTX_EL3STATE_END U(0x60) /* Align to the next 16 byte boundary */
Manish Pandey07952fb2023-05-25 13:46:14 +010079#else
80 #define CTX_EL3STATE_END U(0x50) /* Align to the next 16 byte boundary */
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -060081#endif /* FFH_SUPPORT */
Achin Gupta9ac63c52014-01-16 12:08:03 +000082
83/*******************************************************************************
84 * Constants that allow assembler code to access members of and the
85 * 'el1_sys_regs' structure at their correct offsets. Note that some of the
86 * registers are only 32-bits wide but are stored as 64-bit values for
87 * convenience
88 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +000089#define CTX_EL1_SYSREGS_OFFSET (CTX_EL3STATE_OFFSET + CTX_EL3STATE_END)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070090#define CTX_SPSR_EL1 U(0x0)
91#define CTX_ELR_EL1 U(0x8)
92#define CTX_SCTLR_EL1 U(0x10)
Manish V Badarkhe2b0ee972020-07-28 07:22:30 +010093#define CTX_TCR_EL1 U(0x18)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070094#define CTX_CPACR_EL1 U(0x20)
95#define CTX_CSSELR_EL1 U(0x28)
96#define CTX_SP_EL1 U(0x30)
97#define CTX_ESR_EL1 U(0x38)
98#define CTX_TTBR0_EL1 U(0x40)
99#define CTX_TTBR1_EL1 U(0x48)
100#define CTX_MAIR_EL1 U(0x50)
101#define CTX_AMAIR_EL1 U(0x58)
Manish V Badarkhe2b0ee972020-07-28 07:22:30 +0100102#define CTX_ACTLR_EL1 U(0x60)
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700103#define CTX_TPIDR_EL1 U(0x68)
104#define CTX_TPIDR_EL0 U(0x70)
105#define CTX_TPIDRRO_EL0 U(0x78)
106#define CTX_PAR_EL1 U(0x80)
107#define CTX_FAR_EL1 U(0x88)
108#define CTX_AFSR0_EL1 U(0x90)
109#define CTX_AFSR1_EL1 U(0x98)
110#define CTX_CONTEXTIDR_EL1 U(0xa0)
111#define CTX_VBAR_EL1 U(0xa8)
Madhukar Pappireddybf9cb5f2024-03-25 17:49:00 -0500112#define CTX_MDCCINT_EL1 U(0xb0)
113#define CTX_MDSCR_EL1 U(0xb8)
114
115#define CTX_AARCH64_END U(0xc0) /* Align to the next 16 byte boundary */
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100116
117/*
118 * If the platform is AArch64-only, there is no need to save and restore these
119 * AArch32 registers.
120 */
121#if CTX_INCLUDE_AARCH32_REGS
Madhukar Pappireddybf9cb5f2024-03-25 17:49:00 -0500122#define CTX_SPSR_ABT (CTX_AARCH64_END + U(0x0))
123#define CTX_SPSR_UND (CTX_AARCH64_END + U(0x8))
124#define CTX_SPSR_IRQ (CTX_AARCH64_END + U(0x10))
125#define CTX_SPSR_FIQ (CTX_AARCH64_END + U(0x18))
126#define CTX_DACR32_EL2 (CTX_AARCH64_END + U(0x20))
127#define CTX_IFSR32_EL2 (CTX_AARCH64_END + U(0x28))
128#define CTX_AARCH32_END (CTX_AARCH64_END + U(0x30)) /* Align to the next 16 byte boundary */
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100129#else
Madhukar Pappireddybf9cb5f2024-03-25 17:49:00 -0500130#define CTX_AARCH32_END CTX_AARCH64_END
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000131#endif /* CTX_INCLUDE_AARCH32_REGS */
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100132
Jeenu Viswambharand1b60152014-05-12 15:28:47 +0100133/*
134 * If the timer registers aren't saved and restored, we don't have to reserve
135 * space for them in the context
136 */
137#if NS_TIMER_SWITCH
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000138#define CTX_CNTP_CTL_EL0 (CTX_AARCH32_END + U(0x0))
139#define CTX_CNTP_CVAL_EL0 (CTX_AARCH32_END + U(0x8))
140#define CTX_CNTV_CTL_EL0 (CTX_AARCH32_END + U(0x10))
141#define CTX_CNTV_CVAL_EL0 (CTX_AARCH32_END + U(0x18))
142#define CTX_CNTKCTL_EL1 (CTX_AARCH32_END + U(0x20))
143#define CTX_TIMER_SYSREGS_END (CTX_AARCH32_END + U(0x30)) /* Align to the next 16 byte boundary */
Jeenu Viswambharand1b60152014-05-12 15:28:47 +0100144#else
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000145#define CTX_TIMER_SYSREGS_END CTX_AARCH32_END
146#endif /* NS_TIMER_SWITCH */
147
Govindraj Rajac1be66f2024-03-07 14:42:20 -0600148#if ENABLE_FEAT_MTE2
Justin Chadwell1c7c13a2019-07-18 14:25:33 +0100149#define CTX_TFSRE0_EL1 (CTX_TIMER_SYSREGS_END + U(0x0))
150#define CTX_TFSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x8))
151#define CTX_RGSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x10))
152#define CTX_GCR_EL1 (CTX_TIMER_SYSREGS_END + U(0x18))
Madhukar Pappireddybf9cb5f2024-03-25 17:49:00 -0500153#define CTX_MTE_REGS_END (CTX_TIMER_SYSREGS_END + U(0x20)) /* Align to the next 16 byte boundary */
Justin Chadwell1c7c13a2019-07-18 14:25:33 +0100154#else
155#define CTX_MTE_REGS_END CTX_TIMER_SYSREGS_END
Govindraj Rajac1be66f2024-03-07 14:42:20 -0600156#endif /* ENABLE_FEAT_MTE2 */
Justin Chadwell1c7c13a2019-07-18 14:25:33 +0100157
Madhukar Pappireddybf9cb5f2024-03-25 17:49:00 -0500158#if ENABLE_FEAT_RAS
159#define CTX_DISR_EL1 (CTX_MTE_REGS_END + U(0x0))
160#define CTX_RAS_REGS_END (CTX_MTE_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
161#else
162#define CTX_RAS_REGS_END CTX_MTE_REGS_END
163#endif /* ENABLE_FEAT_RAS */
164
165#if ENABLE_FEAT_S1PIE
166#define CTX_PIRE0_EL1 (CTX_RAS_REGS_END + U(0x0))
167#define CTX_PIR_EL1 (CTX_RAS_REGS_END + U(0x8))
168#define CTX_S1PIE_REGS_END (CTX_RAS_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
169#else
170#define CTX_S1PIE_REGS_END CTX_RAS_REGS_END
171#endif /* ENABLE_FEAT_S1PIE */
172
173#if ENABLE_FEAT_S1POE
174#define CTX_POR_EL1 (CTX_S1PIE_REGS_END + U(0x0))
175#define CTX_S1POE_REGS_END (CTX_S1PIE_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
176#else
177#define CTX_S1POE_REGS_END CTX_S1PIE_REGS_END
178#endif /* ENABLE_FEAT_S1POE */
179
180#if ENABLE_FEAT_S2POE
181#define CTX_S2POR_EL1 (CTX_S1POE_REGS_END + U(0x0))
182#define CTX_S2POE_REGS_END (CTX_S1POE_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
183#else
184#define CTX_S2POE_REGS_END CTX_S1POE_REGS_END
185#endif /* ENABLE_FEAT_S2POE */
186
187#if ENABLE_FEAT_TCR2
188#define CTX_TCR2_EL1 (CTX_S2POE_REGS_END + U(0x0))
189#define CTX_TCR2_REGS_END (CTX_S2POE_REGS_END + U(0x10)) /* Align to the next 16 byte boundary */
190#else
191#define CTX_TCR2_REGS_END CTX_S2POE_REGS_END
192#endif /* ENABLE_FEAT_TCR2 */
193
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000194/*
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000195 * End of system registers.
196 */
Madhukar Pappireddybf9cb5f2024-03-25 17:49:00 -0500197#define CTX_EL1_SYSREGS_END CTX_TCR2_REGS_END
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000198
Achin Gupta9ac63c52014-01-16 12:08:03 +0000199/*******************************************************************************
200 * Constants that allow assembler code to access members of and the 'fp_regs'
201 * structure at their correct offsets.
202 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000203# define CTX_FPREGS_OFFSET (CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100204#if CTX_INCLUDE_FPREGS
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700205#define CTX_FP_Q0 U(0x0)
206#define CTX_FP_Q1 U(0x10)
207#define CTX_FP_Q2 U(0x20)
208#define CTX_FP_Q3 U(0x30)
209#define CTX_FP_Q4 U(0x40)
210#define CTX_FP_Q5 U(0x50)
211#define CTX_FP_Q6 U(0x60)
212#define CTX_FP_Q7 U(0x70)
213#define CTX_FP_Q8 U(0x80)
214#define CTX_FP_Q9 U(0x90)
215#define CTX_FP_Q10 U(0xa0)
216#define CTX_FP_Q11 U(0xb0)
217#define CTX_FP_Q12 U(0xc0)
218#define CTX_FP_Q13 U(0xd0)
219#define CTX_FP_Q14 U(0xe0)
220#define CTX_FP_Q15 U(0xf0)
221#define CTX_FP_Q16 U(0x100)
222#define CTX_FP_Q17 U(0x110)
223#define CTX_FP_Q18 U(0x120)
224#define CTX_FP_Q19 U(0x130)
225#define CTX_FP_Q20 U(0x140)
226#define CTX_FP_Q21 U(0x150)
227#define CTX_FP_Q22 U(0x160)
228#define CTX_FP_Q23 U(0x170)
229#define CTX_FP_Q24 U(0x180)
230#define CTX_FP_Q25 U(0x190)
231#define CTX_FP_Q26 U(0x1a0)
232#define CTX_FP_Q27 U(0x1b0)
233#define CTX_FP_Q28 U(0x1c0)
234#define CTX_FP_Q29 U(0x1d0)
235#define CTX_FP_Q30 U(0x1e0)
236#define CTX_FP_Q31 U(0x1f0)
237#define CTX_FP_FPSR U(0x200)
238#define CTX_FP_FPCR U(0x208)
David Cunadod1a1fd42017-10-20 11:30:57 +0100239#if CTX_INCLUDE_AARCH32_REGS
240#define CTX_FP_FPEXC32_EL2 U(0x210)
241#define CTX_FPREGS_END U(0x220) /* Align to the next 16 byte boundary */
242#else
243#define CTX_FPREGS_END U(0x210) /* Align to the next 16 byte boundary */
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000244#endif /* CTX_INCLUDE_AARCH32_REGS */
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100245#else
246#define CTX_FPREGS_END U(0)
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000247#endif /* CTX_INCLUDE_FPREGS */
Achin Gupta9ac63c52014-01-16 12:08:03 +0000248
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000249/*******************************************************************************
250 * Registers related to CVE-2018-3639
251 ******************************************************************************/
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100252#define CTX_CVE_2018_3639_OFFSET (CTX_FPREGS_OFFSET + CTX_FPREGS_END)
253#define CTX_CVE_2018_3639_DISABLE U(0)
254#define CTX_CVE_2018_3639_END U(0x10) /* Align to the next 16 byte boundary */
255
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000256/*******************************************************************************
257 * Registers related to ARMv8.3-PAuth.
258 ******************************************************************************/
259#define CTX_PAUTH_REGS_OFFSET (CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
260#if CTX_INCLUDE_PAUTH_REGS
261#define CTX_PACIAKEY_LO U(0x0)
262#define CTX_PACIAKEY_HI U(0x8)
263#define CTX_PACIBKEY_LO U(0x10)
264#define CTX_PACIBKEY_HI U(0x18)
265#define CTX_PACDAKEY_LO U(0x20)
266#define CTX_PACDAKEY_HI U(0x28)
267#define CTX_PACDBKEY_LO U(0x30)
268#define CTX_PACDBKEY_HI U(0x38)
269#define CTX_PACGAKEY_LO U(0x40)
270#define CTX_PACGAKEY_HI U(0x48)
Alexei Fedorovf41355c2019-09-13 14:11:59 +0100271#define CTX_PAUTH_REGS_END U(0x50) /* Align to the next 16 byte boundary */
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000272#else
273#define CTX_PAUTH_REGS_END U(0)
274#endif /* CTX_INCLUDE_PAUTH_REGS */
275
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100276/*******************************************************************************
Arvind Ram Prakash4851b492023-10-06 14:35:21 -0500277 * Registers related to ARMv8.2-MPAM.
278 ******************************************************************************/
279#define CTX_MPAM_REGS_OFFSET (CTX_PAUTH_REGS_OFFSET + CTX_PAUTH_REGS_END)
280#if CTX_INCLUDE_MPAM_REGS
281#define CTX_MPAM2_EL2 U(0x0)
282#define CTX_MPAMHCR_EL2 U(0x8)
283#define CTX_MPAMVPM0_EL2 U(0x10)
284#define CTX_MPAMVPM1_EL2 U(0x18)
285#define CTX_MPAMVPM2_EL2 U(0x20)
286#define CTX_MPAMVPM3_EL2 U(0x28)
287#define CTX_MPAMVPM4_EL2 U(0x30)
288#define CTX_MPAMVPM5_EL2 U(0x38)
289#define CTX_MPAMVPM6_EL2 U(0x40)
290#define CTX_MPAMVPM7_EL2 U(0x48)
291#define CTX_MPAMVPMV_EL2 U(0x50)
292#define CTX_MPAM_REGS_END U(0x60)
293#else
294#define CTX_MPAM_REGS_END U(0x0)
295#endif /* CTX_INCLUDE_MPAM_REGS */
296
297/*******************************************************************************
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100298 * Registers initialised in a per-world context.
299 ******************************************************************************/
Jayanth Dodderi Chidanand56aa3822023-12-11 11:22:02 +0000300#define CTX_CPTR_EL3 U(0x0)
301#define CTX_ZCR_EL3 U(0x8)
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -0600302#define CTX_MPAM3_EL3 U(0x10)
303#define CTX_PERWORLD_EL3STATE_END U(0x18)
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100304
Julius Werner53456fc2019-07-09 13:49:11 -0700305#ifndef __ASSEMBLER__
Achin Gupta9ac63c52014-01-16 12:08:03 +0000306
Dan Handley2bd4ef22014-04-09 13:14:54 +0100307#include <stdint.h>
308
Antonio Nino Diaze0f90632018-12-14 00:18:21 +0000309#include <lib/cassert.h>
310
Achin Gupta9ac63c52014-01-16 12:08:03 +0000311/*
312 * Common constants to help define the 'cpu_context' structure and its
313 * members below.
314 */
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700315#define DWORD_SHIFT U(3)
Achin Gupta9ac63c52014-01-16 12:08:03 +0000316#define DEFINE_REG_STRUCT(name, num_regs) \
Dan Handleye2712bc2014-04-10 15:37:22 +0100317 typedef struct name { \
Zelalem91d80612020-02-12 10:37:03 -0600318 uint64_t ctx_regs[num_regs]; \
Dan Handleye2712bc2014-04-10 15:37:22 +0100319 } __aligned(16) name##_t
Achin Gupta9ac63c52014-01-16 12:08:03 +0000320
321/* Constants to determine the size of individual context structures */
Achin Gupta07f4e072014-02-02 12:02:23 +0000322#define CTX_GPREG_ALL (CTX_GPREGS_END >> DWORD_SHIFT)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000323#define CTX_EL1_SYSREGS_ALL (CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000324
Juan Castillo258e94f2014-06-25 17:26:36 +0100325#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000326# define CTX_FPREG_ALL (CTX_FPREGS_END >> DWORD_SHIFT)
Juan Castillo258e94f2014-06-25 17:26:36 +0100327#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000328#define CTX_EL3STATE_ALL (CTX_EL3STATE_END >> DWORD_SHIFT)
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100329#define CTX_CVE_2018_3639_ALL (CTX_CVE_2018_3639_END >> DWORD_SHIFT)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000330#if CTX_INCLUDE_PAUTH_REGS
331# define CTX_PAUTH_REGS_ALL (CTX_PAUTH_REGS_END >> DWORD_SHIFT)
332#endif
Arvind Ram Prakash4851b492023-10-06 14:35:21 -0500333#if CTX_INCLUDE_MPAM_REGS
334# define CTX_MPAM_REGS_ALL (CTX_MPAM_REGS_END >> DWORD_SHIFT)
335#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000336
337/*
Soby Mathew6c5192a2014-04-30 15:36:37 +0100338 * AArch64 general purpose register context structure. Usually x0-x18,
339 * lr are saved as the compiler is expected to preserve the remaining
Achin Gupta07f4e072014-02-02 12:02:23 +0000340 * callee saved registers if used by the C runtime and the assembler
Soby Mathew6c5192a2014-04-30 15:36:37 +0100341 * does not touch the remaining. But in case of world switch during
342 * exception handling, we need to save the callee registers too.
Achin Gupta07f4e072014-02-02 12:02:23 +0000343 */
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000344DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
Achin Gupta07f4e072014-02-02 12:02:23 +0000345
346/*
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000347 * AArch64 EL1 system register context structure for preserving the
348 * architectural state during world switches.
349 */
350DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
351
Achin Gupta9ac63c52014-01-16 12:08:03 +0000352/*
353 * AArch64 floating point register context structure for preserving
354 * the floating point state during switches from one security state to
355 * another.
356 */
Juan Castillo258e94f2014-06-25 17:26:36 +0100357#if CTX_INCLUDE_FPREGS
Achin Gupta9ac63c52014-01-16 12:08:03 +0000358DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
Juan Castillo258e94f2014-06-25 17:26:36 +0100359#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000360
361/*
362 * Miscellaneous registers used by EL3 firmware to maintain its state
363 * across exception entries and exits
364 */
365DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
366
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100367/* Function pointer used by CVE-2018-3639 dynamic mitigation */
368DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
369
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000370/* Registers associated to ARMv8.3-PAuth */
371#if CTX_INCLUDE_PAUTH_REGS
372DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
373#endif
374
Arvind Ram Prakash4851b492023-10-06 14:35:21 -0500375/* Registers associated to ARMv8.2 MPAM */
376#if CTX_INCLUDE_MPAM_REGS
377DEFINE_REG_STRUCT(mpam, CTX_MPAM_REGS_ALL);
378#endif
379
Achin Gupta9ac63c52014-01-16 12:08:03 +0000380/*
381 * Macros to access members of any of the above structures using their
382 * offsets
383 */
Zelalem91d80612020-02-12 10:37:03 -0600384#define read_ctx_reg(ctx, offset) ((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
385#define write_ctx_reg(ctx, offset, val) (((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100386 = (uint64_t) (val))
Achin Gupta9ac63c52014-01-16 12:08:03 +0000387
388/*
Zelalem Awekeb6301e62021-07-09 17:54:30 -0500389 * Top-level context structure which is used by EL3 firmware to preserve
390 * the state of a core at the next lower EL in a given security state and
391 * save enough EL3 meta data to be able to return to that EL and security
392 * state. The context management library will be used to ensure that
393 * SP_EL3 always points to an instance of this structure at exception
394 * entry and exit.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000395 */
Dan Handleye2712bc2014-04-10 15:37:22 +0100396typedef struct cpu_context {
397 gp_regs_t gpregs_ctx;
398 el3_state_t el3state_ctx;
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000399 el1_sysregs_t el1_sysregs_ctx;
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000400
Juan Castillo258e94f2014-06-25 17:26:36 +0100401#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100402 fp_regs_t fpregs_ctx;
Juan Castillo258e94f2014-06-25 17:26:36 +0100403#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100404 cve_2018_3639_t cve_2018_3639_ctx;
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000405
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000406#if CTX_INCLUDE_PAUTH_REGS
407 pauth_t pauth_ctx;
408#endif
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000409
Arvind Ram Prakash4851b492023-10-06 14:35:21 -0500410#if CTX_INCLUDE_MPAM_REGS
411 mpam_t mpam_ctx;
412#endif
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000413
414#if CTX_INCLUDE_EL2_REGS
415 el2_sysregs_t el2_sysregs_ctx;
416#endif
417
Dan Handleye2712bc2014-04-10 15:37:22 +0100418} cpu_context_t;
Achin Gupta9ac63c52014-01-16 12:08:03 +0000419
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100420/*
421 * Per-World Context.
422 * It stores registers whose values can be shared across CPUs.
423 */
424typedef struct per_world_context {
425 uint64_t ctx_cptr_el3;
426 uint64_t ctx_zcr_el3;
Arvind Ram Prakashb5d95592023-11-08 12:28:30 -0600427 uint64_t ctx_mpam3_el3;
Elizabeth Ho4fc00d22023-07-18 14:10:25 +0100428} per_world_context_t;
429
430extern per_world_context_t per_world_context[CPU_DATA_CONTEXT_NUM];
431
Dan Handleye2712bc2014-04-10 15:37:22 +0100432/* Macros to access members of the 'cpu_context_t' structure */
433#define get_el3state_ctx(h) (&((cpu_context_t *) h)->el3state_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100434#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000435# define get_fpregs_ctx(h) (&((cpu_context_t *) h)->fpregs_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100436#endif
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000437#define get_el1_sysregs_ctx(h) (&((cpu_context_t *) h)->el1_sysregs_ctx)
438#if CTX_INCLUDE_EL2_REGS
439# define get_el2_sysregs_ctx(h) (&((cpu_context_t *) h)->el2_sysregs_ctx)
440#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100441#define get_gpregs_ctx(h) (&((cpu_context_t *) h)->gpregs_ctx)
Dimitris Papastamosbb1fd5b2018-06-07 11:29:15 +0100442#define get_cve_2018_3639_ctx(h) (&((cpu_context_t *) h)->cve_2018_3639_ctx)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000443#if CTX_INCLUDE_PAUTH_REGS
444# define get_pauth_ctx(h) (&((cpu_context_t *) h)->pauth_ctx)
445#endif
Arvind Ram Prakash4851b492023-10-06 14:35:21 -0500446#if CTX_INCLUDE_MPAM_REGS
447# define get_mpam_ctx(h) (&((cpu_context_t *) h)->mpam_ctx)
448#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000449
450/*
451 * Compile time assertions related to the 'cpu_context' structure to
452 * ensure that the assembler and the compiler view of the offsets of
453 * the structure members is the same.
454 */
Elyes Haouas183638f2023-02-13 10:05:41 +0100455CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx),
Achin Gupta07f4e072014-02-02 12:02:23 +0000456 assert_core_context_gp_offset_mismatch);
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000457
458CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx),
459 assert_core_context_el3state_offset_mismatch);
460
Elyes Haouas183638f2023-02-13 10:05:41 +0100461CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx),
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000462 assert_core_context_el1_sys_offset_mismatch);
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000463
Juan Castillo258e94f2014-06-25 17:26:36 +0100464#if CTX_INCLUDE_FPREGS
Elyes Haouas183638f2023-02-13 10:05:41 +0100465CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx),
Achin Gupta9ac63c52014-01-16 12:08:03 +0000466 assert_core_context_fp_offset_mismatch);
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000467#endif /* CTX_INCLUDE_FPREGS */
468
Elyes Haouas183638f2023-02-13 10:05:41 +0100469CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx),
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100470 assert_core_context_cve_2018_3639_offset_mismatch);
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000471
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000472#if CTX_INCLUDE_PAUTH_REGS
Elyes Haouas183638f2023-02-13 10:05:41 +0100473CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx),
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000474 assert_core_context_pauth_offset_mismatch);
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000475#endif /* CTX_INCLUDE_PAUTH_REGS */
476
Arvind Ram Prakash4851b492023-10-06 14:35:21 -0500477#if CTX_INCLUDE_MPAM_REGS
478CASSERT(CTX_MPAM_REGS_OFFSET == __builtin_offsetof(cpu_context_t, mpam_ctx),
479 assert_core_context_mpam_offset_mismatch);
Jayanth Dodderi Chidanandfbbee6b2024-01-24 20:05:07 +0000480#endif /* CTX_INCLUDE_MPAM_REGS */
Achin Gupta9ac63c52014-01-16 12:08:03 +0000481
Achin Gupta607084e2014-02-09 18:24:19 +0000482/*
483 * Helper macro to set the general purpose registers that correspond to
484 * parameters in an aapcs_64 call i.e. x0-x7
485 */
486#define set_aapcs_args0(ctx, x0) do { \
487 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100488 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000489#define set_aapcs_args1(ctx, x0, x1) do { \
490 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1); \
491 set_aapcs_args0(ctx, x0); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100492 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000493#define set_aapcs_args2(ctx, x0, x1, x2) do { \
494 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2); \
495 set_aapcs_args1(ctx, x0, x1); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100496 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000497#define set_aapcs_args3(ctx, x0, x1, x2, x3) do { \
498 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3); \
499 set_aapcs_args2(ctx, x0, x1, x2); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100500 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000501#define set_aapcs_args4(ctx, x0, x1, x2, x3, x4) do { \
502 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4); \
503 set_aapcs_args3(ctx, x0, x1, x2, x3); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100504 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000505#define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5) do { \
506 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5); \
507 set_aapcs_args4(ctx, x0, x1, x2, x3, x4); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100508 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000509#define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6) do { \
510 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6); \
511 set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100512 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000513#define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7) do { \
514 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7); \
515 set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100516 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000517
Achin Gupta9ac63c52014-01-16 12:08:03 +0000518/*******************************************************************************
519 * Function prototypes
520 ******************************************************************************/
Juan Castillo258e94f2014-06-25 17:26:36 +0100521#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100522void fpregs_context_save(fp_regs_t *regs);
523void fpregs_context_restore(fp_regs_t *regs);
Juan Castillo258e94f2014-06-25 17:26:36 +0100524#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000525
Julius Werner53456fc2019-07-09 13:49:11 -0700526#endif /* __ASSEMBLER__ */
Achin Gupta9ac63c52014-01-16 12:08:03 +0000527
Antonio Nino Diaz864ca6f2018-10-31 15:25:35 +0000528#endif /* CONTEXT_H */