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