xref: /optee_os/lib/libutee/include/user_ta_header.h (revision 0d77037f5943c86560dd7c8f473fbc6a55d60a34)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2014, STMicroelectronics International N.V.
4  * Copyright (c) 2018, Linaro Limited.
5  */
6 
7 #ifndef USER_TA_HEADER_H
8 #define USER_TA_HEADER_H
9 
10 #include <tee_api_types.h>
11 #include <util.h>
12 
13 #define TA_FLAG_USER_MODE		0	 /* Deprecated, was (1 << 0) */
14 #define TA_FLAG_EXEC_DDR		0	 /* Deprecated, was (1 << 1) */
15 #define TA_FLAG_SINGLE_INSTANCE		(1 << 2)
16 #define TA_FLAG_MULTI_SESSION		(1 << 3)
17 #define TA_FLAG_INSTANCE_KEEP_ALIVE	(1 << 4) /* remains after last close */
18 #define TA_FLAG_SECURE_DATA_PATH	(1 << 5) /* accesses SDP memory */
19 #define TA_FLAG_REMAP_SUPPORT		0	 /* Deprecated, was (1 << 6) */
20 #define TA_FLAG_CACHE_MAINTENANCE	(1 << 7) /* use cache flush syscall */
21 	/*
22 	 * TA instance can execute multiple sessions concurrently
23 	 * (pseudo-TAs only).
24 	 */
25 #define TA_FLAG_CONCURRENT		(1 << 8)
26 #define TA_FLAG_DEVICE_ENUM		(1 << 9) /* device enumeration */
27 
28 #define TA_FLAGS_MASK			GENMASK_32(9, 0)
29 
30 struct ta_head {
31 	TEE_UUID uuid;
32 	uint32_t stack_size;
33 	uint32_t flags;
34 	uint64_t depr_entry;
35 };
36 
37 #if defined(CFG_FTRACE_SUPPORT)
38 #define FTRACE_RETFUNC_DEPTH		50
39 union compat_ptr {
40 	uint64_t ptr64;
41 	struct {
42 		uint32_t lo;
43 		uint32_t hi;
44 	} ptr32;
45 };
46 
47 struct __ftrace_info {
48 	union compat_ptr buf_start;
49 	union compat_ptr buf_end;
50 	union compat_ptr ret_ptr;
51 };
52 
53 struct ftrace_buf {
54 	uint64_t ret_func_ptr;	/* __ftrace_return pointer */
55 	uint64_t ret_stack[FTRACE_RETFUNC_DEPTH]; /* Return stack */
56 	uint32_t ret_idx;	/* Return stack index */
57 	uint32_t lr_idx;	/* lr index used for stack unwinding */
58 	uint64_t begin_time[FTRACE_RETFUNC_DEPTH]; /* Timestamp */
59 	uint64_t suspend_time;	/* Suspend timestamp */
60 	uint32_t curr_size;	/* Size of ftrace buffer */
61 	uint32_t max_size;	/* Max allowed size of ftrace buffer */
62 	uint32_t head_off;	/* Ftrace buffer header offset */
63 	uint32_t buf_off;	/* Ftrace buffer offset */
64 	bool syscall_trace_enabled; /* Some syscalls are never traced */
65 	bool syscall_trace_suspended; /* By foreign interrupt or RPC */
66 };
67 
68 /* Defined by the linker script */
69 extern struct ftrace_buf __ftrace_buf_start;
70 extern uint8_t __ftrace_buf_end[];
71 
72 unsigned long ftrace_return(void);
73 void __ftrace_return(void);
74 #endif
75 
76 #define TA_PROP_STR_SINGLE_INSTANCE	"gpd.ta.singleInstance"
77 #define TA_PROP_STR_MULTI_SESSION	"gpd.ta.multiSession"
78 #define TA_PROP_STR_KEEP_ALIVE		"gpd.ta.instanceKeepAlive"
79 #define TA_PROP_STR_DATA_SIZE		"gpd.ta.dataSize"
80 #define TA_PROP_STR_STACK_SIZE		"gpd.ta.stackSize"
81 #define TA_PROP_STR_VERSION		"gpd.ta.version"
82 #define TA_PROP_STR_DESCRIPTION		"gpd.ta.description"
83 #define TA_PROP_STR_UNSAFE_PARAM	"op-tee.unsafe_param"
84 #define TA_PROP_STR_REMAP		"op-tee.remap"
85 #define TA_PROP_STR_CACHE_SYNC		"op-tee.cache_sync"
86 
87 enum user_ta_prop_type {
88 	USER_TA_PROP_TYPE_BOOL,	/* bool */
89 	USER_TA_PROP_TYPE_U32,	/* uint32_t */
90 	USER_TA_PROP_TYPE_UUID,	/* TEE_UUID */
91 	USER_TA_PROP_TYPE_IDENTITY,	/* TEE_Identity */
92 	USER_TA_PROP_TYPE_STRING,	/* zero terminated string of char */
93 	USER_TA_PROP_TYPE_BINARY_BLOCK,	/* zero terminated base64 coded string */
94 };
95 
96 enum user_ta_core_service_id {
97 	USER_TA_CORE_ENTRY_MATH_INIT = 0x00000010,
98 	USER_TA_CORE_ENTRY_GARBAGE = 0x00000011,
99 	USER_TA_CORE_ENTRY_CLOSESESSION = 0x00000012,
100 };
101 
102 struct user_ta_property {
103 	const char *name;
104 	enum user_ta_prop_type type;
105 	const void *value;
106 };
107 
108 extern const struct user_ta_property ta_props[];
109 extern const size_t ta_num_props;
110 
111 /* Needed by TEE_CheckMemoryAccessRights() */
112 extern uint32_t ta_param_types;
113 extern TEE_Param ta_params[TEE_NUM_PARAMS];
114 
115 /* Trusted Application Function header */
116 typedef struct ta_func_head {
117 	uint32_t cmd_id;	/* Trusted Application Function ID */
118 	uint32_t start;		/* offset to start func */
119 } ta_func_head_t;
120 
121 int tahead_get_trace_level(void);
122 
123 #endif /* USER_TA_HEADER_H */
124