xref: /optee_os/lib/libutee/include/user_ta_header.h (revision 336e32995d9c419d9fc2a6fd5974f99761285415)
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_SINGLE_INSTANCE		(1 << 2)
14 #define TA_FLAG_MULTI_SESSION		(1 << 3)
15 #define TA_FLAG_INSTANCE_KEEP_ALIVE	(1 << 4) /* remains after last close */
16 #define TA_FLAG_SECURE_DATA_PATH	(1 << 5) /* accesses SDP memory */
17 #define TA_FLAG_REMAP_SUPPORT		(1 << 6) /* use map/unmap syscalls */
18 #define TA_FLAG_CACHE_MAINTENANCE	(1 << 7) /* use cache flush syscall */
19 	/*
20 	 * TA instance can execute multiple sessions concurrently
21 	 * (pseudo-TAs only).
22 	 */
23 #define TA_FLAG_CONCURRENT		(1 << 8)
24 #define TA_FLAG_DEVICE_ENUM		(1 << 9) /* device enumeration */
25 
26 #define TA_FLAGS_MASK			GENMASK_32(9, 2)
27 
28 /* Deprecated macros that will be removed in the 3.2 release */
29 #define TA_FLAG_USER_MODE		0
30 #define TA_FLAG_EXEC_DDR		0
31 
32 union ta_head_func_ptr {
33 	uint64_t ptr64;
34 	struct ta_head_func_ptr32 {
35 		uint32_t lo;
36 		uint32_t hi;
37 	} ptr32;
38 };
39 
40 struct ta_head {
41 	TEE_UUID uuid;
42 	uint32_t stack_size;
43 	uint32_t flags;
44 	union ta_head_func_ptr entry;
45 };
46 
47 #define TA_PROP_STR_SINGLE_INSTANCE	"gpd.ta.singleInstance"
48 #define TA_PROP_STR_MULTI_SESSION	"gpd.ta.multiSession"
49 #define TA_PROP_STR_KEEP_ALIVE		"gpd.ta.instanceKeepAlive"
50 #define TA_PROP_STR_DATA_SIZE		"gpd.ta.dataSize"
51 #define TA_PROP_STR_STACK_SIZE		"gpd.ta.stackSize"
52 #define TA_PROP_STR_VERSION		"gpd.ta.version"
53 #define TA_PROP_STR_DESCRIPTION		"gpd.ta.description"
54 #define TA_PROP_STR_UNSAFE_PARAM	"op-tee.unsafe_param"
55 #define TA_PROP_STR_REMAP		"op-tee.remap"
56 #define TA_PROP_STR_CACHE_SYNC		"op-tee.cache_sync"
57 
58 enum user_ta_prop_type {
59 	USER_TA_PROP_TYPE_BOOL,	/* bool */
60 	USER_TA_PROP_TYPE_U32,	/* uint32_t */
61 	USER_TA_PROP_TYPE_UUID,	/* TEE_UUID */
62 	USER_TA_PROP_TYPE_IDENTITY,	/* TEE_Identity */
63 	USER_TA_PROP_TYPE_STRING,	/* zero terminated string of char */
64 	USER_TA_PROP_TYPE_BINARY_BLOCK,	/* zero terminated base64 coded string */
65 };
66 
67 enum user_ta_core_service_id {
68 	USER_TA_CORE_ENTRY_MATH_INIT = 0x00000010,
69 	USER_TA_CORE_ENTRY_GARBAGE = 0x00000011,
70 	USER_TA_CORE_ENTRY_CLOSESESSION = 0x00000012,
71 };
72 
73 struct user_ta_property {
74 	const char *name;
75 	enum user_ta_prop_type type;
76 	const void *value;
77 };
78 
79 extern const struct user_ta_property ta_props[];
80 extern const size_t ta_num_props;
81 
82 /* Needed by TEE_CheckMemoryAccessRights() */
83 extern uint32_t ta_param_types;
84 extern TEE_Param ta_params[TEE_NUM_PARAMS];
85 
86 /* Trusted Application Function header */
87 typedef struct ta_func_head {
88 	uint32_t cmd_id;	/* Trusted Application Function ID */
89 	uint32_t start;		/* offset to start func */
90 } ta_func_head_t;
91 
92 int tahead_get_trace_level(void);
93 
94 #endif /* USER_TA_HEADER_H */
95