1 /*
2 * Copyright (c) 2016-2021, ARM Limited and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7 #ifndef SMCCC_H
8 #define SMCCC_H
9
10 #include <lib/utils_def.h>
11
12 #define SMCCC_VERSION_MAJOR_SHIFT U(16)
13 #define SMCCC_VERSION_MAJOR_MASK U(0x7FFF)
14 #define SMCCC_VERSION_MINOR_SHIFT U(0)
15 #define SMCCC_VERSION_MINOR_MASK U(0xFFFF)
16 #define MAKE_SMCCC_VERSION(_major, _minor) \
17 ((((uint32_t)(_major) & SMCCC_VERSION_MAJOR_MASK) << \
18 SMCCC_VERSION_MAJOR_SHIFT) \
19 | (((uint32_t)(_minor) & SMCCC_VERSION_MINOR_MASK) << \
20 SMCCC_VERSION_MINOR_SHIFT))
21
22 #define SMCCC_MAJOR_VERSION U(1)
23 #define SMCCC_MINOR_VERSION U(2)
24
25 /*******************************************************************************
26 * Bit definitions inside the function id as per the SMC calling convention
27 ******************************************************************************/
28 #define FUNCID_TYPE_SHIFT U(31)
29 #define FUNCID_TYPE_MASK U(0x1)
30 #define FUNCID_TYPE_WIDTH U(1)
31
32 #define FUNCID_CC_SHIFT U(30)
33 #define FUNCID_CC_MASK U(0x1)
34 #define FUNCID_CC_WIDTH U(1)
35
36 #define FUNCID_OEN_SHIFT U(24)
37 #define FUNCID_OEN_MASK U(0x3f)
38 #define FUNCID_OEN_WIDTH U(6)
39
40 #define FUNCID_NUM_SHIFT U(0)
41 #define FUNCID_NUM_MASK U(0xffff)
42 #define FUNCID_NUM_WIDTH U(16)
43
44 #define GET_SMC_NUM(id) (((id) >> FUNCID_NUM_SHIFT) & \
45 FUNCID_NUM_MASK)
46 #define GET_SMC_TYPE(id) (((id) >> FUNCID_TYPE_SHIFT) & \
47 FUNCID_TYPE_MASK)
48 #define GET_SMC_CC(id) (((id) >> FUNCID_CC_SHIFT) & \
49 FUNCID_CC_MASK)
50 #define GET_SMC_OEN(id) (((id) >> FUNCID_OEN_SHIFT) & \
51 FUNCID_OEN_MASK)
52
53 /*******************************************************************************
54 * SMCCC_ARCH_SOC_ID SoC version & revision bit definition
55 ******************************************************************************/
56 #define SOC_ID_JEP_106_BANK_IDX_MASK GENMASK_32(30, 24)
57 #define SOC_ID_JEP_106_BANK_IDX_SHIFT U(24)
58 #define SOC_ID_JEP_106_ID_CODE_MASK GENMASK_32(23, 16)
59 #define SOC_ID_JEP_106_ID_CODE_SHIFT U(16)
60 #define SOC_ID_IMPL_DEF_MASK GENMASK_32(15, 0)
61 #define SOC_ID_IMPL_DEF_SHIFT U(0)
62 #define SOC_ID_SET_JEP_106(bkid, mfid) ((((bkid) << SOC_ID_JEP_106_BANK_IDX_SHIFT) & \
63 SOC_ID_JEP_106_BANK_IDX_MASK) | \
64 (((mfid) << SOC_ID_JEP_106_ID_CODE_SHIFT) & \
65 SOC_ID_JEP_106_ID_CODE_MASK))
66
67 #define SOC_ID_REV_MASK GENMASK_32(30, 0)
68 #define SOC_ID_REV_SHIFT U(0)
69
70 /*******************************************************************************
71 * Owning entity number definitions inside the function id as per the SMC
72 * calling convention
73 ******************************************************************************/
74 #define OEN_ARM_START U(0)
75 #define OEN_ARM_END U(0)
76 #define OEN_CPU_START U(1)
77 #define OEN_CPU_END U(1)
78 #define OEN_SIP_START U(2)
79 #define OEN_SIP_END U(2)
80 #define OEN_OEM_START U(3)
81 #define OEN_OEM_END U(3)
82 #define OEN_STD_START U(4) /* Standard Service Calls */
83 #define OEN_STD_END U(4)
84 #define OEN_STD_HYP_START U(5) /* Standard Hypervisor Service calls */
85 #define OEN_STD_HYP_END U(5)
86 #define OEN_VEN_HYP_START U(6) /* Vendor Hypervisor Service calls */
87 #define OEN_VEN_HYP_END U(6)
88 #define OEN_TAP_START U(48) /* Trusted Applications */
89 #define OEN_TAP_END U(49)
90 #define OEN_TOS_START U(50) /* Trusted OS */
91 #define OEN_TOS_END U(63)
92 #define OEN_LIMIT U(64)
93
94 /* Flags and error codes */
95 #define SMC_64 U(1)
96 #define SMC_32 U(0)
97
98 #define SMC_TYPE_FAST UL(1)
99 #define SMC_TYPE_YIELD UL(0)
100
101 #define SMC_OK ULL(0)
102 #define SMC_UNK -1
103 #define SMC_PREEMPTED -2 /* Not defined by the SMCCC */
104
105 /* Return codes for Arm Architecture Service SMC calls */
106 #define SMC_ARCH_CALL_SUCCESS 0
107 #define SMC_ARCH_CALL_NOT_SUPPORTED -1
108 #define SMC_ARCH_CALL_NOT_REQUIRED -2
109 #define SMC_ARCH_CALL_INVAL_PARAM -3
110
111 /* Various flags passed to SMC handlers */
112 #define SMC_FROM_SECURE (U(0) << 0)
113 #define SMC_FROM_NON_SECURE (U(1) << 0)
114
115 #ifndef __ASSEMBLER__
116
117 #include <stdint.h>
118
119 #include <lib/cassert.h>
120
121 #define is_caller_non_secure(_f) (((_f) & SMC_FROM_NON_SECURE) != U(0))
122 #define is_caller_secure(_f) (!is_caller_non_secure(_f))
123
124 /* The macro below is used to identify a Standard Service SMC call */
125 #define is_std_svc_call(_fid) (GET_SMC_OEN(_fid) == OEN_STD_START)
126
127 /* The macro below is used to identify a Arm Architectural Service SMC call */
128 #define is_arm_arch_svc_call(_fid) (GET_SMC_OEN(_fid) == OEN_ARM_START)
129
130 /* The macro below is used to identify a valid Fast SMC call */
131 #define is_valid_fast_smc(_fid) ((!(((_fid) >> 16) & U(0xff))) && \
132 (GET_SMC_TYPE(_fid) \
133 == (uint32_t)SMC_TYPE_FAST))
134
135 /*
136 * Macro to define UUID for services. Apart from defining and initializing a
137 * uuid_t structure, this macro verifies that the first word of the defined UUID
138 * does not equal SMC_UNK. This is to ensure that the caller won't mistake the
139 * returned UUID in x0 for an invalid SMC error return
140 */
141 #define DEFINE_SVC_UUID2(_name, _tl, _tm, _th, _cl, _ch, \
142 _n0, _n1, _n2, _n3, _n4, _n5) \
143 CASSERT((uint32_t)(_tl) != (uint32_t)SMC_UNK, \
144 invalid_svc_uuid_##_name); \
145 static const uuid_t _name = { \
146 {((_tl) >> 24) & 0xFF, \
147 ((_tl) >> 16) & 0xFF, \
148 ((_tl) >> 8) & 0xFF, \
149 ((_tl) & 0xFF)}, \
150 {((_tm) >> 8) & 0xFF, \
151 ((_tm) & 0xFF)}, \
152 {((_th) >> 8) & 0xFF, \
153 ((_th) & 0xFF)}, \
154 (_cl), (_ch), \
155 { (_n0), (_n1), (_n2), (_n3), (_n4), (_n5) } \
156 }
157
158 /*
159 * Return a UUID in the SMC return registers.
160 *
161 * Acccording to section 5.3 of the SMCCC, UUIDs are returned as a single
162 * 128-bit value using the SMC32 calling convention. This value is mapped to
163 * argument registers x0-x3 on AArch64 (resp. r0-r3 on AArch32). x0 for example
164 * shall hold bytes 0 to 3, with byte 0 in the low-order bits.
165 */
smc_uuid_word(uint8_t b0,uint8_t b1,uint8_t b2,uint8_t b3)166 static inline uint32_t smc_uuid_word(uint8_t b0, uint8_t b1, uint8_t b2, uint8_t b3)
167 {
168 return ((uint32_t) b0) | (((uint32_t) b1) << 8) |
169 (((uint32_t) b2) << 16) | (((uint32_t) b3) << 24);
170 }
171
172 #define SMC_UUID_RET(_h, _uuid) \
173 SMC_RET4(handle, \
174 smc_uuid_word((_uuid).time_low[0], (_uuid).time_low[1], \
175 (_uuid).time_low[2], (_uuid).time_low[3]), \
176 smc_uuid_word((_uuid).time_mid[0], (_uuid).time_mid[1], \
177 (_uuid).time_hi_and_version[0], \
178 (_uuid).time_hi_and_version[1]), \
179 smc_uuid_word((_uuid).clock_seq_hi_and_reserved, \
180 (_uuid).clock_seq_low, (_uuid).node[0], \
181 (_uuid).node[1]), \
182 smc_uuid_word((_uuid).node[2], (_uuid).node[3], \
183 (_uuid).node[4], (_uuid).node[5]))
184
185 #endif /*__ASSEMBLER__*/
186 #endif /* SMCCC_H */
187