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, unless it's a signed 41 * argument then it must be a 32-bit value instead to avoid problems with 42 * sign extension. To keep it simple, only use pointers, int32_t, unsigned 43 * long and size_t. Pointers may only point structures or types based on 44 * fixed width integer types. Only exception are buffers with opaque data. 45 * 46 * Return values should not use a fixed width larger than 32 bits, unsigned 47 * long and pointers are OK though. 48 * 49 * Members in structs on the other hand should only use fixed width integer 50 * types; uint32_t, uint64_t etc. To keep it simple, use uint64_t for all 51 * length fields. 52 */ 53 54 void utee_return(unsigned long ret) __noreturn; 55 56 void utee_log(const void *buf, size_t len); 57 58 void utee_panic(unsigned long code) __noreturn; 59 60 /* prop_set is TEE_PROPSET_xxx*/ 61 TEE_Result utee_get_property(unsigned long prop_set, unsigned long index, 62 void *name, uint32_t *name_len, 63 void *buf, uint32_t *blen, 64 uint32_t *prop_type); 65 TEE_Result utee_get_property_name_to_index(unsigned long prop_set, 66 const void *name, 67 unsigned long name_len, 68 uint32_t *index); 69 70 71 /* sess has type TEE_TASessionHandle */ 72 TEE_Result utee_open_ta_session(const TEE_UUID *dest, 73 unsigned long cancel_req_to, struct utee_params *params, 74 uint32_t *sess, uint32_t *ret_orig); 75 76 /* sess has type TEE_TASessionHandle */ 77 TEE_Result utee_close_ta_session(unsigned long sess); 78 79 /* sess has type TEE_TASessionHandle */ 80 TEE_Result utee_invoke_ta_command(unsigned long sess, 81 unsigned long cancel_req_to, unsigned long cmd_id, 82 struct utee_params *params, uint32_t *ret_orig); 83 84 TEE_Result utee_check_access_rights(uint32_t flags, const void *buf, 85 size_t len); 86 87 /* cancel has type bool */ 88 TEE_Result utee_get_cancellation_flag(uint32_t *cancel); 89 90 /* old_mask has type bool */ 91 TEE_Result utee_unmask_cancellation(uint32_t *old_mask); 92 93 /* old_mask has type bool */ 94 TEE_Result utee_mask_cancellation(uint32_t *old_mask); 95 96 TEE_Result utee_wait(unsigned long timeout); 97 98 /* cat has type enum utee_time_category */ 99 TEE_Result utee_get_time(unsigned long cat, TEE_Time *time); 100 101 TEE_Result utee_set_ta_time(const TEE_Time *time); 102 103 TEE_Result utee_cryp_state_alloc(unsigned long algo, unsigned long op_mode, 104 unsigned long key1, unsigned long key2, 105 uint32_t *state); 106 TEE_Result utee_cryp_state_copy(unsigned long dst, unsigned long src); 107 TEE_Result utee_cryp_state_free(unsigned long state); 108 109 /* iv and iv_len are ignored for some algorithms */ 110 TEE_Result utee_hash_init(unsigned long state, const void *iv, size_t iv_len); 111 TEE_Result utee_hash_update(unsigned long state, const void *chunk, 112 size_t chunk_size); 113 TEE_Result utee_hash_final(unsigned long state, const void *chunk, 114 size_t chunk_size, void *hash, uint64_t *hash_len); 115 116 TEE_Result utee_cipher_init(unsigned long state, const void *iv, size_t iv_len); 117 TEE_Result utee_cipher_update(unsigned long state, const void *src, 118 size_t src_len, void *dest, uint64_t *dest_len); 119 TEE_Result utee_cipher_final(unsigned long state, const void *src, 120 size_t src_len, void *dest, uint64_t *dest_len); 121 122 /* Generic Object Functions */ 123 TEE_Result utee_cryp_obj_get_info(unsigned long obj, TEE_ObjectInfo *info); 124 TEE_Result utee_cryp_obj_restrict_usage(unsigned long obj, unsigned long usage); 125 TEE_Result utee_cryp_obj_get_attr(unsigned long obj, unsigned long attr_id, 126 void *buffer, uint64_t *size); 127 128 /* Transient Object Functions */ 129 /* type has type TEE_ObjectType */ 130 TEE_Result utee_cryp_obj_alloc(unsigned long type, unsigned long max_size, 131 uint32_t *obj); 132 TEE_Result utee_cryp_obj_close(unsigned long obj); 133 TEE_Result utee_cryp_obj_reset(unsigned long obj); 134 TEE_Result utee_cryp_obj_populate(unsigned long obj, 135 struct utee_attribute *attrs, unsigned long attr_count); 136 TEE_Result utee_cryp_obj_copy(unsigned long dst_obj, unsigned long src_obj); 137 138 TEE_Result utee_cryp_obj_generate_key(unsigned long obj, unsigned long key_size, 139 const struct utee_attribute *params, 140 unsigned long param_count); 141 142 TEE_Result utee_cryp_derive_key(unsigned long state, 143 const struct utee_attribute *params, 144 unsigned long param_count, unsigned long derived_key); 145 146 TEE_Result utee_cryp_random_number_generate(void *buf, size_t blen); 147 148 TEE_Result utee_authenc_init(unsigned long state, const void *nonce, 149 size_t nonce_len, size_t tag_len, size_t aad_len, 150 size_t payload_len); 151 TEE_Result utee_authenc_update_aad(unsigned long state, const void *aad_data, 152 size_t aad_data_len); 153 TEE_Result utee_authenc_update_payload(unsigned long state, 154 const void *src_data, size_t src_len, void *dest_data, 155 uint64_t *dest_len); 156 TEE_Result utee_authenc_enc_final(unsigned long state, const void *src_data, 157 size_t src_len, void *dest_data, uint64_t *dest_len, 158 void *tag, uint64_t *tag_len); 159 TEE_Result utee_authenc_dec_final(unsigned long state, const void *src_data, 160 size_t src_len, void *dest_data, uint64_t *dest_len, 161 const void *tag, size_t tag_len); 162 163 TEE_Result utee_asymm_operate(unsigned long state, 164 const struct utee_attribute *params, 165 unsigned long num_params, const void *src_data, 166 size_t src_len, void *dest_data, uint64_t *dest_len); 167 168 TEE_Result utee_asymm_verify(unsigned long state, 169 const struct utee_attribute *params, 170 unsigned long num_params, const void *data, 171 size_t data_len, const void *sig, size_t sig_len); 172 173 /* Persistant Object Functions */ 174 /* obj is of type TEE_ObjectHandle */ 175 TEE_Result utee_storage_obj_open(unsigned long storage_id, 176 const void *object_id, 177 size_t object_id_len, unsigned long flags, 178 uint32_t *obj); 179 180 /* 181 * attr is of type TEE_ObjectHandle 182 * obj is of type TEE_ObjectHandle 183 */ 184 TEE_Result utee_storage_obj_create(unsigned long storage_id, 185 const void *object_id, 186 size_t object_id_len, unsigned long flags, 187 unsigned long attr, const void *data, 188 size_t len, uint32_t *obj); 189 190 /* obj is of type TEE_ObjectHandle */ 191 TEE_Result utee_storage_obj_del(unsigned long obj); 192 193 /* obj is of type TEE_ObjectHandle */ 194 TEE_Result utee_storage_obj_rename(unsigned long obj, const void *new_obj_id, 195 size_t new_obj_id_len); 196 197 /* Persistent Object Enumeration Functions */ 198 /* obj_enum is of type TEE_ObjectEnumHandle */ 199 TEE_Result utee_storage_alloc_enum(uint32_t *obj_enum); 200 201 202 /* obj_enum is of type TEE_ObjectEnumHandle */ 203 TEE_Result utee_storage_free_enum(unsigned long obj_enum); 204 205 /* obj_enum is of type TEE_ObjectEnumHandle */ 206 TEE_Result utee_storage_reset_enum(unsigned long obj_enum); 207 208 /* obj_enum is of type TEE_ObjectEnumHandle */ 209 TEE_Result utee_storage_start_enum(unsigned long obj_enum, 210 unsigned long storage_id); 211 212 /* obj_enum is of type TEE_ObjectEnumHandle */ 213 TEE_Result utee_storage_next_enum(unsigned long obj_enum, TEE_ObjectInfo *info, 214 void *obj_id, uint64_t *len); 215 216 /* Data Stream Access Functions */ 217 /* obj is of type TEE_ObjectHandle */ 218 TEE_Result utee_storage_obj_read(unsigned long obj, void *data, size_t len, 219 uint64_t *count); 220 221 /* obj is of type TEE_ObjectHandle */ 222 TEE_Result utee_storage_obj_write(unsigned long obj, const void *data, 223 size_t len); 224 225 /* obj is of type TEE_ObjectHandle */ 226 TEE_Result utee_storage_obj_trunc(unsigned long obj, size_t len); 227 228 /* obj is of type TEE_ObjectHandle */ 229 /* whence is of type TEE_Whence */ 230 TEE_Result utee_storage_obj_seek(unsigned long obj, int32_t offset, 231 unsigned long whence); 232 233 /* seServiceHandle is of type TEE_SEServiceHandle */ 234 TEE_Result utee_se_service_open(uint32_t *seServiceHandle); 235 236 /* seServiceHandle is of type TEE_SEServiceHandle */ 237 TEE_Result utee_se_service_close(unsigned long seServiceHandle); 238 239 /* 240 * seServiceHandle is of type TEE_SEServiceHandle 241 * r is of type TEE_SEReaderHandle 242 */ 243 TEE_Result utee_se_service_get_readers(unsigned long seServiceHandle, 244 uint32_t *r, uint64_t *len); 245 246 /* 247 * r is of type TEE_SEReaderHandle 248 * p is defined with defines UTEE_SE_READER_* 249 */ 250 TEE_Result utee_se_reader_get_prop(unsigned long r, uint32_t *p); 251 252 /* r is of type TEE_SEReaderHandle */ 253 TEE_Result utee_se_reader_get_name(unsigned long r, 254 char *name, uint64_t *name_len); 255 256 /* 257 * r is of type TEE_SEReaderHandle 258 * s if of type TEE_SESessionHandle 259 */ 260 TEE_Result utee_se_reader_open_session(unsigned long r, uint32_t *s); 261 262 /* r is of type TEE_SEReaderHandle */ 263 TEE_Result utee_se_reader_close_sessions(unsigned long r); 264 265 /* s is of type TEE_SESessionHandle */ 266 TEE_Result utee_se_session_is_closed(unsigned long s); 267 268 /* s is of type TEE_SESessionHandle */ 269 TEE_Result utee_se_session_get_atr(unsigned long s, void *atr, 270 uint64_t *atr_len); 271 272 /* 273 * s is of type TEE_SESessionHandle 274 * c is of type TEE_SEChannelHandle 275 */ 276 TEE_Result utee_se_session_open_channel(unsigned long s, 277 unsigned long is_logical, const void *aid_buffer, 278 size_t aid_buffer_len, uint32_t *c); 279 280 /* s is of type TEE_SESessionHandle */ 281 TEE_Result utee_se_session_close(unsigned long s); 282 283 /* c is of type TEE_SEChannelHandle */ 284 TEE_Result utee_se_channel_select_next(unsigned long c); 285 286 /* c is of type TEE_SEChannelHandle */ 287 TEE_Result utee_se_channel_get_select_resp(unsigned long c, void *resp, 288 uint64_t *resp_len); 289 290 /* c is of type TEE_SEChannelHandle */ 291 TEE_Result utee_se_channel_transmit(unsigned long c, void *cmd, 292 size_t cmd_len, void *resp, uint64_t *resp_len); 293 294 /* c is of type TEE_SEChannelHandle */ 295 TEE_Result utee_se_channel_close(unsigned long c); 296 297 /* op is of type enum utee_cache_operation */ 298 TEE_Result utee_cache_operation(void *va, size_t l, unsigned long op); 299 300 TEE_Result utee_gprof_send(void *buf, size_t size, uint32_t *id); 301 302 #endif /* UTEE_SYSCALLS_H */ 303