1 // SPDX-License-Identifier: MIT
3 * Copyright 2019 Advanced Micro Devices, Inc.
6 #include <linux/errno.h>
8 #include <linux/module.h>
9 #include <linux/slab.h>
10 #include <linux/string.h>
11 #include <linux/device.h>
12 #include <linux/tee_drv.h>
13 #include <linux/types.h>
15 #include <linux/uaccess.h>
16 #include <linux/firmware.h>
17 #include "amdtee_private.h"
18 #include "../tee_private.h"
19 #include <linux/psp-tee.h>
21 static struct amdtee_driver_data *drv_data;
22 static DEFINE_MUTEX(session_list_mutex);
24 static void amdtee_get_version(struct tee_device *teedev,
25 struct tee_ioctl_version_data *vers)
27 struct tee_ioctl_version_data v = {
28 .impl_id = TEE_IMPL_ID_AMDTEE,
30 .gen_caps = TEE_GEN_CAP_GP,
35 static int amdtee_open(struct tee_context *ctx)
37 struct amdtee_context_data *ctxdata;
39 ctxdata = kzalloc(sizeof(*ctxdata), GFP_KERNEL);
43 INIT_LIST_HEAD(&ctxdata->sess_list);
44 INIT_LIST_HEAD(&ctxdata->shm_list);
45 mutex_init(&ctxdata->shm_mutex);
51 static void release_session(struct amdtee_session *sess)
55 /* Close any open session */
56 for (i = 0; i < TEE_NUM_SESSIONS; ++i) {
57 /* Check if session entry 'i' is valid */
58 if (!test_bit(i, sess->sess_mask))
61 handle_close_session(sess->ta_handle, sess->session_info[i]);
62 handle_unload_ta(sess->ta_handle);
68 static void amdtee_release(struct tee_context *ctx)
70 struct amdtee_context_data *ctxdata = ctx->data;
76 struct amdtee_session *sess;
78 sess = list_first_entry_or_null(&ctxdata->sess_list,
79 struct amdtee_session,
85 list_del(&sess->list_node);
86 release_session(sess);
88 mutex_destroy(&ctxdata->shm_mutex);
95 * alloc_session() - Allocate a session structure
96 * @ctxdata: TEE Context data structure
97 * @session: Session ID for which 'struct amdtee_session' structure is to be
100 * Scans the TEE context's session list to check if TA is already loaded in to
101 * TEE. If yes, returns the 'session' structure for that TA. Else allocates,
102 * initializes a new 'session' structure and adds it to context's session list.
104 * The caller must hold a mutex.
107 * 'struct amdtee_session *' on success and NULL on failure.
109 static struct amdtee_session *alloc_session(struct amdtee_context_data *ctxdata,
112 struct amdtee_session *sess;
113 u32 ta_handle = get_ta_handle(session);
115 /* Scan session list to check if TA is already loaded in to TEE */
116 list_for_each_entry(sess, &ctxdata->sess_list, list_node)
117 if (sess->ta_handle == ta_handle) {
118 kref_get(&sess->refcount);
122 /* Allocate a new session and add to list */
123 sess = kzalloc(sizeof(*sess), GFP_KERNEL);
125 sess->ta_handle = ta_handle;
126 kref_init(&sess->refcount);
127 spin_lock_init(&sess->lock);
128 list_add(&sess->list_node, &ctxdata->sess_list);
134 /* Requires mutex to be held */
135 static struct amdtee_session *find_session(struct amdtee_context_data *ctxdata,
138 u32 ta_handle = get_ta_handle(session);
139 u32 index = get_session_index(session);
140 struct amdtee_session *sess;
142 if (index >= TEE_NUM_SESSIONS)
145 list_for_each_entry(sess, &ctxdata->sess_list, list_node)
146 if (ta_handle == sess->ta_handle &&
147 test_bit(index, sess->sess_mask))
153 u32 get_buffer_id(struct tee_shm *shm)
155 struct amdtee_context_data *ctxdata = shm->ctx->data;
156 struct amdtee_shm_data *shmdata;
159 mutex_lock(&ctxdata->shm_mutex);
160 list_for_each_entry(shmdata, &ctxdata->shm_list, shm_node)
161 if (shmdata->kaddr == shm->kaddr) {
162 buf_id = shmdata->buf_id;
165 mutex_unlock(&ctxdata->shm_mutex);
170 static DEFINE_MUTEX(drv_mutex);
171 static int copy_ta_binary(struct tee_context *ctx, void *ptr, void **ta,
174 const struct firmware *fw;
175 char fw_name[TA_PATH_MAX];
184 n = snprintf(fw_name, TA_PATH_MAX,
185 "%s/%08x-%04x-%04x-%02x%02x%02x%02x%02x%02x%02x%02x.bin",
186 TA_LOAD_PATH, uuid->lo, uuid->mid, uuid->hi_ver,
187 uuid->seq_n[0], uuid->seq_n[1],
188 uuid->seq_n[2], uuid->seq_n[3],
189 uuid->seq_n[4], uuid->seq_n[5],
190 uuid->seq_n[6], uuid->seq_n[7]);
191 if (n < 0 || n >= TA_PATH_MAX) {
192 pr_err("failed to get firmware name\n");
196 mutex_lock(&drv_mutex);
197 n = request_firmware(&fw, fw_name, &ctx->teedev->dev);
199 pr_err("failed to load firmware %s\n", fw_name);
204 *ta_size = roundup(fw->size, PAGE_SIZE);
205 *ta = (void *)__get_free_pages(GFP_KERNEL, get_order(*ta_size));
207 pr_err("%s: get_free_pages failed\n", __func__);
212 memcpy(*ta, fw->data, fw->size);
214 release_firmware(fw);
216 mutex_unlock(&drv_mutex);
220 /* mutex must be held by caller */
221 static void destroy_session(struct kref *ref)
223 struct amdtee_session *sess = container_of(ref, struct amdtee_session,
226 list_del(&sess->list_node);
227 mutex_unlock(&session_list_mutex);
231 int amdtee_open_session(struct tee_context *ctx,
232 struct tee_ioctl_open_session_arg *arg,
233 struct tee_param *param)
235 struct amdtee_context_data *ctxdata = ctx->data;
236 struct amdtee_session *sess = NULL;
237 u32 session_info, ta_handle;
242 if (arg->clnt_login != TEE_IOCTL_LOGIN_PUBLIC) {
243 pr_err("unsupported client login method\n");
247 rc = copy_ta_binary(ctx, &arg->uuid[0], &ta, &ta_size);
249 pr_err("failed to copy TA binary\n");
253 /* Load the TA binary into TEE environment */
254 handle_load_ta(ta, ta_size, arg);
255 if (arg->ret != TEEC_SUCCESS)
258 ta_handle = get_ta_handle(arg->session);
260 mutex_lock(&session_list_mutex);
261 sess = alloc_session(ctxdata, arg->session);
262 mutex_unlock(&session_list_mutex);
265 handle_unload_ta(ta_handle);
270 /* Open session with loaded TA */
271 handle_open_session(arg, &session_info, param);
272 if (arg->ret != TEEC_SUCCESS) {
273 pr_err("open_session failed %d\n", arg->ret);
274 handle_unload_ta(ta_handle);
275 kref_put_mutex(&sess->refcount, destroy_session,
276 &session_list_mutex);
280 /* Find an empty session index for the given TA */
281 spin_lock(&sess->lock);
282 i = find_first_zero_bit(sess->sess_mask, TEE_NUM_SESSIONS);
283 if (i < TEE_NUM_SESSIONS) {
284 sess->session_info[i] = session_info;
285 set_session_id(ta_handle, i, &arg->session);
286 set_bit(i, sess->sess_mask);
288 spin_unlock(&sess->lock);
290 if (i >= TEE_NUM_SESSIONS) {
291 pr_err("reached maximum session count %d\n", TEE_NUM_SESSIONS);
292 handle_close_session(ta_handle, session_info);
293 handle_unload_ta(ta_handle);
294 kref_put_mutex(&sess->refcount, destroy_session,
295 &session_list_mutex);
301 free_pages((u64)ta, get_order(ta_size));
305 int amdtee_close_session(struct tee_context *ctx, u32 session)
307 struct amdtee_context_data *ctxdata = ctx->data;
308 u32 i, ta_handle, session_info;
309 struct amdtee_session *sess;
311 pr_debug("%s: sid = 0x%x\n", __func__, session);
314 * Check that the session is valid and clear the session
317 mutex_lock(&session_list_mutex);
318 sess = find_session(ctxdata, session);
320 ta_handle = get_ta_handle(session);
321 i = get_session_index(session);
322 session_info = sess->session_info[i];
323 spin_lock(&sess->lock);
324 clear_bit(i, sess->sess_mask);
325 spin_unlock(&sess->lock);
327 mutex_unlock(&session_list_mutex);
332 /* Close the session */
333 handle_close_session(ta_handle, session_info);
334 handle_unload_ta(ta_handle);
336 kref_put_mutex(&sess->refcount, destroy_session, &session_list_mutex);
341 int amdtee_map_shmem(struct tee_shm *shm)
343 struct amdtee_context_data *ctxdata;
344 struct amdtee_shm_data *shmnode;
345 struct shmem_desc shmem;
352 shmnode = kmalloc(sizeof(*shmnode), GFP_KERNEL);
357 shmem.kaddr = shm->kaddr;
358 shmem.size = shm->size;
361 * Send a MAP command to TEE and get the corresponding
364 rc = handle_map_shmem(count, &shmem, &buf_id);
366 pr_err("map_shmem failed: ret = %d\n", rc);
371 shmnode->kaddr = shm->kaddr;
372 shmnode->buf_id = buf_id;
373 ctxdata = shm->ctx->data;
374 mutex_lock(&ctxdata->shm_mutex);
375 list_add(&shmnode->shm_node, &ctxdata->shm_list);
376 mutex_unlock(&ctxdata->shm_mutex);
378 pr_debug("buf_id :[%x] kaddr[%p]\n", shmnode->buf_id, shmnode->kaddr);
383 void amdtee_unmap_shmem(struct tee_shm *shm)
385 struct amdtee_context_data *ctxdata;
386 struct amdtee_shm_data *shmnode;
392 buf_id = get_buffer_id(shm);
393 /* Unmap the shared memory from TEE */
394 handle_unmap_shmem(buf_id);
396 ctxdata = shm->ctx->data;
397 mutex_lock(&ctxdata->shm_mutex);
398 list_for_each_entry(shmnode, &ctxdata->shm_list, shm_node)
399 if (buf_id == shmnode->buf_id) {
400 list_del(&shmnode->shm_node);
404 mutex_unlock(&ctxdata->shm_mutex);
407 int amdtee_invoke_func(struct tee_context *ctx,
408 struct tee_ioctl_invoke_arg *arg,
409 struct tee_param *param)
411 struct amdtee_context_data *ctxdata = ctx->data;
412 struct amdtee_session *sess;
415 /* Check that the session is valid */
416 mutex_lock(&session_list_mutex);
417 sess = find_session(ctxdata, arg->session);
419 i = get_session_index(arg->session);
420 session_info = sess->session_info[i];
422 mutex_unlock(&session_list_mutex);
427 handle_invoke_cmd(arg, session_info, param);
432 int amdtee_cancel_req(struct tee_context *ctx, u32 cancel_id, u32 session)
437 static const struct tee_driver_ops amdtee_ops = {
438 .get_version = amdtee_get_version,
440 .release = amdtee_release,
441 .open_session = amdtee_open_session,
442 .close_session = amdtee_close_session,
443 .invoke_func = amdtee_invoke_func,
444 .cancel_req = amdtee_cancel_req,
447 static const struct tee_desc amdtee_desc = {
448 .name = DRIVER_NAME "-clnt",
450 .owner = THIS_MODULE,
453 static int __init amdtee_driver_init(void)
455 struct tee_device *teedev;
456 struct tee_shm_pool *pool;
457 struct amdtee *amdtee;
460 rc = psp_check_tee_status();
462 pr_err("amd-tee driver: tee not present\n");
466 drv_data = kzalloc(sizeof(*drv_data), GFP_KERNEL);
470 amdtee = kzalloc(sizeof(*amdtee), GFP_KERNEL);
473 goto err_kfree_drv_data;
476 pool = amdtee_config_shm();
478 pr_err("shared pool configuration error\n");
480 goto err_kfree_amdtee;
483 teedev = tee_device_alloc(&amdtee_desc, NULL, pool, amdtee);
484 if (IS_ERR(teedev)) {
485 rc = PTR_ERR(teedev);
488 amdtee->teedev = teedev;
490 rc = tee_device_register(amdtee->teedev);
492 goto err_device_unregister;
496 drv_data->amdtee = amdtee;
498 pr_info("amd-tee driver initialization successful\n");
501 err_device_unregister:
502 tee_device_unregister(amdtee->teedev);
505 tee_shm_pool_free(pool);
514 pr_err("amd-tee driver initialization failed\n");
517 module_init(amdtee_driver_init);
519 static void __exit amdtee_driver_exit(void)
521 struct amdtee *amdtee;
523 if (!drv_data || !drv_data->amdtee)
526 amdtee = drv_data->amdtee;
528 tee_device_unregister(amdtee->teedev);
529 tee_shm_pool_free(amdtee->pool);
531 module_exit(amdtee_driver_exit);
533 MODULE_AUTHOR(DRIVER_AUTHOR);
534 MODULE_DESCRIPTION("AMD-TEE driver");
535 MODULE_VERSION("1.0");
536 MODULE_LICENSE("Dual MIT/GPL");