xref: /optee_os/lib/libutee/include/utee_syscalls.h (revision 883c4be3d11cacf49665f51d1d6af4c02a0a0afd)

/*
 * Copyright (c) 2015, Linaro Limited
 * Copyright (c) 2014, STMicroelectronics International N.V.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef UTEE_SYSCALLS_H
#define UTEE_SYSCALLS_H

#include <compiler.h>
#include <stddef.h>
#include <stdint.h>

#include <utee_types.h>
#include <tee_api_types.h>
#include <trace.h>

/*
 * Arguments must use the native register width, unless it's a signed
 * argument then it must be a 32-bit value instead to avoid problems with
 * sign extension. To keep it simple, only use pointers, int32_t, unsigned
 * long and size_t. Pointers may only point structures or types based on
 * fixed width integer types. Only exception are buffers with opaque data.
 *
 * Return values should not use a fixed width larger than 32 bits, unsigned
 * long and pointers are OK though.
 *
 * Members in structs on the other hand should only use fixed width integer
 * types; uint32_t, uint64_t etc. To keep it simple, use uint64_t for all
 * length fields.
 */

void utee_return(unsigned long ret) __noreturn;

void utee_log(const void *buf, size_t len);

void utee_panic(unsigned long code) __noreturn;

/* prop_set is TEE_PROPSET_xxx*/
TEE_Result utee_get_property(unsigned long prop_set, unsigned long index,
			     void *name, uint32_t *name_len,
			     void *buf, uint32_t *blen,
				uint32_t *prop_type);
TEE_Result utee_get_property_name_to_index(unsigned long prop_set, void *name,
					   unsigned long name_len,
					   uint32_t *index);


/* sess has type TEE_TASessionHandle */
TEE_Result utee_open_ta_session(const TEE_UUID *dest,
			unsigned long cancel_req_to, struct utee_params *params,
			uint32_t *sess, uint32_t *ret_orig);

/* sess has type TEE_TASessionHandle */
TEE_Result utee_close_ta_session(unsigned long sess);

/* sess has type TEE_TASessionHandle */
TEE_Result utee_invoke_ta_command(unsigned long sess,
			unsigned long cancel_req_to, unsigned long cmd_id,
			struct utee_params *params, uint32_t *ret_orig);

TEE_Result utee_check_access_rights(uint32_t flags, const void *buf,
				    size_t len);

/* cancel has type bool */
TEE_Result utee_get_cancellation_flag(uint32_t *cancel);

/* old_mask has type bool */
TEE_Result utee_unmask_cancellation(uint32_t *old_mask);

/* old_mask has type bool */
TEE_Result utee_mask_cancellation(uint32_t *old_mask);

TEE_Result utee_wait(unsigned long timeout);

/* cat has type enum utee_time_category */
TEE_Result utee_get_time(unsigned long cat, TEE_Time *time);

TEE_Result utee_set_ta_time(const TEE_Time *time);

TEE_Result utee_cryp_state_alloc(unsigned long algo, unsigned long op_mode,
				 unsigned long key1, unsigned long key2,
				 uint32_t *state);
TEE_Result utee_cryp_state_copy(unsigned long dst, unsigned long src);
TEE_Result utee_cryp_state_free(unsigned long state);

/* iv and iv_len are ignored for some algorithms */
TEE_Result utee_hash_init(unsigned long state, const void *iv, size_t iv_len);
TEE_Result utee_hash_update(unsigned long state, const void *chunk,
			    size_t chunk_size);
TEE_Result utee_hash_final(unsigned long state, const void *chunk,
			   size_t chunk_size, void *hash, uint64_t *hash_len);

TEE_Result utee_cipher_init(unsigned long state, const void *iv, size_t iv_len);
TEE_Result utee_cipher_update(unsigned long state, const void *src,
			size_t src_len, void *dest, uint64_t *dest_len);
