/* SPDX-License-Identifier: BSD-2-Clause */
/*
 * Copyright (c) 2014, STMicroelectronics International N.V.
 * Copyright (c) 2018, Linaro Limited.
 */

#ifndef USER_TA_HEADER_H
#define USER_TA_HEADER_H

#include <tee_api_types.h>
#include <util.h>

#define TA_FLAG_USER_MODE		0	 /* Deprecated, was BIT32(0) */
#define TA_FLAG_EXEC_DDR		0	 /* Deprecated, was BIT32(1) */
#define TA_FLAG_SINGLE_INSTANCE		BIT32(2)
#define TA_FLAG_MULTI_SESSION		BIT32(3)
#define TA_FLAG_INSTANCE_KEEP_ALIVE	BIT32(4) /* remains after last close */
#define TA_FLAG_SECURE_DATA_PATH	BIT32(5) /* accesses SDP memory */
#define TA_FLAG_REMAP_SUPPORT		0	 /* Deprecated, was BIT32(6) */
#define TA_FLAG_CACHE_MAINTENANCE	BIT32(7) /* use cache flush syscall */
	/*
	 * TA instance can execute multiple sessions concurrently
	 * (pseudo-TAs only).
	 */
#define TA_FLAG_CONCURRENT		BIT32(8)
	/*
	 * Device enumeration is initiated at multiple stages by the normal
	 * world:
	 * 1. First when the kernel driver has initialized
	 * 2. When RPMB is available via inkernel RPMB routing
	 * 3. When the tee-supplicant is started
	 *
	 * The flags below control at which stage a TA will be enumerated:
	 * TA_FLAG_DEVICE_ENUM - at stage 1
	 * TA_FLAG_DEVICE_ENUM_TEE_STORAGE_PRIVATE -
	 *      when secure storage is available, at stage 2 or 3 depending
	 *      on whether TEE_STORAGE_PRIVATE is using RPMB FS
	 *      (CFG_REE_FS=n CFG_RPMB_FS=y) or REE FS (CFG_REE_FS=y). The
	 *      former utilizes in kernel RPMB routing, and the latter
	 *      depends on tee-supplicant to access secure storage.
	 * TA_FLAG_DEVICE_ENUM_SUPP - at stage 3
	 *
	 * The TA is enumerated at stage 2 if
	 * TA_FLAG_DEVICE_ENUM_TEE_STORAGE_PRIVATE is set and
	 * TEE_STORAGE_PRIVATE is using RPMB FS, or if it's using REE FS it
	 * will be enumerated at stage 3.
	 */
#define TA_FLAG_DEVICE_ENUM		BIT32(9)  /* without tee-supplicant */
#define TA_FLAG_DEVICE_ENUM_SUPP	BIT32(10) /* with tee-supplicant */
	/* See also "gpd.ta.doesNotCloseHandleOnCorruptObject" */
#define TA_FLAG_DONT_CLOSE_HANDLE_ON_CORRUPT_OBJECT \
					BIT32(11)
#define TA_FLAG_DEVICE_ENUM_TEE_STORAGE_PRIVATE	\
					BIT32(12) /* with TEE_STORAGE_PRIVATE */
/*
 * Don't restart a TA with TA_FLAG_INSTANCE_KEEP_ALIVE set if it has
 * crashed.
 */
#define TA_FLAG_INSTANCE_KEEP_CRASHED	BIT32(13)

#define TA_FLAGS_MASK			GENMASK_32(13, 0)

struct ta_head {
	TEE_UUID uuid;
	uint32_t stack_size;
	uint32_t flags;
	uint64_t depr_entry;
};

#if defined(CFG_FTRACE_SUPPORT)
#define FTRACE_RETFUNC_DEPTH		50
union compat_ptr {
	uint64_t ptr64;
	struct {
		uint32_t lo;
		uint32_t hi;
	} ptr32;
};

struct __ftrace_info {
	union compat_ptr buf_start;
	union compat_ptr buf_end;
	union compat_ptr ret_ptr;
};

