tee/optee/optee_smc.h

1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) */
3  * Copyright (c) 2015-2021, Linaro Limited
8 #include <linux/arm-smccc.h>
28  * Normal cached memory (write-back), shareable for SMP systems and not
36  * 32-bit registers.
42  * Return the following UID if using API specified in this file
44  * 384fb3e0-e7f8-11e3-af63-0002a5d5c51b.
56  * Returns 2.0 if using API specified in this file without further extensions.
75  * Used by non-secure world to figure out which Trusted OS is installed.
78  * Returns UUID in a0-4 in the same way as OPTEE_SMC_CALLS_UID
88  * Used by non-secure world to figure out which version of the Trusted OS
92  * Returns revision in a0-1 in the same way as OPTEE_SMC_CALLS_REVISION
93  * described above. May optionally return a 32-bit build identifier in a2,
121  * The payload is in the OP-TEE image format.
135  * OPTEE_SMC_CALL_WITH_REGD_ARG in a0 there is one RPC struct optee_msg_arg
136  * following after the first struct optee_msg_arg. The RPC struct
137  * optee_msg_arg has reserved space for the number of RPC parameters as
142  * 2. Non-secure interrupts should not be masked
143  * 3. If asynchronous notifications has been negotiated successfully, then
150  * a1	Upper 32 bits of a 64-bit physical pointer to a struct optee_msg_arg
151  * a2	Lower 32 bits of a 64-bit physical pointer to a struct optee_msg_arg
152  * a3	Cache settings, not used if physical pointer is in a predefined shared
154  * a4-6	Not used
159  * a1	Upper 32 bits of a 64-bit shared memory cookie
160  * a2	Lower 32 bits of a 64-bit shared memory cookie
163  * a4-6	Not used
168  * a1-3	Not used
169  * a4-7	Preserved
173  * a1-3	Preserved
174  * a4-7	Preserved
176  * RPC return register usage:
178  * a1-2	RPC parameters
179  * a3-7	Resume information, must be preserved
192  * OPTEE_SMC_RETURN_IS_RPC()		Call suspended by RPC call to normal
206  * Returns the Secure/Non-secure shared memory config.
210  * a1-6	Not used
219  * a4-7	Preserved
223  * a1-3 Not used
224  * a4-7	Preserved
243  * a2-6	Not used
250  * a3	Bit[7:0]: Number of parameters needed for RPC to be supplied
254  * a4-7	Preserved
259  * a2-7 Preserved
270  * secure world accepts command buffers located in any parts of non-secure RAM
279 /* Secure world supports pre-allocating RPC arg struct */
297  * example objects used as RPC arguments. When secure world is idle this
304  * a1-6	Not used
309  * a1	Upper 32 bits of a 64-bit Shared memory cookie
310  * a2	Lower 32 bits of a 64-bit Shared memory cookie
311  * a3-7	Preserved
315  * a1-7	Preserved
319  * a1-7	Preserved
336  * example objects used as RPC arguments. When secure world is idle this
337  * function returns OPTEE_SMC_RETURN_OK and the cache is enabled. If
342  * a1-6	Not used
347  * a1-7	Preserved
351  * a1-7	Preserved
358  * Query OP-TEE about number of supported threads
361  * threads OP-TEE supports. That is how many standard calls can be issued
362  * in parallel before OP-TEE will return OPTEE_SMC_RETURN_ETHREAD_LIMIT.
366  * a1-6 Not used
372  * a2-7 Preserved
376  * a1-7	Preserved
383  * Inform OP-TEE that normal world is able to receive asynchronous
388  * a1-6	Not used
393  * a1-7	Preserved
397  * a1-7	Preserved
407  * OP-TEE keeps a record of all posted values. When an interrupt is
417  * a1-6	Not used
423  * a2	Bit[0]: OPTEE_SMC_ASYNC_NOTIF_VALUE_VALID if the value in a1 is
424  *		valid, else 0 if no values where pending
425  * a2	Bit[1]: OPTEE_SMC_ASYNC_NOTIF_VALUE_PENDING if another value is
428  * a3-7	Preserved
432  * a1-7	Preserved
438  * Notification that OP-TEE expects a yielding call to do some bottom half
454  * Resume from RPC (for example after processing a foreign interrupt)
458  * a1-3	Value of a1-3 when OPTEE_SMC_CALL_WITH_ARG returned
469  * OPTEE_SMC_RETURN_RPC			Call suspended by RPC call to normal
488  * Allocate memory for RPC parameter passing. The memory is used to hold a
496  * a4-5	Not used
497  * a6-7	Resume information, must be preserved
501  * a1	Upper 32 bits of 64-bit physical pointer to allocated
502  *	memory, (a1 == 0 && a2 == 0) if size was 0 or if memory can't
504  * a2	Lower 32 bits of 64-bit physical pointer to allocated
505  *	memory, (a1 == 0 && a2 == 0) if size was 0 or if memory can't
508  * a4	Upper 32 bits of 64-bit Shared memory cookie used when freeing
509  *	the memory or doing an RPC
510  * a5	Lower 32 bits of 64-bit Shared memory cookie used when freeing
511  *	the memory or doing an RPC
512  * a6-7	Preserved
523  * a1	Upper 32 bits of 64-bit shared memory cookie belonging to this
525  * a2	Lower 32 bits of 64-bit shared memory cookie belonging to this
527  * a3-7	Resume information, must be preserved
531  * a1-2	Not used
532  * a3-7	Preserved
543  * a1-7	Resume information, must be preserved
547  * a1-7	Preserved
554  * Do an RPC request. The supplied struct optee_msg_arg tells which
557  * - cmd		the Request ID
558  * - ret		return value of the request, filled in by normal world
559  * - num_params		number of parameters for the request
560  * - params		the parameters
561  * - param_attrs	attributes of the parameters
565  * a1	Upper 32 bits of a 64-bit Shared memory cookie holding a
568  * a2	Lower 32 bits of a 64-bit Shared memory cookie holding a
571  * a3-7	Resume information, must be preserved
575  * a1-2	Not used
576  * a3-7	Preserved