TEE_Result utee_cipher_final(unsigned long state, const void *src,
			size_t src_len, void *dest, uint64_t *dest_len);

/* Generic Object Functions */
TEE_Result utee_cryp_obj_get_info(unsigned long obj, TEE_ObjectInfo *info);
TEE_Result utee_cryp_obj_restrict_usage(unsigned long obj, unsigned long usage);
TEE_Result utee_cryp_obj_get_attr(unsigned long obj, unsigned long attr_id,
			void *buffer, uint64_t *size);

/* Transient Object Functions */
/* type has type TEE_ObjectType */
TEE_Result utee_cryp_obj_alloc(unsigned long type, unsigned long max_size,
			uint32_t *obj);
TEE_Result utee_cryp_obj_close(unsigned long obj);
TEE_Result utee_cryp_obj_reset(unsigned long obj);
TEE_Result utee_cryp_obj_populate(unsigned long obj,
			struct utee_attribute *attrs, unsigned long attr_count);
TEE_Result utee_cryp_obj_copy(unsigned long dst_obj, unsigned long src_obj);

TEE_Result utee_cryp_obj_generate_key(unsigned long obj, unsigned long key_size,
			const struct utee_attribute *params,
			unsigned long param_count);

TEE_Result utee_cryp_derive_key(unsigned long state,
			const struct utee_attribute *params,
			unsigned long param_count, unsigned long derived_key);

TEE_Result utee_cryp_random_number_generate(void *buf, size_t blen);

TEE_Result utee_authenc_init(unsigned long state, const void *nonce,
			size_t nonce_len, size_t tag_len, size_t aad_len,
			size_t payload_len);
TEE_Result utee_authenc_update_aad(unsigned long state, const void *aad_data,
			size_t aad_data_len);
TEE_Result utee_authenc_update_payload(unsigned long state,
			const void *src_data, size_t src_len, void *dest_data,
			uint64_t *dest_len);
TEE_Result utee_authenc_enc_final(unsigned long state, const void *src_data,
			size_t src_len, void *dest_data, uint64_t *dest_len,
			void *tag, uint64_t *tag_len);
TEE_Result utee_authenc_dec_final(unsigned long state, const void *src_data,
			size_t src_len, void *dest_data, uint64_t *dest_len,
			const void *tag, size_t tag_len);

TEE_Result utee_asymm_operate(unsigned long state,
			const struct utee_attribute *params,
			unsigned long num_params, const void *src_data,
			size_t src_len, void *dest_data, uint64_t *dest_len);

TEE_Result utee_asymm_verify(unsigned long state,
			const struct utee_attribute *params,
			unsigned long num_params, const void *data,
			size_t data_len, const void *sig, size_t sig_len);

/* Persistant Object Functions */
/* obj is of type TEE_ObjectHandle */
TEE_Result utee_storage_obj_open(unsigned long storage_id, void *object_id,
				 size_t object_id_len, unsigned long flags,
				 uint32_t *obj);

/*
 * attr is of type TEE_ObjectHandle
 * obj is of type TEE_ObjectHandle
 */
TEE_Result utee_storage_obj_create(unsigned long storage_id, void *object_id,
				size_t object_id_len, unsigned long flags,
				unsigned long attr, const void *data,
				size_t len, uint32_t *obj);

/* obj is of type TEE_ObjectHandle */
TEE_Result utee_storage_obj_del(unsigned long obj);

/* obj is of type TEE_ObjectHandle */
TEE_Result utee_storage_obj_rename(unsigned long obj, const void *new_obj_id,
				size_t new_obj_id_len);

/* Persistent Object Enumeration Functions */
/* obj_enum is of type TEE_ObjectEnumHandle */
TEE_Result utee_storage_alloc_enum(uint32_t *obj_enum);


/* obj_enum is of type TEE_ObjectEnumHandle */
TEE_Result utee_storage_free_enum(unsigned long obj_enum);

