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