tee/optee/optee_msg.h

1 /* SPDX-License-Identifier: BSD-2-Clause */
3  * Copyright (c) 2015-2018, Linaro Limited
13  * This file defines the OP-TEE message protocol used to communicate with
14  * an instance of OP-TEE running in secure world. This file is based on
15  * https://github.com/OP-TEE/optee_os/blob/master/core/include/optee_msg.h
21  * 3. Requests from secure world, Remote Procedure Call (RPC), handled by
22  *    tee-supplicant.
26  * Part 1 - formatting of messages
43  * Meta parameter to be absorbed by the Secure OS and not passed
51  * Pointer to a list of pages used to register user-defined SHM buffer.
54  * list of page addresses. OP-TEE core can reconstruct contiguous buffer from
66  *   uint64_t pages_array[OPTEE_MSG_NONCONTIG_PAGE_SIZE/sizeof(uint64_t) - 1];
100  * Page size used in non-contiguous buffer entries
105  * struct optee_msg_param_tmem - temporary memory reference parameter
110  * Secure and normal world communicates pointers as physical address
111  * instead of the virtual address. This is because secure and normal world
115  * structure to secure world.
124  * struct optee_msg_param_rmem - registered memory reference parameter
136  * struct optee_msg_param_value - opaque value parameter
138  * Value parameters are passed unchecked between normal and secure world.
147  * struct optee_msg_param - parameter used together with struct optee_msg_arg
169  * struct optee_msg_arg - call argument
209  * OPTEE_MSG_GET_ARG_SIZE - return size of struct optee_msg_arg
221  * Part 2 - requests from normal world
227  * 384fb3e0-e7f8-11e3-af63-0002a5d5c51b.
228  * Represented in 4 32-bit words in OPTEE_MSG_UID_0, OPTEE_MSG_UID_1,
239  * extensions. Represented in 2 32-bit words in OPTEE_MSG_REVISION_MAJOR
249  * Used by non-secure world to figure out which Trusted OS is installed.
252  * Returns UUID in 4 32-bit words in the same way as
264  * Used by non-secure world to figure out which version of the Trusted OS
268  * Returns revision in 2 32-bit words in the same way as
274  * Do a secure call with struct optee_msg_arg as argument
280  * param[0].u.value.a-b uuid of Trusted Application
281  * param[1].u.value.a-b uuid of Client
320  * Part 3 - Requests from secure world, RPC
327  * RPC communication with tee-supplicant is reversed compared to normal
333  * Load a TA into memory, defined in tee-supplicant
343  * File system access, defined in tee-supplicant
351  * 1970-01-01 00:00:00 +0000 (UTC).
359  * Wait queue primitive, helper for secure world to implement a wait queue.
361  * If secure world need to wait for a secure world mutex it issues a sleep
362  * request instead of spinning in secure world. Conversely is a wakeup
363  * request issued when a secure world mutex with a thread waiting thread is
406  *					as in param[n-1].u.tmem.shm_ref)
409 /* Memory that can be shared with a non-secure user space application */
411 /* Memory only shared with non-secure kernel */