1 /*
2  * Copyright (c) 2015-2017, 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 <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_RESUME_FID		TLK_TOS_YIELD_FID(0x100)
24 #define TLK_SYSTEM_SUSPEND	TLK_TOS_YIELD_FID(0xE001)
25 #define TLK_SYSTEM_RESUME	TLK_TOS_YIELD_FID(0xE002)
26 #define TLK_SYSTEM_OFF		TLK_TOS_YIELD_FID(0xE003)
27 
28 /*
29  * SMC function IDs that TLK uses to signal various forms of completions
30  * to the secure payload dispatcher.
31  */
32 #define TLK_REQUEST_DONE	(0x32000001 | (ULL(1) << 31))
33 #define TLK_PREEMPTED		(0x32000002 | (ULL(1) << 31))
34 #define TLK_ENTRY_DONE		(0x32000003 | (ULL(1) << 31))
35 #define TLK_VA_TRANSLATE	(0x32000004 | (ULL(1) << 31))
36 #define TLK_SUSPEND_DONE	(0x32000005 | (ULL(1) << 31))
37 #define TLK_RESUME_DONE		(0x32000006 | (ULL(1) << 31))
38 #define TLK_SYSTEM_OFF_DONE	(0x32000007 | (ULL(1) << 31))
39 
40 /*
41  * Trusted Application specific function IDs
42  */
43 #define TLK_OPEN_TA_SESSION	TLK_TA_YIELD_FID(0x1)
44 #define TLK_CLOSE_TA_SESSION	TLK_TA_YIELD_FID(0x2)
45 #define TLK_TA_LAUNCH_OP	TLK_TA_YIELD_FID(0x3)
46 #define TLK_TA_SEND_EVENT	TLK_TA_YIELD_FID(0x4)
47 
48 /*
49  * Total number of function IDs implemented for services offered to NS clients.
50  */
51 #define TLK_NUM_FID		7
52 
53 /* TLK implementation version numbers */
54 #define TLK_VERSION_MAJOR	0x0 /* Major version */
55 #define TLK_VERSION_MINOR	0x1 /* Minor version */
56 
57 /*
58  * Standard Trusted OS Function IDs that fall under Trusted OS call range
59  * according to SMC calling convention
60  */
61 #define TOS_CALL_COUNT		0xbf00ff00 /* Number of calls implemented */
62 #define TOS_UID			0xbf00ff01 /* Implementation UID */
63 #define TOS_CALL_VERSION	0xbf00ff03 /* Trusted OS Call Version */
64 
65 #endif /* __TLK_H__ */
66