1 /* 2 * Copyright (c) 2021-2024, Arm Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef RMMD_SVC_H 8 #define RMMD_SVC_H 9 10 #include <common/sha_common_macros.h> 11 #include <lib/smccc.h> 12 #include <lib/utils_def.h> 13 14 /* STD calls FNUM Min/Max ranges */ 15 #define RMI_FNUM_MIN_VALUE U(0x150) 16 #define RMI_FNUM_MAX_VALUE U(0x18F) 17 18 /* Construct RMI fastcall std FID from offset */ 19 #define SMC64_RMI_FID(_offset) \ 20 ((SMC_TYPE_FAST << FUNCID_TYPE_SHIFT) | \ 21 (SMC_64 << FUNCID_CC_SHIFT) | \ 22 (OEN_STD_START << FUNCID_OEN_SHIFT) | \ 23 (((RMI_FNUM_MIN_VALUE + (_offset)) & FUNCID_NUM_MASK) \ 24 << FUNCID_NUM_SHIFT)) 25 26 #define is_rmi_fid(fid) __extension__ ({ \ 27 __typeof__(fid) _fid = (fid); \ 28 ((GET_SMC_NUM(_fid) >= RMI_FNUM_MIN_VALUE) && \ 29 (GET_SMC_NUM(_fid) <= RMI_FNUM_MAX_VALUE) && \ 30 (GET_SMC_TYPE(_fid) == SMC_TYPE_FAST) && \ 31 (GET_SMC_CC(_fid) == SMC_64) && \ 32 (GET_SMC_OEN(_fid) == OEN_STD_START) && \ 33 ((_fid & 0x00FE0000) == 0U)); }) 34 35 /* 36 * RMI_FNUM_REQ_COMPLETE is the only function in the RMI range that originates 37 * from the Realm world and is handled by the RMMD. The RMI functions are 38 * always invoked by the Normal world, forwarded by RMMD and handled by the 39 * RMM. 40 */ 41 /* 0x18F */ 42 #define RMM_RMI_REQ_COMPLETE SMC64_RMI_FID(U(0x3F)) 43 44 /* RMM_BOOT_COMPLETE arg0 error codes */ 45 #define E_RMM_BOOT_SUCCESS (0) 46 #define E_RMM_BOOT_UNKNOWN (-1) 47 #define E_RMM_BOOT_VERSION_MISMATCH (-2) 48 #define E_RMM_BOOT_CPUS_OUT_OF_RANGE (-3) 49 #define E_RMM_BOOT_CPU_ID_OUT_OF_RANGE (-4) 50 #define E_RMM_BOOT_INVALID_SHARED_BUFFER (-5) 51 #define E_RMM_BOOT_MANIFEST_VERSION_NOT_SUPPORTED (-6) 52 #define E_RMM_BOOT_MANIFEST_DATA_ERROR (-7) 53 54 /* The SMC in the range 0x8400 0191 - 0x8400 01AF are reserved for RSIs.*/ 55 56 /* 57 * EL3 - RMM SMCs used for requesting RMMD services. These SMCs originate in Realm 58 * world and return to Realm world. 59 * 60 * These are allocated from 0x8400 01B0 - 0x8400 01CF in the RMM Service range. 61 */ 62 #define RMMD_EL3_FNUM_MIN_VALUE U(0x1B0) 63 #define RMMD_EL3_FNUM_MAX_VALUE U(0x1CF) 64 65 /* Construct RMM_EL3 fastcall std FID from offset */ 66 #define SMC64_RMMD_EL3_FID(_offset) \ 67 ((SMC_TYPE_FAST << FUNCID_TYPE_SHIFT) | \ 68 (SMC_64 << FUNCID_CC_SHIFT) | \ 69 (OEN_STD_START << FUNCID_OEN_SHIFT) | \ 70 (((RMMD_EL3_FNUM_MIN_VALUE + (_offset)) & FUNCID_NUM_MASK) \ 71 << FUNCID_NUM_SHIFT)) 72 73 /* The macros below are used to identify GTSI calls from the SMC function ID */ 74 #define is_rmmd_el3_fid(fid) __extension__ ({ \ 75 __typeof__(fid) _fid = (fid); \ 76 ((GET_SMC_NUM(_fid) >= RMMD_EL3_FNUM_MIN_VALUE) &&\ 77 (GET_SMC_NUM(_fid) <= RMMD_EL3_FNUM_MAX_VALUE) &&\ 78 (GET_SMC_TYPE(_fid) == SMC_TYPE_FAST) && \ 79 (GET_SMC_CC(_fid) == SMC_64) && \ 80 (GET_SMC_OEN(_fid) == OEN_STD_START) && \ 81 ((_fid & 0x00FE0000) == 0U)); }) 82 83 /* 0x1B0 - 0x1B1 */ 84 #define RMM_GTSI_DELEGATE SMC64_RMMD_EL3_FID(U(0)) 85 #define RMM_GTSI_UNDELEGATE SMC64_RMMD_EL3_FID(U(1)) 86 87 /* Return error codes from RMM-EL3 SMCs */ 88 #define E_RMM_OK 0 89 #define E_RMM_UNK -1 90 #define E_RMM_BAD_ADDR -2 91 #define E_RMM_BAD_PAS -3 92 #define E_RMM_NOMEM -4 93 #define E_RMM_INVAL -5 94 #define E_RMM_AGAIN -6 95 96 /* Return error codes from RMI SMCs */ 97 #define RMI_SUCCESS 0 98 #define RMI_ERROR_INPUT 1 99 100 /* 101 * Retrieve Realm attestation key from EL3. Only P-384 ECC curve key is 102 * supported. The arguments to this SMC are : 103 * arg0 - Function ID. 104 * arg1 - Realm attestation key buffer Physical address. 105 * arg2 - Realm attestation key buffer size (in bytes). 106 * arg3 - The type of the elliptic curve to which the requested 107 * attestation key belongs to. The value should be one of the 108 * defined curve types. 109 * The return arguments are : 110 * ret0 - Status / error. 111 * ret1 - Size of the realm attestation key if successful. 112 */ 113 /* 0x1B2 */ 114 #define RMM_ATTEST_GET_REALM_KEY SMC64_RMMD_EL3_FID(U(2)) 115 116 /* 117 * Retrieve Platform token from EL3. 118 * The arguments to this SMC are : 119 * arg0 - Function ID. 120 * arg1 - Platform attestation token buffer Physical address. (The challenge 121 * object is passed in this buffer.) 122 * arg2 - Platform attestation token buffer size (in bytes). 123 * arg3 - Challenge object size (in bytes). It has to be one of the defined 124 * SHA hash sizes. 125 * The return arguments are : 126 * ret0 - Status / error. 127 * ret1 - Size of the platform token if successful. 128 */ 129 /* 0x1B3 */ 130 #define RMM_ATTEST_GET_PLAT_TOKEN SMC64_RMMD_EL3_FID(U(3)) 131 132 /* Starting RMM-EL3 interface version 0.4 */ 133 #define RMM_EL3_FEATURES SMC64_RMMD_EL3_FID(U(4)) 134 #define RMM_EL3_FEAT_REG_0_IDX U(0) 135 /* Bit 0 of FEAT_REG_0 */ 136 /* 1 - the feature is present in EL3 , 0 - the feature is absent */ 137 #define RMM_EL3_FEAT_REG_0_EL3_TOKEN_SIGN_MASK U(0x1) 138 139 /* 140 * Function codes to support attestation where EL3 is used to sign 141 * realm attestation tokens. In this model, the private key is not 142 * exposed to the RMM. 143 * The arguments to this SMC are: 144 * arg0 - Function ID. 145 * arg1 - Opcode, one of: 146 * RMM_EL3_TOKEN_SIGN_PUSH_REQ_OP, 147 * RMM_EL3_TOKEN_SIGN_PULL_RESP_OP, 148 * RMM_EL3_TOKEN_SIGN_GET_RAK_PUB_OP 149 * arg2 - Pointer to buffer with request/response structures, 150 * which is in the RMM<->EL3 shared buffer. 151 * arg3 - Buffer size of memory pointed by arg2. 152 * arg4 - ECC Curve, when opcode is RMM_EL3_TOKEN_SIGN_GET_RAK_PUB_OP 153 * The return arguments are: 154 * ret0 - Status/Error 155 * ret1 - Size of public key if opcode is RMM_EL3_TOKEN_SIGN_GET_RAK_PUB_OP 156 */ 157 #define RMM_EL3_TOKEN_SIGN SMC64_RMMD_EL3_FID(U(5)) 158 159 /* Opcodes for RMM_EL3_TOKEN_SIGN */ 160 #define RMM_EL3_TOKEN_SIGN_PUSH_REQ_OP U(1) 161 #define RMM_EL3_TOKEN_SIGN_PULL_RESP_OP U(2) 162 #define RMM_EL3_TOKEN_SIGN_GET_RAK_PUB_OP U(3) 163 164 /* ECC Curve types for attest key generation */ 165 #define ATTEST_KEY_CURVE_ECC_SECP384R1 U(0) 166 167 /* Identifier for the hash algorithm used for attestation signing */ 168 #define EL3_TOKEN_SIGN_HASH_ALG_SHA384 U(1) 169 170 /* 171 * RMM_BOOT_COMPLETE originates on RMM when the boot finishes (either cold 172 * or warm boot). This is handled by the RMM-EL3 interface SMC handler. 173 * 174 * RMM_BOOT_COMPLETE FID is located at the end of the available range. 175 */ 176 /* 0x1CF */ 177 #define RMM_BOOT_COMPLETE SMC64_RMMD_EL3_FID(U(0x1F)) 178 179 /* 180 * The major version number of the RMM Boot Interface implementation. 181 * Increase this whenever the semantics of the boot arguments change making it 182 * backwards incompatible. 183 */ 184 #define RMM_EL3_IFC_VERSION_MAJOR (U(0)) 185 186 /* 187 * The minor version number of the RMM Boot Interface implementation. 188 * Increase this when a bug is fixed, or a feature is added without 189 * breaking compatibility. 190 */ 191 #define RMM_EL3_IFC_VERSION_MINOR (U(4)) 192 193 #define RMM_EL3_INTERFACE_VERSION \ 194 (((RMM_EL3_IFC_VERSION_MAJOR << 16) & 0x7FFFF) | \ 195 RMM_EL3_IFC_VERSION_MINOR) 196 197 #define RMM_EL3_IFC_VERSION_GET_MAJOR(_version) (((_version) >> 16) \ 198 & 0x7FFF) 199 #define RMM_EL3_IFC_VERSION_GET_MAJOR_MINOR(_version) ((_version) & 0xFFFF) 200 201 #ifndef __ASSEMBLER__ 202 #include <stdint.h> 203 204 int rmmd_setup(void); 205 uint64_t rmmd_rmi_handler(uint32_t smc_fid, 206 uint64_t x1, 207 uint64_t x2, 208 uint64_t x3, 209 uint64_t x4, 210 void *cookie, 211 void *handle, 212 uint64_t flags); 213 214 uint64_t rmmd_rmm_el3_handler(uint32_t smc_fid, 215 uint64_t x1, 216 uint64_t x2, 217 uint64_t x3, 218 uint64_t x4, 219 void *cookie, 220 void *handle, 221 uint64_t flags); 222 223 #endif /* __ASSEMBLER__ */ 224 #endif /* RMMD_SVC_H */ 225