xref: /optee_os/ldelf/include/ldelf.h (revision c86f218c5bc8ba0deb6e7c6ff58f8db93c01e32f)
17509ff7cSJens Wiklander /* SPDX-License-Identifier: BSD-2-Clause */
27509ff7cSJens Wiklander /*
37509ff7cSJens Wiklander  * Copyright (c) 2019, Linaro Limited
47509ff7cSJens Wiklander  */
57509ff7cSJens Wiklander 
67509ff7cSJens Wiklander #ifndef __LDELF_H
77509ff7cSJens Wiklander #define __LDELF_H
87509ff7cSJens Wiklander 
965137432SJens Wiklander #include <types_ext.h>
107509ff7cSJens Wiklander #include <tee_api_types.h>
117509ff7cSJens Wiklander 
127509ff7cSJens Wiklander /* Size of stack for TEE Core to allocate */
137509ff7cSJens Wiklander #define LDELF_STACK_SIZE	(4096 * 2)
147509ff7cSJens Wiklander 
157509ff7cSJens Wiklander /*
167509ff7cSJens Wiklander  * struct ldelf_arg - argument for ldelf
177509ff7cSJens Wiklander  * @uuid:	  [in] UUID of TA to load
187509ff7cSJens Wiklander  * @is_32bit:	  [out] 1 if a 32bit TA or 0 if a 64bit TA
197509ff7cSJens Wiklander  * @flags:	  [out] Flags field of TA header
207509ff7cSJens Wiklander  * @entry_func:	  [out] TA entry function
217509ff7cSJens Wiklander  * @stack_ptr:	  [out] TA stack pointer
2265137432SJens Wiklander  * @dump_entry:	  [out] Dump TA mappings and stack trace
23*c86f218cSJens Wiklander  * @ftrace_entry: [out] Dump TA mappings and ftrace buffer
247509ff7cSJens Wiklander  */
257509ff7cSJens Wiklander struct ldelf_arg {
267509ff7cSJens Wiklander 	TEE_UUID uuid;
277509ff7cSJens Wiklander 	uint32_t is_32bit;
287509ff7cSJens Wiklander 	uint32_t flags;
297509ff7cSJens Wiklander 	uint64_t entry_func;
307509ff7cSJens Wiklander 	uint64_t stack_ptr;
3165137432SJens Wiklander 	uint64_t dump_entry;
32*c86f218cSJens Wiklander 	uint64_t ftrace_entry;
3365137432SJens Wiklander };
3465137432SJens Wiklander 
3565137432SJens Wiklander #define DUMP_MAP_READ	BIT(0)
3665137432SJens Wiklander #define DUMP_MAP_WRITE	BIT(1)
3765137432SJens Wiklander #define DUMP_MAP_EXEC	BIT(2)
3865137432SJens Wiklander #define DUMP_MAP_SECURE	BIT(3)
3965137432SJens Wiklander #define DUMP_MAP_EPHEM	BIT(4)
4065137432SJens Wiklander #define DUMP_MAP_LDELF	BIT(7)
4165137432SJens Wiklander 
4265137432SJens Wiklander /*
4365137432SJens Wiklander  * struct dump_entry_arg - argument for ldelf_dump()
4465137432SJens Wiklander  */
4565137432SJens Wiklander struct dump_entry_arg {
4665137432SJens Wiklander 	union {
4765137432SJens Wiklander 		struct {
4865137432SJens Wiklander 			uint32_t regs[16];
4965137432SJens Wiklander 		} arm32;
5065137432SJens Wiklander 		struct {
5165137432SJens Wiklander 			uint64_t fp;
5265137432SJens Wiklander 			uint64_t sp;
5365137432SJens Wiklander 			uint64_t pc;
5465137432SJens Wiklander 		} arm64;
5565137432SJens Wiklander 	};
5665137432SJens Wiklander 	bool is_arm32;
5765137432SJens Wiklander 	size_t num_maps;
5865137432SJens Wiklander 	struct dump_map {
5965137432SJens Wiklander 		vaddr_t va;
6065137432SJens Wiklander 		paddr_t pa;
6165137432SJens Wiklander 		size_t sz;
6265137432SJens Wiklander 		uint32_t flags;
6365137432SJens Wiklander 	} maps[];
647509ff7cSJens Wiklander };
657509ff7cSJens Wiklander 
667509ff7cSJens Wiklander /*
677509ff7cSJens Wiklander  * ldelf is loaded into memory by TEE Core. BSS is initialized and a
687509ff7cSJens Wiklander  * stack is allocated and supplied in SP register. A struct ldelf_arg
697509ff7cSJens Wiklander  * is placed in the stack and a pointer to the struct is provided in
707509ff7cSJens Wiklander  * r0/x0.
717509ff7cSJens Wiklander  *
727509ff7cSJens Wiklander  * ldelf relocates itself to the address where it is loaded before the main
737509ff7cSJens Wiklander  * C routine is called.
747509ff7cSJens Wiklander  *
757509ff7cSJens Wiklander  * In the main C routine the TA is loaded using the PTA System interface.
767509ff7cSJens Wiklander  */
777509ff7cSJens Wiklander 
787509ff7cSJens Wiklander #endif /*__LDELF_H*/
79