xref: /rk3399_ARM-atf/include/bl32/payloads/tlk.h (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
1 /*
2  * Copyright (c) 2015-2017, 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 __TLK_H__
32 #define __TLK_H__
33 
34 #include <utils.h>
35 
36 /*
37  * Generate function IDs for the Trusted OS/Apps
38  */
39 #define TLK_TOS_STD_FID(fid)	((fid) | 0x72000000 | (0 << 31))
40 #define TLK_TA_STD_FID(fid)	((fid) | 0x70000000 | (0 << 31))
41 
42 /*
43  * Trusted OS specific function IDs
44  */
45 #define TLK_REGISTER_LOGBUF	TLK_TOS_STD_FID(0x1)
46 #define TLK_REGISTER_REQBUF	TLK_TOS_STD_FID(0x2)
47 #define TLK_RESUME_FID		TLK_TOS_STD_FID(0x100)
48 #define TLK_SYSTEM_SUSPEND	TLK_TOS_STD_FID(0xE001)
49 #define TLK_SYSTEM_RESUME	TLK_TOS_STD_FID(0xE002)
50 #define TLK_SYSTEM_OFF		TLK_TOS_STD_FID(0xE003)
51 
52 /*
53  * SMC function IDs that TLK uses to signal various forms of completions
54  * to the secure payload dispatcher.
55  */
56 #define TLK_REQUEST_DONE	(0x32000001 | (ULL(1) << 31))
57 #define TLK_PREEMPTED		(0x32000002 | (ULL(1) << 31))
58 #define TLK_ENTRY_DONE		(0x32000003 | (ULL(1) << 31))
59 #define TLK_VA_TRANSLATE	(0x32000004 | (ULL(1) << 31))
60 #define TLK_SUSPEND_DONE	(0x32000005 | (ULL(1) << 31))
61 #define TLK_RESUME_DONE		(0x32000006 | (ULL(1) << 31))
62 #define TLK_SYSTEM_OFF_DONE	(0x32000007 | (ULL(1) << 31))
63 
64 /*
65  * Trusted Application specific function IDs
66  */
67 #define TLK_OPEN_TA_SESSION	TLK_TA_STD_FID(0x1)
68 #define TLK_CLOSE_TA_SESSION	TLK_TA_STD_FID(0x2)
69 #define TLK_TA_LAUNCH_OP	TLK_TA_STD_FID(0x3)
70 #define TLK_TA_SEND_EVENT	TLK_TA_STD_FID(0x4)
71 
72 /*
73  * Total number of function IDs implemented for services offered to NS clients.
74  */
75 #define TLK_NUM_FID		7
76 
77 /* TLK implementation version numbers */
78 #define TLK_VERSION_MAJOR	0x0 /* Major version */
79 #define TLK_VERSION_MINOR	0x1 /* Minor version */
80 
81 /*
82  * Standard Trusted OS Function IDs that fall under Trusted OS call range
83  * according to SMC calling convention
84  */
85 #define TOS_CALL_COUNT		0xbf00ff00 /* Number of calls implemented */
86 #define TOS_UID			0xbf00ff01 /* Implementation UID */
87 #define TOS_CALL_VERSION	0xbf00ff03 /* Trusted OS Call Version */
88 
89 #endif /* __TLK_H__ */
90