1 /*
2  * Copyright (c) 2019-2021, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef SPMD_PRIVATE_H
8 #define SPMD_PRIVATE_H
9 
10 #include <context.h>
11 
12 /*******************************************************************************
13  * Constants that allow assembler code to preserve callee-saved registers of the
14  * C runtime context while performing a security state switch.
15  ******************************************************************************/
16 #define SPMD_C_RT_CTX_X19		0x0
17 #define SPMD_C_RT_CTX_X20		0x8
18 #define SPMD_C_RT_CTX_X21		0x10
19 #define SPMD_C_RT_CTX_X22		0x18
20 #define SPMD_C_RT_CTX_X23		0x20
21 #define SPMD_C_RT_CTX_X24		0x28
22 #define SPMD_C_RT_CTX_X25		0x30
23 #define SPMD_C_RT_CTX_X26		0x38
24 #define SPMD_C_RT_CTX_X27		0x40
25 #define SPMD_C_RT_CTX_X28		0x48
26 #define SPMD_C_RT_CTX_X29		0x50
27 #define SPMD_C_RT_CTX_X30		0x58
28 
29 #define SPMD_C_RT_CTX_SIZE		0x60
30 #define SPMD_C_RT_CTX_ENTRIES		(SPMD_C_RT_CTX_SIZE >> DWORD_SHIFT)
31 
32 #ifndef __ASSEMBLER__
33 #include <stdint.h>
34 #include <lib/psci/psci_lib.h>
35 #include <plat/common/platform.h>
36 #include <services/ffa_svc.h>
37 
38 typedef enum spmc_state {
39 	SPMC_STATE_RESET = 0,
40 	SPMC_STATE_OFF,
41 	SPMC_STATE_ON_PENDING,
42 	SPMC_STATE_ON
43 } spmc_state_t;
44 
45 /*
46  * Data structure used by the SPM dispatcher (SPMD) in EL3 to track context of
47  * the SPM core (SPMC) at the next lower EL.
48  */
49 typedef struct spmd_spm_core_context {
50 	uint64_t c_rt_ctx;
51 	cpu_context_t cpu_ctx;
52 	spmc_state_t state;
53 	bool secure_interrupt_ongoing;
54 } spmd_spm_core_context_t;
55 
56 /*
57  * Reserve ID for NS physical FFA Endpoint.
58  */
59 #define FFA_NS_ENDPOINT_ID			U(0)
60 
61 /* Mask and shift to check valid secure FF-A Endpoint ID. */
62 #define SPMC_SECURE_ID_MASK			U(1)
63 #define SPMC_SECURE_ID_SHIFT			U(15)
64 
65 #define SPMD_DIRECT_MSG_ENDPOINT_ID		U(FFA_ENDPOINT_ID_MAX - 1)
66 
67 /* Functions used to enter/exit SPMC synchronously */
68 uint64_t spmd_spm_core_sync_entry(spmd_spm_core_context_t *ctx);
69 __dead2 void spmd_spm_core_sync_exit(uint64_t rc);
70 
71 /* Assembly helpers */
72 uint64_t spmd_spm_core_enter(uint64_t *c_rt_ctx);
73 void __dead2 spmd_spm_core_exit(uint64_t c_rt_ctx, uint64_t ret);
74 
75 /* SPMD SPD power management handlers */
76 extern const spd_pm_ops_t spmd_pm;
77 
78 /* SPMC entry point information helper */
79 entry_point_info_t *spmd_spmc_ep_info_get(void);
80 
81 /* SPMC ID getter */
82 uint16_t spmd_spmc_id_get(void);
83 
84 /* SPMC context on CPU based on mpidr */
85 spmd_spm_core_context_t *spmd_get_context_by_mpidr(uint64_t mpidr);
86 
87 /* SPMC context on current CPU get helper */
88 spmd_spm_core_context_t *spmd_get_context(void);
89 
90 int spmd_pm_secondary_ep_register(uintptr_t entry_point);
91 bool spmd_check_address_in_binary_image(uint64_t address);
92 
93 #endif /* __ASSEMBLER__ */
94 
95 #endif /* SPMD_PRIVATE_H */
96