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_FUNC_QUERY_CALL_UID 0xff01
60 #define ARM_SMCCC_QUIRK_NONE 0
61 #define ARM_SMCCC_QUIRK_QCOM_A6 1 /* Save/restore register a6 */
63 #define ARM_SMCCC_VERSION_1_0 0x10000
64 #define ARM_SMCCC_VERSION_1_1 0x10001
65 #define ARM_SMCCC_VERSION_1_2 0x10002
66 #define ARM_SMCCC_VERSION_1_3 0x10003
68 #define ARM_SMCCC_1_3_SVE_HINT 0x10000
70 #define ARM_SMCCC_VERSION_FUNC_ID \
71 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
75 #define ARM_SMCCC_ARCH_FEATURES_FUNC_ID \
76 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
80 #define ARM_SMCCC_ARCH_SOC_ID \
81 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
85 #define ARM_SMCCC_ARCH_WORKAROUND_1 \
86 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
90 #define ARM_SMCCC_ARCH_WORKAROUND_2 \
91 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
95 #define ARM_SMCCC_VENDOR_HYP_CALL_UID_FUNC_ID \
96 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
98 ARM_SMCCC_OWNER_VENDOR_HYP, \
99 ARM_SMCCC_FUNC_QUERY_CALL_UID)
101 /* KVM UID value: 28b46fb6-2ec5-11e9-a9ca-4b564d003a74 */
102 #define ARM_SMCCC_VENDOR_HYP_UID_KVM_REG_0 0xb66fb428U
103 #define ARM_SMCCC_VENDOR_HYP_UID_KVM_REG_1 0xe911c52eU
104 #define ARM_SMCCC_VENDOR_HYP_UID_KVM_REG_2 0x564bcaa9U
105 #define ARM_SMCCC_VENDOR_HYP_UID_KVM_REG_3 0x743a004dU
107 /* KVM "vendor specific" services */
108 #define ARM_SMCCC_KVM_FUNC_FEATURES 0
109 #define ARM_SMCCC_KVM_FUNC_PTP 1
110 #define ARM_SMCCC_KVM_FUNC_FEATURES_2 127
111 #define ARM_SMCCC_KVM_NUM_FUNCS 128
113 #define ARM_SMCCC_VENDOR_HYP_KVM_FEATURES_FUNC_ID \
114 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
116 ARM_SMCCC_OWNER_VENDOR_HYP, \
117 ARM_SMCCC_KVM_FUNC_FEATURES)
119 #define SMCCC_ARCH_WORKAROUND_RET_UNAFFECTED 1
122 * ptp_kvm is a feature used for time sync between vm and host.
123 * ptp_kvm module in guest kernel will get service from host using
126 #define ARM_SMCCC_VENDOR_HYP_KVM_PTP_FUNC_ID \
127 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
129 ARM_SMCCC_OWNER_VENDOR_HYP, \
130 ARM_SMCCC_KVM_FUNC_PTP)
132 /* ptp_kvm counter type ID */
133 #define KVM_PTP_VIRT_COUNTER 0
134 #define KVM_PTP_PHYS_COUNTER 1
136 /* Paravirtualised time calls (defined by ARM DEN0057A) */
137 #define ARM_SMCCC_HV_PV_TIME_FEATURES \
138 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
140 ARM_SMCCC_OWNER_STANDARD_HYP, \
143 #define ARM_SMCCC_HV_PV_TIME_ST \
144 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
146 ARM_SMCCC_OWNER_STANDARD_HYP, \
149 /* TRNG entropy source calls (defined by ARM DEN0098) */
150 #define ARM_SMCCC_TRNG_VERSION \
151 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
153 ARM_SMCCC_OWNER_STANDARD, \
156 #define ARM_SMCCC_TRNG_FEATURES \
157 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
159 ARM_SMCCC_OWNER_STANDARD, \
162 #define ARM_SMCCC_TRNG_GET_UUID \
163 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
165 ARM_SMCCC_OWNER_STANDARD, \
168 #define ARM_SMCCC_TRNG_RND32 \
169 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
171 ARM_SMCCC_OWNER_STANDARD, \
174 #define ARM_SMCCC_TRNG_RND64 \
175 ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
177 ARM_SMCCC_OWNER_STANDARD, \
181 * Return codes defined in ARM DEN 0070A
182 * ARM DEN 0070A is now merged/consolidated into ARM DEN 0028 C
184 #define SMCCC_RET_SUCCESS 0
185 #define SMCCC_RET_NOT_SUPPORTED -1
186 #define SMCCC_RET_NOT_REQUIRED -2
187 #define SMCCC_RET_INVALID_PARAMETER -3
191 #include <linux/linkage.h>
192 #include <linux/types.h>
194 enum arm_smccc_conduit {
201 * arm_smccc_1_1_get_conduit()
203 * Returns the conduit to be used for SMCCCv1.1 or later.
205 * When SMCCCv1.1 is not present, returns SMCCC_CONDUIT_NONE.
207 enum arm_smccc_conduit arm_smccc_1_1_get_conduit(void);
210 * arm_smccc_get_version()
212 * Returns the version to be used for SMCCCv1.1 or later.
214 * When SMCCCv1.1 or above is not present, returns SMCCCv1.0, but this
215 * does not imply the presence of firmware or a valid conduit. Caller
216 * handling SMCCCv1.0 must determine the conduit by other means.
218 u32 arm_smccc_get_version(void);
220 void __init arm_smccc_version_init(u32 version, enum arm_smccc_conduit conduit);
222 extern u64 smccc_has_sve_hint;
225 * struct arm_smccc_res - Result from SMC/HVC call
226 * @a0-a3 result values from registers 0 to 3
228 struct arm_smccc_res {
237 * struct arm_smccc_1_2_regs - Arguments for or Results from SMC/HVC call
238 * @a0-a17 argument values from registers 0 to 17
240 struct arm_smccc_1_2_regs {
262 * arm_smccc_1_2_hvc() - make HVC calls
263 * @args: arguments passed via struct arm_smccc_1_2_regs
264 * @res: result values via struct arm_smccc_1_2_regs
266 * This function is used to make HVC calls following SMC Calling Convention
267 * v1.2 or above. The content of the supplied param are copied from the
268 * structure to registers prior to the HVC instruction. The return values
269 * are updated with the content from registers on return from the HVC
272 asmlinkage void arm_smccc_1_2_hvc(const struct arm_smccc_1_2_regs *args,
273 struct arm_smccc_1_2_regs *res);
276 * arm_smccc_1_2_smc() - make SMC calls
277 * @args: arguments passed via struct arm_smccc_1_2_regs
278 * @res: result values via struct arm_smccc_1_2_regs
280 * This function is used to make SMC calls following SMC Calling Convention
281 * v1.2 or above. The content of the supplied param are copied from the
282 * structure to registers prior to the SMC instruction. The return values
283 * are updated with the content from registers on return from the SMC
286 asmlinkage void arm_smccc_1_2_smc(const struct arm_smccc_1_2_regs *args,
287 struct arm_smccc_1_2_regs *res);
291 * struct arm_smccc_quirk - Contains quirk information
292 * @id: quirk identification
293 * @state: quirk specific information
294 * @a6: Qualcomm quirk entry for returning post-smc call contents of a6
296 struct arm_smccc_quirk {
304 * __arm_smccc_sve_check() - Set the SVE hint bit when doing SMC calls
306 * Sets the SMCCC hint bit to indicate if there is live state in the SVE
307 * registers, this modifies x0 in place and should never be called from C
310 asmlinkage unsigned long __arm_smccc_sve_check(unsigned long x0);
313 * __arm_smccc_smc() - make SMC calls
314 * @a0-a7: arguments passed in registers 0 to 7
315 * @res: result values from registers 0 to 3
316 * @quirk: points to an arm_smccc_quirk, or NULL when no quirks are required.
318 * This function is used to make SMC calls following SMC Calling Convention.
319 * The content of the supplied param are copied to registers 0 to 7 prior
320 * to the SMC instruction. The return values are updated with the content
321 * from register 0 to 3 on return from the SMC instruction. An optional
322 * quirk structure provides vendor specific behavior.
324 asmlinkage void __arm_smccc_smc(unsigned long a0, unsigned long a1,
325 unsigned long a2, unsigned long a3, unsigned long a4,
326 unsigned long a5, unsigned long a6, unsigned long a7,
327 struct arm_smccc_res *res, struct arm_smccc_quirk *quirk);
330 * __arm_smccc_hvc() - make HVC calls
331 * @a0-a7: arguments passed in registers 0 to 7
332 * @res: result values from registers 0 to 3
333 * @quirk: points to an arm_smccc_quirk, or NULL when no quirks are required.
335 * This function is used to make HVC calls following SMC Calling
336 * Convention. The content of the supplied param are copied to registers 0
337 * to 7 prior to the HVC instruction. The return values are updated with
338 * the content from register 0 to 3 on return from the HVC instruction. An
339 * optional quirk structure provides vendor specific behavior.
341 asmlinkage void __arm_smccc_hvc(unsigned long a0, unsigned long a1,
342 unsigned long a2, unsigned long a3, unsigned long a4,
343 unsigned long a5, unsigned long a6, unsigned long a7,
344 struct arm_smccc_res *res, struct arm_smccc_quirk *quirk);
346 #define arm_smccc_smc(...) __arm_smccc_smc(__VA_ARGS__, NULL)
348 #define arm_smccc_smc_quirk(...) __arm_smccc_smc(__VA_ARGS__)
350 #define arm_smccc_hvc(...) __arm_smccc_hvc(__VA_ARGS__, NULL)
352 #define arm_smccc_hvc_quirk(...) __arm_smccc_hvc(__VA_ARGS__)
354 /* SMCCC v1.1 implementation madness follows */
357 #define SMCCC_SMC_INST "smc #0"
358 #define SMCCC_HVC_INST "hvc #0"
360 #elif defined(CONFIG_ARM)
361 #include <asm/opcodes-sec.h>
362 #include <asm/opcodes-virt.h>
364 #define SMCCC_SMC_INST __SMC(0)
365 #define SMCCC_HVC_INST __HVC(0)
369 /* nVHE hypervisor doesn't have a current thread so needs separate checks */
370 #if defined(CONFIG_ARM64_SVE) && !defined(__KVM_NVHE_HYPERVISOR__)
372 #define SMCCC_SVE_CHECK ALTERNATIVE("nop \n", "bl __arm_smccc_sve_check \n", \
374 #define smccc_sve_clobbers "x16", "x30", "cc",
378 #define SMCCC_SVE_CHECK
379 #define smccc_sve_clobbers
383 #define ___count_args(_0, _1, _2, _3, _4, _5, _6, _7, _8, x, ...) x
385 #define __count_args(...) \
386 ___count_args(__VA_ARGS__, 7, 6, 5, 4, 3, 2, 1, 0)
388 #define __constraint_read_0 "r" (arg0)
389 #define __constraint_read_1 __constraint_read_0, "r" (arg1)
390 #define __constraint_read_2 __constraint_read_1, "r" (arg2)
391 #define __constraint_read_3 __constraint_read_2, "r" (arg3)
392 #define __constraint_read_4 __constraint_read_3, "r" (arg4)
393 #define __constraint_read_5 __constraint_read_4, "r" (arg5)
394 #define __constraint_read_6 __constraint_read_5, "r" (arg6)
395 #define __constraint_read_7 __constraint_read_6, "r" (arg7)
397 #define __declare_arg_0(a0, res) \
398 struct arm_smccc_res *___res = res; \
399 register unsigned long arg0 asm("r0") = (u32)a0
401 #define __declare_arg_1(a0, a1, res) \
402 typeof(a1) __a1 = a1; \
403 struct arm_smccc_res *___res = res; \
404 register unsigned long arg0 asm("r0") = (u32)a0; \
405 register typeof(a1) arg1 asm("r1") = __a1
407 #define __declare_arg_2(a0, a1, a2, res) \
408 typeof(a1) __a1 = a1; \
409 typeof(a2) __a2 = a2; \
410 struct arm_smccc_res *___res = res; \
411 register unsigned long arg0 asm("r0") = (u32)a0; \
412 register typeof(a1) arg1 asm("r1") = __a1; \
413 register typeof(a2) arg2 asm("r2") = __a2
415 #define __declare_arg_3(a0, a1, a2, a3, res) \
416 typeof(a1) __a1 = a1; \
417 typeof(a2) __a2 = a2; \
418 typeof(a3) __a3 = a3; \
419 struct arm_smccc_res *___res = res; \
420 register unsigned long arg0 asm("r0") = (u32)a0; \
421 register typeof(a1) arg1 asm("r1") = __a1; \
422 register typeof(a2) arg2 asm("r2") = __a2; \
423 register typeof(a3) arg3 asm("r3") = __a3
425 #define __declare_arg_4(a0, a1, a2, a3, a4, res) \
426 typeof(a4) __a4 = a4; \
427 __declare_arg_3(a0, a1, a2, a3, res); \
428 register typeof(a4) arg4 asm("r4") = __a4
430 #define __declare_arg_5(a0, a1, a2, a3, a4, a5, res) \
431 typeof(a5) __a5 = a5; \
432 __declare_arg_4(a0, a1, a2, a3, a4, res); \
433 register typeof(a5) arg5 asm("r5") = __a5
435 #define __declare_arg_6(a0, a1, a2, a3, a4, a5, a6, res) \
436 typeof(a6) __a6 = a6; \
437 __declare_arg_5(a0, a1, a2, a3, a4, a5, res); \
438 register typeof(a6) arg6 asm("r6") = __a6
440 #define __declare_arg_7(a0, a1, a2, a3, a4, a5, a6, a7, res) \
441 typeof(a7) __a7 = a7; \
442 __declare_arg_6(a0, a1, a2, a3, a4, a5, a6, res); \
443 register typeof(a7) arg7 asm("r7") = __a7
445 #define ___declare_args(count, ...) __declare_arg_ ## count(__VA_ARGS__)
446 #define __declare_args(count, ...) ___declare_args(count, __VA_ARGS__)
448 #define ___constraints(count) \
449 : __constraint_read_ ## count \
450 : smccc_sve_clobbers "memory"
451 #define __constraints(count) ___constraints(count)
454 * We have an output list that is not necessarily used, and GCC feels
455 * entitled to optimise the whole sequence away. "volatile" is what
458 #define __arm_smccc_1_1(inst, ...) \
460 register unsigned long r0 asm("r0"); \
461 register unsigned long r1 asm("r1"); \
462 register unsigned long r2 asm("r2"); \
463 register unsigned long r3 asm("r3"); \
464 __declare_args(__count_args(__VA_ARGS__), __VA_ARGS__); \
465 asm volatile(SMCCC_SVE_CHECK \
467 "=r" (r0), "=r" (r1), "=r" (r2), "=r" (r3) \
468 __constraints(__count_args(__VA_ARGS__))); \
470 *___res = (typeof(*___res)){r0, r1, r2, r3}; \
474 * arm_smccc_1_1_smc() - make an SMCCC v1.1 compliant SMC call
476 * This is a variadic macro taking one to eight source arguments, and
477 * an optional return structure.
479 * @a0-a7: arguments passed in registers 0 to 7
480 * @res: result values from registers 0 to 3
482 * This macro is used to make SMC calls following SMC Calling Convention v1.1.
483 * The content of the supplied param are copied to registers 0 to 7 prior
484 * to the SMC instruction. The return values are updated with the content
485 * from register 0 to 3 on return from the SMC instruction if not NULL.
487 #define arm_smccc_1_1_smc(...) __arm_smccc_1_1(SMCCC_SMC_INST, __VA_ARGS__)
490 * arm_smccc_1_1_hvc() - make an SMCCC v1.1 compliant HVC call
492 * This is a variadic macro taking one to eight source arguments, and
493 * an optional return structure.
495 * @a0-a7: arguments passed in registers 0 to 7
496 * @res: result values from registers 0 to 3
498 * This macro is used to make HVC calls following SMC Calling Convention v1.1.
499 * The content of the supplied param are copied to registers 0 to 7 prior
500 * to the HVC instruction. The return values are updated with the content
501 * from register 0 to 3 on return from the HVC instruction if not NULL.
503 #define arm_smccc_1_1_hvc(...) __arm_smccc_1_1(SMCCC_HVC_INST, __VA_ARGS__)
506 * Like arm_smccc_1_1* but always returns SMCCC_RET_NOT_SUPPORTED.
507 * Used when the SMCCC conduit is not defined. The empty asm statement
508 * avoids compiler warnings about unused variables.
510 #define __fail_smccc_1_1(...) \
512 __declare_args(__count_args(__VA_ARGS__), __VA_ARGS__); \
513 asm ("" : __constraints(__count_args(__VA_ARGS__))); \
515 ___res->a0 = SMCCC_RET_NOT_SUPPORTED; \
519 * arm_smccc_1_1_invoke() - make an SMCCC v1.1 compliant call
521 * This is a variadic macro taking one to eight source arguments, and
522 * an optional return structure.
524 * @a0-a7: arguments passed in registers 0 to 7
525 * @res: result values from registers 0 to 3
527 * This macro will make either an HVC call or an SMC call depending on the
528 * current SMCCC conduit. If no valid conduit is available then -1
529 * (SMCCC_RET_NOT_SUPPORTED) is returned in @res.a0 (if supplied).
531 * The return value also provides the conduit that was used.
533 #define arm_smccc_1_1_invoke(...) ({ \
534 int method = arm_smccc_1_1_get_conduit(); \
536 case SMCCC_CONDUIT_HVC: \
537 arm_smccc_1_1_hvc(__VA_ARGS__); \
539 case SMCCC_CONDUIT_SMC: \
540 arm_smccc_1_1_smc(__VA_ARGS__); \
543 __fail_smccc_1_1(__VA_ARGS__); \
544 method = SMCCC_CONDUIT_NONE; \
550 #endif /*__ASSEMBLY__*/
551 #endif /*__LINUX_ARM_SMCCC_H*/