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