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 struct tee_context *ctx; 57 /* Serializes access to the elements below in this struct */ 58 spinlock_t lock; 59 struct list_head db; 60 u_long *bitmap; 61 }; 62 63 /** 64 * struct optee_supp - supplicant synchronization struct 65 * @ctx the context of current connected supplicant. 66 * if !NULL the supplicant device is available for use, 67 * else busy 68 * @mutex: held while accessing content of this struct 69 * @req_id: current request id if supplicant is doing synchronous 70 * communication, else -1 71 * @reqs: queued request not yet retrieved by supplicant 72 * @idr: IDR holding all requests currently being processed 73 * by supplicant 74 * @reqs_c: completion used by supplicant when waiting for a 75 * request to be queued. 76 */ 77 struct optee_supp { 78 /* Serializes access to this struct */ 79 struct mutex mutex; 80 struct tee_context *ctx; 81 82 int req_id; 83 struct list_head reqs; 84 struct idr idr; 85 struct completion reqs_c; 86 }; 87 88 struct optee_smc { 89 optee_invoke_fn *invoke_fn; 90 void *memremaped_shm; 91 u32 sec_caps; 92 unsigned int notif_irq; 93 }; 94 95 /** 96 * struct optee_ffa_data - FFA communication struct 97 * @ffa_dev FFA device, contains the destination id, the id of 98 * OP-TEE in secure world 99 * @ffa_ops FFA operations 100 * @mutex Serializes access to @global_ids 101 * @global_ids FF-A shared memory global handle translation 102 */ 103 struct optee_ffa { 104 struct ffa_device *ffa_dev; 105 const struct ffa_dev_ops *ffa_ops; 106 /* Serializes access to @global_ids */ 107 struct mutex mutex; 108 struct rhashtable global_ids; 109 }; 110 111 struct optee; 112 113 /** 114 * struct optee_ops - OP-TEE driver internal operations 115 * @do_call_with_arg: enters OP-TEE in secure world 116 * @to_msg_param: converts from struct tee_param to OPTEE_MSG parameters 117 * @from_msg_param: converts from OPTEE_MSG parameters to struct tee_param 118 * 119 * These OPs are only supposed to be used internally in the OP-TEE driver 120 * as a way of abstracting the different methogs of entering OP-TEE in 121 * secure world. 122 */ 123 struct optee_ops { 124 int (*do_call_with_arg)(struct tee_context *ctx, 125 struct tee_shm *shm_arg); 126 int (*to_msg_param)(struct optee *optee, 127 struct optee_msg_param *msg_params, 128 size_t num_params, const struct tee_param *params); 129 int (*from_msg_param)(struct optee *optee, struct tee_param *params, 130 size_t num_params, 131 const struct optee_msg_param *msg_params); 132 }; 133 134 /** 135 * struct optee - main service struct 136 * @supp_teedev: supplicant device 137 * @ops: internal callbacks for different ways to reach secure 138 * world 139 * @teedev: client device 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 union { 156 struct optee_smc smc; 157 struct optee_ffa ffa; 158 }; 159 struct optee_call_queue call_queue; 160 struct optee_notif notif; 161 struct optee_supp supp; 162 struct tee_shm_pool *pool; 163 unsigned int rpc_arg_count; 164 bool scan_bus_done; 165 struct workqueue_struct *scan_bus_wq; 166 struct work_struct scan_bus_work; 167 }; 168 169 struct optee_session { 170 struct list_head list_node; 171 u32 session_id; 172 }; 173 174 struct optee_context_data { 175 /* Serializes access to this struct */ 176 struct mutex mutex; 177 struct list_head sess_list; 178 }; 179 180 struct optee_rpc_param { 181 u32 a0; 182 u32 a1; 183 u32 a2; 184 u32 a3; 185 u32 a4; 186 u32 a5; 187 u32 a6; 188 u32 a7; 189 }; 190 191 /* Holds context that is preserved during one STD call */ 192 struct optee_call_ctx { 193 /* information about pages list used in last allocation */ 194 void *pages_list; 195 size_t num_entries; 196 }; 197 198 int optee_notif_init(struct optee *optee, u_int max_key); 199 void optee_notif_uninit(struct optee *optee); 200 int optee_notif_wait(struct optee *optee, u_int key); 201 int optee_notif_send(struct optee *optee, u_int key); 202 203 u32 optee_supp_thrd_req(struct tee_context *ctx, u32 func, size_t num_params, 204 struct tee_param *param); 205 206 int optee_supp_read(struct tee_context *ctx, void __user *buf, size_t len); 207 int optee_supp_write(struct tee_context *ctx, void __user *buf, size_t len); 208 void optee_supp_init(struct optee_supp *supp); 209 void optee_supp_uninit(struct optee_supp *supp); 210 void optee_supp_release(struct optee_supp *supp); 211 212 int optee_supp_recv(struct tee_context *ctx, u32 *func, u32 *num_params, 213 struct tee_param *param); 214 int optee_supp_send(struct tee_context *ctx, u32 ret, u32 num_params, 215 struct tee_param *param); 216 217 int optee_open_session(struct tee_context *ctx, 218 struct tee_ioctl_open_session_arg *arg, 219 struct tee_param *param); 220 int optee_close_session_helper(struct tee_context *ctx, u32 session); 221 int optee_close_session(struct tee_context *ctx, u32 session); 222 int optee_invoke_func(struct tee_context *ctx, struct tee_ioctl_invoke_arg *arg, 223 struct tee_param *param); 224 int optee_cancel_req(struct tee_context *ctx, u32 cancel_id, u32 session); 225 226 #define PTA_CMD_GET_DEVICES 0x0 227 #define PTA_CMD_GET_DEVICES_SUPP 0x1 228 int optee_enumerate_devices(u32 func); 229 void optee_unregister_devices(void); 230 231 int optee_pool_op_alloc_helper(struct tee_shm_pool_mgr *poolm, 232 struct tee_shm *shm, size_t size, 233 int (*shm_register)(struct tee_context *ctx, 234 struct tee_shm *shm, 235 struct page **pages, 236 size_t num_pages, 237 unsigned long start)); 238 239 240 void optee_remove_common(struct optee *optee); 241 int optee_open(struct tee_context *ctx, bool cap_memref_null); 242 void optee_release(struct tee_context *ctx); 243 void optee_release_supp(struct tee_context *ctx); 244 245 static inline void optee_from_msg_param_value(struct tee_param *p, u32 attr, 246 const struct optee_msg_param *mp) 247 { 248 p->attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT + 249 attr - OPTEE_MSG_ATTR_TYPE_VALUE_INPUT; 250 p->u.value.a = mp->u.value.a; 251 p->u.value.b = mp->u.value.b; 252 p->u.value.c = mp->u.value.c; 253 } 254 255 static inline void optee_to_msg_param_value(struct optee_msg_param *mp, 256 const struct tee_param *p) 257 { 258 mp->attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT + p->attr - 259 TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT; 260 mp->u.value.a = p->u.value.a; 261 mp->u.value.b = p->u.value.b; 262 mp->u.value.c = p->u.value.c; 263 } 264 265 void optee_cq_wait_init(struct optee_call_queue *cq, 266 struct optee_call_waiter *w); 267 void optee_cq_wait_for_completion(struct optee_call_queue *cq, 268 struct optee_call_waiter *w); 269 void optee_cq_wait_final(struct optee_call_queue *cq, 270 struct optee_call_waiter *w); 271 int optee_check_mem_type(unsigned long start, size_t num_pages); 272 struct tee_shm *optee_get_msg_arg(struct tee_context *ctx, size_t num_params, 273 struct optee_msg_arg **msg_arg); 274 275 struct tee_shm *optee_rpc_cmd_alloc_suppl(struct tee_context *ctx, size_t sz); 276 void optee_rpc_cmd_free_suppl(struct tee_context *ctx, struct tee_shm *shm); 277 void optee_rpc_cmd(struct tee_context *ctx, struct optee *optee, 278 struct optee_msg_arg *arg); 279 280 /* 281 * Small helpers 282 */ 283 284 static inline void *reg_pair_to_ptr(u32 reg0, u32 reg1) 285 { 286 return (void *)(unsigned long)(((u64)reg0 << 32) | reg1); 287 } 288 289 static inline void reg_pair_from_64(u32 *reg0, u32 *reg1, u64 val) 290 { 291 *reg0 = val >> 32; 292 *reg1 = val; 293 } 294 295 /* Registration of the ABIs */ 296 int optee_smc_abi_register(void); 297 void optee_smc_abi_unregister(void); 298 int optee_ffa_abi_register(void); 299 void optee_ffa_abi_unregister(void); 300 301 #endif /*OPTEE_PRIVATE_H*/ 302