1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (c) 2015, Linaro Limited
5 #ifndef __LINUX_ARM_SMCCC_H
6 #define __LINUX_ARM_SMCCC_H
8 #include <linux/init.h>
9 #include <uapi/linux/const.h>
12 * This file provides common defines for ARM SMC Calling Convention as
14 * https://developer.arm.com/docs/den0028/latest
16 * This code is up-to-date with version DEN 0028 C
19 #define ARM_SMCCC_STD_CALL _AC(0,U)
20 #define ARM_SMCCC_FAST_CALL _AC(1,U)
21 #define ARM_SMCCC_TYPE_SHIFT 31
23 #define ARM_SMCCC_SMC_32 0
24 #define ARM_SMCCC_SMC_64 1
25 #define ARM_SMCCC_CALL_CONV_SHIFT 30
27 #define ARM_SMCCC_OWNER_MASK 0x3F
28 #define ARM_SMCCC_OWNER_SHIFT 24
30 #define ARM_SMCCC_FUNC_MASK 0xFFFF
32 #define ARM_SMCCC_IS_FAST_CALL(smc_val) \
33 ((smc_val) & (ARM_SMCCC_FAST_CALL << ARM_SMCCC_TYPE_SHIFT))
34 #define ARM_SMCCC_IS_64(smc_val) \
35 ((smc_val) & (ARM_SMCCC_SMC_64 << ARM_SMCCC_CALL_CONV_SHIFT))
36 #define ARM_SMCCC_FUNC_NUM(smc_val) ((smc_val) & ARM_SMCCC_FUNC_MASK)
37 #define ARM_SMCCC_OWNER_NUM(smc_val) \
38 (((smc_val) >> ARM_SMCCC_OWNER_SHIFT) & ARM_SMCCC_OWNER_MASK)
40 #define ARM_SMCCC_CALL_VAL(type, calling_convention, owner, func_num) \
41 (((type) << ARM_SMCCC_TYPE_SHIFT) | \
42 ((calling_convention) << ARM_SMCCC_CALL_CONV_SHIFT) | \
43 (((owner) & ARM_SMCCC_OWNER_MASK) << ARM_SMCCC_OWNER_SHIFT) | \
44 ((func_num) & ARM_SMCCC_FUNC_MASK))
46 #define ARM_SMCCC_OWNER_ARCH 0
47 #define ARM_SMCCC_OWNER_CPU 1
48 #define ARM_SMCCC_OWNER_SIP 2
49 #define ARM_SMCCC_OWNER_OEM 3
50 #define ARM_SMCCC_OWNER_STANDARD 4
51 #define ARM_SMCCC_OWNER_STANDARD_HYP 5
52 #define ARM_SMCCC_OWNER_VENDOR_HYP 6
53 #define ARM_SMCCC_OWNER_TRUSTED_APP 48
54 #define ARM_SMCCC_OWNER_TRUSTED_APP_END 49
55 #define ARM_SMCCC_OWNER_TRUSTED_OS 50
56 #define ARM_SMCCC_OWNER_TRUSTED_OS_END 63
58 #define ARM_SMCCC_QUIRK_NONE 0
59 #define ARM_SMCCC_QUIRK_QCOM_A6 1 /* Save/restore register a6 */
61 #define ARM_SMCCC_VERSION_1_0 0x10000
62 #define ARM_SMCCC_VERSION_1_1 0x10001
63 #define ARM_SMCCC_VERSION_1_2 0x10002
65 #define ARM_SMCCC_VERSION_FUNC_ID \
66 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
70 #define ARM_SMCCC_ARCH_FEATURES_FUNC_ID \
71 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
75 #define ARM_SMCCC_ARCH_SOC_ID \
76 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
80 #define ARM_SMCCC_ARCH_WORKAROUND_1 \
81 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
85 #define ARM_SMCCC_ARCH_WORKAROUND_2 \
86 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
90 #define ARM_SMCCC_ARCH_WORKAROUND_3 \
91 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
95 #define SMCCC_ARCH_WORKAROUND_RET_UNAFFECTED 1
97 /* Paravirtualised time calls (defined by ARM DEN0057A) */
98 #define ARM_SMCCC_HV_PV_TIME_FEATURES \
99 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
101 ARM_SMCCC_OWNER_STANDARD_HYP, \
104 #define ARM_SMCCC_HV_PV_TIME_ST \
105 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
107 ARM_SMCCC_OWNER_STANDARD_HYP, \
111 * Return codes defined in ARM DEN 0070A
112 * ARM DEN 0070A is now merged/consolidated into ARM DEN 0028 C
114 #define SMCCC_RET_SUCCESS 0
115 #define SMCCC_RET_NOT_SUPPORTED -1
116 #define SMCCC_RET_NOT_REQUIRED -2
117 #define SMCCC_RET_INVALID_PARAMETER -3
121 #include <linux/linkage.h>
122 #include <linux/types.h>
124 enum arm_smccc_conduit {
131 * arm_smccc_1_1_get_conduit()
133 * Returns the conduit to be used for SMCCCv1.1 or later.
135 * When SMCCCv1.1 is not present, returns SMCCC_CONDUIT_NONE.
137 enum arm_smccc_conduit arm_smccc_1_1_get_conduit(void);
140 * arm_smccc_get_version()
142 * Returns the version to be used for SMCCCv1.1 or later.
144 * When SMCCCv1.1 or above is not present, returns SMCCCv1.0, but this
145 * does not imply the presence of firmware or a valid conduit. Caller
146 * handling SMCCCv1.0 must determine the conduit by other means.
148 u32 arm_smccc_get_version(void);
150 void __init arm_smccc_version_init(u32 version, enum arm_smccc_conduit conduit);
153 * struct arm_smccc_res - Result from SMC/HVC call
154 * @a0-a3 result values from registers 0 to 3
156 struct arm_smccc_res {
164 * struct arm_smccc_quirk - Contains quirk information
165 * @id: quirk identification
166 * @state: quirk specific information
167 * @a6: Qualcomm quirk entry for returning post-smc call contents of a6
169 struct arm_smccc_quirk {
177 * __arm_smccc_smc() - make SMC calls
178 * @a0-a7: arguments passed in registers 0 to 7
179 * @res: result values from registers 0 to 3
180 * @quirk: points to an arm_smccc_quirk, or NULL when no quirks are required.
182 * This function is used to make SMC calls following SMC Calling Convention.
183 * The content of the supplied param are copied to registers 0 to 7 prior
184 * to the SMC instruction. The return values are updated with the content
185 * from register 0 to 3 on return from the SMC instruction. An optional
186 * quirk structure provides vendor specific behavior.
188 asmlinkage void __arm_smccc_smc(unsigned long a0, unsigned long a1,
189 unsigned long a2, unsigned long a3, unsigned long a4,
190 unsigned long a5, unsigned long a6, unsigned long a7,
191 struct arm_smccc_res *res, struct arm_smccc_quirk *quirk);
194 * __arm_smccc_hvc() - make HVC calls
195 * @a0-a7: arguments passed in registers 0 to 7
196 * @res: result values from registers 0 to 3
197 * @quirk: points to an arm_smccc_quirk, or NULL when no quirks are required.
199 * This function is used to make HVC calls following SMC Calling
200 * Convention. The content of the supplied param are copied to registers 0
201 * to 7 prior to the HVC instruction. The return values are updated with
202 * the content from register 0 to 3 on return from the HVC instruction. An
203 * optional quirk structure provides vendor specific behavior.
205 asmlinkage void __arm_smccc_hvc(unsigned long a0, unsigned long a1,
206 unsigned long a2, unsigned long a3, unsigned long a4,
207 unsigned long a5, unsigned long a6, unsigned long a7,
208 struct arm_smccc_res *res, struct arm_smccc_quirk *quirk);
210 #define arm_smccc_smc(...) __arm_smccc_smc(__VA_ARGS__, NULL)
212 #define arm_smccc_smc_quirk(...) __arm_smccc_smc(__VA_ARGS__)
214 #define arm_smccc_hvc(...) __arm_smccc_hvc(__VA_ARGS__, NULL)
216 #define arm_smccc_hvc_quirk(...) __arm_smccc_hvc(__VA_ARGS__)
218 /* SMCCC v1.1 implementation madness follows */
221 #define SMCCC_SMC_INST "smc #0"
222 #define SMCCC_HVC_INST "hvc #0"
224 #elif defined(CONFIG_ARM)
225 #include <asm/opcodes-sec.h>
226 #include <asm/opcodes-virt.h>
228 #define SMCCC_SMC_INST __SMC(0)
229 #define SMCCC_HVC_INST __HVC(0)
233 #define ___count_args(_0, _1, _2, _3, _4, _5, _6, _7, _8, x, ...) x
235 #define __count_args(...) \
236 ___count_args(__VA_ARGS__, 7, 6, 5, 4, 3, 2, 1, 0)
238 #define __constraint_read_0 "r" (arg0)
239 #define __constraint_read_1 __constraint_read_0, "r" (arg1)
240 #define __constraint_read_2 __constraint_read_1, "r" (arg2)
241 #define __constraint_read_3 __constraint_read_2, "r" (arg3)
242 #define __constraint_read_4 __constraint_read_3, "r" (arg4)
243 #define __constraint_read_5 __constraint_read_4, "r" (arg5)
244 #define __constraint_read_6 __constraint_read_5, "r" (arg6)
245 #define __constraint_read_7 __constraint_read_6, "r" (arg7)
247 #define __declare_arg_0(a0, res) \
248 struct arm_smccc_res *___res = res; \
249 register unsigned long arg0 asm("r0") = (u32)a0
251 #define __declare_arg_1(a0, a1, res) \
252 typeof(a1) __a1 = a1; \
253 struct arm_smccc_res *___res = res; \
254 register unsigned long arg0 asm("r0") = (u32)a0; \
255 register typeof(a1) arg1 asm("r1") = __a1
257 #define __declare_arg_2(a0, a1, a2, res) \
258 typeof(a1) __a1 = a1; \
259 typeof(a2) __a2 = a2; \
260 struct arm_smccc_res *___res = res; \
261 register unsigned long arg0 asm("r0") = (u32)a0; \
262 register typeof(a1) arg1 asm("r1") = __a1; \
263 register typeof(a2) arg2 asm("r2") = __a2
265 #define __declare_arg_3(a0, a1, a2, a3, res) \
266 typeof(a1) __a1 = a1; \
267 typeof(a2) __a2 = a2; \
268 typeof(a3) __a3 = a3; \
269 struct arm_smccc_res *___res = res; \
270 register unsigned long arg0 asm("r0") = (u32)a0; \
271 register typeof(a1) arg1 asm("r1") = __a1; \
272 register typeof(a2) arg2 asm("r2") = __a2; \
273 register typeof(a3) arg3 asm("r3") = __a3
275 #define __declare_arg_4(a0, a1, a2, a3, a4, res) \
276 typeof(a4) __a4 = a4; \
277 __declare_arg_3(a0, a1, a2, a3, res); \
278 register typeof(a4) arg4 asm("r4") = __a4
280 #define __declare_arg_5(a0, a1, a2, a3, a4, a5, res) \
281 typeof(a5) __a5 = a5; \
282 __declare_arg_4(a0, a1, a2, a3, a4, res); \
283 register typeof(a5) arg5 asm("r5") = __a5
285 #define __declare_arg_6(a0, a1, a2, a3, a4, a5, a6, res) \
286 typeof(a6) __a6 = a6; \
287 __declare_arg_5(a0, a1, a2, a3, a4, a5, res); \
288 register typeof(a6) arg6 asm("r6") = __a6
290 #define __declare_arg_7(a0, a1, a2, a3, a4, a5, a6, a7, res) \
291 typeof(a7) __a7 = a7; \
292 __declare_arg_6(a0, a1, a2, a3, a4, a5, a6, res); \
293 register typeof(a7) arg7 asm("r7") = __a7
295 #define ___declare_args(count, ...) __declare_arg_ ## count(__VA_ARGS__)
296 #define __declare_args(count, ...) ___declare_args(count, __VA_ARGS__)
298 #define ___constraints(count) \
299 : __constraint_read_ ## count \
301 #define __constraints(count) ___constraints(count)
304 * We have an output list that is not necessarily used, and GCC feels
305 * entitled to optimise the whole sequence away. "volatile" is what
308 #define __arm_smccc_1_1(inst, ...) \
310 register unsigned long r0 asm("r0"); \
311 register unsigned long r1 asm("r1"); \
312 register unsigned long r2 asm("r2"); \
313 register unsigned long r3 asm("r3"); \
314 __declare_args(__count_args(__VA_ARGS__), __VA_ARGS__); \
315 asm volatile(inst "\n" : \
316 "=r" (r0), "=r" (r1), "=r" (r2), "=r" (r3) \
317 __constraints(__count_args(__VA_ARGS__))); \
319 *___res = (typeof(*___res)){r0, r1, r2, r3}; \
323 * arm_smccc_1_1_smc() - make an SMCCC v1.1 compliant SMC call
325 * This is a variadic macro taking one to eight source arguments, and
326 * an optional return structure.
328 * @a0-a7: arguments passed in registers 0 to 7
329 * @res: result values from registers 0 to 3
331 * This macro is used to make SMC calls following SMC Calling Convention v1.1.
332 * The content of the supplied param are copied to registers 0 to 7 prior
333 * to the SMC instruction. The return values are updated with the content
334 * from register 0 to 3 on return from the SMC instruction if not NULL.
336 #define arm_smccc_1_1_smc(...) __arm_smccc_1_1(SMCCC_SMC_INST, __VA_ARGS__)
339 * arm_smccc_1_1_hvc() - make an SMCCC v1.1 compliant HVC call
341 * This is a variadic macro taking one to eight source arguments, and
342 * an optional return structure.
344 * @a0-a7: arguments passed in registers 0 to 7
345 * @res: result values from registers 0 to 3
347 * This macro is used to make HVC calls following SMC Calling Convention v1.1.
348 * The content of the supplied param are copied to registers 0 to 7 prior
349 * to the HVC instruction. The return values are updated with the content
350 * from register 0 to 3 on return from the HVC instruction if not NULL.
352 #define arm_smccc_1_1_hvc(...) __arm_smccc_1_1(SMCCC_HVC_INST, __VA_ARGS__)
355 * Like arm_smccc_1_1* but always returns SMCCC_RET_NOT_SUPPORTED.
356 * Used when the SMCCC conduit is not defined. The empty asm statement
357 * avoids compiler warnings about unused variables.
359 #define __fail_smccc_1_1(...) \
361 __declare_args(__count_args(__VA_ARGS__), __VA_ARGS__); \
362 asm ("" : __constraints(__count_args(__VA_ARGS__))); \
364 ___res->a0 = SMCCC_RET_NOT_SUPPORTED; \
368 * arm_smccc_1_1_invoke() - make an SMCCC v1.1 compliant call
370 * This is a variadic macro taking one to eight source arguments, and
371 * an optional return structure.
373 * @a0-a7: arguments passed in registers 0 to 7
374 * @res: result values from registers 0 to 3
376 * This macro will make either an HVC call or an SMC call depending on the
377 * current SMCCC conduit. If no valid conduit is available then -1
378 * (SMCCC_RET_NOT_SUPPORTED) is returned in @res.a0 (if supplied).
380 * The return value also provides the conduit that was used.
382 #define arm_smccc_1_1_invoke(...) ({ \
383 int method = arm_smccc_1_1_get_conduit(); \
385 case SMCCC_CONDUIT_HVC: \
386 arm_smccc_1_1_hvc(__VA_ARGS__); \
388 case SMCCC_CONDUIT_SMC: \
389 arm_smccc_1_1_smc(__VA_ARGS__); \
392 __fail_smccc_1_1(__VA_ARGS__); \
393 method = SMCCC_CONDUIT_NONE; \
399 #endif /*__ASSEMBLY__*/
400 #endif /*__LINUX_ARM_SMCCC_H*/