xref: /optee_os/lib/libutee/include/user_ta_header.h (revision b02ae382595aa4dab2ce1da826b00bba278e43ee)
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_TA_FTRACE_SUPPORT)
38 #define FTRACE_RETFUNC_DEPTH		50
39 struct __ftrace_info {
40 	uintptr_t buf_start;
41 	uintptr_t buf_end;
42 	uintptr_t ret_ptr;
43 };
44 
45 struct ftrace_buf {
46 	uint64_t ret_func_ptr;	/* __ftrace_return pointer */
47 	uint64_t ret_stack[FTRACE_RETFUNC_DEPTH]; /* Return stack */
48 	uint32_t ret_idx;	/* Return stack index */
49 	uint32_t lr_idx;	/* lr index used for stack unwinding */
50 	uint32_t curr_size;	/* Size of ftrace buffer */
51 	uint32_t max_size;	/* Max allowed size of ftrace buffer */
52 	uint32_t head_off;	/* Ftrace buffer header offset */
53 	uint32_t buf_off;	/* Ftrace buffer offset */
54 };
55 
56 /* Defined by the linker script */
57 extern struct ftrace_buf __ftrace_buf_start;
58 extern uint8_t __ftrace_buf_end[];
59 
60 unsigned long ftrace_return(void);
61 void __ftrace_return(void);
62 #endif
63 
64 #define TA_PROP_STR_SINGLE_INSTANCE	"gpd.ta.singleInstance"
65 #define TA_PROP_STR_MULTI_SESSION	"gpd.ta.multiSession"
66 #define TA_PROP_STR_KEEP_ALIVE		"gpd.ta.instanceKeepAlive"
67 #define TA_PROP_STR_DATA_SIZE		"gpd.ta.dataSize"
68 #define TA_PROP_STR_STACK_SIZE		"gpd.ta.stackSize"
69 #define TA_PROP_STR_VERSION		"gpd.ta.version"
70 #define TA_PROP_STR_DESCRIPTION		"gpd.ta.description"
71 #define TA_PROP_STR_UNSAFE_PARAM	"op-tee.unsafe_param"
72 #define TA_PROP_STR_REMAP		"op-tee.remap"
73 #define TA_PROP_STR_CACHE_SYNC		"op-tee.cache_sync"
74 
75 enum user_ta_prop_type {
76 	USER_TA_PROP_TYPE_BOOL,	/* bool */
77 	USER_TA_PROP_TYPE_U32,	/* uint32_t */
78 	USER_TA_PROP_TYPE_UUID,	/* TEE_UUID */
79 	USER_TA_PROP_TYPE_IDENTITY,	/* TEE_Identity */
80 	USER_TA_PROP_TYPE_STRING,	/* zero terminated string of char */
81 	USER_TA_PROP_TYPE_BINARY_BLOCK,	/* zero terminated base64 coded string */
82 };
83 
84 enum user_ta_core_service_id {
85 	USER_TA_CORE_ENTRY_MATH_INIT = 0x00000010,
86 	USER_TA_CORE_ENTRY_GARBAGE = 0x00000011,
87 	USER_TA_CORE_ENTRY_CLOSESESSION = 0x00000012,
88 };
89 
90 struct user_ta_property {
91 	const char *name;
92 	enum user_ta_prop_type type;
93 	const void *value;
94 };
95 
96 extern const struct user_ta_property ta_props[];
97 extern const size_t ta_num_props;
98 
99 /* Needed by TEE_CheckMemoryAccessRights() */
100 extern uint32_t ta_param_types;
101 extern TEE_Param ta_params[TEE_NUM_PARAMS];
102 
103 /* Trusted Application Function header */
104 typedef struct ta_func_head {
105 	uint32_t cmd_id;	/* Trusted Application Function ID */
106 	uint32_t start;		/* offset to start func */
107 } ta_func_head_t;
108 
109 int tahead_get_trace_level(void);
110 
111 #endif /* USER_TA_HEADER_H */
112