1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) */
3 * Copyright (c) 2015-2021, Linaro Limited
8 #include <linux/bitops.h>
9 #include <linux/types.h>
12 * This file defines the OP-TEE message protocol (ABI) used to communicate
13 * with an instance of OP-TEE running in secure world.
15 * This file is divided into two sections.
16 * 1. Formatting of messages.
17 * 2. Requests from normal world
20 /*****************************************************************************
21 * Part 1 - formatting of messages
22 *****************************************************************************/
24 #define OPTEE_MSG_ATTR_TYPE_NONE 0x0
25 #define OPTEE_MSG_ATTR_TYPE_VALUE_INPUT 0x1
26 #define OPTEE_MSG_ATTR_TYPE_VALUE_OUTPUT 0x2
27 #define OPTEE_MSG_ATTR_TYPE_VALUE_INOUT 0x3
28 #define OPTEE_MSG_ATTR_TYPE_RMEM_INPUT 0x5
29 #define OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT 0x6
30 #define OPTEE_MSG_ATTR_TYPE_RMEM_INOUT 0x7
31 #define OPTEE_MSG_ATTR_TYPE_FMEM_INPUT OPTEE_MSG_ATTR_TYPE_RMEM_INPUT
32 #define OPTEE_MSG_ATTR_TYPE_FMEM_OUTPUT OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT
33 #define OPTEE_MSG_ATTR_TYPE_FMEM_INOUT OPTEE_MSG_ATTR_TYPE_RMEM_INOUT
34 #define OPTEE_MSG_ATTR_TYPE_TMEM_INPUT 0x9
35 #define OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT 0xa
36 #define OPTEE_MSG_ATTR_TYPE_TMEM_INOUT 0xb
38 #define OPTEE_MSG_ATTR_TYPE_MASK GENMASK(7, 0)
41 * Meta parameter to be absorbed by the Secure OS and not passed
42 * to the Trusted Application.
44 * Currently only used with OPTEE_MSG_CMD_OPEN_SESSION.
46 #define OPTEE_MSG_ATTR_META BIT(8)
49 * Pointer to a list of pages used to register user-defined SHM buffer.
50 * Used with OPTEE_MSG_ATTR_TYPE_TMEM_*.
51 * buf_ptr should point to the beginning of the buffer. Buffer will contain
52 * list of page addresses. OP-TEE core can reconstruct contiguous buffer from
53 * that page addresses list. Page addresses are stored as 64 bit values.
54 * Last entry on a page should point to the next page of buffer.
55 * Every entry in buffer should point to a 4k page beginning (12 least
56 * significant bits must be equal to zero).
58 * 12 least significant bits of optee_msg_param.u.tmem.buf_ptr should hold
59 * page offset of user buffer.
61 * So, entries should be placed like members of this structure:
64 * uint64_t pages_array[OPTEE_MSG_NONCONTIG_PAGE_SIZE/sizeof(uint64_t) - 1];
65 * uint64_t next_page_data;
68 * Structure is designed to exactly fit into the page size
69 * OPTEE_MSG_NONCONTIG_PAGE_SIZE which is a standard 4KB page.
71 * The size of 4KB is chosen because this is the smallest page size for ARM
72 * architectures. If REE uses larger pages, it should divide them to 4KB ones.
74 #define OPTEE_MSG_ATTR_NONCONTIG BIT(9)
77 * Memory attributes for caching passed with temp memrefs. The actual value
78 * used is defined outside the message protocol with the exception of
79 * OPTEE_MSG_ATTR_CACHE_PREDEFINED which means the attributes already
80 * defined for the memory range should be used. If optee_smc.h is used as
81 * bearer of this protocol OPTEE_SMC_SHM_* is used for values.
83 #define OPTEE_MSG_ATTR_CACHE_SHIFT 16
84 #define OPTEE_MSG_ATTR_CACHE_MASK GENMASK(2, 0)
85 #define OPTEE_MSG_ATTR_CACHE_PREDEFINED 0
88 * Same values as TEE_LOGIN_* from TEE Internal API
90 #define OPTEE_MSG_LOGIN_PUBLIC 0x00000000
91 #define OPTEE_MSG_LOGIN_USER 0x00000001
92 #define OPTEE_MSG_LOGIN_GROUP 0x00000002
93 #define OPTEE_MSG_LOGIN_APPLICATION 0x00000004
94 #define OPTEE_MSG_LOGIN_APPLICATION_USER 0x00000005
95 #define OPTEE_MSG_LOGIN_APPLICATION_GROUP 0x00000006
98 * Page size used in non-contiguous buffer entries
100 #define OPTEE_MSG_NONCONTIG_PAGE_SIZE 4096
102 #define OPTEE_MSG_FMEM_INVALID_GLOBAL_ID 0xffffffffffffffff
105 * struct optee_msg_param_tmem - temporary memory reference parameter
106 * @buf_ptr: Address of the buffer
107 * @size: Size of the buffer
108 * @shm_ref: Temporary shared memory reference, pointer to a struct tee_shm
110 * Secure and normal world communicates pointers as physical address
111 * instead of the virtual address. This is because secure and normal world
112 * have completely independent memory mapping. Normal world can even have a
113 * hypervisor which need to translate the guest physical address (AKA IPA
114 * in ARM documentation) to a real physical address before passing the
115 * structure to secure world.
117 struct optee_msg_param_tmem {
124 * struct optee_msg_param_rmem - registered memory reference parameter
125 * @offs: Offset into shared memory reference
126 * @size: Size of the buffer
127 * @shm_ref: Shared memory reference, pointer to a struct tee_shm
129 struct optee_msg_param_rmem {
136 * struct optee_msg_param_fmem - ffa memory reference parameter
137 * @offs_lower: Lower bits of offset into shared memory reference
138 * @offs_upper: Upper bits of offset into shared memory reference
139 * @internal_offs: Internal offset into the first page of shared memory
141 * @size: Size of the buffer
142 * @global_id: Global identifier of Shared memory
144 struct optee_msg_param_fmem {
153 * struct optee_msg_param_value - opaque value parameter
155 * Value parameters are passed unchecked between normal and secure world.
157 struct optee_msg_param_value {
164 * struct optee_msg_param - parameter used together with struct optee_msg_arg
166 * @tmem: parameter by temporary memory reference
167 * @rmem: parameter by registered memory reference
168 * @fmem: parameter by ffa registered memory reference
169 * @value: parameter by opaque value
170 * @octets: parameter by octet string
172 * @attr & OPTEE_MSG_ATTR_TYPE_MASK indicates if tmem, rmem or value is used in
173 * the union. OPTEE_MSG_ATTR_TYPE_VALUE_* indicates value or octets,
174 * OPTEE_MSG_ATTR_TYPE_TMEM_* indicates @tmem and
175 * OPTEE_MSG_ATTR_TYPE_RMEM_* or the alias PTEE_MSG_ATTR_TYPE_FMEM_* indicates
176 * @rmem or @fmem depending on the conduit.
177 * OPTEE_MSG_ATTR_TYPE_NONE indicates that none of the members are used.
179 struct optee_msg_param {
182 struct optee_msg_param_tmem tmem;
183 struct optee_msg_param_rmem rmem;
184 struct optee_msg_param_fmem fmem;
185 struct optee_msg_param_value value;
191 * struct optee_msg_arg - call argument
192 * @cmd: Command, one of OPTEE_MSG_CMD_* or OPTEE_MSG_RPC_CMD_*
193 * @func: Trusted Application function, specific to the Trusted Application,
194 * used if cmd == OPTEE_MSG_CMD_INVOKE_COMMAND
195 * @session: In parameter for all OPTEE_MSG_CMD_* except
196 * OPTEE_MSG_CMD_OPEN_SESSION where it's an output parameter instead
197 * @cancel_id: Cancellation id, a unique value to identify this request
199 * @ret_origin: origin of the return value
200 * @num_params: number of parameters supplied to the OS Command
201 * @params: the parameters supplied to the OS Command
203 * All normal calls to Trusted OS uses this struct. If cmd requires further
204 * information than what these fields hold it can be passed as a parameter
205 * tagged as meta (setting the OPTEE_MSG_ATTR_META bit in corresponding
206 * attrs field). All parameters tagged as meta have to come first.
208 struct optee_msg_arg {
218 /* num_params tells the actual number of element in params */
219 struct optee_msg_param params[];
223 * OPTEE_MSG_GET_ARG_SIZE - return size of struct optee_msg_arg
225 * @num_params: Number of parameters embedded in the struct optee_msg_arg
227 * Returns the size of the struct optee_msg_arg together with the number
228 * of embedded parameters.
230 #define OPTEE_MSG_GET_ARG_SIZE(num_params) \
231 (sizeof(struct optee_msg_arg) + \
232 sizeof(struct optee_msg_param) * (num_params))
234 /*****************************************************************************
235 * Part 2 - requests from normal world
236 *****************************************************************************/
239 * Return the following UID if using API specified in this file without
240 * further extensions:
241 * 384fb3e0-e7f8-11e3-af63-0002a5d5c51b.
242 * Represented in 4 32-bit words in OPTEE_MSG_UID_0, OPTEE_MSG_UID_1,
243 * OPTEE_MSG_UID_2, OPTEE_MSG_UID_3.
245 #define OPTEE_MSG_UID_0 0x384fb3e0
246 #define OPTEE_MSG_UID_1 0xe7f811e3
247 #define OPTEE_MSG_UID_2 0xaf630002
248 #define OPTEE_MSG_UID_3 0xa5d5c51b
249 #define OPTEE_MSG_FUNCID_CALLS_UID 0xFF01
252 * Returns 2.0 if using API specified in this file without further
253 * extensions. Represented in 2 32-bit words in OPTEE_MSG_REVISION_MAJOR
254 * and OPTEE_MSG_REVISION_MINOR
256 #define OPTEE_MSG_REVISION_MAJOR 2
257 #define OPTEE_MSG_REVISION_MINOR 0
258 #define OPTEE_MSG_FUNCID_CALLS_REVISION 0xFF03
261 * Get UUID of Trusted OS.
263 * Used by non-secure world to figure out which Trusted OS is installed.
264 * Note that returned UUID is the UUID of the Trusted OS, not of the API.
266 * Returns UUID in 4 32-bit words in the same way as
267 * OPTEE_MSG_FUNCID_CALLS_UID described above.
269 #define OPTEE_MSG_OS_OPTEE_UUID_0 0x486178e0
270 #define OPTEE_MSG_OS_OPTEE_UUID_1 0xe7f811e3
271 #define OPTEE_MSG_OS_OPTEE_UUID_2 0xbc5e0002
272 #define OPTEE_MSG_OS_OPTEE_UUID_3 0xa5d5c51b
273 #define OPTEE_MSG_FUNCID_GET_OS_UUID 0x0000
276 * Get revision of Trusted OS.
278 * Used by non-secure world to figure out which version of the Trusted OS
279 * is installed. Note that the returned revision is the revision of the
280 * Trusted OS, not of the API.
282 * Returns revision in 2 32-bit words in the same way as
283 * OPTEE_MSG_CALLS_REVISION described above.
285 #define OPTEE_MSG_FUNCID_GET_OS_REVISION 0x0001
288 * Do a secure call with struct optee_msg_arg as argument
289 * The OPTEE_MSG_CMD_* below defines what goes in struct optee_msg_arg::cmd
291 * OPTEE_MSG_CMD_OPEN_SESSION opens a session to a Trusted Application.
292 * The first two parameters are tagged as meta, holding two value
293 * parameters to pass the following information:
294 * param[0].u.value.a-b uuid of Trusted Application
295 * param[1].u.value.a-b uuid of Client
296 * param[1].u.value.c Login class of client OPTEE_MSG_LOGIN_*
298 * OPTEE_MSG_CMD_INVOKE_COMMAND invokes a command a previously opened
299 * session to a Trusted Application. struct optee_msg_arg::func is Trusted
300 * Application function, specific to the Trusted Application.
302 * OPTEE_MSG_CMD_CLOSE_SESSION closes a previously opened session to
303 * Trusted Application.
305 * OPTEE_MSG_CMD_CANCEL cancels a currently invoked command.
307 * OPTEE_MSG_CMD_REGISTER_SHM registers a shared memory reference. The
308 * information is passed as:
309 * [in] param[0].attr OPTEE_MSG_ATTR_TYPE_TMEM_INPUT
310 * [| OPTEE_MSG_ATTR_NONCONTIG]
311 * [in] param[0].u.tmem.buf_ptr physical address (of first fragment)
312 * [in] param[0].u.tmem.size size (of first fragment)
313 * [in] param[0].u.tmem.shm_ref holds shared memory reference
315 * OPTEE_MSG_CMD_UNREGISTER_SHM unregisters a previously registered shared
316 * memory reference. The information is passed as:
317 * [in] param[0].attr OPTEE_MSG_ATTR_TYPE_RMEM_INPUT
318 * [in] param[0].u.rmem.shm_ref holds shared memory reference
319 * [in] param[0].u.rmem.offs 0
320 * [in] param[0].u.rmem.size 0
322 * OPTEE_MSG_CMD_DO_BOTTOM_HALF does the scheduled bottom half processing
325 * OPTEE_MSG_CMD_STOP_ASYNC_NOTIF informs secure world that from now is
326 * normal world unable to process asynchronous notifications. Typically
327 * used when the driver is shut down.
329 #define OPTEE_MSG_CMD_OPEN_SESSION 0
330 #define OPTEE_MSG_CMD_INVOKE_COMMAND 1
331 #define OPTEE_MSG_CMD_CLOSE_SESSION 2
332 #define OPTEE_MSG_CMD_CANCEL 3
333 #define OPTEE_MSG_CMD_REGISTER_SHM 4
334 #define OPTEE_MSG_CMD_UNREGISTER_SHM 5
335 #define OPTEE_MSG_CMD_DO_BOTTOM_HALF 6
336 #define OPTEE_MSG_CMD_STOP_ASYNC_NOTIF 7
337 #define OPTEE_MSG_FUNCID_CALL_WITH_ARG 0x0004
339 #endif /* _OPTEE_MSG_H */