1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (c) 2015-2021, Linaro Limited 4 */ 5 6 #ifndef OPTEE_PRIVATE_H 7 #define OPTEE_PRIVATE_H 8 9 #include <linux/arm-smccc.h> 10 #include <linux/rhashtable.h> 11 #include <linux/semaphore.h> 12 #include <linux/tee_drv.h> 13 #include <linux/types.h> 14 #include "optee_msg.h" 15 16 #define DRIVER_NAME "optee" 17 18 #define OPTEE_MAX_ARG_SIZE 1024 19 20 /* Some Global Platform error codes used in this driver */ 21 #define TEEC_SUCCESS 0x00000000 22 #define TEEC_ERROR_BAD_PARAMETERS 0xFFFF0006 23 #define TEEC_ERROR_NOT_SUPPORTED 0xFFFF000A 24 #define TEEC_ERROR_COMMUNICATION 0xFFFF000E 25 #define TEEC_ERROR_OUT_OF_MEMORY 0xFFFF000C 26 #define TEEC_ERROR_BUSY 0xFFFF000D 27 #define TEEC_ERROR_SHORT_BUFFER 0xFFFF0010 28 29 #define TEEC_ORIGIN_COMMS 0x00000002 30 31 /* 32 * This value should be larger than the number threads in secure world to 33 * meet the need from secure world. The number of threads in secure world 34 * are usually not even close to 255 so we should be safe for now. 35 */ 36 #define OPTEE_DEFAULT_MAX_NOTIF_VALUE 255 37 38 typedef void (optee_invoke_fn)(unsigned long, unsigned long, unsigned long, 39 unsigned long, unsigned long, unsigned long, 40 unsigned long, unsigned long, 41 struct arm_smccc_res *); 42 43 struct optee_call_waiter { 44 struct list_head list_node; 45 struct completion c; 46 }; 47 48 struct optee_call_queue { 49 /* Serializes access to this struct */ 50 struct mutex mutex; 51 struct list_head waiters; 52 }; 53 54 struct optee_notif { 55 u_int max_key; 56 /* Serializes access to the elements below in this struct */ 57 spinlock_t lock; 58 struct list_head db; 59 u_long *bitmap; 60 }; 61 62 /** 63 * struct optee_supp - supplicant synchronization struct 64 * @ctx the context of current connected supplicant. 65 * if !NULL the supplicant device is available for use, 66 * else busy 67 * @mutex: held while accessing content of this struct 68 * @req_id: current request id if supplicant is doing synchronous 69 * communication, else -1 70 * @reqs: queued request not yet retrieved by supplicant 71 * @idr: IDR holding all requests currently being processed 72 * by supplicant 73 * @reqs_c: completion used by supplicant when waiting for a 74 * request to be queued. 75 */ 76 struct optee_supp { 77 /* Serializes access to this struct */ 78 struct mutex mutex; 79 struct tee_context *ctx; 80 81 int req_id; 82 struct list_head reqs; 83 struct idr idr; 84 struct completion reqs_c; 85 }; 86 87 struct optee_smc { 88 optee_invoke_fn *invoke_fn; 89 void *memremaped_shm; 90 u32 sec_caps; 91 unsigned int notif_irq; 92 }; 93 94 /** 95 * struct optee_ffa_data - FFA communication struct 96 * @ffa_dev FFA device, contains the destination id, the id of 97 * OP-TEE in secure world 98 * @ffa_ops FFA operations 99 * @mutex Serializes access to @global_ids 100 * @global_ids FF-A shared memory global handle translation 101 */ 102 struct optee_ffa { 103 struct ffa_device *ffa_dev; 104 const struct ffa_dev_ops *ffa_ops; 105 /* Serializes access to @global_ids */ 106 struct mutex mutex; 107 struct rhashtable global_ids; 108 }; 109 110 struct optee; 111 112 /** 113 * struct optee_ops - OP-TEE driver internal operations 114 * @do_call_with_arg: enters OP-TEE in secure world 115 * @to_msg_param: converts from struct tee_param to OPTEE_MSG parameters 116 * @from_msg_param: converts from OPTEE_MSG parameters to struct tee_param 117 * 118 * These OPs are only supposed to be used internally in the OP-TEE driver 119 * as a way of abstracting the different methogs of entering OP-TEE in 120 * secure world. 121 */ 122 struct optee_ops { 123 int (*do_call_with_arg)(struct tee_context *ctx, 124 struct tee_shm *shm_arg); 125 int (*to_msg_param)(struct optee *optee, 126 struct optee_msg_param *msg_params, 127 size_t num_params, const struct tee_param *params); 128 int (*from_msg_param)(struct optee *optee, struct tee_param *params, 129 size_t num_params, 130 const struct optee_msg_param *msg_params); 131 }; 132 133 /** 134 * struct optee - main service struct 135 * @supp_teedev: supplicant device 136 * @teedev: client device 137 * @ops: internal callbacks for different ways to reach secure 138 * world 139 * @ctx: driver internal TEE context 140 * @smc: specific to SMC ABI 141 * @ffa: specific to FF-A ABI 142 * @call_queue: queue of threads waiting to call @invoke_fn 143 * @notif: notification synchronization struct 144 * @supp: supplicant synchronization struct for RPC to supplicant 145 * @pool: shared memory pool 146 * @rpc_arg_count: If > 0 number of RPC parameters to make room for 147 * @scan_bus_done flag if device registation was already done. 148 * @scan_bus_wq workqueue to scan optee bus and register optee drivers 149 * @scan_bus_work workq to scan optee bus and register optee drivers 150 */ 151 struct optee { 152 struct tee_device *supp_teedev; 153 struct tee_device *teedev; 154 const struct optee_ops *ops; 155 struct tee_context *ctx; 156 union { 157 struct optee_smc smc; 158 struct optee_ffa ffa; 159 }; 160 struct optee_call_queue call_queue; 161 struct optee_notif notif; 162 struct optee_supp supp; 163 struct tee_shm_pool *pool; 164 unsigned int rpc_arg_count; 165 bool scan_bus_done; 166 struct workqueue_struct *scan_bus_wq; 167 struct work_struct scan_bus_work; 168 }; 169 170 struct optee_session { 171 struct list_head list_node; 172 u32 session_id; 173 }; 174 175 struct optee_context_data { 176 /* Serializes access to this struct */ 177 struct mutex mutex; 178 struct list_head sess_list; 179 }; 180 181 struct optee_rpc_param { 182 u32 a0; 183 u32 a1; 184 u32 a2; 185 u32 a3; 186 u32 a4; 187 u32 a5; 188 u32 a6; 189 u32 a7; 190 }; 191 192 /* Holds context that is preserved during one STD call */ 193 struct optee_call_ctx { 194 /* information about pages list used in last allocation */ 195 void *pages_list; 196 size_t num_entries; 197 }; 198 199 int optee_notif_init(struct optee *optee, u_int max_key); 200 void optee_notif_uninit(struct optee *optee); 201 int optee_notif_wait(struct optee *optee, u_int key); 202 int optee_notif_send(struct optee *optee, u_int key); 203 204 u32 optee_supp_thrd_req(struct tee_context *ctx, u32 func, size_t num_params, 205 struct tee_param *param); 206 207 int optee_supp_read(struct tee_context *ctx, void __user *buf, size_t len); 208 int optee_supp_write(struct tee_context *ctx, void __user *buf, size_t len); 209 void optee_supp_init(struct optee_supp *supp); 210 void optee_supp_uninit(struct optee_supp *supp); 211 void optee_supp_release(struct optee_supp *supp); 212 213 int optee_supp_recv(struct tee_context *ctx, u32 *func, u32 *num_params, 214 struct tee_param *param); 215 int optee_supp_send(struct tee_context *ctx, u32 ret, u32 num_params, 216 struct tee_param *param); 217 218 int optee_open_session(struct tee_context *ctx, 219 struct tee_ioctl_open_session_arg *arg, 220 struct tee_param *param); 221 int optee_close_session_helper(struct tee_context *ctx, u32 session); 222 int optee_close_session(struct tee_context *ctx, u32 session); 223 int optee_invoke_func(struct tee_context *ctx, struct tee_ioctl_invoke_arg *arg, 224 struct tee_param *param); 225 int optee_cancel_req(struct tee_context *ctx, u32 cancel_id, u32 session); 226 227 #define PTA_CMD_GET_DEVICES 0x0 228 #define PTA_CMD_GET_DEVICES_SUPP 0x1 229 int optee_enumerate_devices(u32 func); 230 void optee_unregister_devices(void); 231 232 int optee_pool_op_alloc_helper(struct tee_shm_pool *pool, struct tee_shm *shm, 233 size_t size, size_t align, 234 int (*shm_register)(struct tee_context *ctx, 235 struct tee_shm *shm, 236 struct page **pages, 237 size_t num_pages, 238 unsigned long start)); 239 void optee_pool_op_free_helper(struct tee_shm_pool *pool, struct tee_shm *shm, 240 int (*shm_unregister)(struct tee_context *ctx, 241 struct tee_shm *shm)); 242 243 244 void optee_remove_common(struct optee *optee); 245 int optee_open(struct tee_context *ctx, bool cap_memref_null); 246 void optee_release(struct tee_context *ctx); 247 void optee_release_supp(struct tee_context *ctx); 248 249 static inline void optee_from_msg_param_value(struct tee_param *p, u32 attr, 250 const struct optee_msg_param *mp) 251 { 252 p->attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT + 253 attr - OPTEE_MSG_ATTR_TYPE_VALUE_INPUT; 254 p->u.value.a = mp->u.value.a; 255 p->u.value.b = mp->u.value.b; 256 p->u.value.c = mp->u.value.c; 257 } 258 259 static inline void optee_to_msg_param_value(struct optee_msg_param *mp, 260 const struct tee_param *p) 261 { 262 mp->attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT + p->attr - 263 TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT; 264 mp->u.value.a = p->u.value.a; 265 mp->u.value.b = p->u.value.b; 266 mp->u.value.c = p->u.value.c; 267 } 268 269 void optee_cq_wait_init(struct optee_call_queue *cq, 270 struct optee_call_waiter *w); 271 void optee_cq_wait_for_completion(struct optee_call_queue *cq, 272 struct optee_call_waiter *w); 273 void optee_cq_wait_final(struct optee_call_queue *cq, 274 struct optee_call_waiter *w); 275 int optee_check_mem_type(unsigned long start, size_t num_pages); 276 struct tee_shm *optee_get_msg_arg(struct tee_context *ctx, size_t num_params, 277 struct optee_msg_arg **msg_arg); 278 279 struct tee_shm *optee_rpc_cmd_alloc_suppl(struct tee_context *ctx, size_t sz); 280 void optee_rpc_cmd_free_suppl(struct tee_context *ctx, struct tee_shm *shm); 281 void optee_rpc_cmd(struct tee_context *ctx, struct optee *optee, 282 struct optee_msg_arg *arg); 283 284 /* 285 * Small helpers 286 */ 287 288 static inline void *reg_pair_to_ptr(u32 reg0, u32 reg1) 289 { 290 return (void *)(unsigned long)(((u64)reg0 << 32) | reg1); 291 } 292 293 static inline void reg_pair_from_64(u32 *reg0, u32 *reg1, u64 val) 294 { 295 *reg0 = val >> 32; 296 *reg1 = val; 297 } 298 299 /* Registration of the ABIs */ 300 int optee_smc_abi_register(void); 301 void optee_smc_abi_unregister(void); 302 int optee_ffa_abi_register(void); 303 void optee_ffa_abi_unregister(void); 304 305 #endif /*OPTEE_PRIVATE_H*/ 306