xref: /rk3399_ARM-atf/include/bl32/payloads/tlk.h (revision 4c9ad0df665cca331218bc51c24147be8b192752)
1 /*
2  * Copyright (c) 2015-2018, ARM Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef TLK_H
8 #define TLK_H
9 
10 #include <lib/utils_def.h>
11 
12 /*
13  * Generate function IDs for the Trusted OS/Apps
14  */
15 #define TLK_TOS_YIELD_FID(fid)	((fid) | 0x72000000 | (0 << 31))
16 #define TLK_TA_YIELD_FID(fid)	((fid) | 0x70000000 | (0 << 31))
17 
18 /*
19  * Trusted OS specific function IDs
20  */
21 #define TLK_REGISTER_LOGBUF	TLK_TOS_YIELD_FID(0x1)
22 #define TLK_REGISTER_REQBUF	TLK_TOS_YIELD_FID(0x2)
23 #define TLK_SS_REGISTER_HANDLER	TLK_TOS_YIELD_FID(0x3)
24 #define TLK_REGISTER_NS_DRAM_RANGES	TLK_TOS_YIELD_FID(0x4)
25 #define TLK_SET_ROOT_OF_TRUST	TLK_TOS_YIELD_FID(0x5)
26 #define TLK_RESUME_FID		TLK_TOS_YIELD_FID(0x100)
27 #define TLK_SYSTEM_SUSPEND	TLK_TOS_YIELD_FID(0xE001)
28 #define TLK_SYSTEM_RESUME	TLK_TOS_YIELD_FID(0xE002)
29 #define TLK_SYSTEM_OFF		TLK_TOS_YIELD_FID(0xE003)
30 #define TLK_IRQ_FIRED		TLK_TOS_YIELD_FID(0xE004)
31 
32 /*
33  * SMC function IDs that TLK uses to signal various forms of completions
34  * to the secure payload dispatcher.
35  */
36 #define TLK_REQUEST_DONE	(0x32000001 | (ULL(1) << 31))
37 #define TLK_PREEMPTED		(0x32000002 | (ULL(1) << 31))
38 #define TLK_ENTRY_DONE		(0x32000003 | (ULL(1) << 31))
39 #define TLK_VA_TRANSLATE	(0x32000004 | (ULL(1) << 31))
40 #define TLK_SUSPEND_DONE	(0x32000005 | (ULL(1) << 31))
41 #define TLK_RESUME_DONE		(0x32000006 | (ULL(1) << 31))
42 #define TLK_SYSTEM_OFF_DONE	(0x32000007 | (ULL(1) << 31))
43 #define TLK_IRQ_DONE		(0x32000008 | (ULL(1) << 31))
44 
45 /*
46  * Trusted Application specific function IDs
47  */
48 #define TLK_OPEN_TA_SESSION	TLK_TA_YIELD_FID(0x1)
49 #define TLK_CLOSE_TA_SESSION	TLK_TA_YIELD_FID(0x2)
50 #define TLK_TA_LAUNCH_OP	TLK_TA_YIELD_FID(0x3)
51 #define TLK_TA_SEND_EVENT	TLK_TA_YIELD_FID(0x4)
52 
53 /*
54  * Total number of function IDs implemented for services offered to NS clients.
55  */
56 #define TLK_NUM_FID		7
57 
58 /* TLK implementation version numbers */
59 #define TLK_VERSION_MAJOR	0x0 /* Major version */
60 #define TLK_VERSION_MINOR	0x1 /* Minor version */
61 
62 /*
63  * Standard Trusted OS Function IDs that fall under Trusted OS call range
64  * according to SMC calling convention
65  */
66 #define TOS_CALL_COUNT		0xbf00ff00 /* Number of calls implemented */
67 #define TOS_UID			0xbf00ff01 /* Implementation UID */
68 #define TOS_CALL_VERSION	0xbf00ff03 /* Trusted OS Call Version */
69 
70 #endif /* TLK_H */
71