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