blob: 57cf5f04d9c0dbab1f65031e6a7e260ef7feb002 [file] [log] [blame]
Achin Gupta9ac63c52014-01-16 12:08:03 +00001/*
Jayanth Dodderi Chidanand72b69b82022-01-26 17:14:43 +00002 * Copyright (c) 2013-2022, 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
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000010#include <lib/utils_def.h>
Jeenu Viswambharan96c7df02017-11-30 12:54:15 +000011
Achin Gupta9ac63c52014-01-16 12:08:03 +000012/*******************************************************************************
Achin Gupta07f4e072014-02-02 12:02:23 +000013 * Constants that allow assembler code to access members of and the 'gp_regs'
14 * structure at their correct offsets.
15 ******************************************************************************/
Varun Wadekarc6a11f62017-05-25 18:04:48 -070016#define CTX_GPREGS_OFFSET U(0x0)
17#define CTX_GPREG_X0 U(0x0)
18#define CTX_GPREG_X1 U(0x8)
19#define CTX_GPREG_X2 U(0x10)
20#define CTX_GPREG_X3 U(0x18)
21#define CTX_GPREG_X4 U(0x20)
22#define CTX_GPREG_X5 U(0x28)
23#define CTX_GPREG_X6 U(0x30)
24#define CTX_GPREG_X7 U(0x38)
25#define CTX_GPREG_X8 U(0x40)
26#define CTX_GPREG_X9 U(0x48)
27#define CTX_GPREG_X10 U(0x50)
28#define CTX_GPREG_X11 U(0x58)
29#define CTX_GPREG_X12 U(0x60)
30#define CTX_GPREG_X13 U(0x68)
31#define CTX_GPREG_X14 U(0x70)
32#define CTX_GPREG_X15 U(0x78)
33#define CTX_GPREG_X16 U(0x80)
34#define CTX_GPREG_X17 U(0x88)
35#define CTX_GPREG_X18 U(0x90)
36#define CTX_GPREG_X19 U(0x98)
37#define CTX_GPREG_X20 U(0xa0)
38#define CTX_GPREG_X21 U(0xa8)
39#define CTX_GPREG_X22 U(0xb0)
40#define CTX_GPREG_X23 U(0xb8)
41#define CTX_GPREG_X24 U(0xc0)
42#define CTX_GPREG_X25 U(0xc8)
43#define CTX_GPREG_X26 U(0xd0)
44#define CTX_GPREG_X27 U(0xd8)
45#define CTX_GPREG_X28 U(0xe0)
46#define CTX_GPREG_X29 U(0xe8)
47#define CTX_GPREG_LR U(0xf0)
48#define CTX_GPREG_SP_EL0 U(0xf8)
49#define CTX_GPREGS_END U(0x100)
Achin Gupta07f4e072014-02-02 12:02:23 +000050
51/*******************************************************************************
Achin Gupta9ac63c52014-01-16 12:08:03 +000052 * Constants that allow assembler code to access members of and the 'el3_state'
53 * structure at their correct offsets. Note that some of the registers are only
54 * 32-bits wide but are stored as 64-bit values for convenience
55 ******************************************************************************/
Dimitris Papastamosb63c6f12018-01-11 15:29:36 +000056#define CTX_EL3STATE_OFFSET (CTX_GPREGS_OFFSET + CTX_GPREGS_END)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070057#define CTX_SCR_EL3 U(0x0)
Jeenu Viswambharan96c7df02017-11-30 12:54:15 +000058#define CTX_ESR_EL3 U(0x8)
59#define CTX_RUNTIME_SP U(0x10)
60#define CTX_SPSR_EL3 U(0x18)
61#define CTX_ELR_EL3 U(0x20)
Alexei Fedorov503bbf32019-08-13 15:17:53 +010062#define CTX_PMCR_EL0 U(0x28)
Madhukar Pappireddyfba25722020-07-24 03:27:12 -050063#define CTX_IS_IN_EL3 U(0x30)
Max Shvetsovc4502772021-03-22 11:59:37 +000064#define CTX_CPTR_EL3 U(0x38)
65#define CTX_ZCR_EL3 U(0x40)
66#define CTX_EL3STATE_END U(0x50) /* 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
196// Only if ENABLE_MPAM_FOR_LOWER_ELS==1
Max Shvetsovcf784f72021-03-31 19:00:38 +0100197#define CTX_MPAM2_EL2 U(0x108)
198#define CTX_MPAMHCR_EL2 U(0x110)
199#define CTX_MPAMVPM0_EL2 U(0x118)
200#define CTX_MPAMVPM1_EL2 U(0x120)
201#define CTX_MPAMVPM2_EL2 U(0x128)
202#define CTX_MPAMVPM3_EL2 U(0x130)
203#define CTX_MPAMVPM4_EL2 U(0x138)
204#define CTX_MPAMVPM5_EL2 U(0x140)
205#define CTX_MPAMVPM6_EL2 U(0x148)
206#define CTX_MPAMVPM7_EL2 U(0x150)
207#define CTX_MPAMVPMV_EL2 U(0x158)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000208
209// Starting with Armv8.6
Jayanth Dodderi Chidanand13ae0f42021-11-25 14:59:30 +0000210#define CTX_HDFGRTR_EL2 U(0x160)
211#define CTX_HAFGRTR_EL2 U(0x168)
Max Shvetsovcf784f72021-03-31 19:00:38 +0100212#define CTX_HDFGWTR_EL2 U(0x170)
213#define CTX_HFGITR_EL2 U(0x178)
214#define CTX_HFGRTR_EL2 U(0x180)
215#define CTX_HFGWTR_EL2 U(0x188)
216#define CTX_CNTPOFF_EL2 U(0x190)
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000217
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000218// Starting with Armv8.4
Max Shvetsovcf784f72021-03-31 19:00:38 +0100219#define CTX_CONTEXTIDR_EL2 U(0x198)
Jayanth Dodderi Chidanand72b69b82022-01-26 17:14:43 +0000220#define CTX_TTBR1_EL2 U(0x1a0)
221#define CTX_VDISR_EL2 U(0x1a8)
222#define CTX_VSESR_EL2 U(0x1b0)
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500223#define CTX_VNCR_EL2 U(0x1b8)
224#define CTX_TRFCR_EL2 U(0x1c0)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000225
226// Starting with Armv8.5
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500227#define CTX_SCXTNUM_EL2 U(0x1c8)
johpow01f91e59f2021-08-04 19:38:18 -0500228
229// Register for FEAT_HCX
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500230#define CTX_HCRX_EL2 U(0x1d0)
johpow01f91e59f2021-08-04 19:38:18 -0500231
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000232/* Align to the next 16 byte boundary */
Zelalem Awekebd17eae2021-11-03 13:31:53 -0500233#define CTX_EL2_SYSREGS_END U(0x1e0)
Olivier Deprez19628912020-03-20 14:22:05 +0100234
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000235#endif /* CTX_INCLUDE_EL2_REGS */
236
Achin Gupta9ac63c52014-01-16 12:08:03 +0000237/*******************************************************************************
238 * Constants that allow assembler code to access members of and the 'fp_regs'
239 * structure at their correct offsets.
240 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000241#if CTX_INCLUDE_EL2_REGS
242# define CTX_FPREGS_OFFSET (CTX_EL2_SYSREGS_OFFSET + CTX_EL2_SYSREGS_END)
243#else
244# define CTX_FPREGS_OFFSET (CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
245#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100246#if CTX_INCLUDE_FPREGS
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700247#define CTX_FP_Q0 U(0x0)
248#define CTX_FP_Q1 U(0x10)
249#define CTX_FP_Q2 U(0x20)
250#define CTX_FP_Q3 U(0x30)
251#define CTX_FP_Q4 U(0x40)
252#define CTX_FP_Q5 U(0x50)
253#define CTX_FP_Q6 U(0x60)
254#define CTX_FP_Q7 U(0x70)
255#define CTX_FP_Q8 U(0x80)
256#define CTX_FP_Q9 U(0x90)
257#define CTX_FP_Q10 U(0xa0)
258#define CTX_FP_Q11 U(0xb0)
259#define CTX_FP_Q12 U(0xc0)
260#define CTX_FP_Q13 U(0xd0)
261#define CTX_FP_Q14 U(0xe0)
262#define CTX_FP_Q15 U(0xf0)
263#define CTX_FP_Q16 U(0x100)
264#define CTX_FP_Q17 U(0x110)
265#define CTX_FP_Q18 U(0x120)
266#define CTX_FP_Q19 U(0x130)
267#define CTX_FP_Q20 U(0x140)
268#define CTX_FP_Q21 U(0x150)
269#define CTX_FP_Q22 U(0x160)
270#define CTX_FP_Q23 U(0x170)
271#define CTX_FP_Q24 U(0x180)
272#define CTX_FP_Q25 U(0x190)
273#define CTX_FP_Q26 U(0x1a0)
274#define CTX_FP_Q27 U(0x1b0)
275#define CTX_FP_Q28 U(0x1c0)
276#define CTX_FP_Q29 U(0x1d0)
277#define CTX_FP_Q30 U(0x1e0)
278#define CTX_FP_Q31 U(0x1f0)
279#define CTX_FP_FPSR U(0x200)
280#define CTX_FP_FPCR U(0x208)
David Cunadod1a1fd42017-10-20 11:30:57 +0100281#if CTX_INCLUDE_AARCH32_REGS
282#define CTX_FP_FPEXC32_EL2 U(0x210)
283#define CTX_FPREGS_END U(0x220) /* Align to the next 16 byte boundary */
284#else
285#define CTX_FPREGS_END U(0x210) /* Align to the next 16 byte boundary */
286#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100287#else
288#define CTX_FPREGS_END U(0)
Juan Castillo258e94f2014-06-25 17:26:36 +0100289#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000290
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000291/*******************************************************************************
292 * Registers related to CVE-2018-3639
293 ******************************************************************************/
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100294#define CTX_CVE_2018_3639_OFFSET (CTX_FPREGS_OFFSET + CTX_FPREGS_END)
295#define CTX_CVE_2018_3639_DISABLE U(0)
296#define CTX_CVE_2018_3639_END U(0x10) /* Align to the next 16 byte boundary */
297
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000298/*******************************************************************************
299 * Registers related to ARMv8.3-PAuth.
300 ******************************************************************************/
301#define CTX_PAUTH_REGS_OFFSET (CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
302#if CTX_INCLUDE_PAUTH_REGS
303#define CTX_PACIAKEY_LO U(0x0)
304#define CTX_PACIAKEY_HI U(0x8)
305#define CTX_PACIBKEY_LO U(0x10)
306#define CTX_PACIBKEY_HI U(0x18)
307#define CTX_PACDAKEY_LO U(0x20)
308#define CTX_PACDAKEY_HI U(0x28)
309#define CTX_PACDBKEY_LO U(0x30)
310#define CTX_PACDBKEY_HI U(0x38)
311#define CTX_PACGAKEY_LO U(0x40)
312#define CTX_PACGAKEY_HI U(0x48)
Alexei Fedorovf41355c2019-09-13 14:11:59 +0100313#define CTX_PAUTH_REGS_END U(0x50) /* Align to the next 16 byte boundary */
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000314#else
315#define CTX_PAUTH_REGS_END U(0)
316#endif /* CTX_INCLUDE_PAUTH_REGS */
317
Julius Werner53456fc2019-07-09 13:49:11 -0700318#ifndef __ASSEMBLER__
Achin Gupta9ac63c52014-01-16 12:08:03 +0000319
Dan Handley2bd4ef22014-04-09 13:14:54 +0100320#include <stdint.h>
321
Antonio Nino Diaze0f90632018-12-14 00:18:21 +0000322#include <lib/cassert.h>
323
Achin Gupta9ac63c52014-01-16 12:08:03 +0000324/*
325 * Common constants to help define the 'cpu_context' structure and its
326 * members below.
327 */
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700328#define DWORD_SHIFT U(3)
Achin Gupta9ac63c52014-01-16 12:08:03 +0000329#define DEFINE_REG_STRUCT(name, num_regs) \
Dan Handleye2712bc2014-04-10 15:37:22 +0100330 typedef struct name { \
Zelalem91d80612020-02-12 10:37:03 -0600331 uint64_t ctx_regs[num_regs]; \
Dan Handleye2712bc2014-04-10 15:37:22 +0100332 } __aligned(16) name##_t
Achin Gupta9ac63c52014-01-16 12:08:03 +0000333
334/* Constants to determine the size of individual context structures */
Achin Gupta07f4e072014-02-02 12:02:23 +0000335#define CTX_GPREG_ALL (CTX_GPREGS_END >> DWORD_SHIFT)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000336#define CTX_EL1_SYSREGS_ALL (CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
337#if CTX_INCLUDE_EL2_REGS
338# define CTX_EL2_SYSREGS_ALL (CTX_EL2_SYSREGS_END >> DWORD_SHIFT)
339#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100340#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000341# define CTX_FPREG_ALL (CTX_FPREGS_END >> DWORD_SHIFT)
Juan Castillo258e94f2014-06-25 17:26:36 +0100342#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000343#define CTX_EL3STATE_ALL (CTX_EL3STATE_END >> DWORD_SHIFT)
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100344#define CTX_CVE_2018_3639_ALL (CTX_CVE_2018_3639_END >> DWORD_SHIFT)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000345#if CTX_INCLUDE_PAUTH_REGS
346# define CTX_PAUTH_REGS_ALL (CTX_PAUTH_REGS_END >> DWORD_SHIFT)
347#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000348
349/*
Soby Mathew6c5192a2014-04-30 15:36:37 +0100350 * AArch64 general purpose register context structure. Usually x0-x18,
351 * lr are saved as the compiler is expected to preserve the remaining
Achin Gupta07f4e072014-02-02 12:02:23 +0000352 * callee saved registers if used by the C runtime and the assembler
Soby Mathew6c5192a2014-04-30 15:36:37 +0100353 * does not touch the remaining. But in case of world switch during
354 * exception handling, we need to save the callee registers too.
Achin Gupta07f4e072014-02-02 12:02:23 +0000355 */
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000356DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
Achin Gupta07f4e072014-02-02 12:02:23 +0000357
358/*
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000359 * AArch64 EL1 system register context structure for preserving the
360 * architectural state during world switches.
361 */
362DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
363
364
365/*
366 * AArch64 EL2 system register context structure for preserving the
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000367 * architectural state during world switches.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000368 */
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000369#if CTX_INCLUDE_EL2_REGS
370DEFINE_REG_STRUCT(el2_sysregs, CTX_EL2_SYSREGS_ALL);
371#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000372
373/*
374 * AArch64 floating point register context structure for preserving
375 * the floating point state during switches from one security state to
376 * another.
377 */
Juan Castillo258e94f2014-06-25 17:26:36 +0100378#if CTX_INCLUDE_FPREGS
Achin Gupta9ac63c52014-01-16 12:08:03 +0000379DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
Juan Castillo258e94f2014-06-25 17:26:36 +0100380#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000381
382/*
383 * Miscellaneous registers used by EL3 firmware to maintain its state
384 * across exception entries and exits
385 */
386DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
387
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100388/* Function pointer used by CVE-2018-3639 dynamic mitigation */
389DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
390
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000391/* Registers associated to ARMv8.3-PAuth */
392#if CTX_INCLUDE_PAUTH_REGS
393DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
394#endif
395
Achin Gupta9ac63c52014-01-16 12:08:03 +0000396/*
397 * Macros to access members of any of the above structures using their
398 * offsets
399 */
Zelalem91d80612020-02-12 10:37:03 -0600400#define read_ctx_reg(ctx, offset) ((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
401#define write_ctx_reg(ctx, offset, val) (((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100402 = (uint64_t) (val))
Achin Gupta9ac63c52014-01-16 12:08:03 +0000403
404/*
Zelalem Awekeb6301e62021-07-09 17:54:30 -0500405 * Top-level context structure which is used by EL3 firmware to preserve
406 * the state of a core at the next lower EL in a given security state and
407 * save enough EL3 meta data to be able to return to that EL and security
408 * state. The context management library will be used to ensure that
409 * SP_EL3 always points to an instance of this structure at exception
410 * entry and exit.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000411 */
Dan Handleye2712bc2014-04-10 15:37:22 +0100412typedef struct cpu_context {
413 gp_regs_t gpregs_ctx;
414 el3_state_t el3state_ctx;
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000415 el1_sysregs_t el1_sysregs_ctx;
416#if CTX_INCLUDE_EL2_REGS
417 el2_sysregs_t el2_sysregs_ctx;
418#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100419#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100420 fp_regs_t fpregs_ctx;
Juan Castillo258e94f2014-06-25 17:26:36 +0100421#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100422 cve_2018_3639_t cve_2018_3639_ctx;
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000423#if CTX_INCLUDE_PAUTH_REGS
424 pauth_t pauth_ctx;
425#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100426} cpu_context_t;
Achin Gupta9ac63c52014-01-16 12:08:03 +0000427
Dan Handleye2712bc2014-04-10 15:37:22 +0100428/* Macros to access members of the 'cpu_context_t' structure */
429#define get_el3state_ctx(h) (&((cpu_context_t *) h)->el3state_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100430#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000431# define get_fpregs_ctx(h) (&((cpu_context_t *) h)->fpregs_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100432#endif
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000433#define get_el1_sysregs_ctx(h) (&((cpu_context_t *) h)->el1_sysregs_ctx)
434#if CTX_INCLUDE_EL2_REGS
435# define get_el2_sysregs_ctx(h) (&((cpu_context_t *) h)->el2_sysregs_ctx)
436#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100437#define get_gpregs_ctx(h) (&((cpu_context_t *) h)->gpregs_ctx)
Dimitris Papastamosbb1fd5b2018-06-07 11:29:15 +0100438#define get_cve_2018_3639_ctx(h) (&((cpu_context_t *) h)->cve_2018_3639_ctx)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000439#if CTX_INCLUDE_PAUTH_REGS
440# define get_pauth_ctx(h) (&((cpu_context_t *) h)->pauth_ctx)
441#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000442
443/*
444 * Compile time assertions related to the 'cpu_context' structure to
445 * ensure that the assembler and the compiler view of the offsets of
446 * the structure members is the same.
447 */
Dan Handleye2712bc2014-04-10 15:37:22 +0100448CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx), \
Achin Gupta07f4e072014-02-02 12:02:23 +0000449 assert_core_context_gp_offset_mismatch);
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000450CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx), \
451 assert_core_context_el1_sys_offset_mismatch);
452#if CTX_INCLUDE_EL2_REGS
453CASSERT(CTX_EL2_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el2_sysregs_ctx), \
454 assert_core_context_el2_sys_offset_mismatch);
455#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100456#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100457CASSERT(CTX_FPREGS_OFFSET == __builtin_offsetof(cpu_context_t, fpregs_ctx), \
Achin Gupta9ac63c52014-01-16 12:08:03 +0000458 assert_core_context_fp_offset_mismatch);
Juan Castillo258e94f2014-06-25 17:26:36 +0100459#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100460CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx), \
Achin Gupta9ac63c52014-01-16 12:08:03 +0000461 assert_core_context_el3state_offset_mismatch);
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100462CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx), \
463 assert_core_context_cve_2018_3639_offset_mismatch);
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000464#if CTX_INCLUDE_PAUTH_REGS
465CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx), \
466 assert_core_context_pauth_offset_mismatch);
467#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000468
Achin Gupta607084e2014-02-09 18:24:19 +0000469/*
470 * Helper macro to set the general purpose registers that correspond to
471 * parameters in an aapcs_64 call i.e. x0-x7
472 */
473#define set_aapcs_args0(ctx, x0) do { \
474 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X0, x0); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100475 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000476#define set_aapcs_args1(ctx, x0, x1) do { \
477 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X1, x1); \
478 set_aapcs_args0(ctx, x0); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100479 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000480#define set_aapcs_args2(ctx, x0, x1, x2) do { \
481 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X2, x2); \
482 set_aapcs_args1(ctx, x0, x1); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100483 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000484#define set_aapcs_args3(ctx, x0, x1, x2, x3) do { \
485 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X3, x3); \
486 set_aapcs_args2(ctx, x0, x1, x2); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100487 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000488#define set_aapcs_args4(ctx, x0, x1, x2, x3, x4) do { \
489 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X4, x4); \
490 set_aapcs_args3(ctx, x0, x1, x2, x3); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100491 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000492#define set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5) do { \
493 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X5, x5); \
494 set_aapcs_args4(ctx, x0, x1, x2, x3, x4); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100495 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000496#define set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6) do { \
497 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X6, x6); \
498 set_aapcs_args5(ctx, x0, x1, x2, x3, x4, x5); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100499 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000500#define set_aapcs_args7(ctx, x0, x1, x2, x3, x4, x5, x6, x7) do { \
501 write_ctx_reg(get_gpregs_ctx(ctx), CTX_GPREG_X7, x7); \
502 set_aapcs_args6(ctx, x0, x1, x2, x3, x4, x5, x6); \
Soby Mathew24ab34f2016-05-03 17:11:42 +0100503 } while (0)
Achin Gupta607084e2014-02-09 18:24:19 +0000504
Achin Gupta9ac63c52014-01-16 12:08:03 +0000505/*******************************************************************************
506 * Function prototypes
507 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000508void el1_sysregs_context_save(el1_sysregs_t *regs);
509void el1_sysregs_context_restore(el1_sysregs_t *regs);
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000510
511#if CTX_INCLUDE_EL2_REGS
Zelalem Aweke5362beb2022-04-04 17:42:48 -0500512void el2_sysregs_context_save_common(el2_sysregs_t *regs);
513void el2_sysregs_context_restore_common(el2_sysregs_t *regs);
514#if ENABLE_SPE_FOR_LOWER_ELS
515void el2_sysregs_context_save_spe(el2_sysregs_t *regs);
516void el2_sysregs_context_restore_spe(el2_sysregs_t *regs);
517#endif /* ENABLE_SPE_FOR_LOWER_ELS */
518#if CTX_INCLUDE_MTE_REGS
519void el2_sysregs_context_save_mte(el2_sysregs_t *regs);
520void el2_sysregs_context_restore_mte(el2_sysregs_t *regs);
521#endif /* CTX_INCLUDE_MTE_REGS */
522#if ENABLE_MPAM_FOR_LOWER_ELS
523void el2_sysregs_context_save_mpam(el2_sysregs_t *regs);
524void el2_sysregs_context_restore_mpam(el2_sysregs_t *regs);
525#endif /* ENABLE_MPAM_FOR_LOWER_ELS */
Zelalem Aweke5362beb2022-04-04 17:42:48 -0500526#if ENABLE_FEAT_ECV
527void el2_sysregs_context_save_ecv(el2_sysregs_t *regs);
528void el2_sysregs_context_restore_ecv(el2_sysregs_t *regs);
529#endif /* ENABLE_FEAT_ECV */
530#if ENABLE_FEAT_VHE
531void el2_sysregs_context_save_vhe(el2_sysregs_t *regs);
532void el2_sysregs_context_restore_vhe(el2_sysregs_t *regs);
533#endif /* ENABLE_FEAT_VHE */
534#if RAS_EXTENSION
535void el2_sysregs_context_save_ras(el2_sysregs_t *regs);
536void el2_sysregs_context_restore_ras(el2_sysregs_t *regs);
537#endif /* RAS_EXTENSION */
538#if CTX_INCLUDE_NEVE_REGS
539void el2_sysregs_context_save_nv2(el2_sysregs_t *regs);
540void el2_sysregs_context_restore_nv2(el2_sysregs_t *regs);
541#endif /* CTX_INCLUDE_NEVE_REGS */
Zelalem Aweke5362beb2022-04-04 17:42:48 -0500542#if ENABLE_FEAT_CSV2_2
543void el2_sysregs_context_save_csv2(el2_sysregs_t *regs);
544void el2_sysregs_context_restore_csv2(el2_sysregs_t *regs);
545#endif /* ENABLE_FEAT_CSV2_2 */
Zelalem Aweke5362beb2022-04-04 17:42:48 -0500546#endif /* CTX_INCLUDE_EL2_REGS */
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000547
Juan Castillo258e94f2014-06-25 17:26:36 +0100548#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100549void fpregs_context_save(fp_regs_t *regs);
550void fpregs_context_restore(fp_regs_t *regs);
Juan Castillo258e94f2014-06-25 17:26:36 +0100551#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000552
Julius Werner53456fc2019-07-09 13:49:11 -0700553#endif /* __ASSEMBLER__ */
Achin Gupta9ac63c52014-01-16 12:08:03 +0000554
Antonio Nino Diaz864ca6f2018-10-31 15:25:35 +0000555#endif /* CONTEXT_H */