smcinvoke_kernel.c 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Copyright (c) 2021, The Linux Foundation. All rights reserved.
  4. * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  5. */
  6. #include <linux/file.h>
  7. #include <linux/fs.h>
  8. #include <linux/fdtable.h>
  9. #include <linux/anon_inodes.h>
  10. #include <linux/delay.h>
  11. #include <linux/kref.h>
  12. #include <linux/types.h>
  13. #include <linux/slab.h>
  14. #include <linux/firmware.h>
  15. #include <linux/elf.h>
  16. #include "smcinvoke.h"
  17. #include "smcinvoke_object.h"
  18. #include "IClientEnv.h"
  19. #if IS_ENABLED(CONFIG_QSEECOM_COMPAT)
  20. #include "IQSEEComCompat.h"
  21. #include "IQSEEComCompatAppLoader.h"
  22. #include "linux/qseecom_api.h"
  23. #if IS_ENABLED(CONFIG_QSEECOM_PROXY)
  24. #include <linux/qseecom_kernel.h>
  25. #else
  26. #include "misc/qseecom_kernel.h"
  27. #endif
  28. #endif
  29. const uint32_t CQSEEComCompatAppLoader_UID = 122;
  30. struct qseecom_compat_context {
  31. void *dev; /* in/out */
  32. unsigned char *sbuf; /* in/out */
  33. uint32_t sbuf_len; /* in/out */
  34. struct qtee_shm shm;
  35. uint8_t app_arch;
  36. struct Object client_env;
  37. struct Object app_loader;
  38. struct Object app_controller;
  39. };
  40. struct tzobject_context {
  41. int fd;
  42. struct kref refs;
  43. };
  44. static int invoke_over_smcinvoke(void *cxt,
  45. uint32_t op,
  46. union ObjectArg *args,
  47. uint32_t counts);
  48. static struct Object tzobject_new(int fd)
  49. {
  50. struct tzobject_context *me =
  51. kzalloc(sizeof(struct tzobject_context), GFP_KERNEL);
  52. if (!me)
  53. return Object_NULL;
  54. kref_init(&me->refs);
  55. me->fd = fd;
  56. pr_debug("%s: me->fd = %d, me->refs = %u\n", __func__,
  57. me->fd, kref_read(&me->refs));
  58. return (struct Object) { invoke_over_smcinvoke, me };
  59. }
  60. static void tzobject_delete(struct kref *refs)
  61. {
  62. struct tzobject_context *me = container_of(refs,
  63. struct tzobject_context, refs);
  64. pr_info("%s: me->fd = %d, me->refs = %d, files = %p\n",
  65. __func__, me->fd, kref_read(&me->refs), current->files);
  66. /*
  67. * after _close_fd(), ref_cnt will be 0,
  68. * but smcinvoke_release() was still not called,
  69. * so we first call smcinvoke_release_from_kernel_client() to
  70. * free filp and ask TZ to release object, then call _close_fd()
  71. */
  72. smcinvoke_release_from_kernel_client(me->fd);
  73. close_fd(me->fd);
  74. kfree(me);
  75. }
  76. int getObjectFromHandle(int handle, struct Object *obj)
  77. {
  78. int ret = 0;
  79. if (handle == SMCINVOKE_USERSPACE_OBJ_NULL) {
  80. /* NULL object*/
  81. Object_ASSIGN_NULL(*obj);
  82. } else if (handle > SMCINVOKE_USERSPACE_OBJ_NULL) {
  83. *obj = tzobject_new(handle);
  84. if (Object_isNull(*obj))
  85. ret = OBJECT_ERROR_BADOBJ;
  86. } else {
  87. pr_err("CBobj not supported for handle %d\n", handle);
  88. ret = OBJECT_ERROR_BADOBJ;
  89. }
  90. return ret;
  91. }
  92. int getHandleFromObject(struct Object obj, int *handle)
  93. {
  94. int ret = 0;
  95. if (Object_isNull(obj)) {
  96. /* set NULL Object's fd to be -1 */
  97. *handle = SMCINVOKE_USERSPACE_OBJ_NULL;
  98. return ret;
  99. }
  100. if (obj.invoke == invoke_over_smcinvoke) {
  101. struct tzobject_context *ctx = (struct tzobject_context *)(obj.context);
  102. if (ctx != NULL) {
  103. *handle = ctx->fd;
  104. } else {
  105. pr_err("Failed to get tzobject_context obj handle, ret = %d\n", ret);
  106. ret = OBJECT_ERROR_BADOBJ;
  107. }
  108. } else {
  109. pr_err("CBobj not supported\n");
  110. ret = OBJECT_ERROR_BADOBJ;
  111. }
  112. return ret;
  113. }
  114. static int marshalIn(struct smcinvoke_cmd_req *req,
  115. union smcinvoke_arg *argptr,
  116. uint32_t op, union ObjectArg *args,
  117. uint32_t counts)
  118. {
  119. size_t i = 0;
  120. req->op = op;
  121. req->counts = counts;
  122. req->argsize = sizeof(union smcinvoke_arg);
  123. req->args = (uintptr_t)argptr;
  124. FOR_ARGS(i, counts, buffers) {
  125. argptr[i].b.addr = (uintptr_t) args[i].b.ptr;
  126. argptr[i].b.size = args[i].b.size;
  127. }
  128. FOR_ARGS(i, counts, OI) {
  129. int handle = -1, ret;
  130. ret = getHandleFromObject(args[i].o, &handle);
  131. if (ret) {
  132. pr_err("invalid OI[%zu]\n", i);
  133. return OBJECT_ERROR_BADOBJ;
  134. }
  135. argptr[i].o.fd = handle;
  136. }
  137. FOR_ARGS(i, counts, OO) {
  138. argptr[i].o.fd = SMCINVOKE_USERSPACE_OBJ_NULL;
  139. }
  140. return OBJECT_OK;
  141. }
  142. static int marshalOut(struct smcinvoke_cmd_req *req,
  143. union smcinvoke_arg *argptr,
  144. union ObjectArg *args, uint32_t counts,
  145. struct tzobject_context *me)
  146. {
  147. int ret = req->result;
  148. bool failed = false;
  149. size_t i = 0;
  150. argptr = (union smcinvoke_arg *)(uintptr_t)(req->args);
  151. FOR_ARGS(i, counts, BO) {
  152. args[i].b.size = argptr[i].b.size;
  153. }
  154. FOR_ARGS(i, counts, OO) {
  155. ret = getObjectFromHandle(argptr[i].o.fd, &(args[i].o));
  156. if (ret) {
  157. pr_err("Failed to get OO[%zu] from handle = %d\n",
  158. i, (int)argptr[i].o.fd);
  159. failed = true;
  160. break;
  161. }
  162. pr_debug("Succeed to create OO for args[%zu].o, fd = %d\n",
  163. i, (int)argptr[i].o.fd);
  164. }
  165. if (failed) {
  166. FOR_ARGS(i, counts, OO) {
  167. Object_ASSIGN_NULL(args[i].o);
  168. }
  169. /* Only overwrite ret value if invoke result is 0 */
  170. if (ret == 0)
  171. ret = OBJECT_ERROR_BADOBJ;
  172. }
  173. return ret;
  174. }
  175. static int invoke_over_smcinvoke(void *cxt,
  176. uint32_t op,
  177. union ObjectArg *args,
  178. uint32_t counts)
  179. {
  180. int ret = OBJECT_OK;
  181. struct smcinvoke_cmd_req req = {0, 0, 0, 0, 0};
  182. size_t i = 0;
  183. struct tzobject_context *me = NULL;
  184. uint32_t method;
  185. union smcinvoke_arg *argptr = NULL;
  186. FOR_ARGS(i, counts, OO) {
  187. args[i].o = Object_NULL;
  188. }
  189. me = (struct tzobject_context *)cxt;
  190. method = ObjectOp_methodID(op);
  191. pr_debug("%s: cxt = %p, fd = %d, op = %u, cnt = %x, refs = %u\n",
  192. __func__, me, me->fd, op, counts, kref_read(&me->refs));
  193. if (ObjectOp_isLocal(op)) {
  194. switch (method) {
  195. case Object_OP_retain:
  196. kref_get(&me->refs);
  197. return OBJECT_OK;
  198. case Object_OP_release:
  199. kref_put(&me->refs, tzobject_delete);
  200. return OBJECT_OK;
  201. }
  202. return OBJECT_ERROR_REMOTE;
  203. }
  204. argptr = kcalloc(OBJECT_COUNTS_TOTAL(counts),
  205. sizeof(union smcinvoke_arg), GFP_KERNEL);
  206. if (argptr == NULL)
  207. return OBJECT_ERROR_KMEM;
  208. ret = marshalIn(&req, argptr, op, args, counts);
  209. if (ret)
  210. goto exit;
  211. ret = process_invoke_request_from_kernel_client(me->fd, &req);
  212. if (ret) {
  213. pr_err("INVOKE failed with ret = %d, result = %d\n"
  214. "obj.context = %p, fd = %d, op = %d, counts = 0x%x\n",
  215. ret, req.result, me, me->fd, op, counts);
  216. FOR_ARGS(i, counts, OO) {
  217. struct smcinvoke_obj obj = argptr[i].o;
  218. if (obj.fd >= 0) {
  219. pr_err("Close OO[%zu].fd = %d\n", i, obj.fd);
  220. close_fd(obj.fd);
  221. }
  222. }
  223. if (ret == -EBUSY) {
  224. ret = OBJECT_ERROR_BUSY;
  225. }
  226. else if (ret == -ENOMEM){
  227. ret = OBJECT_ERROR_KMEM;
  228. } else {
  229. ret = OBJECT_ERROR_UNAVAIL;
  230. }
  231. goto exit;
  232. }
  233. if (!req.result)
  234. ret = marshalOut(&req, argptr, args, counts, me);
  235. exit:
  236. kfree(argptr);
  237. return ret | req.result;
  238. }
  239. int get_root_obj(struct Object *rootObj)
  240. {
  241. int ret = 0;
  242. int root_fd = -1;
  243. ret = get_root_fd(&root_fd);
  244. if (ret) {
  245. pr_err("Failed to get root fd, ret = %d\n", ret);
  246. return ret;
  247. }
  248. *rootObj = tzobject_new(root_fd);
  249. if (Object_isNull(*rootObj)) {
  250. close_fd(root_fd);
  251. ret = -ENOMEM;
  252. }
  253. return ret;
  254. }
  255. /*
  256. * Get a client environment using a NULL credentials Object
  257. */
  258. int32_t get_client_env_object(struct Object *clientEnvObj)
  259. {
  260. int32_t ret = OBJECT_ERROR;
  261. int retry_count = 0;
  262. struct Object rootObj = Object_NULL;
  263. /* get rootObj */
  264. ret = get_root_obj(&rootObj);
  265. if (ret) {
  266. pr_err("Failed to create rootobj\n");
  267. return ret;
  268. }
  269. /* get client env */
  270. do {
  271. ret = IClientEnv_registerWithCredentials(rootObj,
  272. Object_NULL, clientEnvObj);
  273. if (ret == OBJECT_ERROR_BUSY) {
  274. pr_err("Secure side is busy,will retry after 5 ms, retry_count = %d",retry_count);
  275. msleep(SMCINVOKE_INTERFACE_BUSY_WAIT_MS);
  276. }
  277. } while ((ret == OBJECT_ERROR_BUSY) && (retry_count++ < SMCINVOKE_INTERFACE_MAX_RETRY));
  278. if (ret)
  279. pr_err("Failed to get ClientEnvObject, ret = %d\n", ret);
  280. Object_release(rootObj);
  281. return ret;
  282. }
  283. EXPORT_SYMBOL(get_client_env_object);
  284. #if IS_ENABLED(CONFIG_QSEECOM_COMPAT)
  285. static int load_app(struct qseecom_compat_context *cxt, const char *app_name)
  286. {
  287. size_t fw_size = 0;
  288. u8 *imgbuf_va = NULL;
  289. int ret = 0;
  290. char dist_name[MAX_APP_NAME_SIZE] = {0};
  291. size_t dist_name_len = 0;
  292. struct qtee_shm shm = {0};
  293. if (strnlen(app_name, MAX_APP_NAME_SIZE) == MAX_APP_NAME_SIZE) {
  294. pr_err("The app_name (%s) with length %zu is not valid\n",
  295. app_name, strnlen(app_name, MAX_APP_NAME_SIZE));
  296. return -EINVAL;
  297. }
  298. ret = IQSEEComCompatAppLoader_lookupTA(cxt->app_loader,
  299. app_name, strlen(app_name), &cxt->app_controller);
  300. if (!ret) {
  301. pr_info("app %s exists\n", app_name);
  302. return ret;
  303. }
  304. imgbuf_va = firmware_request_from_smcinvoke(app_name, &fw_size, &shm);
  305. if (imgbuf_va == NULL) {
  306. pr_err("Failed on firmware_request_from_smcinvoke\n");
  307. return -EINVAL;
  308. }
  309. ret = IQSEEComCompatAppLoader_loadFromBuffer(
  310. cxt->app_loader, imgbuf_va, fw_size,
  311. app_name, strlen(app_name),
  312. dist_name, MAX_APP_NAME_SIZE, &dist_name_len,
  313. &cxt->app_controller);
  314. if (ret) {
  315. pr_err("loadFromBuffer failed for app %s, ret = %d\n",
  316. app_name, ret);
  317. goto exit_release_shm;
  318. }
  319. cxt->app_arch = *(uint8_t *)(imgbuf_va + EI_CLASS);
  320. pr_info("%s %d, loaded app %s, dist_name %s, dist_name_len %zu\n",
  321. __func__, __LINE__, app_name, dist_name, dist_name_len);
  322. exit_release_shm:
  323. qtee_shmbridge_free_shm(&shm);
  324. return ret;
  325. }
  326. static int __qseecom_start_app(struct qseecom_handle **handle,
  327. char *app_name, uint32_t size)
  328. {
  329. int ret = 0;
  330. struct qseecom_compat_context *cxt = NULL;
  331. pr_warn("%s, start app %s, size %zu\n",
  332. __func__, app_name, size);
  333. if (app_name == NULL || handle == NULL) {
  334. pr_err("app_name is null or invalid handle\n");
  335. return -EINVAL;
  336. }
  337. /* allocate qseecom_compat_context */
  338. cxt = kzalloc(sizeof(struct qseecom_compat_context), GFP_KERNEL);
  339. if (!cxt)
  340. return -ENOMEM;
  341. /* get client env */
  342. ret = get_client_env_object(&cxt->client_env);
  343. if (ret) {
  344. pr_err("failed to get clientEnv when loading app %s, ret %d\n",
  345. app_name, ret);
  346. ret = -EINVAL;
  347. goto exit_free_cxt;
  348. }
  349. /* get apploader with CQSEEComCompatAppLoader_UID */
  350. ret = IClientEnv_open(cxt->client_env, CQSEEComCompatAppLoader_UID,
  351. &cxt->app_loader);
  352. if (ret) {
  353. pr_err("failed to get apploader when loading app %s, ret %d\n",
  354. app_name, ret);
  355. ret = -EINVAL;
  356. goto exit_release_clientenv;
  357. }
  358. /* load app*/
  359. ret = load_app(cxt, app_name);
  360. if (ret) {
  361. pr_err("failed to load app %s, ret = %d\n",
  362. app_name, ret);
  363. ret = -EINVAL;
  364. goto exit_release_apploader;
  365. }
  366. /* Get the physical address of the req/resp buffer */
  367. ret = qtee_shmbridge_allocate_shm(size, &cxt->shm);
  368. if (ret) {
  369. pr_err("qtee_shmbridge_allocate_shm failed, ret :%d\n", ret);
  370. ret = -EINVAL;
  371. goto exit_release_appcontroller;
  372. }
  373. cxt->sbuf = cxt->shm.vaddr;
  374. cxt->sbuf_len = size;
  375. *handle = (struct qseecom_handle *)cxt;
  376. return ret;
  377. exit_release_appcontroller:
  378. Object_release(cxt->app_controller);
  379. exit_release_apploader:
  380. Object_release(cxt->app_loader);
  381. exit_release_clientenv:
  382. Object_release(cxt->client_env);
  383. exit_free_cxt:
  384. kfree(cxt);
  385. return ret;
  386. }
  387. static int __qseecom_shutdown_app(struct qseecom_handle **handle)
  388. {
  389. struct qseecom_compat_context *cxt = NULL;
  390. if ((handle == NULL) || (*handle == NULL)) {
  391. pr_err("Handle is NULL\n");
  392. return -EINVAL;
  393. }
  394. cxt = (struct qseecom_compat_context *)(*handle);
  395. qtee_shmbridge_free_shm(&cxt->shm);
  396. Object_release(cxt->app_controller);
  397. Object_release(cxt->app_loader);
  398. Object_release(cxt->client_env);
  399. kfree(cxt);
  400. *handle = NULL;
  401. return 0;
  402. }
  403. static int __qseecom_send_command(struct qseecom_handle *handle, void *send_buf,
  404. uint32_t sbuf_len, void *resp_buf, uint32_t rbuf_len)
  405. {
  406. struct qseecom_compat_context *cxt =
  407. (struct qseecom_compat_context *)handle;
  408. size_t out_len = 0;
  409. pr_debug("%s, sbuf_len %u, rbuf_len %u\n",
  410. __func__, sbuf_len, rbuf_len);
  411. if (!handle || !send_buf || !resp_buf || !sbuf_len || !rbuf_len) {
  412. pr_err("One of params is invalid. %s, handle %x, send_buf %x,resp_buf %x,sbuf_len %u, rbuf_len %u\n",
  413. __func__, handle, send_buf, resp_buf, sbuf_len, rbuf_len);
  414. return -EINVAL;
  415. }
  416. return IQSEEComCompat_sendRequest(cxt->app_controller,
  417. send_buf, sbuf_len,
  418. resp_buf, rbuf_len,
  419. send_buf, sbuf_len, &out_len,
  420. resp_buf, rbuf_len, &out_len,
  421. NULL, 0, /* embedded offset array */
  422. (cxt->app_arch == ELFCLASS64),
  423. Object_NULL, Object_NULL,
  424. Object_NULL, Object_NULL);
  425. }
  426. #if IS_ENABLED(CONFIG_QSEECOM_PROXY)
  427. const static struct qseecom_drv_ops qseecom_driver_ops = {
  428. .qseecom_send_command = __qseecom_send_command,
  429. .qseecom_start_app = __qseecom_start_app,
  430. .qseecom_shutdown_app = __qseecom_shutdown_app,
  431. };
  432. int get_qseecom_kernel_fun_ops(void)
  433. {
  434. return provide_qseecom_kernel_fun_ops(&qseecom_driver_ops);
  435. }
  436. #else
  437. int qseecom_start_app(struct qseecom_handle **handle,
  438. char *app_name, uint32_t size)
  439. {
  440. return __qseecom_start_app(handle, app_name, size);
  441. }
  442. EXPORT_SYMBOL(qseecom_start_app);
  443. int qseecom_shutdown_app(struct qseecom_handle **handle)
  444. {
  445. return __qseecom_shutdown_app(handle);
  446. }
  447. EXPORT_SYMBOL(qseecom_shutdown_app);
  448. int qseecom_send_command(struct qseecom_handle *handle, void *send_buf,
  449. uint32_t sbuf_len, void *resp_buf, uint32_t rbuf_len)
  450. {
  451. return __qseecom_send_command(handle, send_buf, sbuf_len,
  452. resp_buf, rbuf_len);
  453. }
  454. EXPORT_SYMBOL(qseecom_send_command);
  455. #endif
  456. #endif