• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2013-2019, 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 
45 /*
46  * Identify a TSP service from function ID filtering the last 16 bits from the
47  * SMC function ID
48  */
49 #define TSP_BARE_FID(fid)	((fid) & 0xffff)
50 
51 /*
52  * Generate function IDs for TSP services to be used in SMC calls, by
53  * appropriately setting bit 31 to differentiate yielding and fast SMC calls
54  */
55 #define TSP_YIELD_FID(fid)	((TSP_BARE_FID(fid) | 0x72000000))
56 #define TSP_FAST_FID(fid)	((TSP_BARE_FID(fid) | 0x72000000) | (1u << 31))
57 
58 /* SMC function ID to request a previously preempted yielding smc */
59 #define TSP_FID_RESUME		TSP_YIELD_FID(0x3000)
60 /*
61  * SMC function ID to request abortion of a previously preempted yielding SMC. A
62  * fast SMC is used so that the TSP abort handler does not have to be
63  * reentrant.
64  */
65 #define TSP_FID_ABORT		TSP_FAST_FID(0x3001)
66 
67 /*
68  * Total number of function IDs implemented for services offered to NS clients.
69  * The function IDs are defined above
70  */
71 #define TSP_NUM_FID		0x5
72 
73 /* TSP implementation version numbers */
74 #define TSP_VERSION_MAJOR	0x0 /* Major version */
75 #define TSP_VERSION_MINOR	0x1 /* Minor version */
76 
77 /*
78  * Standard Trusted OS Function IDs that fall under Trusted OS call range
79  * according to SMC calling convention
80  */
81 #define TOS_CALL_COUNT		0xbf00ff00 /* Number of calls implemented */
82 #define TOS_UID			0xbf00ff01 /* Implementation UID */
83 /*				0xbf00ff02 is reserved */
84 #define TOS_CALL_VERSION	0xbf00ff03 /* Trusted OS Call Version */
85 
86 
87 #ifndef __ASSEMBLER__
88 
89 #include <stdint.h>
90 
91 
92 typedef uint32_t tsp_vector_isn_t;
93 
94 typedef struct tsp_vectors {
95 	tsp_vector_isn_t yield_smc_entry;
96 	tsp_vector_isn_t fast_smc_entry;
97 	tsp_vector_isn_t cpu_on_entry;
98 	tsp_vector_isn_t cpu_off_entry;
99 	tsp_vector_isn_t cpu_resume_entry;
100 	tsp_vector_isn_t cpu_suspend_entry;
101 	tsp_vector_isn_t sel1_intr_entry;
102 	tsp_vector_isn_t system_off_entry;
103 	tsp_vector_isn_t system_reset_entry;
104 	tsp_vector_isn_t abort_yield_smc_entry;
105 } tsp_vectors_t;
106 
107 void tsp_setup(void);
108 
109 #endif /* __ASSEMBLER__ */
110 
111 #endif /* TSP_H */
112