xref: /rk3399_ARM-atf/include/bl32/tsp/tsp.h (revision 5a06bb7e0b3ec6c98857423f52a1f98b54e46303)
1 /*
2  * Copyright (c) 2013-2014, 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 
45 /*
46  * Function identifiers to handle FIQs through the synchronous handling model.
47  * If the TSP was previously interrupted then control has to be returned to
48  * the TSPD after handling the interrupt else execution can remain in the TSP.
49  */
50 #define TSP_HANDLED_S_EL1_FIQ		0xf2000006
51 #define TSP_EL3_FIQ			0xf2000007
52 
53 /* SMC function ID that TSP uses to request service from secure monitor */
54 #define TSP_GET_ARGS		0xf2001000
55 
56 /*
57  * Identifiers for various TSP services. Corresponding function IDs (whether
58  * fast or standard) are generated by macros defined below
59  */
60 #define TSP_ADD		0x2000
61 #define TSP_SUB		0x2001
62 #define TSP_MUL		0x2002
63 #define TSP_DIV		0x2003
64 #define TSP_HANDLE_FIQ_AND_RETURN	0x2004
65 
66 /*
67  * Generate function IDs for TSP services to be used in SMC calls, by
68  * appropriately setting bit 31 to differentiate standard and fast SMC calls
69  */
70 #define TSP_STD_FID(fid)	((fid) | 0x72000000 | (0 << 31))
71 #define TSP_FAST_FID(fid)	((fid) | 0x72000000 | (1 << 31))
72 
73 /* SMC function ID to request a previously preempted std smc */
74 #define TSP_FID_RESUME		TSP_STD_FID(0x3000)
75 
76 /*
77  * Identify a TSP service from function ID filtering the last 16 bits from the
78  * SMC function ID
79  */
80 #define TSP_BARE_FID(fid)	((fid) & 0xffff)
81 
82 /*
83  * Total number of function IDs implemented for services offered to NS clients.
84  * The function IDs are defined above
85  */
86 #define TSP_NUM_FID		0x4
87 
88 /* TSP implementation version numbers */
89 #define TSP_VERSION_MAJOR	0x0 /* Major version */
90 #define TSP_VERSION_MINOR	0x1 /* Minor version */
91 
92 /*
93  * Standard Trusted OS Function IDs that fall under Trusted OS call range
94  * according to SMC calling convention
95  */
96 #define TOS_CALL_COUNT		0xbf00ff00 /* Number of calls implemented */
97 #define TOS_UID			0xbf00ff01 /* Implementation UID */
98 /*				0xbf00ff02 is reserved */
99 #define TOS_CALL_VERSION	0xbf00ff03 /* Trusted OS Call Version */
100 
101 
102 #ifndef __ASSEMBLY__
103 
104 #include <stdint.h>
105 
106 
107 typedef uint32_t tsp_vector_isn_t;
108 
109 typedef struct tsp_vectors {
110 	tsp_vector_isn_t std_smc_entry;
111 	tsp_vector_isn_t fast_smc_entry;
112 	tsp_vector_isn_t cpu_on_entry;
113 	tsp_vector_isn_t cpu_off_entry;
114 	tsp_vector_isn_t cpu_resume_entry;
115 	tsp_vector_isn_t cpu_suspend_entry;
116 	tsp_vector_isn_t fiq_entry;
117 } tsp_vectors_t;
118 
119 
120 #endif /* __ASSEMBLY__ */
121 
122 #endif /* __TSP_H__ */
123