1 /* 2 * Copyright (c) 2015, 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 __TLKD_PRIVATE_H__ 32 #define __TLKD_PRIVATE_H__ 33 34 #include <arch.h> 35 #include <context.h> 36 #include <interrupt_mgmt.h> 37 #include <platform_def.h> 38 #include <psci.h> 39 40 /* 41 * This flag is used by the TLKD to determine if the SP is servicing a standard 42 * SMC request prior to programming the next entry into the SP e.g. if SP 43 * execution is preempted by a non-secure interrupt and handed control to the 44 * normal world. If another request which is distinct from what the SP was 45 * previously doing arrives, then this flag will be help the TLKD to either 46 * reject the new request or service it while ensuring that the previous context 47 * is not corrupted. 48 */ 49 #define STD_SMC_ACTIVE_FLAG_SHIFT 2 50 #define STD_SMC_ACTIVE_FLAG_MASK 1 51 #define get_std_smc_active_flag(state) (((state) >> STD_SMC_ACTIVE_FLAG_SHIFT) \ 52 & STD_SMC_ACTIVE_FLAG_MASK) 53 #define set_std_smc_active_flag(state) ((state) |= \ 54 (1 << STD_SMC_ACTIVE_FLAG_SHIFT)) 55 #define clr_std_smc_active_flag(state) ((state) &= \ 56 ~(STD_SMC_ACTIVE_FLAG_MASK \ 57 << STD_SMC_ACTIVE_FLAG_SHIFT)) 58 59 /******************************************************************************* 60 * Secure Payload execution state information i.e. aarch32 or aarch64 61 ******************************************************************************/ 62 #define SP_AARCH32 MODE_RW_32 63 #define SP_AARCH64 MODE_RW_64 64 65 /******************************************************************************* 66 * Number of cpus that the present on this platform. TODO: Rely on a topology 67 * tree to determine this in the future to avoid assumptions about mpidr 68 * allocation 69 ******************************************************************************/ 70 #define TLKD_CORE_COUNT PLATFORM_CORE_COUNT 71 72 /******************************************************************************* 73 * Constants that allow assembler code to preserve callee-saved registers of the 74 * C runtime context while performing a security state switch. 75 ******************************************************************************/ 76 #define TLKD_C_RT_CTX_X19 0x0 77 #define TLKD_C_RT_CTX_X20 0x8 78 #define TLKD_C_RT_CTX_X21 0x10 79 #define TLKD_C_RT_CTX_X22 0x18 80 #define TLKD_C_RT_CTX_X23 0x20 81 #define TLKD_C_RT_CTX_X24 0x28 82 #define TLKD_C_RT_CTX_X25 0x30 83 #define TLKD_C_RT_CTX_X26 0x38 84 #define TLKD_C_RT_CTX_X27 0x40 85 #define TLKD_C_RT_CTX_X28 0x48 86 #define TLKD_C_RT_CTX_X29 0x50 87 #define TLKD_C_RT_CTX_X30 0x58 88 #define TLKD_C_RT_CTX_SIZE 0x60 89 #define TLKD_C_RT_CTX_ENTRIES (TLKD_C_RT_CTX_SIZE >> DWORD_SHIFT) 90 91 #ifndef __ASSEMBLY__ 92 93 #include <cassert.h> 94 #include <stdint.h> 95 96 /* AArch64 callee saved general purpose register context structure. */ 97 DEFINE_REG_STRUCT(c_rt_regs, TLKD_C_RT_CTX_ENTRIES); 98 99 /* 100 * Compile time assertion to ensure that both the compiler and linker 101 * have the same double word aligned view of the size of the C runtime 102 * register context. 103 */ 104 CASSERT(TLKD_C_RT_CTX_SIZE == sizeof(c_rt_regs_t), \ 105 assert_tlkd_c_rt_regs_size_mismatch); 106 107 /******************************************************************************* 108 * Structure which helps the SPD to maintain the per-cpu state of the SP. 109 * 'state' - collection of flags to track SP state e.g. on/off 110 * 'mpidr' - mpidr to associate a context with a cpu 111 * 'c_rt_ctx' - stack address to restore C runtime context from after 112 * returning from a synchronous entry into the SP. 113 * 'cpu_ctx' - space to maintain SP architectural state 114 * 'saved_tsp_args' - space to store arguments for TSP arithmetic operations 115 * which will queried using the TSP_GET_ARGS SMC by TSP. 116 ******************************************************************************/ 117 typedef struct tlk_context { 118 uint32_t state; 119 uint64_t mpidr; 120 uint64_t c_rt_ctx; 121 cpu_context_t cpu_ctx; 122 } tlk_context_t; 123 124 /******************************************************************************* 125 * Function & Data prototypes 126 ******************************************************************************/ 127 uint64_t tlkd_enter_sp(uint64_t *c_rt_ctx); 128 void __dead2 tlkd_exit_sp(uint64_t c_rt_ctx, uint64_t ret); 129 uint64_t tlkd_synchronous_sp_entry(tlk_context_t *tlk_ctx); 130 void __dead2 tlkd_synchronous_sp_exit(tlk_context_t *tlk_ctx, 131 uint64_t ret); 132 void tlkd_init_tlk_ep_state(struct entry_point_info *tlk_entry_point, 133 uint32_t rw, 134 uint64_t pc, 135 tlk_context_t *tlk_ctx); 136 137 #endif /*__ASSEMBLY__*/ 138 139 #endif /* __TLKD_PRIVATE_H__ */ 140