| blob | dd7a06ee04629ed5e7daf9f14140ee21cc254670 |
1 /*
2 * Copyright (c) 2015-2016, Linaro Limited
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 #ifndef _OPTEE_MSG_H
28 #define _OPTEE_MSG_H
30 #include <linux/bitops.h>
31 #include <linux/types.h>
33 /*
34 * This file defines the OP-TEE message protocol used to communicate
35 * with an instance of OP-TEE running in secure world.
36 *
37 * This file is divided into three sections.
38 * 1. Formatting of messages.
39 * 2. Requests from normal world
40 * 3. Requests from secure world, Remote Procedure Call (RPC), handled by
41 * tee-supplicant.
42 */
44 /*****************************************************************************
45 * Part 1 - formatting of messages
46 *****************************************************************************/
48 #define OPTEE_MSG_ATTR_TYPE_NONE 0x0
49 #define OPTEE_MSG_ATTR_TYPE_VALUE_INPUT 0x1
50 #define OPTEE_MSG_ATTR_TYPE_VALUE_OUTPUT 0x2
51 #define OPTEE_MSG_ATTR_TYPE_VALUE_INOUT 0x3
52 #define OPTEE_MSG_ATTR_TYPE_RMEM_INPUT 0x5
53 #define OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT 0x6
54 #define OPTEE_MSG_ATTR_TYPE_RMEM_INOUT 0x7
55 #define OPTEE_MSG_ATTR_TYPE_TMEM_INPUT 0x9
56 #define OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT 0xa
57 #define OPTEE_MSG_ATTR_TYPE_TMEM_INOUT 0xb
59 #define OPTEE_MSG_ATTR_TYPE_MASK GENMASK(7, 0)
61 /*
62 * Meta parameter to be absorbed by the Secure OS and not passed
63 * to the Trusted Application.
64 *
65 * Currently only used with OPTEE_MSG_CMD_OPEN_SESSION.
66 */
67 #define OPTEE_MSG_ATTR_META BIT(8)
69 /*
70 * The temporary shared memory object is not physically contigous and this
71 * temp memref is followed by another fragment until the last temp memref
72 * that doesn't have this bit set.
73 */
74 #define OPTEE_MSG_ATTR_FRAGMENT BIT(9)
76 /*
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.
82 */
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
87 /*
88 * Same values as TEE_LOGIN_* from TEE Internal API
89 */
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
97 /**
98 * struct optee_msg_param_tmem - temporary memory reference parameter
99 * @buf_ptr: Address of the buffer
100 * @size: Size of the buffer
101 * @shm_ref: Temporary shared memory reference, pointer to a struct tee_shm
102 *
103 * Secure and normal world communicates pointers as physical address
104 * instead of the virtual address. This is because secure and normal world
105 * have completely independent memory mapping. Normal world can even have a
106 * hypervisor which need to translate the guest physical address (AKA IPA
107 * in ARM documentation) to a real physical address before passing the
108 * structure to secure world.
109 */
111 u64 buf_ptr;
112 u64 size;
113 u64 shm_ref;
114 };
116 /**
117 * struct optee_msg_param_rmem - registered memory reference parameter
118 * @offs: Offset into shared memory reference
119 * @size: Size of the buffer
120 * @shm_ref: Shared memory reference, pointer to a struct tee_shm
121 */
123 u64 offs;
124 u64 size;
125 u64 shm_ref;
126 };
128 /**
129 * struct optee_msg_param_value - opaque value parameter
130 *
131 * Value parameters are passed unchecked between normal and secure world.
132 */
134 u64 a;
135 u64 b;
136 u64 c;
137 };
139 /**
140 * struct optee_msg_param - parameter used together with struct optee_msg_arg
141 * @attr: attributes
142 * @tmem: parameter by temporary memory reference
143 * @rmem: parameter by registered memory reference
144 * @value: parameter by opaque value
145 *
146 * @attr & OPTEE_MSG_ATTR_TYPE_MASK indicates if tmem, rmem or value is used in
147 * the union. OPTEE_MSG_ATTR_TYPE_VALUE_* indicates value,
148 * OPTEE_MSG_ATTR_TYPE_TMEM_* indicates tmem and
149 * OPTEE_MSG_ATTR_TYPE_RMEM_* indicates rmem.
150 * OPTEE_MSG_ATTR_TYPE_NONE indicates that none of the members are used.
151 */
153 u64 attr;
159 };
161 /**
162 * struct optee_msg_arg - call argument
163 * @cmd: Command, one of OPTEE_MSG_CMD_* or OPTEE_MSG_RPC_CMD_*
164 * @func: Trusted Application function, specific to the Trusted Application,
165 * used if cmd == OPTEE_MSG_CMD_INVOKE_COMMAND
166 * @session: In parameter for all OPTEE_MSG_CMD_* except
167 * OPTEE_MSG_CMD_OPEN_SESSION where it's an output parameter instead
168 * @cancel_id: Cancellation id, a unique value to identify this request
169 * @ret: return value
170 * @ret_origin: origin of the return value
171 * @num_params: number of parameters supplied to the OS Command
172 * @params: the parameters supplied to the OS Command
173 *
174 * All normal calls to Trusted OS uses this struct. If cmd requires further
175 * information than what these field holds it can be passed as a parameter
176 * tagged as meta (setting the OPTEE_MSG_ATTR_META bit in corresponding
177 * attrs field). All parameters tagged as meta has to come first.
178 *
179 * Temp memref parameters can be fragmented if supported by the Trusted OS
180 * (when optee_smc.h is bearer of this protocol this is indicated with
181 * OPTEE_SMC_SEC_CAP_UNREGISTERED_SHM). If a logical memref parameter is
182 * fragmented then has all but the last fragment the
183 * OPTEE_MSG_ATTR_FRAGMENT bit set in attrs. Even if a memref is fragmented
184 * it will still be presented as a single logical memref to the Trusted
185 * Application.
186 */
188 u32 cmd;
189 u32 func;
190 u32 session;
191 u32 cancel_id;
192 u32 pad;
193 u32 ret;
194 u32 ret_origin;
195 u32 num_params;
197 /* num_params tells the actual number of element in params */
199 };
201 /**
202 * OPTEE_MSG_GET_ARG_SIZE - return size of struct optee_msg_arg
203 *
204 * @num_params: Number of parameters embedded in the struct optee_msg_arg
205 *
206 * Returns the size of the struct optee_msg_arg together with the number
207 * of embedded parameters.
208 */
209 #define OPTEE_MSG_GET_ARG_SIZE(num_params) \
210 (sizeof(struct optee_msg_arg) + \
211 sizeof(struct optee_msg_param) * (num_params))
213 /*****************************************************************************
214 * Part 2 - requests from normal world
215 *****************************************************************************/
217 /*
218 * Return the following UID if using API specified in this file without
219 * further extensions:
220 * 384fb3e0-e7f8-11e3-af63-0002a5d5c51b.
221 * Represented in 4 32-bit words in OPTEE_MSG_UID_0, OPTEE_MSG_UID_1,
222 * OPTEE_MSG_UID_2, OPTEE_MSG_UID_3.
223 */
224 #define OPTEE_MSG_UID_0 0x384fb3e0
225 #define OPTEE_MSG_UID_1 0xe7f811e3
226 #define OPTEE_MSG_UID_2 0xaf630002
227 #define OPTEE_MSG_UID_3 0xa5d5c51b
228 #define OPTEE_MSG_FUNCID_CALLS_UID 0xFF01
230 /*
231 * Returns 2.0 if using API specified in this file without further
232 * extensions. Represented in 2 32-bit words in OPTEE_MSG_REVISION_MAJOR
233 * and OPTEE_MSG_REVISION_MINOR
234 */
235 #define OPTEE_MSG_REVISION_MAJOR 2
236 #define OPTEE_MSG_REVISION_MINOR 0
237 #define OPTEE_MSG_FUNCID_CALLS_REVISION 0xFF03
239 /*
240 * Get UUID of Trusted OS.
241 *
242 * Used by non-secure world to figure out which Trusted OS is installed.
243 * Note that returned UUID is the UUID of the Trusted OS, not of the API.
244 *
245 * Returns UUID in 4 32-bit words in the same way as
246 * OPTEE_MSG_FUNCID_CALLS_UID described above.
247 */
248 #define OPTEE_MSG_OS_OPTEE_UUID_0 0x486178e0
249 #define OPTEE_MSG_OS_OPTEE_UUID_1 0xe7f811e3
250 #define OPTEE_MSG_OS_OPTEE_UUID_2 0xbc5e0002
251 #define OPTEE_MSG_OS_OPTEE_UUID_3 0xa5d5c51b
252 #define OPTEE_MSG_FUNCID_GET_OS_UUID 0x0000
254 /*
255 * Get revision of Trusted OS.
256 *
257 * Used by non-secure world to figure out which version of the Trusted OS
258 * is installed. Note that the returned revision is the revision of the
259 * Trusted OS, not of the API.
260 *
261 * Returns revision in 2 32-bit words in the same way as
262 * OPTEE_MSG_CALLS_REVISION described above.
263 */
264 #define OPTEE_MSG_FUNCID_GET_OS_REVISION 0x0001
266 /*
267 * Do a secure call with struct optee_msg_arg as argument
268 * The OPTEE_MSG_CMD_* below defines what goes in struct optee_msg_arg::cmd
269 *
270 * OPTEE_MSG_CMD_OPEN_SESSION opens a session to a Trusted Application.
271 * The first two parameters are tagged as meta, holding two value
272 * parameters to pass the following information:
273 * param[0].u.value.a-b uuid of Trusted Application
274 * param[1].u.value.a-b uuid of Client
275 * param[1].u.value.c Login class of client OPTEE_MSG_LOGIN_*
276 *
277 * OPTEE_MSG_CMD_INVOKE_COMMAND invokes a command a previously opened
278 * session to a Trusted Application. struct optee_msg_arg::func is Trusted
279 * Application function, specific to the Trusted Application.
280 *
281 * OPTEE_MSG_CMD_CLOSE_SESSION closes a previously opened session to
282 * Trusted Application.
283 *
284 * OPTEE_MSG_CMD_CANCEL cancels a currently invoked command.
285 *
286 * OPTEE_MSG_CMD_REGISTER_SHM registers a shared memory reference. The
287 * information is passed as:
288 * [in] param[0].attr OPTEE_MSG_ATTR_TYPE_TMEM_INPUT
289 * [| OPTEE_MSG_ATTR_FRAGMENT]
290 * [in] param[0].u.tmem.buf_ptr physical address (of first fragment)
291 * [in] param[0].u.tmem.size size (of first fragment)
292 * [in] param[0].u.tmem.shm_ref holds shared memory reference
293 * ...
294 * The shared memory can optionally be fragmented, temp memrefs can follow
295 * each other with all but the last with the OPTEE_MSG_ATTR_FRAGMENT bit set.
296 *
297 * OPTEE_MSG_CMD_UNREGISTER_SHM unregisteres a previously registered shared
298 * memory reference. The information is passed as:
299 * [in] param[0].attr OPTEE_MSG_ATTR_TYPE_RMEM_INPUT
300 * [in] param[0].u.rmem.shm_ref holds shared memory reference
301 * [in] param[0].u.rmem.offs 0
302 * [in] param[0].u.rmem.size 0
303 */
304 #define OPTEE_MSG_CMD_OPEN_SESSION 0
305 #define OPTEE_MSG_CMD_INVOKE_COMMAND 1
306 #define OPTEE_MSG_CMD_CLOSE_SESSION 2
307 #define OPTEE_MSG_CMD_CANCEL 3
308 #define OPTEE_MSG_CMD_REGISTER_SHM 4
309 #define OPTEE_MSG_CMD_UNREGISTER_SHM 5
310 #define OPTEE_MSG_FUNCID_CALL_WITH_ARG 0x0004
312 /*****************************************************************************
313 * Part 3 - Requests from secure world, RPC
314 *****************************************************************************/
316 /*
317 * All RPC is done with a struct optee_msg_arg as bearer of information,
318 * struct optee_msg_arg::arg holds values defined by OPTEE_MSG_RPC_CMD_* below
319 *
320 * RPC communication with tee-supplicant is reversed compared to normal
321 * client communication desribed above. The supplicant receives requests
322 * and sends responses.
323 */
325 /*
326 * Load a TA into memory, defined in tee-supplicant
327 */
328 #define OPTEE_MSG_RPC_CMD_LOAD_TA 0
330 /*
331 * Reserved
332 */
333 #define OPTEE_MSG_RPC_CMD_RPMB 1
335 /*
336 * File system access, defined in tee-supplicant
337 */
338 #define OPTEE_MSG_RPC_CMD_FS 2
340 /*
341 * Get time
342 *
343 * Returns number of seconds and nano seconds since the Epoch,
344 * 1970-01-01 00:00:00 +0000 (UTC).
345 *
346 * [out] param[0].u.value.a Number of seconds
347 * [out] param[0].u.value.b Number of nano seconds.
348 */
349 #define OPTEE_MSG_RPC_CMD_GET_TIME 3
351 /*
352 * Wait queue primitive, helper for secure world to implement a wait queue.
353 *
354 * If secure world need to wait for a secure world mutex it issues a sleep
355 * request instead of spinning in secure world. Conversely is a wakeup
356 * request issued when a secure world mutex with a thread waiting thread is
357 * unlocked.
358 *
359 * Waiting on a key
360 * [in] param[0].u.value.a OPTEE_MSG_RPC_WAIT_QUEUE_SLEEP
361 * [in] param[0].u.value.b wait key
362 *
363 * Waking up a key
364 * [in] param[0].u.value.a OPTEE_MSG_RPC_WAIT_QUEUE_WAKEUP
365 * [in] param[0].u.value.b wakeup key
366 */
367 #define OPTEE_MSG_RPC_CMD_WAIT_QUEUE 4
368 #define OPTEE_MSG_RPC_WAIT_QUEUE_SLEEP 0
369 #define OPTEE_MSG_RPC_WAIT_QUEUE_WAKEUP 1
371 /*
372 * Suspend execution
373 *
374 * [in] param[0].value .a number of milliseconds to suspend
375 */
376 #define OPTEE_MSG_RPC_CMD_SUSPEND 5
378 /*
379 * Allocate a piece of shared memory
380 *
381 * Shared memory can optionally be fragmented, to support that additional
382 * spare param entries are allocated to make room for eventual fragments.
383 * The spare param entries has .attr = OPTEE_MSG_ATTR_TYPE_NONE when
384 * unused. All returned temp memrefs except the last should have the
385 * OPTEE_MSG_ATTR_FRAGMENT bit set in the attr field.
386 *
387 * [in] param[0].u.value.a type of memory one of
388 * OPTEE_MSG_RPC_SHM_TYPE_* below
389 * [in] param[0].u.value.b requested size
390 * [in] param[0].u.value.c required alignment
391 *
392 * [out] param[0].u.tmem.buf_ptr physical address (of first fragment)
393 * [out] param[0].u.tmem.size size (of first fragment)
394 * [out] param[0].u.tmem.shm_ref shared memory reference
395 * ...
396 * [out] param[n].u.tmem.buf_ptr physical address
397 * [out] param[n].u.tmem.size size
398 * [out] param[n].u.tmem.shm_ref shared memory reference (same value
399 * as in param[n-1].u.tmem.shm_ref)
400 */
401 #define OPTEE_MSG_RPC_CMD_SHM_ALLOC 6
402 /* Memory that can be shared with a non-secure user space application */
403 #define OPTEE_MSG_RPC_SHM_TYPE_APPL 0
404 /* Memory only shared with non-secure kernel */
405 #define OPTEE_MSG_RPC_SHM_TYPE_KERNEL 1
407 /*
408 * Free shared memory previously allocated with OPTEE_MSG_RPC_CMD_SHM_ALLOC
409 *
410 * [in] param[0].u.value.a type of memory one of
411 * OPTEE_MSG_RPC_SHM_TYPE_* above
412 * [in] param[0].u.value.b value of shared memory reference
413 * returned in param[0].u.tmem.shm_ref
414 * above
415 */
416 #define OPTEE_MSG_RPC_CMD_SHM_FREE 7