/* obj_enum is of type TEE_ObjectEnumHandle */
TEE_Result utee_storage_reset_enum(unsigned long obj_enum);

/* obj_enum is of type TEE_ObjectEnumHandle */
TEE_Result utee_storage_start_enum(unsigned long obj_enum,
			unsigned long storage_id);

/* obj_enum is of type TEE_ObjectEnumHandle */
TEE_Result utee_storage_next_enum(unsigned long obj_enum, TEE_ObjectInfo *info,
			void *obj_id, uint64_t *len);

/* Data Stream Access Functions */
/* obj is of type TEE_ObjectHandle */
TEE_Result utee_storage_obj_read(unsigned long obj, void *data, size_t len,
			uint64_t *count);

/* obj is of type TEE_ObjectHandle */
TEE_Result utee_storage_obj_write(unsigned long obj, const void *data,
			size_t len);

/* obj is of type TEE_ObjectHandle */
TEE_Result utee_storage_obj_trunc(unsigned long obj, size_t len);

/* obj is of type TEE_ObjectHandle */
/* whence is of type TEE_Whence */
TEE_Result utee_storage_obj_seek(unsigned long obj, int32_t offset,
				 unsigned long whence);

/* seServiceHandle is of type TEE_SEServiceHandle */
TEE_Result utee_se_service_open(uint32_t *seServiceHandle);

/* seServiceHandle is of type TEE_SEServiceHandle */
TEE_Result utee_se_service_close(unsigned long seServiceHandle);

/*
 * seServiceHandle is of type TEE_SEServiceHandle
 * r is of type TEE_SEReaderHandle
 */
TEE_Result utee_se_service_get_readers(unsigned long seServiceHandle,
			uint32_t *r, uint64_t *len);

/*
 * r is of type TEE_SEReaderHandle
 * p is defined with defines UTEE_SE_READER_*
 */
TEE_Result utee_se_reader_get_prop(unsigned long r, uint32_t *p);

/* r is of type TEE_SEReaderHandle */
TEE_Result utee_se_reader_get_name(unsigned long r,
			char *name, uint64_t *name_len);

/*
 * r is of type TEE_SEReaderHandle
 * s if of type TEE_SESessionHandle
 */
TEE_Result utee_se_reader_open_session(unsigned long r, uint32_t *s);

/* r is of type TEE_SEReaderHandle */
TEE_Result utee_se_reader_close_sessions(unsigned long r);

/* s is of type TEE_SESessionHandle */
TEE_Result utee_se_session_is_closed(unsigned long s);

/* s is of type TEE_SESessionHandle */
TEE_Result utee_se_session_get_atr(unsigned long s, void *atr,
			uint64_t *atr_len);

/*
 * s is of type TEE_SESessionHandle
 * c is of type TEE_SEChannelHandle
 */
TEE_Result utee_se_session_open_channel(unsigned long s,
			unsigned long is_logical, const void *aid_buffer,
			size_t aid_buffer_len, uint32_t *c);

/* s is of type TEE_SESessionHandle */
TEE_Result utee_se_session_close(unsigned long s);

/* c is of type TEE_SEChannelHandle */
TEE_Result utee_se_channel_select_next(unsigned long c);

/* c is of type TEE_SEChannelHandle */
TEE_Result utee_se_channel_get_select_resp(unsigned long c, void *resp,
			uint64_t *resp_len);

/* c is of type TEE_SEChannelHandle */
TEE_Result utee_se_channel_transmit(unsigned long c, void *cmd,
			size_t cmd_len, void *resp, uint64_t *resp_len);

/* c is of type TEE_SEChannelHandle */
TEE_Result utee_se_channel_close(unsigned long c);

/* op is of type enum utee_cache_operation */
TEE_Result utee_cache_operation(void *va, size_t l, unsigned long op);

TEE_Result utee_gprof_send(void *buf, size_t size, uint32_t *id);

#endif /* UTEE_SYSCALLS_H */