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