1 /*
2  * Copyright (c) 2013-2014, 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 #include <cpu_data.h>
35 #include <stdint.h>
36 
37 /*******************************************************************************
38  * Forward declarations
39  ******************************************************************************/
40 struct entry_point_info;
41 
42 /*******************************************************************************
43  * Function & variable prototypes
44  ******************************************************************************/
45 void cm_init(void);
46 void *cm_get_context_by_mpidr(uint64_t mpidr, uint32_t security_state);
47 static inline void *cm_get_context(uint32_t security_state);
48 void cm_set_context_by_mpidr(uint64_t mpidr,
49 			     void *context,
50 			     uint32_t security_state);
51 static inline void cm_set_context(void *context, uint32_t security_state);
52 void cm_init_context(uint64_t mpidr, const struct entry_point_info *ep);
53 void cm_prepare_el3_exit(uint32_t security_state);
54 void cm_el1_sysregs_context_save(uint32_t security_state);
55 void cm_el1_sysregs_context_restore(uint32_t security_state);
56 void cm_set_elr_el3(uint32_t security_state, uint64_t entrypoint);
57 void cm_set_elr_spsr_el3(uint32_t security_state,
58 			 uint64_t entrypoint, uint32_t spsr);
59 void cm_write_scr_el3_bit(uint32_t security_state,
60 			  uint32_t bit_pos,
61 			  uint32_t value);
62 void cm_set_next_eret_context(uint32_t security_state);
63 uint32_t cm_get_scr_el3(uint32_t security_state);
64 
65 /* Inline definitions */
66 
67 /*******************************************************************************
68  * This function returns a pointer to the most recent 'cpu_context' structure
69  * for the calling CPU that was set as the context for the specified security
70  * state. NULL is returned if no such structure has been specified.
71  ******************************************************************************/
cm_get_context(uint32_t security_state)72 void *cm_get_context(uint32_t security_state)
73 {
74 	assert(security_state <= NON_SECURE);
75 
76 	return get_cpu_data(cpu_context[security_state]);
77 }
78 
79 /*******************************************************************************
80  * This function sets the pointer to the current 'cpu_context' structure for the
81  * specified security state for the calling CPU
82  ******************************************************************************/
cm_set_context(void * context,uint32_t security_state)83 void cm_set_context(void *context, uint32_t security_state)
84 {
85 	assert(security_state <= NON_SECURE);
86 
87 	set_cpu_data(cpu_context[security_state], context);
88 }
89 
90 
91 #endif /* __CM_H__ */
92