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