xref: /optee_os/lib/libutee/include/utee_syscalls.h (revision b01047730e77127c23a36591643eeb8bb0487d68)
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 <stddef.h>
31 #include <stdint.h>
32 
33 #include <utee_types.h>
34 #include <tee_api_types.h>
35 #include <tee_trace.h>
36 
37 void utee_return(uint32_t ret) /*__attribute__((noreturn))*/ ;
38 
39 void utee_log(const void *buf, size_t len);
40 
41 void utee_panic(uint32_t code) /*__attribute__((noreturn))*/ ;
42 
43 uint32_t utee_dummy(uint32_t *a);
44 
45 uint32_t utee_dummy_7args(uint32_t a1, uint32_t a2, uint32_t a3, uint32_t a4,
46 			  uint32_t a5, uint32_t a6, uint32_t a7);
47 
48 uint32_t utee_nocall(void);
49 
50 TEE_Result utee_get_property(enum utee_property prop, void *buf, uint32_t len);
51 
52 TEE_Result utee_open_ta_session(const TEE_UUID *dest,
53 				uint32_t cancel_req_to, uint32_t param_types,
54 				TEE_Param params[4], TEE_TASessionHandle *sess,
55 				uint32_t *ret_orig);
56 
57 TEE_Result utee_close_ta_session(TEE_TASessionHandle sess);
58 
59 TEE_Result utee_invoke_ta_command(TEE_TASessionHandle sess,
60 				  uint32_t cancel_req_to, uint32_t cmd_id,
61 				  uint32_t param_types, TEE_Param params[4],
62 				  uint32_t *ret_orig);
63 
64 TEE_Result utee_check_access_rights(uint32_t flags, const void *buf,
65 				    size_t len);
66 
67 TEE_Result utee_get_cancellation_flag(bool *cancel);
68 
69 TEE_Result utee_unmask_cancellation(bool *old_mask);
70 
71 TEE_Result utee_mask_cancellation(bool *old_mask);
72 
73 TEE_Result utee_wait(uint32_t timeout);
74 
75 TEE_Result utee_get_time(enum utee_time_category cat, TEE_Time *time);
76 
77 TEE_Result utee_set_ta_time(const TEE_Time *time);
78 
79 TEE_Result utee_cryp_state_alloc(uint32_t algo, uint32_t op_mode,
80 				 uint32_t key1, uint32_t key2,
81 				 uint32_t *state);
82 TEE_Result utee_cryp_state_copy(uint32_t dst, uint32_t src);
83 TEE_Result utee_cryp_state_free(uint32_t state);
84 
85 /* iv and iv_len are ignored for some algorithms */
86 TEE_Result utee_hash_init(uint32_t state, const void *iv, size_t iv_len);
87 TEE_Result utee_hash_update(uint32_t state, const void *chunk,
88 			    size_t chunk_size);
89 TEE_Result utee_hash_final(uint32_t state, const void *chunk,
90 			   size_t chunk_size, void *hash, size_t *hash_len);
91 
92 TEE_Result utee_cipher_init(uint32_t state, const void *iv, size_t iv_len);
93 TEE_Result utee_cipher_update(uint32_t state, const void *src, size_t src_len,
94 			      void *dest, size_t *dest_len);
95 TEE_Result utee_cipher_final(uint32_t state, const void *src, size_t src_len,
96 			     void *dest, size_t *dest_len);
97 
98 /* Generic Object Functions */
99 TEE_Result utee_cryp_obj_get_info(uint32_t obj, TEE_ObjectInfo *info);
100 TEE_Result utee_cryp_obj_restrict_usage(uint32_t obj, uint32_t usage);
101 TEE_Result utee_cryp_obj_get_attr(uint32_t obj, uint32_t attr_id,
102 				  void *buffer, size_t *size);
103 
104 /* Transient Object Functions */
105 TEE_Result utee_cryp_obj_alloc(TEE_ObjectType type, uint32_t max_size,
106 			       uint32_t *obj);
107 TEE_Result utee_cryp_obj_close(uint32_t obj);
108 TEE_Result utee_cryp_obj_reset(uint32_t obj);
109 TEE_Result utee_cryp_obj_populate(uint32_t obj, TEE_Attribute *attrs,
110 				  uint32_t attr_count);
111 TEE_Result utee_cryp_obj_copy(uint32_t dst_obj, uint32_t src_obj);
112 
113 TEE_Result utee_cryp_obj_generate_key(uint32_t obj, uint32_t key_size,
114 				      const TEE_Attribute *params,
115 				      uint32_t param_count);
116 
117 TEE_Result utee_cryp_derive_key(uint32_t state, const TEE_Attribute *params,
118 				uint32_t param_count, uint32_t derived_key);
119 
120 TEE_Result utee_cryp_random_number_generate(void *buf, size_t blen);
121 
122 TEE_Result utee_authenc_init(uint32_t state, const void *nonce,
123 			     size_t nonce_len, size_t tag_len, size_t aad_len,
124 			     size_t payload_len);
125 TEE_Result utee_authenc_update_aad(uint32_t state, const void *aad_data,
126 				   size_t aad_data_len);
127 TEE_Result utee_authenc_update_payload(uint32_t state, const void *src_data,
128 				       size_t src_len, void *dest_data,
129 				       size_t *dest_len);
130 TEE_Result utee_authenc_enc_final(uint32_t state, const void *src_data,
131 				  size_t src_len, void *dest_data,
132 				  size_t *dest_len, void *tag,
133 				  size_t *tag_len);
134 TEE_Result utee_authenc_dec_final(uint32_t state, const void *src_data,
135 				  size_t src_len, void *dest_data,
136 				  size_t *dest_len, const void *tag,
137 				  size_t tag_len);
138 
139 TEE_Result utee_asymm_operate(uint32_t state, const TEE_Attribute *params,
140 			      uint32_t num_params, const void *src_data,
141 			      size_t src_len, void *dest_data,
142 			      size_t *dest_len);
143 
144 TEE_Result utee_asymm_verify(uint32_t state,
145 			     const TEE_Attribute *params, uint32_t num_params,
146 			     const void *data, size_t data_len, const void *sig,
147 			     size_t sig_len);
148 
149 /* Persistant Object Functions */
150 TEE_Result utee_storage_obj_open(uint32_t storage_id, void *object_id,
151 				 uint32_t object_id_len, uint32_t flags,
152 				 TEE_ObjectHandle *obj);
153 
154 TEE_Result utee_storage_obj_create(uint32_t storage_id, void *object_id,
155 				   uint32_t object_id_len, uint32_t flags,
156 				   TEE_ObjectHandle attr, const void *data,
157 				   uint32_t len, TEE_ObjectHandle *obj);
158 
159 TEE_Result utee_storage_obj_del(TEE_ObjectHandle obj);
160 
161 TEE_Result utee_storage_obj_rename(TEE_ObjectHandle obj, const void *new_obj_id,
162 				   size_t new_obj_id_len);
163 
164 /* Persistent Object Enumeration Functions */
165 TEE_Result utee_storage_alloc_enum(TEE_ObjectEnumHandle *obj_enum);
166 
167 TEE_Result utee_storage_free_enum(TEE_ObjectEnumHandle obj_enum);
168 
169 TEE_Result utee_storage_reset_enum(TEE_ObjectEnumHandle obj_enum);
170 
171 TEE_Result utee_storage_start_enum(TEE_ObjectEnumHandle obj_enum,
172 				   uint32_t storage_id);
173 
174 TEE_Result utee_storage_next_enum(TEE_ObjectEnumHandle obj_enum,
175 				  TEE_ObjectInfo *info, void *obj_id,
176 				  size_t *len);
177 
178 /* Data Stream Access Functions */
179 TEE_Result utee_storage_obj_read(TEE_ObjectHandle obj, void *data, size_t len,
180 				 uint32_t *count);
181 
182 TEE_Result utee_storage_obj_write(TEE_ObjectHandle obj, const void *data,
183 				  size_t len);
184 
185 TEE_Result utee_storage_obj_trunc(TEE_ObjectHandle obj, size_t len);
186 
187 TEE_Result utee_storage_obj_seek(TEE_ObjectHandle obj, int32_t offset,
188 				 TEE_Whence whence);
189 
190 #endif /* UTEE_SYSCALLS_H */
191