xref: /optee_os/core/include/kernel/boot.h (revision 17a66904a791447da1356331f01e7c1ca25329be)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2015-2020, Linaro Limited
4  * Copyright (c) 2021-2023, Arm Limited
5  */
6 #ifndef __KERNEL_BOOT_H
7 #define __KERNEL_BOOT_H
8 
9 #include <initcall.h>
10 #include <types_ext.h>
11 
12 /*
13  * struct boot_embdata - Embedded boot data
14  * @total_len: Total length of the embedded boot data
15  * @num_blobs: Number of blobs in the embedded boot data, always 2 even if
16  *	       one blob is empty
17  * @hashes_offset: Offset of hashes from start of this struct
18  * @hashes_len: Length of hashes
19  * @reloc_offset: Offset of reloc from start of this struct
20  * @reloc_len: Length of reloc
21  *
22  * This struct is initialized by scripts/gen_tee_bin.py and must be kept
23  * in sync with that script. The struct and the following data is loaded
24  * at different addresses at boot depending on CFG_WITH_PAGER.
25  *
26  * If configured with CFG_WITH_PAGER=y the struct with data is following
27  * init part, this is together with the init part moved by the primary CPU
28  * so it ends up at __init_end. Whatever need to be saved for later need to
29  * be copied to a safe location in init_runtime().
30  *
31  * If configured with CFG_WITH_PAGER=n following the struct with data is
32  * __data_end, this is moved by the primary CPU so it ends up at __end.
33  */
34 struct boot_embdata {
35 	uint32_t total_len;
36 	uint32_t num_blobs;
37 	uint32_t hashes_offset;
38 	uint32_t hashes_len;
39 	uint32_t reloc_offset;
40 	uint32_t reloc_len;
41 };
42 
43 extern const struct core_mmu_config boot_mmu_config;
44 
45 void boot_init_primary_early(void);
46 void boot_init_primary_late(unsigned long fdt, unsigned long manifest);
47 void boot_init_memtag(void);
48 void boot_save_args(unsigned long a0, unsigned long a1, unsigned long a2,
49 		    unsigned long a3, unsigned long a4);
50 
51 void __panic_at_smc_return(void) __noreturn;
52 
53 #if defined(CFG_WITH_ARM_TRUSTED_FW)
54 unsigned long cpu_on_handler(unsigned long a0, unsigned long a1);
55 unsigned long boot_cpu_on_handler(unsigned long a0, unsigned long a1);
56 #else
57 void boot_init_secondary(unsigned long nsec_entry);
58 #endif
59 
60 void boot_primary_init_intc(void);
61 void boot_secondary_init_intc(void);
62 
63 void init_sec_mon(unsigned long nsec_entry);
64 void init_tee_runtime(void);
65 
66 /* weak routines eventually overridden by platform */
67 void plat_cpu_reset_early(void);
68 void plat_primary_init_early(void);
69 unsigned long plat_get_aslr_seed(void);
70 unsigned long plat_get_freq(void);
71 #if defined(_CFG_CORE_STACK_PROTECTOR) || defined(CFG_WITH_STACK_CANARIES)
72 /*
73  * plat_get_random_stack_canaries() - Get random values for stack canaries.
74  * @buf:	Pointer to the buffer where to store canaries
75  * @ncan:	The number of canaries to generate.
76  * @size:	The size (in bytes) of each canary.
77  *
78  * This function has a __weak default implementation.
79  */
80 void plat_get_random_stack_canaries(void *buf, size_t ncan, size_t size);
81 #endif
82 void arm_cl2_config(vaddr_t pl310);
83 void arm_cl2_enable(vaddr_t pl310);
84 
85 #if defined(CFG_BOOT_SECONDARY_REQUEST)
86 void boot_set_core_ns_entry(size_t core_idx, uintptr_t entry,
87 			    uintptr_t context_id);
88 
89 int boot_core_release(size_t core_idx, paddr_t entry);
90 struct ns_entry_context *boot_core_hpen(void);
91 #endif
92 
93 /* Returns TOS_FW_CONFIG DTB or SP manifest DTB if present, otherwise NULL */
94 void *get_manifest_dt(void);
95 
96 /*
97  * get_aslr_seed() - return a random seed for core ASLR
98  *
99  * This function has a __weak default implementation.
100  */
101 unsigned long get_aslr_seed(void);
102 
103 #endif /* __KERNEL_BOOT_H */
104