blob: a76ecbe3cb3d3c964e7ea3779e15733736b24c81 [file] [log] [blame]
Achin Gupta7aea9082014-02-01 07:51:28 +00001/*
Soby Mathewb0082d22015-04-09 13:40:55 +01002 * Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved.
Achin Gupta7aea9082014-02-01 07:51:28 +00003 *
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
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010034#include <arch.h>
35#include <bl_common.h>
Achin Gupta7aea9082014-02-01 07:51:28 +000036
Achin Gupta7aea9082014-02-01 07:51:28 +000037/*******************************************************************************
Andrew Thoelke4e126072014-06-04 21:10:52 +010038 * Forward declarations
39 ******************************************************************************/
40struct entry_point_info;
41
42/*******************************************************************************
Achin Gupta7aea9082014-02-01 07:51:28 +000043 * Function & variable prototypes
44 ******************************************************************************/
Dan Handleya17fefa2014-05-14 12:38:32 +010045void cm_init(void);
Soby Mathew70716d62015-07-13 16:26:11 +010046void *cm_get_context_by_mpidr(uint64_t mpidr,
Soren Brinkmanna581bd52016-01-14 10:02:33 -080047 uint32_t security_state) __deprecated;
Andrew Thoelkea2f65532014-05-14 17:09:32 +010048void cm_set_context_by_mpidr(uint64_t mpidr,
49 void *context,
Soren Brinkmanna581bd52016-01-14 10:02:33 -080050 uint32_t security_state) __deprecated;
Soby Mathewb0082d22015-04-09 13:40:55 +010051void *cm_get_context_by_index(unsigned int cpu_idx,
52 unsigned int security_state);
53void cm_set_context_by_index(unsigned int cpu_idx,
54 void *context,
55 unsigned int security_state);
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010056void *cm_get_context(uint32_t security_state);
57void cm_set_context(void *context, uint32_t security_state);
Soby Mathew70716d62015-07-13 16:26:11 +010058void cm_init_context(uint64_t mpidr,
Soren Brinkmanna581bd52016-01-14 10:02:33 -080059 const struct entry_point_info *ep) __deprecated;
Soby Mathewb0082d22015-04-09 13:40:55 +010060void cm_init_my_context(const struct entry_point_info *ep);
61void cm_init_context_by_index(unsigned int cpu_idx,
62 const struct entry_point_info *ep);
Andrew Thoelke4e126072014-06-04 21:10:52 +010063void cm_prepare_el3_exit(uint32_t security_state);
Dan Handleya17fefa2014-05-14 12:38:32 +010064void cm_el1_sysregs_context_save(uint32_t security_state);
65void cm_el1_sysregs_context_restore(uint32_t security_state);
Dan Handleya17fefa2014-05-14 12:38:32 +010066void cm_set_elr_el3(uint32_t security_state, uint64_t entrypoint);
Andrew Thoelke4e126072014-06-04 21:10:52 +010067void cm_set_elr_spsr_el3(uint32_t security_state,
68 uint64_t entrypoint, uint32_t spsr);
Dan Handleya17fefa2014-05-14 12:38:32 +010069void cm_write_scr_el3_bit(uint32_t security_state,
70 uint32_t bit_pos,
71 uint32_t value);
72void cm_set_next_eret_context(uint32_t security_state);
Dan Handleya17fefa2014-05-14 12:38:32 +010073uint32_t cm_get_scr_el3(uint32_t security_state);
Andrew Thoelke8c28fe02014-06-02 11:40:35 +010074
Andrew Thoelkec02dbd62014-06-02 10:00:25 +010075/* Inline definitions */
76
77/*******************************************************************************
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010078 * This function is used to program the context that's used for exception
79 * return. This initializes the SP_EL3 to a pointer to a 'cpu_context' set for
80 * the required security state
Andrew Thoelkec02dbd62014-06-02 10:00:25 +010081 ******************************************************************************/
Sandrine Bailleux37a12df2016-04-11 13:17:50 +010082static inline void cm_set_next_context(void *context)
Andrew Thoelkec02dbd62014-06-02 10:00:25 +010083{
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010084#if DEBUG
85 uint64_t sp_mode;
Andrew Thoelkec02dbd62014-06-02 10:00:25 +010086
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010087 /*
88 * Check that this function is called with SP_EL0 as the stack
89 * pointer
90 */
91 __asm__ volatile("mrs %0, SPSel\n"
92 : "=r" (sp_mode));
Andrew Thoelkec02dbd62014-06-02 10:00:25 +010093
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010094 assert(sp_mode == MODE_SP_EL0);
95#endif
Andrew Thoelkec02dbd62014-06-02 10:00:25 +010096
Yatharth Kochar6c0566c2015-10-02 17:56:48 +010097 __asm__ volatile("msr spsel, #1\n"
98 "mov sp, %0\n"
99 "msr spsel, #0\n"
100 : : "r" (context));
Andrew Thoelkec02dbd62014-06-02 10:00:25 +0100101}
Achin Gupta7aea9082014-02-01 07:51:28 +0000102#endif /* __CM_H__ */