1 /*
2  * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved.
3  * Copyright (c) 2020, NVIDIA Corporation. All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  */
7 
8 #ifndef SMCALL_H
9 #define SMCALL_H
10 
11 #define SMC_NUM_ENTITIES	64U
12 #define SMC_NUM_ARGS		4U
13 #define SMC_NUM_PARAMS		(SMC_NUM_ARGS - 1U)
14 
15 #define SMC_IS_FASTCALL(smc_nr)	((smc_nr) & 0x80000000U)
16 #define SMC_IS_SMC64(smc_nr)	((smc_nr) & 0x40000000U)
17 #define SMC_ENTITY(smc_nr)	(((smc_nr) & 0x3F000000U) >> 24U)
18 #define SMC_FUNCTION(smc_nr)	((smc_nr) & 0x0000FFFFU)
19 
20 #define SMC_NR(entity, fn, fastcall, smc64)			\
21 		(((((uint32_t)(fastcall)) & 0x1U) << 31U) |	\
22 		(((smc64) & 0x1U) << 30U) |			\
23 		(((entity) & 0x3FU) << 24U) |			\
24 		((fn) & 0xFFFFU))
25 
26 #define SMC_FASTCALL_NR(entity, fn)	SMC_NR((entity), (fn), 1U, 0U)
27 #define SMC_FASTCALL64_NR(entity, fn)	SMC_NR((entity), (fn), 1U, 1U)
28 #define SMC_YIELDCALL_NR(entity, fn)	SMC_NR((entity), (fn), 0U, 0U)
29 #define SMC_YIELDCALL64_NR(entity, fn)	SMC_NR((entity), (fn), 0U, 1U)
30 
31 #define	SMC_ENTITY_ARCH			0U	/* ARM Architecture calls */
32 #define	SMC_ENTITY_CPU			1U	/* CPU Service calls */
33 #define	SMC_ENTITY_SIP			2U	/* SIP Service calls */
34 #define	SMC_ENTITY_OEM			3U	/* OEM Service calls */
35 #define	SMC_ENTITY_STD			4U	/* Standard Service calls */
36 #define	SMC_ENTITY_RESERVED		5U	/* Reserved for future use */
37 #define	SMC_ENTITY_TRUSTED_APP		48U	/* Trusted Application calls */
38 #define	SMC_ENTITY_TRUSTED_OS		50U	/* Trusted OS calls */
39 #define SMC_ENTITY_LOGGING              51U	/* Used for secure -> nonsecure logging */
40 #define	SMC_ENTITY_SECURE_MONITOR	60U	/* Trusted OS calls internal to secure monitor */
41 
42 /* FC = Fast call, YC = Yielding call */
43 #define SMC_YC_RESTART_LAST	SMC_YIELDCALL_NR  (SMC_ENTITY_SECURE_MONITOR, 0U)
44 #define SMC_YC_NOP		SMC_YIELDCALL_NR  (SMC_ENTITY_SECURE_MONITOR, 1U)
45 
46 /*
47  * Return from secure os to non-secure os with return value in r1
48  */
49 #define SMC_YC_NS_RETURN	SMC_YIELDCALL_NR  (SMC_ENTITY_SECURE_MONITOR, 0U)
50 
51 #define SMC_FC_RESERVED		SMC_FASTCALL_NR (SMC_ENTITY_SECURE_MONITOR, 0U)
52 #define SMC_FC_FIQ_EXIT		SMC_FASTCALL_NR (SMC_ENTITY_SECURE_MONITOR, 1U)
53 #define SMC_FC_REQUEST_FIQ	SMC_FASTCALL_NR (SMC_ENTITY_SECURE_MONITOR, 2U)
54 #define SMC_FC_GET_NEXT_IRQ	SMC_FASTCALL_NR (SMC_ENTITY_SECURE_MONITOR, 3U)
55 #define SMC_FC_FIQ_ENTER	SMC_FASTCALL_NR (SMC_ENTITY_SECURE_MONITOR, 4U)
56 
57 #define SMC_FC64_SET_FIQ_HANDLER SMC_FASTCALL64_NR(SMC_ENTITY_SECURE_MONITOR, 5U)
58 #define SMC_FC64_GET_FIQ_REGS	SMC_FASTCALL64_NR (SMC_ENTITY_SECURE_MONITOR, 6U)
59 
60 #define SMC_FC_CPU_SUSPEND	SMC_FASTCALL_NR (SMC_ENTITY_SECURE_MONITOR, 7U)
61 #define SMC_FC_CPU_RESUME	SMC_FASTCALL_NR (SMC_ENTITY_SECURE_MONITOR, 8U)
62 
63 #define SMC_FC_AARCH_SWITCH	SMC_FASTCALL_NR (SMC_ENTITY_SECURE_MONITOR, 9U)
64 #define SMC_FC_GET_VERSION_STR	SMC_FASTCALL_NR (SMC_ENTITY_SECURE_MONITOR, 10U)
65 
66 /* Trusted OS entity calls */
67 #define SMC_YC_VIRTIO_GET_DESCR	  SMC_YIELDCALL_NR(SMC_ENTITY_TRUSTED_OS, 20U)
68 #define SMC_YC_VIRTIO_START	  SMC_YIELDCALL_NR(SMC_ENTITY_TRUSTED_OS, 21U)
69 #define SMC_YC_VIRTIO_STOP	  SMC_YIELDCALL_NR(SMC_ENTITY_TRUSTED_OS, 22U)
70 
71 #define SMC_YC_VDEV_RESET	  SMC_YIELDCALL_NR(SMC_ENTITY_TRUSTED_OS, 23U)
72 #define SMC_YC_VDEV_KICK_VQ	  SMC_YIELDCALL_NR(SMC_ENTITY_TRUSTED_OS, 24U)
73 #define SMC_YC_SET_ROT_PARAMS	  SMC_YIELDCALL_NR(SMC_ENTITY_TRUSTED_OS, 65535U)
74 
75 /*
76  * Standard Trusted OS Function IDs that fall under Trusted OS call range
77  * according to SMC calling convention
78  */
79 #define SMC_FC64_GET_UUID		SMC_FASTCALL64_NR(63U, 0xFF01U) /* Implementation UID */
80 #define SMC_FC_GET_UUID			SMC_FASTCALL_NR(63U, 0xFF01U) /* Implementation.UID */
81 
82 #endif /* SMCALL_H */
83