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 28 #ifndef __TEE_H 29 #define __TEE_H 30 31 #include <linux/ioctl.h> 32 #include <linux/types.h> 33 34 /* 35 * This file describes the API provided by a TEE driver to user space. 36 * 37 * Each TEE driver defines a TEE specific protocol which is used for the 38 * data passed back and forth using TEE_IOC_CMD. 39 */ 40 41 /* Helpers to make the ioctl defines */ 42 #define TEE_IOC_MAGIC 0xa4 43 #define TEE_IOC_BASE 0 44 45 /* Flags relating to shared memory */ 46 #define TEE_IOCTL_SHM_MAPPED 0x1 /* memory mapped in normal world */ 47 #define TEE_IOCTL_SHM_DMA_BUF 0x2 /* dma-buf handle on shared memory */ 48 49 #define TEE_MAX_ARG_SIZE 1024 50 51 #define TEE_GEN_CAP_GP (1 << 0)/* GlobalPlatform compliant TEE */ 52 #define TEE_GEN_CAP_PRIVILEGED (1 << 1)/* Privileged device (for supplicant) */ 53 #define TEE_GEN_CAP_REG_MEM (1 << 2)/* Supports registering shared memory */ 54 #define TEE_GEN_CAP_MEMREF_NULL (1 << 3) /* Support NULL MemRef */ 55 56 #define TEE_MEMREF_NULL ((__u64)-1) /* NULL MemRef Buffer */ 57 58 /* 59 * TEE Implementation ID 60 */ 61 #define TEE_IMPL_ID_OPTEE 1 62 #define TEE_IMPL_ID_AMDTEE 2 63 64 /* 65 * OP-TEE specific capabilities 66 */ 67 #define TEE_OPTEE_CAP_TZ (1 << 0) 68 69 /** 70 * struct tee_ioctl_version_data - TEE version 71 * @impl_id: [out] TEE implementation id 72 * @impl_caps: [out] Implementation specific capabilities 73 * @gen_caps: [out] Generic capabilities, defined by TEE_GEN_CAPS_* above 74 * 75 * Identifies the TEE implementation, @impl_id is one of TEE_IMPL_ID_* above. 76 * @impl_caps is implementation specific, for example TEE_OPTEE_CAP_* 77 * is valid when @impl_id == TEE_IMPL_ID_OPTEE. 78 */ 79 struct tee_ioctl_version_data { 80 __u32 impl_id; 81 __u32 impl_caps; 82 __u32 gen_caps; 83 }; 84 85 /** 86 * TEE_IOC_VERSION - query version of TEE 87 * 88 * Takes a tee_ioctl_version_data struct and returns with the TEE version 89 * data filled in. 90 */ 91 #define TEE_IOC_VERSION _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 0, \ 92 struct tee_ioctl_version_data) 93 94 /** 95 * struct tee_ioctl_shm_alloc_data - Shared memory allocate argument 96 * @size: [in/out] Size of shared memory to allocate 97 * @flags: [in/out] Flags to/from allocation. 98 * @id: [out] Identifier of the shared memory 99 * 100 * The flags field should currently be zero as input. Updated by the call 101 * with actual flags as defined by TEE_IOCTL_SHM_* above. 102 * This structure is used as argument for TEE_IOC_SHM_ALLOC below. 103 */ 104 struct tee_ioctl_shm_alloc_data { 105 __u64 size; 106 __u32 flags; 107 __s32 id; 108 }; 109 110 /** 111 * TEE_IOC_SHM_ALLOC - allocate shared memory 112 * 113 * Allocates shared memory between the user space process and secure OS. 114 * 115 * Returns a file descriptor on success or < 0 on failure 116 * 117 * The returned file descriptor is used to map the shared memory into user 118 * space. The shared memory is freed when the descriptor is closed and the 119 * memory is unmapped. 120 */ 121 #define TEE_IOC_SHM_ALLOC _IOWR(TEE_IOC_MAGIC, TEE_IOC_BASE + 1, \ 122 struct tee_ioctl_shm_alloc_data) 123 124 /** 125 * struct tee_ioctl_shm_register_fd_data - Shared memory registering argument 126 * @fd: [in] file descriptor identifying the shared memory 127 * @size: [out] Size of shared memory to allocate 128 * @flags: [in] Flags to/from allocation. 129 * @id: [out] Identifier of the shared memory 130 * 131 * The flags field should currently be zero as input. Updated by the call 132 * with actual flags as defined by TEE_IOCTL_SHM_* above. 133 * This structure is used as argument for TEE_IOC_SHM_ALLOC below. 134 */ 135 struct tee_ioctl_shm_register_fd_data { 136 __s64 fd; 137 __u64 size; 138 __u32 flags; 139 __s32 id; 140 } __aligned(8); 141 142 /* 143 * Attributes for struct tee_ioctl_param, selects field in the union 144 */ 145 #define TEE_IOCTL_PARAM_ATTR_TYPE_NONE 0 /* parameter not used */ 146 147 /* 148 * These defines value parameters (struct tee_ioctl_param_value) 149 */ 150 #define TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT 1 151 #define TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT 2 152 #define TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT 3 /* input and output */ 153 154 /* 155 * These defines shared memory reference parameters (struct 156 * tee_ioctl_param_memref) 157 */ 158 #define TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT 5 159 #define TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT 6 160 #define TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INOUT 7 /* input and output */ 161 162 /* 163 * Mask for the type part of the attribute, leaves room for more types 164 */ 165 #define TEE_IOCTL_PARAM_ATTR_TYPE_MASK 0xff 166 167 /* Meta parameter carrying extra information about the message. */ 168 #define TEE_IOCTL_PARAM_ATTR_META 0x100 169 170 /* Mask of all known attr bits */ 171 #define TEE_IOCTL_PARAM_ATTR_MASK \ 172 (TEE_IOCTL_PARAM_ATTR_TYPE_MASK | TEE_IOCTL_PARAM_ATTR_META) 173 174 /* 175 * Matches TEEC_LOGIN_* in GP TEE Client API 176 * Are only defined for GP compliant TEEs 177 */ 178 #define TEE_IOCTL_LOGIN_PUBLIC 0 179 #define TEE_IOCTL_LOGIN_USER 1 180 #define TEE_IOCTL_LOGIN_GROUP 2 181 #define TEE_IOCTL_LOGIN_APPLICATION 4 182 #define TEE_IOCTL_LOGIN_USER_APPLICATION 5 183 #define TEE_IOCTL_LOGIN_GROUP_APPLICATION 6 184 185 /** 186 * struct tee_ioctl_param - parameter 187 * @attr: attributes 188 * @a: if a memref, offset into the shared memory object, else a value parameter 189 * @b: if a memref, size of the buffer, else a value parameter 190 * @c: if a memref, shared memory identifier, else a value parameter 191 * 192 * @attr & TEE_PARAM_ATTR_TYPE_MASK indicates if memref or value is used in 193 * the union. TEE_PARAM_ATTR_TYPE_VALUE_* indicates value and 194 * TEE_PARAM_ATTR_TYPE_MEMREF_* indicates memref. TEE_PARAM_ATTR_TYPE_NONE 195 * indicates that none of the members are used. 196 * 197 * Shared memory is allocated with TEE_IOC_SHM_ALLOC which returns an 198 * identifier representing the shared memory object. A memref can reference 199 * a part of a shared memory by specifying an offset (@a) and size (@b) of 200 * the object. To supply the entire shared memory object set the offset 201 * (@a) to 0 and size (@b) to the previously returned size of the object. 202 */ 203 struct tee_ioctl_param { 204 __u64 attr; 205 __u64 a; 206 __u64 b; 207 __u64 c; 208 }; 209 210 #define TEE_IOCTL_UUID_LEN 16 211 212 /** 213 * struct tee_ioctl_open_session_arg - Open session argument 214 * @uuid: [in] UUID of the Trusted Application 215 * @clnt_uuid: [in] UUID of client 216 * @clnt_login: [in] Login class of client, TEE_IOCTL_LOGIN_* above 217 * @cancel_id: [in] Cancellation id, a unique value to identify this request 218 * @session: [out] Session id 219 * @ret: [out] return value 220 * @ret_origin [out] origin of the return value 221 * @num_params [in] number of parameters following this struct 222 */ 223 struct tee_ioctl_open_session_arg { 224 __u8 uuid[TEE_IOCTL_UUID_LEN]; 225 __u8 clnt_uuid[TEE_IOCTL_UUID_LEN]; 226 __u32 clnt_login; 227 __u32 cancel_id; 228 __u32 session; 229 __u32 ret; 230 __u32 ret_origin; 231 __u32 num_params; 232 /* num_params tells the actual number of element in params */ 233 struct tee_ioctl_param params[]; 234 }; 235 236 /** 237 * TEE_IOC_OPEN_SESSION - opens a session to a Trusted Application 238 * 239 * Takes a struct tee_ioctl_buf_data which contains a struct 240 * tee_ioctl_open_session_arg followed by any array of struct 241 * tee_ioctl_param 242 */ 243 #define TEE_IOC_OPEN_SESSION _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 2, \ 244 struct tee_ioctl_buf_data) 245 246 /** 247 * struct tee_ioctl_invoke_func_arg - Invokes a function in a Trusted 248 * Application 249 * @func: [in] Trusted Application function, specific to the TA 250 * @session: [in] Session id 251 * @cancel_id: [in] Cancellation id, a unique value to identify this request 252 * @ret: [out] return value 253 * @ret_origin [out] origin of the return value 254 * @num_params [in] number of parameters following this struct 255 */ 256 struct tee_ioctl_invoke_arg { 257 __u32 func; 258 __u32 session; 259 __u32 cancel_id; 260 __u32 ret; 261 __u32 ret_origin; 262 __u32 num_params; 263 /* num_params tells the actual number of element in params */ 264 struct tee_ioctl_param params[]; 265 }; 266 267 /** 268 * TEE_IOC_INVOKE - Invokes a function in a Trusted Application 269 * 270 * Takes a struct tee_ioctl_buf_data which contains a struct 271 * tee_invoke_func_arg followed by any array of struct tee_param 272 */ 273 #define TEE_IOC_INVOKE _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 3, \ 274 struct tee_ioctl_buf_data) 275 276 /** 277 * struct tee_ioctl_cancel_arg - Cancels an open session or invoke ioctl 278 * @cancel_id: [in] Cancellation id, a unique value to identify this request 279 * @session: [in] Session id, if the session is opened, else set to 0 280 */ 281 struct tee_ioctl_cancel_arg { 282 __u32 cancel_id; 283 __u32 session; 284 }; 285 286 /** 287 * TEE_IOC_CANCEL - Cancels an open session or invoke 288 */ 289 #define TEE_IOC_CANCEL _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 4, \ 290 struct tee_ioctl_cancel_arg) 291 292 /** 293 * struct tee_ioctl_close_session_arg - Closes an open session 294 * @session: [in] Session id 295 */ 296 struct tee_ioctl_close_session_arg { 297 __u32 session; 298 }; 299 300 /** 301 * TEE_IOC_CLOSE_SESSION - Closes a session 302 */ 303 #define TEE_IOC_CLOSE_SESSION _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 5, \ 304 struct tee_ioctl_close_session_arg) 305 306 /** 307 * struct tee_iocl_supp_recv_arg - Receive a request for a supplicant function 308 * @func: [in] supplicant function 309 * @num_params [in/out] number of parameters following this struct 310 * 311 * @num_params is the number of params that tee-supplicant has room to 312 * receive when input, @num_params is the number of actual params 313 * tee-supplicant receives when output. 314 */ 315 struct tee_iocl_supp_recv_arg { 316 __u32 func; 317 __u32 num_params; 318 /* num_params tells the actual number of element in params */ 319 struct tee_ioctl_param params[]; 320 }; 321 322 /** 323 * TEE_IOC_SUPPL_RECV - Receive a request for a supplicant function 324 * 325 * Takes a struct tee_ioctl_buf_data which contains a struct 326 * tee_iocl_supp_recv_arg followed by any array of struct tee_param 327 */ 328 #define TEE_IOC_SUPPL_RECV _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 6, \ 329 struct tee_ioctl_buf_data) 330 331 /** 332 * struct tee_iocl_supp_send_arg - Send a response to a received request 333 * @ret: [out] return value 334 * @num_params [in] number of parameters following this struct 335 */ 336 struct tee_iocl_supp_send_arg { 337 __u32 ret; 338 __u32 num_params; 339 /* num_params tells the actual number of element in params */ 340 struct tee_ioctl_param params[]; 341 }; 342 343 /** 344 * TEE_IOC_SUPPL_SEND - Receive a request for a supplicant function 345 * 346 * Takes a struct tee_ioctl_buf_data which contains a struct 347 * tee_iocl_supp_send_arg followed by any array of struct tee_param 348 */ 349 #define TEE_IOC_SUPPL_SEND _IOR(TEE_IOC_MAGIC, TEE_IOC_BASE + 7, \ 350 struct tee_ioctl_buf_data) 351 352 /** 353 * struct tee_ioctl_shm_register_data - Shared memory register argument 354 * @addr: [in] Start address of shared memory to register 355 * @length: [in/out] Length of shared memory to register 356 * @flags: [in/out] Flags to/from registration. 357 * @id: [out] Identifier of the shared memory 358 * 359 * The flags field should currently be zero as input. Updated by the call 360 * with actual flags as defined by TEE_IOCTL_SHM_* above. 361 * This structure is used as argument for TEE_IOC_SHM_REGISTER below. 362 */ 363 struct tee_ioctl_shm_register_data { 364 __u64 addr; 365 __u64 length; 366 __u32 flags; 367 __s32 id; 368 }; 369 370 /** 371 * TEE_IOC_SHM_REGISTER_FD - register a shared memory from a file descriptor 372 * 373 * Returns a file descriptor on success or < 0 on failure 374 * 375 * The returned file descriptor refers to the shared memory object in kernel 376 * land. The shared memory is freed when the descriptor is closed. 377 */ 378 #define TEE_IOC_SHM_REGISTER_FD _IOWR(TEE_IOC_MAGIC, TEE_IOC_BASE + 8, \ 379 struct tee_ioctl_shm_register_fd_data) 380 381 /** 382 * struct tee_ioctl_buf_data - Variable sized buffer 383 * @buf_ptr: [in] A __user pointer to a buffer 384 * @buf_len: [in] Length of the buffer above 385 * 386 * Used as argument for TEE_IOC_OPEN_SESSION, TEE_IOC_INVOKE, 387 * TEE_IOC_SUPPL_RECV, and TEE_IOC_SUPPL_SEND below. 388 */ 389 struct tee_ioctl_buf_data { 390 __u64 buf_ptr; 391 __u64 buf_len; 392 }; 393 394 /** 395 * TEE_IOC_SHM_REGISTER - Register shared memory argument 396 * 397 * Registers shared memory between the user space process and secure OS. 398 * 399 * Returns a file descriptor on success or < 0 on failure 400 * 401 * The shared memory is unregisterred when the descriptor is closed. 402 */ 403 #define TEE_IOC_SHM_REGISTER _IOWR(TEE_IOC_MAGIC, TEE_IOC_BASE + 9, \ 404 struct tee_ioctl_shm_register_data) 405 /* 406 * Five syscalls are used when communicating with the TEE driver. 407 * open(): opens the device associated with the driver 408 * ioctl(): as described above operating on the file descriptor from open() 409 * close(): two cases 410 * - closes the device file descriptor 411 * - closes a file descriptor connected to allocated shared memory 412 * mmap(): maps shared memory into user space using information from struct 413 * tee_ioctl_shm_alloc_data 414 * munmap(): unmaps previously shared memory 415 */ 416 417 #endif /*__TEE_H*/ 418