Sanitise includes across codebase
[project/bcm63xx/atf.git] / include / lib / el3_runtime / context_mgmt.h
1 /*
2 * Copyright (c) 2013-2018, 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 unsigned int 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(uint32_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_init_context_by_index(unsigned int cpu_idx,
34 const struct entry_point_info *ep);
35 void cm_setup_context(cpu_context_t *ctx, const entry_point_info_t *ep);
36 void cm_prepare_el3_exit(uint32_t security_state);
37
38 #ifndef AARCH32
39 void cm_el1_sysregs_context_save(uint32_t security_state);
40 void cm_el1_sysregs_context_restore(uint32_t security_state);
41 void cm_set_elr_el3(uint32_t security_state, uintptr_t entrypoint);
42 void cm_set_elr_spsr_el3(uint32_t security_state,
43 uintptr_t entrypoint, uint32_t spsr);
44 void cm_write_scr_el3_bit(uint32_t security_state,
45 uint32_t bit_pos,
46 uint32_t value);
47 void cm_set_next_eret_context(uint32_t security_state);
48 uint32_t cm_get_scr_el3(uint32_t security_state);
49
50 /* Inline definitions */
51
52 /*******************************************************************************
53 * This function is used to program the context that's used for exception
54 * return. This initializes the SP_EL3 to a pointer to a 'cpu_context' set for
55 * the required security state
56 ******************************************************************************/
57 static inline void cm_set_next_context(void *context)
58 {
59 #if ENABLE_ASSERTIONS
60 uint64_t sp_mode;
61
62 /*
63 * Check that this function is called with SP_EL0 as the stack
64 * pointer
65 */
66 __asm__ volatile("mrs %0, SPSel\n"
67 : "=r" (sp_mode));
68
69 assert(sp_mode == MODE_SP_EL0);
70 #endif /* ENABLE_ASSERTIONS */
71
72 __asm__ volatile("msr spsel, #1\n"
73 "mov sp, %0\n"
74 "msr spsel, #0\n"
75 : : "r" (context));
76 }
77
78 #else
79 void *cm_get_next_context(void);
80 void cm_set_next_context(void *context);
81 #endif /* AARCH32 */
82
83 #endif /* CONTEXT_MGMT_H */