xref: /rk3399_ARM-atf/include/lib/el3_runtime/context_mgmt.h (revision b10d44995eb652675863c2cc6a7726683613da0d)
1 /*
2  * Copyright (c) 2013-2017, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef __CM_H__
32 #define __CM_H__
33 
34 #ifndef AARCH32
35 #include <arch.h>
36 #include <assert.h>
37 #include <stdint.h>
38 #endif
39 
40 /*******************************************************************************
41  * Forward declarations
42  ******************************************************************************/
43 struct entry_point_info;
44 
45 /*******************************************************************************
46  * Function & variable prototypes
47  ******************************************************************************/
48 void cm_init(void);
49 void *cm_get_context_by_index(unsigned int cpu_idx,
50 			      unsigned int security_state);
51 void cm_set_context_by_index(unsigned int cpu_idx,
52 			     void *context,
53 			     unsigned int security_state);
54 void *cm_get_context(uint32_t security_state);
55 void cm_set_context(void *context, uint32_t security_state);
56 void cm_init_my_context(const struct entry_point_info *ep);
57 void cm_init_context_by_index(unsigned int cpu_idx,
58 			      const struct entry_point_info *ep);
59 void cm_prepare_el3_exit(uint32_t security_state);
60 
61 #ifndef AARCH32
62 void cm_el1_sysregs_context_save(uint32_t security_state);
63 void cm_el1_sysregs_context_restore(uint32_t security_state);
64 void cm_set_elr_el3(uint32_t security_state, uintptr_t entrypoint);
65 void cm_set_elr_spsr_el3(uint32_t security_state,
66 			uintptr_t entrypoint, uint32_t spsr);
67 void cm_write_scr_el3_bit(uint32_t security_state,
68 			  uint32_t bit_pos,
69 			  uint32_t value);
70 void cm_set_next_eret_context(uint32_t security_state);
71 uint32_t cm_get_scr_el3(uint32_t security_state);
72 
73 
74 void cm_init_context(uint64_t mpidr,
75 		     const struct entry_point_info *ep) __deprecated;
76 
77 void *cm_get_context_by_mpidr(uint64_t mpidr,
78 			      uint32_t security_state) __deprecated;
79 void cm_set_context_by_mpidr(uint64_t mpidr,
80 			     void *context,
81 			     uint32_t security_state) __deprecated;
82 
83 /* Inline definitions */
84 
85 /*******************************************************************************
86  * This function is used to program the context that's used for exception
87  * return. This initializes the SP_EL3 to a pointer to a 'cpu_context' set for
88  * the required security state
89  ******************************************************************************/
90 static inline void cm_set_next_context(void *context)
91 {
92 #if ENABLE_ASSERTIONS
93 	uint64_t sp_mode;
94 
95 	/*
96 	 * Check that this function is called with SP_EL0 as the stack
97 	 * pointer
98 	 */
99 	__asm__ volatile("mrs	%0, SPSel\n"
100 			 : "=r" (sp_mode));
101 
102 	assert(sp_mode == MODE_SP_EL0);
103 #endif /* ENABLE_ASSERTIONS */
104 
105 	__asm__ volatile("msr	spsel, #1\n"
106 			 "mov	sp, %0\n"
107 			 "msr	spsel, #0\n"
108 			 : : "r" (context));
109 }
110 
111 #else
112 void *cm_get_next_context(void);
113 #endif /* AARCH32 */
114 
115 #endif /* __CM_H__ */
116