xref: /optee_os/lib/libutee/include/user_ta_header.h (revision bc420748bfc44a9e09000a3966fc59e9e0219df4)
1 /*
2  * Copyright (c) 2014, STMicroelectronics International N.V.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef USER_TA_HEADER_H
29 #define USER_TA_HEADER_H
30 
31 #include <tee_api_types.h>
32 
33 
34 #define TA_FLAG_USER_MODE		(1 << 0)
35 #define TA_FLAG_EXEC_DDR		(1 << 1)
36 #define TA_FLAG_SINGLE_INSTANCE		(1 << 2)
37 #define TA_FLAG_MULTI_SESSION		(1 << 3)
38 #define TA_FLAG_INSTANCE_KEEP_ALIVE	(1 << 4) /* remains after last close */
39 /*
40  * TA_FLAG_UNSAFE_NW_PARAMS: May manipulate some secure memory based on
41  * physical pointers from non-secure world
42  */
43 #define TA_FLAG_UNSAFE_NW_PARAMS	(1 << 5)
44 #define TA_FLAG_REMAP_SUPPORT		(1 << 6) /* use map/unmap syscalls */
45 #define TA_FLAG_CACHE_MAINTENANCE	(1 << 7) /* use cache flush syscall */
46 
47 struct ta_head {
48 	TEE_UUID uuid;
49 	uint32_t stack_size;
50 	uint32_t flags;
51 	uint32_t open_session;
52 	uint32_t close_session;
53 	uint32_t invoke_command;
54 };
55 
56 #define TA_PROP_STR_SINGLE_INSTANCE	"gpd.ta.singleInstance"
57 #define TA_PROP_STR_MULTI_SESSION	"gpd.ta.multiSession"
58 #define TA_PROP_STR_KEEP_ALIVE		"gpd.ta.instanceKeepAlive"
59 #define TA_PROP_STR_DATA_SIZE		"gpd.ta.dataSize"
60 #define TA_PROP_STR_STACK_SIZE		"gpd.ta.stackSize"
61 #define TA_PROP_STR_VERSION		"gpd.ta.version"
62 #define TA_PROP_STR_DESCRIPTION		"gpd.ta.description"
63 #define TA_PROP_STR_UNSAFE_PARAM	"op-tee.unsafe_param"
64 #define TA_PROP_STR_REMAP		"op-tee.remap"
65 #define TA_PROP_STR_CACHE_SYNC		"op-tee.cache_sync"
66 
67 enum user_ta_prop_type {
68 	USER_TA_PROP_TYPE_BOOL,	/* bool */
69 	USER_TA_PROP_TYPE_U32,	/* uint32_t */
70 	USER_TA_PROP_TYPE_UUID,	/* TEE_UUID */
71 	USER_TA_PROP_TYPE_IDENTITY,	/* TEE_Identity */
72 	USER_TA_PROP_TYPE_STRING,	/* zero terminated string of char */
73 	USER_TA_PROP_TYPE_BINARY_BLOCK,	/* zero terminated base64 coded string */
74 };
75 
76 enum user_ta_core_service_id {
77 	USER_TA_CORE_ENTRY_MATH_INIT = 0x00000010,
78 	USER_TA_CORE_ENTRY_GARBAGE = 0x00000011,
79 	USER_TA_CORE_ENTRY_CLOSESESSION = 0x00000012,
80 };
81 
82 struct user_ta_property {
83 	const char *name;
84 	enum user_ta_prop_type type;
85 	const void *value;
86 };
87 
88 extern const struct user_ta_property ta_props[];
89 extern const size_t ta_num_props;
90 
91 /* Needed by TEE_CheckMemoryAccessRights() */
92 extern uint32_t ta_param_types;
93 extern TEE_Param ta_params[4];
94 
95 /* Trusted Application Function header */
96 typedef struct ta_func_head {
97 	uint32_t cmd_id;	/* Trusted Application Function ID */
98 	uint32_t start;		/* offset to start func */
99 } ta_func_head_t;
100 
101 typedef struct {
102 	/* Same Prefix as ta_head_t */
103 	TEE_UUID uuid;
104 	const char *name;
105 	uint32_t flags;
106 
107 	/* properties */
108 	uint32_t prop_datasize;
109 	uint32_t prop_stacksize;
110 	uint32_t prop_tracelevel;
111 
112 	const ta_func_head_t *funcs;
113 	uint32_t nbr_func;
114 	 TEE_Result(*create_entry_point) (void);
115 	void (*destroy_entry_point) (void);
116 	 TEE_Result(*open_session_entry_point) (uint32_t nParamTypes,
117 					     TEE_Param pParams[4],
118 					     void **ppSessionContext);
119 	void (*close_session_entry_point) (void *pSessionContext);
120 	 TEE_Result(*invoke_command_entry_point) (void *pSessionContext,
121 					       uint32_t nCommandID,
122 					       uint32_t nParamTypes,
123 					       TEE_Param pParams[4]);
124 	 TEE_Result(*core_entries) (uint32_t nServiceId, uint32_t nParamTypes,
125 				   TEE_Param pParam[4]);
126 } ta_static_head_t;
127 
128 int tahead_get_trace_level(void);
129 
130 #endif /* USER_TA_HEADER_H */
131