struct ftrace_buf {
	uint64_t ret_func_ptr;	/* __ftrace_return pointer */
	uint64_t ret_stack[FTRACE_RETFUNC_DEPTH]; /* Return stack */
	uint32_t ret_idx;	/* Return stack index */
	uint32_t lr_idx;	/* lr index used for stack unwinding */
	uint64_t begin_time[FTRACE_RETFUNC_DEPTH]; /* Timestamp */
	uint64_t suspend_time;	/* Suspend timestamp */
	uint32_t curr_idx;	/* Current entry in the (circular) buffer */
	uint32_t max_size;	/* Max allowed size of ftrace buffer */
	uint32_t head_off;	/* Ftrace buffer header offset */
	uint32_t buf_off;	/* Ftrace buffer offset */
	uint32_t dump_id;	/* Dump ID returned by the supplicant */
	bool syscall_trace_enabled; /* Some syscalls are never traced */
	bool syscall_trace_suspended; /* By foreign interrupt or RPC */
	bool overflow;		/* Circular buffer has wrapped */
};

/* Defined by the linker script */
extern struct ftrace_buf __ftrace_buf_start;
extern uint8_t __ftrace_buf_end[];

unsigned long ftrace_return(void);
void __ftrace_return(void);
#endif

void __utee_call_elf_init_fn(void);
void __utee_call_elf_fini_fn(void);

void __utee_tcb_init(void);

/*
 * Information about the ELF objects loaded by the application
 */

struct __elf_phdr_info {
	uint32_t reserved;
	uint16_t count;
	uint8_t reserved2;
	char zero;
	struct dl_phdr_info *dlpi; /* @count entries */
};

/* 32-bit variant for a 64-bit ldelf to access a 32-bit TA */
struct __elf_phdr_info32 {
	uint32_t reserved;
	uint16_t count;
	uint8_t reserved2;
	char zero;
	uint32_t dlpi;
};

extern struct __elf_phdr_info __elf_phdr_info;

#define TA_PROP_STR_SINGLE_INSTANCE	"gpd.ta.singleInstance"
#define TA_PROP_STR_MULTI_SESSION	"gpd.ta.multiSession"
#define TA_PROP_STR_KEEP_ALIVE		"gpd.ta.instanceKeepAlive"
#define TA_PROP_STR_KEEP_CRASHED	"optee.ta.instanceKeepCrashed"
#define TA_PROP_STR_DATA_SIZE		"gpd.ta.dataSize"
#define TA_PROP_STR_STACK_SIZE		"gpd.ta.stackSize"
#define TA_PROP_STR_VERSION		"gpd.ta.version"
#define TA_PROP_STR_DESCRIPTION		"gpd.ta.description"
#define TA_PROP_STR_ENDIAN		"gpd.ta.endian"
#define TA_PROP_STR_DOES_NOT_CLOSE_HANDLE_ON_CORRUPT_OBJECT \
	"gpd.ta.doesNotCloseHandleOnCorruptObject"

enum user_ta_prop_type {
	USER_TA_PROP_TYPE_BOOL,	/* bool */
	USER_TA_PROP_TYPE_U32,	/* uint32_t */
	USER_TA_PROP_TYPE_UUID,	/* TEE_UUID */
	USER_TA_PROP_TYPE_IDENTITY,	/* TEE_Identity */
	USER_TA_PROP_TYPE_STRING,	/* zero terminated string of char */
	USER_TA_PROP_TYPE_BINARY_BLOCK,	/* zero terminated base64 coded string */
	USER_TA_PROP_TYPE_U64,	/* uint64_t */
	USER_TA_PROP_TYPE_INVALID,	/* invalid value */
};

struct user_ta_property {
	const char *name;
	enum user_ta_prop_type type;
	const void *value;
};

extern const struct user_ta_property ta_props[];
extern const size_t ta_num_props;

extern uint8_t __ta_no_share_heap[];
extern const size_t __ta_no_share_heap_size;
/* Needed by TEE_CheckMemoryAccessRights() */
extern uint32_t ta_param_types;
extern TEE_Param ta_params[TEE_NUM_PARAMS];
extern struct malloc_ctx *__ta_no_share_malloc_ctx;

int tahead_get_trace_level(void);

#endif /* USER_TA_HEADER_H */