1/* SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) */ 2/* 3 * Copyright (c) 2015-2019, Linaro Limited 4 */ 5#ifndef _OPTEE_MSG_H 6#define _OPTEE_MSG_H 7 8#include <linux/bitops.h> 9#include <linux/types.h> 10 11/* 12 * This file defines the OP-TEE message protocol (ABI) used to communicate 13 * with an instance of OP-TEE running in secure world. 14 * 15 * This file is divided into three sections. 16 * 1. Formatting of messages. 17 * 2. Requests from normal world 18 * 3. Requests from secure world, Remote Procedure Call (RPC), handled by 19 * tee-supplicant. 20 */ 21 22/***************************************************************************** 23 * Part 1 - formatting of messages 24 *****************************************************************************/ 25 26#define OPTEE_MSG_ATTR_TYPE_NONE 0x0 27#define OPTEE_MSG_ATTR_TYPE_VALUE_INPUT 0x1 28#define OPTEE_MSG_ATTR_TYPE_VALUE_OUTPUT 0x2 29#define OPTEE_MSG_ATTR_TYPE_VALUE_INOUT 0x3 30#define OPTEE_MSG_ATTR_TYPE_RMEM_INPUT 0x5 31#define OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT 0x6 32#define OPTEE_MSG_ATTR_TYPE_RMEM_INOUT 0x7 33#define OPTEE_MSG_ATTR_TYPE_TMEM_INPUT 0x9 34#define OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT 0xa 35#define OPTEE_MSG_ATTR_TYPE_TMEM_INOUT 0xb 36 37#define OPTEE_MSG_ATTR_TYPE_MASK GENMASK(7, 0) 38 39/* 40 * Meta parameter to be absorbed by the Secure OS and not passed 41 * to the Trusted Application. 42 * 43 * Currently only used with OPTEE_MSG_CMD_OPEN_SESSION. 44 */ 45#define OPTEE_MSG_ATTR_META BIT(8) 46 47/* 48 * Pointer to a list of pages used to register user-defined SHM buffer. 49 * Used with OPTEE_MSG_ATTR_TYPE_TMEM_*. 50 * buf_ptr should point to the beginning of the buffer. Buffer will contain 51 * list of page addresses. OP-TEE core can reconstruct contiguous buffer from 52 * that page addresses list. Page addresses are stored as 64 bit values. 53 * Last entry on a page should point to the next page of buffer. 54 * Every entry in buffer should point to a 4k page beginning (12 least 55 * significant bits must be equal to zero). 56 * 57 * 12 least significant bints of optee_msg_param.u.tmem.buf_ptr should hold page 58 * offset of the user buffer. 59 * 60 * So, entries should be placed like members of this structure: 61 * 62 * struct page_data { 63 * uint64_t pages_array[OPTEE_MSG_NONCONTIG_PAGE_SIZE/sizeof(uint64_t) - 1]; 64 * uint64_t next_page_data; 65 * }; 66 * 67 * Structure is designed to exactly fit into the page size 68 * OPTEE_MSG_NONCONTIG_PAGE_SIZE which is a standard 4KB page. 69 * 70 * The size of 4KB is chosen because this is the smallest page size for ARM 71 * architectures. If REE uses larger pages, it should divide them to 4KB ones. 72 */ 73#define OPTEE_MSG_ATTR_NONCONTIG BIT(9) 74 75/* 76 * Memory attributes for caching passed with temp memrefs. The actual value 77 * used is defined outside the message protocol with the exception of 78 * OPTEE_MSG_ATTR_CACHE_PREDEFINED which means the attributes already 79 * defined for the memory range should be used. If optee_smc.h is used as 80 * bearer of this protocol OPTEE_SMC_SHM_* is used for values. 81 */ 82#define OPTEE_MSG_ATTR_CACHE_SHIFT 16 83#define OPTEE_MSG_ATTR_CACHE_MASK GENMASK(2, 0) 84#define OPTEE_MSG_ATTR_CACHE_PREDEFINED 0 85 86/* 87 * Same values as TEE_LOGIN_* from TEE Internal API 88 */ 89#define OPTEE_MSG_LOGIN_PUBLIC 0x00000000 90#define OPTEE_MSG_LOGIN_USER 0x00000001 91#define OPTEE_MSG_LOGIN_GROUP 0x00000002 92#define OPTEE_MSG_LOGIN_APPLICATION 0x00000004 93#define OPTEE_MSG_LOGIN_APPLICATION_USER 0x00000005 94#define OPTEE_MSG_LOGIN_APPLICATION_GROUP 0x00000006 95 96/* 97 * Page size used in non-contiguous buffer entries 98 */ 99#define OPTEE_MSG_NONCONTIG_PAGE_SIZE 4096 100 101/** 102 * struct optee_msg_param_tmem - temporary memory reference parameter 103 * @buf_ptr: Address of the buffer 104 * @size: Size of the buffer 105 * @shm_ref: Temporary shared memory reference, pointer to a struct tee_shm 106 * 107 * Secure and normal world communicates pointers as physical address 108 * instead of the virtual address. This is because secure and normal world 109 * have completely independent memory mapping. Normal world can even have a 110 * hypervisor which need to translate the guest physical address (AKA IPA 111 * in ARM documentation) to a real physical address before passing the 112 * structure to secure world. 113 */ 114struct optee_msg_param_tmem { 115 u64 buf_ptr; 116 u64 size; 117 u64 shm_ref; 118}; 119 120/** 121 * struct optee_msg_param_rmem - registered memory reference parameter 122 * @offs: Offset into shared memory reference 123 * @size: Size of the buffer 124 * @shm_ref: Shared memory reference, pointer to a struct tee_shm 125 */ 126struct optee_msg_param_rmem { 127 u64 offs; 128 u64 size; 129 u64 shm_ref; 130}; 131 132/** 133 * struct optee_msg_param_value - opaque value parameter 134 * 135 * Value parameters are passed unchecked between normal and secure world. 136 */ 137struct optee_msg_param_value { 138 u64 a; 139 u64 b; 140 u64 c; 141}; 142 143/** 144 * struct optee_msg_param - parameter used together with struct optee_msg_arg 145 * @attr: attributes 146 * @tmem: parameter by temporary memory reference 147 * @rmem: parameter by registered memory reference 148 * @value: parameter by opaque value 149 * @octets: parameter by octet string 150 * 151 * @attr & OPTEE_MSG_ATTR_TYPE_MASK indicates if tmem, rmem or value is used in 152 * the union. OPTEE_MSG_ATTR_TYPE_VALUE_* indicates value or octets, 153 * OPTEE_MSG_ATTR_TYPE_TMEM_* indicates @tmem and 154 * OPTEE_MSG_ATTR_TYPE_RMEM_* indicates @rmem, 155 * OPTEE_MSG_ATTR_TYPE_NONE indicates that none of the members are used. 156 */ 157struct optee_msg_param { 158 u64 attr; 159 union { 160 struct optee_msg_param_tmem tmem; 161 struct optee_msg_param_rmem rmem; 162 struct optee_msg_param_value value; 163 u8 octets[24]; 164 } u; 165}; 166 167/** 168 * struct optee_msg_arg - call argument 169 * @cmd: Command, one of OPTEE_MSG_CMD_* or OPTEE_MSG_RPC_CMD_* 170 * @func: Trusted Application function, specific to the Trusted Application, 171 * used if cmd == OPTEE_MSG_CMD_INVOKE_COMMAND 172 * @session: In parameter for all OPTEE_MSG_CMD_* except 173 * OPTEE_MSG_CMD_OPEN_SESSION where it's an output parameter instead 174 * @cancel_id: Cancellation id, a unique value to identify this request 175 * @ret: return value 176 * @ret_origin: origin of the return value 177 * @num_params: number of parameters supplied to the OS Command 178 * @params: the parameters supplied to the OS Command 179 * 180 * All normal calls to Trusted OS uses this struct. If cmd requires further 181 * information than what these field holds it can be passed as a parameter 182 * tagged as meta (setting the OPTEE_MSG_ATTR_META bit in corresponding 183 * attrs field). All parameters tagged as meta has to come first. 184 * 185 * Temp memref parameters can be fragmented if supported by the Trusted OS 186 * (when optee_smc.h is bearer of this protocol this is indicated with 187 * OPTEE_SMC_SEC_CAP_UNREGISTERED_SHM). If a logical memref parameter is 188 * fragmented then has all but the last fragment the 189 * OPTEE_MSG_ATTR_FRAGMENT bit set in attrs. Even if a memref is fragmented 190 * it will still be presented as a single logical memref to the Trusted 191 * Application. 192 */ 193struct optee_msg_arg { 194 u32 cmd; 195 u32 func; 196 u32 session; 197 u32 cancel_id; 198 u32 pad; 199 u32 ret; 200 u32 ret_origin; 201 u32 num_params; 202 203 /* num_params tells the actual number of element in params */ 204 struct optee_msg_param params[0]; 205}; 206 207/** 208 * OPTEE_MSG_GET_ARG_SIZE - return size of struct optee_msg_arg 209 * 210 * @num_params: Number of parameters embedded in the struct optee_msg_arg 211 * 212 * Returns the size of the struct optee_msg_arg together with the number 213 * of embedded parameters. 214 */ 215#define OPTEE_MSG_GET_ARG_SIZE(num_params) \ 216 (sizeof(struct optee_msg_arg) + \ 217 sizeof(struct optee_msg_param) * (num_params)) 218 219/***************************************************************************** 220 * Part 2 - requests from normal world 221 *****************************************************************************/ 222 223/* 224 * Return the following UID if using API specified in this file without 225 * further extensions: 226 * 384fb3e0-e7f8-11e3-af63-0002a5d5c51b. 227 * Represented in 4 32-bit words in OPTEE_MSG_UID_0, OPTEE_MSG_UID_1, 228 * OPTEE_MSG_UID_2, OPTEE_MSG_UID_3. 229 */ 230#define OPTEE_MSG_UID_0 0x384fb3e0 231#define OPTEE_MSG_UID_1 0xe7f811e3 232#define OPTEE_MSG_UID_2 0xaf630002 233#define OPTEE_MSG_UID_3 0xa5d5c51b 234#define OPTEE_MSG_FUNCID_CALLS_UID 0xFF01 235 236/* 237 * Returns 2.0 if using API specified in this file without further 238 * extensions. Represented in 2 32-bit words in OPTEE_MSG_REVISION_MAJOR 239 * and OPTEE_MSG_REVISION_MINOR 240 */ 241#define OPTEE_MSG_REVISION_MAJOR 2 242#define OPTEE_MSG_REVISION_MINOR 0 243#define OPTEE_MSG_FUNCID_CALLS_REVISION 0xFF03 244 245/* 246 * Get UUID of Trusted OS. 247 * 248 * Used by non-secure world to figure out which Trusted OS is installed. 249 * Note that returned UUID is the UUID of the Trusted OS, not of the API. 250 * 251 * Returns UUID in 4 32-bit words in the same way as 252 * OPTEE_MSG_FUNCID_CALLS_UID described above. 253 */ 254#define OPTEE_MSG_OS_OPTEE_UUID_0 0x486178e0 255#define OPTEE_MSG_OS_OPTEE_UUID_1 0xe7f811e3 256#define OPTEE_MSG_OS_OPTEE_UUID_2 0xbc5e0002 257#define OPTEE_MSG_OS_OPTEE_UUID_3 0xa5d5c51b 258#define OPTEE_MSG_FUNCID_GET_OS_UUID 0x0000 259 260/* 261 * Get revision of Trusted OS. 262 * 263 * Used by non-secure world to figure out which version of the Trusted OS 264 * is installed. Note that the returned revision is the revision of the 265 * Trusted OS, not of the API. 266 * 267 * Returns revision in 2 32-bit words in the same way as 268 * OPTEE_MSG_CALLS_REVISION described above. 269 */ 270#define OPTEE_MSG_FUNCID_GET_OS_REVISION 0x0001 271 272/* 273 * Do a secure call with struct optee_msg_arg as argument 274 * The OPTEE_MSG_CMD_* below defines what goes in struct optee_msg_arg::cmd 275 * 276 * OPTEE_MSG_CMD_OPEN_SESSION opens a session to a Trusted Application. 277 * The first two parameters are tagged as meta, holding two value 278 * parameters to pass the following information: 279 * param[0].u.value.a-b uuid of Trusted Application 280 * param[1].u.value.a-b uuid of Client 281 * param[1].u.value.c Login class of client OPTEE_MSG_LOGIN_* 282 * 283 * OPTEE_MSG_CMD_INVOKE_COMMAND invokes a command a previously opened 284 * session to a Trusted Application. struct optee_msg_arg::func is Trusted 285 * Application function, specific to the Trusted Application. 286 * 287 * OPTEE_MSG_CMD_CLOSE_SESSION closes a previously opened session to 288 * Trusted Application. 289 * 290 * OPTEE_MSG_CMD_CANCEL cancels a currently invoked command. 291 * 292 * OPTEE_MSG_CMD_REGISTER_SHM registers a shared memory reference. The 293 * information is passed as: 294 * [in] param[0].attr OPTEE_MSG_ATTR_TYPE_TMEM_INPUT 295 * [| OPTEE_MSG_ATTR_FRAGMENT] 296 * [in] param[0].u.tmem.buf_ptr physical address (of first fragment) 297 * [in] param[0].u.tmem.size size (of first fragment) 298 * [in] param[0].u.tmem.shm_ref holds shared memory reference 299 * ... 300 * The shared memory can optionally be fragmented, temp memrefs can follow 301 * each other with all but the last with the OPTEE_MSG_ATTR_FRAGMENT bit set. 302 * 303 * OPTEE_MSG_CMD_UNREGISTER_SHM unregisteres a previously registered shared 304 * memory reference. The information is passed as: 305 * [in] param[0].attr OPTEE_MSG_ATTR_TYPE_RMEM_INPUT 306 * [in] param[0].u.rmem.shm_ref holds shared memory reference 307 * [in] param[0].u.rmem.offs 0 308 * [in] param[0].u.rmem.size 0 309 */ 310#define OPTEE_MSG_CMD_OPEN_SESSION 0 311#define OPTEE_MSG_CMD_INVOKE_COMMAND 1 312#define OPTEE_MSG_CMD_CLOSE_SESSION 2 313#define OPTEE_MSG_CMD_CANCEL 3 314#define OPTEE_MSG_CMD_REGISTER_SHM 4 315#define OPTEE_MSG_CMD_UNREGISTER_SHM 5 316#define OPTEE_MSG_FUNCID_CALL_WITH_ARG 0x0004 317 318/***************************************************************************** 319 * Part 3 - Requests from secure world, RPC 320 *****************************************************************************/ 321 322/* 323 * All RPC is done with a struct optee_msg_arg as bearer of information, 324 * struct optee_msg_arg::arg holds values defined by OPTEE_MSG_RPC_CMD_* below 325 * 326 * RPC communication with tee-supplicant is reversed compared to normal 327 * client communication desribed above. The supplicant receives requests 328 * and sends responses. 329 */ 330 331/* 332 * Load a TA into memory, defined in tee-supplicant 333 */ 334#define OPTEE_MSG_RPC_CMD_LOAD_TA 0 335 336/* 337 * Reserved 338 */ 339#define OPTEE_MSG_RPC_CMD_RPMB 1 340 341/* 342 * File system access, defined in tee-supplicant 343 */ 344#define OPTEE_MSG_RPC_CMD_FS 2 345 346/* 347 * Get time 348 * 349 * Returns number of seconds and nano seconds since the Epoch, 350 * 1970-01-01 00:00:00 +0000 (UTC). 351 * 352 * [out] param[0].u.value.a Number of seconds 353 * [out] param[0].u.value.b Number of nano seconds. 354 */ 355#define OPTEE_MSG_RPC_CMD_GET_TIME 3 356 357/* 358 * Wait queue primitive, helper for secure world to implement a wait queue. 359 * 360 * If secure world need to wait for a secure world mutex it issues a sleep 361 * request instead of spinning in secure world. Conversely is a wakeup 362 * request issued when a secure world mutex with a thread waiting thread is 363 * unlocked. 364 * 365 * Waiting on a key 366 * [in] param[0].u.value.a OPTEE_MSG_RPC_WAIT_QUEUE_SLEEP 367 * [in] param[0].u.value.b wait key 368 * 369 * Waking up a key 370 * [in] param[0].u.value.a OPTEE_MSG_RPC_WAIT_QUEUE_WAKEUP 371 * [in] param[0].u.value.b wakeup key 372 */ 373#define OPTEE_MSG_RPC_CMD_WAIT_QUEUE 4 374#define OPTEE_MSG_RPC_WAIT_QUEUE_SLEEP 0 375#define OPTEE_MSG_RPC_WAIT_QUEUE_WAKEUP 1 376 377/* 378 * Suspend execution 379 * 380 * [in] param[0].value .a number of milliseconds to suspend 381 */ 382#define OPTEE_MSG_RPC_CMD_SUSPEND 5 383 384/* 385 * Allocate a piece of shared memory 386 * 387 * Shared memory can optionally be fragmented, to support that additional 388 * spare param entries are allocated to make room for eventual fragments. 389 * The spare param entries has .attr = OPTEE_MSG_ATTR_TYPE_NONE when 390 * unused. All returned temp memrefs except the last should have the 391 * OPTEE_MSG_ATTR_FRAGMENT bit set in the attr field. 392 * 393 * [in] param[0].u.value.a type of memory one of 394 * OPTEE_MSG_RPC_SHM_TYPE_* below 395 * [in] param[0].u.value.b requested size 396 * [in] param[0].u.value.c required alignment 397 * 398 * [out] param[0].u.tmem.buf_ptr physical address (of first fragment) 399 * [out] param[0].u.tmem.size size (of first fragment) 400 * [out] param[0].u.tmem.shm_ref shared memory reference 401 * ... 402 * [out] param[n].u.tmem.buf_ptr physical address 403 * [out] param[n].u.tmem.size size 404 * [out] param[n].u.tmem.shm_ref shared memory reference (same value 405 * as in param[n-1].u.tmem.shm_ref) 406 */ 407#define OPTEE_MSG_RPC_CMD_SHM_ALLOC 6 408/* Memory that can be shared with a non-secure user space application */ 409#define OPTEE_MSG_RPC_SHM_TYPE_APPL 0 410/* Memory only shared with non-secure kernel */ 411#define OPTEE_MSG_RPC_SHM_TYPE_KERNEL 1 412 413/* 414 * Free shared memory previously allocated with OPTEE_MSG_RPC_CMD_SHM_ALLOC 415 * 416 * [in] param[0].u.value.a type of memory one of 417 * OPTEE_MSG_RPC_SHM_TYPE_* above 418 * [in] param[0].u.value.b value of shared memory reference 419 * returned in param[0].u.tmem.shm_ref 420 * above 421 */ 422#define OPTEE_MSG_RPC_CMD_SHM_FREE 7 423 424/* 425 * Access a device on an i2c bus 426 * 427 * [in] param[0].u.value.a mode: RD(0), WR(1) 428 * [in] param[0].u.value.b i2c adapter 429 * [in] param[0].u.value.c i2c chip 430 * 431 * [in] param[1].u.value.a i2c control flags 432 * 433 * [in/out] memref[2] buffer to exchange the transfer data 434 * with the secure world 435 * 436 * [out] param[3].u.value.a bytes transferred by the driver 437 */ 438#define OPTEE_MSG_RPC_CMD_I2C_TRANSFER 21 439/* I2C master transfer modes */ 440#define OPTEE_MSG_RPC_CMD_I2C_TRANSFER_RD 0 441#define OPTEE_MSG_RPC_CMD_I2C_TRANSFER_WR 1 442/* I2C master control flags */ 443#define OPTEE_MSG_RPC_CMD_I2C_FLAGS_TEN_BIT BIT(0) 444 445#endif /* _OPTEE_MSG_H */ 446