xref: /rk3399_ARM-atf/include/bl32/tsp/tsp.h (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
1 /*
2  * Copyright (c) 2013-2016, 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 __TSP_H__
32 #define __TSP_H__
33 
34 /*
35  * SMC function IDs that TSP uses to signal various forms of completions
36  * to the secure payload dispatcher.
37  */
38 #define TSP_ENTRY_DONE		0xf2000000
39 #define TSP_ON_DONE		0xf2000001
40 #define TSP_OFF_DONE		0xf2000002
41 #define TSP_SUSPEND_DONE	0xf2000003
42 #define TSP_RESUME_DONE		0xf2000004
43 #define TSP_PREEMPTED		0xf2000005
44 #define TSP_ABORT_DONE		0xf2000007
45 #define TSP_SYSTEM_OFF_DONE	0xf2000008
46 #define TSP_SYSTEM_RESET_DONE	0xf2000009
47 
48 /*
49  * Function identifiers to handle S-El1 interrupt through the synchronous
50  * handling model. If the TSP was previously interrupted then control has to
51  * be returned to the TSPD after handling the interrupt else execution can
52  * remain in the TSP.
53  */
54 #define TSP_HANDLED_S_EL1_INTR		0xf2000006
55 
56 /* SMC function ID that TSP uses to request service from secure monitor */
57 #define TSP_GET_ARGS		0xf2001000
58 
59 /*
60  * Identifiers for various TSP services. Corresponding function IDs (whether
61  * fast or standard) are generated by macros defined below
62  */
63 #define TSP_ADD		0x2000
64 #define TSP_SUB		0x2001
65 #define TSP_MUL		0x2002
66 #define TSP_DIV		0x2003
67 #define TSP_HANDLE_SEL1_INTR_AND_RETURN	0x2004
68 
69 /*
70  * Identify a TSP service from function ID filtering the last 16 bits from the
71  * SMC function ID
72  */
73 #define TSP_BARE_FID(fid)	((fid) & 0xffff)
74 
75 /*
76  * Generate function IDs for TSP services to be used in SMC calls, by
77  * appropriately setting bit 31 to differentiate standard and fast SMC calls
78  */
79 #define TSP_STD_FID(fid)	((TSP_BARE_FID(fid) | 0x72000000))
80 #define TSP_FAST_FID(fid)	((TSP_BARE_FID(fid) | 0x72000000) | (1u << 31))
81 
82 /* SMC function ID to request a previously preempted std smc */
83 #define TSP_FID_RESUME		TSP_STD_FID(0x3000)
84 /*
85  * SMC function ID to request abortion of a previously preempted std smc. A
86  * fast SMC is used so that the TSP abort handler does not have to be
87  * reentrant.
88  */
89 #define TSP_FID_ABORT		TSP_FAST_FID(0x3001)
90 
91 /*
92  * Total number of function IDs implemented for services offered to NS clients.
93  * The function IDs are defined above
94  */
95 #define TSP_NUM_FID		0x5
96 
97 /* TSP implementation version numbers */
98 #define TSP_VERSION_MAJOR	0x0 /* Major version */
99 #define TSP_VERSION_MINOR	0x1 /* Minor version */
100 
101 /*
102  * Standard Trusted OS Function IDs that fall under Trusted OS call range
103  * according to SMC calling convention
104  */
105 #define TOS_CALL_COUNT		0xbf00ff00 /* Number of calls implemented */
106 #define TOS_UID			0xbf00ff01 /* Implementation UID */
107 /*				0xbf00ff02 is reserved */
108 #define TOS_CALL_VERSION	0xbf00ff03 /* Trusted OS Call Version */
109 
110 
111 #ifndef __ASSEMBLY__
112 
113 #include <stdint.h>
114 
115 
116 typedef uint32_t tsp_vector_isn_t;
117 
118 typedef struct tsp_vectors {
119 	tsp_vector_isn_t std_smc_entry;
120 	tsp_vector_isn_t fast_smc_entry;
121 	tsp_vector_isn_t cpu_on_entry;
122 	tsp_vector_isn_t cpu_off_entry;
123 	tsp_vector_isn_t cpu_resume_entry;
124 	tsp_vector_isn_t cpu_suspend_entry;
125 	tsp_vector_isn_t sel1_intr_entry;
126 	tsp_vector_isn_t system_off_entry;
127 	tsp_vector_isn_t system_reset_entry;
128 	tsp_vector_isn_t abort_std_smc_entry;
129 } tsp_vectors_t;
130 
131 
132 #endif /* __ASSEMBLY__ */
133 
134 #endif /* __TSP_H__ */
135