1 /* 2 * Copyright (c) 2014, STMicroelectronics International N.V. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation 13 * and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25 * POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 /* Based on GP TEE Internal Core API Specification Version 1.1 */ 29 30 #ifndef TEE_API_DEFINES_H 31 #define TEE_API_DEFINES_H 32 33 #define TEE_INT_CORE_API_SPEC_VERSION 0x0000000A 34 35 #define TEE_HANDLE_NULL 0 36 37 #define TEE_TIMEOUT_INFINITE 0xFFFFFFFF 38 39 /* API Error Codes */ 40 #define TEE_SUCCESS 0x00000000 41 #define TEE_ERROR_CORRUPT_OBJECT 0xF0100001 42 #define TEE_ERROR_CORRUPT_OBJECT_2 0xF0100002 43 #define TEE_ERROR_STORAGE_NOT_AVAILABLE 0xF0100003 44 #define TEE_ERROR_STORAGE_NOT_AVAILABLE_2 0xF0100004 45 #define TEE_ERROR_GENERIC 0xFFFF0000 46 #define TEE_ERROR_ACCESS_DENIED 0xFFFF0001 47 #define TEE_ERROR_CANCEL 0xFFFF0002 48 #define TEE_ERROR_ACCESS_CONFLICT 0xFFFF0003 49 #define TEE_ERROR_EXCESS_DATA 0xFFFF0004 50 #define TEE_ERROR_BAD_FORMAT 0xFFFF0005 51 #define TEE_ERROR_BAD_PARAMETERS 0xFFFF0006 52 #define TEE_ERROR_BAD_STATE 0xFFFF0007 53 #define TEE_ERROR_ITEM_NOT_FOUND 0xFFFF0008 54 #define TEE_ERROR_NOT_IMPLEMENTED 0xFFFF0009 55 #define TEE_ERROR_NOT_SUPPORTED 0xFFFF000A 56 #define TEE_ERROR_NO_DATA 0xFFFF000B 57 #define TEE_ERROR_OUT_OF_MEMORY 0xFFFF000C 58 #define TEE_ERROR_BUSY 0xFFFF000D 59 #define TEE_ERROR_COMMUNICATION 0xFFFF000E 60 #define TEE_ERROR_SECURITY 0xFFFF000F 61 #define TEE_ERROR_SHORT_BUFFER 0xFFFF0010 62 #define TEE_ERROR_EXTERNAL_CANCEL 0xFFFF0011 63 #define TEE_ERROR_OVERFLOW 0xFFFF300F 64 #define TEE_ERROR_TARGET_DEAD 0xFFFF3024 65 #define TEE_ERROR_STORAGE_NO_SPACE 0xFFFF3041 66 #define TEE_ERROR_MAC_INVALID 0xFFFF3071 67 #define TEE_ERROR_SIGNATURE_INVALID 0xFFFF3072 68 #define TEE_ERROR_TIME_NOT_SET 0xFFFF5000 69 #define TEE_ERROR_TIME_NEEDS_RESET 0xFFFF5001 70 71 /* 72 * Proprietary error codes. 73 * All proprietary error codes should use the 0xF57E prefix. 74 */ 75 #define TEE_ERROR_SYSTEM_BUSY 0xF57E0000 76 #define TEE_ERROR_FILE_NOT_FOUND 0xF57E0010 77 78 /* Parameter Type Constants */ 79 #define TEE_PARAM_TYPE_NONE 0 80 #define TEE_PARAM_TYPE_VALUE_INPUT 1 81 #define TEE_PARAM_TYPE_VALUE_OUTPUT 2 82 #define TEE_PARAM_TYPE_VALUE_INOUT 3 83 #define TEE_PARAM_TYPE_MEMREF_INPUT 5 84 #define TEE_PARAM_TYPE_MEMREF_OUTPUT 6 85 #define TEE_PARAM_TYPE_MEMREF_INOUT 7 86 87 /* Login Type Constants */ 88 #define TEE_LOGIN_PUBLIC 0x00000000 89 #define TEE_LOGIN_USER 0x00000001 90 #define TEE_LOGIN_GROUP 0x00000002 91 #define TEE_LOGIN_APPLICATION 0x00000004 92 #define TEE_LOGIN_APPLICATION_USER 0x00000005 93 #define TEE_LOGIN_APPLICATION_GROUP 0x00000006 94 #define TEE_LOGIN_TRUSTED_APP 0xF0000000 95 96 /* Origin Code Constants */ 97 #define TEE_ORIGIN_API 0x00000001 98 #define TEE_ORIGIN_COMMS 0x00000002 99 #define TEE_ORIGIN_TEE 0x00000003 100 #define TEE_ORIGIN_TRUSTED_APP 0x00000004 101 102 /* Property Sets pseudo handles */ 103 #define TEE_PROPSET_TEE_IMPLEMENTATION (TEE_PropSetHandle)0xFFFFFFFD 104 #define TEE_PROPSET_CURRENT_CLIENT (TEE_PropSetHandle)0xFFFFFFFE 105 #define TEE_PROPSET_CURRENT_TA (TEE_PropSetHandle)0xFFFFFFFF 106 107 /* Memory Access Rights Constants */ 108 #define TEE_MEMORY_ACCESS_READ 0x00000001 109 #define TEE_MEMORY_ACCESS_WRITE 0x00000002 110 #define TEE_MEMORY_ACCESS_ANY_OWNER 0x00000004 111 112 /* Other constants */ 113 #define TEE_STORAGE_PRIVATE 0x00000001 114 115 #define TEE_DATA_FLAG_ACCESS_READ 0x00000001 116 #define TEE_DATA_FLAG_ACCESS_WRITE 0x00000002 117 #define TEE_DATA_FLAG_ACCESS_WRITE_META 0x00000004 118 #define TEE_DATA_FLAG_SHARE_READ 0x00000010 119 #define TEE_DATA_FLAG_SHARE_WRITE 0x00000020 120 #define TEE_DATA_FLAG_EXCLUSIVE 0x00000400 121 #define TEE_DATA_MAX_POSITION 0xFFFFFFFF 122 #define TEE_OBJECT_ID_MAX_LEN 64 123 #define TEE_USAGE_EXTRACTABLE 0x00000001 124 #define TEE_USAGE_ENCRYPT 0x00000002 125 #define TEE_USAGE_DECRYPT 0x00000004 126 #define TEE_USAGE_MAC 0x00000008 127 #define TEE_USAGE_SIGN 0x00000010 128 #define TEE_USAGE_VERIFY 0x00000020 129 #define TEE_USAGE_DERIVE 0x00000040 130 #define TEE_HANDLE_FLAG_PERSISTENT 0x00010000 131 #define TEE_HANDLE_FLAG_INITIALIZED 0x00020000 132 #define TEE_HANDLE_FLAG_KEY_SET 0x00040000 133 #define TEE_HANDLE_FLAG_EXPECT_TWO_KEYS 0x00080000 134 #define TEE_OPERATION_CIPHER 1 135 #define TEE_OPERATION_MAC 3 136 #define TEE_OPERATION_AE 4 137 #define TEE_OPERATION_DIGEST 5 138 #define TEE_OPERATION_ASYMMETRIC_CIPHER 6 139 #define TEE_OPERATION_ASYMMETRIC_SIGNATURE 7 140 #define TEE_OPERATION_KEY_DERIVATION 8 141 #define TEE_OPERATION_STATE_INITIAL 0x00000000 142 #define TEE_OPERATION_STATE_ACTIVE 0x00000001 143 144 /* Algorithm Identifiers */ 145 #define TEE_ALG_AES_ECB_NOPAD 0x10000010 146 #define TEE_ALG_AES_CBC_NOPAD 0x10000110 147 #define TEE_ALG_AES_CTR 0x10000210 148 #define TEE_ALG_AES_CTS 0x10000310 149 #define TEE_ALG_AES_XTS 0x10000410 150 #define TEE_ALG_AES_CBC_MAC_NOPAD 0x30000110 151 #define TEE_ALG_AES_CBC_MAC_PKCS5 0x30000510 152 #define TEE_ALG_AES_CMAC 0x30000610 153 #define TEE_ALG_AES_CCM 0x40000710 154 #define TEE_ALG_AES_GCM 0x40000810 155 #define TEE_ALG_DES_ECB_NOPAD 0x10000011 156 #define TEE_ALG_DES_CBC_NOPAD 0x10000111 157 #define TEE_ALG_DES_CBC_MAC_NOPAD 0x30000111 158 #define TEE_ALG_DES_CBC_MAC_PKCS5 0x30000511 159 #define TEE_ALG_DES3_ECB_NOPAD 0x10000013 160 #define TEE_ALG_DES3_CBC_NOPAD 0x10000113 161 #define TEE_ALG_DES3_CBC_MAC_NOPAD 0x30000113 162 #define TEE_ALG_DES3_CBC_MAC_PKCS5 0x30000513 163 #define TEE_ALG_RSASSA_PKCS1_V1_5_MD5 0x70001830 164 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA1 0x70002830 165 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA224 0x70003830 166 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA256 0x70004830 167 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA384 0x70005830 168 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA512 0x70006830 169 #define TEE_ALG_RSASSA_PKCS1_V1_5_MD5SHA1 0x7000F830 170 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA1 0x70212930 171 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA224 0x70313930 172 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA256 0x70414930 173 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA384 0x70515930 174 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA512 0x70616930 175 #define TEE_ALG_RSAES_PKCS1_V1_5 0x60000130 176 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA1 0x60210230 177 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA224 0x60310230 178 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA256 0x60410230 179 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA384 0x60510230 180 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA512 0x60610230 181 #define TEE_ALG_RSA_NOPAD 0x60000030 182 #define TEE_ALG_DSA_SHA1 0x70002131 183 #define TEE_ALG_DSA_SHA224 0x70003131 184 #define TEE_ALG_DSA_SHA256 0x70004131 185 #define TEE_ALG_DH_DERIVE_SHARED_SECRET 0x80000032 186 #define TEE_ALG_MD5 0x50000001 187 #define TEE_ALG_SHA1 0x50000002 188 #define TEE_ALG_SHA224 0x50000003 189 #define TEE_ALG_SHA256 0x50000004 190 #define TEE_ALG_SHA384 0x50000005 191 #define TEE_ALG_SHA512 0x50000006 192 #define TEE_ALG_MD5SHA1 0x5000000F 193 #define TEE_ALG_HMAC_MD5 0x30000001 194 #define TEE_ALG_HMAC_SHA1 0x30000002 195 #define TEE_ALG_HMAC_SHA224 0x30000003 196 #define TEE_ALG_HMAC_SHA256 0x30000004 197 #define TEE_ALG_HMAC_SHA384 0x30000005 198 #define TEE_ALG_HMAC_SHA512 0x30000006 199 #define TEE_ALG_ECDSA_P192 0x70001042 200 #define TEE_ALG_ECDSA_P224 0x70002042 201 #define TEE_ALG_ECDSA_P256 0x70003042 202 #define TEE_ALG_ECDSA_P384 0x70004042 203 #define TEE_ALG_ECDSA_P521 0x70005042 204 #define TEE_ALG_ECDH_P192 0x80001042 205 #define TEE_ALG_ECDH_P224 0x80002042 206 #define TEE_ALG_ECDH_P256 0x80003042 207 #define TEE_ALG_ECDH_P384 0x80004042 208 #define TEE_ALG_ECDH_P521 0x80005042 209 210 /* Object Types */ 211 212 #define TEE_TYPE_AES 0xA0000010 213 #define TEE_TYPE_DES 0xA0000011 214 #define TEE_TYPE_DES3 0xA0000013 215 #define TEE_TYPE_HMAC_MD5 0xA0000001 216 #define TEE_TYPE_HMAC_SHA1 0xA0000002 217 #define TEE_TYPE_HMAC_SHA224 0xA0000003 218 #define TEE_TYPE_HMAC_SHA256 0xA0000004 219 #define TEE_TYPE_HMAC_SHA384 0xA0000005 220 #define TEE_TYPE_HMAC_SHA512 0xA0000006 221 #define TEE_TYPE_RSA_PUBLIC_KEY 0xA0000030 222 #define TEE_TYPE_RSA_KEYPAIR 0xA1000030 223 #define TEE_TYPE_DSA_PUBLIC_KEY 0xA0000031 224 #define TEE_TYPE_DSA_KEYPAIR 0xA1000031 225 #define TEE_TYPE_DH_KEYPAIR 0xA1000032 226 #define TEE_TYPE_ECDSA_PUBLIC_KEY 0xA0000041 227 #define TEE_TYPE_ECDSA_KEYPAIR 0xA1000041 228 #define TEE_TYPE_ECDH_PUBLIC_KEY 0xA0000042 229 #define TEE_TYPE_ECDH_KEYPAIR 0xA1000042 230 #define TEE_TYPE_GENERIC_SECRET 0xA0000000 231 #define TEE_TYPE_CORRUPTED_OBJECT 0xA00000BE 232 #define TEE_TYPE_DATA 0xA00000BF 233 234 /* List of Object or Operation Attributes */ 235 236 #define TEE_ATTR_SECRET_VALUE 0xC0000000 237 #define TEE_ATTR_RSA_MODULUS 0xD0000130 238 #define TEE_ATTR_RSA_PUBLIC_EXPONENT 0xD0000230 239 #define TEE_ATTR_RSA_PRIVATE_EXPONENT 0xC0000330 240 #define TEE_ATTR_RSA_PRIME1 0xC0000430 241 #define TEE_ATTR_RSA_PRIME2 0xC0000530 242 #define TEE_ATTR_RSA_EXPONENT1 0xC0000630 243 #define TEE_ATTR_RSA_EXPONENT2 0xC0000730 244 #define TEE_ATTR_RSA_COEFFICIENT 0xC0000830 245 #define TEE_ATTR_DSA_PRIME 0xD0001031 246 #define TEE_ATTR_DSA_SUBPRIME 0xD0001131 247 #define TEE_ATTR_DSA_BASE 0xD0001231 248 #define TEE_ATTR_DSA_PUBLIC_VALUE 0xD0000131 249 #define TEE_ATTR_DSA_PRIVATE_VALUE 0xC0000231 250 #define TEE_ATTR_DH_PRIME 0xD0001032 251 #define TEE_ATTR_DH_SUBPRIME 0xD0001132 252 #define TEE_ATTR_DH_BASE 0xD0001232 253 #define TEE_ATTR_DH_X_BITS 0xF0001332 254 #define TEE_ATTR_DH_PUBLIC_VALUE 0xD0000132 255 #define TEE_ATTR_DH_PRIVATE_VALUE 0xC0000232 256 #define TEE_ATTR_RSA_OAEP_LABEL 0xD0000930 257 #define TEE_ATTR_RSA_PSS_SALT_LENGTH 0xF0000A30 258 #define TEE_ATTR_ECC_PUBLIC_VALUE_X 0xD0000141 259 #define TEE_ATTR_ECC_PUBLIC_VALUE_Y 0xD0000241 260 #define TEE_ATTR_ECC_PRIVATE_VALUE 0xC0000341 261 #define TEE_ATTR_ECC_CURVE 0xF0000441 262 263 #define TEE_ATTR_BIT_PROTECTED (1 << 28) 264 #define TEE_ATTR_BIT_VALUE (1 << 29) 265 266 /* 267 * The macro TEE_PARAM_TYPES can be used to construct a value that you can 268 * compare against an incoming paramTypes to check the type of all the 269 * parameters in one comparison, like in the following example: 270 * if (paramTypes != TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_INPUT, 271 * TEE_PARAM_TYPE_MEMREF_OUPUT, 272 * TEE_PARAM_TYPE_NONE, TEE_PARAM_TYPE_NONE)) { 273 * return TEE_ERROR_BAD_PARAMETERS; 274 * } 275 */ 276 #define TEE_PARAM_TYPES(t0,t1,t2,t3) \ 277 ((t0) | ((t1) << 4) | ((t2) << 8) | ((t3) << 12)) 278 279 /* 280 * The macro TEE_PARAM_TYPE_GET can be used to extract the type of a given 281 * parameter from paramTypes if you need more fine-grained type checking. 282 */ 283 #define TEE_PARAM_TYPE_GET(t, i) ((((uint32_t)t) >> ((i)*4)) & 0xF) 284 285 /* 286 * The macro TEE_PARAM_TYPE_SET can be used to load the type of a given 287 * parameter from paramTypes without specifying all types (TEE_PARAM_TYPES) 288 */ 289 #define TEE_PARAM_TYPE_SET(t, i) (((uint32_t)(t) & 0xF) << ((i)*4)) 290 291 /* Not specified in the standard */ 292 #define TEE_NUM_PARAMS 4 293 294 /* TEE Arithmetical APIs */ 295 296 #define TEE_BigIntSizeInU32(n) ((((n)+31)/32)+2) 297 298 #endif /* TEE_API_DEFINES_H */ 299