^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright (c) 2015-2019, Linaro Limited
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) #ifndef OPTEE_SMC_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) #define OPTEE_SMC_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #include <linux/arm-smccc.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #include <linux/bitops.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #define OPTEE_SMC_STD_CALL_VAL(func_num) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) ARM_SMCCC_CALL_VAL(ARM_SMCCC_STD_CALL, ARM_SMCCC_SMC_32, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) ARM_SMCCC_OWNER_TRUSTED_OS, (func_num))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #define OPTEE_SMC_FAST_CALL_VAL(func_num) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, ARM_SMCCC_SMC_32, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) ARM_SMCCC_OWNER_TRUSTED_OS, (func_num))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * Function specified by SMC Calling convention.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define OPTEE_SMC_FUNCID_CALLS_COUNT 0xFF00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define OPTEE_SMC_CALLS_COUNT \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) ARM_SMCCC_CALL_VAL(OPTEE_SMC_FAST_CALL, SMCCC_SMC_32, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) SMCCC_OWNER_TRUSTED_OS_END, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) OPTEE_SMC_FUNCID_CALLS_COUNT)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) * Normal cached memory (write-back), shareable for SMP systems and not
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) * shareable for UP systems.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) #define OPTEE_SMC_SHM_CACHED 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * a0..a7 is used as register names in the descriptions below, on arm32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) * that translates to r0..r7 and on arm64 to w0..w7. In both cases it's
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) * 32-bit registers.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * Function specified by SMC Calling convention
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) * Return one of the following UIDs if using API specified in this file
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * without further extentions:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) * 65cb6b93-af0c-4617-8ed6-644a8d1140f8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) * see also OPTEE_SMC_UID_* in optee_msg.h
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #define OPTEE_SMC_FUNCID_CALLS_UID OPTEE_MSG_FUNCID_CALLS_UID
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) #define OPTEE_SMC_CALLS_UID \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, ARM_SMCCC_SMC_32, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) ARM_SMCCC_OWNER_TRUSTED_OS_END, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) OPTEE_SMC_FUNCID_CALLS_UID)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) * Function specified by SMC Calling convention
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) * Returns 2.0 if using API specified in this file without further extentions.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) * see also OPTEE_MSG_REVISION_* in optee_msg.h
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) #define OPTEE_SMC_FUNCID_CALLS_REVISION OPTEE_MSG_FUNCID_CALLS_REVISION
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) #define OPTEE_SMC_CALLS_REVISION \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, ARM_SMCCC_SMC_32, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) ARM_SMCCC_OWNER_TRUSTED_OS_END, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) OPTEE_SMC_FUNCID_CALLS_REVISION)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) struct optee_smc_calls_revision_result {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) unsigned long major;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) unsigned long minor;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) unsigned long reserved0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) unsigned long reserved1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) * Get UUID of Trusted OS.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) * Used by non-secure world to figure out which Trusted OS is installed.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) * Note that returned UUID is the UUID of the Trusted OS, not of the API.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) * Returns UUID in a0-4 in the same way as OPTEE_SMC_CALLS_UID
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) * described above.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) #define OPTEE_SMC_FUNCID_GET_OS_UUID OPTEE_MSG_FUNCID_GET_OS_UUID
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) #define OPTEE_SMC_CALL_GET_OS_UUID \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) OPTEE_SMC_FAST_CALL_VAL(OPTEE_SMC_FUNCID_GET_OS_UUID)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) * Get revision of Trusted OS.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) * Used by non-secure world to figure out which version of the Trusted OS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) * is installed. Note that the returned revision is the revision of the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) * Trusted OS, not of the API.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) * Returns revision in a0-1 in the same way as OPTEE_SMC_CALLS_REVISION
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) * described above. May optionally return a 32-bit build identifier in a2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) * with zero meaning unspecified.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) #define OPTEE_SMC_FUNCID_GET_OS_REVISION OPTEE_MSG_FUNCID_GET_OS_REVISION
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) #define OPTEE_SMC_CALL_GET_OS_REVISION \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) OPTEE_SMC_FAST_CALL_VAL(OPTEE_SMC_FUNCID_GET_OS_REVISION)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) struct optee_smc_call_get_os_revision_result {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) unsigned long major;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) unsigned long minor;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) unsigned long build_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) unsigned long reserved1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) * Call with struct optee_msg_arg as argument
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) * Call register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) * a0 SMC Function ID, OPTEE_SMC*CALL_WITH_ARG
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) * a1 Upper 32bit of a 64bit physical pointer to a struct optee_msg_arg
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) * a2 Lower 32bit of a 64bit physical pointer to a struct optee_msg_arg
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) * a3 Cache settings, not used if physical pointer is in a predefined shared
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) * memory area else per OPTEE_SMC_SHM_*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) * a4-6 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) * a7 Hypervisor Client ID register
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) * Normal return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) * a0 Return value, OPTEE_SMC_RETURN_*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) * a1-3 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) * a4-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) * OPTEE_SMC_RETURN_ETHREAD_LIMIT return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) * a0 Return value, OPTEE_SMC_RETURN_ETHREAD_LIMIT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) * a1-3 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) * a4-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) * RPC return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) * a0 Return value, OPTEE_SMC_RETURN_IS_RPC(val)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) * a1-2 RPC parameters
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) * a3-7 Resume information, must be preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) * Possible return values:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) * OPTEE_SMC_RETURN_UNKNOWN_FUNCTION Trusted OS does not recognize this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) * function.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) * OPTEE_SMC_RETURN_OK Call completed, result updated in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) * the previously supplied struct
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) * optee_msg_arg.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) * OPTEE_SMC_RETURN_ETHREAD_LIMIT Number of Trusted OS threads exceeded,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) * try again later.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) * OPTEE_SMC_RETURN_EBADADDR Bad physcial pointer to struct
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) * optee_msg_arg.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) * OPTEE_SMC_RETURN_EBADCMD Bad/unknown cmd in struct optee_msg_arg
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) * OPTEE_SMC_RETURN_IS_RPC() Call suspended by RPC call to normal
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) * world.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) #define OPTEE_SMC_FUNCID_CALL_WITH_ARG OPTEE_MSG_FUNCID_CALL_WITH_ARG
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) #define OPTEE_SMC_CALL_WITH_ARG \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) OPTEE_SMC_STD_CALL_VAL(OPTEE_SMC_FUNCID_CALL_WITH_ARG)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) * Get Shared Memory Config
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) * Returns the Secure/Non-secure shared memory config.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) * Call register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) * a0 SMC Function ID, OPTEE_SMC_GET_SHM_CONFIG
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) * a1-6 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) * a7 Hypervisor Client ID register
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) * Have config return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) * a0 OPTEE_SMC_RETURN_OK
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) * a1 Physical address of start of SHM
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) * a2 Size of of SHM
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) * a3 Cache settings of memory, as defined by the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) * OPTEE_SMC_SHM_* values above
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) * a4-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) * Not available register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) * a0 OPTEE_SMC_RETURN_ENOTAVAIL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) * a1-3 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) * a4-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) #define OPTEE_SMC_FUNCID_GET_SHM_CONFIG 7
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) #define OPTEE_SMC_GET_SHM_CONFIG \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) OPTEE_SMC_FAST_CALL_VAL(OPTEE_SMC_FUNCID_GET_SHM_CONFIG)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) struct optee_smc_get_shm_config_result {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) unsigned long status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) unsigned long start;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) unsigned long size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) unsigned long settings;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) * Exchanges capabilities between normal world and secure world
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) * Call register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) * a0 SMC Function ID, OPTEE_SMC_EXCHANGE_CAPABILITIES
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) * a1 bitfield of normal world capabilities OPTEE_SMC_NSEC_CAP_*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) * a2-6 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) * a7 Hypervisor Client ID register
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) * Normal return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) * a0 OPTEE_SMC_RETURN_OK
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) * a1 bitfield of secure world capabilities OPTEE_SMC_SEC_CAP_*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) * a2-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) * Error return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) * a0 OPTEE_SMC_RETURN_ENOTAVAIL, can't use the capabilities from normal world
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) * a1 bitfield of secure world capabilities OPTEE_SMC_SEC_CAP_*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) * a2-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) /* Normal world works as a uniprocessor system */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) #define OPTEE_SMC_NSEC_CAP_UNIPROCESSOR BIT(0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) /* Secure world has reserved shared memory for normal world to use */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) #define OPTEE_SMC_SEC_CAP_HAVE_RESERVED_SHM BIT(0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) /* Secure world can communicate via previously unregistered shared memory */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) #define OPTEE_SMC_SEC_CAP_UNREGISTERED_SHM BIT(1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) * Secure world supports commands "register/unregister shared memory",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) * secure world accepts command buffers located in any parts of non-secure RAM
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) #define OPTEE_SMC_SEC_CAP_DYNAMIC_SHM BIT(2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) /* Secure world supports Shared Memory with a NULL buffer reference */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) #define OPTEE_SMC_SEC_CAP_MEMREF_NULL BIT(4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221) #define OPTEE_SMC_FUNCID_EXCHANGE_CAPABILITIES 9
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) #define OPTEE_SMC_EXCHANGE_CAPABILITIES \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) OPTEE_SMC_FAST_CALL_VAL(OPTEE_SMC_FUNCID_EXCHANGE_CAPABILITIES)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) struct optee_smc_exchange_capabilities_result {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) unsigned long status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) unsigned long capabilities;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) unsigned long reserved0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) unsigned long reserved1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) * Disable and empties cache of shared memory objects
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) * Secure world can cache frequently used shared memory objects, for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) * example objects used as RPC arguments. When secure world is idle this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) * function returns one shared memory reference to free. To disable the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) * cache and free all cached objects this function has to be called until
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) * it returns OPTEE_SMC_RETURN_ENOTAVAIL.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) * Call register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) * a0 SMC Function ID, OPTEE_SMC_DISABLE_SHM_CACHE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) * a1-6 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) * a7 Hypervisor Client ID register
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) * Normal return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) * a0 OPTEE_SMC_RETURN_OK
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) * a1 Upper 32bit of a 64bit Shared memory cookie
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) * a2 Lower 32bit of a 64bit Shared memory cookie
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) * a3-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) * Cache empty return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) * a0 OPTEE_SMC_RETURN_ENOTAVAIL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) * a1-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) * Not idle return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) * a0 OPTEE_SMC_RETURN_EBUSY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) * a1-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) #define OPTEE_SMC_FUNCID_DISABLE_SHM_CACHE 10
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) #define OPTEE_SMC_DISABLE_SHM_CACHE \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) OPTEE_SMC_FAST_CALL_VAL(OPTEE_SMC_FUNCID_DISABLE_SHM_CACHE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) struct optee_smc_disable_shm_cache_result {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) unsigned long status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) unsigned long shm_upper32;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267) unsigned long shm_lower32;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) unsigned long reserved0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) * Enable cache of shared memory objects
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274) * Secure world can cache frequently used shared memory objects, for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) * example objects used as RPC arguments. When secure world is idle this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) * function returns OPTEE_SMC_RETURN_OK and the cache is enabled. If
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) * secure world isn't idle OPTEE_SMC_RETURN_EBUSY is returned.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) * Call register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) * a0 SMC Function ID, OPTEE_SMC_ENABLE_SHM_CACHE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) * a1-6 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) * a7 Hypervisor Client ID register
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) * Normal return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) * a0 OPTEE_SMC_RETURN_OK
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) * a1-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) * Not idle return register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) * a0 OPTEE_SMC_RETURN_EBUSY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) * a1-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) #define OPTEE_SMC_FUNCID_ENABLE_SHM_CACHE 11
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) #define OPTEE_SMC_ENABLE_SHM_CACHE \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) OPTEE_SMC_FAST_CALL_VAL(OPTEE_SMC_FUNCID_ENABLE_SHM_CACHE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) * Resume from RPC (for example after processing a foreign interrupt)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) * Call register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) * a0 SMC Function ID, OPTEE_SMC_CALL_RETURN_FROM_RPC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) * a1-3 Value of a1-3 when OPTEE_SMC_CALL_WITH_ARG returned
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) * OPTEE_SMC_RETURN_RPC in a0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) * Return register usage is the same as for OPTEE_SMC_*CALL_WITH_ARG above.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) * Possible return values
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) * OPTEE_SMC_RETURN_UNKNOWN_FUNCTION Trusted OS does not recognize this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) * function.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) * OPTEE_SMC_RETURN_OK Original call completed, result
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) * updated in the previously supplied.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) * struct optee_msg_arg
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) * OPTEE_SMC_RETURN_RPC Call suspended by RPC call to normal
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313) * world.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) * OPTEE_SMC_RETURN_ERESUME Resume failed, the opaque resume
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) * information was corrupt.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317) #define OPTEE_SMC_FUNCID_RETURN_FROM_RPC 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) #define OPTEE_SMC_CALL_RETURN_FROM_RPC \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319) OPTEE_SMC_STD_CALL_VAL(OPTEE_SMC_FUNCID_RETURN_FROM_RPC)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) #define OPTEE_SMC_RETURN_RPC_PREFIX_MASK 0xFFFF0000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) #define OPTEE_SMC_RETURN_RPC_PREFIX 0xFFFF0000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) #define OPTEE_SMC_RETURN_RPC_FUNC_MASK 0x0000FFFF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) #define OPTEE_SMC_RETURN_GET_RPC_FUNC(ret) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) ((ret) & OPTEE_SMC_RETURN_RPC_FUNC_MASK)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) #define OPTEE_SMC_RPC_VAL(func) ((func) | OPTEE_SMC_RETURN_RPC_PREFIX)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331) * Allocate memory for RPC parameter passing. The memory is used to hold a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332) * struct optee_msg_arg.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) * "Call" register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) * a0 This value, OPTEE_SMC_RETURN_RPC_ALLOC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) * a1 Size in bytes of required argument memory
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) * a2 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338) * a3 Resume information, must be preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) * a4-5 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) * a6-7 Resume information, must be preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) * "Return" register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343) * a0 SMC Function ID, OPTEE_SMC_CALL_RETURN_FROM_RPC.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) * a1 Upper 32bits of 64bit physical pointer to allocated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) * memory, (a1 == 0 && a2 == 0) if size was 0 or if memory can't
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346) * be allocated.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) * a2 Lower 32bits of 64bit physical pointer to allocated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348) * memory, (a1 == 0 && a2 == 0) if size was 0 or if memory can't
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 349) * be allocated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 350) * a3 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 351) * a4 Upper 32bits of 64bit Shared memory cookie used when freeing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 352) * the memory or doing an RPC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 353) * a5 Lower 32bits of 64bit Shared memory cookie used when freeing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 354) * the memory or doing an RPC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 355) * a6-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 356) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 357) #define OPTEE_SMC_RPC_FUNC_ALLOC 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 358) #define OPTEE_SMC_RETURN_RPC_ALLOC \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 359) OPTEE_SMC_RPC_VAL(OPTEE_SMC_RPC_FUNC_ALLOC)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 360)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 361) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 362) * Free memory previously allocated by OPTEE_SMC_RETURN_RPC_ALLOC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 363) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 364) * "Call" register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 365) * a0 This value, OPTEE_SMC_RETURN_RPC_FREE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 366) * a1 Upper 32bits of 64bit shared memory cookie belonging to this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 367) * argument memory
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 368) * a2 Lower 32bits of 64bit shared memory cookie belonging to this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 369) * argument memory
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 370) * a3-7 Resume information, must be preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 371) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 372) * "Return" register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 373) * a0 SMC Function ID, OPTEE_SMC_CALL_RETURN_FROM_RPC.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 374) * a1-2 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 375) * a3-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 376) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 377) #define OPTEE_SMC_RPC_FUNC_FREE 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 378) #define OPTEE_SMC_RETURN_RPC_FREE \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 379) OPTEE_SMC_RPC_VAL(OPTEE_SMC_RPC_FUNC_FREE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 380)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 381) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 382) * Deliver foreign interrupt to normal world.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 383) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 384) * "Call" register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 385) * a0 OPTEE_SMC_RETURN_RPC_FOREIGN_INTR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 386) * a1-7 Resume information, must be preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 387) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 388) * "Return" register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 389) * a0 SMC Function ID, OPTEE_SMC_CALL_RETURN_FROM_RPC.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 390) * a1-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 391) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 392) #define OPTEE_SMC_RPC_FUNC_FOREIGN_INTR 4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 393) #define OPTEE_SMC_RETURN_RPC_FOREIGN_INTR \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 394) OPTEE_SMC_RPC_VAL(OPTEE_SMC_RPC_FUNC_FOREIGN_INTR)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 395)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 396) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 397) * Do an RPC request. The supplied struct optee_msg_arg tells which
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 398) * request to do and the parameters for the request. The following fields
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 399) * are used (the rest are unused):
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 400) * - cmd the Request ID
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 401) * - ret return value of the request, filled in by normal world
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 402) * - num_params number of parameters for the request
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 403) * - params the parameters
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 404) * - param_attrs attributes of the parameters
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 405) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 406) * "Call" register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 407) * a0 OPTEE_SMC_RETURN_RPC_CMD
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 408) * a1 Upper 32bit of a 64bit Shared memory cookie holding a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 409) * struct optee_msg_arg, must be preserved, only the data should
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 410) * be updated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 411) * a2 Lower 32bit of a 64bit Shared memory cookie holding a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 412) * struct optee_msg_arg, must be preserved, only the data should
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 413) * be updated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 414) * a3-7 Resume information, must be preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 415) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 416) * "Return" register usage:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 417) * a0 SMC Function ID, OPTEE_SMC_CALL_RETURN_FROM_RPC.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 418) * a1-2 Not used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 419) * a3-7 Preserved
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 420) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 421) #define OPTEE_SMC_RPC_FUNC_CMD 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 422) #define OPTEE_SMC_RETURN_RPC_CMD \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 423) OPTEE_SMC_RPC_VAL(OPTEE_SMC_RPC_FUNC_CMD)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 424)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 425) /* Returned in a0 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 426) #define OPTEE_SMC_RETURN_UNKNOWN_FUNCTION 0xFFFFFFFF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 427)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 428) /* Returned in a0 only from Trusted OS functions */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 429) #define OPTEE_SMC_RETURN_OK 0x0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 430) #define OPTEE_SMC_RETURN_ETHREAD_LIMIT 0x1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 431) #define OPTEE_SMC_RETURN_EBUSY 0x2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 432) #define OPTEE_SMC_RETURN_ERESUME 0x3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 433) #define OPTEE_SMC_RETURN_EBADADDR 0x4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 434) #define OPTEE_SMC_RETURN_EBADCMD 0x5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 435) #define OPTEE_SMC_RETURN_ENOMEM 0x6
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 436) #define OPTEE_SMC_RETURN_ENOTAVAIL 0x7
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 437) #define OPTEE_SMC_RETURN_IS_RPC(ret) __optee_smc_return_is_rpc((ret))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 438)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 439) static inline bool __optee_smc_return_is_rpc(u32 ret)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 440) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 441) return ret != OPTEE_SMC_RETURN_UNKNOWN_FUNCTION &&
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 442) (ret & OPTEE_SMC_RETURN_RPC_PREFIX_MASK) ==
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 443) OPTEE_SMC_RETURN_RPC_PREFIX;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 444) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 445)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 446) #endif /* OPTEE_SMC_H */