blob: 9d9f9d3325557ee3253058baf0944477339a3b22 [file] [log] [blame]
Achin Gupta9ac63c52014-01-16 12:08:03 +00001/*
Madhukar Pappireddyfba25722020-07-24 03:27:12 -05002 * Copyright (c) 2013-2021, 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)
64#define CTX_EL3STATE_END U(0x40) /* Align to the next 16 byte boundary */
Achin Gupta9ac63c52014-01-16 12:08:03 +000065
66/*******************************************************************************
67 * Constants that allow assembler code to access members of and the
68 * 'el1_sys_regs' structure at their correct offsets. Note that some of the
69 * registers are only 32-bits wide but are stored as 64-bit values for
70 * convenience
71 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +000072#define CTX_EL1_SYSREGS_OFFSET (CTX_EL3STATE_OFFSET + CTX_EL3STATE_END)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070073#define CTX_SPSR_EL1 U(0x0)
74#define CTX_ELR_EL1 U(0x8)
75#define CTX_SCTLR_EL1 U(0x10)
Manish V Badarkhe2b0ee972020-07-28 07:22:30 +010076#define CTX_TCR_EL1 U(0x18)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070077#define CTX_CPACR_EL1 U(0x20)
78#define CTX_CSSELR_EL1 U(0x28)
79#define CTX_SP_EL1 U(0x30)
80#define CTX_ESR_EL1 U(0x38)
81#define CTX_TTBR0_EL1 U(0x40)
82#define CTX_TTBR1_EL1 U(0x48)
83#define CTX_MAIR_EL1 U(0x50)
84#define CTX_AMAIR_EL1 U(0x58)
Manish V Badarkhe2b0ee972020-07-28 07:22:30 +010085#define CTX_ACTLR_EL1 U(0x60)
Varun Wadekarc6a11f62017-05-25 18:04:48 -070086#define CTX_TPIDR_EL1 U(0x68)
87#define CTX_TPIDR_EL0 U(0x70)
88#define CTX_TPIDRRO_EL0 U(0x78)
89#define CTX_PAR_EL1 U(0x80)
90#define CTX_FAR_EL1 U(0x88)
91#define CTX_AFSR0_EL1 U(0x90)
92#define CTX_AFSR1_EL1 U(0x98)
93#define CTX_CONTEXTIDR_EL1 U(0xa0)
94#define CTX_VBAR_EL1 U(0xa8)
Soby Mathewd75d2ba2016-05-17 14:01:32 +010095
96/*
97 * If the platform is AArch64-only, there is no need to save and restore these
98 * AArch32 registers.
99 */
100#if CTX_INCLUDE_AARCH32_REGS
Alexei Fedorov503bbf32019-08-13 15:17:53 +0100101#define CTX_SPSR_ABT U(0xb0) /* Align to the next 16 byte boundary */
102#define CTX_SPSR_UND U(0xb8)
103#define CTX_SPSR_IRQ U(0xc0)
104#define CTX_SPSR_FIQ U(0xc8)
105#define CTX_DACR32_EL2 U(0xd0)
106#define CTX_IFSR32_EL2 U(0xd8)
107#define CTX_AARCH32_END U(0xe0) /* Align to the next 16 byte boundary */
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100108#else
Alexei Fedorov503bbf32019-08-13 15:17:53 +0100109#define CTX_AARCH32_END U(0xb0) /* Align to the next 16 byte boundary */
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000110#endif /* CTX_INCLUDE_AARCH32_REGS */
Soby Mathewd75d2ba2016-05-17 14:01:32 +0100111
Jeenu Viswambharand1b60152014-05-12 15:28:47 +0100112/*
113 * If the timer registers aren't saved and restored, we don't have to reserve
114 * space for them in the context
115 */
116#if NS_TIMER_SWITCH
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000117#define CTX_CNTP_CTL_EL0 (CTX_AARCH32_END + U(0x0))
118#define CTX_CNTP_CVAL_EL0 (CTX_AARCH32_END + U(0x8))
119#define CTX_CNTV_CTL_EL0 (CTX_AARCH32_END + U(0x10))
120#define CTX_CNTV_CVAL_EL0 (CTX_AARCH32_END + U(0x18))
121#define CTX_CNTKCTL_EL1 (CTX_AARCH32_END + U(0x20))
122#define CTX_TIMER_SYSREGS_END (CTX_AARCH32_END + U(0x30)) /* Align to the next 16 byte boundary */
Jeenu Viswambharand1b60152014-05-12 15:28:47 +0100123#else
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000124#define CTX_TIMER_SYSREGS_END CTX_AARCH32_END
125#endif /* NS_TIMER_SWITCH */
126
Justin Chadwell1c7c13a2019-07-18 14:25:33 +0100127#if CTX_INCLUDE_MTE_REGS
128#define CTX_TFSRE0_EL1 (CTX_TIMER_SYSREGS_END + U(0x0))
129#define CTX_TFSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x8))
130#define CTX_RGSR_EL1 (CTX_TIMER_SYSREGS_END + U(0x10))
131#define CTX_GCR_EL1 (CTX_TIMER_SYSREGS_END + U(0x18))
132
133/* Align to the next 16 byte boundary */
134#define CTX_MTE_REGS_END (CTX_TIMER_SYSREGS_END + U(0x20))
135#else
136#define CTX_MTE_REGS_END CTX_TIMER_SYSREGS_END
137#endif /* CTX_INCLUDE_MTE_REGS */
138
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000139/*
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000140 * End of system registers.
141 */
142#define CTX_EL1_SYSREGS_END CTX_MTE_REGS_END
143
144/*
145 * EL2 register set
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000146 */
147
148#if CTX_INCLUDE_EL2_REGS
149/* For later discussion
150 * ICH_AP0R<n>_EL2
151 * ICH_AP1R<n>_EL2
152 * AMEVCNTVOFF0<n>_EL2
153 * AMEVCNTVOFF1<n>_EL2
154 * ICH_LR<n>_EL2
155 */
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000156#define CTX_EL2_SYSREGS_OFFSET (CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
157
158#define CTX_ACTLR_EL2 U(0x0)
159#define CTX_AFSR0_EL2 U(0x8)
160#define CTX_AFSR1_EL2 U(0x10)
161#define CTX_AMAIR_EL2 U(0x18)
162#define CTX_CNTHCTL_EL2 U(0x20)
Max Shvetsovcf784f72021-03-31 19:00:38 +0100163#define CTX_CNTVOFF_EL2 U(0x28)
164#define CTX_CPTR_EL2 U(0x30)
165#define CTX_DBGVCR32_EL2 U(0x38)
166#define CTX_ELR_EL2 U(0x40)
167#define CTX_ESR_EL2 U(0x48)
168#define CTX_FAR_EL2 U(0x50)
169#define CTX_HACR_EL2 U(0x58)
170#define CTX_HCR_EL2 U(0x60)
171#define CTX_HPFAR_EL2 U(0x68)
172#define CTX_HSTR_EL2 U(0x70)
173#define CTX_ICC_SRE_EL2 U(0x78)
174#define CTX_ICH_HCR_EL2 U(0x80)
175#define CTX_ICH_VMCR_EL2 U(0x88)
176#define CTX_MAIR_EL2 U(0x90)
177#define CTX_MDCR_EL2 U(0x98)
178#define CTX_PMSCR_EL2 U(0xa0)
179#define CTX_SCTLR_EL2 U(0xa8)
180#define CTX_SPSR_EL2 U(0xb0)
181#define CTX_SP_EL2 U(0xb8)
182#define CTX_TCR_EL2 U(0xc0)
183#define CTX_TPIDR_EL2 U(0xc8)
184#define CTX_TTBR0_EL2 U(0xd0)
185#define CTX_VBAR_EL2 U(0xd8)
186#define CTX_VMPIDR_EL2 U(0xe0)
187#define CTX_VPIDR_EL2 U(0xe8)
188#define CTX_VTCR_EL2 U(0xf0)
189#define CTX_VTTBR_EL2 U(0xf8)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000190
191// Only if MTE registers in use
Max Shvetsovcf784f72021-03-31 19:00:38 +0100192#define CTX_TFSR_EL2 U(0x100)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000193
194// Only if ENABLE_MPAM_FOR_LOWER_ELS==1
Max Shvetsovcf784f72021-03-31 19:00:38 +0100195#define CTX_MPAM2_EL2 U(0x108)
196#define CTX_MPAMHCR_EL2 U(0x110)
197#define CTX_MPAMVPM0_EL2 U(0x118)
198#define CTX_MPAMVPM1_EL2 U(0x120)
199#define CTX_MPAMVPM2_EL2 U(0x128)
200#define CTX_MPAMVPM3_EL2 U(0x130)
201#define CTX_MPAMVPM4_EL2 U(0x138)
202#define CTX_MPAMVPM5_EL2 U(0x140)
203#define CTX_MPAMVPM6_EL2 U(0x148)
204#define CTX_MPAMVPM7_EL2 U(0x150)
205#define CTX_MPAMVPMV_EL2 U(0x158)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000206
207// Starting with Armv8.6
Max Shvetsovcf784f72021-03-31 19:00:38 +0100208#define CTX_HAFGRTR_EL2 U(0x160)
209#define CTX_HDFGRTR_EL2 U(0x168)
210#define CTX_HDFGWTR_EL2 U(0x170)
211#define CTX_HFGITR_EL2 U(0x178)
212#define CTX_HFGRTR_EL2 U(0x180)
213#define CTX_HFGWTR_EL2 U(0x188)
214#define CTX_CNTPOFF_EL2 U(0x190)
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000215
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000216// Starting with Armv8.4
Max Shvetsovcf784f72021-03-31 19:00:38 +0100217#define CTX_CONTEXTIDR_EL2 U(0x198)
218#define CTX_SDER32_EL2 U(0x1a0)
219#define CTX_TTBR1_EL2 U(0x1a8)
220#define CTX_VDISR_EL2 U(0x1b0)
221#define CTX_VNCR_EL2 U(0x1b8)
222#define CTX_VSESR_EL2 U(0x1c0)
223#define CTX_VSTCR_EL2 U(0x1c8)
224#define CTX_VSTTBR_EL2 U(0x1d0)
225#define CTX_TRFCR_EL2 U(0x1d8)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000226
227// Starting with Armv8.5
Max Shvetsovcf784f72021-03-31 19:00:38 +0100228#define CTX_SCXTNUM_EL2 U(0x1e0)
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000229/* Align to the next 16 byte boundary */
Max Shvetsovcf784f72021-03-31 19:00:38 +0100230#define CTX_EL2_SYSREGS_END U(0x1f0)
Olivier Deprez19628912020-03-20 14:22:05 +0100231
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000232#endif /* CTX_INCLUDE_EL2_REGS */
233
Achin Gupta9ac63c52014-01-16 12:08:03 +0000234/*******************************************************************************
235 * Constants that allow assembler code to access members of and the 'fp_regs'
236 * structure at their correct offsets.
237 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000238#if CTX_INCLUDE_EL2_REGS
239# define CTX_FPREGS_OFFSET (CTX_EL2_SYSREGS_OFFSET + CTX_EL2_SYSREGS_END)
240#else
241# define CTX_FPREGS_OFFSET (CTX_EL1_SYSREGS_OFFSET + CTX_EL1_SYSREGS_END)
242#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100243#if CTX_INCLUDE_FPREGS
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700244#define CTX_FP_Q0 U(0x0)
245#define CTX_FP_Q1 U(0x10)
246#define CTX_FP_Q2 U(0x20)
247#define CTX_FP_Q3 U(0x30)
248#define CTX_FP_Q4 U(0x40)
249#define CTX_FP_Q5 U(0x50)
250#define CTX_FP_Q6 U(0x60)
251#define CTX_FP_Q7 U(0x70)
252#define CTX_FP_Q8 U(0x80)
253#define CTX_FP_Q9 U(0x90)
254#define CTX_FP_Q10 U(0xa0)
255#define CTX_FP_Q11 U(0xb0)
256#define CTX_FP_Q12 U(0xc0)
257#define CTX_FP_Q13 U(0xd0)
258#define CTX_FP_Q14 U(0xe0)
259#define CTX_FP_Q15 U(0xf0)
260#define CTX_FP_Q16 U(0x100)
261#define CTX_FP_Q17 U(0x110)
262#define CTX_FP_Q18 U(0x120)
263#define CTX_FP_Q19 U(0x130)
264#define CTX_FP_Q20 U(0x140)
265#define CTX_FP_Q21 U(0x150)
266#define CTX_FP_Q22 U(0x160)
267#define CTX_FP_Q23 U(0x170)
268#define CTX_FP_Q24 U(0x180)
269#define CTX_FP_Q25 U(0x190)
270#define CTX_FP_Q26 U(0x1a0)
271#define CTX_FP_Q27 U(0x1b0)
272#define CTX_FP_Q28 U(0x1c0)
273#define CTX_FP_Q29 U(0x1d0)
274#define CTX_FP_Q30 U(0x1e0)
275#define CTX_FP_Q31 U(0x1f0)
276#define CTX_FP_FPSR U(0x200)
277#define CTX_FP_FPCR U(0x208)
David Cunadod1a1fd42017-10-20 11:30:57 +0100278#if CTX_INCLUDE_AARCH32_REGS
279#define CTX_FP_FPEXC32_EL2 U(0x210)
280#define CTX_FPREGS_END U(0x220) /* Align to the next 16 byte boundary */
281#else
282#define CTX_FPREGS_END U(0x210) /* Align to the next 16 byte boundary */
283#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100284#else
285#define CTX_FPREGS_END U(0)
Juan Castillo258e94f2014-06-25 17:26:36 +0100286#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000287
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000288/*******************************************************************************
289 * Registers related to CVE-2018-3639
290 ******************************************************************************/
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100291#define CTX_CVE_2018_3639_OFFSET (CTX_FPREGS_OFFSET + CTX_FPREGS_END)
292#define CTX_CVE_2018_3639_DISABLE U(0)
293#define CTX_CVE_2018_3639_END U(0x10) /* Align to the next 16 byte boundary */
294
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000295/*******************************************************************************
296 * Registers related to ARMv8.3-PAuth.
297 ******************************************************************************/
298#define CTX_PAUTH_REGS_OFFSET (CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_END)
299#if CTX_INCLUDE_PAUTH_REGS
300#define CTX_PACIAKEY_LO U(0x0)
301#define CTX_PACIAKEY_HI U(0x8)
302#define CTX_PACIBKEY_LO U(0x10)
303#define CTX_PACIBKEY_HI U(0x18)
304#define CTX_PACDAKEY_LO U(0x20)
305#define CTX_PACDAKEY_HI U(0x28)
306#define CTX_PACDBKEY_LO U(0x30)
307#define CTX_PACDBKEY_HI U(0x38)
308#define CTX_PACGAKEY_LO U(0x40)
309#define CTX_PACGAKEY_HI U(0x48)
Alexei Fedorovf41355c2019-09-13 14:11:59 +0100310#define CTX_PAUTH_REGS_END U(0x50) /* Align to the next 16 byte boundary */
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000311#else
312#define CTX_PAUTH_REGS_END U(0)
313#endif /* CTX_INCLUDE_PAUTH_REGS */
314
Julius Werner53456fc2019-07-09 13:49:11 -0700315#ifndef __ASSEMBLER__
Achin Gupta9ac63c52014-01-16 12:08:03 +0000316
Dan Handley2bd4ef22014-04-09 13:14:54 +0100317#include <stdint.h>
318
Antonio Nino Diaze0f90632018-12-14 00:18:21 +0000319#include <lib/cassert.h>
320
Achin Gupta9ac63c52014-01-16 12:08:03 +0000321/*
322 * Common constants to help define the 'cpu_context' structure and its
323 * members below.
324 */
Varun Wadekarc6a11f62017-05-25 18:04:48 -0700325#define DWORD_SHIFT U(3)
Achin Gupta9ac63c52014-01-16 12:08:03 +0000326#define DEFINE_REG_STRUCT(name, num_regs) \
Dan Handleye2712bc2014-04-10 15:37:22 +0100327 typedef struct name { \
Zelalem91d80612020-02-12 10:37:03 -0600328 uint64_t ctx_regs[num_regs]; \
Dan Handleye2712bc2014-04-10 15:37:22 +0100329 } __aligned(16) name##_t
Achin Gupta9ac63c52014-01-16 12:08:03 +0000330
331/* Constants to determine the size of individual context structures */
Achin Gupta07f4e072014-02-02 12:02:23 +0000332#define CTX_GPREG_ALL (CTX_GPREGS_END >> DWORD_SHIFT)
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000333#define CTX_EL1_SYSREGS_ALL (CTX_EL1_SYSREGS_END >> DWORD_SHIFT)
334#if CTX_INCLUDE_EL2_REGS
335# define CTX_EL2_SYSREGS_ALL (CTX_EL2_SYSREGS_END >> DWORD_SHIFT)
336#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100337#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000338# define CTX_FPREG_ALL (CTX_FPREGS_END >> DWORD_SHIFT)
Juan Castillo258e94f2014-06-25 17:26:36 +0100339#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000340#define CTX_EL3STATE_ALL (CTX_EL3STATE_END >> DWORD_SHIFT)
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100341#define CTX_CVE_2018_3639_ALL (CTX_CVE_2018_3639_END >> DWORD_SHIFT)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000342#if CTX_INCLUDE_PAUTH_REGS
343# define CTX_PAUTH_REGS_ALL (CTX_PAUTH_REGS_END >> DWORD_SHIFT)
344#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000345
346/*
Soby Mathew6c5192a2014-04-30 15:36:37 +0100347 * AArch64 general purpose register context structure. Usually x0-x18,
348 * lr are saved as the compiler is expected to preserve the remaining
Achin Gupta07f4e072014-02-02 12:02:23 +0000349 * callee saved registers if used by the C runtime and the assembler
Soby Mathew6c5192a2014-04-30 15:36:37 +0100350 * does not touch the remaining. But in case of world switch during
351 * exception handling, we need to save the callee registers too.
Achin Gupta07f4e072014-02-02 12:02:23 +0000352 */
Jeenu Viswambharancaa84932014-02-06 10:36:15 +0000353DEFINE_REG_STRUCT(gp_regs, CTX_GPREG_ALL);
Achin Gupta07f4e072014-02-02 12:02:23 +0000354
355/*
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000356 * AArch64 EL1 system register context structure for preserving the
357 * architectural state during world switches.
358 */
359DEFINE_REG_STRUCT(el1_sysregs, CTX_EL1_SYSREGS_ALL);
360
361
362/*
363 * AArch64 EL2 system register context structure for preserving the
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000364 * architectural state during world switches.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000365 */
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000366#if CTX_INCLUDE_EL2_REGS
367DEFINE_REG_STRUCT(el2_sysregs, CTX_EL2_SYSREGS_ALL);
368#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000369
370/*
371 * AArch64 floating point register context structure for preserving
372 * the floating point state during switches from one security state to
373 * another.
374 */
Juan Castillo258e94f2014-06-25 17:26:36 +0100375#if CTX_INCLUDE_FPREGS
Achin Gupta9ac63c52014-01-16 12:08:03 +0000376DEFINE_REG_STRUCT(fp_regs, CTX_FPREG_ALL);
Juan Castillo258e94f2014-06-25 17:26:36 +0100377#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000378
379/*
380 * Miscellaneous registers used by EL3 firmware to maintain its state
381 * across exception entries and exits
382 */
383DEFINE_REG_STRUCT(el3_state, CTX_EL3STATE_ALL);
384
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100385/* Function pointer used by CVE-2018-3639 dynamic mitigation */
386DEFINE_REG_STRUCT(cve_2018_3639, CTX_CVE_2018_3639_ALL);
387
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000388/* Registers associated to ARMv8.3-PAuth */
389#if CTX_INCLUDE_PAUTH_REGS
390DEFINE_REG_STRUCT(pauth, CTX_PAUTH_REGS_ALL);
391#endif
392
Achin Gupta9ac63c52014-01-16 12:08:03 +0000393/*
394 * Macros to access members of any of the above structures using their
395 * offsets
396 */
Zelalem91d80612020-02-12 10:37:03 -0600397#define read_ctx_reg(ctx, offset) ((ctx)->ctx_regs[(offset) >> DWORD_SHIFT])
398#define write_ctx_reg(ctx, offset, val) (((ctx)->ctx_regs[(offset) >> DWORD_SHIFT]) \
Jeenu Viswambharan32ceef52018-08-02 10:14:12 +0100399 = (uint64_t) (val))
Achin Gupta9ac63c52014-01-16 12:08:03 +0000400
401/*
402 * Top-level context structure which is used by EL3 firmware to
403 * preserve the state of a core at EL1 in one of the two security
404 * states and save enough EL3 meta data to be able to return to that
405 * EL and security state. The context management library will be used
406 * to ensure that SP_EL3 always points to an instance of this
407 * structure at exception entry and exit. Each instance will
408 * correspond to either the secure or the non-secure state.
409 */
Dan Handleye2712bc2014-04-10 15:37:22 +0100410typedef struct cpu_context {
411 gp_regs_t gpregs_ctx;
412 el3_state_t el3state_ctx;
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000413 el1_sysregs_t el1_sysregs_ctx;
414#if CTX_INCLUDE_EL2_REGS
415 el2_sysregs_t el2_sysregs_ctx;
416#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100417#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100418 fp_regs_t fpregs_ctx;
Juan Castillo258e94f2014-06-25 17:26:36 +0100419#endif
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100420 cve_2018_3639_t cve_2018_3639_ctx;
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000421#if CTX_INCLUDE_PAUTH_REGS
422 pauth_t pauth_ctx;
423#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100424} cpu_context_t;
Achin Gupta9ac63c52014-01-16 12:08:03 +0000425
Dan Handleye2712bc2014-04-10 15:37:22 +0100426/* Macros to access members of the 'cpu_context_t' structure */
427#define get_el3state_ctx(h) (&((cpu_context_t *) h)->el3state_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100428#if CTX_INCLUDE_FPREGS
Antonio Nino Diaz13adfb12019-01-30 20:41:31 +0000429# define get_fpregs_ctx(h) (&((cpu_context_t *) h)->fpregs_ctx)
Juan Castillo258e94f2014-06-25 17:26:36 +0100430#endif
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000431#define get_el1_sysregs_ctx(h) (&((cpu_context_t *) h)->el1_sysregs_ctx)
432#if CTX_INCLUDE_EL2_REGS
433# define get_el2_sysregs_ctx(h) (&((cpu_context_t *) h)->el2_sysregs_ctx)
434#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100435#define get_gpregs_ctx(h) (&((cpu_context_t *) h)->gpregs_ctx)
Dimitris Papastamosbb1fd5b2018-06-07 11:29:15 +0100436#define get_cve_2018_3639_ctx(h) (&((cpu_context_t *) h)->cve_2018_3639_ctx)
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000437#if CTX_INCLUDE_PAUTH_REGS
438# define get_pauth_ctx(h) (&((cpu_context_t *) h)->pauth_ctx)
439#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000440
441/*
442 * Compile time assertions related to the 'cpu_context' structure to
443 * ensure that the assembler and the compiler view of the offsets of
444 * the structure members is the same.
445 */
Dan Handleye2712bc2014-04-10 15:37:22 +0100446CASSERT(CTX_GPREGS_OFFSET == __builtin_offsetof(cpu_context_t, gpregs_ctx), \
Achin Gupta07f4e072014-02-02 12:02:23 +0000447 assert_core_context_gp_offset_mismatch);
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000448CASSERT(CTX_EL1_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el1_sysregs_ctx), \
449 assert_core_context_el1_sys_offset_mismatch);
450#if CTX_INCLUDE_EL2_REGS
451CASSERT(CTX_EL2_SYSREGS_OFFSET == __builtin_offsetof(cpu_context_t, el2_sysregs_ctx), \
452 assert_core_context_el2_sys_offset_mismatch);
453#endif
Juan Castillo258e94f2014-06-25 17:26:36 +0100454#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +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);
Juan Castillo258e94f2014-06-25 17:26:36 +0100457#endif
Dan Handleye2712bc2014-04-10 15:37:22 +0100458CASSERT(CTX_EL3STATE_OFFSET == __builtin_offsetof(cpu_context_t, el3state_ctx), \
Achin Gupta9ac63c52014-01-16 12:08:03 +0000459 assert_core_context_el3state_offset_mismatch);
Dimitris Papastamosba51d9e2018-05-16 11:36:14 +0100460CASSERT(CTX_CVE_2018_3639_OFFSET == __builtin_offsetof(cpu_context_t, cve_2018_3639_ctx), \
461 assert_core_context_cve_2018_3639_offset_mismatch);
Antonio Nino Diaz594811b2019-01-31 11:58:00 +0000462#if CTX_INCLUDE_PAUTH_REGS
463CASSERT(CTX_PAUTH_REGS_OFFSET == __builtin_offsetof(cpu_context_t, pauth_ctx), \
464 assert_core_context_pauth_offset_mismatch);
465#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000466
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 Mathew24ab34f2016-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 Mathew24ab34f2016-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 Mathew24ab34f2016-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 Mathew24ab34f2016-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 Mathew24ab34f2016-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 Mathew24ab34f2016-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 Mathew24ab34f2016-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 Mathew24ab34f2016-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 ******************************************************************************/
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000506void el1_sysregs_context_save(el1_sysregs_t *regs);
507void el1_sysregs_context_restore(el1_sysregs_t *regs);
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000508
509#if CTX_INCLUDE_EL2_REGS
Max Shvetsovc9e2c922020-02-17 16:15:47 +0000510void el2_sysregs_context_save(el2_sysregs_t *regs);
511void el2_sysregs_context_restore(el2_sysregs_t *regs);
Max Shvetsovbdf502d2020-02-25 13:56:19 +0000512#endif
513
Juan Castillo258e94f2014-06-25 17:26:36 +0100514#if CTX_INCLUDE_FPREGS
Dan Handleye2712bc2014-04-10 15:37:22 +0100515void fpregs_context_save(fp_regs_t *regs);
516void fpregs_context_restore(fp_regs_t *regs);
Juan Castillo258e94f2014-06-25 17:26:36 +0100517#endif
Achin Gupta9ac63c52014-01-16 12:08:03 +0000518
Julius Werner53456fc2019-07-09 13:49:11 -0700519#endif /* __ASSEMBLER__ */
Achin Gupta9ac63c52014-01-16 12:08:03 +0000520
Antonio Nino Diaz864ca6f2018-10-31 15:25:35 +0000521#endif /* CONTEXT_H */