1 /* 2 * Copyright (c) 2015, Linaro Limited 3 * Copyright (c) 2014, STMicroelectronics International N.V. 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright notice, 10 * this list of conditions and the following disclaimer. 11 * 12 * 2. Redistributions in binary form must reproduce the above copyright notice, 13 * this list of conditions and the following disclaimer in the documentation 14 * and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 #ifndef UTEE_SYSCALLS_H 29 #define UTEE_SYSCALLS_H 30 31 #include <compiler.h> 32 #include <stddef.h> 33 #include <stdint.h> 34 35 #include <utee_types.h> 36 #include <tee_api_types.h> 37 #include <trace.h> 38 39 /* 40 * Arguments must use the native register width. To keep it simple, only 41 * use pointers, long, unsigned long and size_t. Pointers may only point 42 * structures or types based on fixed width integer types. Only exception 43 * are buffers with opaque data. 44 * 45 * Return values should not use a fixed width larger than 32 bits, unsigned 46 * long and pointers are OK though. 47 * 48 * Members in structs on the other hand should only use fixed width integer 49 * types; uint32_t, uint64_t etc. To keep it simple, use uint64_t for all 50 * length fields. 51 */ 52 53 void utee_return(unsigned long ret) __noreturn; 54 55 void utee_log(const void *buf, size_t len); 56 57 void utee_panic(unsigned long code) __noreturn; 58 59 uint32_t utee_dummy(uint32_t *a); 60 61 uint32_t utee_dummy_7args(unsigned long a1, unsigned long a2, unsigned long a3, 62 unsigned long a4, unsigned long a5, unsigned long a6, 63 unsigned long a7); 64 65 uint32_t utee_nocall(void); 66 67 /* prop_set is TEE_PROPSET_xxx*/ 68 TEE_Result utee_get_property(unsigned long prop_set, unsigned long index, 69 void *name, uint32_t *name_len, 70 void *buf, uint32_t *blen, 71 uint32_t *prop_type); 72 TEE_Result utee_get_property_name_to_index(unsigned long prop_set, void *name, 73 unsigned long name_len, 74 uint32_t *index); 75 76 77 /* sess has type TEE_TASessionHandle */ 78 TEE_Result utee_open_ta_session(const TEE_UUID *dest, 79 unsigned long cancel_req_to, struct utee_params *params, 80 uint32_t *sess, uint32_t *ret_orig); 81 82 /* sess has type TEE_TASessionHandle */ 83 TEE_Result utee_close_ta_session(unsigned long sess); 84 85 /* sess has type TEE_TASessionHandle */ 86 TEE_Result utee_invoke_ta_command(unsigned long sess, 87 unsigned long cancel_req_to, unsigned long cmd_id, 88 struct utee_params *params, uint32_t *ret_orig); 89 90 TEE_Result utee_check_access_rights(uint32_t flags, const void *buf, 91 size_t len); 92 93 /* cancel has type bool */ 94 TEE_Result utee_get_cancellation_flag(uint32_t *cancel); 95 96 /* old_mask has type bool */ 97 TEE_Result utee_unmask_cancellation(uint32_t *old_mask); 98 99 /* old_mask has type bool */ 100 TEE_Result utee_mask_cancellation(uint32_t *old_mask); 101 102 TEE_Result utee_wait(unsigned long timeout); 103 104 /* cat has type enum utee_time_category */ 105 TEE_Result utee_get_time(unsigned long cat, TEE_Time *time); 106 107 TEE_Result utee_set_ta_time(const TEE_Time *time); 108 109 TEE_Result utee_cryp_state_alloc(unsigned long algo, unsigned long op_mode, 110 unsigned long key1, unsigned long key2, 111 uint32_t *state); 112 TEE_Result utee_cryp_state_copy(unsigned long dst, unsigned long src); 113 TEE_Result utee_cryp_state_free(unsigned long state); 114 115 /* iv and iv_len are ignored for some algorithms */ 116 TEE_Result utee_hash_init(unsigned long state, const void *iv, size_t iv_len); 117 TEE_Result utee_hash_update(unsigned long state, const void *chunk, 118 size_t chunk_size); 119 TEE_Result utee_hash_final(unsigned long state, const void *chunk, 120 size_t chunk_size, void *hash, uint64_t *hash_len); 121 122 TEE_Result utee_cipher_init(unsigned long state, const void *iv, size_t iv_len); 123 TEE_Result utee_cipher_update(unsigned long state, const void *src, 124 size_t src_len, void *dest, uint64_t *dest_len); 125 TEE_Result utee_cipher_final(unsigned long state, const void *src, 126 size_t src_len, void *dest, uint64_t *dest_len); 127 128 /* Generic Object Functions */ 129 TEE_Result utee_cryp_obj_get_info(unsigned long obj, TEE_ObjectInfo *info); 130 TEE_Result utee_cryp_obj_restrict_usage(unsigned long obj, unsigned long usage); 131 TEE_Result utee_cryp_obj_get_attr(unsigned long obj, unsigned long attr_id, 132 void *buffer, uint64_t *size); 133 134 /* Transient Object Functions */ 135 /* type has type TEE_ObjectType */ 136 TEE_Result utee_cryp_obj_alloc(unsigned long type, unsigned long max_size, 137 uint32_t *obj); 138 TEE_Result utee_cryp_obj_close(unsigned long obj); 139 TEE_Result utee_cryp_obj_reset(unsigned long obj); 140 TEE_Result utee_cryp_obj_populate(unsigned long obj, 141 struct utee_attribute *attrs, unsigned long attr_count); 142 TEE_Result utee_cryp_obj_copy(unsigned long dst_obj, unsigned long src_obj); 143 144 TEE_Result utee_cryp_obj_generate_key(unsigned long obj, unsigned long key_size, 145 const struct utee_attribute *params, 146 unsigned long param_count); 147 148 TEE_Result utee_cryp_derive_key(unsigned long state, 149 const struct utee_attribute *params, 150 unsigned long param_count, unsigned long derived_key); 151 152 TEE_Result utee_cryp_random_number_generate(void *buf, size_t blen); 153 154 TEE_Result utee_authenc_init(unsigned long state, const void *nonce, 155 size_t nonce_len, size_t tag_len, size_t aad_len, 156 size_t payload_len); 157 TEE_Result utee_authenc_update_aad(unsigned long state, const void *aad_data, 158 size_t aad_data_len); 159 TEE_Result utee_authenc_update_payload(unsigned long state, 160 const void *src_data, size_t src_len, void *dest_data, 161 uint64_t *dest_len); 162 TEE_Result utee_authenc_enc_final(unsigned long state, const void *src_data, 163 size_t src_len, void *dest_data, uint64_t *dest_len, 164 void *tag, uint64_t *tag_len); 165 TEE_Result utee_authenc_dec_final(unsigned long state, const void *src_data, 166 size_t src_len, void *dest_data, uint64_t *dest_len, 167 const void *tag, size_t tag_len); 168 169 TEE_Result utee_asymm_operate(unsigned long state, 170 const struct utee_attribute *params, 171 unsigned long num_params, const void *src_data, 172 size_t src_len, void *dest_data, uint64_t *dest_len); 173 174 TEE_Result utee_asymm_verify(unsigned long state, 175 const struct utee_attribute *params, 176 unsigned long num_params, const void *data, 177 size_t data_len, const void *sig, size_t sig_len); 178 179 /* Persistant Object Functions */ 180 /* obj is of type TEE_ObjectHandle */ 181 TEE_Result utee_storage_obj_open(unsigned long storage_id, void *object_id, 182 size_t object_id_len, unsigned long flags, 183 uint32_t *obj); 184 185 /* 186 * attr is of type TEE_ObjectHandle 187 * obj is of type TEE_ObjectHandle 188 */ 189 TEE_Result utee_storage_obj_create(unsigned long storage_id, void *object_id, 190 size_t object_id_len, unsigned long flags, 191 unsigned long attr, const void *data, 192 size_t len, uint32_t *obj); 193 194 /* obj is of type TEE_ObjectHandle */ 195 TEE_Result utee_storage_obj_del(unsigned long obj); 196 197 /* obj is of type TEE_ObjectHandle */ 198 TEE_Result utee_storage_obj_rename(unsigned long obj, const void *new_obj_id, 199 size_t new_obj_id_len); 200 201 /* Persistent Object Enumeration Functions */ 202 /* obj_enum is of type TEE_ObjectEnumHandle */ 203 TEE_Result utee_storage_alloc_enum(uint32_t *obj_enum); 204 205 206 /* obj_enum is of type TEE_ObjectEnumHandle */ 207 TEE_Result utee_storage_free_enum(unsigned long obj_enum); 208 209 /* obj_enum is of type TEE_ObjectEnumHandle */ 210 TEE_Result utee_storage_reset_enum(unsigned long obj_enum); 211 212 /* obj_enum is of type TEE_ObjectEnumHandle */ 213 TEE_Result utee_storage_start_enum(unsigned long obj_enum, 214 unsigned long storage_id); 215 216 /* obj_enum is of type TEE_ObjectEnumHandle */ 217 TEE_Result utee_storage_next_enum(unsigned long obj_enum, TEE_ObjectInfo *info, 218 void *obj_id, uint64_t *len); 219 220 /* Data Stream Access Functions */ 221 /* obj is of type TEE_ObjectHandle */ 222 TEE_Result utee_storage_obj_read(unsigned long obj, void *data, size_t len, 223 uint64_t *count); 224 225 /* obj is of type TEE_ObjectHandle */ 226 TEE_Result utee_storage_obj_write(unsigned long obj, const void *data, 227 size_t len); 228 229 /* obj is of type TEE_ObjectHandle */ 230 TEE_Result utee_storage_obj_trunc(unsigned long obj, size_t len); 231 232 /* obj is of type TEE_ObjectHandle */ 233 /* whence is of type TEE_Whence */ 234 TEE_Result utee_storage_obj_seek(unsigned long obj, long offset, 235 unsigned long whence); 236 237 /* seServiceHandle is of type TEE_SEServiceHandle */ 238 TEE_Result utee_se_service_open(uint32_t *seServiceHandle); 239 240 /* seServiceHandle is of type TEE_SEServiceHandle */ 241 TEE_Result utee_se_service_close(unsigned long seServiceHandle); 242 243 /* 244 * seServiceHandle is of type TEE_SEServiceHandle 245 * r is of type TEE_SEReaderHandle 246 */ 247 TEE_Result utee_se_service_get_readers(unsigned long seServiceHandle, 248 uint32_t *r, uint64_t *len); 249 250 /* 251 * r is of type TEE_SEReaderHandle 252 * p is defined with defines UTEE_SE_READER_* 253 */ 254 TEE_Result utee_se_reader_get_prop(unsigned long r, uint32_t *p); 255 256 /* r is of type TEE_SEReaderHandle */ 257 TEE_Result utee_se_reader_get_name(unsigned long r, 258 char *name, uint64_t *name_len); 259 260 /* 261 * r is of type TEE_SEReaderHandle 262 * s if of type TEE_SESessionHandle 263 */ 264 TEE_Result utee_se_reader_open_session(unsigned long r, uint32_t *s); 265 266 /* r is of type TEE_SEReaderHandle */ 267 TEE_Result utee_se_reader_close_sessions(unsigned long r); 268 269 /* s is of type TEE_SESessionHandle */ 270 TEE_Result utee_se_session_is_closed(unsigned long s); 271 272 /* s is of type TEE_SESessionHandle */ 273 TEE_Result utee_se_session_get_atr(unsigned long s, void *atr, 274 uint64_t *atr_len); 275 276 /* 277 * s is of type TEE_SESessionHandle 278 * c is of type TEE_SEChannelHandle 279 */ 280 TEE_Result utee_se_session_open_channel(unsigned long s, 281 unsigned long is_logical, const void *aid_buffer, 282 size_t aid_buffer_len, uint32_t *c); 283 284 /* s is of type TEE_SESessionHandle */ 285 TEE_Result utee_se_session_close(unsigned long s); 286 287 /* c is of type TEE_SEChannelHandle */ 288 TEE_Result utee_se_channel_select_next(unsigned long c); 289 290 /* c is of type TEE_SEChannelHandle */ 291 TEE_Result utee_se_channel_get_select_resp(unsigned long c, void *resp, 292 uint64_t *resp_len); 293 294 /* c is of type TEE_SEChannelHandle */ 295 TEE_Result utee_se_channel_transmit(unsigned long c, void *cmd, 296 size_t cmd_len, void *resp, uint64_t *resp_len); 297 298 /* c is of type TEE_SEChannelHandle */ 299 TEE_Result utee_se_channel_close(unsigned long c); 300 301 /* op is of type enum utee_cache_operation */ 302 TEE_Result utee_cache_operation(void *va, size_t l, unsigned long op); 303 304 #endif /* UTEE_SYSCALLS_H */ 305