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_primary_final(void);
49 void boot_init_memtag(void);
50 void boot_clear_memtag(void);
51 void boot_save_args(unsigned long a0, unsigned long a1, unsigned long a2,
52 unsigned long a3, unsigned long a4);
53
54 void __panic_at_smc_return(void) __noreturn;
55
56 #if defined(CFG_WITH_ARM_TRUSTED_FW)
57 unsigned long cpu_on_handler(unsigned long a0, unsigned long a1);
58 unsigned long boot_cpu_on_handler(unsigned long a0, unsigned long a1);
59 #else
60 void boot_init_secondary(unsigned long nsec_entry);
61 #endif
62
63 void boot_primary_init_intc(void);
64 void boot_secondary_init_intc(void);
65
66 void init_sec_mon(unsigned long nsec_entry);
67 void init_tee_runtime(void);
68
69 /* weak routines eventually overridden by platform */
70 void plat_cpu_reset_early(void);
71 void plat_primary_init_early(void);
72 unsigned long plat_get_aslr_seed(void);
73 unsigned long plat_get_freq(void);
74 #if defined(_CFG_CORE_STACK_PROTECTOR) || defined(CFG_WITH_STACK_CANARIES)
75 /*
76 * plat_get_random_stack_canaries() - Get random values for stack canaries.
77 * @buf: Pointer to the buffer where to store canaries
78 * @ncan: The number of canaries to generate.
79 * @size: The size (in bytes) of each canary.
80 *
81 * This function has a __weak default implementation.
82 */
83 void plat_get_random_stack_canaries(void *buf, size_t ncan, size_t size);
84 #endif
85 void arm_cl2_config(vaddr_t pl310);
86 void arm_cl2_enable(vaddr_t pl310);
87
88 #if defined(CFG_BOOT_SECONDARY_REQUEST)
89 void boot_set_core_ns_entry(size_t core_idx, uintptr_t entry,
90 uintptr_t context_id);
91
92 int boot_core_release(size_t core_idx, paddr_t entry);
93 struct ns_entry_context *boot_core_hpen(void);
94 #endif
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 /* Identify non-secure memory regions for dynamic shared memory */
104 void discover_nsec_memory(void);
105 /* Add reserved memory for static shared memory in the device-tree */
106 int mark_static_shm_as_reserved(struct dt_descriptor *dt);
107
108 #ifdef CFG_BOOT_MEM
109 /*
110 * Stack-like memory allocations during boot before a heap has been
111 * configured. boot_mem_relocate() performs relocation of the boot memory
112 * and address cells registered with boot_mem_add_reloc() during virtual
113 * memory initialization. Unused memory is unmapped and released to pool of
114 * free physical memory once MMU is initialized.
115 */
116 void boot_mem_init(vaddr_t start, vaddr_t end, vaddr_t orig_end);
117 void boot_mem_add_reloc(void *ptr);
118 void boot_mem_relocate(size_t offs);
119 void *boot_mem_alloc(size_t len, size_t align);
120 void *boot_mem_alloc_tmp(size_t len, size_t align);
121 vaddr_t boot_mem_release_unused(void);
122 void boot_mem_release_tmp_alloc(void);
123 #else
boot_mem_add_reloc(void * ptr __unused)124 static inline void boot_mem_add_reloc(void *ptr __unused) { }
boot_mem_alloc(size_t len __unused,size_t align __unused)125 static inline void *boot_mem_alloc(size_t len __unused, size_t align __unused)
126 { return NULL; }
boot_mem_alloc_tmp(size_t len __unused,size_t align __unused)127 static inline void *boot_mem_alloc_tmp(size_t len __unused,
128 size_t align __unused)
129 { return NULL; }
boot_mem_release_unused(void)130 static inline vaddr_t boot_mem_release_unused(void) { return 0; }
boot_mem_release_tmp_alloc(void)131 static inline void boot_mem_release_tmp_alloc(void) { }
132 #endif
133
134 #endif /* __KERNEL_BOOT_H */
135