xref: /optee_os/lib/libutee/include/utee_syscalls.h (revision bc420748bfc44a9e09000a3966fc59e9e0219df4)
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 #ifndef UTEE_SYSCALLS_H
28 #define UTEE_SYSCALLS_H
29 
30 #include <compiler.h>
31 #include <stddef.h>
32 #include <stdint.h>
33 
34 #include <utee_types.h>
35 #include <tee_api_types.h>
36 #include <trace.h>
37 
38 void utee_return(uint32_t ret) __noreturn;
39 
40 void utee_log(const void *buf, size_t len);
41 
42 void utee_panic(uint32_t code) __noreturn;
43 
44 uint32_t utee_dummy(uint32_t *a);
45 
46 uint32_t utee_dummy_7args(uint32_t a1, uint32_t a2, uint32_t a3, uint32_t a4,
47 			  uint32_t a5, uint32_t a6, uint32_t a7);
48 
49 uint32_t utee_nocall(void);
50 
51 TEE_Result utee_get_property(enum utee_property prop, void *buf, uint32_t len);
52 
53 TEE_Result utee_open_ta_session(const TEE_UUID *dest,
54 				uint32_t cancel_req_to, uint32_t param_types,
55 				TEE_Param params[4], TEE_TASessionHandle *sess,
56 				uint32_t *ret_orig);
57 
58 TEE_Result utee_close_ta_session(TEE_TASessionHandle sess);
59 
60 TEE_Result utee_invoke_ta_command(TEE_TASessionHandle sess,
61 				  uint32_t cancel_req_to, uint32_t cmd_id,
62 				  uint32_t param_types, TEE_Param params[4],
63 				  uint32_t *ret_orig);
64 
65 TEE_Result utee_check_access_rights(uint32_t flags, const void *buf,
66 				    size_t len);
67 
68 TEE_Result utee_get_cancellation_flag(bool *cancel);
69 
70 TEE_Result utee_unmask_cancellation(bool *old_mask);
71 
72 TEE_Result utee_mask_cancellation(bool *old_mask);
73 
74 TEE_Result utee_wait(uint32_t timeout);
75 
76 TEE_Result utee_get_time(enum utee_time_category cat, TEE_Time *time);
77 
78 TEE_Result utee_set_ta_time(const TEE_Time *time);
79 
80 TEE_Result utee_cryp_state_alloc(uint32_t algo, uint32_t op_mode,
81 				 uint32_t key1, uint32_t key2,
82 				 uint32_t *state);
83 TEE_Result utee_cryp_state_copy(uint32_t dst, uint32_t src);
84 TEE_Result utee_cryp_state_free(uint32_t state);
85 
86 /* iv and iv_len are ignored for some algorithms */
87 TEE_Result utee_hash_init(uint32_t state, const void *iv, size_t iv_len);
88 TEE_Result utee_hash_update(uint32_t state, const void *chunk,
89 			    size_t chunk_size);
90 TEE_Result utee_hash_final(uint32_t state, const void *chunk,
91 			   size_t chunk_size, void *hash, uint32_t *hash_len);
92 
93 TEE_Result utee_cipher_init(uint32_t state, const void *iv, size_t iv_len);
94 TEE_Result utee_cipher_update(uint32_t state, const void *src, size_t src_len,
95 			      void *dest, uint32_t *dest_len);
96 TEE_Result utee_cipher_final(uint32_t state, const void *src, size_t src_len,
97 			     void *dest, uint32_t *dest_len);
98 
99 /* Generic Object Functions */
100 TEE_Result utee_cryp_obj_get_info(uint32_t obj, TEE_ObjectInfo *info);
101 TEE_Result utee_cryp_obj_restrict_usage(uint32_t obj, uint32_t usage);
102 TEE_Result utee_cryp_obj_get_attr(uint32_t obj, uint32_t attr_id,
103 				  void *buffer, uint32_t *size);
104 
105 /* Transient Object Functions */
106 TEE_Result utee_cryp_obj_alloc(TEE_ObjectType type, uint32_t max_size,
107 			       uint32_t *obj);
108 TEE_Result utee_cryp_obj_close(uint32_t obj);
109 TEE_Result utee_cryp_obj_reset(uint32_t obj);
110 TEE_Result utee_cryp_obj_populate(uint32_t obj, TEE_Attribute *attrs,
111 				  uint32_t attr_count);
112 TEE_Result utee_cryp_obj_copy(uint32_t dst_obj, uint32_t src_obj);
113 
114 TEE_Result utee_cryp_obj_generate_key(uint32_t obj, uint32_t key_size,
115 				      const TEE_Attribute *params,
116 				      uint32_t param_count);
117 
118 TEE_Result utee_cryp_derive_key(uint32_t state, const TEE_Attribute *params,
119 				uint32_t param_count, uint32_t derived_key);
120 
121 TEE_Result utee_cryp_random_number_generate(void *buf, size_t blen);
122 
123 TEE_Result utee_authenc_init(uint32_t state, const void *nonce,
124 			     size_t nonce_len, size_t tag_len, size_t aad_len,
125 			     size_t payload_len);
126 TEE_Result utee_authenc_update_aad(uint32_t state, const void *aad_data,
127 				   size_t aad_data_len);
128 TEE_Result utee_authenc_update_payload(uint32_t state, const void *src_data,
129 				       size_t src_len, void *dest_data,
130 				       uint32_t *dest_len);
131 TEE_Result utee_authenc_enc_final(uint32_t state, const void *src_data,
132 				  size_t src_len, void *dest_data,
133 				  uint32_t *dest_len, void *tag,
134 				  uint32_t *tag_len);
135 TEE_Result utee_authenc_dec_final(uint32_t state, const void *src_data,
136 				  size_t src_len, void *dest_data,
137 				  uint32_t *dest_len, const void *tag,
138 				  size_t tag_len);
139 
140 TEE_Result utee_asymm_operate(uint32_t state, const TEE_Attribute *params,
141 			      uint32_t num_params, const void *src_data,
142 			      size_t src_len, void *dest_data,
143 			      uint32_t *dest_len);
144 
145 TEE_Result utee_asymm_verify(uint32_t state,
146 			     const TEE_Attribute *params, uint32_t num_params,
147 			     const void *data, size_t data_len, const void *sig,
148 			     size_t sig_len);
149 
150 /* Persistant Object Functions */
151 TEE_Result utee_storage_obj_open(uint32_t storage_id, void *object_id,
152 				 uint32_t object_id_len, uint32_t flags,
153 				 TEE_ObjectHandle *obj);
154 
155 TEE_Result utee_storage_obj_create(uint32_t storage_id, void *object_id,
156 				   uint32_t object_id_len, uint32_t flags,
157 				   TEE_ObjectHandle attr, const void *data,
158 				   uint32_t len, TEE_ObjectHandle *obj);
159 
160 TEE_Result utee_storage_obj_del(TEE_ObjectHandle obj);
161 
162 TEE_Result utee_storage_obj_rename(TEE_ObjectHandle obj, const void *new_obj_id,
163 				   size_t new_obj_id_len);
164 
165 /* Persistent Object Enumeration Functions */
166 TEE_Result utee_storage_alloc_enum(TEE_ObjectEnumHandle *obj_enum);
167 
168 TEE_Result utee_storage_free_enum(TEE_ObjectEnumHandle obj_enum);
169 
170 TEE_Result utee_storage_reset_enum(TEE_ObjectEnumHandle obj_enum);
171 
172 TEE_Result utee_storage_start_enum(TEE_ObjectEnumHandle obj_enum,
173 				   uint32_t storage_id);
174 
175 TEE_Result utee_storage_next_enum(TEE_ObjectEnumHandle obj_enum,
176 				  TEE_ObjectInfo *info, void *obj_id,
177 				  uint32_t *len);
178 
179 /* Data Stream Access Functions */
180 TEE_Result utee_storage_obj_read(TEE_ObjectHandle obj, void *data, size_t len,
181 				 uint32_t *count);
182 
183 TEE_Result utee_storage_obj_write(TEE_ObjectHandle obj, const void *data,
184 				  size_t len);
185 
186 TEE_Result utee_storage_obj_trunc(TEE_ObjectHandle obj, size_t len);
187 
188 TEE_Result utee_storage_obj_seek(TEE_ObjectHandle obj, int32_t offset,
189 				 TEE_Whence whence);
190 
191 TEE_Result utee_se_service_open(
192 		TEE_SEServiceHandle *seServiceHandle);
193 
194 TEE_Result utee_se_service_close(
195 		TEE_SEServiceHandle seServiceHandle);
196 
197 TEE_Result utee_se_service_get_readers(
198 		TEE_SEServiceHandle seServiceHandle,
199 		TEE_SEReaderHandle *r, size_t *len);
200 
201 TEE_Result utee_se_reader_get_prop(TEE_SEReaderHandle r,
202 				TEE_SEReaderProperties *p);
203 
204 TEE_Result utee_se_reader_get_name(TEE_SEReaderHandle r,
205 		char *name, size_t *name_len);
206 
207 TEE_Result utee_se_reader_open_session(TEE_SEReaderHandle r,
208 		TEE_SESessionHandle *s);
209 
210 TEE_Result utee_se_reader_close_sessions(TEE_SEReaderHandle r);
211 
212 TEE_Result utee_se_session_is_closed(TEE_SESessionHandle s);
213 
214 TEE_Result utee_se_session_get_atr(TEE_SESessionHandle s,
215 		void *atr, size_t *atr_len);
216 
217 TEE_Result utee_se_session_open_channel(TEE_SESessionHandle s,
218 		bool is_logical, TEE_SEAID *aid, TEE_SEChannelHandle *c);
219 
220 TEE_Result utee_se_session_close(TEE_SESessionHandle s);
221 
222 TEE_Result utee_se_channel_select_next(TEE_SEChannelHandle c);
223 
224 TEE_Result utee_se_channel_get_select_resp(TEE_SEChannelHandle c,
225 	void *resp, size_t *resp_len);
226 
227 TEE_Result utee_se_channel_transmit(TEE_SEChannelHandle c,
228 	void *cmd, size_t cmd_len, void *resp, size_t *resp_len);
229 
230 TEE_Result utee_se_channel_close(TEE_SEChannelHandle c);
231 
232 TEE_Result utee_cache_operation(void *va, size_t l,
233 				enum utee_cache_operation op);
234 
235 #endif /* UTEE_SYSCALLS_H */
236