xref: /optee_os/lib/libutee/include/tee_api_defines.h (revision ede83d725fba6fdace1e96287391818f315dece2)
11bb92983SJerome Forissier /* SPDX-License-Identifier: BSD-2-Clause */
2b0104773SPascal Brand /*
3b0104773SPascal Brand  * Copyright (c) 2014, STMicroelectronics International N.V.
4b0104773SPascal Brand  */
5b0104773SPascal Brand 
679a3c601SCedric Chaumont /* Based on GP TEE Internal Core API Specification Version 1.1 */
779a3c601SCedric Chaumont 
8b0104773SPascal Brand #ifndef TEE_API_DEFINES_H
9b0104773SPascal Brand #define TEE_API_DEFINES_H
10b0104773SPascal Brand 
1179a3c601SCedric Chaumont #define TEE_INT_CORE_API_SPEC_VERSION     0x0000000A
1279a3c601SCedric Chaumont 
13b0104773SPascal Brand #define TEE_HANDLE_NULL                   0
14b0104773SPascal Brand 
15b0104773SPascal Brand #define TEE_TIMEOUT_INFINITE              0xFFFFFFFF
16b0104773SPascal Brand 
17b0104773SPascal Brand /* API Error Codes */
18b0104773SPascal Brand #define TEE_SUCCESS                       0x00000000
1979a3c601SCedric Chaumont #define TEE_ERROR_CORRUPT_OBJECT          0xF0100001
2079a3c601SCedric Chaumont #define TEE_ERROR_CORRUPT_OBJECT_2        0xF0100002
2179a3c601SCedric Chaumont #define TEE_ERROR_STORAGE_NOT_AVAILABLE   0xF0100003
2279a3c601SCedric Chaumont #define TEE_ERROR_STORAGE_NOT_AVAILABLE_2 0xF0100004
2391fc6bd8SJerome Forissier #define TEE_ERROR_CIPHERTEXT_INVALID      0xF0100006
24b0104773SPascal Brand #define TEE_ERROR_GENERIC                 0xFFFF0000
25b0104773SPascal Brand #define TEE_ERROR_ACCESS_DENIED           0xFFFF0001
26b0104773SPascal Brand #define TEE_ERROR_CANCEL                  0xFFFF0002
27b0104773SPascal Brand #define TEE_ERROR_ACCESS_CONFLICT         0xFFFF0003
28b0104773SPascal Brand #define TEE_ERROR_EXCESS_DATA             0xFFFF0004
29b0104773SPascal Brand #define TEE_ERROR_BAD_FORMAT              0xFFFF0005
30b0104773SPascal Brand #define TEE_ERROR_BAD_PARAMETERS          0xFFFF0006
31b0104773SPascal Brand #define TEE_ERROR_BAD_STATE               0xFFFF0007
32b0104773SPascal Brand #define TEE_ERROR_ITEM_NOT_FOUND          0xFFFF0008
33b0104773SPascal Brand #define TEE_ERROR_NOT_IMPLEMENTED         0xFFFF0009
34b0104773SPascal Brand #define TEE_ERROR_NOT_SUPPORTED           0xFFFF000A
35b0104773SPascal Brand #define TEE_ERROR_NO_DATA                 0xFFFF000B
36b0104773SPascal Brand #define TEE_ERROR_OUT_OF_MEMORY           0xFFFF000C
37b0104773SPascal Brand #define TEE_ERROR_BUSY                    0xFFFF000D
38b0104773SPascal Brand #define TEE_ERROR_COMMUNICATION           0xFFFF000E
39b0104773SPascal Brand #define TEE_ERROR_SECURITY                0xFFFF000F
40b0104773SPascal Brand #define TEE_ERROR_SHORT_BUFFER            0xFFFF0010
4179a3c601SCedric Chaumont #define TEE_ERROR_EXTERNAL_CANCEL         0xFFFF0011
42b0104773SPascal Brand #define TEE_ERROR_OVERFLOW                0xFFFF300F
43b0104773SPascal Brand #define TEE_ERROR_TARGET_DEAD             0xFFFF3024
44b0104773SPascal Brand #define TEE_ERROR_STORAGE_NO_SPACE        0xFFFF3041
45b0104773SPascal Brand #define TEE_ERROR_MAC_INVALID             0xFFFF3071
46b0104773SPascal Brand #define TEE_ERROR_SIGNATURE_INVALID       0xFFFF3072
47b0104773SPascal Brand #define TEE_ERROR_TIME_NOT_SET            0xFFFF5000
48b0104773SPascal Brand #define TEE_ERROR_TIME_NEEDS_RESET        0xFFFF5001
49b0104773SPascal Brand 
50b0104773SPascal Brand /* Parameter Type Constants */
51b0104773SPascal Brand #define TEE_PARAM_TYPE_NONE             0
52b0104773SPascal Brand #define TEE_PARAM_TYPE_VALUE_INPUT      1
53b0104773SPascal Brand #define TEE_PARAM_TYPE_VALUE_OUTPUT     2
54b0104773SPascal Brand #define TEE_PARAM_TYPE_VALUE_INOUT      3
55b0104773SPascal Brand #define TEE_PARAM_TYPE_MEMREF_INPUT     5
56b0104773SPascal Brand #define TEE_PARAM_TYPE_MEMREF_OUTPUT    6
57b0104773SPascal Brand #define TEE_PARAM_TYPE_MEMREF_INOUT     7
58b0104773SPascal Brand 
59b0104773SPascal Brand /* Login Type Constants */
60b0104773SPascal Brand #define TEE_LOGIN_PUBLIC                0x00000000
61b0104773SPascal Brand #define TEE_LOGIN_USER                  0x00000001
62b0104773SPascal Brand #define TEE_LOGIN_GROUP                 0x00000002
63b0104773SPascal Brand #define TEE_LOGIN_APPLICATION           0x00000004
64b0104773SPascal Brand #define TEE_LOGIN_APPLICATION_USER      0x00000005
65b0104773SPascal Brand #define TEE_LOGIN_APPLICATION_GROUP     0x00000006
66b0104773SPascal Brand #define TEE_LOGIN_TRUSTED_APP           0xF0000000
67b0104773SPascal Brand 
68b0104773SPascal Brand /* Origin Code Constants */
69b0104773SPascal Brand #define TEE_ORIGIN_API                  0x00000001
70b0104773SPascal Brand #define TEE_ORIGIN_COMMS                0x00000002
71b0104773SPascal Brand #define TEE_ORIGIN_TEE                  0x00000003
72b0104773SPascal Brand #define TEE_ORIGIN_TRUSTED_APP          0x00000004
73b0104773SPascal Brand 
74b0104773SPascal Brand /* Property Sets pseudo handles */
75b0104773SPascal Brand #define TEE_PROPSET_TEE_IMPLEMENTATION  (TEE_PropSetHandle)0xFFFFFFFD
7679a3c601SCedric Chaumont #define TEE_PROPSET_CURRENT_CLIENT      (TEE_PropSetHandle)0xFFFFFFFE
7779a3c601SCedric Chaumont #define TEE_PROPSET_CURRENT_TA          (TEE_PropSetHandle)0xFFFFFFFF
78b0104773SPascal Brand 
79b0104773SPascal Brand /* Memory Access Rights Constants */
80b0104773SPascal Brand #define TEE_MEMORY_ACCESS_READ             0x00000001
81b0104773SPascal Brand #define TEE_MEMORY_ACCESS_WRITE            0x00000002
82b0104773SPascal Brand #define TEE_MEMORY_ACCESS_ANY_OWNER        0x00000004
83b0104773SPascal Brand 
8445d7fb1cSCedric Chaumont /* Memory Management Constant */
8545d7fb1cSCedric Chaumont #define TEE_MALLOC_FILL_ZERO               0x00000000
8645d7fb1cSCedric Chaumont 
87b0104773SPascal Brand /* Other constants */
88b0104773SPascal Brand #define TEE_STORAGE_PRIVATE                0x00000001
8979a3c601SCedric Chaumont 
90b0104773SPascal Brand #define TEE_DATA_FLAG_ACCESS_READ          0x00000001
91b0104773SPascal Brand #define TEE_DATA_FLAG_ACCESS_WRITE         0x00000002
92b0104773SPascal Brand #define TEE_DATA_FLAG_ACCESS_WRITE_META    0x00000004
93b0104773SPascal Brand #define TEE_DATA_FLAG_SHARE_READ           0x00000010
94b0104773SPascal Brand #define TEE_DATA_FLAG_SHARE_WRITE          0x00000020
9584431ae3SCedric Chaumont #define TEE_DATA_FLAG_OVERWRITE            0x00000400
96b0104773SPascal Brand #define TEE_DATA_MAX_POSITION              0xFFFFFFFF
97b0104773SPascal Brand #define TEE_OBJECT_ID_MAX_LEN              64
98b0104773SPascal Brand #define TEE_USAGE_EXTRACTABLE              0x00000001
99b0104773SPascal Brand #define TEE_USAGE_ENCRYPT                  0x00000002
100b0104773SPascal Brand #define TEE_USAGE_DECRYPT                  0x00000004
101b0104773SPascal Brand #define TEE_USAGE_MAC                      0x00000008
102b0104773SPascal Brand #define TEE_USAGE_SIGN                     0x00000010
103b0104773SPascal Brand #define TEE_USAGE_VERIFY                   0x00000020
104b0104773SPascal Brand #define TEE_USAGE_DERIVE                   0x00000040
105b0104773SPascal Brand #define TEE_HANDLE_FLAG_PERSISTENT         0x00010000
106b0104773SPascal Brand #define TEE_HANDLE_FLAG_INITIALIZED        0x00020000
107b0104773SPascal Brand #define TEE_HANDLE_FLAG_KEY_SET            0x00040000
108b0104773SPascal Brand #define TEE_HANDLE_FLAG_EXPECT_TWO_KEYS    0x00080000
109b0104773SPascal Brand #define TEE_OPERATION_CIPHER               1
110b0104773SPascal Brand #define TEE_OPERATION_MAC                  3
111b0104773SPascal Brand #define TEE_OPERATION_AE                   4
112b0104773SPascal Brand #define TEE_OPERATION_DIGEST               5
113b0104773SPascal Brand #define TEE_OPERATION_ASYMMETRIC_CIPHER    6
114b0104773SPascal Brand #define TEE_OPERATION_ASYMMETRIC_SIGNATURE 7
115b0104773SPascal Brand #define TEE_OPERATION_KEY_DERIVATION       8
11679a3c601SCedric Chaumont #define TEE_OPERATION_STATE_INITIAL        0x00000000
11779a3c601SCedric Chaumont #define TEE_OPERATION_STATE_ACTIVE         0x00000001
118b0104773SPascal Brand 
119b0104773SPascal Brand /* Algorithm Identifiers */
120b0104773SPascal Brand #define TEE_ALG_AES_ECB_NOPAD                   0x10000010
121b0104773SPascal Brand #define TEE_ALG_AES_CBC_NOPAD                   0x10000110
122b0104773SPascal Brand #define TEE_ALG_AES_CTR                         0x10000210
123b0104773SPascal Brand #define TEE_ALG_AES_CTS                         0x10000310
124b0104773SPascal Brand #define TEE_ALG_AES_XTS                         0x10000410
125b0104773SPascal Brand #define TEE_ALG_AES_CBC_MAC_NOPAD               0x30000110
126b0104773SPascal Brand #define TEE_ALG_AES_CBC_MAC_PKCS5               0x30000510
127b0104773SPascal Brand #define TEE_ALG_AES_CMAC                        0x30000610
128b0104773SPascal Brand #define TEE_ALG_AES_CCM                         0x40000710
129b0104773SPascal Brand #define TEE_ALG_AES_GCM                         0x40000810
130b0104773SPascal Brand #define TEE_ALG_DES_ECB_NOPAD                   0x10000011
131b0104773SPascal Brand #define TEE_ALG_DES_CBC_NOPAD                   0x10000111
132b0104773SPascal Brand #define TEE_ALG_DES_CBC_MAC_NOPAD               0x30000111
133b0104773SPascal Brand #define TEE_ALG_DES_CBC_MAC_PKCS5               0x30000511
134b0104773SPascal Brand #define TEE_ALG_DES3_ECB_NOPAD                  0x10000013
135b0104773SPascal Brand #define TEE_ALG_DES3_CBC_NOPAD                  0x10000113
136b0104773SPascal Brand #define TEE_ALG_DES3_CBC_MAC_NOPAD              0x30000113
137b0104773SPascal Brand #define TEE_ALG_DES3_CBC_MAC_PKCS5              0x30000513
138ade6f848SJerome Forissier #define TEE_ALG_SM4_ECB_NOPAD                   0x10000014
139ade6f848SJerome Forissier #define TEE_ALG_SM4_CBC_NOPAD                   0x10000114
140ade6f848SJerome Forissier #define TEE_ALG_SM4_CTR                         0x10000214
141b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_V1_5_MD5           0x70001830
142b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA1          0x70002830
143b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA224        0x70003830
144b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA256        0x70004830
145b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA384        0x70005830
146b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA512        0x70006830
147b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_V1_5_MD5SHA1       0x7000F830
148b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA1      0x70212930
149b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA224    0x70313930
150b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA256    0x70414930
151b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA384    0x70515930
152b0104773SPascal Brand #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA512    0x70616930
153b0104773SPascal Brand #define TEE_ALG_RSAES_PKCS1_V1_5                0x60000130
154b0104773SPascal Brand #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA1      0x60210230
155b0104773SPascal Brand #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA224    0x60310230
156b0104773SPascal Brand #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA256    0x60410230
157b0104773SPascal Brand #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA384    0x60510230
158b0104773SPascal Brand #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA512    0x60610230
159b0104773SPascal Brand #define TEE_ALG_RSA_NOPAD                       0x60000030
160b0104773SPascal Brand #define TEE_ALG_DSA_SHA1                        0x70002131
16179a3c601SCedric Chaumont #define TEE_ALG_DSA_SHA224                      0x70003131
16279a3c601SCedric Chaumont #define TEE_ALG_DSA_SHA256                      0x70004131
1630f151943SJerome Forissier #define TEE_ALG_SM2_DSA_SM3                     0x70006045
164b0104773SPascal Brand #define TEE_ALG_DH_DERIVE_SHARED_SECRET         0x80000032
1655b385b3fSJerome Forissier #define TEE_ALG_SM2_KEP                         0x60000045
166b0104773SPascal Brand #define TEE_ALG_MD5                             0x50000001
167b0104773SPascal Brand #define TEE_ALG_SHA1                            0x50000002
168b0104773SPascal Brand #define TEE_ALG_SHA224                          0x50000003
169b0104773SPascal Brand #define TEE_ALG_SHA256                          0x50000004
170b0104773SPascal Brand #define TEE_ALG_SHA384                          0x50000005
171b0104773SPascal Brand #define TEE_ALG_SHA512                          0x50000006
172b0104773SPascal Brand #define TEE_ALG_MD5SHA1                         0x5000000F
173b0104773SPascal Brand #define TEE_ALG_HMAC_MD5                        0x30000001
174b0104773SPascal Brand #define TEE_ALG_HMAC_SHA1                       0x30000002
175b0104773SPascal Brand #define TEE_ALG_HMAC_SHA224                     0x30000003
176b0104773SPascal Brand #define TEE_ALG_HMAC_SHA256                     0x30000004
177b0104773SPascal Brand #define TEE_ALG_HMAC_SHA384                     0x30000005
178b0104773SPascal Brand #define TEE_ALG_HMAC_SHA512                     0x30000006
17947645577SJerome Forissier #define TEE_ALG_HMAC_SM3                        0x30000007
180c988227aSPascal Brand /*
181c988227aSPascal Brand  * Fix GP Internal Core API v1.1
182c988227aSPascal Brand  *     "Table 6-12:  Structure of Algorithm Identifier"
183c988227aSPascal Brand  *     indicates ECDSA have the algorithm "0x41" and ECDH "0x42"
184c988227aSPascal Brand  * whereas
185c988227aSPascal Brand  *     "Table 6-11:  List of Algorithm Identifiers" defines
186c988227aSPascal Brand  *     TEE_ALG_ECDSA_P192 as 0x70001042
187c988227aSPascal Brand  *
188c988227aSPascal Brand  * We chose to define TEE_ALG_ECDSA_P192 as 0x70001041 (conform to table 6-12)
189c988227aSPascal Brand  */
190c988227aSPascal Brand #define TEE_ALG_ECDSA_P192                      0x70001041
191c988227aSPascal Brand #define TEE_ALG_ECDSA_P224                      0x70002041
192c988227aSPascal Brand #define TEE_ALG_ECDSA_P256                      0x70003041
193c988227aSPascal Brand #define TEE_ALG_ECDSA_P384                      0x70004041
194c988227aSPascal Brand #define TEE_ALG_ECDSA_P521                      0x70005041
19579a3c601SCedric Chaumont #define TEE_ALG_ECDH_P192                       0x80001042
19679a3c601SCedric Chaumont #define TEE_ALG_ECDH_P224                       0x80002042
19779a3c601SCedric Chaumont #define TEE_ALG_ECDH_P256                       0x80003042
19879a3c601SCedric Chaumont #define TEE_ALG_ECDH_P384                       0x80004042
19979a3c601SCedric Chaumont #define TEE_ALG_ECDH_P521                       0x80005042
20091fc6bd8SJerome Forissier #define TEE_ALG_SM2_PKE                         0x80000045
20147645577SJerome Forissier #define TEE_ALG_SM3                             0x50000007
20279170ce0SJerome Forissier #define TEE_ALG_ILLEGAL_VALUE                   0xEFFFFFFF
203b0104773SPascal Brand 
204b0104773SPascal Brand /* Object Types */
205b0104773SPascal Brand 
206b0104773SPascal Brand #define TEE_TYPE_AES                        0xA0000010
207b0104773SPascal Brand #define TEE_TYPE_DES                        0xA0000011
208b0104773SPascal Brand #define TEE_TYPE_DES3                       0xA0000013
209ade6f848SJerome Forissier #define TEE_TYPE_SM4                        0xA0000014
210b0104773SPascal Brand #define TEE_TYPE_HMAC_MD5                   0xA0000001
211b0104773SPascal Brand #define TEE_TYPE_HMAC_SHA1                  0xA0000002
212b0104773SPascal Brand #define TEE_TYPE_HMAC_SHA224                0xA0000003
213b0104773SPascal Brand #define TEE_TYPE_HMAC_SHA256                0xA0000004
214b0104773SPascal Brand #define TEE_TYPE_HMAC_SHA384                0xA0000005
215b0104773SPascal Brand #define TEE_TYPE_HMAC_SHA512                0xA0000006
21647645577SJerome Forissier #define TEE_TYPE_HMAC_SM3                   0xA0000007 /* Not in spec */
217b0104773SPascal Brand #define TEE_TYPE_RSA_PUBLIC_KEY             0xA0000030
218b0104773SPascal Brand #define TEE_TYPE_RSA_KEYPAIR                0xA1000030
219b0104773SPascal Brand #define TEE_TYPE_DSA_PUBLIC_KEY             0xA0000031
220b0104773SPascal Brand #define TEE_TYPE_DSA_KEYPAIR                0xA1000031
221b0104773SPascal Brand #define TEE_TYPE_DH_KEYPAIR                 0xA1000032
22279a3c601SCedric Chaumont #define TEE_TYPE_ECDSA_PUBLIC_KEY           0xA0000041
22379a3c601SCedric Chaumont #define TEE_TYPE_ECDSA_KEYPAIR              0xA1000041
22479a3c601SCedric Chaumont #define TEE_TYPE_ECDH_PUBLIC_KEY            0xA0000042
22579a3c601SCedric Chaumont #define TEE_TYPE_ECDH_KEYPAIR               0xA1000042
2260f151943SJerome Forissier #define TEE_TYPE_SM2_DSA_PUBLIC_KEY         0xA0000045
2270f151943SJerome Forissier #define TEE_TYPE_SM2_DSA_KEYPAIR            0xA1000045
2285b385b3fSJerome Forissier #define TEE_TYPE_SM2_KEP_PUBLIC_KEY         0xA0000046
2295b385b3fSJerome Forissier #define TEE_TYPE_SM2_KEP_KEYPAIR            0xA1000046
23091fc6bd8SJerome Forissier #define TEE_TYPE_SM2_PKE_PUBLIC_KEY         0xA0000047
23191fc6bd8SJerome Forissier #define TEE_TYPE_SM2_PKE_KEYPAIR            0xA1000047
232b0104773SPascal Brand #define TEE_TYPE_GENERIC_SECRET             0xA0000000
23379a3c601SCedric Chaumont #define TEE_TYPE_CORRUPTED_OBJECT           0xA00000BE
23479a3c601SCedric Chaumont #define TEE_TYPE_DATA                       0xA00000BF
235b0104773SPascal Brand 
236b0104773SPascal Brand /* List of Object or Operation Attributes */
237b0104773SPascal Brand 
238b0104773SPascal Brand #define TEE_ATTR_SECRET_VALUE               0xC0000000
239b0104773SPascal Brand #define TEE_ATTR_RSA_MODULUS                0xD0000130
240b0104773SPascal Brand #define TEE_ATTR_RSA_PUBLIC_EXPONENT        0xD0000230
241b0104773SPascal Brand #define TEE_ATTR_RSA_PRIVATE_EXPONENT       0xC0000330
242b0104773SPascal Brand #define TEE_ATTR_RSA_PRIME1                 0xC0000430
243b0104773SPascal Brand #define TEE_ATTR_RSA_PRIME2                 0xC0000530
244b0104773SPascal Brand #define TEE_ATTR_RSA_EXPONENT1              0xC0000630
245b0104773SPascal Brand #define TEE_ATTR_RSA_EXPONENT2              0xC0000730
246b0104773SPascal Brand #define TEE_ATTR_RSA_COEFFICIENT            0xC0000830
247b0104773SPascal Brand #define TEE_ATTR_DSA_PRIME                  0xD0001031
248b0104773SPascal Brand #define TEE_ATTR_DSA_SUBPRIME               0xD0001131
249b0104773SPascal Brand #define TEE_ATTR_DSA_BASE                   0xD0001231
250b0104773SPascal Brand #define TEE_ATTR_DSA_PUBLIC_VALUE           0xD0000131
251b0104773SPascal Brand #define TEE_ATTR_DSA_PRIVATE_VALUE          0xC0000231
252b0104773SPascal Brand #define TEE_ATTR_DH_PRIME                   0xD0001032
253b0104773SPascal Brand #define TEE_ATTR_DH_SUBPRIME                0xD0001132
254b0104773SPascal Brand #define TEE_ATTR_DH_BASE                    0xD0001232
255b0104773SPascal Brand #define TEE_ATTR_DH_X_BITS                  0xF0001332
256b0104773SPascal Brand #define TEE_ATTR_DH_PUBLIC_VALUE            0xD0000132
257b0104773SPascal Brand #define TEE_ATTR_DH_PRIVATE_VALUE           0xC0000232
258b0104773SPascal Brand #define TEE_ATTR_RSA_OAEP_LABEL             0xD0000930
259b0104773SPascal Brand #define TEE_ATTR_RSA_PSS_SALT_LENGTH        0xF0000A30
26079a3c601SCedric Chaumont #define TEE_ATTR_ECC_PUBLIC_VALUE_X         0xD0000141
26179a3c601SCedric Chaumont #define TEE_ATTR_ECC_PUBLIC_VALUE_Y         0xD0000241
26279a3c601SCedric Chaumont #define TEE_ATTR_ECC_PRIVATE_VALUE          0xC0000341
26379a3c601SCedric Chaumont #define TEE_ATTR_ECC_CURVE                  0xF0000441
2645b385b3fSJerome Forissier #define TEE_ATTR_SM2_ID_INITIATOR           0xD0000446
2655b385b3fSJerome Forissier #define TEE_ATTR_SM2_ID_RESPONDER           0xD0000546
2665b385b3fSJerome Forissier #define TEE_ATTR_SM2_KEP_USER               0xF0000646
2675b385b3fSJerome Forissier #define TEE_ATTR_SM2_KEP_CONFIRMATION_IN    0xD0000746
2685b385b3fSJerome Forissier #define TEE_ATTR_SM2_KEP_CONFIRMATION_OUT   0xD0000846
2695b385b3fSJerome Forissier #define TEE_ATTR_ECC_EPHEMERAL_PUBLIC_VALUE_X 0xD0000946 /* Missing in 1.2.1 */
2705b385b3fSJerome Forissier #define TEE_ATTR_ECC_EPHEMERAL_PUBLIC_VALUE_Y 0xD0000A46 /* Missing in 1.2.1 */
271b0104773SPascal Brand 
272b9416909SJens Wiklander #define TEE_ATTR_FLAG_PUBLIC		(1 << 28)
273b9416909SJens Wiklander #define TEE_ATTR_FLAG_VALUE		(1 << 29)
274b9416909SJens Wiklander /*
275b9416909SJens Wiklander  * Deprecated, but kept for backwards compatibility
276b9416909SJens Wiklander  *
277b9416909SJens Wiklander  * Be careful with GPD TEE Internal API specification v1.0 where table 6-12
278b9416909SJens Wiklander  * defines BIT [28] with the right meaning whereas sections 5.4.3 and 5.4.4
279b9416909SJens Wiklander  * falsely describe a reversed bit flag value meaning.
280b9416909SJens Wiklander  */
281b9416909SJens Wiklander #define TEE_ATTR_BIT_PROTECTED		TEE_ATTR_FLAG_PUBLIC
282b9416909SJens Wiklander #define TEE_ATTR_BIT_VALUE		TEE_ATTR_FLAG_VALUE
2837583c59eSCedric Chaumont 
284316a94e7SPascal Brand /* List of Supported ECC Curves */
28579170ce0SJerome Forissier #define TEE_CRYPTO_ELEMENT_NONE             0x00000000
286316a94e7SPascal Brand #define TEE_ECC_CURVE_NIST_P192             0x00000001
287316a94e7SPascal Brand #define TEE_ECC_CURVE_NIST_P224             0x00000002
288316a94e7SPascal Brand #define TEE_ECC_CURVE_NIST_P256             0x00000003
289316a94e7SPascal Brand #define TEE_ECC_CURVE_NIST_P384             0x00000004
290316a94e7SPascal Brand #define TEE_ECC_CURVE_NIST_P521             0x00000005
291*ede83d72SJerome Forissier #define TEE_ECC_CURVE_SM2                   0x00000400
292316a94e7SPascal Brand 
293316a94e7SPascal Brand 
2947583c59eSCedric Chaumont /* Panicked Functions Identification */
2957583c59eSCedric Chaumont /* TA Interface */
2967583c59eSCedric Chaumont #define TEE_PANIC_ID_TA_CLOSESESSIONENTRYPOINT      0x00000101
2977583c59eSCedric Chaumont #define TEE_PANIC_ID_TA_CREATEENTRYPOINT            0x00000102
2987583c59eSCedric Chaumont #define TEE_PANIC_ID_TA_DESTROYENTRYPOINT           0x00000103
2997583c59eSCedric Chaumont #define TEE_PANIC_ID_TA_INVOKECOMMANDENTRYPOINT     0x00000104
3007583c59eSCedric Chaumont #define TEE_PANIC_ID_TA_OPENSESSIONENTRYPOINT       0x00000105
3017583c59eSCedric Chaumont /* Property Access */
3027583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_ALLOCATEPROPERTYENUMERATOR 0x00000201
3037583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_FREEPROPERTYENUMERATOR     0x00000202
3047583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETNEXTPROPERTY            0x00000203
3057583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETPROPERTYASBINARYBLOCK   0x00000204
3067583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETPROPERTYASBOOL          0x00000205
3077583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETPROPERTYASIDENTITY      0x00000206
3087583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETPROPERTYASSTRING        0x00000207
3097583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETPROPERTYASU32           0x00000208
3107583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETPROPERTYASUUID          0x00000209
3117583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETPROPERTYNAME            0x0000020A
3127583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_RESETPROPERTYENUMERATOR    0x0000020B
3137583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_STARTPROPERTYENUMERATOR    0x0000020C
3147583c59eSCedric Chaumont /* Panic Function */
3157583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_PANIC                      0x00000301
3167583c59eSCedric Chaumont /* Internal Client API */
3177583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_CLOSETASESSION             0x00000401
3187583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_INVOKETACOMMAND            0x00000402
3197583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_OPENTASESSION              0x00000403
3207583c59eSCedric Chaumont /* Cancellation */
3217583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETCANCELLATIONFLAG        0x00000501
3227583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_MASKCANCELLATION           0x00000502
3237583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_UNMASKCANCELLATION         0x00000503
3247583c59eSCedric Chaumont /* Memory Management */
3257583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_CHECKMEMORYACCESSRIGHTS    0x00000601
3267583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_FREE                       0x00000602
3277583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETINSTANCEDATA            0x00000603
3287583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_MALLOC                     0x00000604
3297583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_MEMCOMPARE                 0x00000605
3307583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_MEMFILL                    0x00000606
3317583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_MEMMOVE                    0x00000607
3327583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_REALLOC                    0x00000608
3337583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_SETINSTANCEDATA            0x00000609
3347583c59eSCedric Chaumont /* Generic Object */
3357583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_CLOSEOBJECT                0x00000701
3367583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETOBJECTBUFFERATTRIBUTE   0x00000702
3377583c59eSCedric Chaumont /* deprecated */
3387583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETOBJECTINFO              0x00000703
3397583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETOBJECTVALUEATTRIBUTE    0x00000704
3407583c59eSCedric Chaumont /* deprecated */
3417583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_RESTRICTOBJECTUSAGE        0x00000705
3427583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETOBJECTINFO1             0x00000706
3437583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_RESTRICTOBJECTUSAGE1       0x00000707
3447583c59eSCedric Chaumont /* Transient Object */
3457583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_ALLOCATETRANSIENTOBJECT    0x00000801
3467583c59eSCedric Chaumont /* deprecated */
3477583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_COPYOBJECTATTRIBUTES       0x00000802
3487583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_FREETRANSIENTOBJECT        0x00000803
3497583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GENERATEKEY                0x00000804
3507583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_INITREFATTRIBUTE           0x00000805
3517583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_INITVALUEATTRIBUTE         0x00000806
3527583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_POPULATETRANSIENTOBJECT    0x00000807
3537583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_RESETTRANSIENTOBJECT       0x00000808
3547583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_COPYOBJECTATTRIBUTES1      0x00000809
3557583c59eSCedric Chaumont /* Persistent Object */
3567583c59eSCedric Chaumont /* deprecated */
3577583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_CLOSEANDDELETEPERSISTENTOBJECT  0x00000901
3587583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_CREATEPERSISTENTOBJECT          0x00000902
3597583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_OPENPERSISTENTOBJECT            0x00000903
3607583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_RENAMEPERSISTENTOBJECT          0x00000904
3617583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_CLOSEANDDELETEPERSISTENTOBJECT1 0x00000905
3627583c59eSCedric Chaumont /* Persistent Object Enumeration */
3637583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_ALLOCATEPERSISTENTOBJECTENUMERATOR 0x00000A01
3647583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_FREEPERSISTENTOBJECTENUMERATOR     0x00000A02
3657583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETNEXTPERSISTENTOBJECT            0x00000A03
3667583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_RESETPERSISTENTOBJECTENUMERATOR    0x00000A04
3677583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_STARTPERSISTENTOBJECTENUMERATOR    0x00000A05
3687583c59eSCedric Chaumont /* Data Stream Access */
3697583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_READOBJECTDATA             0x00000B01
3707583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_SEEKOBJECTDATA             0x00000B02
3717583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_TRUNCATEOBJECTDATA         0x00000B03
3727583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_WRITEOBJECTDATA            0x00000B04
3737583c59eSCedric Chaumont /* Generic Operation */
3747583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_ALLOCATEOPERATION          0x00000C01
3757583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_COPYOPERATION              0x00000C02
3767583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_FREEOPERATION              0x00000C03
3777583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETOPERATIONINFO           0x00000C04
3787583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_RESETOPERATION             0x00000C05
3797583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_SETOPERATIONKEY            0x00000C06
3807583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_SETOPERATIONKEY2           0x00000C07
3817583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETOPERATIONINFOMULTIPLE   0x00000C08
3827583c59eSCedric Chaumont /* Message Digest */
3837583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_DIGESTDOFINAL              0x00000D01
3847583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_DIGESTUPDATE               0x00000D02
3857583c59eSCedric Chaumont /* Symmetric Cipher */
3867583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_CIPHERDOFINAL              0x00000E01
3877583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_CIPHERINIT                 0x00000E02
3887583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_CIPHERUPDATE               0x00000E03
3897583c59eSCedric Chaumont /* MAC */
3907583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_MACCOMPAREFINAL            0x00000F01
3917583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_MACCOMPUTEFINAL            0x00000F02
3927583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_MACINIT                    0x00000F03
3937583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_MACUPDATE                  0x00000F04
3947583c59eSCedric Chaumont /* Authenticated Encryption */
3957583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_AEDECRYPTFINAL             0x00001001
3967583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_AEENCRYPTFINAL             0x00001002
3977583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_AEINIT                     0x00001003
3987583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_AEUPDATE                   0x00001004
3997583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_AEUPDATEAAD                0x00001005
4007583c59eSCedric Chaumont /* Asymmetric */
4017583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_ASYMMETRICDECRYPT          0x00001101
4027583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_ASYMMETRICENCRYPT          0x00001102
4037583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_ASYMMETRICSIGNDIGEST       0x00001103
4047583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_ASYMMETRICVERIFYDIGEST     0x00001104
4057583c59eSCedric Chaumont /* Key Derivation */
4067583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_DERIVEKEY                  0x00001201
4077583c59eSCedric Chaumont /* Random Data Generation */
4087583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GENERATERANDOM             0x00001301
4097583c59eSCedric Chaumont /* Time */
4107583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETREETIME                 0x00001401
4117583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETSYSTEMTIME              0x00001402
4127583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_GETTAPERSISTENTTIME        0x00001403
4137583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_SETTAPERSISTENTTIME        0x00001404
4147583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_WAIT                       0x00001405
4157583c59eSCedric Chaumont /* Memory Allocation and Size of Objects */
4167583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTFMMCONTEXTSIZEINU32  0x00001501
4177583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTFMMSIZEINU32         0x00001502
4187583c59eSCedric Chaumont /* Initialization */
4197583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTINIT                 0x00001601
4207583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTINITFMM              0x00001602
4217583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTINITFMMCONTEXT       0x00001603
4227583c59eSCedric Chaumont /* Converter */
4237583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCONVERTFROMOCTETSTRING 0x00001701
4247583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCONVERTFROMS32         0x00001702
4257583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCONVERTTOOCTETSTRING   0x00001703
4267583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCONVERTTOS32           0x00001704
4277583c59eSCedric Chaumont /* Logical Operation */
4287583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCMP                  0x00001801
4297583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCMPS32               0x00001802
4307583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTGETBIT               0x00001803
4317583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTGETBITCOUNT          0x00001804
4327583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTSHIFTRIGHT           0x00001805
4337583c59eSCedric Chaumont /* Basic Arithmetic */
4347583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTADD                  0x00001901
4357583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTDIV                  0x00001902
4367583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTMUL                  0x00001903
4377583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTNEG                  0x00001904
4387583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTSQUARE               0x00001905
4397583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTSUB                  0x00001906
4407583c59eSCedric Chaumont /* Modular Arithmetic */
4417583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTADDMOD               0x00001A01
4427583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTINVMOD               0x00001A02
4437583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTMOD                  0x00001A03
4447583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTMULMOD               0x00001A04
4457583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTSQUAREMOD            0x00001A05
4467583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTSUBMOD               0x00001A06
4477583c59eSCedric Chaumont /* Other Arithmetic */
4487583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCOMPUTEEXTENDEDGCD   0x00001B01
4497583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTISPROBABLEPRIME      0x00001B02
4507583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTRELATIVEPRIME        0x00001B03
4517583c59eSCedric Chaumont /* Fast Modular Multiplication */
4527583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCOMPUTEFMM           0x00001C01
4537583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCONVERTFROMFMM       0x00001C02
4547583c59eSCedric Chaumont #define TEE_PANIC_ID_TEE_BIGINTCONVERTTOFMM         0x00001C03
455177603c7SJens Wiklander 
456b0104773SPascal Brand /*
457b0104773SPascal Brand  * The macro TEE_PARAM_TYPES can be used to construct a value that you can
458b0104773SPascal Brand  * compare against an incoming paramTypes to check the type of all the
459b0104773SPascal Brand  * parameters in one comparison, like in the following example:
460b0104773SPascal Brand  * if (paramTypes != TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_INPUT,
461b0104773SPascal Brand  *                                  TEE_PARAM_TYPE_MEMREF_OUPUT,
462b0104773SPascal Brand  *                                  TEE_PARAM_TYPE_NONE, TEE_PARAM_TYPE_NONE)) {
463b0104773SPascal Brand  *      return TEE_ERROR_BAD_PARAMETERS;
464b0104773SPascal Brand  *  }
465b0104773SPascal Brand  */
466b0104773SPascal Brand #define TEE_PARAM_TYPES(t0,t1,t2,t3) \
467b0104773SPascal Brand    ((t0) | ((t1) << 4) | ((t2) << 8) | ((t3) << 12))
468b0104773SPascal Brand 
469b0104773SPascal Brand /*
470b0104773SPascal Brand  * The macro TEE_PARAM_TYPE_GET can be used to extract the type of a given
471b0104773SPascal Brand  * parameter from paramTypes if you need more fine-grained type checking.
472b0104773SPascal Brand  */
473b0104773SPascal Brand #define TEE_PARAM_TYPE_GET(t, i) ((((uint32_t)t) >> ((i)*4)) & 0xF)
474b0104773SPascal Brand 
475b0104773SPascal Brand /*
476b0104773SPascal Brand  * The macro TEE_PARAM_TYPE_SET can be used to load the type of a given
477b0104773SPascal Brand  * parameter from paramTypes without specifying all types (TEE_PARAM_TYPES)
478b0104773SPascal Brand  */
479b0104773SPascal Brand #define TEE_PARAM_TYPE_SET(t, i) (((uint32_t)(t) & 0xF) << ((i)*4))
480b0104773SPascal Brand 
481b0104773SPascal Brand /* Not specified in the standard */
482b0104773SPascal Brand #define TEE_NUM_PARAMS  4
483b0104773SPascal Brand 
484b0104773SPascal Brand /* TEE Arithmetical APIs */
485b0104773SPascal Brand 
486b0104773SPascal Brand #define TEE_BigIntSizeInU32(n) ((((n)+31)/32)+2)
487b0104773SPascal Brand 
488b0104773SPascal Brand #endif /* TEE_API_DEFINES_H */
489