xref: /rk3399_ARM-atf/include/lib/el3_runtime/context_mgmt.h (revision 8f64ed92c42f050c4217870e03ce48f95d4c251f)
1 /*
2  * Copyright (c) 2013-2025, Arm Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef CONTEXT_MGMT_H
8 #define CONTEXT_MGMT_H
9 
10 #include <assert.h>
11 #include <context.h>
12 #include <stdint.h>
13 
14 #include <arch.h>
15 
16 /*******************************************************************************
17  * Forward declarations
18  ******************************************************************************/
19 struct entry_point_info;
20 
21 /*******************************************************************************
22  * Function & variable prototypes
23  ******************************************************************************/
24 void cm_init(void);
25 void *cm_get_context_by_index(unsigned int cpu_idx,
26 			      size_t security_state);
27 void cm_set_context_by_index(unsigned int cpu_idx,
28 			     void *context,
29 			     unsigned int security_state);
30 void *cm_get_context(size_t security_state);
31 void cm_set_context(void *context, uint32_t security_state);
32 void cm_init_my_context(const struct entry_point_info *ep);
33 void cm_setup_context(cpu_context_t *ctx, const struct entry_point_info *ep);
34 void cm_prepare_el3_exit(size_t security_state);
35 void cm_prepare_el3_exit_ns(void);
36 
37 #ifdef __aarch64__
38 void cm_manage_extensions_el3(unsigned int my_idx);
39 void cm_manage_extensions_per_world(void);
40 
41 #if (CTX_INCLUDE_EL2_REGS && IMAGE_BL31)
42 void cm_el2_sysregs_context_save(uint32_t security_state);
43 void cm_el2_sysregs_context_restore(uint32_t security_state);
44 #else
45 void cm_el1_sysregs_context_save(uint32_t security_state);
46 void cm_el1_sysregs_context_restore(uint32_t security_state);
47 #endif /* (CTX_INCLUDE_EL2_REGS && IMAGE_BL31) */
48 
49 void cm_set_elr_el3(uint32_t security_state, uintptr_t entrypoint);
50 void cm_set_elr_spsr_el3(uint32_t security_state,
51 			uintptr_t entrypoint, uint32_t spsr);
52 void cm_write_scr_el3_bit(uint32_t security_state,
53 			  uint32_t bit_pos,
54 			  uint32_t value);
55 void cm_set_next_eret_context(uint32_t security_state);
56 u_register_t cm_get_scr_el3(uint32_t security_state);
57 
58 /* Inline definitions */
59 
60 /*******************************************************************************
61  * This function is used to program the context that's used for exception
62  * return. This initializes the SP_EL3 to a pointer to a 'cpu_context' set for
63  * the required security state
64  ******************************************************************************/
65 static inline void cm_set_next_context(void *context)
66 {
67 #if ENABLE_ASSERTIONS
68 	uint64_t sp_mode;
69 
70 	/*
71 	 * Check that this function is called with SP_EL0 as the stack
72 	 * pointer
73 	 */
74 	__asm__ volatile("mrs	%0, SPSel\n"
75 			 : "=r" (sp_mode));
76 
77 	assert(sp_mode == MODE_SP_EL0);
78 #endif /* ENABLE_ASSERTIONS */
79 
80 	__asm__ volatile("msr	spsel, #1\n"
81 			 "mov	sp, %0\n"
82 			 "msr	spsel, #0\n"
83 			 : : "r" (context));
84 }
85 
86 #else
87 void *cm_get_next_context(void);
88 void cm_set_next_context(void *context);
89 static inline void cm_manage_extensions_el3(unsigned int cpu_idx) {}
90 static inline void cm_manage_extensions_per_world(void) {}
91 #endif /* __aarch64__ */
92 
93 #endif /* CONTEXT_MGMT_H */
94