xref: /rk3399_ARM-atf/include/bl32/payloads/tlk.h (revision 53d9c9c85bc49845c4c40315e1ab29d627a1f8c3)
122038315SVarun Wadekar /*
29edac047SDavid Cunado  * Copyright (c) 2015-2017, ARM Limited and Contributors. All rights reserved.
322038315SVarun Wadekar  *
422038315SVarun Wadekar  * Redistribution and use in source and binary forms, with or without
522038315SVarun Wadekar  * modification, are permitted provided that the following conditions are met:
622038315SVarun Wadekar  *
722038315SVarun Wadekar  * Redistributions of source code must retain the above copyright notice, this
822038315SVarun Wadekar  * list of conditions and the following disclaimer.
922038315SVarun Wadekar  *
1022038315SVarun Wadekar  * Redistributions in binary form must reproduce the above copyright notice,
1122038315SVarun Wadekar  * this list of conditions and the following disclaimer in the documentation
1222038315SVarun Wadekar  * and/or other materials provided with the distribution.
1322038315SVarun Wadekar  *
1422038315SVarun Wadekar  * Neither the name of ARM nor the names of its contributors may be used
1522038315SVarun Wadekar  * to endorse or promote products derived from this software without specific
1622038315SVarun Wadekar  * prior written permission.
1722038315SVarun Wadekar  *
1822038315SVarun Wadekar  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1922038315SVarun Wadekar  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2022038315SVarun Wadekar  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2122038315SVarun Wadekar  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
2222038315SVarun Wadekar  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
2322038315SVarun Wadekar  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
2422038315SVarun Wadekar  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
2522038315SVarun Wadekar  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2622038315SVarun Wadekar  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2722038315SVarun Wadekar  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2822038315SVarun Wadekar  * POSSIBILITY OF SUCH DAMAGE.
2922038315SVarun Wadekar  */
3022038315SVarun Wadekar 
3122038315SVarun Wadekar #ifndef __TLK_H__
3222038315SVarun Wadekar #define __TLK_H__
3322038315SVarun Wadekar 
34*53d9c9c8SScott Branden #include <utils_def.h>
359edac047SDavid Cunado 
3622038315SVarun Wadekar /*
3777199df7SVarun Wadekar  * Generate function IDs for the Trusted OS/Apps
3877199df7SVarun Wadekar  */
3977199df7SVarun Wadekar #define TLK_TOS_STD_FID(fid)	((fid) | 0x72000000 | (0 << 31))
406693962cSVarun Wadekar #define TLK_TA_STD_FID(fid)	((fid) | 0x70000000 | (0 << 31))
4177199df7SVarun Wadekar 
4277199df7SVarun Wadekar /*
4377199df7SVarun Wadekar  * Trusted OS specific function IDs
4477199df7SVarun Wadekar  */
4577199df7SVarun Wadekar #define TLK_REGISTER_LOGBUF	TLK_TOS_STD_FID(0x1)
4677199df7SVarun Wadekar #define TLK_REGISTER_REQBUF	TLK_TOS_STD_FID(0x2)
47f9d25054SVarun Wadekar #define TLK_RESUME_FID		TLK_TOS_STD_FID(0x100)
48cb790c5eSVarun Wadekar #define TLK_SYSTEM_SUSPEND	TLK_TOS_STD_FID(0xE001)
49cb790c5eSVarun Wadekar #define TLK_SYSTEM_RESUME	TLK_TOS_STD_FID(0xE002)
50cb790c5eSVarun Wadekar #define TLK_SYSTEM_OFF		TLK_TOS_STD_FID(0xE003)
5177199df7SVarun Wadekar 
5277199df7SVarun Wadekar /*
5322038315SVarun Wadekar  * SMC function IDs that TLK uses to signal various forms of completions
5422038315SVarun Wadekar  * to the secure payload dispatcher.
5522038315SVarun Wadekar  */
569edac047SDavid Cunado #define TLK_REQUEST_DONE	(0x32000001 | (ULL(1) << 31))
579edac047SDavid Cunado #define TLK_PREEMPTED		(0x32000002 | (ULL(1) << 31))
589edac047SDavid Cunado #define TLK_ENTRY_DONE		(0x32000003 | (ULL(1) << 31))
599edac047SDavid Cunado #define TLK_VA_TRANSLATE	(0x32000004 | (ULL(1) << 31))
609edac047SDavid Cunado #define TLK_SUSPEND_DONE	(0x32000005 | (ULL(1) << 31))
619edac047SDavid Cunado #define TLK_RESUME_DONE		(0x32000006 | (ULL(1) << 31))
629edac047SDavid Cunado #define TLK_SYSTEM_OFF_DONE	(0x32000007 | (ULL(1) << 31))
6322038315SVarun Wadekar 
6422038315SVarun Wadekar /*
656693962cSVarun Wadekar  * Trusted Application specific function IDs
666693962cSVarun Wadekar  */
676693962cSVarun Wadekar #define TLK_OPEN_TA_SESSION	TLK_TA_STD_FID(0x1)
686693962cSVarun Wadekar #define TLK_CLOSE_TA_SESSION	TLK_TA_STD_FID(0x2)
696693962cSVarun Wadekar #define TLK_TA_LAUNCH_OP	TLK_TA_STD_FID(0x3)
706693962cSVarun Wadekar #define TLK_TA_SEND_EVENT	TLK_TA_STD_FID(0x4)
716693962cSVarun Wadekar 
726693962cSVarun Wadekar /*
7322038315SVarun Wadekar  * Total number of function IDs implemented for services offered to NS clients.
7422038315SVarun Wadekar  */
756693962cSVarun Wadekar #define TLK_NUM_FID		7
7622038315SVarun Wadekar 
7722038315SVarun Wadekar /* TLK implementation version numbers */
7822038315SVarun Wadekar #define TLK_VERSION_MAJOR	0x0 /* Major version */
7922038315SVarun Wadekar #define TLK_VERSION_MINOR	0x1 /* Minor version */
8022038315SVarun Wadekar 
8122038315SVarun Wadekar /*
8222038315SVarun Wadekar  * Standard Trusted OS Function IDs that fall under Trusted OS call range
8322038315SVarun Wadekar  * according to SMC calling convention
8422038315SVarun Wadekar  */
8522038315SVarun Wadekar #define TOS_CALL_COUNT		0xbf00ff00 /* Number of calls implemented */
8622038315SVarun Wadekar #define TOS_UID			0xbf00ff01 /* Implementation UID */
8722038315SVarun Wadekar #define TOS_CALL_VERSION	0xbf00ff03 /* Trusted OS Call Version */
8822038315SVarun Wadekar 
8922038315SVarun Wadekar #endif /* __TLK_H__ */
90