1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2014, STMicroelectronics International N.V. 4 * Copyright (c) 2022, Linaro Limited 5 */ 6 7 /* Based on GP TEE Internal Core API Specification Version 1.3.1 */ 8 9 #ifndef TEE_API_DEFINES_H 10 #define TEE_API_DEFINES_H 11 12 #define TEE_CORE_API_MAJOR_VERSION 1U 13 #define TEE_CORE_API_MINOR_VERSION 3U 14 #define TEE_CORE_API_MAINTENANCE_VERSION 1U 15 #define TEE_CORE_API_VERSION \ 16 ((TEE_CORE_API_MAJOR_VERSION << 24) | \ 17 (TEE_CORE_API_MINOR_VERSION << 16) | \ 18 (TEE_CORE_API_MAINTENANCE_VERSION << 8)) 19 #define TEE_CORE_API_1_3_1 20 21 /* 22 * Below follows the GP defined way of letting a TA define that it wants an 23 * API compatible with version 1.1 or the latest. An alternative approach 24 * is to set __OPTEE_CORE_API_COMPAT_1_1, but that's an OP-TEE extension. 25 * 26 * The GP specs (>= 1.2) requires that only APIs defined in the indicated 27 * version SHALL be made available when using this mechanism. However, that 28 * is far beyond what ordinary standards requires as they permit 29 * extensions. With this, in OP-TEE, extensions and new API that doesn't 30 * interfere with the selected version of the standard will be permitted. 31 */ 32 #if defined(TEE_CORE_API_REQUIRED_MAINTENANCE_VERSION) && \ 33 !defined(TEE_CORE_API_REQUIRED_MINOR_VERSION) 34 #error "Required TEE_CORE_API_REQUIRED_MINOR_VERSION undefined" 35 #endif 36 #if defined(TEE_CORE_API_REQUIRED_MINOR_VERSION) && \ 37 !defined(TEE_CORE_API_REQUIRED_MAJOR_VERSION) 38 #error "Required TEE_CORE_API_REQUIRED_MAJOR_VERSION undefined" 39 #endif 40 41 #if defined(TEE_CORE_API_REQUIRED_MAJOR_VERSION) 42 #if TEE_CORE_API_REQUIRED_MAJOR_VERSION != 1 && \ 43 TEE_CORE_API_REQUIRED_MAJOR_VERSION != 0 44 #error "Required major version not supported" 45 #endif 46 #ifdef TEE_CORE_API_REQUIRED_MINOR_VERSION 47 #if TEE_CORE_API_REQUIRED_MINOR_VERSION == 1 48 #define __OPTEE_CORE_API_COMPAT_1_1 1 49 #else 50 #error "Required minor version not supported" 51 #endif 52 #if defined(TEE_CORE_API_REQUIRED_MAINTENANCE_VERSION) && \ 53 TEE_CORE_API_REQUIRED_MAINTENANCE_VERSION != 0 54 #error "Required maintenance version not supported" 55 #endif 56 #endif 57 #endif 58 59 /* 60 * For backwards compatibility with v1.1 as provided by up to OP-TEE 61 * version 3.19.0, define __OPTEE_CORE_API_COMPAT_1_1 to 1. 62 * 63 * Some versions of the GP specs have introduced backwards incompatible 64 * changes. For example the v1.0: 65 * 66 * TEE_Result TEE_DigestDoFinal(TEE_OperationHandle operation, 67 * const void *chunk, uint32_t chunkLen, 68 * void *hash, uint32_t *hashLen); 69 * 70 * Was changed in v1.1.1 to this: 71 * 72 * TEE_Result TEE_DigestDoFinal(TEE_OperationHandle operation, 73 * const void *chunk, size_t chunkLen, 74 * void *hash, size_t *hashLen); 75 * 76 * Note the type change for "hashLen", a source of problem especially on 77 * platforms where size_t is a 64-bit unsigned integer. 78 * 79 * As a way of allowing older TAs to be compiled with a newer version of 80 * the API we can turn off or hide different incompatible changes. New 81 * features which are not interfering with older versions of the API are 82 * not disabled. So by enabling __OPTEE_CORE_API_COMPAT_1_1 will not result 83 * in pure 1.1 API, it will be a hybrid API that should work with most TAs 84 * not yet updated to the new API. 85 * 86 * Backwards compatibility is provided by duplicating all functions that 87 * has changed since v1.1. The original function is given a "__GP11_" 88 * prefix and preprocessor macros are used to let a legacy TA use the old 89 * function instead. The same principle applies to defined types. 90 */ 91 #ifndef __OPTEE_CORE_API_COMPAT_1_1 92 #define __OPTEE_CORE_API_COMPAT_1_1 0 93 #endif 94 95 #define TEE_HANDLE_NULL 0 96 97 #define TEE_TIMEOUT_INFINITE 0xFFFFFFFF 98 99 /* API Error Codes */ 100 #define TEE_SUCCESS 0x00000000 101 #define TEE_ERROR_CORRUPT_OBJECT 0xF0100001 102 #define TEE_ERROR_CORRUPT_OBJECT_2 0xF0100002 103 #define TEE_ERROR_STORAGE_NOT_AVAILABLE 0xF0100003 104 #define TEE_ERROR_STORAGE_NOT_AVAILABLE_2 0xF0100004 105 #define TEE_ERROR_UNSUPPORTED_VERSION 0xF0100005 106 #define TEE_ERROR_CIPHERTEXT_INVALID 0xF0100006 107 #define TEE_ERROR_GENERIC 0xFFFF0000 108 #define TEE_ERROR_ACCESS_DENIED 0xFFFF0001 109 #define TEE_ERROR_CANCEL 0xFFFF0002 110 #define TEE_ERROR_ACCESS_CONFLICT 0xFFFF0003 111 #define TEE_ERROR_EXCESS_DATA 0xFFFF0004 112 #define TEE_ERROR_BAD_FORMAT 0xFFFF0005 113 #define TEE_ERROR_BAD_PARAMETERS 0xFFFF0006 114 #define TEE_ERROR_BAD_STATE 0xFFFF0007 115 #define TEE_ERROR_ITEM_NOT_FOUND 0xFFFF0008 116 #define TEE_ERROR_NOT_IMPLEMENTED 0xFFFF0009 117 #define TEE_ERROR_NOT_SUPPORTED 0xFFFF000A 118 #define TEE_ERROR_NO_DATA 0xFFFF000B 119 #define TEE_ERROR_OUT_OF_MEMORY 0xFFFF000C 120 #define TEE_ERROR_BUSY 0xFFFF000D 121 #define TEE_ERROR_COMMUNICATION 0xFFFF000E 122 #define TEE_ERROR_SECURITY 0xFFFF000F 123 #define TEE_ERROR_SHORT_BUFFER 0xFFFF0010 124 #define TEE_ERROR_EXTERNAL_CANCEL 0xFFFF0011 125 #define TEE_ERROR_TIMEOUT 0xFFFF3001 126 #define TEE_ERROR_OVERFLOW 0xFFFF300F 127 #define TEE_ERROR_TARGET_DEAD 0xFFFF3024 128 #define TEE_ERROR_STORAGE_NO_SPACE 0xFFFF3041 129 #define TEE_ERROR_MAC_INVALID 0xFFFF3071 130 #define TEE_ERROR_SIGNATURE_INVALID 0xFFFF3072 131 #define TEE_ERROR_TIME_NOT_SET 0xFFFF5000 132 #define TEE_ERROR_TIME_NEEDS_RESET 0xFFFF5001 133 134 /* Parameter Type Constants */ 135 #define TEE_PARAM_TYPE_NONE 0 136 #define TEE_PARAM_TYPE_VALUE_INPUT 1 137 #define TEE_PARAM_TYPE_VALUE_OUTPUT 2 138 #define TEE_PARAM_TYPE_VALUE_INOUT 3 139 #define TEE_PARAM_TYPE_MEMREF_INPUT 5 140 #define TEE_PARAM_TYPE_MEMREF_OUTPUT 6 141 #define TEE_PARAM_TYPE_MEMREF_INOUT 7 142 143 /* Login Type Constants */ 144 #define TEE_LOGIN_PUBLIC 0x00000000 145 #define TEE_LOGIN_USER 0x00000001 146 #define TEE_LOGIN_GROUP 0x00000002 147 #define TEE_LOGIN_APPLICATION 0x00000004 148 #define TEE_LOGIN_APPLICATION_USER 0x00000005 149 #define TEE_LOGIN_APPLICATION_GROUP 0x00000006 150 #define TEE_LOGIN_TRUSTED_APP 0xF0000000 151 152 /* Origin Code Constants */ 153 #define TEE_ORIGIN_API 0x00000001 154 #define TEE_ORIGIN_COMMS 0x00000002 155 #define TEE_ORIGIN_TEE 0x00000003 156 #define TEE_ORIGIN_TRUSTED_APP 0x00000004 157 158 /* Property Sets pseudo handles */ 159 #define TEE_PROPSET_TEE_IMPLEMENTATION (TEE_PropSetHandle)0xFFFFFFFD 160 #define TEE_PROPSET_CURRENT_CLIENT (TEE_PropSetHandle)0xFFFFFFFE 161 #define TEE_PROPSET_CURRENT_TA (TEE_PropSetHandle)0xFFFFFFFF 162 163 /* Memory Access Rights Constants */ 164 #define TEE_MEMORY_ACCESS_READ 0x00000001 165 #define TEE_MEMORY_ACCESS_WRITE 0x00000002 166 #define TEE_MEMORY_ACCESS_ANY_OWNER 0x00000004 167 168 /* Memory Management Constant */ 169 #define TEE_MALLOC_FILL_ZERO 0x00000000 170 171 /* Other constants */ 172 #define TEE_STORAGE_PRIVATE 0x00000001 173 174 #define TEE_DATA_FLAG_ACCESS_READ 0x00000001 175 #define TEE_DATA_FLAG_ACCESS_WRITE 0x00000002 176 #define TEE_DATA_FLAG_ACCESS_WRITE_META 0x00000004 177 #define TEE_DATA_FLAG_SHARE_READ 0x00000010 178 #define TEE_DATA_FLAG_SHARE_WRITE 0x00000020 179 #define TEE_DATA_FLAG_OVERWRITE 0x00000400 180 #define TEE_DATA_MAX_POSITION 0xFFFFFFFF 181 #define TEE_OBJECT_ID_MAX_LEN 64 182 #define TEE_USAGE_EXTRACTABLE 0x00000001 183 #define TEE_USAGE_ENCRYPT 0x00000002 184 #define TEE_USAGE_DECRYPT 0x00000004 185 #define TEE_USAGE_MAC 0x00000008 186 #define TEE_USAGE_SIGN 0x00000010 187 #define TEE_USAGE_VERIFY 0x00000020 188 #define TEE_USAGE_DERIVE 0x00000040 189 #define TEE_HANDLE_FLAG_PERSISTENT 0x00010000 190 #define TEE_HANDLE_FLAG_INITIALIZED 0x00020000 191 #define TEE_HANDLE_FLAG_KEY_SET 0x00040000 192 #define TEE_HANDLE_FLAG_EXPECT_TWO_KEYS 0x00080000 193 #define TEE_OPERATION_CIPHER 1 194 #define TEE_OPERATION_MAC 3 195 #define TEE_OPERATION_AE 4 196 #define TEE_OPERATION_DIGEST 5 197 #define TEE_OPERATION_ASYMMETRIC_CIPHER 6 198 #define TEE_OPERATION_ASYMMETRIC_SIGNATURE 7 199 #define TEE_OPERATION_KEY_DERIVATION 8 200 #define TEE_OPERATION_STATE_INITIAL 0x00000000 201 #define TEE_OPERATION_STATE_ACTIVE 0x00000001 202 203 /* Algorithm Identifiers */ 204 #define TEE_ALG_AES_ECB_NOPAD 0x10000010 205 #define TEE_ALG_AES_CBC_NOPAD 0x10000110 206 #define TEE_ALG_AES_CTR 0x10000210 207 #define TEE_ALG_AES_CTS 0x10000310 208 #define TEE_ALG_AES_XTS 0x10000410 209 #define TEE_ALG_AES_CBC_MAC_NOPAD 0x30000110 210 #define TEE_ALG_AES_CBC_MAC_PKCS5 0x30000510 211 #define TEE_ALG_AES_CMAC 0x30000610 212 #define TEE_ALG_AES_CCM 0x40000710 213 #define TEE_ALG_AES_GCM 0x40000810 214 #define TEE_ALG_DES_ECB_NOPAD 0x10000011 215 #define TEE_ALG_DES_CBC_NOPAD 0x10000111 216 #define TEE_ALG_DES_CBC_MAC_NOPAD 0x30000111 217 #define TEE_ALG_DES_CBC_MAC_PKCS5 0x30000511 218 #define TEE_ALG_DES3_ECB_NOPAD 0x10000013 219 #define TEE_ALG_DES3_CBC_NOPAD 0x10000113 220 #define TEE_ALG_DES3_CBC_MAC_NOPAD 0x30000113 221 #define TEE_ALG_DES3_CBC_MAC_PKCS5 0x30000513 222 #define TEE_ALG_SM4_ECB_NOPAD 0x10000014 223 #define TEE_ALG_SM4_CBC_NOPAD 0x10000114 224 #define TEE_ALG_SM4_CTR 0x10000214 225 #define TEE_ALG_RSASSA_PKCS1_V1_5_MD5 0x70001830 226 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA1 0x70002830 227 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA224 0x70003830 228 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA256 0x70004830 229 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA384 0x70005830 230 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA512 0x70006830 231 #define TEE_ALG_RSASSA_PKCS1_V1_5_MD5SHA1 0x7000F830 232 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA1 0x70212930 233 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA224 0x70313930 234 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA256 0x70414930 235 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA384 0x70515930 236 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA512 0x70616930 237 #define TEE_ALG_RSAES_PKCS1_V1_5 0x60000130 238 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA1 0x60210230 239 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA224 0x60310230 240 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA256 0x60410230 241 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA384 0x60510230 242 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA512 0x60610230 243 #define TEE_ALG_RSA_NOPAD 0x60000030 244 #define TEE_ALG_DSA_SHA1 0x70002131 245 #define TEE_ALG_DSA_SHA224 0x70003131 246 #define TEE_ALG_DSA_SHA256 0x70004131 247 #define TEE_ALG_SM2_DSA_SM3 0x70006045 248 #define TEE_ALG_DH_DERIVE_SHARED_SECRET 0x80000032 249 #define TEE_ALG_SM2_KEP 0x60000045 250 #define TEE_ALG_MD5 0x50000001 251 #define TEE_ALG_SHA1 0x50000002 252 #define TEE_ALG_SHA224 0x50000003 253 #define TEE_ALG_SHA256 0x50000004 254 #define TEE_ALG_SHA384 0x50000005 255 #define TEE_ALG_SHA512 0x50000006 256 #define TEE_ALG_SHA3_224 0x50000008 257 #define TEE_ALG_SHA3_256 0x50000009 258 #define TEE_ALG_SHA3_384 0x5000000A 259 #define TEE_ALG_SHA3_512 0x5000000B 260 #define TEE_ALG_MD5SHA1 0x5000000F 261 #define TEE_ALG_HMAC_MD5 0x30000001 262 #define TEE_ALG_HMAC_SHA1 0x30000002 263 #define TEE_ALG_HMAC_SHA224 0x30000003 264 #define TEE_ALG_HMAC_SHA256 0x30000004 265 #define TEE_ALG_HMAC_SHA384 0x30000005 266 #define TEE_ALG_HMAC_SHA512 0x30000006 267 #define TEE_ALG_HMAC_SM3 0x30000007 268 269 /* 270 * These are used in the OP-TEE ABI, due to an inconsistency in the v1.1 271 * specification the wrong values we assumed and now we're stuck with those. 272 * 273 * In GP Internal Core API v1.1 274 * "Table 6-12: Structure of Algorithm Identifier" 275 * indicates ECDSA have the algorithm "0x41" and ECDH "0x42" 276 * whereas 277 * "Table 6-11: List of Algorithm Identifiers" defines 278 * TEE_ALG_ECDSA_P192 as 0x70001042 279 * 280 * We chose to define __OPTEE_TEE_ALG_ECDSA_P192 as 0x70001041 and so on 281 * to conform to table 6-12. 282 */ 283 #define __OPTEE_ALG_ECDSA_P192 0x70001041 284 #define __OPTEE_ALG_ECDSA_P224 0x70002041 285 #define __OPTEE_ALG_ECDSA_P256 0x70003041 286 #define __OPTEE_ALG_ECDSA_P384 0x70004041 287 #define __OPTEE_ALG_ECDSA_P521 0x70005041 288 #define __OPTEE_ALG_ECDH_P192 0x80001042 289 #define __OPTEE_ALG_ECDH_P224 0x80002042 290 #define __OPTEE_ALG_ECDH_P256 0x80003042 291 #define __OPTEE_ALG_ECDH_P384 0x80004042 292 #define __OPTEE_ALG_ECDH_P521 0x80005042 293 294 /* TEE_ALG_ECDSA_P* and TEE_ALG_ECDH_P* are deprecated */ 295 #define TEE_ALG_ECDSA_P192 TEE_ALG_ECDSA_SHA1 296 #define TEE_ALG_ECDSA_P224 TEE_ALG_ECDSA_SHA224 297 #define TEE_ALG_ECDSA_P256 TEE_ALG_ECDSA_SHA256 298 #define TEE_ALG_ECDSA_P384 TEE_ALG_ECDSA_SHA384 299 #define TEE_ALG_ECDSA_P521 TEE_ALG_ECDSA_SHA512 300 #define TEE_ALG_ECDH_P192 TEE_ALG_ECDH_DERIVE_SHARED_SECRET 301 #define TEE_ALG_ECDH_P224 TEE_ALG_ECDH_DERIVE_SHARED_SECRET 302 #define TEE_ALG_ECDH_P256 TEE_ALG_ECDH_DERIVE_SHARED_SECRET 303 #define TEE_ALG_ECDH_P384 TEE_ALG_ECDH_DERIVE_SHARED_SECRET 304 #define TEE_ALG_ECDH_P521 TEE_ALG_ECDH_DERIVE_SHARED_SECRET 305 306 #define TEE_ALG_ECDH_DERIVE_SHARED_SECRET 0x80000042 /* v1.1.2 spec */ 307 #define TEE_ALG_ECDSA_SHA1 0x70001042 /* v1.1.2 spec */ 308 #define TEE_ALG_ECDSA_SHA224 0x70002042 /* v1.1.2 spec */ 309 #define TEE_ALG_ECDSA_SHA256 0x70003042 /* v1.1.2 spec */ 310 #define TEE_ALG_ECDSA_SHA384 0x70004042 /* v1.1.2 spec */ 311 #define TEE_ALG_ECDSA_SHA512 0x70005042 /* v1.1.2 spec */ 312 313 #define TEE_ALG_ED25519 0x70006043 /* v1.3.1 spec */ 314 #define TEE_ALG_SM2_PKE 0x80000045 315 #define TEE_ALG_SM3 0x50000007 316 #define TEE_ALG_X25519 0x80000044 317 #define TEE_ALG_ILLEGAL_VALUE 0xEFFFFFFF 318 319 #define TEE_ALG_SHA3_224 0x50000008 320 #define TEE_ALG_SHA3_256 0x50000009 321 #define TEE_ALG_SHA3_384 0x5000000A 322 #define TEE_ALG_SHA3_512 0x5000000B 323 #define TEE_ALG_SHAKE128 0x50000101 324 #define TEE_ALG_SHAKE256 0x50000102 325 326 /* Object Types */ 327 328 #define TEE_TYPE_AES 0xA0000010 329 #define TEE_TYPE_DES 0xA0000011 330 #define TEE_TYPE_DES3 0xA0000013 331 #define TEE_TYPE_SM4 0xA0000014 332 #define TEE_TYPE_HMAC_MD5 0xA0000001 333 #define TEE_TYPE_HMAC_SHA1 0xA0000002 334 #define TEE_TYPE_HMAC_SHA224 0xA0000003 335 #define TEE_TYPE_HMAC_SHA256 0xA0000004 336 #define TEE_TYPE_HMAC_SHA384 0xA0000005 337 #define TEE_TYPE_HMAC_SHA512 0xA0000006 338 #define TEE_TYPE_HMAC_SM3 0xA0000007 /* Not in spec */ 339 #define TEE_TYPE_RSA_PUBLIC_KEY 0xA0000030 340 #define TEE_TYPE_RSA_KEYPAIR 0xA1000030 341 #define TEE_TYPE_DSA_PUBLIC_KEY 0xA0000031 342 #define TEE_TYPE_DSA_KEYPAIR 0xA1000031 343 #define TEE_TYPE_DH_KEYPAIR 0xA1000032 344 #define TEE_TYPE_ECDSA_PUBLIC_KEY 0xA0000041 345 #define TEE_TYPE_ECDSA_KEYPAIR 0xA1000041 346 #define TEE_TYPE_ECDH_PUBLIC_KEY 0xA0000042 347 #define TEE_TYPE_ECDH_KEYPAIR 0xA1000042 348 #define TEE_TYPE_ED25519_PUBLIC_KEY 0xA0000043 /* v1.3.1 spec */ 349 #define TEE_TYPE_ED25519_KEYPAIR 0xA1000043 /* v1.3.1 spec */ 350 #define TEE_TYPE_SM2_DSA_PUBLIC_KEY 0xA0000045 351 #define TEE_TYPE_SM2_DSA_KEYPAIR 0xA1000045 352 #define TEE_TYPE_SM2_KEP_PUBLIC_KEY 0xA0000046 353 #define TEE_TYPE_SM2_KEP_KEYPAIR 0xA1000046 354 #define TEE_TYPE_SM2_PKE_PUBLIC_KEY 0xA0000047 355 #define TEE_TYPE_SM2_PKE_KEYPAIR 0xA1000047 356 #define TEE_TYPE_GENERIC_SECRET 0xA0000000 357 #define TEE_TYPE_CORRUPTED_OBJECT 0xA00000BE 358 #define TEE_TYPE_DATA 0xA00000BF 359 #define TEE_TYPE_X25519_PUBLIC_KEY 0xA0000044 360 #define TEE_TYPE_X25519_KEYPAIR 0xA1000044 361 362 /* List of Object or Operation Attributes */ 363 364 #define TEE_ATTR_SECRET_VALUE 0xC0000000 365 #define TEE_ATTR_RSA_MODULUS 0xD0000130 366 #define TEE_ATTR_RSA_PUBLIC_EXPONENT 0xD0000230 367 #define TEE_ATTR_RSA_PRIVATE_EXPONENT 0xC0000330 368 #define TEE_ATTR_RSA_PRIME1 0xC0000430 369 #define TEE_ATTR_RSA_PRIME2 0xC0000530 370 #define TEE_ATTR_RSA_EXPONENT1 0xC0000630 371 #define TEE_ATTR_RSA_EXPONENT2 0xC0000730 372 #define TEE_ATTR_RSA_COEFFICIENT 0xC0000830 373 #define TEE_ATTR_DSA_PRIME 0xD0001031 374 #define TEE_ATTR_DSA_SUBPRIME 0xD0001131 375 #define TEE_ATTR_DSA_BASE 0xD0001231 376 #define TEE_ATTR_DSA_PUBLIC_VALUE 0xD0000131 377 #define TEE_ATTR_DSA_PRIVATE_VALUE 0xC0000231 378 #define TEE_ATTR_DH_PRIME 0xD0001032 379 #define TEE_ATTR_DH_SUBPRIME 0xD0001132 380 #define TEE_ATTR_DH_BASE 0xD0001232 381 #define TEE_ATTR_DH_X_BITS 0xF0001332 382 #define TEE_ATTR_DH_PUBLIC_VALUE 0xD0000132 383 #define TEE_ATTR_DH_PRIVATE_VALUE 0xC0000232 384 #define TEE_ATTR_RSA_OAEP_LABEL 0xD0000930 385 #define TEE_ATTR_RSA_PSS_SALT_LENGTH 0xF0000A30 386 #define TEE_ATTR_ECC_PUBLIC_VALUE_X 0xD0000141 387 #define TEE_ATTR_ECC_PUBLIC_VALUE_Y 0xD0000241 388 #define TEE_ATTR_ECC_PRIVATE_VALUE 0xC0000341 389 #define TEE_ATTR_ECC_CURVE 0xF0000441 390 #define TEE_ATTR_SM2_ID_INITIATOR 0xD0000446 391 #define TEE_ATTR_SM2_ID_RESPONDER 0xD0000546 392 #define TEE_ATTR_SM2_KEP_USER 0xF0000646 393 #define TEE_ATTR_SM2_KEP_CONFIRMATION_IN 0xD0000746 394 #define TEE_ATTR_SM2_KEP_CONFIRMATION_OUT 0xD0000846 395 396 /* 397 * Commit 5b385b3f835d ("core: crypto: add support for SM2 KEP") defined by 398 * mistake the wrong values for these two. OP-TEE recognizes these two as 399 * alternative IDs in parallel with the correct official values when 400 * supplied as parameters when deriving a key using the TEE_ALG_SM2_KEP 401 * algorithm. 402 */ 403 #define __OPTEE_SM2_KEP_ATTR_ECC_EPHEMERAL_PUBLIC_VALUE_X 0xD0000946 404 #define __OPTEE_SM2_KEP_ATTR_ECC_EPHEMERAL_PUBLIC_VALUE_Y 0xD0000A46 405 406 #define TEE_ATTR_ECC_EPHEMERAL_PUBLIC_VALUE_X 0xD0000146 407 #define TEE_ATTR_ECC_EPHEMERAL_PUBLIC_VALUE_Y 0xD0000246 408 #define TEE_ATTR_EDDSA_CTX 0xD0000643 /* v1.3.1 spec */ 409 #define TEE_ATTR_ED25519_PUBLIC_VALUE 0xD0000743 /* v1.3.1 spec */ 410 #define TEE_ATTR_ED25519_PRIVATE_VALUE 0xC0000843 /* v1.3.1 spec */ 411 #define TEE_ATTR_X25519_PUBLIC_VALUE 0xD0000944 412 #define TEE_ATTR_X25519_PRIVATE_VALUE 0xC0000A44 413 #define TEE_ATTR_EDDSA_PREHASH 0xF0000004 /* v1.3.1 spec */ 414 #define TEE_ATTR_X448_PUBLIC_VALUE 0xD0000A45 415 #define TEE_ATTR_X448_PRIVATE_VALUE 0xC0000A46 416 417 #define TEE_ATTR_FLAG_PUBLIC (1 << 28) 418 #define TEE_ATTR_FLAG_VALUE (1 << 29) 419 /* 420 * Deprecated, but kept for backwards compatibility 421 * 422 * Be careful with GPD TEE Internal API specification v1.0 where table 6-12 423 * defines BIT [28] with the right meaning whereas sections 5.4.3 and 5.4.4 424 * falsely describe a reversed bit flag value meaning. 425 */ 426 #define TEE_ATTR_BIT_PROTECTED TEE_ATTR_FLAG_PUBLIC 427 #define TEE_ATTR_BIT_VALUE TEE_ATTR_FLAG_VALUE 428 429 /* List of Supported ECC Curves */ 430 #define TEE_CRYPTO_ELEMENT_NONE 0x00000000 431 #define TEE_ECC_CURVE_NIST_P192 0x00000001 432 #define TEE_ECC_CURVE_NIST_P224 0x00000002 433 #define TEE_ECC_CURVE_NIST_P256 0x00000003 434 #define TEE_ECC_CURVE_NIST_P384 0x00000004 435 #define TEE_ECC_CURVE_NIST_P521 0x00000005 436 #define TEE_ECC_CURVE_25519 0x00000300 437 #define TEE_ECC_CURVE_SM2 0x00000400 438 439 /* Panicked Functions Identification */ 440 /* TA Interface */ 441 #define TEE_PANIC_ID_TA_CLOSESESSIONENTRYPOINT 0x00000101 442 #define TEE_PANIC_ID_TA_CREATEENTRYPOINT 0x00000102 443 #define TEE_PANIC_ID_TA_DESTROYENTRYPOINT 0x00000103 444 #define TEE_PANIC_ID_TA_INVOKECOMMANDENTRYPOINT 0x00000104 445 #define TEE_PANIC_ID_TA_OPENSESSIONENTRYPOINT 0x00000105 446 /* Property Access */ 447 #define TEE_PANIC_ID_TEE_ALLOCATEPROPERTYENUMERATOR 0x00000201 448 #define TEE_PANIC_ID_TEE_FREEPROPERTYENUMERATOR 0x00000202 449 #define TEE_PANIC_ID_TEE_GETNEXTPROPERTY 0x00000203 450 #define TEE_PANIC_ID_TEE_GETPROPERTYASBINARYBLOCK 0x00000204 451 #define TEE_PANIC_ID_TEE_GETPROPERTYASBOOL 0x00000205 452 #define TEE_PANIC_ID_TEE_GETPROPERTYASIDENTITY 0x00000206 453 #define TEE_PANIC_ID_TEE_GETPROPERTYASSTRING 0x00000207 454 #define TEE_PANIC_ID_TEE_GETPROPERTYASU32 0x00000208 455 #define TEE_PANIC_ID_TEE_GETPROPERTYASUUID 0x00000209 456 #define TEE_PANIC_ID_TEE_GETPROPERTYNAME 0x0000020A 457 #define TEE_PANIC_ID_TEE_RESETPROPERTYENUMERATOR 0x0000020B 458 #define TEE_PANIC_ID_TEE_STARTPROPERTYENUMERATOR 0x0000020C 459 /* Panic Function */ 460 #define TEE_PANIC_ID_TEE_PANIC 0x00000301 461 /* Internal Client API */ 462 #define TEE_PANIC_ID_TEE_CLOSETASESSION 0x00000401 463 #define TEE_PANIC_ID_TEE_INVOKETACOMMAND 0x00000402 464 #define TEE_PANIC_ID_TEE_OPENTASESSION 0x00000403 465 /* Cancellation */ 466 #define TEE_PANIC_ID_TEE_GETCANCELLATIONFLAG 0x00000501 467 #define TEE_PANIC_ID_TEE_MASKCANCELLATION 0x00000502 468 #define TEE_PANIC_ID_TEE_UNMASKCANCELLATION 0x00000503 469 /* Memory Management */ 470 #define TEE_PANIC_ID_TEE_CHECKMEMORYACCESSRIGHTS 0x00000601 471 #define TEE_PANIC_ID_TEE_FREE 0x00000602 472 #define TEE_PANIC_ID_TEE_GETINSTANCEDATA 0x00000603 473 #define TEE_PANIC_ID_TEE_MALLOC 0x00000604 474 #define TEE_PANIC_ID_TEE_MEMCOMPARE 0x00000605 475 #define TEE_PANIC_ID_TEE_MEMFILL 0x00000606 476 #define TEE_PANIC_ID_TEE_MEMMOVE 0x00000607 477 #define TEE_PANIC_ID_TEE_REALLOC 0x00000608 478 #define TEE_PANIC_ID_TEE_SETINSTANCEDATA 0x00000609 479 /* Generic Object */ 480 #define TEE_PANIC_ID_TEE_CLOSEOBJECT 0x00000701 481 #define TEE_PANIC_ID_TEE_GETOBJECTBUFFERATTRIBUTE 0x00000702 482 /* deprecated */ 483 #define TEE_PANIC_ID_TEE_GETOBJECTINFO 0x00000703 484 #define TEE_PANIC_ID_TEE_GETOBJECTVALUEATTRIBUTE 0x00000704 485 /* deprecated */ 486 #define TEE_PANIC_ID_TEE_RESTRICTOBJECTUSAGE 0x00000705 487 #define TEE_PANIC_ID_TEE_GETOBJECTINFO1 0x00000706 488 #define TEE_PANIC_ID_TEE_RESTRICTOBJECTUSAGE1 0x00000707 489 /* Transient Object */ 490 #define TEE_PANIC_ID_TEE_ALLOCATETRANSIENTOBJECT 0x00000801 491 /* deprecated */ 492 #define TEE_PANIC_ID_TEE_COPYOBJECTATTRIBUTES 0x00000802 493 #define TEE_PANIC_ID_TEE_FREETRANSIENTOBJECT 0x00000803 494 #define TEE_PANIC_ID_TEE_GENERATEKEY 0x00000804 495 #define TEE_PANIC_ID_TEE_INITREFATTRIBUTE 0x00000805 496 #define TEE_PANIC_ID_TEE_INITVALUEATTRIBUTE 0x00000806 497 #define TEE_PANIC_ID_TEE_POPULATETRANSIENTOBJECT 0x00000807 498 #define TEE_PANIC_ID_TEE_RESETTRANSIENTOBJECT 0x00000808 499 #define TEE_PANIC_ID_TEE_COPYOBJECTATTRIBUTES1 0x00000809 500 /* Persistent Object */ 501 /* deprecated */ 502 #define TEE_PANIC_ID_TEE_CLOSEANDDELETEPERSISTENTOBJECT 0x00000901 503 #define TEE_PANIC_ID_TEE_CREATEPERSISTENTOBJECT 0x00000902 504 #define TEE_PANIC_ID_TEE_OPENPERSISTENTOBJECT 0x00000903 505 #define TEE_PANIC_ID_TEE_RENAMEPERSISTENTOBJECT 0x00000904 506 #define TEE_PANIC_ID_TEE_CLOSEANDDELETEPERSISTENTOBJECT1 0x00000905 507 /* Persistent Object Enumeration */ 508 #define TEE_PANIC_ID_TEE_ALLOCATEPERSISTENTOBJECTENUMERATOR 0x00000A01 509 #define TEE_PANIC_ID_TEE_FREEPERSISTENTOBJECTENUMERATOR 0x00000A02 510 #define TEE_PANIC_ID_TEE_GETNEXTPERSISTENTOBJECT 0x00000A03 511 #define TEE_PANIC_ID_TEE_RESETPERSISTENTOBJECTENUMERATOR 0x00000A04 512 #define TEE_PANIC_ID_TEE_STARTPERSISTENTOBJECTENUMERATOR 0x00000A05 513 /* Data Stream Access */ 514 #define TEE_PANIC_ID_TEE_READOBJECTDATA 0x00000B01 515 #define TEE_PANIC_ID_TEE_SEEKOBJECTDATA 0x00000B02 516 #define TEE_PANIC_ID_TEE_TRUNCATEOBJECTDATA 0x00000B03 517 #define TEE_PANIC_ID_TEE_WRITEOBJECTDATA 0x00000B04 518 /* Generic Operation */ 519 #define TEE_PANIC_ID_TEE_ALLOCATEOPERATION 0x00000C01 520 #define TEE_PANIC_ID_TEE_COPYOPERATION 0x00000C02 521 #define TEE_PANIC_ID_TEE_FREEOPERATION 0x00000C03 522 #define TEE_PANIC_ID_TEE_GETOPERATIONINFO 0x00000C04 523 #define TEE_PANIC_ID_TEE_RESETOPERATION 0x00000C05 524 #define TEE_PANIC_ID_TEE_SETOPERATIONKEY 0x00000C06 525 #define TEE_PANIC_ID_TEE_SETOPERATIONKEY2 0x00000C07 526 #define TEE_PANIC_ID_TEE_GETOPERATIONINFOMULTIPLE 0x00000C08 527 /* Message Digest */ 528 #define TEE_PANIC_ID_TEE_DIGESTDOFINAL 0x00000D01 529 #define TEE_PANIC_ID_TEE_DIGESTUPDATE 0x00000D02 530 /* Symmetric Cipher */ 531 #define TEE_PANIC_ID_TEE_CIPHERDOFINAL 0x00000E01 532 #define TEE_PANIC_ID_TEE_CIPHERINIT 0x00000E02 533 #define TEE_PANIC_ID_TEE_CIPHERUPDATE 0x00000E03 534 /* MAC */ 535 #define TEE_PANIC_ID_TEE_MACCOMPAREFINAL 0x00000F01 536 #define TEE_PANIC_ID_TEE_MACCOMPUTEFINAL 0x00000F02 537 #define TEE_PANIC_ID_TEE_MACINIT 0x00000F03 538 #define TEE_PANIC_ID_TEE_MACUPDATE 0x00000F04 539 /* Authenticated Encryption */ 540 #define TEE_PANIC_ID_TEE_AEDECRYPTFINAL 0x00001001 541 #define TEE_PANIC_ID_TEE_AEENCRYPTFINAL 0x00001002 542 #define TEE_PANIC_ID_TEE_AEINIT 0x00001003 543 #define TEE_PANIC_ID_TEE_AEUPDATE 0x00001004 544 #define TEE_PANIC_ID_TEE_AEUPDATEAAD 0x00001005 545 /* Asymmetric */ 546 #define TEE_PANIC_ID_TEE_ASYMMETRICDECRYPT 0x00001101 547 #define TEE_PANIC_ID_TEE_ASYMMETRICENCRYPT 0x00001102 548 #define TEE_PANIC_ID_TEE_ASYMMETRICSIGNDIGEST 0x00001103 549 #define TEE_PANIC_ID_TEE_ASYMMETRICVERIFYDIGEST 0x00001104 550 /* Key Derivation */ 551 #define TEE_PANIC_ID_TEE_DERIVEKEY 0x00001201 552 /* Random Data Generation */ 553 #define TEE_PANIC_ID_TEE_GENERATERANDOM 0x00001301 554 /* Time */ 555 #define TEE_PANIC_ID_TEE_GETREETIME 0x00001401 556 #define TEE_PANIC_ID_TEE_GETSYSTEMTIME 0x00001402 557 #define TEE_PANIC_ID_TEE_GETTAPERSISTENTTIME 0x00001403 558 #define TEE_PANIC_ID_TEE_SETTAPERSISTENTTIME 0x00001404 559 #define TEE_PANIC_ID_TEE_WAIT 0x00001405 560 /* Memory Allocation and Size of Objects */ 561 #define TEE_PANIC_ID_TEE_BIGINTFMMCONTEXTSIZEINU32 0x00001501 562 #define TEE_PANIC_ID_TEE_BIGINTFMMSIZEINU32 0x00001502 563 /* Initialization */ 564 #define TEE_PANIC_ID_TEE_BIGINTINIT 0x00001601 565 #define TEE_PANIC_ID_TEE_BIGINTINITFMM 0x00001602 566 #define TEE_PANIC_ID_TEE_BIGINTINITFMMCONTEXT 0x00001603 567 /* Converter */ 568 #define TEE_PANIC_ID_TEE_BIGINTCONVERTFROMOCTETSTRING 0x00001701 569 #define TEE_PANIC_ID_TEE_BIGINTCONVERTFROMS32 0x00001702 570 #define TEE_PANIC_ID_TEE_BIGINTCONVERTTOOCTETSTRING 0x00001703 571 #define TEE_PANIC_ID_TEE_BIGINTCONVERTTOS32 0x00001704 572 /* Logical Operation */ 573 #define TEE_PANIC_ID_TEE_BIGINTCMP 0x00001801 574 #define TEE_PANIC_ID_TEE_BIGINTCMPS32 0x00001802 575 #define TEE_PANIC_ID_TEE_BIGINTGETBIT 0x00001803 576 #define TEE_PANIC_ID_TEE_BIGINTGETBITCOUNT 0x00001804 577 #define TEE_PANIC_ID_TEE_BIGINTSHIFTRIGHT 0x00001805 578 /* Basic Arithmetic */ 579 #define TEE_PANIC_ID_TEE_BIGINTADD 0x00001901 580 #define TEE_PANIC_ID_TEE_BIGINTDIV 0x00001902 581 #define TEE_PANIC_ID_TEE_BIGINTMUL 0x00001903 582 #define TEE_PANIC_ID_TEE_BIGINTNEG 0x00001904 583 #define TEE_PANIC_ID_TEE_BIGINTSQUARE 0x00001905 584 #define TEE_PANIC_ID_TEE_BIGINTSUB 0x00001906 585 /* Modular Arithmetic */ 586 #define TEE_PANIC_ID_TEE_BIGINTADDMOD 0x00001A01 587 #define TEE_PANIC_ID_TEE_BIGINTINVMOD 0x00001A02 588 #define TEE_PANIC_ID_TEE_BIGINTMOD 0x00001A03 589 #define TEE_PANIC_ID_TEE_BIGINTMULMOD 0x00001A04 590 #define TEE_PANIC_ID_TEE_BIGINTSQUAREMOD 0x00001A05 591 #define TEE_PANIC_ID_TEE_BIGINTSUBMOD 0x00001A06 592 /* Other Arithmetic */ 593 #define TEE_PANIC_ID_TEE_BIGINTCOMPUTEEXTENDEDGCD 0x00001B01 594 #define TEE_PANIC_ID_TEE_BIGINTISPROBABLEPRIME 0x00001B02 595 #define TEE_PANIC_ID_TEE_BIGINTRELATIVEPRIME 0x00001B03 596 /* Fast Modular Multiplication */ 597 #define TEE_PANIC_ID_TEE_BIGINTCOMPUTEFMM 0x00001C01 598 #define TEE_PANIC_ID_TEE_BIGINTCONVERTFROMFMM 0x00001C02 599 #define TEE_PANIC_ID_TEE_BIGINTCONVERTTOFMM 0x00001C03 600 601 /* 602 * The macro TEE_PARAM_TYPES can be used to construct a value that you can 603 * compare against an incoming paramTypes to check the type of all the 604 * parameters in one comparison, like in the following example: 605 * if (paramTypes != TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_INPUT, 606 * TEE_PARAM_TYPE_MEMREF_OUPUT, 607 * TEE_PARAM_TYPE_NONE, TEE_PARAM_TYPE_NONE)) { 608 * return TEE_ERROR_BAD_PARAMETERS; 609 * } 610 */ 611 #define TEE_PARAM_TYPES(t0,t1,t2,t3) \ 612 ((t0) | ((t1) << 4) | ((t2) << 8) | ((t3) << 12)) 613 614 /* 615 * The macro TEE_PARAM_TYPE_GET can be used to extract the type of a given 616 * parameter from paramTypes if you need more fine-grained type checking. 617 */ 618 #define TEE_PARAM_TYPE_GET(t, i) ((((uint32_t)t) >> ((i)*4)) & 0xF) 619 620 /* 621 * The macro TEE_PARAM_TYPE_SET can be used to load the type of a given 622 * parameter from paramTypes without specifying all types (TEE_PARAM_TYPES) 623 */ 624 #define TEE_PARAM_TYPE_SET(t, i) (((uint32_t)(t) & 0xF) << ((i)*4)) 625 626 /* Not specified in the standard */ 627 #define TEE_NUM_PARAMS 4 628 629 /* TEE Arithmetical APIs */ 630 631 #define TEE_BigIntSizeInU32(n) ((((n)+31)/32)+2) 632 633 #endif /* TEE_API_DEFINES_H */ 634