include/linux/arm-smccc.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (c) 2015, Linaro Limited
   4  * Copyright 2022-2023 Arm Limited and/or its affiliates <open-source-office@arm.com>
   5  *
   6  * Authors:
   7  *   Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com>
   8  */
   9 #ifndef __LINUX_ARM_SMCCC_H
  10 #define __LINUX_ARM_SMCCC_H
  11
  12 /*
  13  * This file provides common defines for ARM SMC Calling Convention as
  14  * specified in
  15  * http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html
  16  */
  17
  18 #define ARM_SMCCC_STD_CALL              0UL
  19 #define ARM_SMCCC_FAST_CALL             1UL
  20 #define ARM_SMCCC_TYPE_SHIFT            31
  21
  22 #define ARM_SMCCC_SMC_32                0
  23 #define ARM_SMCCC_SMC_64                1
  24 #define ARM_SMCCC_CALL_CONV_SHIFT       30
  25
  26 #define ARM_SMCCC_OWNER_MASK            0x3F
  27 #define ARM_SMCCC_OWNER_SHIFT           24
  28
  29 #define ARM_SMCCC_FUNC_MASK             0xFFFF
  30
  31 #define ARM_SMCCC_IS_FAST_CALL(smc_val) \
  32         ((smc_val) & (ARM_SMCCC_FAST_CALL << ARM_SMCCC_TYPE_SHIFT))
  33 #define ARM_SMCCC_IS_64(smc_val) \
  34         ((smc_val) & (ARM_SMCCC_SMC_64 << ARM_SMCCC_CALL_CONV_SHIFT))
  35 #define ARM_SMCCC_FUNC_NUM(smc_val)     ((smc_val) & ARM_SMCCC_FUNC_MASK)
  36 #define ARM_SMCCC_OWNER_NUM(smc_val) \
  37         (((smc_val) >> ARM_SMCCC_OWNER_SHIFT) & ARM_SMCCC_OWNER_MASK)
  38
  39 #define ARM_SMCCC_CALL_VAL(type, calling_convention, owner, func_num) \
  40         (((type) << ARM_SMCCC_TYPE_SHIFT) | \
  41         ((calling_convention) << ARM_SMCCC_CALL_CONV_SHIFT) | \
  42         (((owner) & ARM_SMCCC_OWNER_MASK) << ARM_SMCCC_OWNER_SHIFT) | \
  43         ((func_num) & ARM_SMCCC_FUNC_MASK))
  44
  45 #define ARM_SMCCC_OWNER_ARCH            0
  46 #define ARM_SMCCC_OWNER_CPU             1
  47 #define ARM_SMCCC_OWNER_SIP             2
  48 #define ARM_SMCCC_OWNER_OEM             3
  49 #define ARM_SMCCC_OWNER_STANDARD        4
  50 #define ARM_SMCCC_OWNER_TRUSTED_APP     48
  51 #define ARM_SMCCC_OWNER_TRUSTED_APP_END 49
  52 #define ARM_SMCCC_OWNER_TRUSTED_OS      50
  53 #define ARM_SMCCC_OWNER_TRUSTED_OS_END  63
  54
  55 #define ARM_SMCCC_QUIRK_NONE            0
  56 #define ARM_SMCCC_QUIRK_QCOM_A6         1 /* Save/restore register a6 */
  57
  58 #define ARM_SMCCC_ARCH_FEATURES         0x80000001
  59
  60 #define ARM_SMCCC_RET_NOT_SUPPORTED     ((unsigned long)-1)
  61
  62 #ifndef __ASSEMBLY__
  63
  64 #include <linux/linkage.h>
  65 #include <linux/types.h>
  66 /**
  67  * struct arm_smccc_res - Result from SMC/HVC call
  68  * @a0-a3 result values from registers 0 to 3
  69  */
  70 struct arm_smccc_res {
  71         unsigned long a0;
  72         unsigned long a1;
  73         unsigned long a2;
  74         unsigned long a3;
  75 };
  76
  77 #ifdef CONFIG_ARM64
  78 /**
  79  * struct arm_smccc_1_2_regs - Arguments for or Results from SMC call
  80  * @a0-a17 argument values from registers 0 to 17
  81  */
  82 struct arm_smccc_1_2_regs {
  83         unsigned long a0;
  84         unsigned long a1;
  85         unsigned long a2;
  86         unsigned long a3;
  87         unsigned long a4;
  88         unsigned long a5;
  89         unsigned long a6;
  90         unsigned long a7;
  91         unsigned long a8;
  92         unsigned long a9;
  93         unsigned long a10;
  94         unsigned long a11;
  95         unsigned long a12;
  96         unsigned long a13;
  97         unsigned long a14;
  98         unsigned long a15;
  99         unsigned long a16;
 100         unsigned long a17;
 101 };
 102
 103 /**
 104  * arm_smccc_1_2_smc() - make SMC calls
 105  * @args: arguments passed via struct arm_smccc_1_2_regs
 106  * @res: result values via struct arm_smccc_1_2_regs
 107  *
 108  * This function is used to make SMC calls following SMC Calling Convention
 109  * v1.2 or above. The content of the supplied param are copied from the
 110  * structure to registers prior to the SMC instruction. The return values
 111  * are updated with the content from registers on return from the SMC
 112  * instruction.
 113  */
 114 asmlinkage void arm_smccc_1_2_smc(const struct arm_smccc_1_2_regs *args,
 115                                   struct arm_smccc_1_2_regs *res);
 116 #endif
 117
 118 /**
 119  * struct arm_smccc_quirk - Contains quirk information
 120  * @id: quirk identification
 121  * @state: quirk specific information
 122  * @a6: Qualcomm quirk entry for returning post-smc call contents of a6
 123  */
 124 struct arm_smccc_quirk {
 125         int     id;
 126         union {
 127                 unsigned long a6;
 128         } state;
 129 };
 130
 131 /**
 132  * struct arm_smccc_feature - Driver registration data for discoverable feature
 133  * @driver_name: name of the driver relate to the SMCCC feature
 134  * @is_supported: callback to test if SMCCC feature is supported
 135  */
 136 struct arm_smccc_feature {
 137         const char *driver_name;
 138         bool (*is_supported)(void (*invoke_fn)(unsigned long a0, unsigned long a1, unsigned long a2,
 139                                                unsigned long a3, unsigned long a4, unsigned long a5,
 140                                                unsigned long a6, unsigned long a7,
 141                                                struct arm_smccc_res *res));
 142 };
 143
 144 #define ARM_SMCCC_FEATURE_DRIVER(__name) \
 145         ll_entry_declare(struct arm_smccc_feature, __name, arm_smccc_feature)
 146
 147 /**
 148  * __arm_smccc_smc() - make SMC calls
 149  * @a0-a7: arguments passed in registers 0 to 7
 150  * @res: result values from registers 0 to 3
 151  * @quirk: points to an arm_smccc_quirk, or NULL when no quirks are required.
 152  *
 153  * This function is used to make SMC calls following SMC Calling Convention.
 154  * The content of the supplied param are copied to registers 0 to 7 prior
 155  * to the SMC instruction. The return values are updated with the content
 156  * from register 0 to 3 on return from the SMC instruction.  An optional
 157  * quirk structure provides vendor specific behavior.
 158  */
 159 asmlinkage void __arm_smccc_smc(unsigned long a0, unsigned long a1,
 160                         unsigned long a2, unsigned long a3, unsigned long a4,
 161                         unsigned long a5, unsigned long a6, unsigned long a7,
 162                         struct arm_smccc_res *res, struct arm_smccc_quirk *quirk);
 163
 164 /**
 165  * __arm_smccc_hvc() - make HVC calls
 166  * @a0-a7: arguments passed in registers 0 to 7
 167  * @res: result values from registers 0 to 3
 168  * @quirk: points to an arm_smccc_quirk, or NULL when no quirks are required.
 169  *
 170  * This function is used to make HVC calls following SMC Calling
 171  * Convention.  The content of the supplied param are copied to registers 0
 172  * to 7 prior to the HVC instruction. The return values are updated with
 173  * the content from register 0 to 3 on return from the HVC instruction.  An
 174  * optional quirk structure provides vendor specific behavior.
 175  */
 176 asmlinkage void __arm_smccc_hvc(unsigned long a0, unsigned long a1,
 177                         unsigned long a2, unsigned long a3, unsigned long a4,
 178                         unsigned long a5, unsigned long a6, unsigned long a7,
 179                         struct arm_smccc_res *res, struct arm_smccc_quirk *quirk);
 180
 181 #define arm_smccc_smc(...) __arm_smccc_smc(__VA_ARGS__, NULL)
 182
 183 #define arm_smccc_smc_quirk(...) __arm_smccc_smc(__VA_ARGS__)
 184
 185 #define arm_smccc_hvc(...) __arm_smccc_hvc(__VA_ARGS__, NULL)
 186
 187 #define arm_smccc_hvc_quirk(...) __arm_smccc_hvc(__VA_ARGS__)
 188
 189 #endif /*__ASSEMBLY__*/
 190 #endif /*__LINUX_ARM_SMCCC_H*/