1 /*
2  * Copyright (c) 2013-2022, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef TSP_H
8 #define TSP_H
9 
10 /*
11  * SMC function IDs that TSP uses to signal various forms of completions
12  * to the secure payload dispatcher.
13  */
14 #define TSP_ENTRY_DONE		0xf2000000
15 #define TSP_ON_DONE		0xf2000001
16 #define TSP_OFF_DONE		0xf2000002
17 #define TSP_SUSPEND_DONE	0xf2000003
18 #define TSP_RESUME_DONE		0xf2000004
19 #define TSP_PREEMPTED		0xf2000005
20 #define TSP_ABORT_DONE		0xf2000007
21 #define TSP_SYSTEM_OFF_DONE	0xf2000008
22 #define TSP_SYSTEM_RESET_DONE	0xf2000009
23 
24 /*
25  * Function identifiers to handle S-EL1 interrupt through the synchronous
26  * handling model. If the TSP was previously interrupted then control has to
27  * be returned to the TSPD after handling the interrupt else execution can
28  * remain in the TSP.
29  */
30 #define TSP_HANDLED_S_EL1_INTR		0xf2000006
31 
32 /* SMC function ID that TSP uses to request service from secure monitor */
33 #define TSP_GET_ARGS		0xf2001000
34 
35 /*
36  * Identifiers for various TSP services. Corresponding function IDs (whether
37  * fast or yielding) are generated by macros defined below
38  */
39 #define TSP_ADD		0x2000
40 #define TSP_SUB		0x2001
41 #define TSP_MUL		0x2002
42 #define TSP_DIV		0x2003
43 #define TSP_HANDLE_SEL1_INTR_AND_RETURN	0x2004
44 #define TSP_CHECK_DIT	0x2005
45 
46 /*
47  * Identify a TSP service from function ID filtering the last 16 bits from the
48  * SMC function ID
49  */
50 #define TSP_BARE_FID(fid)	((fid) & 0xffff)
51 
52 /*
53  * Generate function IDs for TSP services to be used in SMC calls, by
54  * appropriately setting bit 31 to differentiate yielding and fast SMC calls
55  */
56 #define TSP_YIELD_FID(fid)	((TSP_BARE_FID(fid) | 0x72000000))
57 #define TSP_FAST_FID(fid)	((TSP_BARE_FID(fid) | 0x72000000) | (1u << 31))
58 
59 /* SMC function ID to request a previously preempted yielding smc */
60 #define TSP_FID_RESUME		TSP_YIELD_FID(0x3000)
61 /*
62  * SMC function ID to request abortion of a previously preempted yielding SMC. A
63  * fast SMC is used so that the TSP abort handler does not have to be
64  * reentrant.
65  */
66 #define TSP_FID_ABORT		TSP_FAST_FID(0x3001)
67 
68 /*
69  * Total number of function IDs implemented for services offered to NS clients.
70  * The function IDs are defined above
71  */
72 #define TSP_NUM_FID		0x5
73 
74 /* TSP implementation version numbers */
75 #define TSP_VERSION_MAJOR	0x0 /* Major version */
76 #define TSP_VERSION_MINOR	0x1 /* Minor version */
77 
78 /*
79  * Standard Trusted OS Function IDs that fall under Trusted OS call range
80  * according to SMC calling convention
81  */
82 #define TOS_CALL_COUNT		0xbf00ff00 /* Number of calls implemented */
83 #define TOS_UID			0xbf00ff01 /* Implementation UID */
84 /*				0xbf00ff02 is reserved */
85 #define TOS_CALL_VERSION	0xbf00ff03 /* Trusted OS Call Version */
86 
87 
88 #ifndef __ASSEMBLER__
89 
90 #include <stdint.h>
91 
92 
93 typedef uint32_t tsp_vector_isn_t;
94 
95 typedef struct tsp_vectors {
96 	tsp_vector_isn_t yield_smc_entry;
97 	tsp_vector_isn_t fast_smc_entry;
98 	tsp_vector_isn_t cpu_on_entry;
99 	tsp_vector_isn_t cpu_off_entry;
100 	tsp_vector_isn_t cpu_resume_entry;
101 	tsp_vector_isn_t cpu_suspend_entry;
102 	tsp_vector_isn_t sel1_intr_entry;
103 	tsp_vector_isn_t system_off_entry;
104 	tsp_vector_isn_t system_reset_entry;
105 	tsp_vector_isn_t abort_yield_smc_entry;
106 } tsp_vectors_t;
107 
108 void tsp_setup(void);
109 
110 #endif /* __ASSEMBLER__ */
111 
112 #endif /* TSP_H */
113